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

Get the HPE Remote Support global configuration and portal registration status.

Syntax

Get-OVRemoteSupport
    [-ApplianceConnection <Object>]
    [<CommonParameters>]

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.
Use Set-OVRemoteSupport to change the configuration, and Enable-OVRemoteSupport or Disable-OVRemoteSupport to toggle Remote Support on individual servers or enclosures.

Parameters

ApplianceConnection
Object
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

Get-OVRemoteSupport

Check whether Remote Support is enabled

$rs = Get-OVRemoteSupport
if ($rs.EnableRemoteSupport)
{
    Write-Host "Remote Support is enabled for company: $($rs.CompanyName)"
}
else
{
    Write-Warning "Remote Support is not enabled."
}

Get configuration from all connected appliances

$ConnectedSessions | ForEach-Object {
    Get-OVRemoteSupport -ApplianceConnection $_
} | Select-Object CompanyName, EnableRemoteSupport, AutoEnableDevices, ApplianceConnection

Output

HPEOneView.Appliance.RemoteSupport.Configuration Key properties:
PropertyTypeDescription
RegisteredBooleanWhether the appliance is registered with the HPE Remote Support portal
EnableRemoteSupportBooleanWhether Remote Support is currently enabled
CompanyNameStringCompany name associated with the support contract
MarketingOptInBooleanWhether HPE marketing communications opt-in is active
AutoEnableDevicesBooleanWhether newly added devices automatically have Remote Support enabled
EnableEmailNotificationBooleanWhether Remote Support email notifications are active
CreatedDateTimeWhen the configuration was first created
ModifiedDateTimeWhen the configuration was last modified
ApplianceConnectionObjectAppliance the configuration was retrieved from