Skip to content

Instantly share code, notes, and snippets.

@karatechops

karatechops/iLO5_redfish_reference_OAS3.yml

Created December 10, 2019 18:33
Show Gist options
  • Star 0 You must be signed in to star a gist
  • Fork 0 You must be signed in to fork a gist
  • Save karatechops/0c3b0e3fea000d56df7dc6ec70feac9a to your computer and use it in GitHub Desktop.
Save karatechops/0c3b0e3fea000d56df7dc6ec70feac9a to your computer and use it in GitHub Desktop.
Download ZIP
Raw
iLO5_redfish_reference_OAS3.yml
This file has been truncated, but you can view the full file.
servers:
- url: '/redfish/v1'
components:
schemas:
AccountService:
description: This is the schema definition for the Account service. It represents
the properties for this service and has links to the list of accounts.
properties:
'@odata.context':
example: /$metadata#AccountService.AccountService
format: uri
readOnly: true
type: string
x-longDescription: The value of this property shall be the context URL that
describes the resource according to OData-Protocol and shall be of the
form defined in the SPMF specification.
'@odata.etag':
example: W/\DF31857A\""
readOnly: true
type: string
x-longDescription: The value of this property is the Etag of the resource.
'@odata.id':
example: /AccountService/
format: uri
readOnly: true
type: string
x-longDescription: The value of this property shall be the unique identifier
for the resource and it shall be of the form defined in the SPMF specification.
'@odata.type':
example: '#AccountService.v1_3_0.AccountService'
readOnly: true
type: string
x-longDescription: The value of this property shall be an absolute URL that
specifies the type of the resource and it shall be of the form defined
in the SPMF specification.
AccountLockoutCounterResetAfter:
description: The interval of time in seconds between the last failed login
attempt and reset of the lockout threshold counter. This value must be
less than or equal to AccountLockoutDuration. Reset sets the counter to
zero.
readOnly: true
type: number
x-added: iLO 5 1.40
AccountLockoutDuration:
description: The time in seconds an account is locked out. The value must
be greater than or equal to the value of the AccountLockoutCounterResetAfter
property. If set to 0, no lockout occurs.
nullable: true
readOnly: false
type: number
x-added: iLO 5 1.40
AccountLockoutThreshold:
description: The number of failed login attempts allowed before a user account
is locked for a specified duration. A value of 0 means it is never locked.
nullable: true
readOnly: false
type: number
x-added: iLO 5 1.40
Accounts:
description: This property references a resource of type Collection with
a MemberType of ManagerAccount.
properties:
'@odata.id':
example: /AccountService/Accounts/
format: uri
readOnly: true
type: string
x-longDescription: The value of this property shall be the unique identifier
for the resource and it shall be of the form defined in the SPMF specification.
readOnly: true
type: object
x-added: iLO 5 1.10
ActiveDirectory:
description: A remote service that can provide accounts for this manager
to utilize for authentication.
properties:
AccountProviderType:
description: 'This property contains the type of external account provider
this resource references.
Defined values are:
* `ActiveDirectoryService`: An external Active Directory Service.
'
enum:
- ActiveDirectoryService
example: ActiveDirectoryService
readOnly: false
type: string
x-added: iLO 5 1.40
Authentication:
description: Contains the authentication information for the external
service.
properties:
AuthenticationType:
description: 'This property contains the type of authentication
used to connect to the external account provider.
Defined values are:
* `UsernameAndPassword`: Username and password combination.
'
enum:
- UsernameAndPassword
example: UsernameAndPassword
readOnly: false
type: string
x-added: iLO 5 1.40
Password:
description: This property is used with a PATCH or PUT to write
the password for the account service. This property is null on
a GET.
example: 'null'
nullable: true
readOnly: false
type: string
x-added: iLO 5 1.40
Username:
description: This property contains the distinguished name for the
account service.
example: ''
nullable: true
readOnly: false
type: string
x-added: iLO 5 1.40
readOnly: false
type: object
x-added: iLO 5 1.40
RemoteRoleMapping:
description: This property contains a collection of the mapping rules
to convert the external account providers account information to the
local Redfish Role.
items:
description: Contains mapping rules to convert the external account
providers account information to the local Redfish Role.
properties:
LocalRole:
description: The name of the local role in which to map the remote
user or group.
example: dirgroupb3d8954f6ebbe735764e9f7c
nullable: true
readOnly: false
type: string
x-added: iLO 5 1.40
RemoteGroup:
description: This property is the name of the remote group (or
in the case of a Redfish Service, remote role) that will be
mapped to the local role referenced by this entity.
example: Administrators
nullable: true
readOnly: false
type: string
x-added: iLO 5 1.40
readOnly: false
type: object
readOnly: false
type: array
x-added: iLO 5 1.40
ServiceAddresses:
description: This property contains the addresses of the user account
providers this resource references. The format of this field depends
on the Type.
items:
nullable: true
type: string
readOnly: false
type: array
x-added: iLO 5 1.40
ServiceEnabled:
description: This indicates whether this service is enabled.
example: 'false'
nullable: true
readOnly: false
type: boolean
x-added: iLO 5 1.40
readOnly: false
type: object
x-added: iLO 5 1.40
AuthFailureLoggingThreshold:
description: The number of authorization failures allowed before the failure
attempt is logged to the manager log.
readOnly: false
type: number
Description:
description: Provides a description of this resource and is used for commonality in
the schema definitions.
example: iLO User Accounts
nullable: true
readOnly: true
type: string
x-longDescription: This object represents the Description property. All
values for resources described by this schema shall comply to the requirements
as described in the Redfish specification.
Id:
description: Uniquely identifies the resource within the collection of like
resources.
example: AccountService
readOnly: true
type: string
x-added: iLO 5 1.10
x-longDescription: This property represents an identifier for the resource. All
values for resources described by this schema shall comply to the requirements
as described in the Redfish specification.
LDAP:
description: A remote service that can provide accounts for this manager
to utilize for authentication.
properties:
AccountProviderType:
description: 'This property contains the type of external account provider
this resource references.
Defined values are:
* `ActiveDirectoryService`: An external Active Directory Service.
* `LDAPService`: A generic external LDAP Service.
'
enum:
- ActiveDirectoryService
- LDAPService
example: ActiveDirectoryService
readOnly: false
type: string
x-added: iLO 5 1.40
Authentication:
description: Contains the authentication information for the external
service.
properties:
AuthenticationType:
description: 'This property contains the type of authentication
used to connect to the external account provider.
Defined values are:
* `UsernameAndPassword`: Username and password combination.
'
enum:
- UsernameAndPassword
example: UsernameAndPassword
readOnly: false
type: string
x-added: iLO 5 1.40
Password:
description: This property is used with a PATCH or PUT to write
the password for the account service. This property is null on
a GET.
example: 'null'
nullable: true
readOnly: false
type: string
x-added: iLO 5 1.40
Username:
description: This property contains the distinguished name for the
account service.
example: ''
nullable: true
readOnly: false
type: string
x-added: iLO 5 1.40
readOnly: false
type: object
x-added: iLO 5 1.40
LDAPService:
description: Contains settings for parsing a generic LDAP service.
properties:
SearchSettings:
description: Contains settings for searching a generic LDAP service.
properties:
BaseDistinguishedNames:
description: The base distinguished names to use when searching
the LDAP service.
items:
nullable: true
type: string
readOnly: false
type: array
x-added: iLO 5 1.40
readOnly: false
type: object
x-added: iLO 5 1.40
readOnly: false
type: object
x-added: iLO 5 1.40
RemoteRoleMapping:
description: This property contains a collection of the mapping rules
to convert the external account providers account information to the
local Redfish Role.
items:
description: Contains mapping rules to convert the external account
providers account information to the local Redfish Role.
properties:
LocalRole:
description: The name of the local role in which to map the remote
user or group.
example: dirgroupb3d8954f6ebbe735764e9f7c
nullable: true
readOnly: false
type: string
x-added: iLO 5 1.40
RemoteGroup:
description: This property is the name of the remote group (or
in the case of a Redfish Service, remote role) that will be
mapped to the local role referenced by this entity.
example: Administrators
nullable: true
readOnly: false
type: string
x-added: iLO 5 1.40
readOnly: false
type: object
readOnly: false
type: array
x-added: iLO 5 1.40
ServiceAddresses:
description: This property contains the addresses of the user account
providers this resource references. The format of this field depends
on the Type.
items:
nullable: true
type: string
readOnly: false
type: array
x-added: iLO 5 1.40
ServiceEnabled:
description: This indicates whether this service is enabled.
example: 'false'
nullable: true
readOnly: false
type: boolean
x-added: iLO 5 1.40
readOnly: false
type: object
x-added: iLO 5 1.40
LocalAccountAuth:
description: 'Controls when this service will use the accounts defined withing
this AccountService as part of authentication.
Defined values are:
* `Enabled`: Authentication via accounts defined in this AccountService
is enabled.
* `Disabled`: Authentication via accounts defined in this AccountService
is disabled.
'
enum:
- Enabled
- Disabled
example: Enabled
readOnly: false
type: string
x-added: iLO 5 1.40
MaxPasswordLength:
description: The maximum password length for this service.
readOnly: true
type: number
x-added: iLO 5 1.40
MinPasswordLength:
description: The minimum password length for this service.
readOnly: true
type: number
x-added: iLO 5 1.40
Name:
description: The name of the resource or array element.
example: Account Service
readOnly: true
type: string
x-added: iLO 5 1.10
Oem:
properties:
Hpe:
properties:
'@odata.context':
format: uri
readOnly: true
type: string
x-longDescription: The value of this property shall be the context
URL that describes the resource according to OData-Protocol and
shall be of the form defined in the SPMF specification.
'@odata.etag':
readOnly: true
type: string
x-longDescription: The value of this property is the Etag of the
resource.
'@odata.id':
format: uri
readOnly: true
type: string
x-longDescription: The value of this property shall be the unique
identifier for the resource and it shall be of the form defined
in the SPMF specification.
'@odata.type':
readOnly: true
type: string
x-longDescription: The value of this property shall be an absolute
URL that specifies the type of the resource and it shall be of
the form defined in the SPMF specification.
Actions:
properties:
'#HpeiLOAccountService.ImportKerberosKeytab':
properties:
ImportUri@Redfish.AllowableValues:
description: The supported values for the ImportUri parameter.
type: string
x-longDescription: The supported values for the ImportUri
parameter.
target:
description: Link to invoke action
type: string
title:
description: Friendly action name
type: string
type: object
type: object
AuthFailureDelayTimeSeconds:
description: 'The time in seconds to delay for each failure after
AuthFailuresBeforeDelay authentication attempts have failed. Values
of 2, 5, 10, and 30 seconds are valid.
Defined values are:
* `2`
* `5`
* `10`
* `30`
'
enum:
- 2
- 5
- 10
- 30
readOnly: false
type: integer
AuthFailureLoggingThreshold:
description: 'This property enables you to view and configure logging
criteria for failed authentications. A failed login log entry
is recorded after the configured number of attempts. 0 = feature
disabled; 1-3 and 5 are allowable values.
Defined values are:
* `1`
* `2`
* `3`
* `5`
'
enum:
- 1
- 2
- 3
- 5
readOnly: false
type: integer
AuthFailuresBeforeDelay:
description: 'The number of failed authentication attempts allowed
before authentication is delayed by AuthFailureDelayTimeSeconds.
Values of 0, 1, 3, and 5 are valid, with 0 indicating delay after
every authentication failure.
Defined values are:
* `1`
* `3`
* `5`
'
enum:
- 1
- 3
- 5
readOnly: false
type: integer
DefaultPassword:
description: The default password used to log in to the management
processor when factory reset is performed.
nullable: true
readOnly: false
type: string
DefaultUserName:
description: The default name used to log in to the management processor
when factory reset is performed.
nullable: true
readOnly: false
type: string
DirectorySettings:
description: Describes the directory settings.
properties:
LdapAuthenticationMode:
description: 'Represents the LDAP authentication mode.
Defined values are:
* `Disabled`: Directory authentication is disabled.
* `DefaultSchema`: Directory Default schema or Schema-free
option is selected.
* `ExtendedSchema`: HPE Extended schema is selected.
'
enum:
- Disabled
- DefaultSchema
- ExtendedSchema
readOnly: false
type: string
LdapCaCertificateLoaded:
description: Represents if the directory server CA certificate
is loaded or not.
readOnly: true
type: boolean
LdapCaCertificates:
description: A link to a collection of Certificates.
properties:
'@odata.id':
format: uri
readOnly: true
type: string
x-longDescription: The value of this property shall be the
unique identifier for the resource and it shall be of
the form defined in the SPMF specification.
readOnly: true
type: object
LdapServerPort:
description: Represents the port number of the directory server.
readOnly: true
type: integer
readOnly: false
type: object
DirectoryTest:
description: The value of this property shall be a reference to
a resource of type HpeDirectoryTest.
properties:
'@odata.id':
format: uri
readOnly: true
type: string
x-longDescription: The value of this property shall be the unique
identifier for the resource and it shall be of the form defined
in the SPMF specification.
readOnly: true
type: object
EnforcePasswordComplexity:
description: Enforce complexity rules when a user password is set
or changed. Three of four character classes must be present; ASCII
UPPERCASE, LOWERCASE, DIGITS, and Other
readOnly: false
type: boolean
Id:
description: Uniquely identifies the resource within the collection
of like resources.
readOnly: true
type: string
x-longDescription: This property represents an identifier for the
resource. All values for resources described by this schema shall
comply to the requirements as described in the Redfish specification.
KerberosSettings:
description: Describes the kerberos settings.
properties:
KDCServerPort:
description: Represents the port number of the KDC server.
readOnly: true
type: integer
KerberosRealm:
description: Represents the Realm of the KDC server.
nullable: true
readOnly: false
type: string
readOnly: false
type: object
MinPasswordLength:
description: This property specifies the minimum number of characters
allowed when a user password is set or changed. It must be a value
from 0 to 39.
readOnly: false
type: integer
readOnly: false
type: object
readOnly: false
type: object
Roles:
description: A link to a collection of Roles.
properties:
'@odata.id':
example: /AccountService/Roles/
format: uri
readOnly: true
type: string
x-longDescription: The value of this property shall be the unique identifier
for the resource and it shall be of the form defined in the SPMF specification.
readOnly: true
type: object
x-added: iLO 5 1.40
readOnly: false
type: object
AccountService.Update:
description: This is the schema definition for the Account service. It represents
the properties for this service and has links to the list of accounts.
properties:
AccountLockoutDuration:
description: The time in seconds an account is locked out. The value must
be greater than or equal to the value of the AccountLockoutCounterResetAfter
property. If set to 0, no lockout occurs.
nullable: true
readOnly: false
type: number
AccountLockoutThreshold:
description: The number of failed login attempts allowed before a user account
is locked for a specified duration. A value of 0 means it is never locked.
nullable: true
readOnly: false
type: number
ActiveDirectory:
description: A remote service that can provide accounts for this manager
to utilize for authentication.
properties:
AccountProviderType:
description: 'This property contains the type of external account provider
this resource references.
Defined values are:
* `ActiveDirectoryService`: An external Active Directory Service.
'
enum:
- ActiveDirectoryService
readOnly: false
type: string
Authentication:
description: Contains the authentication information for the external
service.
properties:
AuthenticationType:
description: 'This property contains the type of authentication
used to connect to the external account provider.
Defined values are:
* `UsernameAndPassword`: Username and password combination.
'
enum:
- UsernameAndPassword
readOnly: false
type: string
Password:
description: This property is used with a PATCH or PUT to write
the password for the account service. This property is null on
a GET.
nullable: true
readOnly: false
type: string
Username:
description: This property contains the distinguished name for the
account service.
nullable: true
readOnly: false
type: string
readOnly: false
type: object
RemoteRoleMapping:
description: This property contains a collection of the mapping rules
to convert the external account providers account information to the
local Redfish Role.
items:
description: Contains mapping rules to convert the external account
providers account information to the local Redfish Role.
properties:
LocalRole:
description: The name of the local role in which to map the remote
user or group.
nullable: true
readOnly: false
type: string
RemoteGroup:
description: This property is the name of the remote group (or
in the case of a Redfish Service, remote role) that will be
mapped to the local role referenced by this entity.
nullable: true
readOnly: false
type: string
readOnly: false
type: object
readOnly: false
type: array
ServiceAddresses:
description: This property contains the addresses of the user account
providers this resource references. The format of this field depends
on the Type.
items:
nullable: true
type: string
readOnly: false
type: array
ServiceEnabled:
description: This indicates whether this service is enabled.
nullable: true
readOnly: false
type: boolean
readOnly: false
type: object
AuthFailureLoggingThreshold:
description: The number of authorization failures allowed before the failure
attempt is logged to the manager log.
readOnly: false
type: number
LDAP:
description: A remote service that can provide accounts for this manager
to utilize for authentication.
properties:
AccountProviderType:
description: 'This property contains the type of external account provider
this resource references.
Defined values are:
* `ActiveDirectoryService`: An external Active Directory Service.
* `LDAPService`: A generic external LDAP Service.
'
enum:
- ActiveDirectoryService
- LDAPService
readOnly: false
type: string
Authentication:
description: Contains the authentication information for the external
service.
properties:
AuthenticationType:
description: 'This property contains the type of authentication
used to connect to the external account provider.
Defined values are:
* `UsernameAndPassword`: Username and password combination.
'
enum:
- UsernameAndPassword
readOnly: false
type: string
Password:
description: This property is used with a PATCH or PUT to write
the password for the account service. This property is null on
a GET.
nullable: true
readOnly: false
type: string
Username:
description: This property contains the distinguished name for the
account service.
nullable: true
readOnly: false
type: string
readOnly: false
type: object
LDAPService:
description: Contains settings for parsing a generic LDAP service.
properties:
SearchSettings:
description: Contains settings for searching a generic LDAP service.
properties:
BaseDistinguishedNames:
description: The base distinguished names to use when searching
the LDAP service.
items:
nullable: true
type: string
readOnly: false
type: array
readOnly: false
type: object
readOnly: false
type: object
RemoteRoleMapping:
description: This property contains a collection of the mapping rules
to convert the external account providers account information to the
local Redfish Role.
items:
description: Contains mapping rules to convert the external account
providers account information to the local Redfish Role.
properties:
LocalRole:
description: The name of the local role in which to map the remote
user or group.
nullable: true
readOnly: false
type: string
RemoteGroup:
description: This property is the name of the remote group (or
in the case of a Redfish Service, remote role) that will be
mapped to the local role referenced by this entity.
nullable: true
readOnly: false
type: string
readOnly: false
type: object
readOnly: false
type: array
ServiceAddresses:
description: This property contains the addresses of the user account
providers this resource references. The format of this field depends
on the Type.
items:
nullable: true
type: string
readOnly: false
type: array
ServiceEnabled:
description: This indicates whether this service is enabled.
nullable: true
readOnly: false
type: boolean
readOnly: false
type: object
LocalAccountAuth:
description: 'Controls when this service will use the accounts defined withing
this AccountService as part of authentication.
Defined values are:
* `Enabled`: Authentication via accounts defined in this AccountService
is enabled.
* `Disabled`: Authentication via accounts defined in this AccountService
is disabled.
'
enum:
- Enabled
- Disabled
readOnly: false
type: string
Oem:
properties:
Hpe:
properties:
Actions:
properties:
'#HpeiLOAccountService.ImportKerberosKeytab':
properties:
ImportUri@Redfish.AllowableValues:
description: The supported values for the ImportUri parameter.
type: string
x-longDescription: The supported values for the ImportUri
parameter.
target:
description: Link to invoke action
type: string
title:
description: Friendly action name
type: string
type: object
type: object
AuthFailureDelayTimeSeconds:
description: 'The time in seconds to delay for each failure after
AuthFailuresBeforeDelay authentication attempts have failed. Values
of 2, 5, 10, and 30 seconds are valid.
Defined values are:
* `2`
* `5`
* `10`
* `30`
'
enum:
- 2
- 5
- 10
- 30
readOnly: false
type: integer
AuthFailureLoggingThreshold:
description: 'This property enables you to view and configure logging
criteria for failed authentications. A failed login log entry
is recorded after the configured number of attempts. 0 = feature
disabled; 1-3 and 5 are allowable values.
Defined values are:
* `1`
* `2`
* `3`
* `5`
'
enum:
- 1
- 2
- 3
- 5
readOnly: false
type: integer
AuthFailuresBeforeDelay:
description: 'The number of failed authentication attempts allowed
before authentication is delayed by AuthFailureDelayTimeSeconds.
Values of 0, 1, 3, and 5 are valid, with 0 indicating delay after
every authentication failure.
Defined values are:
* `1`
* `3`
* `5`
'
enum:
- 1
- 3
- 5
readOnly: false
type: integer
DefaultPassword:
description: The default password used to log in to the management
processor when factory reset is performed.
nullable: true
readOnly: false
type: string
DefaultUserName:
description: The default name used to log in to the management processor
when factory reset is performed.
nullable: true
readOnly: false
type: string
DirectorySettings:
description: Describes the directory settings.
properties:
LdapAuthenticationMode:
description: 'Represents the LDAP authentication mode.
Defined values are:
* `Disabled`: Directory authentication is disabled.
* `DefaultSchema`: Directory Default schema or Schema-free
option is selected.
* `ExtendedSchema`: HPE Extended schema is selected.
'
enum:
- Disabled
- DefaultSchema
- ExtendedSchema
readOnly: false
type: string
readOnly: false
type: object
EnforcePasswordComplexity:
description: Enforce complexity rules when a user password is set
or changed. Three of four character classes must be present; ASCII
UPPERCASE, LOWERCASE, DIGITS, and Other
readOnly: false
type: boolean
KerberosSettings:
description: Describes the kerberos settings.
properties:
KerberosRealm:
description: Represents the Realm of the KDC server.
nullable: true
readOnly: false
type: string
readOnly: false
type: object
MinPasswordLength:
description: This property specifies the minimum number of characters
allowed when a user password is set or changed. It must be a value
from 0 to 39.
readOnly: false
type: integer
readOnly: false
type: object
readOnly: false
type: object
readOnly: false
type: object
Bios:
description: Bios contains properties surrounding a BIOS Attribute Registry
(where the system-specific BIOS attributes are described) and the Actions
needed to perform changes to BIOS settings, which typically require a system
reset to apply.
properties:
'@Redfish.Settings':
properties:
ETag:
description: The ETag of the resource to which the settings were applied,
after the application.
example: E72F1590
nullable: true
readOnly: true
type: string
x-longDescription: The value of this property shall be the ETag of the
resource to which the settings were applied, after the application. This
is here so that the client can check it against the ETag of the current
resource to see if any other changes have also happened to the resource.
Messages:
description: This is an array of messages associated with the task.
items:
properties:
Message:
description: This is the human readable message, if provided.
nullable: true
type: string
x-longDescription: This property shall contain an optional human
readable message.
MessageArgs:
description: This array of message arguments are substituted for
the arguments in the message when looked up in the message registry.
items:
type: string
type: array
x-longDescription: This property shall contain the message substitution
arguments for the specific message referenced by the MessageId
and shall only be included if the MessageId is present.
MessageId:
description: This is the key for this message which can be used
to look up the message in a message registry.
example: Base.1.0.Success
type: string
x-longDescription: This property shall be a key into message registry
as described in the Redfish specification.
RelatedProperties:
description: This is an array of properties described by the message.
items:
type: string
type: array
x-longDescription: This property shall contain an array of JSON
Pointers indicating the properties described by the message,
if appropriate for the message.
Resolution:
description: Used to provide suggestions on how to resolve the
situation that caused the error.
nullable: true
type: string
x-longDescription: This property shall contain an override of
the Resolution of the message in message registry, if present.
Severity:
description: This is the severity of the errors.
nullable: true
type: string
x-longDescription: The value of this property shall be the severity
of the error, as defined in the Status section of the Redfish
specificaiton.
type: object
readOnly: true
type: array
x-longDescription: The value of this property shall be an array of messages
associated with the task.
SettingsObject:
description: Reference to the resource the client may PUT/PATCH to in
order to change this resource.
properties:
'@odata.id':
description: The unique identifier for a resource.
example: /systems/1/bios/settings/
format: uri
readOnly: true
type: string
x-longDescription: The value of this property shall be the unique
identifier for the resource and it shall be of the form defined
in the Redfish specification.
readOnly: true
type: object
x-longDescription: The value of this property shall be the URI of the
resource to which a client must do a PUT or PATCh in order to modify
this resource.
Time:
description: Indicates the time the settings were applied.
example: '2019-02-06T15:01:40+00:00'
format: date-time
nullable: true
readOnly: true
type: string
x-longDescription: The value of this property shall indicate the time
that the settings object was applied to the resource.
type: object
'@odata.context':
description: The OData description of a payload.
example: /$metadata#Bios.Bios
format: uri
readOnly: true
type: string
x-longDescription: The value of this property shall be the context URL that
describes the resource according to OData-Protocol and shall be of the
form defined in the Redfish specification.
'@odata.etag':
example: W/\7B77B2AE65B86161615E3C1DF312FA1F\""
readOnly: true
type: string
x-longDescription: The value of this property is the Etag of the resource.
'@odata.id':
description: The unique identifier for a resource.
example: /systems/1/bios/settings/
format: uri
readOnly: true
type: string
x-longDescription: The value of this property shall be the unique identifier
for the resource and it shall be of the form defined in the Redfish specification.
'@odata.type':
description: The type of a resource.
example: '#Bios.v1_0_0.Bios'
readOnly: true
type: string
x-longDescription: The value of this property shall be an absolute URL that
specifies the type of the resource and it shall be of the form defined
in the Redfish specification.
Actions:
description: The available actions for this resource.
properties:
'#Bios.ChangePassword':
description: This action is used to change the BIOS passwords.
properties:
target:
description: Link to invoke action
example: /systems/1/bios/settings/Actions/Bios.ChangePasswords/
format: uri
type: string
title:
description: Friendly action name
type: string
type: object
x-longDescription: This action shall perform a change of the selected
BIOS password.
'#Bios.ResetBios':
description: This action is used to reset the BIOS attributes to default.
properties:
target:
description: Link to invoke action
example: /systems/1/bios/settings/Actions/Bios.ResetBios/
format: uri
type: string
title:
description: Friendly action name
type: string
type: object
x-longDescription: This action shall perform a reset of the BIOS attributes
to teir default values.
type: object
x-longDescription: The Actions property shall contain the available actions
for this resource.
AttributeRegistry:
description: The Resource ID of the Attribute Registry for the BIOS Attributes
resource.
example: BiosAttributeRegistryU32.v1_2_10
nullable: true
readOnly: true
type: string
x-longDescription: The reference to the Attribute Registry that lists the
metadata describing the BIOS attribute settings in this resource.
Description:
readOnly: true
type: string
Id:
description: Uniquely identifies the resource within the collection of like
resources.
example: settings
readOnly: true
type: string
x-longDescription: This property represents an identifier for the resource. All
values for resources described by this schema shall comply to the requirements
as described in the Redfish specification.
Name:
description: The name of the resource or array element.
example: BIOS Pending Settings
readOnly: true
type: string
x-longDescription: This object represents the Name property. All values
for resources described by this schema shall comply to the requirements
as described in the Redfish specification. The value of this string shall
be of the format for the reserved word *Name*.
type: object
x-longDescription: This resource shall be used to represent BIOS attributes
for a Redfish implementation.
Bios.Update:
description: Bios contains properties surrounding a BIOS Attribute Registry
(where the system-specific BIOS attributes are described) and the Actions
needed to perform changes to BIOS settings, which typically require a system
reset to apply.
properties:
Actions:
description: The available actions for this resource.
properties:
'#Bios.ChangePassword':
description: This action is used to change the BIOS passwords.
properties:
target:
description: Link to invoke action
format: uri
type: string
title:
description: Friendly action name
type: string
type: object
x-longDescription: This action shall perform a change of the selected
BIOS password.
'#Bios.ResetBios':
description: This action is used to reset the BIOS attributes to default.
properties:
target:
description: Link to invoke action
format: uri
type: string
title:
description: Friendly action name
type: string
type: object
x-longDescription: This action shall perform a reset of the BIOS attributes
to teir default values.
type: object
x-longDescription: The Actions property shall contain the available actions
for this resource.
type: object
x-longDescription: This resource shall be used to represent BIOS attributes
for a Redfish implementation.
Certificate:
description: This is the schema definition for X509 certificates.
properties:
'@odata.context':
format: uri
readOnly: true
type: string
x-longDescription: The value of this property shall be the context URL that
describes the resource according to OData-Protocol and shall be of the
form defined in the SPMF specification.
'@odata.etag':
readOnly: true
type: string
x-longDescription: The value of this property is the Etag of the resource.
'@odata.id':
format: uri
readOnly: true
type: string
x-longDescription: The value of this property shall be the unique identifier
for the resource and it shall be of the form defined in the SPMF specification.
'@odata.type':
readOnly: true
type: string
x-longDescription: The value of this property shall be an absolute URL that
specifies the type of the resource and it shall be of the form defined
in the SPMF specification.
CertificateString:
description: Contains PEM formatted X509 certificate or PKCS7 certificate
chain (Base64 encoded).
format: text
readOnly: false
type: string
x-added: iLO 5 1.40
Id:
description: Uniquely identifies the resource within the collection of like
resources.
readOnly: true
type: string
x-added: iLO 5 1.40
x-longDescription: This property represents an identifier for the resource. All
values for resources described by this schema shall comply to the requirements
as described in the Redfish specification.
Issuer:
description: The Certificate Authority that issued the certificate.
readOnly: true
type: string
x-added: iLO 5 1.40
Name:
description: The name of the resource or array element.
readOnly: true
type: string
x-added: iLO 5 1.40
SerialNumber:
description: The serial number that the Certificate Authority assigned to
the certificate.
example: xxxxxxxxxx
readOnly: true
type: string
x-added: iLO 5 1.40
Subject:
description: The entity to which the certificate was issued.
readOnly: true
type: string
x-added: iLO 5 1.40
ValidNotAfter:
description: The date on which the certificate validity period ends.
format: date-time
nullable: true
readOnly: true
type: string
x-added: iLO 5 1.40
ValidNotBefore:
description: The date on which the certificate validity period begins.
format: date-time
nullable: true
readOnly: true
type: string
x-added: iLO 5 1.40
readOnly: false
type: object
Certificate.Update:
description: This is the schema definition for X509 certificates.
properties:
CertificateString:
description: Contains PEM formatted X509 certificate or PKCS7 certificate
chain (Base64 encoded).
format: text
readOnly: false
type: string
readOnly: false
type: object
CertificateCollection:
properties:
'@odata.context':
example: /$metadata#CertificateCollection.CertificateCollection
format: uri
readOnly: true
type: string
x-longDescription: The value of this property shall be the context URL that
describes the resource according to OData-Protocol and shall be of the
form defined in the SPMF specification.
'@odata.etag':
example: W/\75983E8D\""
readOnly: true
type: string
x-longDescription: The value of this property is the Etag of the resource.
'@odata.id':
example: /AccountService/ExternalAccountProviders/LDAP/Certificates/
format: uri
readOnly: true
type: string
x-longDescription: The value of this property shall be the unique identifier
for the resource and it shall be of the form defined in the SPMF specification.
'@odata.type':
example: '#CertificateCollection.CertificateCollection'
readOnly: true
type: string
x-longDescription: The value of this property shall be an absolute URL that
specifies the type of the resource and it shall be of the form defined
in the SPMF specification.
Description:
description: Provides a description of this resource and is used for commonality in
the schema definitions.
example: iLO LDAP Certificate Collection
nullable: true
readOnly: true
type: string
x-longDescription: This object represents the Description property. All
values for resources described by this schema shall comply to the requirements
as described in the Redfish specification.
Members:
description: Contains the members of this collection.
items:
properties:
'@odata.id':
format: uri
readOnly: true
type: string
x-longDescription: The value of this property shall be the unique
identifier for the resource and it shall be of the form defined
in the SPMF specification.
type: object
readOnly: true
type: array
Members@odata.count:
description: The total number of collection members.
example: '0'
readOnly: true
type: integer
Name:
description: The name of the resource or array element.
example: Certificate Collection
readOnly: true
type: string
Oem:
description: This object represents the Oem property.
readOnly: true
x-longDescription: The value of this string shall be of the format for the
reserved word *Oem*.
type: object
Chassis:
description: The schema definition for the Chassis resource represents the properties
for physical components for any system. This object represents racks, rack
mount servers, blades, standalone, modular systems, enclosures, and all other
containers. The non-CPU/device-centric parts of the schema are accessed either
directly or indirectly through this resource.
properties:
'@odata.context':
example: /$metadata#Chassis.Chassis
format: uri
readOnly: true
type: string
x-longDescription: The value of this property shall be the context URL that
describes the resource according to OData-Protocol and shall be of the
form defined in the SPMF specification.
'@odata.etag':
example: W/\D31371D6\""
readOnly: true
type: string
x-longDescription: The value of this property is the Etag of the resource.
'@odata.id':
example: /Chassis/1/
format: uri
readOnly: true
type: string
x-longDescription: The value of this property shall be the unique identifier
for the resource and it shall be of the form defined in the SPMF specification.
'@odata.type':
example: '#Chassis.v1_6_0.Chassis'
readOnly: true
type: string
x-longDescription: The value of this property shall be an absolute URL that
specifies the type of the resource and it shall be of the form defined
in the SPMF specification.
AssetTag:
description: The chassis user-assigned asset tag.
example: Lorem ipsum dolor sit amet.
nullable: true
readOnly: false
type: string
x-added: iLO 5 1.10
ChassisType:
description: 'This property indicates the physical form factor type of this
resource.
Defined values are:
* `Rack`: An equipment rack, typically a 19-inch wide freestanding unit.
* `Blade`: An enclosed or semi-enclosed, typically vertically-oriented,
system chassis that must be plugged into a multi-system chassis to function
normally.
* `Enclosure`: A generic term for a chassis that does not fit any other
description.
* `StandAlone`: A single, free-standing system, commonly called a tower
or desktop chassis.
* `RackMount`: A single system chassis designed specifically for mounting
in an equipment rack.
* `Card`: A loose device or circuit board intended to be installed in
a system or other enclosure.
* `Cartridge`: A small self-contained system intended to be plugged into
a multi-system chassis.
* `Row`: A collection of equipment racks.
* `Pod`: A collection of equipment racks in a large, likely transportable,
container.
* `Expansion`: A chassis that expands the capabilities or capacity of
another chassis.
* `Sidecar`: A chassis that mechanically connects with another chassis
to expand its capabilities or capacity.
* `Zone`: A logical division or portion of a physical chassis that contains
multiple devices or systems that cannot be physically separated.
* `Sled`: TBD
* `Shelf`: An enclosed or semi-enclosed, typically horizontally-oriented,
system chassis that must be plugged into a multi-system chassis to function
normally.
* `Other`: A chassis that does not fit any of these definitions.
'
enum:
- Rack
- Blade
- Enclosure
- StandAlone
- RackMount
- Card
- Cartridge
- Row
- Pod
- Expansion
- Sidecar
- Zone
- Sled
- Shelf
- Other
example: RackMount
readOnly: true
type: string
x-added: iLO 5 1.10
Description:
description: Provides a description of this resource and is used for commonality in
the schema definitions.
nullable: true
readOnly: true
type: string
x-longDescription: This object represents the Description property. All
values for resources described by this schema shall comply to the requirements
as described in the Redfish specification.
Id:
description: Uniquely identifies the resource within the collection of like
resources.
example: '1'
readOnly: true
type: string
x-added: iLO 5 1.10
x-longDescription: This property represents an identifier for the resource. All
values for resources described by this schema shall comply to the requirements
as described in the Redfish specification.
IndicatorLED:
description: 'The chassis indicator LED that is used to identify the chassis.
The user can manipulate this LED.
Defined values are:
* `Unknown`: The state of the Indicator LED cannot be determined.
* `Lit`: The Indicator LED is on.
* `Blinking`: The Indicator LED is blinking.
* `Off`: The Indicator LED is off.
'
enum:
- Unknown
- Lit
- Blinking
- 'Off'
nullable: true
readOnly: false
type: string
x-added: iLO 5 1.10
Links:
description: The links array contains links to related resources.
properties:
ComputerSystems:
description: An array of references to the computer systems contained
in this chassis. This will only reference ComputerSystems that are
directly and wholly contained in this chassis.
items:
properties:
'@odata.id':
example: /Systems/1/
format: uri
readOnly: true
type: string
x-longDescription: The value of this property shall be the unique
identifier for the resource and it shall be of the form defined
in the SPMF specification.
type: object
readOnly: true
type: array
x-added: iLO 5 1.10
ContainedBy:
description: A reference to the chassis that contains this chassis.
properties:
'@odata.id':
format: uri
readOnly: true
type: string
x-longDescription: The value of this property shall be the unique
identifier for the resource and it shall be of the form defined
in the SPMF specification.
readOnly: true
type: object
x-added: iLO 5 1.10
Contains:
description: An array of references to any other chassis contained in
this chassis.
items:
properties:
'@odata.id':
format: uri
readOnly: true
type: string
x-longDescription: The value of this property shall be the unique
identifier for the resource and it shall be of the form defined
in the SPMF specification.
type: object
readOnly: true
type: array
x-added: iLO 5 1.10
Drives:
description: An array of references to the drives contained in this
chassis.
items:
properties:
'@odata.id':
example: /Chassis/1/Drives/d4f73b6b/
format: uri
readOnly: true
type: string
x-longDescription: The value of this property shall be the unique
identifier for the resource and it shall be of the form defined
in the SPMF specification.
type: object
readOnly: true
type: array
x-added: iLO 5 1.10
LogServices:
description: A reference to the logs for this chassis.
properties:
'@odata.id':
format: uri
readOnly: true
type: string
x-longDescription: The value of this property shall be the unique
identifier for the resource and it shall be of the form defined
in the SPMF specification.
readOnly: true
type: object
x-added: iLO 5 1.10
ManagedBy:
description: An array of references to the managers contained in this
chassis.
items:
properties:
'@odata.id':
example: /Managers/1/
format: uri
readOnly: true
type: string
x-longDescription: The value of this property shall be the unique
identifier for the resource and it shall be of the form defined
in the SPMF specification.
type: object
readOnly: true
type: array
x-added: iLO 5 1.10
Oem:
description: This object represents the Oem property.
readOnly: true
readOnly: true
type: object
x-added: iLO 5 1.10
Manufacturer:
description: The chassis manufacturer.
example: HPE
nullable: true
readOnly: true
type: string
x-added: iLO 5 1.10
Model:
description: The chassis model number.
example: ProLiant DL360 Gen10
nullable: true
readOnly: true
type: string
x-added: iLO 5 1.10
Name:
description: The name of the resource or array element.
example: Computer System Chassis
readOnly: true
type: string
x-added: iLO 5 1.10
NetworkAdapters:
description: The collection of network adapters contained within this chassis.
properties:
'@odata.id':
example: /Chassis/1/NetworkAdapters/
format: uri
readOnly: true
type: string
x-longDescription: The value of this property shall be the unique identifier
for the resource and it shall be of the form defined in the SPMF specification.
readOnly: true
type: object
x-added: iLO 5 1.20
Oem:
properties:
Hpe:
properties:
'@odata.context':
format: uri
readOnly: true
type: string
x-longDescription: The value of this property shall be the context
URL that describes the resource according to OData-Protocol and
shall be of the form defined in the SPMF specification.
'@odata.etag':
readOnly: true
type: string
x-longDescription: The value of this property is the Etag of the
resource.
'@odata.id':
format: uri
readOnly: true
type: string
x-longDescription: The value of this property shall be the unique
identifier for the resource and it shall be of the form defined
in the SPMF specification.
'@odata.type':
readOnly: true
type: string
x-longDescription: The value of this property shall be an absolute
URL that specifies the type of the resource and it shall be of
the form defined in the SPMF specification.
Actions:
properties:
'#HpeServerChassis.DisableMCTPOnServer':
properties:
target:
description: Link to invoke action
type: string
title:
description: Friendly action name
type: string
type: object
'#HpeServerChassis.FactoryResetMCTP':
properties:
target:
description: Link to invoke action
type: string
title:
description: Friendly action name
type: string
type: object
type: object
BayNumber:
description: The bay number of the node or the blade.
readOnly: true
type: integer
BaysConsumedHeight:
description: The number of enclosure bays this chassis consumes
in height.
readOnly: true
type: integer
BaysConsumedWidth:
description: The number of enclosure bays this chassis consumes
in width.
readOnly: true
type: integer
EnclosureIndicatorLED:
description: 'The enclosure indicator LED that is used to identify
the enclosure.
Defined values are:
* `Unknown`: The state of the Indicator LED cannot be determined.
* `Lit`: The Indicator LED is on.
* `Blinking`: The Indicator LED is blinking.
* `Off`: The Indicator LED is off.
'
enum:
- Unknown
- Lit
- Blinking
- 'Off'
nullable: true
readOnly: true
type: string
EnclosureModel:
description: Type of enclosure.
readOnly: true
type: string
EnclosureUUID:
description: The UUID of the enclosure.
readOnly: true
type: string
Firmware:
description: The firmware versions.
properties:
PlatformDefinitionTable:
description: The Intelligent Platform Abstraction Data.
properties:
Current:
description: The current firmware version.
properties:
VersionString:
description: The version of the Intelligent Platform
Abstraction Data.
readOnly: true
type: string
readOnly: true
type: object
readOnly: true
type: object
PowerManagementController:
description: ' The power monitor controller.'
properties:
Current:
description: The current firmware version.
properties:
VersionString:
description: The firmware version of the Power Monitor.
readOnly: true
type: string
readOnly: true
type: object
readOnly: true
type: object
PowerManagementControllerBootloader:
description: The power monitor bootloader.
properties:
Current:
description: The Current firmware version.
properties:
Family:
description: The family type of the Power Monitor hardware.
readOnly: true
type: string
VersionString:
description: The firmware version of the Power Monitor
boot loader.
readOnly: true
type: string
readOnly: true
type: object
readOnly: true
type: object
SASProgrammableLogicDevice:
description: Serial Attached SCSI (SAS) device.
properties:
Current:
description: The current firmware version.
properties:
VersionString:
description: The firmware version of the SAS controller.
readOnly: true
type: string
readOnly: true
type: object
readOnly: true
type: object
SPSFirmwareVersionData:
description: Server Platform Services Data
properties:
Current:
description: Management Engine Data
properties:
VersionString:
description: The SPS FW Version number, aka ME FW Version,
AAAA.BBBB.CCCC.DDDD.E
readOnly: true
type: string
readOnly: true
type: object
readOnly: true
type: object
SystemProgrammableLogicDevice:
description: Complex programmable logic device (CPLD).
properties:
Current:
description: The current firmware version.
properties:
VersionString:
description: The firmware version of the CPLD.
readOnly: true
type: string
readOnly: true
type: object
readOnly: true
type: object
readOnly: true
type: object
Id:
description: Uniquely identifies the resource within the collection
of like resources.
readOnly: true
type: string
x-longDescription: This property represents an identifier for the
resource. All values for resources described by this schema shall
comply to the requirements as described in the Redfish specification.
Images:
description: The URIs for chassis images.
properties:
Front:
description: The URI for this front resource.
properties:
extref:
description: The URI of an external resource.
format: uri
readOnly: true
type: string
type: object
Model:
description: The URI for this external model resource.
properties:
extref:
description: The URI of an external resource.
format: uri
readOnly: true
type: string
type: object
readOnly: true
type: object
Links:
description: The links array contains the links to other resources
that are related to this resource.
properties:
BaseFrus:
description: The URI for this base FRUs resource.
properties:
'@odata.id':
format: uri
readOnly: true
type: string
x-longDescription: The value of this property shall be the
unique identifier for the resource and it shall be of
the form defined in the SPMF specification.
readOnly: true
type: object
BladeEnclosure:
description: The URI for this blade enclosure resource.
properties:
'@odata.id':
format: uri
readOnly: true
type: string
x-longDescription: The value of this property shall be the
unique identifier for the resource and it shall be of
the form defined in the SPMF specification.
readOnly: true
type: object
Devices:
description: The URI for this Devices resource.
properties:
'@odata.id':
format: uri
readOnly: true
type: string
x-longDescription: The value of this property shall be the
unique identifier for the resource and it shall be of
the form defined in the SPMF specification.
readOnly: true
type: object
HddService:
description: The URI for this Hdd service resource.
properties:
'@odata.id':
format: uri
readOnly: true
type: string
x-longDescription: The value of this property shall be the
unique identifier for the resource and it shall be of
the form defined in the SPMF specification.
readOnly: true
type: object
MezzFrus:
description: The URI for this mezzanine FRUs resource.
properties:
'@odata.id':
format: uri
readOnly: true
type: string
x-longDescription: The value of this property shall be the
unique identifier for the resource and it shall be of
the form defined in the SPMF specification.
readOnly: true
type: object
type: object
Location:
description: Locations.
properties:
GeographicLocation:
description: Geographic location.
properties:
RackName:
description: The name of the chassis enclosure.
readOnly: true
type: string
readOnly: true
type: object
LocationInRack:
description: Chassis rack location.
properties:
RackLdsPartNumber:
description: The chassis rack part number.
readOnly: true
type: string
RackLdsProductDescription:
description: ' The chassis rack product description.'
readOnly: true
type: string
RackUHeight:
description: The chassis rack U height.
readOnly: true
type: integer
RackUUID:
description: The chassis rack UUID.
readOnly: true
type: string
TagVersion:
description: The chassis rack tag version.
readOnly: true
type: integer
ULocation:
description: The chassis rack U location.
readOnly: true
type: string
UPosition:
description: The chassis U position in the rack.
readOnly: true
type: integer
readOnly: true
type: object
LocationOfChassis:
description: Chassis location.
properties:
UUID:
description: The chassis UUID provided by SMBIOS.
example: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
readOnly: true
type: string
readOnly: true
type: object
readOnly: true
type: object
MCTPEnabledOnServer:
description: Indicates if MCTP is enabled on the server or not.
readOnly: true
type: boolean
OnboardAdministrator:
description: The properties specific to Onboard Administrator.
properties:
IPv4Address:
description: IPv4 address of the chassis.
nullable: true
readOnly: true
type: string
IPv6:
description: This array of objects enumerates all of the currently
assigned IPv6 addresses on this interface.
properties:
DHCPv6Address:
description: This is the DHCPv6 Address.
items:
format: ipv6
type: string
readOnly: true
type: array
SLAACAddress:
description: This is the SLAAC IPv6 Address.
items:
format: ipv6
type: string
readOnly: true
type: array
StaticAddress:
description: This is the Static IPv6 Address.
items:
format: ipv6
type: string
readOnly: true
type: array
readOnly: true
type: object
MacAddress:
description: MAC address of the chassis.
nullable: true
readOnly: true
type: string
readOnly: true
type: object
PowerAlertMode:
description: The power alert mode settings.
properties:
Activated:
description: The power alert mode activation state.
readOnly: true
type: boolean
AlertPowerWatts:
description: The power consumption of the system when operating
in alert mode.
readOnly: true
type: integer
readOnly: true
type: object
RackName:
description: The name of the rack that contains the enclosure.
readOnly: true
type: string
SmartStorageBattery:
description: This is the definition for HPE Smart Storage Battery.
items:
description: HPE Smart Storage Battery Information.
properties:
BatteryWearLevelPercent:
description: The battery wear level percentage. When this
value reaches 100%, the battery is completely worn out and
needs to be replaced. The value is null if battery wear
level cannot be determined or is not supported.
nullable: true
readOnly: true
type: integer
ChargeLevelPercent:
description: State of charge of the battery.
nullable: true
readOnly: true
type: integer
ErrorCode:
description: 'Error code of the battery.
Defined values are:
* `GeneralFailure`: The battery has failed.
* `HighInternalBatteryResistance`: The battery has failed
due to high internal resistance.
* `LowOpenCircuitVoltage`: The battery has failed due to
a low voltage output.
* `BatteryCellFailure`: The battery has failed.
* `BatteryChargeTimeout`: The battery did not charge at
the expected rate, indicating a faulty battery.
* `OverTemperature`: The battery was disabled due to high
ambient temperature, and will be re-enabled when the temperature
is lowered.
* `DischargeBelowMinimumVoltage`: The battery discharged
below the minimum discharge voltage, and may be re-enabled
upon recharging the battery.
* `DischargeCurrentHigh`: The last backup failed due to
exceeding the maximum discharge current.
* `LoadCountExceeded`: The battery was disabled due to exceeding
the maximum amount of devices supported, and will be re-enabled
when the battery has been recharged or the additional devices
are removed.
* `BackupSucceeded`: The last backup succeeded within the
expected time.
* `OverCurrent`: The battery has been protected due to exceeding
the output current capability. The battery should be re-enabled
on the next reboot.
* `PermanentFailure`: The battery has permanently failed.
* `BackupTimeExceeded`: The last backup failed due to exceeding
the battery discharge time limit.
'
enum:
- GeneralFailure
- HighInternalBatteryResistance
- LowOpenCircuitVoltage
- BatteryCellFailure
- BatteryChargeTimeout
- OverTemperature
- DischargeBelowMinimumVoltage
- DischargeCurrentHigh
- LoadCountExceeded
- BackupSucceeded
- OverCurrent
- PermanentFailure
- BackupTimeExceeded
nullable: true
readOnly: true
type: string
FailurePredicted:
description: Is this battery currently predicting a failure
in the near future.
nullable: true
readOnly: true
type: boolean
FirmwareVersion:
description: Firmware version of the battery.
readOnly: true
type: string
Index:
description: Index of the battery.
readOnly: true
type: integer
MaximumCapWatts:
description: Maximum capacity of the battery in watts.
readOnly: true
type: integer
Model:
description: Model of the battery.
readOnly: true
type: string
ProductName:
description: Product name of the battery.
readOnly: true
type: string
RemainingChargeTimeSeconds:
description: Remaining charging time of the battery in seconds.
nullable: true
readOnly: true
type: integer
SerialNumber:
description: Serial number of the battery.
example: xxxxxxxxxx
readOnly: true
type: string
SparePartNumber:
description: Spare part number of the battery.
readOnly: true
type: string
Status:
properties:
Health:
description: 'This represents the health state of this
resource in the absence of its dependent resources.
Defined values are:
* `OK`: Normal
* `Warning`: A condition exists that requires attention
* `Critical`: A critical condition exists that requires
immediate attention
'
enum:
- OK
- Warning
- Critical
nullable: true
readOnly: true
type: string
x-longDescription: This property shall represent the HealthState
of the resource without considering its dependent resources.
The values shall conform to those defined in the Redfish
specification.
HealthRollup:
description: 'This represents the overall health state
from the view of this resource.
Defined values are:
* `OK`: Normal
* `Warning`: A condition exists that requires attention
* `Critical`: A critical condition exists that requires
immediate attention
'
enum:
- OK
- Warning
- Critical
nullable: true
readOnly: true
type: string
x-longDescription: This property shall represent the HealthState
of the resource and its dependent resources. The values
shall conform to those defined in the Redfish specification.
State:
description: 'This indicates the known state of the resource,
such as if it is enabled.
Defined values are:
* `Enabled`: This function or resource has been enabled.
* `Disabled`: This function or resource has been disabled.
* `StandbyOffline`: This function or resource is enabled,
but awaiting an external action to activate it.
* `StandbySpare`: This function or resource is part
of a redundancy set and is awaiting a failover or other
external action to activate it.
* `InTest`: This function or resource is undergoing
testing.
* `Starting`: This function or resource is starting.
* `Absent`: This function or resource is not present
or not detected.
* `UnavailableOffline`: This function or resource is
present but cannot be used.
* `Deferring`: The element will not process any commands
but will queue new requests.
* `Quiesced`: The element is enabled but only processes
a restricted set of commands.
* `Updating`: The element is updating and may be unavailable
or degraded.
'
enum:
- Enabled
- Disabled
- StandbyOffline
- StandbySpare
- InTest
- Starting
- Absent
- UnavailableOffline
- Deferring
- Quiesced
- Updating
nullable: true
readOnly: true
type: string
x-longDescription: This property shall represent if this
component is available or not and why. Enabled indicates
the resource is available. Disabled indicates the resource
has been intentionally made unavailable but it can be
enabled. Offline indicates the resource is unavailable
intentionally and requires action to be made available. InTest
indicates that the component is undergoing testing. Starting
indicates that the resource is on its way to becoming
available. Absent indicates the resources is physically
unavailable.
type: object
readOnly: true
type: object
readOnly: true
type: array
SystemMaintenanceSwitches:
description: Describes the maintenance switch positions
properties:
Sw1:
description: 'Override iLO security.
Defined values are:
* `On`: iLO Security Override Enabled.
* `Off`: No function (Normal).
'
enum:
- 'On'
- 'Off'
readOnly: true
type: string
Sw10:
description: 'Reserved.
Defined values are:
* `On`: Switch is on.
* `Off`: Switch is off (Normal).
'
enum:
- 'On'
- 'Off'
readOnly: true
type: string
Sw11:
description: 'Reserved.
Defined values are:
* `On`: Switch is on.
* `Off`: Switch is off (Normal).
'
enum:
- 'On'
- 'Off'
readOnly: true
type: string
Sw12:
description: 'Reserved.
Defined values are:
* `On`: Switch is on.
* `Off`: Switch is off (Normal).
'
enum:
- 'On'
- 'Off'
readOnly: true
type: string
Sw2:
description: 'Reserved.
Defined values are:
* `On`: Switch is on.
* `Off`: Switch is off (Normal).
'
enum:
- 'On'
- 'Off'
readOnly: true
type: string
Sw3:
description: 'Reserved.
Defined values are:
* `On`: Switch is on.
* `Off`: Switch is off (Normal).
'
enum:
- 'On'
- 'Off'
readOnly: true
type: string
Sw4:
description: 'Reserved.
Defined values are:
* `On`: Switch is on.
* `Off`: Switch is off (Normal).
'
enum:
- 'On'
- 'Off'
readOnly: true
type: string
Sw5:
description: 'BIOS/UEFI Password Disable.
Defined values are:
* `On`: Power On Password disabled.
* `Off`: Power On Password enabled (Normal).
'
enum:
- 'On'
- 'Off'
readOnly: true
type: string
Sw6:
description: 'Reset Configuration.
Defined values are:
* `On`
* `Off`
'
enum:
- 'On'
- 'Off'
readOnly: true
type: string
Sw7:
description: 'Reserved.
Defined values are:
* `On`: Switch is on.
* `Off`: Switch is off (Default).
'
enum:
- 'On'
- 'Off'
readOnly: true
type: string
Sw8:
description: 'Reserved.
Defined values are:
* `On`: Switch is on.
* `Off`: Switch is off (Default).
'
enum:
- 'On'
- 'Off'
readOnly: true
type: string
Sw9:
description: 'Reserved.
Defined values are:
* `On`: Switch is on.
* `Off`: Switch is off (Default).
'
enum:
- 'On'
- 'Off'
readOnly: true
type: string
readOnly: true
type: object
readOnly: true
type: object
readOnly: true
type: object
PartNumber:
description: The chassis part number.
nullable: true
readOnly: true
type: string
x-added: iLO 5 1.10
PhysicalSecurity:
properties:
IntrusionSensor:
description: 'This indicates the known state of the physical security
sensor, such as if it is hardware intrusion detected.
Defined values are:
* `Normal`: No abnormal physical security conditions are detected
at this time.
* `HardwareIntrusion`: A door, lock, or other mechanism protecting
the internal system hardware from being accessed is detected as being
in an insecure state.
* `TamperingDetected`: Physical tampering of the monitored entity
is detected.
'
enum:
- Normal
- HardwareIntrusion
- TamperingDetected
nullable: true
readOnly: true
type: string
x-added: iLO 5 1.10
IntrusionSensorReArm:
description: 'This indicates how the Normal state to be restored.
Defined values are:
* `Manual`: This sensor would be restored to the Normal state by a
manual re-arm.
* `Automatic`: This sensor would be restored to the Normal state automatically
as no abnormal physical security conditions are detected.
'
enum:
- Manual
- Automatic
nullable: true
readOnly: true
type: string
x-added: iLO 5 1.10
readOnly: true
type: object
x-added: iLO 5 1.10
Power:
description: A reference to the thermal metrics (power supplies, power policies,
sensors) for this chassis.
properties:
'@odata.id':
example: /Chassis/1/Power/
format: uri
readOnly: true
type: string
x-longDescription: The value of this property shall be the unique identifier
for the resource and it shall be of the form defined in the SPMF specification.
readOnly: true
type: object
x-added: iLO 5 1.10
SKU:
description: The chassis SKU.
example: (SKU Number)
nullable: true
readOnly: true
type: string
x-added: iLO 5 1.10
SerialNumber:
description: The chassis serial number.
example: xxxxxxxxxx
nullable: true
readOnly: true
type: string
x-added: iLO 5 1.10
Status:
properties:
Health:
description: 'This represents the health state of this resource in the
absence of its dependent resources.
Defined values are:
* `OK`: Normal
* `Warning`: A condition exists that requires attention
* `Critical`: A critical condition exists that requires immediate
attention
'
enum:
- OK
- Warning
- Critical
example: OK
nullable: true
readOnly: true
type: string
x-added: iLO 5 1.10
x-longDescription: This property shall represent the HealthState of
the resource without considering its dependent resources. The values
shall conform to those defined in the Redfish specification.
HealthRollup:
description: 'This represents the overall health state from the view
of this resource.
Defined values are:
* `OK`: Normal
* `Warning`: A condition exists that requires attention
* `Critical`: A critical condition exists that requires immediate
attention
'
enum:
- OK
- Warning
- Critical
nullable: true
readOnly: true
type: string
x-added: iLO 5 1.10
x-longDescription: This property shall represent the HealthState of
the resource and its dependent resources. The values shall conform
to those defined in the Redfish specification.
State:
description: 'This indicates the known state of the resource, such as
if it is enabled.
Defined values are:
* `Enabled`: This function or resource has been enabled.
* `Disabled`: This function or resource has been disabled.
* `StandbyOffline`: This function or resource is enabled, but awaiting
an external action to activate it.
* `StandbySpare`: This function or resource is part of a redundancy
set and is awaiting a failover or other external action to activate
it.
* `InTest`: This function or resource is undergoing testing.
* `Starting`: This function or resource is starting.
* `Absent`: This function or resource is not present or not detected.
* `UnavailableOffline`: This function or resource is present but cannot
be used.
* `Deferring`: The element will not process any commands but will
queue new requests.
* `Quiesced`: The element is enabled but only processes a restricted
set of commands.
* `Updating`: The element is updating and may be unavailable or degraded.
'
enum:
- Enabled
- Disabled
- StandbyOffline
- StandbySpare
- InTest
- Starting
- Absent
- UnavailableOffline
- Deferring
- Quiesced
- Updating
example: Enabled
nullable: true
readOnly: true
type: string
x-added: iLO 5 1.10
x-longDescription: This property shall represent if this component is
available or not and why. Enabled indicates the resource is available. Disabled
indicates the resource has been intentionally made unavailable but
it can be enabled. Offline indicates the resource is unavailable
intentionally and requires action to be made available. InTest indicates
that the component is undergoing testing. Starting indicates that
the resource is on its way to becoming available. Absent indicates
the resources is physically unavailable.
type: object
x-added: iLO 5 1.10
Thermal:
description: A reference to the thermal metrics (fans, cooling, sensors)
for this chassis.
properties:
'@odata.id':
example: /Chassis/1/Thermal/
format: uri
readOnly: true
type: string
x-longDescription: The value of this property shall be the unique identifier
for the resource and it shall be of the form defined in the SPMF specification.
readOnly: true
type: object
x-added: iLO 5 1.10
readOnly: false
type: object
ChassisCollection:
properties:
'@odata.context':
example: /$metadata#ChassisCollection.ChassisCollection
format: uri
readOnly: true
type: string
x-longDescription: The value of this property shall be the context URL that
describes the resource according to OData-Protocol and shall be of the
form defined in the SPMF specification.
'@odata.etag':
example: W/\AA6D42B0\""
readOnly: true
type: string
x-longDescription: The value of this property is the Etag of the resource.
'@odata.id':
example: /Chassis/
format: uri
readOnly: true
type: string
x-longDescription: The value of this property shall be the unique identifier
for the resource and it shall be of the form defined in the SPMF specification.
'@odata.type':
example: '#ChassisCollection.ChassisCollection'
readOnly: true
type: string
x-longDescription: The value of this property shall be an absolute URL that
specifies the type of the resource and it shall be of the form defined
in the SPMF specification.
Description:
description: Provides a description of this resource and is used for commonality in
the schema definitions.
example: Computer System Chassis View
nullable: true
readOnly: true
type: string
x-longDescription: This object represents the Description property. All
values for resources described by this schema shall comply to the requirements
as described in the Redfish specification.
Members:
description: Contains the members of this collection.
items:
properties:
'@odata.id':
example: /Chassis/1/
format: uri
readOnly: true
type: string
x-longDescription: The value of this property shall be the unique
identifier for the resource and it shall be of the form defined
in the SPMF specification.
type: object
readOnly: true
type: array
Members@odata.count:
description: The total number of collection members.
example: '1'
readOnly: true
type: integer
Name:
description: The name of the resource or array element.
example: Computer System Chassis
readOnly: true
type: string
Oem:
description: This object represents the Oem property.
readOnly: true
x-longDescription: The value of this string shall be of the format for the
reserved word *Oem*.
type: object
ComputerSystem:
description: The schema definition of a computer system and its properties.
A computer system represents a physical or virtual machine and the local resources,
such as memory, CPU, and other devices that can be accessed from that machine.
properties:
'@odata.context':
example: /$metadata#ComputerSystem.ComputerSystem
format: uri
readOnly: true
type: string
x-longDescription: The value of this property shall be the context URL that
describes the resource according to OData-Protocol and shall be of the
form defined in the SPMF specification.
'@odata.etag':
example: W/\60046D86\""
readOnly: true
type: string
x-longDescription: The value of this property is the Etag of the resource.
'@odata.id':
example: /Systems/1/
format: uri
readOnly: true
type: string
x-longDescription: The value of this property shall be the unique identifier
for the resource and it shall be of the form defined in the SPMF specification.
'@odata.type':
example: '#ComputerSystem.v1_4_0.ComputerSystem'
readOnly: true
type: string
x-longDescription: The value of this property shall be an absolute URL that
specifies the type of the resource and it shall be of the form defined
in the SPMF specification.
Actions:
properties:
'#ComputerSystem.Reset':
properties:
ResetType@Redfish.AllowableValues:
description: The supported values for the ResetType parameter.
items:
description: 'Defined values are:
* `On`
* `ForceOff`
* `ForceRestart`
* `Nmi`
* `PushPowerButton`
'
enum:
- 'On'
- ForceOff
- ForceRestart
- Nmi
- PushPowerButton
type: string
type: array
x-longDescription: The supported values for the ResetType parameter.
target:
description: Link to invoke action
example: /Systems/1/Actions/ComputerSystem.Reset/
type: string
title:
description: Friendly action name
type: string
type: object
type: object
AssetTag:
description: A user-definable tag that is used to track this system for
inventory or other client purposes.
example: Lorem ipsum dolor sit amet.
nullable: true
readOnly: false
type: string
x-added: iLO 5 1.10
Bios:
description: The Bios URI.
properties:
'@odata.id':
example: /systems/1/bios/
format: uri
readOnly: true
type: string
x-longDescription: The value of this property shall be the unique identifier
for the resource and it shall be of the form defined in the SPMF specification.
readOnly: true
type: object
x-added: iLO 5 1.10
BiosVersion:
description: The version of the system BIOS or primary system firmware.
example: U32 v2.10 (01/18/2019)
nullable: true
type: string
x-added: iLO 5 1.10
x-longDescription: The value of this property shall be the version string
of the currently installed and running BIOS (for x86 systems). For other
systems, the value may contain a version string representing the primary
system firmware.
Boot:
description: The boot information for the current resource.
properties:
BootSourceOverrideEnabled:
description: 'BootSourceOverrideTarget must be specified before BootSourceOverrideEnabled
can be used.
Defined values are:
* `Disabled`: The system will boot normally.
* `Once`: On its next boot cycle, the system will boot (one time)
to the Boot Source Override Target. The value of BootSourceOverrideEnabled
is then reset back to Disabled.
* `Continuous`: The system will boot to the target specified in the
BootSourceOverrideTarget until this property is set to Disabled.
'
enum:
- Disabled
- Once
- Continuous
example: Disabled
nullable: true
readOnly: false
type: string
x-added: iLO 5 1.10
BootSourceOverrideMode:
description: 'Defined values are:
* `Legacy`: The system will boot in non-UEFI boot mode to the Boot
Source Override Target.
* `UEFI`: The system will boot in UEFI boot mode to the Boot Source
Override Target.
'
enum:
- Legacy
- UEFI
example: UEFI
readOnly: false
type: string
x-added: iLO 5 1.10
BootSourceOverrideTarget:
description: The current boot source to be used at next boot instead
of the normal boot device, if BootSourceOverrideEnabled is true.
example: None
nullable: true
readOnly: false
type: string
x-added: iLO 5 1.10
x-longDescription: The value of this property shall contain the source
to boot the system from, overriding the normal boot order. The valid
values for this property are specified through the Redfish.AllowableValues
annotation. Pxe indicates to PXE boot from the primary NIC; Floppy,
Cd, Usb, Hdd indicates to boot from their devices respectively. BiosSetup
indicates to boot into the native BIOS screen setup. Utilities and
Diags indicate to boot from the local utilities or diags partitions
and UefiTarget indicates to boot from the UEFI device path found in
UefiTargetBootSourceOverride.
BootSourceOverrideTarget@Redfish.AllowableValues:
items:
description: 'The current boot source to be used at next boot instead
of the normal boot device, if BootSourceOverrideEnabled is not Disabled.
Defined values are:
* `None`: Boot from the normal boot device.
* `Pxe`: Boot from the Pre-Boot EXecution (PXE) environment.
* `Floppy`: Boot from the floppy disk drive.
* `Cd`: Boot from the CD/DVD disc.
* `Usb`: Boot from a USB device as specified by the system BIOS.
* `Hdd`: Boot from a hard drive.
* `BiosSetup`: Boot to the BIOS Setup Utility.
* `Utilities`: Boot the manufacturer''s Utilities program(s).
* `Diags`: Boot the manufacturer''s Diagnostics program.
* `UefiShell`: Boot to the UEFI Shell.
* `UefiTarget`: Boot to the UEFI Device specified in the UefiTargetBootSourceOverride
property.
* `SDCard`: Boot from an SD Card
* `UefiHttp`: Boot from a UEFI HTTP network location
'
enum:
- None
- Pxe
- Floppy
- Cd
- Usb
- Hdd
- BiosSetup
- Utilities
- Diags
- UefiShell
- UefiTarget
- SDCard
- UefiHttp
nullable: true
readOnly: true
type: string
type: array
x-added: iLO 5 1.10
UefiTargetBootSourceOverride:
description: This property is the UEFI Device Path of the device to
boot from when BootSourceOverrideTarget is UefiTarget.
example: None
nullable: true
readOnly: false
type: string
x-added: iLO 5 1.10
x-longDescription: The value of this property shall be the UEFI device
path of the override boot target. The valid values for this property
are specified through the Redfish.AllowableValues annotation. BootSourceOverrideEnabled
= Continuous is not supported for UEFI Boot Source Override as this
setting is defined in UEFI as a one time boot only.
UefiTargetBootSourceOverride@Redfish.AllowableValues:
items:
description: An array of structured boot strings.
nullable: true
readOnly: true
type: string
readOnly: true
type: array
x-added: iLO 5 1.10
readOnly: false
type: object
x-added: iLO 5 1.10
Description:
description: Provides a description of this resource and is used for commonality in
the schema definitions.
nullable: true
readOnly: true
type: string
x-longDescription: This object represents the Description property. All
values for resources described by this schema shall comply to the requirements
as described in the Redfish specification.
EthernetInterfaces:
description: A reference to the collection of Ethernet interfaces associated
with this system.
properties:
'@odata.id':
example: /Systems/1/EthernetInterfaces/
format: uri
readOnly: true
type: string
x-longDescription: The value of this property shall be the unique identifier
for the resource and it shall be of the form defined in the SPMF specification.
readOnly: true
type: object
x-added: iLO 5 1.15
HostName:
description: The DNS Host Name, without any domain information
example: xxxxxxxxxx
nullable: true
readOnly: false
type: string
x-added: iLO 5 1.10
x-longDescription: The value of this property shall be the host name for
this system, as reported by the operating system or hypervisor.
Id:
description: Uniquely identifies the resource within the collection of like
resources.
example: '1'
readOnly: true
type: string
x-added: iLO 5 1.10
x-longDescription: This property represents an identifier for the resource. All
values for resources described by this schema shall comply to the requirements
as described in the Redfish specification.
IndicatorLED:
description: 'The state of the indicator LED.
Defined values are:
* `Unknown`: The state of the Indicator LED cannot be determined.
* `Lit`: The Indicator LED is lit.
* `Blinking`: The Indicator LED is blinking.
* `Off`: The Indicator LED is off.
'
enum:
- Unknown
- Lit
- Blinking
- 'Off'
example: 'Off'
nullable: true
readOnly: false
type: string
x-added: iLO 5 1.10
Links:
description: The links array contains the related resource URIs.
properties:
Chassis:
description: The physical container URI associated with this resource.
items:
properties:
'@odata.id':
example: /Chassis/1/
format: uri
readOnly: true
type: string
x-longDescription: The value of this property shall be the unique
identifier for the resource and it shall be of the form defined
in the SPMF specification.
type: object
readOnly: true
type: array
x-added: iLO 5 1.10
ManagedBy:
description: The Manager URI for this resource.
items:
properties:
'@odata.id':
example: /Managers/1/
format: uri
readOnly: true
type: string
x-longDescription: The value of this property shall be the unique
identifier for the resource and it shall be of the form defined
in the SPMF specification.
type: object
readOnly: true
type: array
x-added: iLO 5 1.10
Oem:
description: This object represents the Oem property.
readOnly: true
readOnly: true
type: object
x-added: iLO 5 1.10
LogServices:
description: The LogService collection URI for this resource.
properties:
'@odata.id':
example: /Systems/1/LogServices/
format: uri
readOnly: true
type: string
x-longDescription: The value of this property shall be the unique identifier
for the resource and it shall be of the form defined in the SPMF specification.
readOnly: true
type: object
x-added: iLO 5 1.10
Manufacturer:
description: The manufacturer or OEM of this system.
example: HPE
nullable: true
readOnly: true
type: string
x-added: iLO 5 1.10
Memory:
description: The central memory in the system.
properties:
'@odata.id':
example: /Systems/1/Memory/
format: uri
readOnly: true
type: string
x-longDescription: The value of this property shall be the unique identifier
for the resource and it shall be of the form defined in the SPMF specification.
readOnly: true
type: object
x-added: iLO 5 1.10
MemoryDomains:
description: A reference to the collection of Memory Domains associated
with this system.
properties:
'@odata.id':
example: /Systems/1/MemoryDomains/
format: uri
readOnly: true
type: string
x-longDescription: The value of this property shall be the unique identifier
for the resource and it shall be of the form defined in the SPMF specification.
readOnly: true
type: object
x-added: iLO 5 1.40
x-longDescription: The value of this property shall be a link to a collection
of type MemoryDomainCollection.
MemorySummary:
description: This object describes the central memory of the system in general
detail.
properties:
Status:
properties:
Health:
description: 'This represents the health state of this resource
in the absence of its dependent resources.
Defined values are:
* `OK`: Normal
* `Warning`: A condition exists that requires attention
* `Critical`: A critical condition exists that requires immediate
attention
'
enum:
- OK
- Warning
- Critical
nullable: true
readOnly: true
type: string
x-added: iLO 5 1.10
x-longDescription: This property shall represent the HealthState
of the resource without considering its dependent resources. The
values shall conform to those defined in the Redfish specification.
HealthRollup:
description: 'This represents the overall health state from the
view of this resource.
Defined values are:
* `OK`: Normal
* `Warning`: A condition exists that requires attention
* `Critical`: A critical condition exists that requires immediate
attention
'
enum:
- OK
- Warning
- Critical
example: OK
nullable: true
readOnly: true
type: string
x-added: iLO 5 1.10
x-longDescription: This property shall represent the HealthState
of the resource and its dependent resources. The values shall
conform to those defined in the Redfish specification.
State:
description: 'This indicates the known state of the resource, such
as if it is enabled.
Defined values are:
* `Enabled`: This function or resource has been enabled.
* `Disabled`: This function or resource has been disabled.
* `StandbyOffline`: This function or resource is enabled, but
awaiting an external action to activate it.
* `StandbySpare`: This function or resource is part of a redundancy
set and is awaiting a failover or other external action to activate
it.
* `InTest`: This function or resource is undergoing testing.
* `Starting`: This function or resource is starting.
* `Absent`: This function or resource is not present or not detected.
* `UnavailableOffline`: This function or resource is present but
cannot be used.
* `Deferring`: The element will not process any commands but will
queue new requests.
* `Quiesced`: The element is enabled but only processes a restricted
set of commands.
* `Updating`: The element is updating and may be unavailable or
degraded.
'
enum:
- Enabled
- Disabled
- StandbyOffline
- StandbySpare
- InTest
- Starting
- Absent
- UnavailableOffline
- Deferring
- Quiesced
- Updating
nullable: true
readOnly: true
type: string
x-added: iLO 5 1.10
x-longDescription: This property shall represent if this component
is available or not and why. Enabled indicates the resource is
available. Disabled indicates the resource has been intentionally
made unavailable but it can be enabled. Offline indicates the
resource is unavailable intentionally and requires action to be
made available. InTest indicates that the component is undergoing
testing. Starting indicates that the resource is on its way to
becoming available. Absent indicates the resources is physically
unavailable.
type: object
x-added: iLO 5 1.10
TotalSystemMemoryGiB:
description: This is the total amount of memory in the system measured
in GiB.
example: '633'
nullable: true
readOnly: true
type: integer
x-added: iLO 5 1.10
x-longDescription: This property shall contain the amount of system
general purpose volatile (RAM) memory as measured in gibibytes.
TotalSystemPersistentMemoryGiB:
description: The total configured, system-accessible persistent memory,
measured in GiB.
example: '0'
nullable: true
readOnly: true
type: number
x-added: iLO 5 1.40
x-longDescription: This property shall contain the total amount of configured
persistent memory available to the system as measured in gibibytes.
type: object
x-added: iLO 5 1.10
Model:
description: The model information that the manufacturer uses to refer to
this system.
example: ProLiant DL360 Gen10
nullable: true
readOnly: true
type: string
x-added: iLO 5 1.10
Name:
description: The name of the resource or array element.
example: Computer System
readOnly: true
type: string
x-added: iLO 5 1.10
NetworkInterfaces:
description: The collection of network interfaces partitioned to this system.
properties:
'@odata.id':
example: /Systems/1/NetworkInterfaces/
format: uri
readOnly: true
type: string
x-longDescription: The value of this property shall be the unique identifier
for the resource and it shall be of the form defined in the SPMF specification.
readOnly: true
type: object
x-added: iLO 5 1.20
Oem:
properties:
Hpe:
properties:
'@odata.context':
format: uri
readOnly: true
type: string
x-longDescription: The value of this property shall be the context
URL that describes the resource according to OData-Protocol and
shall be of the form defined in the SPMF specification.
'@odata.etag':
readOnly: true
type: string
x-longDescription: The value of this property is the Etag of the
resource.
'@odata.id':
format: uri
readOnly: true
type: string
x-longDescription: The value of this property shall be the unique
identifier for the resource and it shall be of the form defined
in the SPMF specification.
'@odata.type':
readOnly: true
type: string
x-longDescription: The value of this property shall be an absolute
URL that specifies the type of the resource and it shall be of
the form defined in the SPMF specification.
Actions:
properties:
'#HpeComputerSystemExt.PowerButton':
properties:
PushType@Redfish.AllowableValues:
description: The supported values for the PushType parameter.
items:
description: 'PushType identifies the type of Action to
be performed.
Defined values are:
* `Press`
* `PressAndHold`
'
enum:
- Press
- PressAndHold
readOnly: true
type: string
type: array
x-longDescription: The supported values for the PushType
parameter.
target:
description: Link to invoke action
type: string
title:
description: Friendly action name
type: string
type: object
'#HpeComputerSystemExt.SecureSystemErase':
properties:
SystemROMAndiLOErase@Redfish.AllowableValues:
description: Action to perform resetting the system BIOS
settings and iLO to manufacturing defaults. It also erases
the user data in the NAND like Active Health System(AHS),
Repository.
readOnly: false
type: boolean
UserDataErase@Redfish.AllowableValues:
description: Action to perform erasing all the user data
on the system including TPMs, persistent memory devices,
storage controller configurations, RAID settings, as well
as the hard drives attached to the system. USB and other
removable media will be excluded.
readOnly: false
type: boolean
target:
description: Link to invoke action
type: string
title:
description: Friendly action name
type: string
type: object
'#HpeComputerSystemExt.ServerSigRecompute':
properties:
target:
description: Link to invoke action
type: string
title:
description: Friendly action name
type: string
type: object
'#HpeComputerSystemExt.SystemReset':
properties:
ResetType@Redfish.AllowableValues:
description: The supported values for the ResetType parameter.
items:
description: 'ResetType identifies the type of Action
to be performed.
Defined values are:
* `ColdBoot`
* `AuxCycle`
'
enum:
- ColdBoot
- AuxCycle
type: string
type: array
x-longDescription: The supported values for the ResetType
parameter.
target:
description: Link to invoke action
type: string
title:
description: Friendly action name
type: string
type: object
type: object
AggregateHealthStatus:
description: The Aggregate Health Status of the System.
properties:
AgentlessManagementService:
description: "This indicates if the Agentless Management Service\
\ is available or not. \n\nDefined values are:\n* `Unavailable`:\
\ The Agentless Management Service is unavailable.\n* `Ready`:\
\ The Agentless Management Service is Ready.\n"
enum:
- Unavailable
- Ready
readOnly: true
type: string
BiosOrHardwareHealth:
description: This indicates the health status of the Overall
system
properties:
Status:
properties:
Health:
description: 'This represents the health state of this
resource in the absence of its dependent resources.
Defined values are:
* `OK`: Normal
* `Warning`: A condition exists that requires attention
* `Critical`: A critical condition exists that requires
immediate attention
'
enum:
- OK
- Warning
- Critical
nullable: true
readOnly: true
type: string
x-longDescription: This property shall represent the
HealthState of the resource without considering its
dependent resources. The values shall conform to those
defined in the Redfish specification.
HealthRollup:
description: 'This represents the overall health state
from the view of this resource.
Defined values are:
* `OK`: Normal
* `Warning`: A condition exists that requires attention
* `Critical`: A critical condition exists that requires
immediate attention
'
enum:
- OK
- Warning
- Critical
nullable: true
readOnly: true
type: string
x-longDescription: This property shall represent the
HealthState of the resource and its dependent resources. The
values shall conform to those defined in the Redfish
specification.
State:
description: 'This indicates the known state of the
resource, such as if it is enabled.
Defined values are:
* `Enabled`: This function or resource has been enabled.
* `Disabled`: This function or resource has been disabled.
* `StandbyOffline`: This function or resource is enabled,
but awaiting an external action to activate it.
* `StandbySpare`: This function or resource is part
of a redundancy set and is awaiting a failover or
other external action to activate it.
* `InTest`: This function or resource is undergoing
testing.
* `Starting`: This function or resource is starting.
* `Absent`: This function or resource is not present
or not detected.
* `UnavailableOffline`: This function or resource
is present but cannot be used.
* `Deferring`: The element will not process any commands
but will queue new requests.
* `Quiesced`: The element is enabled but only processes
a restricted set of commands.
* `Updating`: The element is updating and may be unavailable
or degraded.
'
enum:
- Enabled
- Disabled
- StandbyOffline
- StandbySpare
- InTest
- Starting
- Absent
- UnavailableOffline
- Deferring
- Quiesced
- Updating
nullable: true
readOnly: true
type: string
x-longDescription: This property shall represent if
this component is available or not and why. Enabled
indicates the resource is available. Disabled indicates
the resource has been intentionally made unavailable
but it can be enabled. Offline indicates the resource
is unavailable intentionally and requires action to
be made available. InTest indicates that the component
is undergoing testing. Starting indicates that the
resource is on its way to becoming available. Absent
indicates the resources is physically unavailable.
type: object
readOnly: true
type: object
FanRedundancy:
description: "This indicates if the Fan is redundant or not.\
\ \n\nDefined values are:\n* `Redundant`: The fans are Redundant.\n\
* `NonRedundant`: The fans are not Redundant.\n* `FailedRedundant`:\
\ The Redundant fan has failed.\n* `Unknown`: The Redundant\
\ state is unknown.\n"
enum:
- Redundant
- NonRedundant
- FailedRedundant
- Unknown
readOnly: true
type: string
Fans:
description: This indicates the health status of the Fan system.
properties:
Status:
properties:
Health:
description: 'This represents the health state of this
resource in the absence of its dependent resources.
Defined values are:
* `OK`: Normal
* `Warning`: A condition exists that requires attention
* `Critical`: A critical condition exists that requires
immediate attention
'
enum:
- OK
- Warning
- Critical
nullable: true
readOnly: true
type: string
x-longDescription: This property shall represent the
HealthState of the resource without considering its
dependent resources. The values shall conform to those
defined in the Redfish specification.
HealthRollup:
description: 'This represents the overall health state
from the view of this resource.
Defined values are:
* `OK`: Normal
* `Warning`: A condition exists that requires attention
* `Critical`: A critical condition exists that requires
immediate attention
'
enum:
- OK
- Warning
- Critical
nullable: true
readOnly: true
type: string
x-longDescription: This property shall represent the
HealthState of the resource and its dependent resources. The
values shall conform to those defined in the Redfish
specification.
State:
description: 'This indicates the known state of the
resource, such as if it is enabled.
Defined values are:
* `Enabled`: This function or resource has been enabled.
* `Disabled`: This function or resource has been disabled.
* `StandbyOffline`: This function or resource is enabled,
but awaiting an external action to activate it.
* `StandbySpare`: This function or resource is part
of a redundancy set and is awaiting a failover or
other external action to activate it.
* `InTest`: This function or resource is undergoing
testing.
* `Starting`: This function or resource is starting.
* `Absent`: This function or resource is not present
or not detected.
* `UnavailableOffline`: This function or resource
is present but cannot be used.
* `Deferring`: The element will not process any commands
but will queue new requests.
* `Quiesced`: The element is enabled but only processes
a restricted set of commands.
* `Updating`: The element is updating and may be unavailable
or degraded.
'
enum:
- Enabled
- Disabled
- StandbyOffline
- StandbySpare
- InTest
- Starting
- Absent
- UnavailableOffline
- Deferring
- Quiesced
- Updating
nullable: true
readOnly: true
type: string
x-longDescription: This property shall represent if
this component is available or not and why. Enabled
indicates the resource is available. Disabled indicates
the resource has been intentionally made unavailable
but it can be enabled. Offline indicates the resource
is unavailable intentionally and requires action to
be made available. InTest indicates that the component
is undergoing testing. Starting indicates that the
resource is on its way to becoming available. Absent
indicates the resources is physically unavailable.
type: object
readOnly: true
type: object
Memory:
description: This indicates the health status of the Memory
system.
properties:
Status:
properties:
Health:
description: 'This represents the health state of this
resource in the absence of its dependent resources.
Defined values are:
* `OK`: Normal
* `Warning`: A condition exists that requires attention
* `Critical`: A critical condition exists that requires
immediate attention
'
enum:
- OK
- Warning
- Critical
nullable: true
readOnly: true
type: string
x-longDescription: This property shall represent the
HealthState of the resource without considering its
dependent resources. The values shall conform to those
defined in the Redfish specification.
HealthRollup:
description: 'This represents the overall health state
from the view of this resource.
Defined values are:
* `OK`: Normal
* `Warning`: A condition exists that requires attention
* `Critical`: A critical condition exists that requires
immediate attention
'
enum:
- OK
- Warning
- Critical
nullable: true
readOnly: true
type: string
x-longDescription: This property shall represent the
HealthState of the resource and its dependent resources. The
values shall conform to those defined in the Redfish
specification.
State:
description: 'This indicates the known state of the
resource, such as if it is enabled.
Defined values are:
* `Enabled`: This function or resource has been enabled.
* `Disabled`: This function or resource has been disabled.
* `StandbyOffline`: This function or resource is enabled,
but awaiting an external action to activate it.
* `StandbySpare`: This function or resource is part
of a redundancy set and is awaiting a failover or
other external action to activate it.
* `InTest`: This function or resource is undergoing
testing.
* `Starting`: This function or resource is starting.
* `Absent`: This function or resource is not present
or not detected.
* `UnavailableOffline`: This function or resource
is present but cannot be used.
* `Deferring`: The element will not process any commands
but will queue new requests.
* `Quiesced`: The element is enabled but only processes
a restricted set of commands.
* `Updating`: The element is updating and may be unavailable
or degraded.
'
enum:
- Enabled
- Disabled
- StandbyOffline
- StandbySpare
- InTest
- Starting
- Absent
- UnavailableOffline
- Deferring
- Quiesced
- Updating
nullable: true
readOnly: true
type: string
x-longDescription: This property shall represent if
this component is available or not and why. Enabled
indicates the resource is available. Disabled indicates
the resource has been intentionally made unavailable
but it can be enabled. Offline indicates the resource
is unavailable intentionally and requires action to
be made available. InTest indicates that the component
is undergoing testing. Starting indicates that the
resource is on its way to becoming available. Absent
indicates the resources is physically unavailable.
type: object
readOnly: true
type: object
Network:
description: This indicates the health status of the Network
system.
properties:
Status:
properties:
Health:
description: 'This represents the health state of this
resource in the absence of its dependent resources.
Defined values are:
* `OK`: Normal
* `Warning`: A condition exists that requires attention
* `Critical`: A critical condition exists that requires
immediate attention
'
enum:
- OK
- Warning
- Critical
nullable: true
readOnly: true
type: string
x-longDescription: This property shall represent the
HealthState of the resource without considering its
dependent resources. The values shall conform to those
defined in the Redfish specification.
HealthRollup:
description: 'This represents the overall health state
from the view of this resource.
Defined values are:
* `OK`: Normal
* `Warning`: A condition exists that requires attention
* `Critical`: A critical condition exists that requires
immediate attention
'
enum:
- OK
- Warning
- Critical
nullable: true
readOnly: true
type: string
x-longDescription: This property shall represent the
HealthState of the resource and its dependent resources. The
values shall conform to those defined in the Redfish
specification.
State:
description: 'This indicates the known state of the
resource, such as if it is enabled.
Defined values are:
* `Enabled`: This function or resource has been enabled.
* `Disabled`: This function or resource has been disabled.
* `StandbyOffline`: This function or resource is enabled,
but awaiting an external action to activate it.
* `StandbySpare`: This function or resource is part
of a redundancy set and is awaiting a failover or
other external action to activate it.
* `InTest`: This function or resource is undergoing
testing.
* `Starting`: This function or resource is starting.
* `Absent`: This function or resource is not present
or not detected.
* `UnavailableOffline`: This function or resource
is present but cannot be used.
* `Deferring`: The element will not process any commands
but will queue new requests.
* `Quiesced`: The element is enabled but only processes
a restricted set of commands.
* `Updating`: The element is updating and may be unavailable
or degraded.
'
enum:
- Enabled
- Disabled
- StandbyOffline
- StandbySpare
- InTest
- Starting
- Absent
- UnavailableOffline
- Deferring
- Quiesced
- Updating
nullable: true
readOnly: true
type: string
x-longDescription: This property shall represent if
this component is available or not and why. Enabled
indicates the resource is available. Disabled indicates
the resource has been intentionally made unavailable
but it can be enabled. Offline indicates the resource
is unavailable intentionally and requires action to
be made available. InTest indicates that the component
is undergoing testing. Starting indicates that the
resource is on its way to becoming available. Absent
indicates the resources is physically unavailable.
type: object
readOnly: true
type: object
PowerSupplies:
description: This indicates the health status of the Power Supply
system
properties:
PowerSuppliesMismatch:
description: This indicates if the there is a mismatch in
the power supplies.
readOnly: true
type: boolean
Status:
properties:
Health:
description: 'This represents the health state of this
resource in the absence of its dependent resources.
Defined values are:
* `OK`: Normal
* `Warning`: A condition exists that requires attention
* `Critical`: A critical condition exists that requires
immediate attention
'
enum:
- OK
- Warning
- Critical
nullable: true
readOnly: true
type: string
x-longDescription: This property shall represent the
HealthState of the resource without considering its
dependent resources. The values shall conform to those
defined in the Redfish specification.
HealthRollup:
description: 'This represents the overall health state
from the view of this resource.
Defined values are:
* `OK`: Normal
* `Warning`: A condition exists that requires attention
* `Critical`: A critical condition exists that requires
immediate attention
'
enum:
- OK
- Warning
- Critical
nullable: true
readOnly: true
type: string
x-longDescription: This property shall represent the
HealthState of the resource and its dependent resources. The
values shall conform to those defined in the Redfish
specification.
State:
description: 'This indicates the known state of the
resource, such as if it is enabled.
Defined values are:
* `Enabled`: This function or resource has been enabled.
* `Disabled`: This function or resource has been disabled.
* `StandbyOffline`: This function or resource is enabled,
but awaiting an external action to activate it.
* `StandbySpare`: This function or resource is part
of a redundancy set and is awaiting a failover or
other external action to activate it.
* `InTest`: This function or resource is undergoing
testing.
* `Starting`: This function or resource is starting.
* `Absent`: This function or resource is not present
or not detected.
* `UnavailableOffline`: This function or resource
is present but cannot be used.
* `Deferring`: The element will not process any commands
but will queue new requests.
* `Quiesced`: The element is enabled but only processes
a restricted set of commands.
* `Updating`: The element is updating and may be unavailable
or degraded.
'
enum:
- Enabled
- Disabled
- StandbyOffline
- StandbySpare
- InTest
- Starting
- Absent
- UnavailableOffline
- Deferring
- Quiesced
- Updating
nullable: true
readOnly: true
type: string
x-longDescription: This property shall represent if
this component is available or not and why. Enabled
indicates the resource is available. Disabled indicates
the resource has been intentionally made unavailable
but it can be enabled. Offline indicates the resource
is unavailable intentionally and requires action to
be made available. InTest indicates that the component
is undergoing testing. Starting indicates that the
resource is on its way to becoming available. Absent
indicates the resources is physically unavailable.
type: object
readOnly: true
type: object
PowerSupplyRedundancy:
description: "This indicates if the Power Supply is redundant\
\ or not. \n\nDefined values are:\n* `Redundant`: The power\
\ supplies are Redundant.\n* `NonRedundant`: The power supplies\
\ are not Redundant.\n* `FailedRedundant`: The Redundant power\
\ supply has failed.\n* `Unknown`: The Redundant state is\
\ unknown.\n"
enum:
- Redundant
- NonRedundant
- FailedRedundant
- Unknown
readOnly: true
type: string
Processors:
description: This indicates the health status of the Processor
system.
properties:
Status:
properties:
Health:
description: 'This represents the health state of this
resource in the absence of its dependent resources.
Defined values are:
* `OK`: Normal
* `Warning`: A condition exists that requires attention
* `Critical`: A critical condition exists that requires
immediate attention
'
enum:
- OK
- Warning
- Critical
nullable: true
readOnly: true
type: string
x-longDescription: This property shall represent the
HealthState of the resource without considering its
dependent resources. The values shall conform to those
defined in the Redfish specification.
HealthRollup:
description: 'This represents the overall health state
from the view of this resource.
Defined values are:
* `OK`: Normal
* `Warning`: A condition exists that requires attention
* `Critical`: A critical condition exists that requires
immediate attention
'
enum:
- OK
- Warning
- Critical
nullable: true
readOnly: true
type: string
x-longDescription: This property shall represent the
HealthState of the resource and its dependent resources. The
values shall conform to those defined in the Redfish
specification.
State:
description: 'This indicates the known state of the
resource, such as if it is enabled.
Defined values are:
* `Enabled`: This function or resource has been enabled.
* `Disabled`: This function or resource has been disabled.
* `StandbyOffline`: This function or resource is enabled,
but awaiting an external action to activate it.
* `StandbySpare`: This function or resource is part
of a redundancy set and is awaiting a failover or
other external action to activate it.
* `InTest`: This function or resource is undergoing
testing.
* `Starting`: This function or resource is starting.
* `Absent`: This function or resource is not present
or not detected.
* `UnavailableOffline`: This function or resource
is present but cannot be used.
* `Deferring`: The element will not process any commands
but will queue new requests.
* `Quiesced`: The element is enabled but only processes
a restricted set of commands.
* `Updating`: The element is updating and may be unavailable
or degraded.
'
enum:
- Enabled
- Disabled
- StandbyOffline
- StandbySpare
- InTest
- Starting
- Absent
- UnavailableOffline
- Deferring
- Quiesced
- Updating
nullable: true
readOnly: true
type: string
x-longDescription: This property shall represent if
this component is available or not and why. Enabled
indicates the resource is available. Disabled indicates
the resource has been intentionally made unavailable
but it can be enabled. Offline indicates the resource
is unavailable intentionally and requires action to
be made available. InTest indicates that the component
is undergoing testing. Starting indicates that the
resource is on its way to becoming available. Absent
indicates the resources is physically unavailable.
type: object
readOnly: true
type: object
SmartStorageBattery:
description: This indicates the health status of the Smart Storage
Battery.
properties:
Status:
properties:
Health:
description: 'This represents the health state of this
resource in the absence of its dependent resources.
Defined values are:
* `OK`: Normal
* `Warning`: A condition exists that requires attention
* `Critical`: A critical condition exists that requires
immediate attention
'
enum:
- OK
- Warning
- Critical
nullable: true
readOnly: true
type: string
x-longDescription: This property shall represent the
HealthState of the resource without considering its
dependent resources. The values shall conform to those
defined in the Redfish specification.
HealthRollup:
description: 'This represents the overall health state
from the view of this resource.
Defined values are:
* `OK`: Normal
* `Warning`: A condition exists that requires attention
* `Critical`: A critical condition exists that requires
immediate attention
'
enum:
- OK
- Warning
- Critical
nullable: true
readOnly: true
type: string
x-longDescription: This property shall represent the
HealthState of the resource and its dependent resources. The
values shall conform to those defined in the Redfish
specification.
State:
description: 'This indicates the known state of the
resource, such as if it is enabled.
Defined values are:
* `Enabled`: This function or resource has been enabled.
* `Disabled`: This function or resource has been disabled.
* `StandbyOffline`: This function or resource is enabled,
but awaiting an external action to activate it.
* `StandbySpare`: This function or resource is part
of a redundancy set and is awaiting a failover or
other external action to activate it.
* `InTest`: This function or resource is undergoing
testing.
* `Starting`: This function or resource is starting.
* `Absent`: This function or resource is not present
or not detected.
* `UnavailableOffline`: This function or resource
is present but cannot be used.
* `Deferring`: The element will not process any commands
but will queue new requests.
* `Quiesced`: The element is enabled but only processes
a restricted set of commands.
* `Updating`: The element is updating and may be unavailable
or degraded.
'
enum:
- Enabled
- Disabled
- StandbyOffline
- StandbySpare
- InTest
- Starting
- Absent
- UnavailableOffline
- Deferring
- Quiesced
- Updating
nullable: true
readOnly: true
type: string
x-longDescription: This property shall represent if
this component is available or not and why. Enabled
indicates the resource is available. Disabled indicates
the resource has been intentionally made unavailable
but it can be enabled. Offline indicates the resource
is unavailable intentionally and requires action to
be made available. InTest indicates that the component
is undergoing testing. Starting indicates that the
resource is on its way to becoming available. Absent
indicates the resources is physically unavailable.
type: object
readOnly: true
type: object
Storage:
description: This indicates the health status of the Storage
system.
properties:
Status:
properties:
Health:
description: 'This represents the health state of this
resource in the absence of its dependent resources.
Defined values are:
* `OK`: Normal
* `Warning`: A condition exists that requires attention
* `Critical`: A critical condition exists that requires
immediate attention
'
enum:
- OK
- Warning
- Critical
nullable: true
readOnly: true
type: string
x-longDescription: This property shall represent the
HealthState of the resource without considering its
dependent resources. The values shall conform to those
defined in the Redfish specification.
HealthRollup:
description: 'This represents the overall health state
from the view of this resource.
Defined values are:
* `OK`: Normal
* `Warning`: A condition exists that requires attention
* `Critical`: A critical condition exists that requires
immediate attention
'
enum:
- OK
- Warning
- Critical
nullable: true
readOnly: true
type: string
x-longDescription: This property shall represent the
HealthState of the resource and its dependent resources. The
values shall conform to those defined in the Redfish
specification.
State:
description: 'This indicates the known state of the
resource, such as if it is enabled.
Defined values are:
* `Enabled`: This function or resource has been enabled.
* `Disabled`: This function or resource has been disabled.
* `StandbyOffline`: This function or resource is enabled,
but awaiting an external action to activate it.
* `StandbySpare`: This function or resource is part
of a redundancy set and is awaiting a failover or
other external action to activate it.
* `InTest`: This function or resource is undergoing
testing.
* `Starting`: This function or resource is starting.
* `Absent`: This function or resource is not present
or not detected.
* `UnavailableOffline`: This function or resource
is present but cannot be used.
* `Deferring`: The element will not process any commands
but will queue new requests.
* `Quiesced`: The element is enabled but only processes
a restricted set of commands.
* `Updating`: The element is updating and may be unavailable
or degraded.
'
enum:
- Enabled
- Disabled
- StandbyOffline
- StandbySpare
- InTest
- Starting
- Absent
- UnavailableOffline
- Deferring
- Quiesced
- Updating
nullable: true
readOnly: true
type: string
x-longDescription: This property shall represent if
this component is available or not and why. Enabled
indicates the resource is available. Disabled indicates
the resource has been intentionally made unavailable
but it can be enabled. Offline indicates the resource
is unavailable intentionally and requires action to
be made available. InTest indicates that the component
is undergoing testing. Starting indicates that the
resource is on its way to becoming available. Absent
indicates the resources is physically unavailable.
type: object
readOnly: true
type: object
Temperatures:
description: This indicates the health status of the Temperature
system.
properties:
Status:
properties:
Health:
description: 'This represents the health state of this
resource in the absence of its dependent resources.
Defined values are:
* `OK`: Normal
* `Warning`: A condition exists that requires attention
* `Critical`: A critical condition exists that requires
immediate attention
'
enum:
- OK
- Warning
- Critical
nullable: true
readOnly: true
type: string
x-longDescription: This property shall represent the
HealthState of the resource without considering its
dependent resources. The values shall conform to those
defined in the Redfish specification.
HealthRollup:
description: 'This represents the overall health state
from the view of this resource.
Defined values are:
* `OK`: Normal
* `Warning`: A condition exists that requires attention
* `Critical`: A critical condition exists that requires
immediate attention
'
enum:
- OK
- Warning
- Critical
nullable: true
readOnly: true
type: string
x-longDescription: This property shall represent the
HealthState of the resource and its dependent resources. The
values shall conform to those defined in the Redfish
specification.
State:
description: 'This indicates the known state of the
resource, such as if it is enabled.
Defined values are:
* `Enabled`: This function or resource has been enabled.
* `Disabled`: This function or resource has been disabled.
* `StandbyOffline`: This function or resource is enabled,
but awaiting an external action to activate it.
* `StandbySpare`: This function or resource is part
of a redundancy set and is awaiting a failover or
other external action to activate it.
* `InTest`: This function or resource is undergoing
testing.
* `Starting`: This function or resource is starting.
* `Absent`: This function or resource is not present
or not detected.
* `UnavailableOffline`: This function or resource
is present but cannot be used.
* `Deferring`: The element will not process any commands
but will queue new requests.
* `Quiesced`: The element is enabled but only processes
a restricted set of commands.
* `Updating`: The element is updating and may be unavailable
or degraded.
'
enum:
- Enabled
- Disabled
- StandbyOffline
- StandbySpare
- InTest
- Starting
- Absent
- UnavailableOffline
- Deferring
- Quiesced
- Updating
nullable: true
readOnly: true
type: string
x-longDescription: This property shall represent if
this component is available or not and why. Enabled
indicates the resource is available. Disabled indicates
the resource has been intentionally made unavailable
but it can be enabled. Offline indicates the resource
is unavailable intentionally and requires action to
be made available. InTest indicates that the component
is undergoing testing. Starting indicates that the
resource is on its way to becoming available. Absent
indicates the resources is physically unavailable.
type: object
readOnly: true
type: object
readOnly: true
type: object
Bios:
description: The information about the system BIOS.
properties:
Backup:
properties:
BuildNumber:
description: The build number of the firmware.
readOnly: true
type: integer
BuildNumberString:
description: The string version of the build number of the
firmware.
readOnly: true
type: string
Date:
description: The build date of the firmware.
readOnly: true
type: string
DebugBuild:
description: True if the firmware is a debug build; False
if it is not.
readOnly: true
type: boolean
Family:
description: The family of the firmware.
readOnly: true
type: string
MajorVersion:
description: The major version of the firmware.
readOnly: true
type: integer
MinorVersion:
description: The minor version of the firmware.
readOnly: true
type: integer
Time:
description: The build time of the firmware.
readOnly: true
type: string
VersionString:
description: The version string of the firmware. This value
might be null if VersionString is unavailable.
nullable: true
readOnly: true
type: string
type: object
Bootblock:
properties:
BuildNumber:
description: The build number of the firmware.
readOnly: true
type: integer
BuildNumberString:
description: The string version of the build number of the
firmware.
readOnly: true
type: string
Date:
description: The build date of the firmware.
readOnly: true
type: string
DebugBuild:
description: True if the firmware is a debug build; False
if it is not.
readOnly: true
type: boolean
Family:
description: The family of the firmware.
readOnly: true
type: string
MajorVersion:
description: The major version of the firmware.
readOnly: true
type: integer
MinorVersion:
description: The minor version of the firmware.
readOnly: true
type: integer
Time:
description: The build time of the firmware.
readOnly: true
type: string
VersionString:
description: The version string of the firmware. This value
might be null if VersionString is unavailable.
nullable: true
readOnly: true
type: string
type: object
Current:
properties:
BuildNumber:
description: The build number of the firmware.
readOnly: true
type: integer
BuildNumberString:
description: The string version of the build number of the
firmware.
readOnly: true
type: string
Date:
description: The build date of the firmware.
readOnly: true
type: string
DebugBuild:
description: True if the firmware is a debug build; False
if it is not.
readOnly: true
type: boolean
Family:
description: The family of the firmware.
readOnly: true
type: string
MajorVersion:
description: The major version of the firmware.
readOnly: true
type: integer
MinorVersion:
description: The minor version of the firmware.
readOnly: true
type: integer
Time:
description: The build time of the firmware.
readOnly: true
type: string
VersionString:
description: The version string of the firmware. This value
might be null if VersionString is unavailable.
nullable: true
readOnly: true
type: string
type: object
UefiClass:
description: 'The UEFI BIOS Class value defined in the UEFI
specification.
Defined values are:
* `1`
* `2`
* `3`
'
enum:
- 1
- 2
- 3
readOnly: true
type: integer
readOnly: true
type: object
CurrentPowerOnTimeSeconds:
description: Displays the amount of time(in seconds) that has passed
since the server was last powered on. The data is reset on iLO
reset.
nullable: true
readOnly: true
type: integer
DeviceDiscoveryComplete:
properties:
AMSDeviceDiscovery:
description: 'This property indicates the current AMS Device
Discovery Status.
Defined values are:
* `Busy`: The server has AMS loaded and iLO is discovering
devices that require AMS to be loaded
* `Complete`: The server has AMS loaded and iLO is finished
discovering devices that require AMS to be loaded
* `NoAMS`: The server does not have AMS loaded for device
discovery.
* `Initial`: Default state after iLO has booted.
'
enum:
- Busy
- Complete
- NoAMS
- Initial
nullable: true
readOnly: true
type: string
DeviceDiscovery:
description: 'This property indicates the current device discovery
status of devices that are not Smart Array or AMS related.
Defined values are:
* `Busy`: iLO is discovering devices.
* `vAuxDeviceDiscoveryComplete`: The server is off and iLO
is finished discovering devices.
* `vMainDeviceDiscoveryComplete`: The server is on and iLO
is finished discovering devices.
* `DataIncomplete`: iLO response took longer than expected
while discovering devices.
* `Initial`: Default state after iLO has booted.
'
enum:
- Busy
- vAuxDeviceDiscoveryComplete
- vMainDeviceDiscoveryComplete
- DataIncomplete
- Initial
nullable: true
readOnly: true
type: string
SmartArrayDiscovery:
description: 'This property indicates the current Smart Array
Storage Device Discovery Status
Defined values are:
* `Busy`: iLO is discovering Smart Array devices. If the
server is shutdown before discovery is complete, this reflects
an incomplete data set.
* `PendingSoftwareRAID`: Pending discovery of Dynamic Smart
Array.
* `Complete`: iLO is finished discovering Smart Array storage.
* `Initial`: Default state for Smart Array
* `Cached`: Data is cached, server is offline or data not
yet available.
'
enum:
- Busy
- PendingSoftwareRAID
- Complete
- Initial
- Cached
nullable: true
readOnly: true
type: string
readOnly: true
type: object
ElapsedEraseTimeInMinutes:
description: Reports the time elapsed since the erase started
readOnly: true
type: integer
EndOfPostDelaySeconds:
description: Supported on UEFI based systems only. The number of
seconds to delay before finalizing POST with the Mode action (e.g.
delay before shutdown).
nullable: true
readOnly: false
type: integer
EstimatedEraseTimeInMinutes:
description: Reports the guestimate time (in minutes) for the overall
erase process
readOnly: true
type: integer
HostOS:
properties:
OsName:
description: from cpqHoName if AMS is running
readOnly: true
type: string
OsSysDescription:
description: from cpqHosysDesc if AMS is running
readOnly: true
type: string
OsType:
description: from cpqHoOsType if AMS is running.
readOnly: true
type: integer
OsVersion:
description: from cpqHoVersion if AMS is running
readOnly: true
type: string
type: object
Id:
description: Uniquely identifies the resource within the collection
of like resources.
readOnly: true
type: string
x-longDescription: This property represents an identifier for the
resource. All values for resources described by this schema shall
comply to the requirements as described in the Redfish specification.
IntelligentProvisioningAlwaysOn:
description: Always on Intelligent Provisioning is available.
readOnly: true
type: boolean
IntelligentProvisioningIndex:
description: ' Index in the Firmware Version Table for Intelligent
Provisioning.'
nullable: true
readOnly: true
type: integer
IntelligentProvisioningLocation:
description: ' Location string of Intelligent Provisioning in Firmware
Version Table.'
readOnly: true
type: string
IntelligentProvisioningVersion:
description: ' Intelligent Provisioning Version.'
readOnly: true
type: string
IsColdBooting:
description: Indicates if the system is cold booting.
readOnly: true
type: boolean
Links:
description: The links array contains the links to other resources
that are related to this resource.
properties:
EthernetInterfaces:
description: A reference to the ethernet interfaces associated
with this system.
properties:
'@odata.id':
format: uri
readOnly: true
type: string
x-longDescription: The value of this property shall be the
unique identifier for the resource and it shall be of
the form defined in the SPMF specification.
readOnly: true
type: object
NetworkAdapters:
description: A reference to the network adapters associated
with this system.
properties:
'@odata.id':
format: uri
readOnly: true
type: string
x-longDescription: The value of this property shall be the
unique identifier for the resource and it shall be of
the form defined in the SPMF specification.
readOnly: true
type: object
PCIDevices:
description: A reference to the PCI devices associated with
this system.
properties:
'@odata.id':
format: uri
readOnly: true
type: string
x-longDescription: The value of this property shall be the
unique identifier for the resource and it shall be of
the form defined in the SPMF specification.
readOnly: true
type: object
PCISlots:
description: A reference to the PCI slots associated with this
system.
properties:
'@odata.id':
format: uri
readOnly: true
type: string
x-longDescription: The value of this property shall be the
unique identifier for the resource and it shall be of
the form defined in the SPMF specification.
readOnly: true
type: object
SmartStorage:
description: A reference to the SmartStorage associated with
this system.
properties:
'@odata.id':
format: uri
readOnly: true
type: string
x-longDescription: The value of this property shall be the
unique identifier for the resource and it shall be of
the form defined in the SPMF specification.
readOnly: true
type: object
USBDevices:
description: A reference to the USB Devices that are associated
with this system, detected during server boot.
properties:
'@odata.id':
format: uri
readOnly: true
type: string
x-longDescription: The value of this property shall be the
unique identifier for the resource and it shall be of
the form defined in the SPMF specification.
readOnly: true
type: object
USBPorts:
description: A reference to the USB Port Connectors associated
with this system.
properties:
'@odata.id':
format: uri
readOnly: true
type: string
x-longDescription: The value of this property shall be the
unique identifier for the resource and it shall be of
the form defined in the SPMF specification.
readOnly: true
type: object
WorkloadPerformanceAdvisor:
description: A reference to the Workload Performance Advisor
associated with this system.
properties:
'@odata.id':
format: uri
readOnly: true
type: string
x-longDescription: The value of this property shall be the
unique identifier for the resource and it shall be of
the form defined in the SPMF specification.
readOnly: true
type: object
type: object
PCAPartNumber:
description: The PCA part number.
nullable: true
readOnly: true
type: string
PCASerialNumber:
description: The PCA serial number.
nullable: true
readOnly: true
type: string
PostDiscoveryCompleteTimeStamp:
description: Displays the last known POST Discovery Complete time
format: date-time
nullable: true
readOnly: true
type: string
PostDiscoveryMode:
description: 'The manner in which the system will operate during
the discovery section of POST.
Defined values are:
* `Auto`: BIOS will automatically use ForceFastBoot if the system
hardware has not changed from last time of FullDiscovery or ForceFullDiscovery
if the system hardware has changed.
* `ForceFullDiscovery`: Server makes a full discovery of all devices.
* `ForceFastBoot`: Server uses the existing cached discovery data.
'
enum:
- Auto
- ForceFullDiscovery
- ForceFastBoot
nullable: true
readOnly: false
type: string
PostMode:
description: 'The manner in which the system will operate during
and at completion of POST.
Defined values are:
* `Normal`: Normal operations.
* `PostToShutdown`: Server boots until Discovery Completes, then
shuts down.
* `PostToReboot`: Server boots until Discovery Completes, then
reboots.
'
enum:
- Normal
- PostToShutdown
- PostToReboot
nullable: true
readOnly: false
type: string
PostState:
description: 'The current state of system POST.
Defined values are:
* `Unknown`: iLO was unable to determine the current server state.
* `Reset`: The server is currently in reset.
* `PowerOff`: The server power is off.
* `InPost`: The server is booting and has not reached discovery
complete.
* `InPostDiscoveryComplete`: The server has reached discovery
complete and is now waiting for the installed OS to be booted. Discovery
complete is the point at which it has been deemed safe to read
and write the BIOS configuration information.
* `FinishedPost`: The server has booted the installed OS.
'
enum:
- Unknown
- Reset
- PowerOff
- InPost
- InPostDiscoveryComplete
- FinishedPost
nullable: true
readOnly: true
type: string
PowerAllocationLimit:
description: The total amount of power allocated to the system.
nullable: true
readOnly: true
type: integer
PowerAutoOn:
description: 'Auto Power-On mode defines what occurs when the AC
power is applied to the system.
Defined values are:
* `RemainOff`
* `PowerOn`
* `Restore`
'
enum:
- RemainOff
- PowerOn
- Restore
readOnly: false
type: string
PowerOnDelay:
description: 'The PowerAutoOn policy delay that can also be found
in the HpBios::PowerOnDelay object. Will be null if PowerAutoOn
is set to RemainOff. Blades only support Minimum and RandomUpTo120Sec.
Defined values are:
* `Minimum`
* `15Sec`
* `30Sec`
* `45Sec`
* `60Sec`
* `RandomUpTo120Sec`
'
enum:
- Minimum
- 15Sec
- 30Sec
- 45Sec
- 60Sec
- RandomUpTo120Sec
nullable: true
readOnly: false
type: string
PowerOnMinutes:
description: The number of lifetime minutes that the server has
been powered on.
nullable: true
readOnly: true
type: integer
PowerRegulatorMode:
description: 'Power Regulator mode. Switching to and from OS Control
mode requires a server reboot to take effect.
Defined values are:
* `OSControl`
* `Dynamic`
* `Max`
* `Min`
* `Unknown`
'
enum:
- OSControl
- Dynamic
- Max
- Min
- Unknown
readOnly: false
type: string
PowerRegulatorModesSupported:
description: The power regulator modes supported by the system.
items:
type: string
readOnly: true
type: array
ProcessorJitterControl:
description: Describes the various options to perform Jitter Control
of the processor
properties:
ConfiguredFrequencyLimitMHz:
description: Displays the last known user configured frequency
limit of the processor in MHz.
readOnly: true
type: integer
FrequencyLimitMHz:
description: Current frequency limit of the processor in MHz.
readOnly: false
type: integer
Mode:
description: 'Provides various jitter control modes.
Defined values are:
* `Auto`
* `Disabled`
* `Manual`
'
enum:
- Auto
- Disabled
- Manual
readOnly: false
type: string
ProcessorJitterControlOptimization:
description: 'Provides Jitter Control Optimizations.
Defined values are:
* `OptimizedForThroughput`
* `OptimizedForLatency`
* `ZeroLatency`
'
enum:
- OptimizedForThroughput
- OptimizedForLatency
- ZeroLatency
readOnly: false
type: string
readOnly: false
type: object
SMBIOS:
description: A reference to the SMBIOS records associated with this
system.
properties:
extref:
description: The URI of an external resource.
format: uri
readOnly: true
type: string
readOnly: true
type: object
ServerFQDN:
description: The IP address or FQDN of the server. Host software
like AMS is required to obtain this value from the OS.
readOnly: false
type: string
ServerSignature:
description: ' The CRC32 of: All Device Signatures combined together,
Server Slot Location in Enclosure, Enclosure UUID, and Manager
Domain IP Address'
nullable: true
readOnly: true
type: integer
ServerSignatureStatus:
description: 'The current state of Server Signature.
Defined values are:
* `Initial`: The server signature calculation has not run yet.
* `Busy`: The server signature calculation is being run.
* `Invalid`: The server signature is invalid. Re-compute action
necessary.
* `Complete`: The server signature calculation is complete and
valid.
'
enum:
- Initial
- Busy
- Invalid
- Complete
nullable: true
readOnly: true
type: string
SmartStorageConfig:
description: An array of references to SmartStorage elements associated
with this system.
items:
properties:
'@odata.id':
format: uri
readOnly: true
type: string
x-longDescription: The value of this property shall be the
unique identifier for the resource and it shall be of the
form defined in the SPMF specification.
type: object
readOnly: true
type: array
SystemROMAndiLOEraseComponentStatus:
description: Reports the erase status for individual components
properties:
BIOSSettingsEraseStatus:
description: 'Indicates the erase status of the individual components
Defined values are:
* `Idle`: Indicates SecureSystem Erase is not started
* `Initiated`: Indicates Secure System Erase process is started
* `InProgress`: Indicates Secure System Erase process is under
progress
* `CompletedWithSuccess`: Indicates Secure System Erase process
has been completed with no errors
* `CompletedWithErrors`: Indicates Secure System Erase process
has been completed with some errors
* `Failed`: Indicates Secure System Erase process has failed
'
enum:
- Idle
- Initiated
- InProgress
- CompletedWithSuccess
- CompletedWithErrors
- Failed
nullable: true
readOnly: true
type: string
iLOSettingsEraseStatus:
description: 'Indicates the erase status of the individual components
Defined values are:
* `Idle`: Indicates SecureSystem Erase is not started
* `Initiated`: Indicates Secure System Erase process is started
* `InProgress`: Indicates Secure System Erase process is under
progress
* `CompletedWithSuccess`: Indicates Secure System Erase process
has been completed with no errors
* `CompletedWithErrors`: Indicates Secure System Erase process
has been completed with some errors
* `Failed`: Indicates Secure System Erase process has failed
'
enum:
- Idle
- Initiated
- InProgress
- CompletedWithSuccess
- CompletedWithErrors
- Failed
nullable: true
readOnly: true
type: string
readOnly: true
type: object
SystemROMAndiLOEraseStatus:
description: 'Indicates the erase status of the individual components
Defined values are:
* `Idle`: Indicates SecureSystem Erase is not started
* `Initiated`: Indicates Secure System Erase process is started
* `InProgress`: Indicates Secure System Erase process is under
progress
* `CompletedWithSuccess`: Indicates Secure System Erase process
has been completed with no errors
* `CompletedWithErrors`: Indicates Secure System Erase process
has been completed with some errors
* `Failed`: Indicates Secure System Erase process has failed
'
enum:
- Idle
- Initiated
- InProgress
- CompletedWithSuccess
- CompletedWithErrors
- Failed
nullable: true
readOnly: true
type: string
SystemUsage:
description: Describes the various system utilization parameters
properties:
AvgCPU0Freq:
description: Current CPU0 average frequency in MHz.
readOnly: true
type: integer
AvgCPU1Freq:
description: Current CPU1 average frequency in MHz.
readOnly: true
type: integer
AvgCPU2Freq:
description: Current CPU2 average frequency in MHz.
readOnly: true
type: integer
AvgCPU3Freq:
description: Current CPU3 average frequency in MHz.
readOnly: true
type: integer
CPU0Power:
description: Current power consumed by the system CPU0 in Watts.
readOnly: true
type: integer
CPU1Power:
description: Current power consumed by the system CPU1 in Watts.
readOnly: true
type: integer
CPU2Power:
description: Current power consumed by the system CPU2 in Watts.
readOnly: true
type: integer
CPU3Power:
description: Current power consumed by the system CPU3 in Watts.
readOnly: true
type: integer
CPUICUtil:
description: Current System CPU Interconnect utilization in
percentage
readOnly: true
type: integer
CPUUtil:
description: Current System CPU utilization in percentage
readOnly: true
type: integer
IOBusUtil:
description: Current System I/O bus utilization in percentage
readOnly: true
type: integer
JitterCount:
description: Current processor Jitter Count.
readOnly: true
type: integer
MemoryBusUtil:
description: Current System memory bus utilization in percentage
readOnly: true
type: integer
readOnly: true
type: object
UserDataEraseComponentStatus:
description: Reports the erase status for individual components
of User Data
properties:
NVDIMMEraseStatus:
description: 'Indicates the erase status of the individual components
Defined values are:
* `Idle`: Indicates SecureSystem Erase is not started
* `Initiated`: Indicates Secure System Erase process is started
* `InProgress`: Indicates Secure System Erase process is under
progress
* `CompletedWithSuccess`: Indicates Secure System Erase process
has been completed with no errors
* `CompletedWithErrors`: Indicates Secure System Erase process
has been completed with some errors
* `Failed`: Indicates Secure System Erase process has failed
'
enum:
- Idle
- Initiated
- InProgress
- CompletedWithSuccess
- CompletedWithErrors
- Failed
nullable: true
readOnly: true
type: string
NVMeDrivesEraseStatus:
description: 'Indicates the erase status of the individual components
Defined values are:
* `Idle`: Indicates SecureSystem Erase is not started
* `Initiated`: Indicates Secure System Erase process is started
* `InProgress`: Indicates Secure System Erase process is under
progress
* `CompletedWithSuccess`: Indicates Secure System Erase process
has been completed with no errors
* `CompletedWithErrors`: Indicates Secure System Erase process
has been completed with some errors
* `Failed`: Indicates Secure System Erase process has failed
'
enum:
- Idle
- Initiated
- InProgress
- CompletedWithSuccess
- CompletedWithErrors
- Failed
nullable: true
readOnly: true
type: string
SATADrivesEraseStatus:
description: 'Indicates the erase status of the individual components
Defined values are:
* `Idle`: Indicates SecureSystem Erase is not started
* `Initiated`: Indicates Secure System Erase process is started
* `InProgress`: Indicates Secure System Erase process is under
progress
* `CompletedWithSuccess`: Indicates Secure System Erase process
has been completed with no errors
* `CompletedWithErrors`: Indicates Secure System Erase process
has been completed with some errors
* `Failed`: Indicates Secure System Erase process has failed
'
enum:
- Idle
- Initiated
- InProgress
- CompletedWithSuccess
- CompletedWithErrors
- Failed
nullable: true
readOnly: true
type: string
SmartStorageEraseStatus:
description: 'Indicates the erase status of the individual components
Defined values are:
* `Idle`: Indicates SecureSystem Erase is not started
* `Initiated`: Indicates Secure System Erase process is started
* `InProgress`: Indicates Secure System Erase process is under
progress
* `CompletedWithSuccess`: Indicates Secure System Erase process
has been completed with no errors
* `CompletedWithErrors`: Indicates Secure System Erase process
has been completed with some errors
* `Failed`: Indicates Secure System Erase process has failed
'
enum:
- Idle
- Initiated
- InProgress
- CompletedWithSuccess
- CompletedWithErrors
- Failed
nullable: true
readOnly: true
type: string
TPMEraseStatus:
description: 'Indicates the erase status of the individual components
Defined values are:
* `Idle`: Indicates SecureSystem Erase is not started
* `Initiated`: Indicates Secure System Erase process is started
* `InProgress`: Indicates Secure System Erase process is under
progress
* `CompletedWithSuccess`: Indicates Secure System Erase process
has been completed with no errors
* `CompletedWithErrors`: Indicates Secure System Erase process
has been completed with some errors
* `Failed`: Indicates Secure System Erase process has failed
'
enum:
- Idle
- Initiated
- InProgress
- CompletedWithSuccess
- CompletedWithErrors
- Failed
nullable: true
readOnly: true
type: string
readOnly: true
type: object
UserDataEraseStatus:
description: 'Indicates the erase status of the individual components
Defined values are:
* `Idle`: Indicates SecureSystem Erase is not started
* `Initiated`: Indicates Secure System Erase process is started
* `InProgress`: Indicates Secure System Erase process is under
progress
* `CompletedWithSuccess`: Indicates Secure System Erase process
has been completed with no errors
* `CompletedWithErrors`: Indicates Secure System Erase process
has been completed with some errors
* `Failed`: Indicates Secure System Erase process has failed
'
enum:
- Idle
- Initiated
- InProgress
- CompletedWithSuccess
- CompletedWithErrors
- Failed
nullable: true
readOnly: true
type: string
VirtualProfile:
description: 'The current state of the systems virtual profile. This
profile is the one that, when the server is rebooted, will set
the Virtual properties. Intent is to use this state to determine
whether the server needs to be rebooted so these values are set. Additional
informaiton about the profile will be considered later.
Defined values are:
* `Active`
* `Busy`
* `Inactive`
* `Unknown`
'
enum:
- Active
- Busy
- Inactive
- Unknown
readOnly: true
type: string
VirtualUUID:
description: Used in conjunction with the UUID (Logical) value.
nullable: true
readOnly: true
type: string
readOnly: false
type: object
readOnly: false
type: object
PartNumber:
description: The manufacturer's system part number.
nullable: true
readOnly: true
type: string
x-added: iLO 5 1.10
PowerState:
description: 'This is the current power state of the system
Defined values are:
* `On`
* `Off`
* `Unknown`
* `Reset`
'
enum:
- 'On'
- 'Off'
- Unknown
- Reset
example: 'On'
nullable: true
readOnly: true
type: string
x-added: iLO 5 1.10
x-longDescription: The value of this property shall contain the power state
of the system.
ProcessorSummary:
description: This object describes the central processors of the system
in general detail.
properties:
Count:
description: The number of processors in the system.
example: '2'
nullable: true
readOnly: true
type: integer
x-added: iLO 5 1.10
x-longDescription: This property shall contain the number of central
processors in the system.
Model:
description: The processor model for the primary or majority of processors
in this system.
example: Intel(R) Xeon(R) Gold 5215M CPU @ 2.50GHz
nullable: true
readOnly: true
type: string
x-added: iLO 5 1.10
x-longDescription: This property shall contain the processor model for
the central processors in the system, per the description in Table
22 of the SMBIOS Specification DSP0134 2.8 or later.
Status:
properties:
Health:
description: 'This represents the health state of this resource
in the absence of its dependent resources.
Defined values are:
* `OK`: Normal
* `Warning`: A condition exists that requires attention
* `Critical`: A critical condition exists that requires immediate
attention
'
enum:
- OK
- Warning
- Critical
nullable: true
readOnly: true
type: string
x-added: iLO 5 1.10
x-longDescription: This property shall represent the HealthState
of the resource without considering its dependent resources. The
values shall conform to those defined in the Redfish specification.
HealthRollup:
description: 'This represents the overall health state from the
view of this resource.
Defined values are:
* `OK`: Normal
* `Warning`: A condition exists that requires attention
* `Critical`: A critical condition exists that requires immediate
attention
'
enum:
- OK
- Warning
- Critical
example: OK
nullable: true
readOnly: true
type: string
x-added: iLO 5 1.10
x-longDescription: This property shall represent the HealthState
of the resource and its dependent resources. The values shall
conform to those defined in the Redfish specification.
State:
description: 'This indicates the known state of the resource, such
as if it is enabled.
Defined values are:
* `Enabled`: This function or resource has been enabled.
* `Disabled`: This function or resource has been disabled.
* `StandbyOffline`: This function or resource is enabled, but
awaiting an external action to activate it.
* `StandbySpare`: This function or resource is part of a redundancy
set and is awaiting a failover or other external action to activate
it.
* `InTest`: This function or resource is undergoing testing.
* `Starting`: This function or resource is starting.
* `Absent`: This function or resource is not present or not detected.
* `UnavailableOffline`: This function or resource is present but
cannot be used.
* `Deferring`: The element will not process any commands but will
queue new requests.
* `Quiesced`: The element is enabled but only processes a restricted
set of commands.
* `Updating`: The element is updating and may be unavailable or
degraded.
'
enum:
- Enabled
- Disabled
- StandbyOffline
- StandbySpare
- InTest
- Starting
- Absent
- UnavailableOffline
- Deferring
- Quiesced
- Updating
nullable: true
readOnly: true
type: string
x-added: iLO 5 1.10
x-longDescription: This property shall represent if this component
is available or not and why. Enabled indicates the resource is
available. Disabled indicates the resource has been intentionally
made unavailable but it can be enabled. Offline indicates the
resource is unavailable intentionally and requires action to be
made available. InTest indicates that the component is undergoing
testing. Starting indicates that the resource is on its way to
becoming available. Absent indicates the resources is physically
unavailable.
type: object
x-added: iLO 5 1.10
type: object
x-added: iLO 5 1.10
Processors:
description: The central processors in the system.
properties:
'@odata.id':
example: /Systems/1/Processors/
format: uri
readOnly: true
type: string
x-longDescription: The value of this property shall be the unique identifier
for the resource and it shall be of the form defined in the SPMF specification.
readOnly: true
type: object
x-added: iLO 5 1.10
SKU:
description: SKU for this system.
example: (SKU Number)
nullable: true
readOnly: true
type: string
x-added: iLO 5 1.10
SecureBoot:
description: A reference to the UEFI SecureBoot resource associated with
this system.
properties:
'@odata.id':
example: /Systems/1/SecureBoot/
format: uri
readOnly: true
type: string
x-longDescription: The value of this property shall be the unique identifier
for the resource and it shall be of the form defined in the SPMF specification.
readOnly: true
type: object
x-added: iLO 5 1.10
SerialNumber:
description: The system serial number.
example: xxxxxxxxxx
nullable: true
readOnly: true
type: string
x-added: iLO 5 1.10
Status:
properties:
Health:
description: 'This represents the health state of this resource in the
absence of its dependent resources.
Defined values are:
* `OK`: Normal
* `Warning`: A condition exists that requires attention
* `Critical`: A critical condition exists that requires immediate
attention
'
enum:
- OK
- Warning
- Critical
example: OK
nullable: true
readOnly: true
type: string
x-added: iLO 5 1.10
x-longDescription: This property shall represent the HealthState of
the resource without considering its dependent resources. The values
shall conform to those defined in the Redfish specification.
HealthRollup:
description: 'This represents the overall health state from the view
of this resource.
Defined values are:
* `OK`: Normal
* `Warning`: A condition exists that requires attention
* `Critical`: A critical condition exists that requires immediate
attention
'
enum:
- OK
- Warning
- Critical
nullable: true
readOnly: true
type: string
x-added: iLO 5 1.10
x-longDescription: This property shall represent the HealthState of
the resource and its dependent resources. The values shall conform
to those defined in the Redfish specification.
State:
description: 'This indicates the known state of the resource, such as
if it is enabled.
Defined values are:
* `Enabled`: This function or resource has been enabled.
* `Disabled`: This function or resource has been disabled.
* `StandbyOffline`: This function or resource is enabled, but awaiting
an external action to activate it.
* `StandbySpare`: This function or resource is part of a redundancy
set and is awaiting a failover or other external action to activate
it.
* `InTest`: This function or resource is undergoing testing.
* `Starting`: This function or resource is starting.
* `Absent`: This function or resource is not present or not detected.
* `UnavailableOffline`: This function or resource is present but cannot
be used.
* `Deferring`: The element will not process any commands but will
queue new requests.
* `Quiesced`: The element is enabled but only processes a restricted
set of commands.
* `Updating`: The element is updating and may be unavailable or degraded.
'
enum:
- Enabled
- Disabled
- StandbyOffline
- StandbySpare
- InTest
- Starting
- Absent
- UnavailableOffline
- Deferring
- Quiesced
- Updating
example: Enabled
nullable: true
readOnly: true
type: string
x-added: iLO 5 1.10
x-longDescription: This property shall represent if this component is
available or not and why. Enabled indicates the resource is available. Disabled
indicates the resource has been intentionally made unavailable but
it can be enabled. Offline indicates the resource is unavailable
intentionally and requires action to be made available. InTest indicates
that the component is undergoing testing. Starting indicates that
the resource is on its way to becoming available. Absent indicates
the resources is physically unavailable.
type: object
x-added: iLO 5 1.10
Storage:
description: A reference to the collection of storage devices associated
with this system.
properties:
'@odata.id':
example: /Systems/1/Storage/
format: uri
readOnly: true
type: string
x-longDescription: The value of this property shall be the unique identifier
for the resource and it shall be of the form defined in the SPMF specification.
readOnly: true
type: object
x-added: iLO 5 1.10
SystemType:
description: 'The type of computer system that this resource represents.
Defined values are:
* `Physical`: A computer system
* `Virtual`: A virtual machine instance running on this system
* `OS`: An operating system instance
* `PhysicallyPartitioned`: A hardware-based partition of a computer system
* `VirtuallyPartitioned`: A virtual or software-based partition of a computer
system
'
enum:
- Physical
- Virtual
- OS
- PhysicallyPartitioned
- VirtuallyPartitioned
example: Physical
readOnly: true
type: string
x-added: iLO 5 1.10
TrustedModules:
description: This object describes the array of Trusted Modules in the system.
items:
description: This object describes the inventory of a Trusted Modules
installed in the system.
properties:
FirmwareVersion:
description: The firmware version of this Trusted Module
example: '73.0'
nullable: true
readOnly: true
type: string
x-added: iLO 5 1.10
InterfaceType:
description: 'This property indicates the interface type of the Trusted
Module.
Defined values are:
* `TM1_0`: Trusted Module (TM) 1.0
* `TPM1_2`: Trusted Platform Module (TPM) 1.2
* `TPM2_0`: Trusted Platform Module (TPM) 2.0
'
enum:
- TM1_0
- TPM1_2
- TPM2_0
example: TPM2_0
nullable: true
readOnly: true
type: string
x-added: iLO 5 1.10
Oem:
properties:
Hpe:
description: The schema definition for the HPE extended properties
of a memory module.
properties:
'@odata.context':
format: uri
readOnly: true
type: string
x-longDescription: The value of this property shall be the
context URL that describes the resource according to OData-Protocol
and shall be of the form defined in the SPMF specification.
'@odata.etag':
readOnly: true
type: string
x-longDescription: The value of this property is the Etag
of the resource.
'@odata.type':
readOnly: true
type: string
x-longDescription: The value of this property shall be an
absolute URL that specifies the type of the resource and
it shall be of the form defined in the SPMF specification.
VendorName:
description: 'Trusted module vendor name.
Defined values are:
* `None`
* `STMicro`
* `Intel`
* `Nationz`
* `Unknown`
'
enum:
- None
- STMicro
- Intel
- Nationz
- Unknown
readOnly: true
type: string
readOnly: true
type: object
readOnly: false
type: object
Status:
properties:
Health:
description: 'This represents the health state of this resource
in the absence of its dependent resources.
Defined values are:
* `OK`: Normal
* `Warning`: A condition exists that requires attention
* `Critical`: A critical condition exists that requires immediate
attention
'
enum:
- OK
- Warning
- Critical
example: OK
nullable: true
readOnly: true
type: string
x-added: iLO 5 1.10
x-longDescription: This property shall represent the HealthState
of the resource without considering its dependent resources.
The values shall conform to those defined in the Redfish specification.
HealthRollup:
description: 'This represents the overall health state from the
view of this resource.
Defined values are:
* `OK`: Normal
* `Warning`: A condition exists that requires attention
* `Critical`: A critical condition exists that requires immediate
attention
'
enum:
- OK
- Warning
- Critical
nullable: true
readOnly: true
type: string
x-added: iLO 5 1.10
x-longDescription: This property shall represent the HealthState
of the resource and its dependent resources. The values shall
conform to those defined in the Redfish specification.
State:
description: 'This indicates the known state of the resource,
such as if it is enabled.
Defined values are:
* `Enabled`: This function or resource has been enabled.
* `Disabled`: This function or resource has been disabled.
* `StandbyOffline`: This function or resource is enabled, but
awaiting an external action to activate it.
* `StandbySpare`: This function or resource is part of a redundancy
set and is awaiting a failover or other external action to activate
it.
* `InTest`: This function or resource is undergoing testing.
* `Starting`: This function or resource is starting.
* `Absent`: This function or resource is not present or not
detected.
* `UnavailableOffline`: This function or resource is present
but cannot be used.
* `Deferring`: The element will not process any commands but
will queue new requests.
* `Quiesced`: The element is enabled but only processes a restricted
set of commands.
* `Updating`: The element is updating and may be unavailable
or degraded.
'
enum:
- Enabled
- Disabled
- StandbyOffline
- StandbySpare
- InTest
- Starting
- Absent
- UnavailableOffline
- Deferring
- Quiesced
- Updating
example: Enabled
nullable: true
readOnly: true
type: string
x-added: iLO 5 1.10
x-longDescription: This property shall represent if this component
is available or not and why. Enabled indicates the resource
is available. Disabled indicates the resource has been intentionally
made unavailable but it can be enabled. Offline indicates the
resource is unavailable intentionally and requires action to
be made available. InTest indicates that the component is undergoing
testing. Starting indicates that the resource is on its way
to becoming available. Absent indicates the resources is physically
unavailable.
type: object
x-added: iLO 5 1.10
type: object
readOnly: true
type: array
x-added: iLO 5 1.10
UUID:
description: The universal unique identifier for this system.
example: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
nullable: true
readOnly: true
type: string
x-added: iLO 5 1.10
readOnly: false
type: object
ComputerSystem.Reset:
properties:
ResetType:
description: 'Defined values are:
* `On`
* `ForceOff`
* `ForceRestart`
* `Nmi`
* `PushPowerButton`
'
enum:
- 'On'
- ForceOff
- ForceRestart
- Nmi
- PushPowerButton
type: string
type: object
ComputerSystem.Update:
description: The schema definition of a computer system and its properties.
A computer system represents a physical or virtual machine and the local resources,
such as memory, CPU, and other devices that can be accessed from that machine.
properties:
Actions:
properties:
'#ComputerSystem.Reset':
properties:
ResetType@Redfish.AllowableValues:
description: The supported values for the ResetType parameter.
items:
description: 'Defined values are:
* `On`
* `ForceOff`
* `ForceRestart`
* `Nmi`
* `PushPowerButton`
'
enum:
- 'On'
- ForceOff
- ForceRestart
- Nmi
- PushPowerButton
type: string
type: array
x-longDescription: The supported values for the ResetType parameter.
target:
description: Link to invoke action
type: string
title:
description: Friendly action name
type: string
type: object
type: object
AssetTag:
description: A user-definable tag that is used to track this system for
inventory or other client purposes.
example: Lorem ipsum dolor sit amet.
nullable: true
readOnly: false
type: string
BiosVersion:
description: The version of the system BIOS or primary system firmware.
nullable: true
type: string
x-longDescription: The value of this property shall be the version string
of the currently installed and running BIOS (for x86 systems). For other
systems, the value may contain a version string representing the primary
system firmware.
Boot:
description: The boot information for the current resource.
properties:
BootSourceOverrideEnabled:
description: 'BootSourceOverrideTarget must be specified before BootSourceOverrideEnabled
can be used.
Defined values are:
* `Disabled`: The system will boot normally.
* `Once`: On its next boot cycle, the system will boot (one time)
to the Boot Source Override Target. The value of BootSourceOverrideEnabled
is then reset back to Disabled.
* `Continuous`: The system will boot to the target specified in the
BootSourceOverrideTarget until this property is set to Disabled.
'
enum:
- Disabled
- Once
- Continuous
nullable: true
readOnly: false
type: string
BootSourceOverrideMode:
description: 'Defined values are:
* `Legacy`: The system will boot in non-UEFI boot mode to the Boot
Source Override Target.
* `UEFI`: The system will boot in UEFI boot mode to the Boot Source
Override Target.
'
enum:
- Legacy
- UEFI
readOnly: false
type: string
BootSourceOverrideTarget:
description: The current boot source to be used at next boot instead
of the normal boot device, if BootSourceOverrideEnabled is true.
nullable: true
readOnly: false
type: string
x-longDescription: The value of this property shall contain the source
to boot the system from, overriding the normal boot order. The valid
values for this property are specified through the Redfish.AllowableValues
annotation. Pxe indicates to PXE boot from the primary NIC; Floppy,
Cd, Usb, Hdd indicates to boot from their devices respectively. BiosSetup
indicates to boot into the native BIOS screen setup. Utilities and
Diags indicate to boot from the local utilities or diags partitions
and UefiTarget indicates to boot from the UEFI device path found in
UefiTargetBootSourceOverride.
UefiTargetBootSourceOverride:
description: This property is the UEFI Device Path of the device to
boot from when BootSourceOverrideTarget is UefiTarget.
nullable: true
readOnly: false
type: string
x-longDescription: The value of this property shall be the UEFI device
path of the override boot target. The valid values for this property
are specified through the Redfish.AllowableValues annotation. BootSourceOverrideEnabled
= Continuous is not supported for UEFI Boot Source Override as this
setting is defined in UEFI as a one time boot only.
readOnly: false
type: object
HostName:
description: The DNS Host Name, without any domain information
example: xxxxxxxxxx
nullable: true
readOnly: false
type: string
x-longDescription: The value of this property shall be the host name for
this system, as reported by the operating system or hypervisor.
IndicatorLED:
description: 'The state of the indicator LED.
Defined values are:
* `Unknown`: The state of the Indicator LED cannot be determined.
* `Lit`: The Indicator LED is lit.
* `Blinking`: The Indicator LED is blinking.
* `Off`: The Indicator LED is off.
'
enum:
- Unknown
- Lit
- Blinking
- 'Off'
nullable: true
readOnly: false
type: string
Oem:
properties:
Hpe:
properties:
Actions:
properties:
'#HpeComputerSystemExt.PowerButton':
properties:
target:
description: Link to invoke action
type: string
title:
description: Friendly action name
type: string
type: object
'#HpeComputerSystemExt.SecureSystemErase':
properties:
SystemROMAndiLOErase@Redfish.AllowableValues:
description: Action to perform resetting the system BIOS
settings and iLO to manufacturing defaults. It also erases
the user data in the NAND like Active Health System(AHS),
Repository.
readOnly: false
type: boolean
UserDataErase@Redfish.AllowableValues:
description: Action to perform erasing all the user data
on the system including TPMs, persistent memory devices,
storage controller configurations, RAID settings, as well
as the hard drives attached to the system. USB and other
removable media will be excluded.
readOnly: false
type: boolean
target:
description: Link to invoke action
type: string
title:
description: Friendly action name
type: string
type: object
'#HpeComputerSystemExt.ServerSigRecompute':
properties:
target:
description: Link to invoke action
type: string
title:
description: Friendly action name
type: string
type: object
'#HpeComputerSystemExt.SystemReset':
properties:
ResetType@Redfish.AllowableValues:
description: The supported values for the ResetType parameter.
items:
description: 'ResetType identifies the type of Action
to be performed.
Defined values are:
* `ColdBoot`
* `AuxCycle`
'
enum:
- ColdBoot
- AuxCycle
type: string
type: array
x-longDescription: The supported values for the ResetType
parameter.
target:
description: Link to invoke action
type: string
title:
description: Friendly action name
type: string
type: object
type: object
EndOfPostDelaySeconds:
description: Supported on UEFI based systems only. The number of
seconds to delay before finalizing POST with the Mode action (e.g.
delay before shutdown).
nullable: true
readOnly: false
type: integer
PostDiscoveryMode:
description: 'The manner in which the system will operate during
the discovery section of POST.
Defined values are:
* `Auto`: BIOS will automatically use ForceFastBoot if the system
hardware has not changed from last time of FullDiscovery or ForceFullDiscovery
if the system hardware has changed.
* `ForceFullDiscovery`: Server makes a full discovery of all devices.
* `ForceFastBoot`: Server uses the existing cached discovery data.
'
enum:
- Auto
- ForceFullDiscovery
- ForceFastBoot
nullable: true
readOnly: false
type: string
PostMode:
description: 'The manner in which the system will operate during
and at completion of POST.
Defined values are:
* `Normal`: Normal operations.
* `PostToShutdown`: Server boots until Discovery Completes, then
shuts down.
* `PostToReboot`: Server boots until Discovery Completes, then
reboots.
'
enum:
- Normal
- PostToShutdown
- PostToReboot
nullable: true
readOnly: false
type: string
PowerAutoOn:
description: 'Auto Power-On mode defines what occurs when the AC
power is applied to the system.
Defined values are:
* `RemainOff`
* `PowerOn`
* `Restore`
'
enum:
- RemainOff
- PowerOn
- Restore
readOnly: false
type: string
PowerOnDelay:
description: 'The PowerAutoOn policy delay that can also be found
in the HpBios::PowerOnDelay object. Will be null if PowerAutoOn
is set to RemainOff. Blades only support Minimum and RandomUpTo120Sec.
Defined values are:
* `Minimum`
* `15Sec`
* `30Sec`
* `45Sec`
* `60Sec`
* `RandomUpTo120Sec`
'
enum:
- Minimum
- 15Sec
- 30Sec
- 45Sec
- 60Sec
- RandomUpTo120Sec
nullable: true
readOnly: false
type: string
PowerRegulatorMode:
description: 'Power Regulator mode. Switching to and from OS Control
mode requires a server reboot to take effect.
Defined values are:
* `OSControl`
* `Dynamic`
* `Max`
* `Min`
* `Unknown`
'
enum:
- OSControl
- Dynamic
- Max
- Min
- Unknown
readOnly: false
type: string
ProcessorJitterControl:
description: Describes the various options to perform Jitter Control
of the processor
properties:
FrequencyLimitMHz:
description: Current frequency limit of the processor in MHz.
readOnly: false
type: integer
Mode:
description: 'Provides various jitter control modes.
Defined values are:
* `Auto`
* `Disabled`
* `Manual`
'
enum:
- Auto
- Disabled
- Manual
readOnly: false
type: string
ProcessorJitterControlOptimization:
description: 'Provides Jitter Control Optimizations.
Defined values are:
* `OptimizedForThroughput`
* `OptimizedForLatency`
* `ZeroLatency`
'
enum:
- OptimizedForThroughput
- OptimizedForLatency
- ZeroLatency
readOnly: false
type: string
readOnly: false
type: object
ServerFQDN:
description: The IP address or FQDN of the server. Host software
like AMS is required to obtain this value from the OS.
readOnly: false
type: string
readOnly: false
type: object
readOnly: false
type: object
readOnly: false
type: object
ComputerSystemCollection:
properties:
'@odata.context':
example: /$metadata#ComputerSystemCollection.ComputerSystemCollection
format: uri
readOnly: true
type: string
x-longDescription: The value of this property shall be the context URL that
describes the resource according to OData-Protocol and shall be of the
form defined in the SPMF specification.
'@odata.etag':
example: W/\AA6D42B0\""
readOnly: true
type: string
x-longDescription: The value of this property is the Etag of the resource.
'@odata.id':
example: /Systems/
format: uri
readOnly: true
type: string
x-longDescription: The value of this property shall be the unique identifier
for the resource and it shall be of the form defined in the SPMF specification.
'@odata.type':
example: '#ComputerSystemCollection.ComputerSystemCollection'
readOnly: true
type: string
x-longDescription: The value of this property shall be an absolute URL that
specifies the type of the resource and it shall be of the form defined
in the SPMF specification.
Description:
description: Provides a description of this resource and is used for commonality in
the schema definitions.
example: Computer Systems view
nullable: true
readOnly: true
type: string
x-longDescription: This object represents the Description property. All
values for resources described by this schema shall comply to the requirements
as described in the Redfish specification.
Members:
description: Contains the members of this collection.
items:
properties:
'@odata.id':
example: /Systems/1/
format: uri
readOnly: true
type: string
x-longDescription: The value of this property shall be the unique
identifier for the resource and it shall be of the form defined
in the SPMF specification.
type: object
readOnly: true
type: array
Members@odata.count:
description: The total number of collection members.
example: '1'
readOnly: true
type: integer
Name:
description: The name of the resource or array element.
example: Computer Systems
readOnly: true
type: string
Oem:
description: This object represents the Oem property.
readOnly: true
x-longDescription: The value of this string shall be of the format for the
reserved word *Oem*.
type: object
Drive:
properties:
'@odata.context':
example: /$metadata#Drive.Drive
format: uri
readOnly: true
type: string
x-longDescription: The value of this property shall be the context URL that
describes the resource according to OData-Protocol and shall be of the
form defined in the SPMF specification.
'@odata.etag':
example: W/\FA24AEE7\""
readOnly: true
type: string
x-longDescription: The value of this property is the Etag of the resource.
'@odata.id':
example: /Chassis/1/Drives/d4f73b6b/
format: uri
readOnly: true
type: string
x-longDescription: The value of this property shall be the unique identifier
for the resource and it shall be of the form defined in the SPMF specification.
'@odata.type':
example: '#Drive.v1_0_0.Drive'
readOnly: true
type: string
x-longDescription: The value of this property shall be an absolute URL that
specifies the type of the resource and it shall be of the form defined
in the SPMF specification.
BlockSizeBytes:
description: The size of the smallest addressible unit (Block) of this drive
in bytes
nullable: true
type: integer
x-added: iLO 5 1.10
CapableSpeedGbs:
description: The speed which this drive can communicate to a storage controller
in ideal conditions in Gigabits per second
nullable: true
type: integer
x-added: iLO 5 1.10
CapacityBytes:
description: The size in bytes of this Drive
example: '400088000000'
nullable: true
type: integer
x-added: iLO 5 1.10
FailurePredicted:
description: Is this drive currently predicting a failure in the near future
example: 'false'
nullable: true
type: boolean
x-added: iLO 5 1.10
Id:
description: Uniquely identifies the resource within the collection of like
resources.
example: d4f73b6b
readOnly: true
type: string
x-added: iLO 5 1.10
x-longDescription: This property represents an identifier for the resource. All
values for resources described by this schema shall comply to the requirements
as described in the Redfish specification.
Identifiers:
description: The Durable names for the drive
properties:
DurableName:
description: This indicates the world wide, persistent name of the resource.
nullable: true
type: string
x-added: iLO 5 1.10
DurableNameFormat:
description: 'This represents the format of the DurableName property.
Defined values are:
* `EUI`: IEEE-defined 64-bit Extended Unique Identifier
'
enum:
- EUI
nullable: true
type: string
x-added: iLO 5 1.10
type: object
x-added: iLO 5 1.10
Links:
properties:
Volumes:
description: A reference to the Volumes associated with this drive.
items:
properties:
'@odata.id':
format: uri
readOnly: true
type: string
x-longDescription: The value of this property shall be the unique
identifier for the resource and it shall be of the form defined
in the SPMF specification.
type: object
readOnly: true
type: array
x-added: iLO 5 1.10
type: object
x-added: iLO 5 1.10
Location:
items:
description: The Location of the drive
properties:
Info:
description: This indicates the location of the resource.
example: '1:9'
nullable: true
type: string
x-added: iLO 5 1.10
InfoFormat:
description: 'This represents the format of the Info property.
Defined values are:
* `Box:Bay`: The Info is the box and bay number of the Drive.
* `BayNumber`: The Info is the bay number of the Drive.
* `Slot`: The Info is the PCIe slot of the Drive (eg: NVMe drives).
'
enum:
- Box:Bay
- BayNumber
- Slot
example: Box:Bay
nullable: true
type: string
x-added: iLO 5 1.10
type: object
type: array
x-added: iLO 5 1.10
Manufacturer:
description: This is the manufacturer of this drive.
nullable: true
type: string
x-added: iLO 5 1.10
MediaType:
description: 'The type of media contained in this drive.
Defined values are:
* `HDD`: The drive media type is traditional magnetic platters
* `SSD`: The drive media type is solid state or flash memory
'
enum:
- HDD
- SSD
example: SSD
nullable: true
type: string
x-added: iLO 5 1.10
Model:
description: This is the model number for the drive.
example: VO0400KEFJB
nullable: true
type: string
x-added: iLO 5 1.10
Name:
description: The name of the resource or array element.
readOnly: true
type: string
x-added: iLO 5 1.10
NegotiatedSpeedGbs:
description: The speed which this drive is currently communicating to the
storage controller in Gigabits per second
nullable: true
type: integer
x-added: iLO 5 1.10
Oem:
properties:
Hpe:
properties:
'@odata.context':
format: uri
readOnly: true
type: string
x-longDescription: The value of this property shall be the context
URL that describes the resource according to OData-Protocol and
shall be of the form defined in the SPMF specification.
'@odata.etag':
readOnly: true
type: string
x-longDescription: The value of this property is the Etag of the
resource.
'@odata.type':
readOnly: true
type: string
x-longDescription: The value of this property shall be an absolute
URL that specifies the type of the resource and it shall be of
the form defined in the SPMF specification.
CriticalWarning:
description: 'Failure information reported by the drive.
Defined values are:
* `AvailableSpareSpace`: Available spare space has fallen below
the threshold.
* `TemperatureTheshold`: A temperature is above an over temperature
threshold or below an under temperature threshold.
* `ReliabilityError`: The NVM subsystem reliability has been degraded
due to significant media related errors or any internal error
that degrades NVM subsystem reliability.
* `ReadOnlyMode`: The media has been placed in read only mode.
* `VolatileBackupFailure`: The volatile memory backup device has
failed. This field is only valid if the controller has a volatile
memory backup solution
'
enum:
- AvailableSpareSpace
- TemperatureTheshold
- ReliabilityError
- ReadOnlyMode
- VolatileBackupFailure
readOnly: true
type: string
CurrentTemperatureCelsius:
description: The current temperature of the drive
readOnly: true
type: integer
DriveStatus:
description: Drive status as reported by drive or System BIOS, depending
on HealthUpdated.
properties:
Health:
description: 'This represents the health state of this resource
in the absence of its dependent resources.
Defined values are:
* `OK`: Normal
* `Warning`: A condition exists that requires attention
* `Critical`: A critical condition exists that requires immediate
attention
'
enum:
- OK
- Warning
- Critical
nullable: true
readOnly: true
type: string
x-longDescription: This property shall represent the HealthState
of the resource without considering its dependent resources.
The values shall conform to those defined in the Redfish specification.
HealthRollup:
description: 'This represents the overall health state from
the view of this resource.
Defined values are:
* `OK`: Normal
* `Warning`: A condition exists that requires attention
* `Critical`: A critical condition exists that requires immediate
attention
'
enum:
- OK
- Warning
- Critical
nullable: true
readOnly: true
type: string
x-longDescription: This property shall represent the HealthState
of the resource and its dependent resources. The values shall
conform to those defined in the Redfish specification.
State:
description: 'This indicates the known state of the resource,
such as if it is enabled.
Defined values are:
* `Enabled`: This function or resource has been enabled.
* `Disabled`: This function or resource has been disabled.
* `StandbyOffline`: This function or resource is enabled,
but awaiting an external action to activate it.
* `StandbySpare`: This function or resource is part of a redundancy
set and is awaiting a failover or other external action to
activate it.
* `InTest`: This function or resource is undergoing testing.
* `Starting`: This function or resource is starting.
* `Absent`: This function or resource is not present or not
detected.
* `UnavailableOffline`: This function or resource is present
but cannot be used.
* `Deferring`: The element will not process any commands but
will queue new requests.
* `Quiesced`: The element is enabled but only processes a
restricted set of commands.
* `Updating`: The element is updating and may be unavailable
or degraded.
'
enum:
- Enabled
- Disabled
- StandbyOffline
- StandbySpare
- InTest
- Starting
- Absent
- UnavailableOffline
- Deferring
- Quiesced
- Updating
nullable: true
readOnly: true
type: string
x-longDescription: This property shall represent if this component
is available or not and why. Enabled indicates the resource
is available. Disabled indicates the resource has been intentionally
made unavailable but it can be enabled. Offline indicates
the resource is unavailable intentionally and requires action
to be made available. InTest indicates that the component
is undergoing testing. Starting indicates that the resource
is on its way to becoming available. Absent indicates the
resources is physically unavailable.
type: object
HealthUpdated:
description: 'Describes how drive health related data (FailurePredicted,
PredictedMediaLifeLeftPercent, Status, DriveStatus, CriticalWarning,
WearStatus) are updated.
Defined values are:
* `Boot`: The health related properties are updated when the system
boot and are not updated at runtime.
* `Dynamic`: The health related properties are updated periodically
at runtime.
'
enum:
- Boot
- Dynamic
readOnly: true
type: string
NVMeId:
description: 'NVMe Identifier: ModelName, SerialNumber, PCI-Vendor-ID.'
readOnly: true
type: string
PowerOnHours:
description: The number of lifetime hours that the drive has been
powered on. The value is null if the disk power on hours cannot
be determined or is not supported.
nullable: true
readOnly: true
type: integer
TemperatureStatus:
description: Drive temperature status.
properties:
Health:
description: 'This represents the health state of this resource
in the absence of its dependent resources.
Defined values are:
* `OK`: Normal
* `Warning`: A condition exists that requires attention
* `Critical`: A critical condition exists that requires immediate
attention
'
enum:
- OK
- Warning
- Critical
nullable: true
readOnly: true
type: string
x-longDescription: This property shall represent the HealthState
of the resource without considering its dependent resources.
The values shall conform to those defined in the Redfish specification.
HealthRollup:
description: 'This represents the overall health state from
the view of this resource.
Defined values are:
* `OK`: Normal
* `Warning`: A condition exists that requires attention
* `Critical`: A critical condition exists that requires immediate
attention
'
enum:
- OK
- Warning
- Critical
nullable: true
readOnly: true
type: string
x-longDescription: This property shall represent the HealthState
of the resource and its dependent resources. The values shall
conform to those defined in the Redfish specification.
State:
description: 'This indicates the known state of the resource,
such as if it is enabled.
Defined values are:
* `Enabled`: This function or resource has been enabled.
* `Disabled`: This function or resource has been disabled.
* `StandbyOffline`: This function or resource is enabled,
but awaiting an external action to activate it.
* `StandbySpare`: This function or resource is part of a redundancy
set and is awaiting a failover or other external action to
activate it.
* `InTest`: This function or resource is undergoing testing.
* `Starting`: This function or resource is starting.
* `Absent`: This function or resource is not present or not
detected.
* `UnavailableOffline`: This function or resource is present
but cannot be used.
* `Deferring`: The element will not process any commands but
will queue new requests.
* `Quiesced`: The element is enabled but only processes a
restricted set of commands.
* `Updating`: The element is updating and may be unavailable
or degraded.
'
enum:
- Enabled
- Disabled
- StandbyOffline
- StandbySpare
- InTest
- Starting
- Absent
- UnavailableOffline
- Deferring
- Quiesced
- Updating
nullable: true
readOnly: true
type: string
x-longDescription: This property shall represent if this component
is available or not and why. Enabled indicates the resource
is available. Disabled indicates the resource has been intentionally
made unavailable but it can be enabled. Offline indicates
the resource is unavailable intentionally and requires action
to be made available. InTest indicates that the component
is undergoing testing. Starting indicates that the resource
is on its way to becoming available. Absent indicates the
resources is physically unavailable.
type: object
WearStatus:
description: 'The wear status of the drive, an estimation of remaining
life span.
Defined values are:
* `OK`: The SSD is not in any imminent danger of wear out.
* `FiftySixDayThreshold`: Indicates that based upon the current
workload, the solid state disk will reach the maximum usage limit
for writes (wear out) within fifty-six days. You should modify
your write workload or begin preparing to replace your SSD drive
* `FivePercentThreshold`: Indicates that the solid state disk
has passed the five percent threshold and is at or below five
percent of reaching the maximum usage limit for writes (wear out).
You should begin to prepare to replace your SSD drive.
* `TwoPercentThreshold`: Indicates that the solid state disk has
passed the two percent threshold and is at or below two percent
of reaching the maximum usage limit for writes (wear out). You
should begin to prepare to replace your SSD drive.
* `SSDWearOut`: Indicates that a solid state drive is approaching
the maximum usage limit for writes (wear out) and should be replaced
as soon as possible.
* `Unknown`: The SSD wear status cannot be determined.
'
enum:
- OK
- FiftySixDayThreshold
- FivePercentThreshold
- TwoPercentThreshold
- SSDWearOut
- Unknown
readOnly: true
type: string
readOnly: true
type: object
readOnly: false
type: object
PartNumber:
description: The part number for this drive.
nullable: true
type: string
x-added: iLO 5 1.10
PredictedMediaLifeLeftPercent:
description: The percentage of reads and writes that are predicted to still
be available for the media
example: '95'
nullable: true
type: integer
x-added: iLO 5 1.10
Protocol:
description: 'The protocol this drive is using to communicate to the storage
controller
Defined values are:
* `NVMe`: Non-Volatile Memory Express
* `SATA`: Serial AT Attachment
* `USB`: Universal Serial Bus
'
enum:
- NVMe
- SATA
- USB
example: NVMe
nullable: true
type: string
x-added: iLO 5 1.10
Revision:
description: The revision of this Drive
example: 4IFDHPK4
nullable: true
type: string
x-added: iLO 5 1.10
RotationSpeedRPM:
description: The rotation speed of this Drive in Revolutions per Minute
(RPM)
nullable: true
type: integer
x-added: iLO 5 1.10
SerialNumber:
description: Serial Number of the drive.
example: xxxxxxxxxx
nullable: true
type: string
x-added: iLO 5 1.10
Status:
properties:
Health:
description: 'This represents the health state of this resource in the
absence of its dependent resources.
Defined values are:
* `OK`: Normal
* `Warning`: A condition exists that requires attention
* `Critical`: A critical condition exists that requires immediate
attention
'
enum:
- OK
- Warning
- Critical
example: OK
nullable: true
readOnly: true
type: string
x-added: iLO 5 1.10
x-longDescription: This property shall represent the HealthState of
the resource without considering its dependent resources. The values
shall conform to those defined in the Redfish specification.
HealthRollup:
description: 'This represents the overall health state from the view
of this resource.
Defined values are:
* `OK`: Normal
* `Warning`: A condition exists that requires attention
* `Critical`: A critical condition exists that requires immediate
attention
'
enum:
- OK
- Warning
- Critical
nullable: true
readOnly: true
type: string
x-added: iLO 5 1.10
x-longDescription: This property shall represent the HealthState of
the resource and its dependent resources. The values shall conform
to those defined in the Redfish specification.
State:
description: 'This indicates the known state of the resource, such as
if it is enabled.
Defined values are:
* `Enabled`: This function or resource has been enabled.
* `Disabled`: This function or resource has been disabled.
* `StandbyOffline`: This function or resource is enabled, but awaiting
an external action to activate it.
* `StandbySpare`: This function or resource is part of a redundancy
set and is awaiting a failover or other external action to activate
it.
* `InTest`: This function or resource is undergoing testing.
* `Starting`: This function or resource is starting.
* `Absent`: This function or resource is not present or not detected.
* `UnavailableOffline`: This function or resource is present but cannot
be used.
* `Deferring`: The element will not process any commands but will
queue new requests.
* `Quiesced`: The element is enabled but only processes a restricted
set of commands.
* `Updating`: The element is updating and may be unavailable or degraded.
'
enum:
- Enabled
- Disabled
- StandbyOffline
- StandbySpare
- InTest
- Starting
- Absent
- UnavailableOffline
- Deferring
- Quiesced
- Updating
example: Enabled
nullable: true
readOnly: true
type: string
x-added: iLO 5 1.10
x-longDescription: This property shall represent if this component is
available or not and why. Enabled indicates the resource is available. Disabled
indicates the resource has been intentionally made unavailable but
it can be enabled. Offline indicates the resource is unavailable
intentionally and requires action to be made available. InTest indicates
that the component is undergoing testing. Starting indicates that
the resource is on its way to becoming available. Absent indicates
the resources is physically unavailable.
type: object
x-added: iLO 5 1.10
type: object
EthernetInterface:
properties:
'@odata.context':
example: /$metadata#EthernetInterface.EthernetInterface
format: uri
readOnly: true
type: string
x-longDescription: The value of this property shall be the context URL that
describes the resource according to OData-Protocol and shall be of the
form defined in the SPMF specification.
'@odata.etag':
example: W/\F863BF13\""
readOnly: true
type: string
x-longDescription: The value of this property is the Etag of the resource.
'@odata.id':
example: /Systems/1/EthernetInterfaces/1/
format: uri
readOnly: true
type: string
x-longDescription: The value of this property shall be the unique identifier
for the resource and it shall be of the form defined in the SPMF specification.
'@odata.type':
example: '#EthernetInterface.v1_4_1.EthernetInterface'
readOnly: true
type: string
x-longDescription: The value of this property shall be an absolute URL that
specifies the type of the resource and it shall be of the form defined
in the SPMF specification.
AutoNeg:
description: This indicates if the speed and duplex are automatically negotiated
and configured on this interface.
example: 'true'
nullable: true
readOnly: false
type: boolean
x-added: iLO 5 1.10
DHCPv4:
description: DHCPv4 configuration for this interface.
properties:
DHCPEnabled:
description: Determines whether DHCPv4 is enabled on this interface.
example: 'true'
nullable: true
readOnly: false
type: boolean
x-added: iLO 5 1.40
UseDNSServers:
description: Determines whether to use DHCPv4-supplied DNS servers.
example: 'true'
nullable: true
readOnly: false
type: boolean
x-added: iLO 5 1.40
UseDomainName:
description: Determines whether to use a DHCPv4-supplied domain name.
example: 'true'
nullable: true
readOnly: false
type: boolean
x-added: iLO 5 1.40
UseGateway:
description: Determines whether to use a DHCPv4-supplied gateway.
example: 'true'
nullable: true
readOnly: false
type: boolean
x-added: iLO 5 1.40
UseNTPServers:
description: Determines whether to use DHCPv4-supplied NTP servers.
example: 'true'
nullable: true
readOnly: false
type: boolean
x-added: iLO 5 1.40
UseStaticRoutes:
description: Determines whether to use DHCPv4-supplied static routes.
example: 'true'
nullable: true
readOnly: false
type: boolean
x-added: iLO 5 1.40
readOnly: false
type: object
x-added: iLO 5 1.40
DHCPv6:
description: DHCPv6 configuration for this interface.
properties:
OperatingMode:
description: 'Determines the DHCPv6 operating mode for this interface.
Defined values are:
* `Stateful`: DHCPv6 stateful mode.
* `Stateless`: DHCPv6 stateless mode.
* `Disabled`: DHCPv6 is disabled.
'
enum:
- Stateful
- Stateless
- Disabled
example: Stateful
nullable: true
readOnly: false
type: string
x-added: iLO 5 1.40
UseDNSServers:
description: When enabled, DNS server addresses supplied through DHCPv6
stateless mode will be used.
example: 'true'
nullable: true
readOnly: false
type: boolean
x-added: iLO 5 1.40
UseDomainName:
description: When enabled, the domain name supplied through DHCPv6 stateless
mode will be used.
example: 'true'
nullable: true
readOnly: false
type: boolean
x-added: iLO 5 1.40
UseNTPServers:
description: When enabled, NTP server addresses supplied through DHCPv6
stateless mode will be used.
example: 'true'
nullable: true
readOnly: false
type: boolean
x-added: iLO 5 1.40
UseRapidCommit:
description: Determines whether to use DHCPv6 rapid commit mode for
stateful mode address assignments. Do not enable in networks where
more than one DHCPv6 server is configured to provide address assignments.
example: 'false'
nullable: true
readOnly: false
type: boolean
x-added: iLO 5 1.40
readOnly: false
type: object
x-added: iLO 5 1.40
Description:
description: Provides a description of this resource and is used for commonality in
the schema definitions.
example: Configuration of this Manager Network Interface
nullable: true
readOnly: true
type: string
x-added: iLO 5 1.10
x-longDescription: This object represents the Description property. All
values for resources described by this schema shall comply to the requirements
as described in the Redfish specification.
FQDN:
description: This is the complete, fully qualified domain name obtained
by DNS for this interface.
example: ILOmBj5nS.americas.hpqcorp.net
nullable: true
readOnly: false
type: string
x-added: iLO 5 1.10
FullDuplex:
description: This indicates if the interface is in Full Duplex mode or not.
example: 'true'
nullable: true
readOnly: false
type: boolean
x-added: iLO 5 1.10
HostName:
description: The DNS Host Name, without any domain information.
example: xxxxxxxxxx
nullable: true
readOnly: false
type: string
x-added: iLO 5 1.10
IPv4Addresses:
description: Write capability for this array is deprecated and may be removed
in future, use IPv4StaticAddresses instead. The IPv4 addresses currently
assigned to this interface.
items:
description: This type describes an IPv4 Address.
properties:
Address:
description: This is the IPv4 Address.
example: 169.254.68.152
nullable: true
readOnly: false
type: string
x-added: iLO 5 1.10
AddressOrigin:
description: 'This indicates how the address was determined.
Defined values are:
* `Static`: A static address as configured by the user.
* `DHCP`: Address is provided by a DHCPv4 service.
* `BOOTP`: Address is provided by a BOOTP service.
* `IPv4LinkLocal`: Address is valid only for this network segment
(link).
'
enum:
- Static
- DHCP
- BOOTP
- IPv4LinkLocal
example: DHCP
nullable: true
readOnly: true
type: string
x-added: iLO 5 1.10
x-longDescription: The value of this property shall be the IP address
origin for this network interface.
Gateway:
description: This is the IPv4 gateway for this address.
example: 16.85.176.1
nullable: true
readOnly: false
type: string
x-added: iLO 5 1.10
SubnetMask:
description: This is the IPv4 Subnet mask.
example: 255.255.252.0
readOnly: false
type: string
x-added: iLO 5 1.10
type: object
readOnly: false
type: array
x-added: iLO 5 1.10
IPv4StaticAddresses:
description: The IPv4 static addresses assigned to this interface.
items:
description: This type describes an IPv4 Address.
properties:
Address:
description: This is the IPv4 Address.
nullable: true
readOnly: false
type: string
x-added: iLO 5 1.40
AddressOrigin:
description: 'This indicates how the address was determined.
Defined values are:
* `Static`: A static address as configured by the user.
* `DHCP`: Address is provided by a DHCPv4 service.
* `BOOTP`: Address is provided by a BOOTP service.
* `IPv4LinkLocal`: Address is valid only for this network segment
(link).
'
enum:
- Static
- DHCP
- BOOTP
- IPv4LinkLocal
nullable: true
readOnly: true
type: string
x-added: iLO 5 1.40
x-longDescription: The value of this property shall be the IP address
origin for this network interface.
Gateway:
description: This is the IPv4 gateway for this address.
nullable: true
readOnly: false
type: string
x-added: iLO 5 1.40
SubnetMask:
description: This is the IPv4 Subnet mask.
readOnly: false
type: string
x-added: iLO 5 1.40
type: object
readOnly: false
type: array
x-added: iLO 5 1.40
IPv6AddressPolicyTable:
description: An array representing the RFC 6724 Address Selection Policy
Table.
items:
description: A entry in the RFC 6724 Address Selection Policy Table.
properties:
Label:
description: The IPv6 Label (as defined in RFC 6724 section 2.1).
example: 'null'
nullable: true
readOnly: false
type: integer
x-added: iLO 5 1.10
Precedence:
description: The IPv6 Precedence (as defined in RFC 6724 section 2.1.
example: '35'
nullable: true
readOnly: false
type: integer
x-added: iLO 5 1.10
Prefix:
description: The IPv6 Address Prefix (as defined in RFC 6724 section
2.1).
example: ::ffff:0:0/96
nullable: true
readOnly: false
type: string
x-added: iLO 5 1.10
type: object
readOnly: false
type: array
x-added: iLO 5 1.10
IPv6Addresses:
description: Enumerates in an array all of the currently assigned IPv6 addresses
on this interface.
items:
description: This type describes an IPv6 Address.
properties:
Address:
description: This is the IPv6 Address.
example: fe80::21e4:e75e:b1eb:4498%25
nullable: true
readOnly: false
type: string
x-added: iLO 5 1.10
AddressOrigin:
description: 'This indicates how the address was determined.
Defined values are:
* `Static`: A static address as configured by the user.
* `DHCPv6`: Address is provided by a DHCPv6 service.
* `LinkLocal`: Address is valid only for this network segment (link).
* `SLAAC`: Address is provided by a Stateless Address AutoConfiguration
(SLAAC) service.
'
enum:
- Static
- DHCPv6
- LinkLocal
- SLAAC
example: SLAAC
nullable: true
readOnly: true
type: string
x-added: iLO 5 1.10
AddressState:
description: 'The current state of this address as defined in RFC
4862.
Defined values are:
* `Preferred`: This address is currently within both it''s valid
and preferred lifetimes as defined in RFC 4862.
* `Deprecated`: This address is currently within it''s valid lifetime,
but is now outside of it''s preferred lifetime as defined in RFC
4862.
* `Tentative`: This address is currently undergoing Duplicate Address
Detection testing as defined in RFC 4862 section 5.4.
* `Failed`: This address has failed Duplicate Address Detection
testing as defined in RFC 4862 section 5.4 and is not currently
in use.
'
enum:
- Preferred
- Deprecated
- Tentative
- Failed
example: Preferred
nullable: true
readOnly: true
type: string
x-added: iLO 5 1.10
PrefixLength:
description: This is the IPv6 Address Prefix Length.
example: '64'
nullable: true
readOnly: true
type: integer
x-added: iLO 5 1.10
type: object
type: array
x-added: iLO 5 1.10
IPv6DefaultGateway:
description: This is the IPv6 default gateway address that is currently
in use on this interface.
example: FE80::3ED9:2BFF:FE34:600
nullable: true
readOnly: true
type: string
x-added: iLO 5 1.10
IPv6StaticAddresses:
description: Represents in an array all of the IPv6 static addresses to
be assigned on this interface.
items:
description: This object represents a single IPv6 static address to be
assigned on a network interface.
properties:
Address:
description: A valid IPv6 address.
example: '::'
nullable: true
readOnly: false
type: string
x-added: iLO 5 1.10
x-longDescription: This property provides access to a static IPv6
address that is currently assigned on a network interface.
PrefixLength:
description: The Prefix Length of this IPv6 address.
example: 'null'
nullable: true
readOnly: false
type: integer
x-added: iLO 5 1.10
type: object
readOnly: false
type: array
x-added: iLO 5 1.10
IPv6StaticDefaultGateways:
description: The IPv6 static default gateways for this interface.
items:
description: This object represents a single IPv6 static address to be
assigned on a network interface.
properties:
Address:
description: A valid IPv6 address.
example: '::'
nullable: true
readOnly: false
type: string
x-added: iLO 5 1.40
PrefixLength:
description: The Prefix Length of this IPv6 address.
nullable: true
readOnly: false
type: integer
x-added: iLO 5 1.40
type: object
readOnly: false
type: array
x-added: iLO 5 1.40
Id:
description: Uniquely identifies the resource within the collection of like
resources.
example: '1'
readOnly: true
type: string
x-added: iLO 5 1.10
x-longDescription: This property represents an identifier for the resource. All
values for resources described by this schema shall comply to the requirements
as described in the Redfish specification.
InterfaceEnabled:
description: This indicates whether this interface is enabled.
example: 'true'
nullable: true
readOnly: false
type: boolean
x-added: iLO 5 1.40
LinkStatus:
description: 'The link status of this interface (port).
Defined values are:
* `LinkUp`: The link is available for communication on this interface.
* `NoLink`: There is no link or connection detected on this interface.
* `LinkDown`: There is no link on this interface, but the interface is
connected.
'
enum:
- LinkUp
- NoLink
- LinkDown
example: LinkUp
nullable: true
readOnly: true
type: string
x-added: iLO 5 1.20
Links:
description: Contains references to other resources that are related to
this resource.
properties:
HostInterface:
description: This is a reference to a Host Interface that is associated
with this Ethernet Interface.
properties:
'@odata.id':
format: uri
readOnly: true
type: string
x-longDescription: The value of this property shall be the unique
identifier for the resource and it shall be of the form defined
in the SPMF specification.
readOnly: true
type: object
x-added: iLO 5 1.40
type: object
x-added: iLO 5 1.40
MACAddress:
description: This is the currently configured MAC address of the (logical
port) interface.
example: 98:f2:b3:c6:4b:10
readOnly: false
type: string
x-added: iLO 5 1.10
MTUSize:
description: This is the currently configured Maximum Transmission Unit
(MTU) in bytes on this interface.
nullable: true
readOnly: false
type: integer
x-added: iLO 5 1.40
MaxIPv6StaticAddresses:
description: This indicates the maximum number of Static IPv6 addresses
that can be configured on this interface.
example: '4'
nullable: true
readOnly: true
type: integer
x-added: iLO 5 1.10
Name:
description: The name of the resource or array element.
example: PCIe Slot 1 3 Port 1
readOnly: true
type: string
x-added: iLO 5 1.10
NameServers:
description: This represents DNS name servers that are currently in use
on this interface.
items:
type: string
readOnly: true
type: array
x-added: iLO 5 1.10
Oem:
description: This is the manufacturer/provider specific extension moniker
used to divide the Oem object into sections.
properties:
Hpe:
description: The Management Processor General Network Settings.
properties:
'@odata.context':
format: uri
readOnly: true
type: string
x-longDescription: The value of this property shall be the context
URL that describes the resource according to OData-Protocol and
shall be of the form defined in the SPMF specification.
'@odata.etag':
readOnly: true
type: string
x-longDescription: The value of this property is the Etag of the
resource.
'@odata.id':
format: uri
readOnly: true
type: string
x-longDescription: The value of this property shall be the unique
identifier for the resource and it shall be of the form defined
in the SPMF specification.
'@odata.type':
readOnly: true
type: string
x-longDescription: The value of this property shall be an absolute
URL that specifies the type of the resource and it shall be of
the form defined in the SPMF specification.
ConfigurationSettings:
description: 'The state of the currently displayed configuration
settings.
Defined values are:
* `Current`: All configuration settings for this NIC are currently
in use.
* `SomePendingReset`: One or more configuration settings on this
NIC are not yet in use. They require a reset of this management
processor in order to take effect.
'
enum:
- Current
- SomePendingReset
readOnly: true
type: string
DHCPv4:
description: DHCPv4 options.
properties:
ClientId:
description: The client ID to override the default used in iLO.
nullable: true
readOnly: false
type: string
ClientIdType:
description: 'The type of client id in use or to be selected.
Defined values are:
* `Custom`: Allows user to enter any value.
* `Default`: Use the default iLO5 value - MAC Address + Instance
number.
* `Hostname`: Use the hostname.
* `MacAddress`: Use the default iLO4 value - MAC Address.
'
enum:
- Custom
- Default
- Hostname
- MacAddress
readOnly: false
type: string
Enabled:
description: Deprecated, replaced by DMTF standard property
DHCPv4.DHCPEnabled, and will be removed in a future release.
Determines whether DHCPv4 is enabled.
readOnly: false
type: boolean
UseDNSServers:
description: Deprecated, replaced by DMTF standard property
DHCPv4.UseDNSServers, and will be removed in a future release.
Determines whether to use DHCPv4-supplied DNS servers. Can
only be enabled when DHCPv4 is also enabled; otherwise, this
property will be set to false and will be read-only.
readOnly: false
type: boolean
UseDomainName:
description: Deprecated, replaced by DMTF standard property
DHCPv4.UseDomainName, and will be removed in a future release.
Determines whether to use a DHCPv4-supplied domain name. Can
only be enabled when DHCPv4 is also enabled; otherwis,e this
property will be set to false and will be read-only.
readOnly: false
type: boolean
UseGateway:
description: Deprecated, replaced by DMTF standard property
DHCPv4.UseGateway, and will be removed in a future release.
Determines whether to use a DHCPv4-supplied gateway. Can only
be enabled when DHCPv4 is also enabled; otherwise, this property
will be set to false and will be read-only.
readOnly: false
type: boolean
UseNTPServers:
description: Deprecated, replaced by DMTF standard property
DHCPv4.UseNTPServers, and will be removed in a future release.
Determines whether to use DHCPv4-supplied NTP servers. Can
only be enabled when DHCPv4 is also enabled; otherwise, this
property will be set to false and will be read-only.
readOnly: false
type: boolean
UseStaticRoutes:
description: Deprecated, replaced by DMTF standard property
DHCPv4.UseStaticRoutes, and will be removed in a future release.
Determines whether to use DHCPv4-supplied static routes. Can
only be enabled when DHCPv4 is also enabled; otherwise, this
property will be set to false and will be read-only.
readOnly: false
type: boolean
UseWINSServers:
description: Determines whether to use DHCPv4-supplied WINS
servers. Can only be enabled when DHCPv4 is also enabled;
otherwise, this property will be set to false and will be
read-only.
readOnly: false
type: boolean
readOnly: false
type: object
DHCPv6:
description: Management processor DHCPv6 Configuration Settings
properties:
StatefulModeEnabled:
description: Deprecated, replaced by DMTF standard property
DHCPv6Configuration.OperatingMode, and will be removed in
a future release.Determines whether DHCPv6 Stateful mode is
enabled.
readOnly: false
type: boolean
StatelessModeEnabled:
description: Deprecated, replaced by DMTF standard property
DHCPv6Configuration.OperatingMode, and will be removed in
a future release. Determines whether DHCPv6 Stateless mode
is enabled. Always enabled by default whenever DHCPv6 Stateful
mode is also enabled.
readOnly: false
type: boolean
UseDNSServers:
description: Deprecated, replaced by DMTF standard property
DHCPv6Configuration.UseDNSServers, and will be removed in
a future release. Determines whether to use DHCPv6-supplied
DNS servers. Can only be enabled when DHCPv6 Stateless mode
is also enabled; otherwise, this property will be set to false
and will be read-only.
readOnly: false
type: boolean
UseDomainName:
description: Deprecated, replaced by DMTF standard property
DHCPv6Configuration.UseDomainName, and will be removed in
a future release. Determines whether to use a DHCPv6-supplied
domain name. Can only be enabled when DHCPv6 Stateless mode
is also enabled; otherwise, this property will be set to false
and will be read-only.
readOnly: false
type: boolean
UseNTPServers:
description: Deprecated, replaced by DMTF standard property
DHCPv6Configuration.UseNTPServers, and will be removed in
a future release. Determines whether to use DHCPv6-supplied
NTP servers. Can only be enabled when DHCPv6 Stateless mode
is also enabled; otherwise, this property will be set to false
and will be read-only.
readOnly: false
type: boolean
UseRapidCommit:
description: Deprecated, replaced by DMTF standard property
DHCPv6Configuration.UseRapidCommit, and will be removed in
a future release. Determines whether to use DHCPv6 rapid commit
mode. Can only be enabled when DHCPv6 Stateful mode is also
enabled; otherwise, this property will be set to false and
will be read-only. Do not enable in networks where more than
one DHCPv6 server is configured to provide address assignments.
readOnly: false
type: boolean
readOnly: false
type: object
DomainName:
description: Domain name of the network to which this management
processor belongs. This property can only be modified when the
management processor is not configured to use a DHCP supplied
domain name; otherwise this property is read-only indicating the
value is provided by DHCP.
readOnly: false
type: string
HostName:
description: Deprecated, replaced by DMTF standard property HostName,
and will be removed in a future release. The management processor
host name.
example: xxxxxxxxxx
format: hostname
readOnly: false
type: string
IPv4:
description: The Management Processor IPv4 Configuration Settings.
properties:
DDNSRegistration:
description: Determines whether DDNS registration is enabled.
readOnly: false
type: boolean
DNSServers:
description: Deprecated, replaced by DMTF standard array property
StaticNameServers, and will be removed in a future release.
Currently configured IPv4 DNS servers in order of descending
preference. Static values when not configured to use DHCPv4-supplied
DNS servers; otherwise this property is read-only indicating
the values are provided by DHCPv4.
items:
format: ipv4
type: string
readOnly: false
type: array
StaticRoutes:
description: The current configured IPv4 static routes.
items:
properties:
Destination:
description: An IPv4 static route destination. Only writeable
when use of DHCPv4-supplied static routes is disabled;
otherwise this property is read-only indicating the
value is provided by DHCPv4.
format: ipv4
readOnly: false
type: string
Gateway:
description: An IPv4 static route gateway. Only writeable
when use of DHCPv4-supplied static routes is disabled;
otherwise this property is read-only indicating the
value is provided by DHCPv4.
format: ipv4
readOnly: false
type: string
SubnetMask:
description: An IPv4 static route subnet mask. Only writeable
when use of DHCPv4-supplied static routes is disabled;
otherwise this property is read-only indicating the
value is provided by DHCPv4.
format: ipv4
readOnly: false
type: string
readOnly: false
type: object
readOnly: false
type: array
WINSRegistration:
description: Determines whether WINS registration is enabled.
readOnly: false
type: boolean
WINSServers:
description: Currently configured WINS servers in order of descending
preference. Static values when not configured to use DHCPv4-supplied
WINS servers; otherwise this property is read-only indicating
the values are provided by DHCPv4
items:
format: ipv4
type: string
readOnly: false
type: array
readOnly: false
type: object
IPv6:
description: The management processor IPv6 Network Configuration
Settings.
properties:
DDNSRegistration:
description: Determines whether IPv6 DDNS registration is enabled.
readOnly: false
type: boolean
DNSServers:
description: Deprecated, replaced by DMTF standard array property
StaticNameServers, and will be removed in a future release.
Currently configured IPv6 DNS servers in order of descending
preference. Static values when not configured to use DHCPv6-supplied
DNS servers; otherwise this property is read-only indicating
the values are provided by DHCPv6.
items:
format: ipv6
type: string
readOnly: false
type: array
SLAACEnabled:
description: Deprecated, replaced by DMTF standard property
StatelessAddressAutoConfig.IPv6AutoConfigEnabled, and will
be removed in a future release. Determines whether StateLess
Address Auto-Configuration is enabled.
readOnly: false
type: boolean
StaticDefaultGateway:
description: Deprecated, replaced by DMTF standard property
IPv6StaticDefaultGateways[].Address, and will be removed in
a future release. The IPv6 static default gateway entry.
format: ipv6
readOnly: false
type: string
StaticRoutes:
description: The management processor IPv6 static routes.
items:
properties:
Destination:
description: The IPv6 static route destination address.
format: ipv6
readOnly: false
type: string
Gateway:
description: The IPv6 static route gateway.
format: ipv6
readOnly: false
type: string
PrefixLength:
description: The prefix length of the IPv6 static route
destination address.
nullable: true
readOnly: false
type: integer
Status:
description: 'Status of this static route entry.
Defined values are:
* `Unknown`: The status of this static route entry in
the route table is unknown.
* `Pending`: This static route entry has not yet been
added to the route table.
* `Active`: This static route entry was successfully
added to the route table.
* `Failed`: This static route entry could not be added
to the route table.
'
enum:
- Unknown
- Pending
- Active
- Failed
readOnly: true
type: string
readOnly: false
type: object
readOnly: false
type: array
readOnly: false
type: object
Id:
description: Uniquely identifies the resource within the collection
of like resources.
readOnly: true
type: string
x-longDescription: This property represents an identifier for the
resource. All values for resources described by this schema shall
comply to the requirements as described in the Redfish specification.
InterfaceType:
description: 'Describes the network interface type.
Defined values are:
* `Dedicated`
* `Shared`
* `HostInterface`
'
enum:
- Dedicated
- Shared
- HostInterface
readOnly: true
type: string
Links:
description: The URIs for the resources related to the date time
service resource.
properties:
DateTimeService:
description: The URI for this date time service resource.
properties:
'@odata.id':
format: uri
readOnly: true
type: string
x-longDescription: The value of this property shall be the
unique identifier for the resource and it shall be of
the form defined in the SPMF specification.
readOnly: true
type: object
readOnly: true
type: object
NICEnabled:
description: Deprecated, replaced by DMTF standard property InterfaceEnabled,
and will be removed in a future release. Determines whether this
NIC is enabled or disabled. Enabling one NIC will disable the
others. If no NIC is enabled, this management processor is not
accessible over the network.
readOnly: false
type: boolean
NICSupportsIPv6:
description: Indicates whether or not this NIC can support the IPv6
protocol.
readOnly: true
type: boolean
PingGatewayOnStartup:
description: Determines whether to ping the IPv4 gateway on startup.
readOnly: false
type: boolean
SharedNetworkPortOptions:
description: The shared network port options. Only applies to Shared
Network Port.
properties:
NIC:
description: 'Selects the system NIC that is to be shared with
this management processor.
Defined values are:
* `LOM`: The LOM NIC is configured to be shared.
* `FlexibleLOM`: The FlexibleLOM NIC is configured to be shared.
'
enum:
- LOM
- FlexibleLOM
readOnly: false
type: string
Port:
description: The network adapter port number that is used for
sharing. This feature is only applicable on systems and network
adapters that support it.
readOnly: false
type: integer
readOnly: false
type: object
SupportsFlexibleLOM:
description: Indicates whether this system supports FlexibleLOM.
Only applies to Shared Network Port.
readOnly: true
type: boolean
SupportsLOM:
description: Indicates whether this system supports LOM. Only applies
to Shared Network Port.
readOnly: true
type: boolean
readOnly: false
type: object
readOnly: false
type: object
PermanentMACAddress:
description: This is the permanent MAC address assigned to this interface
(port).
example: 30:E1:71:59:D0:D0
readOnly: true
type: string
x-added: iLO 5 1.10
SpeedMbps:
description: This is the current speed in Mbps of this interface.
example: '20000'
nullable: true
readOnly: false
type: integer
StatelessAddressAutoConfig:
description: Stateless Address Automatic Configuration (SLAAC) parameters
for this interface.
properties:
IPv4AutoConfigEnabled:
description: Indicates whether IPv4 SLAAC is enabled for this interface.
nullable: true
readOnly: false
type: boolean
x-added: iLO 5 1.40
x-longDescription: This property shall indicate whether IPv4 Stateless
Address Auto-Configuration (SLAAC) is enabled for this interface.
IPv6AutoConfigEnabled:
description: Indicates whether IPv6 SLAAC is enabled for this interface.
example: 'true'
nullable: true
readOnly: false
type: boolean
x-added: iLO 5 1.40
readOnly: false
type: object
x-added: iLO 5 1.40
StaticNameServers:
description: A statically defined set of DNS server IP addresses (both IPv4
and IPv6).
items:
type: string
readOnly: false
type: array
x-added: iLO 5 1.40
Status:
description: This property describes the status and health of the resource
and its children.
properties:
Health:
description: 'This represents the health state of this resource in the
absence of its dependent resources.
Defined values are:
* `OK`: Normal
* `Warning`: A condition exists that requires attention
* `Critical`: A critical condition exists that requires immediate
attention
'
enum:
- OK
- Warning
- Critical
example: OK
nullable: true
readOnly: true
type: string
x-added: iLO 5 1.10
x-longDescription: This property shall represent the HealthState of
the resource without considering its dependent resources. The values
shall conform to those defined in the Redfish specification.
HealthRollup:
description: 'This represents the overall health state from the view
of this resource.
Defined values are:
* `OK`: Normal
* `Warning`: A condition exists that requires attention
* `Critical`: A critical condition exists that requires immediate
attention
'
enum:
- OK
- Warning
- Critical
nullable: true
readOnly: true
type: string
x-added: iLO 5 1.10
x-longDescription: This property shall represent the HealthState of
the resource and its dependent resources. The values shall conform
to those defined in the Redfish specification.
State:
description: 'This indicates the known state of the resource, such as
if it is enabled.
Defined values are:
* `Enabled`: This function or resource has been enabled.
* `Disabled`: This function or resource has been disabled.
* `StandbyOffline`: This function or resource is enabled, but awaiting
an external action to activate it.
* `StandbySpare`: This function or resource is part of a redundancy
set and is awaiting a failover or other external action to activate
it.
* `InTest`: This function or resource is undergoing testing.
* `Starting`: This function or resource is starting.
* `Absent`: This function or resource is not present or not detected.
* `UnavailableOffline`: This function or resource is present but cannot
be used.
* `Deferring`: The element will not process any commands but will
queue new requests.
* `Quiesced`: The element is enabled but only processes a restricted
set of commands.
* `Updating`: The element is updating and may be unavailable or degraded.
'
enum:
- Enabled
- Disabled
- StandbyOffline
- StandbySpare
- InTest
- Starting
- Absent
- UnavailableOffline
- Deferring
- Quiesced
- Updating
example: Enabled
nullable: true
readOnly: true
type: string
x-added: iLO 5 1.10
x-longDescription: This property shall represent if this component is
available or not and why. Enabled indicates the resource is available. Disabled
indicates the resource has been intentionally made unavailable but
it can be enabled. Offline indicates the resource is unavailable
intentionally and requires action to be made available. InTest indicates
that the component is undergoing testing. Starting indicates that
the resource is on its way to becoming available. Absent indicates
the resources is physically unavailable.
type: object
x-added: iLO 5 1.10
UefiDevicePath:
description: The UEFI device path for this interface.
example: PciRoot(0x1)/Pci(0x0,0x0)/Pci(0x0,0x0)
nullable: true
readOnly: true
type: string
x-added: iLO 5 1.10
x-longDescription: The value of this property shall be the UEFI device path
to the device which implements this interface (port).
VLAN:
description: If this Network Interface supports more than one VLAN, this
property is not present. VLANs collections appear in the Link section
of this resource.
properties:
VLANEnable:
description: This indicates if this VLAN is enabled.
nullable: true
readOnly: false
type: boolean
x-added: iLO 5 1.10
VLANId:
description: This indicates the VLAN identifier for this VLAN.
nullable: true
readOnly: false
type: integer
x-added: iLO 5 1.10
readOnly: false
type: object
x-added: iLO 5 1.10
VLANs:
description: This is a reference to a collection of VLANs and is only used
if the interface supports more than one VLANs.
properties:
'@odata.id':
format: uri
readOnly: true
type: string
x-longDescription: The value of this property shall be the unique identifier
for the resource and it shall be of the form defined in the SPMF specification.
readOnly: true
type: object
x-added: iLO 5 1.10
type: object
EthernetInterface.Update:
properties:
AutoNeg:
description: This indicates if the speed and duplex are automatically negotiated
and configured on this interface.
nullable: true
readOnly: false
type: boolean
DHCPv4:
description: DHCPv4 configuration for this interface.
properties:
DHCPEnabled:
description: Determines whether DHCPv4 is enabled on this interface.
nullable: true
readOnly: false
type: boolean
UseDNSServers:
description: Determines whether to use DHCPv4-supplied DNS servers.
nullable: true
readOnly: false
type: boolean
UseDomainName:
description: Determines whether to use a DHCPv4-supplied domain name.
nullable: true
readOnly: false
type: boolean
UseGateway:
description: Determines whether to use a DHCPv4-supplied gateway.
nullable: true
readOnly: false
type: boolean
UseNTPServers:
description: Determines whether to use DHCPv4-supplied NTP servers.
nullable: true
readOnly: false
type: boolean
UseStaticRoutes:
description: Determines whether to use DHCPv4-supplied static routes.
nullable: true
readOnly: false
type: boolean
readOnly: false
type: object
DHCPv6:
description: DHCPv6 configuration for this interface.
properties:
OperatingMode:
description: 'Determines the DHCPv6 operating mode for this interface.
Defined values are:
* `Stateful`: DHCPv6 stateful mode.
* `Stateless`: DHCPv6 stateless mode.
* `Disabled`: DHCPv6 is disabled.
'
enum:
- Stateful
- Stateless
- Disabled
nullable: true
readOnly: false
type: string
UseDNSServers:
description: When enabled, DNS server addresses supplied through DHCPv6
stateless mode will be used.
nullable: true
readOnly: false
type: boolean
UseDomainName:
description: When enabled, the domain name supplied through DHCPv6 stateless
mode will be used.
nullable: true
readOnly: false
type: boolean
UseNTPServers:
description: When enabled, NTP server addresses supplied through DHCPv6
stateless mode will be used.
nullable: true
readOnly: false
type: boolean
UseRapidCommit:
description: Determines whether to use DHCPv6 rapid commit mode for
stateful mode address assignments. Do not enable in networks where
more than one DHCPv6 server is configured to provide address assignments.
nullable: true
readOnly: false
type: boolean
readOnly: false
type: object
FQDN:
description: This is the complete, fully qualified domain name obtained
by DNS for this interface.
nullable: true
readOnly: false
type: string
FullDuplex:
description: This indicates if the interface is in Full Duplex mode or not.
nullable: true
readOnly: false
type: boolean
HostName:
description: The DNS Host Name, without any domain information.
example: xxxxxxxxxx
nullable: true
readOnly: false
type: string
IPv4Addresses:
description: Write capability for this array is deprecated and may be removed
in future, use IPv4StaticAddresses instead. The IPv4 addresses currently
assigned to this interface.
items:
description: This type describes an IPv4 Address.
properties:
Address:
description: This is the IPv4 Address.
nullable: true
readOnly: false
type: string
Gateway:
description: This is the IPv4 gateway for this address.
nullable: true
readOnly: false
type: string
SubnetMask:
description: This is the IPv4 Subnet mask.
readOnly: false
type: string
type: object
readOnly: false
type: array
IPv4StaticAddresses:
description: The IPv4 static addresses assigned to this interface.
items:
description: This type describes an IPv4 Address.
properties:
Address:
description: This is the IPv4 Address.
nullable: true
readOnly: false
type: string
Gateway:
description: This is the IPv4 gateway for this address.
nullable: true
readOnly: false
type: string
SubnetMask:
description: This is the IPv4 Subnet mask.
readOnly: false
type: string
type: object
readOnly: false
type: array
IPv6AddressPolicyTable:
description: An array representing the RFC 6724 Address Selection Policy
Table.
items:
description: A entry in the RFC 6724 Address Selection Policy Table.
properties:
Label:
description: The IPv6 Label (as defined in RFC 6724 section 2.1).
nullable: true
readOnly: false
type: integer
Precedence:
description: The IPv6 Precedence (as defined in RFC 6724 section 2.1.
nullable: true
readOnly: false
type: integer
Prefix:
description: The IPv6 Address Prefix (as defined in RFC 6724 section
2.1).
nullable: true
readOnly: false
type: string
type: object
readOnly: false
type: array
IPv6Addresses:
description: Enumerates in an array all of the currently assigned IPv6 addresses
on this interface.
items:
description: This type describes an IPv6 Address.
properties:
Address:
description: This is the IPv6 Address.
nullable: true
readOnly: false
type: string
type: object
type: array
IPv6StaticAddresses:
description: Represents in an array all of the IPv6 static addresses to
be assigned on this interface.
items:
description: This object represents a single IPv6 static address to be
assigned on a network interface.
properties:
Address:
description: A valid IPv6 address.
nullable: true
readOnly: false
type: string
x-longDescription: This property provides access to a static IPv6
address that is currently assigned on a network interface.
PrefixLength:
description: The Prefix Length of this IPv6 address.
nullable: true
readOnly: false
type: integer
type: object
readOnly: false
type: array
IPv6StaticDefaultGateways:
description: The IPv6 static default gateways for this interface.
items:
description: This object represents a single IPv6 static address to be
assigned on a network interface.
properties:
Address:
description: A valid IPv6 address.
nullable: true
readOnly: false
type: string
PrefixLength:
description: The Prefix Length of this IPv6 address.
nullable: true
readOnly: false
type: integer
type: object
readOnly: false
type: array
InterfaceEnabled:
description: This indicates whether this interface is enabled.
nullable: true
readOnly: false
type: boolean
MACAddress:
description: This is the currently configured MAC address of the (logical
port) interface.
readOnly: false
type: string
MTUSize:
description: This is the currently configured Maximum Transmission Unit
(MTU) in bytes on this interface.
nullable: true
readOnly: false
type: integer
Oem:
description: This is the manufacturer/provider specific extension moniker
used to divide the Oem object into sections.
properties:
Hpe:
description: The Management Processor General Network Settings.
properties:
DHCPv4:
description: DHCPv4 options.
properties:
ClientId:
description: The client ID to override the default used in iLO.
nullable: true
readOnly: false
type: string
ClientIdType:
description: 'The type of client id in use or to be selected.
Defined values are:
* `Custom`: Allows user to enter any value.
* `Default`: Use the default iLO5 value - MAC Address + Instance
number.
* `Hostname`: Use the hostname.
* `MacAddress`: Use the default iLO4 value - MAC Address.
'
enum:
- Custom
- Default
- Hostname
- MacAddress
readOnly: false
type: string
Enabled:
description: Deprecated, replaced by DMTF standard property
DHCPv4.DHCPEnabled, and will be removed in a future release.
Determines whether DHCPv4 is enabled.
readOnly: false
type: boolean
UseDNSServers:
description: Deprecated, replaced by DMTF standard property
DHCPv4.UseDNSServers, and will be removed in a future release.
Determines whether to use DHCPv4-supplied DNS servers. Can
only be enabled when DHCPv4 is also enabled; otherwise, this
property will be set to false and will be read-only.
readOnly: false
type: boolean
UseDomainName:
description: Deprecated, replaced by DMTF standard property
DHCPv4.UseDomainName, and will be removed in a future release.
Determines whether to use a DHCPv4-supplied domain name. Can
only be enabled when DHCPv4 is also enabled; otherwis,e this
property will be set to false and will be read-only.
readOnly: false
type: boolean
UseGateway:
description: Deprecated, replaced by DMTF standard property
DHCPv4.UseGateway, and will be removed in a future release.
Determines whether to use a DHCPv4-supplied gateway. Can only
be enabled when DHCPv4 is also enabled; otherwise, this property
will be set to false and will be read-only.
readOnly: false
type: boolean
UseNTPServers:
description: Deprecated, replaced by DMTF standard property
DHCPv4.UseNTPServers, and will be removed in a future release.
Determines whether to use DHCPv4-supplied NTP servers. Can
only be enabled when DHCPv4 is also enabled; otherwise, this
property will be set to false and will be read-only.
readOnly: false
type: boolean
UseStaticRoutes:
description: Deprecated, replaced by DMTF standard property
DHCPv4.UseStaticRoutes, and will be removed in a future release.
Determines whether to use DHCPv4-supplied static routes. Can
only be enabled when DHCPv4 is also enabled; otherwise, this
property will be set to false and will be read-only.
readOnly: false
type: boolean
UseWINSServers:
description: Determines whether to use DHCPv4-supplied WINS
servers. Can only be enabled when DHCPv4 is also enabled;
otherwise, this property will be set to false and will be
read-only.
readOnly: false
type: boolean
readOnly: false
type: object
DHCPv6:
description: Management processor DHCPv6 Configuration Settings
properties:
StatefulModeEnabled:
description: Deprecated, replaced by DMTF standard property
DHCPv6Configuration.OperatingMode, and will be removed in
a future release.Determines whether DHCPv6 Stateful mode is
enabled.
readOnly: false
type: boolean
StatelessModeEnabled:
description: Deprecated, replaced by DMTF standard property
DHCPv6Configuration.OperatingMode, and will be removed in
a future release. Determines whether DHCPv6 Stateless mode
is enabled. Always enabled by default whenever DHCPv6 Stateful
mode is also enabled.
readOnly: false
type: boolean
UseDNSServers:
description: Deprecated, replaced by DMTF standard property
DHCPv6Configuration.UseDNSServers, and will be removed in
a future release. Determines whether to use DHCPv6-supplied
DNS servers. Can only be enabled when DHCPv6 Stateless mode
is also enabled; otherwise, this property will be set to false
and will be read-only.
readOnly: false
type: boolean
UseDomainName:
description: Deprecated, replaced by DMTF standard property
DHCPv6Configuration.UseDomainName, and will be removed in
a future release. Determines whether to use a DHCPv6-supplied
domain name. Can only be enabled when DHCPv6 Stateless mode
is also enabled; otherwise, this property will be set to false
and will be read-only.
readOnly: false
type: boolean
UseNTPServers:
description: Deprecated, replaced by DMTF standard property
DHCPv6Configuration.UseNTPServers, and will be removed in
a future release. Determines whether to use DHCPv6-supplied
NTP servers. Can only be enabled when DHCPv6 Stateless mode
is also enabled; otherwise, this property will be set to false
and will be read-only.
readOnly: false
type: boolean
UseRapidCommit:
description: Deprecated, replaced by DMTF standard property
DHCPv6Configuration.UseRapidCommit, and will be removed in
a future release. Determines whether to use DHCPv6 rapid commit
mode. Can only be enabled when DHCPv6 Stateful mode is also
enabled; otherwise, this property will be set to false and
will be read-only. Do not enable in networks where more than
one DHCPv6 server is configured to provide address assignments.
readOnly: false
type: boolean
readOnly: false
type: object
DomainName:
description: Domain name of the network to which this management
processor belongs. This property can only be modified when the
management processor is not configured to use a DHCP supplied
domain name; otherwise this property is read-only indicating the
value is provided by DHCP.
readOnly: false
type: string
HostName:
description: Deprecated, replaced by DMTF standard property HostName,
and will be removed in a future release. The management processor
host name.
example: xxxxxxxxxx
format: hostname
readOnly: false
type: string
IPv4:
description: The Management Processor IPv4 Configuration Settings.
properties:
DDNSRegistration:
description: Determines whether DDNS registration is enabled.
readOnly: false
type: boolean
DNSServers:
description: Deprecated, replaced by DMTF standard array property
StaticNameServers, and will be removed in a future release.
Currently configured IPv4 DNS servers in order of descending
preference. Static values when not configured to use DHCPv4-supplied
DNS servers; otherwise this property is read-only indicating
the values are provided by DHCPv4.
items:
format: ipv4
type: string
readOnly: false
type: array
StaticRoutes:
description: The current configured IPv4 static routes.
items:
properties:
Destination:
description: An IPv4 static route destination. Only writeable
when use of DHCPv4-supplied static routes is disabled;
otherwise this property is read-only indicating the
value is provided by DHCPv4.
format: ipv4
readOnly: false
type: string
Gateway:
description: An IPv4 static route gateway. Only writeable
when use of DHCPv4-supplied static routes is disabled;
otherwise this property is read-only indicating the
value is provided by DHCPv4.
format: ipv4
readOnly: false
type: string
SubnetMask:
description: An IPv4 static route subnet mask. Only writeable
when use of DHCPv4-supplied static routes is disabled;
otherwise this property is read-only indicating the
value is provided by DHCPv4.
format: ipv4
readOnly: false
type: string
readOnly: false
type: object
readOnly: false
type: array
WINSRegistration:
description: Determines whether WINS registration is enabled.
readOnly: false
type: boolean
WINSServers:
description: Currently configured WINS servers in order of descending
preference. Static values when not configured to use DHCPv4-supplied
WINS servers; otherwise this property is read-only indicating
the values are provided by DHCPv4
items:
format: ipv4
type: string
readOnly: false
type: array
readOnly: false
type: object
IPv6:
description: The management processor IPv6 Network Configuration
Settings.
properties:
DDNSRegistration:
description: Determines whether IPv6 DDNS registration is enabled.
readOnly: false
type: boolean
DNSServers:
description: Deprecated, replaced by DMTF standard array property
StaticNameServers, and will be removed in a future release.
Currently configured IPv6 DNS servers in order of descending
preference. Static values when not configured to use DHCPv6-supplied
DNS servers; otherwise this property is read-only indicating
the values are provided by DHCPv6.
items:
format: ipv6
type: string
readOnly: false
type: array
SLAACEnabled:
description: Deprecated, replaced by DMTF standard property
StatelessAddressAutoConfig.IPv6AutoConfigEnabled, and will
be removed in a future release. Determines whether StateLess
Address Auto-Configuration is enabled.
readOnly: false
type: boolean
StaticDefaultGateway:
description: Deprecated, replaced by DMTF standard property
IPv6StaticDefaultGateways[].Address, and will be removed in
a future release. The IPv6 static default gateway entry.
format: ipv6
readOnly: false
type: string
StaticRoutes:
description: The management processor IPv6 static routes.
items:
properties:
Destination:
description: The IPv6 static route destination address.
format: ipv6
readOnly: false
type: string
Gateway:
description: The IPv6 static route gateway.
format: ipv6
readOnly: false
type: string
PrefixLength:
description: The prefix length of the IPv6 static route
destination address.
nullable: true
readOnly: false
type: integer
readOnly: false
type: object
readOnly: false
type: array
readOnly: false
type: object
NICEnabled:
description: Deprecated, replaced by DMTF standard property InterfaceEnabled,
and will be removed in a future release. Determines whether this
NIC is enabled or disabled. Enabling one NIC will disable the
others. If no NIC is enabled, this management processor is not
accessible over the network.
readOnly: false
type: boolean
PingGatewayOnStartup:
description: Determines whether to ping the IPv4 gateway on startup.
readOnly: false
type: boolean
SharedNetworkPortOptions:
description: The shared network port options. Only applies to Shared
Network Port.
properties:
NIC:
description: 'Selects the system NIC that is to be shared with
this management processor.
Defined values are:
* `LOM`: The LOM NIC is configured to be shared.
* `FlexibleLOM`: The FlexibleLOM NIC is configured to be shared.
'
enum:
- LOM
- FlexibleLOM
readOnly: false
type: string
Port:
description: The network adapter port number that is used for
sharing. This feature is only applicable on systems and network
adapters that support it.
readOnly: false
type: integer
readOnly: false
type: object
readOnly: false
type: object
readOnly: false
type: object
SpeedMbps:
description: This is the current speed in Mbps of this interface.
nullable: true
readOnly: false
type: integer
StatelessAddressAutoConfig:
description: Stateless Address Automatic Configuration (SLAAC) parameters
for this interface.
properties:
IPv4AutoConfigEnabled:
description: Indicates whether IPv4 SLAAC is enabled for this interface.
nullable: true
readOnly: false
type: boolean
x-longDescription: This property shall indicate whether IPv4 Stateless
Address Auto-Configuration (SLAAC) is enabled for this interface.
IPv6AutoConfigEnabled:
description: Indicates whether IPv6 SLAAC is enabled for this interface.
nullable: true
readOnly: false
type: boolean
readOnly: false
type: object
StaticNameServers:
description: A statically defined set of DNS server IP addresses (both IPv4
and IPv6).
items:
type: string
readOnly: false
type: array
VLAN:
description: If this Network Interface supports more than one VLAN, this
property is not present. VLANs collections appear in the Link section
of this resource.
properties:
VLANEnable:
description: This indicates if this VLAN is enabled.
nullable: true
readOnly: false
type: boolean
VLANId:
description: This indicates the VLAN identifier for this VLAN.
nullable: true
readOnly: false
type: integer
readOnly: false
type: object
type: object
EthernetInterfaceCollection:
properties:
'@odata.context':
example: /$metadata#EthernetInterfaceCollection.EthernetInterfaceCollection
format: uri
readOnly: true
type: string
x-longDescription: The value of this property shall be the context URL that
describes the resource according to OData-Protocol and shall be of the
form defined in the SPMF specification.
'@odata.etag':
example: W/\DA402EBA\""
readOnly: true
type: string
x-longDescription: The value of this property is the Etag of the resource.
'@odata.id':
example: /Systems/1/EthernetInterfaces/
format: uri
readOnly: true
type: string
x-longDescription: The value of this property shall be the unique identifier
for the resource and it shall be of the form defined in the SPMF specification.
'@odata.type':
example: '#EthernetInterfaceCollection.EthernetInterfaceCollection'
readOnly: true
type: string
x-longDescription: The value of this property shall be an absolute URL that
specifies the type of the resource and it shall be of the form defined
in the SPMF specification.
Description:
description: Provides a description of this resource and is used for commonality in
the schema definitions.
example: Collection of System Ethernet Interfaces
nullable: true
readOnly: true
type: string
x-longDescription: This object represents the Description property. All
values for resources described by this schema shall comply to the requirements
as described in the Redfish specification.
Members:
description: Contains the members of this collection.
items:
properties:
'@odata.id':
example: /Systems/1/EthernetInterfaces/1/
format: uri
readOnly: true
type: string
x-longDescription: The value of this property shall be the unique
identifier for the resource and it shall be of the form defined
in the SPMF specification.
type: object
readOnly: true
type: array
Members@odata.count:
description: The total number of collection members.
example: '7'
readOnly: true
type: integer
Name:
description: The name of the resource or array element.
example: System Ethernet Interfaces
readOnly: true
type: string
Oem:
description: This object represents the Oem property.
readOnly: true
x-longDescription: The value of this string shall be of the format for the
reserved word *Oem*.
type: object
EventDestinationCollection:
properties:
'@odata.context':
example: /$metadata#EventDestinationCollection.EventDestinationCollection
format: uri
readOnly: true
type: string
x-longDescription: The value of this property shall be the context URL that
describes the resource according to OData-Protocol and shall be of the
form defined in the SPMF specification.
'@odata.etag':
example: W/\75983E8D\""
readOnly: true
type: string
x-longDescription: The value of this property is the Etag of the resource.
'@odata.id':
example: /EventService/Subscriptions/
format: uri
readOnly: true
type: string
x-longDescription: The value of this property shall be the unique identifier
for the resource and it shall be of the form defined in the SPMF specification.
'@odata.type':
example: '#EventDestinationCollection.EventDestinationCollection'
readOnly: true
type: string
x-longDescription: The value of this property shall be an absolute URL that
specifies the type of the resource and it shall be of the form defined
in the SPMF specification.
Description:
description: Provides a description of this resource and is used for commonality in
the schema definitions.
example: iLO User Event Subscriptions
nullable: true
readOnly: true
type: string
x-longDescription: This object represents the Description property. All
values for resources described by this schema shall comply to the requirements
as described in the Redfish specification.
Members:
description: Contains the members of this collection.
items:
properties:
'@odata.id':
format: uri
readOnly: true
type: string
x-longDescription: The value of this property shall be the unique
identifier for the resource and it shall be of the form defined
in the SPMF specification.
type: object
readOnly: true
type: array
Members@odata.count:
description: The total number of collection members.
example: '0'
readOnly: true
type: integer
Name:
description: The name of the resource or array element.
example: EventSubscriptions
readOnly: true
type: string
Oem:
description: This object represents the Oem property.
readOnly: true
x-longDescription: The value of this string shall be of the format for the
reserved word *Oem*.
type: object
EventService:
description: This is the schema definition for the Event Service. It represents
the properties for the service itself and has links to the actual list of
subscriptions.
properties:
'@odata.context':
example: /$metadata#EventService.EventService
format: uri
readOnly: true
type: string
x-longDescription: The value of this property shall be the context URL that
describes the resource according to OData-Protocol and shall be of the
form defined in the SPMF specification.
'@odata.etag':
example: W/\0427F3F5\""
readOnly: true
type: string
x-longDescription: The value of this property is the Etag of the resource.
'@odata.id':
example: /EventService/
format: uri
readOnly: true
type: string
x-longDescription: The value of this property shall be the unique identifier
for the resource and it shall be of the form defined in the SPMF specification.
'@odata.type':
example: '#EventService.v1_0_8.EventService'
readOnly: true
type: string
x-longDescription: The value of this property shall be an absolute URL that
specifies the type of the resource and it shall be of the form defined
in the SPMF specification.
Actions:
properties:
'#EventService.SubmitTestEvent':
properties:
EventID@Redfish.AllowableValues:
description: The supported values for the EventID parameter.
items:
readOnly: true
type: string
type: array
x-longDescription: The supported values for the EventID parameter.
EventTimestamp@Redfish.AllowableValues:
description: The supported values for the EventTimestamp parameter.
items:
format: date-time
readOnly: true
type: string
type: array
x-longDescription: The supported values for the EventTimestamp parameter.
EventType@Redfish.AllowableValues:
description: The supported values for the EventType parameter.
items:
description: 'Defined values are:
* `StatusChange`
* `ResourceUpdated`
* `ResourceAdded`
* `ResourceRemoved`
* `Alert`
'
enum:
- StatusChange
- ResourceUpdated
- ResourceAdded
- ResourceRemoved
- Alert
readOnly: true
type: string
type: array
x-longDescription: The supported values for the EventType parameter.
Message@Redfish.AllowableValues:
description: The supported values for the Message parameter.
items:
readOnly: true
type: string
type: array
x-longDescription: The supported values for the Message parameter.
MessageArgs@Redfish.AllowableValues:
description: The supported values for the MessageArgs parameter.
items:
readOnly: true
type: string
type: array
x-longDescription: The supported values for the MessageArgs parameter.
MessageID@Redfish.AllowableValues:
description: The supported values for the MessageID parameter.
items:
readOnly: true
type: string
type: array
x-longDescription: The supported values for the MessageID parameter.
OriginOfCondition@Redfish.AllowableValues:
description: The supported values for the OriginOfCondition parameter.
items:
readOnly: true
type: string
type: array
x-longDescription: The supported values for the OriginOfCondition
parameter.
Severity@Redfish.AllowableValues:
description: The supported values for the Severity parameter.
items:
description: 'Defined values are:
* `OK`
* `Warning`
* `Critical`
'
enum:
- OK
- Warning
- Critical
readOnly: true
type: string
type: array
x-longDescription: The supported values for the Severity parameter.
target:
description: Link to invoke action
example: /EventService/Actions/EventService.SubmitTestEvent/
type: string
title:
description: Friendly action name
type: string
type: object
type: object
DeliveryRetryAttempts:
description: This is the number of attempts an event posting is retried
before the subscription is terminated.
example: '3'
readOnly: false
type: integer
x-added: iLO 5 1.10
DeliveryRetryIntervalSeconds:
description: This represents the number of seconds between retry attempts
for sending any given Event
example: '30'
readOnly: false
type: integer
x-added: iLO 5 1.10
Description:
description: Provides a description of this resource and is used for commonality in
the schema definitions.
example: Event Subscription service
nullable: true
readOnly: true
type: string
x-longDescription: This object represents the Description property. All
values for resources described by this schema shall comply to the requirements
as described in the Redfish specification.
EventTypesForSubscription:
description: This is the types of Events that can be subscribed to.
items:
description: 'Defined values are:
* `StatusChange`: The status of this resource has changed
* `ResourceUpdated`: The value of this resource has been updated
* `ResourceAdded`: A resource has been added
* `ResourceRemoved`: A resource has been removed
* `Alert`: A condition exists which requires attention
'
enum:
- StatusChange
- ResourceUpdated
- ResourceAdded
- ResourceRemoved
- Alert
readOnly: true
type: string
readOnly: true
type: array
x-added: iLO 5 1.10
Id:
description: Uniquely identifies the resource within the collection of like
resources.
example: EventService
readOnly: true
type: string
x-added: iLO 5 1.10
x-longDescription: This property represents an identifier for the resource. All
values for resources described by this schema shall comply to the requirements
as described in the Redfish specification.
Name:
description: The name of the resource or array element.
example: Event Service
readOnly: true
type: string
x-added: iLO 5 1.10
Oem:
properties:
Hpe:
description: This resource shall be used to represent a destination
for events that have been subscribed to by a client.
properties:
'@odata.context':
format: uri
readOnly: true
type: string
x-longDescription: The value of this property shall be the context
URL that describes the resource according to OData-Protocol and
shall be of the form defined in the SPMF specification.
'@odata.etag':
readOnly: true
type: string
x-longDescription: The value of this property is the Etag of the
resource.
'@odata.id':
format: uri
readOnly: true
type: string
x-longDescription: The value of this property shall be the unique
identifier for the resource and it shall be of the form defined
in the SPMF specification.
'@odata.type':
readOnly: true
type: string
x-longDescription: The value of this property shall be an absolute
URL that specifies the type of the resource and it shall be of
the form defined in the SPMF specification.
Actions:
properties:
'#HpeEventService.ImportCACertificate':
properties:
Certificate@Redfish.AllowableValues:
description: The supported values for the Certificate parameter.
items:
description: Contains PEM formatted X509 certificate (Base64
encoded).
format: text
readOnly: false
type: string
type: array
x-longDescription: The supported values for the Certificate
parameter.
target:
description: Link to invoke action
type: string
title:
description: Friendly action name
type: string
type: object
type: object
CACertificates:
description: The value of this property shall be a reference to
a Collection of HpeCertificate resources.
properties:
'@odata.id':
format: uri
readOnly: true
type: string
x-longDescription: The value of this property shall be the unique
identifier for the resource and it shall be of the form defined
in the SPMF specification.
readOnly: true
type: object
Id:
description: Uniquely identifies the resource within the collection
of like resources.
readOnly: true
type: string
x-longDescription: This property represents an identifier for the
resource. All values for resources described by this schema shall
comply to the requirements as described in the Redfish specification.
RequestedMaxEventsToQueueDefault:
description: This represents the default number of events the service
should queue.
readOnly: true
type: integer
RetireOldEventInMinutesDefault:
description: This represents the default number of minutes until
an event is expired.
readOnly: true
type: integer
TTLCountDefault:
description: The default number of TTLUnits until this listener
destination subscription expires. It may be renewed prior to
expire to reset the Time to Live counter. The value 999999 is
reserved to mean a perpetual subscription.
readOnly: true
type: integer
TTLUnitsDefault:
description: 'The default time unit used to measure the subscription
time of this listener destination. This is the units for TTLCount
and is used to express the subscription lifetime of the listener
destination.
Defined values are:
* `seconds`: Time to Live (TTL) in Seconds
* `minutes`: Time to Live (TTL) in Minutes
* `days`: Time to Live (TTL) in Days
'
enum:
- seconds
- minutes
- days
readOnly: true
type: string
readOnly: true
type: object
type: object
ServiceEnabled:
description: This indicates whether this service is enabled.
example: 'true'
nullable: true
type: boolean
x-added: iLO 5 1.40
x-longDescription: The value of this property shall be a boolean indicating
whether this service is enabled.
Status:
properties:
Health:
description: 'This represents the health state of this resource in the
absence of its dependent resources.
Defined values are:
* `OK`: Normal
* `Warning`: A condition exists that requires attention
* `Critical`: A critical condition exists that requires immediate
attention
'
enum:
- OK
- Warning
- Critical
example: OK
nullable: true
readOnly: true
type: string
x-added: iLO 5 1.10
x-longDescription: This property shall represent the HealthState of
the resource without considering its dependent resources. The values
shall conform to those defined in the Redfish specification.
HealthRollup:
description: 'This represents the overall health state from the view
of this resource.
Defined values are:
* `OK`: Normal
* `Warning`: A condition exists that requires attention
* `Critical`: A critical condition exists that requires immediate
attention
'
enum:
- OK
- Warning
- Critical
example: OK
nullable: true
readOnly: true
type: string
x-added: iLO 5 1.10
x-longDescription: This property shall represent the HealthState of
the resource and its dependent resources. The values shall conform
to those defined in the Redfish specification.
State:
description: 'This indicates the known state of the resource, such as
if it is enabled.
Defined values are:
* `Enabled`: This function or resource has been enabled.
* `Disabled`: This function or resource has been disabled.
* `StandbyOffline`: This function or resource is enabled, but awaiting
an external action to activate it.
* `StandbySpare`: This function or resource is part of a redundancy
set and is awaiting a failover or other external action to activate
it.
* `InTest`: This function or resource is undergoing testing.
* `Starting`: This function or resource is starting.
* `Absent`: This function or resource is not present or not detected.
* `UnavailableOffline`: This function or resource is present but cannot
be used.
* `Deferring`: The element will not process any commands but will
queue new requests.
* `Quiesced`: The element is enabled but only processes a restricted
set of commands.
* `Updating`: The element is updating and may be unavailable or degraded.
'
enum:
- Enabled
- Disabled
- StandbyOffline
- StandbySpare
- InTest
- Starting
- Absent
- UnavailableOffline
- Deferring
- Quiesced
- Updating
example: Enabled
nullable: true
readOnly: true
type: string
x-added: iLO 5 1.10
x-longDescription: This property shall represent if this component is
available or not and why. Enabled indicates the resource is available. Disabled
indicates the resource has been intentionally made unavailable but
it can be enabled. Offline indicates the resource is unavailable
intentionally and requires action to be made available. InTest indicates
that the component is undergoing testing. Starting indicates that
the resource is on its way to becoming available. Absent indicates
the resources is physically unavailable.
type: object
x-added: iLO 5 1.10
Subscriptions:
description: This is a reference to a collection of ListenerDestination
resources.
properties:
'@odata.id':
example: /EventService/Subscriptions/
format: uri
readOnly: true
type: string
x-longDescription: The value of this property shall be the unique identifier
for the resource and it shall be of the form defined in the SPMF specification.
readOnly: true
type: object
x-added: iLO 5 1.10
readOnly: false
type: object
EventService.SubmitTestEvent:
properties:
EventId:
readOnly: false
type: string
EventTimestamp:
format: date-time
readOnly: false
type: string
EventType:
description: 'Defined values are:
* `StatusChange`
* `ResourceUpdated`
* `ResourceAdded`
* `ResourceRemoved`
* `Alert`
'
enum:
- StatusChange
- ResourceUpdated
- ResourceAdded
- ResourceRemoved
- Alert
readOnly: false
type: string
Message:
readOnly: false
type: string
MessageArgs:
items:
readOnly: false
type: string
readOnly: false
type: array
MessageId:
readOnly: false
type: string
OriginOfCondition:
readOnly: false
type: string
Severity:
description: 'Defined values are:
* `OK`
* `Warning`
* `Critical`
'
enum:
- OK
- Warning
- Critical
readOnly: false
type: string
type: object
ExtendedInfo:
properties:
error:
properties:
'@Message.ExtendedInfo':
description: An array of message objects describing one or more error
message(s).
items:
properties:
MessageArgs:
items:
example: message argument
type: string
type: array
MessageId:
example: iLO.0.10.SpecificMessage
type: string
type: object
type: array
code:
description: A string indicating a specific MessageId from the message
registry.
example: iLO.0.10.ExtendedInfo
type: string
message:
description: A human-readable error message corresponding to the message
in the message registry.
example: See @Message.ExtendedInfo for more information.
type: string
type: object
type: object
HostInterface:
description: The HostInterface schema represents a single host interface.
properties:
'@odata.context':
example: /$metadata#HostInterface.HostInterface
format: uri
readOnly: true
type: string
x-longDescription: The value of this property shall be the context URL that
describes the resource according to OData-Protocol and shall be of the
form defined in the SPMF specification.
'@odata.etag':
example: W/\B34B5ADE\""
readOnly: true
type: string
x-longDescription: The value of this property is the Etag of the resource.
'@odata.id':
example: /Managers/1/HostInterfaces/1/
format: uri
readOnly: true
type: string
x-longDescription: The value of this property shall be the unique identifier
for the resource and it shall be of the form defined in the SPMF specification.
'@odata.type':
example: '#HostInterface.v1_1_1.HostInterface'
readOnly: true
type: string
x-longDescription: The value of this property shall be an absolute URL that
specifies the type of the resource and it shall be of the form defined
in the SPMF specification.
AuthenticationModes:
description: This indicates the authentication modes available on this interface.
items:
description: An authentication mode allowed by this interface.
properties:
AuthenticationMode:
description: 'Defined values are:
* `AuthNone`: Requests without any sort of authentication are allowed.
* `BasicAuth`: Requests using HTTP Basic Authentication are allowed.
* `RedfishSessionAuth`: Requests using Redfish Session Authentication
are allowed.
* `OemAuth`: Requests using OEM authentication mechanisms are allowed.
'
enum:
- AuthNone
- BasicAuth
- RedfishSessionAuth
- OemAuth
readOnly: false
type: string
x-added: iLO 5 1.40
readOnly: false
type: object
readOnly: false
type: array
x-added: iLO 5 1.40
x-longDescription: The value of this property shall be an array consisting
of the authentication modes allowed on this interface.
Description:
description: Provides a description of this resource and is used for commonality in
the schema definitions.
nullable: true
readOnly: true
type: string
x-added: iLO 5 1.40
x-longDescription: This object represents the Description property. All
values for resources described by this schema shall comply to the requirements
as described in the Redfish specification.
ExternallyAccessible:
description: This indicates whether this interface is accessible by external
entities.
example: 'false'
nullable: true
readOnly: true
type: boolean
x-added: iLO 5 1.40
x-longDescription: The value of this property shall be a boolean indicating
whether this interface is accessible by external (non-host) entities.
FirmwareAuthEnabled:
description: This indicates whether this firmware authentication is enabled
for this interface.
nullable: true
readOnly: false
type: boolean
x-added: iLO 5 1.40
x-longDescription: The value of this property shall be a boolean indicating
whether firmware authentication for this interface is enabled.
FirmwareAuthRoleId:
description: This property contains the Role for firmware authentication
on this interface.
readOnly: false
type: string
x-added: iLO 5 1.40
x-longDescription: The value of this property shall be the ID of the Role
resource that is configured for firmware authentication on this interface.
HostEthernetInterfaces:
description: This is a reference to a collection of NICs that Computer Systems
use for network communication with this Host Interface.
properties:
'@odata.id':
format: uri
readOnly: true
type: string
x-longDescription: The value of this property shall be the unique identifier
for the resource and it shall be of the form defined in the SPMF specification.
readOnly: true
type: object
x-added: iLO 5 1.40
x-longDescription: The value of this property shall be a link to a collection
of type EthernetInterfaceCollection that Computer Systems use as the Host
Interface to this Manager.
HostInterfaceType:
description: 'This indicates the Host Interface type for this interface.
Defined values are:
* `NetworkHostInterface`: This interface is a Network Host Interface.
'
enum:
- NetworkHostInterface
example: NetworkHostInterface
nullable: true
readOnly: true
type: string
x-added: iLO 5 1.40
x-longDescription: The value of this property shall be an enumeration describing
type of the interface.
Id:
description: Uniquely identifies the resource within the collection of like
resources.
example: '1'
readOnly: true
type: string
x-added: iLO 5 1.40
x-longDescription: This property represents an identifier for the resource. All
values for resources described by this schema shall comply to the requirements
as described in the Redfish specification.
InterfaceEnabled:
description: This indicates whether this interface is enabled.
example: 'false'
nullable: true
readOnly: false
type: boolean
x-added: iLO 5 1.40
x-longDescription: The value of this property shall be a boolean indicating
whether this interface is enabled.
KernelAuthEnabled:
description: This indicates whether this kernel authentication is enabled
for this interface.
nullable: true
readOnly: false
type: boolean
x-added: iLO 5 1.40
x-longDescription: The value of this property shall be a boolean indicating
whether kernel authentication for this interface is enabled.
KernelAuthRoleId:
description: This property contains the Role for kernel authentication on
this interface.
readOnly: false
type: string
x-added: iLO 5 1.40
x-longDescription: The value of this property shall be the ID of the Role
resource that is configured for kernel authentication on this interface.
Links:
description: This object represents the Oem property.
readOnly: true
x-added: iLO 5 1.40
x-longDescription: The Links property, as described by the Redfish Specification,
shall contain references to resources that are related to, but not contained
by (subordinate to), this resource.
ManagerEthernetInterface:
description: This is a reference to a single NIC that this Manager uses
for network communication with this Host Interface.
properties:
'@odata.id':
format: uri
readOnly: true
type: string
x-longDescription: The value of this property shall be the unique identifier
for the resource and it shall be of the form defined in the SPMF specification.
readOnly: true
type: object
x-added: iLO 5 1.40
x-longDescription: The value of this property shall be a link to a resource
of type EthernetInterface which represents the network interface used
by this Manager as the HostInterface.
Name:
description: The name of the resource or array element.
example: USB Virtual Ethernet Interface
readOnly: true
type: string
x-added: iLO 5 1.40
NetworkProtocol:
description: This is a reference to the network services and their settings
that the Manager controls. It is here that clients will find network
configuration options as well as network services.
properties:
'@odata.id':
example: /Managers/1/NetworkProtocol/
format: uri
readOnly: true
type: string
x-longDescription: The value of this property shall be the unique identifier
for the resource and it shall be of the form defined in the SPMF specification.
readOnly: true
type: object
x-added: iLO 5 1.40
x-longDescription: The value of this property shall contain a reference
to a resource of type ManagerNetworkProtocol which represents the network
services for this Manager.
Oem:
description: This object represents the Oem property.
readOnly: true
x-longDescription: The value of this string shall be of the format for the
reserved word *Oem*.
Status:
description: Status
properties:
Health:
description: 'This represents the health state of this resource in the
absence of its dependent resources.
Defined values are:
* `OK`: Normal
* `Warning`: A condition exists that requires attention
* `Critical`: A critical condition exists that requires immediate
attention
'
enum:
- OK
- Warning
- Critical
nullable: true
readOnly: true
type: string
x-added: iLO 5 1.40
x-longDescription: This property shall represent the HealthState of
the resource without considering its dependent resources. The values
shall conform to those defined in the Redfish specification.
HealthRollup:
description: 'This represents the overall health state from the view
of this resource.
Defined values are:
* `OK`: Normal
* `Warning`: A condition exists that requires attention
* `Critical`: A critical condition exists that requires immediate
attention
'
enum:
- OK
- Warning
- Critical
nullable: true
readOnly: true
type: string
x-added: iLO 5 1.40
x-longDescription: This property shall represent the HealthState of
the resource and its dependent resources. The values shall conform
to those defined in the Redfish specification.
State:
description: 'This indicates the known state of the resource, such as
if it is enabled.
Defined values are:
* `Enabled`: This function or resource has been enabled.
* `Disabled`: This function or resource has been disabled.
* `StandbyOffline`: This function or resource is enabled, but awaiting
an external action to activate it.
* `StandbySpare`: This function or resource is part of a redundancy
set and is awaiting a failover or other external action to activate
it.
* `InTest`: This function or resource is undergoing testing.
* `Starting`: This function or resource is starting.
* `Absent`: This function or resource is not present or not detected.
* `UnavailableOffline`: This function or resource is present but cannot
be used.
* `Deferring`: The element will not process any commands but will
queue new requests.
* `Quiesced`: The element is enabled but only processes a restricted
set of commands.
* `Updating`: The element is updating and may be unavailable or degraded.
'
enum:
- Enabled
- Disabled
- StandbyOffline
- StandbySpare
- InTest
- Starting
- Absent
- UnavailableOffline
- Deferring
- Quiesced
- Updating
example: Disabled
nullable: true
readOnly: true
type: string
x-added: iLO 5 1.40
x-longDescription: This property shall represent if this component is
available or not and why. Enabled indicates the resource is available. Disabled
indicates the resource has been intentionally made unavailable but
it can be enabled. Offline indicates the resource is unavailable
intentionally and requires action to be made available. InTest indicates
that the component is undergoing testing. Starting indicates that
the resource is on its way to becoming available. Absent indicates
the resources is physically unavailable.
type: object
x-added: iLO 5 1.40
type: object
x-longDescription: This resource shall be used to represent Host Interface resources
as part of the Redfish specification.
HostInterface.Update:
description: The HostInterface schema represents a single host interface.
properties:
AuthenticationModes:
description: This indicates the authentication modes available on this interface.
items:
description: An authentication mode allowed by this interface.
properties:
AuthenticationMode:
description: 'Defined values are:
* `AuthNone`: Requests without any sort of authentication are allowed.
* `BasicAuth`: Requests using HTTP Basic Authentication are allowed.
* `RedfishSessionAuth`: Requests using Redfish Session Authentication
are allowed.
* `OemAuth`: Requests using OEM authentication mechanisms are allowed.
'
enum:
- AuthNone
- BasicAuth
- RedfishSessionAuth
- OemAuth
readOnly: false
type: string
readOnly: false
type: object
readOnly: false
type: array
x-longDescription: The value of this property shall be an array consisting
of the authentication modes allowed on this interface.
FirmwareAuthEnabled:
description: This indicates whether this firmware authentication is enabled
for this interface.
nullable: true
readOnly: false
type: boolean
x-longDescription: The value of this property shall be a boolean indicating
whether firmware authentication for this interface is enabled.
FirmwareAuthRoleId:
description: This property contains the Role for firmware authentication
on this interface.
readOnly: false
type: string
x-longDescription: The value of this property shall be the ID of the Role
resource that is configured for firmware authentication on this interface.
InterfaceEnabled:
description: This indicates whether this interface is enabled.
nullable: true
readOnly: false
type: boolean
x-longDescription: The value of this property shall be a boolean indicating
whether this interface is enabled.
KernelAuthEnabled:
description: This indicates whether this kernel authentication is enabled
for this interface.
nullable: true
readOnly: false
type: boolean
x-longDescription: The value of this property shall be a boolean indicating
whether kernel authentication for this interface is enabled.
KernelAuthRoleId:
description: This property contains the Role for kernel authentication on
this interface.
readOnly: false
type: string
x-longDescription: The value of this property shall be the ID of the Role
resource that is configured for kernel authentication on this interface.
Links:
description: This object represents the Oem property.
readOnly: true
x-longDescription: The Links property, as described by the Redfish Specification,
shall contain references to resources that are related to, but not contained
by (subordinate to), this resource.
Oem:
description: This object represents the Oem property.
readOnly: true
x-longDescription: The value of this string shall be of the format for the
reserved word *Oem*.
type: object
x-longDescription: This resource shall be used to represent Host Interface resources
as part of the Redfish specification.
HostInterfaceCollection:
description: A Collection of HostInterface resource instances.
properties:
'@odata.context':
example: /$metadata#HostInterfaceCollection.HostInterfaceCollection
format: uri
readOnly: true
type: string
x-longDescription: The value of this property shall be the context URL that
describes the resource according to OData-Protocol and shall be of the
form defined in the SPMF specification.
'@odata.etag':
example: W/\AA6D42B0\""
readOnly: true
type: string
x-longDescription: The value of this property is the Etag of the resource.
'@odata.id':
example: /Managers/1/HostInterfaces/
format: uri
readOnly: true
type: string
x-longDescription: The value of this property shall be the unique identifier
for the resource and it shall be of the form defined in the SPMF specification.
'@odata.type':
example: '#HostInterfaceCollection.HostInterfaceCollection'
readOnly: true
type: string
x-longDescription: The value of this property shall be an absolute URL that
specifies the type of the resource and it shall be of the form defined
in the SPMF specification.
Members:
description: Contains the members of this collection.
items:
properties:
'@odata.id':
example: /Managers/1/HostInterfaces/1/
format: uri
readOnly: true
type: string
x-longDescription: The value of this property shall be the unique
identifier for the resource and it shall be of the form defined
in the SPMF specification.
type: object
readOnly: true
type: array
Members@odata.count:
description: The total number of collection members.
example: '1'
readOnly: true
type: integer
Name:
description: The name of the resource or array element.
example: Host Interfaces
readOnly: true
type: string
Oem:
description: This object represents the Oem property.
readOnly: true
x-longDescription: The value of this string shall be of the format for the
reserved word *Oem*.
type: object
HpeBaseConfigs:
properties:
'@odata.context':
description: The OData description of a payload.
example: /$metadata#HpeBaseConfigs.HpeBaseConfigs
format: uri
readOnly: true
type: string
x-longDescription: The value of this property shall be the context URL that
describes the resource according to OData-Protocol and shall be of the
form defined in the Redfish specification.
'@odata.etag':
example: W/\C4B6CE4317286868684410B85E3FDCCE\""
readOnly: true
type: string
x-longDescription: The value of this property is the Etag of the resource.
'@odata.id':
description: The unique identifier for a resource.
example: /systems/1/bios/iscsi/baseconfigs/
format: uri
readOnly: true
type: string
x-longDescription: The value of this property shall be the unique identifier
for the resource and it shall be of the form defined in the Redfish specification.
'@odata.type':
description: The type of a resource.
example: '#HpeBaseConfigs.v2_0_0.HpeBaseConfigs'
readOnly: true
type: string
x-longDescription: The value of this property shall be an absolute URL that
specifies the type of the resource and it shall be of the form defined
in the Redfish specification.
BaseConfigs:
items: {}
readOnly: true
type: array
Capabilities:
properties:
BaseConfig:
example: 'true'
readOnly: true
type: boolean
BaseConfigs:
example: 'false'
readOnly: true
type: boolean
readOnly: true
type: object
Id:
description: Uniquely identifies the resource within the collection of like
resources.
example: baseconfigs
readOnly: true
type: string
x-longDescription: This property represents an identifier for the resource. All
values for resources described by this schema shall comply to the requirements
as described in the Redfish specification.
Name:
description: The name of the resource or array element.
example: iSCSI Software Initiator Default Settings
readOnly: true
type: string
x-longDescription: This object represents the Name property. All values
for resources described by this schema shall comply to the requirements
as described in the Redfish specification. The value of this string shall
be of the format for the reserved word *Name*.
type: object
HpeBaseNetworkAdapter:
properties:
'@odata.context':
example: /$metadata#HpeBaseNetworkAdapter.HpeBaseNetworkAdapter
format: uri
readOnly: true
type: string
x-longDescription: The value of this property shall be the context URL that
describes the resource according to OData-Protocol and shall be of the
form defined in the SPMF specification.
'@odata.etag':
example: W/\649D9173\""
readOnly: true
type: string
x-longDescription: The value of this property is the Etag of the resource.
'@odata.id':
example: /Systems/1/BaseNetworkAdapters/1/
format: uri
readOnly: true
type: string
x-longDescription: The value of this property shall be the unique identifier
for the resource and it shall be of the form defined in the SPMF specification.
'@odata.type':
example: '#HpeBaseNetworkAdapter.v2_0_0.HpeBaseNetworkAdapter'
readOnly: true
type: string
x-longDescription: The value of this property shall be an absolute URL that
specifies the type of the resource and it shall be of the form defined
in the SPMF specification.
FcPorts:
description: Information about the Fiber Channel Ports in the server.
items:
properties:
PortNumber:
description: Port Number.
nullable: true
readOnly: true
type: integer
x-added: iLO 5 1.10
WWNN:
description: World Wide Node Name.
nullable: true
readOnly: true
type: string
x-added: iLO 5 1.10
WWPN:
description: World Wide Port Name.
nullable: true
readOnly: true
type: string
x-added: iLO 5 1.10
type: object
readOnly: true
type: array
x-added: iLO 5 1.10
Firmware:
description: The schema definition for the current firmware version.
properties:
Current:
description: This object contains information about the version of a
firmware image.
properties:
VersionString:
description: This string represents the version of the firmware
image.
example: 16.24.1000
nullable: true
readOnly: true
type: string
x-added: iLO 5 1.10
readOnly: true
type: object
x-added: iLO 5 1.10
readOnly: true
type: object
x-added: iLO 5 1.10
Id:
description: Uniquely identifies the resource within the collection of like
resources.
example: '1'
readOnly: true
type: string
x-added: iLO 5 1.10
x-longDescription: This property represents an identifier for the resource. All
values for resources described by this schema shall comply to the requirements
as described in the Redfish specification.
Name:
description: This is the schema definition for the System NIC. It represents
the properties and has links associated with System NIC.
example: HPE InfiniBand EDR 100Gb 1-port 841QSFP28 Adapter
readOnly: true
type: string
x-added: iLO 5 1.10
PartNumber:
description: The device part number.
example: 878578-001
nullable: true
readOnly: true
type: string
x-added: iLO 5 1.10
PhysicalPorts:
items:
description: Information about the integrated and add-in NICs in the server.
properties:
FullDuplex:
description: Full-duplex data transmission means that data can be
transmitted in both directions on a signal carrier at the same time.
example: 'true'
nullable: true
readOnly: true
type: boolean
x-added: iLO 5 1.10
IPv4Addresses:
description: This array of objects is used to represent the IPv4 connection
characteristics for this interface.
items:
description: This object describes the IPv4 portions for this NIC.
properties:
Address:
description: This is the IPv4 Address.
example: 169.254.68.152
nullable: true
readOnly: true
type: string
x-added: iLO 5 1.10
readOnly: true
type: object
readOnly: true
type: array
x-added: iLO 5 1.10
IPv6Addresses:
description: This array of objects enumerates all of the currently
assigned IPv6 addresses on this interface.
items:
description: This object describes a single IPv6 address currently
assigned on this interface.
properties:
Address:
description: This is the IPv6 Address.
example: fe80::21e4:e75e:b1eb:4498%25
format: ipv6
nullable: true
readOnly: true
type: string
x-added: iLO 5 1.10
readOnly: true
type: object
readOnly: true
type: array
x-added: iLO 5 1.10
LinkStatus:
description: 'The link status of this interface (port).
Defined values are:
* `LinkUp`
* `NoLink`
* `LinkDown`
'
enum:
- LinkUp
- NoLink
- LinkDown
example: LinkUp
nullable: true
type: string
x-added: iLO 5 1.20
MacAddress:
description: The port MAC address.
example: 98:f2:b3:c6:4b:10
nullable: true
readOnly: true
type: string
x-added: iLO 5 1.10
Name:
description: The configured network port name.
example: PCIe Slot 1 3 Port 1
nullable: true
readOnly: true
type: string
x-added: iLO 5 1.10
Oem:
properties:
Hpe:
properties:
'@odata.context':
format: uri
readOnly: true
type: string
x-longDescription: The value of this property shall be the
context URL that describes the resource according to OData-Protocol
and shall be of the form defined in the SPMF specification.
'@odata.etag':
readOnly: true
type: string
x-longDescription: The value of this property is the Etag
of the resource.
'@odata.id':
format: uri
readOnly: true
type: string
x-longDescription: The value of this property shall be the
unique identifier for the resource and it shall be of the
form defined in the SPMF specification.
'@odata.type':
readOnly: true
type: string
x-longDescription: The value of this property shall be an
absolute URL that specifies the type of the resource and
it shall be of the form defined in the SPMF specification.
BadReceives:
description: A count of frames that were received by the adapter
but which had an error. This counter is the sum of mib
items cpqNicIfPhysAdapterAlignmentErrors, cpqNicIfPhysAdapterFCSErrors,
cpqNicIfPhysAdapterFrameTooLongs, and cpqNicIfPhysAdapterInternalMacReceiveErrors.
If this counter increments frequently, check the more detailed
error statistics and take appropriate action.
nullable: true
readOnly: true
type: integer
BadTransmits:
description: A count of frames that were not transmitted by
the adapter because of an error. This counter is the sum
of MIB items cpqNicIfPhysAdapterDeferredTransmissions, cpqNicIfPhysAdapterLateCollisions,
cpqNicIfPhysAdapterExcessiveCollisions, cpqNicIfPhysAdapterCarrierSenseErrors,
and cpqNicIfPhysAdapterInternalMacTransmitErrors. If this
counter increments frequently, check the more detailed error
statistics and take appropriate action.
nullable: true
readOnly: true
type: integer
GoodReceives:
description: A count of frames successfully received by the
physical adapter.
nullable: true
readOnly: true
type: integer
GoodTransmits:
description: A count of frames successfully transmitted by
the physical adapter.
nullable: true
readOnly: true
type: integer
Id:
description: Uniquely identifies the resource within the collection
of like resources.
readOnly: true
type: string
x-longDescription: This property represents an identifier
for the resource. All values for resources described by
this schema shall comply to the requirements as described
in the Redfish specification.
StructuredName:
description: PCI device structured name in UTF-8 format (e.g.
'NIC.LOM.1.1' - see PCIDevices in /rest/v1/Systems/x/PCIDevices
- this comes from SMBIOS
nullable: true
readOnly: true
type: string
Team:
description: If a port is configured for NIC teaming, the
name of the configured link between the physical ports that
form a logical network adapter. This value is displayed
for system NICs only (embedded and stand-up).
nullable: true
readOnly: true
type: string
readOnly: true
type: object
type: object
SpeedMbps:
description: An estimate of the interface's current bandwidth in Megabits
per second. For interfaces which do not vary in bandwidth or for
those where no accurate estimation can be made, this object should
contain the nominal bandwidth.
example: '20000'
nullable: true
readOnly: true
type: integer
x-added: iLO 5 1.10
Status:
properties:
Health:
description: 'This represents the health state of this resource
in the absence of its dependent resources.
Defined values are:
* `OK`: Normal
* `Warning`: A condition exists that requires attention
* `Critical`: A critical condition exists that requires immediate
attention
'
enum:
- OK
- Warning
- Critical
example: OK
nullable: true
readOnly: true
type: string
x-added: iLO 5 1.10
x-longDescription: This property shall represent the HealthState
of the resource without considering its dependent resources.
The values shall conform to those defined in the Redfish specification.
HealthRollup:
description: 'This represents the overall health state from the
view of this resource.
Defined values are:
* `OK`: Normal
* `Warning`: A condition exists that requires attention
* `Critical`: A critical condition exists that requires immediate
attention
'
enum:
- OK
- Warning
- Critical
nullable: true
readOnly: true
type: string
x-added: iLO 5 1.10
x-longDescription: This property shall represent the HealthState
of the resource and its dependent resources. The values shall
conform to those defined in the Redfish specification.
State:
description: 'This indicates the known state of the resource,
such as if it is enabled.
Defined values are:
* `Enabled`: This function or resource has been enabled.
* `Disabled`: This function or resource has been disabled.
* `StandbyOffline`: This function or resource is enabled, but
awaiting an external action to activate it.
* `StandbySpare`: This function or resource is part of a redundancy
set and is awaiting a failover or other external action to activate
it.
* `InTest`: This function or resource is undergoing testing.
* `Starting`: This function or resource is starting.
* `Absent`: This function or resource is not present or not
detected.
* `UnavailableOffline`: This function or resource is present
but cannot be used.
* `Deferring`: The element will not process any commands but
will queue new requests.
* `Quiesced`: The element is enabled but only processes a restricted
set of commands.
* `Updating`: The element is updating and may be unavailable
or degraded.
'
enum:
- Enabled
- Disabled
- StandbyOffline
- StandbySpare
- InTest
- Starting
- Absent
- UnavailableOffline
- Deferring
- Quiesced
- Updating
nullable: true
readOnly: true
type: string
x-added: iLO 5 1.10
x-longDescription: This property shall represent if this component
is available or not and why. Enabled indicates the resource
is available. Disabled indicates the resource has been intentionally
made unavailable but it can be enabled. Offline indicates the
resource is unavailable intentionally and requires action to
be made available. InTest indicates that the component is undergoing
testing. Starting indicates that the resource is on its way
to becoming available. Absent indicates the resources is physically
unavailable.
type: object
x-added: iLO 5 1.10
UEFIDevicePath:
description: UEFIDevice Path for correlation purposes
nullable: true
readOnly: true
type: string
x-added: iLO 5 1.10
readOnly: true
type: object
type: array
x-added: iLO 5 1.10
SerialNumber:
description: The device serial number.
example: xxxxxxxxxx
nullable: true
readOnly: true
type: string
x-added: iLO 5 1.10
Status:
properties:
Health:
description: 'This represents the health state of this resource in the
absence of its dependent resources.
Defined values are:
* `OK`: Normal
* `Warning`: A condition exists that requires attention
* `Critical`: A critical condition exists that requires immediate
attention
'
enum:
- OK
- Warning
- Critical
example: OK
nullable: true
readOnly: true
type: string
x-added: iLO 5 1.10
x-longDescription: This property shall represent the HealthState of
the resource without considering its dependent resources. The values
shall conform to those defined in the Redfish specification.
HealthRollup:
description: 'This represents the overall health state from the view
of this resource.
Defined values are:
* `OK`: Normal
* `Warning`: A condition exists that requires attention
* `Critical`: A critical condition exists that requires immediate
attention
'
enum:
- OK
- Warning
- Critical
nullable: true
readOnly: true
type: string
x-added: iLO 5 1.10
x-longDescription: This property shall represent the HealthState of
the resource and its dependent resources. The values shall conform
to those defined in the Redfish specification.
State:
description: 'This indicates the known state of the resource, such as
if it is enabled.
Defined values are:
* `Enabled`: This function or resource has been enabled.
* `Disabled`: This function or resource has been disabled.
* `StandbyOffline`: This function or resource is enabled, but awaiting
an external action to activate it.
* `StandbySpare`: This function or resource is part of a redundancy
set and is awaiting a failover or other external action to activate
it.
* `InTest`: This function or resource is undergoing testing.
* `Starting`: This function or resource is starting.
* `Absent`: This function or resource is not present or not detected.
* `UnavailableOffline`: This function or resource is present but cannot
be used.
* `Deferring`: The element will not process any commands but will
queue new requests.
* `Quiesced`: The element is enabled but only processes a restricted
set of commands.
* `Updating`: The element is updating and may be unavailable or degraded.
'
enum:
- Enabled
- Disabled
- StandbyOffline
- StandbySpare
- InTest
- Starting
- Absent
- UnavailableOffline
- Deferring
- Quiesced
- Updating
example: Enabled
nullable: true
readOnly: true
type: string
x-added: iLO 5 1.10
x-longDescription: This property shall represent if this component is
available or not and why. Enabled indicates the resource is available. Disabled
indicates the resource has been intentionally made unavailable but
it can be enabled. Offline indicates the resource is unavailable
intentionally and requires action to be made available. InTest indicates
that the component is undergoing testing. Starting indicates that
the resource is on its way to becoming available. Absent indicates
the resources is physically unavailable.
type: object
x-added: iLO 5 1.10
StructuredName:
description: PCI device structured name in UTF-8 format (e.g. 'NIC.LOM.1.1'
- see PCIDevices in /rest/v1/Systems/x/PCIDevices - this comes from SMBIOS
example: NIC.Slot.1.1
nullable: true
readOnly: true
type: string
x-added: iLO 5 1.10
UEFIDevicePath:
description: UEFIDevice Path for correlation purposes
example: PciRoot(0x1)/Pci(0x0,0x0)/Pci(0x0,0x0)
nullable: true
readOnly: true
type: string
x-added: iLO 5 1.10
readOnly: true
type: object
HpeBaseNetworkAdapterCollection:
properties:
'@odata.context':
example: /$metadata#HpeBaseNetworkAdapterCollection.HpeBaseNetworkAdapterCollection
format: uri
readOnly: true
type: string
x-longDescription: The value of this property shall be the context URL that
describes the resource according to OData-Protocol and shall be of the
form defined in the SPMF specification.
'@odata.etag':
example: W/\E589C4BF\""
readOnly: true
type: string
x-longDescription: The value of this property is the Etag of the resource.
'@odata.id':
example: /Systems/1/BaseNetworkAdapters/
format: uri
readOnly: true
type: string
x-longDescription: The value of this property shall be the unique identifier
for the resource and it shall be of the form defined in the SPMF specification.
'@odata.type':
example: '#HpeBaseNetworkAdapterCollection.HpeBaseNetworkAdapterCollection'
readOnly: true
type: string
x-longDescription: The value of this property shall be an absolute URL that
specifies the type of the resource and it shall be of the form defined
in the SPMF specification.
Description:
description: Provides a description of this resource and is used for commonality in
the schema definitions.
example: NetworkAdapters view
nullable: true
readOnly: true
type: string
x-longDescription: This object represents the Description property. All
values for resources described by this schema shall comply to the requirements
as described in the Redfish specification.
Members:
description: Contains the members of this collection.
items:
properties:
'@odata.id':
example: /Systems/1/BaseNetworkAdapters/1/
format: uri
readOnly: true
type: string
x-longDescription: The value of this property shall be the unique
identifier for the resource and it shall be of the form defined
in the SPMF specification.
type: object
readOnly: true
type: array
Members@odata.count:
description: The total number of collection members.
example: '3'
readOnly: true
type: integer
Name:
description: The name of the resource or array element.
example: NetworkAdapters Collection
readOnly: true
type: string
Oem:
description: This object represents the Oem property.
readOnly: true
x-longDescription: The value of this string shall be of the format for the
reserved word *Oem*.
type: object
HpeBiosMapping:
description: This is the schema definition for the BIOS Attributes Mappings
resource.
properties:
'@odata.context':
description: The OData description of a payload.
example: /$metadata#HpeBiosMapping.HpeBiosMapping
format: uri
readOnly: true
type: string
x-longDescription: The value of this property shall be the context URL that
describes the resource according to OData-Protocol and shall be of the
form defined in the Redfish specification.
'@odata.etag':
example: W/\53DA8AA004E026262693EA941589DA2C\""
readOnly: true
type: string
x-longDescription: The value of this property is the Etag of the resource.
'@odata.id':
description: The unique identifier for a resource.
example: /systems/1/bios/mappings/
format: uri
readOnly: true
type: string
x-longDescription: The value of this property shall be the unique identifier
for the resource and it shall be of the form defined in the Redfish specification.
'@odata.type':
description: The type of a resource.
example: '#HpeBiosMapping.v2_0_0.HpeBiosMapping'
readOnly: true
type: string
x-longDescription: The value of this property shall be an absolute URL that
specifies the type of the resource and it shall be of the form defined
in the Redfish specification.
AttributeRegistry:
description: The Resource ID of the Attribute Registry for the BIOS Attributes
resource.
nullable: true
type: string
x-longDescription: The reference to the Attribute Registry that lists the
metadata describing the BIOS attribute settings in this resource.
BiosPciSettingsMappings:
description: Mappings of BIOS settings to the corresponding PCI devices.
This includes, for example, mappings of BIOS settings that enable or disable
PCI devices or network boot.
items:
properties:
Associations:
description: The BIOS settings associated with the parent PCI device.
The settings can be modified by looking them up in the HpBios pending
settings resource. Settings can be listed as property names (of
type 'string'), or property name/value pair (of type 'object')
items:
nullable: true
type: string
readOnly: true
type: array
CorrelatableID:
description: Contains any CorrelatableIDs that represent this PCI
device. The CorrelatableID values can be JSON Pointers or UEFI identifiers.
example: PciRoot(0x0)/Pci(0x17,0x0)
readOnly: true
type: string
Instance:
description: The instance number of the parent PCI device for this
association set.
example: '1'
readOnly: true
type: integer
Subinstances:
description: The sub-instances of child PCI devices and BIOS settings
that are associated.
items:
properties:
Associations:
description: The BIOS settings associated with the child PCI
device. These settings can be modified by looking them up
in the HpBios pending settings resource.
items:
type: string
readOnly: true
type: array
CorrelatableID:
description: Contains any CorrelatableIDs that represent this
PCI device. The CorrelatableID values can be JSON Pointers
or UEFI identifiers.
readOnly: true
type: string
Subinstance:
description: The sub-instance number of the child PCI device
for this association set.
readOnly: true
type: integer
type: object
readOnly: true
type: array
type: object
readOnly: true
type: array
Id:
description: Uniquely identifies the resource within the collection of like
resources.
example: mappings
readOnly: true
type: string
x-longDescription: This property represents an identifier for the resource. All
values for resources described by this schema shall comply to the requirements
as described in the Redfish specification.
Name:
description: The name of the resource or array element.
example: BIOS mappings
readOnly: true
type: string
x-longDescription: This object represents the Name property. All values
for resources described by this schema shall comply to the requirements
as described in the Redfish specification. The value of this string shall
be of the format for the reserved word *Name*.
type: object
x-longDescription: This resource shall be used to represent BIOS Attribute Mappings.
HpeCertAuth:
description: This is the schema definition for certificate based authentication
configuration.
properties:
'@odata.context':
example: /$metadata#HpeCertAuth.HpeCertAuth
format: uri
readOnly: true
type: string
x-longDescription: The value of this property shall be the context URL that
describes the resource according to OData-Protocol and shall be of the
form defined in the SPMF specification.
'@odata.etag':
example: W/\967B38FC\""
readOnly: true
type: string
x-longDescription: The value of this property is the Etag of the resource.
'@odata.id':
example: /Managers/1/SecurityService/CertificateAuthentication/
format: uri
readOnly: true
type: string
x-longDescription: The value of this property shall be the unique identifier
for the resource and it shall be of the form defined in the SPMF specification.
'@odata.type':
example: '#HpeCertAuth.v1_1_0.HpeCertAuth'
readOnly: true
type: string
x-longDescription: The value of this property shall be an absolute URL that
specifies the type of the resource and it shall be of the form defined
in the SPMF specification.
Actions:
properties:
'#HpeCertAuth.DeleteCRL':
properties:
target:
description: Link to invoke action
example: /Managers/1/SecurityService/CertificateAuthentication/Actions/HpeCertAuth.DeleteCRL/
type: string
title:
description: Friendly action name
type: string
type: object
'#HpeCertAuth.ImportCACertificate':
properties:
Certificate@Redfish.AllowableValues:
description: The supported values for the Certificate parameter.
items:
description: Contains PEM formatted X509 certificate (Base64 encoded).
format: text
readOnly: false
type: string
type: array
x-longDescription: The supported values for the Certificate parameter.
target:
description: Link to invoke action
example: /Managers/1/SecurityService/CertificateAuthentication/Actions/HpeCertAuth.ImportCACertificate/
type: string
title:
description: Friendly action name
type: string
type: object
'#HpeCertAuth.ImportCRL':
properties:
ImportUri:
description: The supported values for the Certificate parameter.
items:
description: Contains PEM formatted X509 certificate (Base64 encoded).
format: text
readOnly: false
type: string
type: array
x-longDescription: The supported values for the Certificate parameter.
target:
description: Link to invoke action
example: /Managers/1/SecurityService/CertificateAuthentication/Actions/HpeCertAuth.ImportCRL/
type: string
title:
description: Friendly action name
type: string
type: object
type: object
CACertificates:
description: The value of this property shall be a reference to a Collection
of HpeCertificate resources.
properties:
'@odata.id':
example: /Managers/1/SecurityService/CertificateAuthentication/CACertificates/
format: uri
readOnly: true
type: string
x-longDescription: The value of this property shall be the unique identifier
for the resource and it shall be of the form defined in the SPMF specification.
readOnly: true
type: object
x-added: iLO 5 1.10
CRLIssuer:
description: Issuer of the installed CRL, if present.
example: 'null'
nullable: true
readOnly: true
type: string
x-added: iLO 5 1.10
CRLSerial:
description: Serial Number of the installed CRL, if present.
example: 'null'
nullable: true
readOnly: true
type: string
x-added: iLO 5 1.10
CertificateLoginEnabled:
description: Specifies whether Certificate login is enabled.
example: 'false'
readOnly: false
type: boolean
x-added: iLO 5 1.10
Id:
description: Uniquely identifies the resource within the collection of like
resources.
example: CertificateAuthentication
readOnly: true
type: string
x-added: iLO 5 1.10
x-longDescription: This property represents an identifier for the resource. All
values for resources described by this schema shall comply to the requirements
as described in the Redfish specification.
LDAPCertificateNameMapping:
description: 'The method used to map a certificate to its associated LDAP
user account.
Defined values are:
* `SubjectCN`: The CN portion of the certificate subject will be used
as the LDAP username.
* `SubjectDN`: The fully qualified DN of the certificate subject will
be used as the LDAP username.
* `SANRFC822`: The RFC822 name from the certificate''s subjectAlternativeName
extension will be used as the LDAP username.
* `SANUPN`: The UserPrincipalName from the certificate''s subjectAlternativeName
extension will be used as the LDAP username.
'
enum:
- SubjectCN
- SubjectDN
- SANRFC822
- SANUPN
example: SANUPN
readOnly: false
type: string
x-added: iLO 5 1.10
Links:
description: The links array contains the links to other resources that
are related to this resource.
properties:
UserCertificateMapping:
description: The value of this property shall be a reference to a resource
of Type HpeiLOAccountCertificateMapCollection.
properties:
'@odata.id':
example: /AccountService/UserCertificateMapping/
format: uri
readOnly: true
type: string
x-longDescription: The value of this property shall be the unique
identifier for the resource and it shall be of the form defined
in the SPMF specification.
readOnly: true
type: object
x-added: iLO 5 1.10
type: object
x-added: iLO 5 1.10
OCSPUri:
description: URL to use for OCSP certificate checking.
example: ''
format: uri
nullable: true
readOnly: false
type: string
x-added: iLO 5 1.15
StrictCACModeEnabled:
description: Whether or not Strict CAC Mode is enabled.
example: 'false'
readOnly: false
type: boolean
x-added: iLO 5 1.10
x-longDescription: Whether or not Strict CAC Mode is enabled. In strict
mode, certificates must be supplied for every SSL connection and only
key-based authentication mechanisms are accepted.
readOnly: false
type: object
HpeCertAuth.DeleteCRL:
properties: {}
type: object
HpeCertAuth.ImportCACertificate:
properties:
Certificate:
description: Contains PEM formatted X509 certificate or PKCS7 certificate
chain (Base64 encoded).
format: text
readOnly: false
type: string
type: object
HpeCertAuth.ImportCRL:
properties:
ImportUri:
description: Contains URI of PEM formatted certificate revocation list (CRL)
(Base64 encoded).
format: uri
readOnly: false
type: string
type: object
HpeCertAuth.Update:
description: This is the schema definition for certificate based authentication
configuration.
properties:
Actions:
properties:
'#HpeCertAuth.DeleteCRL':
properties:
target:
description: Link to invoke action
type: string
title:
description: Friendly action name
type: string
type: object
'#HpeCertAuth.ImportCACertificate':
properties:
Certificate@Redfish.AllowableValues:
description: The supported values for the Certificate parameter.
items:
description: Contains PEM formatted X509 certificate (Base64 encoded).
format: text
readOnly: false
type: string
type: array
x-longDescription: The supported values for the Certificate parameter.
target:
description: Link to invoke action
type: string
title:
description: Friendly action name
type: string
type: object
'#HpeCertAuth.ImportCRL':
properties:
ImportUri:
description: The supported values for the Certificate parameter.
items:
description: Contains PEM formatted X509 certificate (Base64 encoded).
format: text
readOnly: false
type: string
type: array
x-longDescription: The supported values for the Certificate parameter.
target:
description: Link to invoke action
type: string
title:
description: Friendly action name
type: string
type: object
type: object
CertificateLoginEnabled:
description: Specifies whether Certificate login is enabled.
readOnly: false
type: boolean
LDAPCertificateNameMapping:
description: 'The method used to map a certificate to its associated LDAP
user account.
Defined values are:
* `SubjectCN`: The CN portion of the certificate subject will be used
as the LDAP username.
* `SubjectDN`: The fully qualified DN of the certificate subject will
be used as the LDAP username.
* `SANRFC822`: The RFC822 name from the certificate''s subjectAlternativeName
extension will be used as the LDAP username.
* `SANUPN`: The UserPrincipalName from the certificate''s subjectAlternativeName
extension will be used as the LDAP username.
'
enum:
- SubjectCN
- SubjectDN
- SANRFC822
- SANUPN
readOnly: false
type: string
OCSPUri:
description: URL to use for OCSP certificate checking.
format: uri
nullable: true
readOnly: false
type: string
StrictCACModeEnabled:
description: Whether or not Strict CAC Mode is enabled.
readOnly: false
type: boolean
x-longDescription: Whether or not Strict CAC Mode is enabled. In strict
mode, certificates must be supplied for every SSL connection and only
key-based authentication mechanisms are accepted.
readOnly: false
type: object
HpeCertificateCollection:
properties:
'@odata.context':
example: /$metadata#HpeCertificateCollection.HpeCertificateCollection
format: uri
readOnly: true
type: string
x-longDescription: The value of this property shall be the context URL that
describes the resource according to OData-Protocol and shall be of the
form defined in the SPMF specification.
'@odata.etag':
example: W/\75983E8D\""
readOnly: true
type: string
x-longDescription: The value of this property is the Etag of the resource.
'@odata.id':
example: /EventService/CACertificates/
format: uri
readOnly: true
type: string
x-longDescription: The value of this property shall be the unique identifier
for the resource and it shall be of the form defined in the SPMF specification.
'@odata.type':
example: '#HpeCertificateCollection.HpeCertificateCollection'
readOnly: true
type: string
x-longDescription: The value of this property shall be an absolute URL that
specifies the type of the resource and it shall be of the form defined
in the SPMF specification.
Description:
description: Provides a description of this resource and is used for commonality in
the schema definitions.
example: Trusted CA Certificates for REST Event Mutual Authentication
nullable: true
readOnly: true
type: string
x-longDescription: This object represents the Description property. All
values for resources described by this schema shall comply to the requirements
as described in the Redfish specification.
Members:
description: Contains the members of this collection.
items:
properties:
'@odata.id':
format: uri
readOnly: true
type: string
x-longDescription: The value of this property shall be the unique
identifier for the resource and it shall be of the form defined
in the SPMF specification.
type: object
readOnly: true
type: array
Members@odata.count:
description: The total number of collection members.
example: '0'
readOnly: true
type: integer
Name:
description: The name of the resource or array element.
example: REST CA Certificates
readOnly: true
type: string
Oem:
description: This object represents the Oem property.
readOnly: true
x-longDescription: The value of this string shall be of the format for the
reserved word *Oem*.
type: object
HpeComponent:
properties:
'@odata.context':
example: /$metadata#HpeComponent.HpeComponent
format: uri
readOnly: true
type: string
x-longDescription: The value of this property shall be the context URL that
describes the resource according to OData-Protocol and shall be of the
form defined in the SPMF specification.
'@odata.etag':
example: W/\CD21D410\
readOnly: true
type: string
x-longDescription: The value of this property is the Etag of the resource.
'@odata.id':
example: /UpdateService/ComponentRepository/a99418fa/
format: uri
readOnly: true
type: string
x-longDescription: The value of this property shall be the unique identifier
for the resource and it shall be of the form defined in the SPMF specification.
'@odata.type':
example: '#HpeComponent.v1_0_1.HpeComponent'
readOnly: true
type: string
x-longDescription: The value of this property shall be an absolute URL that
specifies the type of the resource and it shall be of the form defined
in the SPMF specification.
Activates:
description: 'Indicates when a component becomes active after being updated.
Defined values are:
* `Immediately`: The update activates immediately.
* `AfterReboot`: The update activates after a host server reboot.
* `AfterDeviceReset`: The update activates after a device reset.
* `AfterHardPowerCycle`: The update activates after a full power supply
disconnect or E-Fuse reset.
'
enum:
- Immediately
- AfterReboot
- AfterDeviceReset
- AfterHardPowerCycle
example: AfterDeviceReset
readOnly: true
type: string
x-added: iLO 5 1.10
ComponentType:
description: HTTP-style content-type of binary
readOnly: true
type: string
x-added: iLO 5 1.10
ComponentUri:
description: URI of the component binary.
example: /fwrepo/ilo5_140_p51_checked.bin
format: uri
readOnly: true
type: string
x-added: iLO 5 1.10
Configuration:
description: string defining customized parameters for some components provided
by client at upload time and given to the component at execution time
(Type D only).
example: null
readOnly: false
type: string
x-added: iLO 5 1.10
Created:
description: ISO 8601 time string indicating when this component was added
to the NAND.
example: '2018-11-08T14:51:31Z'
format: date-time
readOnly: true
type: string
x-added: iLO 5 1.10
Criticality:
description: 'Indicates the criticality of the component.
Defined values are:
* `Optional`
* `Recommended`
* `Critical`
'
enum:
- Optional
- Recommended
- Critical
example: Optional
readOnly: false
type: string
x-added: iLO 5 1.10
DeviceClass:
description: Device type GUID from iLO secure flash header
example: 2f317b9d-c9e3-4d76-bff6-b9d0d085a952
readOnly: true
type: string
x-added: iLO 5 1.10
ExecutionParameters:
description: Client supplied execution parameters. These are supplied at
upload time and given to the component at execution time (Type D only).
example: null
readOnly: false
type: string
x-added: iLO 5 1.10
Filename:
description: The unique filename of the component.
example: ilo5_140_p51_checked.bin
readOnly: true
type: string
x-added: iLO 5 1.10
Filepath:
description: Path of file on the USB LUN if you mount the repo as USB.
example: ilo5_140_p51_checked.bin
readOnly: true
type: string
x-added: iLO 5 1.10
Id:
description: Uniquely identifies the resource within the collection of like
resources.
example: a99418fa
readOnly: true
type: string
x-added: iLO 5 1.10
x-longDescription: This property represents an identifier for the resource. All
values for resources described by this schema shall comply to the requirements
as described in the Redfish specification.
Locked:
description: If true, this component cannot be removed with DELETE because
it is referenced by an Install Set
example: 'true'
nullable: true
readOnly: true
type: boolean
x-added: iLO 5 1.10
Name:
description: Name of the component.
example: iLO 5
readOnly: true
type: string
x-added: iLO 5 1.10
SizeBytes:
description: Size of the component file in bytes.
example: '33556503'
nullable: true
readOnly: true
type: integer
x-added: iLO 5 1.10
Targets:
items:
description: Target GUIDs from secure flash header or sidecar file.
type: string
readOnly: true
type: array
x-added: iLO 5 1.10
UpdatableBy:
items:
description: 'Describes which types of update agents may apply this component.
Defined values are:
* `Uefi`: This component may be scheduled for update by UEFI BIOS.
* `RuntimeAgent`: This component may be scheduled for update by a runtime
update agent such as Smart Update Manager or Smart Update Tool.
* `Bmc`: This component may be scheduled for update by iLO.
'
enum:
- Uefi
- RuntimeAgent
- Bmc
readOnly: true
type: string
readOnly: true
type: array
x-added: iLO 5 1.10
Version:
description: Version of the component from secure flash header or sidecar
file.
example: 1.40.51
readOnly: true
type: string
x-added: iLO 5 1.10
type: object
HpeComponent.Update:
properties:
Configuration:
description: string defining customized parameters for some components provided
by client at upload time and given to the component at execution time
(Type D only).
readOnly: false
type: string
Criticality:
description: 'Indicates the criticality of the component.
Defined values are:
* `Optional`
* `Recommended`
* `Critical`
'
enum:
- Optional
- Recommended
- Critical
readOnly: false
type: string
ExecutionParameters:
description: Client supplied execution parameters. These are supplied at
upload time and given to the component at execution time (Type D only).
readOnly: false
type: string
type: object
HpeComponentCollection:
properties:
'@odata.context':
example: /$metadata#HpeComponentCollection.HpeComponentCollection
format: uri
readOnly: true
type: string
x-longDescription: The value of this property shall be the context URL that
describes the resource according to OData-Protocol and shall be of the
form defined in the SPMF specification.
'@odata.etag':
example: W/\AC303DD3\""
readOnly: true
type: string
x-longDescription: The value of this property is the Etag of the resource.
'@odata.id':
example: /UpdateService/ComponentRepository/
format: uri
readOnly: true
type: string
x-longDescription: The value of this property shall be the unique identifier
for the resource and it shall be of the form defined in the SPMF specification.
'@odata.type':
example: '#HpeComponentCollection.HpeComponentCollection'
readOnly: true
type: string
x-longDescription: The value of this property shall be an absolute URL that
specifies the type of the resource and it shall be of the form defined
in the SPMF specification.
Description:
description: Provides a description of this resource and is used for commonality in
the schema definitions.
example: Component Collection
nullable: true
readOnly: true
type: string
x-longDescription: This object represents the Description property. All
values for resources described by this schema shall comply to the requirements
as described in the Redfish specification.
Members:
description: Contains the members of this collection.
items:
properties:
'@odata.id':
example: /UpdateService/ComponentRepository/a99418fa/
format: uri
readOnly: true
type: string
x-longDescription: The value of this property shall be the unique
identifier for the resource and it shall be of the form defined
in the SPMF specification.
type: object
readOnly: true
type: array
Members@odata.count:
description: The total number of collection members.
example: '0'
readOnly: true
type: integer
Name:
description: The name of the resource or array element.
example: Component Collection
readOnly: true
type: string
Oem:
properties:
Hpe:
description: The schema definition for the properties of the component
repository.
properties:
'@odata.context':
format: uri
readOnly: true
type: string
x-longDescription: The value of this property shall be the context
URL that describes the resource according to OData-Protocol and
shall be of the form defined in the SPMF specification.
'@odata.etag':
readOnly: true
type: string
x-longDescription: The value of this property is the Etag of the
resource.
'@odata.id':
format: uri
readOnly: true
type: string
x-longDescription: The value of this property shall be the unique
identifier for the resource and it shall be of the form defined
in the SPMF specification.
'@odata.type':
readOnly: true
type: string
x-longDescription: The value of this property shall be an absolute
URL that specifies the type of the resource and it shall be of
the form defined in the SPMF specification.
ComponentCount:
description: The number of files reported.
nullable: true
readOnly: true
type: integer
FreeSizeBytes:
description: The available repository space in bytes.
nullable: true
readOnly: true
type: integer
Id:
description: Uniquely identifies the resource within the collection
of like resources.
readOnly: true
type: string
x-longDescription: This property represents an identifier for the
resource. All values for resources described by this schema shall
comply to the requirements as described in the Redfish specification.
Name:
description: The name of the resource or array element.
readOnly: true
type: string
Oem:
description: This object represents the Oem property.
readOnly: true
TotalSizeBytes:
description: The total repository size in bytes.
nullable: true
readOnly: true
type: integer
readOnly: true
type: object
readOnly: false
type: object
type: object
HpeComponentInstallSet:
properties:
'@odata.context':
example: /$metadata#HpeComponentInstallSet.HpeComponentInstallSet
format: uri
readOnly: true
type: string
x-longDescription: The value of this property shall be the context URL that
describes the resource according to OData-Protocol and shall be of the
form defined in the SPMF specification.
'@odata.etag':
example: W/\298E1A70\
readOnly: true
type: string
x-longDescription: The value of this property is the Etag of the resource.
'@odata.id':
example: /UpdateService/InstallSets/a74b22b6/
format: uri
readOnly: true
type: string
x-longDescription: The value of this property shall be the unique identifier
for the resource and it shall be of the form defined in the SPMF specification.
'@odata.type':
example: '#HpeComponentInstallSet.v1_0_3.HpeComponentInstallSet'
readOnly: true
type: string
x-longDescription: The value of this property shall be an absolute URL that
specifies the type of the resource and it shall be of the form defined
in the SPMF specification.
Actions:
properties:
'#HpeComponentInstallSet.Invoke':
description: Invokes the install set. This causes iLO to copy the items
in this sequence into the task queue.
properties:
ClearTaskQueue:
description: Previous items in the task queue can be cleared before
the Install Set is invoked
readOnly: true
type: boolean
Expire:
description: ISO 8601 Redfish-style time string after which we will
automatically change state to Expired - null for no expire time
format: date-time
nullable: true
readOnly: true
type: string
MaintenanceWindow:
description: The maintenance window to associate with this invocation.
nullable: true
readOnly: false
type: string
StartAfter:
description: ISO 8601 Redfish-style time string of earliest execution
- null for no start time specified
format: date-time
nullable: true
readOnly: true
type: string
TPMOverride:
description: If true then the TPMOverrideFlag is passed in on the
associated flash operations.
readOnly: true
type: boolean
UpdateRecoverySet:
description: If true then the components in the flash operations
are used to replace matching contents in the Recovery Set.
readOnly: true
type: boolean
target:
description: The URI of this action.
example: /UpdateService/InstallSets/a74b22b6/Actions/HpeComponentInstallSet.Invoke/
format: uri
type: string
type: object
type: object
Created:
description: ISO-time of install set creation.
example: '2018-11-08T14:56:04Z'
format: date-time
nullable: true
readOnly: true
type: string
x-added: iLO 5 1.10
Description:
description: Description of the install set (client supplied upon creation).
example: Essential system firmware components
readOnly: false
type: string
Id:
description: Uniquely identifies the resource within the collection of like
resources.
example: a74b22b6
readOnly: true
type: string
x-added: iLO 5 1.10
x-longDescription: This property represents an identifier for the resource. All
values for resources described by this schema shall comply to the requirements
as described in the Redfish specification.
IsRecovery:
description: If true, this install set is reserved to hold only critical
firmware recovery updatable by iLO. Additionally the 'Administrate Recovery
Set' iLO privilege is required to modify or remove this install set.
example: 'true'
readOnly: false
type: boolean
x-added: iLO 5 1.10
Modified:
description: ISO-time of install modification.
example: '2018-11-08T14:56:21Z'
format: date-time
nullable: true
readOnly: true
type: string
x-added: iLO 5 1.10
Name:
description: Name of the install set (client supplied upon creation).
example: System Recovery Set
readOnly: false
type: string
x-added: iLO 5 1.10
Sequence:
description: An ordered sequence of freeze-dried task items that iLO can
iterate and schedule.
items:
properties:
Command:
description: 'Command to execute.
Defined values are:
* `ApplyUpdate`: Apply an update using the specified component.
* `ResetServer`: Reset the server.
* `ResetBmc`: Reset the BMC.
* `Wait`: Wait for the WaitTimeSeconds number of seconds.
'
enum:
- ApplyUpdate
- ResetServer
- ResetBmc
- Wait
example: ApplyUpdate
readOnly: false
type: string
x-added: iLO 5 1.10
Component:
example: /UpdateService/ComponentRepository/a99418fa
format: uri
readOnly: true
type: string
x-added: iLO 5 1.10
x-longDescription: The value of this property shall be the unique
identifier for the resource and it shall be of the form defined
in the SPMF specification.
Filename:
description: The unique filename of the component. This correlates
to 'Filename' in the HpeComponent.
example: ilo5_140_p51_checked.bin
readOnly: false
type: string
x-added: iLO 5 1.10
Name:
description: Name of the component.
example: System Recovery Set item (iLO 5)
readOnly: false
type: string
x-added: iLO 5 1.10
UpdatableBy:
description: This is an unordered set of permitted updaters that can
execute this item.
items:
description: 'Defined values are:
* `Bmc`: This component may be scheduled for update by iLO.
* `Uefi`: This component may be scheduled for update by UEFI BIOS.
* `RuntimeAgent`: This component may be scheduled for update by
a runtime update agent such as Smart Update Manager or Smart Update
Tool.
'
enum:
- Bmc
- Uefi
- RuntimeAgent
readOnly: false
type: string
readOnly: false
type: array
x-added: iLO 5 1.10
WaitTimeSeconds:
description: The number of seconds to pause if the command is 'Wait'. Ignored
otherwise.
readOnly: false
type: integer
x-added: iLO 5 1.10
type: object
readOnly: false
type: array
x-added: iLO 5 1.10
type: object
HpeComponentInstallSet.Invoke:
properties:
ClearTaskQueue:
description: Previous items in the task queue can be cleared before the
Install Set is invoked
readOnly: true
type: boolean
Expire:
description: ISO 8601 Redfish-style time string after which we will automatically
change state to Expired - null for no expire time
format: date-time
nullable: true
readOnly: true
type: string
MaintenanceWindow:
description: The maintenance window to associate with this invocation.
nullable: true
readOnly: false
type: string
StartAfter:
description: ISO 8601 Redfish-style time string of earliest execution -
null for no start time specified
format: date-time
nullable: true
readOnly: true
type: string
TPMOverride:
description: If true then the TPMOverrideFlag is passed in on the associated
flash operations.
readOnly: true
type: boolean
UpdateRecoverySet:
description: If true then the components in the flash operations are used
to replace matching contents in the Recovery Set.
readOnly: true
type: boolean
type: object
HpeComponentInstallSet.Update:
properties:
Actions:
properties:
'#HpeComponentInstallSet.Invoke':
description: Invokes the install set. This causes iLO to copy the items
in this sequence into the task queue.
properties:
MaintenanceWindow:
description: The maintenance window to associate with this invocation.
nullable: true
readOnly: false
type: string
target:
description: The URI of this action.
format: uri
type: string
type: object
type: object
Description:
description: Description of the install set (client supplied upon creation).
readOnly: false
type: string
IsRecovery:
description: If true, this install set is reserved to hold only critical
firmware recovery updatable by iLO. Additionally the 'Administrate Recovery
Set' iLO privilege is required to modify or remove this install set.
readOnly: false
type: boolean
Name:
description: Name of the install set (client supplied upon creation).
readOnly: false
type: string
Sequence:
description: An ordered sequence of freeze-dried task items that iLO can
iterate and schedule.
items:
properties:
Command:
description: 'Command to execute.
Defined values are:
* `ApplyUpdate`: Apply an update using the specified component.
* `ResetServer`: Reset the server.
* `ResetBmc`: Reset the BMC.
* `Wait`: Wait for the WaitTimeSeconds number of seconds.
'
enum:
- ApplyUpdate
- ResetServer
- ResetBmc
- Wait
readOnly: false
type: string
Filename:
description: The unique filename of the component. This correlates
to 'Filename' in the HpeComponent.
readOnly: false
type: string
Name:
description: Name of the component.
readOnly: false
type: string
UpdatableBy:
description: This is an unordered set of permitted updaters that can
execute this item.
items:
description: 'Defined values are:
* `Bmc`: This component may be scheduled for update by iLO.
* `Uefi`: This component may be scheduled for update by UEFI BIOS.
* `RuntimeAgent`: This component may be scheduled for update by
a runtime update agent such as Smart Update Manager or Smart Update
Tool.
'
enum:
- Bmc
- Uefi
- RuntimeAgent
readOnly: false
type: string
readOnly: false
type: array
WaitTimeSeconds:
description: The number of seconds to pause if the command is 'Wait'. Ignored
otherwise.
readOnly: false
type: integer
type: object
readOnly: false
type: array
type: object
HpeComponentInstallSetCollection:
properties:
'@odata.context':
example: /$metadata#HpeComponentInstallSetCollection.HpeComponentInstallSetCollection
format: uri
readOnly: true
type: string
x-longDescription: The value of this property shall be the context URL that
describes the resource according to OData-Protocol and shall be of the
form defined in the SPMF specification.
'@odata.etag':
example: W/\75983E8D\""
readOnly: true
type: string
x-longDescription: The value of this property is the Etag of the resource.
'@odata.id':
example: /UpdateService/InstallSets/
format: uri
readOnly: true
type: string
x-longDescription: The value of this property shall be the unique identifier
for the resource and it shall be of the form defined in the SPMF specification.
'@odata.type':
example: '#HpeComponentInstallSetCollection.HpeComponentInstallSetCollection'
readOnly: true
type: string
x-longDescription: The value of this property shall be an absolute URL that
specifies the type of the resource and it shall be of the form defined
in the SPMF specification.
Description:
description: Provides a description of this resource and is used for commonality in
the schema definitions.
example: Component Install Set Collection
nullable: true
readOnly: true
type: string
x-longDescription: This object represents the Description property. All
values for resources described by this schema shall comply to the requirements
as described in the Redfish specification.
Members:
description: Contains the members of this collection.
items:
properties:
'@odata.id':
example: /UpdateService/InstallSets/a74b22b6/
format: uri
readOnly: true
type: string
x-longDescription: The value of this property shall be the unique
identifier for the resource and it shall be of the form defined
in the SPMF specification.
type: object
readOnly: true
type: array
Members@odata.count:
description: The total number of collection members.
example: '0'
readOnly: true
type: integer
Name:
description: The name of the resource or array element.
example: Component Install Set Collection
readOnly: true
type: string
type: object
HpeComponentUpdateTask:
properties:
'@odata.context':
format: uri
readOnly: true
type: string
x-longDescription: The value of this property shall be the context URL that
describes the resource according to OData-Protocol and shall be of the
form defined in the SPMF specification.
'@odata.etag':
readOnly: true
type: string
x-longDescription: The value of this property is the Etag of the resource.
'@odata.id':
format: uri
readOnly: true
type: string
x-longDescription: The value of this property shall be the unique identifier
for the resource and it shall be of the form defined in the SPMF specification.
'@odata.type':
readOnly: true
type: string
x-longDescription: The value of this property shall be an absolute URL that
specifies the type of the resource and it shall be of the form defined
in the SPMF specification.
Command:
description: 'Command to execute.
Defined values are:
* `ApplyUpdate`: Apply an update using the specified component.
* `ResetServer`: Reset the server.
* `ResetBmc`: Reset the BMC.
* `Wait`: Wait for the WaitTimeSeconds number of seconds.
'
enum:
- ApplyUpdate
- ResetServer
- ResetBmc
- Wait
readOnly: false
type: string
x-added: iLO 5 1.10
Component:
format: uri
readOnly: true
type: string
x-added: iLO 5 1.10
x-longDescription: The value of this property shall be the unique identifier
for the resource and it shall be of the form defined in the SPMF specification.
Created:
description: ISO-time of task creation (by whomever created this thing)
format: date-time
readOnly: true
type: string
x-added: iLO 5 1.10
Expire:
description: ISO 8601 Redfish-style time string after which we will automatically
change state to Expired - null for no expire time
format: date-time
readOnly: false
type: string
x-added: iLO 5 1.10
Filename:
description: The unique filename of the component. This correlates to 'Filename'
in the HpeComponent.
readOnly: false
type: string
x-added: iLO 5 1.10
Id:
description: Uniquely identifies the resource within the collection of like
resources.
readOnly: true
type: string
x-added: iLO 5 1.10
x-longDescription: This property represents an identifier for the resource. All
values for resources described by this schema shall comply to the requirements
as described in the Redfish specification.
MaintenanceWindow:
description: The maintenance window for this update task.
nullable: true
readOnly: false
type: string
x-added: iLO 5 1.30
Modified:
description: ISO-time of last task queue item update by updater (not client)
format: date-time
readOnly: true
type: string
x-added: iLO 5 1.10
Name:
description: User defined name of the task.
readOnly: false
type: string
x-added: iLO 5 1.10
RecoveryPrivilege:
description: This task was created by a user with Recovery Set privilege,
and would allow a downgrade if 'DowngradePolicy' is set to 'RecoveryDowngrade'. Applies
if the command is 'ApplyUpdate'. Ignored otherwise.
readOnly: true
type: boolean
x-added: iLO 5 1.40
Result:
properties:
MessageArgs:
description: The message arguments array is substituted for the arguments
in the message when looked up in the message registry.
items:
type: string
readOnly: false
type: array
x-added: iLO 5 1.10
MessageId:
description: The key for this message that can be used to look up the
message in a message registry.
readOnly: false
type: string
x-added: iLO 5 1.10
readOnly: false
type: object
x-added: iLO 5 1.10
ResultLog:
description: base64 encoded entry to capture component log. Estimated to
be generally 1-2KB. written by updater
nullable: true
readOnly: false
type: string
x-added: iLO 5 1.10
StartAfter:
description: ISO 8601 Redfish-style time string of earliest execution -
null for no start time specified
format: date-time
readOnly: false
type: string
x-added: iLO 5 1.10
State:
description: 'The current state of the update task.
Defined values are:
* `Pending`: The task is pending execution.
* `InProgress`: The task is executing.
* `Complete`: The task was completed and the results are available in
the Results.
* `Expired`: The task will not execute because the current time is after
the ''Expire'' time.
* `Exception`: The task was unsuccessful because of an exception condition.
* `Canceled`: The task is no longer scheduled to run.
'
enum:
- Pending
- InProgress
- Complete
- Expired
- Exception
- Canceled
readOnly: false
type: string
x-added: iLO 5 1.10
TPMOverride:
description: If true then the TPMOverrideFlag is passed in on the associated
flash operations.
readOnly: false
type: boolean
x-added: iLO 5 1.10
UpdatableBy:
description: This is an unordered set of permitted updaters that can execute
this item.
items:
description: 'Defined values are:
* `Bmc`: This component may be scheduled for update by iLO.
* `Uefi`: This component may be scheduled for update by UEFI BIOS.
* `RuntimeAgent`: This component may be scheduled for update by a runtime
update agent such as Smart Update Manager or Smart Update Tool.
'
enum:
- Bmc
- Uefi
- RuntimeAgent
type: string
readOnly: false
type: array
x-added: iLO 5 1.10
UpdateRecoverySet:
description: Update Recovery Set with this component if the command is 'ApplyUpdate'. Ignored
otherwise.
readOnly: false
type: boolean
x-added: iLO 5 1.20
WaitTimeSeconds:
description: The number of seconds to pause if the command is 'Wait'. Ignored
otherwise.
readOnly: false
type: integer
x-added: iLO 5 1.10
type: object
HpeComponentUpdateTaskQueueCollection:
properties:
'@odata.context':
example: /$metadata#HpeComponentUpdateTaskQueueCollection.HpeComponentUpdateTaskQueueCollection
format: uri
readOnly: true
type: string
x-longDescription: The value of this property shall be the context URL that
describes the resource according to OData-Protocol and shall be of the
form defined in the SPMF specification.
'@odata.etag':
example: W/\75983E8D\""
readOnly: true
type: string
x-longDescription: The value of this property is the Etag of the resource.
'@odata.id':
example: /UpdateService/UpdateTaskQueue/
format: uri
readOnly: true
type: string
x-longDescription: The value of this property shall be the unique identifier
for the resource and it shall be of the form defined in the SPMF specification.
'@odata.type':
example: '#HpeComponentUpdateTaskQueueCollection.HpeComponentUpdateTaskQueueCollection'
readOnly: true
type: string
x-longDescription: The value of this property shall be an absolute URL that
specifies the type of the resource and it shall be of the form defined
in the SPMF specification.
Description:
description: Provides a description of this resource and is used for commonality in
the schema definitions.
example: Component Update Task Queue
nullable: true
readOnly: true
type: string
x-longDescription: This object represents the Description property. All
values for resources described by this schema shall comply to the requirements
as described in the Redfish specification.
Members:
description: Contains the members of this collection.
items:
properties:
'@odata.id':
format: uri
readOnly: true
type: string
x-longDescription: The value of this property shall be the unique
identifier for the resource and it shall be of the form defined
in the SPMF specification.
type: object
readOnly: true
type: array
Members@odata.count:
description: The total number of collection members.
example: '0'
readOnly: true
type: integer
Name:
description: The name of the resource or array element.
example: Component Update Task Queue
readOnly: true
type: string
type: object
HpeDirectoryTest:
description: This is the schema definition for the directory test settings.
properties:
'@odata.context':
example: /$metadata#HpeDirectoryTest.HpeDirectoryTest
format: uri
readOnly: true
type: string
x-longDescription: The value of this property shall be the context URL that
describes the resource according to OData-Protocol and shall be of the
form defined in the SPMF specification.
'@odata.etag':
example: W/\6B3F28F1\""
readOnly: true
type: string
x-longDescription: The value of this property is the Etag of the resource.
'@odata.id':
example: /AccountService/DirectoryTest/
format: uri
readOnly: true
type: string
x-longDescription: The value of this property shall be the unique identifier
for the resource and it shall be of the form defined in the SPMF specification.
'@odata.type':
example: '#HpeDirectoryTest.v1_0_0.HpeDirectoryTest'
readOnly: true
type: string
x-longDescription: The value of this property shall be an absolute URL that
specifies the type of the resource and it shall be of the form defined
in the SPMF specification.
Actions:
properties:
'#HpeDirectoryTest.StartTest':
properties:
DirectoryAdminDn@Redfish.AllowableValues:
description: Distinguished name of the directory administrator.
nullable: true
type: string
DirectoryAdminPassword@Redfish.AllowableValues:
description: Password of the directory administrator.
nullable: true
type: string
TestUserName@Redfish.AllowableValues:
description: Distinguished name or login name of the directory test
user.
nullable: true
type: string
TestUserPassword@Redfish.AllowableValues:
description: Password of the directory test user.
nullable: true
type: string
target:
description: Link to invoke action
example: /AccountService/DirectoryTest/Actions/HpeDirectoryTest.StartTest/
type: string
title:
description: Friendly action name
type: string
type: object
'#HpeDirectoryTest.StopTest':
properties:
target:
description: Link to invoke action
example: /AccountService/DirectoryTest/Actions/HpeDirectoryTest.StopTest/
type: string
title:
description: Friendly action name
type: string
type: object
type: object
Id:
description: Uniquely identifies the resource within the collection of like
resources.
example: DirectoryTest
readOnly: true
type: string
x-added: iLO 5 1.40
x-longDescription: This property represents an identifier for the resource. All
values for resources described by this schema shall comply to the requirements
as described in the Redfish specification.
OverallStatus:
description: 'Represents the overall status of directory tests.
Defined values are:
* `NotRun`: The Overall Directory Test was not run.
* `InProgress`: The Overall Directory Test is in progress.
* `Success`: The Overall Directory Test has completed successfully.
* `Warning`: The Overall Directory Test has completed with warning.
* `Failed`: The Overall Directory Test has failed.
* `Error`: The Directory Test has encountered an error condition.
'
enum:
- NotRun
- InProgress
- Success
- Warning
- Failed
- Error
example: NotRun
readOnly: true
type: string
x-added: iLO 5 1.40
TestResults:
description: This array describes the detailed directory test results.
items:
properties:
Notes:
description: This provides additional details on the directory test.
example: ''
nullable: true
readOnly: true
type: string
x-added: iLO 5 1.40
Status:
description: 'The status of the directory test.
Defined values are:
* `NotRun`: The Directory Test was not run.
* `InProgress`: The Directory Test is in progress.
* `Success`: The Directory Test has completed successfully.
* `Warning`: The Directory Test has not run.
* `Failed`: The Directory Test has failed.
* `Error`: The Directory Test has encountered an error condition.
'
enum:
- NotRun
- InProgress
- Success
- Warning
- Failed
- Error
example: NotRun
readOnly: true
type: string
x-added: iLO 5 1.40
TestName:
description: The name of directory test.
example: Directory Server DNS Name
readOnly: true
type: string
x-added: iLO 5 1.40
type: object
readOnly: true
type: array
x-added: iLO 5 1.40
readOnly: false
type: object
HpeDirectoryTest.StartTest:
properties:
DirectoryAdminDn:
description: Distinguished name of the directory administrator.
nullable: true
type: string
DirectoryAdminPassword:
description: Password of the directory administrator.
nullable: true
type: string
TestUserName:
description: Distinguished name or login name of the directory test user.
nullable: true
type: string
TestUserPassword:
description: Password of the directory test user.
nullable: true
type: string
type: object
HpeDirectoryTest.StopTest:
properties: {}
type: object
HpeESKM:
description: ESKM (Enterprise Security Key Manager) object enables user to connect
to an operational key manager, change redundancy settings, view the key manager
connection settings, test the connection, and view key management events.
properties:
'@odata.context':
example: /$metadata#HpeESKM.HpeESKM
format: uri
readOnly: true
type: string
x-longDescription: The value of this property shall be the context URL that
describes the resource according to OData-Protocol and shall be of the
form defined in the SPMF specification.
'@odata.etag':
example: W/\A5D08BBF\""
readOnly: true
type: string
x-longDescription: The value of this property is the Etag of the resource.
'@odata.id':
example: /Managers/1/SecurityService/ESKM/
format: uri
readOnly: true
type: string
x-longDescription: The value of this property shall be the unique identifier
for the resource and it shall be of the form defined in the SPMF specification.
'@odata.type':
example: '#HpeESKM.v2_0_0.HpeESKM'
readOnly: true
type: string
x-longDescription: The value of this property shall be an absolute URL that
specifies the type of the resource and it shall be of the form defined
in the SPMF specification.
Actions:
properties:
'#HpeESKM.ClearESKMLog':
properties:
target:
description: Link to invoke action
example: /Managers/1/SecurityService/ESKM/Actions/HpeESKM.ClearESKMLog/
type: string
title:
description: Friendly action name
type: string
type: object
'#HpeESKM.TestESKMConnections':
properties:
target:
description: Link to invoke action
example: /Managers/1/SecurityService/ESKM/Actions/HpeESKM.TestESKMConnections/
type: string
title:
description: Friendly action name
type: string
type: object
type: object
ESKMEvents:
items:
description: List of ESKM events (activity trace logs).
properties:
Event:
description: ESKM event description.
nullable: true
readOnly: true
type: string
x-added: iLO 5 1.10
Timestamp:
description: Time of ESKM event.
format: date-time
nullable: true
readOnly: true
type: string
x-added: iLO 5 1.10
readOnly: true
type: object
readOnly: true
type: array
x-added: iLO 5 1.10
Id:
description: Uniquely identifies the resource within the collection of like
resources.
example: ESKM
readOnly: true
type: string
x-added: iLO 5 1.10
x-longDescription: This property represents an identifier for the resource. All
values for resources described by this schema shall comply to the requirements
as described in the Redfish specification.
KeyManagerConfig:
properties:
AccountGroup:
description: Account group on ESKM.
example: ''
nullable: true
readOnly: false
type: string
x-added: iLO 5 1.10
AccountName:
description: Account name on ESKM.
example: ilo-30e17159d0d0
readOnly: true
type: string
x-added: iLO 5 1.10
ESKMLocalCACertificateName:
description: This is the name of Local CA (Certificate Authority) in
ESKM that is used to sign the ESKM server certificate. iLO will retrieve
this certificate from the ESKM server.
example: ''
nullable: true
readOnly: false
type: string
x-added: iLO 5 1.10
ImportedCertificateIssuer:
description: Imported certificate issuer.
example: ''
readOnly: true
type: string
x-added: iLO 5 1.10
ImportedCertificateSubject:
description: Imported certificate subject.
example: ''
readOnly: true
type: string
x-added: iLO 5 1.10
LoginName:
description: ESKM administrator account login name. This property always
returns null on GET.
nullable: true
readOnly: false
type: string
x-added: iLO 5 1.10
Password:
description: ESKM administrator account password. This property always
returns null on GET.
nullable: true
readOnly: false
type: string
x-added: iLO 5 1.10
readOnly: false
type: object
x-added: iLO 5 1.10
KeyServerRedundancyReq:
description: If true encryption keys will be maintained on both the configured
key servers. When this option is disabled, iLO will not verify that encryption
keys are copied to both of the configured key servers.
example: 'false'
readOnly: false
type: boolean
x-added: iLO 5 1.10
PrimaryKeyServerAddress:
description: Primary key server IP address or FQDN. Set to null to clear
the value.
example: 'null'
nullable: true
readOnly: false
type: string
x-added: iLO 5 1.10
PrimaryKeyServerPort:
description: Primary key server port number. Set to null to clear the value.
example: 'null'
nullable: true
readOnly: false
type: integer
x-added: iLO 5 1.10
SecondaryKeyServerAddress:
description: Secondary key server IP address or FQDN. Set to null to clear
the value.
example: 'null'
nullable: true
readOnly: false
type: string
x-added: iLO 5 1.10
SecondaryKeyServerPort:
description: Secondary key server port number. Set to null to clear the
value.
example: 'null'
nullable: true
readOnly: false
type: integer
x-added: iLO 5 1.10
readOnly: false
type: object
HpeESKM.ClearESKMLog:
properties: {}
type: object
HpeESKM.TestESKMConnections:
properties: {}
type: object
HpeESKM.Update:
description: ESKM (Enterprise Security Key Manager) object enables user to connect
to an operational key manager, change redundancy settings, view the key manager
connection settings, test the connection, and view key management events.
properties:
Actions:
properties:
'#HpeESKM.ClearESKMLog':
properties:
target:
description: Link to invoke action
type: string
title:
description: Friendly action name
type: string
type: object
'#HpeESKM.TestESKMConnections':
properties:
target:
description: Link to invoke action
type: string
title:
description: Friendly action name
type: string
type: object
type: object
KeyManagerConfig:
properties:
AccountGroup:
description: Account group on ESKM.
nullable: true
readOnly: false
type: string
ESKMLocalCACertificateName:
description: This is the name of Local CA (Certificate Authority) in
ESKM that is used to sign the ESKM server certificate. iLO will retrieve
this certificate from the ESKM server.
nullable: true
readOnly: false
type: string
LoginName:
description: ESKM administrator account login name. This property always
returns null on GET.
nullable: true
readOnly: false
type: string
Password:
description: ESKM administrator account password. This property always
returns null on GET.
nullable: true
readOnly: false
type: string
readOnly: false
type: object
KeyServerRedundancyReq:
description: If true encryption keys will be maintained on both the configured
key servers. When this option is disabled, iLO will not verify that encryption
keys are copied to both of the configured key servers.
readOnly: false
type: boolean
PrimaryKeyServerAddress:
description: Primary key server IP address or FQDN. Set to null to clear
the value.
nullable: true
readOnly: false
type: string
PrimaryKeyServerPort:
description: Primary key server port number. Set to null to clear the value.
nullable: true
readOnly: false
type: integer
SecondaryKeyServerAddress:
description: Secondary key server IP address or FQDN. Set to null to clear
the value.
nullable: true
readOnly: false
type: string
SecondaryKeyServerPort:
description: Secondary key server port number. Set to null to clear the
value.
nullable: true
readOnly: false
type: integer
readOnly: false
type: object
HpeHttpsCert:
description: This is the schema definition for the X509 Certificate.
properties:
'@odata.context':
example: /$metadata#HpeHttpsCert.HpeHttpsCert
format: uri
readOnly: true
type: string
x-longDescription: The value of this property shall be the context URL that
describes the resource according to OData-Protocol and shall be of the
form defined in the SPMF specification.
'@odata.etag':
example: W/\6AD77770\""
readOnly: true
type: string
x-longDescription: The value of this property is the Etag of the resource.
'@odata.id':
example: /Managers/1/SecurityService/HttpsCert/
format: uri
readOnly: true
type: string
x-longDescription: The value of this property shall be the unique identifier
for the resource and it shall be of the form defined in the SPMF specification.
'@odata.type':
example: '#HpeHttpsCert.v2_0_0.HpeHttpsCert'
readOnly: true
type: string
x-longDescription: The value of this property shall be an absolute URL that
specifies the type of the resource and it shall be of the form defined
in the SPMF specification.
Actions:
properties:
'#HpeHttpsCert.GenerateCSR':
properties:
City@Redfish.AllowableValues:
description: The supported values for the City parameter.
items:
description: The city or locality where the company or organization
that owns this iLO subsystem is located.
readOnly: false
type: string
type: array
x-longDescription: The supported values for the City parameter.
CommonName@Redfish.AllowableValues:
description: The supported values for the CommonName parameter.
items:
description: The FQDN of this iLO subsystem.
readOnly: false
type: string
type: array
x-longDescription: The supported values for the CommonName parameter.
Country@Redfish.AllowableValues:
description: The supported values for the Country parameter.
items:
description: 'The two-character country code where the company
or organization that owns this Manager subsystem is located.
Eg: US'
readOnly: false
type: string
type: array
x-longDescription: The supported values for the Country parameter.
OrgName@Redfish.AllowableValues:
description: The supported values for the OrgName parameter.
items:
description: The name of the company or organization that owns
this iLO subsystem.
readOnly: false
type: string
type: array
x-longDescription: The supported values for the OrgName parameter.
OrgUnit@Redfish.AllowableValues:
description: The supported values for the OrgUnit parameter.
items:
description: The unit within the company or organization that
owns this iLO subsystem.
readOnly: false
type: string
type: array
x-longDescription: The supported values for the OrgUnit parameter.
State@Redfish.AllowableValues:
description: The supported values for the State parameter.
items:
description: The state where the company or organization that
owns this iLO subsystem is located.
readOnly: false
type: string
type: array
x-longDescription: The supported values for the State parameter.
target:
description: Link to invoke action
example: /Managers/1/SecurityService/HttpsCert/Actions/HpeHttpsCert.GenerateCSR/
type: string
title:
description: Friendly action name
type: string
type: object
'#HpeHttpsCert.ImportCertificate':
properties:
Certificate@Redfish.AllowableValues:
description: The supported values for the Certificate parameter.
items:
description: Contains PEM formatted X509 certificate (Base64 encoded).
format: text
readOnly: false
type: string
type: array
x-longDescription: The supported values for the Certificate parameter.
target:
description: Link to invoke action
example: /Managers/1/SecurityService/HttpsCert/Actions/HpeHttpsCert.ImportCertificate/
type: string
title:
description: Friendly action name
type: string
type: object
type: object
CertificateSigningRequest:
description: GenerateCSR action, wait few minutes (upto 10), perform GET
operation, fills CSR. Contains a public and private key pair.
example: 'null'
nullable: true
readOnly: true
type: string
x-added: iLO 5 1.10
Id:
description: Uniquely identifies the resource within the collection of like
resources.
example: HttpsCert
readOnly: true
type: string
x-added: iLO 5 1.10
x-longDescription: This property represents an identifier for the resource. All
values for resources described by this schema shall comply to the requirements
as described in the Redfish specification.
X509CertificateInformation:
description: Contains the X509 Certificate Information.
properties:
Issuer:
description: The Certificate Authority that issued the certificate.
example: CN = Default Issuer (Do not trust), O = Hewlett Packard Enterprise,
OU = ISS, L = Houston, ST = Texas, C = US
readOnly: true
type: string
x-added: iLO 5 1.10
SerialNumber:
description: The serial number that the Certificate Authority assigned
to the certificate.
example: xxxxxxxxxx
readOnly: true
type: string
x-added: iLO 5 1.10
Subject:
description: The entity to which the certificate was issued.
example: CN = ILOmBj5nS.americas.hpqcorp.net, O = Hewlett Packard Enterprise,
OU = ISS, L = Houston, ST = Texas, C = US
readOnly: true
type: string
x-added: iLO 5 1.10
ValidNotAfter:
description: The date on which the certificate validity period ends.
example: '2034-02-05T09:52:15Z'
format: date-time
readOnly: true
type: string
x-added: iLO 5 1.10
ValidNotBefore:
description: The date on which the certificate validity period begins.
example: '2019-02-06T09:52:15Z'
format: date-time
readOnly: true
type: string
x-added: iLO 5 1.10
readOnly: true
type: object
x-added: iLO 5 1.10
readOnly: false
type: object
HpeHttpsCert.GenerateCSR:
properties:
City:
description: The city or locality where the company or organization that
owns this iLO subsystem is located.
readOnly: false
type: string
CommonName:
description: The FQDN of this iLO subsystem.
readOnly: false
type: string
Country:
description: 'The two-character country code where the company or organization
that owns this Manager subsystem is located. Eg: US'
readOnly: false
type: string
IncludeIP:
description: Include the IP Addresses in the CSR.
readOnly: false
type: boolean
OrgName:
description: The name of the company or organization that owns this iLO
subsystem.
readOnly: false
type: string
OrgUnit:
description: The unit within the company or organization that owns this
iLO subsystem.
readOnly: false
type: string
State:
description: The state where the company or organization that owns this
iLO subsystem is located.
readOnly: false
type: string
type: object
HpeHttpsCert.ImportCertificate:
properties:
Certificate:
description: Contains PEM formatted X509 certificate (Base64 encoded).
format: text
readOnly: false
type: string
type: object
HpeInvalidImage:
properties:
'@odata.context':
example: /$metadata#HpeInvalidImage.HpeInvalidImage
format: uri
readOnly: true
type: string
x-longDescription: The value of this property shall be the context URL that
describes the resource according to OData-Protocol and shall be of the
form defined in the SPMF specification.
'@odata.etag':
example: W/\A3A6BF43\
readOnly: true
type: string
x-longDescription: The value of this property is the Etag of the resource.
'@odata.id':
example: /UpdateService/InvalidImageRepository/440860f0/
format: uri
readOnly: true
type: string
x-longDescription: The value of this property shall be the unique identifier
for the resource and it shall be of the form defined in the SPMF specification.
'@odata.type':
example: '#HpeInvalidImage.v1_0_0.HpeInvalidImage'
readOnly: true
type: string
x-longDescription: The value of this property shall be an absolute URL that
specifies the type of the resource and it shall be of the form defined
in the SPMF specification.
Created:
description: ISO 8601 time string indicating when this image was added to
the NAND.
example: '2018-10-25T21:07:05Z'
format: date-time
readOnly: true
type: string
x-added: iLO 5 1.30
DeviceClass:
description: Device type GUID from iLO secure flash header
example: aa148d2e-6e09-453e-bc6f-63baa5f5ccc4
readOnly: true
type: string
x-added: iLO 5 1.30
Filename:
description: The unique filename of the image.
example: Invalid_System_ROM
readOnly: true
type: string
x-added: iLO 5 1.30
Filepath:
description: Path of file on the USB LUN if the repo is mounted as USB.
example: invalid/Invalid_System_ROM
readOnly: true
type: string
x-added: iLO 5 1.30
Id:
description: Uniquely identifies the resource within the collection of like
resources.
example: 440860f0
readOnly: true
type: string
x-added: iLO 5 1.30
x-longDescription: This property represents an identifier for the resource. All
values for resources described by this schema shall comply to the requirements
as described in the Redfish specification.
ImageUri:
description: URI of the image binary.
example: /fwrepo/invalid/Invalid_System_ROM
format: uri
readOnly: true
type: string
x-added: iLO 5 1.30
Name:
description: Name of the image.
example: Invalid System ROM image
readOnly: true
type: string
x-added: iLO 5 1.30
SizeBytes:
description: Size of the image file in bytes.
example: '67108864'
nullable: true
readOnly: true
type: integer
x-added: iLO 5 1.30
type: object
HpeInvalidImageCollection:
properties:
'@odata.context':
example: /$metadata#HpeInvalidImageCollection.HpeInvalidImageCollection
format: uri
readOnly: true
type: string
x-longDescription: The value of this property shall be the context URL that
describes the resource according to OData-Protocol and shall be of the
form defined in the SPMF specification.
'@odata.etag':
example: W/\AA6D42B0\
readOnly: true
type: string
x-longDescription: The value of this property is the Etag of the resource.
'@odata.id':
example: /UpdateService/InvalidImageRepository/
format: uri
readOnly: true
type: string
x-longDescription: The value of this property shall be the unique identifier
for the resource and it shall be of the form defined in the SPMF specification.
'@odata.type':
example: '#HpeInvalidImageCollection.HpeInvalidImageCollection'
readOnly: true
type: string
x-longDescription: The value of this property shall be an absolute URL that
specifies the type of the resource and it shall be of the form defined
in the SPMF specification.
Description:
description: Provides a description of this resource and is used for commonality in
the schema definitions.
example: Invalid Image Collection
nullable: true
readOnly: true
type: string
x-longDescription: This object represents the Description property. All
values for resources described by this schema shall comply to the requirements
as described in the Redfish specification.
Members:
description: Contains the members of this collection.
items:
properties:
'@odata.id':
example: /UpdateService/InvalidImageRepository/440860f0/
format: uri
readOnly: true
type: string
x-longDescription: The value of this property shall be the unique
identifier for the resource and it shall be of the form defined
in the SPMF specification.
type: object
readOnly: true
type: array
Members@odata.count:
description: The total number of collection members.
example: '0'
readOnly: true
type: integer
Name:
description: The name of the resource or array element.
example: Invalid Image Collection
readOnly: true
type: string
type: object
HpeMaintenanceWindow:
properties:
'@odata.context':
example: /$metadata#HpeMaintenanceWindow.HpeMaintenanceWindow
format: uri
readOnly: true
type: string
x-longDescription: The value of this property shall be the context URL that
describes the resource according to OData-Protocol and shall be of the
form defined in the SPMF specification.
'@odata.etag':
example: W/\A3A6BF43\
readOnly: true
type: string
x-longDescription: The value of this property is the Etag of the resource.
'@odata.id':
example: /UpdateService/MaintenanceWindows/a6c4c7b3/
format: uri
readOnly: true
type: string
x-longDescription: The value of this property shall be the unique identifier
for the resource and it shall be of the form defined in the SPMF specification.
'@odata.type':
example: '#HpeMaintenanceWindow.v1_0_1.HpeMaintenanceWindow'
readOnly: true
type: string
x-longDescription: The value of this property shall be an absolute URL that
specifies the type of the resource and it shall be of the form defined
in the SPMF specification.
Created:
description: ISO-time of maintenance window creation (by whomever created
this thing)
example: '2018-11-05T20:32:42Z'
format: date-time
readOnly: true
type: string
x-added: iLO 5 1.30
Description:
description: User defined description of the maintenance window.
example: tt
readOnly: false
type: string
Expire:
description: ISO 8601 Redfish-style time string after which we will automatically
change state to Expired - null for no expire time
example: '2019-11-05T20:32:00Z'
format: date-time
readOnly: false
type: string
x-added: iLO 5 1.30
Id:
description: Uniquely identifies the resource within the collection of like
resources.
example: a6c4c7b3
readOnly: true
type: string
x-added: iLO 5 1.30
x-longDescription: This property represents an identifier for the resource. All
values for resources described by this schema shall comply to the requirements
as described in the Redfish specification.
Modified:
description: ISO-time of last maintenance window item update by updater
(not client)
example: '2018-11-07T20:08:33Z'
format: date-time
readOnly: true
type: string
x-added: iLO 5 1.30
Name:
description: User defined name of the maintenance window.
example: tt
readOnly: false
type: string
x-added: iLO 5 1.30
StartAfter:
description: ISO 8601 Redfish-style time string of earliest execution.
example: '2019-01-05T20:32:00Z'
format: date-time
readOnly: false
type: string
x-added: iLO 5 1.30
type: object
HpeMaintenanceWindow.Update:
properties:
Description:
description: User defined description of the maintenance window.
readOnly: false
type: string
Expire:
description: ISO 8601 Redfish-style time string after which we will automatically
change state to Expired - null for no expire time
format: date-time
readOnly: false
type: string
Name:
description: User defined name of the maintenance window.
readOnly: false
type: string
StartAfter:
description: ISO 8601 Redfish-style time string of earliest execution.
format: date-time
readOnly: false
type: string
type: object
HpeMaintenanceWindowCollection:
properties:
'@odata.context':
example: /$metadata#HpeMaintenanceWindowCollection.HpeMaintenanceWindowCollection
format: uri
readOnly: true
type: string
x-longDescription: The value of this property shall be the context URL that
describes the resource according to OData-Protocol and shall be of the
form defined in the SPMF specification.
'@odata.etag':
example: W/\75983E8D\""
readOnly: true
type: string
x-longDescription: The value of this property is the Etag of the resource.
'@odata.id':
example: /UpdateService/MaintenanceWindows/
format: uri
readOnly: true
type: string
x-longDescription: The value of this property shall be the unique identifier
for the resource and it shall be of the form defined in the SPMF specification.
'@odata.type':
example: '#HpeMaintenanceWindowCollection.HpeMaintenanceWindowCollection'
readOnly: true
type: string
x-longDescription: The value of this property shall be an absolute URL that
specifies the type of the resource and it shall be of the form defined
in the SPMF specification.
Description:
description: Provides a description of this resource and is used for commonality in
the schema definitions.
example: Maintenance Window Collection
nullable: true
readOnly: true
type: string
x-longDescription: This object represents the Description property. All
values for resources described by this schema shall comply to the requirements
as described in the Redfish specification.
Members:
description: Contains the members of this collection.
items:
properties:
'@odata.id':
example: /UpdateService/MaintenanceWindows/a6c4c7b3/
format: uri
readOnly: true
type: string
x-longDescription: The value of this property shall be the unique
identifier for the resource and it shall be of the form defined
in the SPMF specification.
type: object
readOnly: true
type: array
Members@odata.count:
description: The total number of collection members.
example: '0'
readOnly: true
type: integer
Name:
description: The name of the resource or array element.
example: Maintenance Window Collection
readOnly: true
type: string
type: object
HpeNetworkPortEVB:
description: Hewlett Packard Enterprise property extensions for Network Ports
Edge Virtual Bridging
properties:
'@odata.context':
format: uri
readOnly: true
type: string
x-longDescription: The value of this property shall be the context URL that
describes the resource according to OData-Protocol and shall be of the
form defined in the SPMF specification.
'@odata.etag':
readOnly: true
type: string
x-longDescription: The value of this property is the Etag of the resource.
'@odata.id':
format: uri
readOnly: true
type: string
x-longDescription: The value of this property shall be the unique identifier
for the resource and it shall be of the form defined in the SPMF specification.
'@odata.type':
readOnly: true
type: string
x-longDescription: The value of this property shall be an absolute URL that
specifies the type of the resource and it shall be of the form defined
in the SPMF specification.
Description:
description: Provides a description of this resource and is used for commonality in
the schema definitions.
nullable: true
readOnly: true
type: string
x-longDescription: This object represents the Description property. All
values for resources described by this schema shall comply to the requirements
as described in the Redfish specification.
Id:
description: Uniquely identifies the resource within the collection of like
resources.
readOnly: true
type: string
x-added: iLO 5 1.20
x-longDescription: This property represents an identifier for the resource. All
values for resources described by this schema shall comply to the requirements
as described in the Redfish specification.
Name:
description: The name of the resource or array element.
readOnly: true
type: string
x-added: iLO 5 1.20
Receiving:
description: EVB TLV data received from the link partner on this port.
properties:
CdcpActive:
description: True if a currently active IEEE 802.1Qbg CDCP TLV has been
received from the link partner.
nullable: true
readOnly: true
type: boolean
x-added: iLO 5 1.20
ChannelActive:
description: A currently unexpired HPE Channel Link Control or HPE Channel
Description TLV has been received from the link partner.
nullable: true
readOnly: true
type: boolean
x-added: iLO 5 1.20
ChannelDescriptionLocalSequenceNumber:
description: The link partner's HPE Channel Description sequence number
that was last successfully received and processed.
nullable: true
readOnly: true
type: integer
x-added: iLO 5 1.20
ChannelDescriptionRemoteSequenceNumber:
description: The last HPE Channel Decsription sequence number sent on
this link that was successfully received and processed by the link
partner.
nullable: true
readOnly: true
type: integer
x-added: iLO 5 1.20
ChannelDescriptionSubtype:
description: The header subtype field of the last received HPE Channel
Description TLV.
nullable: true
readOnly: true
type: integer
x-added: iLO 5 1.20
ChannelLinkControlLocalSequenceNumber:
description: The link partner's HPE Channel Link Control sequence number
that was last successfully received and processed.
nullable: true
readOnly: true
type: integer
x-added: iLO 5 1.20
ChannelLinkControlMCEnable:
description: The Feature Indicators field, Management Controller (MC)
Channel (SCID 4094) enabled state in the HPE CLC TLV being received
from the link partner on this port.
nullable: true
readOnly: true
type: boolean
x-added: iLO 5 1.20
ChannelLinkControlRemoteSequenceNumber:
description: The last HPE Channel Link control sequence number sent
on this link that was successfully received and processed by the link
partner.
nullable: true
readOnly: true
type: integer
x-added: iLO 5 1.20
ChannelLinkControlSubtype:
description: The header subtype field of the last received HPE Channel
Link Control TLV.
nullable: true
readOnly: true
type: integer
x-added: iLO 5 1.20
Role:
description: 'The link partner''s IEEE 802.1Qbg operating role.
Defined values are:
* `bridge`: Indicates the link partner is operating as a Bridge.
* `station`: Indicates the link partner is operating as a Station.
'
enum:
- bridge
- station
nullable: true
readOnly: true
type: string
x-added: iLO 5 1.20
SChannelAssignments:
description: The set of all EVB <SCID,SVID> S-Channel assignments received
from the link partner on this port.
items:
description: An EVB <SCID,SVID> S-Channel identifier pair.
properties:
Scid:
description: SCID value for this <SCID,SVID> S-Channel identifier
pairreceived from the link partner on this port.
nullable: true
readOnly: true
type: integer
Svid:
description: SVID assignment value for this <SCID,SVID> S-Channel
identifier pair received from the link partner on this port.
When 0 it indicates an assignment request is in progress.
nullable: true
readOnly: true
type: integer
readOnly: true
type: object
readOnly: true
type: array
x-added: iLO 5 1.20
SChannelMaxCount:
description: Indicates the number of S-Channels the link partner can
support on this physical link.
nullable: true
readOnly: true
type: integer
x-added: iLO 5 1.20
SChannelsSupported:
description: When true this link supports S-Channels.
nullable: true
readOnly: true
type: boolean
x-added: iLO 5 1.20
VirtualLinkStatusVector:
description: A bit vector indicating S-Channel status received from
the link partner, 1=up, 0=down. S-Channel status bits are ordered
by SCID from lowest numbered (first) to highest (last).
nullable: true
readOnly: true
type: string
x-added: iLO 5 1.20
readOnly: true
type: object
x-added: iLO 5 1.20
Transmitting:
description: EVB TLV data being transmitted to the link partner on this
port.
properties:
ChannelDescriptionData:
description: The set of all S-Channel descriptions being transmitted
to the link partner on this port.
items:
description: Descriptive data for one S-Channel being transmitted
to the link partner on this port.
properties:
Descriptor0BandwidthCirMbps:
description: The bandwidth Commited Information Rate (CIR) for
this S-Channel, in Mbps.
nullable: true
readOnly: true
type: integer
x-added: iLO 5 1.20
Descriptor0BandwidthPirMbps:
description: The bandwidth Peak Information Rate (PIR) for this
S-Channel, in Mbps.
nullable: true
readOnly: true
type: integer
x-added: iLO 5 1.20
Descriptor0ChannelTerminationType:
description: 'Indicates the termination provided for this S-Channel.
Defined values are:
* `primary-physical`: This S-Channel is presented to the host
OS as a primary PCI physical function.
* `SR-IOV-virtual`: This S-Channel is presented to the host
OS as a PCI SR-IOV virtual function.
* `secondary-physical`: This S-Channel is presented to the host
OS as a secondary PCI physical function, i.e. a PCI physical
function behind a bridge on the device.
* `vSwitch-port`: This S-Channel is mapped to a Virtual Switch
port.
* `NCSI-port`: This S-Channel is mapped to the NCSI internal
port for management.
'
enum:
- primary-physical
- SR-IOV-virtual
- secondary-physical
- vSwitch-port
- NCSI-port
nullable: true
readOnly: true
type: string
x-added: iLO 5 1.20
Descriptor0EthernetSupport:
description: When true, this S-Channel supports Ethernet.
nullable: true
readOnly: true
type: boolean
x-added: iLO 5 1.20
Descriptor0FCoESupport:
description: When true, this S-Channel supports Fibre Channel
over Ethernet (FCoE).
nullable: true
readOnly: true
type: boolean
x-added: iLO 5 1.20
Descriptor0PcpSupport:
description: Indicates which IEEE 802.1Q Ethernet Priority Code
Point (PCP) classes are supported on this S-Channel. When no
PCPs are supported, the S-Channel makes no attempt to filter
or control traffic class. A string of 1/0 characters indicating
1=enabled, 0=disabled. PCP classes are ordered from highest
numbered 7 (first) to lowest 0 (last).
nullable: true
readOnly: true
type: string
x-added: iLO 5 1.20
Descriptor0RoCEESupport:
description: When true, this S-Channel supports RDMA over Converged
Enhanced Ethernet (RoCEE).
nullable: true
readOnly: true
type: boolean
x-added: iLO 5 1.20
Descriptor0Scid:
description: The S-Channel identifier for this Descriptor0 instance.
nullable: true
readOnly: true
type: integer
Descriptor0iSCSISupport:
description: When true, this S-Channel supports Internet SCSI
(iSCSI).
nullable: true
readOnly: true
type: boolean
x-added: iLO 5 1.20
Descriptor1ConnectionID:
description: A unique S-Channel identifer in UUID format.
nullable: true
readOnly: true
type: string
x-added: iLO 5 1.20
Descriptor1Scid:
description: The S-Channel identifier for this Descriptor1 instance.
nullable: true
readOnly: true
type: integer
readOnly: true
type: object
readOnly: true
type: array
x-added: iLO 5 1.20
ChannelDescriptionLocalSequenceNumber:
description: This station's channel discovery local sequence number
which will be transmitted to the link partner on this port.
nullable: true
readOnly: true
type: integer
x-added: iLO 5 1.20
ChannelDescriptionRemoteSequenceNumber:
description: The link partner's channel discovery local sequence number
that was last successfully received and processed.
nullable: true
readOnly: true
type: integer
x-added: iLO 5 1.20
ChannelDescriptorCount:
description: The number of channel descriptor pairs being transmitted
to the link partner on this port.
nullable: true
readOnly: true
type: integer
x-added: iLO 5 1.20
ChannelLinkControlLocalSequenceNumber:
description: This station's channel link control local sequence number
which will be transmitted to the link partner on this port.
nullable: true
readOnly: true
type: integer
x-added: iLO 5 1.20
ChannelLinkControlMCEnable:
description: The Feature Indicators field, Management Controller (MC)
Channel (SCID 4094) enabled state in the HPE CLC TLV being transmitted
to the link partner on this port.
nullable: true
readOnly: true
type: boolean
x-added: iLO 5 1.20
ChannelLinkControlRemoteSequenceNumber:
description: The link partner's channel link control local sequence
number that was last successfully received and processed.
nullable: true
readOnly: true
type: integer
x-added: iLO 5 1.20
Role:
description: 'This port''s IEEE 802.1Qbg role being advertised on the
link.
Defined values are:
* `bridge`: Indicates this link is operating locally as a Bridge.
* `station`: Indicates this link is operating locally as a Station.
'
enum:
- bridge
- station
nullable: true
readOnly: true
type: string
x-added: iLO 5 1.20
SChannelAssignments:
description: The set of all EVB <SCID,SVID> S-Channel assignments being
transmitted to the link partner on this port.
items:
description: An EVB <SCID,SVID> S-Channel identifier pair.
properties:
Scid:
description: SCID value for this <SCID,SVID> S-Channel identifier
pair being transmitted to the link partner on this port.
nullable: true
readOnly: true
type: integer
Svid:
description: SVID assignment value for this <SCID,SVID> S-Channel
identifier pair being transmitted to the link partner on this
port. When 0 it indicates an SVID assignment request to the
link partner is in progress.
nullable: true
readOnly: true
type: integer
readOnly: true
type: object
readOnly: true
type: array
x-added: iLO 5 1.20
SChannelMaxCount:
description: The Channel Capacity value being advertised to the link
partner. It indicates the number of S-Channels this station can support
on this physical link.
nullable: true
readOnly: true
type: integer
x-added: iLO 5 1.20
SChannelsSupported:
description: When true, indicates that this physical link has S-Channel
capability.
nullable: true
readOnly: true
type: boolean
x-added: iLO 5 1.20
VirtualLinkStatusVector:
description: A bit vector indicating S-Channel status being transmitted
on this link, 1=up, 0=down. S-Channel status bits are ordered by SCID
from lowest numbered (first) to highest (last).
nullable: true
readOnly: true
type: string
x-added: iLO 5 1.20
readOnly: true
type: object
x-added: iLO 5 1.20
type: object
HpeNetworkPortLLDP:
description: Hewlett Packard Enterprise property extensions for Network Ports
Link Layer Discovery Protocol
properties:
'@odata.context':
format: uri
readOnly: true
type: string
x-longDescription: The value of this property shall be the context URL that
describes the resource according to OData-Protocol and shall be of the
form defined in the SPMF specification.
'@odata.etag':
readOnly: true
type: string
x-longDescription: The value of this property is the Etag of the resource.
'@odata.id':
format: uri
readOnly: true
type: string
x-longDescription: The value of this property shall be the unique identifier
for the resource and it shall be of the form defined in the SPMF specification.
'@odata.type':
readOnly: true
type: string
x-longDescription: The value of this property shall be an absolute URL that
specifies the type of the resource and it shall be of the form defined
in the SPMF specification.
Description:
description: Provides a description of this resource and is used for commonality in
the schema definitions.
nullable: true
readOnly: true
type: string
x-longDescription: This object represents the Description property. All
values for resources described by this schema shall comply to the requirements
as described in the Redfish specification.
Id:
description: Uniquely identifies the resource within the collection of like
resources.
readOnly: true
type: string
x-added: iLO 5 1.20
x-longDescription: This property represents an identifier for the resource. All
values for resources described by this schema shall comply to the requirements
as described in the Redfish specification.
Name:
description: The name of the resource or array element.
readOnly: true
type: string
x-added: iLO 5 1.20
Receiving:
description: LLDP data being received on this link.
properties:
ChassisID:
description: The LLDP chassis ID received from the link partner.
nullable: true
readOnly: true
type: string
x-added: iLO 5 1.20
ChassisIDSubtype:
description: 'The IEEE 802.1AB-2009 chassis ID subtype received from
the link partner.
Defined values are:
* `chassisComp`: Chassis component, based in the value of entPhysicalAlias
in IETF RFC 4133.
* `ifAlias`: Interface alias, based on the ifAlias MIB object.
* `portComp`: Port component, based in the value of entPhysicalAlias
in IETF RFC 4133.
* `mac-Addr`: MAC address, based on an agent detected unicast source
address as defined in IEEE Std. 802.
* `networkAddr`: Network address, based on an agent detected network
address.
* `ifName`: Interface name, based on the ifName MIB object.
* `agent-ID`: Agent circuit ID, based on the agent-local identifier
of the circuit as defined in RFC 3046.
* `local-Assign`: Locally assigned, based on a alpha-numeric value
locally assigned.
'
enum:
- chassisComp
- ifAlias
- portComp
- mac-Addr
- networkAddr
- ifName
- agent-ID
- local-Assign
nullable: true
readOnly: true
type: string
x-added: iLO 5 1.20
Dcb:
description: DCB data being received on thhis link.
properties:
ApplicationPriorityReceived:
description: True when an unexpired Data Center Bridging (DCB) Application
Priority Table TLV has been received.
nullable: true
readOnly: true
type: boolean
x-added: iLO 5 1.20
ApplicationPriorityTable:
description: The set of all entries in the DCB Application Priority
Table, as received in the LLDP Application Priority TLV.
items:
description: One entry in the DCB Application Priority Table,
as received in the LLDP Application Priority TLV.
properties:
ApplicationPriority:
description: Indicates which priority level is assigned for
this application protocol.
nullable: true
readOnly: true
type: integer
x-added: iLO 5 1.20
ApplicationProtocol:
description: An integer value indicating application protocol
identity, of the type described by DCBApplicationSelect.
nullable: true
readOnly: true
type: integer
x-added: iLO 5 1.20
ApplicationSelect:
description: 'Indentifies the type of the DCBApplicationProtocol
property.
Defined values are:
* `reserved`: Reserved select value.
* `default-Ethertype`: Default priority. Use when priority
not otherwise specified.
* `TCP-SCTP`: DCBApplicationProtocol value is a well known
port over TCP or SCTP.
* `UDP-DCCP`: DCBApplicationProtocol value is a well known
port over UDP or DCCP.
* `TCP-SCTP-UDP-DCCP`: DCBApplicationProtocol is a well
known port over TCP, SCTP, SCTP, or DCCP.
'
enum:
- reserved
- default-Ethertype
- TCP-SCTP
- UDP-DCCP
- TCP-SCTP-UDP-DCCP
nullable: true
readOnly: true
type: string
x-added: iLO 5 1.20
readOnly: true
type: object
readOnly: true
type: array
x-added: iLO 5 1.20
Ets:
description: ETS data being received on this link.
properties:
BandwidthAssignmentTable:
description: The DCB ETS Traffic Class Assignment table received
from the link partner. The sum of all bandwidth assignments
in this table must be 100 or less
items:
description: One entry in the DCB ETS Traffic Class (TC) Bandwidth
Assignment Table.
nullable: true
readOnly: true
type: integer
readOnly: true
type: array
x-added: iLO 5 1.20
CreditBasedShaper:
description: True if the link partner supports the Credit-based
Shaper (CBS) transmmission selection algortithm.
nullable: true
readOnly: true
type: boolean
x-added: iLO 5 1.20
MaximumTrafficClassCount:
description: The maximum number of traffic classes supported
by the link partner.
nullable: true
readOnly: true
type: integer
x-added: iLO 5 1.20
PriorityAssignmentTable:
description: The DCB ETS Priority Assignment Table from the
received DCB ETS Configuration TLV. Priority values are listed
in order from 0 (first) to 7 (last).
items:
description: One entry in the DCB ETS Priority Assignment
Table indicating this priority's Traffic Class assignment.
nullable: true
readOnly: true
type: integer
readOnly: true
type: array
x-added: iLO 5 1.20
TlvReceived:
description: True when an unexpired DCB Enhanced Transmission
Selection (ETS) TLV has been received.
nullable: true
readOnly: true
type: boolean
x-added: iLO 5 1.20
TrafficSelectionAlgorithmTable:
description: The DCB ETS TSA assignment table received from
the link partner. Traffic classes are listed from 0 (first)
to 7 (last).
items:
description: 'An assignment of a Traffic Selection Algorithm
(TSA) to a traffic class.
Defined values are:
* `strict`: Strict priority algorithm.
* `CBS`: Credit-Based Shaper algorithm.
* `ETS`: Enhanced Traffic Selection algorithm.
* `vendor`: Vendor specific algorithm for use with DCB.
'
enum:
- strict
- CBS
- ETS
- vendor
nullable: true
readOnly: true
type: string
readOnly: true
type: array
x-added: iLO 5 1.20
Willing:
description: True if the link partner is willing to accept ETS
configurations.
nullable: true
readOnly: true
type: boolean
x-added: iLO 5 1.20
readOnly: true
type: object
x-added: iLO 5 1.20
LocalEqualRemote:
description: True when the transmitted and received contents match
for both DCB ETS and PFC TLVs.
nullable: true
readOnly: true
type: boolean
x-added: iLO 5 1.20
Pfc:
description: Priority flow control data being received on this link.
properties:
EnabledTrafficClasses:
description: A bit string indicating which priority levels have
PFC enabled, 1=enabled. PFC levels are bit ordered from 7
(first) to 0 (last).
nullable: true
readOnly: true
type: string
x-added: iLO 5 1.20
MacSecurityBypassCapability:
description: True when the link partner has the ability to bypass
MAC security in order to improve PFC responsiveness.
nullable: true
readOnly: true
type: boolean
x-added: iLO 5 1.20
MaximumTrafficClassCount:
description: Indicates the maximum number of traffic classes
that the link partner can simultaneously support.
nullable: true
readOnly: true
type: integer
x-added: iLO 5 1.20
TlvReceived:
description: True when an unexpired DCB Priority Flow Control
(PFC) TLV has been received.
nullable: true
readOnly: true
type: boolean
x-added: iLO 5 1.20
Willing:
description: True if the LLDP link partner is willing to accept
PFC configurations.
nullable: true
readOnly: true
type: boolean
x-added: iLO 5 1.20
readOnly: true
type: object
x-added: iLO 5 1.20
Version:
description: 'The DCB version supported by the link partner.
Defined values are:
* `unknown`: Unknown
* `CEE`: Converged Enhanced Ethernet
* `IEEE`: IEEE 802.1Q
'
enum:
- unknown
- CEE
- IEEE
nullable: true
readOnly: true
type: string
x-added: iLO 5 1.20
readOnly: true
type: object
x-added: iLO 5 1.20
ManagementAddress:
description: The management address received from the link partner.
nullable: true
readOnly: true
type: string
x-added: iLO 5 1.20
ManagementAddressOID:
description: An object identifier for the hardware or protocol entity
associated with the management address.
nullable: true
readOnly: true
type: string
x-added: iLO 5 1.20
ManagementAddressReceived:
description: True when a currently unexpired management address TLV
has been received from the link partner.
nullable: true
readOnly: true
type: boolean
x-added: iLO 5 1.20
ManagementAddressType:
description: 'The type of management address received from the link
partner.
Defined values are:
* `IPv4`: Type 1 (IP version 4).
* `IPv6`: Type 2 (IP version 6).
* `all802`: Type 6 (All 802 media plus Ethernet ''canonical format'').
'
enum:
- IPv4
- IPv6
- all802
nullable: true
readOnly: true
type: string
x-added: iLO 5 1.20
ManagementCvlanID:
description: The management CVLAN ID received from the link partner.
nullable: true
readOnly: true
type: integer
x-added: iLO 5 1.20
ManagementIFNumSubtype:
description: 'Management interface number subtype.
Defined values are:
* `unknown`: Interface number is not known.
* `ifIndex`: Interface number is based on the ifIndex MIB object.
* `sysPortNum`: Interface number is based on the system port numbering
convention.
'
enum:
- unknown
- ifIndex
- sysPortNum
nullable: true
readOnly: true
type: string
x-added: iLO 5 1.20
ManagementIFNumber:
description: Management interface number received from the link partner
represented as a colon delimited string of hexadecimal octets.
nullable: true
readOnly: true
type: string
x-added: iLO 5 1.20
ManagementVlanReceived:
description: True when a currently unexpired management address VID
TLV has been received from the link partner.
nullable: true
readOnly: true
type: boolean
x-added: iLO 5 1.20
NearestBridgeTtlExpired:
description: True when the LLDP PDU most recently received from the
link partner has expired.
nullable: true
readOnly: true
type: boolean
x-added: iLO 5 1.20
PortDescription:
description: The remote link partner's port description.
nullable: true
readOnly: true
type: string
x-added: iLO 5 1.20
PortID:
description: A colon delimited string of hexadecimal octets received
from the link partner identifying its port.
nullable: true
readOnly: true
type: string
x-added: iLO 5 1.20
PortIDSubtype:
description: 'The port ID subtype enumeration from IEEE 802.1AB-2009
Table 8-3, which indicates the format for the PortID property.
Defined values are:
* `chassisComp`: Chassis component, based in the value of entPhysicalAlias
in IETF RFC 4133.
* `ifAlias`: Interface alias, based on the ifAlias MIB object.
* `portComp`: Port component, based in the value of entPhysicalAlias
in IETF RFC 4133.
* `mac-Addr`: MAC address, based on an agent detected unicast source
address as defined in IEEE Std. 802.
* `networkAddr`: Network address, based on an agent detected network
address.
* `ifName`: Interface name, based on the ifName MIB object.
* `agent-ID`: Agent circuit ID, based on the agent-local identifier
of the circuit as defined in RFC 3046.
* `local-Assign`: Locally assigned, based on a alpha-numeric value
locally assigned.
'
enum:
- chassisComp
- ifAlias
- portComp
- mac-Addr
- networkAddr
- ifName
- agent-ID
- local-Assign
nullable: true
readOnly: true
type: string
x-added: iLO 5 1.20
SystemDescription:
description: The system description received from the link partner.
nullable: true
readOnly: true
type: string
x-added: iLO 5 1.20
readOnly: true
type: object
x-added: iLO 5 1.20
Transmitting:
description: LLDP data being transmitted on this link.
properties:
ChassisID:
description: The Link Layer Data Protocol (LLDP) chassis ID being transmitted
on this link.
nullable: true
readOnly: true
type: string
x-added: iLO 5 1.20
ChassisIDSubtype:
description: 'The IEEE 802.1AB-2009 chassis ID subtype being transmitted
on this link.
Defined values are:
* `chassisComp`: Chassis component, based in the value of entPhysicalAlias
in IETF RFC 4133.
* `ifAlias`: Interface alias, based on the ifAlias MIB object.
* `portComp`: Port component, based in the value of entPhysicalAlias
in IETF RFC 4133.
* `mac-Addr`: MAC address, based on an agent detected unicast source
address as defined in IEEE Std. 802.
* `networkAddr`: Network address, based on an agent detected network
address.
* `ifName`: Interface name, based on the ifName MIB object.
* `agent-ID`: Agent circuit ID, based on the agent-local identifier
of the circuit as defined in RFC 3046.
* `local-Assign`: Locally assigned, based on a alpha-numeric value
locally assigned.
'
enum:
- chassisComp
- ifAlias
- portComp
- mac-Addr
- networkAddr
- ifName
- agent-ID
- local-Assign
nullable: true
readOnly: true
type: string
x-added: iLO 5 1.20
ManagementAddresses:
description: The set of all management addresses being transmitted in
LLDP on this link.
items:
description: A management address for this server.
properties:
ManagementIPAddress:
description: A management address.
nullable: true
readOnly: true
type: string
x-added: iLO 5 1.20
ManagementIPAddressType:
description: 'The IANA type of this management address.
Defined values are:
* `IPv4`: Type 1 (IP version 4).
* `IPv6`: Type 2 (IP version 6).
* `all802`: Type 6 (All 802 media plus Ethernet ''canonical
format'').
'
enum:
- IPv4
- IPv6
- all802
nullable: true
readOnly: true
type: string
x-added: iLO 5 1.20
readOnly: true
type: object
readOnly: true
type: array
x-added: iLO 5 1.20
ManagementCvlanID:
description: The management CVLAN ID being transmitted on this link.
nullable: true
readOnly: true
type: integer
x-added: iLO 5 1.20
ManagementCvlanIDTransmitted:
description: When true, indicates that a management CVLAN ID is being
transmitted on this link.
nullable: true
readOnly: true
type: boolean
x-added: iLO 5 1.20
PortDescription:
description: An alphanumeric string describing this link.
nullable: true
readOnly: true
type: string
x-added: iLO 5 1.20
PortID:
description: A colon delimited string of hexadecimal octets identifying
this port.
nullable: true
readOnly: true
type: string
x-added: iLO 5 1.20
PortIDSubtype:
description: 'The port ID subtype from IEEE 802.1AB-2009 Table 8-3.
Defined values are:
* `chassisComp`: Chassis component, based in the value of entPhysicalAlias
in IETF RFC 4133.
* `ifAlias`: Interface alias, based on the ifAlias MIB object.
* `portComp`: Port component, based in the value of entPhysicalAlias
in IETF RFC 4133.
* `mac-Addr`: MAC address, based on an agent detected unicast source
address as defined in IEEE Std. 802.
* `networkAddr`: Network address, based on an agent detected network
address.
* `ifName`: Interface name, based on the ifName MIB object.
* `agent-ID`: Agent circuit ID, based on the agent-local identifier
of the circuit as defined in RFC 3046.
* `local-Assign`: Locally assigned, based on a alpha-numeric value
locally assigned.
'
enum:
- chassisComp
- ifAlias
- portComp
- mac-Addr
- networkAddr
- ifName
- agent-ID
- local-Assign
nullable: true
readOnly: true
type: string
x-added: iLO 5 1.20
SystemDescription:
description: A textual description of this system.
nullable: true
readOnly: true
type: string
x-added: iLO 5 1.20
readOnly: true
type: object
x-added: iLO 5 1.20
type: object
HpePowerMeter:
properties:
'@odata.context':
example: /$metadata#HpePowerMeter.HpePowerMeter
format: uri
readOnly: true
type: string
x-longDescription: The value of this property shall be the context URL that
describes the resource according to OData-Protocol and shall be of the
form defined in the SPMF specification.
'@odata.etag':
example: W/\B7D40F8A\""
readOnly: true
type: string
x-longDescription: The value of this property is the Etag of the resource.
'@odata.id':
example: /Chassis/1/Power/FastPowerMeter/
format: uri
readOnly: true
type: string
x-longDescription: The value of this property shall be the unique identifier
for the resource and it shall be of the form defined in the SPMF specification.
'@odata.type':
example: '#HpePowerMeter.v2_0_1.HpePowerMeter'
readOnly: true
type: string
x-longDescription: The value of this property shall be an absolute URL that
specifies the type of the resource and it shall be of the form defined
in the SPMF specification.
Average:
description: Average power across all samples, over the last 24 hours.
example: '168'
readOnly: true
type: integer
x-added: iLO 5 1.10
Id:
description: Uniquely identifies the resource within the collection of like
resources.
example: FastPowerMeter
readOnly: true
type: string
x-added: iLO 5 1.10
x-longDescription: This property represents an identifier for the resource. All
values for resources described by this schema shall comply to the requirements
as described in the Redfish specification.
Maximum:
description: Maximum power across all samples, taken from the 24 hour history.
example: '225'
readOnly: true
type: integer
x-added: iLO 5 1.10
Minimum:
description: Minimum power across all samples, taken from the 24 hour history.
example: '165'
readOnly: true
type: integer
x-added: iLO 5 1.10
Name:
description: The name of the resource or array element.
example: PowerMeter
readOnly: true
type: string
x-added: iLO 5 1.10
Oem:
description: This object represents the Oem property.
readOnly: true
PowerDetail:
description: Power detail of the power meter.
items:
properties:
AmbTemp:
description: Ambient temperature, in degrees Celsius.
example: '23'
readOnly: true
type: integer
x-added: iLO 5 1.10
Average:
description: Average power in Watts over the sample time.
example: '167'
readOnly: true
type: integer
x-added: iLO 5 1.10
Cap:
description: The applicable power cap in Watts at the time of this
power sample.
example: '0'
readOnly: true
type: integer
x-added: iLO 5 1.10
CpuAvgFreq:
description: CPU average frequency in MHz.
example: '0'
readOnly: true
type: integer
x-added: iLO 5 1.10
CpuCapLim:
description: Measures the effect of the power cap on performance in
percent.
example: '100'
readOnly: true
type: integer
x-added: iLO 5 1.10
CpuMax:
description: The percentage of time the CPU spent in its maximum power
mode.
example: '0'
readOnly: true
type: integer
x-added: iLO 5 1.10
CpuPwrSavLim:
description: Measures the effect of CPU Power Regulator state switching
on performance in percent.
example: '100'
readOnly: true
type: integer
x-added: iLO 5 1.10
CpuUtil:
description: CPU utilization in percent.
example: '0'
readOnly: true
type: integer
x-added: iLO 5 1.10
CpuWatts:
description: The power consumed by the system CPUs in Watts.
example: '26'
readOnly: true
type: integer
x-added: iLO 5 1.30
DimmWatts:
description: The power consumed by the system memory DIMMs in Watts.
example: '20'
readOnly: true
type: integer
x-added: iLO 5 1.30
GpuWatts:
description: The power consumed by the GPU(s) in Watts. This will
be 0 if no GPUs are installed or if the drivers are not loaded.
example: '0'
readOnly: true
type: integer
x-added: iLO 5 1.30
Minimum:
description: Minimum power in Watts over the sample time.
example: '167'
readOnly: true
type: integer
x-added: iLO 5 1.10
Peak:
description: Peak power in Watts over the sample time.
example: '182'
readOnly: true
type: integer
x-added: iLO 5 1.10
PrMode:
description: 'Power Regulator mode, which can be OS Control, Static
High, Static Low or Dynamic.
Defined values are:
* `dyn`: Dynamic Mode - CPU power regulation is managed dynamically
by the firmware.
* `min`: Minimum Mode - CPU power regulation is configured to save
as much power as possible at the possible expense of performance.
* `max`: Maximum Mode - CPU power regulation is configured for maximum
performance at the possible expense of power efficiency.
* `osc`: OS Control Mode - CPU power regulation is managed by the
Operating System.
'
enum:
- dyn
- min
- max
- osc
example: dyn
nullable: true
readOnly: true
type: string
x-added: iLO 5 1.10
PunCap:
description: If true, CPU performance is being penalized by the current
power cap.
example: 'false'
readOnly: true
type: boolean
x-added: iLO 5 1.10
Time:
description: Time at which the power sample detail was captured.
example: '2019-02-07T16:17:14Z'
format: date-time
readOnly: true
type: string
x-added: iLO 5 1.10
UnachCap:
description: If true, the configured power cap could not be achieved
due to system power requirements.
example: 'false'
readOnly: true
type: boolean
x-added: iLO 5 1.10
readOnly: true
type: object
readOnly: true
type: array
x-added: iLO 5 1.10
Samples:
description: Number of samples in the array.
example: '120'
readOnly: true
type: integer
x-added: iLO 5 1.10
readOnly: true
type: object
HpeRemoteSupport:
properties:
'@odata.context':
example: /$metadata#HpeRemoteSupport.HpeRemoteSupport
format: uri
readOnly: true
type: string
x-longDescription: The value of this property shall be the context URL that
describes the resource according to OData-Protocol and shall be of the
form defined in the SPMF specification.
'@odata.etag':
example: W/\680EC74A\""
readOnly: true
type: string
x-longDescription: The value of this property is the Etag of the resource.
'@odata.id':
example: /Managers/1/RemoteSupportService/
format: uri
readOnly: true
type: string
x-longDescription: The value of this property shall be the unique identifier
for the resource and it shall be of the form defined in the SPMF specification.
'@odata.type':
example: '#HpeRemoteSupport.v2_3_0.HpeRemoteSupport'
readOnly: true
type: string
x-longDescription: The value of this property shall be an absolute URL that
specifies the type of the resource and it shall be of the form defined
in the SPMF specification.
Actions:
properties:
'#HpeRemoteSupport.ClearServiceEventLog':
properties:
target:
description: Link to invoke action
example: /Managers/1/RemoteSupportService/Actions/HpeRemoteSupport.ClearServiceEventLog/
type: string
title:
description: Friendly action name
type: string
type: object
'#HpeRemoteSupport.CompleteDirectConnectRegistration':
properties:
target:
description: Link to invoke action
example: /Managers/1/RemoteSupportService/Actions/HpeRemoteSupport.CompleteDirectConnectRegistration/
type: string
title:
description: Friendly action name
type: string
type: object
'#HpeRemoteSupport.DisableRemoteSupport':
properties:
target:
description: Link to invoke action
example: /Managers/1/RemoteSupportService/Actions/HpeRemoteSupport.DisableRemoteSupport/
type: string
title:
description: Friendly action name
type: string
type: object
'#HpeRemoteSupport.RegisterDeviceToRemoteSupport':
properties:
ConnectionType@Redfish.AllowableValues:
description: The supported values for the ConnectionType parameter.
items:
description: 'Defined values are:
* `DirectConnect`
* `CentralConnect`
'
enum:
- DirectConnect
- CentralConnect
type: string
type: array
x-longDescription: The supported values for the ConnectionType parameter.
target:
description: Link to invoke action
example: /Managers/1/RemoteSupportService/Actions/HpeRemoteSupport.RegisterDeviceToRemoteSupport/
type: string
title:
description: Friendly action name
type: string
type: object
'#HpeRemoteSupport.ServerMaintenance':
properties:
MaintenanceMode@Redfish.AllowableValues:
description: The supported values for the MaintenanceMode parameter.
items:
description: 'Defined values are:
* `Set`
* `Clear`
'
enum:
- Set
- Clear
type: string
type: array
x-longDescription: The supported values for the MaintenanceMode
parameter.
target:
description: Link to invoke action
example: /Managers/1/RemoteSupportService/Actions/HpeRemoteSupport.ServerMaintenance/
type: string
title:
description: Friendly action name
type: string
type: object
'#HpeRemoteSupport.TriggerDataCollection':
properties:
DataType@Redfish.AllowableValues:
description: The supported values for the DataType parameter.
items:
description: 'Defined values are:
* `ActiveHealthSystemData`
* `L2CollectionData`
'
enum:
- ActiveHealthSystemData
- L2CollectionData
type: string
type: array
x-longDescription: The supported values for the DataType parameter.
target:
description: Link to invoke action
example: /Managers/1/RemoteSupportService/Actions/HpeRemoteSupport.TriggerDataCollection/
type: string
title:
description: Friendly action name
type: string
type: object
'#HpeRemoteSupport.TriggerTestEvent':
properties:
target:
description: Link to invoke action
example: /Managers/1/RemoteSupportService/Actions/HpeRemoteSupport.TriggerTestEvent/
type: string
title:
description: Friendly action name
type: string
type: object
type: object
ConnectModel:
description: 'The Remote Support connect model type.
Defined values are:
* `DirectConnect`
* `CentralConnect`
'
enum:
- DirectConnect
- CentralConnect
readOnly: true
type: string
x-added: iLO 5 1.20
DataCollectionFrequencyInDays:
description: The frequency of data collection in days. This is applicable
only when the server is registered using Direct Connect.
readOnly: true
type: integer
x-added: iLO 5 1.20
DestinationPort:
description: 'The port number of the Insight Remote Support server. This
is applicable for Central Connect only. '
readOnly: true
type: integer
x-added: iLO 5 1.20
DestinationURL:
description: The host name or IP address of the Remote Support server. This
is applicable for Central Connect only.
readOnly: true
type: string
x-added: iLO 5 1.20
HpePassportPassword:
description: HPE Passport Account Password.
nullable: true
readOnly: true
type: string
x-added: iLO 5 1.20
HpePassportUserId:
description: HPE Passport Account Id.
readOnly: true
type: string
x-added: iLO 5 1.20
Id:
description: Uniquely identifies the resource within the collection of like
resources.
example: RemoteSupportService
readOnly: true
type: string
x-added: iLO 5 1.20
x-longDescription: This property represents an identifier for the resource. All
values for resources described by this schema shall comply to the requirements
as described in the Redfish specification.
LastTransmissionDate:
description: The last transmission date.
format: date-time
readOnly: true
type: string
x-added: iLO 5 1.20
LastTransmissionError:
description: The last transmission error.
example: No error
readOnly: true
type: string
x-added: iLO 5 1.20
LastTransmissionType:
description: "The last transmission type. \n\nDefined values are:\n* `ActiveHealthSystemData`\n\
* `L2DataCollection`\n* `Registration`\n* `Deregistration`\n* `ServiceEvent`\n\
* `NoTransmission`\n"
enum:
- ActiveHealthSystemData
- L2DataCollection
- Registration
- Deregistration
- ServiceEvent
- NoTransmission
example: NoTransmission
nullable: true
readOnly: true
type: string
x-added: iLO 5 1.20
MaintenanceModeEnabled:
description: This indicates if the server is in Maintenance Mode or not.
example: 'false'
readOnly: true
type: boolean
x-added: iLO 5 1.30
ProxySettings:
description: Web proxy settings.
properties:
Password:
description: 'Password for web proxy server authentication. '
example: 'null'
nullable: true
readOnly: false
type: string
x-added: iLO 5 1.20
Port:
description: 'Port number on which to communicate with the web proxy
server. '
example: 'null'
nullable: true
readOnly: false
type: integer
x-added: iLO 5 1.20
Url:
description: Web proxy server host name or IP address.
example: ''
format: url
readOnly: false
type: string
x-added: iLO 5 1.20
Username:
description: 'Username for web proxy server authentication. '
example: ''
nullable: true
readOnly: false
type: string
x-added: iLO 5 1.20
readOnly: false
type: object
x-added: iLO 5 1.20
RemoteSupportEnabled:
description: 'This indicates if the Remote Support Service is available
or not. '
example: 'false'
readOnly: true
type: boolean
x-added: iLO 5 1.20
ServiceEventLogs:
description: A reference to the collection of service event logs.
properties:
'@odata.id':
example: /Managers/1/RemoteSupportService/ServiceEventLogs/
format: uri
readOnly: true
type: string
x-longDescription: The value of this property shall be the unique identifier
for the resource and it shall be of the form defined in the SPMF specification.
readOnly: true
type: object
x-added: iLO 5 1.20
readOnly: false
type: object
HpeRemoteSupport.ClearServiceEventLog:
properties: {}
type: object
HpeRemoteSupport.CompleteDirectConnectRegistration:
properties: {}
type: object
HpeRemoteSupport.DisableRemoteSupport:
properties:
MessageId:
description: A unique message identifier in UUID format used to match the
test Service Event with this request. It is returned in the submission
package SOAP envelope header.
readOnly: true
type: string
type: object
HpeRemoteSupport.RegisterDeviceToRemoteSupport:
properties:
ConnectionType:
description: 'This indicates whether the device will be registered using
Direct Connect or Central Connect.
Defined values are:
* `DirectConnect`
* `CentralConnect`
'
enum:
- DirectConnect
- CentralConnect
readOnly: true
type: string
DestinationPort:
description: The port number of the Remote Support server. This is applicable
for Central Connect only.
readOnly: true
type: integer
DestinationUrl:
description: The host name or IP address of the Remote Support server. This
is applicable for Central Connect only.
readOnly: true
type: string
HpePassportPassword:
description: HPE Passport Account password. It is required when connecting
using Direct Connect.
nullable: true
readOnly: true
type: string
HpePassportUserId:
description: HPE Passport Account User Id. It is required when connecting
using Direct Connect.
readOnly: true
type: string
WebProxyPassword:
description: Password for web proxy server authentication when connecting
using Direct Connect.
nullable: true
readOnly: false
type: string
WebProxyPort:
description: 'Port number on which to communicate with the web proxy server
when connecting using Direct Connect. '
readOnly: false
type: integer
WebProxyUrl:
description: 'Web proxy server host name or IP address when connecting using
Direct Connect. '
format: url
readOnly: false
type: string
WebProxyUsername:
description: Username for web proxy server authentication when connecting
using Direct Connect.
nullable: true
readOnly: false
type: string
type: object
HpeRemoteSupport.ServerMaintenance:
properties:
DurationInMinutes:
description: The number of minutes the Server will remain in server maintenance
mode. The maximum duration can be 1 week
readOnly: true
type: integer
MaintenanceMode:
description: 'Indicates whether to set or clear server maintenance mode.
Defined values are:
* `Set`
* `Clear`
'
enum:
- Set
- Clear
readOnly: true
type: string
MessageId:
description: A unique message identifier in UUID format used to match the
test Service Event with this request. It is returned in the submission
package SOAP envelope header.
readOnly: true
type: string
type: object
HpeRemoteSupport.TriggerDataCollection:
properties:
DataType:
description: 'The type of data that has to be submitted to the Remote Support.
Defined values are:
* `ActiveHealthSystemData`
* `L2CollectionData`
'
enum:
- ActiveHealthSystemData
- L2CollectionData
readOnly: true
type: string
Days:
description: The number of days to include in the transmission, up to a
maximum of the last seven days not including the present day. Possible
values are 1 to 7.
readOnly: true
type: integer
MessageId:
description: A unique message identifier in UUID format used to match the
test Service Event with this request. It is returned in the submission
package SOAP envelope header.
readOnly: true
type: string
type: object
HpeRemoteSupport.TriggerTestEvent:
properties:
MessageId:
description: A unique message identifier in UUID format used to match the
test Service Event with this request. It is returned in the submission
package SOAP envelope header.
readOnly: true
type: string
type: object
HpeRemoteSupport.Update:
properties:
Actions:
properties:
'#HpeRemoteSupport.ClearServiceEventLog':
properties:
target:
description: Link to invoke action
type: string
title:
description: Friendly action name
type: string
type: object
'#HpeRemoteSupport.CompleteDirectConnectRegistration':
properties:
target:
description: Link to invoke action
type: string
title:
description: Friendly action name
type: string
type: object
'#HpeRemoteSupport.DisableRemoteSupport':
properties:
target:
description: Link to invoke action
type: string
title:
description: Friendly action name
type: string
type: object
'#HpeRemoteSupport.RegisterDeviceToRemoteSupport':
properties:
ConnectionType@Redfish.AllowableValues:
description: The supported values for the ConnectionType parameter.
items:
description: 'Defined values are:
* `DirectConnect`
* `CentralConnect`
'
enum:
- DirectConnect
- CentralConnect
type: string
type: array
x-longDescription: The supported values for the ConnectionType parameter.
target:
description: Link to invoke action
type: string
title:
description: Friendly action name
type: string
type: object
'#HpeRemoteSupport.ServerMaintenance':
properties:
MaintenanceMode@Redfish.AllowableValues:
description: The supported values for the MaintenanceMode parameter.
items:
description: 'Defined values are:
* `Set`
* `Clear`
'
enum:
- Set
- Clear
type: string
type: array
x-longDescription: The supported values for the MaintenanceMode
parameter.
target:
description: Link to invoke action
type: string
title:
description: Friendly action name
type: string
type: object
'#HpeRemoteSupport.TriggerDataCollection':
properties:
DataType@Redfish.AllowableValues:
description: The supported values for the DataType parameter.
items:
description: 'Defined values are:
* `ActiveHealthSystemData`
* `L2CollectionData`
'
enum:
- ActiveHealthSystemData
- L2CollectionData
type: string
type: array
x-longDescription: The supported values for the DataType parameter.
target:
description: Link to invoke action
type: string
title:
description: Friendly action name
type: string
type: object
'#HpeRemoteSupport.TriggerTestEvent':
properties:
target:
description: Link to invoke action
type: string
title:
description: Friendly action name
type: string
type: object
type: object
ProxySettings:
description: Web proxy settings.
properties:
Password:
description: 'Password for web proxy server authentication. '
nullable: true
readOnly: false
type: string
Port:
description: 'Port number on which to communicate with the web proxy
server. '
nullable: true
readOnly: false
type: integer
Url:
description: Web proxy server host name or IP address.
format: url
readOnly: false
type: string
Username:
description: 'Username for web proxy server authentication. '
nullable: true
readOnly: false
type: string
readOnly: false
type: object
readOnly: false
type: object
HpeSNMPAlertDestination:
description: The alert destination configuration up to 8 remote management systems
that receive SNMP alerts from the management processor.
properties:
'@odata.context':
example: /$metadata#HpeSNMPAlertDestination.HpeSNMPAlertDestination
format: uri
readOnly: true
type: string
x-longDescription: The value of this property shall be the context URL that
describes the resource according to OData-Protocol and shall be of the
form defined in the SPMF specification.
'@odata.etag':
example: W/\87A82642\
readOnly: true
type: string
x-longDescription: The value of this property is the Etag of the resource.
'@odata.id':
example: /Managers/1/SnmpService/SNMPAlertDestinations/1/
format: uri
readOnly: true
type: string
x-longDescription: The value of this property shall be the unique identifier
for the resource and it shall be of the form defined in the SPMF specification.
'@odata.type':
example: '#HpeSNMPAlertDestination.v2_0_0.HpeSNMPAlertDestination'
readOnly: true
type: string
x-longDescription: The value of this property shall be an absolute URL that
specifies the type of the resource and it shall be of the form defined
in the SPMF specification.
AlertDestination:
description: The IP address or FQDN of remote management system that receive
SNMP alerts.
example: 192.168.7.60
readOnly: false
type: string
x-added: iLO 5 1.20
Id:
description: Uniquely identifies the resource within the collection of like
resources.
example: '1'
readOnly: true
type: string
x-added: iLO 5 1.20
x-longDescription: This property represents an identifier for the resource. All
values for resources described by this schema shall comply to the requirements
as described in the Redfish specification.
SNMPAlertProtocol:
description: 'Indicate the SNMP protocol associated with the AlertDestination.
Defined values are:
* `SNMPv1Trap`: Indicate SNMPv1 trap is enabled for the destination.
* `SNMPv3Trap`: Indicate SNMPv3 trap is enabled for the destination. Needs
to fill the SecurityName as well.
* `SNMPv3Inform`: Indicate SNMPv3 Inform is enabled for the destination.
Needs to fill the SecurityName as well.
'
enum:
- SNMPv1Trap
- SNMPv3Trap
- SNMPv3Inform
example: SNMPv1Trap
nullable: true
readOnly: false
type: string
x-added: iLO 5 1.20
SNMPv3User:
description: SNMPv3 User associated with the destination when SNMP alert
protocol is SNMPv3trap.
properties:
'@odata.id':
format: uri
readOnly: true
type: string
x-longDescription: The value of this property shall be the unique identifier
for the resource and it shall be of the form defined in the SPMF specification.
readOnly: true
type: object
x-added: iLO 5 1.20
SecurityName:
description: Provides the SNMPv3 security name associated with SNMPv3trap
or SNMPv3Inform set on SNMPAlertProtocol.
nullable: true
readOnly: false
type: string
x-added: iLO 5 1.20
TrapCommunity:
description: The configured SNMPv1 trap community string.
example: 2OBAL
readOnly: false
type: string
x-added: iLO 5 1.20
readOnly: false
type: object
HpeSNMPAlertDestination.Update:
description: The alert destination configuration up to 8 remote management systems
that receive SNMP alerts from the management processor.
properties:
AlertDestination:
description: The IP address or FQDN of remote management system that receive
SNMP alerts.
readOnly: false
type: string
SNMPAlertProtocol:
description: 'Indicate the SNMP protocol associated with the AlertDestination.
Defined values are:
* `SNMPv1Trap`: Indicate SNMPv1 trap is enabled for the destination.
* `SNMPv3Trap`: Indicate SNMPv3 trap is enabled for the destination. Needs
to fill the SecurityName as well.
* `SNMPv3Inform`: Indicate SNMPv3 Inform is enabled for the destination.
Needs to fill the SecurityName as well.
'
enum:
- SNMPv1Trap
- SNMPv3Trap
- SNMPv3Inform
nullable: true
readOnly: false
type: string
SecurityName:
description: Provides the SNMPv3 security name associated with SNMPv3trap
or SNMPv3Inform set on SNMPAlertProtocol.
nullable: true
readOnly: false
type: string
TrapCommunity:
description: The configured SNMPv1 trap community string.
readOnly: false
type: string
readOnly: false
type: object
HpeSNMPAlertDestinationCollection:
properties:
'@odata.context':
example: /$metadata#HpeSNMPAlertDestinationCollection.HpeSNMPAlertDestinationCollection
format: uri
readOnly: true
type: string
x-longDescription: The value of this property shall be the context URL that
describes the resource according to OData-Protocol and shall be of the
form defined in the SPMF specification.
'@odata.etag':
example: W/\D602A98A\
readOnly: true
type: string
x-longDescription: The value of this property is the Etag of the resource.
'@odata.id':
example: /Managers/1/SnmpService/SNMPAlertDestinations/
format: uri
readOnly: true
type: string
x-longDescription: The value of this property shall be the unique identifier
for the resource and it shall be of the form defined in the SPMF specification.
'@odata.type':
example: '#HpeSNMPAlertDestinationCollection.HpeSNMPAlertDestinationCollection'
readOnly: true
type: string
x-longDescription: The value of this property shall be an absolute URL that
specifies the type of the resource and it shall be of the form defined
in the SPMF specification.
Description:
description: Provides a description of this resource and is used for commonality in
the schema definitions.
example: SNMP Alert Destination Collection view
nullable: true
readOnly: true
type: string
x-longDescription: This object represents the Description property. All
values for resources described by this schema shall comply to the requirements
as described in the Redfish specification.
Members:
description: Contains the members of this collection.
items:
properties:
'@odata.id':
example: /Managers/1/SnmpService/SNMPAlertDestinations/1/
format: uri
readOnly: true
type: string
x-longDescription: The value of this property shall be the unique
identifier for the resource and it shall be of the form defined
in the SPMF specification.
type: object
readOnly: true
type: array
Members@odata.count:
description: The total number of collection members.
example: '8'
readOnly: true
type: integer
Name:
description: The name of the resource or array element.
example: SNMP Alert Destination Collection
readOnly: true
type: string
Oem:
description: This object represents the Oem property.
readOnly: true
x-longDescription: The value of this string shall be of the format for the
reserved word *Oem*.
type: object
HpeSNMPUser:
description: SNMPv3 supports the User-based Security Model (USM). With this
model, security parameters are configured at both the agent level and the
manager level. Messages exchanged between the agent and the manager are subject
to a data integrity check and data origin authentication. Up to 8 user profiles
are supported for setting SNMPv3 USM parameters.
properties:
'@odata.context':
example: /$metadata#HpeSNMPUser.HpeSNMPUser
format: uri
readOnly: true
type: string
x-longDescription: The value of this property shall be the context URL that
describes the resource according to OData-Protocol and shall be of the
form defined in the SPMF specification.
'@odata.etag':
example: W/\7E018899\
readOnly: true
type: string
x-longDescription: The value of this property is the Etag of the resource.
'@odata.id':
example: /Managers/1/SnmpService/SNMPUsers/1/
format: uri
readOnly: true
type: string
x-longDescription: The value of this property shall be the unique identifier
for the resource and it shall be of the form defined in the SPMF specification.
'@odata.type':
example: '#HpeSNMPUser.v2_1_0.HpeSNMPUser'
readOnly: true
type: string
x-longDescription: The value of this property shall be an absolute URL that
specifies the type of the resource and it shall be of the form defined
in the SPMF specification.
AuthPassphrase:
description: Sets the passphrase to use for sign operations. Enter a value
of 8 to 49 characters.
nullable: true
readOnly: false
type: string
x-added: iLO 5 1.20
AuthProtocol:
description: 'Sets the message digest algorithm to use for encoding the
authorization passphrase. The message digest is calculated over an appropriate
portion of an SNMP message, and is included as part of the message sent
to the recipient.
Defined values are:
* `MD5`: Indicate Message Digest Algorithm.
* `SHA`: Indicate Secure Hash Algorithm.
* `SHA256`: Indicate SHA256 Algorithm.
'
enum:
- MD5
- SHA
- SHA256
example: SHA
readOnly: false
type: string
x-added: iLO 5 1.20
Description:
description: Provides a description of this resource and is used for commonality in
the schema definitions.
nullable: true
readOnly: true
type: string
x-longDescription: This object represents the Description property. All
values for resources described by this schema shall comply to the requirements
as described in the Redfish specification.
Id:
description: Uniquely identifies the resource within the collection of like
resources.
example: '1'
readOnly: true
type: string
x-added: iLO 5 1.20
x-longDescription: This property represents an identifier for the resource. All
values for resources described by this schema shall comply to the requirements
as described in the Redfish specification.
PrivacyPassphrase:
description: Sets the passphrase to use for encrypt operations. Enter a
value of 8 to 49 characters.
nullable: true
readOnly: false
type: string
x-added: iLO 5 1.20
PrivacyProtocol:
description: 'Sets the encryption algorithm to use for encoding the privacy
passphrase. A portion of an SNMP message is encrypted before transmission.
Defined values are:
* `DES`: Indicate Data Encryption Standard Algorithm.
* `AES`: Indicate Advanced Encryption Standard Algorithm.
'
enum:
- DES
- AES
example: DES
readOnly: false
type: string
x-added: iLO 5 1.20
SecurityName:
description: The user profile name. Enter an alphanumeric string of 1 to
32 characters.
example: ZEh7JjCJ
nullable: true
readOnly: false
type: string
x-added: iLO 5 1.20
UserEngineID:
description: The UserEngineID is combined with the SecurityName to create
a SNMPv3 user for each manager. It is only used for creating remote accounts
used with INFORM messages. If this property is not set then INFORM message
will be sent with default or iLO configured engine ID. This value must
be a hexadecimal string with an even number of 10 to 64 characters, excluding
the first two characters, 0x (for example, 0x01020304abcdef).
example: 'null'
nullable: true
readOnly: false
type: string
x-added: iLO 5 1.20
readOnly: false
type: object
HpeSNMPUser.Update:
description: SNMPv3 supports the User-based Security Model (USM). With this
model, security parameters are configured at both the agent level and the
manager level. Messages exchanged between the agent and the manager are subject
to a data integrity check and data origin authentication. Up to 8 user profiles
are supported for setting SNMPv3 USM parameters.
properties:
AuthPassphrase:
description: Sets the passphrase to use for sign operations. Enter a value
of 8 to 49 characters.
nullable: true
readOnly: false
type: string
AuthProtocol:
description: 'Sets the message digest algorithm to use for encoding the
authorization passphrase. The message digest is calculated over an appropriate
portion of an SNMP message, and is included as part of the message sent
to the recipient.
Defined values are:
* `MD5`: Indicate Message Digest Algorithm.
* `SHA`: Indicate Secure Hash Algorithm.
* `SHA256`: Indicate SHA256 Algorithm.
'
enum:
- MD5
- SHA
- SHA256
readOnly: false
type: string
PrivacyPassphrase:
description: Sets the passphrase to use for encrypt operations. Enter a
value of 8 to 49 characters.
nullable: true
readOnly: false
type: string
PrivacyProtocol:
description: 'Sets the encryption algorithm to use for encoding the privacy
passphrase. A portion of an SNMP message is encrypted before transmission.
Defined values are:
* `DES`: Indicate Data Encryption Standard Algorithm.
* `AES`: Indicate Advanced Encryption Standard Algorithm.
'
enum:
- DES
- AES
readOnly: false
type: string
SecurityName:
description: The user profile name. Enter an alphanumeric string of 1 to
32 characters.
nullable: true
readOnly: false
type: string
UserEngineID:
description: The UserEngineID is combined with the SecurityName to create
a SNMPv3 user for each manager. It is only used for creating remote accounts
used with INFORM messages. If this property is not set then INFORM message
will be sent with default or iLO configured engine ID. This value must
be a hexadecimal string with an even number of 10 to 64 characters, excluding
the first two characters, 0x (for example, 0x01020304abcdef).
nullable: true
readOnly: false
type: string
readOnly: false
type: object
HpeSNMPUsersCollection:
properties:
'@odata.context':
example: /$metadata#HpeSNMPUsersCollection.HpeSNMPUsersCollection
format: uri
readOnly: true
type: string
x-longDescription: The value of this property shall be the context URL that
describes the resource according to OData-Protocol and shall be of the
form defined in the SPMF specification.
'@odata.etag':
example: W/\AA6D42B0\
readOnly: true
type: string
x-longDescription: The value of this property is the Etag of the resource.
'@odata.id':
example: /Managers/1/SnmpService/SNMPUsers/
format: uri
readOnly: true
type: string
x-longDescription: The value of this property shall be the unique identifier
for the resource and it shall be of the form defined in the SPMF specification.
'@odata.type':
example: '#HpeSNMPUsersCollection.HpeSNMPUsersCollection'
readOnly: true
type: string
x-longDescription: The value of this property shall be an absolute URL that
specifies the type of the resource and it shall be of the form defined
in the SPMF specification.
Description:
description: Provides a description of this resource and is used for commonality in
the schema definitions.
example: SNMPv3 Users Collection view
nullable: true
readOnly: true
type: string
x-longDescription: This object represents the Description property. All
values for resources described by this schema shall comply to the requirements
as described in the Redfish specification.
Members:
description: Contains the members of this collection.
items:
properties:
'@odata.id':
example: /Managers/1/SnmpService/SNMPUsers/1/
format: uri
readOnly: true
type: string
x-longDescription: The value of this property shall be the unique
identifier for the resource and it shall be of the form defined
in the SPMF specification.
type: object
readOnly: true
type: array
Members@odata.count:
description: The total number of collection members.
example: '1'
readOnly: true
type: integer
Name:
description: The name of the resource or array element.
example: SNMPv3 User Collection
readOnly: true
type: string
Oem:
description: This object represents the Oem property.
readOnly: true
x-longDescription: The value of this string shall be of the format for the
reserved word *Oem*.
type: object
HpeSecurityService:
properties:
'@odata.context':
example: /$metadata#HpeSecurityService.HpeSecurityService
format: uri
readOnly: true
type: string
x-longDescription: The value of this property shall be the context URL that
describes the resource according to OData-Protocol and shall be of the
form defined in the SPMF specification.
'@odata.etag':
example: W/\17B123B4\""
readOnly: true
type: string
x-longDescription: The value of this property is the Etag of the resource.
'@odata.id':
example: /Managers/1/SecurityService/
format: uri
readOnly: true
type: string
x-longDescription: The value of this property shall be the unique identifier
for the resource and it shall be of the form defined in the SPMF specification.
'@odata.type':
example: '#HpeSecurityService.v2_2_0.HpeSecurityService'
readOnly: true
type: string
x-longDescription: The value of this property shall be an absolute URL that
specifies the type of the resource and it shall be of the form defined
in the SPMF specification.
CurrentCipher:
description: Current cipher in use.
example: ECDHE-RSA-AES256-GCM-SHA384
readOnly: true
type: string
x-added: iLO 5 1.15
Id:
description: Uniquely identifies the resource within the collection of like
resources.
example: SecurityService
readOnly: true
type: string
x-added: iLO 5 1.10
x-longDescription: This property represents an identifier for the resource. All
values for resources described by this schema shall comply to the requirements
as described in the Redfish specification.
Links:
description: The links array contains the links to other resources that
are related to this resource.
properties:
CertAuth:
description: The value of this property shall be a reference to a resource
of Type HpeCertAuth.
properties:
'@odata.id':
example: /Managers/1/SecurityService/CertificateAuthentication/
format: uri
readOnly: true
type: string
x-longDescription: The value of this property shall be the unique
identifier for the resource and it shall be of the form defined
in the SPMF specification.
readOnly: true
type: object
x-added: iLO 5 1.10
ESKM:
description: The value of this property shall be a reference to a resource
of Type HpeESKM.
properties:
'@odata.id':
example: /Managers/1/SecurityService/ESKM/
format: uri
readOnly: true
type: string
x-longDescription: The value of this property shall be the unique
identifier for the resource and it shall be of the form defined
in the SPMF specification.
readOnly: true
type: object
x-added: iLO 5 1.10
HttpsCert:
description: The value of this property shall be a reference to a resource
of Type HpeHttpsCert.
properties:
'@odata.id':
example: /Managers/1/SecurityService/HttpsCert/
format: uri
readOnly: true
type: string
x-longDescription: The value of this property shall be the unique
identifier for the resource and it shall be of the form defined
in the SPMF specification.
readOnly: true
type: object
x-added: iLO 5 1.10
SSO:
description: The value of this property shall be a reference to a resource
of Type HpeiLOSSO.
properties:
'@odata.id':
example: /Managers/1/SecurityService/SSO/
format: uri
readOnly: true
type: string
x-longDescription: The value of this property shall be the unique
identifier for the resource and it shall be of the form defined
in the SPMF specification.
readOnly: true
type: object
x-added: iLO 5 1.10
SecurityDashboard:
description: The value of this property shall be a reference to a resource
of Type HpeiLOSecurityDashboard.
properties:
'@odata.id':
example: /Managers/1/SecurityService/SecurityDashboard/
format: uri
readOnly: true
type: string
x-longDescription: The value of this property shall be the unique
identifier for the resource and it shall be of the form defined
in the SPMF specification.
readOnly: true
type: object
x-added: iLO 5 1.40
type: object
x-added: iLO 5 1.10
LoginSecurityBanner:
description: This object describes the security banner displayed on the
iLO login page.
properties:
IsEnabled:
description: Login security banner is enabled or not.
example: 'false'
readOnly: false
type: boolean
x-added: iLO 5 1.15
SecurityMessage:
description: Text message to appear on the iLO login page when login
security banner is enabled.
readOnly: false
type: string
x-added: iLO 5 1.15
readOnly: false
type: object
x-added: iLO 5 1.15
SSHHostKey:
description: SSH Host Key identifying the service.
example: ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQC9yNrbozG0DPFqP++nW0w0t2wv2VHpDOeWyWeg/cLlDdFvlZ35qftrydBg2RdombolCYzkLDzAxG5ly8GI0RXN2poW+Qg9An4uHNcre93DPraeTe+ppPEXTR0dCJgwjTcypop9YUubIFpbXO+8KGVzGMixvI0dGKAwykeV4zBMe3+tlA8mLH0etYp3PrPdHc1J9cFhlzCNH5ughSCVO6OWJZHVN07e8neCewa0S0r29Ld4slP5F50LTiLOM2apQAPAmpTR3skfjDY17KowKU9S9Jnj9crrPxBRpIXvijxWqGoZFbF07TrmNeFXMqhEk74k2VL/Qr0s3rtNzMTcYIst
readOnly: true
type: string
x-added: iLO 5 1.40
SecurityState:
description: 'The operational security level of this Manager.
Defined values are:
* `Wipe`: Manager is currently wiping security related content and returning
to a lower security mode. This state will transition automatically when
finished.
* `Production`: Manager is operating in a normal security mode. Default
state for new systems.
* `HighSecurity`: Manager is operating in high security mode, requiring
extra authentication on host interface(s), and stronger encryption on
network interfaces.
* `FIPS`: Similar to High Security. This mode is intended to meet the
FIPS 140-2 level 1 and Common Criteria security requirements. A reset
to defaults is required to exit this mode.
* `CNSA`: Same as FIPS. Additionally meets the criteria for NSA Commercial
National Security Algorithm suite. Must be in FIPS mode to transition
to CNSA.
* `SuiteB`: Same as FIPS. Additionally meets the criteria for NSA SuiteB
Top Secret installations. Must be in FIPS mode to transition to SuiteB.
* `SynergySecurityMode`: Synergy Security Mode is the mode supported by
the Synergy Composer.
'
enum:
- Wipe
- Production
- HighSecurity
- FIPS
- CNSA
- SuiteB
- SynergySecurityMode
example: Factory
readOnly: false
type: string
x-added: iLO 5 1.10
x-longDescription: The operational security level of this Manager. The valid
values for this property are specified through the Redfish.AllowableValues
annotation.
SecurityState@Redfish.AllowableValues:
description: The supported values for the SecurityState parameter.
items:
description: 'Defined values are:
* `Wipe`
* `Production`
* `HighSecurity`
* `FIPS`
* `CNSA`
* `SuiteB`
'
enum:
- Wipe
- Production
- HighSecurity
- FIPS
- CNSA
- SuiteB
type: string
type: array
x-added: iLO 5 1.10
x-longDescription: The supported values for the SecurityState parameter.
readOnly: false
type: object
HpeSecurityService.Update:
properties:
LoginSecurityBanner:
description: This object describes the security banner displayed on the
iLO login page.
properties:
IsEnabled:
description: Login security banner is enabled or not.
readOnly: false
type: boolean
SecurityMessage:
description: Text message to appear on the iLO login page when login
security banner is enabled.
readOnly: false
type: string
readOnly: false
type: object
SecurityState:
description: 'The operational security level of this Manager.
Defined values are:
* `Wipe`: Manager is currently wiping security related content and returning
to a lower security mode. This state will transition automatically when
finished.
* `Production`: Manager is operating in a normal security mode. Default
state for new systems.
* `HighSecurity`: Manager is operating in high security mode, requiring
extra authentication on host interface(s), and stronger encryption on
network interfaces.
* `FIPS`: Similar to High Security. This mode is intended to meet the
FIPS 140-2 level 1 and Common Criteria security requirements. A reset
to defaults is required to exit this mode.
* `CNSA`: Same as FIPS. Additionally meets the criteria for NSA Commercial
National Security Algorithm suite. Must be in FIPS mode to transition
to CNSA.
* `SuiteB`: Same as FIPS. Additionally meets the criteria for NSA SuiteB
Top Secret installations. Must be in FIPS mode to transition to SuiteB.
* `SynergySecurityMode`: Synergy Security Mode is the mode supported by
the Synergy Composer.
'
enum:
- Wipe
- Production
- HighSecurity
- FIPS
- CNSA
- SuiteB
- SynergySecurityMode
readOnly: false
type: string
x-longDescription: The operational security level of this Manager. The valid
values for this property are specified through the Redfish.AllowableValues
annotation.
SecurityState@Redfish.AllowableValues:
description: The supported values for the SecurityState parameter.
items:
description: 'Defined values are:
* `Wipe`
* `Production`
* `HighSecurity`
* `FIPS`
* `CNSA`
* `SuiteB`
'
enum:
- Wipe
- Production
- HighSecurity
- FIPS
- CNSA
- SuiteB
type: string
type: array
x-longDescription: The supported values for the SecurityState parameter.
readOnly: false
type: object
HpeServerAccHddService:
properties:
'@odata.context':
format: uri
readOnly: true
type: string
x-longDescription: The value of this property shall be the context URL that
describes the resource according to OData-Protocol and shall be of the
form defined in the SPMF specification.
'@odata.etag':
readOnly: true
type: string
x-longDescription: The value of this property is the Etag of the resource.
'@odata.id':
format: uri
readOnly: true
type: string
x-longDescription: The value of this property shall be the unique identifier
for the resource and it shall be of the form defined in the SPMF specification.
'@odata.type':
readOnly: true
type: string
x-longDescription: The value of this property shall be an absolute URL that
specifies the type of the resource and it shall be of the form defined
in the SPMF specification.
BackplaneInfo:
deprecated: true
properties:
EndBay:
description: Represents a ending number of the bay.
readOnly: true
type: integer
x-added: iLO 5 1.20
FirmwareRevision:
description: Indicates the firmware revision in ASCII value.
readOnly: true
type: string
x-added: iLO 5 1.20
HostPortsInfo:
items:
description: Contains host ports information.
properties:
NodeNumber:
description: Represents the node number of compute node attached
to host port x in SEP.
readOnly: true
type: integer
x-added: iLO 5 1.20
PortNumber:
description: Represents the number of physical host ports in SEP.
readOnly: true
type: integer
x-added: iLO 5 1.20
SlotNumber:
description: Represents the slot number of SAS attached to host
port x in SEP.
readOnly: true
type: integer
x-added: iLO 5 1.20
readOnly: true
type: object
readOnly: true
type: array
x-added: iLO 5 1.20
Name:
description: Displays the Backplane Name as read from chassis manager.
readOnly: true
type: string
x-added: iLO 5 1.20
SEPID:
description: Indicates the storage enclosure processor ID.
readOnly: true
type: integer
x-added: iLO 5 1.20
SEPNodeId:
description: The node ID represent the node ID where the storage enclosure
processor is residing.
readOnly: true
type: integer
x-added: iLO 5 1.20
StartBay:
description: Represents a starting number of the bay.
readOnly: true
type: integer
x-added: iLO 5 1.20
TotalBays:
description: Total bay count represents the number of bays attached
to the SEP.
readOnly: true
type: integer
x-added: iLO 5 1.20
TypeID:
description: Indicates the Backplane type ID for the identifier for
backplane type.
readOnly: true
type: integer
x-added: iLO 5 1.20
WWID:
description: Represents a unique world wide ID defining a SEP.
readOnly: true
type: string
x-added: iLO 5 1.20
readOnly: false
type: object
x-added: iLO 5 1.20
Description:
description: Provides a description of this resource and is used for commonality in
the schema definitions.
nullable: true
readOnly: true
type: string
x-longDescription: This object represents the Description property. All
values for resources described by this schema shall comply to the requirements
as described in the Redfish specification.
Id:
description: Uniquely identifies the resource within the collection of like
resources.
readOnly: true
type: string
x-added: iLO 5 1.20
x-longDescription: This property represents an identifier for the resource. All
values for resources described by this schema shall comply to the requirements
as described in the Redfish specification.
Links:
description: THE URIs for the resources related to the Hdd zone resource.
properties:
Zone:
description: A link to the Hdd Zone resource which associated with Apollo
chassis controller.
properties:
'@odata.id':
format: uri
readOnly: true
type: string
x-longDescription: The value of this property shall be the unique
identifier for the resource and it shall be of the form defined
in the SPMF specification.
readOnly: true
type: object
x-added: iLO 5 1.20
readOnly: true
type: object
x-added: iLO 5 1.20
Name:
description: The name of the resource or array element.
readOnly: true
type: string
x-added: iLO 5 1.20
readOnly: false
type: object
HpeServerAccHddZone:
properties:
'@odata.context':
format: uri
readOnly: true
type: string
x-longDescription: The value of this property shall be the context URL that
describes the resource according to OData-Protocol and shall be of the
form defined in the SPMF specification.
'@odata.etag':
readOnly: true
type: string
x-longDescription: The value of this property is the Etag of the resource.
'@odata.id':
format: uri
readOnly: true
type: string
x-longDescription: The value of this property shall be the unique identifier
for the resource and it shall be of the form defined in the SPMF specification.
'@odata.type':
readOnly: true
type: string
x-longDescription: The value of this property shall be an absolute URL that
specifies the type of the resource and it shall be of the form defined
in the SPMF specification.
Actions:
properties:
'#HpeServerAccHddZone.ConfigureZone':
properties:
HostPort@Redfish.AllowableValues:
description: Fill HostPort array to depoly Hdd Zone configuration
or fill empty HostPort to remove Hdd Zone configuration.
items:
readOnly: false
type: array
target:
description: Link to invoke action
type: string
title:
description: Friendly action name
type: string
type: object
'#HpeServerAccHddZone.LoadDefault':
properties:
target:
description: Link to invoke action
type: string
title:
description: Friendly action name
type: string
type: object
type: object
CurrentZoneConfiguration:
deprecated: true
properties:
HostPort:
description: Contains the bay configuration for each HostPort.
items:
properties:
BayNumber:
description: Indicates the physical bay number.
items:
readOnly: true
type: integer
readOnly: false
type: array
x-added: iLO 5 1.20
PortNumber:
description: Represents the number of physical host ports in SEP,
null represents unassigned bay group.
nullable: true
readOnly: true
type: integer
x-added: iLO 5 1.20
type: object
readOnly: true
type: array
x-added: iLO 5 1.20
readOnly: false
type: object
x-added: iLO 5 1.20
Id:
description: Uniquely identifies the resource within the collection of like
resources.
readOnly: true
type: string
x-added: iLO 5 1.20
x-longDescription: This property represents an identifier for the resource. All
values for resources described by this schema shall comply to the requirements
as described in the Redfish specification.
Name:
description: The name of the resource or array element.
readOnly: true
type: string
x-added: iLO 5 1.20
PendingZoneConfiguration:
deprecated: true
properties:
HostPort:
description: Contains the bay configuration for each HostPort.
items:
properties:
BayNumber:
description: Indicates the physical bay number.
items:
readOnly: true
type: integer
readOnly: false
type: array
x-added: iLO 5 1.20
PortNumber:
description: Represents the number of physical host ports in SEP,
null represents unassigned bay group.
nullable: true
readOnly: true
type: integer
x-added: iLO 5 1.20
type: object
readOnly: true
type: array
x-added: iLO 5 1.20
readOnly: false
type: object
x-added: iLO 5 1.20
SEPNodeId:
description: The node ID represent the node ID where the storage enclosure
processor is residing.
readOnly: true
type: integer
x-added: iLO 5 1.20
TypeID:
description: Indicates the Backplane type ID for the identifier for backplane
type.
readOnly: true
type: integer
x-added: iLO 5 1.20
readOnly: true
type: object
HpeServerAccHddZone.ConfigureZone:
properties:
HostPort:
items:
properties:
BayNumber:
items:
readOnly: true
type: integer
readOnly: false
type: array
PortNumber:
nullable: true
readOnly: false
type: integer
readOnly: true
type: object
readOnly: false
type: array
type: object
HpeServerAccHddZone.LoadDefault:
properties: {}
type: object
HpeServerAccPowerCalibration:
properties:
'@odata.context':
format: uri
readOnly: true
type: string
x-longDescription: The value of this property shall be the context URL that
describes the resource according to OData-Protocol and shall be of the
form defined in the SPMF specification.
'@odata.etag':
readOnly: true
type: string
x-longDescription: The value of this property is the Etag of the resource.
'@odata.id':
format: uri
readOnly: true
type: string
x-longDescription: The value of this property shall be the unique identifier
for the resource and it shall be of the form defined in the SPMF specification.
'@odata.type':
readOnly: true
type: string
x-longDescription: The value of this property shall be an absolute URL that
specifies the type of the resource and it shall be of the form defined
in the SPMF specification.
Actions:
properties:
'#HpeServerAccPowerCalibration.Calibrate':
properties:
ActionType@Redfish.AllowableValues:
description: The supported values for the ActionType parameter.
items:
description: 'Defined values are:
* `Start`
* `Stop`
'
enum:
- Start
- Stop
type: string
type: array
x-longDescription: The supported values for the ActionType parameter.
AllZone@Redfish.AllowableValues:
description: If All Zones is set to 'true', the ZoneNumber will
be discarded. Chassis manager will calibrate for all zones and
derive the minimum and maximum power limit setpoints which is
available in PowerLimit URI. If All Zones is set to 'false', the
ZoneNumber will be take effect. Chassis manager will calibrate
for specific zone and derive the throttle peak power data from
0% - 100% which is available in Calibration URI.
items:
readOnly: true
type: boolean
type: array
EEPROMSaveEnabled@Redfish.AllowableValues:
description: To save the calibration data to EEPROM or not.
items:
readOnly: true
type: boolean
type: array
Seconds@Redfish.AllowableValues:
description: The calibration time.
items:
readOnly: true
type: integer
type: array
ZoneNumber@Redfish.AllowableValues:
description: The zone number either on the entire chassis or specific
zone. 0 for entire chassis, other number is for specific zone.
items:
readOnly: true
type: integer
type: array
target:
description: Link to invoke action
type: string
title:
description: Friendly action name
type: string
type: object
type: object
CalibrationData:
deprecated: true
properties:
EndTime:
description: The calibration end time stamp.
readOnly: true
type: string
x-added: iLO 5 1.20
StartTime:
description: The calibration start time stamp.
readOnly: true
type: string
x-added: iLO 5 1.20
State:
description: Specifies whether the calibration is valid or not.
readOnly: true
type: boolean
x-added: iLO 5 1.20
ThrottlePeakPower:
deprecated: true
properties:
Percent_000:
description: The peak power of 0 Percent throttling.
readOnly: true
type: integer
x-added: iLO 5 1.20
Percent_005:
description: The peak power of 5 Percent throttling.
readOnly: true
type: integer
x-added: iLO 5 1.20
Percent_010:
description: The peak power of 10 Percent throttling.
readOnly: true
type: integer
x-added: iLO 5 1.20
Percent_015:
description: The peak power of 15 Percent throttling.
readOnly: true
type: integer
x-added: iLO 5 1.20
Percent_020:
description: The peak power of 20 Percent throttling.
readOnly: true
type: integer
x-added: iLO 5 1.20
Percent_025:
description: The peak power of 25 Percent throttling.
readOnly: true
type: integer
x-added: iLO 5 1.20
Percent_030:
description: The peak power of 30 Percent throttling.
readOnly: true
type: integer
x-added: iLO 5 1.20
Percent_035:
description: The peak power of 35 Percent throttling.
readOnly: true
type: integer
x-added: iLO 5 1.20
Percent_040:
description: The peak power of 40 Percent throttling.
readOnly: true
type: integer
x-added: iLO 5 1.20
Percent_045:
description: The peak power of 45 Percent throttling.
readOnly: true
type: integer
x-added: iLO 5 1.20
Percent_050:
description: The peak power of 50 Percent throttling.
readOnly: true
type: integer
x-added: iLO 5 1.20
Percent_055:
description: The peak power of 55 Percent throttling.
readOnly: true
type: integer
x-added: iLO 5 1.20
Percent_060:
description: The peak power of 60 Percent throttling.
readOnly: true
type: integer
x-added: iLO 5 1.20
Percent_065:
description: The peak power of 65 Percent throttling.
readOnly: true
type: integer
x-added: iLO 5 1.20
Percent_070:
description: The peak power of 70 Percent throttling.
readOnly: true
type: integer
x-added: iLO 5 1.20
Percent_075:
description: The peak power of 75 Percent throttling.
readOnly: true
type: integer
x-added: iLO 5 1.20
Percent_080:
description: The peak power of 80 Percent throttling.
readOnly: true
type: integer
x-added: iLO 5 1.20
Percent_085:
description: The peak power of 85 Percent throttling.
readOnly: true
type: integer
x-added: iLO 5 1.20
Percent_090:
description: The peak power of 90 Percent throttling.
readOnly: true
type: integer
x-added: iLO 5 1.20
Percent_095:
description: The peak power of 95 Percent throttling.
readOnly: true
type: integer
x-added: iLO 5 1.20
Percent_100:
description: The peak power of 100 Percent throttling.
readOnly: true
type: integer
x-added: iLO 5 1.20
readOnly: false
type: object
x-added: iLO 5 1.20
ZoneNumber:
description: The zone number either on the entire chassis or specific
zone. 0 for entire chassis, other number is for specific zone.
readOnly: true
type: integer
x-added: iLO 5 1.20
readOnly: false
type: object
x-added: iLO 5 1.20
CalibrationInProgress:
description: The current state of the chassis power zone calibration task.
readOnly: true
type: boolean
x-added: iLO 5 1.20
Id:
description: Uniquely identifies the resource within the collection of like
resources.
readOnly: true
type: string
x-added: iLO 5 1.20
x-longDescription: This property represents an identifier for the resource. All
values for resources described by this schema shall comply to the requirements
as described in the Redfish specification.
Name:
description: The name of the resource or array element.
readOnly: true
type: string
x-added: iLO 5 1.20
readOnly: true
type: object
HpeServerAccPowerCalibration.Calibrate:
properties:
ActionType:
description: 'Defined values are:
* `Start`
* `Stop`
'
enum:
- Start
- Stop
type: string
AllZone:
readOnly: true
type: boolean
EEPROMSaveEnabled:
readOnly: true
type: boolean
Seconds:
readOnly: true
type: integer
ZoneNumber:
readOnly: true
type: integer
type: object
HpeServerAccPowerLimit:
properties:
'@odata.context':
format: uri
readOnly: true
type: string
x-longDescription: The value of this property shall be the context URL that
describes the resource according to OData-Protocol and shall be of the
form defined in the SPMF specification.
'@odata.etag':
readOnly: true
type: string
x-longDescription: The value of this property is the Etag of the resource.
'@odata.id':
format: uri
readOnly: true
type: string
x-longDescription: The value of this property shall be the unique identifier
for the resource and it shall be of the form defined in the SPMF specification.
'@odata.type':
readOnly: true
type: string
x-longDescription: The value of this property shall be an absolute URL that
specifies the type of the resource and it shall be of the form defined
in the SPMF specification.
Actions:
properties:
'#HpeServerAccPowerLimit.ConfigurePowerLimit':
properties:
PowerLimits@Redfish.AllowableValues:
description: The zone number either on the entire chassis or specific
zone. 0 is for entire chassis, other number is for specific zone.
items:
readOnly: false
type: array
target:
description: Link to invoke action
type: string
title:
description: Friendly action name
type: string
type: object
type: object
ActualPowerLimits:
items:
description: The list of actual PowerLimits.
properties:
PowerLimitInWatts:
description: The actual power limit (in watts) for the zone, it will
be set to null when power limit disabled.
nullable: true
readOnly: false
type: integer
x-added: iLO 5 1.20
ZoneNumber:
description: The zone number either on the entire chassis or specific
zone. 0 for entire chassis, other number is for specific zone.
readOnly: true
type: integer
x-added: iLO 5 1.20
readOnly: true
type: object
readOnly: true
type: array
x-added: iLO 5 1.20
Id:
description: Uniquely identifies the resource within the collection of like
resources.
readOnly: true
type: string
x-added: iLO 5 1.20
x-longDescription: This property represents an identifier for the resource. All
values for resources described by this schema shall comply to the requirements
as described in the Redfish specification.
Name:
description: The name of the resource or array element.
readOnly: true
type: string
x-added: iLO 5 1.20
PowerLimitRanges:
items:
description: The list of PowerLimitRanges.
properties:
MaximumPowerLimit:
description: The Maximum power limit (in watts) for the zone.
readOnly: true
type: integer
x-added: iLO 5 1.20
MinimumPowerLimit:
description: The Minimum power limit (in watts) for the zone.
readOnly: true
type: integer
x-added: iLO 5 1.20
ZoneNumber:
description: The zone number either on the entire chassis or specific
zone. 0 for entire chassis, other number is for specific zone.
readOnly: true
type: integer
x-added: iLO 5 1.20
readOnly: true
type: object
readOnly: true
type: array
x-added: iLO 5 1.20
PowerLimits:
items:
description: The list of target PowerLimits.
properties:
PowerLimitInWatts:
description: The target power limit (in watts) for the zone, it will
be set to null when power limit disabled.
nullable: true
readOnly: false
type: integer
x-added: iLO 5 1.20
ZoneNumber:
description: The zone number either on the entire chassis or specific
zone. 0 for entire chassis, other number is for specific zone.
readOnly: true
type: integer
x-added: iLO 5 1.20
readOnly: true
type: object
readOnly: true
type: array
x-added: iLO 5 1.20
readOnly: true
type: object
HpeServerAccPowerLimit.ConfigurePowerLimit:
properties:
PowerLimits:
items:
properties:
PowerLimitInWatts:
nullable: true
readOnly: false
type: integer
ZoneNumber:
readOnly: false
type: integer
readOnly: true
type: object
readOnly: false
type: array
type: object
HpeServerAccPowerNodesInfo:
properties:
'@odata.context':
format: uri
readOnly: true
type: string
x-longDescription: The value of this property shall be the context URL that
describes the resource according to OData-Protocol and shall be of the
form defined in the SPMF specification.
'@odata.etag':
readOnly: true
type: string
x-longDescription: The value of this property is the Etag of the resource.
'@odata.id':
format: uri
readOnly: true
type: string
x-longDescription: The value of this property shall be the unique identifier
for the resource and it shall be of the form defined in the SPMF specification.
'@odata.type':
readOnly: true
type: string
x-longDescription: The value of this property shall be an absolute URL that
specifies the type of the resource and it shall be of the form defined
in the SPMF specification.
Id:
description: Uniquely identifies the resource within the collection of like
resources.
readOnly: true
type: string
x-added: iLO 5 1.20
x-longDescription: This property represents an identifier for the resource. All
values for resources described by this schema shall comply to the requirements
as described in the Redfish specification.
MaxSupportedNodes:
description: Total Nodes supported in Chassis.
readOnly: true
type: integer
x-added: iLO 5 1.20
Name:
description: The name of the resource or array element.
readOnly: true
type: string
x-added: iLO 5 1.20
NodeInfoList:
items:
description: The list of nodes information.
properties:
NodeNumber:
description: The physical node number in chassis.
readOnly: true
type: integer
x-added: iLO 5 1.20
Throttle:
description: It indicates the current throttle on the node. (PWM %)
readOnly: true
type: integer
x-added: iLO 5 1.20
WarningStatus:
description: Specifies whether the node is in warning status or not.
WarningStatus indicates a node is over loading and chassis manager
force it throttle at 50% for 5 mins
readOnly: true
type: boolean
x-added: iLO 5 1.20
readOnly: true
type: object
readOnly: true
type: array
x-added: iLO 5 1.20
readOnly: true
type: object
HpeServerAccPowerService:
properties:
'@odata.context':
format: uri
readOnly: true
type: string
x-longDescription: The value of this property shall be the context URL that
describes the resource according to OData-Protocol and shall be of the
form defined in the SPMF specification.
'@odata.etag':
readOnly: true
type: string
x-longDescription: The value of this property is the Etag of the resource.
'@odata.id':
format: uri
readOnly: true
type: string
x-longDescription: The value of this property shall be the unique identifier
for the resource and it shall be of the form defined in the SPMF specification.
'@odata.type':
readOnly: true
type: string
x-longDescription: The value of this property shall be an absolute URL that
specifies the type of the resource and it shall be of the form defined
in the SPMF specification.
Description:
description: Provides a description of this resource and is used for commonality in
the schema definitions.
nullable: true
readOnly: true
type: string
x-longDescription: This object represents the Description property. All
values for resources described by this schema shall comply to the requirements
as described in the Redfish specification.
EEPROMSaveEnabled:
description: Determines whether the EEPROM save is enabled or disabled.
readOnly: false
type: boolean
x-added: iLO 5 1.20
Id:
description: Uniquely identifies the resource within the collection of like
resources.
readOnly: true
type: string
x-added: iLO 5 1.20
x-longDescription: This property represents an identifier for the resource. All
values for resources described by this schema shall comply to the requirements
as described in the Redfish specification.
Links:
description: Provides resource URIs under HPE Apollo Chassis Controller
Power Service.
properties:
Calibration:
description: A reference to the Calibration resource associated with
this Apollo chassis controller.
properties:
'@odata.id':
format: uri
readOnly: true
type: string
x-longDescription: The value of this property shall be the unique
identifier for the resource and it shall be of the form defined
in the SPMF specification.
readOnly: true
type: object
x-added: iLO 5 1.20
NodesInfo:
description: A reference to the NodesInfo associated with this Apollo
chassis controller.
properties:
'@odata.id':
format: uri
readOnly: true
type: string
x-longDescription: The value of this property shall be the unique
identifier for the resource and it shall be of the form defined
in the SPMF specification.
readOnly: true
type: object
x-added: iLO 5 1.20
PowerLimit:
description: A reference to the PowerLimit resource associated with
this Apollo chassis controller.
properties:
'@odata.id':
format: uri
readOnly: true
type: string
x-longDescription: The value of this property shall be the unique
identifier for the resource and it shall be of the form defined
in the SPMF specification.
readOnly: true
type: object
x-added: iLO 5 1.20
Zone:
description: A reference to the Zone resource associated with this Apollo
chassis controller.
properties:
'@odata.id':
format: uri
readOnly: true
type: string
x-longDescription: The value of this property shall be the unique
identifier for the resource and it shall be of the form defined
in the SPMF specification.
readOnly: true
type: object
x-added: iLO 5 1.20
readOnly: true
type: object
x-added: iLO 5 1.20
Name:
description: The name of the resource or array element.
readOnly: true
type: string
x-added: iLO 5 1.20
PowerRegulationEnabled:
description: Determines whether power regulation is enabled or disabled.
readOnly: false
type: boolean
x-added: iLO 5 1.20
PowerRegulatorMode:
description: 'Defined values are:
* `ACRedundancy`: AC Redundancy with Throttling Mode (Max Performance
w/ Redundancy).
* `UserConfig`: User Configurable Mode.
* `APM`: APM Power Regulator Mode. Cannot configure by iLO.
* `PowerFeedProtect`: Power Feed Protection Mode.
'
enum:
- ACRedundancy
- UserConfig
- APM
- PowerFeedProtect
readOnly: false
type: string
x-added: iLO 5 1.20
readOnly: false
type: object
HpeServerAccPowerService.Update:
properties:
EEPROMSaveEnabled:
description: Determines whether the EEPROM save is enabled or disabled.
readOnly: false
type: boolean
PowerRegulationEnabled:
description: Determines whether power regulation is enabled or disabled.
readOnly: false
type: boolean
PowerRegulatorMode:
description: 'Defined values are:
* `ACRedundancy`: AC Redundancy with Throttling Mode (Max Performance
w/ Redundancy).
* `UserConfig`: User Configurable Mode.
* `APM`: APM Power Regulator Mode. Cannot configure by iLO.
* `PowerFeedProtect`: Power Feed Protection Mode.
'
enum:
- ACRedundancy
- UserConfig
- APM
- PowerFeedProtect
readOnly: false
type: string
readOnly: false
type: object
HpeServerAccPowerZone:
properties:
'@odata.context':
format: uri
readOnly: true
type: string
x-longDescription: The value of this property shall be the context URL that
describes the resource according to OData-Protocol and shall be of the
form defined in the SPMF specification.
'@odata.etag':
readOnly: true
type: string
x-longDescription: The value of this property is the Etag of the resource.
'@odata.id':
format: uri
readOnly: true
type: string
x-longDescription: The value of this property shall be the unique identifier
for the resource and it shall be of the form defined in the SPMF specification.
'@odata.type':
readOnly: true
type: string
x-longDescription: The value of this property shall be an absolute URL that
specifies the type of the resource and it shall be of the form defined
in the SPMF specification.
Actions:
properties:
'#HpeServerAccPowerZone.ConfigureZone':
properties:
Zone@Redfish.AllowableValues:
description: Fill Zone array to depoly zone configuration or fill
empty Zone array to remove zone configuration.
items:
readOnly: false
type: array
target:
description: Link to invoke action
type: string
title:
description: Friendly action name
type: string
type: object
type: object
Id:
description: Uniquely identifies the resource within the collection of like
resources.
readOnly: true
type: string
x-added: iLO 5 1.20
x-longDescription: This property represents an identifier for the resource. All
values for resources described by this schema shall comply to the requirements
as described in the Redfish specification.
Name:
description: The name of the resource or array element.
readOnly: true
type: string
x-added: iLO 5 1.20
ZoneConfiguration:
deprecated: true
properties:
Zone:
description: Contains the zone configuration for each zone.
items:
properties:
Node:
description: Contains the node configuration for each node.
items:
properties:
NodeNumber:
description: The node number of zone configuration.
readOnly: true
type: integer
x-added: iLO 5 1.20
NodePriority:
description: The power regulation node priority, the range
must between 1 - 5. 5 is default and lowest priority.
readOnly: true
type: integer
x-added: iLO 5 1.20
readOnly: true
type: object
readOnly: true
type: array
x-added: iLO 5 1.20
ZoneNumber:
description: The zone number of zone configuration.
readOnly: true
type: integer
x-added: iLO 5 1.20
ZonePriority:
description: The power regulation zone priority, the range must
between 1 - 5. 5 is default and lowest priority.
readOnly: true
type: integer
x-added: iLO 5 1.20
type: object
readOnly: true
type: array
x-added: iLO 5 1.20
readOnly: false
type: object
x-added: iLO 5 1.20
readOnly: true
type: object
HpeServerAccPowerZone.ConfigureZone:
properties:
Zone:
items:
properties:
Node:
items:
properties:
NodeNumber:
readOnly: false
type: integer
NodePriority:
readOnly: false
type: integer
readOnly: true
type: object
readOnly: false
type: array
ZoneNumber:
readOnly: false
type: integer
ZonePriority:
readOnly: false
type: integer
readOnly: true
type: object
readOnly: false
type: array
type: object
HpeServerBootSettings:
description: The schema definition of the server UEFI Boot Order resource.
properties:
'@Redfish.Settings':
properties:
ETag:
description: The ETag of the resource to which the settings were applied,
after the application.
example: ''
nullable: true
readOnly: true
type: string
x-longDescription: The value of this property shall be the ETag of the
resource to which the settings were applied, after the application. This
is here so that the client can check it against the ETag of the current
resource to see if any other changes have also happened to the resource.
Messages:
description: This is an array of messages associated with the task.
items:
properties:
Message:
description: This is the human readable message, if provided.
nullable: true
type: string
x-longDescription: This property shall contain an optional human
readable message.
MessageArgs:
description: This array of message arguments are substituted for
the arguments in the message when looked up in the message registry.
items:
type: string
type: array
x-longDescription: This property shall contain the message substitution
arguments for the specific message referenced by the MessageId
and shall only be included if the MessageId is present.
MessageId:
description: This is the key for this message which can be used
to look up the message in a message registry.
example: Base.1.0.Success
type: string
x-longDescription: This property shall be a key into message registry
as described in the Redfish specification.
RelatedProperties:
description: This is an array of properties described by the message.
items:
type: string
type: array
x-longDescription: This property shall contain an array of JSON
Pointers indicating the properties described by the message,
if appropriate for the message.
Resolution:
description: Used to provide suggestions on how to resolve the
situation that caused the error.
nullable: true
type: string
x-longDescription: This property shall contain an override of
the Resolution of the message in message registry, if present.
Severity:
description: This is the severity of the errors.
nullable: true
type: string
x-longDescription: The value of this property shall be the severity
of the error, as defined in the Status section of the Redfish
specificaiton.
type: object
readOnly: true
type: array
x-longDescription: The value of this property shall be an array of messages
associated with the task.
SettingsObject:
description: Reference to the resource the client may PUT/PATCH to in
order to change this resource.
properties:
'@odata.id':
description: The unique identifier for a resource.
example: /systems/1/bios/boot/settings/
format: uri
readOnly: true
type: string
x-longDescription: The value of this property shall be the unique
identifier for the resource and it shall be of the form defined
in the Redfish specification.
readOnly: true
type: object
x-longDescription: The value of this property shall be the URI of the
resource to which a client must do a PUT or PATCh in order to modify
this resource.
Time:
description: Indicates the time the settings were applied.
example: 'null'
format: date-time
nullable: true
readOnly: true
type: string
x-longDescription: The value of this property shall indicate the time
that the settings object was applied to the resource.
type: object
'@odata.context':
description: The OData description of a payload.
example: /$metadata#HpeServerBootSettings.HpeServerBootSettings
format: uri
readOnly: true
type: string
x-longDescription: The value of this property shall be the context URL that
describes the resource according to OData-Protocol and shall be of the
form defined in the Redfish specification.
'@odata.etag':
example: W/\1CE4822A9D7EC2C2C27D761C9E463360\""
readOnly: true
type: string
x-longDescription: The value of this property is the Etag of the resource.
'@odata.id':
description: The unique identifier for a resource.
example: /systems/1/bios/boot/settings/
format: uri
readOnly: true
type: string
x-longDescription: The value of this property shall be the unique identifier
for the resource and it shall be of the form defined in the Redfish specification.
'@odata.type':
description: The type of a resource.
example: '#HpeServerBootSettings.v2_0_0.HpeServerBootSettings'
readOnly: true
type: string
x-longDescription: The value of this property shall be an absolute URL that
specifies the type of the resource and it shall be of the form defined
in the Redfish specification.
BootSources:
description: The array of UEFI boot sources available on this server. Each
entry is a UEFI boot option.
items:
properties:
BootString:
description: User-readable string that describes the UEFI boot option.
example: Generic USB Boot
type: string
CorrelatableID:
description: Contains any CorrelatableIDs that represent this boot
option. The correlatableID values can be JSON Pointers or UEFI identifiers.
example: UsbClass(0xFFFF,0xFFFF,0xFF,0xFF,0xFF)
type: string
StructuredBootString:
description: Uniquely identifies this boot option within the server.
example: Generic.USB.1.1
type: string
UEFIDevicePath:
description: Standardized text representation of the UEFI device path
for this boot option, in UTF-8 format.
example: UsbClass(0xFFFF,0xFFFF,0xFF,0xFF,0xFF)
type: string
type: object
readOnly: true
type: array
DefaultBootOrder:
description: The ordered array of default UEFI boot order device types.
This is used to define the order in which UEFI boot order is reset to
when a default configuration is requested.
items:
description: 'Default UEFI boot order device type. This is used to define
the order in which UEFI boot order is reset to when a default configuration
is requested.
Defined values are:
* `UefiShell`
* `Floppy`
* `Cd`
* `Usb`
* `EmbeddedStorage`
* `PcieSlotStorage`
* `EmbeddedFlexLOM`
* `PcieSlotNic`
'
enum:
- UefiShell
- Floppy
- Cd
- Usb
- EmbeddedStorage
- PcieSlotStorage
- EmbeddedFlexLOM
- PcieSlotNic
type: string
readOnly: false
type: array
DesiredBootDevices:
description: The ordered array of the desired UEFI boot devices. Users can
specify information about the desired UEFI boot devices, even if those
devices have not been discovered by BIOS or listed in BootSources array.
Setting this property will force the selected devices to move to the top
of the PersistentBootConfigOrder on next reboot. Currently, this array
is limited to 2 entries.
items:
properties:
CorrelatableID:
description: Standardized text representation of the UEFI device path
of the desired boot device, in UTF-8 format. For example 'PciRoot(0x0)/Pci(0x2,0x2)/Pci(0x0,0x0)'
example: ''
readOnly: false
type: string
Lun:
description: The Logical Unit Number (LUN) of the desired boot device.
This value must be a hexadecimal string with an even number of 2
to 16 characters, excluding the first two characters, 0x (for example,
'0x01').
example: ''
readOnly: false
type: string
Wwn:
description: The Fibre Channel World Wide Name (WWN) of the desired
boot device. This value must be a hexadecimal string with an even
number of 2 to 16 characters, excluding the first two characters,
0x (for example, '0x0001020304050607').
example: ''
readOnly: false
type: string
iScsiTargetName:
description: The iSCSI node target name of the desired boot device.
The value must be a string based on IETF RFC 3270, and can be up
to 223 characters in length (for example, 'iqn.1991-05.com.microsoft:iscsitarget-iscsidisk-target').
example: ''
readOnly: false
type: string
type: object
readOnly: false
type: array
Id:
description: Uniquely identifies the resource within the collection of like
resources.
example: settings
readOnly: true
type: string
x-longDescription: This property represents an identifier for the resource. All
values for resources described by this schema shall comply to the requirements
as described in the Redfish specification.
Name:
description: The name of the resource or array element.
example: Boot Order Pending Settings
readOnly: true
type: string
x-longDescription: This object represents the Name property. All values
for resources described by this schema shall comply to the requirements
as described in the Redfish specification. The value of this string shall
be of the format for the reserved word *Name*.
PersistentBootConfigOrder:
description: The ordered array of boot sources, representing the UEFI Boot
Order list. Each entry in the array is a structured boot string that references
a corresponding entry in the BootSources array.
items:
description: The structured boot string that references a corresponding
entry in the BootSources array.
type: string
readOnly: false
type: array
type: object
HpeServerBootSettings.Update:
description: The schema definition of the server UEFI Boot Order resource.
properties:
DefaultBootOrder:
description: The ordered array of default UEFI boot order device types.
This is used to define the order in which UEFI boot order is reset to
when a default configuration is requested.
items:
description: 'Default UEFI boot order device type. This is used to define
the order in which UEFI boot order is reset to when a default configuration
is requested.
Defined values are:
* `UefiShell`
* `Floppy`
* `Cd`
* `Usb`
* `EmbeddedStorage`
* `PcieSlotStorage`
* `EmbeddedFlexLOM`
* `PcieSlotNic`
'
enum:
- UefiShell
- Floppy
- Cd
- Usb
- EmbeddedStorage
- PcieSlotStorage
- EmbeddedFlexLOM
- PcieSlotNic
type: string
readOnly: false
type: array
DesiredBootDevices:
description: The ordered array of the desired UEFI boot devices. Users can
specify information about the desired UEFI boot devices, even if those
devices have not been discovered by BIOS or listed in BootSources array.
Setting this property will force the selected devices to move to the top
of the PersistentBootConfigOrder on next reboot. Currently, this array
is limited to 2 entries.
items:
properties:
CorrelatableID:
description: Standardized text representation of the UEFI device path
of the desired boot device, in UTF-8 format. For example 'PciRoot(0x0)/Pci(0x2,0x2)/Pci(0x0,0x0)'
readOnly: false
type: string
Lun:
description: The Logical Unit Number (LUN) of the desired boot device.
This value must be a hexadecimal string with an even number of 2
to 16 characters, excluding the first two characters, 0x (for example,
'0x01').
readOnly: false
type: string
Wwn:
description: The Fibre Channel World Wide Name (WWN) of the desired
boot device. This value must be a hexadecimal string with an even
number of 2 to 16 characters, excluding the first two characters,
0x (for example, '0x0001020304050607').
readOnly: false
type: string
iScsiTargetName:
description: The iSCSI node target name of the desired boot device.
The value must be a string based on IETF RFC 3270, and can be up
to 223 characters in length (for example, 'iqn.1991-05.com.microsoft:iscsitarget-iscsidisk-target').
readOnly: false
type: string
type: object
readOnly: false
type: array
PersistentBootConfigOrder:
description: The ordered array of boot sources, representing the UEFI Boot
Order list. Each entry in the array is a structured boot string that references
a corresponding entry in the BootSources array.
items:
description: The structured boot string that references a corresponding
entry in the BootSources array.
type: string
readOnly: false
type: array
type: object
HpeServerDevice:
properties:
'@odata.context':
example: /$metadata#HpeServerDevice.HpeServerDevice
format: uri
readOnly: true
type: string
x-longDescription: The value of this property shall be the context URL that
describes the resource according to OData-Protocol and shall be of the
form defined in the SPMF specification.
'@odata.etag':
example: W/\D368310B\""
readOnly: true
type: string
x-longDescription: The value of this property is the Etag of the resource.
'@odata.id':
example: /Chassis/1/Devices/1/
format: uri
readOnly: true
type: string
x-longDescription: The value of this property shall be the unique identifier
for the resource and it shall be of the form defined in the SPMF specification.
'@odata.type':
example: '#HpeServerDevice.v2_0_0.HpeServerDevice'
readOnly: true
type: string
x-longDescription: The value of this property shall be an absolute URL that
specifies the type of the resource and it shall be of the form defined
in the SPMF specification.
DeviceInstances:
description: An array of references to the instances or ports of this device.
items:
properties:
'@odata.id':
example: /Systems/1/PCIDevices/7/
format: uri
readOnly: true
type: string
x-longDescription: The value of this property shall be the unique
identifier for the resource and it shall be of the form defined
in the SPMF specification.
type: object
readOnly: true
type: array
DeviceType:
description: 'Device type.
Defined values are:
* `GPU`: GPU
* `PLX Controller`: PLX Controller (Bridge)
* `Expansion Riser`: Expansion Riser
* `Smart Storage`: Smart Storage
* `SAS/SATA Storage Controller`: SAS/SATA Storage Controller
* `IDE Storage controller`
* `USB Storage Controller`: USB Storage Controller
* `Storage Controller`: Storage Controller
* `LOM/NIC`: LOM/NIC
* `Converged Network Adapter`: Converged Network Adapter
* `Fibre Channel`: Fibre Channel
* `Direct Attached NVMe Device`: Direct Attached NVMe Device
* `Backplane PIC`: Backplane PIC
* `Smart Storage Battery`: Smart Storage Battery
* `USB`: Universal Serial Bus
* `TPM`: Trusted Platform Module
* `Communication Controller`: Communication Controller
* `Unknown`: Unknown Device Type
'
enum:
- GPU
- PLX Controller
- Expansion Riser
- Smart Storage
- SAS/SATA Storage Controller
- IDE Storage controller
- USB Storage Controller
- Storage Controller
- LOM/NIC
- Converged Network Adapter
- Fibre Channel
- Direct Attached NVMe Device
- Backplane PIC
- Smart Storage Battery
- USB
- TPM
- Communication Controller
- Unknown
example: LOM/NIC
readOnly: true
type: string
FirmwareVersion:
description: The schema definition for the current firmware version.
properties:
Current:
description: This object contains information about the version of a
firmware image.
properties:
VersionString:
description: This string represents the version of the firmware
image.
example: 16.24.1000
nullable: true
readOnly: true
type: string
readOnly: true
type: object
readOnly: true
type: object
Id:
description: Uniquely identifies the resource within the collection of like
resources.
example: '1'
readOnly: true
type: string
x-longDescription: This property represents an identifier for the resource. All
values for resources described by this schema shall comply to the requirements
as described in the Redfish specification.
Links:
description: The links array contains the related resource URIs.
properties:
PCISlots:
description: The PCI Slot associated with this device.
properties:
'@odata.id':
format: uri
readOnly: true
type: string
x-longDescription: The value of this property shall be the unique
identifier for the resource and it shall be of the form defined
in the SPMF specification.
readOnly: true
type: object
readOnly: true
type: object
Location:
description: Location of the device.
example: PCI-E Slot 1
nullable: true
readOnly: true
type: string
MCTPProtocolDisabled:
description: Set to true to disable MCTP on this slot. Once disabled, can
be enabled only through MCTP factory reset.
example: 'false'
readOnly: false
type: boolean
Manufacturer:
description: Device manufacturer.
example: HPE
nullable: true
readOnly: true
type: string
Name:
description: The name of the resource or array element.
example: HPE InfiniBand EDR 100Gb 1-port 841QSFP28 Adapter
readOnly: true
type: string
PartNumber:
description: Board part Number which is HPE PCA Assembly Number.
example: 878578-001
nullable: true
readOnly: true
type: string
ProductPartNumber:
description: Product Part Number.
example: 872725-B21
nullable: true
readOnly: true
type: string
ProductVersion:
description: Product Version.
example: '00'
nullable: true
readOnly: true
type: string
SerialNumber:
description: Product Serial Number.
example: xxxxxxxxxx
nullable: true
readOnly: true
type: string
Status:
properties:
Health:
description: 'This represents the health state of this resource in the
absence of its dependent resources.
Defined values are:
* `OK`: Normal
* `Warning`: A condition exists that requires attention
* `Critical`: A critical condition exists that requires immediate
attention
'
enum:
- OK
- Warning
- Critical
example: OK
nullable: true
readOnly: true
type: string
x-longDescription: This property shall represent the HealthState of
the resource without considering its dependent resources. The values
shall conform to those defined in the Redfish specification.
HealthRollup:
description: 'This represents the overall health state from the view
of this resource.
Defined values are:
* `OK`: Normal
* `Warning`: A condition exists that requires attention
* `Critical`: A critical condition exists that requires immediate
attention
'
enum:
- OK
- Warning
- Critical
nullable: true
readOnly: true
type: string
x-longDescription: This property shall represent the HealthState of
the resource and its dependent resources. The values shall conform
to those defined in the Redfish specification.
State:
description: 'This indicates the known state of the resource, such as
if it is enabled.
Defined values are:
* `Enabled`: This function or resource has been enabled.
* `Disabled`: This function or resource has been disabled.
* `StandbyOffline`: This function or resource is enabled, but awaiting
an external action to activate it.
* `StandbySpare`: This function or resource is part of a redundancy
set and is awaiting a failover or other external action to activate
it.
* `InTest`: This function or resource is undergoing testing.
* `Starting`: This function or resource is starting.
* `Absent`: This function or resource is not present or not detected.
* `UnavailableOffline`: This function or resource is present but cannot
be used.
* `Deferring`: The element will not process any commands but will
queue new requests.
* `Quiesced`: The element is enabled but only processes a restricted
set of commands.
* `Updating`: The element is updating and may be unavailable or degraded.
'
enum:
- Enabled
- Disabled
- StandbyOffline
- StandbySpare
- InTest
- Starting
- Absent
- UnavailableOffline
- Deferring
- Quiesced
- Updating
example: Enabled
nullable: true
readOnly: true
type: string
x-longDescription: This property shall represent if this component is
available or not and why. Enabled indicates the resource is available. Disabled
indicates the resource has been intentionally made unavailable but
it can be enabled. Offline indicates the resource is unavailable
intentionally and requires action to be made available. InTest indicates
that the component is undergoing testing. Starting indicates that
the resource is on its way to becoming available. Absent indicates
the resources is physically unavailable.
type: object
readOnly: true
type: object
HpeServerDeviceCollection:
properties:
'@odata.context':
example: /$metadata#HpeServerDeviceCollection.HpeServerDeviceCollection
format: uri
readOnly: true
type: string
x-longDescription: The value of this property shall be the context URL that
describes the resource according to OData-Protocol and shall be of the
form defined in the SPMF specification.
'@odata.etag':
example: W/\1E796226\""
readOnly: true
type: string
x-longDescription: The value of this property is the Etag of the resource.
'@odata.id':
example: /Chassis/1/Devices/
format: uri
readOnly: true
type: string
x-longDescription: The value of this property shall be the unique identifier
for the resource and it shall be of the form defined in the SPMF specification.
'@odata.type':
example: '#HpeServerDeviceCollection.HpeServerDeviceCollection'
readOnly: true
type: string
x-longDescription: The value of this property shall be an absolute URL that
specifies the type of the resource and it shall be of the form defined
in the SPMF specification.
Description:
description: Provides a description of this resource and is used for commonality in
the schema definitions.
example: Devices View
nullable: true
readOnly: true
type: string
x-longDescription: This object represents the Description property. All
values for resources described by this schema shall comply to the requirements
as described in the Redfish specification.
Members:
description: Contains the members of this collection.
items:
properties:
'@odata.id':
example: /Chassis/1/Devices/1/
format: uri
readOnly: true
type: string
x-longDescription: The value of this property shall be the unique
identifier for the resource and it shall be of the form defined
in the SPMF specification.
type: object
readOnly: true
type: array
Members@odata.count:
description: The total number of collection members.
example: '9'
readOnly: true
type: integer
Name:
description: The name of the resource or array element.
example: Devices
readOnly: true
type: string
Oem:
description: This object represents the Oem property.
readOnly: true
x-longDescription: The value of this string shall be of the format for the
reserved word *Oem*.
type: object
HpeServerPCISlot:
properties:
'@odata.context':
example: /$metadata#HpeServerPCISlot.HpeServerPCISlot
format: uri
readOnly: true
type: string
x-longDescription: The value of this property shall be the context URL that
describes the resource according to OData-Protocol and shall be of the
form defined in the SPMF specification.
'@odata.etag':
example: W/\91E05890\""
readOnly: true
type: string
x-longDescription: The value of this property is the Etag of the resource.
'@odata.id':
example: /Systems/1/PCISlots/1/
format: uri
readOnly: true
type: string
x-longDescription: The value of this property shall be the unique identifier
for the resource and it shall be of the form defined in the SPMF specification.
'@odata.type':
example: '#HpeServerPCISlot.v2_1_0.HpeServerPCISlot'
readOnly: true
type: string
x-longDescription: The value of this property shall be an absolute URL that
specifies the type of the resource and it shall be of the form defined
in the SPMF specification.
BusNumber:
description: PCI slot bus number.
example: '18'
readOnly: true
type: integer
x-added: iLO 5 1.20
Characteristics:
description: Characteristics of the slot.
properties:
Provides3_3Volts:
description: Provides 3.3 volts.
example: 'true'
readOnly: true
type: boolean
x-added: iLO 5 1.20
Provides5Volts:
description: Provides 5.0 volts.
readOnly: true
type: boolean
x-added: iLO 5 1.20
SlotIsShared:
description: The slot shares its opening with another slot.
readOnly: true
type: boolean
x-added: iLO 5 1.20
SupportsCardBus:
description: PC Card slot supports Card Bus.
readOnly: true
type: boolean
x-added: iLO 5 1.20
SupportsHotPlugDevices:
description: Slot supports hot-plug devices.
readOnly: true
type: boolean
x-added: iLO 5 1.20
SupportsModemRingResume:
description: PC Card slot supports Modem Ring Resume.
readOnly: true
type: boolean
x-added: iLO 5 1.20
SupportsPCCard16:
description: PC Card slot supports PC Card-16.
readOnly: true
type: boolean
x-added: iLO 5 1.20
SupportsPowerManagementEventSignal:
description: PCI slot supports Power Management Event signal.
example: 'true'
readOnly: true
type: boolean
x-added: iLO 5 1.20
SupportsSMBusSignal:
description: PCI slot supports SMBUS signal.
readOnly: true
type: boolean
x-added: iLO 5 1.20
SupportsZoomVideo:
description: PC Card slot supports Zoom Video.
readOnly: true
type: boolean
x-added: iLO 5 1.20
readOnly: true
type: object
x-added: iLO 5 1.20
DeviceNumber:
description: PCI slot device number.
example: '0'
readOnly: true
type: integer
x-added: iLO 5 1.20
FunctionNumber:
description: PCI slot function number.
example: '0'
readOnly: true
type: integer
x-added: iLO 5 1.20
Id:
description: Uniquely identifies the resource within the collection of like
resources.
example: '1'
readOnly: true
type: string
x-added: iLO 5 1.10
x-longDescription: This property represents an identifier for the resource. All
values for resources described by this schema shall comply to the requirements
as described in the Redfish specification.
Length:
description: 'PCI slot length
Defined values are:
* `Short`
* `Long`
* `Other`
'
enum:
- Short
- Long
- Other
example: Long
readOnly: true
type: string
x-added: iLO 5 1.10
LinkLanes:
description: 'Bandwidth capacity of the slot, measured by the number of
PCI Express Lanes present. Also known as the slot width.
Defined values are:
* `8 bit`
* `16 bit`
* `32 bit`
* `64 bit`
* `128 bit`
* `x1`
* `x2`
* `x4`
* `x8`
* `x16`
* `x32`
* `Other`
'
enum:
- 8 bit
- 16 bit
- 32 bit
- 64 bit
- 128 bit
- x1
- x2
- x4
- x8
- x16
- x32
- Other
example: x16
readOnly: true
type: string
x-added: iLO 5 1.10
Name:
description: The name of the resource or array element.
example: PCI-E Slot 1
readOnly: true
type: string
x-added: iLO 5 1.10
Status:
description: Status
properties:
EnabledState:
description: Specifies whether the slot is enabled or disabled.
readOnly: true
type: string
x-added: iLO 5 1.10
OperationalStatus:
description: Operational status
items:
properties:
Status:
description: 'Current usage status of the slot: InUse or Empty'
example: InUse
readOnly: true
type: string
x-added: iLO 5 1.10
type: object
readOnly: true
type: array
x-added: iLO 5 1.10
readOnly: true
type: object
x-added: iLO 5 1.10
SupportsHotPlug:
description: Specifies whether the slot supports hot-plug devices.
example: 'false'
readOnly: true
type: boolean
x-added: iLO 5 1.10
Technology:
description: 'PCI technology
Defined values are:
* `PCIExpressGen3`
* `PCIExpressGen2`
* `PCIExpress`
'
enum:
- PCIExpressGen3
- PCIExpressGen2
- PCIExpress
example: PCIExpressGen3
readOnly: true
type: string
x-added: iLO 5 1.10
UEFIDevicePath:
description: Standardized text representation of the UEFI device path, in
UTF-8 format
example: PciRoot(0x1)/Pci(0x0,0x0)/Pci(0x0,0x0)
readOnly: true
type: string
x-added: iLO 5 1.10
readOnly: true
type: object
HpeServerPCISlotCollection:
properties:
'@odata.context':
example: /$metadata#HpeServerPCISlotCollection.HpeServerPCISlotCollection
format: uri
readOnly: true
type: string
x-longDescription: The value of this property shall be the context URL that
describes the resource according to OData-Protocol and shall be of the
form defined in the SPMF specification.
'@odata.etag':
example: W/\C4D3BA70\""
readOnly: true
type: string
x-longDescription: The value of this property is the Etag of the resource.
'@odata.id':
example: /Systems/1/PCISlots/
format: uri
readOnly: true
type: string
x-longDescription: The value of this property shall be the unique identifier
for the resource and it shall be of the form defined in the SPMF specification.
'@odata.type':
example: '#HpeServerPCISlotCollection.HpeServerPCISlotCollection'
readOnly: true
type: string
x-longDescription: The value of this property shall be an absolute URL that
specifies the type of the resource and it shall be of the form defined
in the SPMF specification.
Description:
description: Provides a description of this resource and is used for commonality in
the schema definitions.
example: PciSlots view
nullable: true
readOnly: true
type: string
x-longDescription: This object represents the Description property. All
values for resources described by this schema shall comply to the requirements
as described in the Redfish specification.
Members:
description: Contains the members of this collection.
items:
properties:
'@odata.id':
example: /Systems/1/PCISlots/1/
format: uri
readOnly: true
type: string
x-longDescription: The value of this property shall be the unique
identifier for the resource and it shall be of the form defined
in the SPMF specification.
type: object
readOnly: true
type: array
Members@odata.count:
description: The total number of collection members.
example: '12'
readOnly: true
type: integer
Name:
description: The name of the resource or array element.
example: PciSlots
readOnly: true
type: string
Oem:
description: This object represents the Oem property.
readOnly: true
x-longDescription: The value of this string shall be of the format for the
reserved word *Oem*.
type: object
HpeServerPciDevice:
properties:
'@odata.context':
example: /$metadata#HpeServerPciDevice.HpeServerPciDevice
format: uri
readOnly: true
type: string
x-longDescription: The value of this property shall be the context URL that
describes the resource according to OData-Protocol and shall be of the
form defined in the SPMF specification.
'@odata.etag':
example: W/\76BB8A7C\""
readOnly: true
type: string
x-longDescription: The value of this property is the Etag of the resource.
'@odata.id':
example: /Systems/1/PCIDevices/7/
format: uri
readOnly: true
type: string
x-longDescription: The value of this property shall be the unique identifier
for the resource and it shall be of the form defined in the SPMF specification.
'@odata.type':
example: '#HpeServerPciDevice.v2_0_0.HpeServerPciDevice'
readOnly: true
type: string
x-longDescription: The value of this property shall be an absolute URL that
specifies the type of the resource and it shall be of the form defined
in the SPMF specification.
BayNumber:
description: Bay number value.
readOnly: true
type: integer
x-added: iLO 5 1.10
BusNumber:
description: PCI device bus number value.
example: '18'
readOnly: true
type: integer
x-added: iLO 5 1.10
ClassCode:
description: PCI class code of the endpoint.
example: '2'
readOnly: true
type: integer
x-added: iLO 5 1.10
DeviceID:
description: PCI device ID of the device.
example: '4119'
readOnly: true
type: integer
x-added: iLO 5 1.10
DeviceInstance:
description: PCI device instance value.
example: '1'
readOnly: true
type: integer
x-added: iLO 5 1.10
DeviceLocation:
description: PCI device location.
example: PCI-E Slot 1
readOnly: true
type: string
x-added: iLO 5 1.10
DeviceNumber:
description: PCI device number value.
example: '0'
readOnly: true
type: integer
x-added: iLO 5 1.10
DeviceSubInstance:
description: PCI device sub-instance value.
example: '1'
readOnly: true
type: integer
x-added: iLO 5 1.10
DeviceType:
description: 'Device type value.
Defined values are:
* `Flexible LOM`: Flexible LAN-On-Motherboard
* `Embedded LOM`: Embedded LAN-On-Motherboard
* `NIC`: Network Interface Controller
* `HDD Not attached to a SA Controller`: Hard Disk Drive
* `HDD Attached to a SA Controller`: Hard Disk Drive attached to an array
controller
* `Other PCI Device`: Other PCI Device
* `Unknown`: Unknown PCI Device
* `Other`: Other PCI Device
* `Video`: Video Controller
* `SCSI Controller`: SCSI Controller
* `Ethernet`: Ethernet Controller
* `Token Ring`: Token Ring Controller
* `Sound`: Sound Controller
* `PATA Controller`: Parallel ATA Controller
* `SATA Controller`: Serial ATA Controller
* `SAS Controller`: Serial Attached SCSI Controller
* `Storage Controller`: Storage Controller (not Smart Array)
* `Storage Array Controller`: Smart Array Storage Controller
* `USB Hard Disk Drive`: USB Hard Disk Drive
* `Firmware Volume`: Firmware Volume
* `UEFI Shell`: UEFI Shell
* `Generic UEFI USB Boot Entry`: Generic UEFI USB Boot Entry
* `Dynamic Storage Array Controller`: Dynamic Smart Array Controller
* `File`: File
* `NVMe Hard Drive`: NVMe Hard Drive
* `NVDIMM`: NVDIMM
'
enum:
- Flexible LOM
- Embedded LOM
- NIC
- HDD Not attached to a SA Controller
- HDD Attached to a SA Controller
- Other PCI Device
- Unknown
- Other
- Video
- SCSI Controller
- Ethernet
- Token Ring
- Sound
- PATA Controller
- SATA Controller
- SAS Controller
- Storage Controller
- Storage Array Controller
- USB Hard Disk Drive
- Firmware Volume
- UEFI Shell
- Generic UEFI USB Boot Entry
- Dynamic Storage Array Controller
- File
- NVMe Hard Drive
- NVDIMM
example: NIC
readOnly: true
type: string
x-added: iLO 5 1.10
EnclosureNumber:
description: Enclosure number value.
readOnly: true
type: integer
x-added: iLO 5 1.10
FunctionNumber:
description: PCI device function number value.
example: '0'
readOnly: true
type: integer
x-added: iLO 5 1.10
Id:
description: Uniquely identifies the resource within the collection of like
resources.
example: '7'
readOnly: true
type: string
x-added: iLO 5 1.10
x-longDescription: This property represents an identifier for the resource. All
values for resources described by this schema shall comply to the requirements
as described in the Redfish specification.
LocationString:
description: Text representation of the UEFI device location, in UTF-8 format
example: Slot 1
readOnly: true
type: string
x-added: iLO 5 1.10
Name:
description: The name of the resource or array element.
example: HPE InfiniBand EDR 100Gb 1-port 841QSFP28 Adapter - HCA
readOnly: true
type: string
x-added: iLO 5 1.10
SegmentNumber:
description: PCI segment group number value.
example: '0'
readOnly: true
type: integer
x-added: iLO 5 1.10
StructuredName:
description: PCI device structured name in UTF-8 format.
example: NIC.Slot.1.1
readOnly: true
type: string
x-added: iLO 5 1.10
SubclassCode:
description: PCI sub class code of the endpoint.
example: '7'
readOnly: true
type: integer
x-added: iLO 5 1.10
SubsystemDeviceID:
description: PCI subsystem device ID of the device.
example: '597'
readOnly: true
type: integer
x-added: iLO 5 1.10
SubsystemVendorID:
description: PCI subsystem vendor ID of the device.
example: '5520'
readOnly: true
type: integer
x-added: iLO 5 1.10
UEFIDevicePath:
description: Standardized text representation of the UEFI device path, in
UTF-8 format.
example: PciRoot(0x1)/Pci(0x0,0x0)/Pci(0x0,0x0)
readOnly: true
type: string
x-added: iLO 5 1.10
VendorID:
description: PCI vendor ID of the device.
example: '5555'
readOnly: true
type: integer
x-added: iLO 5 1.10
readOnly: true
type: object
HpeServerPciDeviceCollection:
properties:
'@odata.context':
example: /$metadata#HpeServerPciDeviceCollection.HpeServerPciDeviceCollection
format: uri
readOnly: true
type: string
x-longDescription: The value of this property shall be the context URL that
describes the resource according to OData-Protocol and shall be of the
form defined in the SPMF specification.
'@odata.etag':
example: W/\D4A4F174\""
readOnly: true
type: string
x-longDescription: The value of this property is the Etag of the resource.
'@odata.id':
example: /Systems/1/PCIDevices/
format: uri
readOnly: true
type: string
x-longDescription: The value of this property shall be the unique identifier
for the resource and it shall be of the form defined in the SPMF specification.
'@odata.type':
example: '#HpeServerPciDeviceCollection.HpeServerPciDeviceCollection'
readOnly: true
type: string
x-longDescription: The value of this property shall be an absolute URL that
specifies the type of the resource and it shall be of the form defined
in the SPMF specification.
Description:
description: Provides a description of this resource and is used for commonality in
the schema definitions.
example: ' PciDevices view'
nullable: true
readOnly: true
type: string
x-longDescription: This object represents the Description property. All
values for resources described by this schema shall comply to the requirements
as described in the Redfish specification.
Members:
description: Contains the members of this collection.
items:
properties:
'@odata.id':
example: /Systems/1/PCIDevices/1/
format: uri
readOnly: true
type: string
x-longDescription: The value of this property shall be the unique
identifier for the resource and it shall be of the form defined
in the SPMF specification.
type: object
readOnly: true
type: array
Members@odata.count:
description: The total number of collection members.
example: '18'
readOnly: true
type: integer
Name:
description: The name of the resource or array element.
example: PciDevices
readOnly: true
type: string
Oem:
description: This object represents the Oem property.
readOnly: true
x-longDescription: The value of this string shall be of the format for the
reserved word *Oem*.
type: object
HpeSmartStorage:
description: HpSmartStorage
properties:
'@odata.context':
example: /$metadata#HpeSmartStorage.HpeSmartStorage
format: uri
readOnly: true
type: string
x-longDescription: The value of this property shall be the context URL that
describes the resource according to OData-Protocol and shall be of the
form defined in the SPMF specification.
'@odata.etag':
example: W/\BEFCD4EA\""
readOnly: true
type: string
x-longDescription: The value of this property is the Etag of the resource.
'@odata.id':
example: /Systems/1/SmartStorage/
format: uri
readOnly: true
type: string
x-longDescription: The value of this property shall be the unique identifier
for the resource and it shall be of the form defined in the SPMF specification.
'@odata.type':
example: '#HpeSmartStorage.v2_0_0.HpeSmartStorage'
readOnly: true
type: string
x-longDescription: The value of this property shall be an absolute URL that
specifies the type of the resource and it shall be of the form defined
in the SPMF specification.
Description:
description: Provides a description of this resource and is used for commonality in
the schema definitions.
example: HPE Smart Storage
nullable: true
readOnly: true
type: string
x-longDescription: This object represents the Description property. All
values for resources described by this schema shall comply to the requirements
as described in the Redfish specification.
Id:
description: Uniquely identifies the resource within the collection of like
resources.
example: SmartStorage
readOnly: true
type: string
x-added: iLO 5 1.10
x-longDescription: This property represents an identifier for the resource. All
values for resources described by this schema shall comply to the requirements
as described in the Redfish specification.
Links:
description: The URIs to the resource related to HpSmartStorage
properties:
ArrayControllers:
description: link to collection of membertype HPESmartStorageArrayController.
All Smart HBAs, Smart Arrays and Dynamic Smart Array fall into this
category
properties:
'@odata.id':
example: /Systems/1/SmartStorage/ArrayControllers/
format: uri
readOnly: true
type: string
x-longDescription: The value of this property shall be the unique
identifier for the resource and it shall be of the form defined
in the SPMF specification.
readOnly: true
type: object
x-added: iLO 5 1.10
HostBusAdapters:
description: link to collection of membertype HPESmartStorageHostBusAdapter.
Typically HBAs/ChipSets from other vendors that don't use the SmartArray
brand
properties:
'@odata.id':
example: /Systems/1/SmartStorage/HostBusAdapters/
format: uri
readOnly: true
type: string
x-longDescription: The value of this property shall be the unique
identifier for the resource and it shall be of the form defined
in the SPMF specification.
readOnly: true
type: object
x-added: iLO 5 1.10
readOnly: true
type: object
x-added: iLO 5 1.10
Name:
description: The name of the resource or array element.
example: HpeSmartStorage
readOnly: true
type: string
x-added: iLO 5 1.10
Oem:
description: This object represents the Oem property.
readOnly: true
Status:
properties:
Health:
description: 'This represents the health state of this resource in the
absence of its dependent resources.
Defined values are:
* `OK`: Normal
* `Warning`: A condition exists that requires attention
* `Critical`: A critical condition exists that requires immediate
attention
'
enum:
- OK
- Warning
- Critical
example: OK
nullable: true
readOnly: true
type: string
x-added: iLO 5 1.10
x-longDescription: This property shall represent the HealthState of
the resource without considering its dependent resources. The values
shall conform to those defined in the Redfish specification.
HealthRollup:
description: 'This represents the overall health state from the view
of this resource.
Defined values are:
* `OK`: Normal
* `Warning`: A condition exists that requires attention
* `Critical`: A critical condition exists that requires immediate
attention
'
enum:
- OK
- Warning
- Critical
nullable: true
readOnly: true
type: string
x-added: iLO 5 1.10
x-longDescription: This property shall represent the HealthState of
the resource and its dependent resources. The values shall conform
to those defined in the Redfish specification.
State:
description: 'This indicates the known state of the resource, such as
if it is enabled.
Defined values are:
* `Enabled`: This function or resource has been enabled.
* `Disabled`: This function or resource has been disabled.
* `StandbyOffline`: This function or resource is enabled, but awaiting
an external action to activate it.
* `StandbySpare`: This function or resource is part of a redundancy
set and is awaiting a failover or other external action to activate
it.
* `InTest`: This function or resource is undergoing testing.
* `Starting`: This function or resource is starting.
* `Absent`: This function or resource is not present or not detected.
* `UnavailableOffline`: This function or resource is present but cannot
be used.
* `Deferring`: The element will not process any commands but will
queue new requests.
* `Quiesced`: The element is enabled but only processes a restricted
set of commands.
* `Updating`: The element is updating and may be unavailable or degraded.
'
enum:
- Enabled
- Disabled
- StandbyOffline
- StandbySpare
- InTest
- Starting
- Absent
- UnavailableOffline
- Deferring
- Quiesced
- Updating
nullable: true
readOnly: true
type: string
x-added: iLO 5 1.10
x-longDescription: This property shall represent if this component is
available or not and why. Enabled indicates the resource is available. Disabled
indicates the resource has been intentionally made unavailable but
it can be enabled. Offline indicates the resource is unavailable
intentionally and requires action to be made available. InTest indicates
that the component is undergoing testing. Starting indicates that
the resource is on its way to becoming available. Absent indicates
the resources is physically unavailable.
type: object
x-added: iLO 5 1.10
readOnly: true
type: object
HpeSmartStorageArrayController:
description: HpSmartStorageArrayController
properties:
'@odata.context':
example: /$metadata#HpeSmartStorageArrayController.HpeSmartStorageArrayController
format: uri
readOnly: true
type: string
x-longDescription: The value of this property shall be the context URL that
describes the resource according to OData-Protocol and shall be of the
form defined in the SPMF specification.
'@odata.etag':
example: W/\9F8CF5C7\""
readOnly: true
type: string
x-longDescription: The value of this property is the Etag of the resource.
'@odata.id':
example: /Systems/1/SmartStorage/ArrayControllers/0/
format: uri
readOnly: true
type: string
x-longDescription: The value of this property shall be the unique identifier
for the resource and it shall be of the form defined in the SPMF specification.
'@odata.type':
example: '#HpeSmartStorageArrayController.v2_2_0.HpeSmartStorageArrayController'
readOnly: true
type: string
x-longDescription: The value of this property shall be an absolute URL that
specifies the type of the resource and it shall be of the form defined
in the SPMF specification.
AdapterType:
description: 'Type of Smart controller
Defined values are:
* `SmartArray`: A controller that supports all SmartArray features and
configuration
* `SmartHBA`: A controller that functions natively as an HBA, but has
a ValueRAID mode for basic RAID configuration
* `DynamicSmartArray`: A controller that allows software RAID configuration
'
enum:
- SmartArray
- SmartHBA
- DynamicSmartArray
example: SmartArray
readOnly: true
type: string
x-added: iLO 5 1.10
ArrayCount:
description: The number of arrays configured on this controller
readOnly: true
type: integer
x-added: iLO 5 1.10
BackupPowerSourceStatus:
description: 'The current status of the backup power source (battery, capacitor,
megacell etc.)
Defined values are:
* `Present`: The backup power source is present but charging information
is unknown
* `NotPresent`: The backup power source is not present
* `PresentAndCharged`: The backup power source is present and fully charged
* `PresentAndCharging`: The backup power source is present and is currently
charging
'
enum:
- Present
- NotPresent
- PresentAndCharged
- PresentAndCharging
example: NotPresent
readOnly: true
type: string
x-added: iLO 5 1.10
BootVolumePrimary:
description: The primary boot volume of this controller
readOnly: true
type: string
x-added: iLO 5 1.10
BootVolumeSecondary:
description: The secondary boot volume of this controller
readOnly: true
type: string
x-added: iLO 5 1.10
CacheArrayCount:
description: The number of cache arrays configured on this controller
readOnly: true
type: integer
x-added: iLO 5 1.10
CacheLogicalDriveCount:
description: The number of cache logical drives configured on this controller
readOnly: true
type: integer
x-added: iLO 5 1.10
CacheMemorySizeMiB:
description: The total cache memory size for the controller in MiB
example: '2048'
readOnly: true
type: integer
x-added: iLO 5 1.10
CacheModuleSerialNumber:
description: The serial number of the Cache Module.
example: ' '
readOnly: true
type: string
x-added: iLO 5 1.20
CacheModuleStatus:
properties:
Health:
description: 'This represents the health state of this resource in the
absence of its dependent resources.
Defined values are:
* `OK`: Normal
* `Warning`: A condition exists that requires attention
* `Critical`: A critical condition exists that requires immediate
attention
'
enum:
- OK
- Warning
- Critical
example: OK
nullable: true
readOnly: true
type: string
x-added: iLO 5 1.40
x-longDescription: This property shall represent the HealthState of
the resource without considering its dependent resources. The values
shall conform to those defined in the Redfish specification.
HealthRollup:
description: 'This represents the overall health state from the view
of this resource.
Defined values are:
* `OK`: Normal
* `Warning`: A condition exists that requires attention
* `Critical`: A critical condition exists that requires immediate
attention
'
enum:
- OK
- Warning
- Critical
nullable: true
readOnly: true
type: string
x-added: iLO 5 1.40
x-longDescription: This property shall represent the HealthState of
the resource and its dependent resources. The values shall conform
to those defined in the Redfish specification.
State:
description: 'This indicates the known state of the resource, such as
if it is enabled.
Defined values are:
* `Enabled`: This function or resource has been enabled.
* `Disabled`: This function or resource has been disabled.
* `StandbyOffline`: This function or resource is enabled, but awaiting
an external action to activate it.
* `StandbySpare`: This function or resource is part of a redundancy
set and is awaiting a failover or other external action to activate
it.
* `InTest`: This function or resource is undergoing testing.
* `Starting`: This function or resource is starting.
* `Absent`: This function or resource is not present or not detected.
* `UnavailableOffline`: This function or resource is present but cannot
be used.
* `Deferring`: The element will not process any commands but will
queue new requests.
* `Quiesced`: The element is enabled but only processes a restricted
set of commands.
* `Updating`: The element is updating and may be unavailable or degraded.
'
enum:
- Enabled
- Disabled
- StandbyOffline
- StandbySpare
- InTest
- Starting
- Absent
- UnavailableOffline
- Deferring
- Quiesced
- Updating
nullable: true
readOnly: true
type: string
x-added: iLO 5 1.40
x-longDescription: This property shall represent if this component is
available or not and why. Enabled indicates the resource is available. Disabled
indicates the resource has been intentionally made unavailable but
it can be enabled. Offline indicates the resource is unavailable
intentionally and requires action to be made available. InTest indicates
that the component is undergoing testing. Starting indicates that
the resource is on its way to becoming available. Absent indicates
the resources is physically unavailable.
type: object
x-added: iLO 5 1.40
CachePhysicalDriveCount:
description: The number of physical drives assigned as cache drives attached
to this controller
readOnly: true
type: integer
x-added: iLO 5 1.10
ControllerBoard:
description: Controller Board properties.
properties:
Status:
properties:
Health:
description: 'This represents the health state of this resource
in the absence of its dependent resources.
Defined values are:
* `OK`: Normal
* `Warning`: A condition exists that requires attention
* `Critical`: A critical condition exists that requires immediate
attention
'
enum:
- OK
- Warning
- Critical
example: OK
nullable: true
readOnly: true
type: string
x-added: iLO 5 1.20
x-longDescription: This property shall represent the HealthState
of the resource without considering its dependent resources. The
values shall conform to those defined in the Redfish specification.
HealthRollup:
description: 'This represents the overall health state from the
view of this resource.
Defined values are:
* `OK`: Normal
* `Warning`: A condition exists that requires attention
* `Critical`: A critical condition exists that requires immediate
attention
'
enum:
- OK
- Warning
- Critical
nullable: true
readOnly: true
type: string
x-added: iLO 5 1.20
x-longDescription: This property shall represent the HealthState
of the resource and its dependent resources. The values shall
conform to those defined in the Redfish specification.
State:
description: 'This indicates the known state of the resource, such
as if it is enabled.
Defined values are:
* `Enabled`: This function or resource has been enabled.
* `Disabled`: This function or resource has been disabled.
* `StandbyOffline`: This function or resource is enabled, but
awaiting an external action to activate it.
* `StandbySpare`: This function or resource is part of a redundancy
set and is awaiting a failover or other external action to activate
it.
* `InTest`: This function or resource is undergoing testing.
* `Starting`: This function or resource is starting.
* `Absent`: This function or resource is not present or not detected.
* `UnavailableOffline`: This function or resource is present but
cannot be used.
* `Deferring`: The element will not process any commands but will
queue new requests.
* `Quiesced`: The element is enabled but only processes a restricted
set of commands.
* `Updating`: The element is updating and may be unavailable or
degraded.
'
enum:
- Enabled
- Disabled
- StandbyOffline
- StandbySpare
- InTest
- Starting
- Absent
- UnavailableOffline
- Deferring
- Quiesced
- Updating
nullable: true
readOnly: true
type: string
x-added: iLO 5 1.20
x-longDescription: This property shall represent if this component
is available or not and why. Enabled indicates the resource is
available. Disabled indicates the resource has been intentionally
made unavailable but it can be enabled. Offline indicates the
resource is unavailable intentionally and requires action to be
made available. InTest indicates that the component is undergoing
testing. Starting indicates that the resource is on its way to
becoming available. Absent indicates the resources is physically
unavailable.
type: object
x-added: iLO 5 1.20
readOnly: true
type: object
x-added: iLO 5 1.20
ControllerPartNumber:
description: Smart Array Controller Part Number
example: 836260-001
readOnly: true
type: string
x-added: iLO 5 1.10
CurrentOperatingMode:
description: 'The current operating mode of the controller.
Defined values are:
* `RAID`: The controller is currently functioning in RAID mode
* `HBA`: The controller is currently functioning in HBA mode
* `Mixed`: The controller is currently functioning in Mixed mode
'
enum:
- RAID
- HBA
- Mixed
example: Mixed
readOnly: true
type: string
x-added: iLO 5 1.10
CurrentParallelSurfaceScanCount:
description: Number of disks the controller is scanning in parallel
readOnly: true
type: integer
x-added: iLO 5 1.10
DataLogicalDriveCount:
description: The number of data logical drives configured on this controller
readOnly: true
type: integer
x-added: iLO 5 1.10
DataPhysicalDriveCount:
description: The number of physical drives assigned as data drives attached
to this controller
readOnly: true
type: integer
x-added: iLO 5 1.10
DegradedPerformanceOptimization:
description: 'Enables the controller to attempt to improve performance on
RAID 5/50/6(ADG)/60 logical drives when one or more physical drives in
the logical drive are failed
Defined values are:
* `Enabled`: The controller will attempt to improve performance by buffering
physical drive requests
* `Disabled`: The controller will not buffer, which may result in reading
from the same drive multiple times
'
enum:
- Enabled
- Disabled
readOnly: true
type: string
x-added: iLO 5 1.10
Description:
description: Provides a description of this resource and is used for commonality in
the schema definitions.
example: HPE Smart Storage Array Controller View
nullable: true
readOnly: true
type: string
x-longDescription: This object represents the Description property. All
values for resources described by this schema shall comply to the requirements
as described in the Redfish specification.
DriveWriteCache:
description: 'Enables or disables the write cache of the physical drives
attached to the controller
Defined values are:
* `Enabled`: The write cache of the physical drives attached to the controller
are enabled
* `Disabled`: The write cache of the physical drives attached to the controller
are enabled
'
enum:
- Enabled
- Disabled
example: Disabled
readOnly: true
type: string
x-added: iLO 5 1.10
ElevatorSort:
description: 'Enables the controller to sort requests to a physical drive
Defined values are:
* `Enabled`: The controller will sort the requests to minimize the amount
of seeking the drive must perform in order to reduce seek times
* `Disabled`: The controller will perform the requests as they are recieved
in order to improve request throughput
'
enum:
- Enabled
- Disabled
readOnly: true
type: string
x-added: iLO 5 1.10
EncryptionBootPasswordSet:
description: True if there is a boot password set, false otherwise
readOnly: true
type: boolean
x-added: iLO 5 1.10
EncryptionCryptoOfficerPasswordSet:
description: True if a password has been set for the Encryption Crypto Officer,
false otherwise
example: 'false'
readOnly: true
type: boolean
x-added: iLO 5 1.10
EncryptionCspTestPassed:
description: True if the encryption CSP test passed, false otherwise.
example: 'true'
readOnly: true
type: boolean
x-added: iLO 5 1.20
EncryptionEnabled:
description: True if encryption is currently enabled for this controller,
false otherwise
example: 'false'
readOnly: true
type: boolean
x-added: iLO 5 1.10
EncryptionFwLocked:
description: True if the controller firmware has been locked, preventing
firmware updates, false otherwise
example: 'false'
readOnly: true
type: boolean
x-added: iLO 5 1.10
EncryptionHasLockedVolumes:
description: True if the controller has one or more volumes that are locked,
false otherwise
readOnly: true
type: boolean
x-added: iLO 5 1.10
EncryptionHasLockedVolumesMissingBootPassword:
description: True if there are locked drives due to a missing boot password,
false otherwise
example: 'false'
readOnly: true
type: boolean
x-added: iLO 5 1.10
EncryptionHasSuspendedVolumes:
description: True if the controller password has been temporarily suspended,
false otherwise
readOnly: true
type: boolean
x-added: iLO 5 1.10
EncryptionKeySet:
description: True if the Master Key has been set, false otherwise
readOnly: true
type: boolean
x-added: iLO 5 1.20
EncryptionLocalKeyCacheEnabled:
description: True if the controller caches encryption keys locally when
a remote key manager is being used, false otherwise
readOnly: true
type: boolean
x-added: iLO 5 1.10
EncryptionMixedVolumesEnabled:
description: True if the controller will allow plaintext and encrypted volumes
to exist simultaneously, false otherwise
example: 'false'
readOnly: true
type: boolean
x-added: iLO 5 1.10
EncryptionPhysicalDriveCount:
description: The number of encrypted physical drives attached to the controller
readOnly: true
type: integer
x-added: iLO 5 1.10
EncryptionRecoveryParamsSet:
description: True if the encryption password recovery question and answer
have been set, false otherwise
readOnly: true
type: boolean
x-added: iLO 5 1.10
EncryptionSelfTestPassed:
description: True if the encryption self test passed, false otherwise.
example: 'true'
readOnly: true
type: boolean
x-added: iLO 5 1.20
EncryptionStandaloneModeEnabled:
description: True if the controller manages encryption keys locally, false
if a remote key manager is being used
example: 'false'
readOnly: true
type: boolean
x-added: iLO 5 1.10
EncryptionUserPasswordSet:
description: True if a password has been set for the Encryption User, false
otherwise.
readOnly: true
type: boolean
x-added: iLO 5 1.10
ExpandPriority:
description: 'The level of priority that transformations have over handling
current operating system requests
Defined values are:
* `High`: Transformations will complete as fast as possible at the expense
of normal I/O
* `Medium`: Transformations will perform with some impact on normal I/O
* `Low`: Transformations will perform only when normal I/O is not occurring
and may take longer to complete
'
enum:
- High
- Medium
- Low
readOnly: true
type: string
x-added: iLO 5 1.10
ExternalPortCount:
description: The number of external ports
example: '0'
readOnly: true
type: integer
x-added: iLO 5 1.10
FirmwareVersion:
description: The schema definition for the current firmware version.
properties:
Current:
description: This object contains information about the version of a
firmware image.
properties:
VersionString:
description: This string represents the version of the firmware
image.
example: '1.98'
nullable: true
readOnly: true
type: string
x-added: iLO 5 1.10
readOnly: true
type: object
x-added: iLO 5 1.10
readOnly: true
type: object
x-added: iLO 5 1.10
FlexibleLatencySchedulerSetting:
description: 'This allows the controller to process certain high-latency
requests after a delay that may time out when elevator sorting
Defined values are:
* `Default`: The controller will rely only on elevator sorting
* `Low250`: The controller will apply a cutoff value of 250ms when suspending
elevator sorting
* `Middle100`: The controller will apply a cutoff value of 100ms when
suspending elevator sorting
* `Middle50`: The controller will apply a cutoff value of 50ms when suspending
elevator sorting
* `Aggressive30`: The controller will apply a cutoff value of 30ms when
suspending elevator sorting
* `Aggressive10`: The controller will apply a cutoff value of 10ms when
suspending elevator sorting
'
enum:
- Default
- Low250
- Middle100
- Middle50
- Aggressive30
- Aggressive10
readOnly: true
type: string
x-added: iLO 5 1.10
HardwareRevision:
description: The hardware revision of the controller
example: B
readOnly: true
type: string
x-added: iLO 5 1.10
Id:
description: Uniquely identifies the resource within the collection of like
resources.
example: '0'
readOnly: true
type: string
x-added: iLO 5 1.10
x-longDescription: This property represents an identifier for the resource. All
values for resources described by this schema shall comply to the requirements
as described in the Redfish specification.
InconsistencyRepairPolicy:
description: 'Enables the controller to update data on RAID 6(ADG) and 60
volumes based on parity information when an inconsistency is discovered
during surface scan
Defined values are:
* `Enabled`: The controller will update the data on the drives based on
the parity information
* `Disabled`: The controller will only update the parity information and
leave the data untouched
'
enum:
- Enabled
- Disabled
readOnly: true
type: string
x-added: iLO 5 1.10
InternalPortCount:
description: The number of internal ports
example: '2'
readOnly: true
type: integer
x-added: iLO 5 1.10
IsBootController:
description: True if this controller is the OS boot controller, false otherwise
readOnly: true
type: boolean
x-added: iLO 5 1.10
Links:
description: The URIs to the resource related to HpSmartStorageSmartArray
properties:
LogicalDrives:
description: link to collection of membertype HpSmartStorageLogicalDrive
properties:
'@odata.id':
example: /Systems/1/SmartStorage/ArrayControllers/0/LogicalDrives/
format: uri
readOnly: true
type: string
x-longDescription: The value of this property shall be the unique
identifier for the resource and it shall be of the form defined
in the SPMF specification.
readOnly: true
type: object
x-added: iLO 5 1.10
PhysicalDrives:
description: link to collection of membertype HpSmartStorageDiskDrive.
This constitutes inventory of all physical drives in the system
properties:
'@odata.id':
example: /Systems/1/SmartStorage/ArrayControllers/0/DiskDrives/
format: uri
readOnly: true
type: string
x-longDescription: The value of this property shall be the unique
identifier for the resource and it shall be of the form defined
in the SPMF specification.
readOnly: true
type: object
x-added: iLO 5 1.10
StorageEnclosures:
description: link to collection of membertype HpSmartStorageStorageEnclosure
properties:
'@odata.id':
example: /Systems/1/SmartStorage/ArrayControllers/0/StorageEnclosures/
format: uri
readOnly: true
type: string
x-longDescription: The value of this property shall be the unique
identifier for the resource and it shall be of the form defined
in the SPMF specification.
readOnly: true
type: object
x-added: iLO 5 1.10
UnconfiguredDrives:
description: link to collection of membertype HpSmartStorageDiskDrive.
This constitutes inventory of all unconfigured physical drives (i.e.
drives that haven't been configured as data or spare drives for a
logical drive)
properties:
'@odata.id':
example: /Systems/1/SmartStorage/ArrayControllers/0/UnconfiguredDrives/
format: uri
readOnly: true
type: string
x-longDescription: The value of this property shall be the unique
identifier for the resource and it shall be of the form defined
in the SPMF specification.
readOnly: true
type: object
x-added: iLO 5 1.10
readOnly: true
type: object
x-added: iLO 5 1.10
Location:
description: Location identifier
example: Slot 0
readOnly: true
type: string
x-added: iLO 5 1.10
LocationFormat:
description: 'Format for Location Identifier
Defined values are:
* `PCISlot`: The PCI slot the controller is located at. For embedded controllers,
the slot is 0
'
enum:
- PCISlot
example: PCISlot
readOnly: true
type: string
x-added: iLO 5 1.10
LogicalDriveCount:
description: The number of logical drives configured on this controller
readOnly: true
type: integer
x-added: iLO 5 1.10
Manufacturer:
description: The manufacturer of the controller
readOnly: true
type: string
x-added: iLO 5 1.10
MaxParallelSurfaceScanCount:
description: Maximum number of disks that the controller supports scanning
in parallel
readOnly: true
type: integer
x-added: iLO 5 1.10
Model:
description: The model number for the controller
example: HPE Smart Array P408i-a SR Gen10
readOnly: true
type: string
x-added: iLO 5 1.10
Name:
description: The name of the resource or array element.
example: HpeSmartStorageArrayController
readOnly: true
type: string
x-added: iLO 5 1.10
Oem:
description: This object represents the Oem property.
readOnly: true
OperatingModeAfterReboot:
description: 'The operating mode the controller will be functioning in (RAID
versus HBA) after a reboot
Defined values are:
* `RAID`: The controller will be functioning in RAID mode after rebooting
* `HBA`: The controller will be functioning in HBA mode after rebooting
* `Mixed`: The controller will be functioning in Mixed mode after rebooting
'
enum:
- RAID
- HBA
- Mixed
readOnly: true
type: string
x-added: iLO 5 1.10
ParallelSurfaceScanSupported:
description: True if the controller supports scanning multiple disk surfaces
readOnly: true
type: boolean
x-added: iLO 5 1.10
PhysicalDriveCount:
description: The number of physical drives attached to this controller
readOnly: true
type: integer
x-added: iLO 5 1.10
PowerModeAfterReboot:
description: 'The power mode of the controller after a reboot
Defined values are:
* `Invalid`: The controller will be operating in an unknown power mode
after a reboot
* `Low`: The controller will be operating in minimum power mode after
a reboot
* `LowAutomated`: The controller will be operating in a balanced mode
after a reboot
* `Performant`: The controller will be operating in maximum performance
power mode after a reboot
'
enum:
- Invalid
- Low
- LowAutomated
- Performant
readOnly: true
type: string
x-added: iLO 5 1.10
PowerModeConfigured:
description: 'The current power mode of the controller
Defined values are:
* `Invalid`: The power mode can not be determined
* `Low`: The controller is currently operating in minimum power mode
* `LowAutomated`: The controller is currently operating in a balanced
power mode
* `Performant`: The controller is currently operating in maximum performance
power mode
'
enum:
- Invalid
- Low
- LowAutomated
- Performant
readOnly: true
type: string
x-added: iLO 5 1.10
PowerModeWarningChangedDrive:
description: True if the controller's drive configuration has changed while
using configuration based power settings, false otherwise
readOnly: true
type: boolean
x-added: iLO 5 1.10
PowerModeWarningChangedMode:
description: True if the controller has a new power mode configured, false
otherwise
readOnly: true
type: boolean
x-added: iLO 5 1.10
PowerModeWarningReboot:
description: 'True if a reboot is required to change the active power mode
on the controller, false otherwise
Defined values are:
* `NotRequired`: No reboot is required
* `RequiredNoReason`: A reboot is required for the configured power mode
on the controller
* `RequiredPowerSavings`: Rebooting will enable additional power savings
on the controller
* `RequiredPerformance`: Rebooting will enhance the performance of the
controller
'
enum:
- NotRequired
- RequiredNoReason
- RequiredPowerSavings
- RequiredPerformance
readOnly: true
type: string
x-added: iLO 5 1.10
PowerModeWarningTemperature:
description: True if the controller has crossed a critical temperature threshold
and performance has been reduced to prevent damage to the controller,
false otherwise
readOnly: true
type: boolean
x-added: iLO 5 1.10
PredictiveSpareRebuild:
description: 'Enables or disables predictive spare rebuild mode
Defined values are:
* `Enabled`: Spare drives will replace physical drives that are predicted
to fail preemptively
* `Disabled`: Spare drives will replace physical drives only when they
fail
'
enum:
- Enabled
- Disabled
readOnly: true
type: string
x-added: iLO 5 1.10
QueueDepth:
description: 'This sets the maximum number of requests the controller will
submit to a drive at any given time
Defined values are:
* `2`: 2 requests
* `4`: 4 requests
* `8`: 8 requests
* `16`: 16 requests
* `32`: 32 requests
* `Automatic`: Automatically determine the best queue depth for the controller
'
enum:
- '2'
- '4'
- '8'
- '16'
- '32'
- Automatic
readOnly: true
type: string
x-added: iLO 5 1.10
ReadCachePercent:
description: This indicates the percentage of cache used for read cache
on the controller, with the rest of the cache being used for write cache
example: '0'
nullable: true
readOnly: false
type: integer
x-added: iLO 5 1.20
RebuildPriority:
description: 'The level of priority that rebuilds have over handling current
operating system requests
Defined values are:
* `High`: Rebuilds will complete as fast as possible at the expense of
normal I/O
* `Medium`: Rebuilds will perform with some impact on normal I/O
* `Low`: Rebuilds will perform only when normal I/O is not occurring and
may take longer to complete
* `RapidHigh`: Rebuilds will complete as fast as possible at the expense
of normal I/O
* `RapidMediumHigh`: Rebuilds will perform with an impact on normal I/O
* `RapidMedium`: Rebuilds will perform with some impact on normal I/O
* `RapidLow`: Rebuilds will perform only when normal I/O is not occurring
and may take longer to complete
'
enum:
- High
- Medium
- Low
- RapidHigh
- RapidMediumHigh
- RapidMedium
- RapidLow
readOnly: true
type: string
x-added: iLO 5 1.10
SerialNumber:
description: The serial number for this controller
example: xxxxxxxxxx
readOnly: true
type: string
x-added: iLO 5 1.10
SoftwareRaidHbaFirmwareRev:
description: The firmware version of the underlying HBA that is being used
by the software RAID stack
readOnly: true
type: string
x-added: iLO 5 1.10
SoftwareRaidHbaModeOptionRomRev:
description: The option ROM firmware version used to bootstrap the software
RAID stack
readOnly: true
type: string
x-added: iLO 5 1.10
SparePhysicalDriveCount:
description: he number of physical drives assigned as spare drives attached
to this controller
readOnly: true
type: integer
x-added: iLO 5 1.10
Status:
properties:
Health:
description: 'This represents the health state of this resource in the
absence of its dependent resources.
Defined values are:
* `OK`: Normal
* `Warning`: A condition exists that requires attention
* `Critical`: A critical condition exists that requires immediate
attention
'
enum:
- OK
- Warning
- Critical
example: OK
nullable: true
readOnly: true
type: string
x-added: iLO 5 1.10
x-longDescription: This property shall represent the HealthState of
the resource without considering its dependent resources. The values
shall conform to those defined in the Redfish specification.
HealthRollup:
description: 'This represents the overall health state from the view
of this resource.
Defined values are:
* `OK`: Normal
* `Warning`: A condition exists that requires attention
* `Critical`: A critical condition exists that requires immediate
attention
'
enum:
- OK
- Warning
- Critical
nullable: true
readOnly: true
type: string
x-added: iLO 5 1.10
x-longDescription: This property shall represent the HealthState of
the resource and its dependent resources. The values shall conform
to those defined in the Redfish specification.
State:
description: 'This indicates the known state of the resource, such as
if it is enabled.
Defined values are:
* `Enabled`: This function or resource has been enabled.
* `Disabled`: This function or resource has been disabled.
* `StandbyOffline`: This function or resource is enabled, but awaiting
an external action to activate it.
* `StandbySpare`: This function or resource is part of a redundancy
set and is awaiting a failover or other external action to activate
it.
* `InTest`: This function or resource is undergoing testing.
* `Starting`: This function or resource is starting.
* `Absent`: This function or resource is not present or not detected.
* `UnavailableOffline`: This function or resource is present but cannot
be used.
* `Deferring`: The element will not process any commands but will
queue new requests.
* `Quiesced`: The element is enabled but only processes a restricted
set of commands.
* `Updating`: The element is updating and may be unavailable or degraded.
'
enum:
- Enabled
- Disabled
- StandbyOffline
- StandbySpare
- InTest
- Starting
- Absent
- UnavailableOffline
- Deferring
- Quiesced
- Updating
example: Enabled
nullable: true
readOnly: true
type: string
x-added: iLO 5 1.10
x-longDescription: This property shall represent if this component is
available or not and why. Enabled indicates the resource is available. Disabled
indicates the resource has been intentionally made unavailable but
it can be enabled. Offline indicates the resource is unavailable
intentionally and requires action to be made available. InTest indicates
that the component is undergoing testing. Starting indicates that
the resource is on its way to becoming available. Absent indicates
the resources is physically unavailable.
type: object
x-added: iLO 5 1.10
SupportedOperatingModes:
description: A list of operating modes supported on this controller
items:
description: 'Defined values are:
* `RAID`: The controller supports functioning in RAID mode
* `HBA`: The controller supports functioning in HBA mode
* `Mixed`: The controller supports functioning in Mixed mode
'
enum:
- RAID
- HBA
- Mixed
type: string
readOnly: true
type: array
x-added: iLO 5 1.10
SupportedPowerModes:
description: A list of the power modes that are supported on this controller
items:
description: 'Defined values are:
* `Low`: The controller is currently operating in minimum power mode
* `LowAutomated`: The controller is currently operating in a balanced
power mode
* `Performant`: The controller is currently operating in maximum performance
power mode
'
enum:
- Low
- LowAutomated
- Performant
type: string
readOnly: true
type: array
x-added: iLO 5 1.10
SupportedRaidLevels:
description: A list of RAID levels supported on this controller
items:
description: 'Defined values are:
* `0`: There is no fault tolerance used on the logical drive
* `1`: Two sets of duplicate data is being stored on a pair of drives
* `1ADM`: Three sets of duplicate data is being stored on a trio of
drives
* `10`: Data is duplicated and striped across pairs of disk drives
* `10ADM`: Data is duplicated and striped across trios of disk drives
* `5`: Fault tolerance is achieved by storing parity data across 3 or
more disk drives
* `50`: Fault tolerance is achieved by storing parity data and striping
the data across 6 or more disk drives
* `6`: Fault tolerance is achieved by storing multiple sets parity data
across 4 or more disk drives
* `60`: Fault tolerance is achieved by storing multiple sets parity
data and striping the data across 8 or more disk drives
'
enum:
- '0'
- '1'
- 1ADM
- '10'
- 10ADM
- '5'
- '50'
- '6'
- '60'
type: string
readOnly: true
type: array
x-added: iLO 5 1.10
SurfaceScanAnalysisPriority:
description: 'Priority that the controller takes to find and correct disk
surface errors
Defined values are:
* `Disabled`: Surface scan is disabled and may lead to data loss
* `High`: Surface scan commands will be sent with the host I/O, resulting
in faster scanning, but may inpact host I/O performance
* `Medium`: Surface scan commands have a medium priority, and will have
some impact on host I/O performance
* `Low`: Surface scan commands have a low priority, and will have little
impact on host I/O performance
* `Idle`: Surface scan commands will ony be issued when no host I/O is
present after a delay
'
enum:
- Disabled
- High
- Medium
- Low
- Idle
readOnly: true
type: string
x-added: iLO 5 1.10
UnassignedPhysicalDriveCount:
description: The number of unassigned physical drives attached to this controller
readOnly: true
type: integer
x-added: iLO 5 1.10
WriteCacheBypassThresholdKB:
description: This value sets the write cache bypass threshold, ranging from
16 KB to 1040 KB in multiples of 16 KB, where all writes larger than the
specified value in KB units will bypass the write cache and be written
directly to the disk for non-parity RAID volumes.
nullable: true
readOnly: true
type: integer
x-added: iLO 5 1.20
WriteCacheWithoutBackupPowerEnabled:
description: True if the controller will continue to use write cache even
if the backup power source is not available. False, otherwise.
example: 'false'
readOnly: true
type: boolean
x-added: iLO 5 1.20
readOnly: true
type: object
HpeSmartStorageArrayControllerCollection:
properties:
'@odata.context':
example: /$metadata#HpeSmartStorageArrayControllerCollection.HpeSmartStorageArrayControllerCollection
format: uri
readOnly: true
type: string
x-longDescription: The value of this property shall be the context URL that
describes the resource according to OData-Protocol and shall be of the
form defined in the SPMF specification.
'@odata.etag':
example: W/\AA6D42B0\""
readOnly: true
type: string
x-longDescription: The value of this property is the Etag of the resource.
'@odata.id':
example: /Systems/1/SmartStorage/ArrayControllers/
format: uri
readOnly: true
type: string
x-longDescription: The value of this property shall be the unique identifier
for the resource and it shall be of the form defined in the SPMF specification.
'@odata.type':
example: '#HpeSmartStorageArrayControllerCollection.HpeSmartStorageArrayControllerCollection'
readOnly: true
type: string
x-longDescription: The value of this property shall be an absolute URL that
specifies the type of the resource and it shall be of the form defined
in the SPMF specification.
Description:
description: Provides a description of this resource and is used for commonality in
the schema definitions.
example: HPE Smart Storage Array Controllers View
nullable: true
readOnly: true
type: string
x-longDescription: This object represents the Description property. All
values for resources described by this schema shall comply to the requirements
as described in the Redfish specification.
Members:
description: Contains the members of this collection.
items:
properties:
'@odata.id':
example: /Systems/1/SmartStorage/ArrayControllers/0/
format: uri
readOnly: true
type: string
x-longDescription: The value of this property shall be the unique
identifier for the resource and it shall be of the form defined
in the SPMF specification.
type: object
readOnly: true
type: array
Members@odata.count:
description: The total number of collection members.
example: '1'
readOnly: true
type: integer
Name:
description: The name of the resource or array element.
example: HpeSmartStorageArrayControllers
readOnly: true
type: string
Oem:
description: This object represents the Oem property.
readOnly: true
x-longDescription: The value of this string shall be of the format for the
reserved word *Oem*.
type: object
HpeSmartStorageDiskDrive:
description: HpSmartStorageDiskDrive
properties:
'@odata.context':
example: /$metadata#HpeSmartStorageDiskDrive.HpeSmartStorageDiskDrive
format: uri
readOnly: true
type: string
x-longDescription: The value of this property shall be the context URL that
describes the resource according to OData-Protocol and shall be of the
form defined in the SPMF specification.
'@odata.etag':
example: W/\D0058DE5\""
readOnly: true
type: string
x-longDescription: The value of this property is the Etag of the resource.
'@odata.id':
example: /Systems/1/SmartStorage/ArrayControllers/0/DiskDrives/4/
format: uri
readOnly: true
type: string
x-longDescription: The value of this property shall be the unique identifier
for the resource and it shall be of the form defined in the SPMF specification.
'@odata.type':
example: '#HpeSmartStorageDiskDrive.v2_0_1.HpeSmartStorageDiskDrive'
readOnly: true
type: string
x-longDescription: The value of this property shall be an absolute URL that
specifies the type of the resource and it shall be of the form defined
in the SPMF specification.
BlockSizeBytes:
description: Block size of the drive in bytes. This is the block size presented
by the drive to clients such as the array controller or operating system.
example: '512'
readOnly: true
type: integer
x-added: iLO 5 1.10
CapacityGB:
description: Total capacity of the drive in GB. This denotes the marketing
capacity (base 10)
example: '500'
readOnly: true
type: integer
x-added: iLO 5 1.10
CapacityLogicalBlocks:
description: Total number of logical blocks in the drive
example: '976773168'
readOnly: true
type: integer
x-added: iLO 5 1.10
CapacityMiB:
description: Total capacity of the drive in MiB
example: '476940'
readOnly: true
type: integer
x-added: iLO 5 1.10
CarrierApplicationVersion:
description: Carrier PIC firmware version currently running
example: '11'
readOnly: true
type: string
x-added: iLO 5 1.10
CarrierAuthenticationStatus:
description: 'Authentication status of the drive carrier
Defined values are:
* `OK`: Carrier authenticated as genuine HPE product
* `Fail`: Carrier authentication failed
* `NoCommunication`: Communication could not be established with the carrier
* `NotApplicable`: Carrier does not support authentication
'
enum:
- OK
- Fail
- NoCommunication
- NotApplicable
example: OK
readOnly: true
type: string
x-added: iLO 5 1.10
CurrentTemperatureCelsius:
description: The current temperature of the drive
example: '26'
readOnly: true
type: integer
x-added: iLO 5 1.10
Description:
description: Provides a description of this resource and is used for commonality in
the schema definitions.
example: HPE Smart Storage Disk Drive View
nullable: true
readOnly: true
type: string
x-longDescription: This object represents the Description property. All
values for resources described by this schema shall comply to the requirements
as described in the Redfish specification.
DiskDriveStatusReasons:
description: A list of status reasons that the drive is currently exhibiting
items:
description: 'Defined values are:
* `None`: No status reason available
* `Unknown`: Reason is unknown
* `CommunicationFailure`: Cannot communicate with drive
* `Zoned`: Drive is currently zoned, only basic information can be displayed
* `EraseInProgress`: Drive is currently in process of an erase operation
* `QueuedForErase`: Drive is currently queued for an erase operation
* `EraseCompleted`: Drive has completed the erase operation
* `EraseFailed`: The erase operation has failed for the drive
* `EraseAborted`: The erase operation was aborted
* `Failed`: The drive has failed
* `NonAuthenticDrive`: The drive is not an authentic drive
* `CarrierCommunicationFailure`: The drive carrier has a communication
fault
* `PredictiveFail`: Drive failure is imminent
* `NotSupported`: The drive is not supported by the controller
* `SizeNotValid`: The drive size is invalid. Typically occurs if a drive
part of a raid volume is replaced with a smaller sized drive
* `FailedDueToPredictiveSpareActivation`: The drive was failed due to
a predictive spare activation
* `Rebuilding`: The drive is currently rebuilding
* `TransientDataDrive`: The drive is part of a volume that is currently
undergoing a transformation. After the transformation is complete the
drive''s state will change
* `Unrecoverable`: The drive is in an unrecoverable condition
'
enum:
- None
- Unknown
- CommunicationFailure
- Zoned
- EraseInProgress
- QueuedForErase
- EraseCompleted
- EraseFailed
- EraseAborted
- Failed
- NonAuthenticDrive
- CarrierCommunicationFailure
- PredictiveFail
- NotSupported
- SizeNotValid
- FailedDueToPredictiveSpareActivation
- Rebuilding
- TransientDataDrive
- Unrecoverable
type: string
readOnly: true
type: array
x-added: iLO 5 1.10
DiskDriveUse:
description: 'The current use of the physical drive.
Defined values are:
* `Data`: It is a Data drive which is a part of an array.
* `Spare`: It is a spare drive which is a part of an array.
* `Raw`: Indicates the drive is available to the OS via HBA mode on the
controller.
* `Unconfigured`: Indicates the drive is not available to the OS as controller
is in RAID mode.
* `Unknown`: The current use of the disk drive is not known.
'
enum:
- Data
- Spare
- Raw
- Unconfigured
- Unknown
example: Raw
readOnly: true
type: string
x-added: iLO 5 1.10
EncryptedDrive:
description: True if encryption is currently enabled on this disk drive,
false otherwise
example: 'false'
readOnly: true
type: boolean
x-added: iLO 5 1.10
EraseCompletionPercentage:
description: The percent complete for an erase operation currently occurring
on the disk drive or null if not currently erasing a drive.
nullable: true
readOnly: true
type: integer
x-added: iLO 5 1.10
ErasePattern:
description: The pattern used for erasing the disk drive
readOnly: true
type: string
x-added: iLO 5 1.10
FirmwareVersion:
description: The schema definition for the current firmware version.
properties:
Current:
description: This object contains information about the version of a
firmware image.
properties:
VersionString:
description: This string represents the version of the firmware
image.
example: HPGE
nullable: true
readOnly: true
type: string
x-added: iLO 5 1.10
readOnly: true
type: object
x-added: iLO 5 1.10
readOnly: true
type: object
x-added: iLO 5 1.10
Id:
description: Uniquely identifies the resource within the collection of like
resources.
example: '4'
readOnly: true
type: string
x-added: iLO 5 1.10
x-longDescription: This property represents an identifier for the resource. All
values for resources described by this schema shall comply to the requirements
as described in the Redfish specification.
IndicatorLED:
description: 'The state of the indicator LED.
Defined values are:
* `Unknown`: The state of the Indicator LED cannot be determined.
* `Lit`: The Indicator LED is lit.
* `Blinking`: The Indicator LED is blinking.
* `Off`: The Indicator LED is off.
'
enum:
- Unknown
- Lit
- Blinking
- 'Off'
nullable: true
readOnly: true
type: string
x-added: iLO 5 1.10
InterfaceSpeedMbps:
description: Native interface speed for the device
example: '6000'
readOnly: true
type: integer
x-added: iLO 5 1.10
InterfaceType:
description: 'The connection interface of the drive. The value NVME has
been deprecated.
Defined values are:
* `SAS`: SAS
* `SATA`: SATA
* `NVME`: Non-volatile memory (deprecated)
* `PCIe`: PCIe interface
* `Unknown`: Information is unavailable
'
enum:
- SAS
- SATA
- NVME
- PCIe
- Unknown
example: SATA
readOnly: true
type: string
x-added: iLO 5 1.10
LegacyBootPriority:
description: 'This indicates that the array controller should provide legacy
boot support.
Defined values are:
* `Primary`: This indicates that the array controller should provide legacy
boot support (Interrupt 13h BIOS support) for this physical drive. The
physical drive will be listed as first in the LUN list returned via SCSI
commands
* `Secondary`: This indicates that the array controller should provide
legacy boot support (Interrupt 13h BIOS support) for this physical drive.
The physical drive will be listed as second in the LUN list returned via
SCSI commands
* `None`: Legacy boot not supported on this physical drive
'
enum:
- Primary
- Secondary
- None
example: Primary
readOnly: true
type: string
x-added: iLO 5 1.10
Location:
description: The location of the drive
example: 2I:1:5
readOnly: true
type: string
x-added: iLO 5 1.10
LocationFormat:
description: 'Format for the location property
Defined values are:
* `ControllerPort:Box:Bay`: This format typically used in controller context
where the drive would be identified using the controller port, JBOD box
number and drive bay
* `SwitchPort:Box:Bay`: This format typically used in a SAS switch context
where the drive would be identified using the switch port, JBOD box number
and drive bay
* `SwitchPort:SwitchBay:Bay`: This format typically used in a SAS switch
context where the drive would be identified using the switch port, ICM
bay number for the switch and drive bay
'
enum:
- ControllerPort:Box:Bay
- SwitchPort:Box:Bay
- SwitchPort:SwitchBay:Bay
example: ControllerPort:Box:Bay
readOnly: true
type: string
x-added: iLO 5 1.10
Manufacturer:
description: Manufacturer of the disk drive
readOnly: true
type: string
x-added: iLO 5 1.10
MaximumTemperatureCelsius:
description: The maximum recommended temperature for the drive
example: '45'
readOnly: true
type: integer
x-added: iLO 5 1.10
MediaType:
description: 'Type of disk
Defined values are:
* `HDD`: The drive media type is traditional magnetic platters
* `SSD`: The drive media type is solid state or flash memory
* `SMR`: The drive media type is shingled magnetic recording
'
enum:
- HDD
- SSD
- SMR
example: HDD
readOnly: true
type: string
x-added: iLO 5 1.10
MinimumGoodFirmwareVersion:
description: The minimum recommended firmware revision for the drive
readOnly: true
type: string
x-added: iLO 5 1.10
Model:
description: Drive model number
example: MM0500GBKAK
readOnly: true
type: string
x-added: iLO 5 1.10
Name:
description: The name of the resource or array element.
example: HpeSmartStorageDiskDrive
readOnly: true
type: string
x-added: iLO 5 1.10
NativeBlockSizeBytes:
description: Native block size of the drive in bytes. This is the underlying
sector size used by the physical drive to store data. For example, an
advanced format drive that uses 4K sector sizes to store data will return
4K as the NativeBlockSizeBytes but may return 512 for the BlockSizeBytes
when running in 512e (emulation) mode for backward compatibility
readOnly: true
type: integer
x-added: iLO 5 1.10
Oem:
description: This object represents the Oem property.
readOnly: true
PhyCount:
description: The number of phys the drive has
readOnly: true
type: integer
x-added: iLO 5 1.10
PortCount:
description: The number of ports on the drive. Typically 1 (single-domain)
or 2 (dual-domain)
readOnly: true
type: integer
x-added: iLO 5 1.10
PowerOnHours:
description: The number of lifetime hours that the drive has been powered
on. The value is null if the disk power on hours cannot be determined
or is not supported.
example: 'null'
nullable: true
readOnly: true
type: integer
x-added: iLO 5 1.10
RotationalSpeedRpm:
description: The rotational speed of the drive, only applicable on HDDs
example: '7200'
readOnly: true
type: integer
x-added: iLO 5 1.10
SSDEnduranceUtilizationPercentage:
description: This is the percentage of the drive that has been worn out
and can no longer be used. When this values reaches 100%, the drive has
0% usage remaining and is completely worn out. The value is null if percent
endurance used cannot be determined or is not supported.
example: 'null'
nullable: true
readOnly: true
type: integer
x-added: iLO 5 1.10
SerialNumber:
description: The serial number of the drive
example: xxxxxxxxxx
readOnly: true
type: string
x-added: iLO 5 1.10
SpareRebuildMode:
description: 'Method to used activate this drive when another drive fails,
this is only applicable if the drive is configured as a spare drive
Defined values are:
* `Dedicated`: This drive will take over a failed drive temporarily. When
the failed drive is replaced, this will return to being a spare. This
drive be shared between arrays.
* `Roaming`: This drive will permanently replace a failed drive. The failed
drive will become a spare. This spare drive cannot be shared between arrays.
'
enum:
- Dedicated
- Roaming
readOnly: true
type: string
x-added: iLO 5 1.10
Status:
properties:
Health:
description: 'This represents the health state of this resource in the
absence of its dependent resources.
Defined values are:
* `OK`: Normal
* `Warning`: A condition exists that requires attention
* `Critical`: A critical condition exists that requires immediate
attention
'
enum:
- OK
- Warning
- Critical
example: OK
nullable: true
readOnly: true
type: string
x-added: iLO 5 1.10
x-longDescription: This property shall represent the HealthState of
the resource without considering its dependent resources. The values
shall conform to those defined in the Redfish specification.
HealthRollup:
description: 'This represents the overall health state from the view
of this resource.
Defined values are:
* `OK`: Normal
* `Warning`: A condition exists that requires attention
* `Critical`: A critical condition exists that requires immediate
attention
'
enum:
- OK
- Warning
- Critical
nullable: true
readOnly: true
type: string
x-added: iLO 5 1.10
x-longDescription: This property shall represent the HealthState of
the resource and its dependent resources. The values shall conform
to those defined in the Redfish specification.
State:
description: 'This indicates the known state of the resource, such as
if it is enabled.
Defined values are:
* `Enabled`: This function or resource has been enabled.
* `Disabled`: This function or resource has been disabled.
* `StandbyOffline`: This function or resource is enabled, but awaiting
an external action to activate it.
* `StandbySpare`: This function or resource is part of a redundancy
set and is awaiting a failover or other external action to activate
it.
* `InTest`: This function or resource is undergoing testing.
* `Starting`: This function or resource is starting.
* `Absent`: This function or resource is not present or not detected.
* `UnavailableOffline`: This function or resource is present but cannot
be used.
* `Deferring`: The element will not process any commands but will
queue new requests.
* `Quiesced`: The element is enabled but only processes a restricted
set of commands.
* `Updating`: The element is updating and may be unavailable or degraded.
'
enum:
- Enabled
- Disabled
- StandbyOffline
- StandbySpare
- InTest
- Starting
- Absent
- UnavailableOffline
- Deferring
- Quiesced
- Updating
example: Enabled
nullable: true
readOnly: true
type: string
x-added: iLO 5 1.10
x-longDescription: This property shall represent if this component is
available or not and why. Enabled indicates the resource is available. Disabled
indicates the resource has been intentionally made unavailable but
it can be enabled. Offline indicates the resource is unavailable
intentionally and requires action to be made available. InTest indicates
that the component is undergoing testing. Starting indicates that
the resource is on its way to becoming available. Absent indicates
the resources is physically unavailable.
type: object
x-added: iLO 5 1.10
TransferSpeedMbps:
description: Effective transfer speed to the device taking into account
hardware acceleration such as edge-buffering
readOnly: true
type: integer
x-added: iLO 5 1.10
UncorrectedReadErrors:
description: The number of read errors that have occurred on a drive that
could not be recovered by a drive's Error Correction Code (ECC) algorithm
or through retries. Over time, a drive may produce these errors, and a
problem may exist. The value increases every time the physical drive detects
another error. The severity of these errors depends on if the drive is
in a fault tolerant mode and the controller can remap data to eliminate
problems. If an increase in this counter is seen, run diagnostics on
the drive
example: '0'
readOnly: true
type: integer
x-added: iLO 5 1.40
UncorrectedWriteErrors:
description: The number of write errors that have occurred on a drive that
could not be recovered through retries. Over time, a drive may produce
these errors, and a problem may exist. The value increases every time
the physical drive detects another error. If an increase in this counter
is seen, run diagnostics on the drive.
example: '0'
readOnly: true
type: integer
x-added: iLO 5 1.40
WWID:
description: Unique identifier for the device
readOnly: true
type: string
x-added: iLO 5 1.10
readOnly: true
type: object
HpeSmartStorageDiskDriveCollection:
properties:
'@odata.context':
example: /$metadata#HpeSmartStorageDiskDriveCollection.HpeSmartStorageDiskDriveCollection
format: uri
readOnly: true
type: string
x-longDescription: The value of this property shall be the context URL that
describes the resource according to OData-Protocol and shall be of the
form defined in the SPMF specification.
'@odata.etag':
example: W/\75983E8D\
readOnly: true
type: string
x-longDescription: The value of this property is the Etag of the resource.
'@odata.id':
example: /Systems/1/SmartStorage/HostBusAdapters/0/DiskDrives/
format: uri
readOnly: true
type: string
x-longDescription: The value of this property shall be the unique identifier
for the resource and it shall be of the form defined in the SPMF specification.
'@odata.type':
example: '#HpeSmartStorageDiskDriveCollection.HpeSmartStorageDiskDriveCollection'
readOnly: true
type: string
x-longDescription: The value of this property shall be an absolute URL that
specifies the type of the resource and it shall be of the form defined
in the SPMF specification.
Description:
description: Provides a description of this resource and is used for commonality in
the schema definitions.
example: HpeSmartStorageDiskDrive Collection View
nullable: true
readOnly: true
type: string
x-longDescription: This object represents the Description property. All
values for resources described by this schema shall comply to the requirements
as described in the Redfish specification.
Members:
description: Contains the members of this collection.
items:
properties:
'@odata.id':
example: /Systems/1/SmartStorage/ArrayControllers/0/DiskDrives/0/
format: uri
readOnly: true
type: string
x-longDescription: The value of this property shall be the unique
identifier for the resource and it shall be of the form defined
in the SPMF specification.
type: object
readOnly: true
type: array
Members@odata.count:
description: The total number of collection members.
example: '0'
readOnly: true
type: integer
Name:
description: The name of the resource or array element.
example: HpeSmartStorageDiskDrive Collection
readOnly: true
type: string
Oem:
description: This object represents the Oem property.
readOnly: true
x-longDescription: The value of this string shall be of the format for the
reserved word *Oem*.
type: object
HpeSmartStorageHostBusAdapter:
description: HpSmartStorageHostBusAdapter
properties:
'@odata.context':
example: /$metadata#HpeSmartStorageHostBusAdapter.HpeSmartStorageHostBusAdapter
format: uri
readOnly: true
type: string
x-longDescription: The value of this property shall be the context URL that
describes the resource according to OData-Protocol and shall be of the
form defined in the SPMF specification.
'@odata.etag':
example: W/\07586537\
readOnly: true
type: string
x-longDescription: The value of this property is the Etag of the resource.
'@odata.id':
example: /Systems/1/SmartStorage/HostBusAdapters/0/
format: uri
readOnly: true
type: string
x-longDescription: The value of this property shall be the unique identifier
for the resource and it shall be of the form defined in the SPMF specification.
'@odata.type':
example: '#HpeSmartStorageHostBusAdapter.v2_0_0.HpeSmartStorageHostBusAdapter'
readOnly: true
type: string
x-longDescription: The value of this property shall be an absolute URL that
specifies the type of the resource and it shall be of the form defined
in the SPMF specification.
Description:
description: Provides a description of this resource and is used for commonality in
the schema definitions.
example: HPE Smart Storage Host Bus Adapter View
nullable: true
readOnly: true
type: string
x-longDescription: This object represents the Description property. All
values for resources described by this schema shall comply to the requirements
as described in the Redfish specification.
FirmwareVersion:
description: The schema definition for the current firmware version.
properties:
Current:
description: This object contains information about the version of a
firmware image.
properties:
VersionString:
description: This string represents the version of the firmware
image.
example: N/A
nullable: true
readOnly: true
type: string
x-added: iLO 5 1.10
readOnly: true
type: object
x-added: iLO 5 1.10
readOnly: true
type: object
x-added: iLO 5 1.10
HardwareRevision:
description: The hardware revision of the controller
readOnly: true
type: string
x-added: iLO 5 1.10
Id:
description: Uniquely identifies the resource within the collection of like
resources.
example: '0'
readOnly: true
type: string
x-added: iLO 5 1.10
x-longDescription: This property represents an identifier for the resource. All
values for resources described by this schema shall comply to the requirements
as described in the Redfish specification.
Links:
description: The URIs to the resource related to HpSmartStorageHostBusAdapter
properties:
Drives:
description: link to collection of membertype HpSmartStorageDiskDrive.
properties:
'@odata.id':
example: /Systems/1/SmartStorage/HostBusAdapters/0/DiskDrives/
format: uri
readOnly: true
type: string
x-longDescription: The value of this property shall be the unique
identifier for the resource and it shall be of the form defined
in the SPMF specification.
readOnly: true
type: object
x-added: iLO 5 1.10
StorageEnclosures:
description: link to collection of membertype HpSmartStorageStorageEnclosure
properties:
'@odata.id':
format: uri
readOnly: true
type: string
x-longDescription: The value of this property shall be the unique
identifier for the resource and it shall be of the form defined
in the SPMF specification.
readOnly: true
type: object
x-added: iLO 5 1.10
readOnly: true
type: object
x-added: iLO 5 1.10
Location:
description: Location identifier
example: System Board
readOnly: true
type: string
x-added: iLO 5 1.10
LocationFormat:
description: 'Format for Location Identifier
Defined values are:
* `PCISlot`: The PCI slot the controller is located at. For embedded controllers,
the slot is 0
'
enum:
- PCISlot
example: PCISlot
readOnly: true
type: string
x-added: iLO 5 1.10
Manufacturer:
description: The manufacturer of the controller
readOnly: true
type: string
x-added: iLO 5 1.10
Model:
description: The model number for the controller
example: Standard IDE Controller
readOnly: true
type: string
x-added: iLO 5 1.10
Name:
description: The name of the resource or array element.
example: HpeSmartStorageHostBusAdapter
readOnly: true
type: string
x-added: iLO 5 1.10
Oem:
description: This object represents the Oem property.
readOnly: true
SerialNumber:
description: The serial number for this controller
example: xxxxxxxxxx
readOnly: true
type: string
x-added: iLO 5 1.10
Status:
properties:
Health:
description: 'This represents the health state of this resource in the
absence of its dependent resources.
Defined values are:
* `OK`: Normal
* `Warning`: A condition exists that requires attention
* `Critical`: A critical condition exists that requires immediate
attention
'
enum:
- OK
- Warning
- Critical
example: OK
nullable: true
readOnly: true
type: string
x-added: iLO 5 1.10
x-longDescription: This property shall represent the HealthState of
the resource without considering its dependent resources. The values
shall conform to those defined in the Redfish specification.
HealthRollup:
description: 'This represents the overall health state from the view
of this resource.
Defined values are:
* `OK`: Normal
* `Warning`: A condition exists that requires attention
* `Critical`: A critical condition exists that requires immediate
attention
'
enum:
- OK
- Warning
- Critical
nullable: true
readOnly: true
type: string
x-added: iLO 5 1.10
x-longDescription: This property shall represent the HealthState of
the resource and its dependent resources. The values shall conform
to those defined in the Redfish specification.
State:
description: 'This indicates the known state of the resource, such as
if it is enabled.
Defined values are:
* `Enabled`: This function or resource has been enabled.
* `Disabled`: This function or resource has been disabled.
* `StandbyOffline`: This function or resource is enabled, but awaiting
an external action to activate it.
* `StandbySpare`: This function or resource is part of a redundancy
set and is awaiting a failover or other external action to activate
it.
* `InTest`: This function or resource is undergoing testing.
* `Starting`: This function or resource is starting.
* `Absent`: This function or resource is not present or not detected.
* `UnavailableOffline`: This function or resource is present but cannot
be used.
* `Deferring`: The element will not process any commands but will
queue new requests.
* `Quiesced`: The element is enabled but only processes a restricted
set of commands.
* `Updating`: The element is updating and may be unavailable or degraded.
'
enum:
- Enabled
- Disabled
- StandbyOffline
- StandbySpare
- InTest
- Starting
- Absent
- UnavailableOffline
- Deferring
- Quiesced
- Updating
example: Enabled
nullable: true
readOnly: true
type: string
x-added: iLO 5 1.10
x-longDescription: This property shall represent if this component is
available or not and why. Enabled indicates the resource is available. Disabled
indicates the resource has been intentionally made unavailable but
it can be enabled. Offline indicates the resource is unavailable
intentionally and requires action to be made available. InTest indicates
that the component is undergoing testing. Starting indicates that
the resource is on its way to becoming available. Absent indicates
the resources is physically unavailable.
type: object
x-added: iLO 5 1.10
readOnly: true
type: object
HpeSmartStorageHostBusAdapterCollection:
properties:
'@odata.context':
example: /$metadata#HpeSmartStorageHostBusAdapterCollection.HpeSmartStorageHostBusAdapterCollection
format: uri
readOnly: true
type: string
x-longDescription: The value of this property shall be the context URL that
describes the resource according to OData-Protocol and shall be of the
form defined in the SPMF specification.
'@odata.etag':
example: W/\75983E8D\""
readOnly: true
type: string
x-longDescription: The value of this property is the Etag of the resource.
'@odata.id':
example: /Systems/1/SmartStorage/HostBusAdapters/
format: uri
readOnly: true
type: string
x-longDescription: The value of this property shall be the unique identifier
for the resource and it shall be of the form defined in the SPMF specification.
'@odata.type':
example: '#HpeSmartStorageHostBusAdapterCollection.HpeSmartStorageHostBusAdapterCollection'
readOnly: true
type: string
x-longDescription: The value of this property shall be an absolute URL that
specifies the type of the resource and it shall be of the form defined
in the SPMF specification.
Description:
description: Provides a description of this resource and is used for commonality in
the schema definitions.
example: HPE Smart Storage Host Bus Adapters View
nullable: true
readOnly: true
type: string
x-longDescription: This object represents the Description property. All
values for resources described by this schema shall comply to the requirements
as described in the Redfish specification.
Members:
description: Contains the members of this collection.
items:
properties:
'@odata.id':
example: /Systems/1/SmartStorage/HostBusAdapters/0/
format: uri
readOnly: true
type: string
x-longDescription: The value of this property shall be the unique
identifier for the resource and it shall be of the form defined
in the SPMF specification.
type: object
readOnly: true
type: array
Members@odata.count:
description: The total number of collection members.
example: '0'
readOnly: true
type: integer
Name:
description: The name of the resource or array element.
example: HpeSmartStorageHostBusAdapters
readOnly: true
type: string
Oem:
description: This object represents the Oem property.
readOnly: true
x-longDescription: The value of this string shall be of the format for the
reserved word *Oem*.
type: object
HpeSmartStorageLogicalDrive:
description: HpSmartStorageLogicalDrive
properties:
'@odata.context':
example: /$metadata#HpeSmartStorageLogicalDrive.HpeSmartStorageLogicalDrive
format: uri
readOnly: true
type: string
x-longDescription: The value of this property shall be the context URL that
describes the resource according to OData-Protocol and shall be of the
form defined in the SPMF specification.
'@odata.etag':
example: W/\FE98D16A\
readOnly: true
type: string
x-longDescription: The value of this property is the Etag of the resource.
'@odata.id':
example: /Systems/1/SmartStorage/ArrayControllers/0/LogicalDrives/1/
format: uri
readOnly: true
type: string
x-longDescription: The value of this property shall be the unique identifier
for the resource and it shall be of the form defined in the SPMF specification.
'@odata.type':
example: '#HpeSmartStorageLogicalDrive.v2_1_1.HpeSmartStorageLogicalDrive'
readOnly: true
type: string
x-longDescription: The value of this property shall be an absolute URL that
specifies the type of the resource and it shall be of the form defined
in the SPMF specification.
AccelerationMethod:
description: 'The acceleration method of the logical drive
Defined values are:
* `None`: Logical drive acceleration is disabled
* `ControllerCache`: Reads and writes to the logical drive are being cached
by the controller.
* `IOBypass`: For logical drives on SSDs, read and write information directly
from the drive.
* `SmartCache`: Reads and writes to the logical drive are being cached
by a caching logical drive.
'
enum:
- None
- ControllerCache
- IOBypass
- SmartCache
example: IOBypass
readOnly: true
type: string
x-added: iLO 5 1.20
BlockSizeBytes:
description: The block size of the disk drive in bytes
readOnly: true
type: integer
x-added: iLO 5 1.10
CapacityMiB:
description: Total usable capacity available on this logical drive in MiB
units
example: '114439'
readOnly: true
type: integer
x-added: iLO 5 1.10
Description:
description: Provides a description of this resource and is used for commonality in
the schema definitions.
example: HPE Smart Storage Logical Drive View
nullable: true
readOnly: true
type: string
x-longDescription: This object represents the Description property. All
values for resources described by this schema shall comply to the requirements
as described in the Redfish specification.
DriveAccessName:
description: The access ID of the logical drive given by the OS
readOnly: true
type: string
x-added: iLO 5 1.10
DriveGeometryCylinders:
description: The number of cylinders on the drive
readOnly: true
type: string
x-added: iLO 5 1.10
DriveGeometryHeads:
description: The number of heads on the drive
readOnly: true
type: string
x-added: iLO 5 1.10
DriveGeometrySectors:
description: The number of sectors on the drive
readOnly: true
type: string
x-added: iLO 5 1.10
Id:
description: Uniquely identifies the resource within the collection of like
resources.
example: '1'
readOnly: true
type: string
x-added: iLO 5 1.10
x-longDescription: This property represents an identifier for the resource. All
values for resources described by this schema shall comply to the requirements
as described in the Redfish specification.
InterfaceType:
description: 'The connection interface of the logical drive.
Defined values are:
* `SAS`: SAS
* `SATA`: SATA
* `Mixed`: Contains both SAS and SATA.
* `Unknown`: Information is unavailable
'
enum:
- SAS
- SATA
- Mixed
- Unknown
example: SATA
readOnly: true
type: string
x-added: iLO 5 1.10
LegacyBootPriority:
description: 'Defined values are:
* `Primary`: This indicates that the array controller should provide legacy
boot support (Interrupt 13h BIOS support) for this logical drive. The
logical drive will be listed as first in the LUN list returned via SCSI
commands
* `Secondary`: This indicates that the array controller should provide
legacy boot support (Interrupt 13h BIOS support) for this logical drive.
The logical drive will be listed as second in the LUN list returned via
SCSI commands
* `None`: Legacy boot not supported on this logical drive
'
enum:
- Primary
- Secondary
- None
example: None
readOnly: true
type: string
x-added: iLO 5 1.10
Links:
description: The URIs to the resource related to HpSmartStorageLogicalDrive
properties:
ActiveSpareDrives:
description: link to collection of membertype HpSmartStorageDiskDrive. This
represents the list of drives configured as spare drives for this
logical drive and are currently active.
properties:
'@odata.id':
format: uri
readOnly: true
type: string
x-longDescription: The value of this property shall be the unique
identifier for the resource and it shall be of the form defined
in the SPMF specification.
readOnly: true
type: object
x-added: iLO 5 1.10
DataDrives:
description: link to collection of membertype HpSmartStorageDiskDrive.
This represents the list of data drives configured as part of this
logical drive.
properties:
'@odata.id':
example: /Systems/1/SmartStorage/ArrayControllers/0/LogicalDrives/1/DataDrives/
format: uri
readOnly: true
type: string
x-longDescription: The value of this property shall be the unique
identifier for the resource and it shall be of the form defined
in the SPMF specification.
readOnly: true
type: object
x-added: iLO 5 1.10
StandbySpareDrives:
description: link to collection of membertype HpSmartStorageDiskDrive. This
represents the list of drives configured as spare drives for this
logical drive and are currently not active.
properties:
'@odata.id':
format: uri
readOnly: true
type: string
x-longDescription: The value of this property shall be the unique
identifier for the resource and it shall be of the form defined
in the SPMF specification.
readOnly: true
type: object
x-added: iLO 5 1.10
TransientDataDrives:
description: link to collection of membertype HpSmartStorageDiskDrive. This
represents the list of drives that are currently transitioning from
a data drive to unconfigured or vice versa as part of logical drive
transformation operation.
properties:
'@odata.id':
format: uri
readOnly: true
type: string
x-longDescription: The value of this property shall be the unique
identifier for the resource and it shall be of the form defined
in the SPMF specification.
readOnly: true
type: object
x-added: iLO 5 1.10
readOnly: true
type: object
x-added: iLO 5 1.10
LogicalDriveEncryption:
description: True if encryption is currently enabled on this logical drive,
false otherwise
example: 'false'
readOnly: true
type: boolean
x-added: iLO 5 1.10
LogicalDriveEncryptionDataKeysVolatile:
description: True if volatile keys are enabled for encryption, false otherwise
readOnly: true
type: boolean
x-added: iLO 5 1.10
LogicalDriveEncryptionDataKeysVolatileBackup:
description: True if volatile keys are backed up to a remote key manager,
false if volatile keys are not backed up
readOnly: true
type: boolean
x-added: iLO 5 1.10
LogicalDriveEncryptionDataKeysVolatileStatus:
description: 'The status of the encryption volatile keys
Defined values are:
* `NoOp`: No operations are pending for the volatile keys
* `BackupInProgress`: The volatile keys are being backed up to a remote
key manager
* `BackupAndSetInProgress`: The volatile keys are being set and being
backed up to a remote key manager
* `RestoreInProgress`: The volatile keys are being restored from a remote
key manager
* `DeleteInProgress`: The volatile keys are being removed
'
enum:
- NoOp
- BackupInProgress
- BackupAndSetInProgress
- RestoreInProgress
- DeleteInProgress
readOnly: true
type: string
x-added: iLO 5 1.10
LogicalDriveName:
description: Label given to the logical drive
example: 0254FE26PEYHC0ARH730B6 8DB7
readOnly: true
type: string
x-added: iLO 5 1.10
LogicalDriveNumber:
description: logical drive number
example: '1'
readOnly: true
type: integer
x-added: iLO 5 1.10
LogicalDriveStatusReasons:
description: A list of logical drive status details
items:
description: 'Defined values are:
* `Unknown`: The state of the logical drive is unknown
* `Ok`: The logical drive is in normal operation mode
* `Failed`: Indicates that more physical drives have failed than the
fault tolerance mode of the logical drive can handle without data loss
* `Unconfigured`: The logical drive is not configured
* `Recovering`: The logical drive is using Interim Recovery Mode. In
Interim Recovery Mode, at least one physical drive has failed, but the
logical drive''s fault tolerance mode lets the drive continue to operate
with no data loss
* `ReadyForRebuild`: The logical drive is ready for Automatic Data Recovery.
A failed physical drive has been replaced, but the logical drive is
still operating in Interim Recovery Mode
* `Rebuilding`: The logical drive is currently doing Automatic Data
Recovery, where fault tolerance algorithms restore data to the replacement
drive
* `WrongDrive`: The wrong physical drive was replaced after a failure
* `BadConnect`: A physical drive is not responding
* `Overheating`: The drive array enclosure that contains the logical
drive is overheating. The drive array is still functional, but should
be shutdown
* `Shutdown`: The drive array enclosure that contains the logical drive
has overheated. The logical drive is no longer functional
* `Expanding`: The logical drive is currently undergoing a transformation
(expansion, shrinkage or movement). During transformation, fault tolerance
algorithms redistribute logical drive data according to the transformation
operation selected
* `NotAvailable`: The logical drive is currently unavailable. If a logical
drive is expanding and the new configuration frees additional disk space,
this free space can be configured into another logical volume. If this
is done, the new volume will be set to not available
* `QueuedForExpansion`: The logical drive is ready for transformation
(expansion, shrinkage or movement). The logical drive is in the queue
for transformation
* `MultipathAccessDegraded`: Previously all disk drives of this logical
drive had more than one I/O path to the controller, but now one or few
of them have only one I/O path
* `Erasing`: The logical drive is currently being erased
* `PredictiveSpareRebuildReady`: The logical drive is ready to perform
a predictive spare rebuild. The logical drive is in the queue for rebuild
* `RapidParityInitInProgress`: The logical drive is currently undergoing
rapid parity initialization (RPI). The logical drive is unavailable
to the operating system during RPI and will be made available once RPI
has completed
* `RapidParityInitPending`: The logical drive is currently pending RPI
and will be unavailable
* `NoAccessEncryptedNoControllerKey`: The logical drive is currently
encrypted and cannot be accessed because the array controller has not
yet received the encryption key nor was it found in the controller''s
CSP NVRAM
* `UnencryptedToEncryptedInProgress`: The logical drive is currently
being transformed from unencrypted to encrypted and the volume is online.
Data will be written unencrypted if the write is directed to an LBA
range on th e logical drive that has not yet been migrated
* `NewKeyRekeyInProgress`: The logical drive is currently encrypted
and all data is currently being rekeyed with a new logical drive key
using the background capacity expansion transformation task. The logical
drive is online
* `NoAccessEncryptedControllerEncryptionNotEnabled`: The logical drive
is currently encrypted and cannot be accessed because the array controller
does not have encryption enabled
* `UnencryptedToEncryptedNotStarted`: The logical drive has received
a request to transform from unencrypted to encrypted but this process
has not yet started. The unencrypted logical drive is currently online
* `NewLogDrvKeyRekeyRequestReceived`: The logical drive is encrypted
and has received a request to rekey all data with a new logical drive
encryption key. The logical drive is online
'
enum:
- Unknown
- Ok
- Failed
- Unconfigured
- Recovering
- ReadyForRebuild
- Rebuilding
- WrongDrive
- BadConnect
- Overheating
- Shutdown
- Expanding
- NotAvailable
- QueuedForExpansion
- MultipathAccessDegraded
- Erasing
- PredictiveSpareRebuildReady
- RapidParityInitInProgress
- RapidParityInitPending
- NoAccessEncryptedNoControllerKey
- UnencryptedToEncryptedInProgress
- NewKeyRekeyInProgress
- NoAccessEncryptedControllerEncryptionNotEnabled
- UnencryptedToEncryptedNotStarted
- NewLogDrvKeyRekeyRequestReceived
type: string
readOnly: true
type: array
x-added: iLO 5 1.40
LogicalDriveType:
description: 'How the logical drive is being used
Defined values are:
* `Data`: The drive is being used as a storage drive
* `Cache`: The drive is being used as a cache drive for a different storage
drive
* `SplitMirrorSetPrimary`: This drive is being used as the primary storage
drive of a split mirror set after a Split Mirror Array has been performed
* `SplitMirrorSetBackup`: This drive is being used as the backup storage
drive of a split mirror set after a Split Mirror Array has been performed
* `SplitMirrorSetBackupOrphan`: This drive was being used as the backup
storage drive of a split mirror set that no longer exists
'
enum:
- Data
- Cache
- SplitMirrorSetPrimary
- SplitMirrorSetBackup
- SplitMirrorSetBackupOrphan
example: Data
readOnly: true
type: string
x-added: iLO 5 1.10
MediaType:
description: 'Type of the disk this logical drive is associated with.
Defined values are:
* `HDD`: Spinning disk hard drive.
* `SSD`: Solid state disk.
* `SMR`: Shingled Magnetic Recording.
* `Mixed`: Contains both HDD and SSD.
* `Unknown`: Information is unavailable
'
enum:
- HDD
- SSD
- SMR
- Mixed
- Unknown
example: SSD
readOnly: true
type: string
x-added: iLO 5 1.10
Name:
description: The name of the resource or array element.
example: HpeSmartStorageLogicalDrive
readOnly: true
type: string
x-added: iLO 5 1.10
Oem:
description: This object represents the Oem property.
readOnly: true
ParityInitializationCompletionPercentage:
description: Parity initialization complete percentage for a parity based
logical drive (e.g. RAID 5)
readOnly: true
type: integer
x-added: iLO 5 1.10
ParityInitializationType:
description: 'When creating a logical drive with a RAID level that requires
parity, parity blocks can be initialized with two different methods
Defined values are:
* `Default`: Parity blocks are initialized in the background and the logical
drive is available during this time
* `Rapid`: Both data and parity blocks are initialized in the foreground
and the logical drive will not be available to the operating system until
initialization completes
'
enum:
- Default
- Rapid
readOnly: true
type: string
x-added: iLO 5 1.10
PartitionInformation:
description: OS partition information for the drive
readOnly: true
type: string
x-added: iLO 5 1.10
Raid:
description: 'The current RAID level configured on the logical drive
Defined values are:
* `0`: There is no fault tolerance used on this logical drive
* `1`: Two sets of duplicate data is being stored on a pair of drives
* `1ADM`: Three sets of duplicate data is being stored on a trio of drives
* `10`: Data is duplicated and striped across pairs of disk drives
* `10ADM`: Data is duplicated and striped across trios of disk drives
* `5`: Fault tolerance is achieved by storing parity data across 3 or
more disk drives
* `50`: Fault tolerance is achieved by storing parity data and striping
the data across 6 or more disk drives
* `6`: Fault tolerance is achieved by storing multiple sets parity data
across 4 or more disk drives
* `60`: Fault tolerance is achieved by storing multiple sets parity data
and striping the data across 8 or more disk drives
'
enum:
- '0'
- '1'
- 1ADM
- '10'
- 10ADM
- '5'
- '50'
- '6'
- '60'
example: '0'
readOnly: true
type: string
RebuildCompletionPercentage:
description: The percent complete for a rebuild operation currently occurring
on the logical drive
readOnly: true
type: integer
x-added: iLO 5 1.10
SmartCacheState:
description: 'The state of the SmartCache cache. This is valid if this drive
either is a cache drive, or has a cache drive attached to it
Defined values are:
* `Good`: The cache is functioning properly
* `Limited`: The cache is functioning in a degraded mode, and may not
be functioning at maximum performance
* `DDRUnsafe`: The DDR is unsafe for the cache drive
* `CacheLUNOffline`: The cache drive is offline
* `PrimaryLUNOffline`: The primary logical drive that is being cached
is offline
* `Destroyed`: The cache is destroyed and not functional
* `Flushing`: The cache drive is flushing
* `Configuring`: The caching pair is being configured
* `PairFailAtPowerup`: The primary and cache drive were unable to be paired
at powerup
* `Unknown`: The state of the cache is unknown
'
enum:
- Good
- Limited
- DDRUnsafe
- CacheLUNOffline
- PrimaryLUNOffline
- Destroyed
- Flushing
- Configuring
- PairFailAtPowerup
- Unknown
readOnly: true
type: string
x-added: iLO 5 1.10
Status:
properties:
Health:
description: 'This represents the health state of this resource in the
absence of its dependent resources.
Defined values are:
* `OK`: Normal
* `Warning`: A condition exists that requires attention
* `Critical`: A critical condition exists that requires immediate
attention
'
enum:
- OK
- Warning
- Critical
example: Warning
nullable: true
readOnly: true
type: string
x-added: iLO 5 1.10
x-longDescription: This property shall represent the HealthState of
the resource without considering its dependent resources. The values
shall conform to those defined in the Redfish specification.
HealthRollup:
description: 'This represents the overall health state from the view
of this resource.
Defined values are:
* `OK`: Normal
* `Warning`: A condition exists that requires attention
* `Critical`: A critical condition exists that requires immediate
attention
'
enum:
- OK
- Warning
- Critical
nullable: true
readOnly: true
type: string
x-added: iLO 5 1.10
x-longDescription: This property shall represent the HealthState of
the resource and its dependent resources. The values shall conform
to those defined in the Redfish specification.
State:
description: 'This indicates the known state of the resource, such as
if it is enabled.
Defined values are:
* `Enabled`: This function or resource has been enabled.
* `Disabled`: This function or resource has been disabled.
* `StandbyOffline`: This function or resource is enabled, but awaiting
an external action to activate it.
* `StandbySpare`: This function or resource is part of a redundancy
set and is awaiting a failover or other external action to activate
it.
* `InTest`: This function or resource is undergoing testing.
* `Starting`: This function or resource is starting.
* `Absent`: This function or resource is not present or not detected.
* `UnavailableOffline`: This function or resource is present but cannot
be used.
* `Deferring`: The element will not process any commands but will
queue new requests.
* `Quiesced`: The element is enabled but only processes a restricted
set of commands.
* `Updating`: The element is updating and may be unavailable or degraded.
'
enum:
- Enabled
- Disabled
- StandbyOffline
- StandbySpare
- InTest
- Starting
- Absent
- UnavailableOffline
- Deferring
- Quiesced
- Updating
example: Enabled
nullable: true
readOnly: true
type: string
x-added: iLO 5 1.10
x-longDescription: This property shall represent if this component is
available or not and why. Enabled indicates the resource is available. Disabled
indicates the resource has been intentionally made unavailable but
it can be enabled. Offline indicates the resource is unavailable
intentionally and requires action to be made available. InTest indicates
that the component is undergoing testing. Starting indicates that
the resource is on its way to becoming available. Absent indicates
the resources is physically unavailable.
type: object
x-added: iLO 5 1.10
StripSizeBytes:
description: The strip size of the logical drive in bytes
readOnly: true
type: integer
x-added: iLO 5 1.10
StripeSizeBytes:
description: The stripe size of the logical drive in bytes
example: '262144'
readOnly: true
type: integer
x-added: iLO 5 1.10
TransformationCompletionPercentage:
description: The percent complete for any transformations the logical drive
may be undergoing such as RAID migration, stripesize migration, capacity
expansion etc.
readOnly: true
type: integer
x-added: iLO 5 1.10
VolumeUniqueIdentifier:
description: An identifier (typically SCSI Inquiry based such as Inquiry
VPD Page 0x83 NAA 64 identifier) used to uniquely identify this volume.
example: 600508B1001C874CBB3B49E98F343C23
readOnly: true
type: string
x-added: iLO 5 1.10
readOnly: true
type: object
HpeSmartStorageLogicalDriveCollection:
properties:
'@odata.context':
example: /$metadata#HpeSmartStorageLogicalDriveCollection.HpeSmartStorageLogicalDriveCollection
format: uri
readOnly: true
type: string
x-longDescription: The value of this property shall be the context URL that
describes the resource according to OData-Protocol and shall be of the
form defined in the SPMF specification.
'@odata.etag':
example: W/\AA6D42B0\
readOnly: true
type: string
x-longDescription: The value of this property is the Etag of the resource.
'@odata.id':
example: /Systems/1/SmartStorage/ArrayControllers/0/LogicalDrives/
format: uri
readOnly: true
type: string
x-longDescription: The value of this property shall be the unique identifier
for the resource and it shall be of the form defined in the SPMF specification.
'@odata.type':
example: '#HpeSmartStorageLogicalDriveCollection.HpeSmartStorageLogicalDriveCollection'
readOnly: true
type: string
x-longDescription: The value of this property shall be an absolute URL that
specifies the type of the resource and it shall be of the form defined
in the SPMF specification.
Description:
description: Provides a description of this resource and is used for commonality in
the schema definitions.
example: HPE Smart Storage Logical Drives View
nullable: true
readOnly: true
type: string
x-longDescription: This object represents the Description property. All
values for resources described by this schema shall comply to the requirements
as described in the Redfish specification.
Members:
description: Contains the members of this collection.
items:
properties:
'@odata.id':
example: /Systems/1/SmartStorage/ArrayControllers/0/LogicalDrives/1/
format: uri
readOnly: true
type: string
x-longDescription: The value of this property shall be the unique
identifier for the resource and it shall be of the form defined
in the SPMF specification.
type: object
readOnly: true
type: array
Members@odata.count:
description: The total number of collection members.
example: '1'
readOnly: true
type: integer
Name:
description: The name of the resource or array element.
example: HpeSmartStorageLogicalDrives
readOnly: true
type: string
Oem:
description: This object represents the Oem property.
readOnly: true
x-longDescription: The value of this string shall be of the format for the
reserved word *Oem*.
type: object
HpeSmartStorageStorageEnclosure:
description: HpSmartStorageStorageEnclosure
properties:
'@odata.context':
example: /$metadata#HpeSmartStorageStorageEnclosure.HpeSmartStorageStorageEnclosure
format: uri
readOnly: true
type: string
x-longDescription: The value of this property shall be the context URL that
describes the resource according to OData-Protocol and shall be of the
form defined in the SPMF specification.
'@odata.etag':
example: W/\43EF9FF2\""
readOnly: true
type: string
x-longDescription: The value of this property is the Etag of the resource.
'@odata.id':
example: /Systems/1/SmartStorage/ArrayControllers/0/StorageEnclosures/0/
format: uri
readOnly: true
type: string
x-longDescription: The value of this property shall be the unique identifier
for the resource and it shall be of the form defined in the SPMF specification.
'@odata.type':
example: '#HpeSmartStorageStorageEnclosure.v2_0_0.HpeSmartStorageStorageEnclosure'
readOnly: true
type: string
x-longDescription: The value of this property shall be an absolute URL that
specifies the type of the resource and it shall be of the form defined
in the SPMF specification.
Description:
description: Provides a description of this resource and is used for commonality in
the schema definitions.
example: HPE Smart Storage Enclosure View
nullable: true
readOnly: true
type: string
x-longDescription: This object represents the Description property. All
values for resources described by this schema shall comply to the requirements
as described in the Redfish specification.
DoorLockLED:
description: 'The state of the Door Lock LED. When Lit, this indicates that
the Enclosure should not be removed since the drives are currently in
use.
Defined values are:
* `Unknown`: The state of the Door Lock LED cannot be determined.
* `Lit`: The Door Lock LED is lit.
* `Off`: The Door Lock LED is off.
'
enum:
- Unknown
- Lit
- 'Off'
nullable: true
readOnly: true
type: string
x-added: iLO 5 1.10
DriveBayCount:
description: Number of drive bays supported within the storage enclosure
example: '4'
readOnly: true
type: integer
x-added: iLO 5 1.10
EnclosureLogicalID:
description: Unique ID for the storage enclosure
readOnly: true
type: string
x-added: iLO 5 1.10
FaultLED:
description: 'The state of the Fault LED.
Defined values are:
* `Unknown`: The state of the Fault LED cannot be determined.
* `Lit`: The Fault LED is lit.
* `Off`: The Fault LED is off.
'
enum:
- Unknown
- Lit
- 'Off'
nullable: true
readOnly: true
type: string
x-added: iLO 5 1.10
FirmwareVersion:
description: The schema definition for the current firmware version.
properties:
Current:
description: This object contains information about the version of a
firmware image.
properties:
VersionString:
description: This string represents the version of the firmware
image.
example: ''
nullable: true
readOnly: true
type: string
x-added: iLO 5 1.10
readOnly: true
type: object
x-added: iLO 5 1.10
readOnly: true
type: object
x-added: iLO 5 1.10
Id:
description: Uniquely identifies the resource within the collection of like
resources.
example: '0'
readOnly: true
type: string
x-added: iLO 5 1.10
x-longDescription: This property represents an identifier for the resource. All
values for resources described by this schema shall comply to the requirements
as described in the Redfish specification.
IndicatorLED:
description: 'The state of the indicator LED.
Defined values are:
* `Unknown`: The state of the Indicator LED cannot be determined.
* `Lit`: The Indicator LED is lit.
* `Blinking`: The Indicator LED is blinking.
* `Off`: The Indicator LED is off.
'
enum:
- Unknown
- Lit
- Blinking
- 'Off'
nullable: true
readOnly: true
type: string
x-added: iLO 5 1.10
Links:
description: The URIs to the resource related to HpSmartStorageStorageEnclosure
properties:
Drives:
description: link to a collection of membertype HpSmartStorageDiskDrive
properties:
'@odata.id':
format: uri
readOnly: true
type: string
x-longDescription: The value of this property shall be the unique
identifier for the resource and it shall be of the form defined
in the SPMF specification.
readOnly: true
type: object
x-added: iLO 5 1.10
readOnly: true
type: object
x-added: iLO 5 1.10
Location:
description: Location identifier
example: 1I:0
readOnly: true
type: string
x-added: iLO 5 1.10
LocationFormat:
description: 'Format for Location Identifier
Defined values are:
* `Controller:Box`: This format typically used in controller context where
the drive would be identified using the controller port and JBOD box number
* `SwitchPort:Box`: This format typically used in a SAS switch context
where the drive would be identified using the switch port and JBOD box
number
* `SwitchPort:SwitchBay`: This format typically used in a SAS switch context
where the drive would be identified using the switch port and ICM bay
number for the switch
'
enum:
- Controller:Box
- SwitchPort:Box
- SwitchPort:SwitchBay
example: Controller:Box
readOnly: true
type: string
x-added: iLO 5 1.10
Manufacturer:
description: The manufacturer of the storage enclosure
readOnly: true
type: string
x-added: iLO 5 1.10
Model:
description: The model string for the storage enclosure
example: ''
readOnly: true
type: string
x-added: iLO 5 1.10
Name:
description: The name of the resource or array element.
example: HpSmartStorageEnclosure
readOnly: true
type: string
x-added: iLO 5 1.10
Oem:
description: This object represents the Oem property.
readOnly: true
PartNumber:
description: Part number of this storage enclosure
readOnly: true
type: string
x-added: iLO 5 1.10
SKU:
description: SKU for the storage enclosure
readOnly: true
type: string
x-added: iLO 5 1.10
SerialNumber:
description: The serial number for this storage enclosure
example: xxxxxxxxxx
readOnly: true
type: string
x-added: iLO 5 1.10
Status:
properties:
Health:
description: 'This represents the health state of this resource in the
absence of its dependent resources.
Defined values are:
* `OK`: Normal
* `Warning`: A condition exists that requires attention
* `Critical`: A critical condition exists that requires immediate
attention
'
enum:
- OK
- Warning
- Critical
example: OK
nullable: true
readOnly: true
type: string
x-added: iLO 5 1.10
x-longDescription: This property shall represent the HealthState of
the resource without considering its dependent resources. The values
shall conform to those defined in the Redfish specification.
HealthRollup:
description: 'This represents the overall health state from the view
of this resource.
Defined values are:
* `OK`: Normal
* `Warning`: A condition exists that requires attention
* `Critical`: A critical condition exists that requires immediate
attention
'
enum:
- OK
- Warning
- Critical
nullable: true
readOnly: true
type: string
x-added: iLO 5 1.10
x-longDescription: This property shall represent the HealthState of
the resource and its dependent resources. The values shall conform
to those defined in the Redfish specification.
State:
description: 'This indicates the known state of the resource, such as
if it is enabled.
Defined values are:
* `Enabled`: This function or resource has been enabled.
* `Disabled`: This function or resource has been disabled.
* `StandbyOffline`: This function or resource is enabled, but awaiting
an external action to activate it.
* `StandbySpare`: This function or resource is part of a redundancy
set and is awaiting a failover or other external action to activate
it.
* `InTest`: This function or resource is undergoing testing.
* `Starting`: This function or resource is starting.
* `Absent`: This function or resource is not present or not detected.
* `UnavailableOffline`: This function or resource is present but cannot
be used.
* `Deferring`: The element will not process any commands but will
queue new requests.
* `Quiesced`: The element is enabled but only processes a restricted
set of commands.
* `Updating`: The element is updating and may be unavailable or degraded.
'
enum:
- Enabled
- Disabled
- StandbyOffline
- StandbySpare
- InTest
- Starting
- Absent
- UnavailableOffline
- Deferring
- Quiesced
- Updating
example: Enabled
nullable: true
readOnly: true
type: string
x-added: iLO 5 1.10
x-longDescription: This property shall represent if this component is
available or not and why. Enabled indicates the resource is available. Disabled
indicates the resource has been intentionally made unavailable but
it can be enabled. Offline indicates the resource is unavailable
intentionally and requires action to be made available. InTest indicates
that the component is undergoing testing. Starting indicates that
the resource is on its way to becoming available. Absent indicates
the resources is physically unavailable.
type: object
x-added: iLO 5 1.10
SubEnclosureLocation:
description: Location within the chassis if this storage enclosure is part
of a larger chassis hosting multiple storage enclosures
readOnly: true
type: string
x-added: iLO 5 1.10
readOnly: true
type: object
HpeSmartStorageStorageEnclosureCollection:
properties:
'@odata.context':
example: /$metadata#HpeSmartStorageStorageEnclosureCollection.HpeSmartStorageStorageEnclosureCollection
format: uri
readOnly: true
type: string
x-longDescription: The value of this property shall be the context URL that
describes the resource according to OData-Protocol and shall be of the
form defined in the SPMF specification.
'@odata.etag':
example: W/\570254F2\""
readOnly: true
type: string
x-longDescription: The value of this property is the Etag of the resource.
'@odata.id':
example: /Systems/1/SmartStorage/ArrayControllers/0/StorageEnclosures/
format: uri
readOnly: true
type: string
x-longDescription: The value of this property shall be the unique identifier
for the resource and it shall be of the form defined in the SPMF specification.
'@odata.type':
example: '#HpeSmartStorageStorageEnclosureCollection.HpeSmartStorageStorageEnclosureCollection'
readOnly: true
type: string
x-longDescription: The value of this property shall be an absolute URL that
specifies the type of the resource and it shall be of the form defined
in the SPMF specification.
Description:
description: Provides a description of this resource and is used for commonality in
the schema definitions.
example: HPE Smart Storage Enclosures View
nullable: true
readOnly: true
type: string
x-longDescription: This object represents the Description property. All
values for resources described by this schema shall comply to the requirements
as described in the Redfish specification.
Members:
description: Contains the members of this collection.
items:
properties:
'@odata.id':
example: /Systems/1/SmartStorage/ArrayControllers/0/StorageEnclosures/0/
format: uri
readOnly: true
type: string
x-longDescription: The value of this property shall be the unique
identifier for the resource and it shall be of the form defined
in the SPMF specification.
type: object
readOnly: true
type: array
Members@odata.count:
description: The total number of collection members.
example: '2'
readOnly: true
type: integer
Name:
description: The name of the resource or array element.
example: HpSmartStorageEnclosures
readOnly: true
type: string
Oem:
description: This object represents the Oem property.
readOnly: true
x-longDescription: The value of this string shall be of the format for the
reserved word *Oem*.
type: object
HpeTlsConfig:
description: The schema definition for TLS configuration.
properties:
'@Redfish.Settings':
properties:
ETag:
description: The ETag of the resource to which the settings were applied,
after the application.
example: ''
nullable: true
readOnly: true
type: string
x-longDescription: The value of this property shall be the ETag of the
resource to which the settings were applied, after the application. This
is here so that the client can check it against the ETag of the current
resource to see if any other changes have also happened to the resource.
Messages:
description: This is an array of messages associated with the task.
items:
properties:
Message:
description: This is the human readable message, if provided.
nullable: true
type: string
x-longDescription: This property shall contain an optional human
readable message.
MessageArgs:
description: This array of message arguments are substituted for
the arguments in the message when looked up in the message registry.
items:
type: string
type: array
x-longDescription: This property shall contain the message substitution
arguments for the specific message referenced by the MessageId
and shall only be included if the MessageId is present.
MessageId:
description: This is the key for this message which can be used
to look up the message in a message registry.
example: Base.1.0.Success
type: string
x-longDescription: This property shall be a key into message registry
as described in the Redfish specification.
RelatedProperties:
description: This is an array of properties described by the message.
items:
type: string
type: array
x-longDescription: This property shall contain an array of JSON
Pointers indicating the properties described by the message,
if appropriate for the message.
Resolution:
description: Used to provide suggestions on how to resolve the
situation that caused the error.
nullable: true
type: string
x-longDescription: This property shall contain an override of
the Resolution of the message in message registry, if present.
Severity:
description: This is the severity of the errors.
nullable: true
type: string
x-longDescription: The value of this property shall be the severity
of the error, as defined in the Status section of the Redfish
specificaiton.
type: object
readOnly: true
type: array
x-longDescription: The value of this property shall be an array of messages
associated with the task.
SettingsObject:
description: Reference to the resource the client may PUT/PATCH to in
order to change this resource.
properties:
'@odata.id':
description: The unique identifier for a resource.
example: /systems/1/bios/tlsconfig/settings/
format: uri
readOnly: true
type: string
x-longDescription: The value of this property shall be the unique
identifier for the resource and it shall be of the form defined
in the Redfish specification.
readOnly: true
type: object
x-longDescription: The value of this property shall be the URI of the
resource to which a client must do a PUT or PATCh in order to modify
this resource.
Time:
description: Indicates the time the settings were applied.
example: 'null'
format: date-time
nullable: true
readOnly: true
type: string
x-longDescription: The value of this property shall indicate the time
that the settings object was applied to the resource.
type: object
'@odata.context':
description: The OData description of a payload.
example: /$metadata#HpeTlsConfig.HpeTlsConfig
format: uri
readOnly: true
type: string
x-longDescription: The value of this property shall be the context URL that
describes the resource according to OData-Protocol and shall be of the
form defined in the Redfish specification.
'@odata.etag':
example: W/\28F385EA989AD0D0D053F745E614B9D6\""
readOnly: true
type: string
x-longDescription: The value of this property is the Etag of the resource.
'@odata.id':
description: The unique identifier for a resource.
example: /systems/1/bios/tlsconfig/settings/
format: uri
readOnly: true
type: string
x-longDescription: The value of this property shall be the unique identifier
for the resource and it shall be of the form defined in the Redfish specification.
'@odata.type':
description: The type of a resource.
example: '#HpeTlsConfig.v1_0_0.HpeTlsConfig'
readOnly: true
type: string
x-longDescription: The value of this property shall be an absolute URL that
specifies the type of the resource and it shall be of the form defined
in the Redfish specification.
Certificates:
description: It holds the informations of the installed certificates.
items:
description: A single certificate.
properties:
FingerPrint:
description: The fingerprint of the certificate. It is the sha256
(SHA2) of the Der format of the certificate
readOnly: true
type: string
Issuer:
description: The Issuer of the certificate
readOnly: true
type: string
SerialNumber:
description: The Serial Number of the certificate.
example: xxxxxxxxxx
readOnly: true
type: string
Subject:
description: The Subject of the certificate.
readOnly: true
type: string
ValidNotAfter:
description: The expiration date of the certificate.
readOnly: true
type: string
ValidNotBefore:
description: The date when the certificate becomes valid.
readOnly: true
type: string
type: object
readOnly: true
type: array
Ciphers:
description: 'The encryption used. It can have more than one type of encryption,
example: "AES128-SHA:AES256-SHA:AES128-SHA256:AES256-SHA256"'
example: AES128-SHA:AES256-SHA:AES128-SHA256:AES256-SHA256:AES128-GCM-SHA256:AES256-GCM-SHA384
readOnly: false
type: string
DeleteCertificates:
description: It holds the fingerprints of the Certificates that needs deleting
items:
properties:
FingerPrint:
description: 'To delete a certificate, the user should place its fingerprint
here. The fingerprint would be found as a property under the single
certificate object in the "Certificates" array '
readOnly: false
type: string
type: object
readOnly: false
type: array
HostnameCheck:
description: 'Use this option to enable or disable verification of the connected
server''s hostname with the hostname in the certificate supplied by the
server
Defined values are:
* `Disabled`: Disable verification of the connected server''s hostname.
* `Enabled`: enable verification of the connected server''s hostname.
'
enum:
- Disabled
- Enabled
example: Disabled
readOnly: false
type: string
Id:
description: Uniquely identifies the resource within the collection of like
resources.
example: settings
readOnly: true
type: string
x-longDescription: This property represents an identifier for the resource. All
values for resources described by this schema shall comply to the requirements
as described in the Redfish specification.
Name:
description: The name of the resource or array element.
example: TLS Pending Settings
readOnly: true
type: string
x-longDescription: This object represents the Name property. All values
for resources described by this schema shall comply to the requirements
as described in the Redfish specification. The value of this string shall
be of the format for the reserved word *Name*.
NewCertificates:
description: It holds the body (PEM format) of the Certificates to be added
items:
properties:
X509Certificate:
description: the body (PEM format) of the Certificate to be ad
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment