Skip to content

Serviceroot resource definitions of iLO 5 v3.06

For each data type provided by the HPE ilO Redfish service, find below its description including the list of possible instances (URIs), links to related other resources, described properties and many other details.

Refer to the data types and collection section for more information on Redfish data types and collections.

ServiceRoot

@odata.type: "#ServiceRoot.v1_5_1.ServiceRoot"

The ServiceRoot resource describes the Redfish API service root.

Resource Instances

UriHTTP Allow
/redfish/v1/GET
Link NameDestination type
RegistriesCollection of MessageRegistryFile
ManagersCollection of Manager
AccountServiceAccountService
JsonSchemasCollection of JsonSchemaFile
UpdateServiceUpdateService
Oem/Hpe/Links/ResourceDirectoryHpeiLOResourceDirectory
SessionServiceSessionService
EventServiceEventService
ChassisCollection of Chassis
SystemsCollection of ComputerSystem
Links/SessionsCollection of Session

AccountService

The URI to this account service resource. AccountService is a link ("@odata.id": URI) to another resource.

CertificateService

The URI to the certificate service resource. CertificateService is a link ("@odata.id": URI) to another resource.

Chassis

The URI to this chassis resource. Chassis is a link ("@odata.id": URI) to another resource.

EventService

The URI to the event service resource. EventService is a link ("@odata.id": URI) to another resource.

Fabrics

The URI to fabric collection resource. Fabrics is a link ("@odata.id": URI) to another resource.

JsonSchemas

The URI to this registries resource. JsonSchemas is a link ("@odata.id": URI) to another resource.

Managers

The URI to this managers resource. Managers is a link ("@odata.id": URI) to another resource.

Oem.Hpe.CACLoginUri

Member of ServiceRoot.v1_5_1.ServiceRoot

DescriptionURI for the CAC based authentication.
Typestring
Read OnlyTrue
Formaturi-reference

Oem.Hpe.DebugCode

Member of ServiceRoot.v1_5_1.ServiceRoot

DescriptionSpecifies whether the iLO has debug firmware flashed.
Typeboolean
Read OnlyTrue

Oem.Hpe.DevSystem

Member of ServiceRoot.v1_5_1.ServiceRoot

DescriptionSpecifies whether the test key is enabled.
Typeboolean
Read OnlyTrue

Oem.Hpe.Manager (array)

Member of ServiceRoot.v1_5_1.ServiceRoot

Manager is an array containing elements of:

Manager[{item}].Blade Manager[{item}].Blade.BayNumber Member of ServiceRoot.v1_5_1.ServiceRoot

DescriptionSpecifies the location of the blade in the enclosure.
Typestring
Read OnlyTrue

Manager[{item}].Blade.EnclosureName Member of ServiceRoot.v1_5_1.ServiceRoot

DescriptionSpecifies the name of the enclosure in which the blade is present.
Typestring
Read OnlyTrue

Manager[{item}].Blade.RackName Member of ServiceRoot.v1_5_1.ServiceRoot

DescriptionSpecifies the name of the rack in which the enclosure is present.
Typestring
Read OnlyTrue

Manager[{item}].DefaultLanguage Member of ServiceRoot.v1_5_1.ServiceRoot

DescriptionDefault language used for the Web interface.
Typestring
Read OnlyTrue

Manager[{item}].ExternalManager Member of ServiceRoot.v1_5_1.ServiceRoot

DescriptionReports the current external manager of the system.
Typestring or null
Read OnlyTrue

Manager[{item}].FQDN Member of ServiceRoot.v1_5_1.ServiceRoot

DescriptionFully qualified domain name of the management processor.
Typestring or null
Read OnlyTrue

Manager[{item}].HostName Member of ServiceRoot.v1_5_1.ServiceRoot

DescriptionThe name of management processor.
Typestring or null
Read OnlyTrue

Manager[{item}].IPManager Manager[{item}].Languages (array) Member of ServiceRoot.v1_5_1.ServiceRoot

