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
Get the HPE Remote Support global configuration and portal registration status.Syntax
Description
Get-OVRemoteSupport retrieves the appliance-level HPE Remote Support configuration. The returned object combines data from both the Remote Support registration endpoint and the configuration endpoint, providing a unified view of:
- Whether the appliance is registered with the HPE Remote Support portal.
- Whether Remote Support is enabled.
- The company name configured for support entitlement.
- Whether marketing opt-in is enabled.
- Whether automatic enablement of new devices is configured.
- Whether email notifications for Remote Support events are enabled.
Set-OVRemoteSupport to change the configuration, and Enable-OVRemoteSupport or Disable-OVRemoteSupport to toggle Remote Support on individual servers or enclosures.
Parameters
Specify one or more appliance connection objects or names. Defaults to the default connection in
$ConnectedSessions.Examples
Get Remote Support configuration from the default appliance
Check whether Remote Support is enabled
Get configuration from all connected appliances
Output
HPEOneView.Appliance.RemoteSupport.Configuration
Key properties:
| Property | Type | Description |
|---|---|---|
Registered | Boolean | Whether the appliance is registered with the HPE Remote Support portal |
EnableRemoteSupport | Boolean | Whether Remote Support is currently enabled |
CompanyName | String | Company name associated with the support contract |
MarketingOptIn | Boolean | Whether HPE marketing communications opt-in is active |
AutoEnableDevices | Boolean | Whether newly added devices automatically have Remote Support enabled |
EnableEmailNotification | Boolean | Whether Remote Support email notifications are active |
Created | DateTime | When the configuration was first created |
Modified | DateTime | When the configuration was last modified |
ApplianceConnection | Object | Appliance the configuration was retrieved from |
Related cmdlets
- Set-OVRemoteSupport
- Enable-OVRemoteSupport
- Disable-OVRemoteSupport
- Get-OVRemoteSupportContact — see source repository for cmdlet usage