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

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

"ServiceRoot" Resource Type

Resource Instances

/rest/v1

See Resource Map for more details.

This object represents the HP RESTful API root service.

"ServiceRoot" defines the following properties:

"Oem/Hp/Manager[]/Blade/BayNumber"

This property is a member of [ServiceRoot](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(ServiceRoot-Resource-Type)#serviceroot-resource-type)
Specifies the location of the blade in the enclosure.
JSON type:
String

HTTP Operations

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

"Oem/Hp/Manager[]/Blade/EnclosureName"

This property is a member of [ServiceRoot](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(ServiceRoot-Resource-Type)#serviceroot-resource-type)
Specifies the name of the enclosure in which the blade is present.
JSON type:
String

HTTP Operations

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

"Oem/Hp/Manager[]/Blade/RackName"

This property is a member of [ServiceRoot](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(ServiceRoot-Resource-Type)#serviceroot-resource-type)
Specifies the name of the rack in which the enclosure is present.
JSON type:
String

HTTP Operations

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

"Oem/Hp/Manager[]/DefaultLanguage"

This property is a member of [ServiceRoot](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(ServiceRoot-Resource-Type)#serviceroot-resource-type)
Default language used for the Web interface.
JSON type:
String

HTTP Operations

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

"Oem/Hp/Manager[]/FQDN"

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

HTTP Operations

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

"Oem/Hp/Manager[]/HostName"

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

HTTP Operations

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

"Oem/Hp/Manager[]/IPManager"

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

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/Manager[]/Languages[]/Language"

This property is a member of [ServiceRoot](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(ServiceRoot-Resource-Type)#serviceroot-resource-type)
Specifies one of the languages supported by the management processor.
JSON type:
String

HTTP Operations

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

"Oem/Hp/Manager[]/Languages[]/TranslationName"

This property is a member of [ServiceRoot](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(ServiceRoot-Resource-Type)#serviceroot-resource-type)
Specifies one of the languages supported by the management processor.
JSON type:
String

HTTP Operations

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

"Oem/Hp/Manager[]/Languages[]/Version"

This property is a member of [ServiceRoot](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(ServiceRoot-Resource-Type)#serviceroot-resource-type)
Specifies the version of the management processor in the respective language.
JSON type:
String

HTTP Operations

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

"Oem/Hp/Manager[]/ManagerFirmwareVersion"

This property is a member of [ServiceRoot](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(ServiceRoot-Resource-Type)#serviceroot-resource-type)
The major and minor management processor version numbers.
JSON type:
String

HTTP Operations

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

"Oem/Hp/Manager[]/ManagerFirmwareVersionPass"

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

HTTP Operations

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

"Oem/Hp/Manager[]/ManagerType"

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

HTTP Operations

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

"Oem/Hp/Sessions/CertCommonName"

This property is a member of [ServiceRoot](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(ServiceRoot-Resource-Type)#serviceroot-resource-type)
The name of the management processor as it appears in the digital certificate when a secure web GUI session is established to the management processor.
JSON type:
String

HTTP Operations

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

"Oem/Hp/Sessions/KerberosEnabled"

This property is a member of [ServiceRoot](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(ServiceRoot-Resource-Type)#serviceroot-resource-type)
Specifies whether Kerberos login is enabled.
JSON type:
Boolean ('true' or 'false')

HTTP Operations

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

"Oem/Hp/Sessions/LDAPAuthLicenced"

This property is a member of [ServiceRoot](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(ServiceRoot-Resource-Type)#serviceroot-resource-type)
Specifies whether a valid license is installed for LDAP use.
JSON type:
Boolean ('true' or 'false')

HTTP Operations

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

"Oem/Hp/Sessions/LDAPEnabled"

This property is a member of [ServiceRoot](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(ServiceRoot-Resource-Type)#serviceroot-resource-type)
Specifies whether LDAP login is enabled.
JSON type:
Boolean ('true' or 'false')

HTTP Operations

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

"Oem/Hp/Sessions/LocalLoginEnabled"

This property is a member of [ServiceRoot](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(ServiceRoot-Resource-Type)#serviceroot-resource-type)
Specifies whether local users can log in.
JSON type:
Boolean ('true' or 'false')

HTTP Operations

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

"Oem/Hp/Sessions/LoginFailureDelay"

This property is a member of [ServiceRoot](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(ServiceRoot-Resource-Type)#serviceroot-resource-type)
The delay (seconds) when a management processor login attempt has failed.
JSON type:
Integer greater than or equal to 0.

HTTP Operations

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

"Oem/Hp/Sessions/LoginHint/Hint"

This property is a member of [ServiceRoot](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(ServiceRoot-Resource-Type)#serviceroot-resource-type)
The information on how to log in to the management processor.
JSON type:
String

HTTP Operations

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

"Oem/Hp/Sessions/LoginHint/HintPOSTData/Password"

This property is a member of [ServiceRoot](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(ServiceRoot-Resource-Type)#serviceroot-resource-type)
The password for logging in to the management processor.
JSON type:
String

HTTP Operations

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

"Oem/Hp/Sessions/LoginHint/HintPOSTData/UserName"

This property is a member of [ServiceRoot](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(ServiceRoot-Resource-Type)#serviceroot-resource-type)
The user name for logging in to the management processor.
JSON type:
String

HTTP Operations

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

"Oem/Hp/Sessions/SecurityMessage"

This property is a member of [ServiceRoot](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(ServiceRoot-Resource-Type)#serviceroot-resource-type)
The login security banner message that is displayed on the management processor Login page.
JSON type:
String

HTTP Operations

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

"Oem/Hp/Sessions/SecurityOverride"

This property is a member of [ServiceRoot](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(ServiceRoot-Resource-Type)#serviceroot-resource-type)
Specifies whether the security override switch is enabled.
JSON type:
Boolean ('true' or 'false')

HTTP Operations

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

"Oem/Hp/Sessions/ServerName"

This property is a member of [ServiceRoot](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(ServiceRoot-Resource-Type)#serviceroot-resource-type)
The name of the server that this management processor is managing.
JSON type:
String

HTTP Operations

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

"RedfishVersion"

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

HTTP Operations

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

"ServiceVersion"

This property is a member of [ServiceRoot](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(ServiceRoot-Resource-Type)#serviceroot-resource-type)
The web service version. This is different from the version of the data model.
JSON type:
String

HTTP Operations

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

"Time"

This property is a member of [ServiceRoot](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(ServiceRoot-Resource-Type)#serviceroot-resource-type)
The current web service time.
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.

"UUID"

This property is a member of [ServiceRoot](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(ServiceRoot-Resource-Type)#serviceroot-resource-type)
Unique identifier for a service instance. This value should be an exact match of the UUID value returned in a 200OK from an SSDP M-SEARCH request during discovery.
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.
⚠️ **GitHub.com Fallback** ⚠️