Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/HewlettPackard/POSH-HPEOneView/llms.txt

Use this file to discover all available pages before exploring further.

​
Synopsis

Enable HPE Remote Support for an individual server hardware or enclosure resource.

​
Syntax

Enable-OVRemoteSupport
    -InputObject <Object>
    [-Async]
    [-ApplianceConnection <Object>]
    [<CommonParameters>]

​
Description

Enable-OVRemoteSupport enables the HPE Remote Support feature on a specific server hardware or enclosure resource. When enabled, the device can automatically open HPE support cases, send diagnostic data, and receive proactive support. The cmdlet issues a PATCH request that sets supportEnabled to true on the relevant resource’s Remote Support settings URI. Supported resource categories are:
  • server-hardware
  • enclosures
Remote Support must first be configured and enabled globally on the appliance using Set-OVRemoteSupport. Use Get-OVRemoteSupport to verify the global configuration. By default, the cmdlet waits for the task to complete. Pass -Async to return the task object immediately and manage completion with Wait-OVTaskComplete.
To enable Remote Support on all managed devices at once, set -AutoEnableDevices $true on Set-OVRemoteSupport instead of calling this cmdlet for each device individually.

​
Parameters

​
InputObject
Object
required
The server hardware or enclosure resource object on which to enable Remote Support. Must be a resource object with a category of server-hardware or enclosures.Can be provided via the pipeline.
​
Async
SwitchParameter
Return the async task object immediately without waiting for completion. Use with Wait-OVTaskComplete.
​
ApplianceConnection
Object
Specify one or more appliance connection objects or names. Defaults to the value in the ApplianceConnection property of the input object.

​
Examples

​
Enable Remote Support on a specific server

$server = Get-OVServer -Name 'Encl1, Bay 1'
Enable-OVRemoteSupport -InputObject $server

​
Enable Remote Support on an enclosure

$enclosure = Get-OVEnclosure -Name 'MyEnclosure'
Enable-OVRemoteSupport -InputObject $enclosure

​
Enable Remote Support on multiple servers asynchronously

$tasks = Get-OVServer | ForEach-Object {
    Enable-OVRemoteSupport -InputObject $_ -Async
}

# Wait for all tasks to complete
$tasks | Wait-OVTaskComplete

​
Enable Remote Support on all servers in an enclosure

$servers = Get-OVServer | Where-Object { $_.locationUri -match 'MyEnclosure' }
$tasks   = $servers | ForEach-Object { Enable-OVRemoteSupport -InputObject $_ -Async }
$tasks | Wait-OVTaskComplete

​
Output

When -Async is not used: HPEOneview.Appliance.TaskResource — the completed task. When -Async is used: HPEOneview.Appliance.TaskResource — the task object is returned immediately.