iLO 4 REST API Data Model (Manager Resource Type) - shamimur/hp-proliant-sdk GitHub Wiki

HP RESTful API Data Model Reference for iLO 4—Redfish 1.0 Conformance (Cont)

"Manager" Resource Type

Resource Instances

/rest/v1/Managers/{item}

See Resource Map for more details.

This is the schema definition for a manager. Examples of managers are BMCs, Enclosure Managers, Management Controllers and other subsystems assigned manageability functions.

"Manager" defines the following properties:

"CommandShell/Enabled"

This property is a member of [Manager](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(Manager-Resource-Type)#manager-resource-type)
Indicates if the Command Shell service is enabled for this manager.
JSON type:
Boolean ('true' or 'false')

HTTP Operations

GET Rendered if supported by the implementation or omitted if not.
PATCH This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

PATCH Example

HTTP PATCH to resource with request JSON:

{"CommandShell": {"Enabled": true}}

The property "CommandShell/Enabled" on resource type Manager may not support PATCH of all values and may result in an HTTP 400 error with response of Type ExtendedError. Multiple properties may be included in a single HTTP PATCH operation as long as the request is properly formatted JSON. To address an array entry other than the first, insert nulls as placeholders on skipped array entries.

"CommandShell/MaxConcurrentSessions"

This property is a member of [Manager](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(Manager-Resource-Type)#manager-resource-type)
This is the maximum number of Command Shell sessions, regardless of protocol, that this manager supports.
JSON type:
Integer greater than or equal to 0.

HTTP Operations

GET Rendered if supported by the implementation or omitted if not.

"CommandShell/ServiceEnabled"

This property is a member of [Manager](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(Manager-Resource-Type)#manager-resource-type)
Indicates if the Command Shell service is enabled for this manager.
JSON type:
Boolean ('true' or 'false')

HTTP Operations

GET Rendered if supported by the implementation or omitted if not.
PATCH This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

PATCH Example

HTTP PATCH to resource with request JSON:

{"CommandShell": {"ServiceEnabled": true}}

The property "CommandShell/ServiceEnabled" on resource type Manager may not support PATCH of all values and may result in an HTTP 400 error with response of Type ExtendedError. Multiple properties may be included in a single HTTP PATCH operation as long as the request is properly formatted JSON. To address an array entry other than the first, insert nulls as placeholders on skipped array entries.

"Firmware/Current/VersionString"

This property is a member of [Manager](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(Manager-Resource-Type)#manager-resource-type)
This string represents the version of the firmware image.
JSON type:
String

HTTP Operations

GET Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.

"FirmwareVersion"

This property is a member of [Manager](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(Manager-Resource-Type)#manager-resource-type)
The firmware version of this Manager
JSON type:
String

HTTP Operations

GET Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.

"GraphicalConsole/Enabled"

This property is a member of [Manager](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(Manager-Resource-Type)#manager-resource-type)
Indicates if the Graphical Console service is enabled for this manager.
JSON type:
Boolean ('true' or 'false')

HTTP Operations

GET Rendered if supported by the implementation or omitted if not.
PATCH This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

PATCH Example

HTTP PATCH to resource with request JSON:

{"GraphicalConsole": {"Enabled": true}}

The property "GraphicalConsole/Enabled" on resource type Manager may not support PATCH of all values and may result in an HTTP 400 error with response of Type ExtendedError. Multiple properties may be included in a single HTTP PATCH operation as long as the request is properly formatted JSON. To address an array entry other than the first, insert nulls as placeholders on skipped array entries.

"GraphicalConsole/MaxConcurrentSessions"

This property is a member of [Manager](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(Manager-Resource-Type)#manager-resource-type)
Indicates the maximum number of Graphical Console sessions, regardless of protocol, this manager supports.
JSON type:
Integer greater than or equal to 0.

HTTP Operations

GET Rendered if supported by the implementation or omitted if not.

"GraphicalConsole/ServiceEnabled"

This property is a member of [Manager](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(Manager-Resource-Type)#manager-resource-type)
Indicates if the Command Shell service is enabled for this manager.
JSON type:
Boolean ('true' or 'false')

HTTP Operations

GET Rendered if supported by the implementation or omitted if not.
PATCH This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

PATCH Example

HTTP PATCH to resource with request JSON:

{"GraphicalConsole": {"ServiceEnabled": true}}

The property "GraphicalConsole/ServiceEnabled" on resource type Manager may not support PATCH of all values and may result in an HTTP 400 error with response of Type ExtendedError. Multiple properties may be included in a single HTTP PATCH operation as long as the request is properly formatted JSON. To address an array entry other than the first, insert nulls as placeholders on skipped array entries.

"ManagerType"

This property is a member of [Manager](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(Manager-Resource-Type)#manager-resource-type)
This property is the manager type for this resource.
JSON type:
String containing one of the following supported values: "ManagementController" "EnclosureManager" "BMC"

HTTP Operations

GET Rendered if supported by the implementation or omitted if not.

"Model"

This property is a member of [Manager](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(Manager-Resource-Type)#manager-resource-type)
Model name of the manager.
JSON type:
String

HTTP Operations

GET Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.

"Oem/Hp/ClearRestApiStatus"

This property is a member of [Manager](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(Manager-Resource-Type)#manager-resource-type)
Status of external provider data in NVRAM.
JSON type:
String containing one of the following supported values: "DataPresent" "DataCleared"

HTTP Operations

GET Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.

"Oem/Hp/FederationConfig/IPv6MulticastScope"

This property is a member of [Manager](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(Manager-Resource-Type)#manager-resource-type)
The IPv6 network scope of multicast announcements.
JSON type:
String containing one of the following supported values: "Link" "Site" "Organization"

HTTP Operations

GET Rendered if supported by the implementation or omitted if not.
PATCH This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

PATCH Example

HTTP PATCH to resource with request JSON:

{"Oem": {"Hp": {"FederationConfig": {"IPv6MulticastScope": "Site"}}}}

The property "Oem/Hp/FederationConfig/IPv6MulticastScope" on resource type Manager may not support PATCH of all values and may result in an HTTP 400 error with response of Type ExtendedError. Multiple properties may be included in a single HTTP PATCH operation as long as the request is properly formatted JSON. To address an array entry other than the first, insert nulls as placeholders on skipped array entries.

"Oem/Hp/FederationConfig/MulticastAnnouncementInterval"

This property is a member of [Manager](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(Manager-Resource-Type)#manager-resource-type)
The frequency in Seconds at which the iLO system announces itself on the network. A value of 0 disables multicast announcments.
JSON type:
Integer from 0 to 1800.

HTTP Operations

GET Rendered if supported by the implementation or omitted if not.
PATCH This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

PATCH Example

HTTP PATCH to resource with request JSON:

{"Oem": {"Hp": {"FederationConfig": {"MulticastAnnouncementInterval": <integer-value>}}}}

The property "Oem/Hp/FederationConfig/MulticastAnnouncementInterval" on resource type Manager may not support PATCH of all values and may result in an HTTP 400 error with response of Type ExtendedError. Multiple properties may be included in a single HTTP PATCH operation as long as the request is properly formatted JSON. To address an array entry other than the first, insert nulls as placeholders on skipped array entries.

"Oem/Hp/FederationConfig/MulticastDiscovery"

This property is a member of [Manager](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(Manager-Resource-Type)#manager-resource-type)
Enables or Disables Multicast Discovery for the local iLO system.
JSON type:
String containing one of the following supported values: "Enabled" "Disabled"

HTTP Operations

GET Rendered if supported by the implementation or omitted if not.
PATCH This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

PATCH Example

HTTP PATCH to resource with request JSON:

{"Oem": {"Hp": {"FederationConfig": {"MulticastDiscovery": "Disabled"}}}}

The property "Oem/Hp/FederationConfig/MulticastDiscovery" on resource type Manager may not support PATCH of all values and may result in an HTTP 400 error with response of Type ExtendedError. Multiple properties may be included in a single HTTP PATCH operation as long as the request is properly formatted JSON. To address an array entry other than the first, insert nulls as placeholders on skipped array entries.

"Oem/Hp/FederationConfig/MulticastTimeToLive"

This property is a member of [Manager](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(Manager-Resource-Type)#manager-resource-type)
The maximum number of switches a multicast announcement will traverse before being discarded.
JSON type:
Integer

HTTP Operations

GET Rendered if supported by the implementation or omitted if not.
PATCH This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

PATCH Example

HTTP PATCH to resource with request JSON:

{"Oem": {"Hp": {"FederationConfig": {"MulticastTimeToLive": <integer-value>}}}}

The property "Oem/Hp/FederationConfig/MulticastTimeToLive" on resource type Manager may not support PATCH of all values and may result in an HTTP 400 error with response of Type ExtendedError. Multiple properties may be included in a single HTTP PATCH operation as long as the request is properly formatted JSON. To address an array entry other than the first, insert nulls as placeholders on skipped array entries.

"Oem/Hp/FederationConfig/iLOFederationManagement"

This property is a member of [Manager](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(Manager-Resource-Type)#manager-resource-type)
Enables or Disables iLO Federation features for the local iLO system.
JSON type:
String containing one of the following supported values: "Enabled" "Disabled"

HTTP Operations

GET Rendered if supported by the implementation or omitted if not.
PATCH This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

PATCH Example

HTTP PATCH to resource with request JSON:

{"Oem": {"Hp": {"FederationConfig": {"iLOFederationManagement": "Disabled"}}}}

The property "Oem/Hp/FederationConfig/iLOFederationManagement" on resource type Manager may not support PATCH of all values and may result in an HTTP 400 error with response of Type ExtendedError. Multiple properties may be included in a single HTTP PATCH operation as long as the request is properly formatted JSON. To address an array entry other than the first, insert nulls as placeholders on skipped array entries.

"Oem/Hp/Firmware/Backup/BuildNumber"

This property is a member of Manager

The build number of the firmware.
JSON type:
Integer greater than or equal to 0.

HTTP Operations

GET Rendered if supported by the implementation or omitted if not.

"Oem/Hp/Firmware/Backup/BuildNumberString"

This property is a member of [Manager](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(Manager-Resource-Type)#manager-resource-type)
The string version of the build number of the firmware.
JSON type:
String

HTTP Operations

GET Rendered if supported by the implementation or omitted if not.

"Oem/Hp/Firmware/Backup/Date"

This property is a member of [Manager](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(Manager-Resource-Type)#manager-resource-type)
The build date of the firmware.
JSON type:
String

HTTP Operations

GET Rendered if supported by the implementation or omitted if not.

"Oem/Hp/Firmware/Backup/DebugBuild"

This property is a member of Manager

True if the firmware is a debug build; False if it is not.
JSON type:
Boolean ('true' or 'false')

HTTP Operations

GET Rendered if supported by the implementation or omitted if not.

"Oem/Hp/Firmware/Backup/Family"

This property is a member of [Manager](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(Manager-Resource-Type)#manager-resource-type)
The family of the firmware.
JSON type:
String

HTTP Operations

GET Rendered if supported by the implementation or omitted if not.

"Oem/Hp/Firmware/Backup/MajorVersion"

This property is a member of [Manager](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(Manager-Resource-Type)#manager-resource-type)
The major version of the firmware.
JSON type:
Integer greater than or equal to 0.

HTTP Operations

GET Rendered if supported by the implementation or omitted if not.

"Oem/Hp/Firmware/Backup/MinorVersion"

This property is a member of [Manager](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(Manager-Resource-Type)#manager-resource-type)
The minor version of the firmware.
JSON type:
Integer greater than or equal to 0.

HTTP Operations

GET Rendered if supported by the implementation or omitted if not.

"Oem/Hp/Firmware/Backup/Time"

This property is a member of [Manager](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(Manager-Resource-Type)#manager-resource-type)
The build time of the firmware.
JSON type:
String

HTTP Operations

GET Rendered if supported by the implementation or omitted if not.

"Oem/Hp/Firmware/Backup/VersionString"

This property is a member of [Manager](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(Manager-Resource-Type)#manager-resource-type)
The version string of the firmware. This value might be null if VersionString is unavailable.
JSON type:
String

HTTP Operations

GET Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.

"Oem/Hp/Firmware/Bootblock/BuildNumber"

This property is a member of [Manager](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(Manager-Resource-Type)#manager-resource-type)
The build number of the firmware.
JSON type:
Integer greater than or equal to 0.

HTTP Operations

GET Rendered if supported by the implementation or omitted if not.

"Oem/Hp/Firmware/Bootblock/BuildNumberString"

This property is a member of [Manager](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(Manager-Resource-Type)#manager-resource-type)
The string version of the build number of the firmware.
JSON type:
String

HTTP Operations

GET Rendered if supported by the implementation or omitted if not.

"Oem/Hp/Firmware/Bootblock/Date"

This property is a member of Manager

The build date of the firmware.
JSON type:
String

HTTP Operations

GET Rendered if supported by the implementation or omitted if not.

"Oem/Hp/Firmware/Bootblock/DebugBuild"

This property is a member of Manager

True if the firmware is a debug build; False if it is not.
JSON type:
Boolean ('true' or 'false')

HTTP Operations

GET Rendered if supported by the implementation or omitted if not.

"Oem/Hp/Firmware/Bootblock/Family"

This property is a member of Manager

The family of the firmware.
JSON type:
String

HTTP Operations

GET Rendered if supported by the implementation or omitted if not.

"Oem/Hp/Firmware/Bootblock/MajorVersion"

This property is a member of Manager

The major version of the firmware.
JSON type:
Integer greater than or equal to 0.

HTTP Operations

GET Rendered if supported by the implementation or omitted if not.

"Oem/Hp/Firmware/Bootblock/MinorVersion"

This property is a member of Manager

The minor version of the firmware.
JSON type:
Integer greater than or equal to 0.

HTTP Operations

GET Rendered if supported by the implementation or omitted if not.

"Oem/Hp/Firmware/Bootblock/Time"

This property is a member of Manager

The build time of the firmware.
JSON type:
String

HTTP Operations

GET Rendered if supported by the implementation or omitted if not.

"Oem/Hp/Firmware/Bootblock/VersionString"

This property is a member of Manager

The version string of the firmware. This value might be null if VersionString is unavailable.
JSON type:
String

HTTP Operations

GET Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.

"Oem/Hp/Firmware/Current/BuildNumber"

This property is a member of Manager

The build number of the firmware.
JSON type:
Integer greater than or equal to 0.

HTTP Operations

GET Rendered if supported by the implementation or omitted if not.

"Oem/Hp/Firmware/Current/BuildNumberString"

This property is a member of Manager

The string version of the build number of the firmware.
JSON type:
String

HTTP Operations

GET Rendered if supported by the implementation or omitted if not.

"Oem/Hp/Firmware/Current/Date"

This property is a member of Manager

The build date of the firmware.
JSON type:
String

HTTP Operations

GET Rendered if supported by the implementation or omitted if not.

"Oem/Hp/Firmware/Current/DebugBuild"

This property is a member of Manager

True if the firmware is a debug build; False if it is not.
JSON type:
Boolean ('true' or 'false')

HTTP Operations

GET Rendered if supported by the implementation or omitted if not.

"Oem/Hp/Firmware/Current/Family"

This property is a member of Manager

The family of the firmware.
JSON type:
String

HTTP Operations

GET Rendered if supported by the implementation or omitted if not.

"Oem/Hp/Firmware/Current/MajorVersion"

This property is a member of Manager

The major version of the firmware.
JSON type:
Integer greater than or equal to 0.

HTTP Operations

GET Rendered if supported by the implementation or omitted if not.

"Oem/Hp/Firmware/Current/MinorVersion"

This property is a member of Manager

The minor version of the firmware.
JSON type:
Integer greater than or equal to 0.

HTTP Operations

GET Rendered if supported by the implementation or omitted if not.

"Oem/Hp/Firmware/Current/Time"

This property is a member of Manager

The build time of the firmware.
JSON type:
String

HTTP Operations

GET Rendered if supported by the implementation or omitted if not.

"Oem/Hp/Firmware/Current/VersionString"

This property is a member of Manager

The version string of the firmware. This value might be null if VersionString is unavailable.
JSON type:
String

HTTP Operations

GET Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.

"Oem/Hp/Firmware/Pending/BuildNumber"

This property is a member of Manager

The build number of the firmware.
JSON type:
Integer greater than or equal to 0.

HTTP Operations

GET Rendered if supported by the implementation or omitted if not.

"Oem/Hp/Firmware/Pending/BuildNumberString"

This property is a member of Manager

The string version of the build number of the firmware.
JSON type:
String

HTTP Operations

GET Rendered if supported by the implementation or omitted if not.

"Oem/Hp/Firmware/Pending/Date"

This property is a member of Manager

The build date of the firmware.
JSON type:
String

HTTP Operations

GET Rendered if supported by the implementation or omitted if not.

"Oem/Hp/Firmware/Pending/DebugBuild"

This property is a member of Manager

True if the firmware is a debug build; False if it is not.
JSON type:
Boolean ('true' or 'false')

HTTP Operations

GET Rendered if supported by the implementation or omitted if not.

"Oem/Hp/Firmware/Pending/Family"

This property is a member of Manager

The family of the firmware.
JSON type:
String

HTTP Operations

GET Rendered if supported by the implementation or omitted if not.

"Oem/Hp/Firmware/Pending/MajorVersion"

This property is a member of Manager

The major version of the firmware.
JSON type:
Integer greater than or equal to 0.

HTTP Operations

GET Rendered if supported by the implementation or omitted if not.

"Oem/Hp/Firmware/Pending/MinorVersion"

This property is a member of Manager

The minor version of the firmware.
JSON type:
Integer greater than or equal to 0.

HTTP Operations

GET Rendered if supported by the implementation or omitted if not.

"Oem/Hp/Firmware/Pending/Time"

This property is a member of Manager

The build time of the firmware.
JSON type:
String

HTTP Operations

GET Rendered if supported by the implementation or omitted if not.

"Oem/Hp/Firmware/Pending/VersionString"

This property is a member of Manager

The version string of the firmware. This value might be null if VersionString is unavailable.
JSON type:
String

HTTP Operations

GET Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.

"Oem/Hp/Firmware/definitions/HpFWVersion/BuildNumber"

This property is a member of Manager

The build number of the firmware.
JSON type:
Integer greater than or equal to 0.

HTTP Operations

GET Rendered if supported by the implementation or omitted if not.

"Oem/Hp/Firmware/definitions/HpFWVersion/BuildNumberString"

This property is a member of Manager

The string version of the build number of the firmware.
JSON type:
String

HTTP Operations

GET Rendered if supported by the implementation or omitted if not.

"Oem/Hp/Firmware/definitions/HpFWVersion/Date"

This property is a member of Manager

The build date of the firmware.
JSON type:
String

HTTP Operations

GET Rendered if supported by the implementation or omitted if not.

"Oem/Hp/Firmware/definitions/HpFWVersion/DebugBuild"

This property is a member of Manager

True if the firmware is a debug build; False if it is not.
JSON type:
Boolean ('true' or 'false')

HTTP Operations

GET Rendered if supported by the implementation or omitted if not.

"Oem/Hp/Firmware/definitions/HpFWVersion/Family"

This property is a member of Manager

The family of the firmware.
JSON type:
String

HTTP Operations

GET Rendered if supported by the implementation or omitted if not.

"Oem/Hp/Firmware/definitions/HpFWVersion/MajorVersion"

This property is a member of Manager

The major version of the firmware.
JSON type:
Integer greater than or equal to 0.

HTTP Operations

GET Rendered if supported by the implementation or omitted if not.

"Oem/Hp/Firmware/definitions/HpFWVersion/MinorVersion"

This property is a member of Manager

The minor version of the firmware.
JSON type:
Integer greater than or equal to 0.

HTTP Operations

GET Rendered if supported by the implementation or omitted if not.

"Oem/Hp/Firmware/definitions/HpFWVersion/Time"

This property is a member of Manager

The build time of the firmware.
JSON type:
String

HTTP Operations

GET Rendered if supported by the implementation or omitted if not.

"Oem/Hp/Firmware/definitions/HpFWVersion/VersionString"

This property is a member of Manager

The version string of the firmware. This value might be null if VersionString is unavailable.
JSON type:
String

HTTP Operations

GET Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.

"Oem/Hp/License/LicenseKey"

This property is a member of Manager

The installed license key.
JSON type:
String

HTTP Operations

GET Rendered if supported by the implementation or omitted if not.

"Oem/Hp/License/LicenseString"

This property is a member of Manager

Describes the type of license installed on management processor.
JSON type:
String

HTTP Operations

GET Rendered if supported by the implementation or omitted if not.

"Oem/Hp/License/LicenseType"

This property is a member of Manager

Indicates whether the license is Perpetual or Evaluation.
JSON type:
String

HTTP Operations

GET Rendered if supported by the implementation or omitted if not.

"Oem/Hp/RequiredLoginForiLORBSU"

This property is a member of Manager

Determines whether a user-credential prompt is displayed when a user accesses the iLO RBSU or the iLO 4 Configuration Utility. The following settings are valid: Enabled-A login dialog box opens when a user accesses the iLO RBSU or the iLO 4 Configuration Utility. Disabled (default)-No login is required when a user accesses the iLO RBSU or the iLO 4 Configuration Utility.
JSON type:
Boolean ('true' or 'false')

HTTP Operations

GET Rendered if supported by the implementation or omitted if not.
PATCH This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

PATCH Example

HTTP PATCH to resource with request JSON:

{"Oem": {"Hp": {"RequiredLoginForiLORBSU": true}}}

The property "Oem/Hp/RequiredLoginForiLORBSU" on resource type Manager may not support PATCH of all values and may result in an HTTP 400 error with response of Type ExtendedError. Multiple properties may be included in a single HTTP PATCH operation as long as the request is properly formatted JSON. To address an array entry other than the first, insert nulls as placeholders on skipped array entries.

"Oem/Hp/SerialCLISpeed"

This property is a member of Manager

Serial command line interface speed in bits/second.
JSON type:
Integer

HTTP Operations

GET Rendered if supported by the implementation or omitted if not.
PATCH This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

PATCH Example

HTTP PATCH to resource with request JSON:

{"Oem": {"Hp": {"SerialCLISpeed": <integer-value>}}}

The property "Oem/Hp/SerialCLISpeed" on resource type Manager may not support PATCH of all values and may result in an HTTP 400 error with response of Type ExtendedError. Multiple properties may be included in a single HTTP PATCH operation as long as the request is properly formatted JSON. To address an array entry other than the first, insert nulls as placeholders on skipped array entries.

"Oem/Hp/SerialCLIStatus"

This property is a member of Manager

Status of serial command line interface.
JSON type:
String containing one of the following supported values:
"Disabled"
"EnabledNoAuth"
"EnabledAuthReq"

HTTP Operations

GET Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.
PATCH This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

PATCH Example

HTTP PATCH to resource with request JSON:

{"Oem": {"Hp": {"SerialCLIStatus": "EnabledNoAuth"}}}

The property "Oem/Hp/SerialCLIStatus" on resource type Manager may not support PATCH of all values and may result in an HTTP 400 error with response of Type ExtendedError. Multiple properties may be included in a single HTTP PATCH operation as long as the request is properly formatted JSON. To address an array entry other than the first, insert nulls as placeholders on skipped array entries.

"Oem/Hp/VSPLogDownloadEnabled"

This property is a member of [Manager](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(Manager-Resource-Type)#manager-resource-type)
This property enables or disables download of Virtual Serial Port (VSP) log.
JSON type:
Boolean ('true' or 'false')

HTTP Operations

GET Rendered if supported by the implementation or omitted if not.
PATCH This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

PATCH Example

HTTP PATCH to resource with request JSON:

{"Oem": {"Hp": {"VSPLogDownloadEnabled": true}}}

The property "Oem/Hp/VSPLogDownloadEnabled" on resource type Manager may not support PATCH of all values and may result in an HTTP 400 error with response of Type ExtendedError. Multiple properties may be included in a single HTTP PATCH operation as long as the request is properly formatted JSON. To address an array entry other than the first, insert nulls as placeholders on skipped array entries.

"Oem/Hp/iLOFunctionalityRequired"

This property is a member of [Manager](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(Manager-Resource-Type)#manager-resource-type)
iLO is required and can't be disabled on this platform (usually blades).
JSON type:
Boolean ('true' or 'false')

HTTP Operations

GET Rendered if supported by the implementation or omitted if not.

"Oem/Hp/iLORBSUEnabled"

This property is a member of [Manager](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(Manager-Resource-Type)#manager-resource-type)
Enables or disables the iLO RBSU or the iLO 4 Configuration Utility. The following settings are valid: Enabled (default)-On servers that support the iLO RBSU, pressing F8 during POST starts the iLO RBSU. On servers that support UEFI, the iLO 4 Configuration Utility is available when you access the UEFI System Utilities. Disabled-On servers that support the iLO RBSU, pressing F8 during POST will not start the iLO RBSU. On servers that support UEFI, the iLO 4 Configuration Utility is not available when you access the UEFI System Utilities.
JSON type:
Boolean ('true' or 'false')

HTTP Operations

GET Rendered if supported by the implementation or omitted if not.
PATCH This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

PATCH Example

HTTP PATCH to resource with request JSON:

{"Oem": {"Hp": {"iLORBSUEnabled": true}}}

The property "Oem/Hp/iLORBSUEnabled" on resource type Manager may not support PATCH of all values and may result in an HTTP 400 error with response of Type ExtendedError. Multiple properties may be included in a single HTTP PATCH operation as long as the request is properly formatted JSON. To address an array entry other than the first, insert nulls as placeholders on skipped array entries.

"Oem/Hp/iLOSelfTestResults[]/Notes"

This property is a member of [Manager](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(Manager-Resource-Type)#manager-resource-type)
Additional Information (if any) about the Self Test.
JSON type:
String

HTTP Operations

GET Rendered if supported by the implementation or omitted if not.

"Oem/Hp/iLOSelfTestResults[]/SelfTestName"

This property is a member of [Manager](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(Manager-Resource-Type)#manager-resource-type)
iLO Self Test Name.
JSON type:
String containing one of the following supported values: "CryptographicHardware" "Memory" "WebServerCryptography" "MiscCryptography" "UART" "NVRAMInterface" "NVRAMData" "NIC" "EmbeddedFlash/SDCard" "StaticRAM" "EEPROM" "I2C" "BootBlock" "ThreadInit" "Infrastructure" "HostRom" "SupportedHost" "EEPROMContent" "PowerManagementController" "CPLDPAL0" "CPLDPAL1" "CPLDPAL2" "CPLDPAL3" "CPLDPAL4" "CPLDPAL5"

HTTP Operations

GET Rendered if supported by the implementation or omitted if not.

"Oem/Hp/iLOSelfTestResults[]/Status"

This property is a member of [Manager](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(Manager-Resource-Type)#manager-resource-type)
Status of the Self Test.
JSON type:
String containing one of the following supported values: "NA" "OK" "Informational" "Degraded"

HTTP Operations

GET Rendered if supported by the implementation or omitted if not.

"Oem/Hp/links/FederationDispatch/extref"

This property is a member of [Manager](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(Manager-Resource-Type)#manager-resource-type)
The URI of an external resource.
JSON type:
String

HTTP Operations

GET Rendered if supported by the implementation or omitted if not.

"Oem/Hp/links/VSPLogLocation/extref"

This property is a member of [Manager](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(Manager-Resource-Type)#manager-resource-type)
The URI of an external resource.
JSON type:
String

HTTP Operations

GET Rendered if supported by the implementation or omitted if not.

"Redundancy/MaxNumSupported"

This property is a member of [Manager](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(Manager-Resource-Type)#manager-resource-type)
This is the maximum number of members allowable for this particular managers redundancy, including this manager.
JSON type:
Integer

HTTP Operations

GET Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.

"Redundancy/MemberId"

This property is a member of [Manager](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(Manager-Resource-Type)#manager-resource-type)
This is the identifier for the member within the collection.
JSON type:
String

HTTP Operations

GET Rendered if supported by the implementation or omitted if not.

"Redundancy/MinNumNeeded"

This property is a member of [Manager](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(Manager-Resource-Type)#manager-resource-type)
This is the minumum number of managers needed for this manager to be redundant.
JSON type:
Integer

HTTP Operations

GET Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.

"Redundancy/Mode"

This property is a member of [Manager](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(Manager-Resource-Type)#manager-resource-type)
This is the redundancy mode of the group.
JSON type:
String containing one of the following supported values: "Failover" "N+1" "LoadBalanced" "Sparing" "LimitedSparing"

HTTP Operations

GET Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.

"Redundancy/Status/Health"

This property is a member of [Manager](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(Manager-Resource-Type)#manager-resource-type)
This represents the health state of this resource in the absence of its dependent resources.
JSON type:
String containing one of the following supported values: "OK" "Warning" "Critical"

HTTP Operations

GET Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.

"Redundancy/Status/HealthRollUp"

This property is a member of [Manager](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(Manager-Resource-Type)#manager-resource-type)
This represents the overall health state from the view of this resource.
JSON type:
String containing one of the following supported values: "OK" "Warning" "Critical"

HTTP Operations

GET Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.

"Redundancy/Status/HealthRollup"

This property is a member of [Manager](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(Manager-Resource-Type)#manager-resource-type)
This represents the overall health state from the view of this resource.
JSON type:
String containing one of the following supported values: "OK" "Warning" "Critical"

HTTP Operations

GET Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.

"Redundancy/Status/State"

This property is a member of [Manager](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(Manager-Resource-Type)#manager-resource-type)
This indicates the known state of the resource, such as if it is enabled.
JSON type:
String containing one of the following supported values: "Enabled" "Disabled" "Offline" "InTest" "Starting" "Absent"

HTTP Operations

GET Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.

"SerialConsole/Enabled"

This property is a member of [Manager](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(Manager-Resource-Type)#manager-resource-type)
Indicates if the Serial Console service is enabled for this manager.
JSON type:
Boolean ('true' or 'false')

HTTP Operations

GET Rendered if supported by the implementation or omitted if not.
PATCH This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

PATCH Example

HTTP PATCH to resource with request JSON:

{"SerialConsole": {"Enabled": true}}

The property "SerialConsole/Enabled" on resource type Manager may not support PATCH of all values and may result in an HTTP 400 error with response of Type ExtendedError. Multiple properties may be included in a single HTTP PATCH operation as long as the request is properly formatted JSON. To address an array entry other than the first, insert nulls as placeholders on skipped array entries.

"SerialConsole/MaxConcurrentSessions"

This property is a member of [Manager](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(Manager-Resource-Type)#manager-resource-type)
This is the maximum number of Serial Console sessions, regardless of protocol, that this manager supports.
JSON type:
Integer greater than or equal to 0.

HTTP Operations

GET Rendered if supported by the implementation or omitted if not.

"SerialConsole/ServiceEnabled"

This property is a member of [Manager](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(Manager-Resource-Type)#manager-resource-type)
Indicates if the Command Shell service is enabled for this manager.
JSON type:
Boolean ('true' or 'false')

HTTP Operations

GET Rendered if supported by the implementation or omitted if not.
PATCH This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

PATCH Example

HTTP PATCH to resource with request JSON:

{"SerialConsole": {"ServiceEnabled": true}}

The property "SerialConsole/ServiceEnabled" on resource type Manager may not support PATCH of all values and may result in an HTTP 400 error with response of Type ExtendedError. Multiple properties may be included in a single HTTP PATCH operation as long as the request is properly formatted JSON. To address an array entry other than the first, insert nulls as placeholders on skipped array entries.

"Status/Health"

This property is a member of [Manager](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(Manager-Resource-Type)#manager-resource-type)
This represents the health state of this resource in the absence of its dependent resources.
JSON type:
String containing one of the following supported values: "OK" "Warning" "Critical"

HTTP Operations

GET Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.

"Status/HealthRollUp"

This property is a member of [Manager](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(Manager-Resource-Type)#manager-resource-type)
This represents the overall health state from the view of this resource.
JSON type:
String containing one of the following supported values: "OK" "Warning" "Critical"

HTTP Operations

GET Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.

"Status/HealthRollup"

This property is a member of [Manager](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(Manager-Resource-Type)#manager-resource-type)
This represents the overall health state from the view of this resource.
JSON type:
String containing one of the following supported values: "OK" "Warning" "Critical"

HTTP Operations

GET Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.

"Status/State"

This property is a member of [Manager](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(Manager-Resource-Type)#manager-resource-type)
This indicates the known state of the resource, such as if it is enabled.
JSON type:
String containing one of the following supported values: "Enabled" "Disabled" "Offline" "InTest" "Starting" "Absent"

HTTP Operations

GET Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.

"UUID"

This property is a member of [Manager](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(Manager-Resource-Type)#manager-resource-type)
This is a universally unique identifier that software (for example, HP SIM) uses to uniquely identify this manager. The UUID is assigned when the system is manufactured.
JSON type:
String

HTTP Operations

GET Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.

POST Action "Reset"

Resets iLO 4. iLO 4 will be unresponsive during the reset process and the client should expect to wait for up to a minute for functionality to be restored.

Example

HTTP POST to resource with request JSON:

{ "Action": "Reset"}

POST Action "ClearRestApiState"

Clears the persistent state of the REST API. Some portions of the API may not be available until after the server reboots.

Parameter "Target"

"Target" must be one of the following value(s):

"/Oem/Hp"

Example

HTTP POST to resource with request JSON:

{ "Action": "ClearRestApiState", "Target": "/Oem/Hp"}

POST Action "iLOFunctionality"

Specifies whether iLO functionality is available. The following settings are valid: Enabled (default)-The iLO network is available and communications with operating system drivers are active. Disabled-The iLO network and communications with operating system drivers are terminated when iLO Functionality is disabled. For ProLiant Gen8 servers only: To re-enable iLO functionality, disable iLO security with the system maintenance switch, and then use the iLO RBSU to set iLO Functionality to Enabled. For more information about using the system maintenance switch, see the Maintenance and Service Guide for your server model. For ProLiant Gen9 servers only: To re-enable iLO functionality, use the iLO 4 Configuration Utility (in the UEFI System Utilities) to set iLO Functionality to Enabled. For more information see the HP UEFI System Utilities User Guide. The action resets/reboots the manager. iLO functionality cannot be disabled on server blades.

The "iLOFunctionality" action disables iLO 4's accessibility via the network and resets iLO 4. This should be used with caution as it will render iLO unable to respond to further network operations (including REST operations) until iLO 4 is re-enabled using the RBSU menu.

Parameter "Target"

"Target" must be one of the following value(s):

"/Oem/Hp"

Example

HTTP POST to resource with request JSON:

{ "Action": "iLOFunctionality", "Target": "/Oem/Hp"}

POST Action "ResetToFactoryDefaults"

Resets the iLO to Factory Defaults.

ResetToFactoryDefaults performs the following:

  • Removes Language Packs
  • Erases all customized settings
  • Removes user accounts and restores iLO 4's default username and password
  • Removes all certificates and user licenses
  • Restores iLO 4 network settings to defaults
  • Clears event logs
  • Resets iLO 4 upon completion

Parameter "Target"

"Target" must be one of the following value(s):

"/Oem/Hp"

Parameter "ResetType"

"ResetType" must be one of the following value(s):

"Default"
Reset iLO to defaults, clear logs and reboot iLO.

Example

HTTP POST to resource with request JSON:

{ "Action": "ResetToFactoryDefaults", "Target": "/Oem/Hp", "ResetType": "Default"}
⚠️ **GitHub.com Fallback** ⚠️