Languages is an array containing elements of:

Languages[{item}].Language Member of ServiceRoot.v1_5_1.ServiceRoot

DescriptionSpecifies one of the languages supported by the management processor.
Typestring
Read OnlyTrue

Languages[{item}].TranslationName Member of ServiceRoot.v1_5_1.ServiceRoot

DescriptionSpecifies one of the languages supported by the management processor.
Typestring
Read OnlyTrue

Languages[{item}].Version Member of ServiceRoot.v1_5_1.ServiceRoot

DescriptionSpecifies the version of the management processor in the respective language.
Typestring
Read OnlyTrue

Manager[{item}].ManagerFirmwareVersion Member of ServiceRoot.v1_5_1.ServiceRoot

DescriptionThe major and minor management processor version numbers.
Typestring
Read OnlyTrue

Manager[{item}].ManagerFirmwareVersionPass Member of ServiceRoot.v1_5_1.ServiceRoot

DescriptionThe build or pass number of the management processor version.
Typestring
Read OnlyTrue

Manager[{item}].ManagerType Member of ServiceRoot.v1_5_1.ServiceRoot

DescriptionThe type of the service manager.
Typestring
Read OnlyTrue

Manager[{item}].SelfTestErrors (array) Member of ServiceRoot.v1_5_1.ServiceRoot

SelfTestErrors is an array containing elements of:

SelfTestErrors[{item}].SelfTestName Member of ServiceRoot.v1_5_1.ServiceRoot

DescriptioniLO Self Test Name.
Typestring
Read OnlyTrue

Manager[{item}].Status Member of ServiceRoot.v1_5_1.ServiceRoot See the Redfish standard schema and specification for information on common Status object.

Oem.Hpe.Moniker

Oem.Hpe.Moniker.ADVLIC Member of ServiceRoot.v1_5_1.ServiceRoot

DescriptionOptional Licensed functionality tier name.
Typestring
Read OnlyTrue

Oem.Hpe.Moniker.BMC Member of ServiceRoot.v1_5_1.ServiceRoot

DescriptionGeneric abbreviation for the management processor.
Typestring
Read OnlyTrue

Oem.Hpe.Moniker.BSYS Member of ServiceRoot.v1_5_1.ServiceRoot

DescriptionProduct category name.
Typestring
Read OnlyTrue

Oem.Hpe.Moniker.CLASS Member of ServiceRoot.v1_5_1.ServiceRoot

DescriptionManagement processor product category.
Typestring
Read OnlyTrue

Oem.Hpe.Moniker.FEDGRP Member of ServiceRoot.v1_5_1.ServiceRoot

DescriptionDefault federation group name.
Typestring
Read OnlyTrue

Oem.Hpe.Moniker.IPROV Member of ServiceRoot.v1_5_1.ServiceRoot

DescriptionProduct name for provisioning and deployment suite.
Typestring
Read OnlyTrue

Oem.Hpe.Moniker.PRODABR Member of ServiceRoot.v1_5_1.ServiceRoot

DescriptionAbbreviated product name.
Typestring
Read OnlyTrue

Oem.Hpe.Moniker.PRODFAM Member of ServiceRoot.v1_5_1.ServiceRoot

DescriptionFull product family.
Typestring
Read OnlyTrue

Oem.Hpe.Moniker.PRODGEN Member of ServiceRoot.v1_5_1.ServiceRoot

DescriptionAbbreviated product name and generation.
Typestring
Read OnlyTrue

Oem.Hpe.Moniker.PRODNAM Member of ServiceRoot.v1_5_1.ServiceRoot

DescriptionFull product name.
Typestring
Read OnlyTrue

Oem.Hpe.Moniker.PRODTAG Member of ServiceRoot.v1_5_1.ServiceRoot

DescriptionBranded, abbreviated product name.
Typestring
Read OnlyTrue

Oem.Hpe.Moniker.STDLIC Member of ServiceRoot.v1_5_1.ServiceRoot

DescriptionBase licensed functionality tier name.
Typestring
Read OnlyTrue

Oem.Hpe.Moniker.SUMABR Member of ServiceRoot.v1_5_1.ServiceRoot

DescriptionAcronym for update deployment suite.
Typestring
Read OnlyTrue

Oem.Hpe.Moniker.SUMGR Member of ServiceRoot.v1_5_1.ServiceRoot

DescriptionProduct name for update deployment suite.
Typestring
Read OnlyTrue

Oem.Hpe.Moniker.SYSFAM Member of ServiceRoot.v1_5_1.ServiceRoot

DescriptionHost system product family.
Typestring
Read OnlyTrue

Oem.Hpe.Moniker.SYSMGMT Member of ServiceRoot.v1_5_1.ServiceRoot

DescriptionSystem Management Experience.
Typestring
Read OnlyTrue

Oem.Hpe.Moniker.VENDABR Member of ServiceRoot.v1_5_1.ServiceRoot

DescriptionAbbreviated vendor name (like stock ticker).
Typestring
Read OnlyTrue

Oem.Hpe.Moniker.VENDNAM Member of ServiceRoot.v1_5_1.ServiceRoot

DescriptionFull vendor name.
Typestring
Read OnlyTrue

Oem.Hpe.Moniker.VNIC Member of ServiceRoot.v1_5_1.ServiceRoot

DescriptionVirtual USB network interface to BMC name.
Typestring
Read OnlyTrue

Oem.Hpe.Moniker.WWW Member of ServiceRoot.v1_5_1.ServiceRoot

DescriptionTop level public internet vendor URI.
Typestring
Read OnlyTrue

Oem.Hpe.Moniker.WWWAHSV Member of ServiceRoot.v1_5_1.ServiceRoot

DescriptionPublic internet vendor URI for Active Health viewer.
Typestring
Read OnlyTrue

Oem.Hpe.Moniker.WWWBMC Member of ServiceRoot.v1_5_1.ServiceRoot

DescriptionPublic internet vendor URI for the management processor.
Typestring
Read OnlyTrue

Oem.Hpe.Moniker.WWWDOC Member of ServiceRoot.v1_5_1.ServiceRoot

DescriptionPublic internet vendor URI for the management processor documentation / manuals.
Typestring
Read OnlyTrue

Oem.Hpe.Moniker.WWWERS Member of ServiceRoot.v1_5_1.ServiceRoot

DescriptionPublic internet vendor URI for Embedded Remote Support.
Typestring
Read OnlyTrue

Oem.Hpe.Moniker.WWWGLIS Member of ServiceRoot.v1_5_1.ServiceRoot

DescriptionPublic internet vendor URI for management processor licensing infrastructure.
Typestring
Read OnlyTrue

Oem.Hpe.Moniker.WWWINFOSIGHT Member of ServiceRoot.v1_5_1.ServiceRoot

DescriptionPublic internet resource for active health.
Typestring
Read OnlyTrue

Oem.Hpe.Moniker.WWWIOL Member of ServiceRoot.v1_5_1.ServiceRoot

DescriptionPublic internet vendor URI for Online Insight service.
Typestring
Read OnlyTrue

Oem.Hpe.Moniker.WWWLIC Member of ServiceRoot.v1_5_1.ServiceRoot

DescriptionPublic internet vendor URI for the management processor.
Typestring
Read OnlyTrue

Oem.Hpe.Moniker.WWWLML Member of ServiceRoot.v1_5_1.ServiceRoot

DescriptionPublic internet vendor URI for Learn More Links.
Typestring
Read OnlyTrue

Oem.Hpe.Moniker.WWWPASS Member of ServiceRoot.v1_5_1.ServiceRoot

DescriptionPublic internet vendor URI for accessing support account.
Typestring
Read OnlyTrue

Oem.Hpe.Moniker.WWWPRV Member of ServiceRoot.v1_5_1.ServiceRoot

DescriptionPublic internet vendor URI for privacy policy statement.
Typestring
Read OnlyTrue

Oem.Hpe.Moniker.WWWQSPEC Member of ServiceRoot.v1_5_1.ServiceRoot

DescriptionPublic internet vendor URI for Quick Specs.
Typestring
Read OnlyTrue

Oem.Hpe.Moniker.WWWRESTDOC Member of ServiceRoot.v1_5_1.ServiceRoot

DescriptionPublic internet vendor URI for REST API documentation.
Typestring
Read OnlyTrue

Oem.Hpe.Moniker.WWWSUP Member of ServiceRoot.v1_5_1.ServiceRoot

DescriptionPublic internet vendor URI for management processor and product support.
Typestring
Read OnlyTrue

Oem.Hpe.Moniker.WWWSWLIC Member of ServiceRoot.v1_5_1.ServiceRoot

DescriptionPublic internet vendor URI for vendor software licensing.
Typestring
Read OnlyTrue

Oem.Hpe.PreProd

Member of ServiceRoot.v1_5_1.ServiceRoot

DescriptionSpecifies whether the system identifies as pre-production.
Typeboolean
Read OnlyTrue

Oem.Hpe.Sessions

Oem.Hpe.Sessions.CertCommonName Member of ServiceRoot.v1_5_1.ServiceRoot

DescriptionThe name of the management processor as it appears in the digital certificate when a secure web GUI session is established to the management processor.
Typestring
Read OnlyTrue

Oem.Hpe.Sessions.CertificateLoginEnabled Member of ServiceRoot.v1_5_1.ServiceRoot

DescriptionSpecifies whether Certificate login is enabled.
Typeboolean
Read OnlyTrue

Oem.Hpe.Sessions.KerberosEnabled Member of ServiceRoot.v1_5_1.ServiceRoot

DescriptionSpecifies whether Kerberos login is enabled.
Typeboolean
Read OnlyTrue

Oem.Hpe.Sessions.LDAPAuthLicenced Member of ServiceRoot.v1_5_1.ServiceRoot

DescriptionSpecifies whether a valid license is installed for LDAP use.
Typeboolean
Read OnlyTrue

Oem.Hpe.Sessions.LDAPEnabled Member of ServiceRoot.v1_5_1.ServiceRoot

DescriptionSpecifies whether LDAP login is enabled.
Typeboolean
Read OnlyTrue

Oem.Hpe.Sessions.LocalLoginEnabled Member of ServiceRoot.v1_5_1.ServiceRoot

DescriptionSpecifies whether local users can log in.
Typeboolean
Read OnlyTrue

Oem.Hpe.Sessions.LoginFailureDelay Member of ServiceRoot.v1_5_1.ServiceRoot

DescriptionThe delay (seconds) when a management processor login attempt has failed.
Typeinteger
Read OnlyTrue

Oem.Hpe.Sessions.LoginHint Oem.Hpe.Sessions.LoginHint.Hint Member of ServiceRoot.v1_5_1.ServiceRoot

DescriptionThe information on how to log in to the management processor.
Typestring
Read OnlyTrue

Oem.Hpe.Sessions.LoginHint.HintPOSTData Oem.Hpe.Sessions.LoginHint.HintPOSTData.Password Member of ServiceRoot.v1_5_1.ServiceRoot

DescriptionThe password for logging in to the management processor.
Typestring
Read OnlyTrue

Oem.Hpe.Sessions.LoginHint.HintPOSTData.UserName Member of ServiceRoot.v1_5_1.ServiceRoot

DescriptionThe user name for logging in to the management processor.
Typestring
Read OnlyTrue

Oem.Hpe.Sessions.SecurityMessage Member of ServiceRoot.v1_5_1.ServiceRoot

DescriptionThe login security banner message that is displayed on the management processor Login page.
Typestring
Read OnlyTrue

Oem.Hpe.Sessions.SecurityOverride Member of ServiceRoot.v1_5_1.ServiceRoot

DescriptionSpecifies whether the security override switch is enabled.
Typeboolean
Read OnlyTrue

Oem.Hpe.Sessions.ServerName Member of ServiceRoot.v1_5_1.ServiceRoot

DescriptionThe name of the server that this management processor is managing.
Typestring
Read OnlyTrue

Oem.Hpe.System (array)

Member of ServiceRoot.v1_5_1.ServiceRoot

System is an array containing elements of:

System[{item}].Status Member of ServiceRoot.v1_5_1.ServiceRoot See the Redfish standard schema and specification for information on common Status object.

Oem.Hpe.Time

Member of ServiceRoot.v1_5_1.ServiceRoot

DescriptionThe current Redfish service time.
Typestring or null
Read OnlyTrue
Formatdate-time

Product

Member of ServiceRoot.v1_5_1.ServiceRoot

DescriptionThe product associated with this Redfish service.
Typestring or null
Read OnlyTrue

ProtocolFeaturesSupported

ProtocolFeaturesSupported.ExpandQuery ProtocolFeaturesSupported.ExpandQuery.ExpandAll Member of ServiceRoot.v1_5_1.ServiceRoot

DescriptionThis indicates whether the expand support of asterisk (expand all entries) is supported.
Typeboolean
Read OnlyTrue

ProtocolFeaturesSupported.ExpandQuery.Levels Member of ServiceRoot.v1_5_1.ServiceRoot

DescriptionThis indicates whether the expand support of the $levels qualifier is supported by the service.
Typeboolean
Read OnlyTrue

ProtocolFeaturesSupported.ExpandQuery.MaxLevels Member of ServiceRoot.v1_5_1.ServiceRoot

DescriptionThis indicates the maximum number value of the $levels qualifier in expand operations.
Typenumber
Read OnlyTrue

ProtocolFeaturesSupported.ExpandQuery.NoLinks Member of ServiceRoot.v1_5_1.ServiceRoot

DescriptionThis indicates whether the expand support of period (expand only entries not in the Links section) is supported.
Typeboolean
Read OnlyTrue

ProtocolFeaturesSupported.FilterQuery Member of ServiceRoot.v1_5_1.ServiceRoot

DescriptionThis indicates whether the filter query parameter is supported.
Typeboolean
Read OnlyTrue

ProtocolFeaturesSupported.OnlyMemberQuery Member of ServiceRoot.v1_5_1.ServiceRoot

DescriptionThis indicates whether Management Processor supports the only query option.
Typeboolean
Read OnlyTrue

ProtocolFeaturesSupported.SelectQuery Member of ServiceRoot.v1_5_1.ServiceRoot

DescriptionThis indicates whether the select query parameter is supported.
Typeboolean
Read OnlyTrue

RedfishVersion

Member of ServiceRoot.v1_5_1.ServiceRoot

DescriptionThe version of the Redfish service
Typestring
Read OnlyTrue

Registries

The URI to this registries resource. Registries is a link ("@odata.id": URI) to another resource.

SessionService

The URI to this sessions service resource. SessionService is a link ("@odata.id": URI) to another resource.

Systems

The URI to this systems resource. Systems is a link ("@odata.id": URI) to another resource.

Tasks

The URI to this tasks service resource. Tasks is a link ("@odata.id": URI) to another resource.

TelemetryService

The URI to the TelemetryService resource. TelemetryService is a link ("@odata.id": URI) to another resource.

UUID

Member of ServiceRoot.v1_5_1.ServiceRoot

DescriptionUnique 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.
Typestring or null
Read OnlyTrue

UpdateService

The URI to this UpdateService resource. UpdateService is a link ("@odata.id": URI) to another resource.

Vendor

Member of ServiceRoot.v1_5_1.ServiceRoot

DescriptionThe vendor of the product associated with this Redfish service.
Typestring or null
Read OnlyTrue