This HPE iLO Redfish API documentation is deprecated. See the HPE iLO Redfish documentation for the latest documentation.

NAV Navbar
Logo
cURL python

Introduction

The iLO RESTful API for HPE iLO 5 is a programming interface enabling state-of-the-art server management. This document contains helpful information about how to interact with the iLO RESTful API. The iLO RESTful API uses the basic HTTP operations (GET, PUT, POST, DELETE, and PATCH) to submit or return a JSON formatted resource to or from a URI on iLO 5.

With modern scripting languages, you can easily write simple REST clients for RESTful APIs. Most languages, like Python, can transform JSON into internal-data structures, like dictionaries, allowing for easy access to data. This enables you to write custom code directly to the iLO RESTful API, instead of using intermediate tools such as HPE’s HPQLOCFG or CONREP.

Redfish Conformance

iLO 5’s Redfish conformance details are available in this document in the Managing Hewlett Packard Enterprise Servers Using the RESTful API.

Key benefits of the iLO RESTful API

The iLO RESTful API is becoming the main management interface for Hewlett Packard Enterprise servers with iLO 5. Its feature set will become larger than the existing iLO XML API (RIBCL) and IPMI interfaces. Using the iLO RESTful API, you can take full inventory of the server, control power and reset, configure BIOS and iLO settings, fetch event logs, as well as many other functions.

The iLO RESTful API follows the trend of the Internet in moving to a common pattern for new software interfaces. Many web services in a variety of industries use REST APIs because they are easy to implement, easy to consume, and offer scalability advantages over previous technologies.

HPE OneView, OpenStack, and many other server management APIs are now REST APIs. Most Hewlett Packard Enterprise Management software offerings, as well as the entire Software Defined Infrastructure, are built upon REST APIs.

The iLO RESTful API has the additional advantage of consistency across all present and projected server architectures. The same data model works for traditional rack-mount servers, blades, as well as newer types of systems. This advantage comes because the data model is designed to self-describe the service’s capabilities to the client and has room for flexibility designed in from the start

Changelog

The HPE iLO 5 Redfish service implements the DMTF Redfish specification version 1.6.0 and the schemas implemented by iLO 5 adhere to the DMTF Redfish schema bundle 8010_2021.4.

For a better understanding of the conformance to the DMTF Redfish, read the Redfish versioning paragraph of this article.

iLO 5 2.95 new features and changes

New URIs

HTTP Methods - Additions and Deprecations

Deprecated URIs

Redfish actions - additions and deprecations

Schema Updates

iLO 5 2.90 new features and changes

New URIs

HTTP Methods - Additions and Deprecations

Deprecated URIs

Redfish actions - additions and deprecations

Schema Updates

iLO 5 2.81 new features and changes

New URIs

HTTP Methods - Additions and Deprecations

Deprecated URIs

Redfish actions - additions and deprecations

Schema Updates

iLO 5 2.78 new features and changes

New URIs

HTTP Methods - Additions and Deprecations

Deprecated URIs

Miscellenuous Information

Schema Updates

iLO 5 2.72 new features and changes

New URIs

Miscellaneous Changes

iLO 5 v2.72 supports enabling and disabling of HTTP and HTTPS ports separately using Redfish APIs. Ensure you enable both HTTP and HTTPS, if you want to downgrade the firmware below iLO 5 v2.72, else the web server will not start.

HTTP methods - additions and deprecations

Deprecated URIs

NOTE: From iLO 5 2.72 release, HPE Insight Online direct connectis deprecated. HPE now supports only Insight Remote Support central connect. If you are using HPE Insight Online direct connect, HPE recommends to unregister Insight Online direct connect and register with Insight Remote Support central connect. For more information, see the HPE embedded remote support section of the HPE iLO 5 2.72 User Guide.

#HpeRemoteSupport.v2_6_0.HpeRemoteSupport - ConnectModel (the Remote Support connect model type) will not support the value of DirectConnect. - DataCollectionFrequencyInDays (the frequency of data collection in days. This is applicable only when the server is registered using Direct Connect.) will not apply as HPE Insight Online direct connectis deprecated in this release. - DirectConnectRegistrationIsCompleted (Step 2 of Direct Connect Registration completion status) will not apply as HPE recommends to unregister HPE Insight Online direct connect and HPE Insight Online direct connectis deprecated in this release. - HpeRemoteSupport.CompleteDirectConnectRegistration: There are no parameters for this action, but this action is not applicable when HPE Insight Online direct connectis deprecated in this release. - HpeRemoteSupport.RegisterDeviceToRemoteSupport: This action includes ConnectionType (string)as a parameter. But, ConnectionType (string) will not support the value DirectConnect.

Redfish actions - additions and deprecations

Schema updates

Before iLO 5 v2.72:

    "Oem": {
            "Hpe": {
              "Links": {
                "PCIDevices": {
                  "@odata.id": "/redfish/v1/Systems/1/PCIDevices/"
                },
              },
            }
          },

From iLO 5 v2.72 onwards:

      "Oem": {
            "Hpe": {
              "Links": {
                "PCIDevices": [
                  {
                    "@odata.id": "/redfish/v1/Systems/1/PCIDevices/"
                  }
                ]
              },
            }
          },

iLO 5 2.70 new features and changes

New URIs

HTTP methods - additions and deprecations

No changes have been made to HTTP methods in this release.

Deprecated URIs

No URIs deprecated for this release.

Redfish actions - additions and deprecations

No changes have been made to supported Redfish actions in this release.

Schema updates

iLO 5 2.65 new features and changes

New URIs

#Port.v1_5_0.Port - The HPE iLO 5 Redfish service implements the Port schema in this release as the NetworkPort schema will be deprecated in favor of the Port schema. The NetworkPort URIs will work as expected for all future releases from iLO 5 v2.65.

The following resource instances are added in this schema:

#Port.v1_5_0.Port includes the following properties:

#PortCollection.PortCollection - A Collection of NetworkPort resource instances.

The following resource instances are added in this schema:

#SerialInterfaceCollection.SerialInterfaceCollection

The following resource instance is added in this schema:

#SerialInterface.v1_1_7.SerialInterface

The following resource instance is added in this schema:

HTTP methods - additions and deprecations

No changes have been made to HTTP methods for this release.

Deprecated URIs

Redfish actions - additions and deprecations

No changes have been made to supported Redfish actions for this release.

Schema updates

iLO 5 2.60 new features and changes

New URIs

HTTP methods - additions and deprecations

Deprecated URIs

No URIs deprecated for this release.

Redfish actions - additions and deprecations

Schema updates

iLO 5 2.55 new features and changes

New URIs

No changes have been made to new URIs for this release.

HTTP methods - additions and deprecations

Deprecated URIs

No URIs deprecated for this release.

Schema updates

RDE support changes

Added Redfish Device Enablement (RDE) support for the following URIs and HTTP methods:

iLO 5 2.42 new features and changes

New URIs

HTTP methods - additions and deprecations

No changes have been made to HTTP methods for this release.

Deprecated URIs

No URIs deprecated for this release.

Redfish actions - additions and deprecations

Schema updates

The schema versions listed below correspond to iLO’s schemas which are not aligned to DMTF’s standard Redfish schemas versioning.

iLO 5 2.33 new features and changes

New URIs

HTTP methods - additions and deprecations

Deprecated URIs

Redfish actions - additions and deprecations

Schema updates

The schema versions listed below correspond to iLO’s schemas which are not aligned to DMTF’s standard Redfish schemas versioning.

RDE support changes

Added Redfish Device Enablement (RDE) support for the following URIs and HTTP methods:

BIOS Redfish changes (GEN 10 to GEN 10 Plus)

New URIs

Migrated URIs

iLO 5 2.30 new features and changes

iLO 5 2.10 new features and changes

Redfish features and fixes

HPE OEM features

iLO 5 1.40 new features and changes

iLO 5 1.40 adds support for several Redfish features:

Additionally, it includes support for new iLO 5 1.40 features:

Redfish 1.6 and OpenAPI

iLO 5 version 1.40 and later is conformant with the new Redfish 1.6 requirement to fix certain resource URIs in the data model.

Several resource URIs have been changed to conform to Redfish 1.6. A properly written Redfish client which traverses the data model and finds the URIs dynamically should not be affected, but clients which make assumptions about URIs may require modifications.

Trailing slashes on URIs

iLO 5 versions prior to 1.40 would return an HTTP 308 Redirect back to clients who requested URIs without a trailing slash. Clients must follow 308 Redirect to the alternate URI (the same URI path with a trailing slash.) In order to conform to Redfish 1.6, iLO 5 1.40 changes the behavior and aliases the same resources at both URIs. Requesting a URI with or without a trailing slash will return similar results with the exception that URIs in the returned data will be different. GETs of URIs with trailing slash will return links (@odata.id) with trailing slashes, and GETs of URIs without trailing slashes will return links without trailing slashes.

Version Behavior
1.10-1.3x GET /redfish/v1/Systems redirects (308) to /redfish/v1/Systems/
1.40-later GET /redfish/v1/Systems returns result similar to GET /redfish/v1/Systems/

Changed URIs

The following URIs have changed in iLO 5 1.40 and later to conform to Redfish 1.6:

Old URI in iLO 5 1.10-1.3x New URI Required by Redfish 1.6
/redfish/v1/Chassis/{chassisId}/Drives/{interface}/{driveId} /redfish/v1/Chassis/{systemId}/Drives/{driveId}
/redfish/v1/Systems/{systemId}/Storage/{interface}/{storageId} /redfish/v1/Systems/{systemId}/Storage/{storageId}
/redfish/v1/Systems/{systemId}/Storage/{interface}/{storageId}/Volumes/{volumeId} /redfish/v1/Systems/{systemId}/Storage/{storageId}/Volumes/{volumeId}
/redfish/v1/Systems/{systemId}/NetworkInterfaces/{nId}/NetworkDeviceFunctions/{ndfId} /redfish/v1/Chassis/{chassisId}/NetworkAdapters/{nId}/NetworkDeviceFunctions/{ndfId}
/redfish/v1/Systems/{systemId}/NetworkInterfaces/{nicId}/NetworkPorts/{nportId} /redfish/v1/Chassis/{chassisId}/NetworkAdapters/{Id}/NetworkPorts/{nportId}
/redfish/v1/Schemas/{Id}/ /redfish/v1/JsonSchemas/{Id}
/redfish/v1/Schemas/ /redfish/v1/JsonSchemas
/redfish/v1/Managers/{managerId}/NetworkService/ /redfish/v1/Managers/{managerId}/NetworkProtocol

New ?only Query Parameter

Starting in iLO 5 1.40, appending ?only to GETs on single-member collections returns the one and only member instead. This is a convenient and efficient way to get to important data faster.

GET /redfish/v1/Systems?only returns the one and only ComputerSystem resource instead of the collection that includes it.

This works for collections that have only one member. Otherwise the GET returns the collection as if the query parameter was omitted.

Getting Started

Tips for Using the RESTful API

The RESTful API for HPE iLO is available on ProLiant Gen10 servers running iLO 5 1.10 or later with the iLO Standard license, although some features in the data might not be available without an Advanced license.

To access the RESTful API, you need an HTTPS-capable client, such as a web browser with the Postman REST Client plugin extension or cURL (a popular command line HTTP utility).

RESTful Interface Tool and Python Examples

Although not a requirement, you can use the RESTful Interface Tool with the RESTful API. This command line tool provides a level of abstraction and convenience above direct access to the RESTful API. For details see: http://www.hpe.com/info/restfulapi.

**Python: See ex1_functionname() in the Python example code. This means look for the specified function name in the python example code.

Also, Hewlett Packard Enterprise published example Python code that implements a number of common operations in a RESTful API client. This code can be downloaded at https://github.com/HewlettPackard/python-ilorest-library. In some cases the examples in this document may refer to examples in the Python code with this notation:

If you prefer not to implement a client in Python, this serves as a good pseudocode implementing the logic required to perform an operation.

Example REST API operation with cURL

> curl https://{iLO}/redfish/v1/ -i --insecure -L
  • -i returns HTTP response headers
  • –insecure bypasses TLS/SSL certification verification
  • -L follows HTTP redirect

The above command returns JSON like this:


{
    "@odata.context": "/redfish/v1/$metadata#ServiceRoot",
    "@odata.etag": "W/\"B869D8CC\"",
    "@odata.id": "/redfish/v1/",
    "@odata.type": "#ServiceRoot.v1_1_0.ServiceRoot",
    "AccountService": {
        "@odata.id": "/redfish/v1/AccountService/"
    },
    "Chassis": {
        "@odata.id": "/redfish/v1/Chassis/"
    },
    "EventService": {
        "@odata.id": "/redfish/v1/EventService/"
    },
    "Id": "v1",
    "JsonSchemas": {
        "@odata.id": "/redfish/v1/Schemas/"
    },
    "Links": {
        "Sessions": {
            "@odata.id": "/redfish/v1/SessionService/Sessions/"
        }
    },
    "Managers": {
        "@odata.id": "/redfish/v1/Managers/"
    },
    "Name": "HPE RESTful Root Service",
    "Oem": {
        "Hpe": {
            "@odata.type": "#HpeiLOServiceExt.v2_0_0.HpeiLOServiceExt",
            "Links": {
                "ResourceDirectory": {
                    "@odata.id": "/redfish/v1/ResourceDirectory/"
                }
            },
            "Manager": [
                {
                    "DefaultLanguage": "en",
                    "FQDN": "edited",
                    "HostName": "ILO",
                    "Languages": [
                        {
                            "Language": "en",
                            "TranslationName": "English",
                            "Version": "1.10"
                        }
                    ],
                    "ManagerFirmwareVersion": "1.10",
                    "ManagerType": "iLO 5"
                }
            ],
            "Moniker": {
                "ADVLIC": "iLO Advanced",
                "BMC": "iLO",
                "BSYS": "BladeSystem",
                "CLASS": "Baseboard Management Controller",
                "IPROV": "Intelligent Provisioning",
                "PRODABR": "iLO",
                "PRODFAM": "Integrated Lights-Out",
                "PRODGEN": "iLO 5",
                "PRODNAM": "Integrated Lights-Out 5",
                "PRODTAG": "HPE iLO 5",
                "STDLIC": "iLO Standard",
                "SUMGR": "Smart Update Manager",
                "SYSFAM": "ProLiant",
                "VENDABR": "HPE",
                "VENDNAM": "Hewlett Packard Enterprise",
                "WWW": "www.hpe.com",
                "WWWAHSV": "www.hpe.com/servers/ahsv",
                "WWWBMC": "www.hpe.com/info/ilo",
                "WWWDOC": "www.hpe.com/support/ilo-docs",
                "WWWERS": "www.hpe.com/services/getconnected",
                "WWWGLIS": "reserved for liconf URI",
                "WWWIOL": "www.hpe.com/info/insightonline",
                "WWWLIC": "www.hpe.com/info/ilo/licensing",
                "WWWPASS": "www.hpe.com/support/hpesc",
                "WWWPRV": "www.hpe.com/info/privacy",
                "WWWSUP": "www.hpe.com/support/ilo5",
                "WWWSWLIC": "www.hpe.com/software/SWLicensing"
            },
            "Sessions": {
                "CertCommonName": "edited",
                "CertificateLoginEnabled": false,
                "KerberosEnabled": false,
                "LDAPAuthLicenced": true,
                "LDAPEnabled": false,
                "LocalLoginEnabled": true,
                "LoginFailureDelay": 0,
                "LoginHint": {
                    "Hint": "POST to /Sessions to login using the following JSON object:",
                    "HintPOSTData": {
                        "Password": "password",
                        "UserName": "username"
                    }
                },
                "SecurityOverride": false,
                "ServerName": "edited"
            },
            "Time": "2017-04-03T05:05:01Z"
        }
    },
    "RedfishVersion": "1.0.0",
    "Registries": {
        "@odata.id": "/redfish/v1/Registries/"
    },
    "SessionService": {
        "@odata.id": "/redfish/v1/SessionService/"
    },
    "Systems": {
        "@odata.id": "/redfish/v1/Systems/"
    },
    "UUID": "edited",
    "UpdateService": {
        "@odata.id": "/redfish/v1/UpdateService/"
    }
}

Let’s perform our first GET operation using the RESTful API. We will do an HTTP GET on the iLO HTTPS port, typically port 443 (although it could be different if you have previously configured iLO to use another port). Your client should be prepared to handle the HTTPS certificate challenge. The interface is not available over open HTTP (port 80), so you must use HTTPS.

Our GET operation will be against a resource at /redfish/v1/ (with a trailing slash):

It is best to perform this initial GET with a tool like the CURL or the Postman REST Client mentioned above. Later you will want to do this with your own scripting code, but for now it’s useful to see the HTTP header information exchanged using a browser.

CURL is a command line utility available for many Operating Systems that enables easy access to the RESTful API. CURL is available at https://curl.se. Note that all the CURL examples will use a flag –insecure. This causes CURL to bypass validation of the HTTPS certificate. In real use iLO should be configured to use a user-supplied certificate and this option is not necessary. Notice also that we use the –L option to force CURL to follow HTTP redirect responses. If iLO changes URI locations for various items, it can indicate to the client where the new location is and automatically follow the new link.

In JSON, there is no strong ordering of property names, so iLO may return JSON properties in any order. Likewise, iLO cannot assume the order of properties in any submitted JSON. This is why the best scripting data structure for a RESTful client is a dictionary: a simple set of unordered key/value pairs. This lack of ordering is also the reason you see embedded structure within objects (objects within objects). This allows us to keep related data together that is more logically organized, aesthetically pleasing to view, and helps avoid property name conflicts or ridiculously long property names. It also allows us to use identical blocks of JSON in many places in the data model, like status.

HTTP Resource Operations

Operation HTTP Command Description
Create POST resource URI (payload = resource data) Creates a new resource or invokes a custom action. A synchronous POST returns the newly created resource.
Read GET resource URI Returns the requested resource representation.
Update PATCH or PUT resource URI (payload = update data) Updates an existing resource. You can only PATCH properties that are marked readonly = false in the schema.
Delete DELETE resource URI Deletes the specified resource.

HTTP Status Return Codes

Return Status Description
2xx Successful operation.
308 The resource has moved
4xx Client-side error with message returned
5xx iLO error with error message returned

Navigating the Data Model

The Redfish API is designed to be implemented on many different models of servers and other IT infrastructure devices for years to come. These devices may be quite different from one another. For this reason, the Redfish API does not specify the URIs to various resources. For example, a client cannot assume the BIOS version information is always at a particular URI.

This is more complex for the client, but is necessary to make sure the data model can change to accommodate various future server architectures without requiring specification changes. As an example, if the BIOS version is at /redfish/v1/Systems/1, and a client assumed it is always there, the client would then break when the interface is implemented on a different type of architecture with many compute nodes, each with its own BIOS version, or on other vendor implementations.

Redfish 1.6 (iLO 5 1.40 or later) URI Templates

As of Redfish 1.6, a number of resource types have URI template specifications to be compatible with OpenAPI 3.0. Please see the Redfish 1.6 CSDL schema for details on URI templates for specific types.

A client must still perform GET operations on a Redfish API service in order to discover what resources are available. For instance, just because a Chassis has a template of /redfish/v1/Chassis/{ChassisId} means that a client must still GET /redfish/v1/Chassis in order to find the valid values of {ChassisId}.

Iterating Collections

curl https://{iLO}/redfish/v1/systems/ -i --insecure -u username:password -L

import sys
import redfish

# When running remotely connect using the iLO address, iLO account name, 
# and password to send https requests
iLO_host = "https://{iLO}"
login_account = "admin"
login_password = "password"

## Create a REDFISH object
REDFISH_OBJ = redfish.RedfishClient(base_url=iLO_host,username=login_account, \
                          password=login_password, default_prefix='/redfish/v1')

# Login into the server and create a session
REDFISH_OBJ.login(auth="session")

# Do a GET on a given path
response = REDFISH_OBJ.get("/redfish/v1/systems/", None)

# Print out the response
sys.stdout.write("%s\n" % response)

# Logout of the current session
REDFISH_OBJ.logout()

JSON response example:

{
    "@odata.id": "/redfish/v1/systems/",
    "@odata.context": "/redfish/v1/$metadata/",
    "@odata.type": "#ComputerSystemCollection.ComputerSystemCollection",
    "Members@odata.count": 1,
    "Members": [
        {
            "@odata.id": "/redfish/v1/systems/1/"
        }
    ]
}

Many operations will require you to locate the resource you wish to use. Most of these resources are members of “collections” (arrays of similar items). The method to find collections members is consistent for compute nodes, chassis, management processors, and many other resources in the data model.

Find a Compute Node

curl https://{host}/redfish/v1/systems/{item}/ -i --insecure -u username:password -L

import sys
import redfish

# When running remotely connect using the iLO address, iLO account name, 
# and password to send https requests
iLO_host = "https://{iLO}"
login_account = "admin"
login_password = "password"

## Create a REDFISH object
REDFISH_OBJ = redfish.RedfishClient(base_url=iLO_host,username=login_account, \
                          password=login_password, default_prefix='/redfish/v1')

# Login into the server and create a session
REDFISH_OBJ.login(auth="session")

# Do a GET on a given path
response = REDFISH_OBJ.get("/redfish/v1/systems/{item}/", None)

# Print out the response
sys.stdout.write("%s\n" % response)

# Logout of the current session
REDFISH_OBJ.logout()

JSON response example:

{
    "@odata.context": "/redfish/v1/$metadata#Systems/Members/$entity",
    "@odata.id": "/redfish/v1/Systems/1/",
    "@odata.type": "#ComputerSystem.1.0.1.ComputerSystem",
    ...

    ...
    "SerialNumber": "Kappa",
    "Status": {
        "Health": "Warning",
        "State": "Enabled"
    },
    "SystemType": "Physical",
    "UUID": "00000000-0000-614B-7070-610000000000"
}

A Compute node represents a logical computer system with attributes such as processors, memory, BIOS, power state, firmware version, etc. To find a compute node GET /redfish/v1/systems and iterate the “Members” array in the returned JSON. Each member has a link to a compute node.

Find a compute node by iterating the systems collection at /redfish/v1/systems/.

You can then GET the compute node, PATCH values, or perform Actions.

Find a Chassis

curl https://{host}/redfish/v1/chassis/{item}/ -i --insecure -u username:password -L

import sys
import redfish

# When running remotely connect using the iLO address, iLO account name, 
# and password to send https requests
iLO_host = "https://{iLO}"
login_account = "admin"
login_password = "password"

## Create a REDFISH object
REDFISH_OBJ = redfish.RedfishClient(base_url=iLO_host,username=login_account, \
                          password=login_password, default_prefix='/redfish/v1')

# Login into the server and create a session
REDFISH_OBJ.login(auth="session")

# Do a GET on a given path
response = REDFISH_OBJ.get("/redfish/v1/chassis/{item}/", None)

# Print out the response
sys.stdout.write("%s\n" % response)

# Logout of the current session
REDFISH_OBJ.logout()

JSON response example:

{
    "@odata.context": "/redfish/v1/$metadata#Chassis/Members/$entity",
    "@odata.id": "/redfish/v1/Chassis/1/",
    "@odata.type": "#Chassis.1.0.0.Chassis",
    "ChassisType": "RackMount",
    ...

    ...
    "Status": {
        "Health": "Warning",
        "State": "Enabled"
    },
    "Thermal": {
        "@odata.id": "/redfish/v1/Chassis/1/Thermal/"
    }
}

A Chassis represents a physical or virtual container of compute resources with attributes such as FRU information, power supplies, temperature, etc. To find a chassis GET /redfish/v1/chassis and iterate the “Members” array in the returned JSON. Each member has a link to a chassis.

Find a chassis by iterating the chassis collection at /redfish/v1/chassis/.

You can then GET the chassis, PATCH values, or perform Actions.

Find the iLO 5 Management Processor

curl https://{host}/redfish/v1/managers/{item}/ -i --insecure -u username:password -L

import sys
import redfish

# When running remotely connect using the iLO address, iLO account name, 
# and password to send https requests
iLO_host = "https://{iLO}"
login_account = "admin"
login_password = "password"

## Create a REDFISH object
REDFISH_OBJ = redfish.RedfishClient(base_url=iLO_host,username=login_account, \
                          password=login_password, default_prefix='/redfish/v1')

# Login into the server and create a session
REDFISH_OBJ.login(auth="session")

# Do a GET on a given path
response = REDFISH_OBJ.get("/redfish/v1/managers/{item}/", None)

# Print out the response
sys.stdout.write("%s\n" % response)

# Logout of the current session
REDFISH_OBJ.logout()

JSON response example:

{
    "@odata.context": "/redfish/v1/$metadata#Managers/Members/$entity",
    "@odata.id": "/redfish/v1/Managers/1/",
    "@odata.type": "#Manager.1.0.0.Manager",
    ...

    ...
    "Status": {
        "State": "Enabled"
    },
    "UUID": null,
    "VirtualMedia": {
        "@odata.id": "/redfish/v1/Managers/1/VirtualMedia/"
    }
}

A Manager represents a management processor (or “BMC”) that manages chassis and compute resources. For HPE Gen10 Servers, the manager is iLO 5. Managers contain attributes such as networking state and configuration, management services, security configuration, etc. To find a manager GET /redfish/v1/managers and iterate the “Members” array in the returned JSON. Each member has a link to a chassis.

Find a manager by iterating the manager collection at /redfish/v1/managers/.

You can then GET the manager, PATCH values, or perform Actions.

Authentication and Sessions

The following shows the error displayed on GET /redfish/v1/systems/ when no authentication is attempted:

401 Forbidden

{
  "error": {
    "@Message.ExtendedInfo": [
      {
        "MessageId": "Base.1.0.NoValidSession"
      }
    ],
    "code": "iLO.0.10.ExtendedInfo",
    "message": "See @Message.ExtendedInfo for more information."
  }
}

If you perform an HTTP operation on any other resource other than the root /redfish/v1/ resource, you will receive an HTTP 401 (Forbidden) error indicating that you don’t have the authentication needed to access the resource.

Basic Authentication

curl https://{iLO}/redfish/v1/systems/ -i --insecure -u username:password -L

import sys
import redfish

# When running remotely connect using the iLO address, iLO account name, 
# and password to send https requests
iLO_host = "https://{iLO}"
login_account = "admin"
login_password = "password"

## Create a REDFISH object
REDFISH_OBJ = redfish.RedfishClient(base_url=iLO_host,username=login_account, \
                          password=login_password, default_prefix='/redfish/v1')

# Login into the server and create a session
REDFISH_OBJ.login(auth="basic")

# Logout of the current session
REDFISH_OBJ.logout()

The RESTful API allows you to use HTTP Basic Authentication using a valid iLO user name and password.

Creating and Using Sessions

curl -H "Content-Type: application/json" -H "OData-Version: 4.0" -X POST --data "@data.json" https://{iLO}/redfish/v1/SessionService/Sessions/ --insecure

import redfish

# When running remotely connect using the iLO address, iLO account name, 
# and password to send https requests
iLO_host = "https://{iLO}"
login_account = "admin"
login_password = "password"

## Create a REDFISH object
REDFISH_OBJ = redfish.RedfishClient(base_url=iLO_host,username=login_account, \
                          password=login_password, default_prefix='/redfish/v1')

# Login into the server and create a session
REDFISH_OBJ.login(auth="session")

Contents of data.json

    {
        "UserName": "<your username>", 
        "Password": "<your password>"
    }

Successful headers from iLO:

Cache-Control: no-cache
Connection: keep-alive
Content-length: 163
Content-type: application/json; charset=utf-8
Date: Tue, 14 Jun 2016 22:23:39 GMT
ETag: W/"C84E3EA9"
Link: </redfish/v1/SessionService/Sessions/{item}/>; rel=self
Location: https://{iLO}/redfish/v1/SessionService/Sessions/{item}/
OData-Version: 4.0
Server: HPE-iLO-Server/1.30
X-Auth-Token: c3c5f437f94bc24428fe930bbf50904f
X-Frame-Options: sameorigin
X_HP-CHRP-Service-Version: 1.0.3

Successful response from iLO:

{
  "error": {
    "@Message.ExtendedInfo": [
      {
        "MessageID": "Base.0.10.Created"
      }
    ],
    "code": "iLO.0.10.ExtendedInfo",
    "message": "See @Message.ExtendedInfo for more information."
  }
}

For more complex multi-resource operations, you should log in and establish a session. To log in, iLO has a session manager object at the documented URI /redfish/v1/sessions/. To create a session POST a JSON object to the Session manager:

If the session is created successfully, you receive an HTTP 201 (Created) response from iLO. There will also be two important HTTP response headers.

Using a Session

To use a session, simply include the X-Auth-Token header supplied by the login response in all REST requests.

Log Out of a Session

curl -X "DELETE" https://{iLO}/redfish/v1/SessionService/Sessions/{item}/ -u admin:password --insecure

import redfish

# When running remotely connect using the iLO address, iLO account name, 
# and password to send https requests
iLO_host = "https://{iLO}"
login_account = "admin"
login_password = "password"

## Create a REDFISH object
REDFISH_OBJ = redfish.RedfishClient(base_url=iLO_host,username=login_account, \
                          password=login_password, default_prefix='/redfish/v1')

# Login into the server and create a session
REDFISH_OBJ.login(auth="session")

# Logout of the current session
REDFISH_OBJ.logout()

iLO supports a limited number of simultaneous sessions. If you do not log out of a session it will expire automatically after a time of inactivity. However, it is good practice to log out when finished with a session.

To log out perform an HTTP DELETE to the URI that was returned in the “Location” header when you created the session.

Performing Actions

Example of a system resource advertising an available action:

  {
    "Actions": {
        "#ComputerSystem.Reset": {
            "ResetType@Redfish.AllowableValues": [
                "On",
                "ForceOff",
                "ForceRestart",
                "Nmi",
                "PushPowerButton"
            ],
            "target": "/redfish/v1/Systems/1/Actions/ComputerSystem.Reset"
        }
    }
  }

This action may be invoked by performing:

curl --header "Content-Type: application/json" --request POST --data '{"ResetType": "ForceRestart"}' https://{iLO}/redfish/v1/Systems/1/Actions/ComputerSystem.Reset -u username:password --insecure

REST resources usually support HTTP GET to read the current state, and some support modification and removal with HTTP POST, PUT, PATCH, or DELETE.

There are some resources that support other types of operations not easily mapped to HTTP operations. For this reason the Redfish specification defines “Actions”. Actions are HTTP POST operations with a specifically formatted JSON request including the operation to perform and any parameters. For instance, it is not enough to simply tell a server to reset, but it is also necessary to specify the type of reset: cold boot, warm boot, PCI reset, etc. Actions are often used when the operation causes iLO 5 not just to update a value, but to change system state.

In Redfish, the available actions that can be invoked are identified by a “target” property in the resource’s “Actions” object definitions. The parameters identify the supported values with the annotation @Redfish.AllowableValues.

Actions on HPE-specific Extensions

Actions on HPE-specific extensions are invoked in the same way. Find the target URI for the action and POST a JSON request with parameters.

curl --header "Content-Type: application/json" --request POST --data '{"PushType": "PressAndHold"}' https://{iLO}//redfish/v1/Systems/1/Actions/Oem/Hpe/HpeComputerSystemExt.PowerButton/ -u username:password --insecure

The embedded extensions may also have Actions not specified by the Redfish standard. They are invoked in a similar way. The POST URI may include indicate the HPE specific nature of the action.

The older pre-Redfish form of the Action invocation requires you to specify "Target": "/Oem/Hp" as one of the properties in the body of the request.

It is recommended that you use the Redfish version of the action invocation.

Adapting from iLO 4

This section is a guide to help client code adapt from the iLO 4 RESTful API to the iLO 5 RESTful API.

Introduction

The iLO 5 RESTful API is fully conformant with Redfish. Any remaining support for the pre-Redfish iLO RESTful API has been removed and is replaced by the Redfish equivalents. HPE continues to extend the Redfish data model to enable value for the customer.

iLO 5 has the following additions not implemented in iLO 4:

Chunked Transfer Encoding

Unlike iLO 4, iLO 5 responds to all HTTP operations using Chunked Transfer Encoding. This enables features like $expand that require very large responses.

URI Remapping from /rest to /redfish

For iLO 5 all accesses of the /rest/v1/x URI pattern result in HTTP 308 redirect to /redfish/v1/x/. Additionally, access of /redfish/v1/x redirects to /redfish/v1/x/.

OData-Version HTTP Header Requirements

iLO 5 assumes all requests are to Redfish REST resources are Redfish requests. Unlike iLO 4, the service does not behave differently based upon the presence or absence of the OData-Version header.

This is a change from iLO 4 where the presence of the OData-Version header caused iLO 4 to remove pre-Redfish properties from GET responses.

The only required header for a GET operation is the authorization (X-Auth-Token or Authorization) header, except for the root resource at /redfish/v1/ which requires no headers.

Oem/Hp Sections Renamed to Oem/Hpe

As part of the transition from HP to HPE, and due to the Redfish requirement that the Oem section name reflect an owned IANA name, all Oem section names are changed from Hp to Hpe.

iLO 4 example:

{
  "Oem": {
    "Hp": {
      "@odata.type": "#HpiLOServiceExt.1.0.0.HpiLOServiceExt"
    }
  }
}

iLO 5 example:

{
  "Oem": {
    "Hpe": {
      "@odata.type": "#HpeiLOServiceExt.v2_0_0.HpeiLOServiceExt"
    }
  }
}

Schema Type Changes

To preserve OData conformance, Redfish transitioned the format of @odata.type properties, and iLO 5 follows this change. The type.<major>.<minor>.<errata>.type format has changed to type.v<major>_<minor>_<errata>.type. Also, the type name cannot be parsed programmatically and should be considered opaque. To determine the version of a resource, do not split the type/version by the ‘.’ delimiter.

For example:

iLO @odata.type Format
iLO 4 "@odata.type": "ComputerSystem.1.0.0.ComputerSystem"
iLO 5 "@odata.type": "ComputerSystem.v1_1_0.ComputerSystem"

Status Block Changes

The pre-Redfish property HealthRollUp is removed in iLO 5 and HealthRollup is retained.

iLO 4 example:

{
    "Status": {
          "State": "Starting",
          "Health": "OK",
          "HealthRollup": "OK",
          "HealthRollUp": "OK"
      }
}

iLO 5 example:

{
    "Status": {
          "State": "Starting",
          "Health": "OK",
          "HealthRollup": "OK"
      }
}

Error and Response Changes

HTTP Operation responses in iLO 5 are Redfish conformant and pre-Redfish properties are removed.

iLO 4 example (without the Redfish conformant OData-Version header):

{
  "Messages": [
    {
      "MessageID": "Base.0.10.MalformedJSON"
    }
  ],
  "Type": "ExtendedError.1.0.0",
  "error": {
    "@Message.ExtendedInfo": [
      {
        "MessageID": "Base.0.10.MalformedJSON"
      }
    ],
    "code": "iLO.0.10.ExtendedInfo",
    "message": "See @Message.ExtendedInfo for more information."
  }
}

iLO 5 Redfish example:

{
  "error": {
    "@Message.ExtendedInfo": [
      {
        "MessageId": "Base.0.10.MalformedJSON"
      }
    ],
    "code": "iLO.0.10.ExtendedInfo",
    "message": "See @Message.ExtendedInfo for more information."
  }
}

POST Actions

In Redfish, an “Actions” property informs the client which actions are supported on a resource and how to invoke them.

Advertising Available Actions

iLO 4 contained a pre-Redfish form of this with "AvailableActions". This is now removed and replaced in iLO 5 with Redfish "Actions".

iLO 4 example of advertised action:

{
    "AvailableActions": [
        {
           "Action": "Reset",
           "Capabilities": [
           {
               "AllowableValues": [
                   "On",
                   "ForceOff",
                   "ForceRestart",
                   "Nmi",
                   "PushPowerButton"
               ],
               "PropertyName": "ResetType"
               }
           ]
        }
    ]
}

iLO 5 example of advertised action:

{
    "Actions": {
        "#ComputerSystem.Reset": {
            "target": "/redfish/v1/Systems/1/Actions/ComputerSystem.Reset",
            "ResetType@Redfish.AllowableValues": [
                "On",
                "ForceOff",
                "GracefulRestart",
                "ForceRestart",
                "Nmi",
                "GracefulRestart",
                "ForceOn",
                "PushPowerButton"
            ]
        }
    }
}

Invoking Actions

iLO 4 action invoke example: POST /rest/v1/Systems/1

{
   "Action": "Reset",
   "ResetType": "On"
}

iLO 5 action invoke example: POST /redfish/v1/Systems/1/Actions/ComputerSystem.Reset

{
    "ResetType": "On"
}

Note that the URI of the POST matches the "target" property in "Actions".

OData query options

Redfish is an OData-derived protocol and data model with resources linking to other resources using @odata.id:

{"@odata.id": "/redfish/v1/link_to_some_other_resource"}

The iLO 5 Redfish implementation offers several OData services aiming at facilitating the the consumption of data by Redfish clients.

As an example, the OData "$expand" query option causes the OData service to automatically replace a link with the results of an internal GET of the indicated URI. This is essential to allow the API to scale for clients. An example use case is to expand an event log to return the log entries inline with the collection and reduce the number of GETs required by the client.

Examples of client requests to expand (in the general OData case) looks like:

OData query options supported by iLO 5 are presented below along with use case examples.

iLO 5 $expand

Using the rules above, iLO 5 supports $expand in this way:

$expand is applicable to HTTP GET only.

$expand=., $expand=*, and $expand=($levels=n) result in the same behavior: * Expands all links in both root and Oem/Hpe sections not inside the Links sections. * Levels is always interpreted as 1, regardless of n. This is to avoid the potential for expanding recursively for interlinked resources. * The Links section is never expanded. This is to avoid expanding the Chassis and Manager related links on GET operations to System.

NOTES:

iLO 5 $expand example

See the example in the right pane.

GET /redfish/v1/Chassis (a collection without $expand query option)

{
  "@odata.context": "/redfish/v1/$metadata#Chassis",
  "@odata.etag": "W/\"C2E4D1CC\"",
  "@odata.id": "/redfish/v1/Chassis/",
  "@odata.type": "#ChassisCollection.ChassisCollection",
  "Description": "Computer System Chassis View",
  "MemberType": "#Chassis.v1_2_0.Chassis",
  "Members": [
    {
      "@odata.id": "/redfish/v1/Chassis/1/"
    }
  ],
  "Members@odata.count": 1,
  "Name": "Computer System Chassis"
}

GET /redfish/v1/Chassis?$expand=. (a collection with $expand abbreviated for clarity)

{
  "@odata.context": "/redfish/v1/$metadata#Chassis",
  "@odata.etag": "W/\"C2E4D1CC\"",
  "@odata.id": "/redfish/v1/Chassis/",
  "@odata.type": "#ChassisCollection.ChassisCollection",
  "Description": "Computer System Chassis View",
  "MemberType": "#Chassis.v1_2_0.Chassis",
  "Members": [
    {
      "@odata.context": "/redfish/v1/$metadata#Chassis/Members/$entity",
      "@odata.etag": "W/\"5D370742\"",
      "@odata.id": "/redfish/v1/Chassis/1/",
      "@odata.type": "#Chassis.v1_2_0.Chassis",
      "ChassisType": "RackMount",
      "Id": "1",
      "Manufacturer": "HPE",
      "Model": "ProLiant ML350 Gen10",
      "Name": "Computer System Chassis",
      "SKU": "SKU NUMBER",
      "SerialNumber": "SERIAL NUMBER",
      "Status": {
        "Health": "OK",
        "State": "Starting"
      }
    }
  ],
  "Members@odata.count": 1,
  "Name": "Computer System Chassis"
}

iLO 5 only query option

iLO 5 1.40 and later supports the only query parameter documented in the Redfish API specification. This query parameter is ignored except on collections with only one member. Examples include the ComputerSystemCollection, ChassisCollection, and ManagerCollection.

iLO 5 only example

GET /redfish/v1/Chassis?only (JSON output is abbreviated)

{
    "@odata.context": "/redfish/v1/$metadata#Chassis.Chassis",
    "@odata.etag": "W/\"E85F6E4B\"",
    "@odata.id": "/redfish/v1/Chassis/1/",
    "@odata.type": "#Chassis.v1_6_0.Chassis",
    "Id": "1",
    "ChassisType": "RackMount",
}

iLO 5 $filter query option

The odata.org official site defines the $filter query as the following:

“The $filter system query option allows clients to filter a collection of resources that are addressed by a request URL. The expression specified with $filter is evaluated for each resource in the collection, and only items where the expression evaluates to true are included in the response.”

Six logical operators (Equals, Not Equals, Greater Than…) can be applied to the $filter query. They are defined in the OData specifications.

iLO 5 $filter examples

See the examples in the right pane.

Retrieve “iLO Dedicated Network Interface” properties (output abbreviated): GET /redfish/v1/Managers/1/EthernetInterfaces?$filter=Name eq 'Manager Dedicated Network Interface'

{
    "@odata.context": "/redfish/v1/$metadata#EthernetInterfaceCollection.EthernetInterfaceCollection",
    "@odata.etag": "W/\"2D50600F\"",
    "@odata.id": "/redfish/v1/Managers/1/EthernetInterfaces",
    "@odata.type": "#EthernetInterfaceCollection.EthernetInterfaceCollection",
    "Description": "Configuration of Manager Network Interfaces",
    "Name": "Manager Network Interfaces",
    "Members": [
        {
            "@odata.context": "/redfish/v1/$metadata#EthernetInterface.EthernetInterface",
            "@odata.id": "/redfish/v1/Managers/1/EthernetInterfaces/1",
            "@odata.type": "#EthernetInterface.v1_4_1.EthernetInterface",
            "Id": "1",
            "AutoNeg": true,
            "DHCPv4": {
                "DHCPEnabled": false,
                "UseDNSServers": false,
                "UseDomainName": false,
                "UseGateway": false,
                "UseNTPServers": false,
                "UseStaticRoutes": false
            },
            ....
            "VLAN": {
                "VLANEnable": false,
                "VLANId": null
            }
        }
    ],
    "Members@odata.count": 1
}

Filter IML entries by key (output abbreviated): GET /redfish/v1/Systems/1/LogServices/IML/Entries?$filter=Oem.Hpe.Severity eq 'Repaired' 

{
    "@odata.context": "/redfish/v1/$metadata#LogEntryCollection.LogEntryCollection",
    "@odata.etag": "W/\"C97C370E\"",
    "@odata.id": "/redfish/v1/Systems/1/LogServices/IML/Entries",
    "@odata.type": "#LogEntryCollection.LogEntryCollection",
    "Description": "Integrated Management Logs view",
    "Name": "Integrated Management Logs view",
    "Members": [
        {
            "@odata.context": "/redfish/v1/$metadata#LogEntry.LogEntry",
            "@odata.id": "/redfish/v1/Systems/1/LogServices/IML/Entries/3",
            "@odata.type": "#LogEntry.v1_11_0.LogEntry",
            "Id": "3",
            "Created": "2022-05-17T12:30:50Z",
            "EntryType": "Oem",
            "Message": "HPE Ethernet 1Gb 4-port 331i Adapter - NIC Connectivity status changed to OK for adapter in slot 0, port 1",
            "Name": "Integrated Management Log",
            "Oem": {
                "Hpe": {
                    "@odata.context": "/redfish/v1/$metadata#HpeLogEntry.HpeLogEntry",
                    "@odata.type": "#HpeLogEntry.v2_4_0.HpeLogEntry",
                    "Categories": [
                        "Hardware"
                    ],
                    "Class": 17,
                    "ClassDescription": "Network",
                    "Code": 10,
                    "Count": 1,
                    "EventNumber": 57,
                    "LearnMoreLink": "http://www.hpe.com/support/class0x0011code0x000a-gen10",
                    "RecommendedAction": "If the connection is lost, then check the physical connection from the server to its destination device such as interconnect ,blade, switch etc, including any cables. Refer to the NIC issues flowchart in the Troubleshooting Guide for more information.",
                    "Repaired": true,
                    "Severity": "Repaired",
                    "Updated": "2022-05-17T12:30:50Z"
                }
            },
            "OemRecordFormat": "Hpe-IML",
            "Severity": "OK"
        },
        ....
        {
            "@odata.context": "/redfish/v1/$metadata#LogEntry.LogEntry",
            "@odata.id": "/redfish/v1/Systems/1/LogServices/IML/Entries/28",
            "@odata.type": "#LogEntry.v1_11_0.LogEntry",
            "Id": "28",
            "Created": "2022-05-23T06:36:51Z",
            "EntryType": "Oem",
            "Message": "HPE Ethernet 1Gb 4-port 331i Adapter - NIC Connectivity status changed to OK for adapter in slot 0, port 1",
            "Name": "Integrated Management Log",
            "Oem": {
                "Hpe": {
                    "@odata.context": "/redfish/v1/$metadata#HpeLogEntry.HpeLogEntry",
                    "@odata.type": "#HpeLogEntry.v2_4_0.HpeLogEntry",
                    "Categories": [
                        "Hardware"
                    ],
                    "Class": 17,
                    "ClassDescription": "Network",
                    "Code": 10,
                    "Count": 1,
                    "EventNumber": 82,
                    "LearnMoreLink": "http://www.hpe.com/support/class0x0011code0x000a-gen10",
                    "RecommendedAction": "If the connection is lost, then check the physical connection from the server to its destination device such as interconnect ,blade, switch etc, including any cables. Refer to the NIC issues flowchart in the Troubleshooting Guide for more information.",
                    "Repaired": true,
                    "Severity": "Repaired",
                    "Updated": "2022-05-23T06:36:51Z"
                }
            },
            "OemRecordFormat": "Hpe-IML",
            "Severity": "OK"
        }
    ],
    "Members@odata.count": 25
}

Filter IML entries by date (output abbreviated): GET /redfish/v1/Systems/1/LogServices/IML/Entries?$filter=Created gt '2022-03-05T07:49:50Z' 

{
    "@odata.context": "/redfish/v1/$metadata#LogEntryCollection.LogEntryCollection",
    "@odata.etag": "W/\"C8B694E6\"",
    "@odata.id": "/redfish/v1/Systems/1/LogServices/IML/Entries",
    "@odata.type": "#LogEntryCollection.LogEntryCollection",
    "Description": "Integrated Management Logs view",
    "Name": "Integrated Management Logs view",
    "Members": [
        {
            "@odata.context": "/redfish/v1/$metadata#LogEntry.LogEntry",
            "@odata.id": "/redfish/v1/Systems/1/LogServices/IML/Entries/1",
            "@odata.type": "#LogEntry.v1_11_0.LogEntry",
            "Id": "1",
            "Created": "2022-05-13T14:41:40Z",
            "EntryType": "Oem",
            "Message": "IML Cleared (iLO user: demopaq)",
            "Name": "Integrated Management Log",
            "Oem": {
                "Hpe": {
                    "@odata.context": "/redfish/v1/$metadata#HpeLogEntry.HpeLogEntry",
                    "@odata.type": "#HpeLogEntry.v2_4_0.HpeLogEntry",
                    "Categories": [
                        "Maintenance",
                        "Administration"
                    ],
                    "Class": 33,
                    "ClassDescription": "Maintenance",
                    "Code": 1,
                    "Count": 1,
                    "EventNumber": 55,
                    "Severity": "Informational",
                    "Updated": "2022-05-13T14:41:40Z"
                }
            },
            "OemRecordFormat": "Hpe-IML",
            "Severity": "OK"
        },
        ....
    ],
    "Members@odata.count": 28
}

iLO 5 $count query option

The $count system query option allows clients to request a count of the matching resources included with the resources in the response.

iLO 5 $count example

Retrieve the total number of Security log entries: GET /redfish/v1/systems/1/logservices/SL/Entries?$count=true

{
    "@odata.context": "/redfish/v1/$metadata#LogEntryCollection.LogEntryCollection",
    "@odata.etag": "W/\"75983E8D\"",
    "@odata.type": "#LogEntryCollection.LogEntryCollection",
    "Description": "Security Logs view",
    "Name": "Security Logs",
    "Members": [],
    "Members@odata.count": 31
}

iLO 5 $top and $skip query options

The $top system query option requests the number of items in the queried collection to be included in the result. The $skip query option requests the number of items in the queried collection that are to be skipped and not included in the result.

iLO 5 $top and $skip examples

Retrieve the top ten IML log entries (output abbreviated): GET /redfish/v1/Systems/1/LogServices/IML/Entries?$top=10 

{
    "@odata.context": "/redfish/v1/$metadata#LogEntryCollection.LogEntryCollection",
    "@odata.etag": "W/\"FFCD0D20\"",
    "@odata.id": "/redfish/v1/Systems/1/LogServices/IML/Entries",
    "@odata.type": "#LogEntryCollection.LogEntryCollection",
    "Description": "Integrated Management Logs view",
    "Name": "Integrated Management Logs view",
    "Members": [
        {
            "@odata.context": "/redfish/v1/$metadata#LogEntry.LogEntry",
            "@odata.id": "/redfish/v1/Systems/1/LogServices/IML/Entries/1",
            "@odata.type": "#LogEntry.v1_11_0.LogEntry",
            "Id": "1",
            "Created": "2022-05-13T14:41:40Z",
            "EntryType": "Oem",
            "Message": "IML Cleared (iLO user: demopaq)",
            "Name": "Integrated Management Log",
            "Oem": {
                "Hpe": {
                    "@odata.context": "/redfish/v1/$metadata#HpeLogEntry.HpeLogEntry",
                    "@odata.type": "#HpeLogEntry.v2_4_0.HpeLogEntry",
                    "Categories": [
                        "Maintenance",
                        "Administration"
                    ],
                    "Class": 33,
                    "ClassDescription": "Maintenance",
                    "Code": 1,
                    "Count": 1,
                    "EventNumber": 55,
                    "Severity": "Informational",
                    "Updated": "2022-05-13T14:41:40Z"
                }
            },
            "OemRecordFormat": "Hpe-IML",
            "Severity": "OK"
        },
        ....
  ],
    "Members@odata.count": 10
}

Skip 21 entries: last 10 entries when Members@odata.count is 28 (Output abbreviated): GET /redfish/v1/Systems/1/LogServices/IML/Entries?$skip=18

{
    "@odata.context": "/redfish/v1/$metadata#LogEntryCollection.LogEntryCollection",
    "@odata.etag": "W/\"2B9C6986\"",
    "@odata.id": "/redfish/v1/Systems/1/LogServices/IML/Entries",
    "@odata.type": "#LogEntryCollection.LogEntryCollection",
    "Description": "Integrated Management Logs view",
    "Name": "Integrated Management Logs view",
    "Members": [
        {
            "@odata.context": "/redfish/v1/$metadata#LogEntry.LogEntry",
            "@odata.id": "/redfish/v1/Systems/1/LogServices/IML/Entries/19",
            "@odata.type": "#LogEntry.v1_11_0.LogEntry",
            "Id": "19",
            "Created": "2022-05-18T14:55:37Z",
            "EntryType": "Oem",
            "Message": "HPE Ethernet 1Gb 4-port 331i Adapter - NIC Connectivity status changed to OK for adapter in slot 0, port 1",
            "Name": "Integrated Management Log",
            "Oem": {
                "Hpe": {
                    "@odata.context": "/redfish/v1/$metadata#HpeLogEntry.HpeLogEntry",
                    "@odata.type": "#HpeLogEntry.v2_4_0.HpeLogEntry",
                    "Categories": [
                        "Hardware"
                    ],
                    ...
                    "Severity": "Repaired",
                    "Updated": "2022-05-18T14:55:37Z"
                }
            },
            "OemRecordFormat": "Hpe-IML",
            "Severity": "OK"
        },
        ...
  ],
    "Members@odata.count": 10
}

iLO 5 Data Model Changes

ServiceRoot (/redfish/v1/)

Time

The pre-Redfish REST API on iLO 4 had a Time property representing the current iLO time. Redfish did not include this, so iLO 5 adds it back in the Oem/Hpe section. This is a Redfish conformant time property (ISO 8601).

iLO 4 example of Time:

{
  "@odata.context": "/redfish/v1/$metadata#ServiceRoot",
  "@odata.id": "/redfish/v1/",
  "@odata.type": "#ServiceRoot.v1_0_0.ServiceRoot",
  "Time": "ISO 8601 time (iLO's current time)"
}

iLO 5 example of Time:

{
  "@odata.context": "/redfish/v1/$metadata#ServiceRoot",
  "@odata.id": "/redfish/v1/",
  "@odata.type": "#ServiceRoot.v1_0_0.ServiceRoot",
  "Oem": {
    "Hpe": {
      "@odata.type": "#HpeiLOServiceExt.v2_0_0.HpeiLOServiceExt",
      "Time": "ISO 8601 time (iLO's current time)"
    }
  }
}

RedfishVersion

ServiceVersion has been removed and replaced with RedfishVersion for Redfish conformance.

ComputerSystem (/redfish/v1/systems/{item})

Boot Source Override

iLO 5 implements a more complete Redfish Boot Source Override capability

{
  "Boot": {
    "BootSourceOverrideEnabled": "Disabled",
    "BootSourceOverrideMode": "UEFI",
    "BootSourceOverrideTarget": "None",
    "BootSourceOverrideTarget@Redfish.AllowableValues": [
      "None",
      "Pxe",
      "Floppy",
      "Cd",
      "Usb",
      "Hdd",
      "BiosSetup",
      "Utilities",
      "Diags",
      "UefiTarget",
      "SDCard",
      "UefiHttp"
    ],
    "UefiTargetBootSourceOverride": "None",
    "UefiTargetBootSourceOverride@Redfish.AllowableValues": [
      "None",
      "PciRoot(0x0)/Pci(0x1,0x0)/Pci(0x0,0x0)/Scsi(0x0,0x0)/HD(2,GPT,383D95E0-472A-48F1-8445-2A436025C81C,0x96800,0x31800)/\\EFI\\Microsoft\\Boot\\bootmgfw.efi",
      "UsbClass(0xFFFF,0xFFFF,0xFF,0xFF,0xFF)",
      "PciRoot(0x0)/Pci(0x1,0x0)/Pci(0x0,0x0)/Scsi(0x0,0x0)",
      "PciRoot(0x0)/Pci(0x2,0x0)/Pci(0x0,0x0)/Pci(0x9,0x0)/Pci(0x0,0x0)/MAC(9457A50822E0,0x0)/IPv4(0.0.0.0)",
      "PciRoot(0x1)/Pci(0x2,0x0)/Pci(0x0,0x0)/Pci(0x9,0x0)/Pci(0x0,0x0)/MAC(9457A5086560,0x0)/IPv4(0.0.0.0)",
      "PciRoot(0x0)/Pci(0x3,0x2)/Pci(0x0,0x0)/MAC(3464A99332A0,0x0)/IPv4(0.0.0.0)",
      "PciRoot(0x0)/Pci(0x2,0x0)/Pci(0x0,0x0)/Pci(0x9,0x0)/Pci(0x0,0x0)/MAC(9457A50822E0,0x0)/IPv6(0000:0000:0000:0000:0000:0000:0000:0000)",
      "PciRoot(0x1)/Pci(0x2,0x0)/Pci(0x0,0x0)/Pci(0x9,0x0)/Pci(0x0,0x0)/MAC(9457A5086560,0x0)/IPv6(0000:0000:0000:0000:0000:0000:0000:0000)",
      "PciRoot(0x0)/Pci(0x3,0x2)/Pci(0x0,0x0)/MAC(3464A99332A0,0x0)/IPv6(0000:0000:0000:0000:0000:0000:0000:0000)"
    ]
  }
}

TrustedModules (TPM)

The existing HPE-specific TrustedModules (TPM) sub-object is replaced with the new Redfish-defined version.

iLO 4 example

{
  "Oem": {
    "Hp": {
      "@odata.type": "#HpComputerSystemExt.1.1.2.HpComputerSystemExt",
      "TrustedModules": [
        {
          "Status": "NotPresent"
        }
      ]
    }
  }
}

iLO 5 example

{
  "TrustedModules": [
    {
      "FirmwareVersion": "3.1",
      "ModuleType": "TPM2_0",
      "Status": {
        "Health": "OK",
        "State": "Enabled"
      }
    }
  ]
}

The link to the SecureBoot resource is added as defined in Redfish in place of the existing HPE-specific link. See SecureBoot section for more details.

iLO 4 example SecureBoot link

{
  "Oem": {
    "Hp": {
      "@odata.type": "#HpComputerSystemExt.1.1.2.HpComputerSystemExt",
      "SecureBoot": {
        "@odata.id": "/redfish/v1/Systems/1/SecureBoot/"
      }
    }
  }
}

iLO 5 example SecureBoot link

{
  "SecureBoot": {
    "@odata.id": "/redfish/v1/Systems/1/SecureBoot/"
  }
}

Bios

The link to the Bios resource is added as defined in Redfish in place of the existing HPE-specific OEM link. See UEFI BIOS section for more details.

iLO 4 example Bios link

{
  "Oem": {
    "Hp": {
      "@odata.type": "#HpComputerSystemExt.1.1.2.HpComputerSystemExt",
      "BIOS": {
          "@odata.id": "/redfish/v1/systems/1/bios/"
      }
    }
  }
}

iLO 5 example Bios link

{
  "Bios": {
    "@odata.id": "/redfish/v1/Systems/1/Bios"
  }
}

Other

The following properties have been removed in iLO 5 for Redfish conformance: * Version * VirtualSerialNumber * HostCorrelation - See replacement HostOS described below. * BIOSPostCode * Power (replaced by PowerState) * Processors is now a link to the Processors collection instead of a summary description of the CPUs. * Memory (replaced by MemorySummary)

If the server has a running operating system and HPE Agentless Management Service is installed and running, a new "HostOS" object is included in ComputerSystem with information about the OS:

/Oem/Hpe/HostOS:

UEFI BIOS Standard Redfish Support

iLO5 supports Redfish standard BIOS Attributes and BIOS Attribute Registry resources that replace the HPE proprietary versions used in iLO4. The following is a summary of all BIOS resources changes in Gen10 / iLO5:

Resource Type iLO 4 / Gen9 iLO 5 / Gen10
BIOS current settings HpBios.1.2.0 #Bios.v1_0_0.Bios
BIOS pending settings HpBios.1.2.0 #Bios.v1_0_0.Bios
BIOS Attribute Registry HpBiosAttributeRegistrySchema.1.2.1 #AttributeRegistry.v1_0_0.AttributeRegistry
BIOS PCI Mappings HpBiosMapping.1.2.0 #HpeBiosMapping.v2_0_0.HpeBiosMapping
UEFI Boot Order HpServerBootSettings.1.3.1 #HpeServerBootSettings.v2_0_0.HpeServerBootSettings
Base Config (BIOS defaults) HpBaseConfigs.0.10.0 #HpeBaseConfigs.v2_0_0.HpeBaseConfigs
UEFI iSCSI Software Initiator HpiSCSISoftwareInitiator.1.1.0 #HpeiSCSISoftwareInitiator.v2_0_0.HpeiSCSISoftwareInitiator
BIOS Extensions Schema None #HpeBiosExt.v2_0_0.HpeBiosExt

BIOS Current/Pending Settings Resources

BIOS Attribute Access

Redfish moves the system-specific BIOS attributes from the top level of the resource into an Attributes sub-object:

iLO 4 BIOS Settings Example:

{
    "AdminEmail": "",
    "AdminName": "",
    "AdminPhone": ""
}

iLO 5 BIOS Settings Example:

{
  "Attributes": {
    "AdminEmail": "",
    "AdminName": "",
    "AdminPhone": ""
  }
}
Reset Bios Settings (NEW)

UEFI BIOS Supports a new POST Action to reset settings.

iLO 5 Reset BIOS Settings Action

{
  "Actions": {
    "#Bios.ResetBios": {
      "target": "/redfish/v1/Systems/1/Bios/Settings/Actions/Bios.ResetBios/"
    }
  }
}

POST /redfish/v1/Systems/1/Bios/Settings/Actions/Bios.ResetBios/ no body

Change BIOS Password (NEW)

UEFI BIOS Supports a new Redfish POST Action to change the BIOS password.

iLO 5 Set/Change BIOS Setup Password Actions

{
  "Actions": {
    "#Bios.ChangePassword": {
      "target": "/redfish/v1/Systems/1/Bios/Settings/Actions/Bios.ChangePassword/"
    }
  }
}

POST /redfish/v1/Systems/1/Bios/Settings/Actions/Bios.ChangePassword/

{
  "PasswordName": "Administrator | User",
  "OldPassword" : "OldPasswordText",
  "NewPassword" : "NewPasswordText"
}
Settings Result Report

The result of applying new settings is Redfish conformant in iLO 5.

iLO 4 example:

{
    "SettingsResult": {
        "ETag": "92EB7D02",
        "Messages": [
            {
                "MessageArgs": [
                    "test"
                ],
                "MessageID": "Base.1.0:PropertyUnknown"
            },
            {
                "MessageArgs": [],
                "MessageID": "Base.1.0:Success"
            }
        ],
        "Time": "2012-03-07T14:44.30-05:00"
    }
}

iLO 5 example:

{
    "@Redfish.Settings": {
        "@odata.type": "#Settings.v1_0_0.Settings",
        "ETag": "92EB7D02",
        "Messages": [
            {
            "MessageId": "Base.1.0.PropertyUnknown",
            "RelatedProperties": [
              "#/Attributes/ProcTurboMode"
             ]
            },
            {
                "MessageId": "Base.1.0.Success"
            }
        ],
        "SettingsObject": {
          "@odata.id": "/redfish/v1/Systems/1/Bios/Settings"
        },
        "Time": "2012-03-07T14:44.30-05:00"
    }
}
Changes to BIOS Attribute Enum Values

Attribute names/enum values cannot start with digits, per OData requirements.

iLO 4 example:

{
"AsrTimeoutMinutes": "10",
"SerialConsoleBaudRate": "115200",
}

iLO 5 example:

{
"AsrTimeoutMinutes": "TimeOut10",
"SerialConsoleBaudRate": "Baud115200",
}

With a Redfish conformant BIOS resource structure, some HPE-specific links are moved into an HPE specific section.

iLO 4 example:

{
    "links": {
        "BaseConfigs": {
          "href": "/rest/v1/systems/1/bios/BaseConfigs"
        },
        "Boot": {
          "href": "/rest/v1/systems/1/bios/Boot"
        },
        "Mappings": {
          "href": "/rest/v1/systems/1/bios/Mappings"
        },
        "Settings": {
          "href": "/rest/v1/systems/1/bios/Settings"
        },
        "iScsi": {
          "href": "/rest/v1/systems/1/bios/iScsi"
        },
        "self": {
          "href": "/rest/v1/systems/1/bios"
        }
    }
}

iLO 5 example of HPE-specific links:

{
  "Links": {
    "Oem": {
      "Hpe": {
        "@odata.type": "#HpeBiosExt.v2_0.0.HpeBiosExt",
        "BaseConfigs": {
          "@odata.id": "/redfish/v1/Systems/1/BIOS/BaseConfigs"
        },
        "Boot": {
          "@odata.id": "/redfish/v1/Systems/1/BIOS/Boot"
        },
        "Mappings": {
          "@odata.id": "/redfish/v1/Systems/1/BIOS/Mappings"
        },
        "iScsi": {
          "@odata.id": "/redfish/v1/Systems/1/BIOS/iScsi"
        }
      }
    }
  }
}

Bios Attribute Registry

All BIOS attribute registry resources have switched from HP OEM type (HpBiosAttributeRegistrySchema.1.2.1) to Redfish standard object (AttributeRegistry.v1_0_0).

Other BIOS HPE OEM Resources

Existing BIOS HPE OEM Resources

All the remaining HPE OEM resources remain similar to iLO 4, except for following:

The impacted resources are:

New BIOS HPE OEM Resources

The following new HPE BIOS OEM resources are added in iLO5:

BIOS Password Authentication HTTP Header

iLO4 requires a special HTTP header when BIOS Admin password is programmed to be included in all PUT/PATCH requests on BIOS resources. This header is removed from iLO5. Instead, all access to BIOS resources requires ConfigureBios iLO privilege.

Header iLO 4 / Gen9 iLO 5 / Gen10
X-HPRESTFULAPI-AuthToken A string consisting of the uppercase SHA256 hex digest of the administrator password. In Python this is hashlib.sha256(bios_password.encode()).hexdigest().upper(). None - Access to BIOS resources require iLO account with the ConfigureBios Privilege.

Software/Firmware Inventory and Update

Gen9 FirmwareInventory (/redfish/v1/systems/{item}/firmwareinventory) is removed and replaced with the new Redfish firmware inventory /redfish/v1/UpdateService/FirmwareInventory and /redfish/v1/UpdateService/SoftwareInventory.

Gen9 HpiLOFirmwareUpdate (/redfish/v1/managers/{item}/updateservice) is also removed in favor of the new Redfish update service /redfish/v1/UpdateService.

A Redfish conformant UpdateService has been added at /redfish/v1/UpdateService. This includes the following:

Additionally, the UpdateService is extended with:

SecureBoot (/redfish/v1/systems/{item}/secureboot)

The HpSecureBoot status and configuration resource has been replaced with the Redfish conformant version. The SecureBoot properties change from iLO 4 2.30+ to iLO 5 as follows:

iLO 4 SecureBoot settings example:

{
  "@odata.context": "/redfish/v1/$metadata#Systems/Members/1/SecureBoot$entity",
  "@odata.id": "/redfish/v1/Systems/1/SecureBoot/",
  "@odata.type": "#HpSecureBoot.1.0.0.HpSecureBoot",
  "Id": "SecureBoot",
  "Name": "SecureBoot",
  "ResetAllKeys": false,
  "ResetToDefaultKeys": false,
  "SecureBootCurrentState": false,
  "SecureBootEnable": false
}

iLO 5 SecureBoot settings example:

{
  "@odata.context": "/redfish/v1/$metadata#Systems/1/SecureBoot",
  "@odata.id": "/redfish/v1/Systems/1/SecureBoot",
  "@odata.type": "#SecureBoot.v1_0_0.SecureBoot",
  "Actions": {
    "#SecureBoot.ResetKeys": {
      "ResetKeysType@Redfish.AllowableValues": [
        "ResetAllKeysToDefault",
        "DeleteAllKeys",
        "DeletePK"
      ],
      "target": "/redfish/v1/Systems/1/SecureBoot/Actions/SecureBoot.ResetKeys"
    }
  },
  "Id": "SecureBoot",
  "Name": "UEFI Secure Boot",
  "SecureBootCurrentBoot": "Disabled",
  "SecureBootEnable": false,
  "SecureBootMode": "UserMode"
}

An action exists to reset keys. The ResetKeysType value can be the following:

iLO 5 Reset Secure Boot Keys

POST /redfish/v1/Systems/1/SecureBoot/Actions/SecureBoot.ResetKeys/

{
  "ResetKeysType": "DeleteAllKeys"
}

Memory and NVDIMM Support

iLO 5 replaces iLO 4’s HpMemory DIMM information with the Redfish conformant Memory schema.

Host Correlation Removed

iLO 4 had a pre-Redfish property in the ComputerSystem resource called HostCorrelation designed to enable easy discovery of host MAC and IP addresses. This was not included in the Redfish standard, and is removed in iLO 5 for conformance reasons.

iLO 4 HostCorrelation:

{
  "HostCorrelation": {
    "HostMACAddress": [
      "14:58:d0:d3:10:ca",
      "14:58:d0:d3:10:cb"
    ],
    "HostName": "some-host-name",
    "IPAddress": [
      "ip-address available if AMS is installed and running",
      ""
    ]
  }
}

iLO 5 HostOS:

iLO 5 replaces HostCorrelation with Oem/Hpe/HostOS which is available if Agentless Management Service is running.

iLO 5 HostOS:

{
  "Oem": {
    "Hpe": {
      "HostOS": {
        "OsName": "Windows Server 2012 R2, x64 Standard Edition",
        "OsVersion": "6.3",
        "OsSysDescription": "",
        "OsType": 38
      }
    }
  }
}

Managers (/redfish/v1/Managers/{item}/) (iLO 5)

The following properties have been replaced for Redfish conformance:

iLO 4 iLO 5 replacement
/Firmware FirmwareVersion
/CommandShell/Enabled /CommandShell/ServiceEnabled
/GraphicalConsole/Enabled /GraphicalConsole/ServiceEnabled
/SerialConsole/Enabled /SerialConsole/ServiceEnabled

All of the replacement properties are also implemented in iLO 4 2.30 and later.

iLO 5 Security State

iLO 5 features a new security state setting readable and settable via the REST API.

{
    "Oem": {
        "Hpe": {
            "SecurityState": "HighSecurity"
        }
    }
}

The possible values include:

You may PATCH these settings, but iLO 5 enforces strict limitations on how security states can transition. Any unsupported transition results in an error.

Allowed Transitions:
Transition Notes
Production <–> HighSecurity You may transition freely between Production mode and High Security mode, subject to authentication and privileges.
FIPS <–> SuiteB You may transition freely between Production mode and High Security mode, subject to authentication and privileges.
Production or HighSecurity –> FIPS You may transition into FIPS mode. Transitions out of FIPS mode are complex and beyond the scope of the RESTful API.
Impact on Local iLO RESTful API Access (via HPREST utility and Channel Interface)

iLO 4 allowed anonymous access to the iLO RESTful API over the local channel interface (CHIF) except in the case where the Data Center Lock mode was engaged.

iLO 5 limits access to the local interface in HighSecurity, FIPS, and SuiteB modes to authorized users only. In Production mode, anonymous access remains identical to iLO 4.

When performing local BIOS configuration changes, the following conditions apply:

Local REST Access No BIOS Password BIOS Password Set
Production Mode No authorization required Requires BIOS Configuration Privilege
High Security Mode Requires BIOS Configuration Privilege Requires BIOS Configuration Privilege
Remote REST Access No BIOS Password BIOS Password Set
Production Mode Requires BIOS Configuration Privilege Requires BIOS Configuration Privilege
High Security Mode Requires BIOS Configuration Privilege Requires BIOS Configuration Privilege

Notice that iLO is not validating against the BIOS setup password, but is using the presence of the BIOS password to require BIOS Configuration Privilege.

iLO Ethernet Interfaces (/redfish/v1/managers/{item}/EthernetInterfaces/{item}/)

The following properties have been removed for Redfish conformance:

iLO 4 iLO 5 replacement
/FactoryMacAddress /PermanentMACAddress
/MacAddress /MACAddress
/LinkTechnology Removed (assume Ethernet)
/Autosense /AutoNeg

All of the above replacement properties were added in iLO 4 2.30.

VLAN Configuration

VLAN Configuration for iLO’s Shared Network Interface has changed in iLO 5 to become Redfish conformant.

iLO 4 iLO 5 replacement
/VLANEnable /VLAN/VLANEnable
/VLANId /VLAN/VLANId

iLO Network Protocols (/redfish/v1/managers/{item}/NetworkService/)

The following properties have been removed for Redfish conformance:

iLO 4 iLO 5 replacement
/SessionTimeoutMinutes Removed
/{protocol}/Enabled /{protocol}/ProtocolEnabled
/Oem/Hp/HPSystemManagementHomepageAddress /Oem/Hpe/SystemManagementHomepage

ProtocolEnabled was added in iLO 4 2.30 and Enabled is now removed. HPSystemManagementHomepageAddress was changed as part of the Hewlett Packard Enterprise transition.

Chassis (/redfish/v1/chassis/{item}/)

iLO 5 supports the Redfish PhysicalSecurity status to report the status of the hood sensor. This is only present when a hood sensor is installed on the server:

Example:

{
  "PhysicalSecurity": {
    "IntrusionSensor": "HardwareIntrusion"
  }
}

“Version” has been removed from Chassis to be Redfish conformant.

Power (/redfish/v1/chassis/{item}/power/)

The following properties have been removed for Redfish conformance:

iLO 4 iLO 5 replacement
/PowerConsumedWatts /PowerControl/PowerConsumedWatts
/PowerRequestedWatts /PowerControl/PowerRequestedWatts
/PowerAvailableWatts /PowerControl/PowerAvailableWatts
/PowerAllocatedWatts /PowerControl/PowerAllocatedWatts
/PowerCapacityWatts /PowerControl/PowerCapacityWatts
/PowerMetrics /PowerControl/PowerMetrics
/PowerLimit /PowerControl/PowerLimit
/PowerSupplies[]/CorrelatableID no replacement

Thermal (/redfish/v1/chassis/{item}/thermal)

The existing CurrentReading property for each fan array entry is replaced with the Redfish errata change:

Redfish adds a pair of properties Reading and ReadingUnits. Both are GET-only operation properties. ReadingUnits are returned from a GET operation as Percent and Reading is a number between 0 and 100.

Additionally, a few other properties from the pre-Redfish schema are removed to conform with Redfish.

iLO 4 iLO 5 replacement
/Fans[]/FanName /Fans[]/Name (changed in Redfish Thermal.v1_1_0)
/Fans[]/CurrentReading /Fans[]/Reading*
/Fans[]/CurrentReading /Fans[]/ReadingUnits* (= “Percent”)
/Fans[]/ReadingRPM Removed from old schema - never implemented
/Fans[]/Units /Fans[]/ReadingUnits (= “Percent”)
/Fans[]/Context /Fans[]/PhysicalContext
/Temperatures[]/Context /Temperatures[]/PhysicalContext
/Temperatures[]/CurrentReading /Temperatures[]/ReadingCelsius
/Temperatures[]/Number /Temperatures[]/SensorNumber*
/Temperatures[]/Units Removed - Redfish always read in Celsius (see ReadingCelsius)
/Temperatures[]/LowerThresholdNonCritical /Temperatures[]/UpperThresholdCritical
/Temperatures[]/LowerThresholdCritical /Temperatures[]/UpperThresholdFatal

* These are newly added for iLO 5 as Redfish conformant replacements for the removed properties. The others were added in iLO 4 2.30 and above as Redfish replacements.

NOTE: The threshold property changes fix a issue with incorrectly labeled thresholds in previous releases of iLO.

On-Service JSON Schema

The on-service schema collection remains at /redfish/v1/schema/ and does not change to the Redfish example of /redfish/v1/JsonSchema. Because URIs are opaque, this is left where it is without violating the spec and preserving compatibility.

The existing collection of SchemaFileCollection and SchemaFile resources are now Redfish conformant using JsonSchemaFileCollection and JsonSchemaFile.

iLO 4 iLO 5
/redfish/v1/schemas: “@odata.type”: “#SchemaFileCollection.SchemaFileCollection” /redfish/v1/schemas: “@odata.type”: “#JsonSchemaFileCollection.JsonSchemaFileCollection”
/redfish/v1/schemas/{item}: “@odata.type”: “#SchemaFile.1.0.0.SchemaFile" /redfish/v1/schemas/{item}: “@odata.type”: “#JsonSchemaFile.v1_0_0.JsonSchemaFile"

The main difference in the SchemaFile and JsonSchemaFile is the change from using extref as a pointer to using the Uri property:

iLO 4 example:

{
    "Uri": {
        "extref": "/redfish/v1/registrystore/en/BiosAttributeRegistryP89.v1_0_0.json"
    }
}

iLO 5 example:

{
   "Uri": "/redfish/v1/registrystore/en/BiosAttributeRegistryP89.v1_0_0.json"
}

On-Service Message Registries

Message Registries available in the service conform to Redfish.

The HpCommon registry is renamed to HpeCommon and changed to version 2.0.0.

The iLO registry version is also changed to 2.0.0. The base remains at 1.0.0 because that is a Redfish standard registry.

iLO 4 iLO 5
“Type”: “MessageRegistry.0.10.0” “@odata.type”: “#MessageRegistry.1.0.0.MessageRegistry”
Version RegistryVersion
none OwningEntity (== Hewlett Packard Enterprise)

The collection of Message Registries is changed to:

iLO 4 @odata.type iLO 5 @odata.type
#SchemaFileCollection.SchemaFileCollection" "#MessageRegistryFileCollection.MessageRegistryFileCollection"

The collection items pointing to the registries change type:

iLO 4 @odata.type iLO 5 @odata.type
"#SchemaFile.1.0.0.SchemaFile" "#MessageRegistryFile.1.0.0.MessageRegistryFile"

The only difference between SchemaFile/JsonSchemaFile and MessageRegistryFile is the property substitution Schema for Registry.

Integrated Management Log (IML)

/redfish/v1/Systems/{item}/LogServices/IML/Entries/{item}/

The Integrated Management Log (IML) RESTful API in iLO 5 is significantly enhanced. Each log entry is Redfish conformant with the LogEntry Schema and has been enhanced with features of the IML using an Oem/Hpe extension.

Compared to iLO 4, the following items are new or changed:

Property Change Notes
Oem/Hpe/RecommendedAction Added This is a text string with recommended actions to resolve a condition indicated by this event.
Oem/Hpe/Categories (array of strings) Added Categorizes this log entry into one or more defined categories (see below).
Oem/Hpe/LearnMoreLink Added A URI with the location of more information for this class and code of event.
Oem/Hpe/Count Added Replaces the “Number” property in iLO 4 which was not Redfish conformant and was hidden when the resource was requested in Redfish mode.
Oem/Hpe/Repaired Added This boolean flag indicates whether the event has been repaired.
OemRecordFormat Changed The Oem Record Format has been changed from “Hp-IML” to “Hpe-IML”.
Oem/Hpe/EventNumber Added Replaces the “RecordId” property in iLO 4 which was not Redfish conformant and was hidden when the resource was requested in Redfish mode.

Event Categories

An event can indicate that it is in one or more of the following categories:

Categories
Security
Hardware Failure
Firmware Failure
Maintenance
Administration
Power
Cooling
Invalid User Input
Other
Configuration

iLO 4 example:

{
  "@odata.context": "/redfish/v1/$metadata#Systems/Members/1/LogServices/IML/Entries/Members/$entity",
  "@odata.id": "/redfish/v1/Systems/1/LogServices/IML/Entries/1/",
  "@odata.type": "#LogEntry.1.0.0.LogEntry",
  "Created": "2016-01-12T21:38:00Z",
  "EntryType": "Oem",
  "Id": "1",
  "Message": "IML Cleared (iLO 4 user:[NONE])",
  "Name": "Integrated Management Log",
  "Oem": {
    "Hp": {
      "@odata.type": "#HpLogEntry.1.0.0.HpLogEntry",
      "Class": 33,
      "Code": 1,
      "EventNumber": 28,
      "Updated": "2016-01-12T21:38:00Z"
    }
  },
  "OemRecordFormat": "Hp-IML",
  "Severity": "OK"
}

iLO 5 example:

{
  "@odata.context": "/redfish/v1/$metadata#Systems/Members/1/LogServices/IML/Entries/Members/$entity",
  "@odata.id": "/redfish/v1/Systems/1/LogServices/IML/Entries/1/",
  "@odata.type": "#LogEntry.v1_0_0.LogEntry",
  "Created": "2034-01-01T23:20:04Z",
  "EntryType": "Oem",
  "Id": "1",
  "Message": "System Overheating (Temperature Sensor 0x07, Location Power Supply, Temperature 48)",
  "Name": "Integrated Management Log",
  "Oem": {
    "Hpe": {
      "@odata.type": "#HpeLogEntry.v2_0_0.HpeLogEntry",
      "Categories": [
        "Hardware Failure"
      ],
      "Class": 2,
      "Code": 1,
      "EventNumber": 197,
      "LearnMoreLink": "http://www.hpe.com/support/class0x02code0x01/",
      "RecommendedAction": "Replace DIMM at slot no. 0x07, socket ",
      "Repaired": false,
      "Updated": "2034-01-01T23:20:04Z"
    }
  },
  "OemRecordFormat": "Hpe-IML",
  "Severity": "Warning"
}

EventService (/redfish/v1/EventService/)

The following properties are removed for Redfish conformance:

Event Destinations

The following properties are removed for Redfish conformance:

Detail of All Property Changes

Property Replacements and Removals

Chassis Renames and Removals

@odata.type: #Chassis.v1_2_0.Chassis

Property Replacement Note
/Version none /Version is not Redfish conformant.

ComputerSystem Renames and Removals

@odata.type: #ComputerSystem.v1_2_0.ComputerSystem

Property Replacement
/BIOSPOSTCode none1
/Bios/Current /BiosVersion
/Boot/BootSourceOverrideSupported /Boot/BootSourceOverrideTarget@Redfish.AllowableValues2
/Boot/UefiTargetBootSourceOverrideSupported /Boot/UefiTargetBootSourceOverride@Redfish.AllowableValues3
/HostCorrelation none4
/Memory/Status /MemorySummary/Status
/Memory/TotalSystemMemoryGB /MemorySummary/TotalSystemMemoryGiB
/Power /PowerState5
/Processors/Count /ProcessorSummary/Count
/Processors/ProcessorFamily /ProcessorSummary/Model
/Processors/Status /ProcessorSummary/Status
/Version none6
/VirtualSerialNumber none7

1/BIOSPOSTCode is not Redfish conformant. 2/Boot/BootSourceOverrideSupported is not Redfish conformant. 3/Boot/UefiTargetBootSourceOverrideSupported is not Redfish conformant. 4/HostCorrelation is not Redfish conformant. 5/Power is not Redfish conformant. 6/Version is not Redfish conformant. 7/VirtualSerialNumber is not Redfish conformant.

EthernetInterface Renames and Removals

@odata.type: #EthernetInterface.v1_0_0.EthernetInterface

Property Replacement Note
/Autosense /AutoNeg /Autosense is not Redfish conformant.
/FactoryMacAddress /PermanentMACAddress /FactoryMacAddress is not Redfish conformant.
/LinkTechnology none /LinkTechnology is not Redfish conformant. Ethernet is assumed.
/MacAddress /MACAddress /MacAddress is not Redfish conformant.

Event Renames and Removals

@odata.type: #Event.v1_0_0.Event

Property Replacement Note
/Events[]/EventID /Events[]/EventId
/Events[]/MessageID /Events[]/MessageId /Events[]/MessageID is not Redfish conformant.

EventDestination Renames and Removals

@odata.type: #EventDestination.v1_0_0.EventDestination

Property Replacement Note
/TTLCount none /TTLCount is not Redfish conformant.
/TTLUnits none /TTLUnits is not Redfish conformant.

EventService Renames and Removals

@odata.type: #EventService.v1_0_1.EventService

Property Replacement Note
/DeliveryRetryIntervalInSeconds /Oem/Hpe/DeliveryRetryIntervalSeconds /DeliveryRetryIntervalInSeconds is not Redfish conformant. This has been moved into the EventDestination OEM section as /Oem/Hpe/DeliveryRetryIntervalInSeconds in the HpeEventDestination schema.
/SubscriptionRemovalAction none /SubscriptionRemovalAction is not Redfish conformant.
/SubscriptionRemovalTimeIntervalInMinutes none /SubscriptionRemovalTimeIntervalInMinutes is not Redfish conformant.

ExtendedInfo Renames and Removals

@odata.type: #ExtendedInfo.1.0.0.ExtendedInfo

Property Replacement Note
/Messages /@Message.ExtendedInfo /Messages is not Redfish conformant.
/error/@Message.ExtendedInfo[]/MessageID /error/@Message.ExtendedInfo[]/MessageId /error/@Message.ExtendedInfo[]/MessageID is not Redfish conformant.

HpeBaseNetworkAdapter Renames and Removals

@odata.type: #HpeBaseNetworkAdapter.v2_0_0.HpeBaseNetworkAdapter

Property Replacement Note
/PhysicalPorts[]/links/EthernetNetworkAdapter none

HpeComputerSystemExt Renames and Removals

@odata.type: #HpeComputerSystemExt.v2_1_0.HpeComputerSystemExt

Property Replacement Note
/Actions/#HpComputerSystemExt.PowerButton /Actions/#HpeComputerSystemExt.PowerButton HPE Branding Transition
/Actions/#HpComputerSystemExt.ServerSigRecompute /Actions/#HpeComputerSystemExt.ServerSigRecompute HPE Branding Transition
/Actions/#HpComputerSystemExt.SystemReset /Actions/#HpeComputerSystemExt.SystemReset HPE Branding Transition
/TrustedModules ComputerSystem#/TrustedModules This has been formally approved in the Redfish standard and moved from the Oem/Hpe section into the main ComputerSystem object.

HpeESKM Renames and Removals

@odata.type: #HpeESKM.v2_0_0.HpeESKM

Property Replacement Note
/Actions/#HpESKM.ClearESKMLog /Actions/#HpeESKM.ClearESKMLog HPE Branding Transition
/Actions/#HpESKM.TestESKMConnections /Actions/#HpeESKM.TestESKMConnections HPE Branding Transition

HpeHttpsCert Renames and Removals

@odata.type: #HpeHttpsCert.v2_0_0.HpeHttpsCert

Property Replacement Note
/Actions/#HpHttpsCert.GenerateCSR /Actions/#HpeHttpsCert.GenerateCSR HPE Branding Transition
/Actions/#HpHttpsCert.ImportCertificate /Actions/#HpeHttpsCert.ImportCertificate HPE Branding Transition

HpeiLO Renames and Removals

@odata.type: #HpeiLO.v2_0_0.HpeiLO

Property Replacement Note
/Actions/#HpiLO.ClearRestApiState /Actions/#HpeiLO.ClearRestApiState HPE Branding Transition
/Actions/#HpiLO.ResetToFactoryDefaults /Actions/#HpeiLO.ResetToFactoryDefaults HPE Branding Transition
/Actions/#HpiLO.iLOFunctionality /Actions/#HpeiLO.iLOFunctionality HPE Branding Transition

HpeiLOActiveHealthSystem Renames and Removals

@odata.type: #HpeiLOActiveHealthSystem.v2_0_0.HpeiLOActiveHealthSystem

Property Replacement Note
/Actions/#HpiLOActiveHealthSystem.ClearLog /Actions/#HpeiLOActiveHealthSystem.ClearLog HPE Branding Transition

HpeiLOEmbeddedMedia Renames and Removals

@odata.type: #HpeiLOEmbeddedMedia.v2_0_0.HpeiLOEmbeddedMedia

Property Replacement Note
/SDCard/HpCertified /SDCard/HpeCertified HPE Branding Transition

HpeiLOManagerNetworkService Renames and Removals

@odata.type: #HpeiLOManagerNetworkService.v2_0_0.HpeiLOManagerNetworkService

Property Replacement Note
/Actions/#HpiLOManagerNetworkService.SendTestAlertMail /Actions/#HpeiLOManagerNetworkService.SendTestAlertMail HPE Branding Transition
/Actions/#HpiLOManagerNetworkService.SendTestSyslog /Actions/#HpeiLOManagerNetworkService.SendTestSyslog HPE Branding Transition
/HPSystemManagementHomepageAddress /SystemManagementHomepage HPE Branding Transition

HpeiLOSSO Renames and Removals

@odata.type: #HpeiLOSSO.v2_0_0.HpeiLOSSO

Property Replacement Note
/Actions/#HpiLOSSO.DeleteAllSSORecords /Actions/#HpeiLOSSO.DeleteAllSSORecords HPE Branding Transition
/Actions/#HpiLOSSO.DeleteSSORecordbyNumber /Actions/#HpeiLOSSO.DeleteSSORecordbyNumber HPE Branding Transition
/Actions/#HpiLOSSO.ImportCertificate /Actions/#HpeiLOSSO.ImportCertificate HPE Branding Transition
/Actions/#HpiLOSSO.ImportDNSName /Actions/#HpeiLOSSO.ImportDNSName HPE Branding Transition

HpeiLOSnmpService Renames and Removals

@odata.type: #HpeiLOSnmpService.v2_0_0.HpeiLOSnmpService

Property Replacement Note
/Actions/#SnmpService.SendSNMPTestAlert /Actions/#HpeiLOSnmpService.SendSNMPTestAlert

HpeiLOVirtualMedia Renames and Removals

@odata.type: #HpeiLOVirtualMedia.v2_0_0.HpeiLOVirtualMedia

Property Replacement Note
/Actions/#HpiLOVirtualMedia.1.1.0.EjectVirtualMedia /Actions/#HpeiLOVirtualMedia.EjectVirtualMedia HPE Branding Transition
/Actions/#HpiLOVirtualMedia.1.1.0.InsertVirtualMedia /Actions/#HpeiLOVirtualMedia.InsertVirtualMedia HPE Branding Transition

LogEntry Renames and Removals

@odata.type: #LogEntry.v1_0_0.LogEntry

Property Replacement Note
/Number none /Number is not Redfish conformant.
/RecordId /EventNumber /RecordId is not Redfish conformant.

Manager Renames and Removals

@odata.type: #Manager.v1_1_0.Manager

Property Replacement Note
/CommandShell/Enabled /CommandShell/ServiceEnabled /CommandShell/Enabled is not Redfish conformant.
/Firmware /FirmwareVersion /Firmware is not Redfish conformant.
/GraphicalConsole/Enabled /GraphicalConsole/ServiceEnabled /GraphicalConsole/Enabled is not Redfish conformant.
/SerialConsole/Enabled /SerialConsole/ServiceEnabled /SerialConsole/Enabled is not Redfish conformant.

ManagerNetworkProtocol Renames and Removals

@odata.type: #ManagerNetworkProtocol.v1_0_0.ManagerNetworkProtocol

Property Replacement Note
/HTTP/Enabled /HTTP/ProtocolEnabled /HTTP/Enabled is not Redfish conformant.
/HTTPS/Enabled /HTTPS/ProtocolEnabled /HTTPS/Enabled is not Redfish conformant.
/IPMI/Enabled /IPMI/ProtocolEnabled /IPMI/Enabled is not Redfish conformant.
/KVMIP/Enabled /KVMIP/ProtocolEnabled /KVMIP/Enabled is not Redfish conformant.
/SNMP/Enabled /SNMP/ProtocolEnabled /SNMP/Enabled is not Redfish conformant.
/SSDP/Enabled /SSDP/ProtocolEnabled /SSDP/Enabled is not Redfish conformant.
/SSH/Enabled /SSH/ProtocolEnabled /SSH/Enabled is not Redfish conformant.
/SessionTimeoutMinutes none /SessionTimeoutMinutes is not Redfish conformant.
/VirtualMedia/Enabled /VirtualMedia/ProtocolEnabled /VirtualMedia/Enabled is not Redfish conformant.

Power Renames and Removals

@odata.type: #Power.v1_0_1.Power

Property Replacement Note
/PowerAllocatedWatts /PowerControl/PowerAllocatedWatts /PowerAllocatedWatts is not Redfish conformant.
/PowerAvailableWatts /PowerControl/PowerAvailableWatts /PowerAvailableWatts is not Redfish conformant.
/PowerCapacityWatts /PowerControl/PowerCapacityWatts /PowerCapacityWatts is not Redfish conformant.
/PowerConsumedWatts /PowerControl/PowerConsumedWatts /PowerConsumedWatts is not Redfish conformant.
/PowerLimit /PowerControl/PowerLimit /PowerLimit is not Redfish conformant.
/PowerMetrics /PowerControl/PowerMetrics /PowerMetrics is not Redfish conformant.
/PowerRequestedWatts /PowerControl/PowerRequestedWatts /PowerRequestedWatts is not Redfish conformant.
/PowerSupplies[]/CorrelatableID none /PowerSupplies[]/CorrelatableID is not Redfish conformant.

ServiceRoot Renames and Removals

@odata.type: #ServiceRoot.v1_1_0.ServiceRoot

Property Replacement Note
/Time HpeiLOServiceExt#/Time /Time is not Redfish conformant. A replacement to this is defined in the Oem section of Manager (HpeiLOServiceExt).

Thermal Renames and Removals

@odata.type: #Thermal.v1_1_0.Thermal

Property Replacement Note
/Fans[]/Context /Fans[]/PhysicalContext /Fans[]/Context is not Redfish conformant.
/Fans[]/CurrentReading /Fans[]/Reading /Fans[]/CurrentReading is not Redfish conformant.
/Fans[]/FanName /Fans[]/Name
/Fans[]/ReadingRPM /Fans[]/Reading
/Fans[]/Units /Fans[]/ReadingRPM /Fans[]/Units is not Redfish conformant.
/Temperatures[]/Context /Temperatures[]/PhysicalContext /Temperatures[]/Context is not Redfish conformant.
/Temperatures[]/CurrentReading /Temperatures[]/ReadingCelsius /Temperatures[]/CurrentReading is not Redfish conformant.
/Temperatures[]/Number /Temperatures[]/SensorNumber /Temperatures[]/Number is not Redfish conformant.
/Temperatures[]/Units /Temperatures[]/ReadingCelsius /Temperatures[]/Units is not Redfish conformant.

Property Additions to existing Types

Chassis Additions

@odata.type: #Chassis.v1_2_0.Chassis

Property Note
/Links/Drives An array of references to the drives contained in this chassis.
/PhysicalSecurity A Redfish standard Physical Security object if supported and installed on the chassis.

ComputerSystem Additions

@odata.type: #ComputerSystem.v1_2_0.ComputerSystem

Property Note
/Boot/BootSourceOverrideMode none
/Boot/BootSourceOverrideTarget@Redfish.AllowableValues none
/Boot/UefiTargetBootSourceOverride@Redfish.AllowableValues none
/SecureBoot A reference to the UEFI SecureBoot resource associated with this system.
/Storage A reference to the collection of storage devices associated with this system.
/TrustedModules This object describes the array of Trusted Modules in the system.

Event Additions

@odata.type: #Event.v1_0_0.Event

Property Note
/Events[]/EventId This is a unique instance identifier of an event.

HpeAdvancedMemoryProtection Additions

@odata.type: #HpeAdvancedMemoryProtection.v2_0_0.HpeAdvancedMemoryProtection

Property Note
/MemoryList An array of memory boards containing socket and CPU correlation information.

HpeBaseNetworkAdapter Additions

@odata.type: #HpeBaseNetworkAdapter.v2_0_0.HpeBaseNetworkAdapter

Property Note
/FcPorts Information about the Fiber Channel Ports in the server.

HpeComputerSystemExt Additions

@odata.type: #HpeComputerSystemExt.v2_1_0.HpeComputerSystemExt

Property Note
/AggregateHealthStatus The Aggregate Health Status of the System.
/HostOS none
/Links/USBPorts A reference to the USB Port Connectors associated with this system.
/PCAPartNumber The PCA part number.
/PCASerialNumber The PCA serial number.
/PostDiscoveryCompleteTimeStamp Displays the last known POST Discovery Complete time.
/PostDiscoveryMode The mode which the system operates during the discovery section of POST.
/SMBIOS A reference to the SMBIOS records associated with this system.
/SmartStorageConfig An array of references to SmartStorage elements associated with this system.
/ProcessorJitterControl Allows the user to set the Processor Jitter Control mode and Frequency at run time.
/CurrentPowerOnTimeSeconds Shows the amount of time (in seconds) that has passed since the server was last powered on.
/PowerOnMinutes Retrieves the virtual clock value, in minutes, since the server was first powered on.

HpeLogEntry Additions

@odata.type: #HpeLogEntry.v2_0_0.HpeLogEntry

Property Note
/Categories The log entry categories.
/Count The occurrence count of the log entry.
/LearnMoreLink The HPSC link for troubleshooting information.
/RecommendedAction The recommended action for the event.

HpePowerMetricsExt Additions

@odata.type: #HpePowerMetricsExt.v2_0_0.HpePowerMetricsExt

Property Note
/BbuPowerSupply Battery Backup Unit Power Supply action determines what occurs when a server is running on battery power.
/HasPowerMetering Indicates if the system has power metering.
/MinimumSafelyAchievableCap Minimum Safely Achievable Cap is the lowest cap value that is safe for a group power manager to apply to a particular server. It can either be identical to or slightly greater than the 0 percent cap value calculated during ROM power burn.
/HighEfficiencyMode The redundant power supply mode that is used when redundant power supplies are configured.

HpeSecurityService Additions

@odata.type: #HpeSecurityService.v2_0_0.HpeSecurityService

Property Note
/SecurityState The operational security level of this Manager.
/LoginSecurityBanner Allows you to configure the security banner displayed on the iLO login screen.
/CurrentCipher Displays the current cipher in use.

HpeServerChassis Additions

@odata.type: #HpeServerChassis.v2_0_0.HpeServerChassis

Property Note
/Links/BladeEnclosure The URI for this blade enclosure resource.
/SystemMaintenanceSwitches Describes the maintenance switch positions

HpeServerFan Additions

@odata.type: #HpeServerFan.v2_0_0.HpeServerFan

Property Note
/HotPluggable Indicates if the fan can be replaced while the server is running.
/Redundant Indicates if the fan is in a redundant configuration.

HpeServerPciDevice Additions

@odata.type: #HpeServerPciDevice.v2_0_0.HpeServerPciDevice

Property Note
/LocationString Text representation of the UEFI device location.

HpeSmartStorageArrayController Additions

@odata.type: #HpeSmartStorageArrayController.v2_0_0.HpeSmartStorageArrayController

Property Note
/ControllerPartNumber Smart Array Controller Part Number

HpeSmartStorageDiskDrive Additions

@odata.type: #HpeSmartStorageDiskDrive.v2_0_0.HpeSmartStorageDiskDrive

Property Note
/LegacyBootPriority This indicates that the array controller should provide legacy boot support.

HpeSmartStorageLogicalDrive Additions

@odata.type: #HpeSmartStorageLogicalDrive.v2_0_0.HpeSmartStorageLogicalDrive

Property Note
/InterfaceType The connection interface of the logical drive.
/MediaType Type of the disk this logical drive is associated with.

HpeiLO Additions

@odata.type: #HpeiLO.v2_0_0.HpeiLO

Property Note
/ConfigurationSettings State of the currently displayed configuration settings.
/IdleConnectionTimeoutMinutes This setting specifies how long a user can be inactive before an iLO web interface ends automatically.
/Links/Thumbnail A link to static images in Manager.
/RIBCLEnabled This property enables or disables RIBCL for the management processor. The management processor requires reset when this field is modified.
/WebGuiEnabled This property enables or disables WEB GUI access for the management processor. The management processor requires reset when this field is modified.
/PersistentMouseKeyboardEnabled This property enables or disables the persistent keyboard and mouse feature.

HpeiLOEmbeddedMedia Additions

@odata.type: #HpeiLOEmbeddedMedia.v2_0_0.HpeiLOEmbeddedMedia

Property Note
/SDCard/HpeCertified True if this is an HPE-certified SD card.

HpeiLOManagerNetworkService Additions

@odata.type: #HpeiLOManagerNetworkService.v2_0_0.HpeiLOManagerNetworkService

Property Note
/SystemManagementHomepage The IP address or FQDN of the System Management Homepage (SMH) server.

HpeiLOResourceDirectory Additions

@odata.type: #HpeiLOResourceDirectory.v2_0_0.HpeiLOResourceDirectory

Property Note
/Instances[]/HttpMethods This property lists the set of methods supported by the resource.

HpeiLOServiceExt Additions

@odata.type: #HpeiLOServiceExt.v2_0_0.HpeiLOServiceExt

Property Note
/Time The current Redfish service time. This is a replacement for the ServiceRoot Time removed in Redfish.

Manager Additions

@odata.type: #Manager.v1_1_0.Manager

Property Note
/Links/ManagerInChassis This property is a reference to the chassis that this manager is located within.

ServiceRoot Additions

@odata.type: #ServiceRoot.v1_1_0.ServiceRoot

Property Note
/UpdateService The URI to this UpdateService resource.

Thermal Additions

@odata.type: #Thermal.v1_1_0.Thermal

Property Note
/Fans[]/Name The name of the fan sensor.
/Fans[]/Reading The current speed of the fan.
/Temperatures[]/SensorNumber A numerical identifier to represent the temperature sensor.

Managing iLO 5 Users

iLO 5 supports both local user authentication as well as directory authentication.

iLO 5 1.40 adds:

All user account modifications require the client to be authenticated with the “Administer User Accounts” privilege (UserConfigPriv in the Redfish ManagerAccount)

Local User Administration

iLO 5 has a local user database enabling consistent user management for all interfaces including the Web interface (GUI) as well as the Redfish API. The iLO 5 local user accounts are managed in the AccountService (/redfish/v1/AccountService). An Accounts collection in the AccountService enables clients to create, modify, or remove local user accounts.

GET /redfish/v1/AccountService/Accounts/

{
    "@odata.context": "/redfish/v1/$metadata#ManagerAccountCollection.ManagerAccountCollection",
    "@odata.etag": "W/\"21C260DB\"",
    "@odata.id": "/redfish/v1/AccountService/Accounts/",
    "@odata.type": "#ManagerAccountCollection.ManagerAccountCollection",
    "Description": "iLO User Accounts",
    "Name": "Accounts",
    "Members": [
        {
            "@odata.id": "/redfish/v1/AccountService/Accounts/1/"
        }
    ],
    "Members@odata.count": 1
}

A local user account consists of a user name, password, and a set of privileges. The RoleId describes one of three defined Redfish roles based upon assigned privileges. The Oem/Hpe/LoginName property is a description of the account.

NOTE: Due to a terminology mismatch between the Redfish standard and historical iLO products, the Properties for UserName and LoginName are reversed in Redfish vs. the iLO 5 Web interface:

Redfish Property GUI Term Description Example
UserName Login Name The user identity string used with a password to log into iLO 5 jsmith
Oem/Hpe/LoginName User Name The descriptive name of the user Jane Smith - Director of IT

GET /redfish/v1/AccountService/Accounts/1/

{
    "@odata.context": "/redfish/v1/$metadata#ManagerAccount.ManagerAccount",
    "@odata.etag": "W/\"D9DF9F68\"",
    "@odata.id": "/redfish/v1/AccountService/Accounts/1/",
    "@odata.type": "#ManagerAccount.v1_1_3.ManagerAccount",
    "Id": "1",
    "Description": "iLO User Account",
    "Links": {
        "Role": {
            "@odata.id": "/redfish/v1/AccountService/Roles/Administrator/"
        }
    },
    "Name": "User Account",
    "Oem": {
        "Hpe": {
            "@odata.context": "/redfish/v1/$metadata#HpeiLOAccount.HpeiLOAccount",
            "@odata.type": "#HpeiLOAccount.v2_2_0.HpeiLOAccount",
            "LoginName": "Jane Smith - Director of IT",
            "Privileges": {
                "HostBIOSConfigPriv": true,
                "HostNICConfigPriv": true,
                "HostStorageConfigPriv": true,
                "LoginPriv": true,
                "RemoteConsolePriv": true,
                "SystemRecoveryConfigPriv": true,
                "UserConfigPriv": true,
                "VirtualMediaPriv": true,
                "VirtualPowerAndResetPriv": true,
                "iLOConfigPriv": true
            },
            "ServiceAccount": false
        }
    },
    "Password": null,
    "RoleId": "Administrator",
    "UserName": "jsmith"
}

Note that Password is always shown as null even though its PATCHable with a new password

Roles and Privileges

iLO 5 uses a set of privileges assigned to each user account to grant and restrict access to features. iLO 5’s privileges are:

Redfish iLO Web Interface (GUI)
LoginPriv Login
RemoteConsolePriv Remote Console
VirtualPowerAndResetPriv Virtual Power and Reset
VirtualMediaPriv Virtual Media
HostBIOSConfigPriv Host BIOS
iLOConfigPriv Configure iLO Settings
UserConfigPriv Administer User Accounts
HostNICConfigPriv Host NIC
HostStorageConfigPriv Host Storage
SystemRecoveryConfigPriv Recovery Set

Roles

In iLO 5 1.40 and later, you can use RoleId to create users with specific starting privileges.

On a GET of the local user account, RoleId is synthesized based upon the enabled privileges. iLO 5 does not store a separate RoleId value. For this reason, modifications to raw privileges may or may not result in a changed RoleId based upon iLO’s mapping

If the PATCH includes both RoleID and individual privileges, the privileges corresponding to the RoleId are assigned to the local user account first, and then the explicit privileges are assigned.

PATCH /redfish/v1/AccountService/Accounts/{accountId}

{
    "RoleId": "Administrator",
    "Oem": {
        "Hpe": {
            "Privileges": {
                "SystemRecoveryConfigPriv": true
            }
        }
    }
}

will set all iLO 5 privileges as long as the account performing the operation already has sufficient privilege to grant these privileges.

Privileges granted on Local Account Creation by RoleId

RoleId Privileges
Administrator HostBIOSConfigPriv, HostNICConfigPriv, HostStorageConfigPriv, LoginPriv, RemoteConsolePriv, UserConfigPriv, VirtualMediaPriv, VirtualPowerAndResetPriv, iLOConfigPriv
Operator HostBIOSConfigPriv, HostNICConfigPriv, HostStorageConfigPriv, LoginPriv, RemoteConsolePriv, VirtualMediaPriv, VirtualPowerAndResetPriv
ReadOnly LoginPriv

RoleId shown on an existing Local User Account by Privilege

The RoleId reported is the smallest superset of assigned privileges.

Privileges RoleId
LoginPriv only ReadOnly
iLOConfigPriv or UserConfigPriv or SystemRecoveryConfigPriv and anything else Administrator
any other combination Operator

Creating a new Local User Account

The simplest possible new local user account create operation is to POST to the Accounts collection, as shown in the example in the right pane.

PATCH /redfish/v1/AccountService/Accounts/{accountId}

{
    "UserName": "jsmith",
    "Password": "passwordexample"
}

The next example in the right pane creates a user account jsmith with the default ReadOnly RoleId and only the iLO 5 Login privilege. Notice that Oem/Hpe/LoginName defaults to the provided UserName unless it is specifically specified.

NOTE: Each local user account must have a unique UserName.

GET /redfish/v1/AccountService/Accounts/{accountId}

{
    "@odata.context": "/redfish/v1/$metadata#ManagerAccount.ManagerAccount",
    "@odata.etag": "W/\"B103601C\"",
    "@odata.id": "/redfish/v1/AccountService/Accounts/12/",
    "@odata.type": "#ManagerAccount.v1_1_3.ManagerAccount",
    "Id": "12",
    "Description": "iLO User Account",
    "Links": {
        "Role": {
            "@odata.id": "/redfish/v1/AccountService/Roles/ReadOnly/"
        }
    },
    "Name": "User Account",
    "Oem": {
        "Hpe": {
            "@odata.context": "/redfish/v1/$metadata#HpeiLOAccount.HpeiLOAccount",
            "@odata.type": "#HpeiLOAccount.v2_2_0.HpeiLOAccount",
            "LoginName": "jsmith",
            "Privileges": {
                "HostBIOSConfigPriv": false,
                "HostNICConfigPriv": false,
                "HostStorageConfigPriv": false,
                "LoginPriv": true,
                "RemoteConsolePriv": false,
                "SystemRecoveryConfigPriv": false,
                "UserConfigPriv": false,
                "VirtualMediaPriv": false,
                "VirtualPowerAndResetPriv": false,
                "iLOConfigPriv": false
            },
            "ServiceAccount": false
        }
    },
    "Password": null,
    "RoleId": "ReadOnly",
    "UserName": "jsmith"
}

Creating a new Account using a RoleId

In iLO 5 1.40 and later, you may specify a RoleId with a new user account, as shown in the right pane.

POST /redfish/v1/AccountService/Accounts/

{
    "UserName": "jsmith",
    "Password": "passwordexample",
    "RoleId": "Operator"
}

This results in: GET /redfish/v1/AccountService/Accounts/{accountId}

{
    "@odata.context": "/redfish/v1/$metadata#ManagerAccount.ManagerAccount",
    "@odata.etag": "W/\"6C16FDE3\"",
    "@odata.id": "/redfish/v1/AccountService/Accounts/14/",
    "@odata.type": "#ManagerAccount.v1_1_3.ManagerAccount",
    "Id": "14",
    "Description": "iLO User Account",
    "Links": {
        "Role": {
            "@odata.id": "/redfish/v1/AccountService/Roles/Operator/"
        }
    },
    "Name": "User Account",
    "Oem": {
        "Hpe": {
            "@odata.context": "/redfish/v1/$metadata#HpeiLOAccount.HpeiLOAccount",
            "@odata.type": "#HpeiLOAccount.v2_2_0.HpeiLOAccount",
            "LoginName": "jsmith",
            "Privileges": {
                "HostBIOSConfigPriv": true,
                "HostNICConfigPriv": true,
                "HostStorageConfigPriv": true,
                "LoginPriv": true,
                "RemoteConsolePriv": true,
                "SystemRecoveryConfigPriv": false,
                "UserConfigPriv": false,
                "VirtualMediaPriv": true,
                "VirtualPowerAndResetPriv": true,
                "iLOConfigPriv": false
            },
            "ServiceAccount": false
        }
    },
    "Password": null,
    "RoleId": "Operator",
    "UserName": "jsmith"
}

Creating a new Account with specific Privileges

You may also create a local user with specific privileges, as shown in the right pane.

POST /redfish/v1/AccountService/Accounts/

{
    "UserName": "jsmith",
    "Password": "passwordexample",
    "Oem": {
        "Hpe": {
            "LoginName": "Director of IT",
            "Privileges": {
                "LoginPriv": true,
                "VirtualMediaPriv": true,
                "VirtualPowerAndResetPriv": true
            }
        }
    }
}

This results in the following new local user account: GET /redfish/v1/AccountService/Accounts/{accountId}

{
    "@odata.context": "/redfish/v1/$metadata#ManagerAccount.ManagerAccount",
    "@odata.etag": "W/\"E8037663\"",
    "@odata.id": "/redfish/v1/AccountService/Accounts/15/",
    "@odata.type": "#ManagerAccount.v1_1_3.ManagerAccount",
    "Id": "15",
    "Description": "iLO User Account",
    "Links": {
        "Role": {
            "@odata.id": "/redfish/v1/AccountService/Roles/Operator/"
        }
    },
    "Name": "User Account",
    "Oem": {
        "Hpe": {
            "@odata.context": "/redfish/v1/$metadata#HpeiLOAccount.HpeiLOAccount",
            "@odata.type": "#HpeiLOAccount.v2_2_0.HpeiLOAccount",
            "LoginName": "Director of IT",
            "Privileges": {
                "HostBIOSConfigPriv": false,
                "HostNICConfigPriv": false,
                "HostStorageConfigPriv": false,
                "LoginPriv": true,
                "RemoteConsolePriv": false,
                "SystemRecoveryConfigPriv": false,
                "UserConfigPriv": false,
                "VirtualMediaPriv": true,
                "VirtualPowerAndResetPriv": true,
                "iLOConfigPriv": false
            },
            "ServiceAccount": false
        }
    },
    "Password": null,
    "RoleId": "Operator",
    "UserName": "jsmith"
}

Modifying a Local User Account

The following properties are modifiable on an existing local user account: * UserName * Password - this is always returned as null, but you may PATCH it with a value to change the password * RoleId - PATCHing RoleId on an existing local user account will reset it’s existing privileges with those mapped to the RoleId. * Oem/Hpe/LoginName * Oem/Hpe/Privileges/* - any of the privileges may be modified with true or false

Adding and Removing Privileges

Local user account privileges may be modified with a PATCH to the URI of the desired ManagerAccount resource, as shown in the example in the right pane.

PATCH /redfish/v1/AccountService/Accounts/{accountId}/

{
    "Oem": {
        "Hpe": {
            "Privileges": {
                "VirtualMediaPriv": true,
                "VirtualPowerAndResetPriv": true
            }
        }
    }
}

Changing Roles

See the example in the right pane.

PATCH /redfish/v1/AccountService/Accounts/{accountId}/

{
    "RoleId": "Operator"
}

results in HTTPS status 200:

{
    "error": {
        "code": "iLO.0.10.ExtendedInfo",
        "message": "See @Message.ExtendedInfo for more information.",
        "@Message.ExtendedInfo": [
            {
                "MessageId": "Base.1.0.AccountModified"
            }
        ]
    }
}

Changing Password

Local user account passwords may be modified with a PATCH to the URI of the desired ManagerAccount resource, as shown in the example in the right pane.

PATCH /redfish/v1/AccountService/Accounts/{accountId}/

{
    "Password": "newpassword"
}

Removing a Local User Account

A local user account can be removed with a DELETE to the URI of desired ManagerAccount resource, as shown in the example in the right pane.

DELETE /redfish/v1/AccountService/Accounts/{accountId}/

Directory Authentication

Enabling or Disabling Local User Accounts

See the examples in the right pane for more information.

PATCH /redfish/v1/AccountService/

{
    "LocalAccountAuth": "Disabled"
}

or json { "LocalAccountAuth": "Enabled" }

Note: Disabling local user accounts is not allowed if both Directory Authentication and Kerberos Authentication are disabled.

Configuring Active Directory Authentication

See the examples in the right pane for examples of configuring active directory authentication.

PATCH /redfish/v1/AccountService/

Example 1 (Using default Active Directory server port 636):

{
    "LDAP": {
        "ServiceEnabled": true,
        "ServiceAddresses": [
            "<Active Directory Server host name>"
        ]
    }
}

Example 2 (Using explicit/custom Active Directory server port):

{
    "LDAP": {
        "ServiceEnabled": true,
        "ServiceAddresses": [
            "<Active Directory Server host name>:4646"
        ]
    }
}

Configuring LDAP Authentication

See the examples in the right pane for examples of configuring LDAP authentication.

PATCH /redfish/v1/AccountService/

Example 1 (Using default OpenLDAP server port 636):

{
    "LDAP": {
        "AccountProviderType": "LDAPService",
        "ServiceEnabled": true,
        "ServiceAddresses": [
            "<LDAP Server host name>"
        ]
    }
}

Example 2 (Using explicit/custom OpenLDAP server port):

{
    "LDAP": {
        "AccountProviderType": "LDAPService",
        "ServiceEnabled": true,
        "ServiceAddresses": [
            "<LDAP Server host name>:4646"
        ]
    }
}

Disable Active Directory and LDAP Authentication (Generic LDAP)

See the example in the right pane for more information.

PATCH /redfish/v1/AccountService/

{
    "LDAP": {
        "AccountProviderType": "ActiveDirectoryService",
        "ServiceEnabled": false,
    }
}

Enable and Configure HPE Extended Schema Authentication (for Active Directory only)

See the example in the right pane for more information.

PATCH /redfish/v1/AccountService/

{
    "LDAP": {
        "ServiceEnabled": true,
        "ServiceAddresses": [
            "<Active Directory Server host name>"
        ],
        "Authentication": {
            "Username": "CN=testdevice,CN=Users,DC=ilotest2,DC=com"
        }
    },
    "Oem": {
        "Hpe": {
            "DirectorySettings": {
                "LdapAuthenticationMode": "ExtendedSchema"
            }
        }
    }
}

Add User Search Contexts

See the examples in the right pane for more information.

PATCH /redfish/v1/AccountService/

Sample Payload-1 (Add two new User Search Contexts, with no existing User Search Context present):

{
    "LDAP": {
        "LDAPService": {
            "SearchSettings": {
                "BaseDistinguishedNames": [
                    "CN=Users,DC=domain,DC=com",
                    "DC=domain,DC=com"
                ]
            }
        }
    }
}

Sample Payload-2 (Add a new User Search Context, with two existing User Search Contexts present):

{
    "LDAP": {
        "LDAPService": {
            "SearchSettings": {
                "BaseDistinguishedNames": [
                    "CN=Users,DC=domain,DC=com",
                    "DC=domain,DC=com",
                    "DC=testdomain,DC=com"
                ]
            }
        }
    }
}

Delete User Search Contexts

See the examples in the right pane for more information.

PATCH /redfish/v1/AccountService/

Sample Payload-1 (To delete one/multiple User Search Contexts):

Assume you have three existing User Search Contexts, e.g. “CN=Users,DC=domain,DC=com”, “DC=domain,DC=com” and “DC=testdomain,DC=com”. To delete one, exclude it from the payload and keep the ones to be retained.

{
    "LDAP": {
        "LDAPService": {
            "SearchSettings": {
                "BaseDistinguishedNames": [
                    "CN=Users,DC=domain,DC=com",
                    "DC=domain,DC=com"
                ]
            }
        }
    }
}

Sample Payload-2 (To delete all User Search Contexts):

{
    "LDAP": {
        "LDAPService": {
            "SearchSettings": {
                "BaseDistinguishedNames": [
                    ""
                ]
            }
        }
    }
}

Import LDAP Server CA Certificate

See the example in the right pane for more information.

POST /redfish/v1/AccountService/ExternalAccountProviders/LDAP/Certificates/

{
    "CertificateString": "-----BEGIN CERTIFICATE-----
MIIEHTCCAwWgAwIBAgIQe8LmWgF5edKw01/avJg69DANBgkqhkiG9w0BAQsFADCB
…………………………………………………………………………………………………………………………………
…………………………………………………………………………………………………………………………………
Ow==
-----END CERTIFICATE-----"
}

View LDAP Server CA Certificate Status

See the example in the right pane for more information. GET /redfish/v1/AccountService/

The property Oem/Hpe/DirectorySettings/LdapCaCertificateLoaded indicates the status of the certificate.

View LDAP Server CA Certificate Details

GET /redfish/v1/AccountService/ExternalAccountProviders/LDAP/Certificates/{certId}/

NOTE: The LDAP provider supports a single certificate

{
    "@odata.context": "/redfish/v1/$metadata#Certificate.Certificate",
    "@odata.etag": "W/\"A1110A63\"",
    "@odata.id": "/redfish/v1/AccountService/ExternalAccountProviders/LDAP/Certificates/1/",
    "@odata.type": "#Certificate.v0_9_0.Certificate",
    "Id": "1",
    "Issuer": "/C=US/O=Hewlett Packard Enterprise Company/OU=Infrastructure Services/CN=Hewlett Packard Enterprise Private Root CA",
    "Name": "LDAP Certificate",
    "SerialNumber": "7BC2E65A017979D2B0D35FDABC983AF4",
    "Subject": "/C=US/O=Hewlett Packard Enterprise Company/OU=Infrastructure Services/CN=Hewlett Packard Enterprise Private Root CA",
    "ValidNotAfter": "2025-03-16T23:59:59Z",
    "ValidNotBefore": "2015-03-17T00:00:00Z"
}

Add new Directory Groups (No Existing Groups)

See the example in the right pane for more information.

PATCH /redfish/v1/AccountService/

Sample Payload: “Administrator” and “Operator” are predefined Redfish RoleIds. “LDAP” can also be used instead of “ActiveDirectory”.

{
    "ActiveDirectory": {
        "RemoteRoleMapping": [
            {
                "LocalRole": "Administrator",
                "RemoteGroup": "TestGroup1"
            },
            {
                "LocalRole": "Operator",
                "RemoteGroup": "TestGroup2"
            }
        ]
    }
}

View Directory Groups

See the example in the right pane for more information.

GET /redfish/v1/AccountService/

See the properties under RemoteRoleMapping created by the Add operation (fragment of the response):

{
    "RemoteRoleMapping": [
        {
            "LocalRole": "dirgroup4c6c827762dd20dc530c52ef",
            "RemoteGroup": "TestGroup1"
        },
        {
            "LocalRole": "dirgroupeb9a3afc9cd9d126249c3aed",
            "RemoteGroup": "TestGroup2"
        }
    ]
}

Add New Directory Groups to Existing Groups

See the example in the right pane for more information.

PATCH /redfish/v1/AccountService/

Assume two directory groups (TestGroup1 and TestGroup2 as in the steps above) are present. Use the LocalRole and RemoteGroup values for the existing directory groups from the step above in the payload. Add an additional group “TestGroup3” with “ReadOnly” Redfish Role. “LDAP” can also be used instead of “ActiveDirectory”.

{
    "ActiveDirectory": {
        "RemoteRoleMapping": [
            {
                "LocalRole": "dirgroup4c6c827762dd20dc530c52ef",
                "RemoteGroup": "TestGroup1"
            },
            {
                "LocalRole": "dirgroupeb9a3afc9cd9d126249c3aed",
                "RemoteGroup": "TestGroup2"
            },
            {
                "LocalRole": "ReadOnly",
                "RemoteGroup": "TestGroup3"
            }
        ]
    }
}

Delete Directory Groups

See the example in the right pane for more information.

PATCH /redfish/v1/AccountService/

Sample Payload-1 (To delete one/multiple Directory Groups): Assume you have three existing directory groups, e.g. “TestGroup1”, “TestGroup2” and “TestGroup3”. To delete “TestGroup3”, exclude it from the payload and keep the ones to be retained. “LDAP” can also be used instead of “ActiveDirectory”.

{
    "ActiveDirectory": {
        "RemoteRoleMapping": [
            {
                "LocalRole": "dirgroup4c6c827762dd20dc530c52ef",
                "RemoteGroup": "TestGroup1"
            },
            {
                "LocalRole": "dirgroupeb9a3afc9cd9d126249c3aed",
                "RemoteGroup": "TestGroup2"
            }
        ]
    }
}

Sample Payload-2 (To delete all Directory Groups): “LDAP” can also be used instead of “ActiveDirectory”.

{
    "ActiveDirectory": {
        "RemoteRoleMapping": [
            {}
        ]
    }
}

View Directory Group Privileges

See the example in the right pane for more information.

GET /redfish/v1/AccountService/Roles/

{
    "@odata.context": "/redfish/v1/$metadata#RoleCollection.RoleCollection",
    "@odata.etag": "W/\"08A22FCA\"",
    "@odata.id": "/redfish/v1/AccountService/Roles/",
    "@odata.type": "#RoleCollection.RoleCollection",
    "Description": "iLO Roles Collection",
    "Name": "Roles",
    "Members": [
        {
            "@odata.id": "/redfish/v1/AccountService/Roles/Administrator/"
        },
        {
            "@odata.id": "/redfish/v1/AccountService/Roles/Operator/"
        },
        {
            "@odata.id": "/redfish/v1/AccountService/Roles/ReadOnly/"
        },
        {
            "@odata.id": "/redfish/v1/AccountService/Roles/dirgroup4c6c827762dd20dc530c52ef/"
        },
        {
            "@odata.id": "/redfish/v1/AccountService/Roles/dirgroupeb9a3afc9cd9d126249c3aed/"
        }
    ],
    "Members@odata.count": 5
}

GET /redfish/v1/AccountService/Roles/{directoryGroupId}/

{
    "@odata.context": "/redfish/v1/$metadata#Role.Role",
    "@odata.etag": "W/\"D17157B3\"",
    "@odata.id": "/redfish/v1/AccountService/Roles/dirgroup4c6c827762dd20dc530c52ef/",
    "@odata.type": "#Role.v1_2_1.Role",
    "Id": "dirgroup4c6c827762dd20dc530c52ef",
    "AssignedPrivileges": [
        "Login",
        "ConfigureSelf",
        "ConfigureManager",
        "ConfigureUsers"
    ],
    "Description": "iLO Directory Group Role",
    "IsPredefined": false,
    "Name": "Group Role",
    "Oem": {
        "Hpe": {
            "@odata.context": "/redfish/v1/$metadata#HpeDirectoryGroup.HpeDirectoryGroup",
            "@odata.type": "#HpeDirectoryGroup.v1_0_0.HpeDirectoryGroup",
            "GroupDn": "TestGroup1",
            "GroupSid": ""
        }
    },
    "OemPrivileges": [
        "RemoteConsolePriv",
        "VirtualMediaPriv",
        "VirtualPowerAndResetPriv",
        "HostBIOSConfigPriv",
        "HostNICConfigPriv",
        "HostStorageConfigPriv"
    ],
    "RoleId": "dirgroup4c6c827762dd20dc530c52ef"
}

Modify Directory Group Privileges

See the examples in the right pane for more information.

PATCH /redfish/v1/AccountService/Roles/{directoryGroupId}/

Sample Payload-1 (Update AssignedPrivileges): Add/Remove the privileges in the AssignedPrivileges[] array.

{
    "AssignedPrivileges": [
        "Login",
        "ConfigureSelf",
        "ConfigureUsers"
    ]
}

Sample Payload-2 (Update OemPrivileges): Add/Remove the privileges in the OemPrivileges[] array.

{
    "OemPrivileges": [
        "RemoteConsolePriv",
        "VirtualPowerAndResetPriv",
        "HostNICConfigPriv",
        "HostStorageConfigPriv"
    ]
}

Enable, Configure, Disable Kerberos Authentication

See the examples in the right pane for more information.

PATCH /redfish/v1/AccountService/

Disable

{
    "ActiveDirectory": {
        "ServiceEnabled": false
    }
}

Enable Sample Payload-1 (Using default KDC server port 88):

Where “TESTKDCREALM.COM” is the Kerberos Realm.

{
    "ActiveDirectory": {
        "ServiceEnabled": true,
        "ServiceAddresses": [
            "testkdc.hpe.com@TESTKDCREALM.COM"
        ]
    }
}

Enable Sample Payload-2 (Using explicit/custom KDC server port):

{
    "ActiveDirectory": {
        "ServiceEnabled": true,
        "ServiceAddresses": [
            "testkdc.hpe.com:8888@TESTKDCREALM.COM"
        ]
    }
}

Import Kerberos Keytab File

See the example in the right pane for more information.

POST /redfish/v1/AccountService/Actions/Oem/Hpe/HpeiLOAccountService.ImportKerberosKeytab/

{
    "ImportUri": "http://<URI of keytab file>"
}

Start Directory Test

See the examples in the right pane for more information.

POST on /redfish/v1/AccountService/DirectoryTest/Actions/HpeDirectoryTest.StartTest/

Sample Payload-1 (No parameters):

{
}

Sample Payload-2 (with Test User Name and password):

{
    "TestUserName": "TestUser1",
    "TestUserPassword": "TestPassword1"
}

Sample Payload-3 (with all parameters):

{
    "TestUserName": "TestUser1",
    "TestUserPassword": "TestPassword1",
    "DirectoryAdminDn": "CN=Administrator,CN=Users,DC=ilotest2,DC=com",
    "DirectoryAdminPassword": "AdminPassword"
}

Stop Directory Test

See the example in the right pane for more information.

POST /redfish/v1/AccountService/DirectoryTest/Actions/HpeDirectoryTest.StopTest/

(empty payload)

{
}

View Directory Test Result

See the example in the right pane for more information.

GET /redfish/v1/AccountService/DirectoryTest/

{
    "@odata.context": "/redfish/v1/$metadata#HpeDirectoryTest.HpeDirectoryTest",
    "@odata.etag": "W/\"6B3F28F1\"",
    "@odata.id": "/redfish/v1/AccountService/DirectoryTest/",
    "@odata.type": "#HpeDirectoryTest.v1_0_0.HpeDirectoryTest",
    "Id": "DirectoryTest",
    "Actions": {
        "#HpeDirectoryTest.StartTest": {
            "target": "/redfish/v1/AccountService/DirectoryTest/Actions/HpeDirectoryTest.StartTest/"
        },
        "#HpeDirectoryTest.StopTest": {
            "target": "/redfish/v1/AccountService/DirectoryTest/Actions/HpeDirectoryTest.StopTest/"
        }
    },
    "OverallStatus": "NotRun",
    "TestResults": [
        {
            "Notes": "",
            "Status": "NotRun",
            "TestName": "Directory Server DNS Name"
        },
        {
            "Notes": "",
            "Status": "NotRun",
            "TestName": "Ping Directory Server"
        },
        {
            "Notes": "",
            "Status": "NotRun",
            "TestName": "Connect to Directory Server"
        },
        {
            "Notes": "",
            "Status": "NotRun",
            "TestName": "Connect using SSL"
        },
        {
            "Notes": "",
            "Status": "NotRun",
            "TestName": "Bind to Directory Server"
        },
        {
            "Notes": "",
            "Status": "NotRun",
            "TestName": "Directory Administrator login"
        },
        {
            "Notes": "",
            "Status": "NotRun",
            "TestName": "User Authentication"
        },
        {
            "Notes": "",
            "Status": "NotRun",
            "TestName": "User Authorization"
        },
        {
            "Notes": "",
            "Status": "NotRun",
            "TestName": "Directory User Contexts"
        },
        {
            "Notes": "",
            "Status": "NotRun",
            "TestName": "LOM Object exists"
        }
    ]
}

Implementation of Two Factor Authentication (TFA) in Redfish

Two Factor Authentication is a security feature that enhances security while logging in and creating a user session. TFA uses a One Time Password (OTP) token along with the username and password credentials. When a Microsoft Active Directory user logs in, the user needs to provide the 6 digit token (OTP) received over email.

Two Factor Authentication (TFA) is applicable for Microsoft Active Directory users when enabled.

Pre-requisites for using Two Factor Authentication

Enabling SMTP For Two Factor Authentication

SMTPForTFAEnabled indicates SMTP for Two Factor Authentication (TFA). Perfom GET on /redfish/v1/AccountService. The supported values are Enabled and Disabled.

NOTE: To enable SMTPForTFAEnabled, AlertMailSenderDomain and AlertMailSMTPServer should be set correctly.

GET /redfish/v1/AccountService

{
    "SNMPService": {
        "@odata.id": "/redfish/v1/Managers/1/SnmpService"
    },
    "RemoteSyslogEnabled": false,
    "RemoteSyslogPort": 514,
    "RemoteSyslogServer": "stuv",
    "SMTPForTFAEnabled": false,
    "SNMPTrapPort": 162,
    "SerialOverLanLogging": false,
    "VirtualMediaEncryptionEnabled": true,
    "WebProxyConfiguration": {
        "ProxyPassword": null,
        "ProxyPort": null
    }
}

To enable SMTPForTFAEnabled, perform PATCH on /redfish/v1/Managers/1/NetworkProtocol. The supported values are true and false.

PATCH /redfish/v1/Managers/1/NetworkProtocol

PATCH Payload

{
    "Oem": {
        "Hpe": {
            "SMTPForTFAEnabled": "true"
        }
    }
}

{
    "error":{
        "code": "iLO.0.10ExtendedInfo",
        "message": "See @Message.ExtendedInfo for more information",
        "@Message.ExtendedInfo": {
            "MessageId": "Base.1.4.Success"
        }
    }
}

Enabling Two Factor Authentication

TwoFactorAuth indicates if Two Factor Authentication (TFA) is enabled or not. Perform GET on /redfish/v1/AccountService. The supported values are Enabled and Disabled.

NOTE: Attempting to authenticate using Basic-Auth when TFA is enabled will result in a 401 Unauthorized No Valid Session response if the user account used is a Microsoft Active Directory user.

GET /redfish/v1/AccountService

{
"DirectorTest" : {
    "@odata.id": "/redfish/v1/AccountService/DirectoryTest"
},
"EnforcePasswordComplexity": false,
"KerberosSettings": {
    "KDCServerPort": 88,
    "KerberosRealm": "ILOQA.COM"
},
"MinPasswordLength": 8,
"TwoFactorAuth": "Enabled"
}

To enable or disable TwoFactorAuth, perform PATCH on /redfish/v1/AccountService. The supported values are Enabled and Disabled.

PATCH /redfish/v1/AccountService

PATCH Payload

{
    "Oem": {
        "Hpe": {
            "TwoFactorAuth": "Enabled"
        }
    }
}


{
    "error":{
        "code": "iLO.0.10ExtendedInfo",
        "message": "See @Message.ExtendedInfo for more information",
        "@Message.ExtendedInfo": {
            "MessageId": "Base.1.4.Success"
        }
    }
}

NOTE : Both TwoFactorAuth and SMTPForTFAEnabled should be enabled and true respectively to enable Two Factor Authentication.

Creating a User Session

When Two Factor Authentication is enabled and the Microsoft Active Directory user credentials are entered, a OneTimePasscodeSent response message appears and an One Time Password (OTP) will be sent to the configured Microsoft Active Directory user email id.

To obtain the One Time Password (OTP) perform POST on /redfish/v1/Sessions

POST /redfish/v1/Sessions

POST Payload

{
    "UserName": "jason",
    "Password": "words123"
}


{
    "error":{
        "code": "iLO.0.10ExtendedInfo",
        "message": "See @Message.ExtendedInfo for more information",
        "@Message.ExtendedInfo": [
            {
                "MessageArgs": [
                    "configured mail"
                ],
                "MessageId": "Base.1.17.OneTimePasscodeSent"
            }
        ]
    }
}

This OTP is entered in the POST payload as a Token along with the Microsoft Active Directory user credentials. The Token is 6 digit positive non-zero integer value.

POST /redfish/v1/Sessions

POST Payload

{
    "UserName": "jason",
    "Password": "words123",
    "Token": "123456"
}

{
    "@odata.context": "/redfish/v1/$metadata#Session.Session",
    "@odata.etag": "W/_\"3F61854C",
    "@odata.id": "/redfish/v1/SessionService/Sessions/fewe0000648857f74474c42",
    "@oata.type": "Session.v1_0_0.Session",
    "Id": "jason0000648857f74474c42" 
}

Managing Time in iLO 5

iLO 5 obtains the date and time from one of several sources and is not manually configurable.

The configurable iLO 5 Time/Date related configuration properties are:

iLO 5 Date and Time

iLO 5 current date and time is available in the main Manager resource at /redfish/v1/Managers/{id}

GET /redfish/v1/Managers/{id}

    "DateTime": "2019-01-06T17:11:53Z",
    "DateTimeLocalOffset": "-06:00",

Date/Time Service Resource

A link exists in /redfish/v1/Managers/{id} to the iLO 5 Date/Time Service. See Oem/Hpe/Links/DateTimeService. This points to a DateTime resource at /redfish/v1/Managers/{id}/DateTime.

Time Zone Management

Time Zone configuration is performed with a PATCH to the DateTime resource at /redfish/v1/Managers/{id}/DateTime.

The available time zones are available in the TimeZoneList property. Take note of the Index value of the time zone you wish iLO 5 to be configured with. Then PATCH the TimeZone.Index property:

PATCH /redfish/v1/Managers/{id}/DateTime

{
    "TimeZone": {
        "Index": 4
    }
}

If the operation is successful, iLO 5 will respond with HTTP 200 OK and ResetRequired. An iLO 5 reset is required for date and time operations to be applied. After a successful PATCH the ConfigurationSettings property will contain SomePendingReset indicating that some settings have changed but will not take effect until iLO 5 is reset.

If the time zone is configured to be managed by DHCP, iLO 5 will respond with HTTP 400 and SNTPConfigurationManagedByDHCPAndIsReadOnly (see Using DHCP Supplied Time Settings).

Configuring Network Time Protocol (NTP)

The currently configured Network Time Protocol (NTP) servers are available in the DateTime resource at /redfish/v1/Managers/{id}/DateTime.

GET /redfish/v1/Managers/{id}/DateTime

{
    "NTPServers": [
        "<NTP server 1>",
        "<NTP server 2>"
    ]
}

If NTP is not being managed by DHCP, you may PATCH server addresses into the StaticNTPServers array.

PATCH /redfish/v1/Managers/{id}/DateTime

{
    "StaticNTPServers": [
        "<NTP server 1>",
        "<NTP server 2>"        
    ]
}

or to set one address

{
    "StaticNTPServers": [
        "<NTP server 1>"
    ]
}

If the operation is successful, iLO 5 will respond with HTTP 200 OK and ResetRequired. An iLO 5 reset is required for date and time operations to be applied. After a successful PATCH the ConfigurationSettings property will contain SomePendingReset indicating that some settings have changed but will not take effect until iLO 5 is reset.

If the time zone is configured to be managed by DHCP, iLO 5 will respond with HTTP 400 and SNTPConfigurationManagedByDHCPAndIsReadOnly (see Using DHCP Supplied Time Settings).

Example Use Cases

NOTE: The examples in this section use a pseudo-code syntax for clarity. JSON pointer syntax is used to indicate specific properties.

Reading BIOS Current Settings

To GET the current BIOS configuration:

curl https://{iLO}/redfish/v1/systems/1/bios/settings/ -i --insecure -u username:password -L

# Make sure the DMTF redfish library is not loaded before loading
# the HPE python-ilorest-library:
# pip uninstall redfish
# pip install python-ilorest-library
import sys
import json
from redfish import RedfishClient

# When running remotely, connect using the iLO address, iLO account name,
# and password to send https requests.
SYSTEM_URL = "https://{BMC}"
LOGIN_ACCOUNT = "username"
LOGIN_PASSWORD = "password"
ca_cert_data = {}

# Create a REST object
REDFISHOBJ = RedfishClient(base_url=SYSTEM_URL, username=LOGIN_ACCOUNT,              password=LOGIN_PASSWORD, ca_cert_data=ca_cert_data)

# Login 
REDFISHOBJ.login()

# Get the resource you need.
response = REDFISHOBJ.get("/redfish/v1/systems/1/bios/")
print('Response: '+json.dumps(response.dict, indent=4, sort_keys=True))

Response

{
  "@Redfish.Settings": {
    "@odata.type": "#Settings.v1_0_0.Settings",
    "ETag": "5DFD7F66",
    "Messages": [
      {
        "MessageId": "Base.1.0.Success"
      }
    ],
    "SettingsObject": {
      "@odata.id": "/redfish/v1/systems/1/bios/settings/"
    },
    "Time": "2001-05-07T20:28:28+00:00"
  },
  "@odata.context": "/redfish/v1/$metadata#Bios.Bios",
  "@odata.etag": "W/\"D230AB047BF85050500CD97692925EA4\"",
  "@odata.id": "/redfish/v1/systems/1/bios/",
  "@odata.type": "#Bios.v1_0_0.Bios",
  "Actions": {
    "#Bios.ChangePassword": {
      "target": "/redfish/v1/systems/1/bios/settings/Actions/Bios.ChangePasswords/"
    },
    "#Bios.ResetBios": {
      "target": "/redfish/v1/systems/1/bios/settings/Actions/Bios.ResetBios/"
    }
  },
  "AttributeRegistry": "BiosAttributeRegistryU32.v1_1_20",
  "Attributes": {
    "AcpiHpet": "Enabled",
    "AcpiRootBridgePxm": "Enabled",
    ...
    ...

    "XptPrefetcher": "Enabled",
    "iSCSIPolicy": "SoftwareInitiator"
  },
  "Id": "bios",
  "Name": "BIOS Current Settings",
  "Oem": {
    "Hpe": {
      "@odata.type": "#HpeBiosExt.v2_0_0.HpeBiosExt",
      "Links": {
        "BaseConfigs": {
          "@odata.id": "/redfish/v1/systems/1/bios/baseconfigs/"
        },
        "Boot": {
          "@odata.id": "/redfish/v1/systems/1/bios/boot/"
        },
        "Mappings": {
          "@odata.id": "/redfish/v1/systems/1/bios/mappings/"
        },
        "TlsConfig": {
          "@odata.id": "/redfish/v1/systems/1/bios/tlsconfig/"
        },
        "iScsi": {
          "@odata.id": "/redfish/v1/systems/1/bios/iscsi/"
        }
      },
      "SettingsObject": {
        "UnmodifiedETag": "W/\"7F8B308F162455555532A6400C9EEBC3\""
      }
    }
  }
}

The iLO RESTful API enables UEFI BIOS configuration. The link to the BIOS configuration is from the computer system object.

Changing Pending Settings and understanding “@Redfish.Settings”.

The current configuration object for BIOS is read-only. This object contains a link to a Settings resource that you can perform a PATCH operation on. This is the “pending settings.” If you GET the Settings resource, the returned information shows that you can perform PATCH operations. You can change properties and then perform a PATCH patch operation using the Settings URI. Changes to pending settings do not take effect until the server is reset. Before the server is reset, the current and pending settings are independently available. After the server is reset, the pending settings are applied and you can view any errors in the “@Redfish.Settings” property on the main object.

There are benefits to handling BIOS settings in this way:

Updating the BIOS settings example

curl -H "Content-Type: application/json" -X PATCH --data "@data.json" https://{iLO}/redfish/v1/Systems/1/bios/settings/ -u username:password --insecure

Contents of data.json

{“Attributes”:{“AdminName”: “NewName”}}

For a full Redfish example click here: change_bios_setting.py

The minimum required session ID privileges is Configure.

  1. Iterate through /redfish/v1/Systems and choose a member ComputerSystem. Result = {ilo-ip-address}/redfish/v1/Systems/1/BIOS
  2. Find a link in the Oem/Hp/links called Bios and note the BiosURI.
  3. GET BiosObj from BiosURI and note that it only allows GET (this is the current settings).
  4. Find a link in BiosObj called Settings and note this URI.
  5. Obtain the BIOS settings using the URI from step 4.
    • GET {ilo-ip-address}/redfish/v1/Systems/1/BIOS/Settings
  6. Create a new JSON object with the AdminName property changed to {"Attributes":{"AdminName":"Joe Smith"}}.
  7. Update the BIOS settings. You only need to send the updated AdminName property in the request body.
    • PATCH {ilo-ip-address}/redfish/v1/Systems/1/BIOS/Settings
  8. Obtain the BIOS settings to verify you made the change to the AdminName property.
    • GET {ilo-ip-address}/redfish/v1/Systems/1/BIOS/Settings When the server is reset, the BIOS settings are validated and adopted.

Reading BIOS Defaults example

The BIOS current configuration object contains a link to a separate read-only object, BaseConfigs, which lists the BIOS default settings. To get the BIOS BaseConfigs resource:

curl https://{iLO}/redfish/v1/systems/1/bios/BaseConfigs/ -i --insecure -u username:password -L

import sys
from redfish import AuthMethod, redfish_logger, redfish_client

# When running remotely, connect using the iLO address, iLO account name,
# and password to send https requests.
iLO_host = "https://16.84.27.67"
login_account = "admin"
login_password = "password"

## Create a REDFISH object
REDFISH_OBJ = redfish_client(base_url=iLO_host,username=login_account, \
                          password=login_password, default_prefix="/redfish/v1")

# Login into the server and create a session
REDFISH_OBJ.login(auth="session")

# Do a GET on a given path
response = REDFISH_OBJ.get("/redfish/v1/systems/1/bios/BaseConfigs/", None)

# Print out the response
sys.stdout.write("%s\n" % response)

# Logout of the current session
REDFISH_OBJ.logout()

The results looks something like this:

Response

{
    "@odata.context": "/redfish/v1/$metadata#HpeBaseConfigs.HpeBaseConfigs",
    "@odata.etag": "W/\"1BAB2532EC201D1D1DFED6F112252823\"",
    "@odata.id": "/redfish/v1/systems/1/bios/baseconfigs/",
    "@odata.type": "#HpeBaseConfigs.v2_0_0.HpeBaseConfigs",
    "BaseConfigs": [
        {
            "default": {
                "AcpiHpet": "Enabled",
                "AcpiRootBridgePxm": "Enabled",
                "AcpiSlit": "Enabled",
                 ...
         ...
                "XptPrefetcher": "Auto",
                "iSCSIPolicy": "SoftwareInitiator"
            }
        }
    ],
    "Capabilities": {
        "BaseConfig": true,
        "BaseConfigs": false
    },
    "Id": "baseconfigs",
    "Name": "BIOS Default Settings"
}

Notice that BaseConfigs contains an array of default sets (or base configuration sets). Each base config set contains a list of BIOS properties and their default values. The default base config set contains the BIOS manufacturing defaults. It is possible for BaseConfigs to contain other sets, like default.user for user custom defaults.

BIOS resources and attribute registry overview

The BIOS resources are formatted differently than most other resources. BIOS resources do conform to a schema type as all objects do. However, BIOS settings vary widely across server types and BIOS revisions, so it is extremely difficult to publish a standard schema defining all the possible BIOS setting properties. Furthermore, it is not possible to communicate some of the advanced settings such as inter-setting dependencies, and menu structure in json-schema. Therefore, BIOS uses an Attribute Registry.

Attribute registry

The BIOS Current Configuration resource has a property called AttributeRegistry. This property indicates the name and version of a registry file that defines the properties in the BIOS configuration. It also includes information about interdependencies between settings.

Due to their size, BIOS Attribute Registries are compressed JSON resources (gzip), so the returned HTTP headers indicate a content-encoding of gzip. The REST client will need to decompress the resource. This is done automatically in many web clients (like the Postman plugin).

BIOS attribute registry structure

The BIOS attribute registries contains three top-level arrays:

BIOS attributes

Each BIOS attribute in the attribute registry includes:

Example to reset all BIOS and boot order settings to factory defaults

  1. Iterate through /redfish/v1/Systems/ and choose a member ComputerSystem. Find the BIOS settings resource by following the Bios property link.
    • BiosSettingsURI = {ilo-ip-address}/redfish/v1/Systems/1/BIOS/Settings/
  2. Obtain the BIOS and boot order pending settings.
    • GET @ {ilo-ip-address}/redfish/v1/Systems/1/BIOS/Settings/
  3. Create a new JSON object with the RestoreManufacturingDefaults property and change the value to Yes. Be sure to include the top level JSON Attributes property.
    • JSON = {“Attributes”:{“RestoreManufacturingDefaults”:“Yes”}}
  4. Make a PATCH request with the new JSON to the BiosSettingsUri. You only need to send the updated RestoreManufacturingDefaults property in the request body.
    • PATCH {"Attributes":{"RestoreManufacturingDefaults":"Yes"}} @ {ilo-ip-address}/redfish/v1/Systems/1/BIOS/Settings/

Reverting BIOS UEFI settings to default example

curl -H "Content-Type: application/json" -X POST --data "@data.json" https://{iLO}/redfish/v1/Systems/1/bios/settings/ -u username:password --insecure

Contents of data.json

{“Attributes”:{“BaseConfig”: “default”}}

For a full Redfish example click here: bios_revert_default.py

The BIOS Settings resource supports a special feature that allows you to revert BIOS settings to default for the selected resource. This is accomplished by performing the PATCH or PUT operation on a special property in the BIOS settings object: {“BaseConfig”: “default”}. This can be combined with other property sets to first set default values and then set specific settings all in one operation.

NOTE: The BaseConfig property might not already exist in the BIOS or BIOS Settings resources. To determine if the BIOS resource supports reverting the settings to default, GET the BIOS BaseConfigs resource, and view the Capabilities property.

  1. Iterate through /redfish/v1/Systems/ and choose a member ComputerSystem. Find the BIOS settings resource by following the Bios property link.
    • BiosSettingsURI = {ilo-ip-address}/redfish/v1/Systems/1/BIOS/Settings/
  2. Obtain the BIOS pending settings.
    • GET @ {ilo-ip-address}/redfish/v1/Systems/1/BIOS/Settings/
  3. Create a new JSON object with the BaseConfig property and change the value to default. Be sure to include the top level JSON Attributes property.
    • JSON = {“Attributes”:{“BaseConfig”:“default”}}
  4. Make a PUT request with the new JSON to the BiosSettingsUri. You only need to send the updated BaseConfig property in the request body.
    • PUT {"Attributes":{"BaseConfig":"default"}} @ {ilo-ip-address}/redfish/v1/Systems/1/BIOS/Settings/

When the sever is reset, the BIOS UEFI settings are reverted to default.

NOTE:

Enabling BIOS UEFI Secure Boot example

curl -H "Content-Type: application/json" -X PATCH --data "@data.json" https://{iLO}/redfish/v1/Systems/1/SecureBoot/ -u username:password --insecure

Contents of data.json

{“SecureBootEnable”:true}

For a full Redfish example click here: enable_secure_boot.py

The minimum required session ID privileges is Configure.

  1. Iterate through /redfish/v1/Systems/ and choose a member ComputerSystem. Find a child resource of type HpSecureBoot that allows PATCH operations (there might be more than one, but for this exercise, choose the first one).
    • {ilo-ip-address}/redfish/v1/Systems/1/SecureBoot/
  2. Obtain the secure boot settings.
    • GET {ilo-ip-address}/redfish/v1/Systems/1/SecureBoot/
  3. Create a new JSON object with the SecureBootEnable property changed to {"SecureBootEnable":true}.
  4. Update the secure boot settings. Send the updated SecureBootEnable property in the request body.
    • PATCH {ilo-ip-address}/redfish/v1/Systems/1/SecureBoot/

When the sever is reset, the boot settings are validated and adopted.

Example iSCSI Software Initiator configuration

Existing example resource:

{
    "iSCSISources": [
        {
             "iSCSIAttemptInstance": 1,
             ...
        },
        {
             "iSCSIAttemptInstance": 2,
             ...
        },
        {
             "iSCSIAttemptInstance": 0,
             ...
        },
        {
             "iSCSIAttemptInstance": 0,
             ...
        }
    ],
    ...
}

{
    "iSCSISources": [
        {},
        {
            "iSCSIConnectRetry": 2
        },
        {
            "iSCSIAttemptInstance": 3,
            "iSCSIAttemptName": "Name",
            "iSCSINicSource": "NicBootX"
            ...
        },
        {}
    ]
}

The iSCSI Software Initiator allows you to configure an iSCSI target device to be used as a boot source. The BIOS current configuration object contains a link to a separate resource of type HpeiSCSISoftwareInitiator. The BIOS current configuration resource and the iSCSI Software Initiator current configuration resources are read-only. To change iSCSI settings, you need to follow another link to the Settings resource, which allows PUT and PATCH operations.

The iSCSI target configurations are represented in an iSCSISources property, that is an array of objects, each containing the settings for a single target. The size of the array represents the total number of iSCSI boot sources that can be configured at the same time. Many mutable properties exist, including iSCSIAttemptInstance, which can be set to a unique integer in the range [1, N], where N is the boot sources array size. By default, this instance number is 0 for all objects, indicating that the object should be ignored when configuring iSCSI.

Each object also contains two read-only properties—StructuredBootString and UEFIDevicePath, which are only populated after the target has been successfully configured as a boot source. More information about each property is available in the corresponding schema. The iSCSI initiator name is represented by the iSCSIInitiatorName property.

An additional read-only property, iSCSINicSources, is only shown in the iSCSI current configuration resource. This property is an array of strings representing the possible NIC instances that can be used as targets for iSCSI boot configuration. To confirm which NIC device each string corresponds to, it is recommended to cross-reference two other resources:

Changing the iSCSISources and iSCSIInitiatorName settings can be done through PATCH operations, very similar to how HpeBios settings are changed. However, whereas all BIOS settings are located in a single flat object, iSCSI settings are nested into arrays and sub-objects. When doing a PATCH operation, use empty objects ({}) in place of those boot source objects that you do not want to alter.

The following example covers a situation where you have configured two iSCSI boot sources, and you would like to edit some existing settings, and add a third source.

  1. Iterate through /redfish/v1/Systems and choose a member ComputerSystem. Find a child resource of type HpiSCSISoftwareInitiator that allows PATCH operations.
    • {ilo-address}/redfish/v1/Systems/1/BIOS/iSCSI/Settings/

  2. Inspect the existing iSCSIBootSources array. You need to inspect the iSCSIBootAttemptInstance property of each object to find the boot sources you are prefer to change.

  3. Create a new JSON object with the iSCSIBootSources property.

    • Use an empty object in the position of instance 1 to indicate that it should not be modified. Use an object in the position of instance 2 containing the properties that should be modified—all omitted properties will remain unmodified.
    • To add a new boot source, find any position of instance 0 and replace it with an object containing all the new settings, and most importantly, a new unique value of iSCSIBootAttemptInstance.

  4. Change the iSCSI software initiator settings.

    • PATCH {ilo-address}/redfish/v1/Systems/1/BIOS/iSCSI/Settings/

Changing Boot Settings

UEFI boot structured name string

This UEFI boot structured name string is unique and represents each UEFI boot option in the system. Software can identify and manipulate devices using the string’s fixed format as defined in this specification. Software can assume that the string unique for each boot device in the UEFI BootOrder.

The UEFI boot structured name string is divided into sections separated by ‘.’ characters, using the following format:

....

UEFI boot structured name string examples

Table 1 Examples

Name Description
HD.Emb.4.2 The second instance of a hard drive in embedded SA controller bay 4
NIC.Slot.7.2.IPv4 Port 2 of a NIC in PCIe slot 7, which is enabled for PXE IPv4
NIC.FlexLOM.1.1.IPv6 Port 1 of an embedded NIC FlexLOM, which is enabled for PXE IPv6
PCI.Slot.6.1 PCIe card in slot 6
HD.FrontUSB.2.2 Second partition of a flash drive in front USB port 2

Table 2 Examples of currently supported Structured Boot Strings

Device Type Location Instance Sub instance Qualifier Structure Boot String Examples
Smart Array Hard Drive Embedded Bay number Incremental by LUN HD.Emb.1.1
Slot Slot number Incremental by LUN HD.Slot.1.1
Smart Array Controller Embedded Controller Instance 1 RAID.Emb.1.1
Slot Slot number 1 RAID.Slot.1.1
Dynamic Smart Array Controller (Software RAID) Embedded 1 1 Storage.Emb.1.1
Slot Controller Instance 1 Storage.Slot.1.1
SATA Hard Drive Embedded SATA port # 1 HD.Emb.1.1
SATA Controller Embedded Controller Instance 1 SATA.Emb.1.1
All other storage controllers (FC, SAS, etc…) Embedded 1 1 Storage.Emb.1.1
Slot Slot # 1 Storage.Slot.1.1
Network Adapter LOM NIC number, 1 for 1st NIC, 2 for 2nd NIC Port number IPv4 or IPv6 or iSCSI or FCoE NIC.LOM.1.2.IPv4, NIC.LOM.1.2.IPv6
FlexibleLOM FlexibleLOM number, 1 for 1st FlexLOM, 2 for 2nd FlexLOM Port Number IPv4 or IPv6 or iSCSI or FCoE NIC.FlexLOM.2.1.IPv4, NIC.FlexLOM.2.1.IPv6
Slot Slot Number Port number IPv4 or IPv6 or iSCSI or FCoE NIC.Slot.3.2.Ipv4
Fiber Channel Adapter Slot Slot number Port number IPv4 or IPv6 or iSCSI or FCoE PCI.Slot.3.1
OS Boot entry (such as Embedded HD.Slot.1.2 “Windows Boot Manager”) Slot Embedded Incremental HD.Emb.1.2, HD.Slot.1.2
USB Key Front USB USB Port # Incremental by LUN HD.FrontUSB.1.1
Rear USB USB Port # Incremental by LUN HD.RearUSB.1.1
Internal USB USB Port # HD.InternalUSB.1.1
iLO virtual media HD.Virtual.1.1
ISO image iLO virtual media CD.Virtual.2.1
Virtual Install Disk (VID) Embedded store USB Port # HD.VirtualUSB.1.1
Embedded User Partition Embedded store USB Port # HD.VirtualUSB.2.1
USB CD/DVD Front USB USB Port # CD.FrontUSB.1.1
Rear USB USB Port # CD.RearUSB.1.1
Internal USB USB Port # xxxxxxxx
SD card SD slot USB Port # HD.SD.1.1
Floppy Front USB, Rear USB USB Port # FD.FrontUSB.1.1, FD.RearUSB.1.1
Embedded UEFI Shell Embedded 1 1 Shell.Emb.1.1
UEFI applications (embedded in the ROM firmware) (Diag, System Utility, etc..) Embedded 1 Incremental App.Emb.1.1, App.Emb.1.2, App.Emb.1.3
File URL Different URL Increased by 1 1 File.URL.1.1
HPE RAM Disk Device RAM Memory 1 Port Number RAMDisk.Emb.1.1
Special USB device class with Device Path: UsbClass(0xFFFF, 0xFFFF, 0xFF, 0xFF, 0xFF) Any USB device in the system 1 Generic.USB.1.1
Empty slot, no device Slot Slot number 1 PCI.Slot.2.1
Unknown device Embedded Slot Unknown location Slot number or 1 Incremental Unknown.Slot.1.1, Unknown.Unknown.1.1
NVMe Slot Slot number NVMe drive number (The number is based on bus enumeration sequence). NVMe.Slot.1.1
NVMe Embedded Bay number 1 (Each drive bay has 1 NVMe drive.) NVMe.Emb.1.1

Change UEFI boot order example

For more information click on the python tab.

For a full Redfish example click here: change_boot_order.py

The BIOS current configuration object contains a link to a separate read-only resource of type HpeServerBootSettings that lists the UEFI Boot Order current configuration. This is the system boot order when the system is configured in the UEFI Boot Mode. The UEFI Boot Order current configuration resource contains a BootSources property, which is an array of UEFI boot sources. Each object in that array has a unique StructuredBootString, among other properties that identify that boot source.

The UEFI boot order list itself is represented in a separate PersistentBootConfigOrder property that is an ordered array of boot sources, each referenced by its StructuredBootString. In addition, a DesiredBootDevices property lists a separate ordered list of desired boot sources that might not be listed in the BootSources property. This is useful for configuring boot from a specific SCSI or FC LUN or iSCSI target that might have not been configured (and discovered by BIOS) yet.

As with the BIOS current configuration resource, the UEFI Boot Order current configuration resource is read only (as evident by the allow header, which do not list PATCH as an allowed operation). To change the UEFI Boot Order, you need to follow the link to a separate Settings resource that you can perform a PATCH operation on that contains the pending UEFI Boot Order settings, and update that PersistentBootConfigOrder and/or the DesiredBootDevices properties in that Settings resource. The settings remain pending until next reboot, and the results are reflected back in the @Redfish.Settings property in the UEFI Boot Order current configuration resource.

Prerequisites: Minimum required session ID privileges: Configure

  1. Iterate through /redfish/v1/Systems/ and choose a member ComputerSystem. Find a child resource of type HpeServerBootSettings that allows PATCH operations (there might be more than one, but for this exercise, hoose the first one).
    • {ilo-ip-address}/redfish/v1/Systems/1/BIOS/Boot/Settings/
  2. Obtain the UEFI boot order.
    • GET {ilo-ip-address}/redfish/v1/Systems/1/BIOS/Boot/Settings/
  3. Create a new JSON object with the PersistentBootConfigOrder property and change the boot order.
  4. Change the UEFI boot order. You only need to send the updated PersistentBootConfigOrder property in the request body.
    • PATCH {ilo-ip-address}/redfish/v1/Systems/1/BIOS/Boot/Settings/

When the sever is reset, the new boot order is validated and used.

Reset a Server

Server power control is a system-node-level entity, not a chassis-level control. For example, you can turn on one node in a multi-node chassis. You control power by performing an HTTP operation on a computer system node object.

Some operations in the interface are not truly RESTful GET, PUT, POST, DELETE, or PATCH. They are called custom actions and are performed with an HTTP POST containing a specific request payload. Typically, actions are defined when the action you want to perform is not adequately represented by the properties available in the type. For example, a power button is not readable, so you cannot GET the status of the power button. In this case, pressing the power button is an action.

Actions are POST operations with an Action property that names the action to perform and zero or more parameter properties.

Reset a server example

curl --header "Content-Type: application/json" --request POST --data '{"ResetType": "ForceRestart"}' https://{iLO}/redfish/v1/Systems/1/Actions/ComputerSystem.Reset -u username:password --insecure

Prerequisites

Minimum required session ID privileges: Configure

  1. Iterate through /redfish/v1/Systems collection and choose a member ComputerSystem that allows POST operations.
    • {ilo-ip-address}/redfish/v1/Systems/1
  2. Get the “Actions” -> “#ComputerSystem.Reset” -> “target” Uri.
  3. Construct an Action object to submit to iLO.
    • {"ResetType":"ForceRestart"}
  4. Reset the server by posting the body to the target Uri.
    • POST {ilo-ip-address}/redfish/v1/Systems/1/Actions/ComputerSystem.Reset/

The server resets and reboots.

Download Active Health System Data

For more information click on the python tab.

For a full Redfish example click here: get_ahs_data.py

Active Health System (AHS) data may be accessed by first discovering the resource of type HpiLOActiveHealthSystem. This is typically at https://{iLO}/redfish/v1/managers/{item}/activehealthsystem/. Refer to the section on Iterating Collections for details on how to navigate the data model.

  1. Iterate the Managers collection at https://{iLO}/redfish/v1/managers/. For traditional iLO-based server architectures there is a single manager representing iLO 5 itself.

  2. Find the Link property referring to the HpiLOActiveHealthSystem and follow that link.

  3. GET the HpiLOActiveHealthSystem resource and look for the URI indicated by Links.AHSLocation.extref.

  4. Perform a GET to this URI with the following query parameters to define the download time range and embed customer case information:

If successful, the response is an HTTP 200 level status code and a binary download which can be saved to a file.

Finding the iLO mac address

For more information click on the python tab.

For a full Redfish example click here: find_ilo_mac_address.py

Before you search for the iLO mac address, you must create an instance of a RestObject or RedfishObject. The class constructor takes the iLO hostname/IP address, iLO login username, and password as arguments. The class also initializes a login session, gets systems resources, and message registries.

Adding an iLO user account

For more information click on the python tab.

For a full Redfish example click here: add_user_account.py

Before you add an iLO user account, you must create an instance of a RestObject or RedfishObject. The class constructor takes the iLO hostname/IP address, iLO login username, and password as arguments. The class also initializes a login session, gets systems resources, and message registries.

Setting a license key

curl -H "Content-Type: application/json" -X POST --data "@data.json" https://{iLO}/redfish/v1/Managers/1/LicenseService/ -u username:password --insecure

Contents of data.json

{“LicenseKey”: “xxxxx-xxxxx-xxxxx-xxxxx-xxxxx”}

For a full Redfish example click here: set_license_key.py

Before you set a license key, you must create an instance of a RestObject or RedfishObject. The class constructor takes the iLO hostname/IP address, iLO login username, and password as arguments. The class also initializes a login session, gets systems resources, and message registries.

Changing an iLO user account

For more information click on the python tab.

For full Redfish examples click here: modify_user_account.py, remove_account.py

Before you change an iLO user account, you must create an instance of a RestObject or RedfishObject. The class constructor takes the iLO hostname/IP address, iLO login username, and password as arguments. The class also initializes a login session, gets systems resources, and message registries.

iLO 5 Software/Firmware Update Service

The Redfish standard schema package DSP8010 version 2016.2 introduced the “UpdateService” schema, enabling firmware and software inventory, and simple firmware updates. The iLO 5 Update Service is conformant with the “UpdateService” schema, but significantly expands the capabilities to include a component repository, an update queue, and install sets.

Concepts and Terms

Term Definition
Inventory The installed or running versions of software or firmware.
Target The object of a firmware or software update (e.g. BIOS, iLO, Network Adapter, software package).
Update The process of applying updated firmware or software to applicable targets.
Update Agent The software or firmware agent that applies an update to one or more targets. Update Agents include Smart Update Manager (SUM), UEFI BIOS, and iLO 5. Different types of updates might be supported by specific update agents.
Activate The process of making updated firmware of software active (for example, a BIOS update is activated when the server reboots).
Component A package containing one or more software or firmware update images (also known as a “Smart Component”). Components are typically delivered with the Support Pack for ProLiant (SPP) in EXE, RPM, or ZIP files.
Component Signature File (.compsig) A file containing information about a component, including a digital signature. This enables iLO to verify the integrity and authenticity of a variety of component formats. The .compsig files are also available with the SPP and must be uploaded with the component. SUM automatically uploads the right .compsig file with components.
iLO Repository A persistent storage location on the server that can hold software or firmware update components.
Update Task Queue An iLO managed queue of update operations. iLO might not be the actual update agent. Other update agents include Smart Update Manager (SUM) and the UEFI BIOS.
Install Set A pre-defined sequence of update tasks managed using the iLO REST API that can be added to the Update Task Queue with an “Invoke” action.
Maintenance Window A defined time window that may be used with an Update Task create or Install Set Invoke commands to associate a time with the operation.

Redfish Update Service Operations

The Update Service is available as a link (UpdateService) from the Redfish root resource (/redfish/v1/). The Update Service complies with the Redfish UpdateService schema.

Firmware and Software Inventory

The firmware and software inventory is maintained in two separate collections (FirmwareInventory and SoftwareInventory). These collections support the iLO 5 $expand operation, allowing a client to fetch the entire collection with one GET operation.

Each member item conforms to the Redfish SoftwareInventory schema.

Item (generic) at /redfish/v1/UpdateService/FirmwareInventory/{item}

HTTP Allow: GET

Adapting from iLO 4 HpSwFwInventory to iLO 5 Redfish Inventory

The following attributes of items in the iLO 4 inventory have been replaced in the iLO 5 Redfish conformant inventory:

SimpleUpdate Action

The SimpleUpdate action with the "ImageURI" parameter causes iLO to fetch an image from a web server and flash it directly. Only certain types of images may be supplied, including iLO firmware binaries and UEFI firmware binaries. Smart Components are not supported. The list of supported binaries is the same as those that can be updated through iLO’s Web user interface.

Smart Components may be uploaded to the iLO Repository and a task created to cause UEFI or SUM to perform the update.

POST /redfish/v1/UpdateService/Actions/UpdateService.SimpleUpdate/

{
    "ImageURI": "<uri to binary image for iLO to flash>"
}

HttpPushUri

The HttpPushUri property indicates the URI to POST a firmware component that iLO can flash. Only certain types of images may be supplied including iLO firmware binaries and UEFI firmware binaries. Smart Components are not supported. The list of supported binaries is the same as those that can be updated through iLO’s Web user interface.

The POST must be of Content-Type: “multipart/form-data”

-----------------------------64062213329524
Content-Disposition: form-data; name="sessionKey"

<value of X-Auth-Token here>

-----------------------------64062213329524
Content-Disposition: form-data; name="<component-filename>"; filename="<component-filename>"
Content-Type: application/octet-stream

<binary image>

iLO validates the uploaded binary image and flashes any applicable targets immediately. If the update is for iLO itself, iLO automatically resets at the end of the flash process and activates the new firmware upon restart.

Software and Firmware Management Flow

Evaluating Current Software and Firmware Inventory to iLO Repository Components

This is the general pseudocode to correlate applicable updates in the iLO Repository to updatable items from the inventory.

  1. Use the FirmwareInventory and SoftwareInventory data to evaluate the current software and firmware running on the server.
for component in /redfish/v1/updateservice/componentrepository:
    for inventory_item in /redfish/v1/updateservice/firmwareinventory:

        # if "DeviceClass" is populated in the inventory item
        if DeviceClass in inventory_item:
            # if present and not matching, move along
            if component.DeviceClass != inventory_item.DeviceClass:
                continue

        # if we made this this far, either inventory item doesn't have DeviceClass or they match
        for target in component.Targets:
            if target in item.Oem.Hpe.Targets:
                return inventory_item, component  # return correlated
  1. Upload new components to the iLO Repository
  2. Optionally create or modify Install Sets to bundle multiple components in the iLO Repository into an ordered list of update operations.
  3. Optionally create Maintenance Windows to specify pre-determined time ranges for udpate tasks to be executed.
  4. Create tasks individually or Invoke an Install Set to populate the task list. Use either a time range for each task or specify a Maintenance Window to automatically associate the timed window with the created tasks.
  5. Monitor update operations and handle any errors
  6. Optionally remove any completed Tasks, Maintenance Windows, Install Sets, or components that are no longer required.

Software and Firmware Management Operations

iLO Repository

The iLO Repository is a persistent storage location for update components including Smart Component files (.EXE, .RPM, etc.), as well as raw binary files (.BIN). Additions to the repository require a digital signature for iLO to verify the integrity and authenticity of the component. For raw .BIN files, this information is contained within the file. For Smart Components, the information is in a separate Component Signature file (.compsig) that must be supplied when adding a component.

The Repository is available in the REST API as a child of the Update Service.

  1. GET root (/redfish/v1/).
  2. GET the destination of the UpdateService link.
  3. GET the destination of the Oem/Hpe/ComponentRepository link.

Additions to the repository are made via the UpdateService actions. Removals are made by DELETE on repository collection members.

Upload Components

See details on the HttpPushUri in the Update Service resource first. The upload process can alternatively be used to add components to the iLO Repository. As with update, the POST must be a multipart/form-data.

The following HTTP headers must be supplied:

    # build the HTTP headers
    # 'Content-Type': 'multipart/form-data',
    headers = {'Accept': 'application/json',
               'Expect':'',
               'OData-Version': '4.0',
               'X-Auth-Token': sessionkey,
               'Cookie': 'sessionKey=' + sessionkey}

The HTTP POST body:

-----------------------------64062213329524
Content-Disposition: form-data; name="sessionKey"

<value of X-Auth-Token here>

-----------------------------64062213329524
Content-Disposition: form-data; name="parameters"
Content-Type: application/json

{
  "UploadCurrentEtag": "<client-defined-string>",
}

-----------------------------64062213329524
Content-Disposition: form-data; name="compsig"; filename="compsig-filename"
Content-Type: application/octet-stream

<binary content of component signature file>

-----------------------------64062213329524
Content-Disposition: form-data; name="file"; filename="component-filename"
Content-Type: application/octet-stream

<binary content of component file>

The new ‘compsig’ part enables the client to push the component signature file with the payload.

The ‘parameters’ part enables clients to add parameters to the upload like execution parameters.

‘parameters’ part in multi-part POST

The following parameters may be specified in a JSON object as part of the upload. All parameters are optional and the ‘Parameters’ multi-part may be optional.

Parameter Name JSON type Description
UpdateRepository boolean If true, adds the component to the repository. This is ignored and assumed true for components flashable by UEFI or SUT/SUM.
UploadCurrentEtag string client-selected-etag-string-reported back in ‘UploadCurrentEtag’
UpdateTarget boolean If true, iLO immediately flashes the binary. This is ignored and assumed false for components flashable by UEFI or SUT/SUM.
Section integer Section number for huge uploads (see below) starting at 0.

NOTE: The two free-form parameters, ‘ExecutionParameters’ and ‘Configuration’ (used by SUM to communicate to the components) are not supplied here, but can be PATCHed later once the components are in the Repository.

iLO self-flash Example:

{
    "UploadCurrentEtag": "<client-defined-string>",
    "UpdateRepository": true,
    "UpdateTarget": true
}

Smart Component Example:

{
    "UploadCurrentEtag": "<client-defined-string>"
}

Waiting for Uploads to Complete

After uploading the component, iLO must verify and write the contents to the repository. The client may track this progress by polling on Oem/Hpe/State property in the UpdateService. Values are:

State Detail
Uploading iLO is processing the upload - Clients likely won’t see this State because this state occurs during the upload POST.
Verifying iLO is verifying the integrity and authenticity of the upload.
Writing iLO is writing the upload to the repository.
Updating iLO is updating one or more targets applicable to the upload.
Complete The operation is complete without errors.
Error The operation encountered errors.

The client should wait for Complete before progressing.

Inventory Components in iLO Repository

The iLO Repository is a collection that supports the $expand operation. Perform a GET operation on the collection and its members to inventory the repository.

Available data for each member includes:

Property PATCHable? Detail
Name No Component Name
Filename No Unique file name
Version No Version as a string
SizeBytes No Size in Bytes
Criticality Yes Recommended, optional, critical.
Created No Time the component was added to the repository.
Locked No True if the component is referenced by a task or install set.
ComponentUri No URI of the component binary.
Activates No A hint of when a component activates (for example, after reboot).
Configuration Yes For Smart Update Manager use only.
ExecutionParameters Yes The command line passed to the component when launched.

Remove Components

Perform a DELETE operation on the repository collection member to remove it from the repository.

Free Space

The free and total space of the iLO Repository in bytes is available as part of the Repository Collection.

{
    "@odata.context": "/redfish/v1/$metadata#ComponentRepository",
    "@odata.etag": "W/\"FF1B13FE\"",
    "@odata.id": "/redfish/v1/UpdateService/ComponentRepository/",
    "@odata.type": "#HpeComponentCollection.HpeComponentCollection",
    "Description": "Component Collection",
    "Members@odata.count": 0,
    "Name": "Component Collection",
    "Oem": {
        "Hpe": {
            "@odata.type": "#HpeComponentRepositoryInformation.v2_0_0.HpeComponentRepositoryInformation",
            "ComponentCount": 0,
            "FreeSizeBytes": 1073102848,
            "TotalSizeBytes": 1073168384
        }
    }
}

Correlating Components with Current Software and Firmware Version Inventory

There is not a one-to-one correspondence between installed firmware or software and update components. For example, a component might carry firmware for several network controllers.

This algorithm shows how to correlate current version inventory with available components:

for component in componentrepository:
    for inventory_item in inventory:

        # if "DeviceClass" is populated in the inventory item
        if DeviceClass in inventory_item:
            # if present and not matching, move along
            if component.DeviceClass != inventory_item.DeviceClass:
                continue

        # if we made this this far, either inventory item doesn't have DeviceClass or they match
        for target in component.Targets:
            if target in item.Oem.Hpe.Targets:
                return inventory_item, component  # return correlated

Tasks

Update Agents and Strong Queue Order

Different updates must be performed in different ways:

The UpdateableBy property indicates which “update agent” may perform the update.

For an update to be applied to a running operating system, SUM or SUT must run on the OS. SUM/SUT checks for pending tasks that include RuntimeAgent in the UpdateableBy property.

For an update to be applied during UEFI POST, UEFI checks for pending tasks that include Uefi in the UpdateableBy property.

For an update to be applied any time by iLO, iLO checks for pending tasks that include Bmc in the UpdateableBy property. Note that items that are updateable by iLO are never marked as updatable by any other agent.

Because of the strong ordering of the task queue, updaters do not bypass another pending item or exception item to find something to update. This can result in task queue stalls. For example, if the top of the queue is marked as Uefi update, and the second item is marked RuntimeAgent, SUM/SUT won’t process their item until the system has rebooted, and UEFI has processed its top item.

Updaters process the queue in order, looking at the task state:

Task State Updater Behavior
Pending Mark as InProgress and begin task.
InProgress Do nothing and stop processing the queue - a task item is in progress by another updater (assuming this task is not yours).
Expired Do nothing and stop processing the queue - the task item has expired, and because of strong queue ordering, all following tasks are not processed.
Exception Do nothing and stop processing the queue - the task item has failed, and because of strong queue ordering, all following tasks are not processed.
Complete Iterate to next task and examine its State.
Canceled Iterate to next task and examine its State.

Creating Update Tasks

Create a new Task resource to schedule Update tasks. POST a new task object to the tasks collection pointed to by UpdateService Oem/Hpe/UpdateTaskQueue:

Example that enables an component to be updated by either SUM or UEFI:

{
    "Name": "Unique Client supplied friendly name of this task item.",
    "UpdatableBy": [
        "Uefi",
        "RuntimeAgent"
    ],
    "Command": "ApplyUpdate",
    "Component": "<component-name>",
    "TPMOverride": true
}

Example that enables an binary component to be updated by iLO:

{
    "Name": "Unique Client supplied friendly name of this task item.",
    "UpdatableBy": [
        "Bmc"
    ],
    "Command": "ApplyUpdate",
    "Component": "<component-name>"
}

This creates a new task in the Pending state at the end of the queue. If it assigned to the Bmc and is at the top of the queue, iLO starts operating on it immediately. Otherwise, the new task is operated on as soon as an updater runs and finds the new task.

Creating Scheduled Tasks

Starting with iLO 5 1.30 a client may specify a time window for a task. Time is always relative to iLO’s clock. Two options exist for creating scheduled tasks: explicit time ranges or Maintenance Windows.

Explicit Time Range: Include StartAfter and Expire in Task Create POST

StartAfter and Expire are two times that can be included in the task create POST operation. You may specify either or both. Each must be formatted as an ISO 8601 time string.

Tasks in the Pending state will not begin execution until iLO time is after StartAfter. If for some reason an update does not start and remains in a Pending state until after the Expire time, it will never be executed and the State will be Expired. This can happen for instance if a task is to be executed by UEFI and no reboot happens during the time window.

Maintenance Window

See the section on Maintenance Windows later for more details on the use of Maintenance Windows.

If a client creates a Maintenance Window, this window may be specified (by Id) in the creation of a task.

Example that uses a Maintenance Window

{
    "Name": "Unique Client supplied friendly name of this task item.",
    "UpdatableBy": [
        "Bmc"
    ],
    "Command": "ApplyUpdate",
    "Component": "<component-name>",
    "MaintenanceWindow": "<maintenance-window-id>"
}

Creating Wait Tasks

Wait tasks can be used to insert time between two other tasks. The UpdatableBy property should contain only one update agent chosen based upon the updater that needs the time.

Example that causes UEFI to Wait for 30 seconds:

{
    "Name": "Pause 30 seconds",
    "UpdatableBy": [
        "Uefi"
    ],
    "Command": "Wait",
    "WaitTimeSeconds": 30
}

WaitTimeSeconds can be in the range 0-3600 seconds.s

Retiring and Removing Tasks

The REST client that creates an update task is expected to DELETE the task upon completion after the final status/log information is obtained.

Tasks are removed by performing a DELETE operation on the task collection member. The entire queue can be cleared by deleting all tasks. InProgress tasks should not be deleted even though the REST API will allow it. This might be useful if the task list is stalled and needs to be cleared.

iLO automatically removes completed tasks (State is Complete) after 24 hours, but tasks in any other state are not removed.

Handling Exceptions

If a task cannot complete it will report a State value of Exception. Tasks in this state do not automatically clear and require attention to clear. You may remove the task and re-add it later if there is a condition corrected that improves its chances of executing to completion.

Stalls in the Task Queue

Tasks can be added to the task queue that cannot execute to completion. In this case, the task queue might stall waiting for attention or the appropriate updater to execute. Examples may include the following:

Maintenance Windows

(New for iLO 5 1.30)

Tasks can be created and Install Sets invoked with either an explicit time range (specifying StartAfter and Expire times) or by referring by Id to a Maintenance Window.

The Maintenance Window collection is pointed to by UpdateService Oem/Hpe/MaintenanceWindows:

A special feature of Maintenance Windows is that any task associated with a Maintenance Window may be rescheduled by PATCHing the Maintenance Window instead of modifying multiple tasks.

Creating Maintenance Windows

POST a new object to the Maintenance Window collection:

{
    "Name": "unique name of the Maintenance Window.",
    "StartAfter": "ISO 8601 Redfish-style time string of earliest execution - null for no start time specified",
    "Expire": "ISO 8601 Redfish-style time string after which we will automatically change state to Expired - null for no expire time"
}

Any of these properties may be PATCHed to modify an existing Maintenance Window.

Referring to Maintenance Windows

Each Maintenance Window has an Id string property. Use this value with the MaintenanceWindow property when creating a task or invoking an install set.

Removing Maintenance Windows

Maintenance Windows are removed by performing a DELETE operation on the Maintenance Window member.

Maintenance Windows will eventually be outdated with times in the past and should be removed.

Install Sets

Create a new install set resource to create Install Sets. POST a new install set object to the install set collection pointed to by UpdateService Oem/Hpe/InstallSets:

Creating Install Sets

POST a new install set object to the install set collection:

{
    "Name": "unique name of the install set.",
    "IsRecovery": false,
    "Sequence": [
        {
            "Name": "Client supplied friendly name of this task item.",
            "UpdatableBy": [
                "Uefi",
                "RuntimeAgent"
            ],
            "Command": "ApplyUpdate",
            "Filename": "Name of the file as it appears in the repository."
        }
    ]
}

Invoking Install Sets

Install Sets are invoked by performing the Invoke action on the install set member item. The Invoke action has no parameters.

Invoking an install set causes iLO to append the task queue with new tasks, each corresponding to the items in the Sequence array.

POST /redfish/v1/updateservice/installsets/{id}/Actions/HpeComponentInstallSet.Invoke
Content-Type: application/json

{
    "ClearTaskQueue": true,
}

Scheduled Install Sets

Starting with iLO 5 1.30 a client may specify a time window for an Install Set. Time is always relative to iLO’s clock. Two options exist for creating scheduled tasks: explicit time ranges or Maintenance Windows.

Explicit Time Range: Include StartAfter and Expire in Invoke

StartAfter and Expire are two times that can be included in Invoke Action. You may specify either or both. Each must be formatted as an ISO 8601 time string.

Each task in the Install Set will be created with this explicit time range. Tasks in the Pending state will not begin execution until iLO time is after StartAfter. If for some reason an update does not start and remains in a Pending state until after the Expire time, it will never be executed and the State will be Expired. This can happen for instance if a task is to be executed by UEFI and no reboot happens during the time window.

POST /redfish/v1/updateservice/installsets/{id}/Actions/HpeComponentInstallSet.Invoke
Content-Type: application/json

{
    "ClearTaskQueue": true,
    "StartAfter": "ISO 8601 Redfish-style time string of earliest execution - null for no start time specified",
    "Expire": "ISO 8601 Redfish-style time string after which we will automatically change state to Expired - null for no expire time"
}
Install sets and Maintenance Windows

If a client creates a Maintenance Window, this window may be specified (by Id) in the Install Set Invoke.

POST /redfish/v1/updateservice/installsets/{id}/Actions/HpeComponentInstallSet.Invoke
Content-Type: application/json

{
    "ClearTaskQueue": true,
    "MaintenanceWindow": "<maintenance-windows-Id>"
}

Removing Install Sets

Install Sets are removed by performing a DELETE operation on the install set member.

Using Install Sets for Rollback and Baseline Management

iLO does not maintain a specific “rollback” architecture. Instead, a client might maintain alternate versions of the same deliverable in the iLO Repository, and maintain multiple (up to 8) install sets in the InstallSets collection.

Firmware Recovery Install Set

SystemRecoveryConfigPriv

One of the install sets on the system might be marked with a property "IsRecovery": true. If true, the install set is reserved to hold only critical firmware recovery components.

‘Administrate Recovery Set’ iLO user privilege is required to modify or remove this install set.“. This is called SystemRecoveryConfigPriv in the REST API’s Account privileges. This privilege enables users to alter or remove this recovery install set.

The recovery install set should only be modified with care and hold a minimal set of firmware updates needed to make the server bootable. These firmware image file must be directly flashable by iLO. The order is important because the install set is the order of update.

Firmware Verification

Firmware Verification, available with the iLO Advanced Premium Security Edition, enables you to run an on-demand verification scan or implement scheduled scans.

To respond to detected issues, choose between logging the results, or logging the results and initiating a repair action that uses a recovery install set.

Depending on the scan results, information is logged in the Active Health System Log and the Integrated Management Log.

The following firmware items are verified:

When a firmware verification scan is in progress, you cannot install firmware updates or upload firmware to the iLO Repository.

Configuring Firmware Verification

Available with iLO Advanced Premium Security Edition

Firmware Verification scan options:

If a problem is detected for a supported firmware item, iLO checks for the affected firmware type in a protected install set. By default, this set is the System recovery set. If a firmware image is available, iLO flashes that firmware image to complete the repair.

GET /redfish/v1/UpdateService/

{
    "Oem": {
        "Hpe": {
            "FirmwareIntegrity": {
                "EnableBackgroundScan": true,
                "LastScanResult": "OK",
                "LastScanTime": "2017-05-31T19:14:54Z",
                "OnIntegrityFailure": "LogAndRepairAutomatically",
                "ScanEveryDays": 14
            }
        }
    }
}

Initiating a Firmware Verification Scan

Available with iLO Advanced Premium Security Edition

You may manually start a firmware verification scan by invoking the action "StartFirmwareIntegrityCheck”. You must have the iLO Advanced Premium Security Edition license to use this feature.

POST /redfish/v1/UpdateService/Actions/Oem/Hpe/HpeiLOUpdateServiceExt.StartFirmwareIntegrityCheck

BIOS Defaults and Passwords

Actions are POST operations to perform a specific request, such as a system reset or a password change. Actions are completely different from actions in iLO 4. The Bios resource has 2 actions:

Reset BIOS Settings

UEFI BIOS Supports a new POST action to reset settings.

"Actions": {
  "#Bios.ResetBios": {
    "target": "/redfish/v1/Systems/1/Bios/Settings/Actions/Bios.ResetBios"
  }
}

The body of the POST should contain

{
  "ResetType" : "default"      
}

or

{  
  "ResetType" : "default.user"
} 

Change BIOS password

UEFI BIOS supports a new POST action to change the BIOS password.

"Actions": {
  "#Bios.ChangePassword": {
    "target": "/redfish/v1/Systems/1/Bios/Settings/Actions/Bios.ChangePassword"
  }
}

The body of the action should contain:

{
  "PasswordName": "Administrator | User",
  "OldPassword" : "OldPasswordText",
  "NewPassword" : "NewPasswordText"
}

The target link is where the body of the action should be posted.

iSCSI Software Initiator Configuration

Introduction

The iSCSI Software Initiator allows you to configure an iSCSI target device to be used as a boot source. The BIOS current configuration object contains a link to a separate resource of type HpeiSCSISoftwareInitiator. The BIOS current configuration resource and the iSCSI Software Initiator current configuration resources are read-only. To change iSCSI settings, you need to follow another link to the Settings resource, which allows PUT and PATCH operations.

The iSCSI target configurations are represented in an iSCSISources property, that is an array of objects, each containing the settings for a single target. The size of the array represents the total number of iSCSI boot sources that can be configured at the same time. Many mutable properties exist, including iSCSIAttemptInstance, which can be set to a unique integer in the range [1, N], where N is the boot sources array size. By default, this instance number is 0 for all objects, indicating that the object should be ignored when configuring iSCSI.

Each object also contains two read-only properties—StructuredBootString and UEFIDevicePath, which are only populated after the target has been successfully configured as a boot source. More information about each property is available in the corresponding schema. The iSCSI initiator name is represented by the iSCSIInitiatorName property.

An additional read-only property, iSCSINicSources, is only shown in the iSCSI current configuration resource. This property is an array of strings representing the possible NIC instances that can be used as targets for iSCSI boot configuration. To confirm which NIC device each string corresponds to, it is recommended to cross-reference two other resources.

Changing the iSCSISources and iSCSIInitiatorName settings can be done through PATCH operations, very similar to how HpeBios settings are changed. However, whereas all BIOS settings are located in a single flat object, iSCSI settings are nested into arrays and sub-objects. When doing a PATCH operation, use empty objects ({}) in place of those boot source objects that you do not want to alter.

The following example covers a situation where you have configured two iSCSI boot sources, and you would like to edit some existing settings, and add a third source.

  1. Iterate through /redfish/v1/Systems and choose a member ComputerSystem. Find a child resource of type HpeiSCSISoftwareInitiator that allows PATCH operations.
    • {ilo-address}/redfish/v1/Systems/1/BIOS/iSCSI/Settings

  2. Inspect the existing iSCSISources array. You need to inspect the iSCSIAttemptInstance property of each object to find the boot sources you are prefer to change.

  3. Create a new JSON object with the iSCSISources property.

    • Use an empty object in the position of instance 1 to indicate that it should not be modified. Use an object in the position of instance 2 containing the properties that should be modified—all omitted properties remain unmodified.
    • To add a new boot source, find any position of instance 0 and replace it with an object containing all the new settings, and most importantly, a new unique value of iSCSIAttemptInstance.

  4. Change the iSCSI software initiator settings.

    • PATCH {ilo-address}/redfish/v1/Systems/1/BIOS/iSCSI/Settings

HTTPS Boot TLS Configuration

TLS Certificates Resource has three resources within the RESTful API tree: - Current Settings Resource (read-only) : redfish/v1/systems/1/bios/tlsconfig/ - Contains current TLS certificates resource configuration data present in the system - Pending Settings Resource (read/write) : redfish/v1/systems/1/bios/tlsconfig/settings/ - Writable resource used to configure TLS certificates settings - Modifiable properties: - "Ciphers" - Set the desired supported ciphers - "HostnameCheck" - Enable/Disable host name checking - "ProtocolVersion" - Set the desired protocol version - "VerifyMode" - Set the verification method (PEER/NONE) - "NewCertificates" - An array of the certificates to be installed - "DeleteCertificates" - An array of the fingerprints of the certificates to be deleted - Read Only properties that gets modified internally: - "Certificates" - An array of all the installed certificates - "TlsCaCertificateCount" - The number of the installed certificates

Installing Certificates

The certificates are X509 keys. In PEM format, the certificates are encoded in a series of strings with new line characters between them:

This an example of a certificate in a PEM format:

—–BEGIN CERTIFICATE—– MIIEHTCCAwWgAwIBAgIQe8LmWgF5edKw01/avJg69DANBgkqhkiG9w0BAQsFADCB kTELMAkGA1UEBhMCVVMxKzApBgNVBAoTIkhld2xldHQgUGFja2FyZCBFbnRlcnBy aXNlIENvbXBhbnkxIDAeBgNVBAsTF0luZnJhc3RydWN0dXJlIFNlcnZpY2VzMTMw

It should be modified to add the new line characters:

—–BEGIN CERTIFICATE—–\r\nMIIGxDCCBaygAwIBAgIQUkL9757013wOQ2heZMCLizANBgkqhkiG9w0BAQsFADCB\r\nkTELMAkGA1UEBhMCVVMxKzApBgNVBAo TIkhld2xldHQgUGFja2FyZCBFbnRlcnBy\r\naXNlIENvbXBhbnkxIDAeBgNVBAsTF0luZnJhc3RydWN0dXJlIFNlcnZpY2VzMTMw\r\n

Notice the “\r\n” added at the beginning of the certificate and at end of each line in the certificate body. Finally, the certificate needs to be PUT (only a PUT would work) through the API (Postman,..), as many as needed to be installed. See the examples in the right pane for more information:

PUT /redfish/v1/Systems/{item}/bios/tlsconfig/settings/

{
  "NewCertificates": [
    {
      "X509Certificate":"-----BEGIN CERTIFICATE-----\r\nMIIGxDCCBaygAwIBAgIQUkL9757013wOQ2heZMCLizANBg......"
    }
  ]
}

Once installed, it will look like this after rebooting:

{
  "@odata.context": "/redfish/v1/$metadata#HpeTlsConfig.HpeTlsConfig",
  "@odata.etag": "W/\"DAE5B73CD430CFCFCF7E180C05FE6C9E\"",
  "@odata.id": "/redfish/v1/systems/1/bios/tlsconfig/settings/",
  "@odata.type": "#HpeTlsConfig.v1_0_0.HpeTlsConfig",
  "Certificates": [
    {
        "FingerPrint": "54:8C:8B:45:55:30:47:8D:43:8D:44:BF:33:E0:C5:A5:44:1E:E9:5E:B2:0A:AC:A6:CA:59:B6:D9:7B:FC:83:A9",
        "Issuer": "C=US, O=Whatever, OU=Infrastructure Services, CN=Whatever Private Root CA",
        "SerialNumber": "5242FDEF9EF4D77CE43685E64C08B8B",
        "Subject": "O=Whatever, CN=John Smith, OU=XXX-WEB-H, OU=Computer Name - Smith.John, OU=Employment Status - Employees, OU=SmartCard, emailAddress=John.Smith@whatever.com",
        "ValidNotAfter": "07/11/2017  23:59",
        "ValidNotBefore": "07/11/2016  00:00"
    }
  ],
  "Ciphers": "AES128-SHA:AES256-SHA:AES128-SHA256:AES256-SHA256:AES128-GCM-SHA256:AES256-GCM-SHA384",
  "DeleteCertificates": [],
  "HostnameCheck": "Enabled",
  "Id": "settings",
  "Name": "TLS Pending Settings",
  "NewCertificates": [],
  "ProtocolVersion": "AUTO",
  "TlsCaCertificateCount": 1,
  "VerifyMode": "NONE"
}

Deleting Certificates

When a certificate is installed, a new field is created with the Fingerprint of that certificate (SHA256). To remove a certificate, PUT the fingerprint to remove

PUT /redfish/v1/Systems/1/bios/tlsconfig/settings/

{
  "DeleteCertificates": [
    {
      "FingerPrint": "54:8C:8B:45:55:30:47:8D:43:8D:44:BF:33:E0:C5:A5:44:1E:E9:5E:B2:0A:AC:A6:CA:59:B6:D9:7B:FC:83:A9"
    }
  ]
}

You can delete more than one certificate at a time.

Resetting the resource to its default settings

See the example in the right pane for more information.

PUT /redfish/v1/Systems/1/bios/tlsconfig/settings/

{
  "BaseConfig": "Default"
}

The default resource would look like:

{
  "@odata.context": "/redfish/v1/$metadata#HpeTlsConfig.HpeTlsConfig",
  "@odata.etag": "W/\"F5B8B30487AB151515845B0C2CC520E0\"",
  "@odata.id": "/redfish/v1/systems/1/bios/tlsconfig/settings/",
  "@odata.type": "#HpeTlsConfig.v1_0_0.HpeTlsConfig",
  "Certificates": [],
  "Ciphers": "AES128-SHA:AES256-SHA:AES128-SHA256:AES256-SHA256:AES128-GCM-SHA256:AES256-GCM-SHA384",
  "DeleteCertificates": [],
  "HostnameCheck": "Disabled",
  "Id": "settings",
  "Name": "TLS Current Settings",
  "NewCertificates": [],
  "ProtocolVersion": "AUTO",
  "TlsCaCertificateCount": 0,
  "VerifyMode": "PEER"
}

Examples of other changes

PATCH /redfish/v1/Systems/1/bios/tlsconfig/settings/

{
  "Ciphers": "AES128-SHA:AES256-SHA"
}

PATCH /redfish/v1/Systems/1/bios/tlsconfig/settings/

{
  "VerifyMode": "PEER"
}

PATCH /redfish/v1/Systems/1/bios/tlsconfig/settings/

{
  "HostnameCheck": "Enabled"
}

PATCH /redfish/v1/Systems/1/bios/tlsconfig/settings/

{
  "ProtocolVersion": "1.1"
}

SSL certificates

SSL protocol is a standard for encrypting data so that it cannot be viewed or modified while in transit on the network. This protocol uses a key to encrypt and decrypt the data. Generally, the longer the key, the better the encryption.

A certificate is a small data file that connects an SSL key to a server. The certificate contains the server name and the server public key. Only the server has the corresponding private key, and this is how it is authenticated.

A certificate must be signed to be valid. If it is signed by a Certificate Authority (CA), and that CA is trusted, all certificates signed by the CA are also trusted. A self-signed certificate is one in which the owner of the certificate acts as its own CA. By default, iLO creates a self-signed certificate for use in SSL connections. This certificate enables iLO to work without additional configuration steps.

IMPORTANT: Using a self-signed certificate is less secure than importing a trusted certificate. Hewlett Packard Enterprise recommends importing a trusted certificate to protect the security of the iLO processor.

Manually obtaining and importing an SSL certificate

iLO allows you to create a Certificate Signing Request that you can send to a Certificate Authority to obtain a trusted SSL certificate to import into iLO.

An SSL certificate works only with the keys generated with its corresponding CSR. If iLO is reset to the factory default settings, or another CSR is generated before the certificate that corresponds to the previous CSR is imported, the certificate does not work. In that case, a new CSR must be generated and used to obtain a new certificate from a CA.

Obtain a trusted certificate from a Certificate Authority (CA)

Prerequisites:

Enter the following details when you create a CSR: * City or Locality (L)—The city or locality where the company or organization that owns this iLO subsystem is located. * Common Name (CN)—The FQDN of this iLO subsystem. * Country ©—The two-character country code that identifies the country where the company or organization that owns this iLO subsystem is located. Enter the two-letter abbreviation in capital letters. * Organization Name (O)—The name of the company or organization that owns this iLO subsystem. * Organizational Unit (OU)—(Optional) The unit within the company or organization that owns this iLO subsystem. * State (ST)—The state where the company or organization that owns this iLO subsystem is located.

POST /redfish/v1/managers/{item}/securityservice/httpscert/HpeHttpsCert.GenerateCSR

{
    "City": "<City>",
    "CommonName": "<CommonName>",
    "Country": "<Country>",
    "IncludeIP": <true or false>,
    "OrgName": "<OrgName>",
    "OrgUnit": "<OrgUnit>",
    "State": "<State>"
}

Importing a trusted certificate

Prerequisites:

POST /redfish/v1/managers/{item}/securityservice/httpscert/HpeHttpsCert.ImportCertificate

{
    "Certificate": "<text>"
}

Sideloading certificate with private key

Note : Only 384-bit ECDSA key is allowed in CNSA security state and up to 2048-bit RSA key is allowed in other security states.

To sideload a certificate along with the private key, perform a POST request with the combined certificate and private key string in Certificate.

POST /redfish/v1/managers/{item}/securityservice/httpscert/HpeHttpsCert.ImportCertificate

{
    "Certificate": "<text>"
}

Automatic Certificate Enrollment

From iLO5 2.60 onwards, iLO supports obtaining and renewing SSL certificate automatically using the Simple Certificate Enrollment Protocol (SCEP). Currently, iLO supports these features on the Microsoft Network Device Enrollment Service (NDES).

By default the feature is disabled. To enable automatic certificate enrollment for iLO, you must first configure the following services on the certificate enrollment server: - Configure the Certificate Authority (CA). CA is the server that runs the Certificate Services and issues certificates. - Configure NDES. NDES is the Certificate Enrollment Server.

NOTE: This feature is not supported when iLO is in CNSA security state.

Enabling Automatic Certificate Enrollment

Prerequisites:

NOTE: If Enrollment Service is enabled, removal and manual import of certificate is not allowed.

To enable Automatic Certificate Enrollment, perform PATCH on /redfish/v1/Managers/1/SecurityService/AutomaticCertificateEnrollment

PATCH /redfish/v1/Managers/1/SecurityService/AutomaticCertificateEnrollment

PATCH Payload:

{
    "AutomaticCertificateEnrollmentSettings" : {
        "ServiceEnabled" : true,
        "ServerUrl" : "<CertificateServerURL>",
        "ChallengePassword" : "<ChallengePassword>"
    }
}

Updating certificate enrollment settings

Prerequisites:

NOTE: Updating the settings does not initiate certificate enrollment. To start the enrollment, first disable the service and enable it again.

To view the automatic certificate enrollment settings, perform GET on

GET /redfish/v1/Managers/1/SecurityService/AutomaticCertificateEnrollment

{
    "@odata.context": "/redfish/v1/$metadata#HpeAutomaticCertEnrollment.HpeAutomaticCertEnrollment",
    "@odata.etag": "W/\"<ETAG>\"",
    "@odata.id": "/redfish/v1/Managers/1/SecurityService/AutomaticCertificateEnrollment/",
    "@odata.type": "#HpeAutomaticCertEnrollment.v1_0_0.HpeAutomaticCertEnrollment",
    "Id": "AutomaticCertificateEnrollment",
    "Actions": {
        "#HpeAutomaticCertEnrollment.ImportCACertificate": {
            "Certificate@Redfish.AllowableValues": [
                "Certificate"
            ],
            "target": "/redfish/v1/Managers/1/SecurityService/AutomaticCertificateEnrollment/Actions/HpeAutomaticCertEnrollment.ImportCACertificate/"
        }
    },
    "AutomaticCertificateEnrollmentSettings": {
        "CACertificateName": "Unavailable",
        "CertificateEnrollmentStatus": "Disabled",
        "ChallengePassword": null,
        "ServerUrl": "",
        "ServiceEnabled": false
    },
    "HttpsCertCSRSubjectValue": {
        "City": "<City>",
        "CommonName": "<CommonName>",
        "Country": "<Country>",
        "IncludeIP": false,
        "OrgName": "<OrgName>",
        "OrgUnit": "<OrgUnit>",
        "State": "<State>"
    }
}

Modifying Webserver CSR subject contents

To modify the webserver CSR subject contents, perform PATCH on /redfish/v1/Managers/1/SecurityService/AutomaticCertificateEnrollment

PATCH /redfish/v1/Managers/1/SecurityService/AutomaticCertificateEnrollment

PATCH Payload:

{
    "HttpsCertCSRSubjectValue": {
        "City": "<City>",
        "CommonName": "<CommonName>",
        "Country": "<Country>",
        "IncludeIP": false,
        "OrgName": "<OrgName>",
        "OrgUnit": "<OrgUnit>",
        "State": "<State>"
    }
}

Renewing automatically managed SSL certificate

When the certificate enrollment service is enabled and the certificate is about to expire (that is 30 days from the expiry date), iLO initiates certificate renewal automatically. As soon as iLO initiates certificate renewal, the certificate enrollment status will change to InProgress.

Certificate enrollment status will change to Success when the renewal is successful. For information on renewal status, see the Security Logs. You must reset iLO manually after successful renewal. The newly trusted certificate will be in use only after iLO reset.

Certificate enrollment status will change to Failed if the renewal fails. For more information on cause of failure and recommended actions, see the Security Logs.

Viewing webserver certificate

Webserver certificate whether self-signed, manually imported or issued automatically can be viewed by performing GET on redfish/v1/managers/1/securityservice/httpscert/

GET redfish/v1/managers/1/securityservice/httpscert/

{
    "@odata.context": "/redfish/v1/$metadata#HpeHttpsCert.HpeHttpsCert",
    "@odata.etag": "W/\"<ETAG>\"",
    "@odata.id": "/redfish/v1/Managers/1/SecurityService/HttpsCert/",
    "@odata.type": "#HpeHttpsCert.v2_0_0.HpeHttpsCert",
    "Id": "HttpsCert",
    "Actions": {
        "#HpeHttpsCert.GenerateCSR": {
            "target": "/redfish/v1/Managers/1/SecurityService/HttpsCert/Actions/HpeHttpsCert.GenerateCSR/"
        },
        "#HpeHttpsCert.ImportCertificate": {
            "target": "/redfish/v1/Managers/1/SecurityService/HttpsCert/Actions/HpeHttpsCert.ImportCertificate/"
        }
    },
    "CertificateSigningRequest": null,
    "X509CertificateInformation": {
        "Issuer": "CN = <CommonName>, O = <OrgName>, OU = <OrgUnit>, L = <Region>, ST = <State>, C = <Country>",
        "SerialNumber": "<SerialNumber>",
        "Subject": "CN = <CommonName>, O = <OrgName>, OU = <OrgUnit>, L = <Region>, ST = <State>, C = <Country>",
        "ValidNotAfter": "2037-05-26T10:07:53Z",
        "ValidNotBefore": "2022-05-27T10:07:53Z"
    }
}

Disabling enrollment service

Disabling enrollment service does not remove the certificate generated using the service. To remove the certificate, see Removing an SSL certificate.

When the service is disabled, iLO does not initiate renewal of the certificate automatically.

Prerequisites:

To disable Automatic Certificate Enrollment, perform PATCH on /redfish/v1/Managers/1/SecurityService/AutomaticCertificateEnrollment

PATCH /redfish/v1/Managers/1/SecurityService/AutomaticCertificateEnrollment

PATCH Payload:

{
    "AutomaticCertificateEnrollmentSettings" : {
        "ServiceEnabled" : false
    }
}

Removing an SSL certificate

Use this feature to remove an SSL certificate and regenerate the iLO self-signed certificate.

NOTE: If Certificate Enrollment Service is enabled, removal and manual import of certificate is not allowed.

You might want to remove a certificate for the following reasons: - The certificate expired. - The certificate contains invalid information. - There are security concerns related to the certificate. - An experienced support organization recommended that you remove the certificate.

Prerequisites:

DELETE /redfish/v1/managers/{item}/securityservice/httpscert/

Security Service

The HpeSecurityService resource type contains security links and properties mentioned in the Resource definition section of this document. This section provides technical detail concerning several server management identities, including the Server Identity (DevID).

DevID is a standard (based on IEEE 802.1AR) way to uniquely identify a server across networks. DevID is uniquely bound to a server that enables a server to prove its identity in various industry standards and protocols that authenticate, provision, and authorize communicating devices. iLO supports factory provisioned server identity (iLO IDevID) and user defined server identity (iLO LDevID). iLO also stores the system certificates (System IDevID and System IAK).

Following are the different server management identities described in this section:

iLO IDevID

iLO can be provisioned with server identity in the factory. This factory provisioned server identity is called iLO IDevID. HPE servers can be securely on boarded into a customer network using the IDevID for 802.1X authentication. iLO IDevID has life time validity and is immutable.

To instruct the HPE factory to provision a server with an IDevID, include either SKU P41905-B21 (if you do not have a TPM2.0 module) or P42104-B21 (if you have a TPM2.0 module) in your order.

iLO does not allow you to update or delete IDevID since it is immutable. You can view the iLO IDevID certificate using the RESTful API GET command toward /redfish/v1/Managers/{@managerId}/SecurityService/iLOIDevID/Certificates/{@certId}

iLO LDevID

IDevID can be supplemented by a user defined server identity, called iLO LDevID. iLO LDevID is unique in the administrative domain, in which the server is used. HPE servers can be securely on boarded into a customer network using the LDevID for 802.1X authentication. iLO LDevID can be used on servers that do not have iLO IDevID. LDevID helps in facilitating the enrollment (authentication and authorization of credentials) by local network administrators. iLO allows to import, view, and delete LDevID outside the factory.

Importing an LDevID certificate

NOTE: LDevID certificate import requires the system in the FIPS security state. You can retrieve this state with a GET request toward the HpeSecurityService URI.

Follow these steps in sequence to import an LDevID certificate:

A successful response body contains the CSR as well as a link to the destination of the signed certificate in the CertificateCollection object.

iLO LDevID CSR generation: POST /redfish/v1/CertificateService/Actions/CertificateService.GenerateCSR

{
    "CertificateCollection": {
              "@odata.id": "/redfish/v1/Managers/1/SecurityService/iLOLDevID/Certificates/"
    }
}

NOTE: Replace non ASCII characters like CRLF or CR with literally “\n” in the CertificateString property.

Import signed LDevID certificate: POST /redfish/v1/Managers/{@managerId}/SecurityService/iLOLDevID/Certificates/


{
    "CertificateType": "PEM",
    "CertificateString": "-----BEGIN CERTIFICATE-----\n<Contents of the trusted certificate>\n-----END CERTIFICATE-----\n"
}

Before importing, iLO validates the input certificate with the following parameters:

NOTE: iLO supports import of LDevID certificates up to 16 KB size.

Viewing the imported LDevID certificate

To view the imported LDevID certificate, use the following RESTful API GET command toward /redfish/v1/Managers/{@managerId}/SecurityService/iLOLDevID/Certificates/{@certId}

Deleting the imported LDevID certificate

To delete the imported LDevID certificate, use the following RESTful API DELETE command toward /redfish/v1/Managers/{@managerId}/SecurityService/iLOLDevID/Certificates/{@certId}

Updating an LDevID certificate

You cannot update a LDevID certificate. To replace a certificate, you must delete the existing LDevID certificate and generate a new certificate. See Importing an LDevID certificate.

NOTE: In case LDevID certificate is lost due to secure erase, you can restore it using the Backup and Restore feature or replace it.

System IDevID certificate

iLO can be provisioned with the server host identity, available for use by the operating system. This factory provisioned system identity is called System IDevID, whose corresponding private key is stored in TPM. System IDevID follows the TCG proposal for TPM2.0 implementation of an IDevID. You have to order a specific server SKU (P42104-B21) for obtaining System IDevID.

iLO does not allow you to update or delete the certificate. You can only view the certificate using the RESTful API GET command toward /redfish/v1/Managers/{@managerId}/SecurityService/SystemIDevID/Certificates/{@certId}

System IAK certificate

iLO can be provisioned with the System Initial Attestation Key (IAK) certificate in the factory. This is similar to System IDevID but used for TPM-based attestation. The corresponding private key is stored in TPM. System IAK follows the TCG proposal for TPM2.0 implementation of an IDevID. You have to order a specific server SKU (P42104-B21) for obtaining System IAK certificate.

iLO does not allow you to update or delete the certificate. You can only view the certificate using the RESTful API GET command toward /redfish/v1/Managers/{@managerId}/SecurityService/SystemIAK/Certificates/{@certId}

NOTE: iLO IDevID, iLO LDevID, System IDevID, and System IAK are preserved across iLO security state transitions, reset to factory defaults.

Platform certificate

iLO can be provisioned with the platform certificate which is an attribute certificate that functions as a signed manifest for the hardware chassis or configuration used to detect supply chain tampering. This certificate is TCG compliant. You have to order a specific server SKU (P42104-B21) for obtaining Platform certificate.

iLO does not allow you to update or delete the platform certificate. You can only view the certificate using the RESTful API GET command toward /redfish/v1/Managers/{@managerId}/SecurityService/PlatformCert/Certificates/{@certId}

Enabling/disabling specific TLS versions

From iLO 5 2.72 version, the HpeSecurityService resource type includes a new property called TLSVersion. This section details the TLSversion property which displays the status (Enabled / Disabled) of different TLS versions supported and how they can be modified in different security states.

HPE iLO Standard, that comes with every HPE ProLiant Gen10 or later server, gives customers the ability to configure servers in one of three security states (Production, High Security, and FIPS). With an iLO Advanced license, customers have a fourth security state available to them that needs the highest-level encryption capabilities of CNSA.

iLO features the following security states:

  1. Production
  2. High Security
  3. FIPS (Federal Information Processing Standards)
  4. CNSA (Commercial National Security Algorithm)

NOTE: - TLS versions 1.0 and 1.1 can be enabled or disabled only in Production mode but they are disabled in higher security modes such as High Security, FIPS, and CNSA. - Tools that do not support TLS 1.2 will not be able to connect to iLO when TLS 1.0 and 1.1 are disabled.

For more information on iLO security states, see the iLO encryption settings of the HPE iLO 5 User Guide

Viewing status of TLS versions enabled/disabled

To view the enabled/disabled status of TLS versions, perform GET on /redfish/v1/Managers/1/SecurityService/

GET /redfish/v1/Managers/1/SecurityService/

{
....
    "TLSVersion": {
        "TLS1_0": "Disabled",
        "TLS1_1": "Enabled",
        "TLS1_2": "Enabled"
    }
...
}

Modifying the enable/disable status of specific TLS versions

Note: - In iLO 5 v2.72, TLSVersion properties are not PATCHable through Redfish. Performing the PATCH operation using the values Enabled or Disabled results in the iLO returning iLO.2.15.PropertyValueBadParam. - This is fixed in iLO 5 v2.78.

Enabling/disabling the TLS versions triggers an event and creates an alert for that event. The message arguments include TLS version being modified, its Status, and the user who requested for the change for the alert.

To enable or disable TLS 1.0 or TLS 1.1 versions or both at the same time in the production state, perform PATCH on /redfish/v1/Managers/1/SecurityService/

PATCH /redfish/v1/Managers/1/SecurityService/

PATCH Payload:

{
    "TLSVersion": {
       "TLS1_0": "Disabled",
       "TLS1_1": "Enabled"
    }
}

iLO automatically resets after enabling or disabling TLS versions and iLO 5 will respond with HTTP 200 OK after PATCH.

Performing PATCH on TLS versions creates an entry in the Security Log. See Security Logs

Examples of entries (Description) in the Security Log after performing PATCH on TLS versions:

Managing the iLO Redfish Host Interface (“Virtual NIC”)

iLO 5 1.40 adds a virtual network interface to access iLO’s HTTPS resources (including the Redfish API and the Web GUI) to the host. This interface is disabled by default in Gen10 servers but may be enabled by default in future servers.

When accessing iLO 5 through the virtual network interface, authentication is enforced.

Enabling the Virtual NIC

The Virtual NIC (also known as the Redfish Host API) is disabled by default but may be enabled either though the Web GUI or by a Redfish operation. An iLO reset is required for this change to take effect.

PATCH /redfish/v1/Managers/{managerId}/

{
    "Oem": {
        "Hpe": {
            "VirtualNICEnabled": true
        }
    }
}

Using the Virtual NIC

When enabled, software running on the server operating system may access the iLO 5 Web GUI or Redfish API using IP address 16.1.15.1. Normal authentication is required.

NOTE: The Virtual NIC does NOT act as a passthrough to traffic on the iLO 5 network connection. It is a separate network connection into iLO’s resources.

Disabling the Virtual NIC

The Virtual NIC may be disabled either though the Web GUI or by a Redfish operation. An iLO reset is required for this change to take effect.

PATCH /redfish/v1/Managers/{managerId}/

{
    "Oem": {
        "Hpe": {
            "VirtualNICEnabled": false
        }
    }
}

Secure Erase

The secure erase process resets iLO and deletes all licenses stored there, resets BIOS settings, and deletes all AHS and warranty data stored on the system. The secure erase process also erases supported non-volatile storage data and deletes any deployment settings profiles. iLO reboots multiple times after the process is initiated.

NOTE: Securely erasing the server can take up to a day to complete.

Secure erase erases supported non-volatile storage data and returns the server to the manufacturing default state. The feature complies with specification NIST SP 800-88 Revision 1, Guidelines for Media Sanitization. For more information about NIST SP 800-88, see https://nvlpubs.nist.gov/nistpubs/specialpublications/nist.sp.800-88r1.pdf. Section 2.5 of the specification describes the level of sanitization. The appendix recommends minimum sanitization levels for media. Secure erase implements the NIST SP 800-88 Revision 1 Sanitization Recommendations for Purging user data and returns the server and supported components to the default state. This feature automates many of the tasks you follow in the Statement of Volatility document for a server. To view what was erased successfully, see View secure erase report. The process can take up to a day to fully erase and reset all user data. When you activate secure erase, iLO 5 does not allow firmware update or reset operations. DO NOT perform any iLO 5 configuration changes until this process is completed.

Secure erase access methods

You can initiate the secure erase process from the following products:

Prerequisites

Process flow

  1. User initiates secure erase.
  2. Upon reboot, BIOS erases configuration, system time, TPM configuration and user data (drives and persistent memory). The system powers off after completion.
  3. iLO 5 then erases key NVRAM and NAND data, and then automatically resets.

Initiating secure erase through Redfish

To initiate secure erase, perform a POST on /redfish/v1/Systems/<index>/Actions/Oem/Hpe/HpeComputerSystemExt.SecureSystemErase/.

The payload for this POST includes two properties:

Property Type Description
SystemRomAndiLOErase Boolean Reset the system BIOS settings and iLO to manufacturing defaults. It also erases the Active Health System (AHS) user data in the NAND.
UserDataErase Boolean Erase all the user data on the system including TPMs, persistent memory devices, storage controller configurations, RAID settings, and data from the hard drives attached to the system. USB and other removable media will be excluded.

NOTE: The POST operation payload requires both the SystemRomAndiLOErase and UserDataErase parameters to be set to true to initiate the secure erase process.

NOTE: Once you initiate this process, it cannot be undone.

POST /redfish/v1/Systems/1/Actions/Oem/Hpe/HpeComputerSystemExt.SecureSystemErase/

{
    "SystemROMAndiLOErase" : true ,
    "UserDataErase": true
}

This returns a response indicating that a server system reset is required.

returns

{
    "error": {
        "code": "iLO.0.10.ExtendedInfo",
        "message": "See @Message.ExtendedInfo for more information.",
        "@Message.ExtendedInfo": [
            {
                "MessageId": "iLO.2.7.SystemResetRequired"
            }
        ],
    }
}

The client must then initiate a server reset using the Reset action in the ComputerSystem resource.

POST /redfish/v1/Systems/{id}/Actions/ComputerSystem.Reset

{
    "ResetType": "ForceRestart"
}

At this point the UEFI BIOS will begin erasing configuration information.

Monitor status of secure erase

Once the secure erase is initiated, perform GET on /redfish/v1/Systems/1/. This resource includes an object Oem.Hpe which contains the status value properties for the secure erase previously initiated. This includes the following properties:

Property Type Description
UserDataEraseStatus Status (Enum) Reports the overall user data erase status
UserDataEraseComponentStatus.{ComponentName} Status (Enum) Indicates the erase status of the individual components
ElapsedEraseTimeInMinutes Integer Reports the time elapsed since the erase started
EstimatedEraseTimeInMinutes Integer Reports the approximate time (in minutes) for the overall erase process

The Status enum takes the following values - Idle, Initiated, InProgress, CompletedWithSuccess, CompletedWithErrors, Failed.

View secure erase report

The client must then initiate a server reset using the Reset action in the ComputerSystem resource.

To view the secure erase report for each of the individual drives or disks installed, perform GET on /redfish/v1/systems/1/Oem/Hpe/EraseReport/{reportId}.

> curl https://{iLO}/redfish/v1/sytems/1/Oem/Hpe/EraseReport/2 -i --insecure -L

{
    "ResetType"        : "ForceRestart",
    "DeviceType"       : "NVMeDrive",
    "DeviceIdentifier" : "NVMe M.2 Drive Slot 1 Bay 1",
    "SerialNumber"     : "<serialNumber>",
    "EraseStatus"      : "CompletedWithSuccess",
    "EraseType"        : "PURGE",
    "StartTime"        : "2019-05-30T08:40:13Z",
    "EndTime"          : "2019-05-30T08:40:13Z"
}

Impacts to the server after secure erase completes

The server will need to be re-provisioned to be used after this operation.

Troubleshooting

In some situations the secure erase function may return an HTTP 500 Internal Server Error.

HTTP 500 Internal Server Error

{
    "error": {
        "code": "iLO.0.10.ExtendedInfo",
        "message": "See @Message.ExtendedInfo for more information.",
        "@Message.ExtendedInfo": [
            {
                "MessageId": "Base.1.0.InternalError"
            }
        ],
    }
}

In the event of this error:

  1. Check if the installed BIOS firmware supports secure erase. Note: This feature is supported only on Gen10 servers and above that have been updated with SPP version 2019.03.0 or later.
  2. If the system is already updated with the correct BIOS firmware version, then reboot the server. Once the system booted, execute the secure erase again using POST action URI.

For more troubleshooting tips and secure erase FAQ, please refer “Intelligent Provisioning User Guide for HPE ProLiant Gen10 Servers and HPE Synergy” https://support.hpe.com/hpesc/public/docDisplay?docLocale=en_US&docId=sd00001085en_us

iLO Backup and Restore

The Backup and Restore service allows you to create and download a binary file containing the configuration of the iLO. In addition, you can restore the iLO configuration on a system with the same hardware configuration as the system that was backed up. This feature is not meant to duplicate a configuration and apply it to a different iLO system.

In general, it is not expected that you will need to perform an iLO restore operation. However, there are cases in which having a backup of the configuration eases and expedites the return to a normal operating environment.

As with any computer system, backing up your data is a recommended practice to minimize the impact from failures. Hewlett Packard Enterprise recommends performing a backup each time that you update the iLO firmware.

You might want to restore the iLO configuration in the following situations:

Battery failure or removal

Various configuration parameters are stored in the battery-powered SRAM. Although rare, the battery can fail. In some situations, battery removal and replacement might be required. To avoid the loss of configuration information, restore the iLO configuration from a backup file after the battery is replaced.

Reset to factory defaults

In some cases, you might need to reset iLO to the factory default settings to erase settings external to iLO. Resetting iLO to the factory default settings erases the iLO configuration. To recover the iLO configuration quickly, restore the configuration from a backup file after the reset to the factory default settings is complete.

Accidental or incorrect configuration change

In some cases, the iLO configuration might be changed incorrectly, causing important settings to be lost. This situation might occur if iLO is set to the factory default settings or user accounts are deleted. To recover the original configuration, restore the configuration from a backup file.

System board replacement

If a system board replacement is required to address a hardware issue, you can use this feature to transfer the iLO configuration from the original system board to the new system board.

Lost license key

If a license key is accidentally replaced, or you reset iLO to the factory default settings, and you are not sure which key to install, you can restore the license key and other configuration settings from a backup file.

What information is restored?

The iLO configuration includes many categories such as Power, Network, Security, the User Database, and License Keys. Most configuration information is stored in the battery-powered SRAM memory device, and it can be backed up and restored.

Information that is not restored

Some information is not suitable to be restored. The information that cannot be restored is not part of the iLO configuration, but instead is related to the iLO or server system state.

The following information is not backed up or restored:

Backing up the iLO 5 configuration

To find the information about the BackupRestoreService, perform GET /redfish/v1/Managers/1/BackupRestoreService

GET /redfish/v1/Managers/1/BackupRestoreService

{
    "@odata.context": "/redfish/v1/$metadata#HpeiLOBackupRestoreService.HpeiLOBackupRestoreService",
    "@odata.etag": "W/\"D863AC37\"",
    "@odata.id": "/redfish/v1/Managers/1/BackupRestoreService",
    "@odata.type": "#HpeiLOBackupRestoreService.v2_2_0.HpeiLOBackupRestoreService",
    "Id": "BackupRestoreService",
    "BackupFileLocation": "/bkupdata/HPE_MXQ32200VV_20020928_0712.bak",
    "BackupFiles": {
        "@odata.id": "/redfish/v1/Managers/1/BackupRestoreService/BackupFiles"
    },
    "HttpPushUri": "/cgi-bin/uploadRestoreFile",
    "Name": "Backup Restore Service"
}

GET the backup file based upon the BackupFileLocation URI

GET /bkupdata/HPE_MXQ32200VV_20020928_0712.bak

The GET operation to the BackupFileLocation URI returns HTTP 200 with Content Type: application/octet-stream. This is the binary image of the backup file.

Restoring the iLO 5 configuration

POST /cgi-bin/uploadRestoreFile

The content type of the POST must be Form Data and include the session key.

Enabling Custom Backup and Restore

From iLO 5 v2.72 release, the backup and restore feature introduces a new OEM property called CustomBackupandRestore. Users can enable this property that allows automatically restoring user defined iLO configuration that was earlier used for backup instead of the factory default settings.

/redfish/v1/managers/1/backuprestoreservice (GET, PATCH)

"CustomBackupandRestore": {
            "description": "This property indicates whether a custom backup and restore is enabled.", 
            "etag": true,
            "readonly": false,
            "type": "boolean"
        }

NOTE:

  1. For iLO5 v2.72, only IPMI and SNMP user configurations are covered in this custom backup and auto-restore feature.
  2. An IEL is logged when the PATCH is performed to set the CustomBackupandRestore property to true/false.
  3. When the auto-restore takes place during the iLO boot, there may be a possible delay of up to 120 seconds before some of the iLO functionalities become available after the auto-restore has taken place.
  4. iLO is configured to use the Production or High Security state - custom backup and auto-restore functionality is not supported in FIPS and higher security states.
  5. If iLO is reset to the factory default settings, then the custom backup needs to be configured again.

To modify the value of the CustomBackupandRestore property, send a PATCH request to the Backup and Restore URI.

PATCH /redfish/v1/managers/1/backuprestoreservice

{
    "CustomBackupandRestore": true
}

Storage data models

The following sections describe the storage models supported by iLO - DMTF Redfish Storage Model and HPE OEM Storage Model.

DMTF Redfish Storage Model

HPE ProLiant Gen10 servers (iLO 5 version equal or greater than 2.30) and beyond implement the DMTF standard known as Platform Level Data Model for Redfish Device Enablement (PLDM for RDE). This open standard allows storage controllers to host their own set of Redfish resources and capabilities which are rooted under the iLO /redfish/v1 service root. As a result, responses to Redfish client requests are provided by the controllers through the iLO.

Without the implementation of PLDM for RDE in either the iLO firmware or the storage controller firmware, the iLO responds to Redfish client requests using its own database of storage controller resources and properties, populated during Pre-OS tasks (POST).

For updated information on the Redfish resources, corresponding URIs, and supported HTTP methods towards storage controllers implementing PLDM for RDE, see the Configuration and Redfish sections of the HPE SR Gen10 Plus Controller User Guide.

The array controllers have implemented the DMTF Redfish storage data model for inventory (GET). Starting at iLO 5 firmware version 2.65, the array controllers that have implemented the DMTF PLDM for RDE standard support Redfish write operations (POST, DELETE, and PATCH).

The following table lists the Redfish resources and the corresponding URIs for the GET requests towards storage controllers implementing PLDM for RDE:

Redfish Resource Method URI
Storage GET /redfish/v1/Systems/{item}/Storage/{item}
Controller Collection GET /redfish/v1/Systems/{item}/Storage/{item}/Controllers
Storage Controller GET /redfish/v1/Systems/{item}/Storage/{item}/Controllers/{item}
Port Collection GET /redfish/v1/Systems/{item}/Storage/{item}/Controllers/{item}/Ports
Volume Collection GET /redfish/v1/Systems/{item}/Storage/{item}/Volumes
Volume Capabilities GET /redfish/v1/Systems/{item}/Storage/{item}/Volumes/Capabilities
Volume GET /redfish/v1/Systems/{item}/Storage/{item}/Volumes/{item}
Drive GET /redfish/v1/Systems/{item}/Storage/{item}/Drives/{item}

The following table lists the Redfish resources and corresponding URIs for write requests towards storage controllers implementing PLDM for RDE:

Redfish Resource Method URI
Volume Create POST /redfish/v1/Systems/{item}/Storage/{item}/Volumes
Volume Delete DEL /redfish/v1/Systems/{item}/Storage/{item}/Volumes/{item}

NOTE: The Redfish responses from controllers implementing PLDM for RDE depend on the schema versions that are supported by each device and are likely to vary across each device vendor/family/model. Create and delete volume operations will also likely vary across devices.

For more information on RDE support changes and limitations, see Redfish Device Enablement (RDE) support.

Example GET responses

GET /redfish/v1/Systems/1/Storage/{item}

{
    "@odata.context": "/redfish/v1/$metadata#Storage.Storage",
    "@odata.etag": "W/\"F7D058EE\"",
    "@odata.id": "/redfish/v1/Systems/1/Storage/DA000008/",
    "@odata.type": "#Storage.v1_12_0.Storage",
    "Id": "DA000008",
    "Controllers": {
        "@odata.id": "/redfish/v1/Systems/1/Storage/DA000008/Controllers/"
    },
    "Drives": [
        {
            "@odata.id": "/redfish/v1/Systems/1/Storage/DA000008/Drives/CAE9137A/"
        },
        {
            "@odata.id": "/redfish/v1/Systems/1/Storage/DA000008/Drives/F377244E/"
        },
        {
            "@odata.id": "/redfish/v1/Systems/1/Storage/DA000008/Drives/E55B33A9/"
        },
        {
            "@odata.id": "/redfish/v1/Systems/1/Storage/DA000008/Drives/69483FD4/"
        }
    ],
    "Links": {
        "Enclosures": [
            {
                "@odata.id": "/redfish/v1/Chassis/1/"
            }
        ]
    },
    "Name": "SATA Storage System",
    "Status": {
        "Health": "OK",
        "State": "Enabled"
    },
    "StorageControllers": [
        {
            "@odata.id": "/redfish/v1/Systems/1/Storage/DA000008#/StorageControllers/0/",
            "FirmwareVersion": null,
            "Location": {
                "PartLocation": {
                    "ServiceLabel": "System Board"
                }
            },
            "Manufacturer": "",
            "MemberId": "0",
            "Model": "Embedded SATA Controller #2",
            "Name": "SATA Storage Controller",
            "PartNumber": "",
            "SerialNumber": "<SerialNumber>",
            "Status": {
                "Health": null,
                "State": null
            },
            "SupportedDeviceProtocols": [
                "SATA"
            ]
        }
    ]
}

GET /redfish/v1/Systems/1/Storage/{item}/Drives/{item}

{
    "@odata.context": "/redfish/v1/$metadata#Drive.Drive",
    "@odata.etag": "W/\"98A85B7F\"",
    "@odata.id": "/redfish/v1/Systems/1/Storage/DA000008/Drives/CAE9137A/",
    "@odata.type": "#Drive.v1_7_0.Drive",
    "Id": "CAE9137A",
    "Actions": {
        "#Drive.Reset": {
            "ResetValue@Redfish.AllowableValues": [
                "ForceOff",
                "ForceOn",
                "PowerCycle"
            ],
            "target": "/redfish/v1/Systems/1/Storage/DA000008/Drives/CAE9137A/Actions/Drive.Reset/"
        }
    },
    "CapacityBytes": 1000204000000,
    "Identifiers": [],
    "IndicatorLED": "Off",
    "Location": [
        {
            "Info": "SATA Drive Box 3 Bay 4",
            "InfoFormat": "BayNumber"
        }
    ],
    "MediaType": "HDD",
    "Model": "MM1000GFJTE",
    "Name": "Secondary Storage Device",
    "Oem": {
        "Hpe": {
            "@odata.context": "/redfish/v1/$metadata#HpeiLODriveExt.HpeiLODriveExt",
            "@odata.type": "#HpeiLODriveExt.v2_0_1.HpeiLODriveExt",
            "DriveStatus": {},
            "TemperatureStatus": {}
        }
    },
    "PhysicalLocation": {
        "PartLocation": {
            "LocationOrdinalValue": 4,
            "LocationType": "Bay",
            "ServiceLabel": "SATA Drive Box 3 Bay 4"
        }
    },
    "Revision": "HPG5",
    "SerialNumber": "<SerialNumber>",
    "Status": {
        "Health": "OK",
        "State": "Enabled"
    }
}

GET /redfish/v1/Systems/1/Storage/{item}/Volumes/{item}

{
    "@odata.etag": "\"14175561\"",
    "@odata.id": "/redfish/v1/Systems/1/Storage/DE009000/Volumes/238",
    "@odata.type": "#Volume.v1_4_0.Volume",
    "Id": "238",
    "Name": "MR Volume",
    "Status": {
        "State": "Enabled",
        "Health": "OK"
    },
    "BlockSizeBytes": 512,
    "CapacityBytes": 85899345920,
    "DisplayName": "WESERVER",
    "Encrypted": false,
    "EncryptionTypes": [
        "NativeDriveEncryption"
    ],
    "Identifiers": [
        {
            "DurableName": "425380496",
            "DurableNameFormat": "NAA"
        }
    ],
    "Links": {
        "Drives@odata.count": 1,
        "Drives": [
            {
                "@odata.id": "/redfish/v1/Systems/1/Storage/DE009000/Drives/8"
            }
        ],
        "DedicatedSpareDrives@odata.count": 0,
        "DedicatedSpareDrives": []
    },
    "LogicalUnitNumber": 0,
    "Operations": [],
    "OptimumIOSizeBytes": 65536,
    "RAIDType": "RAID0",
    "ReadCachePolicy": "Off",
    "StripSizeBytes": 65536,
    "VolumeUsage": "Data",
    "WriteCachePolicy": "WriteThrough"
}

Creating Volumes

Creating volumes in a storage controller supporting PLDM for RDE in write mode, is performed using a POST request toward /redfish/v1/Systems/1/Storage/{item}/Volumes. The exhaustive list of required and optional parameters of such POST requests can be retrieved with a GET request to /redfish/v1/Systems/1/Storage/{item}/Volumes/Capabilities This URI provides as well the possible values for each capability.

Verify POST requests are allowed to create volumes: HEAD /redfish/v1/Systems/1/Storage/{item}/Volumes

{
  "Allow": "GET, HEAD, POST",
  "Content-Length": "0",
  "Date": "Tue, 05 Jul 2022 12:43:12 GMT",
  "ETag": "W/\"75983E8D\"",
  "Link": "</redfish/v1/SchemaStore/en/StorageCollection.json>; rel=describedby",
  "OData-Version": "4.0",
  "X-Content-Type-Options": "nosniff",
  "X-Frame-Options": "sameorigin",
  "X-XSS-Protection": "1; mode=block"
}

Retrieve optional and required parameters to create a volume: GET /redfish/v1/Systems/1/Storage/{item}/Volumes/Capabilities

{
  "@odata.id": "/redfish/v1/Systems/1/Storage/DE00D000/Volumes/Capabilities",
  "@odata.type": "#Volume.v1_6_2.Volume",
  "Id": "Capabilities",
  "Name": "Capabilities for the volume collection",
  "RAIDType@Redfish.RequiredOnCreate": true,
  "RAIDType@Redfish.AllowableValues": [
    "RAID0",
    "RAID1",
    "RAID10",
    "RAID5",
    "RAID50",
    "RAID6",
    "RAID60",
    "RAID1Triple",
    "RAID10Triple"
  ],
  "CapacityBytes@Redfish.OptionalOnCreate": true,
  "StripSizeBytes@Redfish.OptionalOnCreate": true,
  "IOPerfModeEnabled@Redfish.OptionalOnCreate": true,
  "IOPerfModeEnabled@Redfish.UpdatableAfterCreate": true,
  "MediaSpanCount@Redfish.OptionalOnCreate": true,
  "DisplayName@Redfish.OptionalOnCreate": true,
  "DisplayName@Redfish.UpdatableAfterCreate": true,
  "ReadCachePolicy@Redfish.OptionalOnCreate": true,
  "ReadCachePolicy@Redfish.AllowableValues": [
    "Off",
    "ReadAhead"
  ],
  "ReadCachePolicy@Redfish.UpdatableAfterCreate": true,
  "WriteCachePolicy@Redfish.OptionalOnCreate": true,
  "WriteCachePolicy@Redfish.AllowableValues": [
    "Off"
  ],
  "WriteCachePolicy@Redfish.UpdatableAfterCreate": true,
  "VolumeUsage@Redfish.OptionalOnCreate": true,
  "VolumeUsage@Redfish.AllowableValues": [
    "Data"
  ],
  "InitializeMethod@Redfish.OptionalOnCreate": true,
  "InitializeMethod@Redfish.AllowableValues": [
    "Background",
    "Foreground"
  ],
  "Links@Redfish.RequiredOnCreate": true,
  "Links": {
    "Drives@Redfish.RequiredOnCreate": true,
    "DedicatedSpareDrives@Redfish.OptionalOnCreate": true,
    "DedicatedSpareDrives@Redfish.UpdatableAfterCreate": true
  },
  "@odata.etag": "\"0A1FA1E9\""
}

Volume creation: POST /redfish/v1/Systems/1/Storage/{item}/Volumes

{
    "CapacityBytes": <Number>,
    "StripSizeBytes": <Number>,
    "DisplayName": "string",
    "ReadCachePolicy": "string",
    "RAIDType": "string",
    "WriteCachePolicy": "string",
    "Links": {
        "Drives": [
            {
                "@odata.id": "/redfish/v1/Systems/1/Storage/{item}/Drives/0"
            },
            {
                "@odata.id": "/redfish/v1/Systems/1/Storage/{item}/Drives/4"
            }
        ]
    }
}

The properties to be passed as part of the POST payload are described below:

Property Datatype Description
CapacityBytes Number Size in bytes of this volume.
StripSizeBytes Number The number of blocks (bytes) in a strip in a disk array that uses striped data mapping.
DisplayName String A user-configurable string to name the volume.
ReadCachePolicy String Indicates the read cache policy setting for the Volume.
RAIDType String The RAID type of this volume.
WriteCachePolicy String (enum)
"WriteThrough"/ "UnprotectedWriteBack" / "ProtectedWriteBack"		 Indicates the write cache policy setting for the Volume.
Links Collection of @odata.id Links to the physical drives from which to create the Volume.

Deleting Volumes

DELETE /redfish/v1/Systems/1/Storage/{item}/Volumes/{item}

HPE OEM Storage Models

HPE initially developed the SmartStorage Redfish OEM data model for HPE ProLiant DL580 Gen8 server. This model supported inventory (GET) and monitoring (Events) features.

In HPE ProLiant Gen10, the SmartStorageConfig resource was added to support configuration. This OEM model used a proprietary API that only supports the SR line of storage controllers. This OEM storage model is removed starting with HPE Gen11 servers. Customers are encouraged to use the open standard “DMTF Redfish Storage Model” described above.

The following table lists the Redfish resources and corresponding URIs for the GET requests toward the legacy OEM HPE SmartStorage model:

Redfish Resource Method URI
HPE Smart Storage Config GET /redfish/v1/Systems/{item}/smartstorageconfig
HPE Smart Storage GET /redfish/v1/Systems/{item}/SmartStorage
HPE Smart Storage Array Controller Collection GET /redfish/v1/Systems/{item}/SmartStorage/ArrayControllers
HPE Smart Storage Array Controller GET /redfish/v1/Systems/{item}/SmartStorage/ArrayControllers/{item}
HPE Smart Storage Logical Drive Collection GET /redfish/v1/Systems/{item}/SmartStorage/ArrayControllers/{item}/LogicalDrives
HPE Smart Storage Storage Enclosure Collection GET /redfish/v1/Systems/{item}/SmartStorage/ArrayControllers/{item}/StorageEnclosures
HPE Smart Storage Disk Drive Collection GET /redfish/v1/Systems/{item}/SmartStorage/ArrayControllers/{item}/DiskDrives

The following table lists the Redfish resources and corresponding URIs for write requests toward the legacy OEM HPE SmartStorageConfig model

NOTE: The HPE SmartArray configuration process is similar to the way BIOS is configured. PATCH or PUT requests are performed toward a temporary setting zone. Then, upon reboot, the settings are verified and, if valid, they are transferred in the current area. If they are not valid, error messages are posted in the @Redfish.Settings resource of current area.

Redfish Resource Method URI
Logical Drive Create & Delete PUT /redfish/v1/Systems/{item}/smartstorageconfig/settings
Spare Drives PATCH /redfish/v1/Systems/{item}/smartstorageconfig/settings
Spare Rebuild Mode PATCH /redfish/v1/Systems/{item}/smartstorageconfig/settings
Accelerator PATCH /redfish/v1/Systems/{item}/smartstorageconfig/settings
Read Cache Percent PATCH /redfish/v1/Systems/{item}/smartstorageconfig/settings
Rebuild Priority PATCH /redfish/v1/Systems/{item}/smartstorageconfig/settings
Surface Scan Analysis Priority PATCH /redfish/v1/Systems/{item}/smartstorageconfig/settings
Drive Write Cache PATCH /redfish/v1/Systems/{item}/smartstorageconfig/settings
Physical Drive Erase PUT /redfish/v1/Systems/{item}/smartstorageconfig/settings

The SmartStorageConfig resource sub-tree is linked into the ComputerSystem resource:

GET /redfish/v1/systems/{item}/ (output truncated)

...
{
  "Oem": {
    "Hpe": {
      "SmartStorageConfig": {
        "@odata.id": "/redfish/v1/systems/{item}/smartstorageconfig/"
      }
    }
  }
}
...

The /redfish/v1/systems/{item}/smartstorageconfig/ URI is the GET-only current configuration which links to the pending configuration URI.

SmartStorageConfig output example

GET /redfish/v1/systems/{item}/smartstorageconfig/

{
    "@Redfish.Settings": {
        "@odata.type": "#Settings.v1_0_0.Settings",
        "ETag": "",
        "Messages": [
            {
                "MessageId": "Base.1.0.Success"
            }
        ],
        "SettingsObject": {
            "@odata.id": "/redfish/v1/systems/1/smartstorageconfig/settings/"
        },
        "Time": ""
    },
    "@odata.context": "/redfish/v1/$metadata#SmartStorageConfig.SmartStorageConfig",
    "@odata.etag": "W/\"5C73F2701BE5B6B6B665E028E718BAB2\"",
    "@odata.id": "/redfish/v1/systems/1/smartstorageconfig/",
    "@odata.type": "#SmartStorageConfig.v2_0_0.SmartStorageConfig",
    "CurrentParallelSurfaceScanCount": 1,
    "DataGuard": "Strict",
    "DegradedPerformanceOptimization": "Disabled",
    "DriveWriteCache": "Disabled",
    "ElevatorSort": "Enabled",
    "EncryptionConfiguration": "None",
    "EncryptionEULA": null,
    "ExpandPriority": "Medium",
    "FlexibleLatencySchedulerSetting": "Default",
    "Id": "smartstorageconfig",
    "InconsistencyRepairPolicy": "Disabled",
    "Location": "Slot UNKNOWN",
    "LocationFormat": "PCISlot",
    "LogicalDrives": [
        {
            "Accelerator": "ControllerCache",
            "BlockSizeBytes": 512,
            "CapacityBlocks": 1953459632,
            "CapacityGiB": 931,
            "DataDrives": [
                "P1I:3:1"
            ],
            "DriveLocationFormat": "ControllerPort:Box:Bay",
            "LegacyBootPriority": "None",
            "LogicalDriveName": "Logical Drive 0",
            "LogicalDriveNumber": 1,
            "ParityGroupCount": 0,
            "Raid": "Raid0",
            "SpareDrives": [],
            "SpareRebuildMode": null,
            "StripSizeBytes": 262144,
            "StripeSizeBytes": 262144,
            "VolumeUniqueIdentifier": "600508B1001CAC3093F52C735D6DE038"
        }
    ],
    "MonitorAndPerformanceAnalysisDelaySeconds": 60,
    "NoBatteryWriteCache": "Disabled",
    "Oem": {
        "Hpe": {
            "@odata.type": "#HpeBiosExt.v2_0_0.HpeBiosExt",
            "SettingsObject": {
                "UnmodifiedETag": "W/\"1D348072E79A999999DDFE0BCB960774\""
            }
        }
    },
    "PhysicalDrives": [
        {
            "LegacyBootPriority": "None",
            "Location": "P1I:3:1",
            "LocationFormat": "ControllerPort:Box:Bay"
        }
    ],
    "Ports": [
        {
            "OperatingModeAfterReboot": "Mixed",
            "PortIndex": 0
        },
        {
            "OperatingModeAfterReboot": "Mixed",
            "PortIndex": 1
        }
    ],
    "PowerModeAfterReboot": "MaxPerformance",
    "PredictiveSpareRebuild": "Disabled",
    "QueueDepth": "Automatic",
    "ReadCachePercent": 100,
    "RebuildPriority": "RapidLow",
    "SurfaceScanAnalysisDelaySeconds": 3,
    "SurfaceScanAnalysisPriority": "Idle",
    "SurvivalPowerMode": "Enabled",
    "WriteCacheBypassThresholdKiB": 1040
}

Update controller configuration

The controller configuration is accurate after boot, before any online changes are administered using dedicated applications like the HPE Smart Storage Administrator (SSA). A live version of this data is available in both redfish/v1/Systems/{item}/smartstorageconfig/ and /redfish/v1/Systems/1/SmartStorage/.

PATCH /redfish/v1/Systems/{item}/smartstorageconfig/settings/

{
    "DataGuard": "Strict",
    "ExpandPriority": "High",
    "RebuildPriority": "High",
    "ReadCachePercent": 20
}

View logical drive inventory

The logical drive inventory is accurate after boot, before any online changes are administered using dedicated applications like the HPE Smart Storage Administrator (SSA). A live version of this data is available in both redfish/v1/Systems/{item}/smartstorageconfig/ and /redfish/v1/Systems/1/SmartStorage.

GET /redfish/v1/Systems/{item}/smartstorageconfig/

{
   "LocationFormat": "PCISlot",
   "DataGuard": "Strict",
   "Location": "Slot 1",
   "BootVolumePrimary": "600508B1001C406C193B03A644CDF6C2",
   "BootVolumeSecondary": "00000000000000000000000000000000",
   "LogicalDrives": [
        {
            "LogicalDriveNumber": 1,
            "Status": {
                "State": "Enabled",
                "HealthRollup": "OK",
                "Health": "OK"
            },
            "VolumeUniqueIdentifier": "600508B1001C406C193B03A644CDF6C2",
            "LegacyBootPriority": "Primary",
            "CapacityGiB": 558,
            "CapacityBlocks": 1171743324,
            "Raid": "Raid0",
            "StripSizeBytes": 262144,
            "StripeSizeBytes": 524288,
            "Accelerator": "None",
            "LogicalDriveName": "A4119B335001438020C7EA30\u0002\u00012B8F",
            "DriveLocationFormat": "ControllerPort:Box:Bay",
            "DataDrives": [
                "1I:1:1",
                "1I:1:2"
            ],
            "SpareDrives": []
        }
    ]
}

The DataGuard property

The management of HPE Smart Storage devices requires a proper understanding of the DataGuard property part of the SmartStorageConfig sub-tree. The value of this attribute “indicates whether or not data destructive actions are allowed” as explained in the Resource Definitions paragraph.

This property is set in the pending settings area (SmartStorageConfig/Settings) along with the directives to be performed by the Smart Storage device (i.e. Logical Volume Creation, Deletion…). During the next Pre-OS Tasks process, the iLO firmware checks its value and performs, or does not perform, the requested directives.

Read the DataGuard paragraph for the supported values.

Create logical drives

Find below two examples of logical drive creation.

PUT /redfish/v1/Systems/{item}/smartstorageconfig/settings/

{
    "DataGuard": "Disabled",
    "LogicalDrives": [
       {
          "CapacityGiB": 558,
          "Raid": "Raid0",
          "StripSizeBytes": 262144,
          "LogicalDriveName": "MyLD",
          "DataDrives": [
                "1I:1:1",
                "1I:1:2"
          ],
          "SpareDrives": [
                "1I:1:3"
          ],
          "Accelerator": "ControllerCache",
          "LegacyBootPriority": "None"
       }
    ]
}

PUT /redfish/v1/Systems/{item}/smartstorageconfig/settings/

{
    "DataGuard": "Disabled",
    "LogicalDrives": [
       {
          "LogicalDriveName": "MyLD",
          "Raid": "Raid5", 
          "DataDrives": {
             "DataDriveCount": 4,
             "DataDriveMediaType": "HDD",
             "DataDriveInterfaceType": "SAS", 
             "DataDriveMinimumSizeGiB": 1000
          }
       }
    ]
}

DataGuard rules concerning Logical Volume deletion

Delete logical drives

There are two ways to delete logical drives. The first enables you to remove specific logical drives by Volume Unique Identifier. The second can be used to remove all logical drives.

The Actions property is not present by default in the resource but must be added with an HTTPS PUT operation.

NOTE: The Actions property here is under the specific logical drive you wish to delete.

PUT /redfish/v1/Systems/{item}/SmartStorageConfig/Settings/

{
   "LogicalDrives": [
      {
         "Actions": [{"Action": "LogicalDriveDelete"}],
         "VolumeUniqueIdentifier": "600123459AF45456664443"
      }
    ],
    "DataGuard": "Permissive"
}

PATCH /redfish/v1/Systems/{item}/SmartStorageConfig/Settings/

{
    "LogicalDrives": [],
    "DataGuard": "Disabled"
}

A system reboot is required for the Smart Storage firmware to validate and perform any requested changes. The result of the operations will be available in the current configuration resource at /redfish/v1/Systems/{item}/SmartStorageConfig/ (the parent resource of the settings resource.)

Sanitize drives

Physical drive erase:

PATCH /redfish/v1/systems/{item}/smartstorageconfig/settings/

{
    "Actions": [
        {
            "Action": "PhysicalDriveErase",
            "ErasePattern": "SanitizeRestrictedBlockErase",
            "PhysicalDriveList": [
                "1I:1:1",
                "1I:1:2"
            ]
        }
    ],
    "DataGuard": "Disabled"
}

Sanitize is a long running operation and the drive is not available (for RAID config) until sanitize is complete. The status can be checked from the iLO/SmartStorage data.

Redfish Device Enablement (RDE) support

Redfish Device Enablement (RDE) enables a management controller (iLO) to present Redfish-conformant data model of I/O devices in a server, without the need for code specific to each device vendor/family/model. With the changes described below, iLO is enabling these devices to handle their own Redfish data model but it is up to the vendors to make their devices conform to the latest standards of Redfish. The Redfish responses from the device depend on the schema versions that are supported by each device and are likely to vary across each device vendor/family/model.

NOTE: As of iLO 5 2.70 version, iLO returns 400 Bad Request when RDE devices/adapters take a long time to process and respond to POST requests.

iLO support for enabling RDE URIs and corresponding HTTP methods

The following table lists the Redfish URIs enabled by iLO for RDE capable devices. It also lists the iLO firmware version in which the support was added for the URI and HTTP method.

URI GET HEAD PATCH POST DELETE
/redfish/v1/Systems/{@systemsId}/NetworkInterfaces 2.55 - - - -
/redfish/v1/Systems/{@systemsId}/NetworkInterfaces/{@nicId} 2.55 2.55 - - -
/redfish/v1/Systems/{@systemId}/EthernetInterfaces 2.55 - - - -
/redfish/v1/Systems/{@systemId}/EthernetInterfaces/{@nicId} 2.55 2.55 2.72 2.72 -
/redfish/v1/Chassis/{@chassisId}/PCIeDevices 2.55 - - - -
/redfish/v1/Chassis/{@chassisId}/PCIeDevices/{@PCIeDeviceId} 2.55 2.55 - - -
/redfish/v1/Chassis/{@chassisId}/PCIeDevices/{@PCIeDeviceId}/PCIeFunctions 2.55 - - - -
/redfish/v1/Chassis/{@chassisId}/PCIeDevices/{@PCIeDeviceId}/PCIeFunctions/{@PCIeFunctionId} 2.55 2.55 - - -
/redfish/v1/Chassis/{@chassisId}/NetworkAdapters 2.33 - - - -
/redfish/v1/Chassis/{@chassisId}/NetworkAdapters/{@nicId} 2.33 2.33 2.50 2.55 -
/redfish/v1/Chassis/{@chassisId}/NetworkAdapters/{@nicId}/NetworkPorts 2.33 - - - -
/redfish/v1/Chassis/{@chassisId}/NetworkAdapters/{@nicId}/NetworkPorts/{@portId} 2.33 2.33 2.50 2.55 -
/redfish/v1/Chassis/{@chassisId}/NetworkAdapters/{@nicId}/Ports 2.65 - - - -
/redfish/v1/Chassis/{@chassisId}/NetworkAdapters/{@nicId}/Ports/{@portId} 2.65 2.65 2.65 2.65 -
/redfish/v1/Chassis/{@chassisId}/NetworkAdapters/{@nicId}/NetworkDeviceFunctions 2.33 - - - -
/redfish/v1/Chassis/{@chassisId}/NetworkAdapters/{@nicId}/NetworkDeviceFunctions/{@pfId} 2.33 2.33 2.50 2.55 -
/redfish/v1/Systems/{@systemId}/Storage 2.33 - - - -
/redfish/v1/Systems/{@systemId}/Storage/{@storageId} 2.33 2.50 2.50 2.55 -
/redfish/v1/Systems/{@systemId}/Storage/{@storageId}/Drives/{@driveId} 2.33 2.33 2.50 2.55 -
/redfish/v1/Systems/{@systemId}/Storage/{@storageId}/Controllers/ 2.70 - - - -
/redfish/v1/Systems/{@systemId}/Storage/{@storageId}/Controllers/{@controllerId} 2.70 2.70 2.72 - -
/redfish/v1/Systems/{@systemId}/Storage/{@storageId}/Controllers/{@ControllerId}/Ports/{@portId} 2.65 2.65 2.65 - -
/redfish/v1/Systems/{@systemId}/Storage/{@storageId}/Volumes 2.33 - - 2.60 -
/redfish/v1/Systems/{@systemId}/Storage/{@storageId}/Volumes/{@volumeId} 2.33 2.50 2.50 2.50 2.50

RDE capable device schema file locations

The schema files describing RDE capable devices are not stored in iLO nor in the device. However, their location is in the Link response header property of HEAD requests.

These schema files can be obtained using iLOrest tool.

To get the controller schema file of an RDE capable storage controller:

ilorest rawhead /redfish/v1/Systems/1/Storage/DE07C000 2>/dev/null | jq ‘.Link’

http://redfish.dmtf.org/schemas/v1/Storage.v1_10_1.json#/definitions/Storage

To get the volume schema file of an RDE capable logical volumes:

ilorest rawhead /redfish/v1/Systems/1/Storage/DE07C000/Volumes 2>/dev/null | jq -r ‘.Link’

http://redfish.dmtf.org/schemas/swordfish/v1/VolumeCollection.json

To get the network port schema file of an RDE capable network adapter:

ilorest rawhead /redfish/v1/Chassis/1/NetworkAdapters/DE080000/NetworkPorts 2>/dev/null | jq ‘.Link’

http://redfish.dmtf.org/schemas/v1/NetworkPortCollection.json

For more details, refer to the DMTF RDE specification.

Compute node data

Base FRUs

iLO 5 features the ability to display the FRU data on server blade board.

Accessing Base FRUs through Redfish

To access the Redfish Base FRUs resource, perform GET on /redfish/v1/Chassis/1/BaseFrus/. This resource includes a link to the collection of entries /redfish/v1/Chassis/1/BaseFrus/. Individual FRUs can be accessed by performing GET on /redfish/v1/Chassis/1/BaseFrus/{@baseId}/Details.

> curl https://{iLO}/redfish/v1/Chassis/1/BaseFrus/{@baseId}/Details -i --insecure -L

{
  "BladeInfo":{
    "Capabilities":{
      "BBCoordMap":["A"],
      "ChangesRequireReboot": true,
      "CurrentSenseSF":[195],
      "DynamicPower": true,
      "EkeyGroupMatchReq":[],
      "ILOHwReset": true,
      "StaticLowPowerMode": true,
      "TVSMechanicalFuse": true,
      "TempDeadlyDelayTime": 120,
      "UEFISupport": true
    },
    "PortMap":[
      {
        "BBCoord": "A",
        "BBMezzSlot":[
          {
            "LinkInfo":{"LType": "PCIe"},
            "MZ": 1,
            "Sys":[
              {
                "Cpu": 1,
                "Id": "1",
                "Pin":[
                  "0..15"
                ]
              }
            ]
          },
          {
            "LinkInfo":{
              "LType": "PCIe"
            },
            "MZ": 2,
            "Sys":[
              {
                "Cpu": 2,
                "Id": "1",
                "Pin":[
                  "0..15"
                ]
              }
            ]
          },
          {
            "LinkInfo":{"LType": "PCIe"},
            "MZ": 3,
            "Sys":[
              {
                "Cpu": 1,
                "Id": "1",
                "Pin":[
                  "0..15"
                ]
              }
            ]
          }
        ]
      }
    ],
    "Systems":[
      {
        "Components":[
          {
            "Count": 2,
            "DevType": "Processor",
            "Name": "CPU Slots"
          },
          {
            "Count": 32,
            "DevType": "DIMM",
            "Name": "Memory Module Slots"
          }
        ],
        "Id": "1"
      }
    ]
  },
  "IpmiProductInfo":{
    "AssemblyPartNumber": "<AssemblyPartNumber>",
    "BoardRevCode": "X3",
    "ChassisDepth": 572,
    "ChassisHeight": 213,
    "ChassisPartNumber": "<ChassisPartNumber>",
    "ChassisSerialNumber": "<ChassisSerialNumber>",
    "ChassisWidth": 64,
    "ManufacturedFor": "HPE",
    "Manufacturer": "HPE",
    "PCASerialNumber": "<PCASerialNumber>",
    "PCASparePartNumber": "<PCASparePartNumber>",
    "PartNumber": "<PartNumber>",
    "ProductVersion": "10P",
    "SerialNumber": "<SerialNumber>",
    "SlotsConsumedHeight": 1,
    "SlotsConsumedWidth": 1
  },
  "MgmtConfig":[
    {
      "ConnectType": "iLO",
      "CustomerVisible": true,
      "LinkRate": "1Gb",
      "ProtocolType": "Ethernet"
    }
  ],
  "PowerInfo":{
    "FullOn": 22,
    "LowMode": 16,
    "MaxPowerDuringAlert": 22,
    "Vaux": 10
  },
  "Preamble":{
    "CommType":[
      "iLO",
      "RIS"
    ],
    "EEPROMSize": 4096,
    "EfuseResetDuration": 4,
    "FactoryTimeStamp": "2020-08-13T04:08:02+0000",
    "FruSubType":[
      "Blade",
      "IpmiSegment"
    ],
    "FruType": "ServerBlade",
    "GreenFactor":[
      "Low Halogen"
    ],
    "HwCompliance":[],
    "Language": "en-US",
    "LastModified": "2020-07-10",
    "Model": "Synergy 480 Gen10 Plus Compute Module"
  },
  "Type": "HpServerFru.1.0.1"
}

Mezzanine FRUs

The NIC and Mezzanine (Mezz) option FRU information informs Onboard Administrator of the type of interconnects each server requires. Before power is provided to a server blade, Onboard Administrator compares this information with the FRU EEPROMs on installed interconnect modules to check for electronic keying errors.

iLO 5 features the ability to display the FRU data on the cards in the Mezzanine slots.

Accessing MEZZ FRUs through Redfish

To access the Redfish MEZZ FRUs resource, perform GET on /redfish/v1/Chassis/1/MezzFrus/. This resource includes a link to the collection of entries /redfish/v1/Chassis/1/MezzFrus/. Individual FRUs can be accessed by performing GET on /redfish/v1/Chassis/1/MezzFrus/{@mezzId}/Details.

> curl https://{iLO}/redfish/v1/Chassis/1/MezzFrus/{@mezzId}/Details -i --insecure -L

{
  "Type": "HpMezzFru.1.0.1",
  "Preamble":{
    "Model": "Synergy 4820C 10/20/25Gb CNA",
    "LastModified": "2018-03-29",
    "FactoryTimeStamp": "2019-11-29T02:04:57+0000",
    "EEPROMSize": 16384,
    "Language": "en-US",
    "HwCompliance":[
      "PCI"
    ],
    "GreenFactor":[],
    "FruType": "Mezz",
    "FruSubType":[
      "Ethernet",
      "IpmiSegment"
    ],
    "CommType":[
      "DCI",
      "RIS",
      "iLO"
    ]
  },
  "IpmiProductInfo":{
    "Manufacturer": "HPE",
    "ManufacturedFor": "HPE",
    "SerialNumber": "<SerialNumber>",
    "PartNumber": "<PartNumber>",
    "PCASerialNumber": "<PCASerialNumber>",
    "PCASparePartNumber": "<PCASparePartNumber>",
    "AssemblyPartNumber": "<AssemblyPartNumber>",
    "BoardRevCode": "0A"
  },
  "PowerInfo":{
    "FullOn": 13,
    "LowMode": 11,
    "Vaux": 6
  },
  "MezzInfo":{
    "CardType": "C",
    "Capabilities":{
      "EkeyMismatch": "DisableOnReboot",
      "EkeyGroupMatchReq":[],
      "EkeyPortToAirIsOk": true,
      "ScanChainSupport": true,
      "PortSwap": true,
      "LLSupport": false,
      "LinkInfo":{"LType": "PCIe", "LWidth":["16x" ], "LReverse": true},
      "ESwitchSupport": false,
      "CLPSupport": false
    },
    "PortMap":[
      {
        "ConnName": "System",
        "ConnType":[
          "Copper"
        ],
        "SysToPort":[
          {
            "PrName": "Flex10",
            "PrSp": 10,
            "PinSp": 10,
            "Capabilities":[
              {"Pin":["0..15" ], "PrName": "Flex10-1"},
              {"Pin":["0..15" ], "PrName": "Flex10-3"}
            ]
          },
          {
            "PrName": "Flex20",
            "PrSp": 20,
            "PinSp": 10,
            "Capabilities":[
              {"Pin":["0..15" ], "PrName": "Flex20-1:2"},
              {"Pin":["0..15" ], "PrName": "Flex20-3:4"}
            ]
          },
          {
            "PrName": "Flex25",
            "PrSp": 25,
            "PinSp": 25,
            "Capabilities":[
              {"Pin":["0..15" ], "PrName": "Flex25-1"},
              {"Pin":["0..15" ], "PrName": "Flex25-3"}
            ]
          }
        ]
      },
      {
        "ConnName": "Fabric",
        "ConnType":["Copper"],
        "MediaInfo":[
          {"MediaId": 1, "MAC": "94:40:c9:5b:34:76"},
          {"MediaId": 2, "WwpnPrefix": "20:00:"},
          {"MediaId": 3, "WwnnPrefix": "10:00:"}
        ],
        "PortToFabric":[
          {
            "PortId": 1,
            "Personality":[
              {
                "TechType": "Ethernet",
                "SubType":["Ethernet", "iSCSI", "FCoE"],
                "SerdesType": "FF",
                "Capabilities":[
                  {"PrType": "Ethernet", "PrName": "Flex10-1", "PrSp": 10, "PinSp": 10},
                  {"PrType": "Ethernet", "PrName": "Flex20-1:2", "PrSp": 20, "PinSp": 10},
                  {"PrType": "Ethernet", "PrName": "Flex25-1", "PrSp": 25, "PinSp": 25},
                  {"PrType": "iSCSI", "PrName": "Flex10-1", "PrSp": 10, "PinSp": 10},
                  {"PrType": "iSCSI", "PrName": "Flex20-1:2", "PrSp": 20, "PinSp": 10},
                  {"PrType": "iSCSI", "PrName": "Flex25-1", "PrSp": 25, "PinSp": 25},
                  {"PrType": "FCoE", "PrName": "Flex10-1", "PrSp": 10, "PinSp": 10},
                  {"PrType": "FCoE", "PrName": "Flex20-1:2", "PrSp": 20, "PinSp": 10},
                  {"PrType": "FCoE", "PrName": "Flex25-1", "PrSp": 25, "PinSp": 25}
                ]
              }
            ]
          },
          {
            "PortId": 2,
            "Personality":[
              {
                "TechType": "Ethernet",
                "SubType":["Ethernet", "iSCSI", "FCoE"],
                "SerdesType": "FF",
                "Capabilities":[
                  {"PrType": "Ethernet", "PrName": "Flex10-3", "PrSp": 10, "PinSp": 10},
                  {"PrType": "Ethernet", "PrName": "Flex20-3:4", "PrSp": 20, "PinSp": 10},
                  {"PrType": "Ethernet", "PrName": "Flex25-3", "PrSp": 25, "PinSp": 25},
                  {"PrType": "iSCSI", "PrName": "Flex10-3", "PrSp": 10, "PinSp": 10},
                  {"PrType": "iSCSI", "PrName": "Flex20-3:4", "PrSp": 20, "PinSp": 10},
                  {"PrType": "iSCSI", "PrName": "Flex25-3", "PrSp": 25, "PinSp": 25},
                  {"PrType": "FCoE", "PrName": "Flex10-3", "PrSp": 10, "PinSp": 10},
                  {"PrType": "FCoE", "PrName": "Flex20-3:4", "PrSp": 20, "PinSp": 10},
                  {"PrType": "FCoE", "PrName": "Flex25-3", "PrSp": 25, "PinSp": 25}
                ]
              }
            ]
          }
        ],
        "PortToFabricSwap":[
          {
            "PortId": 1,
            "Personality":[
              {"TechType": "Ethernet", "SubType":["Ethernet", "iSCSI", "FCoE" ], "SerdesType": "FF"}
            ]
          },
          {
            "PortId": 2,
            "Personality":[
              {
                "TechType": "Ethernet",
                "SubType":["Ethernet", "iSCSI", "FCoE"],
                "SerdesType": "FF",
                "Capabilities":[
                  {"PrType": "Ethernet", "PrName": "Flex10-3", "PrSp": 10, "PinSp": 10},
                  {"PrType": "Ethernet", "PrName": "Flex20-3:4", "PrSp": 20, "PinSp": 10},
                  {"PrType": "Ethernet", "PrName": "Flex25-3", "PrSp": 25, "PinSp": 25},
                  {"PrType": "iSCSI", "PrName": "Flex10-3", "PrSp": 10, "PinSp": 10},
                  {"PrType": "iSCSI", "PrName": "Flex20-3:4", "PrSp": 20, "PinSp": 10},
                  {"PrType": "iSCSI", "PrName": "Flex25-3", "PrSp": 25, "PinSp": 25},
                  {"PrType": "FCoE", "PrName": "Flex10-3", "PrSp": 10, "PinSp": 10},
                  {"PrType": "FCoE", "PrName": "Flex20-3:4", "PrSp": 20, "PinSp": 10},
                  {"PrType": "FCoE", "PrName": "Flex25-3", "PrSp": 25, "PinSp": 25}
                ]
              }
            ]
          }
        ]
      }
    ]
  }
}

Logging

iLO 5 features a logging service that enables you to view logs of different categories. These logs are of the following types - Security Logs (SL), Integrated Management Logs (IML), iLO Event Logs (IEL), Alert Event Logs, and DPU Logs. All of these logs are part of the #LogServices resource type. The entry point for the SL, IML, and Alert Event logs is at /redfish/v1/systems/{item}/logservices. The entry point for the IEL is at /redfish/v1/managers/{item}/logservices.

Security Logs

The Security Logs provide a record of the security events recorded by the iLO firmware. Examples of the logged events include changes to the security configuration and security compliance issues. Other logged events include hardware intrusion, maintenance, and denial of service. The security logs provide a focused view of all recorded security events. When the security log is full, the new events overwrite the previous event in the log.

Accessing SLs through Redfish

To access the Redfish SL resource, perform GET on /redfish/v1/Systems/1/LogServices/SL/. This resource includes a link to the collection of entries /redfish/v1/Systems/1/LogServices/SL/Entries/ and an action /redfish/v1/Systems/1/LogServices/SL/Actions/LogService.ClearLog to clear the SLs. Individual SLs can be accessed by performing GET on /redfish/v1/Systems/1/LogServices/SL/Entries/{@SlId}.

> curl https://{iLO}/redfish/v1/systems/1/logservices/sl/entries/{SlId} -i --insecure -L

{
    "@odata.context": "/redfish/v1/$metadata#LogEntry.LogEntry",
    "@odata.etag": "W/\"89680635\"",
    "@odata.id": "/redfish/v1/Systems/1/LogServices/SL/Entries/3",
    "@odata.type": "#LogEntry.v1_1_0.LogEntry",
    "Id": "3",
    "Created": "2020-01-08T11:15:41Z",
    "EntryType": "Oem",
    "Message": "iLO detected 3 unauthorized login attempts.",
    "Name": "Security Log",
    "Oem": {
        "Hpe": {
            "@odata.context": "/redfish/v1/$metadata#HpeLogEntry.HpeLogEntry",
            "@odata.type": "#HpeLogEntry.v2_3_0.HpeLogEntry",
            "Categories": [
                "Security",
                "Administration"
            ],
            "Class": 56,
            "ClassDescription": "Denial of Service",
            "Code": 2,
            "Count": 1,
            "EventNumber": 3,
            "Severity": "Informational",
            "Updated": "2020-01-08T11:15:41Z",
            "UserAction": "Not Applicable"
        }
    },
    "OemRecordFormat": "Hpe-SL",
    "Severity": "OK"
}

Clearing SLs through Redfish Action

To completely clear all SLs, perform POST on https://{iLOIP}/redfish/v1/systems/1/logservices/sl/Actions/LogService.ClearLog.

NOTE: Cleared SLs will be available in the server AHS logs.

Integrated Management Log

The IML provides a record of historical events that have occurred on the server. Events are generated by the system ROM and by services such as the iLO drivers. Logged events include server-specific information such as health and status information, firmware updates, operating system information, and ROM-based POST codes. Entries in the IML can help you diagnose issues or identify potential issues. Preventative action might help to avoid disruption of service. When the IML is full, new events overwrite the previous event in the log.

Examples of IML event types

Accessing IMLs through Redfish

To access the Redfish IML resource, perform GET on /redfish/v1/Systems/1/LogServices/IML/. This resource includes a link to the collection of entries /redfish/v1/Systems/1/LogServices/IML/Entries/ and an action LogService.ClearLog to clear the IMLs. Individual IMLs can be accessed by performing GET on /redfish/v1/Systems/1/LogServices/IML/Entries/{@ImlId}.

> curl https://{iLO}/redfish/v1/systems/1/logservices/iml/entries/{ImlId} -i --insecure -L

{
    "@odata.context": "/redfish/v1/$metadata#LogEntry.LogEntry",
    "@odata.etag": "W/\"C18B58CC\"",
    "@odata.id": "/redfish/v1/Systems/1/LogServices/IML/Entries/1",
    "@odata.type": "#LogEntry.v1_1_0.LogEntry",
    "Id": "1",
    "Created": "0000-00-00T00:00:00Z",
    "EntryType": "Oem",
    "Message": "IML Cleared (iLO user: admin)",
    "Name": "Integrated Management Log",
    "Oem": {
        "Hpe": {
            "@odata.context": "/redfish/v1/$metadata#HpeLogEntry.HpeLogEntry",
            "@odata.type": "#HpeLogEntry.v2_3_0.HpeLogEntry",
            "Categories": [
                "Maintenance",
                "Administration"
            ],
            "Class": 33,
            "ClassDescription": "Maintenance",
            "Code": 1,
            "Count": 1,
            "EventNumber": 51,
            "Severity": "Informational",
            "Updated": "0000-00-00T00:00:00Z"
        }
    },
    "OemRecordFormat": "Hpe-IML",
    "Severity": "OK"
}

Repairing IMLs through Redfish PATCH

To manually mark an IML event as repaired, perform a PATCH on https://{iLOIP}/redfish/v1/systems/1/logservices/iml/entries/{ImlId}. This is only supported on events that are of severity Caution or Critical.

NOTE: When events are manually marked as repaired, SNMP or REST alerts are not notified.

PATCH /redfish/v1/systems/1/logservices/iml/entries/{ImlId}

{
    "Oem" : {
        "Hpe" : {
            "Repaired" : true
        }
    }
}

Clearing IMLs through Redfish Action

To completely clear all IMLs, perform POST on https://{iLOIP}/redfish/v1/systems/1/logservices/iml/Actions/LogService.ClearLog.

NOTE: Cleared IMLs are available in the server AHS logs.

iLO Event Log

The iLO Event Log provides a record of significant events recorded by the iLO firmware. Examples of the logged events include server events such as a server power outage or a server reset. Other logged events include logins, virtual power events, clearing the log, and some configuration changes. iLO provides secure password encryption, tracking all login attempts and maintaining a record of all login failures. The Authentication Failure Logging setting allows you to configure logging criteria for failed authentications. The event log captures the client name for each logged entry to improve auditing capabilities in DHCP environments, and records the account name, computer name, and IP address. When the event log is full, each new event overwrites the oldest event in the log. For a list of the errors that might appear in the event log, see the error messages guide for your server.

Accessing IELs through Redfish

To access the Redfish IEL resource, perform GET on /redfish/v1/Managers/1/LogServices/IEL/. This resource includes a link to the collection of entries /redfish/v1/Managers/1/LogServices/IEL/Entries/ and an action /redfish/v1/Managers/1/LogServices/IEL/Actions/LogService.ClearLog to clear the IELs. Individual IELs can be accessed by performing GET on /redfish/v1/Managers/1/LogServices/IEL/Entries/{@IelId}.

> curl https://{iLO}/redfish/v1/managers/1/logservices/iel/entries/{IelId} -i --insecure -L

{
    "@odata.context": "/redfish/v1/$metadata#LogEntry.LogEntry",
    "@odata.etag": "W/\"C1EEC71D\"",
    "@odata.id": "/redfish/v1/Managers/1/LogServices/IEL/Entries/1",
    "@odata.type": "#LogEntry.v1_1_0.LogEntry",
    "Id": "1",
    "Created": "2022-02-25T05:13:01Z",
    "EntryType": "Oem",
    "Message": "Host REST login: System Administrator",
    "Name": "iLO Event Log",
    "Oem": {
        "Hpe": {
            "@odata.context": "/redfish/v1/$metadata#HpeLogEntry.HpeLogEntry",
            "@odata.type": "#HpeLogEntry.v2_3_0.HpeLogEntry",
            "Categories": [
                "Security",
                "Administration"
            ],
            "Class": 35,
            "ClassDescription": "iLO 5",
            "Code": 1131,
            "Count": 11,
            "EventNumber": 256407,
            "Severity": "Informational",
            "Updated": "2022-02-25T05:13:11Z"
        }
    },
    "OemRecordFormat": "Hpe-iLOEventLog",
    "Severity": "OK"
}

Clearing IELs through Redfish Action

To completely clear all IELs, perform POST on https://{iLOIP}/redfish/v1/managers/1/logservices/iel/Actions/LogService.ClearLog.

NOTE: Cleared IELs will still be present in the server AHS logs.

Alert Event Log

The Entries under API - /redfish/v1/Systems/{item}/LogServices/Event/Entries list alerts in iLO. In general, clients can choose to asynchronously receive events by Subscribing to Event. Alerts are specifically those event entries having EventType as Alert, and they can be accessed synchronously by performing GET on /redfish/v1/Systems/{item}/LogServices/Event/Entries (without subscribing).

As of iLO 5 v2.70, these alerts are non-persistent, meaning that after an iLO reset, the count of /Event/Entries resets to 0, and only the new alerts generated after the iLO reset are logged to this collection. iLO can store up to 256 REST alerts (no life cycle events will be stored) in a rolling buffer mechanism. These alerts can also be cleared by performing POST on /redfish/v1/Systems/1/LogServices/Event/Actions/LogService.ClearLog/.

Following information will only be stored/retrieved and presented in JSON format as an API response:

The Properties from EventID to MessageArgs are all under the LogEntry schema, while ServiceEvent is a new OEM property defined with iLO 5 firmware v2.70.

Accessing Alert Event Log through Redfish

To access the Redfish Alert Event Log resource, perform GET on /redfish/v1/Systems/1/LogServices/Event/. This resource includes a link to the collection of entries /redfish/v1/Systems/1/LogServices/Event/Entries and an action /redfish/v1/Systems/1/LogServices/Event/Actions/LogService.ClearLog/ to clear the Alert Event Logs. Individual Alert Event Logs can be accessed by performing GET on /redfish/v1/Systems/1/LogServices/Event/Entries/{@entriesId}.

GET /redfish/v1/Systems/1/LogService/Event/Entries/24

{
    "@odata.context": "/redfish/v1/$metadata#LogEntry.LogEntry",
    "@odata.id": "/redfish/v1/Systems/1/LogServices/Event/Entries/24/",
    "@odata.type": "#LogEntry.v1_11_0.LogEntry",
    "Id": "24",
    "Created": "2022-08-01T00:05:59Z",
    "EntryType": "Oem",
    "EventId": "3f4b0657-6612-5c36-d2fa-d747682c8c8b",
    "EventTimestamp": "2022-08-01T00:05:59Z",
    "Links": {
       "OriginOfCondition": {
          "@odata.id": "/redfish/v1/Chassis/2/Thermal#Fans/0/"
        }
    },
    "MessageArgs": [
          "1"
        ],
    "MessageId": "iLOEvents.3.7.FanFailed",
    "Name": "Event",
    "Oem": {
        "Hpe": {
          "@odata.context": "/redfish/v1/$metadata#HpeLogEntry.HpeLogEntry",
          "@odata.type": "#HpeLogEntry.v2_4_0.HpeLogEntry",
          "ServiceEvent": "True"
        }
    },
    "OemRecordFormat": "Hpe-Event",
    "Severity": "Critical"
  }

Clearing Alert Event Log through Redfish Action

To completely clear all Alert Event Logs, perform POST on https://{iLOIP}/redfish/v1/Systems/1/LogServices/Event/Actions/LogService.ClearLog/.

DPU Log

DPU devices maintain a separate resource tree (i.e. /redfish/v1/systems/2) and all sub-resources are listed under it. One of these sub-resources is the DPU Management Logs resource - /redfish/v1/systems/2/LogServices/DPU. The DPU Management logs provide a record of historical events that have occurred on the DPU. Logged events include DPU-specific information such as health and status information, firmware updates, configuration changes etc. Entries in the DPU can help you diagnose issues or identify potential issues. Preventative action might help to avoid disruption of service. When the DPU Log entry collection is full, new events overwrite the previous event in the log.

Accessing DPU Log through Redfish

To access the Redfish DPU Log resource, perform GET on /redfish/v1/Systems/2/LogServices/DPU/. This resource includes a link to the collection of entries /redfish/v1/Systems/2/LogServices/DPU/Entries and an action /redfish/v1/Systems/2/LogServices/DPU/Actions/LogService.ClearLog/ to clear the DPU Logs. Individual DPU Log can be accessed by performing GET on /redfish/v1/Systems/2/LogServices/DPU/Entries/{@entriesId}.

GET /redfish/v1/Systems/2/LogServices/DPU/Entries/1

{
    "@odata.context": "/redfish/v1/$metadata#LogEntry.LogEntry",
    "@odata.etag": "W/\"D92B34AC\"",
    "@odata.id": "/redfish/v1/Systems/2/LogServices/DPU/Entries/1",
    "@odata.type": "#LogEntry.v1_11_0.LogEntry",
    "Id": "1",
    "Created": "2021-06-10T08:08:42Z",
    "EntryType": "Oem",
    "Message": "DPU Log cleared by: Administrator",
    "Name": "DPU Log",
    "Severity": "OK"
}

Clearing DPU Log through Redfish Action

To completely clear all DPU Logs, perform POST on https://{iLOIP}/redfish/v1/Systems/2/LogServices/DPU/Actions/LogService.ClearLog/.

Serial interface

The Redfish serial interface resource lists physical serial interfaces that allow access to iLO. It allows administrators to configure the baud rate and enable or disable serial access to iLO Command line interface using server physical serial port.

Accessing serial interfaces resource through Redfish

To access the Redfish serial interfaces resource, perform GET on /redfish/v1/Managers/1/SerialInterfaces/. This collection resource includes links to the serial interface members /redfish/v1/Managers/1/SerialInterfaces/{serialInterfaceId}.

Viewing serial interface configuration

To view configuration information on a specific member from the serial interfaces collection, perform GET on /redfish/v1/Managers/1/SerialInterfaces/{serialInterfaceId}. This resource provides configurable information on the following:

Property Type Description
InterfaceEnabled Boolean An indication of whether this interface is enabled
BitRate Enum (Bitrate) The receive and transmit rate of data flow, typically in bits per second (bit/s), over the serial connection

The Bitrate enum can take the following values - "9600", "19200", "38400", "57600", "115200"

> curl https://{iLO}/redfish/v1/Managers/1/SerialInterfaces/{serialInterfaceId} -i --insecure -L

{
    "@odata.context": "/redfish/v1/$metadata#SerialInterface.SerialInterface",
    "@odata.etag": "W/\"0CFA12DC\"",
    "@odata.id": "/redfish/v1/Managers/1/SerialInterfaces/1",
    "@odata.type": "#SerialInterface.v1_1_7.SerialInterface",
    "Id": "1",
    "BitRate": "115200",
    "Description" : "Serial Interface",
    "InterfaceEnabled" : true,
    "Name" : "SerialInterface"
}

Configuring serial interface through Redfish PATCH

To modify the serial interface configuration, perform a PATCH on /redfish/v1/Managers/1/SerialInterfaces/{serialInterfaceId}.

PATCH /redfish/v1/Managers/1/SerialInterfaces/{serialInterfaceId}

{
    "InterfaceEnabled" : true,
    "BitRate" : "9600"
}

HPE Persistent Memory Configuration

Configuration of HPE Persistent Memory featuring Intel Optane persistent memory modules (PMM) uses the Redfish MemoryChunk, MemoryDomain, and TaskService to manage goal configurations. Please note that the HPE RESTful Interface tool v2.5.0 provides commands for inventory and configuration of PMMs. The new HPE Persistent Memory Management Utility provides a graphical experience for managing PMMs. Both tools use the iLO RESTful API, but add a layer of abstraction for the user.

Concepts and Terms

Term Definition
Interleave Set A group of Memory Regions that are interleaved together. Represented by a MemoryChunk in Redfish.
Memory Chunk A Memory Chunk is a group of one or more regions. The chunk represents an interleave set. Memory Domains and Chunks will ONLY be reported for Persistent Regions. Volatile Regions will be treated just like DIMMs with no such data reported.
Memory Domain Memory Domains are used to indicate to the client which Memory (DIMMs) can be grouped together in Memory Chunks to form interleave sets or otherwise grouped together. Informational only, not configurable.
Memory Region A region is a portion of a DIMM of a specific size and mode. A DIMM can have one or more regions. Regions can be the same or different mode on a DIMM.
Namespace For PMM, this is a device made available in filesystem (OS) source.

Overview

To create a MemoryChunk and Regions required, POST a MemoryChunk to the MemoryChunkCollection in a specific MemoryDomain. In the POST, list the DIMMs that should be included in MemorySet for the MemoryChunk, based on the InterleavableMemorySets in the MemoryDomain. All DIMMs on the socket related to the MemoryDomain must be configured in a MemoryChunk in order for the configuration to succeed.

To delete a MemoryChunk, DELETE the MemoryChunk from the MemoryChunkCollection. Deleting a MemoryChunk will result in the corresponding memory region being set to volatile memory.

POST will only be supported for persistent Memory Chunks. Remaining capacity will be configured as volatile. Only persistent Memory Chunks will be reported in the system, since volatile interleaving is not reported for standard DIMMs.

Only one Interleaved MemoryChunk is supported, and that Interleaved MemoryChunk must include all DIMMs on that socket. This matches what is specified in the MemoryDomain’s InterleavableMemorySets. If several POST requests are issued to configure multiple Interleaved MemoryChunks on a socket, iLO will reject the POST. iLO ensures all CPU installed PMMs are included in the memory set for a POST that is creating an interleaved Memory Chunk. This also checks for duplicate DIMM entries.

Memory Population Violations

If the memory population rules are violated, then configuration through the iLO RESTful API is not supported. Configuration may fail or have unexpected results.

MemoryChunk POST properties

Note: The values specified by MemoryChunkSizeMiB or MemoryChunkSizePercentage must be the same across all POST requests on a given socket (Memory Domain).

Example MemoryChunk POST

The example below is a POST body for creating a MemoryChunk using the MemoryChunkSizePercentage property. The PMMs on processor 1 in slots 6 and 7 will be interleaved and provisioned to 50% persistent memory (App Direct) mode. The remaining 50% is set to volatile (memory) mode.

POST /redfish/v1/Systems/1/MemoryDomains/PROC1MemoryDomain/MemoryChunks/

{
    "AddressRangeType": "PMEM",
    "Oem": {
       "Hpe": {
          "MemoryChunkSizePercentage": 50
       }    
    },
    "InterleaveSets": [
       {
          "Memory" : { "@odata.id": "/redfish/v1/Systems/1/Memory/proc1dimm6/"}
       },
       {
          "Memory" : { "@odata.id": "/redfish/v1/Systems/1/Memory/proc1dimm7/"}
       }
    ]
}

Configuration Tasks

Since the POST and DELETE modifications to the MemoryChunks are applied on system reboot, iLO will create a Task for each request. The Tasks are managed by the TaskService. On success, the POST and DELETE responses will include information about the corresponding Task. All the staged Tasks will be provided to BIOS on reboot. BIOS will process all the Tasks, in order, to create new Goal Configurations for each impacted PMMs. If Goal Configurations cannot be created, then ALL of the Tasks will fail, and the Task status will report the reason for the failure. PATCH to the MemoryChunk is not supported, so reconfiguration of existing configurations must first DELETE the existing MemoryChunks before creating a new configuration.

Example response to a MemoryChunk POST:

Status: 202 Accepted

{
    "@odata.context": "/redfish/v1/$metadata#Task.Task",
    "@odata.etag": "W/\"D793BCE6\"",
    "@odata.id": "/redfish/v1/TaskService/Tasks/1545/",
    "@odata.type": "#Task.v1_3_0.Task",
    "Id": "1545",
    "Description": "iLO Task",
    "Messages": [
        {}
    ],
    "Name": "Task 1545",
    "Payload": {
        "HttpOperation": "POST",
        "JsonBody": "{\"AddressRangeType\":\"PMEM\",\"InterleaveSets\":[{\"Memory\":{\"@odata.id\":\"/redfish/v1/Systems/1/Memory/proc1dimm6/\"}},{\"Memory\":{\"@odata.id\":\"/redfish/v1/Systems/1/Memory/proc1dimm7/\"}}],\"Oem\":{\"Hpe\":{\"MemoryChunkSizePercentage\":100}}}",
        "TargetUri": "/redfish/v1/Systems/1/MemoryDomains/PROC1MemoryDomain/MemoryChunks/"
    },
    "StartTime": "2019-03-06T16:18:50Z",
    "TaskMonitor": "/redfish/v1/TaskService/TaskMonitors/1545/",
    "TaskState": "New"
}

POST and Task limits

iLO will limit the total number of Tasks to a minimum of 192.

Configuration Sequencing

The intent of configuration will only be inferred from the sequence in which the requests are made. As such, any DELETE requests must precede any POST requests relating to MemoryDomains on the same socket. A DELETE request and a POST request may be performed in the same reboot, as long as they follow this rule.

Example 1: Reconfigure to Change Interleaving

Start: Example configuration is two PMMs, A1 and A2, of 16 GiB each on a single socket on the same memory controller. There are two existing MemoryChunks, MC1 and MC2, for 100% persistent memory non-interleaved.

Goal: Reconfigure these two PMMs to be 100% persistent memory interleaved.

Solution: The client would first issue a DELETE request on MC1 and a separate DELETE request on MC2. This would create two New Tasks in the TaskService. The client would then issue a POST request on the MemoryDomain’s Memory Chunk Collection. The POST body includes DIMMs A1 and A2 in the corresponding InterleaveSets with an Oem.Hpe.MemoryChunkSizePercentage of 100% or a MemoryChunkSizeMiB of 32GiB. This would result in three New Tasks in the TaskService queue to be consumed on reboot. See details steps below:

  1. Delete MC1.

DELETE /redfish/v1/Systems/1/MemoryDomains/PROC1MemoryDomain/MemoryChunks/MC1

  1. Delete MC2.

DELETE /redfish/v1/Systems/1/MemoryDomains/PROC1MemoryDomain/MemoryChunks/MC2

  1. Create new configuration: Option 1 using MemoryChunkSizePercentage

POST /redfish/v1/Systems/1/MemoryDomains/PROC1MemoryDomain/MemoryChunks

   {
       "AddressRangeType": "PMEM",
       "Oem": {
           "Hpe": {
               "MemoryChunkSizePercentage": 100
           }
       },
       "InterleaveSets": [
          {
               "Memory": {
                   "@odata.id": "/redfish/v1/Systems/1/Memory/A1/"
            }
           },
           {
               "Memory": {
                   "@odata.id": "/redfish/v1/Systems/1/Memory/A2/"
               }
           }
       ]
   }
  1. Create new configuration: Option 2 using MemoryChunkSizeMiB

POST /redfish/v1/Systems/1/MemoryDomains/PROC1MemoryDomain/MemoryChunks

   {
       "AddressRangeType": "PMEM",
       "MemoryChunkSizeMiB": 32768,
       "InterleaveSets": [
          {
               "Memory": {
                   "@odata.id": "/redfish/v1/Systems/1/Memory/A1/"
            }
           },
           {
               "Memory": {
                   "@odata.id": "/redfish/v1/Systems/1/Memory/A2/"
               }
           }
       ]
   }
  1. Reboot system to apply changes staged in iLO as Tasks.

Example 2: Reconfigure to change Memory Provisioning on Two-Socket System

Start: Example configuration is two PMMs, A1 and A2, of 16GiB each on a single socket on the same memory controller. There are two existing MemoryChunks, MC1 and MC2, for 100% persistent memory non-interleaved. Also, two PMMs, B1 and B2, of 16GiB each on a single socket (separate than A1 and A2) on the same memory controller with two existing MemoryChunks, MC3 and MC4, for 100% persistent memory non-interleaved.

Goal: Reconfigure these four PMMs to be 50% persistent memory non-interleaved. The remaining 50% is volatile (memory mode).

Solution: The client would first issue separate DELETE requests on MC1, MC2, MC3, and MC4. This would create four New Tasks in the TaskService. The client would then issue a POST request on the Memory Chunk Collection of the MemoryDomain corresponding to A1 with A1 in the corresponding InterleaveSets and an Oem.Hpe.MemoryChunkSizePercentage of 50% or a MemoryChunkSizeMiB of 16GiB. The client would repeat this POST request on the MemoryDomains corresponding to A2, B1, and B2 with each of those respective DIMMs in their own InterleaveSets. This would result in eight New Tasks in the TaskService queue that would be consumed on reboot. See detailed steps below:

  1. Delete MC1.

DELETE /redfish/v1/Systems/1/MemoryDomains/PROC1MemoryDomain/MemoryChunks/MC1

  1. Delete MC2.

DELETE /redfish/v1/Systems/1/MemoryDomains/PROC1MemoryDomain/MemoryChunks/MC2

  1. Delete MC3.

DELETE /redfish/v1/Systems/1/MemoryDomains/PROC2MemoryDomain/MemoryChunks/MC3

  1. Delete MC4.

DELETE /redfish/v1/Systems/1/MemoryDomains/PROC2MemoryDomain/MemoryChunks/MC4

  1. Create new configuration using MemoryChunkSizePercentage for A1.

POST /redfish/v1/Systems/1/MemoryDomains/PROC1MemoryDomain/MemoryChunks

   {
       "AddressRangeType": "PMEM",
       "Oem": {
           "Hpe": {
               "MemoryChunkSizePercentage": 50
           }
       },
       "InterleaveSets": [
            {
               "Memory": {
                   "@odata.id": "/redfish/v1/Systems/1/Memory/A1/"
               }
           }
       ]
   }
  1. Create new configuration using MemoryChunkSizePercentage for A2.

POST /redfish/v1/Systems/1/MemoryDomains/PROC1MemoryDomain/MemoryChunks

   {
       "AddressRangeType": "PMEM",
       "Oem": {
           "Hpe": {
               "MemoryChunkSizePercentage": 50
           }
       },
       "InterleaveSets": [
            {
               "Memory": {
                   "@odata.id": "/redfish/v1/Systems/1/Memory/A2/"
               }
           }
       ]
   }
  1. Create new configuration using MemoryChunkSizePercentage for B1.

POST /redfish/v1/Systems/1/MemoryDomains/PROC2MemoryDomain/MemoryChunks

   {
       "AddressRangeType": "PMEM",
       "Oem": {
           "Hpe": {
               "MemoryChunkSizePercentage": 50
           }
       },
       "InterleaveSets": [
            {
               "Memory": {
                   "@odata.id": "/redfish/v1/Systems/1/Memory/B1/"
               }
           }
       ]
   }
  1. Create new configuration using MemoryChunkSizePercentage for B2.

POST /redfish/v1/Systems/1/MemoryDomains/PROC2MemoryDomain/MemoryChunks

   {
       "AddressRangeType": "PMEM",
       "Oem": {
           "Hpe": {
               "MemoryChunkSizePercentage": 50
           }
       },
       "InterleaveSets": [
            {
               "Memory": {
                   "@odata.id": "/redfish/v1/Systems/1/Memory/B2/"
               }
           }
       ]
   }
  1. Reboot system to apply changes staged in iLO as Tasks.

Managing Apollo Drive Bay Mapping

The HPE Apollo 2000 System with the HPE Apollo r2800 Chassis (including the Storage Expander Backplane) supports 24 SFF HPE SmartDrives. The SFF drive bays can be assigned to specific server nodes.

CAUTION: Changing the drive bay mapping configuration might cause data loss or data corruption. For example, consider a configuration with drive bays two through seven assigned to node 1, with the drives configured as a RAID0 volume. Data corruption might occur if you change the drive bay mapping so that the configured drives are no longer available.

Prerequisites

Getting host port topology details

The HostPortsInfo JSON object displays the node number and SAS controller associated with each server host port. Before you change the drive bay mapping, HPE recommends using the following REST API to view and understand the PortNumber mapping:

GET /redfish/v1/Chassis/1/AccHddService

This action returns the HostPortsInfo JSON object.

{
    "HostPortsInfo": [
        {
            "NodeNumber": 1,
            "PortNumber": 1,
            "SlotNumber": 1
        },
        {
            "NodeNumber": 2,
            "PortNumber": 2,
            "SlotNumber": 1
        },
        {
            "NodeNumber": 3,
            "PortNumber": 3,
            "SlotNumber": 1
        },
        {
            "NodeNumber": 4,
            "PortNumber": 4,
            "SlotNumber": 1
        }
    ]
}

Getting current and pending drive bay mapping

GET /redfish/v1/Chassis/1/AccHddService/zone

This action returns the CurrentZoneConfiguration and PendingZoneConfiguration JSON objects.

The CurrentZoneConfiguration JSON object displays the current drive bay mapping in the chassis.

{
    "CurrentZoneConfiguration": {
        "HostPort": [
            {
                "BayNumber": [ 1, 2, 3, 4, 5, 6 ],
                "PortNumber": 1
            },
            {
                "BayNumber": [ 7, 8, 9, 10, 11, 12 ],
                "PortNumber": 2
            },
            {
                "BayNumber": [ 13, 14, 15, 16, 17, 18 ],
                "PortNumber": 3
            },
            {
                "BayNumber": [ 19, 20, 21, 22, 23, 24 ],
                "PortNumber": 4
            },
            {
                "PortNumber": null
            }
        ]
    }
}

Note: The value PortNumber null indicates that a drive bay is not assigned.

The PendingZoneConfiguration JSON object displays the pending drive bay mapping configuration. This configuration will not be applied until all nodes remain powered off for at least 5 seconds.

{
    "PendingZoneConfiguration": {
        "HostPort": [
            {
                "BayNumber": [ 1, 2, 3, 4 ],
                "PortNumber": 1
            },
            {
                "BayNumber": [ 7, 8, 9, 10 ],
                "PortNumber": 2
            },
            {
                "BayNumber": [ 13, 14, 15, 16 ],
                "PortNumber": 3
            },
            {
                "BayNumber": [ 19, 20, 21, 22 ],
                "PortNumber": 4
            },
            {
                "BayNumber": [ 5, 6, 11, 12, 17, 18, 23, 24 ],
                "PortNumber": null
            }
        ]
    }
}

Note: The value PortNumber null indicates that a drive bay is not assigned.

Configuring drive bay mapping

You can make drive bay mapping configuration changes from any server node. The changes take effect when all server nodes in the Apollo 2000 system chassis are powered off and the Chassis firmware is able to reset the Storage Expander backplane. All nodes must remain powered off for at least 5 seconds after you initiate the configuration change.

The following example shows three drive bays assigned to each node.

POST /redfish/v1/Chassis/1/AccHddService/Zone/Actions/HpeServerAccHddZone.ConfigureZone

{
    "HostPort": [
      {
        "BayNumber": [
          1,
          2,
          3
        ],
        "PortNumber": 1
      },
      {
        "BayNumber": [
          7,
          8,
          9
        ],
        "PortNumber": 2
      },
      {
        "BayNumber": [
          13,
          14,
          15
        ],
        "PortNumber": 3
      },
      {
        "BayNumber": [
          19,
          20,
          21
        ],
        "PortNumber": 4
      }
    ]
}

This action returns a response indicating that all server nodes in the chassis must remain powered off for at least 5 seconds for the changes to take effect.

{
    "error": {
        "code": "iLO.0.10.ExtendedInfo",
        "message": "See @Message.ExtendedInfo for more information.",
        "@Message.ExtendedInfo": [
            {
                "MessageId": "iLO.2.9.ChassisResetRequired"
            }
        ]
    }
}

Setting drive bay mapping to the default configuration

The default configuration divides the 24 SFF drive bays by the number of server host ports in the Apollo 2000 Chassis. In a configuration with four 1U servers, the default drive bay configuration is six drive bays allocated to each of the four server slots. In a configuration with two 2U servers, the default drive bay configuration is 12 drive bays allocated to each of the two server slots.

POST an empty JSON object to URI to set drive bay mapping to the default configuration.

POST /redfish/v1/Chassis/1/AccHddService/Zone/Actions/HpeServerAccHddZone.LoadDefault

{}

This action returns a response indicating that all server nodes in the chassis must remain powered off for at least 5 seconds for the changes to take effect.

{
    "error": {
        "code": "iLO.0.10.ExtendedInfo",
        "message": "See @Message.ExtendedInfo for more information.",
        "@Message.ExtendedInfo": [
            {
                "MessageId": "iLO.2.9.ChassisResetRequired"
            }
        ]
    }
}

Error messages and registries in the iLO RESTful API

HTTP response 400

{
  "error": {
    "@Message.ExtendedInfo": [
      {
        "MessageId": "iLO.0.9.InvalidLicenseKey"
      }
    ],
    "code": "iLO.0.10.ExtendedInfo",
    "message": "See @Message.ExtendedInfo for more information."
  }
}

"InvalidLicenseKey": {
    "Description": "The license key is not valid.",
    "Message": "The license key is not valid.",
    "Severity": "Warning",
    "NumberOfArgs": 0,
    "ParamTypes": [],
    "Resolution": "Retry the operation using a valid license key."
}

Error messages appear in several places in the iLO RESTful API.

All error cases use a basic error JSON structure called ExtendedInfo. The most important property in ExtendedInfo is MessageId, a string containing a lookup key into a message registry.

MessageId helps to keep the iLO service small by keeping much of the explanatory text for an error out of the code. Instead, iLO supplies an ExtendedInfo response, where the MessageId provides enough information so that you can look up more details from another file.

For example, if you POST to the iLO license service to install an iLO license, but you supply an incorrect LicenseKey string, iLO responds with an error similar to the following:

HTTP response 400 is the standard RESTful API response to an error. In the example above, the error is easy to understand, but some errors are not easy to understand. To display a more meaningful error message, parse the string iLO.0.9.InvalidLicenseKey into the following components:

The search returns a result similar to the following:

Many error messages can also return parameters. These parameters may be plugged into the strings in the registry to form detailed messages tailored to the instance of the error message.

RESTful Events and the Event Service

iLO 5 features an event subscription service that enables you to subscribe to receive notifications when the REST data changes or when certain alerts occur. These notifications are in the form of HTTPS POST operations to a URI of your choice.

The event service is located in the data model at /redfish/v1/EventService. This resource includes a link to a collection of subscriptions (called Subscriptions located at /redfish/v1/EventService/Subscriptions).

Subscribing for Events examples

POST /redfish/v1/EventService/Subscriptions/

{
    "Destination": "https://myeventreciever/eventreceiver",
    "EventTypes": [
        "ResourceAdded",
        "ResourceRemoved",
        "ResourceUpdated",
        "StatusChange",
        "Alert"
    ],
    "HttpHeaders": {
        "Header": "HeaderValue"
    },
    "Context": "context string",
    "Oem": {
        "Hpe": {
            "DeliveryRetryIntervalInSeconds": 30,
            "RequestedMaxEventsToQueue": 20,
            "DeliveryRetryAttempts": 5,
            "RetireOldEventInMinutes": 10
        }
    }
}

In order to receive events, you must provide an HTTPS server accessible to iLO’s network with a URI you designate as the target for iLO-initiated HTTPS POST operations.

Construct a JSON object conforming to the type ListenerDestination (see example) and POST this to the collection indicated by the Subscriptions link at /redfish/v1/EventService/Subscriptions. If you receive an HTTP 201 Created response, a new subscription has been added. Note that iLO does not test the destination URI during this phase, so if the indicated URI is not valid, this will not be flagged until events are emitted and the connection to the destination fails.

Example POST payload to create a new subscription

Much of the above content depends entirely upon your needs and setup:

Consult the ListenerDestination schema for more details on each property. The subscription will automatically expire after the TTL information specified and must be renewed.

Simple Network Management Protocol

HPE iLO supports the Simple Network Management Protocol (SNMP). SNMP traps are generated by Redfish events posted in the iLO Integrated Management Logs (IML). iLO SNMP Object Identifiers (OIDs) are defined in the HPE Systems Insight Manager (SIM) MIB update kit. To cross reference an SNMP trap with REST alerts information, see the REST alerts table in the iLO 5 user guide.

SNMP configuration

SNMPv3 configuration can only be performed when the SNMP is enabled. SNMPv1 configuration can only be performed when the SNMP and the SNMPv1 are enabled.

SNMP enablement

SNMP enablement is performed by setting the SNMP/ProtocolEnabled property to true under the Redfish standard ManagerNetworkProtocol URI.

PATCH /redfish/v1/Managers/1/NetworkProtocol

{
    "SNMP": {
        "ProtocolEnabled": true
    }
}

SNMP ports configuration

The SNMP default port number (161) can be modified with a PATCH request of the SNMP/Port property under the Redfish standard ManagerNetworkProtocol URI.

The SNMP default trap port (162) can be modified with a PATCH request of the OEM/Hpe/SNMPTrapPort property under the ManagerNetworkProtocol URI.

PATCH /redfish/v1/Managers/1/NetworkProtocol

"Port": <integer>,
"Oem": {
        "Hpe": {
            "SNMPTrapPort": <integer>
        }
}

SNMPv1 enablement

SNMPv1 is enabled when the SNMPv1Enabled key is set to true, under the redfish/v1/Managers/1/SNMPServices URI. An iLO reset is required when a PATCH request is performed on that property.

PATCH /redfish/v1/Managers/1/SnmpService

{
    "SNMPv1Enabled": true,
    "SNMPv1RequestEnabled" : true,
    "SNMPv1TrapEnabled" : true

}

SNMP settings

General SNMP settings can be set in under the redfish/v1/Managers/1/SNMPServices URI.

PATCH /redfish/v1/Managers/1/SnmpService

{
    "Location": "My Location",
    "Contact": "Contact Name",
    "Role": "My role",
    "RoleDetail": "My role details",
    "ReadCommunities": [
        "communitystring1",
        "communitystring2",
        "communitystring3"
    ]
}

SNMPv3 settings

Specific SNMPv3 settings can be provided under the redfish/v1/Managers/1/SNMPServices URI.

PATCH /redfish/v1/Managers/1/SnmpService

{
    "SNMPv3EngineID": "0x8000000001020304",
    "SNMPv3InformRetryAttempt": 2,
    "SNMPv3InformRetryIntervalSeconds": 15
}

SNMP alerts

SNMP alerts properties can be set under the redfish/v1/Managers/1/SNMPServices URI.

iLO5 2.90 onwards, the following properties have been added:
- SNMPv1RequestsEnabled: Enables iLO to receive external SNMPv1 requests.
- SNMPv1TrapEnabled: Enables iLO to send SNMPv1 traps to the remote management systems configured in the alert destination.
- SNMPv3RequestsEnabled: Enables iLO to receive external SNMPv3 requests.
- SNMPv3TrapEnabled: Enables iLO to send SNMPv3 traps to the remote management systems configured in the alert destination.

NOTE:
- SNMPv1Enabled enables both SNMPv1RequestsEnabled and SNMPv1TrapEnabled.
- AlertsEnabled enables both SNMPv1TrapEnabled and SNMPv3TrapEnabled.
- Enabling either SNMPv1RequestsEnabled or SNMPv1TrapEnabled will enable SNMPv1Enabled.
- Enabling either SNMPv1TrapEnabled or SNMPv3TrapEnabled will enable AlertsEnabled.

PATCH /redfish/v1/Managers/1/SnmpService

{
    "TrapSourceHostname": "Manager",
    "AlertsEnabled": true,
    "SNMPv1Enabled": false,
    "Oem": {
        "Hpe": {
            "SNMPColdStartTrapBroadcast": false
        }
    },
    "PeriodicHSATrapConfig": "Disabled"
}

SNMP alert destinations

NOTE:
- The SNMPv1TrapEnabled option is available when SNMPv1TrapEnabled is enabled in the SNMP Alerts section.
- The SNMPv3TrapEnabled option is available when SNMPv3TrapEnabled is enabled in the SNMP Alerts section and at least one SNMPv3 user is configured.
- The SNMPv3Inform option is available when at least one SNMPv3 user is configured.

Add an SNMP alert destination with a POST request in the HpeSNMPAlertDestinationCollection URI.

POST redfish/v1/Managers/1/SnmpService/SNMPAlertDestinations

{
    "AlertDestination": "192.168.87.41",
    "SNMPAlertProtocol": "SNMPv1Trap",
    "TrapCommunity": "public"
}

SNMPv3 users

NOTE:
SNMPv3 users is available only if the SNMP Protocol is set to SNMPv3TrapEnabled or SNMPv3Inform.

SNMPv3 users can be managed under the HpeSNMPUsersCollection URI.

Add an SNMP user: POST /redfish/v1/Managers/1/SnmpService/SNMPUsers

{
    "SecurityName": "snmpuser",
    "AuthProtocol": "SHA",
    "AuthPassphrase": "myauthpassword",
    "PrivacyProtocol": "AES",
    "PrivacyPassphrase": "myPrivacyPassphrase",
    "UserEngineID": "0x8000000001020304"
}

Delete an SNMP user: DELETE /redfish/v1/Managers/1/SnmpService/SNMPUsers/2

Send test alerts

Test alerts can be sent to alert destinations using a POST request towards HpeiLOSnmpService.SendSNMPTestAlert under the redfish/v1/Managers/1/SNMPServices URI with an empty body.

POST /redfish/v1/Managers/1/SnmpService/Actions/HpeiLOSnmpService.SendSNMPTestAlert/

{}

Using the RESTful Interface Tool

Although not a requirement, you can use the RESTful Interface Tool with the RESTful API. This command line tool provides a level of abstraction and convenience above direct access to the RESTful API. For more information, see: http://www.hpe.com/info/resttool.

Client Best Practices

When developing a client for the RESTful API, be sure to not code based upon assumptions that are not guaranteed. The reason avoiding these assumptions is so important is that implementations may vary across systems and firmware versions, and we want your code to work consistently.

API Architecture

The RESTful API is a hypermedia API by design. This is to avoid building in restrictive assumptions to the data model that will make it difficult to adapt to future hardware implementations. A hypermedia API avoids these assumptions by making the data model discoverable via links between resources.

The client should not interact with a URI as if it will remain static. Only specific top-level URIs (any URI in this sample code) can be assumed as static.

All URIs, with the exception of known top-level URIs, must be discovered dynamically by following the href links in the data model. Clients should not make assumptions about the URIs for the resource members of a collection. For instance, the URI of a collection member will NOT always be /redfish/v1/.../collection/1, or 2.

Traversing the data model

Although the resources in the data model are linked together, because of cross link references between resources, a client may not assume the resource model is a tree. It is a graph instead, so any crawl of the data model should keep track of visited resources to avoid an infinite traversal loop.

A reference to another resource is any property called href (@odata.id in Redfish) no matter where it occurs in a resource.

An external reference to a resource outside the data model is referred to by a property called “extref”. Any resource referred to by extref should not be assumed to follow the conventions of the API.

HTTP POST to Create

When POSTing to create a resource (e.g. create an account or session), a successful response includes a Location HTTP header indicating the resource URI of the newly created resource. The POST may also include a representation of the newly created object in a JSON response body but may not. Do not assume the response body, but test it. It may also be an ExtendedError object.

HTTP Redirect

All clients must correctly handle HTTP redirect (for example, 308, 301, and so on.) iLO 5 will use redirection as a way to alias portions of the data model and to migrate the data model to the Redfish specified URIs (for example, /redfish/…).

Errata

EthernetInterfaces for ComputerSystem

In iLO 5 1.10, the link (@odata.id) to the EthernetInterfacesCollection is in the wrong location in the ComputerSystem resource. It should be a link directly from the root of the resource.

{
  "EthernetInterfaces": {
    "@odata.id": "<link>"
  }
}

In iLO 5 1.10 it is instead in the Hpe OEM sub-object:

{
  "Oem": {
    "Hpe": {
      "EthernetInterfaces": {
        "@odata.id": "<link>"
      }
    }
  }
}

Future iLO 5 firmware will correct this by adding the additional corrected link.

Other Web Resources

Resource Map

URI Type
/redfish/v1/ ServiceRoot
/redfish/v1/AccountService AccountService
/redfish/v1/AccountService/Accounts Collection of ManagerAccount
/redfish/v1/AccountService/Accounts/{item} ManagerAccount
/redfish/v1/AccountService/DirectoryTest HpeDirectoryTest
/redfish/v1/AccountService/ExternalAccountProviders/LDAP/Certificates Collection of Certificate
/redfish/v1/AccountService/ExternalAccountProviders/LDAP/Certificates/{item} Certificate
/redfish/v1/AccountService/Roles Collection of Role
/redfish/v1/AccountService/Roles/{item} Role
/redfish/v1/AccountService/UserCertificateMapping Collection of HpeiLOAccountCertificateMap
/redfish/v1/AccountService/UserCertificateMapping/{item} HpeiLOAccountCertificateMap
/redfish/v1/CertificateService CertificateService
/redfish/v1/CertificateService/CertificateLocations CertificateLocations
/redfish/v1/Chassis Collection of Chassis
/redfish/v1/Chassis/{item} Chassis
/redfish/v1/Chassis/{item}/AccHddService HpeServerAccHddService
/redfish/v1/Chassis/{item}/AccHddService/Zone HpeServerAccHddZone
/redfish/v1/Chassis/{item}/Devices Collection of HpeServerDevice
/redfish/v1/Chassis/{item}/Devices/{item} HpeServerDevice
/redfish/v1/Chassis/{item}/NetworkAdapters Collection of NetworkAdapter
/redfish/v1/Chassis/{item}/NetworkAdapters/{item} NetworkAdapter
/redfish/v1/Chassis/{item}/NetworkAdapters/{item}/NetworkDeviceFunctions Collection of NetworkDeviceFunction
/redfish/v1/Chassis/{item}/NetworkAdapters/{item}/NetworkDeviceFunctions/{item} NetworkDeviceFunction
/redfish/v1/Chassis/{item}/NetworkAdapters/{item}/NetworkDeviceFunctions/{item}/Settings NetworkDeviceFunction
/redfish/v1/Chassis/{item}/NetworkAdapters/{item}/NetworkPorts Collection of NetworkPort
/redfish/v1/Chassis/{item}/NetworkAdapters/{item}/NetworkPorts/{item} NetworkPort
/redfish/v1/Chassis/{item}/NetworkAdapters/{item}/NetworkPorts/{item}/HpeEVB HpeNetworkPortEVB
/redfish/v1/Chassis/{item}/NetworkAdapters/{item}/NetworkPorts/{item}/HpeLLDP HpeNetworkPortLLDP
/redfish/v1/Chassis/{item}/NetworkAdapters/{item}/NetworkPorts/{item}/Settings NetworkPort
/redfish/v1/Chassis/{item}/NetworkAdapters/{item}/Ports Collection of Port
/redfish/v1/Chassis/{item}/NetworkAdapters/{item}/Ports/{item} Port
/redfish/v1/Chassis/{item}/NetworkAdapters/{item}/Ports/{item}/Settings Port
/redfish/v1/Chassis/{item}/NetworkAdapters/{item}/Settings NetworkAdapter
/redfish/v1/Chassis/{item}/Power Power
/redfish/v1/Chassis/{item}/Power/AccPowerService HpeServerAccPowerService
/redfish/v1/Chassis/{item}/Power/AccPowerService/Calibration HpeServerAccPowerCalibration
/redfish/v1/Chassis/{item}/Power/AccPowerService/NodesInfo HpeServerAccPowerNodesInfo
/redfish/v1/Chassis/{item}/Power/AccPowerService/PowerLimit HpeServerAccPowerLimit
/redfish/v1/Chassis/{item}/Power/AccPowerService/Zone HpeServerAccPowerZone
/redfish/v1/Chassis/{item}/Power/FastPowerMeter HpePowerMeter
/redfish/v1/Chassis/{item}/Power/FederatedGroupCapping HpeiLOFederatedGroupCapping
/redfish/v1/Chassis/{item}/Power/PowerMeter HpePowerMeter
/redfish/v1/Chassis/{item}/Thermal Thermal
/redfish/v1/EventService EventService
/redfish/v1/EventService/CACertificates Collection of HpeCertificate
/redfish/v1/EventService/CACertificates/{item} HpeCertificate
/redfish/v1/EventService/Subscriptions Collection of EventDestination
/redfish/v1/EventService/Subscriptions/{item} EventDestination
/redfish/v1/JsonSchemas Collection of JsonSchemaFile
/redfish/v1/JsonSchemas/{item} JsonSchemaFile
/redfish/v1/Managers Collection of Manager
/redfish/v1/Managers/{item} Manager
/redfish/v1/Managers/{item}/ActiveHealthSystem HpeiLOActiveHealthSystem
/redfish/v1/Managers/{item}/BackupRestoreService HpeiLOBackupRestoreService
/redfish/v1/Managers/{item}/BackupRestoreService/BackupFiles Collection of HpeiLOBackupFile
/redfish/v1/Managers/{item}/BackupRestoreService/BackupFiles/{item} HpeiLOBackupFile
/redfish/v1/Managers/{item}/DateTime HpeiLODateTime
/redfish/v1/Managers/{item}/EmbeddedMedia HpeiLOEmbeddedMedia
/redfish/v1/Managers/{item}/EthernetInterfaces Collection of EthernetInterface
/redfish/v1/Managers/{item}/EthernetInterfaces/{item} EthernetInterface
/redfish/v1/Managers/{item}/FederationGroups Collection of HpeiLOFederationGroup
/redfish/v1/Managers/{item}/FederationGroups/{item} HpeiLOFederationGroup
/redfish/v1/Managers/{item}/FederationPeers Collection of HpeiLOFederationPeers
/redfish/v1/Managers/{item}/FederationPeers/{item} HpeiLOFederationPeers
/redfish/v1/Managers/{item}/HostInterfaces Collection of HostInterface
/redfish/v1/Managers/{item}/HostInterfaces/{item} HostInterface
/redfish/v1/Managers/{item}/LicenseService Collection of HpeiLOLicense
/redfish/v1/Managers/{item}/LicenseService/{item} HpeiLOLicense
/redfish/v1/Managers/{item}/LogServices Collection of LogService
/redfish/v1/Managers/{item}/LogServices/IEL LogService
/redfish/v1/Managers/{item}/LogServices/IEL/Entries Collection of LogEntry
/redfish/v1/Managers/{item}/LogServices/IEL/Entries/{item} LogEntry
/redfish/v1/Managers/{item}/NetworkProtocol ManagerNetworkProtocol
/redfish/v1/Managers/{item}/RemoteSupportService HpeRemoteSupport
/redfish/v1/Managers/{item}/RemoteSupportService/ServiceEventLogs Collection of LogEntry
/redfish/v1/Managers/{item}/RemoteSupportService/ServiceEventLogs/{item} LogEntry
/redfish/v1/Managers/{item}/SecurityService HpeSecurityService
/redfish/v1/Managers/{item}/SecurityService/AutomaticCertificateEnrollment HpeAutomaticCertEnrollment
/redfish/v1/Managers/{item}/SecurityService/CertificateAuthentication HpeCertAuth
/redfish/v1/Managers/{item}/SecurityService/CertificateAuthentication/CACertificates Collection of HpeCertificate
/redfish/v1/Managers/{item}/SecurityService/CertificateAuthentication/CACertificates/{item} HpeCertificate
/redfish/v1/Managers/{item}/SecurityService/ESKM HpeESKM
/redfish/v1/Managers/{item}/SecurityService/HttpsCert HpeHttpsCert
/redfish/v1/Managers/{item}/SecurityService/PlatformCert/Certificates Collection of Certificate
/redfish/v1/Managers/{item}/SecurityService/PlatformCert/Certificates/{item} Certificate
/redfish/v1/Managers/{item}/SecurityService/SSO HpeiLOSSO
/redfish/v1/Managers/{item}/SecurityService/SecurityDashboard HpeiLOSecurityDashboard
/redfish/v1/Managers/{item}/SecurityService/SecurityDashboard/SecurityParams Collection of HpeiLOSecurityParam
/redfish/v1/Managers/{item}/SecurityService/SecurityDashboard/SecurityParams/{item} HpeiLOSecurityParam
/redfish/v1/Managers/{item}/SecurityService/SystemIAK/Certificates Collection of Certificate
/redfish/v1/Managers/{item}/SecurityService/SystemIAK/Certificates/{item} Certificate
/redfish/v1/Managers/{item}/SecurityService/SystemIDevID/Certificates Collection of Certificate
/redfish/v1/Managers/{item}/SecurityService/SystemIDevID/Certificates/{item} Certificate
/redfish/v1/Managers/{item}/SecurityService/iLOIDevID/Certificates Collection of Certificate
/redfish/v1/Managers/{item}/SecurityService/iLOIDevID/Certificates/{item} Certificate
/redfish/v1/Managers/{item}/SecurityService/iLOLDevID/Certificates Collection of Certificate
/redfish/v1/Managers/{item}/SecurityService/iLOLDevID/Certificates/{item} Certificate
/redfish/v1/Managers/{item}/SerialInterfaces Collection of SerialInterface
/redfish/v1/Managers/{item}/SerialInterfaces/{item} SerialInterface
/redfish/v1/Managers/{item}/SnmpService HpeiLOSnmpService
/redfish/v1/Managers/{item}/SnmpService/SNMPAlertDestinations Collection of HpeSNMPAlertDestination
/redfish/v1/Managers/{item}/SnmpService/SNMPAlertDestinations/{item} HpeSNMPAlertDestination
/redfish/v1/Managers/{item}/SnmpService/SNMPUsers Collection of HpeSNMPUser
/redfish/v1/Managers/{item}/SnmpService/SNMPUsers/{item} HpeSNMPUser
/redfish/v1/Managers/{item}/VirtualMedia Collection of VirtualMedia
/redfish/v1/Managers/{item}/VirtualMedia/{item} VirtualMedia
/redfish/v1/Registries Collection of MessageRegistryFile
/redfish/v1/Registries/{item} MessageRegistryFile
/redfish/v1/ResourceDirectory HpeiLOResourceDirectory
/redfish/v1/SessionService SessionService
/redfish/v1/SessionService/Sessions Collection of Session
/redfish/v1/SessionService/Sessions/{item} Session
/redfish/v1/Systems Collection of ComputerSystem
/redfish/v1/Systems/{item} ComputerSystem
/redfish/v1/Systems/{item}/BaseNetworkAdapters Collection of HpeBaseNetworkAdapter
/redfish/v1/Systems/{item}/BaseNetworkAdapters/{item} HpeBaseNetworkAdapter
/redfish/v1/Systems/{item}/Bios Bios
/redfish/v1/Systems/{item}/Bios/Kmsconfig/Baseconfigs HpeBaseConfigs
/redfish/v1/Systems/{item}/Bios/Kmsconfig/Settings HpeKmsConfig
/redfish/v1/Systems/{item}/Bios/Serverconfiglock/Baseconfigs HpeBaseConfigs
/redfish/v1/Systems/{item}/Bios/Serverconfiglock/Settings HpeServerConfigLock
/redfish/v1/Systems/{item}/Bios/Settings Bios
/redfish/v1/Systems/{item}/Bios/baseconfigs HpeBaseConfigs
/redfish/v1/Systems/{item}/Bios/boot HpeServerBootSettings
/redfish/v1/Systems/{item}/Bios/boot/Settings HpeServerBootSettings
/redfish/v1/Systems/{item}/Bios/boot/baseconfigs HpeBaseConfigs
/redfish/v1/Systems/{item}/Bios/hpescalablepmem HpeScalablePmem
/redfish/v1/Systems/{item}/Bios/hpescalablepmem/Settings HpeScalablePmem
/redfish/v1/Systems/{item}/Bios/iscsi HpeiSCSISoftwareInitiator
/redfish/v1/Systems/{item}/Bios/iscsi/Settings HpeiSCSISoftwareInitiator
/redfish/v1/Systems/{item}/Bios/iscsi/baseconfigs HpeBaseConfigs
/redfish/v1/Systems/{item}/Bios/mappings HpeBiosMapping
/redfish/v1/Systems/{item}/Bios/tlsconfig HpeTlsConfig
/redfish/v1/Systems/{item}/Bios/tlsconfig/Settings HpeTlsConfig
/redfish/v1/Systems/{item}/Bios/tlsconfig/baseconfigs HpeBaseConfigs
/redfish/v1/Systems/{item}/BootOptions Collection of BootOption
/redfish/v1/Systems/{item}/BootOptions/{item} BootOption
/redfish/v1/Systems/{item}/EthernetInterfaces Collection of EthernetInterface
/redfish/v1/Systems/{item}/EthernetInterfaces/{item} EthernetInterface
/redfish/v1/Systems/{item}/LogServices Collection of LogService
/redfish/v1/Systems/{item}/LogServices/DPU LogService
/redfish/v1/Systems/{item}/LogServices/DPU/Entries Collection of LogEntry
/redfish/v1/Systems/{item}/LogServices/DPU/Entries/{item} LogEntry
/redfish/v1/Systems/{item}/LogServices/Event LogService
/redfish/v1/Systems/{item}/LogServices/Event/Entries Collection of LogEntry
/redfish/v1/Systems/{item}/LogServices/Event/Entries/{item} LogEntry
/redfish/v1/Systems/{item}/LogServices/IML LogService
/redfish/v1/Systems/{item}/LogServices/IML/Entries Collection of LogEntry
/redfish/v1/Systems/{item}/LogServices/IML/Entries/{item} LogEntry
/redfish/v1/Systems/{item}/LogServices/SL LogService
/redfish/v1/Systems/{item}/LogServices/SL/Entries Collection of LogEntry
/redfish/v1/Systems/{item}/LogServices/SL/Entries/{item} LogEntry
/redfish/v1/Systems/{item}/Memory Collection of Memory
/redfish/v1/Systems/{item}/Memory/{item} Memory
/redfish/v1/Systems/{item}/MemoryDomains Collection of MemoryDomain
/redfish/v1/Systems/{item}/MemoryDomains/{item} MemoryDomain
/redfish/v1/Systems/{item}/MemoryDomains/{item}/MemoryChunks Collection of MemoryChunks
/redfish/v1/Systems/{item}/MemoryDomains/{item}/MemoryChunks/{item} MemoryChunks
/redfish/v1/Systems/{item}/NetworkInterfaces Collection of NetworkInterface
/redfish/v1/Systems/{item}/NetworkInterfaces/{item} NetworkInterface
/redfish/v1/Systems/{item}/NetworkInterfaces/{item}/NetworkDeviceFunctions Collection of NetworkDeviceFunction
/redfish/v1/Systems/{item}/NetworkInterfaces/{item}/NetworkDeviceFunctions/{item} NetworkDeviceFunction
/redfish/v1/Systems/{item}/NetworkInterfaces/{item}/NetworkPorts Collection of NetworkPort
/redfish/v1/Systems/{item}/NetworkInterfaces/{item}/NetworkPorts/{item} NetworkPort
/redfish/v1/Systems/{item}/NetworkInterfaces/{item}/NetworkPorts/{item}/HpeEVB HpeNetworkPortEVB
/redfish/v1/Systems/{item}/NetworkInterfaces/{item}/NetworkPorts/{item}/HpeLLDP HpeNetworkPortLLDP
/redfish/v1/Systems/{item}/NetworkInterfaces/{item}/NetworkPorts/{item}/Settings NetworkPort
/redfish/v1/Systems/{item}/NetworkInterfaces/{item}/Ports Collection of Port
/redfish/v1/Systems/{item}/NetworkInterfaces/{item}/Ports/{item} Port
/redfish/v1/Systems/{item}/NetworkInterfaces/{item}/Ports/{item}/Settings Port
/redfish/v1/Systems/{item}/PCIDevices Collection of HpeServerPciDevice
/redfish/v1/Systems/{item}/PCIDevices/{item} HpeServerPciDevice
/redfish/v1/Systems/{item}/PCISlots Collection of HpeServerPCISlot
/redfish/v1/Systems/{item}/PCISlots/{item} HpeServerPCISlot
/redfish/v1/Systems/{item}/Processors Collection of Processor
/redfish/v1/Systems/{item}/Processors/{item} Processor
/redfish/v1/Systems/{item}/SecureBoot SecureBoot
/redfish/v1/Systems/{item}/SmartStorage HpeSmartStorage
/redfish/v1/Systems/{item}/SmartStorage/ArrayControllers Collection of HpeSmartStorageArrayController
/redfish/v1/Systems/{item}/SmartStorage/ArrayControllers/{item} HpeSmartStorageArrayController
/redfish/v1/Systems/{item}/SmartStorage/ArrayControllers/{item}/DiskDrives Collection of HpeSmartStorageDiskDrive
/redfish/v1/Systems/{item}/SmartStorage/ArrayControllers/{item}/DiskDrives/{item} HpeSmartStorageDiskDrive
/redfish/v1/Systems/{item}/SmartStorage/ArrayControllers/{item}/LogicalDrives Collection of HpeSmartStorageLogicalDrive
/redfish/v1/Systems/{item}/SmartStorage/ArrayControllers/{item}/LogicalDrives/{item} HpeSmartStorageLogicalDrive
/redfish/v1/Systems/{item}/SmartStorage/ArrayControllers/{item}/LogicalDrives/{item}/DataDrives Collection of HpeSmartStorageDiskDrive
/redfish/v1/Systems/{item}/SmartStorage/ArrayControllers/{item}/StorageEnclosures Collection of HpeSmartStorageStorageEnclosure
/redfish/v1/Systems/{item}/SmartStorage/ArrayControllers/{item}/StorageEnclosures/{item} HpeSmartStorageStorageEnclosure
/redfish/v1/Systems/{item}/SmartStorage/ArrayControllers/{item}/UnconfiguredDrives Collection of HpeSmartStorageDiskDrive
/redfish/v1/Systems/{item}/SmartStorage/ArrayControllers/{item}/UnconfiguredDrives/{item} HpeSmartStorageDiskDrive
/redfish/v1/Systems/{item}/SmartStorage/HostBusAdapters Collection of HpeSmartStorageHostBusAdapter
/redfish/v1/Systems/{item}/SmartStorage/HostBusAdapters/{item} HpeSmartStorageHostBusAdapter
/redfish/v1/Systems/{item}/SmartStorage/HostBusAdapters/{item}/DiskDrives Collection of HpeSmartStorageDiskDrive
/redfish/v1/Systems/{item}/SmartStorage/HostBusAdapters/{item}/DiskDrives/{item} HpeSmartStorageDiskDrive
/redfish/v1/Systems/{item}/SmartStorageConfig SmartStorageConfig
/redfish/v1/Systems/{item}/SmartStorageConfig/Settings SmartStorageConfig
/redfish/v1/Systems/{item}/Storage Collection of Storage
/redfish/v1/Systems/{item}/Storage/{item}/Controllers/ Collection of StorageController
/redfish/v1/Systems/{item}/Storage/{item}/Controllers/{item} StorageController
/redfish/v1/Systems/{item}/Storage/{item}/Controllers/{item}/Ports/{item} Port
/redfish/v1/Systems/{item}/Storage/{item}/StorageControllers/{item}/Ports/{item} Port
/redfish/v1/Systems/{item}/USBDevices Collection of HpeUSBDevice
/redfish/v1/Systems/{item}/USBDevices/{item} HpeUSBDevice
/redfish/v1/Systems/{item}/USBPorts Collection of HpeUSBPort
/redfish/v1/Systems/{item}/USBPorts/{item} HpeUSBPort
/redfish/v1/Systems/{item}/WorkloadPerformanceAdvisor Collection of HpeWorkloadPerformanceAdvisor
/redfish/v1/Systems/{item}/WorkloadPerformanceAdvisor/{item} HpeWorkloadPerformanceAdvisor
/redfish/v1/TaskService TaskService
/redfish/v1/TaskService/Tasks Collection of Task
/redfish/v1/TaskService/Tasks/{item} Task
/redfish/v1/TelemetryService TelemetryService
/redfish/v1/TelemetryService/MetricDefinitions Collection of MetricDefinition
/redfish/v1/TelemetryService/MetricDefinitions/{item} MetricDefinition
/redfish/v1/TelemetryService/MetricReportDefinitions Collection of MetricReportDefinition
/redfish/v1/TelemetryService/MetricReportDefinitions/{item} MetricReportDefinition
/redfish/v1/TelemetryService/MetricReports/{item} MetricReport
/redfish/v1/TelemetryService/MetricsReport Collection of MetricReport
/redfish/v1/TelemetryService/Triggers Collection of Triggers
/redfish/v1/TelemetryService/Triggers/{item} Triggers
/redfish/v1/UpdateService UpdateService
/redfish/v1/UpdateService/ComponentRepository Collection of HpeComponent
/redfish/v1/UpdateService/ComponentRepository/{item} HpeComponent
/redfish/v1/UpdateService/FirmwareInventory Collection of SoftwareInventory
/redfish/v1/UpdateService/FirmwareInventory/{item} SoftwareInventory
/redfish/v1/UpdateService/InstallSets Collection of HpeComponentInstallSet
/redfish/v1/UpdateService/InstallSets/{item} HpeComponentInstallSet
/redfish/v1/UpdateService/InvalidImageRepository Collection of HpeInvalidImage
/redfish/v1/UpdateService/InvalidImageRepository/{item} HpeInvalidImage
/redfish/v1/UpdateService/MaintenanceWindows Collection of HpeMaintenanceWindow
/redfish/v1/UpdateService/MaintenanceWindows/{item} HpeMaintenanceWindow
/redfish/v1/UpdateService/SoftwareInventory Collection of SoftwareInventory
/redfish/v1/UpdateService/SoftwareInventory/{item} SoftwareInventory
/redfish/v1/UpdateService/UpdateTaskQueue Collection of HpeComponentUpdateTask
/redfish/v1/UpdateService/UpdateTaskQueue/{item} HpeComponentUpdateTask
/redfish/v1/systems/{item}/bios/Kmsconfig HpeKmsConfig
/redfish/v1/systems/{item}/bios/Serverconfiglock HpeServerConfigLock
redfish/v1/Chassis/{item}/BaseFrus Collection of HpeiLOFrus
redfish/v1/Chassis/{item}/BaseFrus/{item} HpeiLOFrus
redfish/v1/Chassis/{item}/BaseFrus/{item}/Details HpeiLOFrus
redfish/v1/Chassis/{item}/MezzFrus Collection of HpeiLOFrus
redfish/v1/Chassis/{item}/MezzFrus/{item} HpeiLOFrus
redfish/v1/Chassis/{item}/MezzFrus/{item}/Details HpeiLOFrus
redfish/v1/Chassis/{item}/PCIeDevices Collection of PCIeDevice
redfish/v1/Chassis/{item}/PCIeDevices/{item} PCIeDevice
redfish/v1/Chassis/{item}/PCIeDevices/{item}/PCIeFunctions Collection of PCIeFunction
redfish/v1/Chassis/{item}/PCIeDevices/{item}/PCIeFunctions/{item} PCIeFunction
redfish/v1/Chassis/{item}/PCIeSlots PCIeSlots
redfish/v1/Systems/{item}/NetworkInterfaces/{item}/NetworkDeviceFunctions/{item}/Settings NetworkDeviceFunction
redfish/v1/Systems/{item}/SecureEraseReportService HpeSecureEraseReportService
redfish/v1/Systems/{item}/SecureEraseReportService/SecureEraseReportEntries Collection of HpeSecureEraseReport
redfish/v1/Systems/{item}/SecureEraseReportService/SecureEraseReportEntries/{item} HpeSecureEraseReport
redfish/v1/Systems/{item}/SmartStorage/ArrayControllers/{item}/LogicalDrives/{item}/ActiveSpareDrives Collection of HpeSmartStorageDiskDrive
redfish/v1/Systems/{item}/SmartStorage/ArrayControllers/{item}/LogicalDrives/{item}/StandbySpareDrives Collection of HpeSmartStorageDiskDrive
redfish/v1/Systems/{item}/Storage/{item} Storage
redfish/v1/Systems/{item}/Storage/{item}/Drives/{item} Drive
redfish/v1/Systems/{item}/Storage/{item}/Volumes Collection of Volume
redfish/v1/Systems/{item}/Storage/{item}/Volumes/{item} Volume

Resource Definitions

Each resource in the API has a “type” that defines its properties. See the Redfish specification for @odata.type for details.

This section defines the supported types and lists the typical instances of each. Because this API document is applicable to all HPE servers using iLO 5, you may find variations such as:

Collections

Many resource types in the API are members of “collections.” Collections are groups of similar resources and are typically an array of Member links.

Redfish does not define a generic collection “type” (@odata.type) but all collections are identical in structure. A ComputerSystemCollection is identical in structure to a ChassisCollection although they have slightly different names. Typically, collection types are suffixed with the word collection and are recognizable by the presence of the Members array of links.

Collections may be GET-only that may not be added to or removed from. Examples of GET-only collections are the Systems collection at /redfish/v1/systems/. In a typical systems collection describing physical hardware, it wouldn’t make sense to be able to create or remove members using GET or DELETE.

Other collections may be editable. Examples of these might be the Accounts collection at /redfish/v1/accountservice/accounts. The API supports the addition or removal of user accounts. To add a new member to an editable collection, perform an HTTP POST to the collection resource with a body consisting of the required JSON properties needed to create a new member (this does not necessarily require you to POST every property because many may take a unique service-assigned value or take a default value.)

For more information on collections see the Redfish 1.0 DMTF standard at https://www.dmtf.org/standards/redfish and the example Python code: https://github.com/HewlettPackard/python-ilorest-library.

GET https://{iLO}/redfish/v1/systems/ showing a collection response (JSON)

{
    "@odata.id": "/redfish/v1/systems/",
    "@odata.context": "/redfish/v1/$metadata/",
    "@odata.type": "#ComputerSystemCollection.ComputerSystemCollection",
    "Members@odata.count": 1,
    "Members": [
        {
            "@odata.id": "/redfish/v1/systems/1/"
        }
    ]
}

Properties

Collection Instances:

  • https://{iLO}/redfish/v1/AccountService/Accounts

  • https://{iLO}/redfish/v1/Chassis

  • https://{iLO}/redfish/v1/EventService/EventSubscriptions

  • https://{iLO}/redfish/v1/Managers

  • https://{iLO}/redfish/v1/Managers/{item}/EthernetInterfaces

  • https://{iLO}/redfish/v1/Managers/{item}/FederationGroups

  • https://{iLO}/redfish/v1/Managers/{item}/FederationPeers

  • https://{iLO}/redfish/v1/Managers/{item}/LicenseService

  • https://{iLO}/redfish/v1/Managers/{item}/LogServices

  • https://{iLO}/redfish/v1/Managers/{item}/LogServices/IEL/Entries

  • https://{iLO}/redfish/v1/Managers/{item}/VirtualMedia

  • https://{iLO}/redfish/v1/Registries

  • https://{iLO}/redfish/v1/Schemas

  • https://{iLO}/redfish/v1/SessionService/Sessions

  • https://{iLO}/redfish/v1/Systems

  • https://{iLO}/redfish/v1/Systems/{item}/LogServices

  • https://{iLO}/redfish/v1/Systems/{item}/LogServices/IML/Entries

  • https://{iLO}/redfish/v1/Systems/{item}/Memory

  • https://{iLO}/redfish/v1/Systems/{item}/NetworkAdapters

  • https://{iLO}/redfish/v1/Systems/{item}/PCIDevices

  • https://{iLO}/redfish/v1/Systems/{item}/PCISlots

  • https://{iLO}/redfish/v1/Systems/{item}/SmartStorage/ArrayControllers

  • https://{iLO}/redfish/v1/Systems/{item}/SmartStorage/ArrayControllers/{item}/DiskDrives

  • https://{iLO}/redfish/v1/Systems/{item}/SmartStorage/ArrayControllers/{item}/LogicalDrives

  • https://{iLO}/redfish/v1/Systems/{item}/SmartStorage/ArrayControllers/{item}/StorageEnclosures

  • https://{iLO}/redfish/v1/Systems/{item}/SmartStorage/HostBusAdapters

Members@odata.count

JSONPath: /Members@odata.count (read only integer)

The number of members in the collection.

Members[]

JSONPath: /Members (read only array of links)

The Members array consists of links (@odata.id) to the members of the collection.

AccountService.v1_5_0.AccountService

@odata.type: "#AccountService.v1_5_0.AccountService"

The AccountService resource describes the BMC user account management service. It represents the properties for this service and has links to the list of accounts.

Managing User Accounts with the Accounts Collection

JSONPath: /Accounts/@odata.id

The destination of this link is a collection of user accounts (see ManagerAccount).

Resource Instances

Uri HTTP Allow
/redfish/v1/accountservice GET POST PATCH
Link Name Destination type
Accounts Collection of ManagerAccount

AccountLockoutCounterResetAfter

Member of AccountService.v1_5_0.AccountService
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.
Type number
Read Only True
Added iLO 5 1.40

AccountLockoutCounterResetEnabled

Member of AccountService.v1_5_0.AccountService
Description The value indicates whether the threshold counter will be reset after AccountLockoutCounterResetAfter expires.
Type boolean
Read Only True

AccountLockoutDuration

Member of AccountService.v1_5_0.AccountService
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.
Type number or null
Read Only False
Added iLO 5 1.40

AccountLockoutThreshold

Member of AccountService.v1_5_0.AccountService
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.
Type number or null
Read Only False
Added iLO 5 1.40

Accounts

This property references a resource of type Collection with a MemberType of ManagerAccount. Accounts is a link ("@odata.id": URI) to another resource.

ActiveDirectory

ActiveDirectory.AccountProviderType Member of AccountService.v1_5_0.AccountService
Description This property contains the type of external account provider this resource references.
Type string
Read Only False
Added iLO 5 1.40

The following are the supported values:

Value Description
ActiveDirectoryService An external Active Directory Service.

ActiveDirectory.Authentication ActiveDirectory.Authentication.AuthenticationType Member of AccountService.v1_5_0.AccountService
Description This property contains the type of authentication used to connect to the external account provider.
Type string
Read Only False
Added iLO 5 1.40

The following are the supported values:

Value Description
UsernameAndPassword Username and password combination.

ActiveDirectory.Authentication.Password Member of AccountService.v1_5_0.AccountService
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.
Type string or null
Read Only False
Added iLO 5 1.40

ActiveDirectory.Authentication.Username Member of AccountService.v1_5_0.AccountService
Description This property contains the distinguished name for the account service.
Type string or null
Read Only False
Added iLO 5 1.40

ActiveDirectory.RemoteRoleMapping (array) Member of AccountService.v1_5_0.AccountService RemoteRoleMapping is an array containing elements of:

RemoteRoleMapping[{item}].LocalRole Member of AccountService.v1_5_0.AccountService
Description The name of the local role in which to map the remote user or group.
Type string or null
Read Only False

RemoteRoleMapping[{item}].RemoteGroup Member of AccountService.v1_5_0.AccountService
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.
Type string or null
Read Only False

ActiveDirectory.ServiceAddresses (array) Member of AccountService.v1_5_0.AccountService ServiceAddresses is an array containing elements of:
Type string or null
Read Only True

ActiveDirectory.ServiceEnabled Member of AccountService.v1_5_0.AccountService
Description This indicates whether this service is enabled.
Type boolean or null
Read Only False
Added iLO 5 1.40

AuthFailureLoggingThreshold

Member of AccountService.v1_5_0.AccountService
Description The number of authorization failures allowed before the failure attempt is logged to the manager log.
Type number
Read Only False

LDAP

LDAP.AccountProviderType Member of AccountService.v1_5_0.AccountService
Description This property contains the type of external account provider this resource references.
Type string
Read Only False
Added iLO 5 1.40

The following are the supported values:

Value Description
ActiveDirectoryService An external Active Directory Service.
LDAPService A generic external LDAP Service.

LDAP.Authentication LDAP.Authentication.AuthenticationType Member of AccountService.v1_5_0.AccountService
Description This property contains the type of authentication used to connect to the external account provider.
Type string
Read Only False
Added iLO 5 1.40

The following are the supported values:

Value Description
UsernameAndPassword Username and password combination.

LDAP.Authentication.Password Member of AccountService.v1_5_0.AccountService
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.
Type string or null
Read Only False
Added iLO 5 1.40

LDAP.Authentication.Username Member of AccountService.v1_5_0.AccountService
Description This property contains the distinguished name for the account service.
Type string or null
Read Only False
Added iLO 5 1.40

LDAP.Certificates A link to a collection of Certificates used for the external account service. Certificates is a link ("@odata.id": URI) to another resource.

LDAP.LDAPService LDAP.LDAPService.SearchSettings LDAP.LDAPService.SearchSettings.BaseDistinguishedNames (array) Member of AccountService.v1_5_0.AccountService BaseDistinguishedNames is an array containing elements of:
Type string or null
Read Only True

LDAP.RemoteRoleMapping (array) Member of AccountService.v1_5_0.AccountService RemoteRoleMapping is an array containing elements of:

RemoteRoleMapping[{item}].LocalRole Member of AccountService.v1_5_0.AccountService
Description The name of the local role in which to map the remote user or group.
Type string or null
Read Only False

RemoteRoleMapping[{item}].RemoteGroup Member of AccountService.v1_5_0.AccountService
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.
Type string or null
Read Only False

LDAP.ServiceAddresses (array) Member of AccountService.v1_5_0.AccountService ServiceAddresses is an array containing elements of:
Type string or null
Read Only True

LDAP.ServiceEnabled Member of AccountService.v1_5_0.AccountService
Description This indicates whether this service is enabled.
Type boolean or null
Read Only False
Added iLO 5 1.40

LocalAccountAuth

Member of AccountService.v1_5_0.AccountService
Description Controls when this service will use the accounts defined withing this AccountService as part of authentication.
Type string
Read Only False
Added iLO 5 1.40

The following are the supported values:

Value Description
Enabled Authentication via accounts defined in this AccountService is enabled.
Disabled Authentication via accounts defined in this AccountService is disabled.

MaxPasswordLength

Member of AccountService.v1_5_0.AccountService
Description The maximum password length for this service.
Type number
Read Only True
Added iLO 5 1.40

MinPasswordLength

Member of AccountService.v1_5_0.AccountService
Description The minimum password length for this account service.
Type integer
Read Only True
Added iLO 5 1.40

Oem.Hpe.AuthFailureDelayTimeSeconds

Member of AccountService.v1_5_0.AccountService
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.
Type integer
Read Only False
Added iLO 5 1.10

The following are the supported values:

Value
2
5
10
30

Oem.Hpe.AuthFailureLoggingThreshold

Member of AccountService.v1_5_0.AccountService
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.
Type integer
Read Only False

The following are the supported values:

Value
Null
1
2
3
5

Oem.Hpe.AuthFailuresBeforeDelay

Member of AccountService.v1_5_0.AccountService
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.
Type integer
Read Only False
Added iLO 5 1.10

The following are the supported values:

Value
Null
1
3
5

Oem.Hpe.DefaultPassword

Member of AccountService.v1_5_0.AccountService
Description The default password used to log in to the management processor when factory reset is performed.
Type string or null
Read Only False
Added iLO 5 1.17

Oem.Hpe.DefaultUserName

Member of AccountService.v1_5_0.AccountService
Description The default name used to log in to the management processor when factory reset is performed.
Type string or null
Read Only False
Added iLO 5 1.17

Oem.Hpe.DirectorySettings

Oem.Hpe.DirectorySettings.LdapAuthenticationMode Member of AccountService.v1_5_0.AccountService
Description Represents the LDAP authentication mode.
Type string
Read Only False
Added iLO 5 1.40

The following are the supported values:

Value Description
Disabled Directory authentication is disabled.
DefaultSchema Directory Default schema or Schema-free option is selected.
ExtendedSchema HPE Extended schema is selected.

Oem.Hpe.DirectorySettings.LdapCaCertificateLoaded Member of AccountService.v1_5_0.AccountService
Description Represents if the directory server CA certificate is loaded or not.
Type boolean
Read Only True
Added iLO 5 1.40

Oem.Hpe.DirectorySettings.LdapCaCertificates A link to a collection of Certificates. LdapCaCertificates is a link ("@odata.id": URI) to another resource.

Oem.Hpe.DirectorySettings.LdapServerPort Member of AccountService.v1_5_0.AccountService
Description Represents the port number of the directory server.
Type integer
Read Only True
Added iLO 5 1.40

Oem.Hpe.DirectoryTest

The value of this property shall be a reference to a resource of type HpeDirectoryTest. DirectoryTest is a link ("@odata.id": URI) to another resource.

Oem.Hpe.EnforcePasswordComplexity

Member of AccountService.v1_5_0.AccountService
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
Type boolean
Read Only False
Added iLO 5 1.40

Oem.Hpe.KerberosSettings

Oem.Hpe.KerberosSettings.KDCServerPort Member of AccountService.v1_5_0.AccountService
Description Represents the port number of the KDC server.
Type integer
Read Only True
Added iLO 5 1.40

Oem.Hpe.KerberosSettings.KerberosRealm Member of AccountService.v1_5_0.AccountService
Description Represents the Realm of the KDC server.
Type string or null
Read Only False
Added iLO 5 1.40

Oem.Hpe.MinPasswordLength

Member of AccountService.v1_5_0.AccountService
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.
Type integer
Read Only False
Added iLO 5 1.10

Oem.Hpe.TwoFactorAuth

Member of AccountService.v1_5_0.AccountService
Description This property indicates two factor authentication enabled or not
Type string
Read Only False

The following are the supported values:

Value
Enabled
Disabled

Roles

A link to a collection of Roles. Roles is a link ("@odata.id": URI) to another resource.

Actions

HpeiLOAccountService.ImportKerberosKeytab Member of AccountService.v1_5_0.AccountService Import the Kerberos keytab file.

Parameters:

ImportUri (string)

URI of the kerberos keytab file.

Bios.v1_0_0.Bios

@odata.type: "#Bios.v1_0_0.Bios"

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.

Resource Instances

Uri HTTP Allow
/redfish/v1/systems/{item}/bios GET
/redfish/v1/systems/{item}/bios/settings GET POST PATCH
Link Name Destination type
@Redfish.Settings/SettingsObject Bios
Oem/Hpe/Links/BaseConfigs HpeBaseConfigs
Oem/Hpe/Links/Boot HpeServerBootSettings
Oem/Hpe/Links/Mappings HpeBiosMapping
Oem/Hpe/Links/ScalablePmem HpeScalablePmem
Oem/Hpe/Links/TlsConfig HpeTlsConfig
Oem/Hpe/Links/iScsi HpeiSCSISoftwareInitiator

AttributeRegistry

Member of Bios.v1_0_0.Bios
Description The Resource ID of the Attribute Registry for the BIOS Attributes resource.
Type string or null
Read Only True

Attributes

AcpiHpet (High Precision Event Timer (HPET) ACPI Support) Member of Bios.v1_0_0.Bios
Description Use this option to disable the High Precision Event Timer (HPET) table and device object in ACPI. When disabled, the HPET is not available to an operating system that supports the HPET through the industry standard ACPI name space.
Type Enumeration
Read Only False
Value Description
Enabled Enabled
Disabled Disabled

AcpiRootBridgePxm (Memory Proximity Reporting for I/O) Member of Bios.v1_0_0.Bios
Description When enabled, the System BIOS reports the proximity relationship between I/O devices and system memory to the operating system. Most operating systems can use this information to efficiently assign memory resources for devices, such as network controllers and storage devices. Additionally, certain I/O devices might not be able to take advantage of I/O handling benefits if their OS drivers are not properly optimized to support this feature. See your operating system and I/O device documentation for more details.
Type Enumeration
Read Only False
Value Description
Enabled Enabled
Disabled Disabled

AcpiSlit (ACPI SLIT) Member of Bios.v1_0_0.Bios
Description The ACPI SLIT (System Locality Information Table) defines the relative access times between processors, memory subsystems, and I/O subsystems. Operating systems that support the SLIT can use this information to improve performance by allocating resources and workloads more efficiently.
Type Enumeration
Read Only False
Value Description
Enabled Enabled
Disabled Disabled

AdjSecPrefetch (Adjacent Sector Prefetch) Member of Bios.v1_0_0.Bios
Description Use this option to disable the processor Adjacent Sector Prefetch feature. In some cases, setting this option to disabled can improve performance. Typically, setting this option to enabled provides better performance. Only disable this option after performing application benchmarking to verify improved performance in the environment.
Type Enumeration
Read Only False
Value Description
Enabled Enabled
Disabled Disabled

AdminEmail (Administrator E-mail Address) Member of Bios.v1_0_0.Bios
Description Enter the server administrator’s e-mail address.
Type String
Read Only False

AdminName (Administrator Name) Member of Bios.v1_0_0.Bios
Description Enter the server administrator’s name text.
Type String
Read Only False

AdminOtherInfo (Administrator Other Information) Member of Bios.v1_0_0.Bios
Description Enter the server administrator’s information text.
Type String
Read Only False

AdminPhone (Administrator Phone Number) Member of Bios.v1_0_0.Bios
Description Enter the server administrator’s phone number text.
Type String
Read Only False

AdvCrashDumpMode (Advanced Crash Dump Mode) Member of Bios.v1_0_0.Bios
Description Use this option to enable the Advanced Crash Dump Mode. When enabled, the system will be configured to log additional debug information to the Active Health System logs when an unexpected system crash is experienced. This option should only be enabled when directed by qualified service personnel
Type Enumeration
Read Only False
Value Description
Disabled Disabled
Enabled Enabled

AdvancedMemProtection (Advanced Memory Protection) Member of Bios.v1_0_0.Bios
Description Use this option to configure additional memory protection with ECC (Error Checking and Correcting). Options and support vary per system. Advanced ECC keeps all installed memory available for use while still protecting the system against all single-bit failures and certain multi-bit failures. Online Spare Memory enables a system to automatically map out a group of memory that is detected to be at an increased risk of receiving uncorrected memory errors based on an advanced analysis of corrected memory errors. The mapped out memory is automatically replaced by a spare group of memory without interrupting the system. Mirrored Memory provides the maximum protection against uncorrected memory errors that might otherwise result in a system failure. Fault Tolerant Advanced Double Device Data Correction (ADDDC) enables the system to correct memory errors and continue to operate in cases of multiple DRAM device failures on a DIMM. This provides protection against uncorrectable memory errors beyond what is available with Advanced ECC.
Type Enumeration
Read Only False
Value Description
FastFaultTolerantADDDC Fault Tolerant Memory (ADDDC)
AdvancedEcc Advanced ECC Support
OnlineSpareAdvancedEcc Online Spare with Advanced ECC Support
MirroredAdvancedEcc Mirrored Memory with Advanced ECC Support

AsrStatus (ASR Status) Member of Bios.v1_0_0.Bios
Description Use this option to configure the Automatic Server Recovery option, which enables the system to automatically reboot if the server locks up.
Type Enumeration
Read Only False
Value Description
Enabled Enabled
Disabled Disabled

AsrTimeoutMinutes (ASR Timeout) Member of Bios.v1_0_0.Bios
Description When Automatic Server Recovery is enabled, you can use this option to set the time to wait before rebooting the server in the event of an operating system crash or server lockup.
Type Enumeration
Read Only False
Value Description
Timeout10 10 Minutes
Timeout15 15 Minutes
Timeout20 20 Minutes
Timeout30 30 Minutes
Timeout5 5 Minutes

AssetTagProtection (Asset Tag Protection) Member of Bios.v1_0_0.Bios
Description Use this option to lock Asset Tag information. When set to lock, the Asset Tag is not erased if the default system settings are restored.
Type Enumeration
Read Only False
Value Description
Locked Locked
Unlocked Unlocked

AutoPowerOn (Automatic Power-On) Member of Bios.v1_0_0.Bios
Description Use this option to configure the server power state when AC power is applied to the system. Restore Last Power State returns the system to its previous power state when AC power is restored after an AC power loss. Note: This option is not available on all systems. Always Power On and Always Power Off causes the system to always return to the “on” and “off” state, respectively, whenever power is applied, even if the system is in the “off” state when power is lost.
Type Enumeration
Read Only False
Value Description
AlwaysPowerOn Always Power On
AlwaysPowerOff Always Power Off
RestoreLastState Restore Last Power State

BootMode (Boot Mode) Member of Bios.v1_0_0.Bios
Description Use this option to select the boot mode of the system. Selecting UEFI Mode configures the system to boot Unified Extensible Firmware Interface (UEFI) compatible operating systems. Selecting Legacy BIOS Mode configures the system to boot traditional operating systems in Legacy BIOS compatibility mode. The operating system can only boot in the mode in which it is installed. The following options require booting in UEFI Mode: Secure Boot, IPv6 PXE Boot, boot > 2.2 TB Disks in AHCI SATA Mode, and Smart Array SW RAID.
Type Enumeration
Read Only False
Value Description
Uefi UEFI Mode
LegacyBios Legacy BIOS Mode

BootOrderPolicy (Boot Order Policy) Member of Bios.v1_0_0.Bios
Description Use this option to configure how the system attempts to boot devices per the Boot Order list when no bootable device is found. If configured to ‘Retry Boot Order Indefinitely,’ the system continuously attempts to process the Boot Order list until a bootable device is found. If configured to ‘Attempt Boot Order Once,’ the system attempts to process all items in the Boot Order list once, and if unsuccessful, waits for user input to proceed. If configured for ‘Reset After Failed Boot Attempt,’ the system attempts to process all items in the Boot Order list once, and then reboots the system.
Type Enumeration
Read Only False
Value Description
RetryIndefinitely Retry Boot Order Indefinitely
AttemptOnce Attempt Boot Order Once
ResetAfterFailed Reset After Failed Boot Attempt

ChannelInterleaving (Channel Interleaving) Member of Bios.v1_0_0.Bios
Description You can only configure this option if the Workload Profile is set to Custom. Use this option to modify the level of interleaving for which the memory system is configured. Typically, higher levels of memory interleaving result in maximum performance. However, reducing the level of interleaving can result in power savings.
Type Enumeration
Read Only False
Value Description
Enabled Enabled
Disabled Disabled

CollabPowerControl (Collaborative Power Control) Member of Bios.v1_0_0.Bios
Description For operating systems that support the Processor Clocking Control (PCC) Interface, enabling this option enables the Operating System to request processor frequency changes even if the Power Regulator option on the server are configured for Dynamic Power Savings Mode. For Operating Systems that do not support the PCC Interface, or when the Power Regulator Mode is not configured for Dynamic Power Savings Mode, this option has no effect on system operation.
Type Enumeration
Read Only False
Value Description
Enabled Enabled
Disabled Disabled

ConsistentDevNaming (Consistent Device Naming) Member of Bios.v1_0_0.Bios
Description Use this option to select the level of Consistent Device Naming. On supported operating systems, NIC ports are named based on their location in the system. CDN Support for LOMs Only names Embedded NICs and FlexibleLOMs. Existing NIC connections retain their names until reinstalled under the OS environment.
Type Enumeration
Read Only False
Value Description
LomsAndSlots CDN Support for LOMs and Slots
LomsOnly CDN Support for LOMs Only
Disabled Disabled

CoreBoosting (Core Boosting) Member of Bios.v1_0_0.Bios
Description Use this option to enable the Core Boosting technology to increase processor performance on qualified processors.
Type Enumeration
Read Only False
Value Description
Disabled Disabled
Enabled Enabled

CustomPostMessage (Custom POST Message) Member of Bios.v1_0_0.Bios
Description Enter a message to be displayed on POST screen during system startup. This feature limits POST screen messaging to 62 characters, special characters are also accepted.
Type String
Read Only False

DaylightSavingsTime (Daylight Savings Time) Member of Bios.v1_0_0.Bios
Description This option controls the Daylight Savings Time (DST) adjustment to the displayed local time. If this option is disabled, the displayed local time will not be adjusted for DST. If this option is enabled, the displayed local time will be advanced by one hour.
Type Enumeration
Read Only False
Value Description
Disabled Disabled
Enabled Enabled

DcuIpPrefetcher (DCU IP Prefetcher) Member of Bios.v1_0_0.Bios
Description Use this option to disable the processor DCU IP Prefetcher feature. In some cases, setting this option to disabled can improve performance. In most cases, the default value of enabled provides optimal performance. Only disable this option after performing application benchmarking to verify improved performance in the environment.
Type Enumeration
Read Only False
Value Description
Enabled Enabled
Disabled Disabled

DcuStreamPrefetcher (DCU Stream Prefetcher) Member of Bios.v1_0_0.Bios
Description Use this option to disable the processor DCU Stream Prefetcher feature. In some cases, setting this option to disabled can improve performance. Typically, setting this option to enabled provides better performance. Only disable this option after performing application benchmarking to verify improved performance in your environment.
Type Enumeration
Read Only False
Value Description
Enabled Enabled
Disabled Disabled

Dhcpv4 (DHCPv4) Member of Bios.v1_0_0.Bios
Description When enabled, this option enables obtaining the pre-boot network IPv4 configuration from a DHCP server. Individual settings are not available. When disabled, you must configure static IP address settings individually.
Type Enumeration
Read Only False
Value Description
Enabled Enabled
Disabled Disabled

DirectToUpi (Direct To UPI (D2K)) Member of Bios.v1_0_0.Bios
Description Direct To UPI (D2K)
Type Enumeration
Read Only False
Value Description
Auto Auto
Enabled Enabled
Disabled Disabled

DynamicPowerCapping (Dynamic Power Capping Functionality) Member of Bios.v1_0_0.Bios
Description Use this option to configure when the System BIOS executes power calibration during the boot process. In Auto mode, calibration is run the first time the server is booted, and is then only run again when the server’s hardware configuration changes, configuration settings change, or if the system determines a new calibration is necessary. When disabled, the calibration does not run, and Dynamic Power Capping is not supported. When enabled, the calibration is run on every boot.
Type Enumeration
Read Only False
Value Description
Auto Auto
Enabled Enabled
Disabled Disabled

EmbNicAspm (PCIe Power Management(ASPM)) Member of Bios.v1_0_0.Bios
Description Use this option to configure the PCIe Link Power Management (ASPM) support for the selected device. When configured for L0s Enabled, the selected device’s link enters a standby energy savings state. When configured for L1 Enabled, the selected device’s link enters a lower power standby state at the expense of a longer exit latency. When configured for L1 and L0s Enabled, the selected device’s link enters either power savings mode, depending on link utilization, and provides the highest energy savings.
Type Enumeration
Read Only False
Value Description
Auto Auto
Disabled Disabled
AspmL1Enabled L1 Enabled

EmbNicEnable (PCIe Device Disable) Member of Bios.v1_0_0.Bios
Description Select this option to enable or disable PCI devices.
Type Enumeration
Read Only False
Value Description
Auto Auto
Disabled Disabled

EmbNicLinkSpeed (PCIe Link Speed) Member of Bios.v1_0_0.Bios
Description Use this option to configure the PCIe Link Speed for the selected device. When configured for Auto, the selected device trains at the maximum supported speed of the PCIe link. When configured for PCIe Generation 2 Link Speed, the selected device trains at a maximum of PCIe Generation 2 speed. When configured for PCIe Generation Link 1 speed, the selected device trains at a maximum of PCIe Generation 1 speed.
Type Enumeration
Read Only False
Value Description
Auto Auto
PcieGen1 PCIe Generation 1.0

EmbNicPCIeOptionROM (PCIe Option ROM) Member of Bios.v1_0_0.Bios
Description Use this option to enable or disable Device Option ROM
Type Enumeration
Read Only False
Value Description
Enabled Enabled
Disabled Disabled

EmbSas1Aspm (PCIe Power Management(ASPM)) Member of Bios.v1_0_0.Bios
Description Use this option to configure the PCIe Link Power Management (ASPM) support for the selected device. When configured for L0s Enabled, the selected device’s link enters a standby energy savings state. When configured for L1 Enabled, the selected device’s link enters a lower power standby state at the expense of a longer exit latency. When configured for L1 and L0s Enabled, the selected device’s link enters either power savings mode, depending on link utilization, and provides the highest energy savings.
Type Enumeration
Read Only False
Value Description
Auto Auto
Disabled Disabled
AspmL1Enabled L1 Enabled

EmbSas1Boot (Embedded SAS Controller 1) Member of Bios.v1_0_0.Bios
Description When Boot All Targets is selected, all valid boot targets attached to the storage controller are made available in the UEFI Boot Order list. If Boot No Targets is selected, no boot targets from this storage controller are made available in the UEFI Boot Order list.If Boot Limit to 24 Targets is selected, 24 boot targets attached to the storage controller are made available in the UEFI Boot Order list.
Type Enumeration
Read Only False
Value Description
AllTargets Boot All Targets
TwentyFourTargets Boot Limit to 24 Targets
NoTargets Boot No Targets

EmbSas1Enable (PCIe Device Disable) Member of Bios.v1_0_0.Bios
Description Select this option to enable or disable PCI devices.
Type Enumeration
Read Only False
Value Description
Auto Auto
Disabled Disabled

EmbSas1LinkSpeed (PCIe Link Speed) Member of Bios.v1_0_0.Bios
Description Use this option to configure the PCIe Link Speed for the selected device. When configured for Auto, the selected device trains at the maximum supported speed of the PCIe link. When configured for PCIe Generation 2 Link Speed, the selected device trains at a maximum of PCIe Generation 2 speed. When configured for PCIe Generation Link 1 speed, the selected device trains at a maximum of PCIe Generation 1 speed.
Type Enumeration
Read Only False
Value Description
Auto Auto
PcieGen1 PCIe Generation 1.0
PcieGen2 PCIe Generation 2.0

EmbSas1PcieOptionROM (PCIe Option ROM) Member of Bios.v1_0_0.Bios
Description Use this option to enable or disable Device Option ROM
Type Enumeration
Read Only False
Value Description
Enabled Enabled
Disabled Disabled

EmbSata1Aspm (SATA Power Management(SALP)) Member of Bios.v1_0_0.Bios
Description Use this option to enable or disable Aggressive Link Power Management(SALP).
Type Enumeration
Read Only False
Value Description
Disabled Disabled
Enabled Enabled

EmbSata1Enable (SATA Device Disable) Member of Bios.v1_0_0.Bios
Description Select this option to enable or disable SATA devices.
Type Enumeration
Read Only False
Value Description
Auto Auto
Disabled Disabled

EmbSata1PCIeOptionROM (PCIe Option ROM) Member of Bios.v1_0_0.Bios
Description Use this option to enable or disable Device Option ROM
Type Enumeration
Read Only False
Value Description
Enabled Enabled
Disabled Disabled

EmbSata2Aspm (SATA Power Management(SALP)) Member of Bios.v1_0_0.Bios
Description Use this option to enable or disable Aggressive Link Power Management(SALP).
Type Enumeration
Read Only False
Value Description
Disabled Disabled
Enabled Enabled

EmbSata2Enable (SATA Device Disable) Member of Bios.v1_0_0.Bios
Description Select this option to enable or disable SATA devices.
Type Enumeration
Read Only False
Value Description
Auto Auto
Disabled Disabled

EmbSata2PCIeOptionROM (PCIe Option ROM) Member of Bios.v1_0_0.Bios
Description Use this option to enable or disable Device Option ROM
Type Enumeration
Read Only False
Value Description
Enabled Enabled
Disabled Disabled

EmbVideoConnection (Embedded Video Connection) Member of Bios.v1_0_0.Bios
Description When configured for Auto mode, the external video connection to the embedded video controller is automatically disabled to save power when a monitor is not attached. It is automatically enabled when a monitor is attached, including when the server is operating. When configured for Always Disabled, the external video connection to the embedded video controller is disabled, and a monitor connected to this port does not display except during system boot. This can be used for security reasons. When configured for Always Enabled, the external video connection to the embedded video controller is always enabled. This option is only required if a monitor is attached with a monitor detection that does not function properly (making AUTO mode not work properly). Note: This option does not affect Integrated Remote Console video. Also, if you press F9 or F11 during system boot, the configured video connector behavior is overridden, and the video console remains enabled. This lets you reconfigure the Embedded Video Connection option even if the video is disabled.
Type Enumeration
Read Only False
Value Description
Auto Auto
AlwaysDisabled Always Disabled
AlwaysEnabled Always Enabled

EmbeddedDiagnostics (Embedded Diagnostics) Member of Bios.v1_0_0.Bios
Description Use this option to enable or disable Embedded Diagnostics functionality. If disabled, you cannot launch Embedded Diagnostics. Enable this option to use the Embedded Diagnostics functionality.
Type Enumeration
Read Only False
Value Description
Enabled Enabled
Disabled Disabled

EmbeddedSata (Embedded SATA Configuration) Member of Bios.v1_0_0.Bios
Description Important: Smart Array SW RAID is not supported when Boot Mode is set to Legacy BIOS Mode. Use this option to configure the embedded chipset SATA controller. When selecting the Advanced Host Controller Interface (AHCI) or RAID (if supported), make sure the proper operating system drivers are used for proper operation.
Type Enumeration
Read Only False
Value Description
Ahci SATA AHCI Support
Raid Smart Array SW RAID Support

EmbeddedSerialPort (Embedded Serial Port) Member of Bios.v1_0_0.Bios
Description Select this option to assign the logical COM port address and associated default resources to the selected physical serial port. The operating system can overwrite this setting.
Type Enumeration
Read Only False
Value Description
Com1Irq4 COM 1; IRQ4; I/O: 3F8h-3FFh
Com2Irq3 COM 2; IRQ3; I/O: 2F8h-2FFh
Disabled Disabled

EmbeddedUefiShell (Embedded UEFI Shell) Member of Bios.v1_0_0.Bios
Description Use this option to enable or disable the Embedded UEFI Shell. When enabled, you can launch the Embedded UEFI Shell from the pre-boot environment. When enabled and the Boot Mode is configured for UEFI Mode, you can add the Embedded UEFI Shell to the UEFI Boot Order list by selecting the option entitled ‘Add Embedded UEFI Shell to Boot Order’. When disabled, the Embedded UEFI Shell is not available in the pre-boot environment, and you cannot add it to the UEFI Boot Order list. The Embedded UEFI Shell is a pre-boot command line environment that you can use for scripting and running UEFI applications. It provides CLI-based commands to configure the server, update the System BIOS and other firmware, and obtain system information and error logs.
Type Enumeration
Read Only False
Value Description
Enabled Enabled
Disabled Disabled

EmsConsole (EMS Console) Member of Bios.v1_0_0.Bios
Description Use this option to configure the ACPI serial port settings, which include the ability to redirect the Windows Server Emergency Management console (EMS) through either the physical or virtual serial port.
Type Enumeration
Read Only False
Value Description
Disabled Disabled
Physical Physical Serial Port
Virtual Virtual Serial Port

EnabledCoresPerProc (Enabled Cores per Processor) Member of Bios.v1_0_0.Bios
Description This option enables limiting the number of enabled processor cores per physical processor. You can set the number of enabled cores to a value supported by the physical processor. Setting the value to 0 or a value larger than the number of supported cores of the installed processor will result in all processor cores in the socket being enabled.
Type Integer
Read Only False

EnergyEfficientTurbo (Energy Efficient Turbo) Member of Bios.v1_0_0.Bios
Description This option controls whether the processor uses an energy efficiency based policy when engaging turbo range frequencies. This option is only applicable when Turbo Mode is enabled.
Type Enumeration
Read Only False
Value Description
Enabled Enabled
Disabled Disabled

EnergyPerfBias (Energy/Performance Bias) Member of Bios.v1_0_0.Bios
Description You can only configure this option if the Workload Profile is set to Custom. Use this option to configure several processor subsystems to optimize the performance and power usage of the processor. Balanced Performance provides optimum power efficiency, and is recommended for most environments. Maximum Performance Mode is recommended for environments that require the highest performance and lowest latency but are not sensitive to power consumption. Only use Power Savings Mode in environments that are power sensitive and can accept reduced performance.
Type Enumeration
Read Only False
Value Description
MaxPerf Maximum Performance
BalancedPerf Balanced Performance
BalancedPower Balanced Power
PowerSavingsMode Power Savings Mode

EnhancedProcPerf (Enhanced Processor Performance) Member of Bios.v1_0_0.Bios
Description Use this option to enable the Enhanced Processor Performance setting. When enabled, this option will adjust the processor settings to a more aggressive setting that can result in improved performance, but may result in a higher power consumption.
Type Enumeration
Read Only False
Value Description
Disabled Disabled
Enabled Enabled

EraseUserDefaults (Erase User Defaults) Member of Bios.v1_0_0.Bios
Description Select this option to erase the user defaults backup.
Type Enumeration
Read Only False
Value Description
No No, Cancel
Yes Yes, erase the current settings.

ExtendedAmbientTemp (Extended Ambient Temperature Support) Member of Bios.v1_0_0.Bios
Description Use this option to enable the server to operate at higher ambient temperatures than normally supported. These options are only supported with specific hardware configurations. See your server documentation before configuring the server to enable extended ambient temperature support. Improper system operation or damage to hardware components can result from enabling these options in unsupported configurations. Selecting Enabled for 40c Ambient (ASHRAE 3) enables the server to operate in environments with ambient temperatures up to 40 degrees Celsius. Selecting Enabled for 45c Ambient (ASHRAE 4) enables the server to operate in environments with ambient temperatures up to 45 degrees Celsius. Not all servers support both 40c Ambient (ASHRAE 3) and 45c Ambient (ASHRAE 4).
Type Enumeration
Read Only False
Value Description
Disabled Disabled
ASHRAE3 Enabled for 40c Ambient (ASHRAE 3)
ASHRAE4 Enabled for 45c Ambient (ASHRAE 4)

ExtendedMemTest (Extended Memory Test) Member of Bios.v1_0_0.Bios
Description When enabled, the system validates memory during the memory initialization process. If uncorrectable memory errors are detected, the memory is mapped out, and the failed DIMMs are logged to the Integrated Management Log (IML). Enabling this option can result in a significant increase in the server boot time.
Type Enumeration
Read Only False
Value Description
Enabled Enabled
Disabled Disabled

F11BootMenu (One-Time Boot Menu (F11 Prompt)) Member of Bios.v1_0_0.Bios
Description Use this option to disable the POST One-Time Boot F11 Prompt. Note: When disabled, shell ‘boot’ command is not available for use.
Type Enumeration
Read Only False
Value Description
Enabled Enabled
Disabled Disabled

FCScanPolicy (Fibre Channel/FCoE Scan Policy) Member of Bios.v1_0_0.Bios
Description Use this option to change the default Fibre Channel or FCoE policy for scanning for boot targets. When configured for Scan All Targets, each installed FC/FCoE adapter scans all available targets. When configured for Scan Configured Targets Only, the FC/FCoE adapters only scan targets that are preconfigured in the devices settings. This option overrides any individual device settings configured in the device-specific setup.This option is only supported in UEFI Mode.
Type Enumeration
Read Only False
Value Description
AllTargets Scan All Targets
CardConfig Scan Configured Targets Only

FanFailPolicy (Fan Failure Policy) Member of Bios.v1_0_0.Bios
Description Use this option to configure how the server reacts when fans fail, resulting in the server not having required fans in operation. When configured for “Shutdown/Halt on Critical Fan Failures,” the server cannot boot or operate when it does not have required fans operating due to one or more fan failures. When configured for “Allow Operation with Critical Fan Failures,” the server can boot and operate if it does not have required fans operating due to one or more fan failures. It is recommended that you configure the Fan Failure Policy to the default state of “Shutdown/Halt on Critical Fan Failures.” Operating without the required fans operating can result in damage to hardware components.
Type Enumeration
Read Only False
Value Description
Shutdown Shutdown/Halt on Critical Fan Failures
Allow Allow Operation with Critical Fan Failures

FanInstallReq (Fan Installation Requirements) Member of Bios.v1_0_0.Bios
Description Use this option to configure how the server reacts when all required fans are not installed. When configured for Enable Messaging, the server displays messages and log events to the Integrated Management Log (IML) when required fans are not installed. The server can still boot and operate. When configured for Disable Messaging, the server does not display messages and log events when required fans are not installed. All indications that the server is operating without required fans are removed. It is recommended that you leave Fan Installation Requirements in the default state of Enable Messaging. Operating without the required fans can result in damage to hardware components.
Type Enumeration
Read Only False
Value Description
EnableMessaging Enable Messaging
DisableMessaging Disable Messaging

FlexLom1Aspm (PCIe Power Management(ASPM)) Member of Bios.v1_0_0.Bios
Description Use this option to configure the PCIe Link Power Management (ASPM) support for the selected device. When configured for L0s Enabled, the selected device’s link enters a standby energy savings state. When configured for L1 Enabled, the selected device’s link enters a lower power standby state at the expense of a longer exit latency. When configured for L1 and L0s Enabled, the selected device’s link enters either power savings mode, depending on link utilization, and provides the highest energy savings.
Type Enumeration
Read Only False
Value Description
Auto Auto
Disabled Disabled
AspmL1Enabled L1 Enabled

FlexLom1Enable (PCIe Device Disable) Member of Bios.v1_0_0.Bios
Description Select this option to enable or disable PCI devices.
Type Enumeration
Read Only False
Value Description
Auto Auto
Disabled Disabled

FlexLom1LinkSpeed (PCIe Link Speed) Member of Bios.v1_0_0.Bios
Description Use this option to configure the PCIe Link Speed for the selected device. When configured for Auto, the selected device trains at the maximum supported speed of the PCIe link. When configured for PCIe Generation 2 Link Speed, the selected device trains at a maximum of PCIe Generation 2 speed. When configured for PCIe Generation Link 1 speed, the selected device trains at a maximum of PCIe Generation 1 speed.
Type Enumeration
Read Only False
Value Description
Auto Auto
PcieGen1 PCIe Generation 1.0
PcieGen2 PCIe Generation 2.0

FlexLom1PCIeOptionROM (PCIe Option ROM) Member of Bios.v1_0_0.Bios
Description Use this option to enable or disable Device Option ROM
Type Enumeration
Read Only False
Value Description
Enabled Enabled
Disabled Disabled

HttpSupport (HTTP Support) Member of Bios.v1_0_0.Bios
Description Use this option to control the UEFI HTTP(s) boot support when in UEFI Mode, and the ‘Discover Shell Auto-Start Script using DHCP’ option under ‘Embedded UEFI Shell’ settings. When ‘Auto’ is selected, the system automatically adds HTTP(S) boot options to the UEFI Boot Order list for every network port that is enabled for Network Boot. Selecting this option enables the system to boot to the HTTP or HTTPS URLs provided by the DHCP server. Any other URLs provided by the DHCP server are ignored. When ‘HTTP only’ is selected, the system automatically adds HTTP boot options to the UEFI Boot Order list for every network port that is enabled for Network Boot. Selecting this option enables the system to boot to the HTTP URLs provided by the DHCP server, and to ignore any HTTPS or other URLs that are provided. When ‘HTTPS only’ is selected, the system automatically adds HTTPS boot options to the UEFI Boot Order list for every network port that is enabled for Network Boot. Selecting this option enables the system to boot to the HTTPS URLs provided by the DHCP server, and to ignore any HTTP or other URLs that are provided. To enable HTTPS boot either by selecting ‘Auto’ or ‘HTTPS only’, you must enroll the respective TLS certificate of the HTTPS server under Server Security > TLS(HTTPS) Options. Note: This setting only affects the HTTP boot options added for the network ports, and the Discover Shell Auto-Start Script provided by the DHCP server. Other settings, such as Boot from URL, are not affected by this setting.
Type Enumeration
Read Only False
Value Description
Auto Auto
HttpsOnly HTTPS only
HttpOnly HTTP only
Disabled Disabled

HwPrefetcher (HW Prefetcher) Member of Bios.v1_0_0.Bios
Description Use this option to disable the processor HW prefetch feature. In some cases, setting this option to disabled can improve performance. Typically, setting this option to enabled provides better performance. Only disable this option after performing application benchmarking to verify improved performance in the environment.
Type Enumeration
Read Only False
Value Description
Enabled Enabled
Disabled Disabled

IntelDmiLinkFreq (Intel DMI Link Frequency) Member of Bios.v1_0_0.Bios
Description Use this option to force the link speed between the processor and the southbridge to run at slower speeds to save power.
Type Enumeration
Read Only False
Value Description
Auto Auto
DmiGen1 Gen 1 Speed
DmiGen2 Gen 2 Speed

IntelNicDmaChannels (Intel NIC DMA Channels (IOAT)) Member of Bios.v1_0_0.Bios
Description Use this option to select the Intel NIC DMA Channels support. This is a NIC acceleration option that only runs on Intel-based NICs.
Type Enumeration
Read Only False
Value Description
Enabled Enabled
Disabled Disabled

IntelPerfMonitoring (Intel Performance Monitoring Support) Member of Bios.v1_0_0.Bios
Description This option does not impact performance. When enabled, this option exposes certain chipset devices that can be used with the Intel Performance Monitoring Toolkit.
Type Enumeration
Read Only False
Value Description
Disabled Disabled
Enabled Enabled

IntelProcVtd (Intel® VT-d) Member of Bios.v1_0_0.Bios
Description If enabled, a hypervisor or operating system supporting this option can use hardware capabilities provided by Intel VT for Directed I/O. You can leave this set to enabled even if you are not using a hypervisor or an operating system that uses this option.
Type Enumeration
Read Only False
Value Description
Enabled Enabled
Disabled Disabled

IntelSpeedSelect (Intel® Speed Select) Member of Bios.v1_0_0.Bios
Description Intel® Speed Select is available on only certain processor models.Speed Select processors have unique configurations that support higher base frequencies with fewer enabled core counts. Changing this setting will result in increasing the CPU base frequency along with a reduction in number of available cores. Consult documentation for the installed processor model for more information and core/frequency mappings of each configuration.
Type Enumeration
Read Only False
Value Description
Base Base
Config1 Config 1
Config2 Config 2

IntelTxt (Intel® TXT Support) Member of Bios.v1_0_0.Bios
Description Use this option to modify Intel TXT support.
Type Enumeration
Read Only False
Value Description
Enabled Enabled
Disabled Disabled

IntelUpiFreq (Intel UPI Link Frequency) Member of Bios.v1_0_0.Bios
Description Use this option to set the UPI Link frequency to a lower speed. Running at a lower frequency can reduce power consumption, but can also affect system performance. You can only configure this option if two or more CPUs are present and the Workload Profile is set to custom.
Type Enumeration
Read Only False
Value Description
Auto Auto
MinUpiSpeed Min UPI Speed

IntelUpiLinkEn (Intel UPI Link Enablement) Member of Bios.v1_0_0.Bios
Description Use this option to configure the UPI topology to use fewer links between processors, when available. Changing from the default can reduce UPI bandwidth performance in exchange for less power consumption.
Type Enumeration
Read Only False
Value Description
Auto Auto
SingleLink Single Link Operation

IntelUpiPowerManagement (Intel UPI Link Power Management) Member of Bios.v1_0_0.Bios
Description Use this option to place the Quick Path Interconnect (UPI) links into a low power state when the links are not being used. This lowers power usage with minimal effect on performance. You can only configure this option if two or more CPUs are present and the Workload Profile is set to custom.
Type Enumeration
Read Only False
Value Description
Enabled Enabled
Disabled Disabled

IntelligentProvisioning (Intelligent Provisioning (F10 Prompt)) Member of Bios.v1_0_0.Bios
Description Use this option to enable or disable the Intelligent Provisioning functionality. When disabled, you are prevented from entering the Intelligent Provisioning environment by pressing F10 during server boot. You must set this option to enabled to use Intelligent Provisioning functionality.
Type Enumeration
Read Only False
Value Description
Enabled Enabled
Disabled Disabled

InternalSDCardSlot (Internal SD Card Slot) Member of Bios.v1_0_0.Bios
Description Use this option to enable or disable the Internal SD Card Slot. When set to disabled, the SD card slot is disabled, regardless of whether an SD Card is installed or not. The SD Card will not be visible in the pre-boot environment or under the operating system.
Type Enumeration
Read Only False
Value Description
Enabled Enabled
Disabled Disabled

Ipv4Address (IPv4 Address) Member of Bios.v1_0_0.Bios
Description Use this option to specify the pre-boot network IPv4 address. Enter a static IP address using dotted-decimal notation (for example, 127.0.0.1). If DHCP is used (the DHCPv4 option is enabled), this setting is unavailable because the value is supplied automatically.
Type String
Read Only False

Ipv4Gateway (IPv4 Gateway) Member of Bios.v1_0_0.Bios
Description Use this option to specify the pre-boot network gateway IPv4 address. Enter a static IP address using dotted-decimal notation (for example, 127.0.0.1). If DHCP is used (the DHCPv4 option is enabled), this setting is unavailable because the value is supplied automatically.
Type String
Read Only False

Ipv4PrimaryDNS (IPv4 Primary DNS) Member of Bios.v1_0_0.Bios
Description Use this option to specify the pre-boot network Primary DNS Server IPv4 address. Enter a static IP address using dotted-decimal notation (for example, 127.0.0.1). If DHCP is used (the DHCPv4 option is enabled), this setting is unavailable because the value is supplied automatically.
Type String
Read Only False

Ipv4SecondaryDNS (IPv4 Secondary DNS) Member of Bios.v1_0_0.Bios
Description Use this option to specify the pre-boot network Secondary DNS Server IPv4 address. Enter a static IP address using dotted-decimal notation (for example, 127.0.0.1). If DHCP is used (the DHCPv4 option is enabled), this setting is unavailable because the value is supplied automatically.
Type String
Read Only False

Ipv4SubnetMask (IPv4 Subnet Mask) Member of Bios.v1_0_0.Bios
Description Use this option to specify the pre-boot network subnet mask. Enter a static IP address using dotted-decimal notation (for example, 255.255.255.0). If DHCP is used (the DHCPv4 option is enabled), this setting is unavailable because the value is supplied automatically.
Type String
Read Only False

Ipv6Address (IPv6 Address) Member of Bios.v1_0_0.Bios
Description Use this option to specify the pre-boot network IPv6 address. Enter a static IP address in the standard colon seperated format (for example, 1234::1000). If IPv6 Config Policy is set to Automatic, this setting is unavailable because the value is supplied automatically.
Type String
Read Only False

Ipv6ConfigPolicy (IPv6 Config Policy) Member of Bios.v1_0_0.Bios
Description When set to Automatic, this option enables obtaining the pre-boot network IPv6 configuration automatically. Individual settings are not available. When set to Manual, you must configure static IP address settings individually.
Type Enumeration
Read Only False
Value Description
Automatic Automatic
Manual Manual

Ipv6Duid (IPv6 DHCP Unique Identifier) Member of Bios.v1_0_0.Bios
Description Use this option to control the IPv6 DHCP Unique Identifier (DUID). If configured for Auto, the DUID is set using the Universal Unique Identifier (UUID) of the server, or using the DUID-LLT method if the server UUID is not available. If configured for DUID-LLT, the DUID is set based on the Link-layer Address Plus Time [DUID-LLT] method.
Type Enumeration
Read Only False
Value Description
Auto Auto
DuidLlt DUID-LLT

Ipv6Gateway (IPv6 Gateway) Member of Bios.v1_0_0.Bios
Description Use this option to specify the pre-boot network gateway IPv6 address. Enter a static IP address in the standard colon seperated format (for example, 1234::1000). If IPv6 Config Policy is set to Automatic, this setting is unavailable because the value is supplied automatically.
Type String
Read Only False

Ipv6PrimaryDNS (IPv6 Primary DNS) Member of Bios.v1_0_0.Bios
Description Use this option to specify the pre-boot network Primary DNS Server IPv6 address. Enter a static IP address in the standard colon seperated format (for example, 1234::1000). If IPv6 Config Policy is set to Automatic, this setting is unavailable because the value is supplied automatically.
Type String
Read Only False

Ipv6SecondaryDNS (IPv6 Secondary DNS) Member of Bios.v1_0_0.Bios
Description Use this option to specify the pre-boot network Secondary DNS Server IPv6 address. Enter a static IP address in the standard colon seperated format (for example, 1234::1000). If IPv6 Config Policy is set to Automatic, this setting is unavailable because the value is supplied automatically.
Type String
Read Only False

LLCDeadLineAllocation (LLC Dead Line Allocation) Member of Bios.v1_0_0.Bios
Description Enable - Opportunistically fill dead lines in LLC. Disable - Never fill dead lines in LLC.
Type Enumeration
Read Only False
Value Description
Enabled Enabled
Disabled Disabled

LlcPrefetch (LLC Prefetch) Member of Bios.v1_0_0.Bios
Description Use this option to configure the processor Last Level Cache (LLC) prefetch feature. In some cases, setting this option to disabled can improve performance. Typically, setting this option to enabled provides better performance. Only disable this option after performing application benchmarking to verify improved performance in the environment.
Type Enumeration
Read Only False
Value Description
Enabled Enabled
Disabled Disabled

LocalRemoteThreshold (Local/Remote Threshold) Member of Bios.v1_0_0.Bios
Description Local/Remote Threshold setting.
Type Enumeration
Read Only False
Value Description
Auto Auto
Low Low
Medium Medium
High High
Disabled Disabled

MaxMemBusFreqMHz (Maximum Memory Bus Frequency) Member of Bios.v1_0_0.Bios
Description Use this option to configure the memory system to run memory at a lower maximum speed than that supported by the installed processor and DIMM configuration. Setting this option to Auto configures the system to run memory at the maximum speed supported.
Type Enumeration
Read Only False
Value Description
Auto Auto
MaxMemBusFreq2933 2933 MHz
MaxMemBusFreq2667 2667 MHz
MaxMemBusFreq2400 2400 MHz
MaxMemBusFreq2133 2133 MHz
MaxMemBusFreq1867 1867 MHz

MaxPcieSpeed (Maximum PCI Express Speed) Member of Bios.v1_0_0.Bios
Description If a PCI Express device does not run properly at its optimal speed, lowering the speed at which the device is running can address this issue. This option enables you to lower the maximum PCI Express speed at which the server allows PCI Express devices to operate. You can also use it to address issues with problematic PCI Express devices. Setting this value to Maximum Supported configures the platform to run at the maximum speed supported by the platform or the PCIe device, whichever is lower.
Type Enumeration
Read Only False
Value Description
PerPortCtrl Per Port Control
PcieGen1 PCIe Generation 1.0

MemClearWarmReset (Memory Clear on Warm Reset) Member of Bios.v1_0_0.Bios
Description Use this option to configure when memory is cleared on warm resets. When disabled, the contents of memory are only cleared on a warm reset if requested by the operating system. When enabled, memory is cleared on all reboots. Disabling this option can save boot time by skipping the clearing of memory on warm resets.
Type Enumeration
Read Only False
Value Description
Enabled Enabled
Disabled Disabled

MemFastTraining (Memory Fast Training) Member of Bios.v1_0_0.Bios
Description This option enables a boot time reduction by controlling when the BIOS bypasses the full memory training. When enabled, the server bypasses the full memory training during boot, and uses memory parameters determined on a previous boot to decrease boot time. Note that even when enabled, the BIOS performs a full memory training if the DIMM configuration or processor configuration changes, or if there is a change in any BIOS setting related to memory or processor configuration. When disabled, the server performs a full memory training on every server boot.
Type Enumeration
Read Only False
Value Description
Enabled Enabled
Disabled Disabled

MemMirrorMode (Memory Mirroring Mode) Member of Bios.v1_0_0.Bios
Description Use this option to select from the available Memory Mirroring modes. Full Mirror - reserves 50% of the total available memory for mirroring. Partial Mirror (20% above 4GB) - reserves 20% of the total available Memory above 4GB for Mirroring. Partial Mirror (10% above 4GB) - reserves 10% of the total available Memory above 4GB for Mirroring. Partial Mirror (Memory below 4GB) - depending on the memory configuration, sets up 2GB or 3GB of lower memory below 4GB for Mirroring. Partial Mirror (OS Configured) - sets up the system to configure Partial Mirroring at OS level. This option will be not active and grayed out unless Advanced Memory Protection is set to Mirrored Memory with Advanced ECC Support.
Type Enumeration
Read Only False
Value Description
Full Full Mirror
PartialOsConfig Partial Mirror (OS Configured)
PartialFirst4GB Partial Mirror (Memory below 4GB)
Partial10PercentAbove4GB Partial Mirror (10% above 4GB)
Partial20PercentAbove4GB Partial Mirror (20% above 4GB)

MemPatrolScrubbing (Memory Patrol Scrubbing) Member of Bios.v1_0_0.Bios
Description This option corrects memory soft errors so that, over the length of the system runtime, the risk of producing multi-bit and uncorrectable errors is reduced.
Type Enumeration
Read Only False
Value Description
Enabled Enabled
Disabled Disabled

MemRefreshRate (Memory Refresh Rate) Member of Bios.v1_0_0.Bios
Description This option controls the refresh rate of the memory controller and might affect the performance and resiliency of the server memory. It is recommended that you leave this setting in the default state unless indicated in other documentation for this server.
Type Enumeration
Read Only False
Value Description
Refreshx1 1x Refresh
Refreshx2 2x Refresh

MemoryControllerInterleaving (Memory Controller Interleaving) Member of Bios.v1_0_0.Bios
Description Use this option to control the Memory Controller Interleaving option. When set to Auto, the system will automatically enable or disable memory controller interleaving based on the configuration of the system. When set to disabled, the user may force disable memory controller interleaving. In certain memory configurations, setting this option to disabled has showed a performance benefit across all memory in the system. It is recommended to leave this option to set to Auto.
Type Enumeration
Read Only False
Value Description
Auto Auto
Disabled Disabled

MemoryRemap (Memory Remap) Member of Bios.v1_0_0.Bios
Description Use this option to remap memory that may have been previously disabled from the system due to a failure event, such as an uncorrectable memory error. The Remap All Memory Option causes the system to make all memory in the system available again on the next boot. The No Action option leaves any affected memory unavailable to the system.
Type Enumeration
Read Only False
Value Description
NoAction No Action
AllMemory All Memory

MinProcIdlePkgState (Minimum Processor Idle Power Package C-State) Member of Bios.v1_0_0.Bios
Description You can configure this option only if the Workload Profile is set to Custom. Use this option to select the lowest idle package power state (C-state) of the processor. The processor automatically transitions into package C-states based on the Core C-states in which cores on the processor have transitioned. The higher the package C-state, the lower the power usage of that idle package state. (Package C6 (retention) is the lowest power idle package state supported by the processor).
Type Enumeration
Read Only False
Value Description
C6Retention Package C6 (retention) State
C6NonRetention Package C6 (non-retention) State
NoState No Package State

MinProcIdlePower (Minimum Processor Idle Power Core C-State) Member of Bios.v1_0_0.Bios
Description You can only configure this option if Workload Profile is set to Custom. Use this option to select the lowest idle power state (C-state) of the processor that the operating system uses. The higher the C-state, the lower the power usage of that idle state. (C6 is the lowest power idle state supported by the processor).
Type Enumeration
Read Only False
Value Description
C6 C6 State
C1E C1E State
NoCStates No C-states

MixedPowerSupplyReporting (Mixed Power Supply Reporting) Member of Bios.v1_0_0.Bios
Description When enabled, the server logs a message that a mixed power supply configuration is present. When disabled, the server no longer logs messages that a mixed power supply configuration is present.
Type Enumeration
Read Only False
Value Description
Enabled Enabled
Disabled Disabled

NetworkBootRetry (Network Boot Retry Support) Member of Bios.v1_0_0.Bios
Description Use this option to configure the Network Boot Retry Support. When enabled, the system BIOS attempts to boot the network device up to the number of times configured in the Network Boot Retry Count option before attempting to boot the next network device. This setting only takes effect when attempting to boot a network device from the F12 function key and one-time boot options.
Type Enumeration
Read Only False
Value Description
Enabled Enabled
Disabled Disabled

NetworkBootRetryCount (Network Boot Retry Count) Member of Bios.v1_0_0.Bios
Description Use this option to control the number of times the system BIOS attempts to boot a network device. The valid range is from 0 to 20.
Type Integer
Read Only False

NicBoot1 (Embedded NIC 1 Boot) Member of Bios.v1_0_0.Bios
Description Use this option to enable or disable network boot (PXE, iSCSI, FCoE or UEFI HTTP) for the selected NIC. You might need to configure the NIC firmware for the boot option to be active.
Type Enumeration
Read Only False
Value Description
NetworkBoot Network Boot
Disabled Disabled

NicBoot10 (Embedded NIC 10 Boot) Member of Bios.v1_0_0.Bios
Description Use this option to enable or disable network boot (PXE, iSCSI, FCoE or UEFI HTTP) for the selected NIC. You might need to configure the NIC firmware for the boot option to be active.
Type Enumeration
Read Only False
Value Description
NetworkBoot Network Boot
Disabled Disabled

NicBoot11 (Embedded NIC 11 Boot) Member of Bios.v1_0_0.Bios
Description Use this option to enable or disable network boot (PXE, iSCSI, FCoE or UEFI HTTP) for the selected NIC. You might need to configure the NIC firmware for the boot option to be active.
Type Enumeration
Read Only False
Value Description
NetworkBoot Network Boot
Disabled Disabled

NicBoot12 (Embedded NIC 12 Boot) Member of Bios.v1_0_0.Bios
Description Use this option to enable or disable network boot (PXE, iSCSI, FCoE or UEFI HTTP) for the selected NIC. You might need to configure the NIC firmware for the boot option to be active.
Type Enumeration
Read Only False
Value Description
NetworkBoot Network Boot
Disabled Disabled

NicBoot2 (Embedded NIC 2 Boot) Member of Bios.v1_0_0.Bios
Description Use this option to enable or disable network boot (PXE, iSCSI, FCoE or UEFI HTTP) for the selected NIC. You might need to configure the NIC firmware for the boot option to be active.
Type Enumeration
Read Only False
Value Description
NetworkBoot Network Boot
Disabled Disabled

NicBoot3 (Embedded NIC 3 Boot) Member of Bios.v1_0_0.Bios
Description Use this option to enable or disable network boot (PXE, iSCSI, FCoE or UEFI HTTP) for the selected NIC. You might need to configure the NIC firmware for the boot option to be active.
Type Enumeration
Read Only False
Value Description
NetworkBoot Network Boot
Disabled Disabled

NicBoot4 (Embedded NIC 4 Boot) Member of Bios.v1_0_0.Bios
Description Use this option to enable or disable network boot (PXE, iSCSI, FCoE or UEFI HTTP) for the selected NIC. You might need to configure the NIC firmware for the boot option to be active.
Type Enumeration
Read Only False
Value Description
NetworkBoot Network Boot
Disabled Disabled

NicBoot5 (Embedded NIC 5 Boot) Member of Bios.v1_0_0.Bios
Description Use this option to enable or disable network boot (PXE, iSCSI, FCoE or UEFI HTTP) for the selected NIC. You might need to configure the NIC firmware for the boot option to be active.
Type Enumeration
Read Only False
Value Description
NetworkBoot Network Boot
Disabled Disabled

NicBoot6 (Embedded NIC 6 Boot) Member of Bios.v1_0_0.Bios
Description Use this option to enable or disable network boot (PXE, iSCSI, FCoE or UEFI HTTP) for the selected NIC. You might need to configure the NIC firmware for the boot option to be active.
Type Enumeration
Read Only False
Value Description
NetworkBoot Network Boot
Disabled Disabled

NicBoot7 (Embedded NIC 7 Boot) Member of Bios.v1_0_0.Bios
Description Use this option to enable or disable network boot (PXE, iSCSI, FCoE or UEFI HTTP) for the selected NIC. You might need to configure the NIC firmware for the boot option to be active.
Type Enumeration
Read Only False
Value Description
NetworkBoot Network Boot
Disabled Disabled

NicBoot8 (Embedded NIC 8 Boot) Member of Bios.v1_0_0.Bios
Description Use this option to enable or disable network boot (PXE, iSCSI, FCoE or UEFI HTTP) for the selected NIC. You might need to configure the NIC firmware for the boot option to be active.
Type Enumeration
Read Only False
Value Description
NetworkBoot Network Boot
Disabled Disabled

NicBoot9 (Embedded NIC 9 Boot) Member of Bios.v1_0_0.Bios
Description Use this option to enable or disable network boot (PXE, iSCSI, FCoE or UEFI HTTP) for the selected NIC. You might need to configure the NIC firmware for the boot option to be active.
Type Enumeration
Read Only False
Value Description
NetworkBoot Network Boot
Disabled Disabled

NodeInterleaving (Node Interleaving) Member of Bios.v1_0_0.Bios
Description Use this option to disable the NUMA architecture properties for the system. All operating system platforms support NUMA architectures. In most cases, optimum performance is obtained by disabling the Node Interleaving option. When this option is enabled, memory addresses are interleaved across the memory installed for each processor. Some workloads might experience improved performance when this option is enabled. Node Interleaving cannot be enabled when NVDIMMs are present in the system.
Type Enumeration
Read Only False
Value Description
Enabled Enabled
Disabled Disabled

NumaGroupSizeOpt (NUMA Group Size Optimization) Member of Bios.v1_0_0.Bios
Description Use this option to configure how the System BIOS reports the size of a NUMA node (number of logical processors), which assists the Operating System in grouping processors for application use (referred to as Kgroups). The default setting of Clustered provides better performance due to optimizing the resulting groups along NUMA boundaries. However, some applications might not be optimized to take advantage of processors spanning multiple groups. In such cases, selecting the Flat option might be necessary in order for those applications to utilize more logical processors.
Type Enumeration
Read Only False
Value Description
Flat Flat
Clustered Clustered

NvDimmNMemFunctionality (NVDIMM-N Support) Member of Bios.v1_0_0.Bios
Description This option controls whether NVDIMM-N support (including backing up the contents of the memory to flash on power down or reset) is enabled. If this option is configured for Disabled, then the NVDIMMs of type NVDIMM-N in the system are NOT used by the operating system as persistent storage, and are NOT used by the operating system as system memory.
Type Enumeration
Read Only False
Value Description
Enabled Enabled
Disabled Disabled

NvDimmNMemInterleaving (NVDIMM-N Interleaving) Member of Bios.v1_0_0.Bios
Description This option controls whether the NVDIMMs of type NVDIMM-N installed on a particular processor will be interleaved with each other in the memory map. This option does NOT impact the interleaving of standard DIMMs, and interleaving is never enabled across NVDIMMs of type NVDIMM-N and standard DIMMs. NVDIMMs of type NVDIMM-N installed on different processors are never interleaved together. If this setting is changed, then all installed NVDIMMs of type NVDIMM-N must be sanitized.
Type Enumeration
Read Only False
Value Description
Enabled Enabled
Disabled Disabled

NvDimmNSanitizePolicy (NVDIMM-N Sanitize/Erase on Next Reboot Policy) Member of Bios.v1_0_0.Bios
Description This option is used to Sanitize/Erase all user data and error status data saved in the selected NVDIMMs of type NVDIMM-N. Selected NVDIMMs of type NVDIMM-N are sanitized/erased on the next reboot of the system. This process is required BEFORE the NVDIMM-N Memory Interleaving option can be modified. An NVDIMM-N must be sanitized/erased when it is initially installed in the system or installed in a different DIMM slot on the system. In addition, an NVDIMM-N can be recovered to normal operation if it has received an Uncorrectable Memory Error, a Backup Error, a Restore Error, or an Arming Error (if the NVDIMM hardware is functional). Note that the largest group of NVDIMMs of type NVDIMM-N selected are sanitized/erased. For instance, if ‘Sanitize/Erase all NVDIMM-N on Processor 1’ is enabled and ‘Sanitize/Erase Processor 1 DIMM 8’ is disabled, all NVDIMMs of type NVDIMM-N on Processor 1 are sanitized/erased including Processor 1 DIMM 8. There are four policies that control the action of the system after NVDIMMs of type NVDIMM-N are sanitized/erased. The options are to power off the system after sanitizing/erasing NVDIMMs, to enable the system to boot to the operating system after sanitizing/erasing NVDIMMs, to boot to the System Utilities after sanitizing/erasing NVDIMMs, or to sanitize/erase the NVDIMMs back to the factory default settings and power off the system. ‘Sanitize/Erase to Factory Defaults and Power System Off’ is recommended when retiring the NVDIMMs with no intention of reuse.
Type Enumeration
Read Only False
Value Description
Disabled Disabled
SanitizeAndRebootSystem Sanitize/Erase and Boot to Operating System
SanitizeAndShutdownSystem Sanitize/Erase and Power System Off
SanitizeAndBootToFirmwareUI Sanitize/Erase and Boot to System Utilities
SanitizeToFactoryDefaults Sanitize/Erase to Factory Defaults and Power System Off

NvdimmLabelSupport (NVDIMM-N OS Label Support) Member of Bios.v1_0_0.Bios
Description Use this option to enable NVDIMM OS Label support via the ACPI methods _LSI, _LSR, and _LSW.When this option is enabled, the ACPI methods will be generated for each active NVDIMM in the system. When this option is disabled, those methods will not be generated. This option does NOT apply to Intel Optane Memory devices.
Type Enumeration
Read Only False
Value Description
Enabled Enabled
Disabled Disabled

NvmeFormat1 (NVMe Drive 1) Member of Bios.v1_0_0.Bios
Description Use this option to decommission NVM Express drives. Selected NVM Express drives are securely erased in the following boot.
Type Enumeration
Read Only False
Value Description
Enabled Enabled
Disabled Disabled

NvmeFormat10 (NVMe Drive 10) Member of Bios.v1_0_0.Bios
Description Use this option to decommission NVM Express drives. Selected NVM Express drives are securely erased in the following boot.
Type Enumeration
Read Only False
Value Description
Enabled Enabled
Disabled Disabled

NvmeFormat11 (NVMe Drive 11) Member of Bios.v1_0_0.Bios
Description Use this option to decommission NVM Express drives. Selected NVM Express drives are securely erased in the following boot.
Type Enumeration
Read Only False
Value Description
Enabled Enabled
Disabled Disabled

NvmeFormat12 (NVMe Drive 12) Member of Bios.v1_0_0.Bios
Description Use this option to decommission NVM Express drives. Selected NVM Express drives are securely erased in the following boot.
Type Enumeration
Read Only False
Value Description
Enabled Enabled
Disabled Disabled

NvmeFormat13 (NVMe Drive 13) Member of Bios.v1_0_0.Bios
Description Use this option to decommission NVM Express drives. Selected NVM Express drives are securely erased in the following boot.
Type Enumeration
Read Only False
Value Description
Enabled Enabled
Disabled Disabled

NvmeFormat14 (NVMe Drive 14) Member of Bios.v1_0_0.Bios
Description Use this option to decommission NVM Express drives. Selected NVM Express drives are securely erased in the following boot.
Type Enumeration
Read Only False
Value Description
Enabled Enabled
Disabled Disabled

NvmeFormat15 (NVMe Drive 15) Member of Bios.v1_0_0.Bios
Description Use this option to decommission NVM Express drives. Selected NVM Express drives are securely erased in the following boot.
Type Enumeration
Read Only False
Value Description
Enabled Enabled
Disabled Disabled

NvmeFormat16 (NVMe Drive 16) Member of Bios.v1_0_0.Bios
Description Use this option to decommission NVM Express drives. Selected NVM Express drives are securely erased in the following boot.
Type Enumeration
Read Only False
Value Description
Enabled Enabled
Disabled Disabled

NvmeFormat17 (NVMe Drive 17) Member of Bios.v1_0_0.Bios
Description Use this option to decommission NVM Express drives. Selected NVM Express drives are securely erased in the following boot.
Type Enumeration
Read Only False
Value Description
Enabled Enabled
Disabled Disabled

NvmeFormat18 (NVMe Drive 18) Member of Bios.v1_0_0.Bios
Description Use this option to decommission NVM Express drives. Selected NVM Express drives are securely erased in the following boot.
Type Enumeration
Read Only False
Value Description
Enabled Enabled
Disabled Disabled

NvmeFormat19 (NVMe Drive 19) Member of Bios.v1_0_0.Bios
Description Use this option to decommission NVM Express drives. Selected NVM Express drives are securely erased in the following boot.
Type Enumeration
Read Only False
Value Description
Enabled Enabled
Disabled Disabled

NvmeFormat2 (NVMe Drive 2) Member of Bios.v1_0_0.Bios
Description Use this option to decommission NVM Express drives. Selected NVM Express drives are securely erased in the following boot.
Type Enumeration
Read Only False
Value Description
Enabled Enabled
Disabled Disabled

NvmeFormat20 (NVMe Drive 20) Member of Bios.v1_0_0.Bios
Description Use this option to decommission NVM Express drives. Selected NVM Express drives are securely erased in the following boot.
Type Enumeration
Read Only False
Value Description
Enabled Enabled
Disabled Disabled

NvmeFormat21 (NVMe Drive 21) Member of Bios.v1_0_0.Bios
Description Use this option to decommission NVM Express drives. Selected NVM Express drives are securely erased in the following boot.
Type Enumeration
Read Only False
Value Description
Enabled Enabled
Disabled Disabled

NvmeFormat22 (NVMe Drive 22) Member of Bios.v1_0_0.Bios
Description Use this option to decommission NVM Express drives. Selected NVM Express drives are securely erased in the following boot.
Type Enumeration
Read Only False
Value Description
Enabled Enabled
Disabled Disabled

NvmeFormat23 (NVMe Drive 23) Member of Bios.v1_0_0.Bios
Description Use this option to decommission NVM Express drives. Selected NVM Express drives are securely erased in the following boot.
Type Enumeration
Read Only False
Value Description
Enabled Enabled
Disabled Disabled

NvmeFormat24 (NVMe Drive 24) Member of Bios.v1_0_0.Bios
Description Use this option to decommission NVM Express drives. Selected NVM Express drives are securely erased in the following boot.
Type Enumeration
Read Only False
Value Description
Enabled Enabled
Disabled Disabled

NvmeFormat25 (NVMe Drive 25) Member of Bios.v1_0_0.Bios
Description Use this option to decommission NVM Express drives. Selected NVM Express drives are securely erased in the following boot.
Type Enumeration
Read Only False
Value Description
Enabled Enabled
Disabled Disabled

NvmeFormat26 (NVMe Drive 26) Member of Bios.v1_0_0.Bios
Description Use this option to decommission NVM Express drives. Selected NVM Express drives are securely erased in the following boot.
Type Enumeration
Read Only False
Value Description
Enabled Enabled
Disabled Disabled

NvmeFormat27 (NVMe Drive 27) Member of Bios.v1_0_0.Bios
Description Use this option to decommission NVM Express drives. Selected NVM Express drives are securely erased in the following boot.
Type Enumeration
Read Only False
Value Description
Enabled Enabled
Disabled Disabled

NvmeFormat28 (NVMe Drive 28) Member of Bios.v1_0_0.Bios
Description Use this option to decommission NVM Express drives. Selected NVM Express drives are securely erased in the following boot.
Type Enumeration
Read Only False
Value Description
Enabled Enabled
Disabled Disabled

NvmeFormat29 (NVMe Drive 29) Member of Bios.v1_0_0.Bios
Description Use this option to decommission NVM Express drives. Selected NVM Express drives are securely erased in the following boot.
Type Enumeration
Read Only False
Value Description
Enabled Enabled
Disabled Disabled

NvmeFormat3 (NVMe Drive 3) Member of Bios.v1_0_0.Bios
Description Use this option to decommission NVM Express drives. Selected NVM Express drives are securely erased in the following boot.
Type Enumeration
Read Only False
Value Description
Enabled Enabled
Disabled Disabled

NvmeFormat30 (NVMe Drive 30) Member of Bios.v1_0_0.Bios
Description Use this option to decommission NVM Express drives. Selected NVM Express drives are securely erased in the following boot.
Type Enumeration
Read Only False
Value Description
Enabled Enabled
Disabled Disabled

NvmeFormat31 (NVMe Drive 31) Member of Bios.v1_0_0.Bios
Description Use this option to decommission NVM Express drives. Selected NVM Express drives are securely erased in the following boot.
Type Enumeration
Read Only False
Value Description
Enabled Enabled
Disabled Disabled

NvmeFormat32 (NVMe Drive 32) Member of Bios.v1_0_0.Bios
Description Use this option to decommission NVM Express drives. Selected NVM Express drives are securely erased in the following boot.
Type Enumeration
Read Only False
Value Description
Enabled Enabled
Disabled Disabled

NvmeFormat33 (NVMe Drive 33) Member of Bios.v1_0_0.Bios
Description Use this option to decommission NVM Express drives. Selected NVM Express drives are securely erased in the following boot.
Type Enumeration
Read Only False
Value Description
Enabled Enabled
Disabled Disabled

NvmeFormat34 (NVMe Drive 34) Member of Bios.v1_0_0.Bios
Description Use this option to decommission NVM Express drives. Selected NVM Express drives are securely erased in the following boot.
Type Enumeration
Read Only False
Value Description
Enabled Enabled
Disabled Disabled

NvmeFormat35 (NVMe Drive 35) Member of Bios.v1_0_0.Bios
Description Use this option to decommission NVM Express drives. Selected NVM Express drives are securely erased in the following boot.
Type Enumeration
Read Only False
Value Description
Enabled Enabled
Disabled Disabled

NvmeFormat36 (NVMe Drive 36) Member of Bios.v1_0_0.Bios
Description Use this option to decommission NVM Express drives. Selected NVM Express drives are securely erased in the following boot.
Type Enumeration
Read Only False
Value Description
Enabled Enabled
Disabled Disabled

NvmeFormat37 (NVMe Drive 37) Member of Bios.v1_0_0.Bios
Description Use this option to decommission NVM Express drives. Selected NVM Express drives are securely erased in the following boot.
Type Enumeration
Read Only False
Value Description
Enabled Enabled
Disabled Disabled

NvmeFormat38 (NVMe Drive 38) Member of Bios.v1_0_0.Bios
Description Use this option to decommission NVM Express drives. Selected NVM Express drives are securely erased in the following boot.
Type Enumeration
Read Only False
Value Description
Enabled Enabled
Disabled Disabled

NvmeFormat39 (NVMe Drive 39) Member of Bios.v1_0_0.Bios
Description Use this option to decommission NVM Express drives. Selected NVM Express drives are securely erased in the following boot.
Type Enumeration
Read Only False
Value Description
Enabled Enabled
Disabled Disabled

NvmeFormat4 (NVMe Drive 4) Member of Bios.v1_0_0.Bios
Description Use this option to decommission NVM Express drives. Selected NVM Express drives are securely erased in the following boot.
Type Enumeration
Read Only False
Value Description
Enabled Enabled
Disabled Disabled

NvmeFormat40 (NVMe Drive 40) Member of Bios.v1_0_0.Bios
Description Use this option to decommission NVM Express drives. Selected NVM Express drives are securely erased in the following boot.
Type Enumeration
Read Only False
Value Description
Enabled Enabled
Disabled Disabled

NvmeFormat41 (NVMe Drive 41) Member of Bios.v1_0_0.Bios
Description Use this option to decommission NVM Express drives. Selected NVM Express drives are securely erased in the following boot.
Type Enumeration
Read Only False
Value Description
Enabled Enabled
Disabled Disabled

NvmeFormat42 (NVMe Drive 42) Member of Bios.v1_0_0.Bios
Description Use this option to decommission NVM Express drives. Selected NVM Express drives are securely erased in the following boot.
Type Enumeration
Read Only False
Value Description
Enabled Enabled
Disabled Disabled

NvmeFormat43 (NVMe Drive 43) Member of Bios.v1_0_0.Bios
Description Use this option to decommission NVM Express drives. Selected NVM Express drives are securely erased in the following boot.
Type Enumeration
Read Only False
Value Description
Enabled Enabled
Disabled Disabled

NvmeFormat44 (NVMe Drive 44) Member of Bios.v1_0_0.Bios
Description Use this option to decommission NVM Express drives. Selected NVM Express drives are securely erased in the following boot.
Type Enumeration
Read Only False
Value Description
Enabled Enabled
Disabled Disabled

NvmeFormat45 (NVMe Drive 45) Member of Bios.v1_0_0.Bios
Description Use this option to decommission NVM Express drives. Selected NVM Express drives are securely erased in the following boot.
Type Enumeration
Read Only False
Value Description
Enabled Enabled
Disabled Disabled

NvmeFormat46 (NVMe Drive 46) Member of Bios.v1_0_0.Bios
Description Use this option to decommission NVM Express drives. Selected NVM Express drives are securely erased in the following boot.
Type Enumeration
Read Only False
Value Description
Enabled Enabled
Disabled Disabled

NvmeFormat47 (NVMe Drive 47) Member of Bios.v1_0_0.Bios
Description Use this option to decommission NVM Express drives. Selected NVM Express drives are securely erased in the following boot.
Type Enumeration
Read Only False
Value Description
Enabled Enabled
Disabled Disabled

NvmeFormat48 (NVMe Drive 48) Member of Bios.v1_0_0.Bios
Description Use this option to decommission NVM Express drives. Selected NVM Express drives are securely erased in the following boot.
Type Enumeration
Read Only False
Value Description
Enabled Enabled
Disabled Disabled

NvmeFormat49 (NVMe Drive 49) Member of Bios.v1_0_0.Bios
Description Use this option to decommission NVM Express drives. Selected NVM Express drives are securely erased in the following boot.
Type Enumeration
Read Only False
Value Description
Enabled Enabled
Disabled Disabled

NvmeFormat5 (NVMe Drive 5) Member of Bios.v1_0_0.Bios
Description Use this option to decommission NVM Express drives. Selected NVM Express drives are securely erased in the following boot.
Type Enumeration
Read Only False
Value Description
Enabled Enabled
Disabled Disabled

NvmeFormat50 (NVMe Drive 50) Member of Bios.v1_0_0.Bios
Description Use this option to decommission NVM Express drives. Selected NVM Express drives are securely erased in the following boot.
Type Enumeration
Read Only False
Value Description
Enabled Enabled
Disabled Disabled

NvmeFormat6 (NVMe Drive 6) Member of Bios.v1_0_0.Bios
Description Use this option to decommission NVM Express drives. Selected NVM Express drives are securely erased in the following boot.
Type Enumeration
Read Only False
Value Description
Enabled Enabled
Disabled Disabled

NvmeFormat7 (NVMe Drive 7) Member of Bios.v1_0_0.Bios
Description Use this option to decommission NVM Express drives. Selected NVM Express drives are securely erased in the following boot.
Type Enumeration
Read Only False
Value Description
Enabled Enabled
Disabled Disabled

NvmeFormat8 (NVMe Drive 8) Member of Bios.v1_0_0.Bios
Description Use this option to decommission NVM Express drives. Selected NVM Express drives are securely erased in the following boot.
Type Enumeration
Read Only False
Value Description
Enabled Enabled
Disabled Disabled

NvmeFormat9 (NVMe Drive 9) Member of Bios.v1_0_0.Bios
Description Use this option to decommission NVM Express drives. Selected NVM Express drives are securely erased in the following boot.
Type Enumeration
Read Only False
Value Description
Enabled Enabled
Disabled Disabled

NvmeOptionRom (Embedded NVM Express Option ROM) Member of Bios.v1_0_0.Bios
Description Use this option to enable or disable embedded NVM Express Option ROM. When enabled, the system loads the NVM Express Option ROM provided by the system BIOS. When disabled, the system loads the NVM Express Option ROM provided by the adapter.
Type Enumeration
Read Only False
Value Description
Enabled Enabled
Disabled Disabled

OpportunisticSelfRefresh (Opportunistic Self-Refresh) Member of Bios.v1_0_0.Bios
Description Enables or disables opportunistic self-refresh.
Type Enumeration
Read Only False
Value Description
Enabled Enabled
Disabled Disabled

PciPeerToPeerSerialization (PCI Peer to Peer Serialization) Member of Bios.v1_0_0.Bios
Description Select this option to configure the PCIe Peer to Peer Serialization Option. When set to enabled, PCIe transactions are interleaved across PCIe root ports of a processor which can result in increased performance in peer to peer communication. Certain configurations such as systems populated with multiple GPUs on a processor socket may see increased performance when this feature is enabled.
Type Enumeration
Read Only False
Value Description
Enabled Enabled
Disabled Disabled

PciResourcePadding (NVMe PCIe Resource Padding) Member of Bios.v1_0_0.Bios
Description Use this option to configure PCIe resources to support PCIe hot-add for NVMe drives. When Normal is selected, PCIe resources are only allocated to devices installed at boot time, and PCIe hot-add is not supported. When Medium is selected, additional PCIe resources are allocated for each PCIe Root Port, which might enable a PCIe hot-add event to work without requiring a system reboot to enumerate the device. When High is selected, a maximum amount of PCIe resources are set aside to allow for the best chance of supporting a PCIe hot-add event.
Type Enumeration
Read Only False
Value Description
Normal Normal
Medium Medium
High High

PciSlot1Aspm (PCIe Power Management(ASPM)) Member of Bios.v1_0_0.Bios
Description Use this option to configure the PCIe Link Power Management (ASPM) support for the selected device. When configured for L0s Enabled, the selected device’s link enters a standby energy savings state. When configured for L1 Enabled, the selected device’s link enters a lower power standby state at the expense of a longer exit latency. When configured for L1 and L0s Enabled, the selected device’s link enters either power savings mode, depending on link utilization, and provides the highest energy savings.
Type Enumeration
Read Only False
Value Description
Auto Auto
Disabled Disabled
AspmL1Enabled L1 Enabled

PciSlot1Bifurcation (PCIe Slot 1 Bifurcation) Member of Bios.v1_0_0.Bios
Description Use this option to bifurcate the selected PCIe slot. When Auto is selected, the PCIe slot will train at the maximum width supported by the slot and end point. When Slot Bifurcated is selected, the PCIe slot will be bifurcated into two equal width slots. When Slot Dual Bifurcate (quadfurcate) is selected, the PCIe slot will be bifurcated into four equal width slots.Note: Only change this option if the device installed in the slot supports this capability.
Type Enumeration
Read Only False
Value Description
Auto Auto
SlotBifurcated Bifurcate
SlotDualBifurcated Dual Bifurcate

PciSlot1Enable (PCIe Device Disable) Member of Bios.v1_0_0.Bios
Description Select this option to enable or disable PCI devices.
Type Enumeration
Read Only False
Value Description
Auto Auto
Disabled Disabled

PciSlot1LinkSpeed (PCIe Link Speed) Member of Bios.v1_0_0.Bios
Description Use this option to configure the PCIe Link Speed for the selected device. When configured for Auto, the selected device trains at the maximum supported speed of the PCIe link. When configured for PCIe Generation 2 Link Speed, the selected device trains at a maximum of PCIe Generation 2 speed. When configured for PCIe Generation Link 1 speed, the selected device trains at a maximum of PCIe Generation 1 speed.
Type Enumeration
Read Only False
Value Description
Auto Auto
PcieGen1 PCIe Generation 1.0
PcieGen2 PCIe Generation 2.0

PciSlot1OptionROM (PCIe Option ROM) Member of Bios.v1_0_0.Bios
Description Use this option to enable or disable Device Option ROM
Type Enumeration
Read Only False
Value Description
Enabled Enabled
Disabled Disabled

PciSlot2Aspm (PCIe Power Management(ASPM)) Member of Bios.v1_0_0.Bios
Description Use this option to configure the PCIe Link Power Management (ASPM) support for the selected device. When configured for L0s Enabled, the selected device’s link enters a standby energy savings state. When configured for L1 Enabled, the selected device’s link enters a lower power standby state at the expense of a longer exit latency. When configured for L1 and L0s Enabled, the selected device’s link enters either power savings mode, depending on link utilization, and provides the highest energy savings.
Type Enumeration
Read Only False
Value Description
Auto Auto
Disabled Disabled
AspmL1Enabled L1 Enabled

PciSlot2Bifurcation (PCIe Slot 2 Bifurcation) Member of Bios.v1_0_0.Bios
Description Use this option to bifurcate the selected PCIe slot. When Auto is selected, the PCIe slot will train at the maximum width supported by the slot and end point. When Slot Bifurcated is selected, the PCIe slot will be bifurcated into two equal width slots. When Slot Dual Bifurcate (quadfurcate) is selected, the PCIe slot will be bifurcated into four equal width slots.Note: Only change this option if the device installed in the slot supports this capability.
Type Enumeration
Read Only False
Value Description
Auto Auto
SlotBifurcated Bifurcate
SlotDualBifurcated Dual Bifurcate

PciSlot2Enable (PCIe Device Disable) Member of Bios.v1_0_0.Bios
Description Select this option to enable or disable PCI devices.
Type Enumeration
Read Only False
Value Description
Auto Auto
Disabled Disabled

PciSlot2LinkSpeed (PCIe Link Speed) Member of Bios.v1_0_0.Bios
Description Use this option to configure the PCIe Link Speed for the selected device. When configured for Auto, the selected device trains at the maximum supported speed of the PCIe link. When configured for PCIe Generation 2 Link Speed, the selected device trains at a maximum of PCIe Generation 2 speed. When configured for PCIe Generation Link 1 speed, the selected device trains at a maximum of PCIe Generation 1 speed.
Type Enumeration
Read Only False
Value Description
Auto Auto
PcieGen1 PCIe Generation 1.0
PcieGen2 PCIe Generation 2.0

PciSlot2OptionROM (PCIe Option ROM) Member of Bios.v1_0_0.Bios
Description Use this option to enable or disable Device Option ROM
Type Enumeration
Read Only False
Value Description
Enabled Enabled
Disabled Disabled

PciSlot3Aspm (PCIe Power Management(ASPM)) Member of Bios.v1_0_0.Bios
Description Use this option to configure the PCIe Link Power Management (ASPM) support for the selected device. When configured for L0s Enabled, the selected device’s link enters a standby energy savings state. When configured for L1 Enabled, the selected device’s link enters a lower power standby state at the expense of a longer exit latency. When configured for L1 and L0s Enabled, the selected device’s link enters either power savings mode, depending on link utilization, and provides the highest energy savings.
Type Enumeration
Read Only False
Value Description
Auto Auto
Disabled Disabled
AspmL1Enabled L1 Enabled

PciSlot3Bifurcation (PCIe Slot 3 Bifurcation) Member of Bios.v1_0_0.Bios
Description Use this option to bifurcate the selected PCIe slot. When Auto is selected, the PCIe slot will train at the maximum width supported by the slot and end point. When Slot Bifurcated is selected, the PCIe slot will be bifurcated into two equal width slots. When Slot Dual Bifurcate (quadfurcate) is selected, the PCIe slot will be bifurcated into four equal width slots.Note: Only change this option if the device installed in the slot supports this capability.
Type Enumeration
Read Only False
Value Description
Auto Auto
SlotBifurcated Bifurcate
SlotDualBifurcated Dual Bifurcate

PciSlot3Enable (PCIe Device Disable) Member of Bios.v1_0_0.Bios
Description Select this option to enable or disable PCI devices.
Type Enumeration
Read Only False
Value Description
Auto Auto
Disabled Disabled

PciSlot3LinkSpeed (PCIe Link Speed) Member of Bios.v1_0_0.Bios
Description Use this option to configure the PCIe Link Speed for the selected device. When configured for Auto, the selected device trains at the maximum supported speed of the PCIe link. When configured for PCIe Generation 2 Link Speed, the selected device trains at a maximum of PCIe Generation 2 speed. When configured for PCIe Generation Link 1 speed, the selected device trains at a maximum of PCIe Generation 1 speed.
Type Enumeration
Read Only False
Value Description
Auto Auto
PcieGen1 PCIe Generation 1.0
PcieGen2 PCIe Generation 2.0

PciSlot3OptionROM (PCIe Option ROM) Member of Bios.v1_0_0.Bios
Description Use this option to enable or disable Device Option ROM
Type Enumeration
Read Only False
Value Description
Enabled Enabled
Disabled Disabled

PciSlot4Aspm (PCIe Power Management(ASPM)) Member of Bios.v1_0_0.Bios
Description Use this option to configure the PCIe Link Power Management (ASPM) support for the selected device. When configured for L0s Enabled, the selected device’s link enters a standby energy savings state. When configured for L1 Enabled, the selected device’s link enters a lower power standby state at the expense of a longer exit latency. When configured for L1 and L0s Enabled, the selected device’s link enters either power savings mode, depending on link utilization, and provides the highest energy savings.
Type Enumeration
Read Only False
Value Description
Auto Auto
Disabled Disabled
AspmL1Enabled L1 Enabled

PciSlot4Bifurcation (PCIe Slot 4 Bifurcation) Member of Bios.v1_0_0.Bios
Description Use this option to bifurcate the selected PCIe slot. When Auto is selected, the PCIe slot will train at the maximum width supported by the slot and end point. When Slot Bifurcated is selected, the PCIe slot will be bifurcated into two equal width slots. When Slot Dual Bifurcate (quadfurcate) is selected, the PCIe slot will be bifurcated into four equal width slots.Note: Only change this option if the device installed in the slot supports this capability.
Type Enumeration
Read Only False
Value Description
Auto Auto
SlotBifurcated Bifurcate
SlotDualBifurcated Dual Bifurcate

PciSlot4Enable (PCIe Device Disable) Member of Bios.v1_0_0.Bios
Description Select this option to enable or disable PCI devices.
Type Enumeration
Read Only False
Value Description
Auto Auto
Disabled Disabled

PciSlot4LinkSpeed (PCIe Link Speed) Member of Bios.v1_0_0.Bios
Description Use this option to configure the PCIe Link Speed for the selected device. When configured for Auto, the selected device trains at the maximum supported speed of the PCIe link. When configured for PCIe Generation 2 Link Speed, the selected device trains at a maximum of PCIe Generation 2 speed. When configured for PCIe Generation Link 1 speed, the selected device trains at a maximum of PCIe Generation 1 speed.
Type Enumeration
Read Only False
Value Description
Auto Auto
PcieGen1 PCIe Generation 1.0
PcieGen2 PCIe Generation 2.0

PciSlot4OptionROM (PCIe Option ROM) Member of Bios.v1_0_0.Bios
Description Use this option to enable or disable Device Option ROM
Type Enumeration
Read Only False
Value Description
Enabled Enabled
Disabled Disabled

PciSlot5Aspm (PCIe Power Management(ASPM)) Member of Bios.v1_0_0.Bios
Description Use this option to configure the PCIe Link Power Management (ASPM) support for the selected device. When configured for L0s Enabled, the selected device’s link enters a standby energy savings state. When configured for L1 Enabled, the selected device’s link enters a lower power standby state at the expense of a longer exit latency. When configured for L1 and L0s Enabled, the selected device’s link enters either power savings mode, depending on link utilization, and provides the highest energy savings.
Type Enumeration
Read Only False
Value Description
Auto Auto
Disabled Disabled
AspmL1Enabled L1 Enabled

PciSlot5Bifurcation (PCIe Slot 5 Bifurcation) Member of Bios.v1_0_0.Bios
Description Use this option to bifurcate the selected PCIe slot. When Auto is selected, the PCIe slot will train at the maximum width supported by the slot and end point. When Slot Bifurcated is selected, the PCIe slot will be bifurcated into two equal width slots. When Slot Dual Bifurcate (quadfurcate) is selected, the PCIe slot will be bifurcated into four equal width slots.Note: Only change this option if the device installed in the slot supports this capability.
Type Enumeration
Read Only False
Value Description
Auto Auto
SlotBifurcated Bifurcate
SlotDualBifurcated Dual Bifurcate

PciSlot5Enable (PCIe Device Disable) Member of Bios.v1_0_0.Bios
Description Select this option to enable or disable PCI devices.
Type Enumeration
Read Only False
Value Description
Auto Auto
Disabled Disabled

PciSlot5LinkSpeed (PCIe Link Speed) Member of Bios.v1_0_0.Bios
Description Use this option to configure the PCIe Link Speed for the selected device. When configured for Auto, the selected device trains at the maximum supported speed of the PCIe link. When configured for PCIe Generation 2 Link Speed, the selected device trains at a maximum of PCIe Generation 2 speed. When configured for PCIe Generation Link 1 speed, the selected device trains at a maximum of PCIe Generation 1 speed.
Type Enumeration
Read Only False
Value Description
Auto Auto
PcieGen1 PCIe Generation 1.0
PcieGen2 PCIe Generation 2.0

PciSlot5OptionROM (PCIe Option ROM) Member of Bios.v1_0_0.Bios
Description Use this option to enable or disable Device Option ROM
Type Enumeration
Read Only False
Value Description
Enabled Enabled
Disabled Disabled

PciSlot6Aspm (PCIe Power Management(ASPM)) Member of Bios.v1_0_0.Bios
Description Use this option to configure the PCIe Link Power Management (ASPM) support for the selected device. When configured for L0s Enabled, the selected device’s link enters a standby energy savings state. When configured for L1 Enabled, the selected device’s link enters a lower power standby state at the expense of a longer exit latency. When configured for L1 and L0s Enabled, the selected device’s link enters either power savings mode, depending on link utilization, and provides the highest energy savings.
Type Enumeration
Read Only False
Value Description
Auto Auto
Disabled Disabled
AspmL1Enabled L1 Enabled

PciSlot6Bifurcation (PCIe Slot 6 Bifurcation) Member of Bios.v1_0_0.Bios
Description Use this option to bifurcate the selected PCIe slot. When Auto is selected, the PCIe slot will train at the maximum width supported by the slot and end point. When Slot Bifurcated is selected, the PCIe slot will be bifurcated into two equal width slots. When Slot Dual Bifurcate (quadfurcate) is selected, the PCIe slot will be bifurcated into four equal width slots.Note: Only change this option if the device installed in the slot supports this capability.
Type Enumeration
Read Only False
Value Description
Auto Auto
SlotBifurcated Bifurcate
SlotDualBifurcated Dual Bifurcate

PciSlot6Enable (PCIe Device Disable) Member of Bios.v1_0_0.Bios
Description Select this option to enable or disable PCI devices.
Type Enumeration
Read Only False
Value Description
Auto Auto
Disabled Disabled

PciSlot6LinkSpeed (PCIe Link Speed) Member of Bios.v1_0_0.Bios
Description Use this option to configure the PCIe Link Speed for the selected device. When configured for Auto, the selected device trains at the maximum supported speed of the PCIe link. When configured for PCIe Generation 2 Link Speed, the selected device trains at a maximum of PCIe Generation 2 speed. When configured for PCIe Generation Link 1 speed, the selected device trains at a maximum of PCIe Generation 1 speed.
Type Enumeration
Read Only False
Value Description
Auto Auto
PcieGen1 PCIe Generation 1.0
PcieGen2 PCIe Generation 2.0

PciSlot6OptionROM (PCIe Option ROM) Member of Bios.v1_0_0.Bios
Description Use this option to enable or disable Device Option ROM
Type Enumeration
Read Only False
Value Description
Enabled Enabled
Disabled Disabled

PciSlot7Aspm (PCIe Power Management(ASPM)) Member of Bios.v1_0_0.Bios
Description Use this option to configure the PCIe Link Power Management (ASPM) support for the selected device. When configured for L0s Enabled, the selected device’s link enters a standby energy savings state. When configured for L1 Enabled, the selected device’s link enters a lower power standby state at the expense of a longer exit latency. When configured for L1 and L0s Enabled, the selected device’s link enters either power savings mode, depending on link utilization, and provides the highest energy savings.
Type Enumeration
Read Only False
Value Description
Auto Auto
Disabled Disabled
AspmL1Enabled L1 Enabled

PciSlot7Bifurcation (PCIe Slot 7 Bifurcation) Member of Bios.v1_0_0.Bios
Description Use this option to bifurcate the selected PCIe slot. When Auto is selected, the PCIe slot will train at the maximum width supported by the slot and end point. When Slot Bifurcated is selected, the PCIe slot will be bifurcated into two equal width slots. When Slot Dual Bifurcate (quadfurcate) is selected, the PCIe slot will be bifurcated into four equal width slots.Note: Only change this option if the device installed in the slot supports this capability.
Type Enumeration
Read Only False
Value Description
Auto Auto
SlotBifurcated Bifurcate
SlotDualBifurcated Dual Bifurcate

PciSlot7Enable (PCIe Device Disable) Member of Bios.v1_0_0.Bios
Description Select this option to enable or disable PCI devices.
Type Enumeration
Read Only False
Value Description
Auto Auto
Disabled Disabled

PciSlot7LinkSpeed (PCIe Link Speed) Member of Bios.v1_0_0.Bios
Description Use this option to configure the PCIe Link Speed for the selected device. When configured for Auto, the selected device trains at the maximum supported speed of the PCIe link. When configured for PCIe Generation 2 Link Speed, the selected device trains at a maximum of PCIe Generation 2 speed. When configured for PCIe Generation Link 1 speed, the selected device trains at a maximum of PCIe Generation 1 speed.
Type Enumeration
Read Only False
Value Description
Auto Auto
PcieGen1 PCIe Generation 1.0
PcieGen2 PCIe Generation 2.0

PciSlot7OptionROM (PCIe Option ROM) Member of Bios.v1_0_0.Bios
Description Use this option to enable or disable Device Option ROM
Type Enumeration
Read Only False
Value Description
Enabled Enabled
Disabled Disabled

PciSlot8Aspm (PCIe Power Management(ASPM)) Member of Bios.v1_0_0.Bios
Description Use this option to configure the PCIe Link Power Management (ASPM) support for the selected device. When configured for L0s Enabled, the selected device’s link enters a standby energy savings state. When configured for L1 Enabled, the selected device’s link enters a lower power standby state at the expense of a longer exit latency. When configured for L1 and L0s Enabled, the selected device’s link enters either power savings mode, depending on link utilization, and provides the highest energy savings.
Type Enumeration
Read Only False
Value Description
Auto Auto
Disabled Disabled
AspmL1Enabled L1 Enabled

PciSlot8Bifurcation (PCIe Slot 8 Bifurcation) Member of Bios.v1_0_0.Bios
Description Use this option to bifurcate the selected PCIe slot. When Auto is selected, the PCIe slot will train at the maximum width supported by the slot and end point. When Slot Bifurcated is selected, the PCIe slot will be bifurcated into two equal width slots. When Slot Dual Bifurcate (quadfurcate) is selected, the PCIe slot will be bifurcated into four equal width slots.Note: Only change this option if the device installed in the slot supports this capability.
Type Enumeration
Read Only False
Value Description
Auto Auto
SlotBifurcated Bifurcate
SlotDualBifurcated Dual Bifurcate

PciSlot8Enable (PCIe Device Disable) Member of Bios.v1_0_0.Bios
Description Select this option to enable or disable PCI devices.
Type Enumeration
Read Only False
Value Description
Auto Auto
Disabled Disabled

PciSlot8LinkSpeed (PCIe Link Speed) Member of Bios.v1_0_0.Bios
Description Use this option to configure the PCIe Link Speed for the selected device. When configured for Auto, the selected device trains at the maximum supported speed of the PCIe link. When configured for PCIe Generation 2 Link Speed, the selected device trains at a maximum of PCIe Generation 2 speed. When configured for PCIe Generation Link 1 speed, the selected device trains at a maximum of PCIe Generation 1 speed.
Type Enumeration
Read Only False
Value Description
Auto Auto
PcieGen1 PCIe Generation 1.0
PcieGen2 PCIe Generation 2.0

PciSlot8OptionROM (PCIe Option ROM) Member of Bios.v1_0_0.Bios
Description Use this option to enable or disable Device Option ROM
Type Enumeration
Read Only False
Value Description
Enabled Enabled
Disabled Disabled

PersistentMemAddressRangeScrub (Persistent Memory Address Range Scrub) Member of Bios.v1_0_0.Bios
Description Use this option to configure the NVDIMM memory Address Range Scrub support. When enabled, this option allows a supported OS to attempt recovery from an uncorrectable memory error detected in the NVDIMM memory. When disabled, the NVDIMM memory will be disabled on the following boot after detecting an uncorrectable memory error in the NVDIMM. If the NVDIMM memory Memory Interleaving option is enabled, a disabled NVDIMM will include all the modules or regions within the set.
Type Enumeration
Read Only False
Value Description
Enabled Enabled
Disabled Disabled

PersistentMemBackupPowerPolicy (Persistent Memory Backup Power Policy) Member of Bios.v1_0_0.Bios
Description This option controls whether the system waits during system boot for batteries to charge if sufficient battery backup power for the installed persistent memory is not available. If this option is configured for ‘Continue Boot without Backup Power’, the server boots even if sufficient battery backup power is not installed. In this case, if sufficient battery backup power is not enabled, the configured memory will NOT be used by the operating system as persistent storage or as system memory. If this option is configured for ‘Use External Backup Power’, the server will depend on an external UPS to handle an AC loss condition.
Type Enumeration
Read Only False
Value Description
WaitForBackupPower Wait for Backup Power on Boot
BootWithoutBackupPower Continue Boot without Backup Power
UseExternalBackupPower Use External Backup Power

PersistentMemScanMem (Persistent Memory Integrity Check) Member of Bios.v1_0_0.Bios
Description When this option is enabled, persistent memory will be checked during system boot to determine data integrity. Depending on the Persistent Memory Address Range Scrub setting, discovered errors during the data integrity check will either be presented to the operating system for recovery or cause the persistent memory to be mapped out and unavailable to the operating system. If this option is disabled, any persistent memory which has issues with the ability to read data or which has bad data may result in uncorrectable errors that result in a system crash. If this option is disabled, Persistent Memory Address Range Scrub functionality might be impacted.For NVDIMM-N, this option will be automatically enabled if Persistent Memory Address Range Scrub functionality is enabled.
Type Enumeration
Read Only False
Value Description
Enabled Enabled
Disabled Disabled

PostBootProgress (POST Verbose Boot Progress) Member of Bios.v1_0_0.Bios
Description Use this option to enable verbose boot progress messaging. Because this option displays additional debug information to the screen and serial console, it might be helpful for determining why a server became unresponsive during the boot process.
Type Enumeration
Read Only False
Value Description
Disabled Disabled
Serial Serial Only
All All

PostDiscoveryMode (UEFI POST Discovery Mode) Member of Bios.v1_0_0.Bios
Description Use this option to configure the UEFI POST Discovery Mode. When Auto is selected, the system selectively starts devices which are required for booting the devices in the UEFI Boot Order list. Note: For some situations like system configuration change, the system will change to start all devices for discovering all boot devices. When Force Full Discovery is selected, the system starts all devices in the system providing full boot target availability. Note: When Force Full Discovery is selected, boot time might significantly increase. When Force Fast Discovery is selected, the system starts as few devices as possible to get minimal boot time. Note: When Force Fast Discovery is selected, some unsupported devices may not work properly. You may need to replace the unsupported device with one that supports Fast Discovery.
Type Enumeration
Read Only False
Value Description
Auto Auto
ForceFullDiscovery Force Full Discovery
ForceFastDiscovery Force Fast Discovery

PostF1Prompt (POST F1 Prompt) Member of Bios.v1_0_0.Bios
Description Use this option to configure the system to display the F1 key on the server POST screen. If an error is encountered, you can press the F1 key to continue with the server power-up sequence. Select one of the following options: Delayed 20 Seconds - If an error occurs, the system pauses for 20 seconds at the F1 prompt and continues to boot the OS. Delayed 2 Seconds - If an error occurs, the system pauses for 2 seconds at the F1 prompt and continues to boot the OS. Disabled - If an error occurs, the system bypasses the F1 prompt and continues to boot the OS. Note: For critical errors, the system pauses for 20 seconds at the F1 prompt, regardless of how this option is configured.
Type Enumeration
Read Only False
Value Description
Delayed20Sec Delayed 20 seconds
Delayed2Sec Delayed 2 seconds
Disabled Disabled

PostVideoSupport (POST Video Support) Member of Bios.v1_0_0.Bios
Description Use this option to configure the POST Video Support setting. When set to Display All, the system will display POST video to all installed video controllers. When set to Display Embedded Only, the system will only display POST video to the embedded video controller. This option is only supported in UEFI Boot Mode and only applies to video output during the POST (pre-boot) environment.
Type Enumeration
Read Only False
Value Description
DisplayAll Display All
DisplayEmbeddedOnly Display Embedded Only

PowerButton (Power Button Mode) Member of Bios.v1_0_0.Bios
Description Disabling this option disables the momentary power button functionality. This option does not affect the four-second power button override or the remote power control functionality.
Type Enumeration
Read Only False
Value Description
Enabled Enabled
Disabled Disabled

PowerOnDelay (Power-On Delay) Member of Bios.v1_0_0.Bios
Description Use this option to delay the server from turning on for a specified time. Pressing the power button (using the Virtual Power Button), or Wake-ON LAN events, and RTC Wake-up events override the delay and power on the server without any additional delay. This enables staggering when servers power-up after a power loss to prevent power usage spikes.Note that the actual delay before the server is powered on will be longer than the specified time because the server must always wait for iLO FW to initialize before the server attempts to power on.
Type Enumeration
Read Only False
Value Description
NoDelay No Delay
Random Random Delay
Delay15Sec 15 Second Delay
Delay30Sec 30 Second Delay
Delay45Sec 45 Second Delay
Delay60Sec 60 Second Delay

PowerRegulator (Power Regulator) Member of Bios.v1_0_0.Bios
Description You can only configure this option if the Workload Profile is set to Custom. Use this option to configure the following Power Regulator support: - Dynamic Power Savings Mode: Automatically varies processor speed and power usage based on processor utilization. Enables the reduction of overall power consumption with little or no impact on performance. Does not require OS support. - Static Low Power Mode: Reduces processor speed and power usage. Guarantees a lower maximum power usage for the system. Performance impacts are greater for environments with higher processor utilization. - Static High Performance Mode: Processors run in their maximum power/performance state at all times, regardless of the OS power management policy. - OS Control Mode: Processors run in their maximum power/performance state at all times unless the OS enables a power management policy.
Type Enumeration
Read Only False
Value Description
DynamicPowerSavings Dynamic Power Savings Mode
StaticLowPower Static Low Power Mode
StaticHighPerf Static High Performance Mode
OsControl OS Control Mode

PreBootNetwork (Pre-Boot Network Interface) Member of Bios.v1_0_0.Bios
Description Use this option to select the network interface used for pre-boot network connections. When the selection is Auto, the system uses the first available port with a network connection.
Type Enumeration
Read Only False
Value Description
Auto Auto
EmbNicPort1 Embedded NIC Port 1
EmbNicPort2 Embedded NIC Port 2
EmbNicPort3 Embedded NIC Port 3
EmbNicPort4 Embedded NIC Port 4
EmbNicPort5 Embedded NIC Port 5
EmbNicPort6 Embedded NIC Port 6
EmbNicPort7 Embedded NIC Port 7
EmbNicPort8 Embedded NIC Port 8
FlexLom1Port1 Embedded FlexibleLOM 1 Port 1
FlexLom1Port2 Embedded FlexibleLOM 1 Port 2
FlexLom1Port3 Embedded FlexibleLOM 1 Port 3
FlexLom1Port4 Embedded FlexibleLOM 1 Port 4
FlexLom1Port5 Embedded FlexibleLOM 1 Port 5
FlexLom1Port6 Embedded FlexibleLOM 1 Port 6
FlexLom1Port7 Embedded FlexibleLOM 1 Port 7
FlexLom1Port8 Embedded FlexibleLOM 1 Port 8
Slot1NicPort1 Slot 1 NIC Port 1
Slot1NicPort2 Slot 1 NIC Port 2
Slot1NicPort3 Slot 1 NIC Port 3
Slot1NicPort4 Slot 1 NIC Port 4
Slot1NicPort5 Slot 1 NIC Port 5
Slot1NicPort6 Slot 1 NIC Port 6
Slot1NicPort7 Slot 1 NIC Port 7
Slot1NicPort8 Slot 1 NIC Port 8
Slot2NicPort1 Slot 2 NIC Port 1
Slot2NicPort2 Slot 2 NIC Port 2
Slot2NicPort3 Slot 2 NIC Port 3
Slot2NicPort4 Slot 2 NIC Port 4
Slot2NicPort5 Slot 2 NIC Port 5
Slot2NicPort6 Slot 2 NIC Port 6
Slot2NicPort7 Slot 2 NIC Port 7
Slot2NicPort8 Slot 2 NIC Port 8
Slot3NicPort1 Slot 3 NIC Port 1
Slot3NicPort2 Slot 3 NIC Port 2
Slot3NicPort3 Slot 3 NIC Port 3
Slot3NicPort4 Slot 3 NIC Port 4
Slot3NicPort5 Slot 3 NIC Port 5
Slot3NicPort6 Slot 3 NIC Port 6
Slot3NicPort7 Slot 3 NIC Port 7
Slot3NicPort8 Slot 3 NIC Port 8
Slot4NicPort1 Slot 4 NIC Port 1
Slot4NicPort2 Slot 4 NIC Port 2
Slot4NicPort3 Slot 4 NIC Port 3
Slot4NicPort4 Slot 4 NIC Port 4
Slot4NicPort5 Slot 4 NIC Port 5
Slot4NicPort6 Slot 4 NIC Port 6
Slot4NicPort7 Slot 4 NIC Port 7
Slot4NicPort8 Slot 4 NIC Port 8
Slot5NicPort1 Slot 5 NIC Port 1
Slot5NicPort2 Slot 5 NIC Port 2
Slot5NicPort3 Slot 5 NIC Port 3
Slot5NicPort4 Slot 5 NIC Port 4
Slot5NicPort5 Slot 5 NIC Port 5
Slot5NicPort6 Slot 5 NIC Port 6
Slot5NicPort7 Slot 5 NIC Port 7
Slot5NicPort8 Slot 5 NIC Port 8
Slot6NicPort1 Slot 6 NIC Port 1
Slot6NicPort2 Slot 6 NIC Port 2
Slot6NicPort3 Slot 6 NIC Port 3
Slot6NicPort4 Slot 6 NIC Port 4
Slot6NicPort5 Slot 6 NIC Port 5
Slot6NicPort6 Slot 6 NIC Port 6
Slot6NicPort7 Slot 6 NIC Port 7
Slot6NicPort8 Slot 6 NIC Port 8
Slot7NicPort1 Slot 7 NIC Port 1
Slot7NicPort2 Slot 7 NIC Port 2
Slot7NicPort3 Slot 7 NIC Port 3
Slot7NicPort4 Slot 7 NIC Port 4
Slot7NicPort5 Slot 7 NIC Port 5
Slot7NicPort6 Slot 7 NIC Port 6
Slot7NicPort7 Slot 7 NIC Port 7
Slot7NicPort8 Slot 7 NIC Port 8
Slot8NicPort1 Slot 8 NIC Port 1
Slot8NicPort2 Slot 8 NIC Port 2
Slot8NicPort3 Slot 8 NIC Port 3
Slot8NicPort4 Slot 8 NIC Port 4
Slot8NicPort5 Slot 8 NIC Port 5
Slot8NicPort6 Slot 8 NIC Port 6
Slot8NicPort7 Slot 8 NIC Port 7
Slot8NicPort8 Slot 8 NIC Port 8

PrebootNetworkEnvPolicy (Pre-Boot Network Environment) Member of Bios.v1_0_0.Bios
Description Use this option to set the preference for Pre-Boot Network. If configured for Auto, all the network operations initiated in the pre boot environment occur over IPv4 or IPv6. The order of the existing network boot targets is not modified in the UEFI Boot Order list. New network boot targets are added to the end of the list using the default policy of the System BIOS. If configured for IPv4, all the network operations initiated in the pre boot environment only occur over IPv4. All existing IPv6 network boot targets are removed in the UEFI Boot Order. No new IPv6 network boot targets are added to the list. If configured for IPv6, all the network operations initiated in the pre boot environment only occur over IPv6. All existing IPv4 network boot targets in the UEFI Boot Order are removed. No new IPv4 network boot targets are added to the list.
Type Enumeration
Read Only False
Value Description
Auto Auto
IPv4 IPv4
IPv6 IPv6

PrebootNetworkProxy (Pre-Boot Network Proxy) Member of Bios.v1_0_0.Bios
Description Use this option to configure a pre-boot network proxy. When set, network operations for ‘Pre-Boot Network Interface’ are attempted through the configured proxy. The proxy must be in a HTTP URL format, and can be specified as http://IPv4_address:port, http://IPv6 address:port or http://FQDN:port.
Type String
Read Only False

ProcAes (Processor AES-NI Support) Member of Bios.v1_0_0.Bios
Description Use this option to enable or disable the Advanced Encryption Standard Instruction Set (AES-NI) in the processor.
Type Enumeration
Read Only False
Value Description
Enabled Enabled
Disabled Disabled

ProcHyperthreading (Intel® Hyper-Threading) Member of Bios.v1_0_0.Bios
Description Use this option to enable or disable Intel Hyper-Threading. When enabled, each physical processor core operates as two logical processor cores. When disabled, each physical processor core operates as one logical processor core. Enabling this option can improve overall performance for applications that benefit from a higher processor core count.
Type Enumeration
Read Only False
Value Description
Enabled Enabled
Disabled Disabled

ProcTurbo (Intel® Turbo Boost Technology) Member of Bios.v1_0_0.Bios
Description Turbo Boost Technology enables the processor to transition to a higher frequency than the processor’s rated speed if the processor has available power and is within temperature specifications. Disabling this option reduces power usage, and also reduces the system’s maximum achievable performance under some workloads.
Type Enumeration
Read Only False
Value Description
Disabled Disabled
Enabled Enabled

ProcVirtualization (Intel® Virtualization Technology (Intel VT) ) Member of Bios.v1_0_0.Bios
Description When enabled, a hypervisor or operating system supporting this option can use hardware capabilities provided by Intel VT. Some hypervisors require that you enable Intel VT. You can leave this set to enabled even if you are not using a hypervisor or an operating system that uses this option.
Type Enumeration
Read Only False
Value Description
Enabled Enabled
Disabled Disabled

ProcX2Apic (Processor x2APIC Support) Member of Bios.v1_0_0.Bios
Description x2APIC support enables operating systems to run more efficiently on high core count configurations. It also optimizes interrupt distribution in virtualized environments. In most cases, set this option to enabled. This configures the operating system to optionally enable x2APIC support when it loads. Some older hypervisors and operating systems might have issues with optional x2APIC support, in which case disabling x2APIC might be necessary to address those issues. Additionally, some hypervisors and operating systems will not use X2APIC unless this option is set to Force Enabled prior to booting. The Force Enabled option also causes the Intel® VT-d setting to be set to enabled.
Type Enumeration
Read Only False
Value Description
Enabled Enabled
ForceEnabled Force Enabled
Disabled Disabled

ProcessorConfigTDPLevel (Processor Config TDP Level) Member of Bios.v1_0_0.Bios
Description Use this option to override the default CPU policy for SSE, AVX, and AVX-512 deterministic frequencies.This will result in lowering the deterministic operational frequency (P1) based on the setting.Disabling Turbo Mode will enhance the deterministic behavior, but result in a lower operational frequency.
Type Enumeration
Read Only False
Value Description
Normal Normal
Level1 Level 1
Level2 Level 2

ProcessorJitterControl (Processor Jitter Control) Member of Bios.v1_0_0.Bios
Description Processor Jitter Control allows the customer to manage processor frequency variance to do technologies such as Turbo which vary the frequency based on power, thermals, and active cores. When configured for Auto-tuned, the platform will monitor frequency variance and automatically make adjustments to minimize variance over time. When configured for Manual-tuned, the customer can choose to attempt to operate the processor at a fixed frequency and can select lower or higher frequencies statically.Note:Auto-tuned mode requires that processor C-states be disabled for proper operation. Refer to the Intelligent System Tuning Whitepaper at hpe.com/info/IST on how to properly disable C-states in UEFI System Utilities and/or the Linux Operating System.
Type Enumeration
Read Only False
Value Description
Disabled Disabled
Auto-tuned Auto-tuned
Manual-tuned Manual-tuned

ProcessorJitterControlFrequency (Processor Jitter Control Frequency) Member of Bios.v1_0_0.Bios
Description Processor Jitter Control Frequency allows the customer to stipulate the starting frequency in the Auto-tuned mode, or the desired frequency in the Manual-tuned mode. The input frequency is in units of Megahertz. System firmware will adjust the frequency to the nearest higher intermediate frequency supported by the processor if the input frequency is not supported.
Type Integer
Read Only False

ProcessorJitterControlOptimization (Processor Jitter Control Optimization) Member of Bios.v1_0_0.Bios
Description This option optimizes the thresholds used when the Auto-tuned function detects fluctuations in processor frequency. Optimizing for throughput allows only the amount of fluctuations that doesn’t impact overall compute throughput. Optimizing for Latency allows for a very small amount of occasional fluctuations to occur before reducing processor frequency. Zero Latency attempts to eliminate any frequency fluctuations.
Type Enumeration
Read Only False
Value Description
OptimizedForThroughput Optimized for Throughput
OptimizedForLatency Optimized for Latency
ZeroLatency Zero Latency

ProductId (Product ID) Member of Bios.v1_0_0.Bios
Description Use this option to set the system product ID. This value must always match the product ID sticker located on the chassis.
Type String
Read Only False

RedundantPowerSupply (Redundant Power Supply Mode) Member of Bios.v1_0_0.Bios
Description Use this option to configure how the system handles redundant power supply configurations. Balanced Mode shares the power delivery equally between all installed power supplies. All High Efficiency Mode options provide the most power efficient operation with redundant power supplies by keeping half of the power supplies in standby mode at lower power usage levels. The High Efficiency Mode options enable the system to select which power supply to place in standby. Auto enables the system to select between the odd or even power supply based on a semi-random distribution within a group of systems.
Type Enumeration
Read Only False
Value Description
BalancedMode Balanced Mode
HighEfficiencyAuto High Efficiency Mode (Auto)
HighEfficiencyOddStandby High Efficiency Mode (Odd Supply Standby)
HighEfficiencyEvenStandby High Efficiency Mode (Even Supply Standby)

RemovableFlashBootSeq (Removable Flash Media Boot Sequence) Member of Bios.v1_0_0.Bios
Description Use this option to select which USB or SD Card devices you want to search for first when enumerating boot devices. You can select whether the system boots to external USB drive keys, internal USB drive keys, or the internal SD card slot. This option does not override the device boot order in the Standard Boot Order (IPL) option. You can only configure this option when Boot Mode is set to Legacy BIOS.
Type Enumeration
Read Only False
Value Description
InternalSdCardFirst Internal SD Card First
InternalKeysFirst Internal DriveKeys First
ExternalKeysFirst External DriveKeys First

RestoreDefaults (Restore Default System Settings) Member of Bios.v1_0_0.Bios
Description Use this option to reset all configuration settings to their default values. Changes that have been made might be lost. You must reboot the system for changes to take effect.
Type Enumeration
Read Only False
Value Description
No No, cancel the restore procedure.
Yes Yes, restore the default settings.

RestoreManufacturingDefaults (Restore Default Manufacturing Settings) Member of Bios.v1_0_0.Bios
Description Use this option to reset all configuration settings to their default manufacturing values. Changes that have been made might be lost. If Secure Boot is enabled, related security settings might be lost. You must reboot the system for changes to take effect.
Type Enumeration
Read Only False
Value Description
No No, cancel restore procedure.
Yes Yes, restore the default settings.

RomSelection (ROM Selection) Member of Bios.v1_0_0.Bios
Description Use this option to revert the server to a previous BIOS ROM image. The backup image is the BIOS ROM image that was used prior to the last flash event.
Type Enumeration
Read Only False
Value Description
CurrentRom Use Current ROM
BackupRom Switch to Backup ROM

SanitizeAllNvDimmN (Sanitize/Erase all NVDIMM-N in the System) Member of Bios.v1_0_0.Bios
Description When Enabled, all user data in ALL NVDIMMs of type NVDIMM-N in the system are erased on the next reboot.
Type Enumeration
Read Only False
Value Description
Enabled Enabled
Disabled Disabled

SanitizeProc1Dimm1 (Sanitize/Erase Processor 1 DIMM 1) Member of Bios.v1_0_0.Bios
Description When Enabled, all user data in the selected NVDIMM-N are erased on the next reboot.
Type Enumeration
Read Only False
Value Description
Enabled Enabled
Disabled Disabled

SanitizeProc1Dimm10 (Sanitize/Erase Processor 1 DIMM 10) Member of Bios.v1_0_0.Bios
Description When Enabled, all user data in the selected NVDIMM-N are erased on the next reboot.
Type Enumeration
Read Only False
Value Description
Enabled Enabled
Disabled Disabled

SanitizeProc1Dimm11 (Sanitize/Erase Processor 1 DIMM 11) Member of Bios.v1_0_0.Bios
Description When Enabled, all user data in the selected NVDIMM-N are erased on the next reboot.
Type Enumeration
Read Only False
Value Description
Enabled Enabled
Disabled Disabled

SanitizeProc1Dimm12 (Sanitize/Erase Processor 1 DIMM 12) Member of Bios.v1_0_0.Bios
Description When Enabled, all user data in the selected NVDIMM-N are erased on the next reboot.
Type Enumeration
Read Only False
Value Description
Enabled Enabled
Disabled Disabled

SanitizeProc1Dimm2 (Sanitize/Erase Processor 1 DIMM 2) Member of Bios.v1_0_0.Bios
Description When Enabled, all user data in the selected NVDIMM-N are erased on the next reboot.
Type Enumeration
Read Only False
Value Description
Enabled Enabled
Disabled Disabled

SanitizeProc1Dimm3 (Sanitize/Erase Processor 1 DIMM 3) Member of Bios.v1_0_0.Bios
Description When Enabled, all user data in the selected NVDIMM-N are erased on the next reboot.
Type Enumeration
Read Only False
Value Description
Enabled Enabled
Disabled Disabled

SanitizeProc1Dimm4 (Sanitize/Erase Processor 1 DIMM 4) Member of Bios.v1_0_0.Bios
Description When Enabled, all user data in the selected NVDIMM-N are erased on the next reboot.
Type Enumeration
Read Only False
Value Description
Enabled Enabled
Disabled Disabled

SanitizeProc1Dimm5 (Sanitize/Erase Processor 1 DIMM 5) Member of Bios.v1_0_0.Bios
Description When Enabled, all user data in the selected NVDIMM-N are erased on the next reboot.
Type Enumeration
Read Only False
Value Description
Enabled Enabled
Disabled Disabled

SanitizeProc1Dimm6 (Sanitize/Erase Processor 1 DIMM 6) Member of Bios.v1_0_0.Bios
Description When Enabled, all user data in the selected NVDIMM-N are erased on the next reboot.
Type Enumeration
Read Only False
Value Description
Enabled Enabled
Disabled Disabled

SanitizeProc1Dimm7 (Sanitize/Erase Processor 1 DIMM 7) Member of Bios.v1_0_0.Bios
Description When Enabled, all user data in the selected NVDIMM-N are erased on the next reboot.
Type Enumeration
Read Only False
Value Description
Enabled Enabled
Disabled Disabled

SanitizeProc1Dimm8 (Sanitize/Erase Processor 1 DIMM 8) Member of Bios.v1_0_0.Bios
Description When Enabled, all user data in the selected NVDIMM-N are erased on the next reboot.
Type Enumeration
Read Only False
Value Description
Enabled Enabled
Disabled Disabled

SanitizeProc1Dimm9 (Sanitize/Erase Processor 1 DIMM 9) Member of Bios.v1_0_0.Bios
Description When Enabled, all user data in the selected NVDIMM-N are erased on the next reboot.
Type Enumeration
Read Only False
Value Description
Enabled Enabled
Disabled Disabled

SanitizeProc1NvDimmN (Sanitize/Erase all NVDIMM-N on Processor 1) Member of Bios.v1_0_0.Bios
Description When Enabled, all user data in ALL NVDIMMs of type NVDIMM-N installed on the selected processor are erased on the next reboot.
Type Enumeration
Read Only False
Value Description
Enabled Enabled
Disabled Disabled

SanitizeProc2Dimm1 (Sanitize/Erase Processor 2 DIMM 1) Member of Bios.v1_0_0.Bios
Description When Enabled, all user data in the selected NVDIMM-N are erased on the next reboot.
Type Enumeration
Read Only False
Value Description
Enabled Enabled
Disabled Disabled

SanitizeProc2Dimm10 (Sanitize/Erase Processor 2 DIMM 10) Member of Bios.v1_0_0.Bios
Description When Enabled, all user data in the selected NVDIMM-N are erased on the next reboot.
Type Enumeration
Read Only False
Value Description
Enabled Enabled
Disabled Disabled

SanitizeProc2Dimm11 (Sanitize/Erase Processor 2 DIMM 11) Member of Bios.v1_0_0.Bios
Description When Enabled, all user data in the selected NVDIMM-N are erased on the next reboot.
Type Enumeration
Read Only False
Value Description
Enabled Enabled
Disabled Disabled

SanitizeProc2Dimm12 (Sanitize/Erase Processor 2 DIMM 12) Member of Bios.v1_0_0.Bios
Description When Enabled, all user data in the selected NVDIMM-N are erased on the next reboot.
Type Enumeration
Read Only False
Value Description
Enabled Enabled
Disabled Disabled

SanitizeProc2Dimm2 (Sanitize/Erase Processor 2 DIMM 2) Member of Bios.v1_0_0.Bios
Description When Enabled, all user data in the selected NVDIMM-N are erased on the next reboot.
Type Enumeration
Read Only False
Value Description
Enabled Enabled
Disabled Disabled

SanitizeProc2Dimm3 (Sanitize/Erase Processor 2 DIMM 3) Member of Bios.v1_0_0.Bios
Description When Enabled, all user data in the selected NVDIMM-N are erased on the next reboot.
Type Enumeration
Read Only False
Value Description
Enabled Enabled
Disabled Disabled

SanitizeProc2Dimm4 (Sanitize/Erase Processor 2 DIMM 4) Member of Bios.v1_0_0.Bios
Description When Enabled, all user data in the selected NVDIMM-N are erased on the next reboot.
Type Enumeration
Read Only False
Value Description
Enabled Enabled
Disabled Disabled

SanitizeProc2Dimm5 (Sanitize/Erase Processor 2 DIMM 5) Member of Bios.v1_0_0.Bios
Description When Enabled, all user data in the selected NVDIMM-N are erased on the next reboot.
Type Enumeration
Read Only False
Value Description
Enabled Enabled
Disabled Disabled

SanitizeProc2Dimm6 (Sanitize/Erase Processor 2 DIMM 6) Member of Bios.v1_0_0.Bios
Description When Enabled, all user data in the selected NVDIMM-N are erased on the next reboot.
Type Enumeration
Read Only False
Value Description
Enabled Enabled
Disabled Disabled

SanitizeProc2Dimm7 (Sanitize/Erase Processor 2 DIMM 7) Member of Bios.v1_0_0.Bios
Description When Enabled, all user data in the selected NVDIMM-N are erased on the next reboot.
Type Enumeration
Read Only False
Value Description
Enabled Enabled
Disabled Disabled

SanitizeProc2Dimm8 (Sanitize/Erase Processor 2 DIMM 8) Member of Bios.v1_0_0.Bios
Description When Enabled, all user data in the selected NVDIMM-N are erased on the next reboot.
Type Enumeration
Read Only False
Value Description
Enabled Enabled
Disabled Disabled

SanitizeProc2Dimm9 (Sanitize/Erase Processor 2 DIMM 9) Member of Bios.v1_0_0.Bios
Description When Enabled, all user data in the selected NVDIMM-N are erased on the next reboot.
Type Enumeration
Read Only False
Value Description
Enabled Enabled
Disabled Disabled

SanitizeProc2NvDimmN (Sanitize/Erase all NVDIMM-N on Processor 2) Member of Bios.v1_0_0.Bios
Description When Enabled, all user data in ALL NVDIMMs of type NVDIMM-N installed on the selected processor are erased on the next reboot.
Type Enumeration
Read Only False
Value Description
Enabled Enabled
Disabled Disabled

SataSecureErase (SATA Secure Erase) Member of Bios.v1_0_0.Bios
Description Use this option to control whether Secure Erase functionality is supported. When enabled, the Security Freeze Lock command is not sent to supported SATA hard drives, enabling Secure erase to function (the Secure Erase command is supported). This option is only supported when the SATA controller is in AHCI mode. Secure Erase only operates with hard drives that support the Secure Erase command.
Type Enumeration
Read Only False
Value Description
Enabled Enabled
Disabled Disabled

SaveUserDefaults (Save User Defaults) Member of Bios.v1_0_0.Bios
Description Select this option to save the current settings as the system defaults.
Type Enumeration
Read Only False
Value Description
No No, Cancel
Yes Yes, Save

SecStartBackupImage (Backup ROM Image Authentication) Member of Bios.v1_0_0.Bios
Description Use this option to enable cryptographic authentication of the backup ROM image on startup. When this option is disabled, only the primary image is authenticated on each startup. Enable this option to also perform cryptographic authentication of the backup ROM image.
Type Enumeration
Read Only False
Value Description
Enabled Enabled
Disabled Disabled

SecureBootStatus (Secure Boot Status) Member of Bios.v1_0_0.Bios
Description The current state of Secure Boot configuration.
Type Enumeration
Read Only True
Value Description
Enabled Enabled
Disabled Disabled

SerialConsoleBaudRate (BIOS Serial Console Baud Rate) Member of Bios.v1_0_0.Bios
Description This is the transfer rate at which data is transmitted through the serial port.
Type Enumeration
Read Only False
Value Description
BaudRate9600 9600
BaudRate19200 19200
BaudRate38400 38400
BaudRate57600 57600
BaudRate115200 115200

SerialConsoleEmulation (BIOS Serial Console Emulation Mode) Member of Bios.v1_0_0.Bios
Description Use this option to select the emulation mode type. The option you select depends on the emulation you want to use in your serial terminal program (such as HyperTerminal or PuTTy). The BIOS emulation mode must match the mode you select in your terminal program.
Type Enumeration
Read Only False
Value Description
Vt100 VT100
Ansi ANSI
Vt100Plus VT100+
VtUtf8 VT-UTF8

SerialConsolePort (BIOS Serial Console Port) Member of Bios.v1_0_0.Bios
Description Use this option to re-direct video and keystrokes through the serial port to OS boot. This option can interfere with non-terminal devices attached to the serial port. In such cases, set this option to disabled. This option is only supported in English language mode when running in the UEFI pre-boot System Utilities.
Type Enumeration
Read Only False
Value Description
Auto Auto
Disabled Disabled
Physical Physical Serial Port
Virtual Virtual Serial Port

SerialNumber (Serial Number) Member of Bios.v1_0_0.Bios
Description Use this option to set the system serial number. This value must always match the serial number sticker located on the chassis.
Type String
Read Only False

ServerAssetTag (Server Asset Tag) Member of Bios.v1_0_0.Bios
Description Select this option to modify the Server Asset Tag text line.
Type String
Read Only False

ServerConfigLockStatus (Server Configuration Lock Status) Member of Bios.v1_0_0.Bios
Description The current state of the Server Configuration Lock feature.
Type Enumeration
Read Only True
Value Description
Enabled Enabled
Disabled Disabled

ServerName (Server Name) Member of Bios.v1_0_0.Bios
Description Select this option to modify the server name text line.
Type String
Read Only False

ServerOtherInfo (Server Other Information) Member of Bios.v1_0_0.Bios
Description Use this option to modify the Other Server text line.
Type String
Read Only False

ServerPrimaryOs (Server Primary OS) Member of Bios.v1_0_0.Bios
Description Use this option to modify the Server Primary OS text line.
Type String
Read Only False

ServiceEmail (Service Contact E-mail Address) Member of Bios.v1_0_0.Bios
Description Enter the server service contact e-mail address.
Type String
Read Only False

ServiceName (Service Contact Name) Member of Bios.v1_0_0.Bios
Description Enter the server service contact name text.
Type String
Read Only False

ServiceOtherInfo (Service Contact Other Information) Member of Bios.v1_0_0.Bios
Description Enter the other server service contact information text.
Type String
Read Only False

ServicePhone (Service Contact Phone Number) Member of Bios.v1_0_0.Bios
Description Enter the server service contact phone number text.
Type String
Read Only False

SetupBrowserSelection (Setup Browser Selection) Member of Bios.v1_0_0.Bios
Description Select which setup browser to use: GUI or Text. Auto mode uses text when the user enters RBSU via serial console, and uses GUI via IRC or physical terminal.
Type Enumeration
Read Only False
Value Description
GUI GUI
Text Text
Auto Auto

Slot1NicBoot1 (Slot 1 NIC Port 1 Boot) Member of Bios.v1_0_0.Bios
Description Use this option to enable or disable UEFI PXE Boot, UEFI HTTP Boot and iSCSI Software Initiator for the selected NIC. You might need to configure the NIC firmware for the boot option to be active. This is applicable only in UEFI Boot Mode.
Type Enumeration
Read Only False
Value Description
NetworkBoot Network Boot
Disabled Disabled

Slot1NicBoot2 (Slot 1 NIC Port 2 Boot) Member of Bios.v1_0_0.Bios
Description Use this option to enable or disable UEFI PXE Boot, UEFI HTTP Boot and iSCSI Software Initiator for the selected NIC. You might need to configure the NIC firmware for the boot option to be active. This is applicable only in UEFI Boot Mode.
Type Enumeration
Read Only False
Value Description
NetworkBoot Network Boot
Disabled Disabled

Slot1NicBoot3 (Slot 1 NIC Port 3 Boot) Member of Bios.v1_0_0.Bios
Description Use this option to enable or disable UEFI PXE Boot, UEFI HTTP Boot and iSCSI Software Initiator for the selected NIC. You might need to configure the NIC firmware for the boot option to be active. This is applicable only in UEFI Boot Mode.
Type Enumeration
Read Only False
Value Description
NetworkBoot Network Boot
Disabled Disabled

Slot1NicBoot4 (Slot 1 NIC Port 4 Boot) Member of Bios.v1_0_0.Bios
Description Use this option to enable or disable UEFI PXE Boot, UEFI HTTP Boot and iSCSI Software Initiator for the selected NIC. You might need to configure the NIC firmware for the boot option to be active. This is applicable only in UEFI Boot Mode.
Type Enumeration
Read Only False
Value Description
NetworkBoot Network Boot
Disabled Disabled

Slot1NicBoot5 (Slot 1 NIC Port 5 Boot) Member of Bios.v1_0_0.Bios
Description Use this option to enable or disable UEFI PXE Boot, UEFI HTTP Boot and iSCSI Software Initiator for the selected NIC. You might need to configure the NIC firmware for the boot option to be active. This is applicable only in UEFI Boot Mode.
Type Enumeration
Read Only False
Value Description
NetworkBoot Network Boot
Disabled Disabled

Slot1NicBoot6 (Slot 1 NIC Port 6 Boot) Member of Bios.v1_0_0.Bios
Description Use this option to enable or disable UEFI PXE Boot, UEFI HTTP Boot and iSCSI Software Initiator for the selected NIC. You might need to configure the NIC firmware for the boot option to be active. This is applicable only in UEFI Boot Mode.
Type Enumeration
Read Only False
Value Description
NetworkBoot Network Boot
Disabled Disabled

Slot1NicBoot7 (Slot 1 NIC Port 7 Boot) Member of Bios.v1_0_0.Bios
Description Use this option to enable or disable UEFI PXE Boot, UEFI HTTP Boot and iSCSI Software Initiator for the selected NIC. You might need to configure the NIC firmware for the boot option to be active. This is applicable only in UEFI Boot Mode.
Type Enumeration
Read Only False
Value Description
NetworkBoot Network Boot
Disabled Disabled

Slot1NicBoot8 (Slot 1 NIC Port 8 Boot) Member of Bios.v1_0_0.Bios
Description Use this option to enable or disable UEFI PXE Boot, UEFI HTTP Boot and iSCSI Software Initiator for the selected NIC. You might need to configure the NIC firmware for the boot option to be active. This is applicable only in UEFI Boot Mode.
Type Enumeration
Read Only False
Value Description
NetworkBoot Network Boot
Disabled Disabled

Slot1StorageBoot (PCIe Slot 1) Member of Bios.v1_0_0.Bios
Description When Boot All Targets is selected, all valid boot targets attached to the storage controller are made available in the UEFI Boot Order list. If Boot No Targets is selected, no boot targets from this storage controller are made available in the UEFI Boot Order.If Boot Limit to 24 Targets is selected, 24 boot targets attached to the storage controller are made available in the UEFI Boot Order.
Type Enumeration
Read Only False
Value Description
AllTargets Boot All Targets
TwentyFourTargets Boot Limit to 24 Targets
NoTargets Boot No Targets

Slot2NicBoot1 (Slot 2 NIC Port 1 Boot) Member of Bios.v1_0_0.Bios
Description Use this option to enable or disable UEFI PXE Boot, UEFI HTTP Boot and iSCSI Software Initiator for the selected NIC. You might need to configure the NIC firmware for the boot option to be active. This is applicable only in UEFI Boot Mode.
Type Enumeration
Read Only False
Value Description
NetworkBoot Network Boot
Disabled Disabled

Slot2NicBoot2 (Slot 2 NIC Port 2 Boot) Member of Bios.v1_0_0.Bios
Description Use this option to enable or disable UEFI PXE Boot, UEFI HTTP Boot and iSCSI Software Initiator for the selected NIC. You might need to configure the NIC firmware for the boot option to be active. This is applicable only in UEFI Boot Mode.
Type Enumeration
Read Only False
Value Description
NetworkBoot Network Boot
Disabled Disabled

Slot2NicBoot3 (Slot 2 NIC Port 3 Boot) Member of Bios.v1_0_0.Bios
Description Use this option to enable or disable UEFI PXE Boot, UEFI HTTP Boot and iSCSI Software Initiator for the selected NIC. You might need to configure the NIC firmware for the boot option to be active. This is applicable only in UEFI Boot Mode.
Type Enumeration
Read Only False
Value Description
NetworkBoot Network Boot
Disabled Disabled

Slot2NicBoot4 (Slot 2 NIC Port 4 Boot) Member of Bios.v1_0_0.Bios
Description Use this option to enable or disable UEFI PXE Boot, UEFI HTTP Boot and iSCSI Software Initiator for the selected NIC. You might need to configure the NIC firmware for the boot option to be active. This is applicable only in UEFI Boot Mode.
Type Enumeration
Read Only False
Value Description
NetworkBoot Network Boot
Disabled Disabled

Slot2NicBoot5 (Slot 2 NIC Port 5 Boot) Member of Bios.v1_0_0.Bios
Description Use this option to enable or disable UEFI PXE Boot, UEFI HTTP Boot and iSCSI Software Initiator for the selected NIC. You might need to configure the NIC firmware for the boot option to be active. This is applicable only in UEFI Boot Mode.
Type Enumeration
Read Only False
Value Description
NetworkBoot Network Boot
Disabled Disabled

Slot2NicBoot6 (Slot 2 NIC Port 6 Boot) Member of Bios.v1_0_0.Bios
Description Use this option to enable or disable UEFI PXE Boot, UEFI HTTP Boot and iSCSI Software Initiator for the selected NIC. You might need to configure the NIC firmware for the boot option to be active. This is applicable only in UEFI Boot Mode.
Type Enumeration
Read Only False
Value Description
NetworkBoot Network Boot
Disabled Disabled

Slot2NicBoot7 (Slot 2 NIC Port 7 Boot) Member of Bios.v1_0_0.Bios
Description Use this option to enable or disable UEFI PXE Boot, UEFI HTTP Boot and iSCSI Software Initiator for the selected NIC. You might need to configure the NIC firmware for the boot option to be active. This is applicable only in UEFI Boot Mode.
Type Enumeration
Read Only False
Value Description
NetworkBoot Network Boot
Disabled Disabled

Slot2NicBoot8 (Slot 2 NIC Port 8 Boot) Member of Bios.v1_0_0.Bios
Description Use this option to enable or disable UEFI PXE Boot, UEFI HTTP Boot and iSCSI Software Initiator for the selected NIC. You might need to configure the NIC firmware for the boot option to be active. This is applicable only in UEFI Boot Mode.
Type Enumeration
Read Only False
Value Description
NetworkBoot Network Boot
Disabled Disabled

Slot2StorageBoot (PCIe Slot 2) Member of Bios.v1_0_0.Bios
Description When Boot All Targets is selected, all valid boot targets attached to the storage controller are made available in the UEFI Boot Order list. If Boot No Targets is selected, no boot targets from this storage controller are made available in the UEFI Boot Order.If Boot Limit to 24 Targets is selected, 24 boot targets attached to the storage controller are made available in the UEFI Boot Order.
Type Enumeration
Read Only False
Value Description
AllTargets Boot All Targets
TwentyFourTargets Boot Limit to 24 Targets
NoTargets Boot No Targets

Slot3NicBoot1 (Slot 3 NIC Port 1 Boot) Member of Bios.v1_0_0.Bios
Description Use this option to enable or disable UEFI PXE Boot, UEFI HTTP Boot and iSCSI Software Initiator for the selected NIC. You might need to configure the NIC firmware for the boot option to be active. This is applicable only in UEFI Boot Mode.
Type Enumeration
Read Only False
Value Description
NetworkBoot Network Boot
Disabled Disabled

Slot3NicBoot2 (Slot 3 NIC Port 2 Boot) Member of Bios.v1_0_0.Bios
Description Use this option to enable or disable UEFI PXE Boot, UEFI HTTP Boot and iSCSI Software Initiator for the selected NIC. You might need to configure the NIC firmware for the boot option to be active. This is applicable only in UEFI Boot Mode.
Type Enumeration
Read Only False
Value Description
NetworkBoot Network Boot
Disabled Disabled

Slot3NicBoot3 (Slot 3 NIC Port 3 Boot) Member of Bios.v1_0_0.Bios
Description Use this option to enable or disable UEFI PXE Boot, UEFI HTTP Boot and iSCSI Software Initiator for the selected NIC. You might need to configure the NIC firmware for the boot option to be active. This is applicable only in UEFI Boot Mode.
Type Enumeration
Read Only False
Value Description
NetworkBoot Network Boot
Disabled Disabled

Slot3NicBoot4 (Slot 3 NIC Port 4 Boot) Member of Bios.v1_0_0.Bios
Description Use this option to enable or disable UEFI PXE Boot, UEFI HTTP Boot and iSCSI Software Initiator for the selected NIC. You might need to configure the NIC firmware for the boot option to be active. This is applicable only in UEFI Boot Mode.
Type Enumeration
Read Only False
Value Description
NetworkBoot Network Boot
Disabled Disabled

Slot3NicBoot5 (Slot 3 NIC Port 5 Boot) Member of Bios.v1_0_0.Bios
Description Use this option to enable or disable UEFI PXE Boot, UEFI HTTP Boot and iSCSI Software Initiator for the selected NIC. You might need to configure the NIC firmware for the boot option to be active. This is applicable only in UEFI Boot Mode.
Type Enumeration
Read Only False
Value Description
NetworkBoot Network Boot
Disabled Disabled

Slot3NicBoot6 (Slot 3 NIC Port 6 Boot) Member of Bios.v1_0_0.Bios
Description Use this option to enable or disable UEFI PXE Boot, UEFI HTTP Boot and iSCSI Software Initiator for the selected NIC. You might need to configure the NIC firmware for the boot option to be active. This is applicable only in UEFI Boot Mode.
Type Enumeration
Read Only False
Value Description
NetworkBoot Network Boot
Disabled Disabled

Slot3NicBoot7 (Slot 3 NIC Port 7 Boot) Member of Bios.v1_0_0.Bios
Description Use this option to enable or disable UEFI PXE Boot, UEFI HTTP Boot and iSCSI Software Initiator for the selected NIC. You might need to configure the NIC firmware for the boot option to be active. This is applicable only in UEFI Boot Mode.
Type Enumeration
Read Only False
Value Description
NetworkBoot Network Boot
Disabled Disabled

Slot3NicBoot8 (Slot 3 NIC Port 8 Boot) Member of Bios.v1_0_0.Bios
Description Use this option to enable or disable UEFI PXE Boot, UEFI HTTP Boot and iSCSI Software Initiator for the selected NIC. You might need to configure the NIC firmware for the boot option to be active. This is applicable only in UEFI Boot Mode.
Type Enumeration
Read Only False
Value Description
NetworkBoot Network Boot
Disabled Disabled

Slot3StorageBoot (PCIe Slot 3) Member of Bios.v1_0_0.Bios
Description When Boot All Targets is selected, all valid boot targets attached to the storage controller are made available in the UEFI Boot Order list. If Boot No Targets is selected, no boot targets from this storage controller are made available in the UEFI Boot Order.If Boot Limit to 24 Targets is selected, 24 boot targets attached to the storage controller are made available in the UEFI Boot Order.
Type Enumeration
Read Only False
Value Description
AllTargets Boot All Targets
TwentyFourTargets Boot Limit to 24 Targets
NoTargets Boot No Targets

Slot4NicBoot1 (Slot 4 NIC Port 1 Boot) Member of Bios.v1_0_0.Bios
Description Use this option to enable or disable UEFI PXE Boot, UEFI HTTP Boot and iSCSI Software Initiator for the selected NIC. You might need to configure the NIC firmware for the boot option to be active. This is applicable only in UEFI Boot Mode.
Type Enumeration
Read Only False
Value Description
NetworkBoot Network Boot
Disabled Disabled

Slot4NicBoot2 (Slot 4 NIC Port 2 Boot) Member of Bios.v1_0_0.Bios
Description Use this option to enable or disable UEFI PXE Boot, UEFI HTTP Boot and iSCSI Software Initiator for the selected NIC. You might need to configure the NIC firmware for the boot option to be active. This is applicable only in UEFI Boot Mode.
Type Enumeration
Read Only False
Value Description
NetworkBoot Network Boot
Disabled Disabled

Slot4NicBoot3 (Slot 4 NIC Port 3 Boot) Member of Bios.v1_0_0.Bios
Description Use this option to enable or disable UEFI PXE Boot, UEFI HTTP Boot and iSCSI Software Initiator for the selected NIC. You might need to configure the NIC firmware for the boot option to be active. This is applicable only in UEFI Boot Mode.
Type Enumeration
Read Only False
Value Description
NetworkBoot Network Boot
Disabled Disabled

Slot4NicBoot4 (Slot 4 NIC Port 4 Boot) Member of Bios.v1_0_0.Bios
Description Use this option to enable or disable UEFI PXE Boot, UEFI HTTP Boot and iSCSI Software Initiator for the selected NIC. You might need to configure the NIC firmware for the boot option to be active. This is applicable only in UEFI Boot Mode.
Type Enumeration
Read Only False
Value Description
NetworkBoot Network Boot
Disabled Disabled

Slot4NicBoot5 (Slot 4 NIC Port 5 Boot) Member of Bios.v1_0_0.Bios
Description Use this option to enable or disable UEFI PXE Boot, UEFI HTTP Boot and iSCSI Software Initiator for the selected NIC. You might need to configure the NIC firmware for the boot option to be active. This is applicable only in UEFI Boot Mode.
Type Enumeration
Read Only False
Value Description
NetworkBoot Network Boot
Disabled Disabled

Slot4NicBoot6 (Slot 4 NIC Port 6 Boot) Member of Bios.v1_0_0.Bios
Description Use this option to enable or disable UEFI PXE Boot, UEFI HTTP Boot and iSCSI Software Initiator for the selected NIC. You might need to configure the NIC firmware for the boot option to be active. This is applicable only in UEFI Boot Mode.
Type Enumeration
Read Only False
Value Description
NetworkBoot Network Boot
Disabled Disabled

Slot4NicBoot7 (Slot 4 NIC Port 7 Boot) Member of Bios.v1_0_0.Bios
Description Use this option to enable or disable UEFI PXE Boot, UEFI HTTP Boot and iSCSI Software Initiator for the selected NIC. You might need to configure the NIC firmware for the boot option to be active. This is applicable only in UEFI Boot Mode.
Type Enumeration
Read Only False
Value Description
NetworkBoot Network Boot
Disabled Disabled

Slot4NicBoot8 (Slot 4 NIC Port 8 Boot) Member of Bios.v1_0_0.Bios
Description Use this option to enable or disable UEFI PXE Boot, UEFI HTTP Boot and iSCSI Software Initiator for the selected NIC. You might need to configure the NIC firmware for the boot option to be active. This is applicable only in UEFI Boot Mode.
Type Enumeration
Read Only False
Value Description
NetworkBoot Network Boot
Disabled Disabled

Slot4StorageBoot (PCIe Slot 4) Member of Bios.v1_0_0.Bios
Description When Boot All Targets is selected, all valid boot targets attached to the storage controller are made available in the UEFI Boot Order list. If Boot No Targets is selected, no boot targets from this storage controller are made available in the UEFI Boot Order.If Boot Limit to 24 Targets is selected, 24 boot targets attached to the storage controller are made available in the UEFI Boot Order.
Type Enumeration
Read Only False
Value Description
AllTargets Boot All Targets
TwentyFourTargets Boot Limit to 24 Targets
NoTargets Boot No Targets

Slot5NicBoot1 (Slot 5 NIC Port 1 Boot) Member of Bios.v1_0_0.Bios
Description Use this option to enable or disable UEFI PXE Boot, UEFI HTTP Boot and iSCSI Software Initiator for the selected NIC. You might need to configure the NIC firmware for the boot option to be active. This is applicable only in UEFI Boot Mode.
Type Enumeration
Read Only False
Value Description
NetworkBoot Network Boot
Disabled Disabled

Slot5NicBoot2 (Slot 5 NIC Port 2 Boot) Member of Bios.v1_0_0.Bios
Description Use this option to enable or disable UEFI PXE Boot, UEFI HTTP Boot and iSCSI Software Initiator for the selected NIC. You might need to configure the NIC firmware for the boot option to be active. This is applicable only in UEFI Boot Mode.
Type Enumeration
Read Only False
Value Description
NetworkBoot Network Boot
Disabled Disabled

Slot5NicBoot3 (Slot 5 NIC Port 3 Boot) Member of Bios.v1_0_0.Bios
Description Use this option to enable or disable UEFI PXE Boot, UEFI HTTP Boot and iSCSI Software Initiator for the selected NIC. You might need to configure the NIC firmware for the boot option to be active. This is applicable only in UEFI Boot Mode.
Type Enumeration
Read Only False
Value Description
NetworkBoot Network Boot
Disabled Disabled

Slot5NicBoot4 (Slot 5 NIC Port 4 Boot) Member of Bios.v1_0_0.Bios
Description Use this option to enable or disable UEFI PXE Boot, UEFI HTTP Boot and iSCSI Software Initiator for the selected NIC. You might need to configure the NIC firmware for the boot option to be active. This is applicable only in UEFI Boot Mode.
Type Enumeration
Read Only False
Value Description
NetworkBoot Network Boot
Disabled Disabled

Slot5NicBoot5 (Slot 5 NIC Port 5 Boot) Member of Bios.v1_0_0.Bios
Description Use this option to enable or disable UEFI PXE Boot, UEFI HTTP Boot and iSCSI Software Initiator for the selected NIC. You might need to configure the NIC firmware for the boot option to be active. This is applicable only in UEFI Boot Mode.
Type Enumeration
Read Only False
Value Description
NetworkBoot Network Boot
Disabled Disabled

Slot5NicBoot6 (Slot 5 NIC Port 6 Boot) Member of Bios.v1_0_0.Bios
Description Use this option to enable or disable UEFI PXE Boot, UEFI HTTP Boot and iSCSI Software Initiator for the selected NIC. You might need to configure the NIC firmware for the boot option to be active. This is applicable only in UEFI Boot Mode.
Type Enumeration
Read Only False
Value Description
NetworkBoot Network Boot
Disabled Disabled

Slot5NicBoot7 (Slot 5 NIC Port 7 Boot) Member of Bios.v1_0_0.Bios
Description Use this option to enable or disable UEFI PXE Boot, UEFI HTTP Boot and iSCSI Software Initiator for the selected NIC. You might need to configure the NIC firmware for the boot option to be active. This is applicable only in UEFI Boot Mode.
Type Enumeration
Read Only False
Value Description
NetworkBoot Network Boot
Disabled Disabled

Slot5NicBoot8 (Slot 5 NIC Port 8 Boot) Member of Bios.v1_0_0.Bios
Description Use this option to enable or disable UEFI PXE Boot, UEFI HTTP Boot and iSCSI Software Initiator for the selected NIC. You might need to configure the NIC firmware for the boot option to be active. This is applicable only in UEFI Boot Mode.
Type Enumeration
Read Only False
Value Description
NetworkBoot Network Boot
Disabled Disabled

Slot5StorageBoot (PCIe Slot 5) Member of Bios.v1_0_0.Bios
Description When Boot All Targets is selected, all valid boot targets attached to the storage controller are made available in the UEFI Boot Order list. If Boot No Targets is selected, no boot targets from this storage controller are made available in the UEFI Boot Order.If Boot Limit to 24 Targets is selected, 24 boot targets attached to the storage controller are made available in the UEFI Boot Order.
Type Enumeration
Read Only False
Value Description
AllTargets Boot All Targets
TwentyFourTargets Boot Limit to 24 Targets
NoTargets Boot No Targets

Slot6NicBoot1 (Slot 6 NIC Port 1 Boot) Member of Bios.v1_0_0.Bios
Description Use this option to enable or disable UEFI PXE Boot, UEFI HTTP Boot and iSCSI Software Initiator for the selected NIC. You might need to configure the NIC firmware for the boot option to be active. This is applicable only in UEFI Boot Mode.
Type Enumeration
Read Only False
Value Description
NetworkBoot Network Boot
Disabled Disabled

Slot6NicBoot2 (Slot 6 NIC Port 2 Boot) Member of Bios.v1_0_0.Bios
Description Use this option to enable or disable UEFI PXE Boot, UEFI HTTP Boot and iSCSI Software Initiator for the selected NIC. You might need to configure the NIC firmware for the boot option to be active. This is applicable only in UEFI Boot Mode.
Type Enumeration
Read Only False
Value Description
NetworkBoot Network Boot
Disabled Disabled

Slot6NicBoot3 (Slot 6 NIC Port 3 Boot) Member of Bios.v1_0_0.Bios
Description Use this option to enable or disable UEFI PXE Boot, UEFI HTTP Boot and iSCSI Software Initiator for the selected NIC. You might need to configure the NIC firmware for the boot option to be active. This is applicable only in UEFI Boot Mode.
Type Enumeration
Read Only False
Value Description
NetworkBoot Network Boot
Disabled Disabled

Slot6NicBoot4 (Slot 6 NIC Port 4 Boot) Member of Bios.v1_0_0.Bios
Description Use this option to enable or disable UEFI PXE Boot, UEFI HTTP Boot and iSCSI Software Initiator for the selected NIC. You might need to configure the NIC firmware for the boot option to be active. This is applicable only in UEFI Boot Mode.
Type Enumeration
Read Only False
Value Description
NetworkBoot Network Boot
Disabled Disabled

Slot6NicBoot5 (Slot 6 NIC Port 5 Boot) Member of Bios.v1_0_0.Bios
Description Use this option to enable or disable UEFI PXE Boot, UEFI HTTP Boot and iSCSI Software Initiator for the selected NIC. You might need to configure the NIC firmware for the boot option to be active. This is applicable only in UEFI Boot Mode.
Type Enumeration
Read Only False
Value Description
NetworkBoot Network Boot
Disabled Disabled

Slot6NicBoot6 (Slot 6 NIC Port 6 Boot) Member of Bios.v1_0_0.Bios
Description Use this option to enable or disable UEFI PXE Boot, UEFI HTTP Boot and iSCSI Software Initiator for the selected NIC. You might need to configure the NIC firmware for the boot option to be active. This is applicable only in UEFI Boot Mode.
Type Enumeration
Read Only False
Value Description
NetworkBoot Network Boot
Disabled Disabled

Slot6NicBoot7 (Slot 6 NIC Port 7 Boot) Member of Bios.v1_0_0.Bios
Description Use this option to enable or disable UEFI PXE Boot, UEFI HTTP Boot and iSCSI Software Initiator for the selected NIC. You might need to configure the NIC firmware for the boot option to be active. This is applicable only in UEFI Boot Mode.
Type Enumeration
Read Only False
Value Description
NetworkBoot Network Boot
Disabled Disabled

Slot6NicBoot8 (Slot 6 NIC Port 8 Boot) Member of Bios.v1_0_0.Bios
Description Use this option to enable or disable UEFI PXE Boot, UEFI HTTP Boot and iSCSI Software Initiator for the selected NIC. You might need to configure the NIC firmware for the boot option to be active. This is applicable only in UEFI Boot Mode.
Type Enumeration
Read Only False
Value Description
NetworkBoot Network Boot
Disabled Disabled

Slot6StorageBoot (PCIe Slot 6) Member of Bios.v1_0_0.Bios
Description When Boot All Targets is selected, all valid boot targets attached to the storage controller are made available in the UEFI Boot Order list. If Boot No Targets is selected, no boot targets from this storage controller are made available in the UEFI Boot Order.If Boot Limit to 24 Targets is selected, 24 boot targets attached to the storage controller are made available in the UEFI Boot Order.
Type Enumeration
Read Only False
Value Description
AllTargets Boot All Targets
TwentyFourTargets Boot Limit to 24 Targets
NoTargets Boot No Targets

Slot7NicBoot1 (Slot 7 NIC Port 1 Boot) Member of Bios.v1_0_0.Bios
Description Use this option to enable or disable UEFI PXE Boot, UEFI HTTP Boot and iSCSI Software Initiator for the selected NIC. You might need to configure the NIC firmware for the boot option to be active. This is applicable only in UEFI Boot Mode.
Type Enumeration
Read Only False
Value Description
NetworkBoot Network Boot
Disabled Disabled

Slot7NicBoot2 (Slot 7 NIC Port 2 Boot) Member of Bios.v1_0_0.Bios
Description Use this option to enable or disable UEFI PXE Boot, UEFI HTTP Boot and iSCSI Software Initiator for the selected NIC. You might need to configure the NIC firmware for the boot option to be active. This is applicable only in UEFI Boot Mode.
Type Enumeration
Read Only False
Value Description
NetworkBoot Network Boot
Disabled Disabled

Slot7NicBoot3 (Slot 7 NIC Port 3 Boot) Member of Bios.v1_0_0.Bios
Description Use this option to enable or disable UEFI PXE Boot, UEFI HTTP Boot and iSCSI Software Initiator for the selected NIC. You might need to configure the NIC firmware for the boot option to be active. This is applicable only in UEFI Boot Mode.
Type Enumeration
Read Only False
Value Description
NetworkBoot Network Boot
Disabled Disabled

Slot7NicBoot4 (Slot 7 NIC Port 4 Boot) Member of Bios.v1_0_0.Bios
Description Use this option to enable or disable UEFI PXE Boot, UEFI HTTP Boot and iSCSI Software Initiator for the selected NIC. You might need to configure the NIC firmware for the boot option to be active. This is applicable only in UEFI Boot Mode.
Type Enumeration
Read Only False
Value Description
NetworkBoot Network Boot
Disabled Disabled

Slot7StorageBoot (PCIe Slot 7) Member of Bios.v1_0_0.Bios
Description When Boot All Targets is selected, all valid boot targets attached to the storage controller are made available in the UEFI Boot Order list. If Boot No Targets is selected, no boot targets from this storage controller are made available in the UEFI Boot Order.If Boot Limit to 24 Targets is selected, 24 boot targets attached to the storage controller are made available in the UEFI Boot Order.
Type Enumeration
Read Only False
Value Description
AllTargets Boot All Targets
TwentyFourTargets Boot Limit to 24 Targets
NoTargets Boot No Targets

Slot8NicBoot1 (Slot 8 NIC Port 1 Boot) Member of Bios.v1_0_0.Bios
Description Use this option to enable or disable UEFI PXE Boot, UEFI HTTP Boot and iSCSI Software Initiator for the selected NIC. You might need to configure the NIC firmware for the boot option to be active. This is applicable only in UEFI Boot Mode.
Type Enumeration
Read Only False
Value Description
NetworkBoot Network Boot
Disabled Disabled

Slot8NicBoot2 (Slot 8 NIC Port 2 Boot) Member of Bios.v1_0_0.Bios
Description Use this option to enable or disable UEFI PXE Boot, UEFI HTTP Boot and iSCSI Software Initiator for the selected NIC. You might need to configure the NIC firmware for the boot option to be active. This is applicable only in UEFI Boot Mode.
Type Enumeration
Read Only False
Value Description
NetworkBoot Network Boot
Disabled Disabled

Slot8NicBoot3 (Slot 8 NIC Port 3 Boot) Member of Bios.v1_0_0.Bios
Description Use this option to enable or disable UEFI PXE Boot, UEFI HTTP Boot and iSCSI Software Initiator for the selected NIC. You might need to configure the NIC firmware for the boot option to be active. This is applicable only in UEFI Boot Mode.
Type Enumeration
Read Only False
Value Description
NetworkBoot Network Boot
Disabled Disabled

Slot8NicBoot4 (Slot 8 NIC Port 4 Boot) Member of Bios.v1_0_0.Bios
Description Use this option to enable or disable UEFI PXE Boot, UEFI HTTP Boot and iSCSI Software Initiator for the selected NIC. You might need to configure the NIC firmware for the boot option to be active. This is applicable only in UEFI Boot Mode.
Type Enumeration
Read Only False
Value Description
NetworkBoot Network Boot
Disabled Disabled

Slot8StorageBoot (PCIe Slot 8) Member of Bios.v1_0_0.Bios
Description When Boot All Targets is selected, all valid boot targets attached to the storage controller are made available in the UEFI Boot Order list. If Boot No Targets is selected, no boot targets from this storage controller are made available in the UEFI Boot Order.If Boot Limit to 24 Targets is selected, 24 boot targets attached to the storage controller are made available in the UEFI Boot Order.
Type Enumeration
Read Only False
Value Description
AllTargets Boot All Targets
TwentyFourTargets Boot Limit to 24 Targets
NoTargets Boot No Targets

Sriov (SR-IOV) Member of Bios.v1_0_0.Bios
Description If enabled, SR-IOV support enables a hypervisor to create virtual instances of a PCI-express device, potentially increasing performance. If enabled, the BIOS allocates additional resources to PCI-express devices. You can leave this option set to enabled even if you are not using a hypervisor.
Type Enumeration
Read Only False
Value Description
Enabled Enabled
Disabled Disabled

StaleAtoS (Stale A to S) Member of Bios.v1_0_0.Bios
Description Stale A to S directory optimization.
Type Enumeration
Read Only False
Value Description
Enabled Enabled
Disabled Disabled

SubNumaClustering (Sub-NUMA Clustering) Member of Bios.v1_0_0.Bios
Description When enabled, Sub-NUMA Clustering divides the processor’s cores, cache, and memory into multiple NUMA domains. Enabling this feature can increase performance for workloads that are NUMA aware and optimized. Note: When this option is enabled, up to 1GB of system memory may become unavailable.
Type Enumeration
Read Only False
Value Description
Enabled Enabled
Disabled Disabled

ThermalConfig (Thermal Configuration) Member of Bios.v1_0_0.Bios
Description Use this option to select the fan cooling solution for the system. Optimal Cooling provides the most efficient solution by configuring fan speeds to the minimum required speed to provide adequate cooling. Increased Cooling runs fans at higher speeds to provide additional cooling. Select Increased Cooling when third-party storage controllers are cabled to the embedded hard drive cage, or if the system is experiencing thermal issues that cannot be resolved. Maximum cooling provides the maximum cooling available on this platform. Enhanced CPU Cooling runs the fans at a higher speed to provide additional cooling to the processors. Selecting Enhanced CPU Cooling may improve system performance with certain processor intensive workloads.
Type Enumeration
Read Only False
Value Description
OptimalCooling Optimal Cooling
IncreasedCooling Increased Cooling
MaxCooling Maximum Cooling
EnhancedCPUCooling Enhanced CPU Cooling

ThermalShutdown (Thermal Shutdown) Member of Bios.v1_0_0.Bios
Description Use this option to control the reaction of the system to caution level thermal events. When disabled, the System Management Firmware ignores thermal events, and the system immediately powers off in data-destructive situations.
Type Enumeration
Read Only False
Value Description
Enabled Enabled
Disabled Disabled

TimeFormat (Time Format) Member of Bios.v1_0_0.Bios
Description This option controls how the system time is stored in the hardware Real Time Clock (RTC). When configured to ‘Coordinated Universal Time (UTC)’ (default) the local time is calculated from the associated time zone value. When configured to ‘Local Time’ the time is stored directly as local time and the time zone option does not have meaning. Setting this option to ‘Local Time’ works around an issue when using Microsoft Windows operating systems in Legacy Boot Mode where the time is set incorrectly.
Type Enumeration
Read Only False
Value Description
Utc Coordinated Universal Time (UTC)
Local Local Time

TimeZone (Time Zone) Member of Bios.v1_0_0.Bios
Description This option displays the current time zone setting for the system.
Type Enumeration
Read Only False
Value Description
UtcM12 UTC-12:00, International Date Line West
UtcM11 UTC-11:00, Midway Island, Samoa
UtcM10 UTC-10:00, Hawaii
UtcM9 UTC-09:00, Alaska
UtcM8 UTC-08:00, Pacific Time(US & Canada)
UtcM7 UTC-07:00, Mountain Time (US & Canada)
UtcM6 UTC-06:00, Central America, Central Time(US & Canada)
UtcM5 UTC-05:00, Eastern Time(US & Canada)
UtcM430 UTC-04:30, Caracas
UtcM4 UTC-04:00, Atlantic Time(Canada), Caracas, Santiago
UtcM330 UTC-03:30, Newfoundland
UtcM3 UTC-03:00, Brasilia, Buenos Aires, Georgetown, Greenland
UtcM2 UTC-02:00, Mid-Atlantic
UtcM1 UTC-01:00, Azores, Cape Verde Is.
Utc0 UTC-00:00, Greenwich Mean Time, Dublin, London
UtcP1 UTC+01:00, Amsterdam, Berlin, Rome, Paris, West Central Africa
UtcP2 UTC+02:00, Athens, Istanbul, Cairo, Jerusalem
UtcP3 UTC+03:00, Baghdad, Kuwait, Riyadh, Moscow, Nairobi
UtcP330 UTC+03:30, Tehran
UtcP4 UTC+04:00, Abu Dhabi, Muscat, Baku, Tbilisi, Yerevan
UtcP430 UTC+04:30, Kabul
UtcP5 UTC+05:00, Ekaterinburg, Islamabad, Karachi, Tashkent
UtcP530 UTC+05:30, Chennai, Kolkata, Mumbai, New Delhi
UtcP545 UTC+05:45, Kathmandu
UtcP6 UTC+06:00, Almaty, Novosibirsk, Astana, Dhaka
UtcP630 UTC+06:30, Rangoon
UtcP7 UTC+07:00, Bangkok, Hanoi, Jakarta, Krasnoyarsk
UtcP8 UTC+08:00, Taipei, Beijing, Chongqing, Hong Kong, Urumqi
UtcP9 UTC+09:00, Osaka, Sapporo, Tokyo, Seoul, Yakutsk
UtcP930 UTC+09:30, Adelaide, Darwin
UtcP10 UTC+10:00, Canberra, Melbourne, Sydney, Guam, Hobart, Vladivostok
UtcP11 UTC+11:00, Magadan, Solomon Is., New Caledonia
UtcP12 UTC+12:00, Auckland, Wellington, Fiji, Kamchatka, Marshall Is.
UtcP13 UTC+13:00, Nuku'alofa
UtcP14 UTC+14:00, Line Islands
Unspecified Unspecified Time Zone

Tpm20SoftwareInterfaceOperation (TPM 2.0 Software Interface Operation) Member of Bios.v1_0_0.Bios
Description TPM 2.0 Software Interface Operation: FIFO or CRB.
Type Enumeration
Read Only False
Value Description
NoAction No Action
Fifo FIFO interface
Crb CRB interface

Tpm20SoftwareInterfaceStatus (Current TPM 2.0 Software Interface Status) Member of Bios.v1_0_0.Bios
Description Current TPM 2.0 Software Interface Status: FIFO or CRB.
Type Enumeration
Read Only True
Value Description
NoAction No Action
Fifo FIFO interface
Crb CRB interface

Tpm2Operation (TPM 2.0 Operation) Member of Bios.v1_0_0.Bios
Description Use this option to perform a clear operation on the TPM. Clearing the TPM can prevent the server from booting to a TPM-aware operating system if the operating system uses TPM’s measurements. TPM 2.0 is only supported in UEFI Mode.
Type Enumeration
Read Only False
Value Description
NoAction No Action
Clear Clear

TpmActivePcrs (Current TPM 2.0 Active PCRs) Member of Bios.v1_0_0.Bios
Description Current TPM 2.0 Active PCRs: SHA1, SHA256 or SHA1_SHA256
Type Enumeration
Read Only True
Value Description
NotSpecified Not specified
Sha1 SHA1 only
Sha256 SHA256 only
Sha1Sha256 SHA1 and SHA256

TpmChipId (Current TPM Chip ID) Member of Bios.v1_0_0.Bios
Description Current TPM Chip: STMicro, Intel PTT fTPM or Nationz TPM20
Type Enumeration
Read Only True
Value Description
None None
StMicroGen10 ST Micro Gen10
IntelPttFTpm Intel PTT fTPM
NationzTpm20 Nationz TPM20

TpmFips (Current TPM FIPS mode) Member of Bios.v1_0_0.Bios
Description Current TPM FIPS (Federal Information Processing Standard) status: Not specified; non-FIPS certified; FIPS certified.
Type Enumeration
Read Only True
Value Description
NotSpecified Not specified
NonFipsMode Non-FIPS Mode
FipsMode FIPS mode

TpmFipsModeSwitch (TPM FIPS Mode Switch) Member of Bios.v1_0_0.Bios
Description Use this option to switch the TPM chip to FIPS mode, regular mode.
Type Enumeration
Read Only False
Value Description
NoAction No Action
RegularMode Regular mode
FipsMode FIPS mode

TpmModeSwitchOperation (TPM Mode Switch Operation) Member of Bios.v1_0_0.Bios
Description Use this option to switch the TPM chip to TPM 1.2/2.0, FIPS mode or non-FIPS mode.
Type Enumeration
Read Only False
Value Description
NoAction No Action
Tpm12 TPM 1.2
Tpm20 TPM 2.0

TpmOperation (TPM 1.2 Operation) Member of Bios.v1_0_0.Bios
Description Use this option to enable the Trusted Platform Module and BIOS secure startup. When enabled, the TPM is fully functional. When disabled, the TPM is visible; however, functionality is limited. This option also enables you to reset the TPM to factory settings, which clears any assigned passwords, keys, or ownership data. Clearing the TPM can prevent the server from booting to a TPM-aware operating system if the operating system uses TPM’s measurements.
Type Enumeration
Read Only False
Value Description
NoAction No Action
Enable Enable
Disable Disable
Clear Clear

TpmState (Current TPM State) Member of Bios.v1_0_0.Bios
Description Current TPM device state: Not Present; Present and Disabled; Present and Enabled.
Type Enumeration
Read Only True
Value Description
NotPresent Not Present
PresentDisabled Present and Disabled
PresentEnabled Present and Enabled

TpmType (Current TPM Type) Member of Bios.v1_0_0.Bios
Description Current TPM device type.
Type Enumeration
Read Only True
Value Description
NoTpm No TPM
Tpm12 TPM 1.2
Tpm20 TPM 2.0

TpmUefiOpromMeasuring (TPM UEFI Option ROM Measurement) Member of Bios.v1_0_0.Bios
Description Use this option to enable measuring the UEFI PCI option ROMs. Disabling this option skips measuring the UEFI PCI option ROMs.
Type Enumeration
Read Only False
Value Description
Enabled Enabled
Disabled Disabled

TpmVisibility (TPM Visibility) Member of Bios.v1_0_0.Bios
Description Use this option to hide the TPM from the operating system. When the TPM is hidden, BIOS secure startup is disabled, and the TPM does not respond to any commands. Intended use is for removing the TPM option from the system without removing the actual hardware.
Type Enumeration
Read Only False
Value Description
Hidden Hidden
Visible Visible

UefiOptimizedBoot (UEFI Optimized Boot) Member of Bios.v1_0_0.Bios
Description When enabled, the system BIOS boots using native UEFI graphics drivers. When disabled, the system BIOS boots using INT10 legacy video support. You cannot disable this option if Secure Boot is enabled. You can only configure this option if Boot Mode is configured to UEFI Mode. Set this option to disabled for compatibility with Microsoft Windows 2008 and Windows 2008 R2 operating systems on a system configured for UEFI Mode. Set this option to enabled for compatibility with VMWare ESXi operating systems on a system configured for UEFI Mode.
Type Enumeration
Read Only False
Value Description
Enabled Enabled
Disabled Disabled

UefiSerialDebugLevel (UEFI Serial Debug Message Level) Member of Bios.v1_0_0.Bios
Description Use this option to enable the UEFI Serial Debug output and verbosity level. Selecting Verbose can impact server boot time significantly. This option is only applicable in UEFI Mode.
Type Enumeration
Read Only False
Value Description
Disabled Disabled
ErrorsOnly Errors Only
Medium Medium
Network Network
Verbose Verbose
Custom Custom

UefiShellBootOrder (Add Embedded UEFI Shell to Boot Order) Member of Bios.v1_0_0.Bios
Description When enabled, this option adds the Embedded UEFI Shell as an entry in the UEFI Boot Order list. This option is only available when the Boot Mode is configured to UEFI Mode and the Embedded UEFI Shell is enabled.
Type Enumeration
Read Only False
Value Description
Enabled Enabled
Disabled Disabled

UefiShellScriptVerification (Shell Script Verification) Member of Bios.v1_0_0.Bios
Description Enable this option to allow verification of UEFI shell script files when Secure Boot is enabled. For successful execution of script, make sure that UEFI shell scripts are enrolled in the Secure Boot database (db).
Type Enumeration
Read Only False
Value Description
Enabled Enabled
Disabled Disabled

UefiShellStartup (UEFI Shell Script Auto-Start) Member of Bios.v1_0_0.Bios
Description Use this option to enable or disable automatic execution of the Embedded UEFI Shell startup script. You can store the script file on local media or access it from a network location. You must name the script file “startup.nsh” and place it on local media or a network location accessible to the server.
Type Enumeration
Read Only False
Value Description
Enabled Enabled
Disabled Disabled

UefiShellStartupLocation (Shell Auto-Start Script Location) Member of Bios.v1_0_0.Bios
Description Use this option to select the location of the Embedded UEFI Shell startup script. For the ‘File Systems on Attached Media’ option, you must name the script file “startup.nsh” and place it on a UEFI accessible local file system, such as a FAT32 partition on a USB disk or HDD. For the ‘Network Location’ option, the file must end with a .nsh extension, and must be placed at an HTTP/HTTPS or FTP location accessible to the system. When you select the ‘Auto’ option, the system attempts to retrieve the startup script from the network location first, followed by locally attached media.
Type Enumeration
Read Only False
Value Description
Auto Auto
AttachedMedia File Systems on Attached Media
NetworkLocation Network Location

UefiShellStartupUrl (Network Location for Shell Auto-Start Script) Member of Bios.v1_0_0.Bios
Description Use this option to configure a network URL to a UEFI Shell startup script. This option is available and used only when the Auto-Start Script Location is set to ‘Network Location’, or ‘Auto’, and the Shell Auto-Start Script discovery using DHCP is set to ‘Disabled’. URLs in HTTP/HTTPS are accepted using either an IPv4 or IPv6 server address, or using a host name. FTP formats are accepted using either an IPv4 server address or a host name. For example, the URLs can be in any of the following formats: http://192.168.0.1/file/file.nsh, http://example.com/file/file.nsh, https://example.com/file/file.nsh, http://[1234::1000]/file.nsh. The file must end with an .nsh extension. When configured, the Embedded UEFI Shell attempts to load and execute the startup script from the network location pointed to by this URL. When a HTTPS URL is configured, you must enroll the respective HTTPS server’s TLS certificate under Server Security > TLS(HTTPS) Options.
Type String
Read Only False

UefiShellStartupUrlFromDhcp (Discover Shell Auto-Start Script using DHCP) Member of Bios.v1_0_0.Bios
Description Use this option to let the Shell discover its startup script URL using DHCP. This option is available only if the ‘HTTP Support’ policy is not set to ‘Disabled’ and Auto-Start Script Location is set to ‘Network Location’, or ‘Auto’. When set to ‘Enabled’, the Shell sends DHCP requests with the DHCP User Class option set to the string ‘UEFIShell’. The DHCP server must be configured to provide HTTP/HTTPS or FTP URLs when this DHCP User Class string is present in the DHCP request. The User Class option is Option 77 when using DHCP over IPv4, and Option 15 when using DHCP over IPv6. URLs in HTTP/HTTPS must use either an IPv4 or IPv6 server address, or a host name. FTP formats are accepted using either an IPv4 server address or a host name. The URL provided by the DHCP server should match the ‘HTTP Support’ policy. When ‘HTTP Support’ policy is set to ‘Auto’, any HTTP/HTTPS or FTP URL provided by the DHCP server is used. When policy is set to ‘HTTPS only’, only HTTPS URLs are used, and other URLs are ignored. When policy is set to ‘HTTP only’, only HTTP or FTP URLs are used, and other URLs are ignored. When policy is set to ‘Disabled’, the Shell does not send any DHCP request.
Type Enumeration
Read Only False
Value Description
Enabled Enabled
Disabled Disabled

UncoreFreqScaling (Uncore Frequency Scaling) Member of Bios.v1_0_0.Bios
Description This option controls the frequency scaling of the processor’s internal busses (the uncore.) Setting this option to Auto enables the processor to dynamically change frequencies based on workload. Forcing to the maximum or minimum frequency enables tuning for latency or power consumption.
Type Enumeration
Read Only False
Value Description
Auto Auto
Maximum Maximum
Minimum Minimum

UpiPrefetcher (UPI Prefetcher) Member of Bios.v1_0_0.Bios
Description Use this option to disable the processor UPI Prefetch feature. In some cases, setting this option to disabled can improve performance. Typically, setting this option to enabled provides better performance. Only disable this option after performing application benchmarking to verify improved performance in the environment. This option must be enabled when Sub-Numa Clustering (SNC) is enabled.
Type Enumeration
Read Only False
Value Description
Enabled Enabled
Disabled Disabled

UrlBootFile (Boot from URL 1) Member of Bios.v1_0_0.Bios
Description Use this option to configure a network URL to a bootable ISO or EFI file. URLs in HTTP/HTTPS are accepted using either an IPv4 or IPv6 server address, or using a host name. For example, the URLs can be in any of the following formats: http://192.168.0.1/file/image.iso, http://example.com/file/image.efi, https://example.com/file/image.efi, http://[1234::1000]/image.iso. When configured, this URL is listed as a boot option in the UEFI boot menu. Selecting this boot option downloads the file to the system memory, and configures the system to attempt to boot from it. There is no specific ordering on this option. It can be independently ordered in the boot menu. This setting requires configuring the ‘Pre-Boot Network Interface’ option if you want to access the URL location through a specific network interface. When a HTTPS URL is configured, this setting requires enrolling the respective TLS certificate of the HTTPS server under Server Security > TLS(HTTPS) Options. This option does not depend on the \“DHCPv4\” and \“IPv6 Config Policy\” settings. This is only applicable in UEFI Mode. Note: Booting from an ISO file can involve only booting a preliminary OS environment image, such as WinPE or a mini Linux, or a complete OS install image if the OS supports the HTTP Boot feature (Old OS versions may not support this). Please check your OS documentation for the HTTP Boot feature support.
Type String
Read Only False

UrlBootFile2 (Boot from URL 2) Member of Bios.v1_0_0.Bios
Description Use this option to configure a network URL to a bootable ISO or EFI file. URLs in HTTP/HTTPS are accepted using either an IPv4 or IPv6 server address, or using a host name. For example, the URLs can be in any of the following formats: http://192.168.0.1/file/image.iso, http://example.com/file/image.efi, https://example.com/file/image.efi, http://[1234::1000]/image.iso. When configured, this URL is listed as a boot option in the UEFI boot menu. Selecting this boot option downloads the file to the system memory, and configures the system to attempt to boot from it. There is no specific ordering on this option. It can be independently ordered in the boot menu. This setting requires configuring the ‘Pre-Boot Network Interface’ option if you want to access the URL location through a specific network interface. When a HTTPS URL is configured, this setting requires enrolling the respective TLS certificate of the HTTPS server under Server Security > TLS(HTTPS) Options. This option does not depend on the \“DHCPv4\” and \“IPv6 Config Policy\” settings. This is only applicable in UEFI Mode. Note: Booting from an ISO file can involve only booting a preliminary OS environment image, such as WinPE or a mini Linux, or a complete OS install image if the OS supports the HTTP Boot feature (Old OS versions may not support this). Please check your OS documentation for the HTTP Boot feature support.
Type String
Read Only False

UrlBootFile3 (Boot from URL 3) Member of Bios.v1_0_0.Bios
Description Use this option to configure a network URL to a bootable ISO or EFI file. URLs in HTTP/HTTPS are accepted using either an IPv4 or IPv6 server address, or using a host name. For example, the URLs can be in any of the following formats: http://192.168.0.1/file/image.iso, http://example.com/file/image.efi, https://example.com/file/image.efi, http://[1234::1000]/image.iso. When configured, this URL is listed as a boot option in the UEFI boot menu. Selecting this boot option downloads the file to the system memory, and configures the system to attempt to boot from it. There is no specific ordering on this option. It can be independently ordered in the boot menu. This setting requires configuring the ‘Pre-Boot Network Interface’ option if you want to access the URL location through a specific network interface. When a HTTPS URL is configured, this setting requires enrolling the respective TLS certificate of the HTTPS server under Server Security > TLS(HTTPS) Options. This option does not depend on the \“DHCPv4\” and \“IPv6 Config Policy\” settings. This is only applicable in UEFI Mode. Note: Booting from an ISO file can involve only booting a preliminary OS environment image, such as WinPE or a mini Linux, or a complete OS install image if the OS supports the HTTP Boot feature (Old OS versions may not support this). Please check your OS documentation for the HTTP Boot feature support.
Type String
Read Only False

UrlBootFile4 (Boot from URL 4) Member of Bios.v1_0_0.Bios
Description Use this option to configure a network URL to a bootable ISO or EFI file. URLs in HTTP/HTTPS are accepted using either an IPv4 or IPv6 server address, or using a host name. For example, the URLs can be in any of the following formats: http://192.168.0.1/file/image.iso, http://example.com/file/image.efi, https://example.com/file/image.efi, http://[1234::1000]/image.iso. When configured, this URL is listed as a boot option in the UEFI boot menu. Selecting this boot option downloads the file to the system memory, and configures the system to attempt to boot from it. There is no specific ordering on this option. It can be independently ordered in the boot menu. This setting requires configuring the ‘Pre-Boot Network Interface’ option if you want to access the URL location through a specific network interface. When a HTTPS URL is configured, this setting requires enrolling the respective TLS certificate of the HTTPS server under Server Security > TLS(HTTPS) Options. This option does not depend on the \“DHCPv4\” and \“IPv6 Config Policy\” settings. This is only applicable in UEFI Mode. Note: Booting from an ISO file can involve only booting a preliminary OS environment image, such as WinPE or a mini Linux, or a complete OS install image if the OS supports the HTTP Boot feature (Old OS versions may not support this). Please check your OS documentation for the HTTP Boot feature support.
Type String
Read Only False

UsbBoot (USB Boot Support) Member of Bios.v1_0_0.Bios
Description Set this option to disabled to prevent the system from booting to any USB devices connected to the server. This includes preventing boot to virtual media devices, and the embedded SD or uSD card slot (if supported).
Type Enumeration
Read Only False
Value Description
Enabled Enabled
Disabled Disabled

UsbControl (USB Control) Member of Bios.v1_0_0.Bios
Description All USB Ports Enabled: Enables all USB ports and embedded devices.All USB Ports Disabled: Disables all USB ports and embedded devices.External USB Ports Disabled: Disables only external USB ports.Internal USB Ports Disabled: Disables only internal USB ports.
Type Enumeration
Read Only False
Value Description
UsbEnabled All USB Ports Enabled
UsbDisabled All USB Ports Disabled
ExternalUsbDisabled External USB Ports Disabled
InternalUsbDisabled Internal USB Ports Disabled

UserDefaultsState (User Defaults) Member of Bios.v1_0_0.Bios
Description Displays whether user default settings are enabled or disabled.
Type Enumeration
Read Only True
Value Description
Enabled Enabled
Disabled Disabled

UtilityLang (Utility Language) Member of Bios.v1_0_0.Bios
Description Select this option to adjust the current language for the system.
Type Enumeration
Read Only False
Value Description
English English
Japanese Japanese
Chinese Chinese

VideoOptions (Video Options) Member of Bios.v1_0_0.Bios
Description Use this option to configure video settings in the system. When set to Add-in Video Enabled, Embedded Video Disabled, the system only displays video to the first discovered add-in video controller. When set to Both Add-in and Embedded Video Enabled, the system displays video to both the embedded and the first discovered add-in video controllers. In both modes, early system startup video is displayed to the embedded video controller.
Type Enumeration
Read Only False
Value Description
OptionalVideoOnly Add-in Video Enabled, Embedded Video Disabled
BothVideoEnabled Both Add-in and Embedded Video Enabled

VirtualInstallDisk (Virtual Install Disk) Member of Bios.v1_0_0.Bios
Description Use this option to control the Virtual Install Disk. The Virtual Install Disk contains drivers specific to this server that an OS can use during installation. If enabled, the Virtual Install Disk appears as a drive in the operating system.
Type Enumeration
Read Only False
Value Description
Enabled Enabled
Disabled Disabled

VirtualSerialPort (Virtual Serial Port) Member of Bios.v1_0_0.Bios
Description Use this option to assign the logical COM port address and associated default resources used by the Virtual Serial Port (VSP). VSP enables the Management Processor to present an emulated serial port to support the BIOS Serial Console and operating system serial console.
Type Enumeration
Read Only False
Value Description
Com1Irq4 COM 1; IRQ4; I/O: 3F8h-3FFh
Com2Irq3 COM 2; IRQ3; I/O: 2F8h-2FFh
Disabled Disabled

VlanControl (VLAN Control) Member of Bios.v1_0_0.Bios
Description Use this option to enable or disable VLAN tagging on all enabled network interfaces.
Type Enumeration
Read Only False
Value Description
Enabled Enabled
Disabled Disabled

VlanId (VLAN ID) Member of Bios.v1_0_0.Bios
Description Use this option to set the global VLAN ID for all enabled network interfaces. Valid values are 0 to 4094.A value of 0 sets the device to send untagged frames.
Type Integer
Read Only False

VlanPriority (VLAN Priority) Member of Bios.v1_0_0.Bios
Description Use this option to set the priority for the VLAN tagged frames. Valid values are 0 to 7.
Type Integer
Read Only False

WakeOnLan (Wake-On LAN) Member of Bios.v1_0_0.Bios
Description You can configure the server to be powered on remotely when it receives a special packet. This option requires a NIC, NIC driver, and operating system that are WOL-capable.
Type Enumeration
Read Only False
Value Description
Enabled Enabled
Disabled Disabled

WorkloadProfile (Workload Profile) Member of Bios.v1_0_0.Bios
Description Select this option to change the Workload Profile to accommodate your desired workload. Settings that are changed by the Workload Profile are grayed out and unchangeable unless in the ‘Custom’ profile. Please refer to the ‘UEFI Workload-based Performance Tuning Guide’ for details on which profiles affect which options.
Type Enumeration
Read Only False
Value Description
GeneralPowerEfficientCompute General Power Efficient Compute
GeneralPeakFrequencyCompute General Peak Frequency Compute
GeneralThroughputCompute General Throughput Compute
Virtualization-PowerEfficient Virtualization - Power Efficient
Virtualization-MaxPerformance Virtualization - Max Performance
LowLatency Low Latency
MissionCritical Mission Critical
TransactionalApplicationProcessing Transactional Application Processing
HighPerformanceCompute(HPC) High Performance Compute (HPC)
DecisionSupport Decision Support
GraphicProcessing Graphic Processing
I/OThroughput I/O Throughput
Custom Custom

XptPrefetcher (XPT Prefetcher) Member of Bios.v1_0_0.Bios
Description Use this option to disable the processor XPT Prefetch feature. In some cases, setting this option to disabled can improve performance. Typically, setting this option to enabled provides better performance. Only disable this option after performing application benchmarking to verify improved performance in the environment. This option must be enabled when Sub-Numa Clustering (SNC) is enabled.
Type Enumeration
Read Only False
Value Description
Auto Auto
Enabled Enabled
Disabled Disabled

iSCSIPolicy (iSCSI Policy) Member of Bios.v1_0_0.Bios
Description Use this option to set the iSCSI Policy. If configured to Software Initiator, the iSCSI software initiator will be used to access iSCSI targets on any configured NIC ports. If configured to Adapter Initiator, the adapter specific iSCSI initiator will be used instead. The adapter firmware must be configured to access iSCSI targets from the adapter initiator.
Type Enumeration
Read Only False
Value Description
SoftwareInitiator Software Initiator
AdapterInitiator Adapter Initiator

BootOption.v1_0_1.BootOption

@odata.type: "#BootOption.v1_0_1.BootOption"

This is the schema definition for the BootOption resource. It represents the properties of a bootable device available in the System.

Resource Instances

Uri HTTP Allow
/redfish/v1/systems/{item}/bootoptions/{item} GET

Alias

Member of BootOption.v1_0_1.BootOption
Description The alias of this Boot Source.
Type string or null
Read Only True

BootOptionEnabled

Member of BootOption.v1_0_1.BootOption
Description A flag that shows if the Boot Option is enabled.
Type boolean or null
Read Only False

BootOptionReference

Member of BootOption.v1_0_1.BootOption
Description The unique boot option string that is referenced in the BootOrder.
Type string or null
Read Only True

DisplayName

Member of BootOption.v1_0_1.BootOption
Description The user-readable display string of the Boot Option.
Type string or null
Read Only True

UefiDevicePath

Member of BootOption.v1_0_1.BootOption
Description The UEFI device path used to access this UEFI Boot Option.
Type string or null
Read Only True

BootOptionCollection.BootOptionCollection

@odata.type: "#BootOptionCollection.BootOptionCollection"

A Collection of BootOption resource instances.

Resource Instances

Uri HTTP Allow
/redfish/v1/systems/{item}/bootoptions GET
Link Name Destination type
Members[] BootOption

Members (array)

Member of BootOptionCollection.BootOptionCollection Members is an array containing elements of:

Members[{item}].@odata.id Member of BootOptionCollection.BootOptionCollection
Type string
Read Only True
Format uri-reference

Members@odata.count

Member of BootOptionCollection.BootOptionCollection
Description The total number of collection members.
Type integer
Read Only True

Certificate.v1_6_0.Certificate

@odata.type: "#Certificate.v1_6_0.Certificate"

The Certificate resource describes an X509 certificate.

Resource Instances

Uri HTTP Allow
/redfish/v1/accountservice/externalaccountproviders/ldap/certificates/{item} GET PATCH DELETE
/redfish/v1/managers/{item}/securityservice/iloidevid/certificates/{item} GET
/redfish/v1/managers/{item}/securityservice/iloldevid/certificates/{item} GET POST DELETE
/redfish/v1/managers/{item}/securityservice/platformcert/certificates/{item} GET
/redfish/v1/managers/{item}/securityservice/systemiak/certificates/{item} GET
/redfish/v1/managers/{item}/securityservice/systemidevid/certificates/{item} GET

CertificateString

Member of Certificate.v1_6_0.Certificate
Description Contains PEM formatted X509 certificate or PKCS7 certificate chain (Base64 encoded).
Type string
Read Only False
Added iLO 5 1.40
Format text

CertificateType

Member of Certificate.v1_6_0.Certificate
Type string
Read Only False

The following are the supported values:

Value Description
PEM A PEM encoded certificate.
PKCS7 A PEM encoded PKCS7 certificate.

Issuer

Issuer.City Member of Certificate.v1_6_0.Certificate
Description The city or locality of the organization of the entity.
Type string
Read Only True

Issuer.CommonName Member of Certificate.v1_6_0.Certificate
Description The fully qualified domain name of the entity.
Type string
Read Only True

Issuer.Country Member of Certificate.v1_6_0.Certificate
Description The country of the organization of the entity.
Type string
Read Only True

Issuer.DisplayString Member of Certificate.v1_6_0.Certificate
Description A human-readable string for this identifier.
Type string or null
Read Only True

Issuer.Email Member of Certificate.v1_6_0.Certificate
Description The email address of the contact within the organization of the entity.
Type string or null
Read Only True

Issuer.Organization Member of Certificate.v1_6_0.Certificate
Description The name of the organization of the entity.
Type string
Read Only True

Issuer.OrganizationalUnit Member of Certificate.v1_6_0.Certificate
Description The name of the unit or division of the organization of the entity.
Type string
Read Only True

Issuer.State Member of Certificate.v1_6_0.Certificate
Description The state, province, or region of the organization of the entity.
Type string
Read Only True

SerialNumber

Member of Certificate.v1_6_0.Certificate
Description The serial number that the Certificate Authority assigned to the certificate.
Type string
Read Only True
Added iLO 5 1.40

Subject

Subject.City Member of Certificate.v1_6_0.Certificate
Description The city or locality of the organization of the entity.
Type string
Read Only True

Subject.CommonName Member of Certificate.v1_6_0.Certificate
Description The fully qualified domain name of the entity.
Type string
Read Only True

Subject.Country Member of Certificate.v1_6_0.Certificate
Description The country of the organization of the entity.
Type string
Read Only True

Subject.DisplayString Member of Certificate.v1_6_0.Certificate
Description A human-readable string for this identifier.
Type string or null
Read Only True

Subject.Email Member of Certificate.v1_6_0.Certificate
Description The email address of the contact within the organization of the entity.
Type string or null
Read Only True

Subject.Organization Member of Certificate.v1_6_0.Certificate
Description The name of the organization of the entity.
Type string
Read Only True

Subject.OrganizationalUnit Member of Certificate.v1_6_0.Certificate
Description The name of the unit or division of the organization of the entity.
Type string
Read Only True

Subject.State Member of Certificate.v1_6_0.Certificate
Description The state, province, or region of the organization of the entity.
Type string
Read Only True

ValidNotAfter

Member of Certificate.v1_6_0.Certificate
Description The date on which the certificate validity period ends.
Type string or null
Read Only True
Added iLO 5 1.40
Format date-time

ValidNotBefore

Member of Certificate.v1_6_0.Certificate
Description The date on which the certificate validity period begins.
Type string or null
Read Only True
Added iLO 5 1.40
Format date-time

CertificateCollection.CertificateCollection

@odata.type: "#CertificateCollection.CertificateCollection"

A Collection of Certificate resource instances.

Resource Instances

Uri HTTP Allow
/redfish/v1/accountservice/externalaccountproviders/ldap/certificates GET POST
/redfish/v1/managers/{item}/securityservice/iloidevid/certificates GET
/redfish/v1/managers/{item}/securityservice/iloldevid/certificates GET POST
/redfish/v1/managers/{item}/securityservice/platformcert/certificates GET
/redfish/v1/managers/{item}/securityservice/systemiak/certificates GET
/redfish/v1/managers/{item}/securityservice/systemidevid/certificates GET
Link Name Destination type
Members[] Certificate

Members (array)

Member of CertificateCollection.CertificateCollection Members is an array containing elements of:

Members[{item}].@odata.id Member of CertificateCollection.CertificateCollection
Type string
Read Only True
Format uri-reference

Members@odata.count

Member of CertificateCollection.CertificateCollection
Description The total number of collection members.
Type integer
Read Only True

CertificateLocations.v1_0_2.CertificateLocations

@odata.type: "#CertificateLocations.v1_0_2.CertificateLocations"

The CertificateLocations schema describes a Resource that an administrator can use in order to locate all certificates installed on a given service.

Resource Instances

Uri HTTP Allow
/redfish/v1/certificateservice/certificatelocations GET

CertificateService.v1_0_3.CertificateService

@odata.type: "#CertificateService.v1_0_3.CertificateService"

The CertificateService schema describes a certificate service that represents the actions available to manage certificates and links to the certificates.

Resource Instances

Uri HTTP Allow
/redfish/v1/certificateservice GET POST
Link Name Destination type
Links/CertificateLocations CertificateLocations

CertificateLocations

The information about the location of certificates. CertificateLocations is a link ("@odata.id": URI) to another resource.

Actions

CertificateService.GenerateCSR Member of CertificateService.v1_0_3.CertificateService

Parameters:

AlternativeNames (array)

The additional host names of the component to secure.

CertificateCollection (object)

The link to the certificate collection where the certificate is installed after the certificate authority (CA) signs the certificate.

ChallengePassword (string)

The challenge password to apply to the certificate for revocation requests.

City (string)

The city or locality of the organization making the request.

CommonName (string)

The fully qualified domain name of the component to secure.

ContactPerson (string)

The name of the user making the request.

Country (string)

The two-letter country code of the organization making the request.

Email (string)

The email address of the contact within the organization making the request.

GivenName (string)

The given name of the user making the request.

Initials (string)

The initials of the user making the request.

KeyBitLength (integer)

The length of the key, in bits, if needed based on the KeyPairAlgorithm parameter value.

KeyCurveId (string)

The curve ID to use with the key, if needed based on the KeyPairAlgorithm parameter value.

KeyPairAlgorithm (string)

The type of key-pair for use with signing algorithms.

KeyUsage (array)

The usage of the key contained in the certificate.

Organization (string)

The name of the organization making the request.

OrganizationalUnit (string)

The name of the unit or division of the organization making the request.

State (string)

The state, province, or region of the organization making the request.

Surname (string)

The surname of the user making the request.

UnstructuredName (string)

The unstructured name of the subject.

Chassis.v1_19_0.Chassis

@odata.type: "#Chassis.v1_19_0.Chassis"

The Chassis resource describes the physical components for a system. This object represents rack mount servers, blades, and all other containers. The non-CPU/device-centric parts of the schema are accessed either directly or indirectly through this resource.

Resource Instances

Uri HTTP Allow
/redfish/v1/chassis/{item} GET POST PATCH
Link Name Destination type
Links/ComputerSystems[] ComputerSystem
Links/Drives[] Drive
Links/ManagedBy[] Manager
NetworkAdapters Collection of NetworkAdapter
Oem/Hpe/Links/Devices Collection of HpeServerDevice
Power Power
Thermal Thermal

AssetTag

Member of Chassis.v1_19_0.Chassis
Description The chassis user-assigned asset tag.
Type string or null
Read Only False
Added iLO 5 1.10

ChassisType

Member of Chassis.v1_19_0.Chassis
Description This property indicates the physical form factor type of this resource.
Type string
Read Only True
Added iLO 5 1.10

The following are the supported values:

Value Description
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.

IndicatorLED

Member of Chassis.v1_19_0.Chassis
Description The chassis indicator LED that is used to identify the chassis. The user can manipulate this LED.
Type string or null
Read Only False
Added iLO 5 1.10

The following are the supported values:

Value Description
Null A value is temporarily unavailable
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.

Location

Location.PartLocation Location.PartLocation.LocationOrdinalValue Member of Chassis.v1_19_0.Chassis
Description The number that represents the location of the part. If LocationType is slot and this unit is in slot 2, the LocationOrdinalValue is 2.
Type integer or null
Read Only True

Location.PartLocation.LocationType Member of Chassis.v1_19_0.Chassis
Description The location types for PartLocation.
Type string or null
Read Only True

The following are the supported values:

Value Description
Null A value is temporarily unavailable
Slot The slot as the type of location.
Bay The bay as the type of location.
Connector The connector as the type of location.
Socket The socket as the type of location.

Location.PartLocation.Orientation Member of Chassis.v1_19_0.Chassis
Description The orientation for the ordering of the part location ordinal value.
Type string or null
Read Only True

The following are the supported values:

Value Description
Null A value is temporarily unavailable
FrontToBack The ordering for LocationOrdinalValue is front to back.
BackToFront The ordering for the LocationOrdinalValue is back to front.
TopToBottom The ordering for the LocationOrdinalValue is top to bottom.
BottomToTop The ordering for LocationOrdinalValue is bottom to top.
LeftToRight The ordering for the LocationOrdinalValue is left to right.
RightToLeft The ordering for the LocationOrdinalValue is right to left.

Location.PartLocation.Reference Member of Chassis.v1_19_0.Chassis
Description The reference area for the location of the part.
Type string or null
Read Only True

The following are the supported values:

Value Description
Null A value is temporarily unavailable
Top The part is in the top of the unit.
Bottom The part is in the bottom of the unit.
Front The part is in the front of the unit.
Rear The part is in the rear of the unit.
Left The part is on the left side of of the unit.
Right The part is on the right side of the unit.
Middle The part is in the middle of the unit.

Location.PartLocation.ServiceLabel Member of Chassis.v1_19_0.Chassis
Description The label of the part location, such as a silk-screened name or a printed label.
Type string or null
Read Only True

Location.Placement Location.Placement.AdditionalInfo Member of Chassis.v1_19_0.Chassis
Description Area designation or other additional info.
Type string or null
Read Only False

Location.Placement.Rack Member of Chassis.v1_19_0.Chassis
Description The name of a rack location within a row.
Type string or null
Read Only False

Location.Placement.RackOffset Member of Chassis.v1_19_0.Chassis
Description The vertical location of the item, in terms of RackOffsetUnits.
Type integer or null
Read Only False

Location.Placement.RackOffsetUnits Member of Chassis.v1_19_0.Chassis
Description The type of rack unit in use.
Type string or null
Read Only False

The following are the supported values:

Value Description
Null A value is temporarily unavailable
OpenU A rack unit that is equal to 48 mm (1.89 in).
EIA_310 A rack unit that is equal to 1.75 in (44.45 mm).

Location.Placement.Row Member of Chassis.v1_19_0.Chassis
Description The name of the row.
Type string or null
Read Only False

LocationIndicatorActive

Member of Chassis.v1_19_0.Chassis
Description An indicator allowing an operator to physically locate this resource.
Type boolean or null
Read Only False

Manufacturer

Member of Chassis.v1_19_0.Chassis
Description The chassis manufacturer.
Type string or null
Read Only True
Added iLO 5 1.10

Model

Member of Chassis.v1_19_0.Chassis
Description The chassis model number.
Type string or null
Read Only True
Added iLO 5 1.10

NetworkAdapters

The collection of network adapters contained within this chassis. NetworkAdapters is a link ("@odata.id": URI) to another resource.

Oem.Hpe.BayNumber

Member of Chassis.v1_19_0.Chassis
Description The bay number of the node or the blade.
Type integer
Read Only True
Added iLO 5 1.10

Oem.Hpe.BaysConsumedHeight

Member of Chassis.v1_19_0.Chassis
Description The number of enclosure bays this chassis consumes in height.
Type integer
Read Only True
Added iLO 5 1.10

Oem.Hpe.BaysConsumedWidth

Member of Chassis.v1_19_0.Chassis
Description The number of enclosure bays this chassis consumes in width.
Type integer
Read Only True
Added iLO 5 1.10

Oem.Hpe.ChassisInputPowerWatts

Member of Chassis.v1_19_0.Chassis
Description The total input power consumed by the chassis and nodes.
Type integer
Read Only True

Oem.Hpe.ChassisPowerWatts

Member of Chassis.v1_19_0.Chassis
Description The total power consumed by the chassis and nodes.
Type integer
Read Only True

Oem.Hpe.ChassisServerLockActive

Member of Chassis.v1_19_0.Chassis
Description When Chassis Server Lock is activated, the server will be linked to the current chassis and not allow SSO connections from any other chassis.
Type boolean
Read Only False

Oem.Hpe.ChassisServerLockValid

Member of Chassis.v1_19_0.Chassis
Description The server is installed in the same chassis that it was linked to when Chassis Server Lock was activated.
Type boolean
Read Only True

Oem.Hpe.ElConfigOverride

Member of Chassis.v1_19_0.Chassis
Description The value indicates if Thermal Configuration includes Edgeline specific options.
Type boolean
Read Only False

Oem.Hpe.EnclosureCPLD

Member of Chassis.v1_19_0.Chassis
Description The CPLD version of the enclosure.
Type string
Read Only True

Oem.Hpe.EnclosureDateTime

Member of Chassis.v1_19_0.Chassis
Description The date and time in a Moonshot EL chassis (enclosure).
Type string
Read Only False
Format date-time

Oem.Hpe.EnclosureIndicatorLED

Member of Chassis.v1_19_0.Chassis
Description The enclosure indicator LED that is used to identify the enclosure.
Type string or null
Read Only True
Added iLO 5 1.40

The following are the supported values:

Value Description
Null A value is temporarily unavailable
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.

Oem.Hpe.EnclosureModel

Member of Chassis.v1_19_0.Chassis
Description Type of enclosure.
Type string
Read Only True
Added iLO 5 1.40

Oem.Hpe.EnclosureUUID

Member of Chassis.v1_19_0.Chassis
Description The UUID of the enclosure.
Type string
Read Only True
Added iLO 5 1.40

Oem.Hpe.Firmware

Oem.Hpe.Firmware.ChassisControllerVersion Oem.Hpe.Firmware.ChassisControllerVersion.Current Oem.Hpe.Firmware.ChassisControllerVersion.Current.VersionString Member of Chassis.v1_19_0.Chassis
Description The firmware version of the chassis controller.
Type string
Read Only True

Oem.Hpe.Firmware.PlatformDefinitionTable Oem.Hpe.Firmware.PlatformDefinitionTable.Current Oem.Hpe.Firmware.PlatformDefinitionTable.Current.VersionString Member of Chassis.v1_19_0.Chassis
Description The version of the Intelligent Platform Abstraction Data.
Type string
Read Only True
Added iLO 5 1.10

Oem.Hpe.Firmware.PowerManagementController Oem.Hpe.Firmware.PowerManagementController.Current Oem.Hpe.Firmware.PowerManagementController.Current.VersionString Member of Chassis.v1_19_0.Chassis
Description The firmware version of the Power Monitor.
Type string
Read Only True
Added iLO 5 1.10

Oem.Hpe.Firmware.PowerManagementControllerBootloader Oem.Hpe.Firmware.PowerManagementControllerBootloader.Current Oem.Hpe.Firmware.PowerManagementControllerBootloader.Current.Family Member of Chassis.v1_19_0.Chassis
Description The family type of the Power Monitor hardware.
Type string
Read Only True
Added iLO 5 1.10

Oem.Hpe.Firmware.PowerManagementControllerBootloader.Current.VersionString Member of Chassis.v1_19_0.Chassis
Description The firmware version of the Power Monitor boot loader.
Type string
Read Only True
Added iLO 5 1.10

Oem.Hpe.Firmware.SASProgrammableLogicDevice Oem.Hpe.Firmware.SASProgrammableLogicDevice.Current Oem.Hpe.Firmware.SASProgrammableLogicDevice.Current.VersionString Member of Chassis.v1_19_0.Chassis
Description The firmware version of the SAS controller.
Type string
Read Only True
Added iLO 5 1.10

Oem.Hpe.Firmware.SPSFirmwareVersionData Oem.Hpe.Firmware.SPSFirmwareVersionData.Current Oem.Hpe.Firmware.SPSFirmwareVersionData.Current.VersionString Member of Chassis.v1_19_0.Chassis
Description The SPS FW Version number, aka ME FW Version, AAAA.BBBB.CCCC.DDDD.E
Type string
Read Only True
Added iLO 5 1.10

Oem.Hpe.Firmware.SystemProgrammableLogicDevice Oem.Hpe.Firmware.SystemProgrammableLogicDevice.Current Oem.Hpe.Firmware.SystemProgrammableLogicDevice.Current.VersionString Member of Chassis.v1_19_0.Chassis
Description The firmware version of the CPLD.
Type string
Read Only True
Added iLO 5 1.10

Oem.Hpe.IPv4Address

Member of Chassis.v1_19_0.Chassis
Description The IPv4 address of the chassis manager.
Type string
Read Only True

Oem.Hpe.Images

Oem.Hpe.Images.Front Oem.Hpe.Images.Front.extref Member of Chassis.v1_19_0.Chassis
Description The URI of an external resource.
Type string
Read Only True
Added iLO 5 1.10
Format uri-reference

Oem.Hpe.Images.Model Oem.Hpe.Images.Model.extref Member of Chassis.v1_19_0.Chassis
Description The URI of an external resource.
Type string
Read Only True
Added iLO 5 1.10
Format uri-reference

Oem.Hpe.Location

Oem.Hpe.Location.GeographicLocation Oem.Hpe.Location.GeographicLocation.RackName Member of Chassis.v1_19_0.Chassis
Description The name of the chassis enclosure.
Type string
Read Only True
Added iLO 5 1.10

Oem.Hpe.Location.LocationInRack Oem.Hpe.Location.LocationInRack.RackLdsPartNumber Member of Chassis.v1_19_0.Chassis
Description The chassis rack part number.
Type string
Read Only True
Added iLO 5 1.10

Oem.Hpe.Location.LocationInRack.RackLdsProductDescription Member of Chassis.v1_19_0.Chassis
Description The chassis rack product description.
Type string
Read Only True
Added iLO 5 1.10

Oem.Hpe.Location.LocationInRack.RackUHeight Member of Chassis.v1_19_0.Chassis
Description The chassis rack U height.
Type integer
Read Only True
Added iLO 5 1.10

Oem.Hpe.Location.LocationInRack.RackUUID Member of Chassis.v1_19_0.Chassis
Description The chassis rack UUID.
Type string
Read Only True
Added iLO 5 1.10

Oem.Hpe.Location.LocationInRack.TagVersion Member of Chassis.v1_19_0.Chassis
Description The chassis rack tag version.
Type integer
Read Only True
Added iLO 5 1.10

Oem.Hpe.Location.LocationInRack.ULocation Member of Chassis.v1_19_0.Chassis
Description The chassis rack U location.
Type string
Read Only True
Added iLO 5 1.10

Oem.Hpe.Location.LocationInRack.UPosition Member of Chassis.v1_19_0.Chassis
Description The chassis U position in the rack.
Type integer
Read Only True
Added iLO 5 1.10

Oem.Hpe.Location.LocationOfChassis Oem.Hpe.Location.LocationOfChassis.UUID Member of Chassis.v1_19_0.Chassis
Description The chassis UUID provided by SMBIOS.
Type string
Read Only True
Added iLO 5 1.10

Oem.Hpe.MCTPEnabledOnServer

Member of Chassis.v1_19_0.Chassis
Description Indicates if MCTP is enabled on the server or not.
Type boolean
Read Only True
Added iLO 5 1.20

Oem.Hpe.NodePowerWatts

Member of Chassis.v1_19_0.Chassis
Description The total power being consumed by this node.
Type integer
Read Only True

Oem.Hpe.OnboardAdministrator

Oem.Hpe.OnboardAdministrator.IPv4Address Member of Chassis.v1_19_0.Chassis
Description IPv4 address of the chassis.
Type string or null
Read Only True
Added iLO 5 1.20

Oem.Hpe.OnboardAdministrator.IPv6 Oem.Hpe.OnboardAdministrator.IPv6.DHCPv6Address (array) Member of Chassis.v1_19_0.Chassis DHCPv6Address is an array containing elements of:
Type string
Read Only True
Format ipv6

Oem.Hpe.OnboardAdministrator.IPv6.SLAACAddress (array) Member of Chassis.v1_19_0.Chassis SLAACAddress is an array containing elements of:
Type string
Read Only True
Format ipv6

Oem.Hpe.OnboardAdministrator.IPv6.StaticAddress (array) Member of Chassis.v1_19_0.Chassis StaticAddress is an array containing elements of:
Type string
Read Only True
Format ipv6

Oem.Hpe.OnboardAdministrator.MacAddress Member of Chassis.v1_19_0.Chassis
Description MAC address of the chassis.
Type string or null
Read Only True
Added iLO 5 1.20

Oem.Hpe.PcieMini2SlotRiser

Member of Chassis.v1_19_0.Chassis
Description PCIE mini 2 slot riser is a platform dependent value used to identify installation of this riser.
Type string
Read Only True

The following are the supported values:

Value Description
NotInstalled The PCIE mini 2 slot riser is not installed. The PCIE mini slot 3 and slot 4 do not exist in this Enclosure.
InstalledWithOtherFRU A non recognized riser option is installed with a valid EEPROM FRU. Contact Customer Support to secure a replacement.
InstalledWithBadFRU The PCIe mini 2 slot riser is installed with an invaild EEPROM FRU. Contact Customer Support to secure a replacement.
Installed The PCIE mini 2 slot riser is installed. The PCIE mini slot 3 and slot 4 exist in this Enclosure.

Oem.Hpe.PowerAlertMode

Oem.Hpe.PowerAlertMode.Activated Member of Chassis.v1_19_0.Chassis
Description The power alert mode activation state.
Type boolean
Read Only True
Added iLO 5 1.10

Oem.Hpe.PowerAlertMode.AlertPowerWatts Member of Chassis.v1_19_0.Chassis
Description The power consumption of the system when operating in alert mode.
Type integer
Read Only True
Added iLO 5 1.10

Oem.Hpe.PowerAlertMode.SpikeWatts Member of Chassis.v1_19_0.Chassis
Description Maximum additional power consumed when all CPUs are in Turbo Mode
Type integer
Read Only True

Oem.Hpe.RackName

Member of Chassis.v1_19_0.Chassis
Description The name of the rack that contains the enclosure.
Type string
Read Only True
Added iLO 5 1.40

Oem.Hpe.SmartStorageBattery (array)

Member of Chassis.v1_19_0.Chassis SmartStorageBattery is an array containing elements of:

SmartStorageBattery[{item}].BatteryWearLevelPercent Member of Chassis.v1_19_0.Chassis
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.
Type integer or null
Read Only True

SmartStorageBattery[{item}].ChargeLevelPercent Member of Chassis.v1_19_0.Chassis
Description State of charge of the battery.
Type integer or null
Read Only True

SmartStorageBattery[{item}].ErrorCode Member of Chassis.v1_19_0.Chassis
Description Error code of the battery.
Type string or null
Read Only True

The following are the supported values:

Value Description
Null A value is temporarily unavailable
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.

SmartStorageBattery[{item}].FailurePredicted Member of Chassis.v1_19_0.Chassis
Description Is this battery currently predicting a failure in the near future.
Type boolean or null
Read Only True

SmartStorageBattery[{item}].FirmwareVersion Member of Chassis.v1_19_0.Chassis
Description Firmware version of the battery.
Type string
Read Only True

SmartStorageBattery[{item}].Index Member of Chassis.v1_19_0.Chassis
Description Index of the battery.
Type integer
Read Only True

SmartStorageBattery[{item}].MaximumCapWatts Member of Chassis.v1_19_0.Chassis
Description Maximum capacity of the battery in watts.
Type integer
Read Only True

SmartStorageBattery[{item}].Model Member of Chassis.v1_19_0.Chassis
Description Model of the battery.
Type string
Read Only True

SmartStorageBattery[{item}].ProductName Member of Chassis.v1_19_0.Chassis
Description Product name of the battery.
Type string
Read Only True

SmartStorageBattery[{item}].RemainingChargeTimeSeconds Member of Chassis.v1_19_0.Chassis
Description Remaining charging time of the battery in seconds.
Type integer or null
Read Only True

SmartStorageBattery[{item}].SerialNumber Member of Chassis.v1_19_0.Chassis
Description Serial number of the battery.
Type string
Read Only True

SmartStorageBattery[{item}].SparePartNumber Member of Chassis.v1_19_0.Chassis
Description Spare part number of the battery.
Type string
Read Only True

SmartStorageBattery[{item}].Status Member of Chassis.v1_19_0.Chassis See the Redfish standard schema and specification for information on common Status object.

Oem.Hpe.SystemMaintenanceSwitches

Oem.Hpe.SystemMaintenanceSwitches.Sw1 Member of Chassis.v1_19_0.Chassis
Description Override iLO security.
Type string
Read Only True
Added iLO 5 1.10

The following are the supported values:

Value Description
On iLO Security Override Enabled.
Off No function (Normal).

Oem.Hpe.SystemMaintenanceSwitches.Sw10 Member of Chassis.v1_19_0.Chassis
Description Reserved.
Type string
Read Only True
Added iLO 5 1.10

The following are the supported values:

Value Description
On Switch is on.
Off Switch is off (Normal).

Oem.Hpe.SystemMaintenanceSwitches.Sw11 Member of Chassis.v1_19_0.Chassis
Description Reserved.
Type string
Read Only True
Added iLO 5 1.10

The following are the supported values:

Value Description
On Switch is on.
Off Switch is off (Normal).

Oem.Hpe.SystemMaintenanceSwitches.Sw12 Member of Chassis.v1_19_0.Chassis
Description Reserved.
Type string
Read Only True
Added iLO 5 1.10

The following are the supported values:

Value Description
On Switch is on.
Off Switch is off (Normal).

Oem.Hpe.SystemMaintenanceSwitches.Sw2 Member of Chassis.v1_19_0.Chassis
Description Reserved.
Type string
Read Only True
Added iLO 5 1.10

The following are the supported values:

Value Description
On Switch is on.
Off Switch is off (Normal).

Oem.Hpe.SystemMaintenanceSwitches.Sw3 Member of Chassis.v1_19_0.Chassis
Description Reserved.
Type string
Read Only True
Added iLO 5 1.10

The following are the supported values:

Value Description
On Switch is on.
Off Switch is off (Normal).

Oem.Hpe.SystemMaintenanceSwitches.Sw4 Member of Chassis.v1_19_0.Chassis
Description Reserved.
Type string
Read Only True
Added iLO 5 1.10

The following are the supported values:

Value Description
On Switch is on.
Off Switch is off (Normal).

Oem.Hpe.SystemMaintenanceSwitches.Sw5 Member of Chassis.v1_19_0.Chassis
Description BIOS/UEFI Password Disable.
Type string
Read Only True
Added iLO 5 1.10

The following are the supported values:

Value Description
On Power On Password disabled.
Off Power On Password enabled (Normal).

Oem.Hpe.SystemMaintenanceSwitches.Sw6 Member of Chassis.v1_19_0.Chassis
Description Reset Configuration.
Type string
Read Only True
Added iLO 5 1.10

The following are the supported values:

Value Description
On
Off

Oem.Hpe.SystemMaintenanceSwitches.Sw7 Member of Chassis.v1_19_0.Chassis
Description Reserved.
Type string
Read Only True
Added iLO 5 1.10

The following are the supported values:

Value Description
On Switch is on.
Off Switch is off (Default).

Oem.Hpe.SystemMaintenanceSwitches.Sw8 Member of Chassis.v1_19_0.Chassis
Description Reserved.
Type string
Read Only True
Added iLO 5 1.10

The following are the supported values:

Value Description
On Switch is on.
Off Switch is off (Default).

Oem.Hpe.SystemMaintenanceSwitches.Sw9 Member of Chassis.v1_19_0.Chassis
Description Reserved.
Type string
Read Only True
Added iLO 5 1.10

The following are the supported values:

Value Description
On Switch is on.
Off Switch is off (Default).

Oem.Hpe.TrayID

Member of Chassis.v1_19_0.Chassis
Description Tray ID is a platform dependent value used to identify what kind of server tray it is.
Type string
Read Only True

PCIeDevices

The link to the collection of PCIe devices located in this chassis. PCIeDevices is a link ("@odata.id": URI) to another resource.

PCIeSlots

The link to the PCIe slot properties for this chassis. PCIeSlots is a link ("@odata.id": URI) to another resource.

PartNumber

Member of Chassis.v1_19_0.Chassis
Description The chassis part number.
Type string or null
Read Only True
Added iLO 5 1.10

PhysicalSecurity

PhysicalSecurity.IntrusionSensor Member of Chassis.v1_19_0.Chassis
Description This indicates the known state of the physical security sensor, such as if it is hardware intrusion detected.
Type string or null
Read Only True
Added iLO 5 1.10

The following are the supported values:

Value Description
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.

PhysicalSecurity.IntrusionSensorReArm Member of Chassis.v1_19_0.Chassis
Description This indicates how the Normal state to be restored.
Type string or null
Read Only True
Added iLO 5 1.10

The following are the supported values:

Value Description
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.

Power

A reference to the thermal metrics (power supplies, power policies, sensors) for this chassis. Power is a link ("@odata.id": URI) to another resource.

PowerState

Member of Chassis.v1_19_0.Chassis
Description This is the current power state of the chassis.
Type string or null
Read Only True

The following are the supported values:

Value
Null
On
Off
Unknown
Reset

SKU

Member of Chassis.v1_19_0.Chassis
Description The chassis SKU.
Type string or null
Read Only True
Added iLO 5 1.10

SerialNumber

Member of Chassis.v1_19_0.Chassis
Description The chassis serial number.
Type string or null
Read Only True
Added iLO 5 1.10

Status

Member of Chassis.v1_19_0.Chassis See the Redfish standard schema and specification for information on common Status object.

Thermal

A reference to the thermal metrics (fans, cooling, sensors) for this chassis. Thermal is a link ("@odata.id": URI) to another resource.

Actions

HpeServerChassis.DisableMCTPOnServer Member of Chassis.v1_19_0.Chassis There are no parameters for this action.

HpeServerChassis.FactoryResetMCTP Member of Chassis.v1_19_0.Chassis There are no parameters for this action.

HpeServerChassis.ModifyEnclosureChassisFru Member of Chassis.v1_19_0.Chassis The action to modify field of enclosure chassis FRU.

Parameters:

PartNumber (string)

Part Number of the enclosure chassis.

SerialNumber (string)

Serial Number of the enclosure chassis.

ChassisCollection.ChassisCollection

@odata.type: "#ChassisCollection.ChassisCollection"

A Collection of Chassis resource instances.

Resource Instances

Uri HTTP Allow
/redfish/v1/chassis GET
Link Name Destination type
Members[] Chassis

Members (array)

Member of ChassisCollection.ChassisCollection Members is an array containing elements of:

Members[{item}].@odata.id Member of ChassisCollection.ChassisCollection
Type string
Read Only True
Format uri-reference

Members@odata.count

Member of ChassisCollection.ChassisCollection
Description The total number of collection members.
Type integer
Read Only True

ComputerSystem.v1_17_0.ComputerSystem

@odata.type: "#ComputerSystem.v1_17_0.ComputerSystem"

The ComputerSystem resource describes the compute node and its properties. A ComputerSystem represents a physical or virtual machine and the local resources, such as memory, CPU, and other devices that can be accessed from that machine.

Resource Instances

Uri HTTP Allow
/redfish/v1/systems/{item} GET POST PATCH
Link Name Destination type
Bios Bios
EthernetInterfaces Collection of EthernetInterface
Links/Chassis[] Chassis
Links/ManagedBy[] Manager
LogServices Collection of LogService
Memory Collection of Memory
NetworkInterfaces Collection of NetworkInterface
Oem/Hpe/Links/EthernetInterfaces Collection of EthernetInterface
Oem/Hpe/Links/NetworkAdapters Collection of HpeBaseNetworkAdapter
Oem/Hpe/Links/PCIDevices Collection of HpeServerPciDevice
Oem/Hpe/Links/PCISlots Collection of HpeServerPCISlot
Oem/Hpe/Links/SmartStorage HpeSmartStorage
Oem/Hpe/Links/USBDevices Collection of HpeUSBDevice
Oem/Hpe/Links/USBPorts Collection of HpeUSBPort
Oem/Hpe/SmartStorageConfig[] SmartStorageConfig
Processors Collection of Processor
SecureBoot SecureBoot
Storage Collection of Storage

AssetTag

Member of ComputerSystem.v1_17_0.ComputerSystem
Description A user-definable tag that is used to track this system for inventory or other client purposes.
Type string or null
Read Only False
Added iLO 5 1.10

Bios

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

BiosVersion

Member of ComputerSystem.v1_17_0.ComputerSystem
Description The version of the system BIOS or primary system firmware.
Type string or null
Read Only True
Added iLO 5 1.10

Boot

Boot.BootOptions A reference to the collection of the UEFI Boot Options associated with this Computer System. BootOptions is a link ("@odata.id": URI) to another resource.

Boot.BootOrder (array) Member of ComputerSystem.v1_17_0.ComputerSystem BootOrder is an array containing elements of:
Type string or null
Read Only True

Boot.BootSourceOverrideEnabled Member of ComputerSystem.v1_17_0.ComputerSystem
Description BootSourceOverrideTarget must be specified before BootSourceOverrideEnabled can be used.
Type string or null
Read Only False
Added iLO 5 1.10

The following are the supported values:

Value Description
Null A value is temporarily unavailable
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.

Boot.BootSourceOverrideMode Member of ComputerSystem.v1_17_0.ComputerSystem
Type string
Read Only False
Added iLO 5 1.10

The following are the supported values:

Value Description
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.

Boot.BootSourceOverrideTarget Member of ComputerSystem.v1_17_0.ComputerSystem
Description The current boot source to be used at next boot instead of the normal boot device, if BootSourceOverrideEnabled is true.
Type string or null
Read Only False
Added iLO 5 1.10

Boot.BootSourceOverrideTarget@Redfish.AllowableValues (array) Member of ComputerSystem.v1_17_0.ComputerSystem BootSourceOverrideTarget@Redfish.AllowableValues is an array containing elements of:
Description The current boot source to be used at next boot instead of the normal boot device, if BootSourceOverrideEnabled is not Disabled.
Type string or null
Read Only True

The following are the supported values:

Value Description
Null A value is temporarily unavailable
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

Boot.UefiTargetBootSourceOverride Member of ComputerSystem.v1_17_0.ComputerSystem
Description This property is the UEFI Device Path of the device to boot from when BootSourceOverrideTarget is UefiTarget.
Type string or null
Read Only False
Added iLO 5 1.10

Boot.UefiTargetBootSourceOverride@Redfish.AllowableValues (array) Member of ComputerSystem.v1_17_0.ComputerSystem UefiTargetBootSourceOverride@Redfish.AllowableValues is an array containing elements of:
Description An array of structured boot strings.
Type string or null
Read Only True

BootProgress

BootProgress.LastState Member of ComputerSystem.v1_17_0.ComputerSystem
Description SmartNIC device operating system status
Type string or null
Read Only False

The following are the supported values:

Value Description
OSBootStarted The operating system has started booting.
OSRunning The operating system is running.
OEM The operating system state is reported in the OemLastState property.

BootProgress.OemLastState Member of ComputerSystem.v1_17_0.ComputerSystem
Description SmartNIC device operating system oem status
Type string or null
Read Only False

The following are the supported values:

Value Description
OSServicesReady The operating system services are ready.
OSServicesOffline The operating system services are offline.
OSHalting The operating system has started halting.
OSHalted The operating system has performed a shutdown.

EthernetInterfaces

A reference to the collection of Ethernet interfaces associated with this system. EthernetInterfaces is a link ("@odata.id": URI) to another resource.

HostName

Member of ComputerSystem.v1_17_0.ComputerSystem
Description The DNS Host Name, without any domain information
Type string or null
Read Only False
Added iLO 5 1.10

HostingRole

Member of ComputerSystem.v1_17_0.ComputerSystem
Description The enumerations of HostingRoles specify different features that the hosting ComputerSystem supports.
Type string
Read Only True

The following are the supported values:

Value Description
ApplicationServer The system hosts functionality that supports general purpose applications.
StorageServer The system hosts functionality that supports the system acting as a storage server.
Switch The system hosts functionality that supports the system acting as a switch.
Appliance The system hosts functionality that supports the system acting as an appliance.
BareMetalServer The system hosts functionality that supports the system acting as a bare metal server.
VirtualMachineServer The system hosts functionality that supports the system acting as a virtual machine server.
ContainerServer The system hosts functionality that supports the system acting as a container server.

IndicatorLED

Member of ComputerSystem.v1_17_0.ComputerSystem
Description The state of the indicator LED.
Type string or null
Read Only False
Added iLO 5 1.10

The following are the supported values:

Value Description
Null A value is temporarily unavailable
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.

LocationIndicatorActive

Member of ComputerSystem.v1_17_0.ComputerSystem
Description An indicator allowing an operator to physically locate this resource.
Type boolean or null
Read Only False

LogServices

The LogService collection URI for this resource. LogServices is a link ("@odata.id": URI) to another resource.

Manufacturer

Member of ComputerSystem.v1_17_0.ComputerSystem
Description The manufacturer or OEM of this system.
Type string or null
Read Only True
Added iLO 5 1.10

Memory

The central memory in the system. Memory is a link ("@odata.id": URI) to another resource.

MemoryDomains

A reference to the collection of Memory Domains associated with this system. MemoryDomains is a link ("@odata.id": URI) to another resource.

MemorySummary

MemorySummary.Status Member of ComputerSystem.v1_17_0.ComputerSystem See the Redfish standard schema and specification for information on common Status object.

MemorySummary.TotalSystemMemoryGiB Member of ComputerSystem.v1_17_0.ComputerSystem
Description This is the total amount of memory in the system measured in GiB.
Type integer or null
Read Only True
Added iLO 5 1.10

MemorySummary.TotalSystemPersistentMemoryGiB Member of ComputerSystem.v1_17_0.ComputerSystem
Description The total configured, system-accessible persistent memory, measured in GiB.
Type number or null
Read Only True
Added iLO 5 1.40

Model

Member of ComputerSystem.v1_17_0.ComputerSystem
Description The model information that the manufacturer uses to refer to this system.
Type string or null
Read Only True
Added iLO 5 1.10

NetworkInterfaces

The collection of network interfaces partitioned to this system. NetworkInterfaces is a link ("@odata.id": URI) to another resource.

Oem.Hpe.AggregateHealthStatus

Oem.Hpe.AggregateHealthStatus.AgentlessManagementService Member of ComputerSystem.v1_17_0.ComputerSystem
Description This indicates if the Agentless Management Service is available or not.
Type string
Read Only True
Added iLO 5 1.10

The following are the supported values:

Value Description
Unavailable The Agentless Management Service is unavailable.
Ready The Agentless Management Service is Ready.

Oem.Hpe.AggregateHealthStatus.AggregateServerHealth Member of ComputerSystem.v1_17_0.ComputerSystem
Description This represents the overall health state
Type string or null
Read Only True

The following are the supported values:

Value Description
Null A value is temporarily unavailable
OK Normal
Warning A condition exists that requires attention
Critical A critical condition exists that requires immediate attention

Oem.Hpe.AggregateHealthStatus.BiosOrHardwareHealth Oem.Hpe.AggregateHealthStatus.BiosOrHardwareHealth.Status Member of ComputerSystem.v1_17_0.ComputerSystem See the Redfish standard schema and specification for information on common Status object.

Oem.Hpe.AggregateHealthStatus.FanRedundancy Member of ComputerSystem.v1_17_0.ComputerSystem
Description This indicates if the Fan is redundant or not.
Type string
Read Only True
Added iLO 5 1.10

The following are the supported values:

Value Description
Redundant The fans are Redundant.
NonRedundant The fans are not Redundant.
FailedRedundant The Redundant fan has failed.
Unknown The Redundant state is unknown.

Oem.Hpe.AggregateHealthStatus.Fans Oem.Hpe.AggregateHealthStatus.Fans.Status Member of ComputerSystem.v1_17_0.ComputerSystem See the Redfish standard schema and specification for information on common Status object.

Oem.Hpe.AggregateHealthStatus.LiquidCooling Oem.Hpe.AggregateHealthStatus.LiquidCooling.Status Member of ComputerSystem.v1_17_0.ComputerSystem See the Redfish standard schema and specification for information on common Status object.

Oem.Hpe.AggregateHealthStatus.LiquidCoolingRedundancy Member of ComputerSystem.v1_17_0.ComputerSystem
Description This indicates if the LiquidCooling Units are redundant or not.
Type string
Read Only True

The following are the supported values:

Value Description
Redundant The Liquid Cooling modules are Redundant.
NonRedundant The Liquid Cooling modules are not Redundant.
FailedRedundant The Redundant fan has failed.
Unknown The Redundant state is unknown.

Oem.Hpe.AggregateHealthStatus.Memory Oem.Hpe.AggregateHealthStatus.Memory.Status Member of ComputerSystem.v1_17_0.ComputerSystem See the Redfish standard schema and specification for information on common Status object.

Oem.Hpe.AggregateHealthStatus.Network Oem.Hpe.AggregateHealthStatus.Network.Status Member of ComputerSystem.v1_17_0.ComputerSystem See the Redfish standard schema and specification for information on common Status object.

Oem.Hpe.AggregateHealthStatus.PowerSupplies Oem.Hpe.AggregateHealthStatus.PowerSupplies.PowerSuppliesMismatch Member of ComputerSystem.v1_17_0.ComputerSystem
Description This indicates if the there is a mismatch in the power supplies.
Type boolean
Read Only True
Added iLO 5 1.10

Oem.Hpe.AggregateHealthStatus.PowerSupplies.Status Member of ComputerSystem.v1_17_0.ComputerSystem See the Redfish standard schema and specification for information on common Status object.

Oem.Hpe.AggregateHealthStatus.PowerSupplyRedundancy Member of ComputerSystem.v1_17_0.ComputerSystem
Description This indicates if the Power Supply is redundant or not.
Type string
Read Only True
Added iLO 5 1.10

The following are the supported values:

Value Description
Redundant The power supplies are Redundant.
NonRedundant The power supplies are not Redundant.
FailedRedundant The Redundant power supply has failed.
Unknown The Redundant state is unknown.

Oem.Hpe.AggregateHealthStatus.Processors Oem.Hpe.AggregateHealthStatus.Processors.Status Member of ComputerSystem.v1_17_0.ComputerSystem See the Redfish standard schema and specification for information on common Status object.

Oem.Hpe.AggregateHealthStatus.SmartStorageBattery Oem.Hpe.AggregateHealthStatus.SmartStorageBattery.Status Member of ComputerSystem.v1_17_0.ComputerSystem See the Redfish standard schema and specification for information on common Status object.

Oem.Hpe.AggregateHealthStatus.Storage Oem.Hpe.AggregateHealthStatus.Storage.Status Member of ComputerSystem.v1_17_0.ComputerSystem See the Redfish standard schema and specification for information on common Status object.

Oem.Hpe.AggregateHealthStatus.Temperatures Oem.Hpe.AggregateHealthStatus.Temperatures.Status Member of ComputerSystem.v1_17_0.ComputerSystem See the Redfish standard schema and specification for information on common Status object.

Oem.Hpe.AvailableSystemCapabilities (array)

Member of ComputerSystem.v1_17_0.ComputerSystem AvailableSystemCapabilities is an array containing elements of:
Description Indicates SmartNIC DPU supports OS-triggered DPC
Type string or null
Read Only True

The following are the supported values:

Value
OSTriggeredDPC

Oem.Hpe.Bios

Oem.Hpe.Bios.Backup Oem.Hpe.Bios.Backup.BuildNumber Member of ComputerSystem.v1_17_0.ComputerSystem
Description The build number of the firmware.
Type integer
Read Only True
Added iLO 5 1.10

Oem.Hpe.Bios.Backup.BuildNumberString Member of ComputerSystem.v1_17_0.ComputerSystem
Description The string version of the build number of the firmware.
Type string
Read Only True
Added iLO 5 1.10

Oem.Hpe.Bios.Backup.Date Member of ComputerSystem.v1_17_0.ComputerSystem
Description The build date of the firmware.
Type string
Read Only True
Added iLO 5 1.10

Oem.Hpe.Bios.Backup.DebugBuild Member of ComputerSystem.v1_17_0.ComputerSystem
Description True if the firmware is a debug build; False if it is not.
Type boolean
Read Only True
Added iLO 5 1.10

Oem.Hpe.Bios.Backup.Family Member of ComputerSystem.v1_17_0.ComputerSystem
Description The family of the firmware.
Type string
Read Only True
Added iLO 5 1.10

Oem.Hpe.Bios.Backup.MajorVersion Member of ComputerSystem.v1_17_0.ComputerSystem
Description The major version of the firmware.
Type integer
Read Only True
Added iLO 5 1.10

Oem.Hpe.Bios.Backup.MinorVersion Member of ComputerSystem.v1_17_0.ComputerSystem
Description The minor version of the firmware.
Type integer
Read Only True
Added iLO 5 1.10

Oem.Hpe.Bios.Backup.Time Member of ComputerSystem.v1_17_0.ComputerSystem
Description The build time of the firmware.
Type string
Read Only True
Added iLO 5 1.10

Oem.Hpe.Bios.Backup.VersionString Member of ComputerSystem.v1_17_0.ComputerSystem
Description The version string of the firmware. This value might be null if VersionString is unavailable.
Type string or null
Read Only True
Added iLO 5 1.10

Oem.Hpe.Bios.Bootblock Oem.Hpe.Bios.Bootblock.BuildNumber Member of ComputerSystem.v1_17_0.ComputerSystem
Description The build number of the firmware.
Type integer
Read Only True
Added iLO 5 1.10

Oem.Hpe.Bios.Bootblock.BuildNumberString Member of ComputerSystem.v1_17_0.ComputerSystem
Description The string version of the build number of the firmware.
Type string
Read Only True
Added iLO 5 1.10

Oem.Hpe.Bios.Bootblock.Date Member of ComputerSystem.v1_17_0.ComputerSystem
Description The build date of the firmware.
Type string
Read Only True
Added iLO 5 1.10

Oem.Hpe.Bios.Bootblock.DebugBuild Member of ComputerSystem.v1_17_0.ComputerSystem
Description True if the firmware is a debug build; False if it is not.
Type boolean
Read Only True
Added iLO 5 1.10

Oem.Hpe.Bios.Bootblock.Family Member of ComputerSystem.v1_17_0.ComputerSystem
Description The family of the firmware.
Type string
Read Only True
Added iLO 5 1.10

Oem.Hpe.Bios.Bootblock.MajorVersion Member of ComputerSystem.v1_17_0.ComputerSystem
Description The major version of the firmware.
Type integer
Read Only True
Added iLO 5 1.10

Oem.Hpe.Bios.Bootblock.MinorVersion Member of ComputerSystem.v1_17_0.ComputerSystem
Description The minor version of the firmware.
Type integer
Read Only True
Added iLO 5 1.10

Oem.Hpe.Bios.Bootblock.Time Member of ComputerSystem.v1_17_0.ComputerSystem
Description The build time of the firmware.
Type string
Read Only True
Added iLO 5 1.10

Oem.Hpe.Bios.Bootblock.VersionString Member of ComputerSystem.v1_17_0.ComputerSystem
Description The version string of the firmware. This value might be null if VersionString is unavailable.
Type string or null
Read Only True
Added iLO 5 1.10

Oem.Hpe.Bios.Current Oem.Hpe.Bios.Current.BuildNumber Member of ComputerSystem.v1_17_0.ComputerSystem
Description The build number of the firmware.
Type integer
Read Only True
Added iLO 5 1.10

Oem.Hpe.Bios.Current.BuildNumberString Member of ComputerSystem.v1_17_0.ComputerSystem
Description The string version of the build number of the firmware.
Type string
Read Only True
Added iLO 5 1.10

Oem.Hpe.Bios.Current.Date Member of ComputerSystem.v1_17_0.ComputerSystem
Description The build date of the firmware.
Type string
Read Only True
Added iLO 5 1.10

Oem.Hpe.Bios.Current.DebugBuild Member of ComputerSystem.v1_17_0.ComputerSystem
Description True if the firmware is a debug build; False if it is not.
Type boolean
Read Only True
Added iLO 5 1.10

Oem.Hpe.Bios.Current.Family Member of ComputerSystem.v1_17_0.ComputerSystem
Description The family of the firmware.
Type string
Read Only True
Added iLO 5 1.10

Oem.Hpe.Bios.Current.MajorVersion Member of ComputerSystem.v1_17_0.ComputerSystem
Description The major version of the firmware.
Type integer
Read Only True
Added iLO 5 1.10

Oem.Hpe.Bios.Current.MinorVersion Member of ComputerSystem.v1_17_0.ComputerSystem
Description The minor version of the firmware.
Type integer
Read Only True
Added iLO 5 1.10

Oem.Hpe.Bios.Current.Time Member of ComputerSystem.v1_17_0.ComputerSystem
Description The build time of the firmware.
Type string
Read Only True
Added iLO 5 1.10

Oem.Hpe.Bios.Current.VersionString Member of ComputerSystem.v1_17_0.ComputerSystem
Description The version string of the firmware. This value might be null if VersionString is unavailable.
Type string or null
Read Only True
Added iLO 5 1.10

Oem.Hpe.Bios.UefiClass Member of ComputerSystem.v1_17_0.ComputerSystem
Description The UEFI BIOS Class value defined in the UEFI specification.
Type integer
Read Only True
Added iLO 5 1.10

The following are the supported values:

Value
Null
1
2
3

Oem.Hpe.BootProgress

Oem.Hpe.BootProgress.OemResetReason Member of ComputerSystem.v1_17_0.ComputerSystem
Description The Smart NIC Device Operating system OEM reset reason .
Type string or null
Read Only False

The following are the supported values:

Value Description
Unknown unknown reason, cold start
OSNormal a normal reset by ESXio
BMCNormal reset by BMC
OSCrash a reset after a crash by ESXio
HWWatchdog a reset due to hardware watchdog
Thermal a reset due to thermal shutdown

Oem.Hpe.BootProgress.ResetReason Member of ComputerSystem.v1_17_0.ComputerSystem
Description The Smart NIC Device Operating system reset reason .
Type string or null
Read Only False

The following are the supported values:

Value Description
OEM oem value , SmartNIC DPU
Unknown unknown reason, cold start
OSNormal a normal reset by ESXio
BMCNormal reset by BMC
OSCrash a reset after a crash by ESXio
HWWatchdog a reset due to hardware watchdog
Thermal a reset due to thermal shutdown

Oem.Hpe.CriticalTempRemainOff

Member of ComputerSystem.v1_17_0.ComputerSystem
Description Indicates whether server should remain off after thermal shutdown is triggered.
Type boolean
Read Only False

Oem.Hpe.CurrentPowerOnTimeSeconds

Member of ComputerSystem.v1_17_0.ComputerSystem
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.
Type integer or null
Read Only True
Added iLO 5 1.15

Oem.Hpe.DeviceDiscoveryComplete

Oem.Hpe.DeviceDiscoveryComplete.AMSDeviceDiscovery Member of ComputerSystem.v1_17_0.ComputerSystem
Description This property indicates the current AMS Device Discovery Status.
Type string or null
Read Only True
Added iLO 5 1.10

The following are the supported values:

Value Description
Null A value is temporarily unavailable
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.

Oem.Hpe.DeviceDiscoveryComplete.DeviceDiscovery Member of ComputerSystem.v1_17_0.ComputerSystem
Description This property indicates the current device discovery status of devices that are not Smart Array or AMS related.
Type string or null
Read Only True
Added iLO 5 1.10

The following are the supported values:

Value Description
Null A value is temporarily unavailable
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.

Oem.Hpe.DeviceDiscoveryComplete.SmartArrayDiscovery Member of ComputerSystem.v1_17_0.ComputerSystem
Description This property indicates the current Smart Array Storage Device Discovery Status
Type string or null
Read Only True
Added iLO 5 1.10

The following are the supported values:

Value Description
Null A value is temporarily unavailable
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.

Oem.Hpe.ElapsedEraseTimeInMinutes

Member of ComputerSystem.v1_17_0.ComputerSystem
Description Reports the time elapsed since the erase started
Type integer
Read Only True
Added iLO 5 1.40

Oem.Hpe.EnabledSystemCapabilities (array)

Member of ComputerSystem.v1_17_0.ComputerSystem EnabledSystemCapabilities is an array containing elements of:
Description Indicates SmartNIC DPU supports OS-triggered DPC
Type string or null
Read Only True

The following are the supported values:

Value
OSTriggeredDPC

Oem.Hpe.EndOfPostDelaySeconds

Member of ComputerSystem.v1_17_0.ComputerSystem
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). If > 255 seconds is requested, the value is rounded up to the nearest minute.
Type integer or null
Read Only False
Added iLO 5 1.10

Oem.Hpe.EstimatedEraseTimeInMinutes

Member of ComputerSystem.v1_17_0.ComputerSystem
Description Reports the guestimate time (in minutes) for the overall erase process
Type integer
Read Only True
Added iLO 5 1.40

Oem.Hpe.HealthCntl

Member of ComputerSystem.v1_17_0.ComputerSystem
Description Set the Health of the system.
Type string or null
Read Only False

The following are the supported values:

Value
Null
OK
Caution
Critical
Release

Oem.Hpe.HostOS

Oem.Hpe.HostOS.OsName Member of ComputerSystem.v1_17_0.ComputerSystem
Description from cpqHoName if AMS is running
Type string
Read Only True
Added iLO 5 1.10

Oem.Hpe.HostOS.OsSysDescription Member of ComputerSystem.v1_17_0.ComputerSystem
Description from cpqHosysDesc if AMS is running
Type string
Read Only True
Added iLO 5 1.10

Oem.Hpe.HostOS.OsType Member of ComputerSystem.v1_17_0.ComputerSystem
Description from cpqHoOsType if AMS is running.
Type integer
Read Only True
Added iLO 5 1.10

Oem.Hpe.HostOS.OsVersion Member of ComputerSystem.v1_17_0.ComputerSystem
Description from cpqHoVersion if AMS is running
Type string
Read Only True
Added iLO 5 1.10

Oem.Hpe.IntegrationConfig

Oem.Hpe.IntegrationConfig.OsReadyTimeout Member of ComputerSystem.v1_17_0.ComputerSystem
Type integer
Read Only False

Oem.Hpe.IntelligentProvisioningAlwaysOn

Member of ComputerSystem.v1_17_0.ComputerSystem
Description Always on Intelligent Provisioning is available.
Type boolean
Read Only True
Added iLO 5 1.10

Oem.Hpe.IntelligentProvisioningIndex

Member of ComputerSystem.v1_17_0.ComputerSystem
Description Index in the Firmware Version Table for Intelligent Provisioning.
Type integer or null
Read Only True
Added iLO 5 1.10

Oem.Hpe.IntelligentProvisioningLocation

Member of ComputerSystem.v1_17_0.ComputerSystem
Description Location string of Intelligent Provisioning in Firmware Version Table.
Type string
Read Only True
Added iLO 5 1.10

Oem.Hpe.IntelligentProvisioningVersion

Member of ComputerSystem.v1_17_0.ComputerSystem
Description Intelligent Provisioning Version.
Type string
Read Only True
Added iLO 5 1.10

Oem.Hpe.IsColdBooting

Member of ComputerSystem.v1_17_0.ComputerSystem
Description Indicates if the system is cold booting.
Type boolean
Read Only True
Added iLO 5 1.30

Oem.Hpe.OperatingSystem

Oem.Hpe.OperatingSystem.Kernel Oem.Hpe.OperatingSystem.Kernel.Version Member of ComputerSystem.v1_17_0.ComputerSystem
Description SmartNIC device operating system kernel version
Type string or null
Read Only False

Oem.Hpe.PCAPartNumber

Member of ComputerSystem.v1_17_0.ComputerSystem
Description The PCA part number.
Type string or null
Read Only True
Added iLO 5 1.10

Oem.Hpe.PCASerialNumber

Member of ComputerSystem.v1_17_0.ComputerSystem
Description The PCA serial number.
Type string or null
Read Only True
Added iLO 5 1.10

Oem.Hpe.PostDiscoveryCompleteTimeStamp

Member of ComputerSystem.v1_17_0.ComputerSystem
Description Displays the last known POST Discovery Complete time
Type string or null
Read Only True
Added iLO 5 1.10
Format date-time

Oem.Hpe.PostDiscoveryMode

Member of ComputerSystem.v1_17_0.ComputerSystem
Description The manner in which the system will operate during the discovery section of POST.
Type string or null
Read Only False
Added iLO 5 1.10

The following are the supported values:

Value Description
Null A value is temporarily unavailable
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.

Oem.Hpe.PostMode

Member of ComputerSystem.v1_17_0.ComputerSystem
Description The manner in which the system will operate during and at completion of POST.
Type string or null
Read Only False
Added iLO 5 1.10

The following are the supported values:

Value Description
Null A value is temporarily unavailable
Normal Normal operations.
PostToShutdown Server boots until Discovery Completes, then shuts down.
PostToReboot Server boots until Discovery Completes, then reboots.

Oem.Hpe.PostState

Member of ComputerSystem.v1_17_0.ComputerSystem
Description The current state of system POST.
Type string or null
Read Only True
Added iLO 5 1.10

The following are the supported values:

Value Description
Null A value is temporarily unavailable
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.
InPostDiscoveryStart The server has started to discover devices.
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.

Oem.Hpe.PowerAllocationLimit

Member of ComputerSystem.v1_17_0.ComputerSystem
Description The total amount of power allocated to the system.
Type integer or null
Read Only True
Added iLO 5 1.10

Oem.Hpe.PowerAutoOn

Member of ComputerSystem.v1_17_0.ComputerSystem
Description Auto Power-On mode defines what occurs when the AC power is applied to the system.
Type string
Read Only False
Added iLO 5 1.10

The following are the supported values:

Value
RemainOff
PowerOn
Restore

Oem.Hpe.PowerOnDelay

Member of ComputerSystem.v1_17_0.ComputerSystem
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.
Type string or null
Read Only False
Added iLO 5 1.10

The following are the supported values:

Value
Null
Minimum
15Sec
30Sec
45Sec
60Sec
RandomUpTo120Sec

Oem.Hpe.PowerOnMinutes

Member of ComputerSystem.v1_17_0.ComputerSystem
Description The number of lifetime minutes that the server has been powered on.
Type integer or null
Read Only True
Added iLO 5 1.15

Oem.Hpe.PowerRegulatorMode

Member of ComputerSystem.v1_17_0.ComputerSystem
Description Power Regulator mode. Switching to and from OS Control mode requires a server reboot to take effect.
Type string
Read Only False
Added iLO 5 1.10

The following are the supported values:

Value
OSControl
Dynamic
Max
Min
Unknown

Oem.Hpe.PowerRegulatorModesSupported (array)

Member of ComputerSystem.v1_17_0.ComputerSystem PowerRegulatorModesSupported is an array containing elements of:
Type string
Read Only True

Oem.Hpe.ProcessorJitterControl

Oem.Hpe.ProcessorJitterControl.ConfiguredFrequencyLimitMHz Member of ComputerSystem.v1_17_0.ComputerSystem
Description Displays the last known user configured frequency limit of the processor in MHz.
Type integer
Read Only True
Added iLO 5 1.30

Oem.Hpe.ProcessorJitterControl.FrequencyLimitMHz Member of ComputerSystem.v1_17_0.ComputerSystem
Description Current frequency limit of the processor in MHz.
Type integer
Read Only False
Added iLO 5 1.15

Oem.Hpe.ProcessorJitterControl.Mode Member of ComputerSystem.v1_17_0.ComputerSystem
Description Provides various jitter control modes.
Type string
Read Only False
Added iLO 5 1.15

The following are the supported values:

Value
Auto
Disabled
Manual

Oem.Hpe.ProcessorJitterControl.ProcessorJitterControlOptimization Member of ComputerSystem.v1_17_0.ComputerSystem
Description Provides Jitter Control Optimizations.
Type string
Read Only False
Added iLO 5 1.30

The following are the supported values:

Value Description
OptimizedForThroughput
OptimizedForLatency
ZeroLatency

Oem.Hpe.SMBIOS

Oem.Hpe.SMBIOS.extref Member of ComputerSystem.v1_17_0.ComputerSystem
Description The URI of an external resource.
Type string
Read Only True
Added iLO 5 1.10
Format uri-reference

Oem.Hpe.ServerFQDN

Member of ComputerSystem.v1_17_0.ComputerSystem
Description The IP address or FQDN of the server. Host software like AMS is required to obtain this value from the OS.
Type string
Read Only False
Added iLO 5 1.20

Oem.Hpe.ServerIntelligentDiagnosticsModeEnabled

Member of ComputerSystem.v1_17_0.ComputerSystem
Description Indicates the current state of server Intelligent Diagnostics mode.
Type boolean
Read Only True

Oem.Hpe.ServerSafeModeEnabled

Member of ComputerSystem.v1_17_0.ComputerSystem
Description Indicates the current state of server Safe Mode.
Type boolean
Read Only True

Oem.Hpe.ServerSignature

Member of ComputerSystem.v1_17_0.ComputerSystem
Description The CRC32 of: All Device Signatures combined together, Server Slot Location in Enclosure, Enclosure UUID, and Manager Domain IP Address
Type integer or null
Read Only True
Added iLO 5 1.10

Oem.Hpe.ServerSignatureStatus

Member of ComputerSystem.v1_17_0.ComputerSystem
Description The current state of Server Signature.
Type string or null
Read Only True
Added iLO 5 1.10

The following are the supported values:

Value Description
Null A value is temporarily unavailable
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.

Oem.Hpe.SmartStorageConfig (array)

Member of ComputerSystem.v1_17_0.ComputerSystem SmartStorageConfig is an array containing elements of:

SmartStorageConfig[{item}].@odata.id Member of ComputerSystem.v1_17_0.ComputerSystem
Type string
Read Only True
Format uri-reference

Oem.Hpe.SystemROMAndiLOEraseComponentStatus

Oem.Hpe.SystemROMAndiLOEraseComponentStatus.BIOSSettingsEraseStatus Member of ComputerSystem.v1_17_0.ComputerSystem
Description Indicates the erase status of the individual components
Type string or null
Read Only True
Added iLO 5 1.40

The following are the supported values:

Value Description
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

Oem.Hpe.SystemROMAndiLOEraseComponentStatus.iLOSettingsEraseStatus Member of ComputerSystem.v1_17_0.ComputerSystem
Description Indicates the erase status of the individual components
Type string or null
Read Only True
Added iLO 5 1.40

The following are the supported values:

Value Description
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

Oem.Hpe.SystemROMAndiLOEraseStatus

Member of ComputerSystem.v1_17_0.ComputerSystem
Description Indicates the erase status of the individual components
Type string or null
Read Only True
Added iLO 5 1.40

The following are the supported values:

Value Description
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

Oem.Hpe.SystemUsage

Oem.Hpe.SystemUsage.AvgCPU0Freq Member of ComputerSystem.v1_17_0.ComputerSystem
Description Current CPU0 average frequency in MHz.
Type integer
Read Only True
Added iLO 5 1.40

Oem.Hpe.SystemUsage.AvgCPU1Freq Member of ComputerSystem.v1_17_0.ComputerSystem
Description Current CPU1 average frequency in MHz.
Type integer
Read Only True
Added iLO 5 1.40

Oem.Hpe.SystemUsage.AvgCPU2Freq Member of ComputerSystem.v1_17_0.ComputerSystem
Description Current CPU2 average frequency in MHz.
Type integer
Read Only True
Added iLO 5 1.40

Oem.Hpe.SystemUsage.AvgCPU3Freq Member of ComputerSystem.v1_17_0.ComputerSystem
Description Current CPU3 average frequency in MHz.
Type integer
Read Only True
Added iLO 5 1.40

Oem.Hpe.SystemUsage.CPU0Power Member of ComputerSystem.v1_17_0.ComputerSystem
Description Current power consumed by the system CPU0 in Watts.
Type integer
Read Only True
Added iLO 5 1.40

Oem.Hpe.SystemUsage.CPU1Power Member of ComputerSystem.v1_17_0.ComputerSystem
Description Current power consumed by the system CPU1 in Watts.
Type integer
Read Only True
Added iLO 5 1.40

Oem.Hpe.SystemUsage.CPU2Power Member of ComputerSystem.v1_17_0.ComputerSystem
Description Current power consumed by the system CPU2 in Watts.
Type integer
Read Only True
Added iLO 5 1.40

Oem.Hpe.SystemUsage.CPU3Power Member of ComputerSystem.v1_17_0.ComputerSystem
Description Current power consumed by the system CPU3 in Watts.
Type integer
Read Only True
Added iLO 5 1.40

Oem.Hpe.SystemUsage.CPUICUtil Member of ComputerSystem.v1_17_0.ComputerSystem
Description Current System CPU Interconnect utilization in percentage
Type integer
Read Only True
Added iLO 5 1.40

Oem.Hpe.SystemUsage.CPUUtil Member of ComputerSystem.v1_17_0.ComputerSystem
Description Current System CPU utilization in percentage
Type integer
Read Only True
Added iLO 5 1.40

Oem.Hpe.SystemUsage.IOBusUtil Member of ComputerSystem.v1_17_0.ComputerSystem
Description Current System I/O bus utilization in percentage
Type integer
Read Only True
Added iLO 5 1.40

Oem.Hpe.SystemUsage.JitterCount Member of ComputerSystem.v1_17_0.ComputerSystem
Description Current processor Jitter Count.
Type integer
Read Only True
Added iLO 5 1.40

Oem.Hpe.SystemUsage.MemoryBusUtil Member of ComputerSystem.v1_17_0.ComputerSystem
Description Current System memory bus utilization in percentage
Type integer
Read Only True
Added iLO 5 1.40

Oem.Hpe.UserDataEraseComponentStatus

Oem.Hpe.UserDataEraseComponentStatus.NVDIMMEraseStatus Member of ComputerSystem.v1_17_0.ComputerSystem
Description Indicates the erase status of the individual components
Type string or null
Read Only True
Added iLO 5 1.40

The following are the supported values:

Value Description
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

Oem.Hpe.UserDataEraseComponentStatus.NVMeDrivesEraseStatus Member of ComputerSystem.v1_17_0.ComputerSystem
Description Indicates the erase status of the individual components
Type string or null
Read Only True
Added iLO 5 1.40

The following are the supported values:

Value Description
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

Oem.Hpe.UserDataEraseComponentStatus.SATADrivesEraseStatus Member of ComputerSystem.v1_17_0.ComputerSystem
Description Indicates the erase status of the individual components
Type string or null
Read Only True
Added iLO 5 1.40

The following are the supported values:

Value Description
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

Oem.Hpe.UserDataEraseComponentStatus.SmartStorageEraseStatus Member of ComputerSystem.v1_17_0.ComputerSystem
Description Indicates the erase status of the individual components
Type string or null
Read Only True
Added iLO 5 1.40

The following are the supported values:

Value Description
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

Oem.Hpe.UserDataEraseComponentStatus.TPMEraseStatus Member of ComputerSystem.v1_17_0.ComputerSystem
Description Indicates the erase status of the individual components
Type string or null
Read Only True
Added iLO 5 1.40

The following are the supported values:

Value Description
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

Oem.Hpe.UserDataEraseStatus

Member of ComputerSystem.v1_17_0.ComputerSystem
Description Indicates the erase status of the individual components
Type string or null
Read Only True
Added iLO 5 1.40

The following are the supported values:

Value Description
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

Oem.Hpe.VirtualProfile

Member of ComputerSystem.v1_17_0.ComputerSystem
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.
Type string
Read Only True
Added iLO 5 1.10

The following are the supported values:

Value
Active
Busy
Inactive
Unknown

Oem.Hpe.VirtualUUID

Member of ComputerSystem.v1_17_0.ComputerSystem
Description Used in conjunction with the UUID (Logical) value.
Type string or null
Read Only True
Added iLO 5 1.10

PartNumber

Member of ComputerSystem.v1_17_0.ComputerSystem
Description The manufacturer’s system part number.
Type string or null
Read Only True
Added iLO 5 1.10

PowerState

Member of ComputerSystem.v1_17_0.ComputerSystem
Description This is the current power state of the system
Type string or null
Read Only True
Added iLO 5 1.10

The following are the supported values:

Value
Null
On
Off
Unknown
Reset
PoweringOn
PoweringOff

ProcessorSummary

ProcessorSummary.Count Member of ComputerSystem.v1_17_0.ComputerSystem
Description The number of processors in the system.
Type integer or null
Read Only True
Added iLO 5 1.10

ProcessorSummary.Model Member of ComputerSystem.v1_17_0.ComputerSystem
Description The processor model for the primary or majority of processors in this system.
Type string or null
Read Only True
Added iLO 5 1.10

ProcessorSummary.Status Member of ComputerSystem.v1_17_0.ComputerSystem See the Redfish standard schema and specification for information on common Status object.

Processors

The central processors in the system. Processors is a link ("@odata.id": URI) to another resource.

SKU

Member of ComputerSystem.v1_17_0.ComputerSystem
Description SKU for this system.
Type string or null
Read Only True
Added iLO 5 1.10

SecureBoot

A reference to the UEFI SecureBoot resource associated with this system. SecureBoot is a link ("@odata.id": URI) to another resource.

SerialNumber

Member of ComputerSystem.v1_17_0.ComputerSystem
Description The system serial number.
Type string or null
Read Only True
Added iLO 5 1.10

Status

Member of ComputerSystem.v1_17_0.ComputerSystem See the Redfish standard schema and specification for information on common Status object.

Storage

A reference to the collection of storage devices associated with this system. Storage is a link ("@odata.id": URI) to another resource.

SystemType

Member of ComputerSystem.v1_17_0.ComputerSystem
Description The type of computer system that this resource represents.
Type string
Read Only True
Added iLO 5 1.10

The following are the supported values:

Value Description
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
DPU SmartNIC DPU System

TrustedModules (array)

Member of ComputerSystem.v1_17_0.ComputerSystem TrustedModules is an array containing elements of:

TrustedModules[{item}].FirmwareVersion Member of ComputerSystem.v1_17_0.ComputerSystem
Description The firmware version of this Trusted Module
Type string or null
Read Only True
Added iLO 5 1.10

TrustedModules[{item}].InterfaceType Member of ComputerSystem.v1_17_0.ComputerSystem
Description This property indicates the interface type of the Trusted Module.
Type string or null
Read Only True
Added iLO 5 1.10

The following are the supported values:

Value Description
TM1_0 Trusted Module ™ 1.0
TPM1_2 Trusted Platform Module (TPM) 1.2
TPM2_0 Trusted Platform Module (TPM) 2.0

TrustedModules[{item}].Oem.Hpe.VendorName Member of ComputerSystem.v1_17_0.ComputerSystem
Description Trusted module vendor name.
Type string
Read Only True
Added iLO 5 1.20

The following are the supported values:

Value
None
STMicro
Intel
Nationz
Unknown

TrustedModules[{item}].Status Member of ComputerSystem.v1_17_0.ComputerSystem See the Redfish standard schema and specification for information on common Status object.

UUID

Member of ComputerSystem.v1_17_0.ComputerSystem
Description The universal unique identifier for this system.
Type string or null
Read Only True
Added iLO 5 1.10

Actions

ComputerSystem.Reset Member of ComputerSystem.v1_17_0.ComputerSystem This action resets the system.

Parameters:

ResetType (string)

The type of reset.

Value Description
ForceOff Turn off the unit immediately (non-graceful shutdown).
ForceOn Turn on the unit immediately.
ForceRestart Shut down immediately and non-gracefully and restart the system.
GracefulRestart Shut down gracefully and restart the system.
GracefulShutdown Shut down gracefully and power off.
Nmi Generate a diagnostic interrupt, which is usually an NMI on x86 systems, to stop normal operations, complete diagnostic actions, and, typically, halt the system.
On Turn on the unit.
PowerCycle Power cycle the unit.
PushPowerButton Simulate the pressing of the physical power button on this unit.

target (string)

Link to invoke action

title (string)

Friendly action name

ComputerSystem.SetSimpleUpdateStatus Member of ComputerSystem.v1_17_0.ComputerSystem

Parameters:

Message (string)

Message to be displayed

PercentComplete (integer)

Percentage of task complete

TaskState (string)

TaskState identifies the type of Action to be performed.

Value Description
New
Starting
Running
Suspended
Interrupted
Pending
Stopping
Completed
Killed
Exception
Service

TaskStatus (string)

Current status of the ongoing task

Value Description
Ok
Warning
Critical

HpeComputerSystemExt.PowerButton Member of ComputerSystem.v1_17_0.ComputerSystem

Parameters:

PushType (string)

PushType identifies the type of Action to be performed.

Value Description
Press
PressAndHold

HpeComputerSystemExt.RestoreManufacturingDefaults Member of ComputerSystem.v1_17_0.ComputerSystem There are no parameters for this action.

HpeComputerSystemExt.RestoreSystemDefaults Member of ComputerSystem.v1_17_0.ComputerSystem There are no parameters for this action.

HpeComputerSystemExt.SecureSystemErase Member of ComputerSystem.v1_17_0.ComputerSystem

Parameters:

SystemROMAndiLOErase (boolean)

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.

UserDataErase (boolean)

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.

HpeComputerSystemExt.ServerIntelligentDiagnosticsMode Member of ComputerSystem.v1_17_0.ComputerSystem There are no parameters for this action.

HpeComputerSystemExt.ServerSafeMode Member of ComputerSystem.v1_17_0.ComputerSystem There are no parameters for this action.

HpeComputerSystemExt.ServerSigRecompute Member of ComputerSystem.v1_17_0.ComputerSystem There are no parameters for this action.

HpeComputerSystemExt.SystemReset Member of ComputerSystem.v1_17_0.ComputerSystem

Parameters:

ResetType (string)

ResetType identifies the type of Action to be performed.

Value Description
ColdBoot
AuxCycle

ComputerSystemCollection.ComputerSystemCollection

@odata.type: "#ComputerSystemCollection.ComputerSystemCollection"

A Collection of ComputerSystem resource instances.

Resource Instances

Uri HTTP Allow
/redfish/v1/systems GET
Link Name Destination type
Members[] ComputerSystem

Members (array)

Member of ComputerSystemCollection.ComputerSystemCollection Members is an array containing elements of:

Members[{item}].@odata.id Member of ComputerSystemCollection.ComputerSystemCollection
Type string
Read Only True
Format uri-reference

Members@odata.count

Member of ComputerSystemCollection.ComputerSystemCollection
Description The total number of collection members.
Type integer
Read Only True

Drive.v1_14_0.Drive

@odata.type: "#Drive.v1_14_0.Drive"

The Drive resource describes a single physical disk drive for a system, including links to associated Volumes.

Resource Instances

Uri HTTP Allow
/redfish/v1/systems/{item}/storage/{item}/drives/{item} GET POST PATCH

BlockSizeBytes

Member of Drive.v1_14_0.Drive
Description The size of the smallest addressible unit (Block) of this drive in bytes
Type integer or null
Read Only True
Added iLO 5 1.10

CapableSpeedGbs

Member of Drive.v1_14_0.Drive
Description The speed which this drive can communicate to a storage controller in ideal conditions in Gigabits per second
Type number or null
Read Only True
Added iLO 5 1.10

CapacityBytes

Member of Drive.v1_14_0.Drive
Description The size in bytes of this Drive
Type integer or null
Read Only True
Added iLO 5 1.10

EncryptionAbility

Member of Drive.v1_14_0.Drive
Type string
Read Only True

The following are the supported values:

Value Description
None The drive is not capable of self encryption
SelfEncryptingDrive The drive is capable of self encryption per the Trusted Computing Group’s Self Encrypting Drive Standard
Other The drive is capable of self encryption through some other means

EncryptionStatus

Member of Drive.v1_14_0.Drive
Type string
Read Only True

The following are the supported values:

Value Description
Unencrypted
Unlocked The drive is currently encrypted but the data is accessible to the user unencrypted.
Locked The drive is currently encrypted and the data is not accessible to the user, however the system has the ability to unlock the drive automatically.
Foreign The drive is currently encrypted, the data is not accessible to the user, and the system requires user intervention to expose the data.

FailurePredicted

Member of Drive.v1_14_0.Drive
Description Is this drive currently predicting a failure in the near future
Type boolean or null
Read Only True
Added iLO 5 1.10

HotspareType

Member of Drive.v1_14_0.Drive
Type string
Read Only True

The following are the supported values:

Value Description
None The drive is not currently a hotspare
Global The drive is currently serving as a hotspare for all other drives in the storage system.
Chassis The drive is currently serving as a hotspare for all other drives in the chassis.
Dedicated The drive is currently serving as a hotspare for a user defined set of drives.

Identifiers (array)

Member of Drive.v1_14_0.Drive Identifiers is an array containing elements of:

Identifiers[{item}].DurableName Member of Drive.v1_14_0.Drive
Description The world-wide, persistent name of the resource.
Type string or null
Read Only True

Identifiers[{item}].DurableNameFormat Member of Drive.v1_14_0.Drive
Description The format of the durable name property.
Type string or null
Read Only True

The following are the supported values:

Value Description
NAA The Name Address Authority (NAA) format.
iQN The iSCSI Qualified Name (iQN).
FC_WWN The Fibre Channel (FC) World Wide Name (WWN).
UUID The Universally Unique Identifier (UUID).
EUI The IEEE-defined 64-bit Extended Unique Identifier (EUI).
NQN The NVMe Qualified Name (NQN).
NGUID The Namespace Globally Unique Identifier (NGUID).

IndicatorLED

Member of Drive.v1_14_0.Drive
Description The state of the indicator LED.
Type string or null
Read Only False

The following are the supported values:

Value Description
Null A value is temporarily unavailable
Lit The Indicator LED is lit.
Blinking The indicator LED is blinking.
Off The Indicator LED is off.

Location (array)

Member of Drive.v1_14_0.Drive Location is an array containing elements of:

Location[{item}].Info Member of Drive.v1_14_0.Drive
Description This indicates the location of the resource.
Type string or null
Read Only True
Added iLO 5 1.10

Location[{item}].InfoFormat Member of Drive.v1_14_0.Drive
Description This represents the format of the Info property.
Type string or null
Read Only True
Added iLO 5 1.10

The following are the supported values:

Value Description
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).

LocationIndicatorActive

Member of Drive.v1_14_0.Drive
Description An indicator allowing an operator to physically locate this resource.
Type boolean or null
Read Only False

Manufacturer

Member of Drive.v1_14_0.Drive
Description This is the manufacturer of this drive.
Type string or null
Read Only True
Added iLO 5 1.10

MediaType

Member of Drive.v1_14_0.Drive
Description The type of media contained in this drive.
Type string or null
Read Only True
Added iLO 5 1.10

The following are the supported values:

Value Description
HDD The drive media type is traditional magnetic platters
SSD The drive media type is solid state or flash memory

Model

Member of Drive.v1_14_0.Drive
Description This is the model number for the drive.
Type string or null
Read Only True
Added iLO 5 1.10

NegotiatedSpeedGbs

Member of Drive.v1_14_0.Drive
Description The speed which this drive is currently communicating to the storage controller in Gigabits per second
Type number or null
Read Only True
Added iLO 5 1.10

Oem.Hpe.CriticalWarning

Member of Drive.v1_14_0.Drive
Description Failure information reported by the drive.
Type string
Read Only True
Added iLO 5 1.20

The following are the supported values:

Value Description
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

Oem.Hpe.CurrentTemperatureCelsius

Member of Drive.v1_14_0.Drive
Description The current temperature of the drive
Type integer
Read Only True
Added iLO 5 1.20

Oem.Hpe.DriveStatus

Oem.Hpe.DriveStatus.Health Member of Drive.v1_14_0.Drive
Description This represents the health state of this resource in the absence of its dependent resources.
Type string or null
Read Only True
Added iLO 5 1.20

The following are the supported values:

Value Description
Null A value is temporarily unavailable
OK Normal
Warning A condition exists that requires attention
Critical A critical condition exists that requires immediate attention

Oem.Hpe.DriveStatus.HealthRollup Member of Drive.v1_14_0.Drive
Description This represents the overall health state from the view of this resource.
Type string or null
Read Only True
Added iLO 5 1.20

The following are the supported values:

Value Description
Null A value is temporarily unavailable
OK Normal
Warning A condition exists that requires attention
Critical A critical condition exists that requires immediate attention

Oem.Hpe.DriveStatus.State Member of Drive.v1_14_0.Drive
Description This indicates the known state of the resource, such as if it is enabled.
Type string or null
Read Only True
Added iLO 5 1.20

The following are the supported values:

Value Description
Null A value is temporarily unavailable
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.

Oem.Hpe.FaultLED

Member of Drive.v1_14_0.Drive
Description The Drive Fault LED that is used to indicate a fault in the drive. The user can manipulate this LED.
Type string
Read Only False

The following are the supported values:

Value Description
Null A value is temporarily unavailable
Unknown The state of the Fault LED cannot be determined.
Lit The Fault LED is on.
Blinking The Fault LED is blinking.
Off The Fault LED is off.

Oem.Hpe.HealthUpdated

Member of Drive.v1_14_0.Drive
Description Describes how drive health related data (FailurePredicted, PredictedMediaLifeLeftPercent, Status, DriveStatus, CriticalWarning, WearStatus) are updated.
Type string
Read Only True
Added iLO 5 1.10

The following are the supported values:

Value Description
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.

Oem.Hpe.NVMeId

Member of Drive.v1_14_0.Drive
Description NVMe Identifier: ModelName, SerialNumber, PCI-Vendor-ID.
Type string
Read Only True
Added iLO 5 1.10

Oem.Hpe.PowerOnHours

Member of Drive.v1_14_0.Drive
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.
Type integer or null
Read Only True
Added iLO 5 1.20

Oem.Hpe.TemperatureStatus

Oem.Hpe.TemperatureStatus.Health Member of Drive.v1_14_0.Drive
Description This represents the health state of this resource in the absence of its dependent resources.
Type string or null
Read Only True
Added iLO 5 1.20

The following are the supported values:

Value Description
Null A value is temporarily unavailable
OK Normal
Warning A condition exists that requires attention
Critical A critical condition exists that requires immediate attention

Oem.Hpe.TemperatureStatus.HealthRollup Member of Drive.v1_14_0.Drive
Description This represents the overall health state from the view of this resource.
Type string or null
Read Only True
Added iLO 5 1.20

The following are the supported values:

Value Description
Null A value is temporarily unavailable
OK Normal
Warning A condition exists that requires attention
Critical A critical condition exists that requires immediate attention

Oem.Hpe.TemperatureStatus.State Member of Drive.v1_14_0.Drive
Description This indicates the known state of the resource, such as if it is enabled.
Type string or null
Read Only True
Added iLO 5 1.20

The following are the supported values:

Value Description
Null A value is temporarily unavailable
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.

Oem.Hpe.WearStatus

Member of Drive.v1_14_0.Drive
Description The wear status of the drive, an estimation of remaining life span.
Type string
Read Only True
Added iLO 5 1.20

The following are the supported values:

Value Description
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.

Operations

Operations.AssociatedTask Operations.AssociatedTask.EndTime Member of Drive.v1_14_0.Drive
Description The date-time stamp that the task was last completed.
Type string
Read Only True
Format date-time

Operations.AssociatedTask.Messages (array) Member of Drive.v1_14_0.Drive Messages is an array containing elements of:

Messages[{item}].Message Member of Drive.v1_14_0.Drive
Description This is the human readable message, if provided.
Type string or null
Read Only True

Messages[{item}].MessageArgs (array) Member of Drive.v1_14_0.Drive MessageArgs is an array containing elements of:
Type string
Read Only True

Messages[{item}].MessageId Member of Drive.v1_14_0.Drive
Description This is the key for this message which can be used to look up the message in a message registry.
Type string
Read Only True

Messages[{item}].RelatedProperties (array) Member of Drive.v1_14_0.Drive RelatedProperties is an array containing elements of:
Type string
Read Only True

Messages[{item}].Resolution Member of Drive.v1_14_0.Drive
Description Used to provide suggestions on how to resolve the situation that caused the error.
Type string or null
Read Only True

Messages[{item}].Severity Member of Drive.v1_14_0.Drive
Description This is the severity of the event.
Type string
Read Only True

The following are the supported values:

Value Description
OK Normal
Warning A condition exists that requires attention
Critical A critical condition exists that requires immediate attention

Operations.AssociatedTask.Payload Operations.AssociatedTask.Payload.HttpHeaders (array) Member of Drive.v1_14_0.Drive HttpHeaders is an array containing elements of:
Type string
Read Only True

Operations.AssociatedTask.Payload.HttpOperation Member of Drive.v1_14_0.Drive
Description The HTTP operation to perform to execute this Task.
Type string
Read Only True

Operations.AssociatedTask.Payload.JsonBody Member of Drive.v1_14_0.Drive
Description This property contains the JSON payload to use in the execution of this Task.
Type string
Read Only True

Operations.AssociatedTask.Payload.TargetUri Member of Drive.v1_14_0.Drive
Description The URI of the target for this task.
Type string
Read Only True
Format uri-reference

Operations.AssociatedTask.StartTime Member of Drive.v1_14_0.Drive
Description The date-time stamp that the task was last started.
Type string
Read Only True
Format date-time

Operations.AssociatedTask.TaskMonitor Member of Drive.v1_14_0.Drive
Description The URI of the Task Monitor for this task.
Type string or null
Read Only True
Format uri-reference

Operations.AssociatedTask.TaskState Member of Drive.v1_14_0.Drive
Description The state of the task.
Type string
Read Only True

The following are the supported values:

Value Description
New A new task.
Starting Task is starting.
Running Task is running normally.
Suspended Task has been suspended.
Interrupted Task has been interrupted.
Pending Task is pending and has not started.
Stopping Task is in the process of stopping.
Completed Task has completed.
Killed Task was terminated.
Exception Task has stopped due to an exception condition.
Service Task is running as a service.

Operations.AssociatedTask.TaskStatus Member of Drive.v1_14_0.Drive
Description This is the completion status of the task.
Type string
Read Only True

The following are the supported values:

Value Description
OK Normal.
Warning A condition exists that requires attention.
Critical A critical condition exists that requires immediate attention.

Operations.OperationName Member of Drive.v1_14_0.Drive
Description The name of the operation.
Type string or null
Read Only True

Operations.PercentageComplete Member of Drive.v1_14_0.Drive
Description The percentage of the operation that has been completed.
Type integer or null
Read Only True

PartNumber

Member of Drive.v1_14_0.Drive
Description The part number for this drive.
Type string or null
Read Only True
Added iLO 5 1.10

PhysicalLocation

PhysicalLocation.PartLocation PhysicalLocation.PartLocation.LocationOrdinalValue Member of Drive.v1_14_0.Drive
Description The number that represents the location of the part. If LocationType is slot and this unit is in slot 2, the LocationOrdinalValue is 2.
Type integer or null
Read Only True

PhysicalLocation.PartLocation.LocationType Member of Drive.v1_14_0.Drive
Description The location types for PartLocation.
Type string or null
Read Only True

The following are the supported values:

Value Description
Null A value is temporarily unavailable
Slot The slot as the type of location.
Bay The bay as the type of location.
Connector The connector as the type of location.
Socket The socket as the type of location.

PhysicalLocation.PartLocation.Orientation Member of Drive.v1_14_0.Drive
Description The orientation for the ordering of the part location ordinal value.
Type string or null
Read Only True

The following are the supported values:

Value Description
Null A value is temporarily unavailable
FrontToBack The ordering for LocationOrdinalValue is front to back.
BackToFront The ordering for the LocationOrdinalValue is back to front.
TopToBottom The ordering for the LocationOrdinalValue is top to bottom.
BottomToTop The ordering for LocationOrdinalValue is bottom to top.
LeftToRight The ordering for the LocationOrdinalValue is left to right.
RightToLeft The ordering for the LocationOrdinalValue is right to left.

PhysicalLocation.PartLocation.Reference Member of Drive.v1_14_0.Drive
Description The reference area for the location of the part.
Type string or null
Read Only True

The following are the supported values:

Value Description
Null A value is temporarily unavailable
Top The part is in the top of the unit.
Bottom The part is in the bottom of the unit.
Front The part is in the front of the unit.
Rear The part is in the rear of the unit.
Left The part is on the left side of of the unit.
Right The part is on the right side of the unit.
Middle The part is in the middle of the unit.

PhysicalLocation.PartLocation.ServiceLabel Member of Drive.v1_14_0.Drive
Description The label of the part location, such as a silk-screened name or a printed label.
Type string or null
Read Only True

PhysicalLocation.Placement PhysicalLocation.Placement.AdditionalInfo Member of Drive.v1_14_0.Drive
Description Area designation or other additional info.
Type string or null
Read Only False

PhysicalLocation.Placement.Rack Member of Drive.v1_14_0.Drive
Description The name of a rack location within a row.
Type string or null
Read Only False

PhysicalLocation.Placement.RackOffset Member of Drive.v1_14_0.Drive
Description The vertical location of the item, in terms of RackOffsetUnits.
Type integer or null
Read Only False

PhysicalLocation.Placement.RackOffsetUnits Member of Drive.v1_14_0.Drive
Description The type of rack unit in use.
Type string or null
Read Only False

The following are the supported values:

Value Description
Null A value is temporarily unavailable
OpenU A rack unit that is equal to 48 mm (1.89 in).
EIA_310 A rack unit that is equal to 1.75 in (44.45 mm).

PhysicalLocation.Placement.Row Member of Drive.v1_14_0.Drive
Description The name of the row.
Type string or null
Read Only False

PredictedMediaLifeLeftPercent

Member of Drive.v1_14_0.Drive
Description The percentage of reads and writes that are predicted to still be available for the media
Type integer or null
Read Only True
Added iLO 5 1.10

Protocol

Member of Drive.v1_14_0.Drive
Description The protocol this drive is using to communicate to the storage controller
Type string or null
Read Only True
Added iLO 5 1.10

The following are the supported values:

Value Description
SAS Serial Attached SCSI.
NVMe Non-Volatile Memory Express
SATA Serial AT Attachment
USB Universal Serial Bus

Revision

Member of Drive.v1_14_0.Drive
Description The revision of this Drive
Type string or null
Read Only True
Added iLO 5 1.10

RotationSpeedRPM

Member of Drive.v1_14_0.Drive
Description The rotation speed of this Drive in Revolutions per Minute (RPM)
Type number or null
Read Only True
Added iLO 5 1.10

SerialNumber

Member of Drive.v1_14_0.Drive
Description Serial Number of the drive.
Type string or null
Read Only True
Added iLO 5 1.10

Status

Member of Drive.v1_14_0.Drive See the Redfish standard schema and specification for information on common Status object.

StatusIndicator

Member of Drive.v1_14_0.Drive
Type string
Read Only True

The following are the supported values:

Value Description
OK The drive is OK.
Fail The drive has failed.
Rebuild The drive is being rebuilt.
PredictiveFailureAnalysis The drive is still working but predicted to fail soon.
Hotspare The drive is marked to be automatically rebuilt and used as a replacement for a failed drive.
InACriticalArray The array that this drive is a part of is degraded.
InAFailedArray The array that this drive is a part of is failed.

WriteCacheEnabled

Member of Drive.v1_14_0.Drive
Description An indication of whether the drive write cache is enabled.
Type boolean or null
Read Only False

Actions

Drive.Reset Member of Drive.v1_14_0.Drive

Parameters:

ResetValue (string)

Reset Drive

Value Description
ForceOff Turn off the unit immediately (non-graceful shutdown).
ForceOn Turn on the unit immediately.
PowerCycle Power cycle the unit.

target (string)

Link to invoke action

EthernetInterface.v1_4_1.EthernetInterface

@odata.type: "#EthernetInterface.v1_4_1.EthernetInterface"

The EthernetInterface resource describes a single, logical ethernet interface or network interface controller (NIC).

Resource Instances

Uri HTTP Allow
/redfish/v1/managers/{item}/ethernetinterfaces/{item} GET PATCH
/redfish/v1/systems/{item}/ethernetinterfaces/{item} GET POST PATCH

AutoNeg

Member of EthernetInterface.v1_4_1.EthernetInterface
Description This indicates if the speed and duplex are automatically negotiated and configured on this interface.
Type boolean or null
Read Only False
Added iLO 5 1.10

DHCPv4

DHCPv4.DHCPEnabled Member of EthernetInterface.v1_4_1.EthernetInterface
Description Determines whether DHCPv4 is enabled on this interface.
Type boolean or null
Read Only False
Added iLO 5 1.40

DHCPv4.UseDNSServers Member of EthernetInterface.v1_4_1.EthernetInterface
Description Determines whether to use DHCPv4-supplied DNS servers.
Type boolean or null
Read Only False
Added iLO 5 1.40

DHCPv4.UseDomainName Member of EthernetInterface.v1_4_1.EthernetInterface
Description Determines whether to use a DHCPv4-supplied domain name.
Type boolean or null
Read Only False
Added iLO 5 1.40

DHCPv4.UseGateway Member of EthernetInterface.v1_4_1.EthernetInterface
Description Determines whether to use a DHCPv4-supplied gateway.
Type boolean or null
Read Only False
Added iLO 5 1.40

DHCPv4.UseNTPServers Member of EthernetInterface.v1_4_1.EthernetInterface
Description Determines whether to use DHCPv4-supplied NTP servers.
Type boolean or null
Read Only False
Added iLO 5 1.40

DHCPv4.UseStaticRoutes Member of EthernetInterface.v1_4_1.EthernetInterface
Description Determines whether to use DHCPv4-supplied static routes.
Type boolean or null
Read Only False
Added iLO 5 1.40

DHCPv6

DHCPv6.OperatingMode Member of EthernetInterface.v1_4_1.EthernetInterface
Description Determines the DHCPv6 operating mode for this interface.
Type string or null
Read Only False
Added iLO 5 1.40

The following are the supported values:

Value Description
Null A value is temporarily unavailable
Stateful DHCPv6 stateful mode.
Stateless DHCPv6 stateless mode.
Disabled DHCPv6 is disabled.

DHCPv6.UseDNSServers Member of EthernetInterface.v1_4_1.EthernetInterface
Description When enabled, DNS server addresses supplied through DHCPv6 stateless mode will be used.
Type boolean or null
Read Only False
Added iLO 5 1.40

DHCPv6.UseDomainName Member of EthernetInterface.v1_4_1.EthernetInterface
Description When enabled, the domain name supplied through DHCPv6 stateless mode will be used.
Type boolean or null
Read Only False
Added iLO 5 1.40

DHCPv6.UseNTPServers Member of EthernetInterface.v1_4_1.EthernetInterface
Description When enabled, NTP server addresses supplied through DHCPv6 stateless mode will be used.
Type boolean or null
Read Only False
Added iLO 5 1.40

DHCPv6.UseRapidCommit Member of EthernetInterface.v1_4_1.EthernetInterface
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.
Type boolean or null
Read Only False
Added iLO 5 1.40

FQDN

Member of EthernetInterface.v1_4_1.EthernetInterface
Description This is the complete, fully qualified domain name obtained by DNS for this interface.
Type string or null
Read Only False
Added iLO 5 1.10

FullDuplex

Member of EthernetInterface.v1_4_1.EthernetInterface
Description This indicates if the interface is in Full Duplex mode or not.
Type boolean or null
Read Only False
Added iLO 5 1.10

HostName

Member of EthernetInterface.v1_4_1.EthernetInterface
Description The DNS Host Name, without any domain information.
Type string or null
Read Only False
Added iLO 5 1.10

IPv4Addresses (array)

Member of EthernetInterface.v1_4_1.EthernetInterface IPv4Addresses is an array containing elements of:

IPv4Addresses[{item}].Address Member of EthernetInterface.v1_4_1.EthernetInterface
Description This is the IPv4 Address.
Type string or null
Read Only False
Added iLO 5 1.10

IPv4Addresses[{item}].AddressOrigin Member of EthernetInterface.v1_4_1.EthernetInterface
Description This indicates how the address was determined.
Type string or null
Read Only True
Added iLO 5 1.10

The following are the supported values:

Value Description
Null A value is temporarily unavailable
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).

IPv4Addresses[{item}].Gateway Member of EthernetInterface.v1_4_1.EthernetInterface
Description This is the IPv4 gateway for this address.
Type string or null
Read Only False
Added iLO 5 1.10

IPv4Addresses[{item}].SubnetMask Member of EthernetInterface.v1_4_1.EthernetInterface
Description This is the IPv4 Subnet mask.
Type string
Read Only False
Added iLO 5 1.10

IPv4StaticAddresses (array)

Member of EthernetInterface.v1_4_1.EthernetInterface IPv4StaticAddresses is an array containing elements of:

IPv4StaticAddresses[{item}].Address Member of EthernetInterface.v1_4_1.EthernetInterface
Description This is the IPv4 Address.
Type string or null
Read Only False
Added iLO 5 1.40

IPv4StaticAddresses[{item}].AddressOrigin Member of EthernetInterface.v1_4_1.EthernetInterface
Description This indicates how the address was determined.
Type string or null
Read Only True
Added iLO 5 1.40

The following are the supported values:

Value Description
Null A value is temporarily unavailable
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).

IPv4StaticAddresses[{item}].Gateway Member of EthernetInterface.v1_4_1.EthernetInterface
Description This is the IPv4 gateway for this address.
Type string or null
Read Only False
Added iLO 5 1.40

IPv4StaticAddresses[{item}].SubnetMask Member of EthernetInterface.v1_4_1.EthernetInterface
Description This is the IPv4 Subnet mask.
Type string
Read Only False
Added iLO 5 1.40

IPv6AddressPolicyTable (array)

Member of EthernetInterface.v1_4_1.EthernetInterface IPv6AddressPolicyTable is an array containing elements of:

IPv6AddressPolicyTable[{item}].Label Member of EthernetInterface.v1_4_1.EthernetInterface
Description The IPv6 Label (as defined in RFC 6724 section 2.1).
Type integer or null
Read Only False
Added iLO 5 1.10

IPv6AddressPolicyTable[{item}].Precedence Member of EthernetInterface.v1_4_1.EthernetInterface
Description The IPv6 Precedence (as defined in RFC 6724 section 2.1.
Type integer or null
Read Only False
Added iLO 5 1.10

IPv6AddressPolicyTable[{item}].Prefix Member of EthernetInterface.v1_4_1.EthernetInterface
Description The IPv6 Address Prefix (as defined in RFC 6724 section 2.1).
Type string or null
Read Only False
Added iLO 5 1.10

IPv6Addresses (array)

Member of EthernetInterface.v1_4_1.EthernetInterface IPv6Addresses is an array containing elements of:

IPv6Addresses[{item}].Address Member of EthernetInterface.v1_4_1.EthernetInterface
Description This is the IPv6 Address.
Type string or null
Read Only False
Added iLO 5 1.10

IPv6Addresses[{item}].AddressOrigin Member of EthernetInterface.v1_4_1.EthernetInterface
Description This indicates how the address was determined.
Type string or null
Read Only True
Added iLO 5 1.10

The following are the supported values:

Value Description
Null A value is temporarily unavailable
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.

IPv6Addresses[{item}].AddressState Member of EthernetInterface.v1_4_1.EthernetInterface
Description The current state of this address as defined in RFC 4862.
Type string or null
Read Only True
Added iLO 5 1.10

The following are the supported values:

Value Description
Null A value is temporarily unavailable
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.

IPv6Addresses[{item}].PrefixLength Member of EthernetInterface.v1_4_1.EthernetInterface
Description This is the IPv6 Address Prefix Length.
Type integer or null
Read Only True
Added iLO 5 1.10

IPv6DefaultGateway

Member of EthernetInterface.v1_4_1.EthernetInterface
Description This is the IPv6 default gateway address that is currently in use on this interface.
Type string or null
Read Only True
Added iLO 5 1.10

IPv6StaticAddresses (array)

Member of EthernetInterface.v1_4_1.EthernetInterface IPv6StaticAddresses is an array containing elements of:

IPv6StaticAddresses[{item}].Address Member of EthernetInterface.v1_4_1.EthernetInterface
Description A valid IPv6 address.
Type string or null
Read Only False
Added iLO 5 1.10

IPv6StaticAddresses[{item}].PrefixLength Member of EthernetInterface.v1_4_1.EthernetInterface
Description The Prefix Length of this IPv6 address.
Type integer or null
Read Only False
Added iLO 5 1.10

IPv6StaticDefaultGateways (array)

Member of EthernetInterface.v1_4_1.EthernetInterface IPv6StaticDefaultGateways is an array containing elements of:

IPv6StaticDefaultGateways[{item}].Address Member of EthernetInterface.v1_4_1.EthernetInterface
Description A valid IPv6 address.
Type string or null
Read Only False
Added iLO 5 1.40

IPv6StaticDefaultGateways[{item}].PrefixLength Member of EthernetInterface.v1_4_1.EthernetInterface
Description The Prefix Length of this IPv6 address.
Type integer or null
Read Only False
Added iLO 5 1.40

InterfaceEnabled

Member of EthernetInterface.v1_4_1.EthernetInterface
Description This indicates whether this interface is enabled.
Type boolean or null
Read Only False
Added iLO 5 1.40

LinkStatus

Member of EthernetInterface.v1_4_1.EthernetInterface
Description The link status of this interface (port).
Type string or null
Read Only True
Added iLO 5 1.20

The following are the supported values:

Value Description
Null A value is temporarily unavailable
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.

MACAddress

Member of EthernetInterface.v1_4_1.EthernetInterface
Description This is the currently configured MAC address of the (logical port) interface.
Type string
Read Only False
Added iLO 5 1.10

MTUSize

Member of EthernetInterface.v1_4_1.EthernetInterface
Description This is the currently configured Maximum Transmission Unit (MTU) in bytes on this interface.
Type integer or null
Read Only False
Added iLO 5 1.40

MaxIPv6StaticAddresses

Member of EthernetInterface.v1_4_1.EthernetInterface
Description This indicates the maximum number of Static IPv6 addresses that can be configured on this interface.
Type integer or null
Read Only True
Added iLO 5 1.10

NameServers (array)

Member of EthernetInterface.v1_4_1.EthernetInterface NameServers is an array containing elements of:
Type string
Read Only True

Oem.Hpe.ConfigurationSettings

Member of EthernetInterface.v1_4_1.EthernetInterface
Description The state of the currently displayed configuration settings.
Type string
Read Only True
Added iLO 5 1.10

The following are the supported values:

Value Description
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.

Oem.Hpe.DHCPv4

Oem.Hpe.DHCPv4.ClientId Member of EthernetInterface.v1_4_1.EthernetInterface
Description The client ID to override the default used in iLO.
Type string or null
Read Only False
Added iLO 5 1.40

Oem.Hpe.DHCPv4.ClientIdType Member of EthernetInterface.v1_4_1.EthernetInterface
Description The type of client id in use or to be selected.
Type string
Read Only False
Added iLO 5 1.40

The following are the supported values:

Value Description
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.

Oem.Hpe.DHCPv4.Enabled Member of EthernetInterface.v1_4_1.EthernetInterface
Description Deprecated, replaced by DMTF standard property DHCPv4.DHCPEnabled, and will be removed in a future release. Determines whether DHCPv4 is enabled.
Type boolean
Read Only False
Added iLO 5 1.10

Oem.Hpe.DHCPv4.UseDNSServers Member of EthernetInterface.v1_4_1.EthernetInterface
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.
Type boolean
Read Only False
Added iLO 5 1.10

Oem.Hpe.DHCPv4.UseDomainName Member of EthernetInterface.v1_4_1.EthernetInterface
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.
Type boolean
Read Only False
Added iLO 5 1.10

Oem.Hpe.DHCPv4.UseGateway Member of EthernetInterface.v1_4_1.EthernetInterface
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.
Type boolean
Read Only False
Added iLO 5 1.10

Oem.Hpe.DHCPv4.UseNTPServers Member of EthernetInterface.v1_4_1.EthernetInterface
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.
Type boolean
Read Only False
Added iLO 5 1.10

Oem.Hpe.DHCPv4.UseStaticRoutes Member of EthernetInterface.v1_4_1.EthernetInterface
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.
Type boolean
Read Only False
Added iLO 5 1.10

Oem.Hpe.DHCPv4.UseWINSServers Member of EthernetInterface.v1_4_1.EthernetInterface
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.
Type boolean
Read Only False
Added iLO 5 1.10

Oem.Hpe.DHCPv6

Oem.Hpe.DHCPv6.StatefulModeEnabled Member of EthernetInterface.v1_4_1.EthernetInterface
Description Deprecated, replaced by DMTF standard property DHCPv6Configuration.OperatingMode, and will be removed in a future release.Determines whether DHCPv6 Stateful mode is enabled.
Type boolean
Read Only False
Added iLO 5 1.10

Oem.Hpe.DHCPv6.StatelessModeEnabled Member of EthernetInterface.v1_4_1.EthernetInterface
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.
Type boolean
Read Only False
Added iLO 5 1.10

Oem.Hpe.DHCPv6.UseDNSServers Member of EthernetInterface.v1_4_1.EthernetInterface
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.
Type boolean
Read Only False
Added iLO 5 1.10

Oem.Hpe.DHCPv6.UseDomainName Member of EthernetInterface.v1_4_1.EthernetInterface
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.
Type boolean
Read Only False
Added iLO 5 1.10

Oem.Hpe.DHCPv6.UseNTPServers Member of EthernetInterface.v1_4_1.EthernetInterface
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.
Type boolean
Read Only False
Added iLO 5 1.10

Oem.Hpe.DHCPv6.UseRapidCommit Member of EthernetInterface.v1_4_1.EthernetInterface
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.
Type boolean
Read Only False
Added iLO 5 1.10

Oem.Hpe.DomainName

Member of EthernetInterface.v1_4_1.EthernetInterface
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.
Type string
Read Only False
Added iLO 5 1.10

Oem.Hpe.HostName

Member of EthernetInterface.v1_4_1.EthernetInterface
Description Deprecated, replaced by DMTF standard property HostName, and will be removed in a future release. The management processor host name.
Type string
Read Only False
Added iLO 5 1.10
Format hostname

Oem.Hpe.IPv4

Oem.Hpe.IPv4.DDNSRegistration Member of EthernetInterface.v1_4_1.EthernetInterface
Description Determines whether DDNS registration is enabled.
Type boolean
Read Only False
Added iLO 5 1.10

Oem.Hpe.IPv4.DNSServers (array) Member of EthernetInterface.v1_4_1.EthernetInterface DNSServers is an array containing elements of:
Type string
Read Only True
Format ipv4

Oem.Hpe.IPv4.StaticRoutes (array) Member of EthernetInterface.v1_4_1.EthernetInterface StaticRoutes is an array containing elements of:

StaticRoutes[{item}].Destination Member of EthernetInterface.v1_4_1.EthernetInterface
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.
Type string
Read Only False
Format ipv4

StaticRoutes[{item}].Gateway Member of EthernetInterface.v1_4_1.EthernetInterface
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.
Type string
Read Only False
Format ipv4

StaticRoutes[{item}].SubnetMask Member of EthernetInterface.v1_4_1.EthernetInterface
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.
Type string
Read Only False
Format ipv4

Oem.Hpe.IPv4.WINSRegistration Member of EthernetInterface.v1_4_1.EthernetInterface
Description Determines whether WINS registration is enabled.
Type boolean
Read Only False
Added iLO 5 1.10

Oem.Hpe.IPv4.WINSServers (array) Member of EthernetInterface.v1_4_1.EthernetInterface WINSServers is an array containing elements of:
Type string
Read Only True
Format ipv4

Oem.Hpe.IPv6

Oem.Hpe.IPv6.DDNSRegistration Member of EthernetInterface.v1_4_1.EthernetInterface
Description Determines whether IPv6 DDNS registration is enabled.
Type boolean
Read Only False
Added iLO 5 1.10

Oem.Hpe.IPv6.DNSServers (array) Member of EthernetInterface.v1_4_1.EthernetInterface DNSServers is an array containing elements of:
Type string
Read Only True
Format ipv6

Oem.Hpe.IPv6.SLAACEnabled Member of EthernetInterface.v1_4_1.EthernetInterface
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.
Type boolean
Read Only False
Added iLO 5 1.10

Oem.Hpe.IPv6.StaticDefaultGateway Member of EthernetInterface.v1_4_1.EthernetInterface
Description Deprecated, replaced by DMTF standard property IPv6StaticDefaultGateways[].Address, and will be removed in a future release. The IPv6 static default gateway entry.
Type string
Read Only False
Added iLO 5 1.10
Format ipv6

Oem.Hpe.IPv6.StaticRoutes (array) Member of EthernetInterface.v1_4_1.EthernetInterface StaticRoutes is an array containing elements of:

StaticRoutes[{item}].Destination Member of EthernetInterface.v1_4_1.EthernetInterface
Description The IPv6 static route destination address.
Type string
Read Only False
Format ipv6

StaticRoutes[{item}].Gateway Member of EthernetInterface.v1_4_1.EthernetInterface
Description The IPv6 static route gateway.
Type string
Read Only False
Format ipv6

StaticRoutes[{item}].PrefixLength Member of EthernetInterface.v1_4_1.EthernetInterface
Description The prefix length of the IPv6 static route destination address.
Type integer or null
Read Only False

StaticRoutes[{item}].Status Member of EthernetInterface.v1_4_1.EthernetInterface See the Redfish standard schema and specification for information on common Status object.

Oem.Hpe.InterfaceType

Member of EthernetInterface.v1_4_1.EthernetInterface
Description Describes the network interface type.
Type string
Read Only True
Added iLO 5 1.10

The following are the supported values:

Value
Dedicated
Shared
HostInterface

Oem.Hpe.NICEnabled

Member of EthernetInterface.v1_4_1.EthernetInterface
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.
Type boolean
Read Only False
Added iLO 5 1.10

Oem.Hpe.NICSupportsIPv6

Member of EthernetInterface.v1_4_1.EthernetInterface
Description Indicates whether or not this NIC can support the IPv6 protocol.
Type boolean
Read Only True
Added iLO 5 1.10

Oem.Hpe.PingGatewayOnStartup

Member of EthernetInterface.v1_4_1.EthernetInterface
Description Determines whether to ping the IPv4 gateway on startup.
Type boolean
Read Only False
Added iLO 5 1.10

Oem.Hpe.SharedNetworkPortOptions

Oem.Hpe.SharedNetworkPortOptions.NIC Member of EthernetInterface.v1_4_1.EthernetInterface
Description Selects the system NIC that is to be shared with this management processor.
Type string
Read Only False
Added iLO 5 1.10

The following are the supported values:

Value Description
LOM The LOM NIC is configured to be shared.
FlexibleLOM The FlexibleLOM NIC is configured to be shared.
FlexibleLOM/OCP The FlexibleLOM/OCP is configured to be shared.

Oem.Hpe.SharedNetworkPortOptions.Port Member of EthernetInterface.v1_4_1.EthernetInterface
Description The network adapter port number that is used for sharing. This feature is only applicable on systems and network adapters that support it.
Type integer
Read Only False
Added iLO 5 1.10

Oem.Hpe.SupportsFlexibleLOM

Member of EthernetInterface.v1_4_1.EthernetInterface
Description Indicates whether this system supports FlexibleLOM. Only applies to Shared Network Port.
Type boolean
Read Only True
Added iLO 5 1.10

Oem.Hpe.SupportsLOM

Member of EthernetInterface.v1_4_1.EthernetInterface
Description Indicates whether this system supports LOM. Only applies to Shared Network Port.
Type boolean
Read Only True
Added iLO 5 1.10

PermanentMACAddress

Member of EthernetInterface.v1_4_1.EthernetInterface
Description This is the permanent MAC address assigned to this interface (port).
Type string
Read Only True
Added iLO 5 1.10

SpeedMbps

Member of EthernetInterface.v1_4_1.EthernetInterface
Description This is the current speed in Mbps of this interface.
Type integer or null
Read Only False

StatelessAddressAutoConfig

StatelessAddressAutoConfig.IPv4AutoConfigEnabled Member of EthernetInterface.v1_4_1.EthernetInterface
Description Indicates whether IPv4 SLAAC is enabled for this interface.
Type boolean or null
Read Only False
Added iLO 5 1.40

StatelessAddressAutoConfig.IPv6AutoConfigEnabled Member of EthernetInterface.v1_4_1.EthernetInterface
Description Indicates whether IPv6 SLAAC is enabled for this interface.
Type boolean or null
Read Only False
Added iLO 5 1.40

StaticNameServers (array)

Member of EthernetInterface.v1_4_1.EthernetInterface StaticNameServers is an array containing elements of:
Type string
Read Only True

Status

Member of EthernetInterface.v1_4_1.EthernetInterface See the Redfish standard schema and specification for information on common Status object.

UefiDevicePath

Member of EthernetInterface.v1_4_1.EthernetInterface
Description The UEFI device path for this interface.
Type string or null
Read Only True
Added iLO 5 1.10

VLAN

VLAN.VLANEnable Member of EthernetInterface.v1_4_1.EthernetInterface
Description This indicates if this VLAN is enabled.
Type boolean or null
Read Only False
Added iLO 5 1.10

VLAN.VLANId Member of EthernetInterface.v1_4_1.EthernetInterface
Description This indicates the VLAN identifier for this VLAN.
Type integer or null
Read Only False
Added iLO 5 1.10

VLANs

This is a reference to a collection of VLANs and is only used if the interface supports more than one VLANs. VLANs is a link ("@odata.id": URI) to another resource.

EthernetInterfaceCollection.EthernetInterfaceCollection

@odata.type: "#EthernetInterfaceCollection.EthernetInterfaceCollection"

A Collection of EthernetInterface resource instances.

Resource Instances

Uri HTTP Allow
/redfish/v1/managers/{item}/ethernetinterfaces GET
/redfish/v1/systems/{item}/ethernetinterfaces GET
Link Name Destination type
Members[] EthernetInterface

Members (array)

Member of EthernetInterfaceCollection.EthernetInterfaceCollection Members is an array containing elements of:

Members[{item}].@odata.id Member of EthernetInterfaceCollection.EthernetInterfaceCollection
Type string
Read Only True
Format uri-reference

Members@odata.count

Member of EthernetInterfaceCollection.EthernetInterfaceCollection
Description The total number of collection members.
Type integer
Read Only True

EventDestination.v1_4_5.EventDestination

@odata.type: "#EventDestination.v1_4_5.EventDestination"

The EventDestination resource describes the target of an event subscription, including the types of events subscribed and context to provide to the target in the Event payload.

Resource Instances

Uri HTTP Allow
/redfish/v1/eventservice/subscriptions/{item} GET PATCH DELETE

Context

Member of EventDestination.v1_4_5.EventDestination
Description A client-supplied string that is stored with the listener destination subscription.
Type string
Read Only False
Added iLO 5 1.10

Destination

Member of EventDestination.v1_4_5.EventDestination
Description The URI of the destination listener service.
Type string
Read Only False
Added iLO 5 1.10
Format uri-reference

EventTypes (array)

Member of EventDestination.v1_4_5.EventDestination EventTypes is an array containing elements of:
Type string
Read Only True

The following are the supported values:

Value
StatusChange
ResourceUpdated
ResourceAdded
ResourceRemoved
Alert

HttpHeaders (array)

Member of EventDestination.v1_4_5.EventDestination HttpHeaders is an array containing elements of:

Oem.Hpe.DeliveryRetryAttempts

Member of EventDestination.v1_4_5.EventDestination
Description This is the number of attempts an event posting is retried before the subscription is terminated.
Type integer
Read Only False
Added iLO 5 1.10

Oem.Hpe.DeliveryRetryIntervalInSeconds

Member of EventDestination.v1_4_5.EventDestination
Description This represents the number of seconds between retry attempts for sending any given Event
Type integer
Read Only False
Added iLO 5 1.10

Oem.Hpe.MutualAuthenticationEnabled

Member of EventDestination.v1_4_5.EventDestination
Description This represents if the subscriber and iLO need to perform mutual authentication when an event is sent.
Type boolean
Read Only False
Added iLO 5 1.17

Oem.Hpe.RequestedMaxEventsToQueue

Member of EventDestination.v1_4_5.EventDestination
Description This represents the number of events the service should queue.
Type integer
Read Only False
Added iLO 5 1.10

Oem.Hpe.RetireOldEventInMinutes

Member of EventDestination.v1_4_5.EventDestination
Description This represents the number of minutes until an event is expired.
Type integer
Read Only False
Added iLO 5 1.10

Protocol

Member of EventDestination.v1_4_5.EventDestination
Description The protocol type of the event connection.
Type string
Read Only True
Added iLO 5 1.10

The following are the supported values:

Value
Redfish

SubscriptionType

Member of EventDestination.v1_4_5.EventDestination
Description The subscription type for events.
Type string or null
Read Only True

The following are the supported values:

Value
RedfishEvent

EventDestinationCollection.EventDestinationCollection

@odata.type: "#EventDestinationCollection.EventDestinationCollection"

A Collection of EventDestination resource instances.

Resource Instances

Uri HTTP Allow
/redfish/v1/eventservice/subscriptions GET POST
Link Name Destination type
Members[] EventDestination

Members (array)

Member of EventDestinationCollection.EventDestinationCollection Members is an array containing elements of:

Members[{item}].@odata.id Member of EventDestinationCollection.EventDestinationCollection
Type string
Read Only True
Format uri-reference

Members@odata.count

Member of EventDestinationCollection.EventDestinationCollection
Description The total number of collection members.
Type integer
Read Only True

EventService.v1_2_7.EventService

@odata.type: "#EventService.v1_2_7.EventService"

The EventService resource describes the Event Service. It represents the properties for the service itself and has links to the actual list of subscriptions.

Resource Instances

Uri HTTP Allow
/redfish/v1/eventservice GET POST
Link Name Destination type
Oem/Hpe/CACertificates Collection of HpeCertificate
Subscriptions Collection of EventDestination

DeliveryRetryAttempts

Member of EventService.v1_2_7.EventService
Description This is the number of attempts an event posting is retried before the subscription is terminated.
Type integer
Read Only False
Added iLO 5 1.10

DeliveryRetryIntervalSeconds

Member of EventService.v1_2_7.EventService
Description This represents the number of seconds between retry attempts for sending any given Event
Type integer
Read Only False
Added iLO 5 1.10

EventTypesForSubscription (array)

Member of EventService.v1_2_7.EventService EventTypesForSubscription is an array containing elements of:
Type string
Read Only True

The following are the supported values:

Value Description
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

Oem.Hpe.CACertificates

The value of this property shall be a reference to a Collection of HpeCertificate resources. CACertificates is a link ("@odata.id": URI) to another resource.

Oem.Hpe.RequestedMaxEventsToQueueDefault

Member of EventService.v1_2_7.EventService
Description This represents the default number of events the service should queue.
Type integer
Read Only True
Added iLO 5 1.10

Oem.Hpe.RetireOldEventInMinutesDefault

Member of EventService.v1_2_7.EventService
Description This represents the default number of minutes until an event is expired.
Type integer
Read Only True
Added iLO 5 1.10

Oem.Hpe.TTLCountDefault

Member of EventService.v1_2_7.EventService
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.
Type integer
Read Only True
Added iLO 5 1.10

Oem.Hpe.TTLUnitsDefault

Member of EventService.v1_2_7.EventService
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.
Type string
Read Only True
Added iLO 5 1.10

The following are the supported values:

Value Description
seconds Time to Live (TTL) in Seconds
minutes Time to Live (TTL) in Minutes
days Time to Live (TTL) in Days

ServiceEnabled

Member of EventService.v1_2_7.EventService
Description This indicates whether this service is enabled.
Type boolean or null
Read Only True
Added iLO 5 1.40

Status

Member of EventService.v1_2_7.EventService See the Redfish standard schema and specification for information on common Status object.

Subscriptions

This is a reference to a collection of ListenerDestination resources. Subscriptions is a link ("@odata.id": URI) to another resource.

Actions

EventService.SubmitTestEvent Member of EventService.v1_2_7.EventService

Parameters:

EventId (string)

EventTimestamp (string)

EventType (string)

Value Description
StatusChange
ResourceUpdated
ResourceAdded
ResourceRemoved
Alert

Message (string)

MessageArgs (array)

MessageId (string)

OriginOfCondition (string)

Severity (string)

Value Description
OK
Warning
Critical

HpeEventService.ImportCACertificate Member of EventService.v1_2_7.EventService Imports a Trusted CA Certificate

Parameters:

Certificate (string)

Contains PEM formatted X509 certificate or PKCS7 certificate chain (Base64 encoded).

HostInterface.v1_1_1.HostInterface

@odata.type: "#HostInterface.v1_1_1.HostInterface"

The HostInterface resource describes a Redfish Host Interface, which is a method of accessing the Redfish API from the host computer system.

Resource Instances

Uri HTTP Allow
/redfish/v1/managers/{item}/hostinterfaces/{item} GET PATCH

AuthenticationModes (array)

Member of HostInterface.v1_1_1.HostInterface AuthenticationModes is an array containing elements of:

AuthenticationModes[{item}].AuthenticationMode Member of HostInterface.v1_1_1.HostInterface
Type string
Read Only False
Added iLO 5 1.40

The following are the supported values:

Value Description
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.

ExternallyAccessible

Member of HostInterface.v1_1_1.HostInterface
Description This indicates whether this interface is accessible by external entities.
Type boolean or null
Read Only True
Added iLO 5 1.40

FirmwareAuthEnabled

Member of HostInterface.v1_1_1.HostInterface
Description This indicates whether this firmware authentication is enabled for this interface.
Type boolean or null
Read Only False
Added iLO 5 1.40

FirmwareAuthRoleId

Member of HostInterface.v1_1_1.HostInterface
Description This property contains the Role for firmware authentication on this interface.
Type string
Read Only False
Added iLO 5 1.40

HostEthernetInterfaces

This is a reference to a collection of NICs that Computer Systems use for network communication with this Host Interface. HostEthernetInterfaces is a link ("@odata.id": URI) to another resource.

HostEthernetInterfaces property is not supported in iLO5.

HostInterfaceType

Member of HostInterface.v1_1_1.HostInterface
Description This indicates the Host Interface type for this interface.
Type string or null
Read Only True
Added iLO 5 1.40

The following are the supported values:

Value Description
NetworkHostInterface This interface is a Network Host Interface.

InterfaceEnabled

Member of HostInterface.v1_1_1.HostInterface
Description This indicates whether this interface is enabled.
Type boolean
Read Only False
Added iLO 5 1.40

KernelAuthEnabled

Member of HostInterface.v1_1_1.HostInterface
Description This indicates whether this kernel authentication is enabled for this interface.
Type boolean or null
Read Only False
Added iLO 5 1.40

KernelAuthRoleId

Member of HostInterface.v1_1_1.HostInterface
Description This property contains the Role for kernel authentication on this interface.
Type string
Read Only False
Added iLO 5 1.40

ManagerEthernetInterface

This is a reference to a single NIC that this Manager uses for network communication with this Host Interface. ManagerEthernetInterface is a link ("@odata.id": URI) to another resource.

NetworkProtocol

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. NetworkProtocol is a link ("@odata.id": URI) to another resource.

Status

Member of HostInterface.v1_1_1.HostInterface See the Redfish standard schema and specification for information on common Status object.

HostInterfaceCollection.HostInterfaceCollection

@odata.type: "#HostInterfaceCollection.HostInterfaceCollection"

A Collection of HostInterface resource instances.

Resource Instances

Uri HTTP Allow
/redfish/v1/managers/{item}/hostinterfaces GET
Link Name Destination type
Members[] HostInterface

Members (array)

Member of HostInterfaceCollection.HostInterfaceCollection Members is an array containing elements of:

Members[{item}].@odata.id Member of HostInterfaceCollection.HostInterfaceCollection
Type string
Read Only True
Format uri-reference

Members@odata.count

Member of HostInterfaceCollection.HostInterfaceCollection
Description The total number of collection members.
Type integer
Read Only True

HpeAutomaticCertEnrollment.v1_0_0.HpeAutomaticCertEnrollment

@odata.type: "#HpeAutomaticCertEnrollment.v1_0_0.HpeAutomaticCertEnrollment"

The HpeAutomaticCertEnrollment resource describes the properties of automatic Certificate Enrollment feature support.

Resource Instances

Uri HTTP Allow
/redfish/v1/managers/{item}/securityservice/automaticcertificateenrollment GET POST PATCH

AutomaticCertificateEnrollmentSettings

AutomaticCertificateEnrollmentSettings.CACertificateName Member of HpeAutomaticCertEnrollment.v1_0_0.HpeAutomaticCertEnrollment
Description This is the name of imported CA(Certificate Authority) Certificate which is used to sign the SSL certificate.
Type string
Read Only True

AutomaticCertificateEnrollmentSettings.CertificateEnrollmentStatus Member of HpeAutomaticCertEnrollment.v1_0_0.HpeAutomaticCertEnrollment
Description Enrollment Status of SSL certificate
Type string
Read Only True

The following are the supported values:

Value Description
InProgress Enrollment request is in progress.
Success Enrollment has completed successfully.
Failed Enrollment request has failed.
Disabled
Unknown Enrollment request status is Unknown.

AutomaticCertificateEnrollmentSettings.ChallengePassword Member of HpeAutomaticCertEnrollment.v1_0_0.HpeAutomaticCertEnrollment
Description Challenge Password required to complete certificate Enrollment.
Type string or null
Read Only False

AutomaticCertificateEnrollmentSettings.ServerUrl Member of HpeAutomaticCertEnrollment.v1_0_0.HpeAutomaticCertEnrollment
Description Link to Certificate Enrollment Server.
Type string
Read Only False
Format uri-reference

AutomaticCertificateEnrollmentSettings.ServiceEnabled Member of HpeAutomaticCertEnrollment.v1_0_0.HpeAutomaticCertEnrollment
Description This indicates whether this Automatic Certificate Enrollment(ACE) service is enabled.
Type boolean or null
Read Only False

HttpsCertCSRSubjectValue

HttpsCertCSRSubjectValue.City Member of HpeAutomaticCertEnrollment.v1_0_0.HpeAutomaticCertEnrollment
Description The city or locality where the company or organization that owns this iLO subsystem is located.
Type string
Read Only False

HttpsCertCSRSubjectValue.CommonName Member of HpeAutomaticCertEnrollment.v1_0_0.HpeAutomaticCertEnrollment
Description The FQDN of this iLO subsystem.
Type string
Read Only False

HttpsCertCSRSubjectValue.Country Member of HpeAutomaticCertEnrollment.v1_0_0.HpeAutomaticCertEnrollment
Description The two-character country code where the company or organization that owns this Manager subsystem is located. Eg: US
Type string
Read Only False

HttpsCertCSRSubjectValue.IncludeIP Member of HpeAutomaticCertEnrollment.v1_0_0.HpeAutomaticCertEnrollment
Description Include the IP Addresses in the CSR.
Type boolean
Read Only False

HttpsCertCSRSubjectValue.OrgName Member of HpeAutomaticCertEnrollment.v1_0_0.HpeAutomaticCertEnrollment
Description The name of the company or organization that owns this iLO subsystem.
Type string
Read Only False

HttpsCertCSRSubjectValue.OrgUnit Member of HpeAutomaticCertEnrollment.v1_0_0.HpeAutomaticCertEnrollment
Description The unit within the company or organization that owns this iLO subsystem.
Type string
Read Only False

HttpsCertCSRSubjectValue.State Member of HpeAutomaticCertEnrollment.v1_0_0.HpeAutomaticCertEnrollment
Description The state where the company or organization that owns this iLO subsystem is located.
Type string
Read Only False

Actions

HpeAutomaticCertEnrollment.ImportCACertificate Member of HpeAutomaticCertEnrollment.v1_0_0.HpeAutomaticCertEnrollment Imports a CA Certificate.

Parameters:

Certificate (string)

Contains PEM formatted X509 certificate (Base64 encoded).

HpeBaseConfigs.v2_0_0.HpeBaseConfigs

@odata.type: "#HpeBaseConfigs.v2_0_0.HpeBaseConfigs"

Resource Instances

Uri HTTP Allow
/redfish/v1/Systems/{item}/Bios/Kmsconfig/Baseconfigs GET
/redfish/v1/Systems/{item}/Bios/Serverconfiglock/Baseconfigs GET
/redfish/v1/systems/{item}/bios/baseconfigs GET
/redfish/v1/systems/{item}/bios/boot/baseconfigs GET
/redfish/v1/systems/{item}/bios/iscsi/baseconfigs GET
/redfish/v1/systems/{item}/bios/tlsconfig/baseconfigs GET

BaseConfigs (array)

Member of HpeBaseConfigs.v2_0_0.HpeBaseConfigs BaseConfigs is an array containing elements of:

Capabilities

Capabilities.BaseConfig Member of HpeBaseConfigs.v2_0_0.HpeBaseConfigs
Type boolean
Read Only True

Capabilities.BaseConfigs Member of HpeBaseConfigs.v2_0_0.HpeBaseConfigs
Type boolean
Read Only True

HpeBaseNetworkAdapter.v2_0_0.HpeBaseNetworkAdapter

@odata.type: "#HpeBaseNetworkAdapter.v2_0_0.HpeBaseNetworkAdapter"

The HpeBaseNetworkAdapter resource describes an Ethernet Adapter and its ports. Clients should use the Redfish NetworkAdapter and NetworkInterface resources when available instead of this.

Resource Instances

Uri HTTP Allow
/redfish/v1/systems/{item}/basenetworkadapters/{item} GET

FcPorts (array)

Member of HpeBaseNetworkAdapter.v2_0_0.HpeBaseNetworkAdapter FcPorts is an array containing elements of:

FcPorts[{item}].PortNumber Member of HpeBaseNetworkAdapter.v2_0_0.HpeBaseNetworkAdapter
Description Port Number.
Type integer or null
Read Only True
Added iLO 5 1.10

FcPorts[{item}].WWNN Member of HpeBaseNetworkAdapter.v2_0_0.HpeBaseNetworkAdapter
Description World Wide Node Name.
Type string or null
Read Only True
Added iLO 5 1.10

FcPorts[{item}].WWPN Member of HpeBaseNetworkAdapter.v2_0_0.HpeBaseNetworkAdapter
Description World Wide Port Name.
Type string or null
Read Only True
Added iLO 5 1.10

Firmware

Firmware.Current Firmware.Current.VersionString Member of HpeBaseNetworkAdapter.v2_0_0.HpeBaseNetworkAdapter
Description This string represents the version of the firmware image.
Type string or null
Read Only True
Added iLO 5 1.10

Location

Member of HpeBaseNetworkAdapter.v2_0_0.HpeBaseNetworkAdapter
Description Location of the device.
Type string
Read Only True

PartNumber

Member of HpeBaseNetworkAdapter.v2_0_0.HpeBaseNetworkAdapter
Description The device part number.
Type string or null
Read Only True
Added iLO 5 1.10

PhysicalPorts (array)

Member of HpeBaseNetworkAdapter.v2_0_0.HpeBaseNetworkAdapter PhysicalPorts is an array containing elements of:

PhysicalPorts[{item}].FullDuplex Member of HpeBaseNetworkAdapter.v2_0_0.HpeBaseNetworkAdapter
Description Full-duplex data transmission means that data can be transmitted in both directions on a signal carrier at the same time.
Type boolean or null
Read Only True
Added iLO 5 1.10

PhysicalPorts[{item}].IPv4Addresses (array) Member of HpeBaseNetworkAdapter.v2_0_0.HpeBaseNetworkAdapter IPv4Addresses is an array containing elements of:

IPv4Addresses[{item}].Address Member of HpeBaseNetworkAdapter.v2_0_0.HpeBaseNetworkAdapter
Description This is the IPv4 Address.
Type string or null
Read Only True

PhysicalPorts[{item}].IPv6Addresses (array) Member of HpeBaseNetworkAdapter.v2_0_0.HpeBaseNetworkAdapter IPv6Addresses is an array containing elements of:

IPv6Addresses[{item}].Address Member of HpeBaseNetworkAdapter.v2_0_0.HpeBaseNetworkAdapter
Description This is the IPv6 Address.
Type string or null
Read Only True
Format ipv6

PhysicalPorts[{item}].LinkStatus Member of HpeBaseNetworkAdapter.v2_0_0.HpeBaseNetworkAdapter
Description The link status of this interface (port).
Type string or null
Read Only True
Added iLO 5 1.20

The following are the supported values:

Value
LinkUp
NoLink
LinkDown
Null

PhysicalPorts[{item}].MacAddress Member of HpeBaseNetworkAdapter.v2_0_0.HpeBaseNetworkAdapter
Description The port MAC address.
Type string or null
Read Only True
Added iLO 5 1.10

PhysicalPorts[{item}].Oem.Hpe.BadReceives Member of HpeBaseNetworkAdapter.v2_0_0.HpeBaseNetworkAdapter
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.
Type integer or null
Read Only True
Added iLO 5 1.10

PhysicalPorts[{item}].Oem.Hpe.BadTransmits Member of HpeBaseNetworkAdapter.v2_0_0.HpeBaseNetworkAdapter
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.
Type integer or null
Read Only True
Added iLO 5 1.10

PhysicalPorts[{item}].Oem.Hpe.GoodReceives Member of HpeBaseNetworkAdapter.v2_0_0.HpeBaseNetworkAdapter
Description A count of frames successfully received by the physical adapter.
Type integer or null
Read Only True
Added iLO 5 1.10

PhysicalPorts[{item}].Oem.Hpe.GoodTransmits Member of HpeBaseNetworkAdapter.v2_0_0.HpeBaseNetworkAdapter
Description A count of frames successfully transmitted by the physical adapter.
Type integer or null
Read Only True
Added iLO 5 1.10

PhysicalPorts[{item}].Oem.Hpe.StructuredName Member of HpeBaseNetworkAdapter.v2_0_0.HpeBaseNetworkAdapter
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
Type string or null
Read Only True
Added iLO 5 1.10

PhysicalPorts[{item}].Oem.Hpe.Team Member of HpeBaseNetworkAdapter.v2_0_0.HpeBaseNetworkAdapter
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).
Type string or null
Read Only True
Added iLO 5 1.10

PhysicalPorts[{item}].SpeedMbps Member of HpeBaseNetworkAdapter.v2_0_0.HpeBaseNetworkAdapter
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.
Type integer or null
Read Only True
Added iLO 5 1.10

PhysicalPorts[{item}].Status Member of HpeBaseNetworkAdapter.v2_0_0.HpeBaseNetworkAdapter See the Redfish standard schema and specification for information on common Status object.

PhysicalPorts[{item}].UEFIDevicePath Member of HpeBaseNetworkAdapter.v2_0_0.HpeBaseNetworkAdapter
Description UEFIDevice Path for correlation purposes
Type string or null
Read Only True
Added iLO 5 1.10

SerialNumber

Member of HpeBaseNetworkAdapter.v2_0_0.HpeBaseNetworkAdapter
Description The device serial number.
Type string or null
Read Only True
Added iLO 5 1.10

Status

Member of HpeBaseNetworkAdapter.v2_0_0.HpeBaseNetworkAdapter See the Redfish standard schema and specification for information on common Status object.

StructuredName

Member of HpeBaseNetworkAdapter.v2_0_0.HpeBaseNetworkAdapter
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
Type string or null
Read Only True
Added iLO 5 1.10

UEFIDevicePath

Member of HpeBaseNetworkAdapter.v2_0_0.HpeBaseNetworkAdapter
Description UEFIDevice Path for correlation purposes
Type string or null
Read Only True
Added iLO 5 1.10

HpeBaseNetworkAdapterCollection.HpeBaseNetworkAdapterCollection

@odata.type: "#HpeBaseNetworkAdapterCollection.HpeBaseNetworkAdapterCollection"

A Collection of HpeBaseNetworkAdapter resource instances.

Resource Instances

Uri HTTP Allow
/redfish/v1/systems/{item}/basenetworkadapters GET
Link Name Destination type
Members[] HpeBaseNetworkAdapter

Members (array)

Member of HpeBaseNetworkAdapterCollection.HpeBaseNetworkAdapterCollection Members is an array containing elements of:

Members[{item}].@odata.id Member of HpeBaseNetworkAdapterCollection.HpeBaseNetworkAdapterCollection
Type string
Read Only True
Format uri-reference

Members@odata.count

Member of HpeBaseNetworkAdapterCollection.HpeBaseNetworkAdapterCollection
Description The total number of collection members.
Type integer
Read Only True

HpeBiosMapping.v2_0_0.HpeBiosMapping

@odata.type: "#HpeBiosMapping.v2_0_0.HpeBiosMapping"

This is the schema definition for the BIOS Attributes Mappings resource.

Resource Instances

Uri HTTP Allow
/redfish/v1/systems/{item}/bios/mappings GET

AttributeRegistry

Member of HpeBiosMapping.v2_0_0.HpeBiosMapping
Description The Resource ID of the Attribute Registry for the BIOS Attributes resource.
Type string or null
Read Only True

BiosPciSettingsMappings (array)

Member of HpeBiosMapping.v2_0_0.HpeBiosMapping BiosPciSettingsMappings is an array containing elements of:

BiosPciSettingsMappings[{item}].Associations (array) Member of HpeBiosMapping.v2_0_0.HpeBiosMapping Associations is an array containing elements of:

BiosPciSettingsMappings[{item}].CorrelatableID Member of HpeBiosMapping.v2_0_0.HpeBiosMapping
Description Contains any CorrelatableIDs that represent this PCI device. The CorrelatableID values can be JSON Pointers or UEFI identifiers.
Type string
Read Only True

BiosPciSettingsMappings[{item}].Instance Member of HpeBiosMapping.v2_0_0.HpeBiosMapping
Description The instance number of the parent PCI device for this association set.
Type integer
Read Only True

BiosPciSettingsMappings[{item}].Subinstances (array) Member of HpeBiosMapping.v2_0_0.HpeBiosMapping Subinstances is an array containing elements of:

Subinstances[{item}].Associations (array) Member of HpeBiosMapping.v2_0_0.HpeBiosMapping Associations is an array containing elements of:
Type string
Read Only True

Subinstances[{item}].CorrelatableID Member of HpeBiosMapping.v2_0_0.HpeBiosMapping
Description Contains any CorrelatableIDs that represent this PCI device. The CorrelatableID values can be JSON Pointers or UEFI identifiers.
Type string
Read Only True

Subinstances[{item}].Subinstance Member of HpeBiosMapping.v2_0_0.HpeBiosMapping
Description The sub-instance number of the child PCI device for this association set.
Type integer
Read Only True

HpeCertAuth.v1_1_0.HpeCertAuth

@odata.type: "#HpeCertAuth.v1_1_0.HpeCertAuth"

The HpeCertAuth resource describes the BMC certificate based authentication feature.

Resource Instances

Uri HTTP Allow
/redfish/v1/managers/{item}/securityservice/certificateauthentication GET POST PATCH
Link Name Destination type
CACertificates Collection of HpeCertificate
Links/UserCertificateMapping Collection of HpeiLOAccountCertificateMap

CACertificates

The value of this property shall be a reference to a Collection of HpeCertificate resources. CACertificates is a link ("@odata.id": URI) to another resource.

CRLIssuer

Member of HpeCertAuth.v1_1_0.HpeCertAuth
Description Issuer of the installed CRL, if present.
Type string or null
Read Only True
Added iLO 5 1.10

CRLSerial

Member of HpeCertAuth.v1_1_0.HpeCertAuth
Description Serial Number of the installed CRL, if present.
Type string or null
Read Only True
Added iLO 5 1.10

CertificateLoginEnabled

Member of HpeCertAuth.v1_1_0.HpeCertAuth
Description Specifies whether Certificate login is enabled.
Type boolean
Read Only False
Added iLO 5 1.10

LDAPCertificateNameMapping

Member of HpeCertAuth.v1_1_0.HpeCertAuth
Description The method used to map a certificate to its associated LDAP user account.
Type string
Read Only False
Added iLO 5 1.10

The following are the supported values:

Value Description
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.

OCSPUri

Member of HpeCertAuth.v1_1_0.HpeCertAuth
Description URL to use for OCSP certificate checking.
Type string or null
Read Only False
Added iLO 5 1.15
Format uri-reference

StrictCACModeEnabled

Member of HpeCertAuth.v1_1_0.HpeCertAuth
Description Whether or not Strict CAC Mode is enabled.
Type boolean
Read Only False
Added iLO 5 1.10

Actions

HpeCertAuth.DeleteCRL Member of HpeCertAuth.v1_1_0.HpeCertAuth Remove an installed Certificate Revocation List (CRL).

There are no parameters for this action.

HpeCertAuth.ImportCACertificate Member of HpeCertAuth.v1_1_0.HpeCertAuth Imports a Trusted Certificate

Parameters:

Certificate (string)

Contains PEM formatted X509 certificate or PKCS7 certificate chain (Base64 encoded).

HpeCertAuth.ImportCRL Member of HpeCertAuth.v1_1_0.HpeCertAuth Imports a Certificate Revocation List (CRL).

Parameters:

ImportUri (string)

Contains URI of PEM formatted certificate revocation list (CRL) (Base64 encoded).

HpeCertificate.v1_0_0.HpeCertificate

@odata.type: "#HpeCertificate.v1_0_0.HpeCertificate"

The HpeCertificate resource describes an X509 certificate.

This resource type was added in iLO 5 1.20

Resource Instances

Uri HTTP Allow
/redfish/v1/eventservice/cacertificates/{item} GET DELETE
/redfish/v1/managers/{item}/securityservice/certificateauthentication/cacertificates/{item} GET DELETE

Issuer

Member of HpeCertificate.v1_0_0.HpeCertificate
Description The Certificate Authority that issued the certificate.
Type string
Read Only True
Added iLO 5 1.10

SerialNumber

Member of HpeCertificate.v1_0_0.HpeCertificate
Description The serial number that the Certificate Authority assigned to the certificate.
Type string
Read Only True
Added iLO 5 1.10

Subject

Member of HpeCertificate.v1_0_0.HpeCertificate
Description The entity to which the certificate was issued.
Type string
Read Only True
Added iLO 5 1.10

ValidNotAfter

Member of HpeCertificate.v1_0_0.HpeCertificate
Description The date on which the certificate validity period ends.
Type string or null
Read Only True
Added iLO 5 1.10
Format date-time

ValidNotBefore

Member of HpeCertificate.v1_0_0.HpeCertificate
Description The date on which the certificate validity period begins.
Type string or null
Read Only True
Added iLO 5 1.10
Format date-time

HpeCertificateCollection.HpeCertificateCollection

@odata.type: "#HpeCertificateCollection.HpeCertificateCollection"

A Collection of HpeCertificate resource instances.

Resource Instances

Uri HTTP Allow
/redfish/v1/eventservice/cacertificates GET
/redfish/v1/managers/{item}/securityservice/certificateauthentication/cacertificates GET
Link Name Destination type
Members[] HpeCertificate

Members (array)

Member of HpeCertificateCollection.HpeCertificateCollection Members is an array containing elements of:

Members[{item}].@odata.id Member of HpeCertificateCollection.HpeCertificateCollection
Type string
Read Only True
Format uri-reference

Members@odata.count

Member of HpeCertificateCollection.HpeCertificateCollection
Description The total number of collection members.
Type integer
Read Only True

HpeComponent.v1_0_1.HpeComponent

@odata.type: "#HpeComponent.v1_0_1.HpeComponent"

The HpeComponent resource describes a software or firmware update component.

Resource Instances

Uri HTTP Allow
/redfish/v1/updateservice/componentrepository/{item} GET PATCH DELETE

Activates

Member of HpeComponent.v1_0_1.HpeComponent
Description Indicates when a component becomes active after being updated.
Type string
Read Only True
Added iLO 5 1.10

The following are the supported values:

Value Description
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.

ComponentType

Member of HpeComponent.v1_0_1.HpeComponent
Description HTTP-style content-type of binary
Type string
Read Only True
Added iLO 5 1.10

ComponentUri

Member of HpeComponent.v1_0_1.HpeComponent
Description URI of the component binary.
Type string
Read Only True
Added iLO 5 1.10
Format uri-reference

Configuration

Member of HpeComponent.v1_0_1.HpeComponent
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).
Type string
Read Only False
Added iLO 5 1.10

Created

Member of HpeComponent.v1_0_1.HpeComponent
Description ISO 8601 time string indicating when this component was added to the NAND.
Type string
Read Only True
Added iLO 5 1.10
Format date-time

Criticality

Member of HpeComponent.v1_0_1.HpeComponent

Criticality

Member of HpeComponent.v1_0_1.HpeComponent

Criticality

Member of HpeComponent.v1_0_1.HpeComponent
Type string
Read Only True
Added iLO 5 1.10

The following are the supported values:

Value
Optional
Recommended
Critical

DeviceClass

Member of HpeComponent.v1_0_1.HpeComponent
Description Device type GUID from iLO secure flash header
Type string
Read Only True
Added iLO 5 1.10

ExecutionParameters

Member of HpeComponent.v1_0_1.HpeComponent
Description Client supplied execution parameters. These are supplied at upload time and given to the component at execution time (Type D only).
Type string
Read Only False
Added iLO 5 1.10

Filename

Member of HpeComponent.v1_0_1.HpeComponent
Description The unique filename of the component.
Type string
Read Only True
Added iLO 5 1.10

Filepath

Member of HpeComponent.v1_0_1.HpeComponent
Description Path of file on the USB LUN if you mount the repo as USB.
Type string
Read Only True
Added iLO 5 1.10

Locked

Member of HpeComponent.v1_0_1.HpeComponent
Description If true, this component cannot be removed with DELETE because it is referenced by an Install Set
Type boolean
Read Only True
Added iLO 5 1.10

SizeBytes

Member of HpeComponent.v1_0_1.HpeComponent
Description Size of the component file in bytes.
Type integer or null
Read Only True
Added iLO 5 1.10

Targets (array)

Member of HpeComponent.v1_0_1.HpeComponent Targets is an array containing elements of:
Description Target GUIDs from secure flash header or sidecar file.
Type string
Read Only True

UpdatableBy (array)

Member of HpeComponent.v1_0_1.HpeComponent UpdatableBy is an array containing elements of:
Description Describes which types of update agents may apply this component.
Type string
Read Only True

The following are the supported values:

Value Description
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.

Version

Member of HpeComponent.v1_0_1.HpeComponent
Description Version of the component from secure flash header or sidecar file.
Type string
Read Only True
Added iLO 5 1.10

HpeComponentCollection.HpeComponentCollection

@odata.type: "#HpeComponentCollection.HpeComponentCollection"

A Collection of HpeComponent resource instances.

Resource Instances

Uri HTTP Allow
/redfish/v1/updateservice/componentrepository GET
Link Name Destination type
Members[] HpeComponent

Members (array)

Member of HpeComponentCollection.HpeComponentCollection Members is an array containing elements of:

Members[{item}].@odata.id Member of HpeComponentCollection.HpeComponentCollection
Type string
Read Only True
Format uri-reference

Members@odata.count

Member of HpeComponentCollection.HpeComponentCollection
Description The total number of collection members.
Type integer
Read Only True

Oem.Hpe.ComponentCount

Member of HpeComponentCollection.HpeComponentCollection
Description The number of files reported.
Type integer or null
Read Only True
Added iLO 5 1.10

Oem.Hpe.FreeSizeBytes

Member of HpeComponentCollection.HpeComponentCollection
Description The available repository space in bytes.
Type integer or null
Read Only True
Added iLO 5 1.10

Oem.Hpe.TotalSizeBytes

Member of HpeComponentCollection.HpeComponentCollection
Description The total repository size in bytes.
Type integer or null
Read Only True
Added iLO 5 1.10

HpeComponentInstallSet.v1_2_0.HpeComponentInstallSet

@odata.type: "#HpeComponentInstallSet.v1_2_0.HpeComponentInstallSet"

The HpeComponentInstallSet resource describes an Install Set, an ordered list of installation instructions that may be invoked.

Resource Instances

Uri HTTP Allow
/redfish/v1/updateservice/installsets/{item} GET POST PATCH DELETE

Created

Member of HpeComponentInstallSet.v1_2_0.HpeComponentInstallSet
Description ISO-time of install set creation.
Type string or null
Read Only True
Added iLO 5 1.10
Format date-time

IsRecovery

Member of HpeComponentInstallSet.v1_2_0.HpeComponentInstallSet
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.
Type boolean
Read Only False
Added iLO 5 1.10

Modified

Member of HpeComponentInstallSet.v1_2_0.HpeComponentInstallSet
Description ISO-time of install modification.
Type string or null
Read Only True
Added iLO 5 1.10
Format date-time

Sequence (array)

Member of HpeComponentInstallSet.v1_2_0.HpeComponentInstallSet Sequence is an array containing elements of:

Sequence[{item}].Command Member of HpeComponentInstallSet.v1_2_0.HpeComponentInstallSet
Description Command to execute.
Type string
Read Only False
Added iLO 5 1.10

The following are the supported values:

Value Description
ApplyUpdate Apply an update using the specified component.
ResetServer Reset the server.
ResetBmc Reset the BMC.
Wait Wait for the WaitTimeSeconds number of seconds.
BootToUefi Boot the server to UEFI shell
PendingReset Reset is pending after bundle update

Sequence[{item}].Component Member of HpeComponentInstallSet.v1_2_0.HpeComponentInstallSet
Type string
Read Only True
Added iLO 5 1.10
Format uri-reference

Sequence[{item}].ExecutionTimeoutMinutes Member of HpeComponentInstallSet.v1_2_0.HpeComponentInstallSet
Description The number of minutes that this update will likely take to apply. Applies if the command is ‘ApplyUpdate’. Ignored otherwise.
Type integer
Read Only False

Sequence[{item}].Filename Member of HpeComponentInstallSet.v1_2_0.HpeComponentInstallSet
Description The unique filename of the component. This correlates to ‘Filename’ in the HpeComponent.
Type string
Read Only False
Added iLO 5 1.10

Sequence[{item}].UpdatableBy (array) Member of HpeComponentInstallSet.v1_2_0.HpeComponentInstallSet UpdatableBy is an array containing elements of:
Type string
Read Only False

The following are the supported values:

Value Description
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.

Sequence[{item}].WaitTimeSeconds Member of HpeComponentInstallSet.v1_2_0.HpeComponentInstallSet
Description The number of seconds to pause if the command is ‘Wait’. Ignored otherwise.
Type integer
Read Only False
Added iLO 5 1.10

Actions

HpeComponentInstallSet.Invoke Member of HpeComponentInstallSet.v1_2_0.HpeComponentInstallSet

Parameters:

ClearTaskQueue (boolean)

Previous items in the task queue can be cleared before the Install Set is invoked

HpeComponentInstallSetCollection.HpeComponentInstallSetCollection

@odata.type: "#HpeComponentInstallSetCollection.HpeComponentInstallSetCollection"

A Collection of HpeComponentInstallSet resource instances.

Resource Instances

Uri HTTP Allow
/redfish/v1/updateservice/installsets GET POST
Link Name Destination type
Members[] HpeComponentInstallSet

Members (array)

Member of HpeComponentInstallSetCollection.HpeComponentInstallSetCollection Members is an array containing elements of:

Members[{item}].@odata.id Member of HpeComponentInstallSetCollection.HpeComponentInstallSetCollection
Type string
Read Only True
Format uri-reference

Members@odata.count

Member of HpeComponentInstallSetCollection.HpeComponentInstallSetCollection
Description The total number of collection members.
Type integer
Read Only True

HpeComponentUpdateTask.v1_3_0.HpeComponentUpdateTask

@odata.type: "#HpeComponentUpdateTask.v1_3_0.HpeComponentUpdateTask"

The HpeComponentUpdateTask resource describes an Update Task, an element in the update task queue. This represents an install instruction.

Resource Instances

Uri HTTP Allow
/redfish/v1/updateservice/updatetaskqueue/{item} GET PATCH DELETE

Command

Member of HpeComponentUpdateTask.v1_3_0.HpeComponentUpdateTask
Description Command to execute.
Type string
Read Only False
Added iLO 5 1.10

The following are the supported values:

Value Description
ApplyUpdate Apply an update using the specified component.
ResetServer Reset the server.
ResetBmc Reset the BMC.
Wait Wait for the WaitTimeSeconds number of seconds.
PendingReset Reset is pending after bundle update.

Component

Member of HpeComponentUpdateTask.v1_3_0.HpeComponentUpdateTask
Type string
Read Only True
Added iLO 5 1.10
Format uri-reference

Created

Member of HpeComponentUpdateTask.v1_3_0.HpeComponentUpdateTask
Description ISO-time of task creation (by whomever created this thing)
Type string
Read Only True
Added iLO 5 1.10
Format date-time

ExecutionTimeoutMinutes

Member of HpeComponentUpdateTask.v1_3_0.HpeComponentUpdateTask
Description The number of minutes that this update will likely take to apply. Applies if the command is ‘ApplyUpdate’. Ignored otherwise.
Type integer
Read Only False

Expire

Member of HpeComponentUpdateTask.v1_3_0.HpeComponentUpdateTask
Description ISO 8601 Redfish-style time string after which we will automatically change state to Expired - null for no expire time
Type string
Read Only False
Added iLO 5 1.10
Format date-time

Filename

Member of HpeComponentUpdateTask.v1_3_0.HpeComponentUpdateTask
Description The unique filename of the component. This correlates to ‘Filename’ in the HpeComponent.
Type string
Read Only False
Added iLO 5 1.10

MaintenanceWindow

Member of HpeComponentUpdateTask.v1_3_0.HpeComponentUpdateTask
Description The maintenance window for this update task.
Type string or null
Read Only False
Added iLO 5 1.30

Modified

Member of HpeComponentUpdateTask.v1_3_0.HpeComponentUpdateTask
Description ISO-time of last task queue item update by updater (not client)
Type string
Read Only True
Added iLO 5 1.10
Format date-time

RecoveryPrivilege

Member of HpeComponentUpdateTask.v1_3_0.HpeComponentUpdateTask
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.
Type boolean
Read Only True
Added iLO 5 1.40

Result

Result.MessageArgs (array) Member of HpeComponentUpdateTask.v1_3_0.HpeComponentUpdateTask MessageArgs is an array containing elements of:
Type string
Read Only True

Result.MessageId Member of HpeComponentUpdateTask.v1_3_0.HpeComponentUpdateTask
Description The key for this message that can be used to look up the message in a message registry.
Type string
Read Only False
Added iLO 5 1.10

ResultLog

Member of HpeComponentUpdateTask.v1_3_0.HpeComponentUpdateTask
Description base64 encoded entry to capture component log. Estimated to be generally 1-2KB. written by updater
Type string or null
Read Only False
Added iLO 5 1.10

StartAfter

Member of HpeComponentUpdateTask.v1_3_0.HpeComponentUpdateTask
Description ISO 8601 Redfish-style time string of earliest execution - null for no start time specified
Type string
Read Only False
Added iLO 5 1.10
Format date-time

State

Member of HpeComponentUpdateTask.v1_3_0.HpeComponentUpdateTask
Description The current state of the update task.
Type string
Read Only False
Added iLO 5 1.10

The following are the supported values:

Value Description
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.

TPMOverride

Member of HpeComponentUpdateTask.v1_3_0.HpeComponentUpdateTask
Description If true then the TPMOverrideFlag is passed in on the associated flash operations.
Type boolean
Read Only False
Added iLO 5 1.10

UpdatableBy (array)

Member of HpeComponentUpdateTask.v1_3_0.HpeComponentUpdateTask UpdatableBy is an array containing elements of:
Type string
Read Only True

The following are the supported values:

Value Description
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.

UpdateRecoverySet

Member of HpeComponentUpdateTask.v1_3_0.HpeComponentUpdateTask
Description Update Recovery Set with this component if the command is ‘ApplyUpdate’. Ignored otherwise.
Type boolean
Read Only False
Added iLO 5 1.20

WaitTimeSeconds

Member of HpeComponentUpdateTask.v1_3_0.HpeComponentUpdateTask
Description The number of seconds to pause if the command is ‘Wait’. Ignored otherwise.
Type integer
Read Only False
Added iLO 5 1.10

HpeComponentUpdateTaskQueueCollection.HpeComponentUpdateTaskQueueCollection

@odata.type: "#HpeComponentUpdateTaskQueueCollection.HpeComponentUpdateTaskQueueCollection"

A Collection of HpeComponentUpdateTaskQueue resource instances.

Resource Instances

Uri HTTP Allow
/redfish/v1/updateservice/updatetaskqueue GET POST
Link Name Destination type
Members[] HpeComponentUpdateTask

Members (array)

Member of HpeComponentUpdateTaskQueueCollection.HpeComponentUpdateTaskQueueCollection Members is an array containing elements of:

Members[{item}].@odata.id Member of HpeComponentUpdateTaskQueueCollection.HpeComponentUpdateTaskQueueCollection
Type string
Read Only True
Format uri-reference

Members@odata.count

Member of HpeComponentUpdateTaskQueueCollection.HpeComponentUpdateTaskQueueCollection
Description The total number of collection members.
Type integer
Read Only True

HpeDirectoryTest.v1_0_0.HpeDirectoryTest

@odata.type: "#HpeDirectoryTest.v1_0_0.HpeDirectoryTest"

The HpeDirectoryTest resource describes the BMC directory test.

Resource Instances

Uri HTTP Allow
/redfish/v1/accountservice/directorytest GET POST

OverallStatus

Member of HpeDirectoryTest.v1_0_0.HpeDirectoryTest
Description Represents the overall status of directory tests.
Type string
Read Only True
Added iLO 5 1.40

The following are the supported values:

Value Description
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.

TestResults (array)

Member of HpeDirectoryTest.v1_0_0.HpeDirectoryTest TestResults is an array containing elements of:

TestResults[{item}].Notes Member of HpeDirectoryTest.v1_0_0.HpeDirectoryTest
Description This provides additional details on the directory test.
Type string or null
Read Only True
Added iLO 5 1.40

TestResults[{item}].Status Member of HpeDirectoryTest.v1_0_0.HpeDirectoryTest See the Redfish standard schema and specification for information on common Status object.

TestResults[{item}].TestName Member of HpeDirectoryTest.v1_0_0.HpeDirectoryTest
Description The name of directory test.
Type string
Read Only True
Added iLO 5 1.40

Actions

HpeDirectoryTest.StartTest Member of HpeDirectoryTest.v1_0_0.HpeDirectoryTest Start the directory test.

Parameters:

HpeESKM.v2_0_0.HpeESKM

@odata.type: "#HpeESKM.v2_0_0.HpeESKM"

The HpeESKM resource describes properties for managing the ESKM feature. ESKM (Enterprise Security Key Manager) enables connections to an operational key manager,change redundancy settings,view the key manager connection settings,test the connection,and view key management events.

Resource Instances

Uri HTTP Allow
/redfish/v1/managers/{item}/securityservice/eskm GET POST PATCH

ESKMEvents (array)

Member of HpeESKM.v2_0_0.HpeESKM ESKMEvents is an array containing elements of:

ESKMEvents[{item}].Event Member of HpeESKM.v2_0_0.HpeESKM
Description ESKM event description.
Type string or null
Read Only True
Added iLO 5 1.10

ESKMEvents[{item}].Timestamp Member of HpeESKM.v2_0_0.HpeESKM
Description Time of ESKM event.
Type string or null
Read Only True
Added iLO 5 1.10
Format date-time

KeyManagerConfig

KeyManagerConfig.AccountGroup Member of HpeESKM.v2_0_0.HpeESKM
Description Account group on ESKM.
Type string or null
Read Only False
Added iLO 5 1.10

KeyManagerConfig.AccountName Member of HpeESKM.v2_0_0.HpeESKM
Description Account name on ESKM.
Type string
Read Only True
Added iLO 5 1.10

KeyManagerConfig.ESKMLocalCACertificateName Member of HpeESKM.v2_0_0.HpeESKM
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.
Type string or null
Read Only False
Added iLO 5 1.10

KeyManagerConfig.ImportedCertificateIssuer Member of HpeESKM.v2_0_0.HpeESKM
Description Imported certificate issuer.
Type string
Read Only True
Added iLO 5 1.10

KeyManagerConfig.ImportedCertificateSubject Member of HpeESKM.v2_0_0.HpeESKM
Description Imported certificate subject.
Type string
Read Only True
Added iLO 5 1.10

KeyManagerConfig.LoginName Member of HpeESKM.v2_0_0.HpeESKM
Description ESKM administrator account login name. This property always returns null on GET.
Type string or null
Read Only False
Added iLO 5 1.10

KeyManagerConfig.Password Member of HpeESKM.v2_0_0.HpeESKM
Description ESKM administrator account password. This property always returns null on GET.
Type string or null
Read Only False
Added iLO 5 1.10

KeyServerRedundancyReq

Member of HpeESKM.v2_0_0.HpeESKM
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.
Type boolean
Read Only False
Added iLO 5 1.10

PrimaryKeyServerAddress

Member of HpeESKM.v2_0_0.HpeESKM
Description Primary key server IP address or FQDN. Set to null to clear the value.
Type string or null
Read Only False
Added iLO 5 1.10

PrimaryKeyServerPort

Member of HpeESKM.v2_0_0.HpeESKM
Description Primary key server port number. Set to null to clear the value.
Type integer or null
Read Only False
Added iLO 5 1.10

SecondaryKeyServerAddress

Member of HpeESKM.v2_0_0.HpeESKM
Description Secondary key server IP address or FQDN. Set to null to clear the value.
Type string or null
Read Only False
Added iLO 5 1.10

SecondaryKeyServerPort

Member of HpeESKM.v2_0_0.HpeESKM
Description Secondary key server port number. Set to null to clear the value.
Type integer or null
Read Only False
Added iLO 5 1.10

Actions

HpeESKM.ClearESKMLog Member of HpeESKM.v2_0_0.HpeESKM Clears ESKM log.

There are no parameters for this action.

HpeESKM.TestESKMConnections Member of HpeESKM.v2_0_0.HpeESKM Test ESKM connections.

There are no parameters for this action.

HpeHttpsCert.v2_0_0.HpeHttpsCert

@odata.type: "#HpeHttpsCert.v2_0_0.HpeHttpsCert"

The HpeHttpsCert resource describes an X509 certificate.

Resource Instances

Uri HTTP Allow
/redfish/v1/managers/{item}/securityservice/httpscert GET POST DELETE

CertificateSigningRequest

Member of HpeHttpsCert.v2_0_0.HpeHttpsCert
Description GenerateCSR action, wait few minutes (upto 10), perform GET operation, fills CSR. Contains a public and private key pair.
Type string or null
Read Only True
Added iLO 5 1.10

X509CertificateInformation

X509CertificateInformation.Issuer Member of HpeHttpsCert.v2_0_0.HpeHttpsCert
Description The Certificate Authority that issued the certificate.
Type string
Read Only True
Added iLO 5 1.10

X509CertificateInformation.SerialNumber Member of HpeHttpsCert.v2_0_0.HpeHttpsCert
Description The serial number that the Certificate Authority assigned to the certificate.
Type string
Read Only True
Added iLO 5 1.10

X509CertificateInformation.Subject Member of HpeHttpsCert.v2_0_0.HpeHttpsCert
Description The entity to which the certificate was issued.
Type string
Read Only True
Added iLO 5 1.10

X509CertificateInformation.ValidNotAfter Member of HpeHttpsCert.v2_0_0.HpeHttpsCert
Description The date on which the certificate validity period ends.
Type string
Read Only True
Added iLO 5 1.10
Format date-time

X509CertificateInformation.ValidNotBefore Member of HpeHttpsCert.v2_0_0.HpeHttpsCert
Description The date on which the certificate validity period begins.
Type string
Read Only True
Added iLO 5 1.10
Format date-time

Actions

HpeHttpsCert.GenerateCSR Member of HpeHttpsCert.v2_0_0.HpeHttpsCert

Parameters:

City (string)

The city or locality where the company or organization that owns this iLO subsystem is located.

CommonName (string)

The FQDN of this iLO subsystem.

Country (string)

The two-character country code where the company or organization that owns this Manager subsystem is located. Eg: US

IncludeIP (boolean)

Include the IP Addresses in the CSR.

OrgName (string)

The name of the company or organization that owns this iLO subsystem.

OrgUnit (string)

The unit within the company or organization that owns this iLO subsystem.

State (string)

The state where the company or organization that owns this iLO subsystem is located.

HpeHttpsCert.ImportCertificate Member of HpeHttpsCert.v2_0_0.HpeHttpsCert Imports a Trusted Certificate and iLO is reset.

Parameters:

Certificate (string)

Contains PEM formatted X509 certificate (Base64 encoded).

HpeiLOAccountCertificateMap.v1_0_1.HpeiLOAccountCertificateMap

@odata.type: "#HpeiLOAccountCertificateMap.v1_0_1.HpeiLOAccountCertificateMap"

The HpeiLOAccountCertificateMap resource describes mapping X509 certificates to user accounts.

This resource type was added in iLO 5 1.20

Resource Instances

Uri HTTP Allow
/redfish/v1/accountservice/usercertificatemapping/{item} GET POST DELETE

Fingerprint

Member of HpeiLOAccountCertificateMap.v1_0_1.HpeiLOAccountCertificateMap
Description The fingerprint which uniquely identifies the mapped certificate.
Type string
Read Only False
Added iLO 5 1.10

FingerprintDigestAlgorithm

Member of HpeiLOAccountCertificateMap.v1_0_1.HpeiLOAccountCertificateMap
Description The algorithm used to calculate the fingerprint.
Type string
Read Only False
Added iLO 5 1.10

UserName

Member of HpeiLOAccountCertificateMap.v1_0_1.HpeiLOAccountCertificateMap
Description The name used to log in to the management processor.
Type string
Read Only False
Added iLO 5 1.10

HpeiLOAccountCertificateMapCollection.HpeiLOAccountCertificateMapCollection

@odata.type: "#HpeiLOAccountCertificateMapCollection.HpeiLOAccountCertificateMapCollection"

A Collection of HpeiLOAccountCertificateMap resource instances.

Resource Instances

Uri HTTP Allow
/redfish/v1/accountservice/usercertificatemapping GET POST
Link Name Destination type
Members[] HpeiLOAccountCertificateMap

Members (array)

Member of HpeiLOAccountCertificateMapCollection.HpeiLOAccountCertificateMapCollection Members is an array containing elements of:

Members[{item}].@odata.id Member of HpeiLOAccountCertificateMapCollection.HpeiLOAccountCertificateMapCollection
Type string
Read Only True
Format uri-reference

Members@odata.count

Member of HpeiLOAccountCertificateMapCollection.HpeiLOAccountCertificateMapCollection
Description The total number of collection members.
Type integer
Read Only True

HpeiLOActiveHealthSystem.v2_5_0.HpeiLOActiveHealthSystem

@odata.type: "#HpeiLOActiveHealthSystem.v2_5_0.HpeiLOActiveHealthSystem"

The HpeiLOActiveHealthSystem resource describes the properties for managing the Active Health System.

Resource Instances

Uri HTTP Allow
/redfish/v1/managers/{item}/activehealthsystem GET POST PATCH

AHSEnabled

Member of HpeiLOActiveHealthSystem.v2_5_0.HpeiLOActiveHealthSystem
Description Determines whether HPE Active Health System logging is enabled or disabled.
Type boolean
Read Only False
Added iLO 5 1.10

AHSFileEnd

Member of HpeiLOActiveHealthSystem.v2_5_0.HpeiLOActiveHealthSystem
Description The end of the AHS log.
Type string or null
Read Only True
Added iLO 5 1.10
Format date-time

AHSFileStart

Member of HpeiLOActiveHealthSystem.v2_5_0.HpeiLOActiveHealthSystem
Description The start of the AHS log.
Type string or null
Read Only True
Added iLO 5 1.10
Format date-time

AHSStatus

AHSStatus.HardwareEnabled Member of HpeiLOActiveHealthSystem.v2_5_0.HpeiLOActiveHealthSystem
Description Determines whether HPE Active Health System logging in hardware is enabled or not.
Type boolean
Read Only True
Added iLO 5 1.20

AHSStatus.SoftwareEnabled Member of HpeiLOActiveHealthSystem.v2_5_0.HpeiLOActiveHealthSystem
Description Determines whether HPE Active Health System logging in software is enabled or not.
Type boolean
Read Only True
Added iLO 5 1.20

AHSStatus.TemporaryHoldEnabled Member of HpeiLOActiveHealthSystem.v2_5_0.HpeiLOActiveHealthSystem
Description Determines whether HPE Active Health System logging access is temporarily disabled.
Type boolean
Read Only True
Added iLO 5 1.20

LocationParameters

LocationParameters.case_no Member of HpeiLOActiveHealthSystem.v2_5_0.HpeiLOActiveHealthSystem
Description This query parameter may be added to the AHS location URI to insert the case number into the AHS log header. For example, http://iloname.example.net/ahsdata/HPE_xxxxxxxxxx_20140821.ahs?downloadAll=1&&case_no=abc123.
Type string
Read Only True
Added iLO 5 1.10

LocationParameters.co_name Member of HpeiLOActiveHealthSystem.v2_5_0.HpeiLOActiveHealthSystem
Description This query parameter may be added to the AHS location URI to insert the company name into the AHS log header. For example, http://iloname.example.net/ahsdata/HPE_xxxxxxxxxx_20140821.ahs?downloadAll=1&&co_name=myCompany.
Type string
Read Only True
Added iLO 5 1.10

LocationParameters.contact_name Member of HpeiLOActiveHealthSystem.v2_5_0.HpeiLOActiveHealthSystem
Description This query parameter may be added to the AHS location URI to insert the contact name into the AHS log header. For example, http://iloname.example.net/ahsdata/HPE_xxxxxxxxxx_20140821.ahs?downloadAll=1&&contact_name=JohnDoe.
Type string
Read Only True
Added iLO 5 1.10

LocationParameters.days Member of HpeiLOActiveHealthSystem.v2_5_0.HpeiLOActiveHealthSystem
Description This query parameter should be used to download the most recent N days of the AHS log. For example, http://iloname.example.net/ahsdata/HPE_xxxxxxxxxx_20140821.ahs?days=7. Will retrive logs made within the last 7 days.
Type string
Read Only True
Added iLO 5 1.15

LocationParameters.downloadAll Member of HpeiLOActiveHealthSystem.v2_5_0.HpeiLOActiveHealthSystem
Description This query parameter should be used to download entire AHS log. For example, http://iloname.example.net/ahsdata/HPE_xxxxxxxxxx_20140821.ahs?downloadAll=1.
Type string
Read Only True
Added iLO 5 1.10

LocationParameters.email Member of HpeiLOActiveHealthSystem.v2_5_0.HpeiLOActiveHealthSystem
Description This query parameter may be added to the AHS location URI to insert the contacts email address into the AHS log header. For example, http://iloname.example.net/ahsdata/HPE_xxxxxxxxxx_20140821.ahs?downloadAll=1&&email=abc@xyz.com.
Type string
Read Only True
Added iLO 5 1.10

LocationParameters.from Member of HpeiLOActiveHealthSystem.v2_5_0.HpeiLOActiveHealthSystem
Description This query parameter must be added with the ‘to’ query parameter to the AHS location URI to limit the range of data returned. ‘downloadAll’ parameter should not be used with this query parameter. For example, http://iloname.example.net/ahsdata/HPE_xxxxxxxxxx_20140821.ahs?from=2014-03-01&&to=2014-03-30.
Type string
Read Only True
Added iLO 5 1.10

LocationParameters.phone Member of HpeiLOActiveHealthSystem.v2_5_0.HpeiLOActiveHealthSystem
Description This query parameter may be added to the AHS location URI to insert the contacts phone number into the AHS log header. For example, http://iloname.example.net/ahsdata/HPE_xxxxxxxxxx_20140821.ahs?downloadAll=1&&contact_name=JohnDoe&&phone=555-555-5555.
Type string
Read Only True
Added iLO 5 1.10

LocationParameters.to Member of HpeiLOActiveHealthSystem.v2_5_0.HpeiLOActiveHealthSystem
Description This query parameter must be added with the ‘from’ query parameter to the AHS location URI to limit the range of data returned.‘downloadAll’ parameter should not be used with this query parameter. For example, http://iloname.example.net/ahsdata/HPE_xxxxxxxxxx_20140821.ahs?from=2014-03-01&&to=2014-03-30.
Type string
Read Only True
Added iLO 5 1.10

Actions

HpeiLOActiveHealthSystem.CaptureSystemLog Member of HpeiLOActiveHealthSystem.v2_5_0.HpeiLOActiveHealthSystem There are no parameters for this action.

HpeiLOActiveHealthSystem.ClearLog Member of HpeiLOActiveHealthSystem.v2_5_0.HpeiLOActiveHealthSystem There are no parameters for this action.

HpeiLOActiveHealthSystem.LogAmplifierData Member of HpeiLOActiveHealthSystem.v2_5_0.HpeiLOActiveHealthSystem

Parameters:

iLOAmplifierManagesCount (integer)

Number of iLOs that this Amplifier instance manages.

iLOAmplifierName (string)

Name of the iLO Amplifier instance that manages this iLO.

HpeiLOActiveHealthSystem.LogMilestone Member of HpeiLOActiveHealthSystem.v2_5_0.HpeiLOActiveHealthSystem

Parameters:

MilestoneDescription (string)

Description of milestone.

MilestoneOrigin (string)

Origin of milestone.

HpeiLOBackupFile.v1_0_0.HpeiLOBackupFile

@odata.type: "#HpeiLOBackupFile.v1_0_0.HpeiLOBackupFile"

The HpeiLOBackupFile resource describes the properties for managing BMC backup files.

Resource Instances

Uri HTTP Allow
/redfish/v1/managers/{item}/backuprestoreservice/backupfiles/{item} GET POST DELETE

Created

Member of HpeiLOBackupFile.v1_0_0.HpeiLOBackupFile
Description ISO-time of backup file creation (by whomever created this thing)
Type string
Read Only True
Added iLO 5 1.40
Format date-time

FileSize

Member of HpeiLOBackupFile.v1_0_0.HpeiLOBackupFile
Description Size of backup file.
Type integer or null
Read Only True
Added iLO 5 1.40

FirmwareVersion

Member of HpeiLOBackupFile.v1_0_0.HpeiLOBackupFile
Description iLO firmware version running when this backup file was created.
Type string or null
Read Only True
Added iLO 5 1.40

Actions

HpeiLOBackupFile.Restore Member of HpeiLOBackupFile.v1_0_0.HpeiLOBackupFile There are no parameters for this action.

HpeiLOBackupFileCollection.HpeiLOBackupFileCollection

@odata.type: "#HpeiLOBackupFileCollection.HpeiLOBackupFileCollection"

A Collection of HpeiLOBackupFile resource instances.

Resource Instances

Uri HTTP Allow
/redfish/v1/managers/{item}/backuprestoreservice/backupfiles GET POST
Link Name Destination type
Members[] HpeiLOBackupFile

Members (array)

Member of HpeiLOBackupFileCollection.HpeiLOBackupFileCollection Members is an array containing elements of:

Members[{item}].@odata.id Member of HpeiLOBackupFileCollection.HpeiLOBackupFileCollection
Type string
Read Only True
Format uri-reference

Members@odata.count

Member of HpeiLOBackupFileCollection.HpeiLOBackupFileCollection
Description The total number of collection members.
Type integer
Read Only True

Oem.Hpe.BackupFileCount

Member of HpeiLOBackupFileCollection.HpeiLOBackupFileCollection
Description The number of backup files reported.
Type integer or null
Read Only True
Added iLO 5 1.40

Oem.Hpe.BackupFilesAllowed

Member of HpeiLOBackupFileCollection.HpeiLOBackupFileCollection
Description The number of backup files supported.
Type integer or null
Read Only True
Added iLO 5 1.40

HpeiLOBackupRestoreService.v2_2_0.HpeiLOBackupRestoreService

@odata.type: "#HpeiLOBackupRestoreService.v2_2_0.HpeiLOBackupRestoreService"

The HpeiLOBackupRestoreService resource describes the properties for using the BMC backup and restore features.

Resource Instances

Uri HTTP Allow
/redfish/v1/managers/{item}/backuprestoreservice GET PATCH

BackupFileLocation

Member of HpeiLOBackupRestoreService.v2_2_0.HpeiLOBackupRestoreService
Description The URI to which a client may POST to create and download a file for a subsequent restore operation.
Type string
Read Only True
Added iLO 5 1.15
Format uri-reference

BackupFiles

Link to backup files. BackupFiles is a link ("@odata.id": URI) to another resource.

CustomBackupandRestore

Member of HpeiLOBackupRestoreService.v2_2_0.HpeiLOBackupRestoreService
Description This property indicates whether a custom backup and restore is enabled.
Type boolean
Read Only False

HttpPushUri

Member of HpeiLOBackupRestoreService.v2_2_0.HpeiLOBackupRestoreService
Description The URI to which a client may POST a file for a subsequent restore operation.
Type string
Read Only True
Added iLO 5 1.15
Format uri-reference

HpeiLODateTime.v2_0_0.HpeiLODateTime

@odata.type: "#HpeiLODateTime.v2_0_0.HpeiLODateTime"

The HpeiLODateTime resource describes the properties for managing the BMC data and time.

Resource Instances

Uri HTTP Allow
/redfish/v1/managers/{item}/datetime GET PATCH
Link Name Destination type
Links/EthernetNICs Collection of EthernetInterface

ConfigurationSettings

Member of HpeiLODateTime.v2_0_0.HpeiLODateTime
Description The state of the currently displayed configuration settings.
Type string
Read Only True
Added iLO 5 1.10

The following are the supported values:

Value
Current
SomePendingReset

DateTime

Member of HpeiLODateTime.v2_0_0.HpeiLODateTime
Description The date and time used by management processor.
Type string
Read Only True
Added iLO 5 1.10
Format date-time

NTPServers (array)

Member of HpeiLODateTime.v2_0_0.HpeiLODateTime NTPServers is an array containing elements of:
Description The current NTP server’s IPv4 address, IPv6 address, or FQDN. The value either comes from DHCP or is static depending on the DHCP settings.
Type string or null
Read Only True

PropagateTimeToHost

Member of HpeiLODateTime.v2_0_0.HpeiLODateTime
Description Determines whether the server time is synchronized with the management processor time during the first POST after AC power is applied.
Type boolean
Read Only False
Added iLO 5 1.10

StaticNTPServers (array)

Member of HpeiLODateTime.v2_0_0.HpeiLODateTime StaticNTPServers is an array containing elements of:
Description The static NTP server’s IPv4 address, IPv6 address, or FQDN. To set this property, management processor must not be configured to use NTP servers provided by DHCPv4 or DHCPv6.
Type string
Read Only True

TimeZone

TimeZone.Index Member of HpeiLODateTime.v2_0_0.HpeiLODateTime
Description The index of the current time zone. To set a new time zone, specify a different time zone index. This property can be set only when DHCPv4 or DHCPv6 supplied time settings are disabled. Since the time zone list might vary from one firmware version to another (which often leads to differences in time zone indices), setting the time zone by name is recommended over setting by index, for better compatibility.
Type number
Read Only False
Added iLO 5 1.10

TimeZone.UtcOffset Member of HpeiLODateTime.v2_0_0.HpeiLODateTime
Description The UTC offset of the current time zone, in the format {+/-}hh:mm
Type string
Read Only True
Added iLO 5 1.10

TimeZone.Value Member of HpeiLODateTime.v2_0_0.HpeiLODateTime
Description The environment variable value.
Type string
Read Only True
Added iLO 5 1.10

TimeZoneList (array)

Member of HpeiLODateTime.v2_0_0.HpeiLODateTime TimeZoneList is an array containing elements of:

TimeZoneList[{item}].Index Member of HpeiLODateTime.v2_0_0.HpeiLODateTime
Description The time zone index.
Type number
Read Only True
Added iLO 5 1.10

TimeZoneList[{item}].UtcOffset Member of HpeiLODateTime.v2_0_0.HpeiLODateTime
Description The UTC offset of the time zone, in the format {+/-}hh:mm
Type string
Read Only True
Added iLO 5 1.10

TimeZoneList[{item}].Value Member of HpeiLODateTime.v2_0_0.HpeiLODateTime
Description The environment variable value.
Type string
Read Only True
Added iLO 5 1.10

HpeiLOEmbeddedMedia.v2_0_0.HpeiLOEmbeddedMedia

@odata.type: "#HpeiLOEmbeddedMedia.v2_0_0.HpeiLOEmbeddedMedia"

The HpeiLOEmbeddedMedia resource describes the properties for the embedded media.

Resource Instances

Uri HTTP Allow
/redfish/v1/managers/{item}/embeddedmedia GET

Controller

Controller.Firmware Controller.Firmware.Current Controller.Firmware.Current.VersionString Member of HpeiLOEmbeddedMedia.v2_0_0.HpeiLOEmbeddedMedia
Description The current version of the embedded media controller.
Type string
Read Only True
Added iLO 5 1.10

Controller.Status Member of HpeiLOEmbeddedMedia.v2_0_0.HpeiLOEmbeddedMedia See the Redfish standard schema and specification for information on common Status object.

SDCard

SDCard.SizeMB Member of HpeiLOEmbeddedMedia.v2_0_0.HpeiLOEmbeddedMedia
Description The size of the SD card present in the server, in MB.
Type integer
Read Only True
Added iLO 5 1.10

SDCard.Status Member of HpeiLOEmbeddedMedia.v2_0_0.HpeiLOEmbeddedMedia See the Redfish standard schema and specification for information on common Status object.

HpeiLOFederatedGroupCapping.v2_0_0.HpeiLOFederatedGroupCapping

@odata.type: "#HpeiLOFederatedGroupCapping.v2_0_0.HpeiLOFederatedGroupCapping"

The HpeiLOFederatedGroupCapping resource describes the properties for managing Federated Group Capping.

Resource Instances

Uri HTTP Allow
/redfish/v1/chassis/{item}/power/federatedgroupcapping GET PATCH

CapWatts

Member of HpeiLOFederatedGroupCapping.v2_0_0.HpeiLOFederatedGroupCapping
Description The configured power cap for all servers in a group. This value is 0 if the power cap is not configured.
Type integer
Read Only True
Added iLO 5 1.10

CapacityWatts

Member of HpeiLOFederatedGroupCapping.v2_0_0.HpeiLOFederatedGroupCapping
Description The total power supply capacity for all servers in a group.
Type integer
Read Only True
Added iLO 5 1.10

Groups

Throttle

Member of HpeiLOFederatedGroupCapping.v2_0_0.HpeiLOFederatedGroupCapping
Description High, Med, or Low based on the percentage of power usage.
Type string
Read Only True
Added iLO 5 1.10

HpeiLOFederationGroup.v2_0_0.HpeiLOFederationGroup

@odata.type: "#HpeiLOFederationGroup.v2_0_0.HpeiLOFederationGroup"

The HpeiLOFederationGroup resource describes the properties for managing Federation groups.

Resource Instances

Uri HTTP Allow
/redfish/v1/managers/{item}/federationgroups/{item} GET PATCH DELETE

Key

Member of HpeiLOFederationGroup.v2_0_0.HpeiLOFederationGroup
Description The password used by the Federation Group.
Type string or null
Read Only False

Privileges

Privileges.HostBIOSConfigPriv Member of HpeiLOFederationGroup.v2_0_0.HpeiLOFederationGroup
Description Host BIOS configuration privileges.
Type boolean
Read Only False
Added iLO 5 1.10

Privileges.HostNICConfigPriv Member of HpeiLOFederationGroup.v2_0_0.HpeiLOFederationGroup
Description Host NIC configuration privileges.
Type boolean
Read Only False
Added iLO 5 1.10

Privileges.HostStorageConfigPriv Member of HpeiLOFederationGroup.v2_0_0.HpeiLOFederationGroup
Description Host Storage configuration privileges.
Type boolean
Read Only False
Added iLO 5 1.10

Privileges.LoginPriv Member of HpeiLOFederationGroup.v2_0_0.HpeiLOFederationGroup
Description Login privileges.
Type boolean
Read Only False
Added iLO 5 1.10

Privileges.RemoteConsolePriv Member of HpeiLOFederationGroup.v2_0_0.HpeiLOFederationGroup
Description Remote console privileges.
Type boolean
Read Only False
Added iLO 5 1.10

Privileges.SystemRecoveryConfigPriv Member of HpeiLOFederationGroup.v2_0_0.HpeiLOFederationGroup
Description System Recovery configuration privileges.
Type boolean
Read Only False
Added iLO 5 1.10

Privileges.UserConfigPriv Member of HpeiLOFederationGroup.v2_0_0.HpeiLOFederationGroup
Description User configuration privileges.
Type boolean
Read Only False
Added iLO 5 1.10

Privileges.VirtualMediaPriv Member of HpeiLOFederationGroup.v2_0_0.HpeiLOFederationGroup
Description Virtual media privileges.
Type boolean
Read Only False
Added iLO 5 1.10

Privileges.VirtualPowerAndResetPriv Member of HpeiLOFederationGroup.v2_0_0.HpeiLOFederationGroup
Description Virtual power and reset privileges.
Type boolean
Read Only False
Added iLO 5 1.10

Privileges.iLOConfigPriv Member of HpeiLOFederationGroup.v2_0_0.HpeiLOFederationGroup
Description The management processor configuration privileges.
Type boolean
Read Only False
Added iLO 5 1.10

HpeiLOFederationGroupCollection.HpeiLOFederationGroupCollection

@odata.type: "#HpeiLOFederationGroupCollection.HpeiLOFederationGroupCollection"

A Collection of HpeiLOFederationGroup resource instances.

Resource Instances

Uri HTTP Allow
/redfish/v1/managers/{item}/federationgroups GET POST
Link Name Destination type
Members[] HpeiLOFederationGroup

Members (array)

Member of HpeiLOFederationGroupCollection.HpeiLOFederationGroupCollection Members is an array containing elements of:

Members[{item}].@odata.id Member of HpeiLOFederationGroupCollection.HpeiLOFederationGroupCollection
Type string
Read Only True
Format uri-reference

Members@odata.count

Member of HpeiLOFederationGroupCollection.HpeiLOFederationGroupCollection
Description The total number of collection members.
Type integer
Read Only True

HpeiLOFederationPeers.v2_0_0.HpeiLOFederationPeers

@odata.type: "#HpeiLOFederationPeers.v2_0_0.HpeiLOFederationPeers"

The HpeiLOFederationPeers resource describes the properties for viewing Federation peers.

Resource Instances

Uri HTTP Allow
/redfish/v1/managers/{item}/federationpeers/{item} GET

Peers (array)

Member of HpeiLOFederationPeers.v2_0_0.HpeiLOFederationPeers Peers is an array containing elements of:

Peers[{item}].HttpErrorCode Member of HpeiLOFederationPeers.v2_0_0.HpeiLOFederationPeers
Description Error code for success or failure.
Type integer
Read Only True
Added iLO 5 1.10

Peers[{item}].ManagerIPAddress Member of HpeiLOFederationPeers.v2_0_0.HpeiLOFederationPeers
Description Manager IP address of the federation peer.
Type string
Read Only True
Added iLO 5 1.10

Peers[{item}].Time Member of HpeiLOFederationPeers.v2_0_0.HpeiLOFederationPeers
Description Time when the federation peer was added.
Type string
Read Only True
Added iLO 5 1.10
Format date-time

Peers[{item}].URL Member of HpeiLOFederationPeers.v2_0_0.HpeiLOFederationPeers
Description URL of the federation peer.
Type string
Read Only True
Added iLO 5 1.10
Format url

Peers[{item}].UUID Member of HpeiLOFederationPeers.v2_0_0.HpeiLOFederationPeers
Description UUID peers that are part of the federation group.
Type string
Read Only True
Added iLO 5 1.10

HpeiLOFederationPeersCollection.HpeiLOFederationPeersCollection

@odata.type: "#HpeiLOFederationPeersCollection.HpeiLOFederationPeersCollection"

A Collection of HpeiLOFederationPeers resource instances.

Resource Instances

Uri HTTP Allow
/redfish/v1/managers/{item}/federationpeers GET
Link Name Destination type
Members[] HpeiLOFederationPeers

Members (array)

Member of HpeiLOFederationPeersCollection.HpeiLOFederationPeersCollection Members is an array containing elements of:

Members[{item}].@odata.id Member of HpeiLOFederationPeersCollection.HpeiLOFederationPeersCollection
Type string
Read Only True
Format uri-reference

Members@odata.count

Member of HpeiLOFederationPeersCollection.HpeiLOFederationPeersCollection
Description The total number of collection members.
Type integer
Read Only True

HpeiLOFrus.v2_0_0.HpeiLOFrus

@odata.type: "#HpeiLOFrus.v2_0_0.HpeiLOFrus"

The HpeiLOFrus resource describes features of add-in adapters.

Resource Instances

Uri HTTP Allow
/redfish/v1/chassis/{item}/basefrus/{item} GET
/redfish/v1/chassis/{item}/basefrus/{item}/details GET
/redfish/v1/chassis/{item}/mezzfrus/{item} GET
/redfish/v1/chassis/{item}/mezzfrus/{item}/details GET

FRU

Member of HpeiLOFrus.v2_0_0.HpeiLOFrus
Description The typename this FRU describes.
Type string
Read Only True
Added iLO 5 1.10

Member of HpeiLOFrus.v2_0_0.HpeiLOFrus
Description The aggregation of the Link signals for all ports on the FRU card.
Type boolean
Read Only True
Added iLO 5 1.10

FRUType

Member of HpeiLOFrus.v2_0_0.HpeiLOFrus
Description The type of FRU that is installed, i.e. Base or Mezzanine FRU.
Type string
Read Only True
Added iLO 5 1.10

The following are the supported values:

Value
Base
Mezzanine

Interlocked

Member of HpeiLOFrus.v2_0_0.HpeiLOFrus
Description Indicates if a PCIe card is installed in slot.
Type boolean
Read Only True
Added iLO 5 1.10

Location

Member of HpeiLOFrus.v2_0_0.HpeiLOFrus
Description The location where the FRU resides.
Type string
Read Only True
Added iLO 5 1.10

PGood

Member of HpeiLOFrus.v2_0_0.HpeiLOFrus
Description The Power Good status.
Type boolean
Read Only True
Added iLO 5 1.10

PhysicalSlot

Member of HpeiLOFrus.v2_0_0.HpeiLOFrus
Description The physical slot in which this FRU resides. 0 is for Base FRU, 1-N is for Mezzanine FRUs
Type integer
Read Only True
Added iLO 5 1.10

Seated

Member of HpeiLOFrus.v2_0_0.HpeiLOFrus
Description Indicates if the Base FRU is properly seated in the slot.
Type boolean
Read Only True
Added iLO 5 1.10

SerialNumber

Member of HpeiLOFrus.v2_0_0.HpeiLOFrus
Description The system’s serial number.
Type string
Read Only True
Added iLO 5 1.10

UEFIDeviceName

Member of HpeiLOFrus.v2_0_0.HpeiLOFrus
Description The Device Name in UTF-8 format.
Type string
Read Only True
Added iLO 5 1.10

UEFIDevicePaths (array)

Member of HpeiLOFrus.v2_0_0.HpeiLOFrus UEFIDevicePaths is an array containing elements of:
Type string
Read Only True

HpeiLOFrusCollection.HpeiLOFrusCollection

@odata.type: "#HpeiLOFrusCollection.HpeiLOFrusCollection"

A Collection of HpeiLOFrus resource instances.

Resource Instances

Uri HTTP Allow
/redfish/v1/chassis/{item}/basefrus GET
/redfish/v1/chassis/{item}/mezzfrus GET
Link Name Destination type
Members[] HpeiLOFrus

Members (array)

Member of HpeiLOFrusCollection.HpeiLOFrusCollection Members is an array containing elements of:

Members[{item}].@odata.id Member of HpeiLOFrusCollection.HpeiLOFrusCollection
Type string
Read Only True
Format uri-reference

Members@odata.count

Member of HpeiLOFrusCollection.HpeiLOFrusCollection
Description The total number of collection members.
Type integer
Read Only True

HpeiLOLicense.v2_3_0.HpeiLOLicense

@odata.type: "#HpeiLOLicense.v2_3_0.HpeiLOLicense"

The HpeiLOLicense resource describes the properties for managing BMC licenses.

Resource Instances

Uri HTTP Allow
/redfish/v1/managers/{item}/licenseservice/{item} GET DELETE

Confirmation

Confirmation.Code Member of HpeiLOLicense.v2_3_0.HpeiLOLicense
Description Confirmation service response code.
Type string
Read Only True
Added iLO 5 1.10

Confirmation.Message Member of HpeiLOLicense.v2_3_0.HpeiLOLicense
Description User-friendly confirmation information for the current managment processor license.
Type string
Read Only True
Added iLO 5 1.10

Confirmation.Service Member of HpeiLOLicense.v2_3_0.HpeiLOLicense
Description Confirmation service URI.
Type string
Read Only True
Added iLO 5 1.10

Confirmation.Status Member of HpeiLOLicense.v2_3_0.HpeiLOLicense See the Redfish standard schema and specification for information on common Status object.

ConfirmationRequest

ConfirmationRequest.EON ConfirmationRequest.EON.License Member of HpeiLOLicense.v2_3_0.HpeiLOLicense
Description The current license of this management processor.
Type string
Read Only True
Added iLO 5 1.10

ConfirmationRequest.EON.LicenseKey Member of HpeiLOLicense.v2_3_0.HpeiLOLicense
Description The license key installed on this management processor.
Type string
Read Only True
Added iLO 5 1.10

ConfirmationRequest.EON.Quantity Member of HpeiLOLicense.v2_3_0.HpeiLOLicense
Description The number of entitlements licensed.
Type integer
Read Only True
Added iLO 5 1.10

ConfirmationRequest.EON.State Member of HpeiLOLicense.v2_3_0.HpeiLOLicense
Description The current licensing state and behavior of the management processor. This is affected by license installation, activation and confirmation.
Type string
Read Only True
Added iLO 5 1.10

The following are the supported values:

Value Description
unlicensed standard baseline functionality
evaluation evaluation / demonstration temporary licensed functionality
nfr not for resale experimental functionality
expired standard baseline functionality and evaluation licenses no longer accepted
unconfirmed licensed functionality that has not been confirmed
timeout licensed functionality is disabled until the license is confirmed
confirmed licensed functionality has been confirmed for use
static system has active built-in licensed functionality that does not require confirmation
err error

ConfirmationRequest.Signer Member of HpeiLOLicense.v2_3_0.HpeiLOLicense
Description Source of confirmation request.
Type string
Read Only True
Added iLO 5 1.10

ConfirmationRequest.System ConfirmationRequest.System.ChipId Member of HpeiLOLicense.v2_3_0.HpeiLOLicense
Description Management processor unique chip identifier.
Type string
Read Only True
Added iLO 5 1.10

ConfirmationRequest.System.Product Member of HpeiLOLicense.v2_3_0.HpeiLOLicense
Description System housing management processor.
Type string
Read Only True
Added iLO 5 1.10

ConfirmationRequest.System.SerialNumber Member of HpeiLOLicense.v2_3_0.HpeiLOLicense
Description System serial number.
Type string
Read Only True
Added iLO 5 1.10

License

Member of HpeiLOLicense.v2_3_0.HpeiLOLicense
Description The current license of this management processor.
Type string
Read Only True
Added iLO 5 1.10

LicenseClass

Member of HpeiLOLicense.v2_3_0.HpeiLOLicense
Description The class of current license on this management processor.
Type string or null
Read Only True
Added iLO 5 1.20

The following are the supported values:

Value
FQL
BETA
EVALUATION
AKA
DL
FFQL
SL
SITE
EVAL
MLA

LicenseErr

Member of HpeiLOLicense.v2_3_0.HpeiLOLicense
Description Error information from the most recent attempt to alter the installed management processor license.
Type string
Read Only True
Added iLO 5 1.10

LicenseExpire

Member of HpeiLOLicense.v2_3_0.HpeiLOLicense
Description User-friendly expiration information of the installed management processor license. For example, for demo license, Evaluation period 2 months 5 days 6 hours remain.
Type string
Read Only True
Added iLO 5 1.10

LicenseFeatures

LicenseFeatures.AutoCertEnroll Member of HpeiLOLicense.v2_3_0.HpeiLOLicense
Description Automatic Certificate Enrollment.
Type boolean
Read Only True

LicenseFeatures.DirectoryAuth Member of HpeiLOLicense.v2_3_0.HpeiLOLicense
Description Directory integrated authentication.
Type boolean
Read Only True
Added iLO 5 1.10

LicenseFeatures.DowngradePolicy Member of HpeiLOLicense.v2_3_0.HpeiLOLicense
Description Firmware downgrade policy setting.
Type boolean
Read Only True
Added iLO 5 1.40

LicenseFeatures.EmailAlert Member of HpeiLOLicense.v2_3_0.HpeiLOLicense
Description Email based alerting.
Type boolean
Read Only True
Added iLO 5 1.10

LicenseFeatures.FWScan Member of HpeiLOLicense.v2_3_0.HpeiLOLicense
Description Runtime FW Integrity check.
Type boolean
Read Only True
Added iLO 5 1.10

LicenseFeatures.Federation Member of HpeiLOLicense.v2_3_0.HpeiLOLicense
Description Distributed peer to peer management.
Type boolean
Read Only True
Added iLO 5 1.10

LicenseFeatures.Jitter Member of HpeiLOLicense.v2_3_0.HpeiLOLicense
Description Jitter Control.
Type boolean
Read Only True
Added iLO 5 1.10

LicenseFeatures.KD Member of HpeiLOLicense.v2_3_0.HpeiLOLicense
Description Kernel Debugging (VSP raw mode).
Type boolean
Read Only True
Added iLO 5 1.10

LicenseFeatures.KeyMgr Member of HpeiLOLicense.v2_3_0.HpeiLOLicense
Description Store and retrieve keys from an external key manager.
Type boolean
Read Only True
Added iLO 5 1.10

LicenseFeatures.MURC Member of HpeiLOLicense.v2_3_0.HpeiLOLicense
Description Shared Multi-User Remote Console.
Type boolean
Read Only True
Added iLO 5 1.10

LicenseFeatures.ODIM Member of HpeiLOLicense.v2_3_0.HpeiLOLicense
Description Open Distributed Infrastructure Management.
Type boolean
Read Only True

LicenseFeatures.PowerReg Member of HpeiLOLicense.v2_3_0.HpeiLOLicense
Description Power Regulator.
Type boolean
Read Only True
Added iLO 5 1.10

LicenseFeatures.RC Member of HpeiLOLicense.v2_3_0.HpeiLOLicense
Description Graphical Remote Console.
Type boolean
Read Only True
Added iLO 5 1.10

LicenseFeatures.Recovery Member of HpeiLOLicense.v2_3_0.HpeiLOLicense
Description OS Recovery Event.
Type boolean
Read Only True
Added iLO 5 1.17

LicenseFeatures.RemoteSyslog Member of HpeiLOLicense.v2_3_0.HpeiLOLicense
Description Remote Syslog.
Type boolean
Read Only True
Added iLO 5 1.10

LicenseFeatures.Scrncap Member of HpeiLOLicense.v2_3_0.HpeiLOLicense
Description Video Capture.
Type boolean
Read Only True
Added iLO 5 1.10

LicenseFeatures.SecureErase Member of HpeiLOLicense.v2_3_0.HpeiLOLicense
Description Secure Erase of embedded media.
Type boolean
Read Only True
Added iLO 5 1.10

LicenseFeatures.SmartCard Member of HpeiLOLicense.v2_3_0.HpeiLOLicense
Description 2-Factor Authentication (Smart Card).
Type boolean
Read Only True
Added iLO 5 1.10

LicenseFeatures.SuiteB Member of HpeiLOLicense.v2_3_0.HpeiLOLicense
Description SuiteB/CNSA mode support.
Type boolean
Read Only True
Added iLO 5 1.10

LicenseFeatures.TextCons Member of HpeiLOLicense.v2_3_0.HpeiLOLicense
Description Text Console.
Type boolean
Read Only True
Added iLO 5 1.10

LicenseFeatures.VM Member of HpeiLOLicense.v2_3_0.HpeiLOLicense
Description Remote Console based Virtual Media.
Type boolean
Read Only True
Added iLO 5 1.10

LicenseFeatures.VMScript Member of HpeiLOLicense.v2_3_0.HpeiLOLicense
Description Scripted Virtual Media.
Type boolean
Read Only True
Added iLO 5 1.10

LicenseFeatures.VSPLogging Member of HpeiLOLicense.v2_3_0.HpeiLOLicense
Description Virtual Serial Port Logging and Playback.
Type boolean
Read Only True
Added iLO 5 1.10

LicenseInstallDate

Member of HpeiLOLicense.v2_3_0.HpeiLOLicense
Description User-friendly installation date information of the installed management processor license. For example, 19 May 2017
Type string
Read Only True
Added iLO 5 1.20

LicenseKey

Member of HpeiLOLicense.v2_3_0.HpeiLOLicense
Description User-visible license key installed on this management processor. License keys are 25 or 29 characters and contain letters, numbers and hypens. Use POST method to collection of membertype HpeiLOLicense to install / update the license.
Type string
Read Only True
Added iLO 5 1.10

LicenseSeats

Member of HpeiLOLicense.v2_3_0.HpeiLOLicense
Description The number of systems authorized to use this activation key.
Type integer
Read Only True

LicenseTier

Member of HpeiLOLicense.v2_3_0.HpeiLOLicense
Description The licensed feature-set of the management processor.
Type string
Read Only True
Added iLO 5 1.10

The following are the supported values:

Value
STD
BLSTD
ADV
BLADV
ESS
SCALEOUT
APSE

LicenseType

Member of HpeiLOLicense.v2_3_0.HpeiLOLicense
Description The type of current license activation on this management processor.
Type string
Read Only True
Added iLO 5 1.10

The following are the supported values:

Value
Unlicensed
Evaluation
Perpetual
Subscription
Internal
Duration
Expired

HpeiLOLicenseCollection.HpeiLOLicenseCollection

@odata.type: "#HpeiLOLicenseCollection.HpeiLOLicenseCollection"

A Collection of HpeiLOLicense resource instances.

Resource Instances

Uri HTTP Allow
/redfish/v1/managers/{item}/licenseservice GET POST
Link Name Destination type
Members[] HpeiLOLicense

Members (array)

Member of HpeiLOLicenseCollection.HpeiLOLicenseCollection Members is an array containing elements of:

Members[{item}].@odata.id Member of HpeiLOLicenseCollection.HpeiLOLicenseCollection
Type string
Read Only True
Format uri-reference

Members@odata.count

Member of HpeiLOLicenseCollection.HpeiLOLicenseCollection
Description The total number of collection members.
Type integer
Read Only True

HpeiLOResourceDirectory.v2_0_0.HpeiLOResourceDirectory

@odata.type: "#HpeiLOResourceDirectory.v2_0_0.HpeiLOResourceDirectory"

The HpeiLOResourceDirectory resource describes the resource directory. The resource directory is a selected set of resources and resource types for faster access to resources.

Resource Instances

Uri HTTP Allow
/redfish/v1/resourcedirectory GET

Instances (array)

Member of HpeiLOResourceDirectory.v2_0_0.HpeiLOResourceDirectory Instances is an array containing elements of:

Instances[{item}].@odata.id Member of HpeiLOResourceDirectory.v2_0_0.HpeiLOResourceDirectory
Type string
Read Only True
Format uri-reference

Instances[{item}].@odata.type Member of HpeiLOResourceDirectory.v2_0_0.HpeiLOResourceDirectory
Type string
Read Only True

Instances[{item}].ETag Member of HpeiLOResourceDirectory.v2_0_0.HpeiLOResourceDirectory
Description This is the last known etag of the resource. The property is omitted if not known.
Type string
Read Only True
Added iLO 5 1.10

Instances[{item}].HttpMethods (array) Member of HpeiLOResourceDirectory.v2_0_0.HpeiLOResourceDirectory HttpMethods is an array containing elements of:
Type string
Read Only True

The following are the supported values:

Value
GET
HEAD
POST
PUT
PATCH
DELETE

Instances[{item}].MemberType Member of HpeiLOResourceDirectory.v2_0_0.HpeiLOResourceDirectory
Description This property has the type of members for collection resources.
Type string
Read Only True
Added iLO 5 1.10

HpeiLOSecurityDashboard.v1_0_0.HpeiLOSecurityDashboard

@odata.type: "#HpeiLOSecurityDashboard.v1_0_0.HpeiLOSecurityDashboard"

The HpeiLOSecurityDashboard resource describes the BMC security dashboard.

Resource Instances

Uri HTTP Allow
/redfish/v1/managers/{item}/securityservice/securitydashboard GET
Link Name Destination type
SecurityParameters HpeiLOSecurityParam

OverallSecurityStatus

Member of HpeiLOSecurityDashboard.v1_0_0.HpeiLOSecurityDashboard
Type string
Read Only True
Added iLO 5 1.40

The following are the supported values:

Value Description
Ok The Overall security state of the system is OK.
Risk The Overall security state of the system is Risk.
Ignored The user has ignored (or suppressed) the risk on all the security parameters (whose Status value is Risk).

SecurityParameters

This property references a resource of type Collection with a MemberType of HpeiLOSecurityParam. SecurityParameters is a link ("@odata.id": URI) to another resource.

ServerConfigurationLockStatus

Member of HpeiLOSecurityDashboard.v1_0_0.HpeiLOSecurityDashboard
Type string
Read Only True
Added iLO 5 1.40

The following are the supported values:

Value Description
Enabled Server Configuration Lock is Enabled.
Disabled Server Configuration Lock is Disabled.

HpeiLOSecurityParam.v1_1_0.HpeiLOSecurityParam

@odata.type: "#HpeiLOSecurityParam.v1_1_0.HpeiLOSecurityParam"

The HpeiLOSecurityParam resource describes the properties for BMC security dashboard parameters.

Resource Instances

Uri HTTP Allow
/redfish/v1/managers/{item}/securityservice/securitydashboard/securityparams/{item} GET PATCH

Ignore

Member of HpeiLOSecurityParam.v1_1_0.HpeiLOSecurityParam
Description This indicates if the security status of the security parameter is set to ignored or not.
Type boolean or null
Read Only False
Added iLO 5 1.40

IgnoredBy

Member of HpeiLOSecurityParam.v1_1_0.HpeiLOSecurityParam
Description This represents the user who changed the value of Ignore.
Type string
Read Only True
Added iLO 5 1.40

IgnoredTime

Member of HpeiLOSecurityParam.v1_1_0.HpeiLOSecurityParam
Description This represents the time when the risk configuration was suppressed.
Type string
Read Only True
Added iLO 5 1.40

RecommendedAction

Member of HpeiLOSecurityParam.v1_1_0.HpeiLOSecurityParam
Description This represents the recommended action.
Type string
Read Only True
Added iLO 5 1.40

SecurityStatus

Member of HpeiLOSecurityParam.v1_1_0.HpeiLOSecurityParam
Description This represents if the status of the security parameter.
Type string
Read Only True
Added iLO 5 1.40

The following are the supported values:

Value Description
Risk This indicates a security issue associated with the security parameter.
Ok This indicates no security issue associated with the security parameter.

State

Member of HpeiLOSecurityParam.v1_1_0.HpeiLOSecurityParam
Description This represents the state or value of the security parameter.
Type string
Read Only True
Added iLO 5 1.40

The following are the supported values:

Value Description
On The state of the Security Parameter is On.
Off The state of the Security Parameter is Off.
Enabled The state of the Security Parameter is Enabled.
Disabled The state of the Security Parameter is Disabled.
Failed The status of the Security Parameter or the result of an operation represented by the Security Parameter is Failed.
Ok The status of the Security Parameter or the result of an operation represented by the Security Parameter is Ok.
Insufficient The value of the Security Parameter is Insufficient or less than the default value.
Repaired The state of the Security Parameter is Repaired.
True The state of the Security Parameter is True.
False The state of the Security Parameter is False.

HpeiLOSecurityParamCollection.HpeiLOSecurityParamCollection

@odata.type: "#HpeiLOSecurityParamCollection.HpeiLOSecurityParamCollection"

A Collection of HpeiLOSecurityParam resource instances.

Resource Instances

Uri HTTP Allow
/redfish/v1/managers/{item}/securityservice/securitydashboard/securityparams GET
Link Name Destination type
Members[] HpeiLOSecurityParam

Members (array)

Member of HpeiLOSecurityParamCollection.HpeiLOSecurityParamCollection Members is an array containing elements of:

Members[{item}].@odata.id Member of HpeiLOSecurityParamCollection.HpeiLOSecurityParamCollection
Type string
Read Only True
Format uri-reference

Members@odata.count

Member of HpeiLOSecurityParamCollection.HpeiLOSecurityParamCollection
Description The total number of collection members.
Type integer
Read Only True

HpeiLOSnmpService.v2_4_0.HpeiLOSnmpService

@odata.type: "#HpeiLOSnmpService.v2_4_0.HpeiLOSnmpService"

The HpeiLOSnmpService resource describes the properties for managing the SNMP configuration of the BMC.

Resource Instances

Uri HTTP Allow
/redfish/v1/managers/{item}/snmpservice GET POST PATCH
Link Name Destination type
SNMPAlertDestinations Collection of HpeSNMPAlertDestination
SNMPUsers Collection of HpeSNMPUser

AlertDestinationAssociations (array)

Member of HpeiLOSnmpService.v2_4_0.HpeiLOSnmpService AlertDestinationAssociations is an array containing elements of:

AlertDestinationAssociations[{item}].SNMPAlertProtocol Member of HpeiLOSnmpService.v2_4_0.HpeiLOSnmpService
Description Indicate the SNMP protocol associated with the AlertDestination.
Type string or null
Read Only False
Added iLO 5 1.20

The following are the supported values:

Value Description
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.
Null A value is temporarily unavailable

AlertDestinationAssociations[{item}].SecurityName Member of HpeiLOSnmpService.v2_4_0.HpeiLOSnmpService
Description Provides the SNMPv3 security name associated with the destination when SNMP alert protocol is SNMPv3 trap or inform.
Type string or null
Read Only False
Added iLO 5 1.20

AlertDestinations (array)

Member of HpeiLOSnmpService.v2_4_0.HpeiLOSnmpService AlertDestinations is an array containing elements of:
Type string or null
Read Only True

AlertsEnabled

Member of HpeiLOSnmpService.v2_4_0.HpeiLOSnmpService
Description The alert conditions that the management processor detects independently of the host operating system can be sent to specified SNMP alert destinations. Indicates if the SNMPv1 Trap or SNMPv3 Trap is enabled.
Type boolean
Read Only False
Added iLO 5 1.10

Contact

Member of HpeiLOSnmpService.v2_4_0.HpeiLOSnmpService
Description The string of up to 49 characters that specifies the system administrator or server owner. The string can include a name, email address, or phone number.
Type string or null
Read Only False
Added iLO 5 1.10

Location

Member of HpeiLOSnmpService.v2_4_0.HpeiLOSnmpService
Description The string of up to 49 characters that specifies the physical location of the server.
Type string or null
Read Only False
Added iLO 5 1.10

Oem.Hpe.SNMPColdStartTrapBroadcast

Member of HpeiLOSnmpService.v2_4_0.HpeiLOSnmpService
Description If set to true, the Cold Start Trap will be enabled. The Cold Start Trap is broadcast to a subnet broadcast address if there are no trap destinations configured in the SNMP Alert Destination(s) boxes.
Type boolean
Read Only False
Added iLO 5 1.10

PeriodicHSATrapConfig

Member of HpeiLOSnmpService.v2_4_0.HpeiLOSnmpService
Description If there are any component in health status array(HSA) Trap are in degraded or failed condition then HSA trap will be sent periodically till the component status becomes ok or fine condition. This setting is disabled by default.
Type string
Read Only False
Added iLO 5 1.20

The following are the supported values:

Value
Disabled
Daily
Weekly
Monthly

ReadCommunities (array)

Member of HpeiLOSnmpService.v2_4_0.HpeiLOSnmpService ReadCommunities is an array containing elements of:
Type string
Read Only True

Role

Member of HpeiLOSnmpService.v2_4_0.HpeiLOSnmpService
Description The string of up to 64 characters that describes the server role or function.
Type string or null
Read Only False
Added iLO 5 1.10

RoleDetail

Member of HpeiLOSnmpService.v2_4_0.HpeiLOSnmpService
Description The string of up to 512 characters that describes specific tasks that the server might perform.
Type string or null
Read Only False
Added iLO 5 1.10

SNMPAlertDestinations

SNMP Alert Destination details. SNMPAlertDestinations is a link ("@odata.id": URI) to another resource.

SNMPUsers

SNMPv3 User details. SNMPUsers is a link ("@odata.id": URI) to another resource.

SNMPv1Enabled

Member of HpeiLOSnmpService.v2_4_0.HpeiLOSnmpService
Description Indicates if the SNMPv1 Query or SNMPv1 Trap is enabled.
Type boolean
Read Only False

SNMPv1RequestsEnabled

Member of HpeiLOSnmpService.v2_4_0.HpeiLOSnmpService
Description Indicates if the SNMPv1 Query is enabled.
Type boolean
Read Only False

SNMPv1TrapEnabled

Member of HpeiLOSnmpService.v2_4_0.HpeiLOSnmpService
Description Indicates if the SNMPv1 Trap is enabled.
Type boolean
Read Only False

SNMPv1Traps

Member of HpeiLOSnmpService.v2_4_0.HpeiLOSnmpService
Description When enabled, SNMPv1 traps are sent to the remote management systems configured in the SNMP Alert Destination(s) boxes.
Type boolean
Read Only False
Added iLO 5 1.10

SNMPv3EngineID

Member of HpeiLOSnmpService.v2_4_0.HpeiLOSnmpService
Description The SNMPv3 Engine ID is the unique identifier of an SNMP engine that belongs to an SNMP agent entity. This value must be a hexadecimal string with an even number of 6 to 32 characters, excluding the first two characters, 0x (for example, 0x01020304abcdef).
Type string or null
Read Only False
Added iLO 5 1.10

SNMPv3InformRetryAttempt

Member of HpeiLOSnmpService.v2_4_0.HpeiLOSnmpService
Description Specifies the number of retries to be used in SNMPv3 inform.
Type integer
Read Only False
Added iLO 5 1.20

SNMPv3InformRetryIntervalSeconds

Member of HpeiLOSnmpService.v2_4_0.HpeiLOSnmpService
Description Specifies the interval in seconds between SNMPv3 inform retries.
Type integer
Read Only False
Added iLO 5 1.20

SNMPv3RequestsEnabled

Member of HpeiLOSnmpService.v2_4_0.HpeiLOSnmpService
Description Indicates if the SNMPv3 Query is enabled.
Type boolean
Read Only False

SNMPv3TrapEnabled

Member of HpeiLOSnmpService.v2_4_0.HpeiLOSnmpService
Description Indicates if the SNMPv3 Trap is enabled.
Type boolean
Read Only False

Status

Member of HpeiLOSnmpService.v2_4_0.HpeiLOSnmpService See the Redfish standard schema and specification for information on common Status object.

TrapCommunities (array)

Member of HpeiLOSnmpService.v2_4_0.HpeiLOSnmpService TrapCommunities is an array containing elements of:
Type string
Read Only True

TrapSourceHostname

Member of HpeiLOSnmpService.v2_4_0.HpeiLOSnmpService
Description Determines the host name that is used in the SNMP-defined sysName variable when the management processor generates SNMP traps.
Type string
Read Only False
Added iLO 5 1.10

The following are the supported values:

Value
Manager
System

Users (array)

Member of HpeiLOSnmpService.v2_4_0.HpeiLOSnmpService Users is an array containing elements of:

Users[{item}].AuthPassphrase Member of HpeiLOSnmpService.v2_4_0.HpeiLOSnmpService
Description Sets the passphrase to use for sign operations. Enter a value of 8 to 49 characters.
Type string or null
Read Only False
Added iLO 5 1.10

Users[{item}].AuthProtocol Member of HpeiLOSnmpService.v2_4_0.HpeiLOSnmpService
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. Select MD5 (Message Digest) or SHA (Secure Hash Algorithm).
Type string or null
Read Only False
Added iLO 5 1.10

The following are the supported values:

Value Description
MD5 Indicate Message Digest Algorithm.
SHA Indicate Secure Hash Algorithm.
SHA256 Indicate SHA256 Algorithm.
Null A value is temporarily unavailable

Users[{item}].PrivacyPassphrase Member of HpeiLOSnmpService.v2_4_0.HpeiLOSnmpService
Description Sets the passphrase to use for encrypt operations. Enter a value of 8 to 49 characters.
Type string or null
Read Only False
Added iLO 5 1.10

Users[{item}].PrivacyProtocol Member of HpeiLOSnmpService.v2_4_0.HpeiLOSnmpService
Description Sets the encryption algorithm to use for encoding the privacy passphrase. A portion of an SNMP message is encrypted before transmission. Select AES (Advanced Encryption Standard) or DES (Data Encryption Standard).
Type string or null
Read Only False
Added iLO 5 1.10

The following are the supported values:

Value Description
AES Indicate Advanced Encryption Standard Algorithm.
DES Indicate Data Encryption Standard Algorithm.
Null A value is temporarily unavailable

Users[{item}].SecurityName Member of HpeiLOSnmpService.v2_4_0.HpeiLOSnmpService
Description The user profile name. Enter an alphanumeric string of 1 to 32 characters.
Type string or null
Read Only False
Added iLO 5 1.10

Users[{item}].UserEngineID Member of HpeiLOSnmpService.v2_4_0.HpeiLOSnmpService
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).
Type string or null
Read Only False
Added iLO 5 1.20

Actions

HpeiLOSnmpService.SendSNMPTestAlert Member of HpeiLOSnmpService.v2_4_0.HpeiLOSnmpService There are no parameters for this action.

HpeiLOSSO.v2_0_0.HpeiLOSSO

@odata.type: "#HpeiLOSSO.v2_0_0.HpeiLOSSO"

The HpeiLOSSO resource describes the configuration of the HPE BMC single-sign-on trusted server feature.

Resource Instances

Uri HTTP Allow
/redfish/v1/managers/{item}/securityservice/sso GET POST PATCH

ManagerTrustedCertificates (array)

Member of HpeiLOSSO.v2_0_0.HpeiLOSSO ManagerTrustedCertificates is an array containing elements of:

ManagerTrustedCertificates[{item}].@odata.id Member of HpeiLOSSO.v2_0_0.HpeiLOSSO
Type string
Read Only True
Format uri-reference

ManagerTrustedCertificates[{item}].@odata.type Member of HpeiLOSSO.v2_0_0.HpeiLOSSO
Type string
Read Only True

ManagerTrustedCertificates[{item}].Certificate Member of HpeiLOSSO.v2_0_0.HpeiLOSSO
Description Contains PEM formatted X509 certificate (Base64 encoded).
Type string or null
Read Only True
Added iLO 5 1.10

ManagerTrustedCertificates[{item}].CertificateDetails ManagerTrustedCertificates[{item}].CertificateDetails.Issuer Member of HpeiLOSSO.v2_0_0.HpeiLOSSO
Description The Certificate Authority that issued the certificate.
Type string
Read Only True
Added iLO 5 1.10

ManagerTrustedCertificates[{item}].CertificateDetails.Subject Member of HpeiLOSSO.v2_0_0.HpeiLOSSO
Description The entity to which the certificate was issued.
Type string
Read Only True
Added iLO 5 1.10

ManagerTrustedCertificates[{item}].CertificateDetails.ValidNotAfter Member of HpeiLOSSO.v2_0_0.HpeiLOSSO
Description The date on which the certificate validity period ends.
Type string
Read Only True
Added iLO 5 1.10
Format date-time

ManagerTrustedCertificates[{item}].CertificateDetails.ValidNotBefore Member of HpeiLOSSO.v2_0_0.HpeiLOSSO
Description The date on which the certificate validity period begins.
Type string
Read Only True
Added iLO 5 1.10
Format date-time

ManagerTrustedCertificates[{item}].RecordType Member of HpeiLOSSO.v2_0_0.HpeiLOSSO
Description Specifies the type of SSO record imported.
Type string
Read Only true
Added iLO 5 1.15

The following are the supported values:

Value Description
Certificate It is a PEM formatted X509 certificate (Base64 encoded).
DNSName It is a DNS name or an IP address of the HPE SSO-compliant application.

ManagerTrustedCertificates[{item}].SerialNumber Member of HpeiLOSSO.v2_0_0.HpeiLOSSO
Description Contains the Serial number for the SSO records.
Type integer
Read Only True
Added iLO 5 1.10

ManagerTrustedCertificates[{item}].ServerName Member of HpeiLOSSO.v2_0_0.HpeiLOSSO
Description The Server name (or certificate subject).
Type string or null
Read Only True
Added iLO 5 1.10

ManagerTrustedCertificates[{item}].Status Member of HpeiLOSSO.v2_0_0.HpeiLOSSO See the Redfish standard schema and specification for information on common Status object.

SSOsettings

SSOsettings.AdminPrivilege SSOsettings.AdminPrivilege.HostBIOSConfigPriv Member of HpeiLOSSO.v2_0_0.HpeiLOSSO
Description Host BIOS Configuration Privileges.
Type boolean
Read Only False
Added iLO 5 1.10

SSOsettings.AdminPrivilege.HostNICConfigPriv Member of HpeiLOSSO.v2_0_0.HpeiLOSSO
Description Host NIC Configuration Privileges.
Type boolean
Read Only False
Added iLO 5 1.10

SSOsettings.AdminPrivilege.HostStorageConfigPriv Member of HpeiLOSSO.v2_0_0.HpeiLOSSO
Description Host Storage Configuration Privileges.
Type boolean
Read Only False
Added iLO 5 1.10

SSOsettings.AdminPrivilege.LoginPriv Member of HpeiLOSSO.v2_0_0.HpeiLOSSO
Description Login Privileges.
Type boolean
Read Only False
Added iLO 5 1.10

SSOsettings.AdminPrivilege.RemoteConsolePriv Member of HpeiLOSSO.v2_0_0.HpeiLOSSO
Description Remote Console Privileges.
Type boolean
Read Only False
Added iLO 5 1.10

SSOsettings.AdminPrivilege.SystemRecoveryConfigPriv Member of HpeiLOSSO.v2_0_0.HpeiLOSSO
Description System Recovery Configuration Privileges.
Type boolean
Read Only False
Added iLO 5 1.10

SSOsettings.AdminPrivilege.UserConfigPriv Member of HpeiLOSSO.v2_0_0.HpeiLOSSO
Description User Configuration Privileges.
Type boolean
Read Only False
Added iLO 5 1.10

SSOsettings.AdminPrivilege.VirtualMediaPriv Member of HpeiLOSSO.v2_0_0.HpeiLOSSO
Description Virtual Media Privileges.
Type boolean
Read Only False
Added iLO 5 1.10

SSOsettings.AdminPrivilege.VirtualPowerAndResetPriv Member of HpeiLOSSO.v2_0_0.HpeiLOSSO
Description Power and Reset Privileges.
Type boolean
Read Only False
Added iLO 5 1.10

SSOsettings.AdminPrivilege.iLOConfigPriv Member of HpeiLOSSO.v2_0_0.HpeiLOSSO
Description iLO Configuration Privileges.
Type boolean
Read Only False
Added iLO 5 1.10

SSOsettings.OperatorPrivilege SSOsettings.OperatorPrivilege.HostBIOSConfigPriv Member of HpeiLOSSO.v2_0_0.HpeiLOSSO
Description Host BIOS Configuration Privileges.
Type boolean
Read Only False
Added iLO 5 1.10

SSOsettings.OperatorPrivilege.HostNICConfigPriv Member of HpeiLOSSO.v2_0_0.HpeiLOSSO
Description Host NIC Configuration Privileges.
Type boolean
Read Only False
Added iLO 5 1.10

SSOsettings.OperatorPrivilege.HostStorageConfigPriv Member of HpeiLOSSO.v2_0_0.HpeiLOSSO
Description Host Storage Configuration Privileges.
Type boolean
Read Only False
Added iLO 5 1.10

SSOsettings.OperatorPrivilege.LoginPriv Member of HpeiLOSSO.v2_0_0.HpeiLOSSO
Description Login Privileges.
Type boolean
Read Only False
Added iLO 5 1.10

SSOsettings.OperatorPrivilege.RemoteConsolePriv Member of HpeiLOSSO.v2_0_0.HpeiLOSSO
Description Remote Console Privileges.
Type boolean
Read Only False
Added iLO 5 1.10

SSOsettings.OperatorPrivilege.SystemRecoveryConfigPriv Member of HpeiLOSSO.v2_0_0.HpeiLOSSO
Description System Recovery Configuration Privileges.
Type boolean
Read Only False
Added iLO 5 1.10

SSOsettings.OperatorPrivilege.UserConfigPriv Member of HpeiLOSSO.v2_0_0.HpeiLOSSO
Description User Configuration Privileges.
Type boolean
Read Only False
Added iLO 5 1.10

SSOsettings.OperatorPrivilege.VirtualMediaPriv Member of HpeiLOSSO.v2_0_0.HpeiLOSSO
Description Virtual Media Privileges.
Type boolean
Read Only False
Added iLO 5 1.10

SSOsettings.OperatorPrivilege.VirtualPowerAndResetPriv Member of HpeiLOSSO.v2_0_0.HpeiLOSSO
Description Power and Reset Privileges.
Type boolean
Read Only False
Added iLO 5 1.10

SSOsettings.OperatorPrivilege.iLOConfigPriv Member of HpeiLOSSO.v2_0_0.HpeiLOSSO
Description iLO Configuration Privileges.
Type boolean
Read Only False
Added iLO 5 1.10

SSOsettings.SSOTrustMode Member of HpeiLOSSO.v2_0_0.HpeiLOSSO
Description Represents the SSO Trust Mode.
Type string
Read Only False
Added iLO 5 1.10

The following are the supported values:

Value Description
TrustNone Rejects all SSO connection request.
TrustAll Accepts any SSO connection initiated from any HPE SSO compliant application.
TrustbyName Enables SSO connections from an HPE SSO compliant application by matching a directly imported IP address or DNS name.
TrustbyCert Enables SSO connections from an HPE SSO compliant application by matching a certificate previously imported to iLO.

SSOsettings.UserPrivilege SSOsettings.UserPrivilege.HostBIOSConfigPriv Member of HpeiLOSSO.v2_0_0.HpeiLOSSO
Description Host BIOS Configuration Privileges.
Type boolean
Read Only False
Added iLO 5 1.10

SSOsettings.UserPrivilege.HostNICConfigPriv Member of HpeiLOSSO.v2_0_0.HpeiLOSSO
Description Host NIC Configuration Privileges.
Type boolean
Read Only False
Added iLO 5 1.10

SSOsettings.UserPrivilege.HostStorageConfigPriv Member of HpeiLOSSO.v2_0_0.HpeiLOSSO
Description Host Storage Configuration Privileges.
Type boolean
Read Only False
Added iLO 5 1.10

SSOsettings.UserPrivilege.LoginPriv Member of HpeiLOSSO.v2_0_0.HpeiLOSSO
Description Login Privileges.
Type boolean
Read Only False
Added iLO 5 1.10

SSOsettings.UserPrivilege.RemoteConsolePriv Member of HpeiLOSSO.v2_0_0.HpeiLOSSO
Description Remote Console Privileges.
Type boolean
Read Only False
Added iLO 5 1.10

SSOsettings.UserPrivilege.SystemRecoveryConfigPriv Member of HpeiLOSSO.v2_0_0.HpeiLOSSO
Description System Recovery Configuration Privileges.
Type boolean
Read Only False
Added iLO 5 1.10

SSOsettings.UserPrivilege.UserConfigPriv Member of HpeiLOSSO.v2_0_0.HpeiLOSSO
Description User Configuration Privileges.
Type boolean
Read Only False
Added iLO 5 1.10

SSOsettings.UserPrivilege.VirtualMediaPriv Member of HpeiLOSSO.v2_0_0.HpeiLOSSO
Description Virtual Media Privileges.
Type boolean
Read Only False
Added iLO 5 1.10

SSOsettings.UserPrivilege.VirtualPowerAndResetPriv Member of HpeiLOSSO.v2_0_0.HpeiLOSSO
Description Power and Reset Privileges.
Type boolean
Read Only False
Added iLO 5 1.10

SSOsettings.UserPrivilege.iLOConfigPriv Member of HpeiLOSSO.v2_0_0.HpeiLOSSO
Description iLO Configuration Privileges.
Type boolean
Read Only False
Added iLO 5 1.10

Actions

HpeiLOSSO.DeleteAllSSORecords Member of HpeiLOSSO.v2_0_0.HpeiLOSSO Delete all the SSO records.

There are no parameters for this action.

HpeiLOSSO.DeleteSSORecordbyNumber Member of HpeiLOSSO.v2_0_0.HpeiLOSSO Delete SSO record by record number.

Parameters:

RecordNumber (integer)

Index of the SSO record to be deleted.

HpeiLOSSO.ImportCertificate Member of HpeiLOSSO.v2_0_0.HpeiLOSSO Import the HPE SSO Certificate.

Parameters:

CertInput (string)

PEM formatted X509 certificate (Base64 encoded)/DNS name or IP address to import the certificate.

CertType (string)

Specifies the type of certificate imported.

Value Description
DirectImportCert iLO directly imports the Certificate.
ImportCertUri iLO imports the certificate from the HPE SSO compliant application over the network.

HpeiLOSSO.ImportDNSName Member of HpeiLOSSO.v2_0_0.HpeiLOSSO Add DNS Name to the record list.

Parameters:

DNSName (string)

DNS Name of the HPE SSO Trusted Server.

HpeInvalidImage.v1_0_0.HpeInvalidImage

@odata.type: "#HpeInvalidImage.v1_0_0.HpeInvalidImage"

The HpeInvalidImage resource describes the properties of an invalid firmware image detected and preserved from a computer system.

Resource Instances

Uri HTTP Allow
/redfish/v1/updateservice/invalidimagerepository/{item} GET POST PATCH DELETE

Created

Member of HpeInvalidImage.v1_0_0.HpeInvalidImage
Description ISO 8601 time string indicating when this image was added to the NAND.
Type string
Read Only True
Added iLO 5 1.30
Format date-time

DeviceClass

Member of HpeInvalidImage.v1_0_0.HpeInvalidImage
Description Device type GUID from iLO secure flash header
Type string
Read Only True
Added iLO 5 1.30

Filename

Member of HpeInvalidImage.v1_0_0.HpeInvalidImage
Description The unique filename of the image.
Type string
Read Only True
Added iLO 5 1.30

Filepath

Member of HpeInvalidImage.v1_0_0.HpeInvalidImage
Description Path of file on the USB LUN if the repo is mounted as USB.
Type string
Read Only True
Added iLO 5 1.30

ImageUri

Member of HpeInvalidImage.v1_0_0.HpeInvalidImage
Description URI of the image binary.
Type string
Read Only True
Added iLO 5 1.30
Format uri-reference

SizeBytes

Member of HpeInvalidImage.v1_0_0.HpeInvalidImage
Description Size of the image file in bytes.
Type integer or null
Read Only True
Added iLO 5 1.30

HpeInvalidImageCollection.HpeInvalidImageCollection

@odata.type: "#HpeInvalidImageCollection.HpeInvalidImageCollection"

A Collection of HpeInvalidImage resource instances.

Resource Instances

Uri HTTP Allow
/redfish/v1/updateservice/invalidimagerepository GET POST
Link Name Destination type
Members[] HpeInvalidImage

Members (array)

Member of HpeInvalidImageCollection.HpeInvalidImageCollection Members is an array containing elements of:

Members[{item}].@odata.id Member of HpeInvalidImageCollection.HpeInvalidImageCollection
Type string
Read Only True
Format uri-reference

Members@odata.count

Member of HpeInvalidImageCollection.HpeInvalidImageCollection
Description The total number of collection members.
Type integer
Read Only True

HpeiSCSISoftwareInitiator.v2_0_0.HpeiSCSISoftwareInitiator

@odata.type: "#HpeiSCSISoftwareInitiator.v2_0_0.HpeiSCSISoftwareInitiator"

Resource Instances

Uri HTTP Allow
/redfish/v1/systems/{item}/bios/iscsi GET
/redfish/v1/systems/{item}/bios/iscsi/settings GET PATCH
Link Name Destination type
@Redfish.Settings/SettingsObject HpeiSCSISoftwareInitiator
Oem/Hpe/Links/BaseConfigs HpeBaseConfigs

@Redfish.Settings

Member of HpeiSCSISoftwareInitiator.v2_0_0.HpeiSCSISoftwareInitiator See the Redfish standard schema and specification for information on common @Redfish properties.

iSCSIInitiatorName

Member of HpeiSCSISoftwareInitiator.v2_0_0.HpeiSCSISoftwareInitiator
Description The worldwide unique iSCSI Qualified Name (IQN) of this iSCSI Initiator. Only IQN format is accepted. EUI format is not supported (for example, ‘iqn.1986-03.com.hp:init.sn-123456’).
Type string
Read Only True

iSCSINicSources (array)

Member of HpeiSCSISoftwareInitiator.v2_0_0.HpeiSCSISoftwareInitiator iSCSINicSources is an array containing elements of:
Description The BIOS Attribute that describes a NIC instance that can be used as a target for iSCSI configuration.
Type string
Read Only True

iSCSISources (array)

Member of HpeiSCSISoftwareInitiator.v2_0_0.HpeiSCSISoftwareInitiator iSCSISources is an array containing elements of:

iSCSISources[{item}].StructuredBootString Member of HpeiSCSISoftwareInitiator.v2_0_0.HpeiSCSISoftwareInitiator
Description Identifies this iSCSI option within the server.
Type string or null
Read Only True

iSCSISources[{item}].UEFIDevicePath Member of HpeiSCSISoftwareInitiator.v2_0_0.HpeiSCSISoftwareInitiator
Description Standardized text representation of the UEFI device path for this option, in UTF-8 format.
Type string or null
Read Only True

iSCSISources[{item}].iSCSIAttemptInstance Member of HpeiSCSISoftwareInitiator.v2_0_0.HpeiSCSISoftwareInitiator
Description Uniquely identifies this iSCSI attempt within iSCSISources array. If set to zero, all other properties in the boot option object are ignored (which will delete an existing boot attempt).
Type integer
Read Only True

iSCSISources[{item}].iSCSIAttemptName Member of HpeiSCSISoftwareInitiator.v2_0_0.HpeiSCSISoftwareInitiator
Description Human readable descriptive name for this iSCSI attempt configuration
Type string or null
Read Only True

iSCSISources[{item}].iSCSIAuthenticationMethod Member of HpeiSCSISoftwareInitiator.v2_0_0.HpeiSCSISoftwareInitiator
Description The iSCSI connection authentication method.
Type string
Read Only True

The following are the supported values:

Value Description
None No iSCSI connection security.
CHAP iSCSI connection is secured using Challenge Handshake Authentication Protocol (CHAP).

iSCSISources[{item}].iSCSIChapSecret Member of HpeiSCSISoftwareInitiator.v2_0_0.HpeiSCSISoftwareInitiator
Description The password needed for CHAP authentication. This is applicable only when the Authentication Method is set to CHAP, and the CHAP Type is set to Mutual.
Type string or null
Read Only True

iSCSISources[{item}].iSCSIChapType Member of HpeiSCSISoftwareInitiator.v2_0_0.HpeiSCSISoftwareInitiator
Description The CHAP authentication type. This is applicable only when the Authentication Method is set to CHAP.
Type string
Read Only True

The following are the supported values:

Value Description
OneWay The target will authenticate the initiator. .
Mutual both the initiator and target will authenticate each other.

iSCSISources[{item}].iSCSIChapUsername Member of HpeiSCSISoftwareInitiator.v2_0_0.HpeiSCSISoftwareInitiator
Description The user name needed for CHAP authentication. This is applicable only when the Authentication Method is set to CHAP.
Type string or null
Read Only True

iSCSISources[{item}].iSCSIConnectRetry Member of HpeiSCSISoftwareInitiator.v2_0_0.HpeiSCSISoftwareInitiator
Description The number of times to retry the iSCSI connection. Zero means no retries.
Type integer
Read Only True

iSCSISources[{item}].iSCSIConnectTimeoutMS Member of HpeiSCSISoftwareInitiator.v2_0_0.HpeiSCSISoftwareInitiator
Description The iSCSI connection timeout value in milliseconds.
Type integer
Read Only True

iSCSISources[{item}].iSCSIConnection Member of HpeiSCSISoftwareInitiator.v2_0_0.HpeiSCSISoftwareInitiator
Description Enables or Disables iSCSI mode for a selected iSCSI attempt.
Type string
Read Only True

The following are the supported values:

Value Description
Disabled Connecting to this iSCSI attempt is disabled.
Enabled Connecting to this iSCSI attempt is enabled.
EnabledMpio Connecting to this iSCSI attempt is enabled with MPIO (Multi Path I/O).

iSCSISources[{item}].iSCSIInitiatorGateway Member of HpeiSCSISoftwareInitiator.v2_0_0.HpeiSCSISoftwareInitiator
Description The gateway address of the iSCSI Initiator, if not configured via DHCP. The address must be an IPv4 or IPv6 address, depending on the IP Address Type.
Type string
Read Only True

iSCSISources[{item}].iSCSIInitiatorInfoViaDHCP Member of HpeiSCSISoftwareInitiator.v2_0_0.HpeiSCSISoftwareInitiator
Description If enabled, the iSCSI Initiator information is configured from DHCP. Otherwise, the iSCSI initiator information must be statically configured. When providing static values for the Initiator, ensure Target settings are also configured with static values.
Type boolean
Read Only True

iSCSISources[{item}].iSCSIInitiatorIpAddress Member of HpeiSCSISoftwareInitiator.v2_0_0.HpeiSCSISoftwareInitiator
Description The IP Address of the iSCSI Initiator, if not configured via DHCP. The Initiator IP Address is always auto-assigned if IP address type is IPv6. The address must be an IPv4 or IPv6 address, depending on the IP Address Type.
Type string
Read Only True

iSCSISources[{item}].iSCSIInitiatorNetmask Member of HpeiSCSISoftwareInitiator.v2_0_0.HpeiSCSISoftwareInitiator
Description The subnet mask of the iSCSI Initiator, if not configured via DHCP. The address must be an IPv4.
Type string
Read Only True

iSCSISources[{item}].iSCSIIpAddressType Member of HpeiSCSISoftwareInitiator.v2_0_0.HpeiSCSISoftwareInitiator
Description The iSCSI IP Address type. If set to Auto, IPv4 will be attempted first, followed by IPv6.
Type string
Read Only True

The following are the supported values:

Value Description
IPv4 The iSCSI IP address is configured in IPv4 format.
IPv6 The iSCSI IP address is configured in IPv6 format.
Auto The iSCSI IP address is configured in IPv4. If an issue occurs with IPv4, then the IPv6 configuration is used.

iSCSISources[{item}].iSCSILUN Member of HpeiSCSISoftwareInitiator.v2_0_0.HpeiSCSISoftwareInitiator
Description The iSCSI target Logical Unit Number (LUN), if not obtained from DHCP. This value must follow the SAM-2 spec. E.g. 0001-1234-5678-9ABC. If the digit number is less then 5 characters, a dash character is not required. E.g. 0001. If the lun number is 12345, input 1234-5
Type string
Read Only True

iSCSISources[{item}].iSCSINicSource Member of HpeiSCSISoftwareInitiator.v2_0_0.HpeiSCSISoftwareInitiator
Description A BIOS Attribute that describes this selected NIC instance. This must match one of the possible values listed in the iSCSINicSources array.
Type string or null
Read Only True

iSCSISources[{item}].iSCSIReverseChapSecret Member of HpeiSCSISoftwareInitiator.v2_0_0.HpeiSCSISoftwareInitiator
Description The password needed for reverse CHAP authentication (from the target to the initiator). This is applicable only when the Authentication Method is set to CHAP, and the CHAP Type is set to Mutual.
Type string or null
Read Only True

iSCSISources[{item}].iSCSIReverseChapUsername Member of HpeiSCSISoftwareInitiator.v2_0_0.HpeiSCSISoftwareInitiator
Description User Name for reverse CHAP authentication (from the target to the initiator). This is applicable only when the Authentication Method is set to CHAP, and the CHAP Type is set to Mutual.
Type string or null
Read Only True

iSCSISources[{item}].iSCSITargetInfoViaDHCP Member of HpeiSCSISoftwareInitiator.v2_0_0.HpeiSCSISoftwareInitiator
Description If enabled, the iSCSI target information are configured from DHCP. Otherwise, the iSCSI target information must be statically configured.
Type boolean
Read Only True

iSCSISources[{item}].iSCSITargetIpAddress Member of HpeiSCSISoftwareInitiator.v2_0_0.HpeiSCSISoftwareInitiator
Description The IP Address of the iSCSI Target, if not obtained from DHCP. The address must be an IPv4 or IPv6 address, depending on the IP Address Type.
Type string
Read Only True

iSCSISources[{item}].iSCSITargetName Member of HpeiSCSISoftwareInitiator.v2_0_0.HpeiSCSISoftwareInitiator
Description The worldwide unique iSCSI Qualified Name (IQN) of this iSCSI target. Only the IQN format is accepted. EUI format is not supported (for example, ‘iqn.1991-05.com.microsoft:iscsitarget-iscsidisk-target’).
Type string or null
Read Only True

iSCSISources[{item}].iSCSITargetTcpPort Member of HpeiSCSISoftwareInitiator.v2_0_0.HpeiSCSISoftwareInitiator
Description The iSCSI Target TCP Port number, if not obtained from DHCP.
Type integer
Read Only True

HpeKmsConfig.v1_0_0.HpeKmsConfig

@odata.type: "#HpeKmsConfig.v1_0_0.HpeKmsConfig"

The schema definition for Key Management Service configuration.

Resource Instances

Uri HTTP Allow
/redfish/v1/Systems/{item}/Bios/Kmsconfig/Settings GET PATCH
/redfish/v1/systems/{item}/bios/Kmsconfig GET
Link Name Destination type
@Redfish.Settings/SettingsObject HpeKmsConfig
Oem/Hpe/Links/BaseConfigs HpeBaseConfigs

@Redfish.Settings

Member of HpeKmsConfig.v1_0_0.HpeKmsConfig See the Redfish standard schema and specification for information on common @Redfish properties.

DeleteUnusedEncryptionKeys

Member of HpeKmsConfig.v1_0_0.HpeKmsConfig
Description Removes unused encryption keys.
Type string
Read Only False

The following are the supported values:

Value Description
Disabled Do not removed unused encryption keys.
Enabled Remove unused encryption keys.

EncryptableDevices (array)

Member of HpeKmsConfig.v1_0_0.HpeKmsConfig EncryptableDevices is an array containing elements of:

EncryptableDevices[{item}].DeviceName Member of HpeKmsConfig.v1_0_0.HpeKmsConfig
Description Name of the encryptable device.
Type string
Read Only True

EncryptableDevices[{item}].EncryptionAction Member of HpeKmsConfig.v1_0_0.HpeKmsConfig
Description Devices can take two types of action for encrypting namely, enable and disable. If user would like to modify the Passphrase, then User can opt to change encryption
Type string
Read Only False

The following are the supported values:

Value Description
Enable Enable Encryption for the device.
Disable Disable Encryption for the device.
Change Modify the Encryption Passphrase.
Unlock Unlock the Encrypted device.
Undefined Encryption action is Undefined.

EncryptableDevices[{item}].EncryptionPhrase Member of HpeKmsConfig.v1_0_0.HpeKmsConfig
Description Encryption Passphrase would show up if the device is encrypted and be modified as well.
Type string or null
Read Only False

EncryptableDevices[{item}].EncryptionStatus Member of HpeKmsConfig.v1_0_0.HpeKmsConfig
Description Encryption status of the device.
Type string
Read Only True

The following are the supported values:

Value Description
EncryptionStatusUnknown Device is encrypted, but Passphrase is unknown.
Encrypted Device is Encrypted.
Decrypted Device is Unencrypted.

EncryptableDevices[{item}].PassphraseType Member of HpeKmsConfig.v1_0_0.HpeKmsConfig
Description Passphrase can be either entered manually or auto generated
Type string
Read Only False

The following are the supported values:

Value Description
Auto Passphrase is generated from the system.
Manual Passphrase is entered manually.

KeyManagementType

Member of HpeKmsConfig.v1_0_0.HpeKmsConfig
Description Key Management Type.
Type string
Read Only False

The following are the supported values:

Value Description
Disabled Key Management is Disabled
Local Key Management Type is Local
Remote Key Management Type is Remote

OpalBlockSid

Member of HpeKmsConfig.v1_0_0.HpeKmsConfig
Description TCG Block SID.
Type string
Read Only False

The following are the supported values:

Value Description
Disabled Disable TCG Block SID feature.
Enabled Enable TCG Block SID feature.

HpeMaintenanceWindow.v1_0_1.HpeMaintenanceWindow

@odata.type: "#HpeMaintenanceWindow.v1_0_1.HpeMaintenanceWindow"

The HpeMaintenanceWindow resource describes the properties for managing the time window for a software or firmware update task or install set.

Resource Instances

Uri HTTP Allow
/redfish/v1/updateservice/maintenancewindows/{item} GET POST PATCH DELETE

Created

Member of HpeMaintenanceWindow.v1_0_1.HpeMaintenanceWindow
Description ISO-time of maintenance window creation (by whomever created this thing)
Type string
Read Only True
Added iLO 5 1.30
Format date-time

Expire

Member of HpeMaintenanceWindow.v1_0_1.HpeMaintenanceWindow
Description ISO 8601 Redfish-style time string after which we will automatically change state to Expired - null for no expire time
Type string
Read Only False
Added iLO 5 1.30
Format date-time

Modified

Member of HpeMaintenanceWindow.v1_0_1.HpeMaintenanceWindow
Description ISO-time of last maintenance window item update by updater (not client)
Type string
Read Only True
Added iLO 5 1.30
Format date-time

StartAfter

Member of HpeMaintenanceWindow.v1_0_1.HpeMaintenanceWindow
Description ISO 8601 Redfish-style time string of earliest execution.
Type string
Read Only False
Added iLO 5 1.30
Format date-time

HpeMaintenanceWindowCollection.HpeMaintenanceWindowCollection

@odata.type: "#HpeMaintenanceWindowCollection.HpeMaintenanceWindowCollection"

A Collection of HpeMaintenanceWindow resource instances.

Resource Instances

Uri HTTP Allow
/redfish/v1/updateservice/maintenancewindows GET POST
Link Name Destination type
Members[] HpeMaintenanceWindow

Members (array)

Member of HpeMaintenanceWindowCollection.HpeMaintenanceWindowCollection Members is an array containing elements of:

Members[{item}].@odata.id Member of HpeMaintenanceWindowCollection.HpeMaintenanceWindowCollection
Type string
Read Only True
Format uri-reference

Members@odata.count

Member of HpeMaintenanceWindowCollection.HpeMaintenanceWindowCollection
Description The total number of collection members.
Type integer
Read Only True

HpeNetworkPortEVB.v1_2_0.HpeNetworkPortEVB

@odata.type: "#HpeNetworkPortEVB.v1_2_0.HpeNetworkPortEVB"

Note: Deprecated, willl be removed in a future release. The HpeNetworkPortEVB resource describes the Hewlett Packard Enterprise property extensions for Network Ports Edge Virtual Bridging

Resource Instances

Uri HTTP Allow
/redfish/v1/chassis/{item}/networkadapters/{item}/networkports/{item}/hpeevb GET
/redfish/v1/systems/{item}/networkinterfaces/{item}/networkports/{item}/hpeevb GET

Receiving

Receiving.CdcpActive Member of HpeNetworkPortEVB.v1_2_0.HpeNetworkPortEVB
Description True if a currently active IEEE 802.1Qbg CDCP TLV has been received from the link partner.
Type boolean or null
Read Only True
Added iLO 5 1.20

Receiving.ChannelActive Member of HpeNetworkPortEVB.v1_2_0.HpeNetworkPortEVB
Description A currently unexpired HPE Channel Link Control or HPE Channel Description TLV has been received from the link partner.
Type boolean or null
Read Only True
Added iLO 5 1.20

Receiving.ChannelDescriptionLocalSequenceNumber Member of HpeNetworkPortEVB.v1_2_0.HpeNetworkPortEVB
Description The link partner’s HPE Channel Description sequence number that was last successfully received and processed.
Type integer or null
Read Only True
Added iLO 5 1.20

Receiving.ChannelDescriptionRemoteSequenceNumber Member of HpeNetworkPortEVB.v1_2_0.HpeNetworkPortEVB
Description The last HPE Channel Decsription sequence number sent on this link that was successfully received and processed by the link partner.
Type integer or null
Read Only True
Added iLO 5 1.20

Receiving.ChannelDescriptionSubtype Member of HpeNetworkPortEVB.v1_2_0.HpeNetworkPortEVB
Description The header subtype field of the last received HPE Channel Description TLV.
Type integer or null
Read Only True
Added iLO 5 1.20

Receiving.ChannelLinkControlLocalSequenceNumber Member of HpeNetworkPortEVB.v1_2_0.HpeNetworkPortEVB
Description The link partner’s HPE Channel Link Control sequence number that was last successfully received and processed.
Type integer or null
Read Only True
Added iLO 5 1.20

Receiving.ChannelLinkControlMCEnable Member of HpeNetworkPortEVB.v1_2_0.HpeNetworkPortEVB
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.
Type boolean or null
Read Only True
Added iLO 5 1.20

Receiving.ChannelLinkControlRemoteSequenceNumber Member of HpeNetworkPortEVB.v1_2_0.HpeNetworkPortEVB
Description The last HPE Channel Link control sequence number sent on this link that was successfully received and processed by the link partner.
Type integer or null
Read Only True
Added iLO 5 1.20

Receiving.ChannelLinkControlSubtype Member of HpeNetworkPortEVB.v1_2_0.HpeNetworkPortEVB
Description The header subtype field of the last received HPE Channel Link Control TLV.
Type integer or null
Read Only True
Added iLO 5 1.20

Receiving.Role Member of HpeNetworkPortEVB.v1_2_0.HpeNetworkPortEVB
Description The link partner’s IEEE 802.1Qbg operating role.
Type string or null
Read Only True
Added iLO 5 1.20

The following are the supported values:

Value Description
Null A value is temporarily unavailable
bridge Indicates the link partner is operating as a Bridge.
station Indicates the link partner is operating as a Station.

Receiving.SChannelAssignments (array) Member of HpeNetworkPortEVB.v1_2_0.HpeNetworkPortEVB SChannelAssignments is an array containing elements of:

SChannelAssignments[{item}].Scid Member of HpeNetworkPortEVB.v1_2_0.HpeNetworkPortEVB
Description SCID value for this S-Channel identifier pairreceived from the link partner on this port.
Type integer or null
Read Only True

SChannelAssignments[{item}].Svid Member of HpeNetworkPortEVB.v1_2_0.HpeNetworkPortEVB
Description SVID assignment value for this S-Channel identifier pair received from the link partner on this port. When 0 it indicates an assignment request is in progress.
Type integer or null
Read Only True

Receiving.SChannelMaxCount Member of HpeNetworkPortEVB.v1_2_0.HpeNetworkPortEVB
Description Indicates the number of S-Channels the link partner can support on this physical link.
Type integer or null
Read Only True
Added iLO 5 1.20

Receiving.SChannelsSupported Member of HpeNetworkPortEVB.v1_2_0.HpeNetworkPortEVB
Description When true this link supports S-Channels.
Type boolean or null
Read Only True
Added iLO 5 1.20

Receiving.VirtualLinkStatusVector Member of HpeNetworkPortEVB.v1_2_0.HpeNetworkPortEVB
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).
Type string or null
Read Only True
Added iLO 5 1.20

Transmitting

Transmitting.ChannelDescriptionData (array) Member of HpeNetworkPortEVB.v1_2_0.HpeNetworkPortEVB ChannelDescriptionData is an array containing elements of:

ChannelDescriptionData[{item}].Descriptor0BandwidthCirMbps Member of HpeNetworkPortEVB.v1_2_0.HpeNetworkPortEVB
Description The bandwidth Commited Information Rate (CIR) for this S-Channel, in Mbps.
Type integer or null
Read Only True

ChannelDescriptionData[{item}].Descriptor0BandwidthPirMbps Member of HpeNetworkPortEVB.v1_2_0.HpeNetworkPortEVB
Description The bandwidth Peak Information Rate (PIR) for this S-Channel, in Mbps.
Type integer or null
Read Only True

ChannelDescriptionData[{item}].Descriptor0ChannelTerminationType Member of HpeNetworkPortEVB.v1_2_0.HpeNetworkPortEVB
Description Indicates the termination provided for this S-Channel.
Type string or null
Read Only True

The following are the supported values:

Value Description
Null A value is temporarily unavailable
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.

ChannelDescriptionData[{item}].Descriptor0EthernetSupport Member of HpeNetworkPortEVB.v1_2_0.HpeNetworkPortEVB
Description When true, this S-Channel supports Ethernet.
Type boolean or null
Read Only True

ChannelDescriptionData[{item}].Descriptor0FCoESupport Member of HpeNetworkPortEVB.v1_2_0.HpeNetworkPortEVB
Description When true, this S-Channel supports Fibre Channel over Ethernet (FCoE).
Type boolean or null
Read Only True

ChannelDescriptionData[{item}].Descriptor0PcpSupport Member of HpeNetworkPortEVB.v1_2_0.HpeNetworkPortEVB
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).
Type string or null
Read Only True

ChannelDescriptionData[{item}].Descriptor0RoCEESupport Member of HpeNetworkPortEVB.v1_2_0.HpeNetworkPortEVB
Description When true, this S-Channel supports RDMA over Converged Enhanced Ethernet (RoCEE).
Type boolean or null
Read Only True

ChannelDescriptionData[{item}].Descriptor0Scid Member of HpeNetworkPortEVB.v1_2_0.HpeNetworkPortEVB
Description The S-Channel identifier for this Descriptor0 instance.
Type integer or null
Read Only True

ChannelDescriptionData[{item}].Descriptor0iSCSISupport Member of HpeNetworkPortEVB.v1_2_0.HpeNetworkPortEVB
Description When true, this S-Channel supports Internet SCSI (iSCSI).
Type boolean or null
Read Only True

ChannelDescriptionData[{item}].Descriptor1ConnectionID Member of HpeNetworkPortEVB.v1_2_0.HpeNetworkPortEVB
Description A unique S-Channel identifer in UUID format.
Type string or null
Read Only True

ChannelDescriptionData[{item}].Descriptor1Scid Member of HpeNetworkPortEVB.v1_2_0.HpeNetworkPortEVB
Description The S-Channel identifier for this Descriptor1 instance.
Type integer or null
Read Only True

Transmitting.ChannelDescriptionLocalSequenceNumber Member of HpeNetworkPortEVB.v1_2_0.HpeNetworkPortEVB
Description This station’s channel discovery local sequence number which will be transmitted to the link partner on this port.
Type integer or null
Read Only True
Added iLO 5 1.20

Transmitting.ChannelDescriptionRemoteSequenceNumber Member of HpeNetworkPortEVB.v1_2_0.HpeNetworkPortEVB
Description The link partner’s channel discovery local sequence number that was last successfully received and processed.
Type integer or null
Read Only True
Added iLO 5 1.20

Transmitting.ChannelDescriptorCount Member of HpeNetworkPortEVB.v1_2_0.HpeNetworkPortEVB
Description The number of channel descriptor pairs being transmitted to the link partner on this port.
Type integer or null
Read Only True
Added iLO 5 1.20

Transmitting.ChannelLinkControlLocalSequenceNumber Member of HpeNetworkPortEVB.v1_2_0.HpeNetworkPortEVB
Description This station’s channel link control local sequence number which will be transmitted to the link partner on this port.
Type integer or null
Read Only True
Added iLO 5 1.20

Transmitting.ChannelLinkControlMCEnable Member of HpeNetworkPortEVB.v1_2_0.HpeNetworkPortEVB
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.
Type boolean or null
Read Only True
Added iLO 5 1.20

Transmitting.ChannelLinkControlRemoteSequenceNumber Member of HpeNetworkPortEVB.v1_2_0.HpeNetworkPortEVB
Description The link partner’s channel link control local sequence number that was last successfully received and processed.
Type integer or null
Read Only True
Added iLO 5 1.20

Transmitting.Role Member of HpeNetworkPortEVB.v1_2_0.HpeNetworkPortEVB
Description This port’s IEEE 802.1Qbg role being advertised on the link.
Type string or null
Read Only True
Added iLO 5 1.20

The following are the supported values:

Value Description
Null A value is temporarily unavailable
bridge Indicates this link is operating locally as a Bridge.
station Indicates this link is operating locally as a Station.

Transmitting.SChannelAssignments (array) Member of HpeNetworkPortEVB.v1_2_0.HpeNetworkPortEVB SChannelAssignments is an array containing elements of:

SChannelAssignments[{item}].Scid Member of HpeNetworkPortEVB.v1_2_0.HpeNetworkPortEVB
Description SCID value for this S-Channel identifier pair being transmitted to the link partner on this port.
Type integer or null
Read Only True

SChannelAssignments[{item}].Svid Member of HpeNetworkPortEVB.v1_2_0.HpeNetworkPortEVB
Description SVID assignment value for this 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.
Type integer or null
Read Only True

Transmitting.SChannelMaxCount Member of HpeNetworkPortEVB.v1_2_0.HpeNetworkPortEVB
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.
Type integer or null
Read Only True
Added iLO 5 1.20

Transmitting.SChannelsSupported Member of HpeNetworkPortEVB.v1_2_0.HpeNetworkPortEVB
Description When true, indicates that this physical link has S-Channel capability.
Type boolean or null
Read Only True
Added iLO 5 1.20

Transmitting.VirtualLinkStatusVector Member of HpeNetworkPortEVB.v1_2_0.HpeNetworkPortEVB
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).
Type string or null
Read Only True
Added iLO 5 1.20

HpeNetworkPortLLDP.v1_2_0.HpeNetworkPortLLDP

@odata.type: "#HpeNetworkPortLLDP.v1_2_0.HpeNetworkPortLLDP"

NOTE: Deprecated, will be removed in a future release, replaced by NetworkPort.Oem.Hpe.LldpData. The HpeNetworkPortLLDP resource describes the Hewlett Packard Enterprise property extensions for Network Ports Link Layer Discovery Protocol

Resource Instances

Uri HTTP Allow
/redfish/v1/chassis/{item}/networkadapters/{item}/networkports/{item}/hpelldp GET
/redfish/v1/systems/{item}/networkinterfaces/{item}/networkports/{item}/hpelldp GET

Receiving

Receiving.ChassisID Member of HpeNetworkPortLLDP.v1_2_0.HpeNetworkPortLLDP
Description The LLDP chassis ID received from the link partner.
Type string or null
Read Only True
Added iLO 5 1.20

Receiving.ChassisIDSubtype Member of HpeNetworkPortLLDP.v1_2_0.HpeNetworkPortLLDP
Description The IEEE 802.1AB-2009 chassis ID subtype received from the link partner.
Type string or null
Read Only True
Added iLO 5 1.20

The following are the supported values:

Value Description
Null A value is temporarily unavailable
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.
MacAddr 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.
AgentId Agent circuit ID, based on the agent-local identifier of the circuit as defined in RFC 3046.
LocalAssign Locally assigned, based on a alpha-numeric value locally assigned.

Receiving.Dcb Receiving.Dcb.ApplicationPriorityReceived Member of HpeNetworkPortLLDP.v1_2_0.HpeNetworkPortLLDP
Description True when an unexpired Data Center Bridging (DCB) Application Priority Table TLV has been received.
Type boolean or null
Read Only True
Added iLO 5 1.20

Receiving.Dcb.ApplicationPriorityTable (array) Member of HpeNetworkPortLLDP.v1_2_0.HpeNetworkPortLLDP ApplicationPriorityTable is an array containing elements of:

ApplicationPriorityTable[{item}].ApplicationPriority Member of HpeNetworkPortLLDP.v1_2_0.HpeNetworkPortLLDP
Description Indicates which priority level is assigned for this application protocol.
Type integer or null
Read Only True

ApplicationPriorityTable[{item}].ApplicationProtocol Member of HpeNetworkPortLLDP.v1_2_0.HpeNetworkPortLLDP
Description An integer value indicating application protocol identity, of the type described by DCBApplicationSelect.
Type integer or null
Read Only True

ApplicationPriorityTable[{item}].ApplicationSelect Member of HpeNetworkPortLLDP.v1_2_0.HpeNetworkPortLLDP
Description Indentifies the type of the DCBApplicationProtocol property.
Type string or null
Read Only True

The following are the supported values:

Value Description
Null A value is temporarily unavailable
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.

Receiving.Dcb.Ets Receiving.Dcb.Ets.BandwidthAssignmentTable (array) Member of HpeNetworkPortLLDP.v1_2_0.HpeNetworkPortLLDP BandwidthAssignmentTable is an array containing elements of:
Description One entry in the DCB ETS Traffic Class (TC) Bandwidth Assignment Table.
Type integer or null
Read Only True

Receiving.Dcb.Ets.CreditBasedShaper Member of HpeNetworkPortLLDP.v1_2_0.HpeNetworkPortLLDP
Description True if the link partner supports the Credit-based Shaper (CBS) transmmission selection algortithm.
Type boolean or null
Read Only True
Added iLO 5 1.20

Receiving.Dcb.Ets.MaximumTrafficClassCount Member of HpeNetworkPortLLDP.v1_2_0.HpeNetworkPortLLDP
Description The maximum number of traffic classes supported by the link partner.
Type integer or null
Read Only True
Added iLO 5 1.20

Receiving.Dcb.Ets.PriorityAssignmentTable (array) Member of HpeNetworkPortLLDP.v1_2_0.HpeNetworkPortLLDP PriorityAssignmentTable is an array containing elements of:
Description One entry in the DCB ETS Priority Assignment Table indicating this priority’s Traffic Class assignment.
Type integer or null
Read Only True

Receiving.Dcb.Ets.TlvReceived Member of HpeNetworkPortLLDP.v1_2_0.HpeNetworkPortLLDP
Description True when an unexpired DCB Enhanced Transmission Selection (ETS) TLV has been received.
Type boolean or null
Read Only True
Added iLO 5 1.20

Receiving.Dcb.Ets.TrafficSelectionAlgorithmTable (array) Member of HpeNetworkPortLLDP.v1_2_0.HpeNetworkPortLLDP TrafficSelectionAlgorithmTable is an array containing elements of:
Description An assignment of a Traffic Selection Algorithm (TSA) to a traffic class.
Type string or null
Read Only True

The following are the supported values:

Value Description
Null A value is temporarily unavailable
strict Strict priority algorithm.
CBS Credit-Based Shaper algorithm.
ETS Enhanced Traffic Selection algorithm.
vendor Vendor specific algorithm for use with DCB.

Receiving.Dcb.Ets.Willing Member of HpeNetworkPortLLDP.v1_2_0.HpeNetworkPortLLDP
Description True if the link partner is willing to accept ETS configurations.
Type boolean or null
Read Only True
Added iLO 5 1.20

Receiving.Dcb.LocalEqualRemote Member of HpeNetworkPortLLDP.v1_2_0.HpeNetworkPortLLDP
Description True when the transmitted and received contents match for both DCB ETS and PFC TLVs.
Type boolean or null
Read Only True
Added iLO 5 1.20

Receiving.Dcb.Pfc Receiving.Dcb.Pfc.EnabledTrafficClasses Member of HpeNetworkPortLLDP.v1_2_0.HpeNetworkPortLLDP
Description A bit string indicating which priority levels have PFC enabled, 1=enabled. PFC levels are bit ordered from 7 (first) to 0 (last).
Type string or null
Read Only True
Added iLO 5 1.20

Receiving.Dcb.Pfc.MacSecurityBypassCapability Member of HpeNetworkPortLLDP.v1_2_0.HpeNetworkPortLLDP
Description True when the link partner has the ability to bypass MAC security in order to improve PFC responsiveness.
Type boolean or null
Read Only True
Added iLO 5 1.20

Receiving.Dcb.Pfc.MaximumTrafficClassCount Member of HpeNetworkPortLLDP.v1_2_0.HpeNetworkPortLLDP
Description Indicates the maximum number of traffic classes that the link partner can simultaneously support.
Type integer or null
Read Only True
Added iLO 5 1.20

Receiving.Dcb.Pfc.TlvReceived Member of HpeNetworkPortLLDP.v1_2_0.HpeNetworkPortLLDP
Description True when an unexpired DCB Priority Flow Control (PFC) TLV has been received.
Type boolean or null
Read Only True
Added iLO 5 1.20

Receiving.Dcb.Pfc.Willing Member of HpeNetworkPortLLDP.v1_2_0.HpeNetworkPortLLDP
Description True if the LLDP link partner is willing to accept PFC configurations.
Type boolean or null
Read Only True
Added iLO 5 1.20

Receiving.Dcb.Version Member of HpeNetworkPortLLDP.v1_2_0.HpeNetworkPortLLDP
Description The DCB version supported by the link partner.
Type string or null
Read Only True
Added iLO 5 1.20

The following are the supported values:

Value Description
Null A value is temporarily unavailable
unknown Unknown
CEE Converged Enhanced Ethernet
IEEE IEEE 802.1Q

Receiving.ManagementAddress Member of HpeNetworkPortLLDP.v1_2_0.HpeNetworkPortLLDP
Description The management address received from the link partner.
Type string or null
Read Only True
Added iLO 5 1.20

Receiving.ManagementAddressOID Member of HpeNetworkPortLLDP.v1_2_0.HpeNetworkPortLLDP
Description An object identifier for the hardware or protocol entity associated with the management address.
Type string or null
Read Only True
Added iLO 5 1.20

Receiving.ManagementAddressReceived Member of HpeNetworkPortLLDP.v1_2_0.HpeNetworkPortLLDP
Description True when a currently unexpired management address TLV has been received from the link partner.
Type boolean or null
Read Only True
Added iLO 5 1.20

Receiving.ManagementAddressType Member of HpeNetworkPortLLDP.v1_2_0.HpeNetworkPortLLDP
Description The type of management address received from the link partner.
Type string or null
Read Only True
Added iLO 5 1.20

The following are the supported values:

Value Description
Null A value is temporarily unavailable
IPv4 Type 1 (IP version 4).
IPv6 Type 2 (IP version 6).
all802 Type 6 (All 802 media plus Ethernet ‘canonical format’).

Receiving.ManagementCvlanID Member of HpeNetworkPortLLDP.v1_2_0.HpeNetworkPortLLDP
Description The management CVLAN ID received from the link partner.
Type integer or null
Read Only True
Added iLO 5 1.20

Receiving.ManagementIFNumSubtype Member of HpeNetworkPortLLDP.v1_2_0.HpeNetworkPortLLDP
Description Management interface number subtype.
Type string or null
Read Only True
Added iLO 5 1.20

The following are the supported values:

Value Description
Null A value is temporarily unavailable
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.

Receiving.ManagementIFNumber Member of HpeNetworkPortLLDP.v1_2_0.HpeNetworkPortLLDP
Description Management interface number received from the link partner represented as a colon delimited string of hexadecimal octets.
Type string or null
Read Only True
Added iLO 5 1.20

Receiving.ManagementVlanReceived Member of HpeNetworkPortLLDP.v1_2_0.HpeNetworkPortLLDP
Description True when a currently unexpired management address VID TLV has been received from the link partner.
Type boolean or null
Read Only True
Added iLO 5 1.20

Receiving.NearestBridgeTtlExpired Member of HpeNetworkPortLLDP.v1_2_0.HpeNetworkPortLLDP
Description True when the LLDP PDU most recently received from the link partner has expired.
Type boolean or null
Read Only True
Added iLO 5 1.20

Receiving.PortDescription Member of HpeNetworkPortLLDP.v1_2_0.HpeNetworkPortLLDP
Description The remote link partner’s port description.
Type string or null
Read Only True
Added iLO 5 1.20

Receiving.PortID Member of HpeNetworkPortLLDP.v1_2_0.HpeNetworkPortLLDP
Description A colon delimited string of hexadecimal octets received from the link partner identifying its port.
Type string or null
Read Only True
Added iLO 5 1.20

Receiving.PortIDSubtype Member of HpeNetworkPortLLDP.v1_2_0.HpeNetworkPortLLDP
Description The port ID subtype enumeration from IEEE 802.1AB-2009 Table 8-3, which indicates the format for the PortID property.
Type string or null
Read Only True
Added iLO 5 1.20

The following are the supported values:

Value Description
Null A value is temporarily unavailable
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.
MacAddr 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.
AgentId Agent circuit ID, based on the agent-local identifier of the circuit as defined in RFC 3046.
LocalAssign Locally assigned, based on a alpha-numeric value locally assigned.

Receiving.SystemDescription Member of HpeNetworkPortLLDP.v1_2_0.HpeNetworkPortLLDP
Description The system description received from the link partner.
Type string or null
Read Only True
Added iLO 5 1.20

Transmitting

Transmitting.ChassisID Member of HpeNetworkPortLLDP.v1_2_0.HpeNetworkPortLLDP
Description The Link Layer Data Protocol (LLDP) chassis ID being transmitted on this link.
Type string or null
Read Only True
Added iLO 5 1.20

Transmitting.ChassisIDSubtype Member of HpeNetworkPortLLDP.v1_2_0.HpeNetworkPortLLDP
Description The IEEE 802.1AB-2009 chassis ID subtype being transmitted on this link.
Type string or null
Read Only True
Added iLO 5 1.20

The following are the supported values:

Value Description
Null A value is temporarily unavailable
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.
MacAddr 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.
AgentId Agent circuit ID, based on the agent-local identifier of the circuit as defined in RFC 3046.
LocalAssign Locally assigned, based on a alpha-numeric value locally assigned.

Transmitting.ManagementAddresses (array) Member of HpeNetworkPortLLDP.v1_2_0.HpeNetworkPortLLDP ManagementAddresses is an array containing elements of:

ManagementAddresses[{item}].ManagementIPAddress Member of HpeNetworkPortLLDP.v1_2_0.HpeNetworkPortLLDP
Description A management address.
Type string or null
Read Only True

ManagementAddresses[{item}].ManagementIPAddressType Member of HpeNetworkPortLLDP.v1_2_0.HpeNetworkPortLLDP
Description The IANA type of this management address.
Type string or null
Read Only True

The following are the supported values:

Value Description
Null A value is temporarily unavailable
IPv4 Type 1 (IP version 4).
IPv6 Type 2 (IP version 6).
all802 Type 6 (All 802 media plus Ethernet ‘canonical format’).

Transmitting.ManagementCvlanID Member of HpeNetworkPortLLDP.v1_2_0.HpeNetworkPortLLDP
Description The management CVLAN ID being transmitted on this link.
Type integer or null
Read Only True
Added iLO 5 1.20

Transmitting.ManagementCvlanIDTransmitted Member of HpeNetworkPortLLDP.v1_2_0.HpeNetworkPortLLDP
Description When true, indicates that a management CVLAN ID is being transmitted on this link.
Type boolean or null
Read Only True
Added iLO 5 1.20

Transmitting.PortDescription Member of HpeNetworkPortLLDP.v1_2_0.HpeNetworkPortLLDP
Description An alphanumeric string describing this link.
Type string or null
Read Only True
Added iLO 5 1.20

Transmitting.PortID Member of HpeNetworkPortLLDP.v1_2_0.HpeNetworkPortLLDP
Description A colon delimited string of hexadecimal octets identifying this port.
Type string or null
Read Only True
Added iLO 5 1.20

Transmitting.PortIDSubtype Member of HpeNetworkPortLLDP.v1_2_0.HpeNetworkPortLLDP
Description The port ID subtype from IEEE 802.1AB-2009 Table 8-3.
Type string or null
Read Only True
Added iLO 5 1.20

The following are the supported values:

Value Description
Null A value is temporarily unavailable
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.
MacAddr 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.
AgentId Agent circuit ID, based on the agent-local identifier of the circuit as defined in RFC 3046.
LocalAssign Locally assigned, based on a alpha-numeric value locally assigned.

Transmitting.SystemDescription Member of HpeNetworkPortLLDP.v1_2_0.HpeNetworkPortLLDP
Description A textual description of this system.
Type string or null
Read Only True
Added iLO 5 1.20

HpePowerMeter.v2_0_1.HpePowerMeter

@odata.type: "#HpePowerMeter.v2_0_1.HpePowerMeter"

The HpePowerMeter resource contains the computer system power history logged by the BMC.

Resource Instances

Uri HTTP Allow
/redfish/v1/chassis/{item}/power/fastpowermeter GET
/redfish/v1/chassis/{item}/power/powermeter GET

Average

Member of HpePowerMeter.v2_0_1.HpePowerMeter
Description Average power across all samples, over the last 24 hours.
Type integer
Read Only True
Added iLO 5 1.10

Maximum

Member of HpePowerMeter.v2_0_1.HpePowerMeter
Description Maximum power across all samples, taken from the 24 hour history.
Type integer
Read Only True
Added iLO 5 1.10

Minimum

Member of HpePowerMeter.v2_0_1.HpePowerMeter
Description Minimum power across all samples, taken from the 24 hour history.
Type integer
Read Only True
Added iLO 5 1.10

PowerDetail (array)

Member of HpePowerMeter.v2_0_1.HpePowerMeter PowerDetail is an array containing elements of:

PowerDetail[{item}].AmbTemp Member of HpePowerMeter.v2_0_1.HpePowerMeter
Description Ambient temperature, in degrees Celsius.
Type integer
Read Only True
Added iLO 5 1.10

PowerDetail[{item}].Average Member of HpePowerMeter.v2_0_1.HpePowerMeter
Description Average power in Watts over the sample time.
Type integer
Read Only True
Added iLO 5 1.10

PowerDetail[{item}].Cap Member of HpePowerMeter.v2_0_1.HpePowerMeter
Description The applicable power cap in Watts at the time of this power sample.
Type integer
Read Only True
Added iLO 5 1.10

PowerDetail[{item}].CpuAvgFreq Member of HpePowerMeter.v2_0_1.HpePowerMeter
Description CPU average frequency in MHz.
Type integer
Read Only True
Added iLO 5 1.10

PowerDetail[{item}].CpuCapLim Member of HpePowerMeter.v2_0_1.HpePowerMeter
Description Measures the effect of the power cap on performance in percent.
Type integer
Read Only True
Added iLO 5 1.10

PowerDetail[{item}].CpuMax Member of HpePowerMeter.v2_0_1.HpePowerMeter
Description The percentage of time the CPU spent in its maximum power mode.
Type integer
Read Only True
Added iLO 5 1.10

PowerDetail[{item}].CpuPwrSavLim Member of HpePowerMeter.v2_0_1.HpePowerMeter
Description Measures the effect of CPU Power Regulator state switching on performance in percent.
Type integer
Read Only True
Added iLO 5 1.10

PowerDetail[{item}].CpuUtil Member of HpePowerMeter.v2_0_1.HpePowerMeter
Description CPU utilization in percent.
Type integer
Read Only True
Added iLO 5 1.10

PowerDetail[{item}].CpuWatts Member of HpePowerMeter.v2_0_1.HpePowerMeter
Description The power consumed by the system CPUs in Watts.
Type integer
Read Only True
Added iLO 5 1.30

PowerDetail[{item}].DimmWatts Member of HpePowerMeter.v2_0_1.HpePowerMeter
Description The power consumed by the system memory DIMMs in Watts.
Type integer
Read Only True
Added iLO 5 1.30

PowerDetail[{item}].GpuWatts Member of HpePowerMeter.v2_0_1.HpePowerMeter
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.
Type integer
Read Only True
Added iLO 5 1.30

PowerDetail[{item}].Minimum Member of HpePowerMeter.v2_0_1.HpePowerMeter
Description Minimum power in Watts over the sample time.
Type integer
Read Only True
Added iLO 5 1.10

PowerDetail[{item}].Peak Member of HpePowerMeter.v2_0_1.HpePowerMeter
Description Peak power in Watts over the sample time.
Type integer
Read Only True
Added iLO 5 1.10

PowerDetail[{item}].PrMode Member of HpePowerMeter.v2_0_1.HpePowerMeter
Description Power Regulator mode, which can be OS Control, Static High, Static Low or Dynamic.
Type string or null
Read Only True
Added iLO 5 1.10

The following are the supported values:

Value Description
Null A value is temporarily unavailable
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.

PowerDetail[{item}].PunCap Member of HpePowerMeter.v2_0_1.HpePowerMeter
Description If true, CPU performance is being penalized by the current power cap.
Type boolean
Read Only True
Added iLO 5 1.10

PowerDetail[{item}].Time Member of HpePowerMeter.v2_0_1.HpePowerMeter
Description Time at which the power sample detail was captured.
Type string
Read Only True
Added iLO 5 1.10
Format date-time

PowerDetail[{item}].UnachCap Member of HpePowerMeter.v2_0_1.HpePowerMeter
Description If true, the configured power cap could not be achieved due to system power requirements.
Type boolean
Read Only True
Added iLO 5 1.10

Samples

Member of HpePowerMeter.v2_0_1.HpePowerMeter
Description Number of samples in the array.
Type integer
Read Only True
Added iLO 5 1.10

HpeRemoteSupport.v2_6_0.HpeRemoteSupport

@odata.type: "#HpeRemoteSupport.v2_6_0.HpeRemoteSupport"

The HpeRemoteSupport resource describes the properties for management of HPE Embedded Report Support.

This resource type was added in iLO 5 1.20

HpeRemoteSupport enables management of HPE Remote Support configuration on iLO 5.

Resource Instances

Uri HTTP Allow
/redfish/v1/managers/{item}/remotesupportservice GET POST PATCH
Link Name Destination type
ServiceEventLogs Collection of LogEntry

ConnectModel

Member of HpeRemoteSupport.v2_6_0.HpeRemoteSupport
Description The Remote Support connect model type.
Type string
Read Only True
Added iLO 5 1.20

The following are the supported values:

Value
DirectConnect
CentralConnect

DataCollectionFrequencyInDays

Member of HpeRemoteSupport.v2_6_0.HpeRemoteSupport
Description The frequency of data collection in days. This is applicable only when the server is registered using Direct Connect.
Type integer
Read Only True
Added iLO 5 1.20

DestinationPort

Member of HpeRemoteSupport.v2_6_0.HpeRemoteSupport
Description The port number of the Insight Remote Support server. This is applicable for Central Connect only.
Type integer
Read Only True
Added iLO 5 1.20

DestinationURL

Member of HpeRemoteSupport.v2_6_0.HpeRemoteSupport
Description The host name or IP address of the Remote Support server. This is applicable for Central Connect only.
Type string
Read Only True
Added iLO 5 1.20

DirectConnectRegistrationIsCompleted

Member of HpeRemoteSupport.v2_6_0.HpeRemoteSupport
Description Step 2 of Direct Connect Registration completion status.
Type boolean
Read Only True

ExternalAgentName

Member of HpeRemoteSupport.v2_6_0.HpeRemoteSupport
Description This indicates the name of external Remote Support agent.
Type string
Read Only True

HpePassportPassword

Member of HpeRemoteSupport.v2_6_0.HpeRemoteSupport
Description HPE Passport Account Password.
Type string or null
Read Only True
Added iLO 5 1.20

HpePassportUserId

Member of HpeRemoteSupport.v2_6_0.HpeRemoteSupport
Description HPE Passport Account Id.
Type string
Read Only True
Added iLO 5 1.20

LastTransmissionDate

Member of HpeRemoteSupport.v2_6_0.HpeRemoteSupport
Description The last transmission date.
Type string
Read Only True
Added iLO 5 1.20
Format date-time

LastTransmissionError

Member of HpeRemoteSupport.v2_6_0.HpeRemoteSupport
Description The last transmission error.
Type string
Read Only True
Added iLO 5 1.20

LastTransmissionType

Member of HpeRemoteSupport.v2_6_0.HpeRemoteSupport
Description The last transmission type.
Type string or null
Read Only True
Added iLO 5 1.20

The following are the supported values:

Value
ActiveHealthSystemData
L2DataCollection
Registration
Deregistration
ServiceEvent
NoTransmission
Null

MaintenanceModeEnabled

Member of HpeRemoteSupport.v2_6_0.HpeRemoteSupport
Description This indicates if the server is in Maintenance Mode or not.
Type boolean
Read Only True
Added iLO 5 1.30

MaintenanceTimeLeftInMinutes

Member of HpeRemoteSupport.v2_6_0.HpeRemoteSupport
Description This indicates the time remaining in minutes for the server to be in the maintenance mode.
Type integer
Read Only True

ProxySettings

ProxySettings.Password Member of HpeRemoteSupport.v2_6_0.HpeRemoteSupport
Description Password for web proxy server authentication.
Type string or null
Read Only False
Added iLO 5 1.20

ProxySettings.Port Member of HpeRemoteSupport.v2_6_0.HpeRemoteSupport
Description Port number on which to communicate with the web proxy server.
Type integer or null
Read Only False
Added iLO 5 1.20

ProxySettings.Url Member of HpeRemoteSupport.v2_6_0.HpeRemoteSupport
Description Web proxy server host name or IP address.
Type string
Read Only False
Added iLO 5 1.20
Format url

ProxySettings.Username Member of HpeRemoteSupport.v2_6_0.HpeRemoteSupport
Description Username for web proxy server authentication.
Type string or null
Read Only False
Added iLO 5 1.20

RemoteSupportEnabled

Member of HpeRemoteSupport.v2_6_0.HpeRemoteSupport
Description This indicates if the Remote Support Service is available or not.
Type boolean
Read Only True
Added iLO 5 1.20

ServiceEventLogs

A reference to the collection of service event logs. ServiceEventLogs is a link ("@odata.id": URI) to another resource.

Actions

HpeRemoteSupport.ClearServiceEventLog Member of HpeRemoteSupport.v2_6_0.HpeRemoteSupport There are no parameters for this action.

HpeRemoteSupport.DisableRemoteSupport Member of HpeRemoteSupport.v2_6_0.HpeRemoteSupport

Parameters:

MessageId (string)

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.

HpeRemoteSupport.RegisterDeviceToRemoteSupport Member of HpeRemoteSupport.v2_6_0.HpeRemoteSupport

Parameters:

ConnectionType (string)

This indicates whether the device will be registered using Direct Connect or Central Connect.

Value Description
DirectConnect
CentralConnect

DestinationPort (integer)

The port number of the Remote Support server. This is applicable for Central Connect only.

DestinationUrl (string)

The host name or IP address of the Remote Support server. This is applicable for Central Connect only.

HpeSecureEraseReport.v1_0_0.HpeSecureEraseReport

@odata.type: "#HpeSecureEraseReport.v1_0_0.HpeSecureEraseReport"

The HpeSecureEraseReport resource describes the secure erase status and the other details of the devices during the secure system erase operation.

Resource Instances

Uri HTTP Allow
/redfish/v1/systems/{item}/secureerasereportservice/secureerasereportentries/{item} GET

DeviceIdentifier

Member of HpeSecureEraseReport.v1_0_0.HpeSecureEraseReport
Description This represents the unique identifier for the device in the system like it’s physical location or the exact device path etc.,
Type string or null
Read Only True

DeviceType

Member of HpeSecureEraseReport.v1_0_0.HpeSecureEraseReport
Description This indicates the device type being securely erased.
Type string or null
Read Only True

The following are the supported values:

Value Description
SmartStorage This indicates the device type is Smart Storage
SATADrives This indicates the device type is SATA drive
NVMeDrives This indicates the device type is NVMe drive
NVDIMM This indicates the device type is NVDIMM/Persistent Memory
TPM This indicates the device type is TPM (Trusted Platform Module)
UEFIStore This indicates the device type is UEFI Store
NAND This indicates the device type is Embedded NAND Flash
NVRAM This indicates the device type is NVRAM (Battery backed SRAM)

EraseEndTime

Member of HpeSecureEraseReport.v1_0_0.HpeSecureEraseReport
Description The date and time of the end of secure erase operation, ISO8601 Redfish-style time
Type string
Read Only True
Format date-time

EraseStartTime

Member of HpeSecureEraseReport.v1_0_0.HpeSecureEraseReport
Description The date and time of the start of secure erase operation, ISO8601 Redfish-style time
Type string
Read Only True
Format date-time

EraseStatus

Member of HpeSecureEraseReport.v1_0_0.HpeSecureEraseReport
Description Indicates the secure erase status of the individual components
Type string or null
Read Only True

The following are the supported values:

Value Description
Idle Indicates Secure System 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

EraseType

Member of HpeSecureEraseReport.v1_0_0.HpeSecureEraseReport
Description This indicates the NIST SP800-88 Rev.1 (National Institute of Standards and Technology) approved techniques to sanitize a particular media or device.
Type string or null
Read Only True

The following are the supported values:

Value Description
Purge This indicates that Purge technique is used to sanitize the device.
Clear This indicates that Clear technique is used to sanitize the device.

SerialNumber

Member of HpeSecureEraseReport.v1_0_0.HpeSecureEraseReport
Description This represents the serial number of the device being erased.
Type string or null
Read Only True

HpeSecureEraseReportCollection.HpeSecureEraseReportCollection

@odata.type: "#HpeSecureEraseReportCollection.HpeSecureEraseReportCollection"

A Collection of HpeSecureEraseReport resource instances.

Resource Instances

Uri HTTP Allow
/redfish/v1/systems/{item}/secureerasereportservice/secureerasereportentries GET
Link Name Destination type
Members[] HpeSecureEraseReport

Members (array)

Member of HpeSecureEraseReportCollection.HpeSecureEraseReportCollection Members is an array containing elements of:

Members[{item}].@odata.id Member of HpeSecureEraseReportCollection.HpeSecureEraseReportCollection
Type string
Read Only True
Format uri-reference

Members@odata.count

Member of HpeSecureEraseReportCollection.HpeSecureEraseReportCollection
Description The total number of collection members.
Type integer
Read Only True

HpeSecureEraseReportService.v1_0_0.HpeSecureEraseReportService

@odata.type: "#HpeSecureEraseReportService.v1_0_0.HpeSecureEraseReportService"

The HpeSecureEraseReportService resource describes the properties of the Secure Erase Report feature.

Resource Instances

Uri HTTP Allow
/redfish/v1/systems/{item}/secureerasereportservice GET POST
Link Name Destination type
Links/SecureEraseReportEntries Collection of HpeSecureEraseReport

EraseInitiatedBy

Member of HpeSecureEraseReportService.v1_0_0.HpeSecureEraseReportService
Description This indicates the user name who initiated the secure system erase process.
Type string or null
Read Only True

ServerSerialNumber

Member of HpeSecureEraseReportService.v1_0_0.HpeSecureEraseReportService
Description This represents the server serial number.
Type string or null
Read Only True

Actions

HpeSecureEraseReportService.DeleteSecureEraseReport Member of HpeSecureEraseReportService.v1_0_0.HpeSecureEraseReportService There are no parameters for this action.

HpeSecurityService.v2_3_1.HpeSecurityService

@odata.type: "#HpeSecurityService.v2_3_1.HpeSecurityService"

The HpeSecurityService resource describes the properties for management of the security configuration of the BMC.

Resource Instances

Uri HTTP Allow
/redfish/v1/managers/{item}/securityservice GET PATCH
Link Name Destination type
Links/AutomaticCertificateEnrollment HpeAutomaticCertEnrollment
Links/CertAuth HpeCertAuth
Links/ESKM HpeESKM
Links/HttpsCert HpeHttpsCert
Links/SSO HpeiLOSSO
Links/SecurityDashboard HpeiLOSecurityDashboard
Links/SecurityParams Collection of HpeiLOSecurityParam

CurrentCipher

Member of HpeSecurityService.v2_3_1.HpeSecurityService
Description Current cipher in use.
Type string
Read Only True
Added iLO 5 1.15

LoginSecurityBanner

LoginSecurityBanner.IsEnabled Member of HpeSecurityService.v2_3_1.HpeSecurityService
Description Login security banner is enabled or not.
Type boolean
Read Only False
Added iLO 5 1.15

LoginSecurityBanner.SecurityMessage Member of HpeSecurityService.v2_3_1.HpeSecurityService
Description Text message to appear on the iLO login page and iLO SSH pre-authentication banner when login security banner is enabled.
Type string
Read Only False
Added iLO 5 1.15

PlatformCert

PlatformCert.Certificates This is a reference to a collection of certificates used for PlatformCert by this manager. Certificates is a link ("@odata.id": URI) to another resource.

PlatformCertUpdate

PlatformCertUpdate.Certificates This is a reference to a collection of certificates used for PlatformCert Updates by this manager. Certificates is a link ("@odata.id": URI) to another resource.

SSHHostKey

Member of HpeSecurityService.v2_3_1.HpeSecurityService
Description SSH Host Key identifying the service.
Type string
Read Only True
Added iLO 5 1.40

SecurityState

Member of HpeSecurityService.v2_3_1.HpeSecurityService
Description The operational security level of this Manager.
Type string
Read Only False
Added iLO 5 1.10

The following are the supported values:

Value Description
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.

SecurityState@Redfish.AllowableValues (array)

Member of HpeSecurityService.v2_3_1.HpeSecurityService SecurityState@Redfish.AllowableValues is an array containing elements of:
Type string
Read Only True

The following are the supported values:

Value
Wipe
Production
HighSecurity
FIPS
CNSA
SuiteB

SystemIAK

SystemIAK.Certificates This is a reference to a collection of certificates used for System IAK by this manager. Certificates is a link ("@odata.id": URI) to another resource.

SystemIDevID

SystemIDevID.Certificates This is a reference to a collection of certificates used for System IDevId by this manager. Certificates is a link ("@odata.id": URI) to another resource.

TLSVersion

TLSVersion.TLS1_0 Member of HpeSecurityService.v2_3_1.HpeSecurityService
Description This Indicate whether the TLS 1.0 is Enabled or disabled.
Type string or null
Read Only False

The following are the supported values:

Value Description
Enabled Enabled TLS 1.0.
Disabled Disabled TLS 1.0.

TLSVersion.TLS1_1 Member of HpeSecurityService.v2_3_1.HpeSecurityService
Description This Indicate whether the TLS 1.1 is Enabled or disabled.
Type string or null
Read Only False

The following are the supported values:

Value Description
Enabled Enabled TLS 1.1.
Disabled Disabled TLS 1.1.

TLSVersion.TLS1_2 Member of HpeSecurityService.v2_3_1.HpeSecurityService
Description This Indicate whether the TLS 1.2 is Enabled or disabled.
Type string or null
Read Only True

The following are the supported values:

Value Description
Enabled Enabled TLS 1.2.
Disabled Disabled TLS 1.2.

TLSVersion.TLS1_3 Member of HpeSecurityService.v2_3_1.HpeSecurityService
Description This Indicate whether the TLS 1.3 is Enabled or disabled.
Type string or null
Read Only True

The following are the supported values:

Value Description
Enabled Enabled TLS 1.3.
Disabled Disabled TLS 1.3.

TrustedOSSecurity

TrustedOSSecurity.EnableBackgroundScan Member of HpeSecurityService.v2_3_1.HpeSecurityService
Description Enables or disables background scan of host OS software.
Type boolean
Read Only False

TrustedOSSecurity.LastScanResult Member of HpeSecurityService.v2_3_1.HpeSecurityService
Description Health of the host after the last scan done by Trusted OS Security scan engine.
Type string or null
Read Only True

The following are the supported values:

Value Description
OK The last Trusted OS Security scan completed without finding any issues.
Critical The last Trusted OS Security scan completed finding issue(s). Refer to the SL log for details.
Unknown The health is Unknown because either the scan data is unavailable or scan is not enabled or last scan failed to complete.

TrustedOSSecurity.LastScanTime Member of HpeSecurityService.v2_3_1.HpeSecurityService
Description The time stamp of the last Trusted OS Security scan.
Type string or null
Read Only True
Format date-time

TrustedOSSecurity.OnIntegrityFailure Member of HpeSecurityService.v2_3_1.HpeSecurityService
Description Sets the policy for how the Trusted OS Security check handles integrity failures.
Type string
Read Only True

The following are the supported values:

Value Description
NoAction No action will be taken when a failure is detected.
Alert Generate an alert when a failure is detected.
PowerOff Gracefully power system off when a failure is detected.
PowerOffForce Force system power off when a failure is detected.
Reset Reset system power off when a failure is detected.
ColdBoot ColdBoot system power off when a failure is detected.
ForceNMI ForceNMI system power off when a failure is detected.

TrustedOSSecurity.ScanEverySeconds Member of HpeSecurityService.v2_3_1.HpeSecurityService
Description Sets the interval between Trusted OS Security scans in second increments.
Type integer or null
Read Only False

iLOIDevID

iLOIDevID.Certificates This is a reference to a collection of certificates used for iLO IDevId by this manager. Certificates is a link ("@odata.id": URI) to another resource.

iLOLDevID

iLOLDevID.Certificates This is a reference to a collection of certificates used for iLO LDevId by this manager. Certificates is a link ("@odata.id": URI) to another resource.

HpeServerAccHddService.v1_0_0.HpeServerAccHddService

@odata.type: "#HpeServerAccHddService.v1_0_0.HpeServerAccHddService"

The HpeServerAccHddService resource describes the properties for management of shared power in an enclosure.

This resource type was added in iLO 5 1.20 and is available on HPE ProLiant Apollo XL systems.

Resource Instances

Uri HTTP Allow
/redfish/v1/chassis/{item}/acchddservice GET

BackplaneInfo

BackplaneInfo.EndBay Member of HpeServerAccHddService.v1_0_0.HpeServerAccHddService
Description Represents a ending number of the bay.
Type integer
Read Only True
Added iLO 5 1.20

BackplaneInfo.FirmwareRevision Member of HpeServerAccHddService.v1_0_0.HpeServerAccHddService
Description Indicates the firmware revision in ASCII value.
Type string
Read Only True
Added iLO 5 1.20

BackplaneInfo.HostPortsInfo (array) Member of HpeServerAccHddService.v1_0_0.HpeServerAccHddService HostPortsInfo is an array containing elements of:

HostPortsInfo[{item}].NodeNumber Member of HpeServerAccHddService.v1_0_0.HpeServerAccHddService
Description Represents the node number of compute node attached to host port x in SEP.
Type integer
Read Only True

HostPortsInfo[{item}].PortNumber Member of HpeServerAccHddService.v1_0_0.HpeServerAccHddService
Description Represents the number of physical host ports in SEP.
Type integer
Read Only True

HostPortsInfo[{item}].SlotNumber Member of HpeServerAccHddService.v1_0_0.HpeServerAccHddService
Description Represents the slot number of SAS attached to host port x in SEP.
Type integer
Read Only True

BackplaneInfo.SEPID Member of HpeServerAccHddService.v1_0_0.HpeServerAccHddService
Description Indicates the storage enclosure processor ID.
Type integer
Read Only True
Added iLO 5 1.20

BackplaneInfo.SEPNodeId Member of HpeServerAccHddService.v1_0_0.HpeServerAccHddService
Description The node ID represent the node ID where the storage enclosure processor is residing.
Type integer
Read Only True
Added iLO 5 1.20

BackplaneInfo.StartBay Member of HpeServerAccHddService.v1_0_0.HpeServerAccHddService
Description Represents a starting number of the bay.
Type integer
Read Only True
Added iLO 5 1.20

BackplaneInfo.TotalBays Member of HpeServerAccHddService.v1_0_0.HpeServerAccHddService
Description Total bay count represents the number of bays attached to the SEP.
Type integer
Read Only True
Added iLO 5 1.20

BackplaneInfo.TypeID Member of HpeServerAccHddService.v1_0_0.HpeServerAccHddService
Description Indicates the Backplane type ID for the identifier for backplane type.
Type integer
Read Only True
Added iLO 5 1.20

BackplaneInfo.WWID Member of HpeServerAccHddService.v1_0_0.HpeServerAccHddService
Description Represents a unique world wide ID defining a SEP.
Type string
Read Only True
Added iLO 5 1.20

HpeServerAccHddZone.v1_0_0.HpeServerAccHddZone

@odata.type: "#HpeServerAccHddZone.v1_0_0.HpeServerAccHddZone"

The HpeServerAccHddZone resource describes the properties for management of shared hard drives in an enclosure.

This resource type was added in iLO 5 1.20 and is available on HPE ProLiant Apollo XL systems.

Resource Instances

Uri HTTP Allow
/redfish/v1/chassis/{item}/acchddservice/zone GET POST

BackupZoneConfigurationInBmc

BackupZoneConfigurationInBmc.HostPort (array) Member of HpeServerAccHddZone.v1_0_0.HpeServerAccHddZone HostPort is an array containing elements of:

HostPort[{item}].BayNumber (array) Member of HpeServerAccHddZone.v1_0_0.HpeServerAccHddZone BayNumber is an array containing elements of:
Type integer
Read Only True

HostPort[{item}].PortNumber Member of HpeServerAccHddZone.v1_0_0.HpeServerAccHddZone
Description Represents the number of physical host ports in SEP, null represents unassigned bay group.
Type integer or null
Read Only True

CurrentZoneConfiguration

CurrentZoneConfiguration.HostPort (array) Member of HpeServerAccHddZone.v1_0_0.HpeServerAccHddZone HostPort is an array containing elements of:

HostPort[{item}].BayNumber (array) Member of HpeServerAccHddZone.v1_0_0.HpeServerAccHddZone BayNumber is an array containing elements of:
Type integer
Read Only True

HostPort[{item}].PortNumber Member of HpeServerAccHddZone.v1_0_0.HpeServerAccHddZone
Description Represents the number of physical host ports in SEP, null represents unassigned bay group.
Type integer or null
Read Only True

PendingZoneConfiguration

PendingZoneConfiguration.HostPort (array) Member of HpeServerAccHddZone.v1_0_0.HpeServerAccHddZone HostPort is an array containing elements of:

HostPort[{item}].BayNumber (array) Member of HpeServerAccHddZone.v1_0_0.HpeServerAccHddZone BayNumber is an array containing elements of:
Type integer
Read Only True

HostPort[{item}].PortNumber Member of HpeServerAccHddZone.v1_0_0.HpeServerAccHddZone
Description Represents the number of physical host ports in SEP, null represents unassigned bay group.
Type integer or null
Read Only True

SEPNodeId

Member of HpeServerAccHddZone.v1_0_0.HpeServerAccHddZone
Description The node ID represent the node ID where the storage enclosure processor is residing.
Type integer
Read Only True
Added iLO 5 1.20

TypeID

Member of HpeServerAccHddZone.v1_0_0.HpeServerAccHddZone
Description Indicates the Backplane type ID for the identifier for backplane type.
Type integer
Read Only True
Added iLO 5 1.20

Actions

HpeServerAccHddZone.BackupConfigurationToBmc Member of HpeServerAccHddZone.v1_0_0.HpeServerAccHddZone Backup Apollo Chassis Controller Hdd zone configuration to BMC.

There are no parameters for this action.

HpeServerAccHddZone.ConfigureZone Member of HpeServerAccHddZone.v1_0_0.HpeServerAccHddZone Execute Apollo Chassis Controller Hdd zone configuration.

Parameters:

HostPort (array)

HpeServerAccHddZone.LoadDefault Member of HpeServerAccHddZone.v1_0_0.HpeServerAccHddZone Load Apollo Chassis Controller default Hdd zone configuration.

There are no parameters for this action.

HpeServerAccPowerCalibration.v1_0_0.HpeServerAccPowerCalibration

@odata.type: "#HpeServerAccPowerCalibration.v1_0_0.HpeServerAccPowerCalibration"

The HpeServerAccPowerCalibration resource describes the properties for management of shared power in an enclosure.

This resource type was added in iLO 5 1.20 and is available on HPE ProLiant Apollo XL systems.

Resource Instances

Uri HTTP Allow
/redfish/v1/chassis/{item}/power/accpowerservice/calibration GET POST

CalibrationData

CalibrationData.EndTime Member of HpeServerAccPowerCalibration.v1_0_0.HpeServerAccPowerCalibration
Description The calibration end time stamp.
Type string
Read Only True
Added iLO 5 1.20

CalibrationData.StartTime Member of HpeServerAccPowerCalibration.v1_0_0.HpeServerAccPowerCalibration
Description The calibration start time stamp.
Type string
Read Only True
Added iLO 5 1.20

CalibrationData.State Member of HpeServerAccPowerCalibration.v1_0_0.HpeServerAccPowerCalibration
Description Specifies whether the calibration is valid or not.
Type boolean
Read Only True
Added iLO 5 1.20

CalibrationData.ThrottlePeakPower CalibrationData.ThrottlePeakPower.Percent_000 Member of HpeServerAccPowerCalibration.v1_0_0.HpeServerAccPowerCalibration
Description The peak power of 0 Percent throttling.
Type integer
Read Only True
Added iLO 5 1.20

CalibrationData.ThrottlePeakPower.Percent_005 Member of HpeServerAccPowerCalibration.v1_0_0.HpeServerAccPowerCalibration
Description The peak power of 5 Percent throttling.
Type integer
Read Only True
Added iLO 5 1.20

CalibrationData.ThrottlePeakPower.Percent_010 Member of HpeServerAccPowerCalibration.v1_0_0.HpeServerAccPowerCalibration
Description The peak power of 10 Percent throttling.
Type integer
Read Only True
Added iLO 5 1.20

CalibrationData.ThrottlePeakPower.Percent_015 Member of HpeServerAccPowerCalibration.v1_0_0.HpeServerAccPowerCalibration
Description The peak power of 15 Percent throttling.
Type integer
Read Only True
Added iLO 5 1.20

CalibrationData.ThrottlePeakPower.Percent_020 Member of HpeServerAccPowerCalibration.v1_0_0.HpeServerAccPowerCalibration
Description The peak power of 20 Percent throttling.
Type integer
Read Only True
Added iLO 5 1.20

CalibrationData.ThrottlePeakPower.Percent_025 Member of HpeServerAccPowerCalibration.v1_0_0.HpeServerAccPowerCalibration
Description The peak power of 25 Percent throttling.
Type integer
Read Only True
Added iLO 5 1.20

CalibrationData.ThrottlePeakPower.Percent_030 Member of HpeServerAccPowerCalibration.v1_0_0.HpeServerAccPowerCalibration
Description The peak power of 30 Percent throttling.
Type integer
Read Only True
Added iLO 5 1.20

CalibrationData.ThrottlePeakPower.Percent_035 Member of HpeServerAccPowerCalibration.v1_0_0.HpeServerAccPowerCalibration
Description The peak power of 35 Percent throttling.
Type integer
Read Only True
Added iLO 5 1.20

CalibrationData.ThrottlePeakPower.Percent_040 Member of HpeServerAccPowerCalibration.v1_0_0.HpeServerAccPowerCalibration
Description The peak power of 40 Percent throttling.
Type integer
Read Only True
Added iLO 5 1.20

CalibrationData.ThrottlePeakPower.Percent_045 Member of HpeServerAccPowerCalibration.v1_0_0.HpeServerAccPowerCalibration
Description The peak power of 45 Percent throttling.
Type integer
Read Only True
Added iLO 5 1.20

CalibrationData.ThrottlePeakPower.Percent_050 Member of HpeServerAccPowerCalibration.v1_0_0.HpeServerAccPowerCalibration
Description The peak power of 50 Percent throttling.
Type integer
Read Only True
Added iLO 5 1.20

CalibrationData.ThrottlePeakPower.Percent_055 Member of HpeServerAccPowerCalibration.v1_0_0.HpeServerAccPowerCalibration
Description The peak power of 55 Percent throttling.
Type integer
Read Only True
Added iLO 5 1.20

CalibrationData.ThrottlePeakPower.Percent_060 Member of HpeServerAccPowerCalibration.v1_0_0.HpeServerAccPowerCalibration
Description The peak power of 60 Percent throttling.
Type integer
Read Only True
Added iLO 5 1.20

CalibrationData.ThrottlePeakPower.Percent_065 Member of HpeServerAccPowerCalibration.v1_0_0.HpeServerAccPowerCalibration
Description The peak power of 65 Percent throttling.
Type integer
Read Only True
Added iLO 5 1.20

CalibrationData.ThrottlePeakPower.Percent_070 Member of HpeServerAccPowerCalibration.v1_0_0.HpeServerAccPowerCalibration
Description The peak power of 70 Percent throttling.
Type integer
Read Only True
Added iLO 5 1.20

CalibrationData.ThrottlePeakPower.Percent_075 Member of HpeServerAccPowerCalibration.v1_0_0.HpeServerAccPowerCalibration
Description The peak power of 75 Percent throttling.
Type integer
Read Only True
Added iLO 5 1.20

CalibrationData.ThrottlePeakPower.Percent_080 Member of HpeServerAccPowerCalibration.v1_0_0.HpeServerAccPowerCalibration
Description The peak power of 80 Percent throttling.
Type integer
Read Only True
Added iLO 5 1.20

CalibrationData.ThrottlePeakPower.Percent_085 Member of HpeServerAccPowerCalibration.v1_0_0.HpeServerAccPowerCalibration
Description The peak power of 85 Percent throttling.
Type integer
Read Only True
Added iLO 5 1.20

CalibrationData.ThrottlePeakPower.Percent_090 Member of HpeServerAccPowerCalibration.v1_0_0.HpeServerAccPowerCalibration
Description The peak power of 90 Percent throttling.
Type integer
Read Only True
Added iLO 5 1.20

CalibrationData.ThrottlePeakPower.Percent_095 Member of HpeServerAccPowerCalibration.v1_0_0.HpeServerAccPowerCalibration
Description The peak power of 95 Percent throttling.
Type integer
Read Only True
Added iLO 5 1.20

CalibrationData.ThrottlePeakPower.Percent_100 Member of HpeServerAccPowerCalibration.v1_0_0.HpeServerAccPowerCalibration
Description The peak power of 100 Percent throttling.
Type integer
Read Only True
Added iLO 5 1.20

CalibrationData.ZoneNumber Member of HpeServerAccPowerCalibration.v1_0_0.HpeServerAccPowerCalibration
Description The zone number either on the entire chassis or specific zone. 0 for entire chassis, other number is for specific zone.
Type integer
Read Only True
Added iLO 5 1.20

CalibrationInProgress

Member of HpeServerAccPowerCalibration.v1_0_0.HpeServerAccPowerCalibration
Description The current state of the chassis power zone calibration task.
Type boolean
Read Only True
Added iLO 5 1.20

Actions

HpeServerAccPowerCalibration.Calibrate Member of HpeServerAccPowerCalibration.v1_0_0.HpeServerAccPowerCalibration Execute the Apollo Chassis Controller power calibration configuration.

Parameters:

ActionType (string)

Value Description
Start
Stop

AllZone (boolean)

EEPROMSaveEnabled (boolean)

Seconds (integer)

ZoneNumber (integer)

HpeServerAccPowerLimit.v1_0_0.HpeServerAccPowerLimit

@odata.type: "#HpeServerAccPowerLimit.v1_0_0.HpeServerAccPowerLimit"

The HpeServerAccPowerLimit resource describes the properties for management of shared power in an enclosure.

This resource type was added in iLO 5 1.20 and is available on HPE ProLiant Apollo XL systems.

Resource Instances

Uri HTTP Allow
/redfish/v1/chassis/{item}/power/accpowerservice/powerlimit GET POST

ActualPowerLimits (array)

Member of HpeServerAccPowerLimit.v1_0_0.HpeServerAccPowerLimit ActualPowerLimits is an array containing elements of:

ActualPowerLimits[{item}].PowerLimitInWatts Member of HpeServerAccPowerLimit.v1_0_0.HpeServerAccPowerLimit
Description The actual power limit (in watts) for the zone, it will be set to null when power limit disabled.
Type integer or null
Read Only False
Added iLO 5 1.20

ActualPowerLimits[{item}].ZoneNumber Member of HpeServerAccPowerLimit.v1_0_0.HpeServerAccPowerLimit
Description The zone number either on the entire chassis or specific zone. 0 for entire chassis, other number is for specific zone.
Type integer
Read Only True
Added iLO 5 1.20

PowerLimitRanges (array)

Member of HpeServerAccPowerLimit.v1_0_0.HpeServerAccPowerLimit PowerLimitRanges is an array containing elements of:

PowerLimitRanges[{item}].MaximumPowerLimit Member of HpeServerAccPowerLimit.v1_0_0.HpeServerAccPowerLimit
Description The Maximum power limit (in watts) for the zone.
Type integer
Read Only True
Added iLO 5 1.20

PowerLimitRanges[{item}].MinimumPowerLimit Member of HpeServerAccPowerLimit.v1_0_0.HpeServerAccPowerLimit
Description The Minimum power limit (in watts) for the zone.
Type integer
Read Only True
Added iLO 5 1.20

PowerLimitRanges[{item}].ZoneNumber Member of HpeServerAccPowerLimit.v1_0_0.HpeServerAccPowerLimit
Description The zone number either on the entire chassis or specific zone. 0 for entire chassis, other number is for specific zone.
Type integer
Read Only True
Added iLO 5 1.20

PowerLimits (array)

Member of HpeServerAccPowerLimit.v1_0_0.HpeServerAccPowerLimit PowerLimits is an array containing elements of:

PowerLimits[{item}].PowerLimitInWatts Member of HpeServerAccPowerLimit.v1_0_0.HpeServerAccPowerLimit
Description The target power limit (in watts) for the zone, it will be set to null when power limit disabled.
Type integer or null
Read Only False
Added iLO 5 1.20

PowerLimits[{item}].ZoneNumber Member of HpeServerAccPowerLimit.v1_0_0.HpeServerAccPowerLimit
Description The zone number either on the entire chassis or specific zone. 0 for entire chassis, other number is for specific zone.
Type integer
Read Only True
Added iLO 5 1.20

Actions

HpeServerAccPowerLimit.ConfigurePowerLimit Member of HpeServerAccPowerLimit.v1_0_0.HpeServerAccPowerLimit Deploy the Apollo Chassis Controller power limit configuration.

Parameters:

PowerLimits (array)

HpeServerAccPowerNodesInfo.v1_0_0.HpeServerAccPowerNodesInfo

@odata.type: "#HpeServerAccPowerNodesInfo.v1_0_0.HpeServerAccPowerNodesInfo"

The HpeServerAccPowerNodesInfo resource describes the properties for management of shared power in an enclosure.

This resource type was added in iLO 5 1.20 and is available on HPE ProLiant Apollo XL systems.

Resource Instances

Uri HTTP Allow
/redfish/v1/chassis/{item}/power/accpowerservice/nodesinfo GET

MaxSupportedNodes

Member of HpeServerAccPowerNodesInfo.v1_0_0.HpeServerAccPowerNodesInfo
Description Total Nodes supported in Chassis.
Type integer
Read Only True
Added iLO 5 1.20

NodeInfoList (array)

Member of HpeServerAccPowerNodesInfo.v1_0_0.HpeServerAccPowerNodesInfo NodeInfoList is an array containing elements of:

NodeInfoList[{item}].NodeNumber Member of HpeServerAccPowerNodesInfo.v1_0_0.HpeServerAccPowerNodesInfo
Description The physical node number in chassis.
Type integer
Read Only True
Added iLO 5 1.20

NodeInfoList[{item}].Throttle Member of HpeServerAccPowerNodesInfo.v1_0_0.HpeServerAccPowerNodesInfo
Description It indicates the current throttle on the node. (PWM %)
Type integer
Read Only True
Added iLO 5 1.20

NodeInfoList[{item}].WarningStatus Member of HpeServerAccPowerNodesInfo.v1_0_0.HpeServerAccPowerNodesInfo
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
Type boolean
Read Only True
Added iLO 5 1.20

HpeServerAccPowerService.v1_0_0.HpeServerAccPowerService

@odata.type: "#HpeServerAccPowerService.v1_0_0.HpeServerAccPowerService"

The HpeServerAccPowerService resource describes the properties for management of shared power in an enclosure.

This resource type was added in iLO 5 1.20 and is available on HPE ProLiant Apollo XL systems.

Resource Instances

Uri HTTP Allow
/redfish/v1/chassis/{item}/power/accpowerservice GET PATCH

EEPROMSaveEnabled

Member of HpeServerAccPowerService.v1_0_0.HpeServerAccPowerService
Description Determines whether the EEPROM save is enabled or disabled.
Type boolean
Read Only False
Added iLO 5 1.20

PowerRegulationEnabled

Member of HpeServerAccPowerService.v1_0_0.HpeServerAccPowerService
Description Determines whether power regulation is enabled or disabled.
Type boolean
Read Only False
Added iLO 5 1.20

PowerRegulatorMode

Member of HpeServerAccPowerService.v1_0_0.HpeServerAccPowerService
Type string
Read Only False
Added iLO 5 1.20

The following are the supported values:

Value Description
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.

HpeServerAccPowerZone.v1_0_0.HpeServerAccPowerZone

@odata.type: "#HpeServerAccPowerZone.v1_0_0.HpeServerAccPowerZone"

The HpeServerAccPowerZone resource describes the properties for management of shared power in an enclosure.

This resource type was added in iLO 5 1.20 and is available on HPE ProLiant Apollo XL systems.

Resource Instances

Uri HTTP Allow
/redfish/v1/chassis/{item}/power/accpowerservice/zone GET POST

ZoneConfiguration

ZoneConfiguration.Zone (array) Member of HpeServerAccPowerZone.v1_0_0.HpeServerAccPowerZone Zone is an array containing elements of:

Zone[{item}].Node (array) Member of HpeServerAccPowerZone.v1_0_0.HpeServerAccPowerZone Node is an array containing elements of:

Node[{item}].NodeNumber Member of HpeServerAccPowerZone.v1_0_0.HpeServerAccPowerZone
Description The node number of zone configuration.
Type integer
Read Only True

Node[{item}].NodePriority Member of HpeServerAccPowerZone.v1_0_0.HpeServerAccPowerZone
Description The power regulation node priority, the range must between 1 - 5. 5 is default and lowest priority.
Type integer
Read Only True

Zone[{item}].ZoneNumber Member of HpeServerAccPowerZone.v1_0_0.HpeServerAccPowerZone
Description The zone number of zone configuration.
Type integer
Read Only True

Zone[{item}].ZonePriority Member of HpeServerAccPowerZone.v1_0_0.HpeServerAccPowerZone
Description The power regulation zone priority, the range must between 1 - 5. 5 is default and lowest priority.
Type integer
Read Only True

Actions

HpeServerAccPowerZone.ConfigureZone Member of HpeServerAccPowerZone.v1_0_0.HpeServerAccPowerZone Execute the Apollo Chassis Controller power regulation zone configuration.

Parameters:

Zone (array)

HpeServerBootSettings.v2_0_0.HpeServerBootSettings

@odata.type: "#HpeServerBootSettings.v2_0_0.HpeServerBootSettings"

The schema definition of the server UEFI Boot Order resource.

Resource Instances

Uri HTTP Allow
/redfish/v1/systems/{item}/bios/boot GET
/redfish/v1/systems/{item}/bios/boot/settings GET PATCH
Link Name Destination type
@Redfish.Settings/SettingsObject HpeServerBootSettings
Oem/Hpe/Links/BaseConfigs HpeBaseConfigs

@Redfish.Settings

Member of HpeServerBootSettings.v2_0_0.HpeServerBootSettings See the Redfish standard schema and specification for information on common @Redfish properties.

BootSources (array)

Member of HpeServerBootSettings.v2_0_0.HpeServerBootSettings BootSources is an array containing elements of:

BootSources[{item}].BootString Member of HpeServerBootSettings.v2_0_0.HpeServerBootSettings
Description User-readable string that describes the UEFI boot option.
Type string
Read Only True

BootSources[{item}].CorrelatableID Member of HpeServerBootSettings.v2_0_0.HpeServerBootSettings
Description Contains any CorrelatableIDs that represent this boot option. The correlatableID values can be JSON Pointers or UEFI identifiers.
Type string
Read Only True

BootSources[{item}].StructuredBootString Member of HpeServerBootSettings.v2_0_0.HpeServerBootSettings
Description Uniquely identifies this boot option within the server.
Type string
Read Only True

BootSources[{item}].UEFIDevicePath Member of HpeServerBootSettings.v2_0_0.HpeServerBootSettings
Description Standardized text representation of the UEFI device path for this boot option, in UTF-8 format.
Type string
Read Only True

DefaultBootOrder (array)

Member of HpeServerBootSettings.v2_0_0.HpeServerBootSettings DefaultBootOrder is an array containing elements of:
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.
Type string
Read Only True

The following are the supported values:

Value
UefiShell
Floppy
Cd
Usb
EmbeddedStorage
PcieSlotStorage
EmbeddedFlexLOM
PcieSlotNic

DesiredBootDevices (array)

Member of HpeServerBootSettings.v2_0_0.HpeServerBootSettings DesiredBootDevices is an array containing elements of:

DesiredBootDevices[{item}].CorrelatableID Member of HpeServerBootSettings.v2_0_0.HpeServerBootSettings
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)’
Type string
Read Only False

DesiredBootDevices[{item}].Lun Member of HpeServerBootSettings.v2_0_0.HpeServerBootSettings
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’).
Type string
Read Only False

DesiredBootDevices[{item}].Wwn Member of HpeServerBootSettings.v2_0_0.HpeServerBootSettings
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’).
Type string
Read Only False

DesiredBootDevices[{item}].iScsiTargetName Member of HpeServerBootSettings.v2_0_0.HpeServerBootSettings
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’).
Type string
Read Only False

PersistentBootConfigOrder (array)

Member of HpeServerBootSettings.v2_0_0.HpeServerBootSettings PersistentBootConfigOrder is an array containing elements of:
Description The structured boot string that references a corresponding entry in the BootSources array.
Type string
Read Only True

HpeServerConfigLock.v1_0_0.HpeServerConfigLock

@odata.type: "#HpeServerConfigLock.v1_0_0.HpeServerConfigLock"

The schema definition for Server Configuration Lock configuration.

Resource Instances

Uri HTTP Allow
/redfish/v1/Systems/{item}/Bios/Serverconfiglock/Settings GET PATCH
/redfish/v1/systems/{item}/bios/Serverconfiglock GET
Link Name Destination type
@Redfish.Settings/SettingsObject HpeServerConfigLock
Oem/Hpe/Links/BaseConfigs HpeBaseConfigs

@Redfish.Settings

Member of HpeServerConfigLock.v1_0_0.HpeServerConfigLock See the Redfish standard schema and specification for information on common @Redfish properties.

NewServerConfigLockPassword

Member of HpeServerConfigLock.v1_0_0.HpeServerConfigLock
Description The new Server Configuration Lock password. This field is used to update the current Server Configuration Lock password and force the system configuration digital fingerprint to be recalculated.
Type string or null
Read Only True

ServerConfigLockChallenge

Member of HpeServerConfigLock.v1_0_0.HpeServerConfigLock
Description Select this option to enable or disable a Server Configuration Lock password challenge on every boot.
Type string
Read Only False

The following are the supported values:

Value Description
Disabled Disable Server Configuration Lock password challenge on every boot.
Enabled Enable Server Configuration Lock password challenge on every boot.
Null A value is temporarily unavailable

ServerConfigLockDisable

Member of HpeServerConfigLock.v1_0_0.HpeServerConfigLock
Description Select this option to disable Server Configuration Lock.
Type string
Read Only False

The following are the supported values:

Value Description
False Don’t disable Server Configuration Lock.
True Disable Server Configuration Lock.
Null A value is temporarily unavailable

ServerConfigLockExcludeCpus

Member of HpeServerConfigLock.v1_0_0.HpeServerConfigLock
Description Select this option to exclude CPU information from the Digital Fingerprint. Note that this setting only takes effect when Server Configuration Lock is enabled/reenabled.
Type string
Read Only False

The following are the supported values:

Value Description
False Do not exclude CPU information from the Digital Fingerprint.
True Exclude CPU information from the Digital Fingerprint.
Null A value is temporarily unavailable

ServerConfigLockExcludeDimms

Member of HpeServerConfigLock.v1_0_0.HpeServerConfigLock
Description Select this option to exclude DIMM information from the Digital Fingerprint. Note that this setting only takes effect when Server Configuration Lock is enabled/reenabled.
Type string
Read Only False

The following are the supported values:

Value Description
False Do not exclude DIMM information from the Digital Fingerprint.
True Exclude DIMM information from the Digital Fingerprint.
Null A value is temporarily unavailable

ServerConfigLockExcludeFwRevs

Member of HpeServerConfigLock.v1_0_0.HpeServerConfigLock
Description Select this option to exclude system firmware revisions from the Digital Fingerprint. Note that this setting only takes effect when Server Configuration Lock is enabled/reenabled.
Type string
Read Only False

The following are the supported values:

Value Description
False Do not exclude system firmware revision information from the Digital Fingerprint.
True Exclude system firmware revision information from the Digital Fingerprint.
Null A value is temporarily unavailable

ServerConfigLockExcludePciSlots

Member of HpeServerConfigLock.v1_0_0.HpeServerConfigLock
Description Select this option to exclude PCIe slot information from the Digital Fingerprint. Note that this setting only takes effect when Server Configuration Lock is enabled/reenabled.
Type string
Read Only False

The following are the supported values:

Value Description
False Do not exclude PCIe slot information from the Digital Fingerprint.
True Exclude PCIe slot information from the Digital Fingerprint.
Null A value is temporarily unavailable

ServerConfigLockExcludeSecurity

Member of HpeServerConfigLock.v1_0_0.HpeServerConfigLock
Description Select this option to exclude security configuration information from the Digital Fingerprint. Note that this setting only takes effect when Server Configuration Lock is enabled/reenabled.
Type string
Read Only False

The following are the supported values:

Value Description
False Do not exclude security configuration information from the Digital Fingerprint.
True Exclude security configuration information from the Digital Fingerprint.
Null A value is temporarily unavailable

ServerConfigLockLogStored

Member of HpeServerConfigLock.v1_0_0.HpeServerConfigLock
Description Has a Server Configuration Lock failure log been stored?
Type string
Read Only True

The following are the supported values:

Value Description
True A Server Configuration Lock failure has been logged.
False A Server Configuration Lock failure has not been logged.

ServerConfigLockPassword

Member of HpeServerConfigLock.v1_0_0.HpeServerConfigLock
Description The Server Configuration Lock password. If Server Configuration Lock is currently enabled, this field is used to convey the current Server Configuration Lock password and is required to make any Server Configuration Lock configuration changes. If Server Configuration Lock is currently disabled, this field is used to set the Server Configuration Lock password, and to digitally fingerprint the system to enable Server Configuration Lock.
Type string or null
Read Only True

ServerConfigLockState

Member of HpeServerConfigLock.v1_0_0.HpeServerConfigLock
Description Enabled/Disabled state of the Server Configuration Lock Feature.
Type string
Read Only True

The following are the supported values:

Value Description
Disabled The Server Configuration Lock feature is disabled.
Enabled The Server Configuration Lock feature is enabled.

ServerConfigLockTamperHalt

Member of HpeServerConfigLock.v1_0_0.HpeServerConfigLock
Description Select this option to enable or disable the Server Configuration Lock behavior to halt on a configuration change detection.
Type string
Read Only False

The following are the supported values:

Value Description
Disabled Disable Server Configuration Lock behavior to halt on configuration changes.
Enabled Enable Server Configuration Lock behavior to halt on configuration changes.
Null A value is temporarily unavailable

ServerConfigLockTransport

Member of HpeServerConfigLock.v1_0_0.HpeServerConfigLock
Description Select this option to enable or disable Server Configuration Lock “first-boot” behaviors. This option is expected to be enabled just prior to shipping the server. When the server arrives at its destination and is first powered on, Server Configuration Lock will require the Server Configuration Lock password in order to boot. Server Configuration Lock will also indicate if someone attempted to change the system configuration during the shipment process.
Type string
Read Only False

The following are the supported values:

Value Description
Disabled Disable Server Configuration Lock “first-boot” behaviors.
Enabled Enable Server Configuration Lock “first-boot” behaviors.
Null A value is temporarily unavailable

ServerConfigLockTransportAudit

Member of HpeServerConfigLock.v1_0_0.HpeServerConfigLock
Description Select this option to enable or disable out-of-band acknowledge of Server Configuration Lock “first-boot” behaviors (see ServerConfigLockTransport).
Type string
Read Only False

The following are the supported values:

Value Description
Disabled Disable Server Configuration Lock out-of-band acknowledge of “first-boot” audit.
Enabled Enable Server Configuration Lock out-of-band acknowledge of “first-boot” audit.
Null A value is temporarily unavailable

HpeServerDevice.v2_1_0.HpeServerDevice

@odata.type: "#HpeServerDevice.v2_1_0.HpeServerDevice"

The HpeServerDevice resource describes the properties of FRU devices.

This resource type was added in iLO 5 1.20

HpeServerDevice represents physical server devices including part information. This is especially useful for system inventory.

Resource Instances

Uri HTTP Allow
/redfish/v1/chassis/{item}/devices/{item} GET PATCH
Link Name Destination type
DeviceInstances[] HpeServerPciDevice

DeviceInstances (array)

Member of HpeServerDevice.v2_1_0.HpeServerDevice DeviceInstances is an array containing elements of:

DeviceInstances[{item}].@odata.id Member of HpeServerDevice.v2_1_0.HpeServerDevice
Type string
Read Only True
Format uri-reference

DeviceType

Member of HpeServerDevice.v2_1_0.HpeServerDevice
Description Device type.
Type string
Read Only True

The following are the supported values:

Value Description
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

FirmwareVersion

FirmwareVersion.Current FirmwareVersion.Current.VersionString Member of HpeServerDevice.v2_1_0.HpeServerDevice
Description This string represents the version of the firmware image.
Type string or null
Read Only True

FirmwareVersion.FirmwareVersions (array) Member of HpeServerDevice.v2_1_0.HpeServerDevice FirmwareVersions is an array containing elements of:

FirmwareVersions[{item}].ComponentName Member of HpeServerDevice.v2_1_0.HpeServerDevice
Description Name of GPU cores
Type string or null
Read Only True

FirmwareVersions[{item}].VersionString Member of HpeServerDevice.v2_1_0.HpeServerDevice
Description Version String of GPU cores
Type string or null
Read Only True

Location

Member of HpeServerDevice.v2_1_0.HpeServerDevice
Description Location of the device.
Type string or null
Read Only True

MCTPProtocolDisabled

Member of HpeServerDevice.v2_1_0.HpeServerDevice
Description Set to true to disable MCTP on this slot. Once disabled, can be enabled only through MCTP factory reset.
Type boolean
Read Only False

Manufacturer

Member of HpeServerDevice.v2_1_0.HpeServerDevice
Description Device manufacturer.
Type string or null
Read Only True

PartNumber

Member of HpeServerDevice.v2_1_0.HpeServerDevice
Description Board part Number which is HPE PCA Assembly Number.
Type string or null
Read Only True

ProductPartNumber

Member of HpeServerDevice.v2_1_0.HpeServerDevice
Description Product Part Number.
Type string or null
Read Only True

ProductVersion

Member of HpeServerDevice.v2_1_0.HpeServerDevice
Description Product Version.
Type string or null
Read Only True

SerialNumber

Member of HpeServerDevice.v2_1_0.HpeServerDevice
Description Product Serial Number.
Type string or null
Read Only True

Status

Member of HpeServerDevice.v2_1_0.HpeServerDevice See the Redfish standard schema and specification for information on common Status object.

HpeServerDeviceCollection.HpeServerDeviceCollection

@odata.type: "#HpeServerDeviceCollection.HpeServerDeviceCollection"

A Collection of HpeServerDevice resource instances.

Resource Instances

Uri HTTP Allow
/redfish/v1/chassis/{item}/devices GET
Link Name Destination type
Members[] HpeServerDevice

Members (array)

Member of HpeServerDeviceCollection.HpeServerDeviceCollection Members is an array containing elements of:

Members[{item}].@odata.id Member of HpeServerDeviceCollection.HpeServerDeviceCollection
Type string
Read Only True
Format uri-reference

Members@odata.count

Member of HpeServerDeviceCollection.HpeServerDeviceCollection
Description The total number of collection members.
Type integer
Read Only True

HpeServerPciDevice.v2_0_0.HpeServerPciDevice

@odata.type: "#HpeServerPciDevice.v2_0_0.HpeServerPciDevice"

The HpeServerPciDevice resource describes the properties of PCI devices.

Resource Instances

Uri HTTP Allow
/redfish/v1/systems/{item}/pcidevices/{item} GET

BayNumber

Member of HpeServerPciDevice.v2_0_0.HpeServerPciDevice
Description Bay number value.
Type integer
Read Only True
Added iLO 5 1.10

Bifurcated

Member of HpeServerPciDevice.v2_0_0.HpeServerPciDevice
Description Indicates if the PCIe device support bifurcation.
Type string
Read Only True

The following are the supported values:

Value Description
BifurcationNotSupported This device does not support Bifurcation.
BifurcationSupportedPrimaryDevice This device does support Bifurcation.
BifurcationSupportedSecondaryDevice This is second bifurcated device.

The link to the next bifurcated devices. BifurcatedSecondaryDeviceLink is a link ("@odata.id": URI) to another resource.

BusNumber

Member of HpeServerPciDevice.v2_0_0.HpeServerPciDevice
Description PCI device bus number value.
Type integer
Read Only True
Added iLO 5 1.10

ClassCode

Member of HpeServerPciDevice.v2_0_0.HpeServerPciDevice
Description PCI class code of the endpoint.
Type integer
Read Only True
Added iLO 5 1.10

DeviceID

Member of HpeServerPciDevice.v2_0_0.HpeServerPciDevice
Description PCI device ID of the device.
Type integer
Read Only True
Added iLO 5 1.10

DeviceInstance

Member of HpeServerPciDevice.v2_0_0.HpeServerPciDevice
Description PCI device instance value.
Type integer
Read Only True
Added iLO 5 1.10

DeviceLocation

Member of HpeServerPciDevice.v2_0_0.HpeServerPciDevice
Description PCI device location.
Type string
Read Only True
Added iLO 5 1.10

DeviceNumber

Member of HpeServerPciDevice.v2_0_0.HpeServerPciDevice
Description PCI device number value.
Type integer
Read Only True
Added iLO 5 1.10

DeviceSubInstance

Member of HpeServerPciDevice.v2_0_0.HpeServerPciDevice
Description PCI device sub-instance value.
Type integer
Read Only True
Added iLO 5 1.10

DeviceType

Member of HpeServerPciDevice.v2_0_0.HpeServerPciDevice
Description Device type value.
Type string
Read Only True
Added iLO 5 1.10

The following are the supported values:

Value Description
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

EnclosureNumber

Member of HpeServerPciDevice.v2_0_0.HpeServerPciDevice
Description Enclosure number value.
Type integer
Read Only True
Added iLO 5 1.10

FunctionNumber

Member of HpeServerPciDevice.v2_0_0.HpeServerPciDevice
Description PCI device function number value.
Type integer
Read Only True
Added iLO 5 1.10

LocationString

Member of HpeServerPciDevice.v2_0_0.HpeServerPciDevice
Description Text representation of the UEFI device location, in UTF-8 format
Type string
Read Only True
Added iLO 5 1.10

SegmentNumber

Member of HpeServerPciDevice.v2_0_0.HpeServerPciDevice
Description PCI segment group number value.
Type integer
Read Only True
Added iLO 5 1.10

StructuredName

Member of HpeServerPciDevice.v2_0_0.HpeServerPciDevice
Description PCI device structured name in UTF-8 format.
Type string
Read Only True
Added iLO 5 1.10

SubclassCode

Member of HpeServerPciDevice.v2_0_0.HpeServerPciDevice
Description PCI sub class code of the endpoint.
Type integer
Read Only True
Added iLO 5 1.10

SubsystemDeviceID

Member of HpeServerPciDevice.v2_0_0.HpeServerPciDevice
Description PCI subsystem device ID of the device.
Type integer
Read Only True
Added iLO 5 1.10

SubsystemVendorID

Member of HpeServerPciDevice.v2_0_0.HpeServerPciDevice
Description PCI subsystem vendor ID of the device.
Type integer
Read Only True
Added iLO 5 1.10

UEFIDevicePath

Member of HpeServerPciDevice.v2_0_0.HpeServerPciDevice
Description Standardized text representation of the UEFI device path, in UTF-8 format.
Type string
Read Only True
Added iLO 5 1.10

VendorID

Member of HpeServerPciDevice.v2_0_0.HpeServerPciDevice
Description PCI vendor ID of the device.
Type integer
Read Only True
Added iLO 5 1.10

HpeServerPciDeviceCollection.HpeServerPciDeviceCollection

@odata.type: "#HpeServerPciDeviceCollection.HpeServerPciDeviceCollection"

A Collection of HpeServerPciDevice resource instances.

Resource Instances

Uri HTTP Allow
/redfish/v1/systems/{item}/pcidevices GET
Link Name Destination type
Members[] HpeServerPciDevice

Members (array)

Member of HpeServerPciDeviceCollection.HpeServerPciDeviceCollection Members is an array containing elements of:

Members[{item}].@odata.id Member of HpeServerPciDeviceCollection.HpeServerPciDeviceCollection
Type string
Read Only True
Format uri-reference

Members@odata.count

Member of HpeServerPciDeviceCollection.HpeServerPciDeviceCollection
Description The total number of collection members.
Type integer
Read Only True

HpeServerPCISlot.v2_1_1.HpeServerPCISlot

@odata.type: "#HpeServerPCISlot.v2_1_1.HpeServerPCISlot"

The HpeServerPCISlot resource describes the properties of PCI slots.

Resource Instances

Uri HTTP Allow
/redfish/v1/systems/{item}/pcislots/{item} GET

BusNumber

Member of HpeServerPCISlot.v2_1_1.HpeServerPCISlot
Description PCI slot bus number.
Type integer
Read Only True
Added iLO 5 1.20

Characteristics

Characteristics.Provides3_3Volts Member of HpeServerPCISlot.v2_1_1.HpeServerPCISlot
Description Provides 3.3 volts.
Type boolean
Read Only True
Added iLO 5 1.20

Characteristics.Provides5Volts Member of HpeServerPCISlot.v2_1_1.HpeServerPCISlot
Description Provides 5.0 volts.
Type boolean
Read Only True
Added iLO 5 1.20

Characteristics.SlotIsShared Member of HpeServerPCISlot.v2_1_1.HpeServerPCISlot
Description The slot shares its opening with another slot.
Type boolean
Read Only True
Added iLO 5 1.20

Characteristics.SupportsCardBus Member of HpeServerPCISlot.v2_1_1.HpeServerPCISlot
Description PC Card slot supports Card Bus.
Type boolean
Read Only True
Added iLO 5 1.20

Characteristics.SupportsHotPlugDevices Member of HpeServerPCISlot.v2_1_1.HpeServerPCISlot
Description Slot supports hot-plug devices.
Type boolean
Read Only True
Added iLO 5 1.20

Characteristics.SupportsModemRingResume Member of HpeServerPCISlot.v2_1_1.HpeServerPCISlot
Description PC Card slot supports Modem Ring Resume.
Type boolean
Read Only True
Added iLO 5 1.20

Characteristics.SupportsPCCard16 Member of HpeServerPCISlot.v2_1_1.HpeServerPCISlot
Description PC Card slot supports PC Card-16.
Type boolean
Read Only True
Added iLO 5 1.20

Characteristics.SupportsPowerManagementEventSignal Member of HpeServerPCISlot.v2_1_1.HpeServerPCISlot
Description PCI slot supports Power Management Event signal.
Type boolean
Read Only True
Added iLO 5 1.20

Characteristics.SupportsSMBusSignal Member of HpeServerPCISlot.v2_1_1.HpeServerPCISlot
Description PCI slot supports SMBUS signal.
Type boolean
Read Only True
Added iLO 5 1.20

Characteristics.SupportsZoomVideo Member of HpeServerPCISlot.v2_1_1.HpeServerPCISlot
Description PC Card slot supports Zoom Video.
Type boolean
Read Only True
Added iLO 5 1.20

DeviceNumber

Member of HpeServerPCISlot.v2_1_1.HpeServerPCISlot
Description PCI slot device number.
Type integer
Read Only True
Added iLO 5 1.20

FunctionNumber

Member of HpeServerPCISlot.v2_1_1.HpeServerPCISlot
Description PCI slot function number.
Type integer
Read Only True
Added iLO 5 1.20

Length

Member of HpeServerPCISlot.v2_1_1.HpeServerPCISlot
Description PCI slot length
Type string
Read Only True
Added iLO 5 1.10

The following are the supported values:

Value
Short
Long
Other

LinkLanes

Member of HpeServerPCISlot.v2_1_1.HpeServerPCISlot
Description Bandwidth capacity of the slot, measured by the number of PCI Express Lanes present. Also known as the slot width.
Type string
Read Only True
Added iLO 5 1.10

The following are the supported values:

Value
8 bit
16 bit
32 bit
64 bit
128 bit
x1
x2
x4
x8
x16
x32
Other

Status

Member of HpeServerPCISlot.v2_1_1.HpeServerPCISlot See the Redfish standard schema and specification for information on common Status object.

SupportsHotPlug

Member of HpeServerPCISlot.v2_1_1.HpeServerPCISlot
Description Specifies whether the slot supports hot-plug devices.
Type boolean
Read Only True
Added iLO 5 1.10

Technology

Member of HpeServerPCISlot.v2_1_1.HpeServerPCISlot
Description PCI technology
Type string
Read Only True
Added iLO 5 1.10

The following are the supported values:

Value
Proprietary
OCP NIC 3.0
PCIExpressGen5
PCIExpressGen4
PCIExpressGen3
PCIExpressGen2
PCIExpress

UEFIDevicePath

Member of HpeServerPCISlot.v2_1_1.HpeServerPCISlot
Description Standardized text representation of the UEFI device path, in UTF-8 format
Type string
Read Only True
Added iLO 5 1.10

HpeServerPCISlotCollection.HpeServerPCISlotCollection

@odata.type: "#HpeServerPCISlotCollection.HpeServerPCISlotCollection"

A Collection of HpeServerPCISlot resource instances.

Resource Instances

Uri HTTP Allow
/redfish/v1/systems/{item}/pcislots GET
Link Name Destination type
Members[] HpeServerPCISlot

Members (array)

Member of HpeServerPCISlotCollection.HpeServerPCISlotCollection Members is an array containing elements of:

Members[{item}].@odata.id Member of HpeServerPCISlotCollection.HpeServerPCISlotCollection
Type string
Read Only True
Format uri-reference

Members@odata.count

Member of HpeServerPCISlotCollection.HpeServerPCISlotCollection
Description The total number of collection members.
Type integer
Read Only True

HpeSmartStorage.v2_0_0.HpeSmartStorage

@odata.type: "#HpeSmartStorage.v2_0_0.HpeSmartStorage"

The HpeSmartStorage resource describes the properties of the HPE Smart Storage controller,drives,and volumes.

Resource Instances

Uri HTTP Allow
/redfish/v1/systems/{item}/smartstorage GET
Link Name Destination type
Links/ArrayControllers Collection of HpeSmartStorageArrayController
Links/HostBusAdapters Collection of HpeSmartStorageHostBusAdapter

Status

Member of HpeSmartStorage.v2_0_0.HpeSmartStorage See the Redfish standard schema and specification for information on common Status object.

HpeSmartStorageArrayController.v2_2_0.HpeSmartStorageArrayController

@odata.type: "#HpeSmartStorageArrayController.v2_2_0.HpeSmartStorageArrayController"

The HpeSmartStorageArrayController resource describes the properties of the HPE Smart Storage controller,drives,and volumes.

Resource Instances

Uri HTTP Allow
/redfish/v1/systems/{item}/smartstorage/arraycontrollers/{item} GET
Link Name Destination type
Links/LogicalDrives Collection of HpeSmartStorageLogicalDrive
Links/PhysicalDrives Collection of HpeSmartStorageDiskDrive
Links/StorageEnclosures Collection of HpeSmartStorageStorageEnclosure
Links/UnconfiguredDrives Collection of HpeSmartStorageDiskDrive

AdapterType

Member of HpeSmartStorageArrayController.v2_2_0.HpeSmartStorageArrayController
Description Type of Smart controller
Type string
Read Only True
Added iLO 5 1.10

The following are the supported values:

Value Description
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

ArrayCount

Member of HpeSmartStorageArrayController.v2_2_0.HpeSmartStorageArrayController
Description The number of arrays configured on this controller
Type integer
Read Only True
Added iLO 5 1.10

BackupPowerSourceStatus

Member of HpeSmartStorageArrayController.v2_2_0.HpeSmartStorageArrayController
Description The current status of the backup power source (battery, capacitor, megacell etc.)
Type string
Read Only True
Added iLO 5 1.10

The following are the supported values:

Value Description
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

BootVolumePrimary

Member of HpeSmartStorageArrayController.v2_2_0.HpeSmartStorageArrayController
Description The primary boot volume of this controller
Type string
Read Only True
Added iLO 5 1.10

BootVolumeSecondary

Member of HpeSmartStorageArrayController.v2_2_0.HpeSmartStorageArrayController
Description The secondary boot volume of this controller
Type string
Read Only True
Added iLO 5 1.10

CacheArrayCount

Member of HpeSmartStorageArrayController.v2_2_0.HpeSmartStorageArrayController
Description The number of cache arrays configured on this controller
Type integer
Read Only True
Added iLO 5 1.10

CacheLogicalDriveCount

Member of HpeSmartStorageArrayController.v2_2_0.HpeSmartStorageArrayController
Description The number of cache logical drives configured on this controller
Type integer
Read Only True
Added iLO 5 1.10

CacheMemorySizeMiB

Member of HpeSmartStorageArrayController.v2_2_0.HpeSmartStorageArrayController
Description The total cache memory size for the controller in MiB
Type integer
Read Only True
Added iLO 5 1.10

CacheModuleSerialNumber

Member of HpeSmartStorageArrayController.v2_2_0.HpeSmartStorageArrayController
Description The serial number of the Cache Module.
Type string
Read Only True
Added iLO 5 1.20

CacheModuleStatus

CacheModuleStatus.Health Member of HpeSmartStorageArrayController.v2_2_0.HpeSmartStorageArrayController
Description This represents the health state of this resource in the absence of its dependent resources.
Type string or null
Read Only True
Added iLO 5 1.40

The following are the supported values:

Value Description
Null A value is temporarily unavailable
OK Normal
Warning A condition exists that requires attention
Critical A critical condition exists that requires immediate attention

CacheModuleStatus.HealthRollup Member of HpeSmartStorageArrayController.v2_2_0.HpeSmartStorageArrayController
Description This represents the overall health state from the view of this resource.
Type string or null
Read Only True
Added iLO 5 1.40

The following are the supported values:

Value Description
Null A value is temporarily unavailable
OK Normal
Warning A condition exists that requires attention
Critical A critical condition exists that requires immediate attention

CacheModuleStatus.State Member of HpeSmartStorageArrayController.v2_2_0.HpeSmartStorageArrayController
Description This indicates the known state of the resource, such as if it is enabled.
Type string or null
Read Only True
Added iLO 5 1.40

The following are the supported values:

Value Description
Null A value is temporarily unavailable
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.

CachePhysicalDriveCount

Member of HpeSmartStorageArrayController.v2_2_0.HpeSmartStorageArrayController
Description The number of physical drives assigned as cache drives attached to this controller
Type integer
Read Only True
Added iLO 5 1.10

ControllerBoard

ControllerBoard.Status Member of HpeSmartStorageArrayController.v2_2_0.HpeSmartStorageArrayController See the Redfish standard schema and specification for information on common Status object.

ControllerPartNumber

Member of HpeSmartStorageArrayController.v2_2_0.HpeSmartStorageArrayController
Description Smart Array Controller Part Number
Type string
Read Only True
Added iLO 5 1.10

CurrentOperatingMode

Member of HpeSmartStorageArrayController.v2_2_0.HpeSmartStorageArrayController
Description The current operating mode of the controller.
Type string
Read Only True
Added iLO 5 1.10

The following are the supported values:

Value Description
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

CurrentParallelSurfaceScanCount

Member of HpeSmartStorageArrayController.v2_2_0.HpeSmartStorageArrayController
Description Number of disks the controller is scanning in parallel
Type integer
Read Only True
Added iLO 5 1.10

DataLogicalDriveCount

Member of HpeSmartStorageArrayController.v2_2_0.HpeSmartStorageArrayController
Description The number of data logical drives configured on this controller
Type integer
Read Only True
Added iLO 5 1.10

DataPhysicalDriveCount

Member of HpeSmartStorageArrayController.v2_2_0.HpeSmartStorageArrayController
Description The number of physical drives assigned as data drives attached to this controller
Type integer
Read Only True
Added iLO 5 1.10

DegradedPerformanceOptimization

Member of HpeSmartStorageArrayController.v2_2_0.HpeSmartStorageArrayController
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
Type string
Read Only True
Added iLO 5 1.10

The following are the supported values:

Value Description
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

DriveWriteCache

Member of HpeSmartStorageArrayController.v2_2_0.HpeSmartStorageArrayController
Description Enables or disables the write cache of the physical drives attached to the controller
Type string
Read Only True
Added iLO 5 1.10

The following are the supported values:

Value Description
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

DualModeControllerSupported

Member of HpeSmartStorageArrayController.v2_2_0.HpeSmartStorageArrayController
Description True if the controller will support BMIC and RDE.
Type boolean
Read Only True

ElevatorSort

Member of HpeSmartStorageArrayController.v2_2_0.HpeSmartStorageArrayController
Description Enables the controller to sort requests to a physical drive
Type string
Read Only True
Added iLO 5 1.10

The following are the supported values:

Value Description
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

EncryptionBootPasswordSet

Member of HpeSmartStorageArrayController.v2_2_0.HpeSmartStorageArrayController
Description True if there is a boot password set, false otherwise
Type boolean
Read Only True
Added iLO 5 1.10

EncryptionCryptoOfficerPasswordSet

Member of HpeSmartStorageArrayController.v2_2_0.HpeSmartStorageArrayController
Description True if a password has been set for the Encryption Crypto Officer, false otherwise
Type boolean
Read Only True
Added iLO 5 1.10

EncryptionCspTestPassed

Member of HpeSmartStorageArrayController.v2_2_0.HpeSmartStorageArrayController
Description True if the encryption CSP test passed, false otherwise.
Type boolean
Read Only True
Added iLO 5 1.20

EncryptionEnabled

Member of HpeSmartStorageArrayController.v2_2_0.HpeSmartStorageArrayController
Description True if encryption is currently enabled for this controller, false otherwise
Type boolean
Read Only True
Added iLO 5 1.10

EncryptionFwLocked

Member of HpeSmartStorageArrayController.v2_2_0.HpeSmartStorageArrayController
Description True if the controller firmware has been locked, preventing firmware updates, false otherwise
Type boolean
Read Only True
Added iLO 5 1.10

EncryptionHasLockedVolumes

Member of HpeSmartStorageArrayController.v2_2_0.HpeSmartStorageArrayController
Description True if the controller has one or more volumes that are locked, false otherwise
Type boolean
Read Only True
Added iLO 5 1.10

EncryptionHasLockedVolumesMissingBootPassword

Member of HpeSmartStorageArrayController.v2_2_0.HpeSmartStorageArrayController
Description True if there are locked drives due to a missing boot password, false otherwise
Type boolean
Read Only True
Added iLO 5 1.10

EncryptionHasSuspendedVolumes

Member of HpeSmartStorageArrayController.v2_2_0.HpeSmartStorageArrayController
Description True if the controller password has been temporarily suspended, false otherwise
Type boolean
Read Only True
Added iLO 5 1.10

EncryptionKeySet

Member of HpeSmartStorageArrayController.v2_2_0.HpeSmartStorageArrayController
Description True if the Master Key has been set, false otherwise
Type boolean
Read Only True
Added iLO 5 1.20

EncryptionLocalKeyCacheEnabled

Member of HpeSmartStorageArrayController.v2_2_0.HpeSmartStorageArrayController
Description True if the controller caches encryption keys locally when a remote key manager is being used, false otherwise
Type boolean
Read Only True
Added iLO 5 1.10

EncryptionMixedVolumesEnabled

Member of HpeSmartStorageArrayController.v2_2_0.HpeSmartStorageArrayController
Description True if the controller will allow plaintext and encrypted volumes to exist simultaneously, false otherwise
Type boolean
Read Only True
Added iLO 5 1.10

EncryptionPhysicalDriveCount

Member of HpeSmartStorageArrayController.v2_2_0.HpeSmartStorageArrayController
Description The number of encrypted physical drives attached to the controller
Type integer
Read Only True
Added iLO 5 1.10

EncryptionRecoveryParamsSet

Member of HpeSmartStorageArrayController.v2_2_0.HpeSmartStorageArrayController
Description True if the encryption password recovery question and answer have been set, false otherwise
Type boolean
Read Only True
Added iLO 5 1.10

EncryptionSelfTestPassed

Member of HpeSmartStorageArrayController.v2_2_0.HpeSmartStorageArrayController
Description True if the encryption self test passed, false otherwise.
Type boolean
Read Only True
Added iLO 5 1.20

EncryptionStandaloneModeEnabled

Member of HpeSmartStorageArrayController.v2_2_0.HpeSmartStorageArrayController
Description True if the controller manages encryption keys locally, false if a remote key manager is being used
Type boolean
Read Only True
Added iLO 5 1.10

EncryptionUserPasswordSet

Member of HpeSmartStorageArrayController.v2_2_0.HpeSmartStorageArrayController
Description True if a password has been set for the Encryption User, false otherwise.
Type boolean
Read Only True
Added iLO 5 1.10

ExpandPriority

Member of HpeSmartStorageArrayController.v2_2_0.HpeSmartStorageArrayController
Description The level of priority that transformations have over handling current operating system requests
Type string
Read Only True
Added iLO 5 1.10

The following are the supported values:

Value Description
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

ExternalPortCount

Member of HpeSmartStorageArrayController.v2_2_0.HpeSmartStorageArrayController
Description The number of external ports
Type integer
Read Only True
Added iLO 5 1.10

FirmwareVersion

FirmwareVersion.Current FirmwareVersion.Current.VersionString Member of HpeSmartStorageArrayController.v2_2_0.HpeSmartStorageArrayController
Description This string represents the version of the firmware image.
Type string or null
Read Only True
Added iLO 5 1.10

FlexibleLatencySchedulerSetting

Member of HpeSmartStorageArrayController.v2_2_0.HpeSmartStorageArrayController
Description This allows the controller to process certain high-latency requests after a delay that may time out when elevator sorting
Type string
Read Only True
Added iLO 5 1.10

The following are the supported values:

Value Description
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

HardwareRevision

Member of HpeSmartStorageArrayController.v2_2_0.HpeSmartStorageArrayController
Description The hardware revision of the controller
Type string
Read Only True
Added iLO 5 1.10

InconsistencyRepairPolicy

Member of HpeSmartStorageArrayController.v2_2_0.HpeSmartStorageArrayController
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
Type string
Read Only True
Added iLO 5 1.10

The following are the supported values:

Value Description
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

InternalPortCount

Member of HpeSmartStorageArrayController.v2_2_0.HpeSmartStorageArrayController
Description The number of internal ports
Type integer
Read Only True
Added iLO 5 1.10

IsBootController

Member of HpeSmartStorageArrayController.v2_2_0.HpeSmartStorageArrayController
Description True if this controller is the OS boot controller, false otherwise
Type boolean
Read Only True
Added iLO 5 1.10

Location

Member of HpeSmartStorageArrayController.v2_2_0.HpeSmartStorageArrayController
Description Location identifier
Type string
Read Only True
Added iLO 5 1.10

LocationFormat

Member of HpeSmartStorageArrayController.v2_2_0.HpeSmartStorageArrayController
Description Format for Location Identifier
Type string
Read Only True
Added iLO 5 1.10

The following are the supported values:

Value Description
PCISlot The PCI slot the controller is located at. For embedded controllers, the slot is 0

LogicalDriveCount

Member of HpeSmartStorageArrayController.v2_2_0.HpeSmartStorageArrayController
Description The number of logical drives configured on this controller
Type integer
Read Only True
Added iLO 5 1.10

Manufacturer

Member of HpeSmartStorageArrayController.v2_2_0.HpeSmartStorageArrayController
Description The manufacturer of the controller
Type string
Read Only True
Added iLO 5 1.10

MaxParallelSurfaceScanCount

Member of HpeSmartStorageArrayController.v2_2_0.HpeSmartStorageArrayController
Description Maximum number of disks that the controller supports scanning in parallel
Type integer
Read Only True
Added iLO 5 1.10

Model

Member of HpeSmartStorageArrayController.v2_2_0.HpeSmartStorageArrayController
Description The model number for the controller
Type string
Read Only True
Added iLO 5 1.10

OperatingModeAfterReboot

Member of HpeSmartStorageArrayController.v2_2_0.HpeSmartStorageArrayController
Description The operating mode the controller will be functioning in (RAID versus HBA) after a reboot
Type string
Read Only True
Added iLO 5 1.10

The following are the supported values:

Value Description
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

ParallelSurfaceScanSupported

Member of HpeSmartStorageArrayController.v2_2_0.HpeSmartStorageArrayController
Description True if the controller supports scanning multiple disk surfaces
Type boolean
Read Only True
Added iLO 5 1.10

PhysicalDriveCount

Member of HpeSmartStorageArrayController.v2_2_0.HpeSmartStorageArrayController
Description The number of physical drives attached to this controller
Type integer
Read Only True
Added iLO 5 1.10

PowerModeAfterReboot

Member of HpeSmartStorageArrayController.v2_2_0.HpeSmartStorageArrayController
Description The power mode of the controller after a reboot
Type string
Read Only True
Added iLO 5 1.10

The following are the supported values:

Value Description
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

PowerModeConfigured

Member of HpeSmartStorageArrayController.v2_2_0.HpeSmartStorageArrayController
Description The current power mode of the controller
Type string
Read Only True
Added iLO 5 1.10

The following are the supported values:

Value Description
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

PowerModeWarningChangedDrive

Member of HpeSmartStorageArrayController.v2_2_0.HpeSmartStorageArrayController
Description True if the controller’s drive configuration has changed while using configuration based power settings, false otherwise
Type boolean
Read Only True
Added iLO 5 1.10

PowerModeWarningChangedMode

Member of HpeSmartStorageArrayController.v2_2_0.HpeSmartStorageArrayController
Description True if the controller has a new power mode configured, false otherwise
Type boolean
Read Only True
Added iLO 5 1.10

PowerModeWarningReboot

Member of HpeSmartStorageArrayController.v2_2_0.HpeSmartStorageArrayController
Description True if a reboot is required to change the active power mode on the controller, false otherwise
Type string
Read Only True
Added iLO 5 1.10

The following are the supported values:

Value Description
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

PowerModeWarningTemperature

Member of HpeSmartStorageArrayController.v2_2_0.HpeSmartStorageArrayController
Description True if the controller has crossed a critical temperature threshold and performance has been reduced to prevent damage to the controller, false otherwise
Type boolean
Read Only True
Added iLO 5 1.10

PredictiveSpareRebuild

Member of HpeSmartStorageArrayController.v2_2_0.HpeSmartStorageArrayController
Description Enables or disables predictive spare rebuild mode
Type string
Read Only True
Added iLO 5 1.10

The following are the supported values:

Value Description
Enabled Spare drives will replace physical drives that are predicted to fail preemptively
Disabled Spare drives will replace physical drives only when they fail

QueueDepth

Member of HpeSmartStorageArrayController.v2_2_0.HpeSmartStorageArrayController
Description This sets the maximum number of requests the controller will submit to a drive at any given time
Type string
Read Only True
Added iLO 5 1.10

The following are the supported values:

Value Description
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

ReadCachePercent

Member of HpeSmartStorageArrayController.v2_2_0.HpeSmartStorageArrayController
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
Type integer or null
Read Only False
Added iLO 5 1.20

RebuildPriority

Member of HpeSmartStorageArrayController.v2_2_0.HpeSmartStorageArrayController
Description The level of priority that rebuilds have over handling current operating system requests
Type string
Read Only True
Added iLO 5 1.10

The following are the supported values:

Value Description
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

SerialNumber

Member of HpeSmartStorageArrayController.v2_2_0.HpeSmartStorageArrayController
Description The serial number for this controller
Type string
Read Only True
Added iLO 5 1.10

SoftwareRaidHbaFirmwareRev

Member of HpeSmartStorageArrayController.v2_2_0.HpeSmartStorageArrayController
Description The firmware version of the underlying HBA that is being used by the software RAID stack
Type string
Read Only True
Added iLO 5 1.10

SoftwareRaidHbaModeOptionRomRev

Member of HpeSmartStorageArrayController.v2_2_0.HpeSmartStorageArrayController
Description The option ROM firmware version used to bootstrap the software RAID stack
Type string
Read Only True
Added iLO 5 1.10

SparePhysicalDriveCount

Member of HpeSmartStorageArrayController.v2_2_0.HpeSmartStorageArrayController
Description he number of physical drives assigned as spare drives attached to this controller
Type integer
Read Only True
Added iLO 5 1.10

Status

Member of HpeSmartStorageArrayController.v2_2_0.HpeSmartStorageArrayController See the Redfish standard schema and specification for information on common Status object.

SupportedOperatingModes (array)

Member of HpeSmartStorageArrayController.v2_2_0.HpeSmartStorageArrayController SupportedOperatingModes is an array containing elements of:
Type string
Read Only True

The following are the supported values:

Value Description
RAID The controller supports functioning in RAID mode
HBA The controller supports functioning in HBA mode
Mixed The controller supports functioning in Mixed mode

SupportedPowerModes (array)

Member of HpeSmartStorageArrayController.v2_2_0.HpeSmartStorageArrayController SupportedPowerModes is an array containing elements of:
Type string
Read Only True

The following are the supported values:

Value Description
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

SupportedRaidLevels (array)

Member of HpeSmartStorageArrayController.v2_2_0.HpeSmartStorageArrayController SupportedRaidLevels is an array containing elements of:
Type string
Read Only True

The following are the supported values:

Value Description
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

SurfaceScanAnalysisPriority

Member of HpeSmartStorageArrayController.v2_2_0.HpeSmartStorageArrayController
Description Priority that the controller takes to find and correct disk surface errors
Type string
Read Only True
Added iLO 5 1.10

The following are the supported values:

Value Description
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

UnassignedPhysicalDriveCount

Member of HpeSmartStorageArrayController.v2_2_0.HpeSmartStorageArrayController
Description The number of unassigned physical drives attached to this controller
Type integer
Read Only True
Added iLO 5 1.10

WriteCacheBypassThresholdKB

Member of HpeSmartStorageArrayController.v2_2_0.HpeSmartStorageArrayController
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.
Type integer or null
Read Only True
Added iLO 5 1.20

WriteCacheWithoutBackupPowerEnabled

Member of HpeSmartStorageArrayController.v2_2_0.HpeSmartStorageArrayController
Description True if the controller will continue to use write cache even if the backup power source is not available. False, otherwise.
Type boolean
Read Only True
Added iLO 5 1.20

HpeSmartStorageArrayControllerCollection.HpeSmartStorageArrayControllerCollection

@odata.type: "#HpeSmartStorageArrayControllerCollection.HpeSmartStorageArrayControllerCollection"

A Collection of HpeSmartStorageArrayController resource instances.

Resource Instances

Uri HTTP Allow
/redfish/v1/systems/{item}/smartstorage/arraycontrollers GET
Link Name Destination type
Members[] HpeSmartStorageArrayController

Members (array)

Member of HpeSmartStorageArrayControllerCollection.HpeSmartStorageArrayControllerCollection Members is an array containing elements of:

Members[{item}].@odata.id Member of HpeSmartStorageArrayControllerCollection.HpeSmartStorageArrayControllerCollection
Type string
Read Only True
Format uri-reference

Members@odata.count

Member of HpeSmartStorageArrayControllerCollection.HpeSmartStorageArrayControllerCollection
Description The total number of collection members.
Type integer
Read Only True

HpeSmartStorageDiskDrive.v2_1_0.HpeSmartStorageDiskDrive

@odata.type: "#HpeSmartStorageDiskDrive.v2_1_0.HpeSmartStorageDiskDrive"

The HpeSmartStorageDiskDrive resource describes the properties of the HPE Smart Storage controller,drives,and volumes.

Resource Instances

Uri HTTP Allow
/redfish/v1/systems/{item}/smartstorage/arraycontrollers/{item}/diskdrives/{item} GET
/redfish/v1/systems/{item}/smartstorage/arraycontrollers/{item}/unconfigureddrives/{item}
/redfish/v1/systems/{item}/smartstorage/hostbusadapters/{item}/diskdrives/{item}

BlockSizeBytes

Member of HpeSmartStorageDiskDrive.v2_1_0.HpeSmartStorageDiskDrive
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.
Type integer
Read Only True
Added iLO 5 1.10

CapacityGB

Member of HpeSmartStorageDiskDrive.v2_1_0.HpeSmartStorageDiskDrive
Description Total capacity of the drive in GB. This denotes the marketing capacity (base 10)
Type integer
Read Only True
Added iLO 5 1.10

CapacityLogicalBlocks

Member of HpeSmartStorageDiskDrive.v2_1_0.HpeSmartStorageDiskDrive
Description Total number of logical blocks in the drive
Type integer
Read Only True
Added iLO 5 1.10

CapacityMiB

Member of HpeSmartStorageDiskDrive.v2_1_0.HpeSmartStorageDiskDrive
Description Total capacity of the drive in MiB
Type integer
Read Only True
Added iLO 5 1.10

CarrierApplicationVersion

Member of HpeSmartStorageDiskDrive.v2_1_0.HpeSmartStorageDiskDrive
Description Carrier PIC firmware version currently running
Type string
Read Only True
Added iLO 5 1.10

CarrierAuthenticationStatus

Member of HpeSmartStorageDiskDrive.v2_1_0.HpeSmartStorageDiskDrive
Description Authentication status of the drive carrier
Type string
Read Only True
Added iLO 5 1.10

The following are the supported values:

Value Description
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

CurrentTemperatureCelsius

Member of HpeSmartStorageDiskDrive.v2_1_0.HpeSmartStorageDiskDrive
Description The current temperature of the drive
Type integer
Read Only True
Added iLO 5 1.10

DiskDriveStatusReasons (array)

Member of HpeSmartStorageDiskDrive.v2_1_0.HpeSmartStorageDiskDrive DiskDriveStatusReasons is an array containing elements of:
Type string
Read Only True

The following are the supported values:

Value Description
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

DiskDriveUse

Member of HpeSmartStorageDiskDrive.v2_1_0.HpeSmartStorageDiskDrive
Description The current use of the physical drive.
Type string
Read Only True
Added iLO 5 1.10

The following are the supported values:

Value Description
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.

EncryptedDrive

Member of HpeSmartStorageDiskDrive.v2_1_0.HpeSmartStorageDiskDrive
Description True if encryption is currently enabled on this disk drive, false otherwise
Type boolean
Read Only True
Added iLO 5 1.10

EraseCompletionPercentage

Member of HpeSmartStorageDiskDrive.v2_1_0.HpeSmartStorageDiskDrive
Description The percent complete for an erase operation currently occurring on the disk drive or null if not currently erasing a drive.
Type integer or null
Read Only True
Added iLO 5 1.10

ErasePattern

Member of HpeSmartStorageDiskDrive.v2_1_0.HpeSmartStorageDiskDrive
Description The pattern used for erasing the disk drive
Type string
Read Only True
Added iLO 5 1.10

FirmwareVersion

FirmwareVersion.Current FirmwareVersion.Current.VersionString Member of HpeSmartStorageDiskDrive.v2_1_0.HpeSmartStorageDiskDrive
Description This string represents the version of the firmware image.
Type string or null
Read Only True
Added iLO 5 1.10

IndicatorLED

Member of HpeSmartStorageDiskDrive.v2_1_0.HpeSmartStorageDiskDrive
Description The state of the indicator LED.
Type string or null
Read Only True
Added iLO 5 1.10

The following are the supported values:

Value Description
Null A value is temporarily unavailable
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.

InterfaceSpeedMbps

Member of HpeSmartStorageDiskDrive.v2_1_0.HpeSmartStorageDiskDrive
Description Native interface speed for the device
Type integer
Read Only True
Added iLO 5 1.10

InterfaceType

Member of HpeSmartStorageDiskDrive.v2_1_0.HpeSmartStorageDiskDrive
Description The connection interface of the drive. The value NVME has been deprecated.
Type string
Read Only True
Added iLO 5 1.10

The following are the supported values:

Value Description
SAS SAS
SATA SATA
NVME Non-volatile memory (deprecated)
PCIe PCIe interface
Unknown Information is unavailable

LegacyBootPriority

Member of HpeSmartStorageDiskDrive.v2_1_0.HpeSmartStorageDiskDrive
Description This indicates that the array controller should provide legacy boot support.
Type string
Read Only True
Added iLO 5 1.10

The following are the supported values:

Value Description
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

Location

Member of HpeSmartStorageDiskDrive.v2_1_0.HpeSmartStorageDiskDrive
Description The location of the drive
Type string
Read Only True
Added iLO 5 1.10

LocationFormat

Member of HpeSmartStorageDiskDrive.v2_1_0.HpeSmartStorageDiskDrive
Description Format for the location property
Type string
Read Only True
Added iLO 5 1.10

The following are the supported values:

Value Description
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

Manufacturer

Member of HpeSmartStorageDiskDrive.v2_1_0.HpeSmartStorageDiskDrive
Description Manufacturer of the disk drive
Type string
Read Only True
Added iLO 5 1.10

MaximumTemperatureCelsius

Member of HpeSmartStorageDiskDrive.v2_1_0.HpeSmartStorageDiskDrive
Description The maximum recommended temperature for the drive
Type integer
Read Only True
Added iLO 5 1.10

MediaType

Member of HpeSmartStorageDiskDrive.v2_1_0.HpeSmartStorageDiskDrive
Description Type of disk
Type string
Read Only True
Added iLO 5 1.10

The following are the supported values:

Value Description
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

MinimumGoodFirmwareVersion

Member of HpeSmartStorageDiskDrive.v2_1_0.HpeSmartStorageDiskDrive
Description The minimum recommended firmware revision for the drive
Type string
Read Only True
Added iLO 5 1.10

Model

Member of HpeSmartStorageDiskDrive.v2_1_0.HpeSmartStorageDiskDrive
Description Drive model number
Type string
Read Only True
Added iLO 5 1.10

NativeBlockSizeBytes

Member of HpeSmartStorageDiskDrive.v2_1_0.HpeSmartStorageDiskDrive
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
Type integer
Read Only True
Added iLO 5 1.10

PhyCount

Member of HpeSmartStorageDiskDrive.v2_1_0.HpeSmartStorageDiskDrive
Description The number of phys the drive has
Type integer
Read Only True
Added iLO 5 1.10

PortCount

Member of HpeSmartStorageDiskDrive.v2_1_0.HpeSmartStorageDiskDrive
Description The number of ports on the drive. Typically 1 (single-domain) or 2 (dual-domain)
Type integer
Read Only True
Added iLO 5 1.10

PowerOnHours

Member of HpeSmartStorageDiskDrive.v2_1_0.HpeSmartStorageDiskDrive
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.
Type integer or null
Read Only True
Added iLO 5 1.10

RotationalSpeedRpm

Member of HpeSmartStorageDiskDrive.v2_1_0.HpeSmartStorageDiskDrive
Description The rotational speed of the drive, only applicable on HDDs
Type integer
Read Only True
Added iLO 5 1.10

SSDEnduranceUtilizationPercentage

Member of HpeSmartStorageDiskDrive.v2_1_0.HpeSmartStorageDiskDrive
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.
Type integer or null
Read Only True
Added iLO 5 1.10

SerialNumber

Member of HpeSmartStorageDiskDrive.v2_1_0.HpeSmartStorageDiskDrive
Description The serial number of the drive
Type string
Read Only True
Added iLO 5 1.10

SpareRebuildMode

Member of HpeSmartStorageDiskDrive.v2_1_0.HpeSmartStorageDiskDrive
Description Method to used activate this drive when another drive fails, this is only applicable if the drive is configured as a spare drive
Type string
Read Only True
Added iLO 5 1.10

The following are the supported values:

Value Description
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.

Status

Member of HpeSmartStorageDiskDrive.v2_1_0.HpeSmartStorageDiskDrive See the Redfish standard schema and specification for information on common Status object.

TransferSpeedMbps

Member of HpeSmartStorageDiskDrive.v2_1_0.HpeSmartStorageDiskDrive
Description Effective transfer speed to the device taking into account hardware acceleration such as edge-buffering
Type integer
Read Only True
Added iLO 5 1.10

UncorrectedReadErrors

Member of HpeSmartStorageDiskDrive.v2_1_0.HpeSmartStorageDiskDrive
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
Type integer
Read Only True
Added iLO 5 1.40

UncorrectedWriteErrors

Member of HpeSmartStorageDiskDrive.v2_1_0.HpeSmartStorageDiskDrive
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.
Type integer
Read Only True
Added iLO 5 1.40

WWID

Member of HpeSmartStorageDiskDrive.v2_1_0.HpeSmartStorageDiskDrive
Description Unique identifier for the device
Type string
Read Only True
Added iLO 5 1.10

HpeSmartStorageDiskDriveCollection.HpeSmartStorageDiskDriveCollection

@odata.type: "#HpeSmartStorageDiskDriveCollection.HpeSmartStorageDiskDriveCollection"

A Collection of HpeSmartStorageDiskDrive resource instances.

Resource Instances

Uri HTTP Allow
/redfish/v1/systems/{item}/smartstorage/arraycontrollers/{item}/diskdrives GET
/redfish/v1/systems/{item}/smartstorage/arraycontrollers/{item}/logicaldrives/{item}/activesparedrives GET
/redfish/v1/systems/{item}/smartstorage/arraycontrollers/{item}/logicaldrives/{item}/datadrives GET
/redfish/v1/systems/{item}/smartstorage/arraycontrollers/{item}/logicaldrives/{item}/standbysparedrives GET
/redfish/v1/systems/{item}/smartstorage/arraycontrollers/{item}/unconfigureddrives GET
/redfish/v1/systems/{item}/smartstorage/hostbusadapters/{item}/diskdrives GET
Link Name Destination type
Members[] HpeSmartStorageDiskDrive

Members (array)

Member of HpeSmartStorageDiskDriveCollection.HpeSmartStorageDiskDriveCollection Members is an array containing elements of:

Members[{item}].@odata.id Member of HpeSmartStorageDiskDriveCollection.HpeSmartStorageDiskDriveCollection
Type string
Read Only True
Format uri-reference

Members@odata.count

Member of HpeSmartStorageDiskDriveCollection.HpeSmartStorageDiskDriveCollection
Description The total number of collection members.
Type integer
Read Only True

HpeSmartStorageHostBusAdapter.v2_0_0.HpeSmartStorageHostBusAdapter

@odata.type: "#HpeSmartStorageHostBusAdapter.v2_0_0.HpeSmartStorageHostBusAdapter"

The HpeSmartStorageHostBusAdapter resource describes the properties of the HPE Smart Storage controller,drives,and volumes.

Resource Instances

Uri HTTP Allow
/redfish/v1/systems/{item}/smartstorage/hostbusadapters/{item} GET
Link Name Destination type
Links/Drives Collection of HpeSmartStorageDiskDrive

FirmwareVersion

FirmwareVersion.Current FirmwareVersion.Current.VersionString Member of HpeSmartStorageHostBusAdapter.v2_0_0.HpeSmartStorageHostBusAdapter
Description This string represents the version of the firmware image.
Type string or null
Read Only True
Added iLO 5 1.10

HardwareRevision

Member of HpeSmartStorageHostBusAdapter.v2_0_0.HpeSmartStorageHostBusAdapter
Description The hardware revision of the controller
Type string
Read Only True
Added iLO 5 1.10

Location

Member of HpeSmartStorageHostBusAdapter.v2_0_0.HpeSmartStorageHostBusAdapter
Description Location identifier
Type string
Read Only True
Added iLO 5 1.10

LocationFormat

Member of HpeSmartStorageHostBusAdapter.v2_0_0.HpeSmartStorageHostBusAdapter
Description Format for Location Identifier
Type string
Read Only True
Added iLO 5 1.10

The following are the supported values:

Value Description
PCISlot The PCI slot the controller is located at. For embedded controllers, the slot is 0

Manufacturer

Member of HpeSmartStorageHostBusAdapter.v2_0_0.HpeSmartStorageHostBusAdapter
Description The manufacturer of the controller
Type string
Read Only True
Added iLO 5 1.10

Model

Member of HpeSmartStorageHostBusAdapter.v2_0_0.HpeSmartStorageHostBusAdapter
Description The model number for the controller
Type string
Read Only True
Added iLO 5 1.10

SerialNumber

Member of HpeSmartStorageHostBusAdapter.v2_0_0.HpeSmartStorageHostBusAdapter
Description The serial number for this controller
Type string
Read Only True
Added iLO 5 1.10

Status

Member of HpeSmartStorageHostBusAdapter.v2_0_0.HpeSmartStorageHostBusAdapter See the Redfish standard schema and specification for information on common Status object.

HpeSmartStorageHostBusAdapterCollection.HpeSmartStorageHostBusAdapterCollection

@odata.type: "#HpeSmartStorageHostBusAdapterCollection.HpeSmartStorageHostBusAdapterCollection"

A Collection of HpeSmartStorageHostBusAdapter resource instances.

Resource Instances

Uri HTTP Allow
/redfish/v1/systems/{item}/smartstorage/hostbusadapters GET
Link Name Destination type
Members[] HpeSmartStorageHostBusAdapter

Members (array)

Member of HpeSmartStorageHostBusAdapterCollection.HpeSmartStorageHostBusAdapterCollection Members is an array containing elements of:

Members[{item}].@odata.id Member of HpeSmartStorageHostBusAdapterCollection.HpeSmartStorageHostBusAdapterCollection
Type string
Read Only True
Format uri-reference

Members@odata.count

Member of HpeSmartStorageHostBusAdapterCollection.HpeSmartStorageHostBusAdapterCollection
Description The total number of collection members.
Type integer
Read Only True

HpeSmartStorageLogicalDrive.v2_3_0.HpeSmartStorageLogicalDrive

@odata.type: "#HpeSmartStorageLogicalDrive.v2_3_0.HpeSmartStorageLogicalDrive"

The HpeSmartStorageLogicalDrive resource describes the properties of the HPE Smart Storage controller,drives,and volumes.

Resource Instances

Uri HTTP Allow
/redfish/v1/systems/{item}/smartstorage/arraycontrollers/{item}/logicaldrives/{item} GET
Link Name Destination type
Links/DataDrives Collection of HpeSmartStorageDiskDrive
Links/ActiveSpareDrives Collection of HpeSmartStorageDiskDrive
Links/StandbySpareDrives Collection of HpeSmartStorageDiskDrive

AccelerationMethod

Member of HpeSmartStorageLogicalDrive.v2_3_0.HpeSmartStorageLogicalDrive
Description The acceleration method of the logical drive
Type string
Read Only True
Added iLO 5 1.20

The following are the supported values:

Value Description
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.

BlockSizeBytes

Member of HpeSmartStorageLogicalDrive.v2_3_0.HpeSmartStorageLogicalDrive
Description The block size of the disk drive in bytes
Type integer
Read Only True
Added iLO 5 1.10

CapacityMiB

Member of HpeSmartStorageLogicalDrive.v2_3_0.HpeSmartStorageLogicalDrive
Description Total usable capacity available on this logical drive in MiB units
Type integer
Read Only True
Added iLO 5 1.10

DriveAccessName

Member of HpeSmartStorageLogicalDrive.v2_3_0.HpeSmartStorageLogicalDrive
Description The access ID of the logical drive given by the OS
Type string
Read Only True
Added iLO 5 1.10

DriveGeometryCylinders

Member of HpeSmartStorageLogicalDrive.v2_3_0.HpeSmartStorageLogicalDrive
Description The number of cylinders on the drive
Type string
Read Only True
Added iLO 5 1.10

DriveGeometryHeads

Member of HpeSmartStorageLogicalDrive.v2_3_0.HpeSmartStorageLogicalDrive
Description The number of heads on the drive
Type string
Read Only True
Added iLO 5 1.10

DriveGeometrySectors

Member of HpeSmartStorageLogicalDrive.v2_3_0.HpeSmartStorageLogicalDrive
Description The number of sectors on the drive
Type string
Read Only True
Added iLO 5 1.10

InterfaceType

Member of HpeSmartStorageLogicalDrive.v2_3_0.HpeSmartStorageLogicalDrive
Description The connection interface of the logical drive.
Type string
Read Only True
Added iLO 5 1.10

The following are the supported values:

Value Description
SAS SAS
SATA SATA
Mixed Contains both SAS and SATA.
NVMe NVMe
Unknown Information is unavailable

LegacyBootPriority

Member of HpeSmartStorageLogicalDrive.v2_3_0.HpeSmartStorageLogicalDrive
Type string
Read Only True
Added iLO 5 1.10

The following are the supported values:

Value Description
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

LogicalDriveEncryption

Member of HpeSmartStorageLogicalDrive.v2_3_0.HpeSmartStorageLogicalDrive
Description True if encryption is currently enabled on this logical drive, false otherwise
Type boolean
Read Only True
Added iLO 5 1.10

LogicalDriveEncryptionDataKeysVolatile

Member of HpeSmartStorageLogicalDrive.v2_3_0.HpeSmartStorageLogicalDrive
Description True if volatile keys are enabled for encryption, false otherwise
Type boolean
Read Only True
Added iLO 5 1.10

LogicalDriveEncryptionDataKeysVolatileBackup

Member of HpeSmartStorageLogicalDrive.v2_3_0.HpeSmartStorageLogicalDrive
Description True if volatile keys are backed up to a remote key manager, false if volatile keys are not backed up
Type boolean
Read Only True
Added iLO 5 1.10

LogicalDriveEncryptionDataKeysVolatileStatus

Member of HpeSmartStorageLogicalDrive.v2_3_0.HpeSmartStorageLogicalDrive
Description The status of the encryption volatile keys
Type string
Read Only True
Added iLO 5 1.10

The following are the supported values:

Value Description
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

LogicalDriveName

Member of HpeSmartStorageLogicalDrive.v2_3_0.HpeSmartStorageLogicalDrive
Description Label given to the logical drive
Type string
Read Only True
Added iLO 5 1.10

LogicalDriveNumber

Member of HpeSmartStorageLogicalDrive.v2_3_0.HpeSmartStorageLogicalDrive
Description logical drive number
Type integer
Read Only True
Added iLO 5 1.10

LogicalDriveStatusReasons (array)

Member of HpeSmartStorageLogicalDrive.v2_3_0.HpeSmartStorageLogicalDrive LogicalDriveStatusReasons is an array containing elements of:
Type string
Read Only True

The following are the supported values:

Value Description
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
Unsupproted The state of the logical drive is unsupported
Offline Logical volume is comprised of one or more Locked SEDs. Volume is offline
SEDQualinprogress Logical volume SED Qualification is in progress
SEDQualFailed Logical volume SED Qualification failed

LogicalDriveType

Member of HpeSmartStorageLogicalDrive.v2_3_0.HpeSmartStorageLogicalDrive
Description How the logical drive is being used
Type string
Read Only True
Added iLO 5 1.10

The following are the supported values:

Value Description
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

MediaType

Member of HpeSmartStorageLogicalDrive.v2_3_0.HpeSmartStorageLogicalDrive
Description Type of the disk this logical drive is associated with.
Type string
Read Only True
Added iLO 5 1.10

The following are the supported values:

Value Description
HDD Spinning disk hard drive.
SSD Solid state disk.
SMR Shingled Magnetic Recording.
Mixed Contains both HDD and SSD.
Unknown Information is unavailable

ParityInitializationCompletionPercentage

Member of HpeSmartStorageLogicalDrive.v2_3_0.HpeSmartStorageLogicalDrive
Description Parity initialization complete percentage for a parity based logical drive (e.g. RAID 5)
Type integer
Read Only True
Added iLO 5 1.10

ParityInitializationType

Member of HpeSmartStorageLogicalDrive.v2_3_0.HpeSmartStorageLogicalDrive
Description When creating a logical drive with a RAID level that requires parity, parity blocks can be initialized with two different methods
Type string
Read Only True
Added iLO 5 1.10

The following are the supported values:

Value Description
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

PartitionInformation

Member of HpeSmartStorageLogicalDrive.v2_3_0.HpeSmartStorageLogicalDrive
Description OS partition information for the drive
Type string
Read Only True
Added iLO 5 1.10

Raid

Member of HpeSmartStorageLogicalDrive.v2_3_0.HpeSmartStorageLogicalDrive
Description The current RAID level configured on the logical drive
Type string
Read Only True

The following are the supported values:

Value Description
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

RebuildCompletionPercentage

Member of HpeSmartStorageLogicalDrive.v2_3_0.HpeSmartStorageLogicalDrive
Description The percent complete for a rebuild operation currently occurring on the logical drive
Type integer
Read Only True
Added iLO 5 1.10

SmartCacheState

Member of HpeSmartStorageLogicalDrive.v2_3_0.HpeSmartStorageLogicalDrive
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
Type string
Read Only True
Added iLO 5 1.10

The following are the supported values:

Value Description
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

Status

Member of HpeSmartStorageLogicalDrive.v2_3_0.HpeSmartStorageLogicalDrive See the Redfish standard schema and specification for information on common Status object.

StripSizeBytes

Member of HpeSmartStorageLogicalDrive.v2_3_0.HpeSmartStorageLogicalDrive
Description The strip size of the logical drive in bytes
Type integer
Read Only True
Added iLO 5 1.10

StripeSizeBytes

Member of HpeSmartStorageLogicalDrive.v2_3_0.HpeSmartStorageLogicalDrive
Description The stripe size of the logical drive in bytes
Type integer
Read Only True
Added iLO 5 1.10

TransformationCompletionPercentage

Member of HpeSmartStorageLogicalDrive.v2_3_0.HpeSmartStorageLogicalDrive
Description The percent complete for any transformations the logical drive may be undergoing such as RAID migration, stripesize migration, capacity expansion etc.
Type integer
Read Only True
Added iLO 5 1.10

VolumeUniqueIdentifier

Member of HpeSmartStorageLogicalDrive.v2_3_0.HpeSmartStorageLogicalDrive
Description An identifier (typically SCSI Inquiry based such as Inquiry VPD Page 0x83 NAA 64 identifier) used to uniquely identify this volume.
Type string
Read Only True
Added iLO 5 1.10

HpeSmartStorageLogicalDriveCollection.HpeSmartStorageLogicalDriveCollection

@odata.type: "#HpeSmartStorageLogicalDriveCollection.HpeSmartStorageLogicalDriveCollection"

A Collection of HpeSmartStorageLogicalDrive resource instances.

Resource Instances

Uri HTTP Allow
/redfish/v1/systems/{item}/smartstorage/arraycontrollers/{item}/logicaldrives GET
Link Name Destination type
Members[] HpeSmartStorageLogicalDrive

Members (array)

Member of HpeSmartStorageLogicalDriveCollection.HpeSmartStorageLogicalDriveCollection Members is an array containing elements of:

Members[{item}].@odata.id Member of HpeSmartStorageLogicalDriveCollection.HpeSmartStorageLogicalDriveCollection
Type string
Read Only True
Format uri-reference

Members@odata.count

Member of HpeSmartStorageLogicalDriveCollection.HpeSmartStorageLogicalDriveCollection
Description The total number of collection members.
Type integer
Read Only True

HpeSmartStorageStorageEnclosure.v2_0_0.HpeSmartStorageStorageEnclosure

@odata.type: "#HpeSmartStorageStorageEnclosure.v2_0_0.HpeSmartStorageStorageEnclosure"

The HpeSmartStorageStorageEnclosure resource describes the properties of the HPE Smart Storage controller,drives,and volumes.

Resource Instances

Uri HTTP Allow
/redfish/v1/systems/{item}/smartstorage/arraycontrollers/{item}/storageenclosures/{item} GET

DoorLockLED

Member of HpeSmartStorageStorageEnclosure.v2_0_0.HpeSmartStorageStorageEnclosure
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.
Type string or null
Read Only True
Added iLO 5 1.10

The following are the supported values:

Value Description
Null A value is temporarily unavailable
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.

DriveBayCount

Member of HpeSmartStorageStorageEnclosure.v2_0_0.HpeSmartStorageStorageEnclosure
Description Number of drive bays supported within the storage enclosure
Type integer
Read Only True
Added iLO 5 1.10

EnclosureLogicalID

Member of HpeSmartStorageStorageEnclosure.v2_0_0.HpeSmartStorageStorageEnclosure
Description Unique ID for the storage enclosure
Type string
Read Only True
Added iLO 5 1.10

FaultLED

Member of HpeSmartStorageStorageEnclosure.v2_0_0.HpeSmartStorageStorageEnclosure
Description The state of the Fault LED.
Type string or null
Read Only True
Added iLO 5 1.10

The following are the supported values:

Value Description
Null A value is temporarily unavailable
Unknown The state of the Fault LED cannot be determined.
Lit The Fault LED is lit.
Off The Fault LED is off.

FirmwareVersion

FirmwareVersion.Current FirmwareVersion.Current.VersionString Member of HpeSmartStorageStorageEnclosure.v2_0_0.HpeSmartStorageStorageEnclosure
Description This string represents the version of the firmware image.
Type string or null
Read Only True
Added iLO 5 1.10

IndicatorLED

Member of HpeSmartStorageStorageEnclosure.v2_0_0.HpeSmartStorageStorageEnclosure
Description The state of the indicator LED.
Type string or null
Read Only True
Added iLO 5 1.10

The following are the supported values:

Value Description
Null A value is temporarily unavailable
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.

Location

Member of HpeSmartStorageStorageEnclosure.v2_0_0.HpeSmartStorageStorageEnclosure
Description Location identifier
Type string
Read Only True
Added iLO 5 1.10

LocationFormat

Member of HpeSmartStorageStorageEnclosure.v2_0_0.HpeSmartStorageStorageEnclosure
Description Format for Location Identifier
Type string
Read Only True
Added iLO 5 1.10

The following are the supported values:

Value Description
Port: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

Manufacturer

Member of HpeSmartStorageStorageEnclosure.v2_0_0.HpeSmartStorageStorageEnclosure
Description The manufacturer of the storage enclosure
Type string
Read Only True
Added iLO 5 1.10

Model

Member of HpeSmartStorageStorageEnclosure.v2_0_0.HpeSmartStorageStorageEnclosure
Description The model string for the storage enclosure
Type string
Read Only True
Added iLO 5 1.10

PartNumber

Member of HpeSmartStorageStorageEnclosure.v2_0_0.HpeSmartStorageStorageEnclosure
Description Part number of this storage enclosure
Type string
Read Only True
Added iLO 5 1.10

SKU

Member of HpeSmartStorageStorageEnclosure.v2_0_0.HpeSmartStorageStorageEnclosure
Description SKU for the storage enclosure
Type string
Read Only True
Added iLO 5 1.10

SerialNumber

Member of HpeSmartStorageStorageEnclosure.v2_0_0.HpeSmartStorageStorageEnclosure
Description The serial number for this storage enclosure
Type string
Read Only True
Added iLO 5 1.10

Status

Member of HpeSmartStorageStorageEnclosure.v2_0_0.HpeSmartStorageStorageEnclosure See the Redfish standard schema and specification for information on common Status object.

SubEnclosureLocation

Member of HpeSmartStorageStorageEnclosure.v2_0_0.HpeSmartStorageStorageEnclosure
Description Location within the chassis if this storage enclosure is part of a larger chassis hosting multiple storage enclosures
Type string
Read Only True
Added iLO 5 1.10

HpeSmartStorageStorageEnclosureCollection.HpeSmartStorageStorageEnclosureCollection

@odata.type: "#HpeSmartStorageStorageEnclosureCollection.HpeSmartStorageStorageEnclosureCollection"

A Collection of HpeSmartStorageStorageEnclosure resource instances.

Resource Instances

Uri HTTP Allow
/redfish/v1/systems/{item}/smartstorage/arraycontrollers/{item}/storageenclosures GET
Link Name Destination type
Members[] HpeSmartStorageStorageEnclosure

Members (array)

Member of HpeSmartStorageStorageEnclosureCollection.HpeSmartStorageStorageEnclosureCollection Members is an array containing elements of:

Members[{item}].@odata.id Member of HpeSmartStorageStorageEnclosureCollection.HpeSmartStorageStorageEnclosureCollection
Type string
Read Only True
Format uri-reference

Members@odata.count

Member of HpeSmartStorageStorageEnclosureCollection.HpeSmartStorageStorageEnclosureCollection
Description The total number of collection members.
Type integer
Read Only True

HpeSNMPAlertDestination.v2_0_0.HpeSNMPAlertDestination

@odata.type: "#HpeSNMPAlertDestination.v2_0_0.HpeSNMPAlertDestination"

The HpeSNMPAlertDestination resource describes the properties for SNMP Alert Destinations. The alert destination configuration up to 8 remote management systems that receive SNMP alerts from the BMC.

This resource type was added in iLO 5 1.20

Resource Instances

Uri HTTP Allow
/redfish/v1/managers/{item}/snmpservice/snmpalertdestinations/{item} GET PATCH DELETE

AlertDestination

Member of HpeSNMPAlertDestination.v2_0_0.HpeSNMPAlertDestination
Description The IP address or FQDN of remote management system that receive SNMP alerts.
Type string
Read Only False
Added iLO 5 1.20

SNMPAlertProtocol

Member of HpeSNMPAlertDestination.v2_0_0.HpeSNMPAlertDestination
Description Indicate the SNMP protocol associated with the AlertDestination.
Type string or null
Read Only False
Added iLO 5 1.20

The following are the supported values:

Value Description
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.
Null A value is temporarily unavailable

SNMPv3User

SNMPv3 User associated with the destination when SNMP alert protocol is SNMPv3trap. SNMPv3User is a link ("@odata.id": URI) to another resource.

SecurityName

Member of HpeSNMPAlertDestination.v2_0_0.HpeSNMPAlertDestination
Description Provides the SNMPv3 security name associated with SNMPv3trap or SNMPv3Inform set on SNMPAlertProtocol.
Type string or null
Read Only False
Added iLO 5 1.20

TrapCommunity

Member of HpeSNMPAlertDestination.v2_0_0.HpeSNMPAlertDestination
Description The configured SNMPv1 trap community string.
Type string
Read Only False
Added iLO 5 1.20

HpeSNMPAlertDestinationCollection.HpeSNMPAlertDestinationCollection

@odata.type: "#HpeSNMPAlertDestinationCollection.HpeSNMPAlertDestinationCollection"

A Collection of HpeSNMPAlertDestination resource instances.

Resource Instances

Uri HTTP Allow
/redfish/v1/managers/{item}/snmpservice/snmpalertdestinations GET POST
Link Name Destination type
Members[] HpeSNMPAlertDestination

Members (array)

Member of HpeSNMPAlertDestinationCollection.HpeSNMPAlertDestinationCollection Members is an array containing elements of:

Members[{item}].@odata.id Member of HpeSNMPAlertDestinationCollection.HpeSNMPAlertDestinationCollection
Type string
Read Only True
Format uri-reference

Members@odata.count

Member of HpeSNMPAlertDestinationCollection.HpeSNMPAlertDestinationCollection
Description The total number of collection members.
Type integer
Read Only True

HpeSNMPUser.v2_1_0.HpeSNMPUser

@odata.type: "#HpeSNMPUser.v2_1_0.HpeSNMPUser"

The HpeSNMPUser resource describes the properties for SNMP support. 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.

This resource type was added in iLO 5 1.20

Resource Instances

Uri HTTP Allow
/redfish/v1/managers/{item}/snmpservice/snmpusers/{item} GET PATCH DELETE

AuthPassphrase

Member of HpeSNMPUser.v2_1_0.HpeSNMPUser
Description Sets the passphrase to use for sign operations. Enter a value of 8 to 49 characters.
Type string or null
Read Only False
Added iLO 5 1.20

AuthProtocol

Member of HpeSNMPUser.v2_1_0.HpeSNMPUser
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.
Type string
Read Only False
Added iLO 5 1.20

The following are the supported values:

Value Description
MD5 Indicate Message Digest Algorithm.
SHA Indicate Secure Hash Algorithm.
SHA256 Indicate SHA256 Algorithm.

PrivacyPassphrase

Member of HpeSNMPUser.v2_1_0.HpeSNMPUser
Description Sets the passphrase to use for encrypt operations. Enter a value of 8 to 49 characters.
Type string or null
Read Only False
Added iLO 5 1.20

PrivacyProtocol

Member of HpeSNMPUser.v2_1_0.HpeSNMPUser
Description Sets the encryption algorithm to use for encoding the privacy passphrase. A portion of an SNMP message is encrypted before transmission.
Type string
Read Only False
Added iLO 5 1.20

The following are the supported values:

Value Description
DES Indicate Data Encryption Standard Algorithm.
AES Indicate Advanced Encryption Standard Algorithm.

SecurityName

Member of HpeSNMPUser.v2_1_0.HpeSNMPUser
Description The user profile name. Enter an alphanumeric string of 1 to 32 characters.
Type string or null
Read Only False
Added iLO 5 1.20

UserEngineID

Member of HpeSNMPUser.v2_1_0.HpeSNMPUser
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).
Type string or null
Read Only False
Added iLO 5 1.20

HpeSNMPUsersCollection.HpeSNMPUsersCollection

@odata.type: "#HpeSNMPUsersCollection.HpeSNMPUsersCollection"

A Collection of HpeSNMPUsers resource instances.

Resource Instances

Uri HTTP Allow
/redfish/v1/managers/{item}/snmpservice/snmpusers GET POST
Link Name Destination type
Members[] HpeSNMPUser

Members (array)

Member of HpeSNMPUsersCollection.HpeSNMPUsersCollection Members is an array containing elements of:

Members[{item}].@odata.id Member of HpeSNMPUsersCollection.HpeSNMPUsersCollection
Type string
Read Only True
Format uri-reference

Members@odata.count

Member of HpeSNMPUsersCollection.HpeSNMPUsersCollection
Description The total number of collection members.
Type integer
Read Only True

HpeTlsConfig.v1_0_0.HpeTlsConfig

@odata.type: "#HpeTlsConfig.v1_0_0.HpeTlsConfig"

The schema definition for TLS configuration.

Resource Instances

Uri HTTP Allow
/redfish/v1/systems/{item}/bios/tlsconfig GET
/redfish/v1/systems/{item}/bios/tlsconfig/settings GET PATCH
Link Name Destination type
@Redfish.Settings/SettingsObject HpeTlsConfig
Oem/Hpe/Links/BaseConfigs HpeBaseConfigs

@Redfish.Settings

Member of HpeTlsConfig.v1_0_0.HpeTlsConfig See the Redfish standard schema and specification for information on common @Redfish properties.

Certificates (array)

Member of HpeTlsConfig.v1_0_0.HpeTlsConfig Certificates is an array containing elements of:

Certificates[{item}].FingerPrint Member of HpeTlsConfig.v1_0_0.HpeTlsConfig
Description The fingerprint of the certificate. It is the sha256 (SHA2) of the Der format of the certificate
Type string
Read Only True

Certificates[{item}].Issuer Member of HpeTlsConfig.v1_0_0.HpeTlsConfig
Description The Issuer of the certificate
Type string
Read Only True

Certificates[{item}].SerialNumber Member of HpeTlsConfig.v1_0_0.HpeTlsConfig
Description The Serial Number of the certificate.
Type string
Read Only True

Certificates[{item}].Subject Member of HpeTlsConfig.v1_0_0.HpeTlsConfig
Description The Subject of the certificate.
Type string
Read Only True

Certificates[{item}].ValidNotAfter Member of HpeTlsConfig.v1_0_0.HpeTlsConfig
Description The expiration date of the certificate.
Type string
Read Only True

Certificates[{item}].ValidNotBefore Member of HpeTlsConfig.v1_0_0.HpeTlsConfig
Description The date when the certificate becomes valid.
Type string
Read Only True

Ciphers

Member of HpeTlsConfig.v1_0_0.HpeTlsConfig
Description The encryption used. It can have more than one type of encryption, example: “AES128-SHA:AES256-SHA:AES128-SHA256:AES256-SHA256”
Type string
Read Only False

DeleteCertificates (array)

Member of HpeTlsConfig.v1_0_0.HpeTlsConfig DeleteCertificates is an array containing elements of:

DeleteCertificates[{item}].FingerPrint Member of HpeTlsConfig.v1_0_0.HpeTlsConfig
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
Type string
Read Only False

HostnameCheck

Member of HpeTlsConfig.v1_0_0.HpeTlsConfig
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
Type string
Read Only False

The following are the supported values:

Value Description
Disabled Disable verification of the connected server’s hostname.
Enabled enable verification of the connected server’s hostname.

NewCertificates (array)

Member of HpeTlsConfig.v1_0_0.HpeTlsConfig NewCertificates is an array containing elements of:

NewCertificates[{item}].X509Certificate Member of HpeTlsConfig.v1_0_0.HpeTlsConfig
Description the body (PEM format) of the Certificate to be added
Type string
Read Only False

ProtocolVersion

Member of HpeTlsConfig.v1_0_0.HpeTlsConfig
Type string
Read Only True

The following are the supported values:

Value
AUTO
1.0
1.1
1.2
1.3

TlsCaCertificateCount

Member of HpeTlsConfig.v1_0_0.HpeTlsConfig
Description The certificates count.
Type integer
Read Only False

VerifyMode

Member of HpeTlsConfig.v1_0_0.HpeTlsConfig
Description It determines if/how the certificates are validated.
Type string
Read Only False

The following are the supported values:

Value
NONE
PEER

HpeUSBDevice.v2_0_0.HpeUSBDevice

@odata.type: "#HpeUSBDevice.v2_0_0.HpeUSBDevice"

The HpeUSBDevice resource describes the properties of USB devices.

Resource Instances

Uri HTTP Allow
/redfish/v1/systems/{item}/usbdevices/{item} GET

DeviceCapacityMB

Member of HpeUSBDevice.v2_0_0.HpeUSBDevice
Description USB device usable capacity (if applicable) in Mbytes
Type integer
Read Only True
Added iLO 5 1.10

DeviceClass

Member of HpeUSBDevice.v2_0_0.HpeUSBDevice
Description USB device Class code as defined by the USB HID device specification.
Type integer
Read Only True
Added iLO 5 1.10

DeviceName

Member of HpeUSBDevice.v2_0_0.HpeUSBDevice
Description USB device name in UTF-8 format.
Type string or null
Read Only True
Added iLO 5 1.10

DeviceProtocol

Member of HpeUSBDevice.v2_0_0.HpeUSBDevice
Description Protocol code as defined by the USB HID specification.
Type integer
Read Only True
Added iLO 5 1.10

DeviceSubClass

Member of HpeUSBDevice.v2_0_0.HpeUSBDevice
Description USB device SubClass code as defined by the USB HID device specification.
Type integer
Read Only True
Added iLO 5 1.10

Location

Member of HpeUSBDevice.v2_0_0.HpeUSBDevice
Description Location of the USB device on the server
Type string or null
Read Only True
Added iLO 5 1.10

ProductID

Member of HpeUSBDevice.v2_0_0.HpeUSBDevice
Description USB product ID as defined by manufacturer.
Type integer
Read Only True
Added iLO 5 1.10

StructuredName

Member of HpeUSBDevice.v2_0_0.HpeUSBDevice
Description USB device structured name in UTF-8 format.
Type string or null
Read Only True
Added iLO 5 1.10

UEFIDevicePath

Member of HpeUSBDevice.v2_0_0.HpeUSBDevice
Description UEFI device path of USB device. Standardized text representation of the UEFI device path, in UTF-8 format
Type string or null
Read Only True
Added iLO 5 1.10

VendorID

Member of HpeUSBDevice.v2_0_0.HpeUSBDevice
Description Vendor ID of detected USB device.
Type integer
Read Only True
Added iLO 5 1.10

HpeUSBDevicesCollection.HpeUSBDevicesCollection

@odata.type: "#HpeUSBDevicesCollection.HpeUSBDevicesCollection"

A Collection of HpeUSBDevices resource instances.

Resource Instances

Uri HTTP Allow
/redfish/v1/systems/{item}/usbdevices GET
Link Name Destination type
Members[] HpeUSBDevice

Members (array)

Member of HpeUSBDevicesCollection.HpeUSBDevicesCollection Members is an array containing elements of:

Members[{item}].@odata.id Member of HpeUSBDevicesCollection.HpeUSBDevicesCollection
Type string
Read Only True
Format uri-reference

Members@odata.count

Member of HpeUSBDevicesCollection.HpeUSBDevicesCollection
Description The total number of collection members.
Type integer
Read Only True

HpeUSBPort.v2_0_0.HpeUSBPort

@odata.type: "#HpeUSBPort.v2_0_0.HpeUSBPort"

The HpeUSBPort resource describes the properties of USB ports.

Resource Instances

Uri HTTP Allow
/redfish/v1/systems/{item}/usbports/{item} GET

InstanceNumber

Member of HpeUSBPort.v2_0_0.HpeUSBPort
Description Instance number of the USB Port
Type integer
Read Only True
Added iLO 5 1.10

Location

Member of HpeUSBPort.v2_0_0.HpeUSBPort
Description Location of the USB Device on the server
Type string or null
Read Only True
Added iLO 5 1.10

The following are the supported values:

Value Description
Null A value is temporarily unavailable
Back Located on the rear panel of the server.
Front Located on the front bezel of the server.
Internal Located internally within the server chassis.
InternalManagement Internal management media.
InternalSDCard The internal SD-Card slot.
iLOManagement iLO virtual USB devices.

PCIBusNumber

Member of HpeUSBPort.v2_0_0.HpeUSBPort
Description PCI Bus number of the USB controller that controls this USB port
Type integer
Read Only True
Added iLO 5 1.10

PCIDeviceNumber

Member of HpeUSBPort.v2_0_0.HpeUSBPort
Description PCI Device Number of the USB Controller that controls this USB Port.
Type integer
Read Only True
Added iLO 5 1.10

PCIFunctionNumber

Member of HpeUSBPort.v2_0_0.HpeUSBPort
Description PCI Function Number of the USB Controller that controls this USB Port.
Type integer
Read Only True
Added iLO 5 1.10

ParentHubInstance

Member of HpeUSBPort.v2_0_0.HpeUSBPort
Description Parent Hub Instance that provides an instance number of the internal hub this USB Port is connected to.
Type integer
Read Only True
Added iLO 5 1.10

SharedCapability

Member of HpeUSBPort.v2_0_0.HpeUSBPort
Description Shared Capability of the USB Port
Type string or null
Read Only True
Added iLO 5 1.10

The following are the supported values:

Value Description
Null A value is temporarily unavailable
UnsharedManagement Not shared as a Management Port.
SharedManagementPhysicalSwitch Shared management port w/ physical switch to control whether muxed to iLO or host.
SharedManagementPortAutomaticControl

SpeedCapability

Member of HpeUSBPort.v2_0_0.HpeUSBPort
Description USB speed capability of the USB port as configured by the BIOS during POST.
Type string or null
Read Only True
Added iLO 5 1.10

The following are the supported values:

Value Description
Null A value is temporarily unavailable
USB1FullSpeed USB 1.0 Full Speed
USB2HighSpeed USB 2.0 High Speed
USB3SuperSpeed USB 3.x SuperSpeed

UEFIDevicePath

Member of HpeUSBPort.v2_0_0.HpeUSBPort
Description UEFI Device Path of USB Endpoint. Standardized text representation of the UEFI device path, in UTF-8 format
Type string
Read Only True
Added iLO 5 1.10

HpeUSBPortsCollection.HpeUSBPortsCollection

@odata.type: "#HpeUSBPortsCollection.HpeUSBPortsCollection"

A Collection of HpeUSBPorts resource instances.

Resource Instances

Uri HTTP Allow
/redfish/v1/systems/{item}/usbports GET
Link Name Destination type
Members[] HpeUSBPort

Members (array)

Member of HpeUSBPortsCollection.HpeUSBPortsCollection Members is an array containing elements of:

Members[{item}].@odata.id Member of HpeUSBPortsCollection.HpeUSBPortsCollection
Type string
Read Only True
Format uri-reference

Members@odata.count

Member of HpeUSBPortsCollection.HpeUSBPortsCollection
Description The total number of collection members.
Type integer
Read Only True

HpeWorkloadPerformanceAdvisor.v1_0_0.HpeWorkloadPerformanceAdvisor

@odata.type: "#HpeWorkloadPerformanceAdvisor.v1_0_0.HpeWorkloadPerformanceAdvisor"

The HpeWorkloadPerformanceAdvisor resource describes the properties for managing the HPE Workload Performance Advisor.

Resource Instances

Uri HTTP Allow
/redfish/v1/systems/{item}/workloadperformanceadvisor/{item} GET

Duration

Member of HpeWorkloadPerformanceAdvisor.v1_0_0.HpeWorkloadPerformanceAdvisor
Description Specifies the duration over which the workload performance advisor is computed.
Type string or null
Read Only True
Added iLO 5 1.40

PerformanceTuningOption (array)

Member of HpeWorkloadPerformanceAdvisor.v1_0_0.HpeWorkloadPerformanceAdvisor PerformanceTuningOption is an array containing elements of:

PerformanceTuningOption[{item}].BIOSAttributeName Member of HpeWorkloadPerformanceAdvisor.v1_0_0.HpeWorkloadPerformanceAdvisor
Description The attribute name of the BIOS settings.
Type string or null
Read Only False
Added iLO 5 1.40

PerformanceTuningOption[{item}].RecommendedValue Member of HpeWorkloadPerformanceAdvisor.v1_0_0.HpeWorkloadPerformanceAdvisor
Description Recommended value for the corresponding BIOS attribute. Please refer to BIOS attribute registry schema for more information.
Type string or null
Read Only False
Added iLO 5 1.40

WorkloadCharacteristics (array)

Member of HpeWorkloadPerformanceAdvisor.v1_0_0.HpeWorkloadPerformanceAdvisor WorkloadCharacteristics is an array containing elements of:

WorkloadCharacteristics[{item}].MetricId Member of HpeWorkloadPerformanceAdvisor.v1_0_0.HpeWorkloadPerformanceAdvisor
Description The id of the metric.
Type string or null
Read Only False
Added iLO 5 1.40

WorkloadCharacteristics[{item}].MetricValue Member of HpeWorkloadPerformanceAdvisor.v1_0_0.HpeWorkloadPerformanceAdvisor
Description The workload utilization of the metric.
Type string or null
Read Only False
Added iLO 5 1.40

The following are the supported values:

Value Description
Low Utilization is low.
Medium Utilization is medium.
High Utilization is high.

HpeWorkloadPerformanceAdvisorCollection.HpeWorkloadPerformanceAdvisorCollection

@odata.type: "#HpeWorkloadPerformanceAdvisorCollection.HpeWorkloadPerformanceAdvisorCollection"

A Collection of HpeWorkloadPerformanceAdvisor resource instances.

Resource Instances

Uri HTTP Allow
/redfish/v1/systems/{item}/workloadperformanceadvisor GET
Link Name Destination type
Members[] HpeWorkloadPerformanceAdvisor

Members (array)

Member of HpeWorkloadPerformanceAdvisorCollection.HpeWorkloadPerformanceAdvisorCollection Members is an array containing elements of:

Members[{item}].@odata.id Member of HpeWorkloadPerformanceAdvisorCollection.HpeWorkloadPerformanceAdvisorCollection
Type string
Read Only True
Format uri-reference

Members@odata.count

Member of HpeWorkloadPerformanceAdvisorCollection.HpeWorkloadPerformanceAdvisorCollection
Description The total number of collection members.
Type integer
Read Only True

JsonSchemaFile.v1_0_4.JsonSchemaFile

@odata.type: "#JsonSchemaFile.v1_0_4.JsonSchemaFile"

The JSON Schema File resource describes the location (URI) of a particular Redfish schema definition being implemented or referenced by a Redfish service.

Resource Instances

Uri HTTP Allow
/redfish/v1/jsonschemas/{item} GET

Languages (array)

Member of JsonSchemaFile.v1_0_4.JsonSchemaFile Languages is an array containing elements of:
Type string
Read Only True

Location (array)

Member of JsonSchemaFile.v1_0_4.JsonSchemaFile Location is an array containing elements of:

Location[{item}].Language Member of JsonSchemaFile.v1_0_4.JsonSchemaFile
Description The RFC 5646 language code for this schema or registry item.
Type string
Read Only True
Added iLO 5 1.10

Location[{item}].Uri Member of JsonSchemaFile.v1_0_4.JsonSchemaFile
Description Link to locally available URI for schema.
Type string
Read Only True
Added iLO 5 1.10
Format uri-reference

Schema

Member of JsonSchemaFile.v1_0_4.JsonSchemaFile
Description The typename this schema describes.
Type string
Read Only True
Added iLO 5 1.10

JsonSchemaFileCollection.JsonSchemaFileCollection

@odata.type: "#JsonSchemaFileCollection.JsonSchemaFileCollection"

A Collection of JsonSchemaFile resource instances.

Resource Instances

Uri HTTP Allow
/redfish/v1/jsonschemas GET
Link Name Destination type
Members[] JsonSchemaFile

Members (array)

Member of JsonSchemaFileCollection.JsonSchemaFileCollection Members is an array containing elements of:

Members[{item}].@odata.id Member of JsonSchemaFileCollection.JsonSchemaFileCollection
Type string
Read Only True
Format uri-reference

Members@odata.count

Member of JsonSchemaFileCollection.JsonSchemaFileCollection
Description The total number of collection members.
Type integer
Read Only True

LogEntry.v1_11_0.LogEntry

@odata.type: "#LogEntry.v1_11_0.LogEntry"

This resource defines the record format for a log. It is designed to be used for SEL logs (from IPMI) as well as Event Logs and OEM-specific log formats. The EntryType field indicates the type of log and the resource includes several additional properties dependent on the EntryType.

Resource Instances

Uri HTTP Allow
/redfish/v1/managers/{item}/logservices/iel/entries/{item} GET
/redfish/v1/managers/{item}/remotesupportservice/serviceeventlogs/{item} GET
/redfish/v1/systems/{item}/logservices/dpu/entries/{item} GET PATCH
/redfish/v1/systems/{item}/logservices/event/entries/{item} GET
/redfish/v1/systems/{item}/logservices/iml/entries/{item} GET PATCH
/redfish/v1/systems/{item}/logservices/sl/entries/{item} GET

Created

Member of LogEntry.v1_11_0.LogEntry
Description The date and time when the log entry was created, for example, 2014-04-15T00:38:00Z.
Type string
Read Only True
Added iLO 5 1.10
Format date-time

EntryType

Member of LogEntry.v1_11_0.LogEntry
Description The log entry type.
Type string
Read Only True
Added iLO 5 1.10

The following are the supported values:

Value
Oem

EventId

Member of LogEntry.v1_11_0.LogEntry
Description The unique instance identifier for an event.
Type string
Read Only True

EventTimestamp

Member of LogEntry.v1_11_0.LogEntry
Description The date and time when the event occurred.
Type string
Read Only True
Format date-time

Message

Member of LogEntry.v1_11_0.LogEntry
Description The log entry details.
Type string
Read Only True
Added iLO 5 1.10

MessageArgs (array)

Member of LogEntry.v1_11_0.LogEntry MessageArgs is an array containing elements of:
Type string
Read Only True

MessageId

Member of LogEntry.v1_11_0.LogEntry
Description The MessageId, event data, or OEM-specific information. This property decodes from the entry type. If the entry type is Event, this property contains a Redfish Specification-defined MessageId. If the entry type is SEL, this property contains the Event Data. Otherwise, this property contains OEM-specific information.
Type string
Read Only True

Oem.Hpe.Categories (array)

Member of LogEntry.v1_11_0.LogEntry Categories is an array containing elements of:
Type string or null
Read Only True

The following are the supported values:

Value
Security
Hardware
Firmware
Maintenance
Administration
Power
Cooling
Invalid User Input
Other
Configuration

Oem.Hpe.Class

Member of LogEntry.v1_11_0.LogEntry
Description The log entry event class.
Type integer
Read Only True
Added iLO 5 1.10

Oem.Hpe.ClassDescription

Member of LogEntry.v1_11_0.LogEntry
Description The log entry event class description.
Type string
Read Only True

Oem.Hpe.Code

Member of LogEntry.v1_11_0.LogEntry
Description The log entry event code.
Type integer
Read Only True
Added iLO 5 1.10

Oem.Hpe.Count

Member of LogEntry.v1_11_0.LogEntry
Description The occurrence count of the log entry.
Type integer
Read Only True
Added iLO 5 1.10

Oem.Hpe.Destination

Member of LogEntry.v1_11_0.LogEntry
Description The destination host name or IP address of the remote server that recevied the service event.
Type string
Read Only True
Added iLO 5 1.20

Oem.Hpe.EventNumber

Member of LogEntry.v1_11_0.LogEntry
Description The event log identification number. Events are numbered in the order in which they are generated.
Type integer
Read Only True
Added iLO 5 1.10

Oem.Hpe.Identifier

Member of LogEntry.v1_11_0.LogEntry
Description The unique identifier of the service event.
Type string
Read Only True
Added iLO 5 1.20

Member of LogEntry.v1_11_0.LogEntry
Description The link to troubleshooting information.
Type string
Read Only True
Added iLO 5 1.10
Format uri-reference

Oem.Hpe.RecommendedAction

Member of LogEntry.v1_11_0.LogEntry
Description The recommended action for the event.
Type string
Read Only True
Added iLO 5 1.10

Oem.Hpe.Repaired

Member of LogEntry.v1_11_0.LogEntry
Description The repaired status of the IML event.
Type boolean
Read Only False
Added iLO 5 1.10

Oem.Hpe.ServiceEvent

Member of LogEntry.v1_11_0.LogEntry
Description This indicates a service ticket to be raised for the corresponding event log.
Type string
Read Only True

Oem.Hpe.ServiceEventMessageID

Member of LogEntry.v1_11_0.LogEntry
Description This property represents the Embedded Remote Support Message ID. It is applicable only for a Service Event log.
Type string
Read Only True

Oem.Hpe.Severity

Member of LogEntry.v1_11_0.LogEntry
Description The log entry event Severity.
Type string
Read Only True

The following are the supported values:

Value Description
Informational Informational event
Caution Caution event
Critical Critical event
Repaired Critical or Caution event repaired

Oem.Hpe.SubmitStatus

Member of LogEntry.v1_11_0.LogEntry
Description The service event log submission status .
Type string
Read Only True
Added iLO 5 1.20

Oem.Hpe.Updated

Member of LogEntry.v1_11_0.LogEntry
Description The date and time of the latest log entry update, for example, 2014-04-15T00:38:00Z.
Type string
Read Only True
Added iLO 5 1.10
Format date-time

Oem.Hpe.UserAction

Member of LogEntry.v1_11_0.LogEntry
Description The User action for the event.
Type string
Read Only False

The following are the supported values:

Value Description
Repaired The event repaired by user.
Ignored The event ignored by user.
None No user action taken on the event.
Not Applicable User action not applicable for the event.

OemRecordFormat

Member of LogEntry.v1_11_0.LogEntry
Description The format of an OEM record.
Type string
Read Only True
Added iLO 5 1.10

The following are the supported values:

Value
Hpe-IML
Hpe-iLOEventLog
Hpe-SL
Hpe-Event

Severity

Member of LogEntry.v1_11_0.LogEntry
Description The log entry severity.
Type string
Read Only True
Added iLO 5 1.10

The following are the supported values:

Value
OK
Warning
Critical

LogEntryCollection.LogEntryCollection

@odata.type: "#LogEntryCollection.LogEntryCollection"

A Collection of LogEntry resource instances.

Resource Instances

Uri HTTP Allow
/redfish/v1/managers/{item}/logservices/iel/entries GET POST
/redfish/v1/managers/{item}/remotesupportservice/serviceeventlogs GET
/redfish/v1/systems/{item}/logservices/dpu/entries GET POST
/redfish/v1/systems/{item}/logservices/event/entries GET POST
/redfish/v1/systems/{item}/logservices/iml/entries GET POST
/redfish/v1/systems/{item}/logservices/sl/entries GET POST
Link Name Destination type
Members[] LogEntry

Members (array)

Member of LogEntryCollection.LogEntryCollection Members is an array containing elements of:

Members[{item}].@odata.context Member of LogEntryCollection.LogEntryCollection
Type string
Read Only True
Format uri-reference

Members[{item}].@odata.etag Member of LogEntryCollection.LogEntryCollection
Type string
Read Only True

Members[{item}].@odata.id Member of LogEntryCollection.LogEntryCollection
Type string
Read Only True
Format uri-reference

Members[{item}].@odata.type Member of LogEntryCollection.LogEntryCollection
Type string
Read Only True

Members[{item}].Created Member of LogEntryCollection.LogEntryCollection
Description The date and time when the log entry was created, for example, 2014-04-15T00:38:00Z.
Type string
Read Only True
Format date-time

Members[{item}].EntryType Member of LogEntryCollection.LogEntryCollection
Description The log entry type.
Type string
Read Only True

The following are the supported values:

Value
Oem

Members[{item}].EventId Member of LogEntryCollection.LogEntryCollection
Description The unique instance identifier for an event.
Type string
Read Only True

Members[{item}].EventTimestamp Member of LogEntryCollection.LogEntryCollection
Description The date and time when the event occurred.
Type string
Read Only True
Format date-time

Members[{item}].Links Members[{item}].Links.OriginOfCondition The link to the resource that caused the log entry. OriginOfCondition is a link ("@odata.id": URI) to another resource.

Members[{item}].Message Member of LogEntryCollection.LogEntryCollection
Description The log entry details.
Type string
Read Only True

Members[{item}].MessageArgs (array) Member of LogEntryCollection.LogEntryCollection MessageArgs is an array containing elements of:
Type string
Read Only True

Members[{item}].MessageId Member of LogEntryCollection.LogEntryCollection
Description The MessageId, event data, or OEM-specific information. This property decodes from the entry type. If the entry type is Event, this property contains a Redfish Specification-defined MessageId. If the entry type is SEL, this property contains the Event Data. Otherwise, this property contains OEM-specific information.
Type string
Read Only True

Members[{item}].Oem.Hpe.Categories (array) Member of LogEntryCollection.LogEntryCollection Categories is an array containing elements of:
Type string or null
Read Only True

The following are the supported values:

Value
Security
Hardware
Firmware
Maintenance
Administration
Power
Cooling
Invalid User Input
Other
Configuration

Members[{item}].Oem.Hpe.Class Member of LogEntryCollection.LogEntryCollection
Description The log entry event class.
Type integer
Read Only True
Added iLO 5 1.10

Members[{item}].Oem.Hpe.ClassDescription Member of LogEntryCollection.LogEntryCollection
Description The log entry event class description.
Type string
Read Only True

Members[{item}].Oem.Hpe.Code Member of LogEntryCollection.LogEntryCollection
Description The log entry event code.
Type integer
Read Only True
Added iLO 5 1.10

Members[{item}].Oem.Hpe.Count Member of LogEntryCollection.LogEntryCollection
Description The occurrence count of the log entry.
Type integer
Read Only True
Added iLO 5 1.10

Members[{item}].Oem.Hpe.Destination Member of LogEntryCollection.LogEntryCollection
Description The destination host name or IP address of the remote server that recevied the service event.
Type string
Read Only True
Added iLO 5 1.20

Members[{item}].Oem.Hpe.EventNumber Member of LogEntryCollection.LogEntryCollection
Description The event log identification number. Events are numbered in the order in which they are generated.
Type integer
Read Only True
Added iLO 5 1.10

Members[{item}].Oem.Hpe.Identifier Member of LogEntryCollection.LogEntryCollection
Description The unique identifier of the service event.
Type string
Read Only True
Added iLO 5 1.20

Members[{item}].Oem.Hpe.LearnMoreLink Member of LogEntryCollection.LogEntryCollection
Description The link to troubleshooting information.
Type string
Read Only True
Added iLO 5 1.10
Format uri-reference

Members[{item}].Oem.Hpe.RecommendedAction Member of LogEntryCollection.LogEntryCollection
Description The recommended action for the event.
Type string
Read Only True
Added iLO 5 1.10

Members[{item}].Oem.Hpe.Repaired Member of LogEntryCollection.LogEntryCollection
Description The repaired status of the IML event.
Type boolean
Read Only False
Added iLO 5 1.10

Members[{item}].Oem.Hpe.ServiceEvent Member of LogEntryCollection.LogEntryCollection
Description This indicates a service ticket to be raised for the corresponding event log.
Type string
Read Only True

Members[{item}].Oem.Hpe.ServiceEventMessageID Member of LogEntryCollection.LogEntryCollection
Description This property represents the Embedded Remote Support Message ID. It is applicable only for a Service Event log.
Type string
Read Only True

Members[{item}].Oem.Hpe.Severity Member of LogEntryCollection.LogEntryCollection
Description The log entry event Severity.
Type string
Read Only True

The following are the supported values:

Value Description
Informational Informational event
Caution Caution event
Critical Critical event
Repaired Critical or Caution event repaired

Members[{item}].Oem.Hpe.SubmitStatus Member of LogEntryCollection.LogEntryCollection
Description The service event log submission status .
Type string
Read Only True
Added iLO 5 1.20

Members[{item}].Oem.Hpe.Updated Member of LogEntryCollection.LogEntryCollection
Description The date and time of the latest log entry update, for example, 2014-04-15T00:38:00Z.
Type string
Read Only True
Added iLO 5 1.10
Format date-time

Members[{item}].Oem.Hpe.UserAction Member of LogEntryCollection.LogEntryCollection
Description The User action for the event.
Type string
Read Only False

The following are the supported values:

Value Description
Repaired The event repaired by user.
Ignored The event ignored by user.
None No user action taken on the event.
Not Applicable User action not applicable for the event.

Members[{item}].OemRecordFormat Member of LogEntryCollection.LogEntryCollection
Description The format of an OEM record.
Type string
Read Only True

The following are the supported values:

Value
Hpe-IML
Hpe-iLOEventLog
Hpe-SL
Hpe-Event

Members[{item}].Severity Member of LogEntryCollection.LogEntryCollection
Description The log entry severity.
Type string
Read Only True

The following are the supported values:

Value
OK
Warning
Critical

Members@odata.count

Member of LogEntryCollection.LogEntryCollection
Description The total number of collection members.
Type integer
Read Only True

LogService.v1_1_0.LogService

@odata.type: "#LogService.v1_1_0.LogService"

This resource contains properties for monitoring and configuring an event log service for the resource or service to which it is associated.

Resource Instances

Uri HTTP Allow
/redfish/v1/managers/{item}/logservices/iel GET POST
/redfish/v1/systems/{item}/logservices/dpu GET POST
/redfish/v1/systems/{item}/logservices/event GET POST
/redfish/v1/systems/{item}/logservices/iml GET POST
/redfish/v1/systems/{item}/logservices/sl GET POST
Link Name Destination type
Entries Collection of LogEntry

DateTime

Member of LogService.v1_1_0.LogService
Description The current date and time, with UTC offset, that the Log Service uses to set or read time.
Type string or null
Read Only True
Format date-time

DateTimeLocalOffset

Member of LogService.v1_1_0.LogService
Description The UTC offset that the current DateTime proeprtu value contains in the +HH:MM format.
Type string or null
Read Only True

Entries

The URI to this log entries collection resource. Entries is a link ("@odata.id": URI) to another resource.

MaxNumberOfRecords

Member of LogService.v1_1_0.LogService
Description The maximum number of log entries.
Type integer
Read Only True
Added iLO 5 1.10

OverWritePolicy

Member of LogService.v1_1_0.LogService
Description When the log is full, the overwrite policy is enforced.
Type string
Read Only True
Added iLO 5 1.10

The following are the supported values:

Value Description
Unknown The overwrite policy is not known or is undefined.
WrapsWhenFull When the log is full, new entries will overwrite previous entries.
NeverOverwrites When the log is full, new entries are discarded.

ServiceEnabled

Member of LogService.v1_1_0.LogService
Description An indication of whether this service is enabled.
Type boolean
Read Only True

Status

Member of LogService.v1_1_0.LogService See the Redfish standard schema and specification for information on common Status object.

Actions

LogService.ClearLog Member of LogService.v1_1_0.LogService There are no parameters for this action.

LogServiceCollection.LogServiceCollection

@odata.type: "#LogServiceCollection.LogServiceCollection"

A Collection of LogService resource instances.

Resource Instances

Uri HTTP Allow
/redfish/v1/managers/{item}/logservices GET
/redfish/v1/systems/{item}/logservices GET
Link Name Destination type
Members[] LogService

Members (array)

Member of LogServiceCollection.LogServiceCollection Members is an array containing elements of:

Members[{item}].@odata.id Member of LogServiceCollection.LogServiceCollection
Type string
Read Only True
Format uri-reference

Members@odata.count

Member of LogServiceCollection.LogServiceCollection
Description The total number of collection members.
Type integer
Read Only True

Manager.v1_5_1.Manager

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

The Manager resource describes a manager. Examples of managers are BMCs, Enclosure Managers, Management Controllers and other subsystems assigned manageability functions.

Resource Instances

Uri HTTP Allow
/redfish/v1/managers/{item} GET POST PATCH
Link Name Destination type
EthernetInterfaces Collection of EthernetInterface
HostInterfaces Collection of HostInterface
Links/ManagerForChassis[] Chassis
Links/ManagerForServers[] ComputerSystem
Links/ManagerInChassis Chassis
LogServices Collection of LogService
NetworkProtocol ManagerNetworkProtocol
Oem/Hpe/Links/ActiveHealthSystem HpeiLOActiveHealthSystem
Oem/Hpe/Links/BackupRestoreService HpeiLOBackupRestoreService
Oem/Hpe/Links/DateTimeService HpeiLODateTime
Oem/Hpe/Links/EmbeddedMediaService HpeiLOEmbeddedMedia
Oem/Hpe/Links/FederationGroups Collection of HpeiLOFederationGroup
Oem/Hpe/Links/FederationPeers Collection of HpeiLOFederationPeers
Oem/Hpe/Links/LicenseService Collection of HpeiLOLicense
Oem/Hpe/Links/RemoteSupport HpeRemoteSupport
Oem/Hpe/Links/SecurityService HpeSecurityService
SerialInterfaces Collection of SerialInterface
VirtualMedia Collection of VirtualMedia

CommandShell

CommandShell.ConnectTypesSupported (array) Member of Manager.v1_5_1.Manager ConnectTypesSupported is an array containing elements of:
Type string
Read Only True

The following are the supported values:

Value Description
SSH The controller supports a Command Shell connection using the SSH protocol
Telnet The controller supports a Command Shell connection using the Telnet protocol
IPMI The controller supports a Command Shell connection using the IPMI Serial-over-LAN (SOL) protocol
Oem The controller supports a Command Shell connectino using an OEM-specific protocol

CommandShell.MaxConcurrentSessions Member of Manager.v1_5_1.Manager
Description This is the maximum number of Command Shell sessions, regardless of protocol, that this manager supports.
Type integer
Read Only True
Added iLO 5 1.10

CommandShell.ServiceEnabled Member of Manager.v1_5_1.Manager
Description Indicates if the Command Shell service is enabled for this manager.
Type boolean
Read Only False
Added iLO 5 1.10

DateTime

Member of Manager.v1_5_1.Manager
Description The current DateTime (with offset) for the manager, used to set or read time.
Type string or null
Read Only True
Format date-time

DateTimeLocalOffset

Member of Manager.v1_5_1.Manager
Description The time offset from UTC that the DateTime property is set to in format: +06:00 .
Type string or null
Read Only True

EthernetInterfaces

This is a reference to a collection of NICs that this manager uses for network communication. It is here that clients will find NIC configuration options and settings. EthernetInterfaces is a link ("@odata.id": URI) to another resource.

FirmwareVersion

Member of Manager.v1_5_1.Manager
Description The firmware version of this Manager
Type string or null
Read Only True
Added iLO 5 1.10

GraphicalConsole

GraphicalConsole.ConnectTypesSupported (array) Member of Manager.v1_5_1.Manager ConnectTypesSupported is an array containing elements of:
Type string
Read Only True

The following are the supported values:

Value Description
KVMIP The controller supports a Graphical Console connection using a KVM-IP (redirection of Keyboard, Video, Mouse over IP) protocol
Oem The controller supports a Graphical Console connection using an OEM-specific protocol

GraphicalConsole.MaxConcurrentSessions Member of Manager.v1_5_1.Manager
Description Indicates the maximum number of Graphical Console sessions, regardless of protocol, this manager supports.
Type integer
Read Only True
Added iLO 5 1.10

GraphicalConsole.ServiceEnabled Member of Manager.v1_5_1.Manager
Description Indicates if the Command Shell service is enabled for this manager.
Type boolean
Read Only False
Added iLO 5 1.10

HostInterfaces

This is a reference to a collection of Host Interfaces that this manager uses for local host communication. It is here that clients will find Host Interface configuration options and settings. HostInterfaces is a link ("@odata.id": URI) to another resource.

LogServices

Reference to a resource of type Collection with a MemberType of Logs. LogServices is a link ("@odata.id": URI) to another resource.

ManagerType

Member of Manager.v1_5_1.Manager
Description This property is the manager type for this resource.
Type string
Read Only True
Added iLO 5 1.10

The following are the supported values:

Value Description
ManagementController A controller used primarily to monitor or manage the operation of a device or system
EnclosureManager A controller which provides management functions for a chassis or group of devices or systems
BMC A controller which provides management functions for a single computer system

Model

Member of Manager.v1_5_1.Manager
Description Model name of the manager.
Type string or null
Read Only True
Added iLO 5 1.10

NetworkProtocol

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. NetworkProtocol is a link ("@odata.id": URI) to another resource.

Oem.Hpe.ClearRestApiStatus

Member of Manager.v1_5_1.Manager
Description Status of external provider data in NVRAM.
Type string or null
Read Only True
Added iLO 5 1.10

The following are the supported values:

Value Description
Null A value is temporarily unavailable
DataPresent External Provider data is present in NVRAM.
DataCleared External Provider data is not present in NVRAM.

Oem.Hpe.CloudConnect

Oem.Hpe.CloudConnect.ActivationKey Member of Manager.v1_5_1.Manager
Description The activation key is the customer account ID of HPE GreenLake. Obtain the account ID by visiting HPE GreenLake portal-Manage->Account Details card.
Type string
Read Only True

Oem.Hpe.CloudConnect.CloudConnectStatus Member of Manager.v1_5_1.Manager
Description Indicates the current status of cloud connection.
Type string
Read Only True

The following are the supported values:

Value Description
NotEnabled Indicates the initial state of the system or cloud connect service is disabled.
ConnectionInProgress Indicates the cloud activation or connection to the communication service is in progress
ConnectionFailed Indicates the cloud activation could not be completed and and the retry attempts for activation also failed
Connected Indicates the cloud connect enabled, activation successful and connection to communication service successful
RetryInProgress Indicates a connection issue with the communication service and being retried for a successful communication
NotConnected Indicates the connection retries to the communication service has failed and periodic retries will be attempted

Oem.Hpe.CloudConnect.FailReason Member of Manager.v1_5_1.Manager
Description Indicates the reason for cloud connection failure.
Type string
Read Only True

The following are the supported values:

Value Description
iLOTimeError Indicates the cloud activation failed due to incorrect iLO time.
NetworkError Indicates the cloud activation failed due to network issues.
ProxyError Indicates the cloud activation failed due to Proxy errors.
ActivationKeyMissing Indicates the cloud activation failed due to missing activation key.
WrongActivationKey Indicates the cloud activation failed due to wrong activation key errors.
WrongiLOVersion Indicates the cloud activation failed due to wrong iLO version errors.

Oem.Hpe.CloudConnect.NextRetryTime Member of Manager.v1_5_1.Manager
Description Indicates the timestamp of next retry event.
Type string
Read Only True

Oem.Hpe.ConfigurationLimitations

Member of Manager.v1_5_1.Manager
Description Limitations on configuration change based on node type.
Type string
Read Only False

The following are the supported values:

Value Description
Null A value is temporarily unavailable
None No user interface configuration limitations are in effect.
ManagedNode This is a managed node. User interfaces that are required for management cannot be modified.

Oem.Hpe.ConfigurationSettings

Member of Manager.v1_5_1.Manager
Description State of the currently displayed configuration settings.
Type string
Read Only True
Added iLO 5 1.10

The following are the supported values:

Value
Current
SomePendingReset

Oem.Hpe.FederationConfig

Oem.Hpe.FederationConfig.IPv6MulticastScope Member of Manager.v1_5_1.Manager
Description The IPv6 network scope of multicast announcements.
Type string
Read Only False
Added iLO 5 1.10

The following are the supported values:

Value
Link
Site
Organization

Oem.Hpe.FederationConfig.MulticastAnnouncementInterval Member of Manager.v1_5_1.Manager
Description The frequency in Seconds at which the iLO system announces itself on the network. A value of 0 disables multicast announcments.
Type integer
Read Only False
Added iLO 5 1.10

The following are the supported values:

Value
Null
30
60
120
300
600
900
1800

Oem.Hpe.FederationConfig.MulticastDiscovery Member of Manager.v1_5_1.Manager
Description Enables or Disables Multicast Discovery for the local iLO system.
Type string
Read Only False
Added iLO 5 1.10

The following are the supported values:

Value
Enabled
Disabled

Oem.Hpe.FederationConfig.MulticastTimeToLive Member of Manager.v1_5_1.Manager
Description The maximum number of switches a multicast announcement will traverse before being discarded.
Type integer
Read Only False
Added iLO 5 1.10

Oem.Hpe.FederationConfig.iLOFederationManagement Member of Manager.v1_5_1.Manager
Description Enables or Disables iLO Federation features for the local iLO system.
Type string
Read Only False
Added iLO 5 1.10

The following are the supported values:

Value
Enabled
Disabled

Oem.Hpe.Firmware

Oem.Hpe.Firmware.Backup Oem.Hpe.Firmware.Backup.BuildNumber Member of Manager.v1_5_1.Manager
Description The build number of the firmware.
Type integer
Read Only True
Added iLO 5 1.10

Oem.Hpe.Firmware.Backup.BuildNumberString Member of Manager.v1_5_1.Manager
Description The string version of the build number of the firmware.
Type string
Read Only True
Added iLO 5 1.10

Oem.Hpe.Firmware.Backup.Date Member of Manager.v1_5_1.Manager
Description The build date of the firmware.
Type string
Read Only True
Added iLO 5 1.10

Oem.Hpe.Firmware.Backup.DebugBuild Member of Manager.v1_5_1.Manager
Description True if the firmware is a debug build; False if it is not.
Type boolean
Read Only True
Added iLO 5 1.10

Oem.Hpe.Firmware.Backup.Family Member of Manager.v1_5_1.Manager
Description The family of the firmware.
Type string
Read Only True
Added iLO 5 1.10

Oem.Hpe.Firmware.Backup.MajorVersion Member of Manager.v1_5_1.Manager
Description The major version of the firmware.
Type integer
Read Only True
Added iLO 5 1.10

Oem.Hpe.Firmware.Backup.MinorVersion Member of Manager.v1_5_1.Manager
Description The minor version of the firmware.
Type integer
Read Only True
Added iLO 5 1.10

Oem.Hpe.Firmware.Backup.Time Member of Manager.v1_5_1.Manager
Description The build time of the firmware.
Type string
Read Only True
Added iLO 5 1.10

Oem.Hpe.Firmware.Backup.VersionString Member of Manager.v1_5_1.Manager
Description The version string of the firmware. This value might be null if VersionString is unavailable.
Type string or null
Read Only True
Added iLO 5 1.10

Oem.Hpe.Firmware.Bootblock Oem.Hpe.Firmware.Bootblock.BuildNumber Member of Manager.v1_5_1.Manager
Description The build number of the firmware.
Type integer
Read Only True
Added iLO 5 1.10

Oem.Hpe.Firmware.Bootblock.BuildNumberString Member of Manager.v1_5_1.Manager
Description The string version of the build number of the firmware.
Type string
Read Only True
Added iLO 5 1.10

Oem.Hpe.Firmware.Bootblock.Date Member of Manager.v1_5_1.Manager
Description The build date of the firmware.
Type string
Read Only True
Added iLO 5 1.10

Oem.Hpe.Firmware.Bootblock.DebugBuild Member of Manager.v1_5_1.Manager
Description True if the firmware is a debug build; False if it is not.
Type boolean
Read Only True
Added iLO 5 1.10

Oem.Hpe.Firmware.Bootblock.Family Member of Manager.v1_5_1.Manager
Description The family of the firmware.
Type string
Read Only True
Added iLO 5 1.10

Oem.Hpe.Firmware.Bootblock.MajorVersion Member of Manager.v1_5_1.Manager
Description The major version of the firmware.
Type integer
Read Only True
Added iLO 5 1.10

Oem.Hpe.Firmware.Bootblock.MinorVersion Member of Manager.v1_5_1.Manager
Description The minor version of the firmware.
Type integer
Read Only True
Added iLO 5 1.10

Oem.Hpe.Firmware.Bootblock.Time Member of Manager.v1_5_1.Manager
Description The build time of the firmware.
Type string
Read Only True
Added iLO 5 1.10

Oem.Hpe.Firmware.Bootblock.VersionString Member of Manager.v1_5_1.Manager
Description The version string of the firmware. This value might be null if VersionString is unavailable.
Type string or null
Read Only True
Added iLO 5 1.10

Oem.Hpe.Firmware.Current Oem.Hpe.Firmware.Current.BuildNumber Member of Manager.v1_5_1.Manager
Description The build number of the firmware.
Type integer
Read Only True
Added iLO 5 1.10

Oem.Hpe.Firmware.Current.BuildNumberString Member of Manager.v1_5_1.Manager
Description The string version of the build number of the firmware.
Type string
Read Only True
Added iLO 5 1.10

Oem.Hpe.Firmware.Current.Date Member of Manager.v1_5_1.Manager
Description The build date of the firmware.
Type string
Read Only True
Added iLO 5 1.10

Oem.Hpe.Firmware.Current.DebugBuild Member of Manager.v1_5_1.Manager
Description True if the firmware is a debug build; False if it is not.
Type boolean
Read Only True
Added iLO 5 1.10

Oem.Hpe.Firmware.Current.Family Member of Manager.v1_5_1.Manager
Description The family of the firmware.
Type string
Read Only True
Added iLO 5 1.10

Oem.Hpe.Firmware.Current.MajorVersion Member of Manager.v1_5_1.Manager
Description The major version of the firmware.
Type integer
Read Only True
Added iLO 5 1.10

Oem.Hpe.Firmware.Current.MinorVersion Member of Manager.v1_5_1.Manager
Description The minor version of the firmware.
Type integer
Read Only True
Added iLO 5 1.10

Oem.Hpe.Firmware.Current.Time Member of Manager.v1_5_1.Manager
Description The build time of the firmware.
Type string
Read Only True
Added iLO 5 1.10

Oem.Hpe.Firmware.Current.VersionString Member of Manager.v1_5_1.Manager
Description The version string of the firmware. This value might be null if VersionString is unavailable.
Type string or null
Read Only True
Added iLO 5 1.10

Oem.Hpe.Firmware.Pending Oem.Hpe.Firmware.Pending.BuildNumber Member of Manager.v1_5_1.Manager
Description The build number of the firmware.
Type integer
Read Only True
Added iLO 5 1.10

Oem.Hpe.Firmware.Pending.BuildNumberString Member of Manager.v1_5_1.Manager
Description The string version of the build number of the firmware.
Type string
Read Only True
Added iLO 5 1.10

Oem.Hpe.Firmware.Pending.Date Member of Manager.v1_5_1.Manager
Description The build date of the firmware.
Type string
Read Only True
Added iLO 5 1.10

Oem.Hpe.Firmware.Pending.DebugBuild Member of Manager.v1_5_1.Manager
Description True if the firmware is a debug build; False if it is not.
Type boolean
Read Only True
Added iLO 5 1.10

Oem.Hpe.Firmware.Pending.Family Member of Manager.v1_5_1.Manager
Description The family of the firmware.
Type string
Read Only True
Added iLO 5 1.10

Oem.Hpe.Firmware.Pending.MajorVersion Member of Manager.v1_5_1.Manager
Description The major version of the firmware.
Type integer
Read Only True
Added iLO 5 1.10

Oem.Hpe.Firmware.Pending.MinorVersion Member of Manager.v1_5_1.Manager
Description The minor version of the firmware.
Type integer
Read Only True
Added iLO 5 1.10

Oem.Hpe.Firmware.Pending.Time Member of Manager.v1_5_1.Manager
Description The build time of the firmware.
Type string
Read Only True
Added iLO 5 1.10

Oem.Hpe.Firmware.Pending.VersionString Member of Manager.v1_5_1.Manager
Description The version string of the firmware. This value might be null if VersionString is unavailable.
Type string or null
Read Only True
Added iLO 5 1.10

Oem.Hpe.FrontPanelUSB

Oem.Hpe.FrontPanelUSB.State Member of Manager.v1_5_1.Manager
Description The state of the front USB port device.
Type string
Read Only True
Added iLO 5 1.10

The following are the supported values:

Value Description
Null A value is temporarily unavailable
Ready iLO has not detected a front panel device.
Busy iLO has detected a front panel device and is initializing or executing operations on the device.
Complete iLO has successfully finished initializing or executing operations on the device.
Error iLO failed to initialize or execute operations on the device.
Disabled The front panel device is disabled by user configuration.

Oem.Hpe.IdleConnectionTimeoutMinutes

Member of Manager.v1_5_1.Manager
Description This setting specifies how long a user can be inactive before an iLO web interface ends automatically.
Type integer
Read Only False
Added iLO 5 1.10

The following are the supported values:

Value
Null
15
30
60
120

Oem.Hpe.IntegratedRemoteConsole

Oem.Hpe.IntegratedRemoteConsole.HotKeys (array) Member of Manager.v1_5_1.Manager HotKeys is an array containing elements of:

HotKeys[{item}].KeySequence (array) Member of Manager.v1_5_1.Manager KeySequence is an array containing elements of:
Type string
Read Only True

The following are the supported values:

Value Description
NONE No key
ESC Escape key
L_ALT Left Alt key
R_ALT Right Alt key
L_SHIFT Left Shift key
R_SHIFT Right Shift key
L_CTRL Left Control key
R_CTRL Right Control key
L_GUI Left Windows key
R_GUI Right Windows key
INS Insert key
DEL Delete key
HOME Home key
END End key
PG_UP Page Up key
PG_DN Page Down key
ENTER Enter key
TAB Tab key
BREAK Break key
BACKSPACE Backspace key
NUM_PLUS Num Plus key
NUM_MINUS Num Minus key
SCRL_LCK Scroll Lock key
SYS_RQ Sys Rq key
PRINT_SCRN
F1 F1 key
F2 F2 key
F3 F3 key
F4 F4 key
F5 F5 key
F6 F6 key
F7 F7 key
F8 F8 key
F9 F9 key
F10 F10 key
F11 F11 key
F12 F12 key
SPACE Space key
' Apostrophe key
, Comma key
- Hyphen key
. Period key
/ Slash key
; Semicolon key
= Equals key
[ Left square bracket key
\ Backslash key
] Right square bracket key
“”“` Backtick key
0 0 key
1 1 key
2 2 key
3 3 key
4 4 key
5 5 key
6 6 key
7 7 key
8 8 key
9 9 key
a a key
b b key
c c key
d d key
e e key
f f key
g g key
h h key
i i key
j j key
k k key
l l key
m m key
n n key
o o key
p p key
q q key
r r key
s s key
t t key
u u key
v v key
w w key
x x key
y y key
z z key

Oem.Hpe.IntegratedRemoteConsole.LockKey Oem.Hpe.IntegratedRemoteConsole.LockKey.CustomKeySequence (array) Member of Manager.v1_5_1.Manager CustomKeySequence is an array containing elements of:
Type string
Read Only True

The following are the supported values:

Value Description
NONE No key
ESC Escape key
L_ALT Left Alt key
R_ALT Right Alt key
L_SHIFT Left Shift key
R_SHIFT Right Shift key
L_CTRL Left Control key
R_CTRL Right Control key
L_GUI Left Windows key
R_GUI Right Windows key
INS Insert key
DEL Delete key
HOME Home key
END End key
PG_UP Page Up key
PG_DN Page Down key
ENTER Enter key
TAB Tab key
BREAK Break key
BACKSPACE Backspace key
NUM_PLUS Num Plus key
NUM_MINUS Num Minus key
SCRL_LCK Scroll Lock key
SYS_RQ Sys Rq key
PRINT_SCRN
F1 F1 key
F2 F2 key
F3 F3 key
F4 F4 key
F5 F5 key
F6 F6 key
F7 F7 key
F8 F8 key
F9 F9 key
F10 F10 key
F11 F11 key
F12 F12 key
SPACE Space key
' Apostrophe key
, Comma key
- Hyphen key
. Period key
/ Slash key
; Semicolon key
= Equals key
[ Left square bracket key
\ Backslash key
] Right square bracket key
”“”` Backtick key
0 0 key
1 1 key
2 2 key
3 3 key
4 4 key
5 5 key
6 6 key
7 7 key
8 8 key
9 9 key
a a key
b b key
c c key
d d key
e e key
f f key
g g key
h h key
i i key
j j key
k k key
l l key
m m key
n n key
o o key
p p key
q q key
r r key
s s key
t t key
u u key
v v key
w w key
x x key
y y key
z z key

Oem.Hpe.IntegratedRemoteConsole.LockKey.LockOption Member of Manager.v1_5_1.Manager
Description Lock option setting.
Type string
Read Only False

The following are the supported values:

Value Description
Windows This option configures iLO to lock a managed server running a Windows operating system.
Custom This option configures iLO to use a custom key sequence to lock a managed server or log out a user on that server.
Disabled This option disables the Remote Console Computer Lock feature.

Oem.Hpe.IntegratedRemoteConsole.TrustedCertificateRequired Member of Manager.v1_5_1.Manager
Description When this setting is enabled and a trusted SSL certificate has been imported into iLO, the .NET IRC is launched by using an HTTPS connection. When this setting is disabled, the .NET IRC is launched by using a non-SSL connection.
Type boolean
Read Only False

Oem.Hpe.License

Oem.Hpe.License.LicenseKey Member of Manager.v1_5_1.Manager
Description The installed license key.
Type string
Read Only True
Added iLO 5 1.10

Oem.Hpe.License.LicenseString Member of Manager.v1_5_1.Manager
Description Describes the type of license installed on management processor.
Type string
Read Only True
Added iLO 5 1.10

Oem.Hpe.License.LicenseType Member of Manager.v1_5_1.Manager
Description Indicates whether the license is Perpetual or Evaluation.
Type string
Read Only True
Added iLO 5 1.10

Oem.Hpe.PersistentMouseKeyboardEnabled

Member of Manager.v1_5_1.Manager
Description Persistent mouse and keyboard feature is enabled or not. When this feature is enabled, the iLO virtual mouse and keyboard are always connected to the iLO UHCI USB controller. When this feature is disabled, the iLO virtual mouse and keyboard are connected dynamically to the iLO UHCI controller only when a Remote Console application is open and connected to iLO.
Type boolean
Read Only False
Added iLO 5 1.15

Oem.Hpe.PhysicalMonitorHealthStatusEnabled

Member of Manager.v1_5_1.Manager
Description This property enables or disables the display of Server Health Status on a physical monitor attached to the system.
Type boolean
Read Only False

Oem.Hpe.RIBCLEnabled

Member of Manager.v1_5_1.Manager
Description This property enables or disables RIBCL for the management processor. The management processor will require reset when this field is modified.
Type boolean
Read Only False
Added iLO 5 1.10

Oem.Hpe.RemoteConsoleThumbnailEnabled

Member of Manager.v1_5_1.Manager
Description This property enables or disables the accessibility of remote console thumbnail image in iLO. Disabling this property will not disable remote console feature.
Type boolean
Read Only False

Oem.Hpe.RequireHostAuthentication

Member of Manager.v1_5_1.Manager
Description Determines whether authentication is required for host-based utilities which use CHIF (typically use of CHIF requires Administrator/root credentials)
Type boolean
Read Only False

Oem.Hpe.RequiredLoginForiLORBSU

Member of Manager.v1_5_1.Manager
Description Determines whether a user-credential prompt is displayed when a user accesses the iLO RBSU or the iLO Configuration Utility. The following settings are valid: Enabled-A login dialog box opens when a user accesses the iLO RBSU or the iLO Configuration Utility. Disabled (default)-No login is required when a user accesses the iLO RBSU or the iLO Configuration Utility.
Type boolean
Read Only False
Added iLO 5 1.10

Oem.Hpe.SerialCLISpeed

Member of Manager.v1_5_1.Manager
Description Serial command line interface speed in bits/second.
Type integer
Read Only False
Added iLO 5 1.10

The following are the supported values:

Value
9600
19200
38400
57600
115200

Oem.Hpe.SerialCLIStatus

Member of Manager.v1_5_1.Manager
Description Status of serial command line interface.
Type string or null
Read Only False
Added iLO 5 1.10

The following are the supported values:

Value Description
Null A value is temporarily unavailable
Disabled Serial command line interface is disabled.
EnabledNoAuth Serial command line interface is enabled with no authentication required.
EnabledAuthReq Serial command line interface is enabled with authentication required.

Oem.Hpe.SerialCLIUART

Member of Manager.v1_5_1.Manager
Description Indicates presence of UART hardware.
Type string
Read Only True

The following are the supported values:

Value Description
NotPresent UART hardware present.
Present UART hardware not present.

Oem.Hpe.VSPDlLoggingEnabled

Member of Manager.v1_5_1.Manager
Description This property enables or disables logging to the downloadable Virtual Serial Port (VSP) log.
Type boolean
Read Only False
Added iLO 5 1.10

Oem.Hpe.VSPLogDownloadEnabled

Member of Manager.v1_5_1.Manager
Description This property enables or disables download of the downloadable Virtual Serial Port (VSP) log.
Type boolean
Read Only False
Added iLO 5 1.10

Oem.Hpe.VideoPresenceDetectOverride

Member of Manager.v1_5_1.Manager
Description This property controls video presence detection on the VGA port. True: firmware workaround detects some KVMs that are not automatically supported. False: hardware-based automatic video presence detection.
Type boolean
Read Only False

Oem.Hpe.VideoPresenceDetectOverrideSupported

Member of Manager.v1_5_1.Manager
Description This indicates whether the VideoPresenceDetectOverride property is supported on this type of system.
Type boolean
Read Only True

Oem.Hpe.VirtualNICEnabled

Member of Manager.v1_5_1.Manager
Description Indicates whether the Virtual Network Interface is enabled or not.
Type boolean
Read Only False

Oem.Hpe.WebGuiEnabled

Member of Manager.v1_5_1.Manager
Description This property enables or disables WEB GUI access for the management processor. The management processor will require reset when this field is modified.
Type boolean
Read Only False
Added iLO 5 1.10

Oem.Hpe.iLOFunctionalityEnabled

Member of Manager.v1_5_1.Manager
Description iLO functionality is enabled on this platform.
Type boolean
Read Only True

Oem.Hpe.iLOFunctionalityRequired

Member of Manager.v1_5_1.Manager
Description iLO functionality is required and can’t be disabled on this platform (usually blades).
Type boolean
Read Only True
Added iLO 5 1.10

Oem.Hpe.iLOIPduringPOSTEnabled

Member of Manager.v1_5_1.Manager
Description Specifies whether displaying the iLO network IP address during host server POST is enabled(default) or not.
Type boolean
Read Only False

Oem.Hpe.iLORBSUEnabled

Member of Manager.v1_5_1.Manager
Description Enables or disables the iLO Configuration Utility. The following settings are valid: Enabled (default)-On servers that support the iLO Configuration Utility, the iLO Configuration Utility is available when you access the UEFI System Utilities by pressing F9 during POST. Disabled-On servers that support the iLO Configuration Utility, the iLO Configuration Utility is not available when you access the UEFI System Utilities by pressing F9 during POST.
Type boolean
Read Only False
Added iLO 5 1.10

Oem.Hpe.iLOSelfTestResults (array)

Member of Manager.v1_5_1.Manager iLOSelfTestResults is an array containing elements of:

iLOSelfTestResults[{item}].Notes Member of Manager.v1_5_1.Manager
Description Additional Information (if any) about the Self Test.
Type string
Read Only True

iLOSelfTestResults[{item}].SelfTestName Member of Manager.v1_5_1.Manager
Description iLO Self Test Name.
Type string
Read Only True

The following are the supported values:

Value Description
UnknownSelfTest UnknownSelfTest self test result.
CryptographicHardware CryptographicHardware self test result.
Memory Memory self test result.
WebServerCryptography WebServerCryptography self test result.
MiscCryptography MiscCryptography self test result.
UART UART self test result.
HoodSense Hood Sense self test result.
NVRAMInterface NVRAMInterface self test result.
NVRAMData NVRAMData self test result.
NVRAMSpace NVRAM space self test result.
NIC NIC self test result.
EmbeddedFlash EmbeddedFlash or SD Card self test result.
StaticRAM StaticRAM self test result.
EEPROM EEPROM self test result.
I2C I2C self test result.
BootBlock BootBlock self test result.
ThreadInit ThreadInit self test result.
Infrastructure Infrastructure self test result.
HostRom
SupportedHost Supported Host self test result.
EEPROMContent EEPROMContent self test result.
PowerManagementController Power Management Controller self test result.
CPLDPAL0 CPLD PAL0 self test result.
CPLDPAL1 CPLD PAL1 self test result.
CPLDPAL2 CPLD PAL2 self test result.
CPLDPAL3 CPLD PAL3 self test result.
CPLDPAL4 CPLD PAL4 self test result.
CPLDPAL5 CPLD PAL5 self test result.
ASICFuses ASIC Fuses self test result.

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

Oem.Hpe.iLOServicePort

Oem.Hpe.iLOServicePort.MassStorageAuthenticationRequired Member of Manager.v1_5_1.Manager
Description Indicates whether mass storage authentication is required or not.
Type boolean
Read Only False
Added iLO 5 1.10

Oem.Hpe.iLOServicePort.USBEthernetAdaptersEnabled Member of Manager.v1_5_1.Manager
Description Indicates whether the USB Ethernet Adapters are enabled or not.
Type boolean
Read Only False
Added iLO 5 1.10

Oem.Hpe.iLOServicePort.USBFlashDriveEnabled Member of Manager.v1_5_1.Manager
Description Indicates whether the USB Flash Drive is enabled or not.
Type boolean
Read Only False
Added iLO 5 1.10

Oem.Hpe.iLOServicePort.iLOServicePortEnabled Member of Manager.v1_5_1.Manager
Description Indicates whether the iLO Service Port is enabled or not.
Type boolean
Read Only False
Added iLO 5 1.10

Redundancy

Member of Manager.v1_5_1.Manager See the Redfish standard schema and specification for information on common Redundancy object.

SerialConsole

SerialConsole.ConnectTypesSupported (array) Member of Manager.v1_5_1.Manager ConnectTypesSupported is an array containing elements of:
Type string
Read Only True

The following are the supported values:

Value Description
SSH The controller supports a Serial Console connection using the SSH protocol
Telnet The controller supports a Serial Console connection using the Telnet protocol
IPMI The controller supports a Serial Console connection using the IPMI Serial-over-LAN (SOL) protocol
Oem

SerialConsole.MaxConcurrentSessions Member of Manager.v1_5_1.Manager
Description This is the maximum number of Serial Console sessions, regardless of protocol, that this manager supports.
Type integer
Read Only True
Added iLO 5 1.10

SerialConsole.ServiceEnabled Member of Manager.v1_5_1.Manager
Description Indicates if the Command Shell service is enabled for this manager.
Type boolean
Read Only False
Added iLO 5 1.10

SerialInterfaces

The link to a collection of serial interfaces that this manager uses for serial and console communication. SerialInterfaces is a link ("@odata.id": URI) to another resource.

Status

Member of Manager.v1_5_1.Manager See the Redfish standard schema and specification for information on common Status object.

UUID

Member of Manager.v1_5_1.Manager
Description This is a universally unique identifier that supervisory software uses to uniquely identify this manager. The UUID is assigned when the system is manufactured.
Type string or null
Read Only True
Added iLO 5 1.10

VirtualMedia

This is a reference to the virtual media services for this manager. VirtualMedia is a link ("@odata.id": URI) to another resource.

Actions

Manager.Reset Member of Manager.v1_5_1.Manager

Parameters:

ResetType (string)

Value Description
ForceRestart
GracefulRestart

HpeiLO.ClearHotKeys Member of Manager.v1_5_1.Manager Clear hot keys which are used during Remote Console sessions.

There are no parameters for this action.

HpeiLO.ClearRestApiState Member of Manager.v1_5_1.Manager Clears the persistent state of the REST API. Some portions of the API may not be available until after the server reboots.

There are no parameters for this action.

HpeiLO.DisableCloudConnect Member of Manager.v1_5_1.Manager Action to disable cloud connect service.

Parameters:

FailReason (string)

Indicates the reason for cloud connection failure.

Value Description
ActivationKeyMissing Indicates the cloud activation failed due to missing activation key.
NetworkError Indicates the cloud activation failed due to network issues.
ProxyError Indicates the cloud activation failed due to Proxy errors.
WrongActivationKey Indicates the cloud activation failed due to wrong activation key errors.
WrongiLOVersion Indicates the cloud activation failed due to wrong iLO version errors.
iLOTimeError Indicates the cloud activation failed due to incorrect iLO time.

HpeiLO.DisableiLOFunctionality Member of Manager.v1_5_1.Manager This action will disable the iLO network and will terminate communications with operating system drivers. To re-enable iLO functionality, use the iLO Configuration Utility (in the UEFI System Utilities) to set iLO Functionality to Enabled. For more information see the HPE UEFI System Utilities User Guide. The action resets/reboots the manager. iLO functionality cannot be disabled on server blades.

There are no parameters for this action.

HpeiLO.EnableCloudConnect Member of Manager.v1_5_1.Manager Action to enable cloud connect service.

Parameters:

ActivationKey (string)

The activation key is the customer account ID of HPE GreenLake. Obtain the account ID by visiting HPE GreenLake portal-Manage->Account Details card.

OverrideManager (boolean)

The property is used to override the existing manager (Example: HPE OneView).

HpeiLO.RequestFirmwareAndOsRecovery Member of Manager.v1_5_1.Manager Requests that the Recovery Install set be invoked, and when complete causes a OS reinstallation.

There are no parameters for this action.

HpeiLO.ResetToFactoryDefaults Member of Manager.v1_5_1.Manager Resets the iLO to Factory Defaults.

Parameters:

ResetType (string)

Value Description
Default Reset iLO to defaults, clear logs and reboot iLO.

ManagerAccount.v1_3_0.ManagerAccount

@odata.type: "#ManagerAccount.v1_3_0.ManagerAccount"

The user accounts, owned by a Manager, are defined in this resource. Changes to a Manager Account may affect the current Redfish service connection if this manager is responsible for the Redfish service.

Resource Instances

Uri HTTP Allow
/redfish/v1/accountservice/accounts/{item} GET PATCH DELETE

Oem.Hpe.LoginName

Member of ManagerAccount.v1_3_0.ManagerAccount
Description Descriptive login name that helps to easily identify the owner of each user name. The login name does not have to be the same as the user name and must use printable characters. The maximum length for a user name is 39 characters.
Type string
Read Only False
Added iLO 5 1.10

Oem.Hpe.Privileges

Oem.Hpe.Privileges.HostBIOSConfigPriv Member of ManagerAccount.v1_3_0.ManagerAccount
Description This privilege enables a user to configure Host Bios Settings.
Type boolean
Read Only False
Added iLO 5 1.10

Oem.Hpe.Privileges.HostNICConfigPriv Member of ManagerAccount.v1_3_0.ManagerAccount
Description This privilege enables a user to configure Host NIC Settings.
Type boolean
Read Only False
Added iLO 5 1.10

Oem.Hpe.Privileges.HostStorageConfigPriv Member of ManagerAccount.v1_3_0.ManagerAccount
Description This privilege enables a user to configure Host Storage Settings.
Type boolean
Read Only False
Added iLO 5 1.10

Oem.Hpe.Privileges.LoginPriv Member of ManagerAccount.v1_3_0.ManagerAccount
Description This privilege enables a user to log in to management processor. All local accounts have the login privilege. This privilege is added automatically if it is not specified.
Type boolean
Read Only False
Added iLO 5 1.10

Oem.Hpe.Privileges.RemoteConsolePriv Member of ManagerAccount.v1_3_0.ManagerAccount
Description This privilege enables a user to remotely access the host system Remote Console, including video, keyboard, and mouse control.
Type boolean
Read Only False
Added iLO 5 1.10

Oem.Hpe.Privileges.SystemRecoveryConfigPriv Member of ManagerAccount.v1_3_0.ManagerAccount
Description This privilege enables a user to manage the critical recovery firmware images on the iLO Repository.
Type boolean
Read Only False
Added iLO 5 1.10

Oem.Hpe.Privileges.UserConfigPriv Member of ManagerAccount.v1_3_0.ManagerAccount
Description This privilege enables a user to add, edit, and delete local management processor user accounts. A user with this privilege can change privileges for all users.
Type boolean
Read Only False
Added iLO 5 1.10

Oem.Hpe.Privileges.VirtualMediaPriv Member of ManagerAccount.v1_3_0.ManagerAccount
Description This privilege enables a user to use the Virtual Media feature on the host system.
Type boolean
Read Only False
Added iLO 5 1.10

Oem.Hpe.Privileges.VirtualPowerAndResetPriv Member of ManagerAccount.v1_3_0.ManagerAccount
Description This privilege enables a user to power-cycle or reset the host system. These activities interrupt system availability. A user with this privilege can diagnose the system by using the Generate NMI to System button.
Type boolean
Read Only False
Added iLO 5 1.10

Oem.Hpe.Privileges.iLOConfigPriv Member of ManagerAccount.v1_3_0.ManagerAccount
Description This privilege enables a user to configure most management processor settings, including security settings, and to remotely update the management processor firmware. This privilege does not enable local user account administration.
Type boolean
Read Only False
Added iLO 5 1.10

Oem.Hpe.ServiceAccount

Member of ManagerAccount.v1_3_0.ManagerAccount
Description Indicate that the account type is service account
Type boolean
Read Only False
Added iLO 5 1.20

Oem.Hpe.SkipEscCharsCheck

Member of ManagerAccount.v1_3_0.ManagerAccount
Description Indicates that the escape characters check to be skipped or not
Type boolean
Read Only False

Password

Member of ManagerAccount.v1_3_0.ManagerAccount
Description The password used to log in to the management processor. The maximum length for a password is 39 characters. The minimum length for a password is specified in the MinPasswordLength property of the AccountService schema.
Type string or null
Read Only False
Added iLO 5 1.10

PasswordChangeRequired

Member of ManagerAccount.v1_3_0.ManagerAccount
Description Indicates that the password for this account must be changed. The service requires the password to be changed before access is allowed.
Type boolean
Read Only True

RoleId

Member of ManagerAccount.v1_3_0.ManagerAccount
Description This property contains the name of the Role for this account.
Type string
Read Only False
Added iLO 5 1.40

UserName

Member of ManagerAccount.v1_3_0.ManagerAccount
Description The name used to log in to the management processor. The user name does not have to be the same as the login name. The maximum length for the user name is 39 characters. The user name must use printable characters.
Type string
Read Only False
Added iLO 5 1.10

ManagerAccountCollection.ManagerAccountCollection

@odata.type: "#ManagerAccountCollection.ManagerAccountCollection"

A Collection of ManagerAccount resource instances.

Resource Instances

Uri HTTP Allow
/redfish/v1/accountservice/accounts GET POST
Link Name Destination type
Members[] ManagerAccount

Members (array)

Member of ManagerAccountCollection.ManagerAccountCollection Members is an array containing elements of:

Members[{item}].@odata.id Member of ManagerAccountCollection.ManagerAccountCollection
Type string
Read Only True
Format uri-reference

Members@odata.count

Member of ManagerAccountCollection.ManagerAccountCollection
Description The total number of collection members.
Type integer
Read Only True

ManagerCollection.ManagerCollection

@odata.type: "#ManagerCollection.ManagerCollection"

A Collection of Manager resource instances.

Resource Instances

Uri HTTP Allow
/redfish/v1/managers GET
Link Name Destination type
Members[] Manager

Members (array)

Member of ManagerCollection.ManagerCollection Members is an array containing elements of:

Members[{item}].@odata.id Member of ManagerCollection.ManagerCollection
Type string
Read Only True
Format uri-reference

Members@odata.count

Member of ManagerCollection.ManagerCollection
Description The total number of collection members.
Type integer
Read Only True

ManagerNetworkProtocol.v1_0_0.ManagerNetworkProtocol

@odata.type: "#ManagerNetworkProtocol.v1_0_0.ManagerNetworkProtocol"

This resource is used to obtain or modify the network services managed by this manager.

Granularity to enable/disable HTTP(S) ports

iLO 5 v2.72 onwards supports enabling/disabling the HTTP/HTTPS ports.

Disable/Enable HTTP(S) Port:

NOTE:

HTTP.ProtocolEnabled property applies to both HTTP and HTTPS. To disable iLO’s HTTP & HTTPS ports, PATCH the ProtocolEnabled property to false. Note that this will affect the iLO Web and Redfish API interfaces which use these ports. For either HTTP or HTTPS ports to be enabled, the ProtocolEnabled property must be set to true.

For example, to disable HTTP port:

PATCH /redfish/v1/Managers/1/NetworkProtocol

PATCH Payload:


{
    "HTTP": {
        "Port": 0
    }
}

NOTE:

iLO reset is required after the PATCH for the change to come into effect.

Resource Instances

Uri HTTP Allow
/redfish/v1/managers/{item}/networkprotocol GET POST PATCH
Link Name Destination type
Oem/Hpe/Links/EthernetInterfaces Collection of EthernetInterface
Oem/Hpe/Links/SNMPService HpeiLOSnmpService

FQDN

Member of ManagerNetworkProtocol.v1_0_0.ManagerNetworkProtocol
Description The fully-qualified domain name of the manager that is obtained by DNS and includes the host name and top-level domain name.
Type string or null
Read Only True
Added iLO 5 1.10

HTTP

HTTP.Port Member of ManagerNetworkProtocol.v1_0_0.ManagerNetworkProtocol
Description The HTTP port number.
Type integer or null
Read Only False
Added iLO 5 1.10

HTTP.ProtocolEnabled Member of ManagerNetworkProtocol.v1_0_0.ManagerNetworkProtocol
Description Indicates whether HTTP is enabled or disabled.
Type boolean or null
Read Only False
Added iLO 5 1.10

HTTPS

HTTPS.Port Member of ManagerNetworkProtocol.v1_0_0.ManagerNetworkProtocol
Description The HTTPS/SSL port number.
Type integer or null
Read Only False
Added iLO 5 1.10

HTTPS.ProtocolEnabled Member of ManagerNetworkProtocol.v1_0_0.ManagerNetworkProtocol
Description Indicates whether HTTPS/SSL is enabled or disabled.
Type boolean or null
Read Only False
Added iLO 5 1.10

HostName

Member of ManagerNetworkProtocol.v1_0_0.ManagerNetworkProtocol
Description The host name of the manager that is obtained by DNS and does not include any domain information.
Type string or null
Read Only False
Added iLO 5 1.10

IPMI

IPMI.Port Member of ManagerNetworkProtocol.v1_0_0.ManagerNetworkProtocol
Description The IPMI over LAN port number.
Type integer or null
Read Only False
Added iLO 5 1.10

IPMI.ProtocolEnabled Member of ManagerNetworkProtocol.v1_0_0.ManagerNetworkProtocol
Description Indicates whether IPMI over LAN is enabled for the manager.
Type boolean or null
Read Only False
Added iLO 5 1.10

KVMIP

KVMIP.Port Member of ManagerNetworkProtocol.v1_0_0.ManagerNetworkProtocol
Description The KVM-IP port number.
Type integer or null
Read Only False
Added iLO 5 1.10

KVMIP.ProtocolEnabled Member of ManagerNetworkProtocol.v1_0_0.ManagerNetworkProtocol
Description Indicates whether KVM-IP is enabled for the manager.
Type boolean or null
Read Only False
Added iLO 5 1.10

Oem.Hpe.AlertMailEmail

Member of ManagerNetworkProtocol.v1_0_0.ManagerNetworkProtocol
Description The destination email address for email alerts.
Type string
Read Only False
Added iLO 5 1.10

Oem.Hpe.AlertMailEnabled

Member of ManagerNetworkProtocol.v1_0_0.ManagerNetworkProtocol
Description Indicates whether AlertMail is enabled. This can be enabled only when the properties AlertMailEmail, AlertMailSenderDomain and AlertMailSMTPServer are set or not empty.
Type boolean
Read Only False
Added iLO 5 1.10

Oem.Hpe.AlertMailSMTPAuthEnabled

Member of ManagerNetworkProtocol.v1_0_0.ManagerNetworkProtocol
Description Indicates whether AlertMail SMTP Authentication is enabled. This can be enabled only when the properties AlertMailSMTPSecureEnabled, AlertMailSMTPAuthUser and AlertMailSMTPAuthPw are set or not empty.
Type boolean
Read Only False
Added iLO 5 1.30

Oem.Hpe.AlertMailSMTPAuthPw

Member of ManagerNetworkProtocol.v1_0_0.ManagerNetworkProtocol
Description The password credential for SMTP server Authentication.
Type string or null
Read Only False
Added iLO 5 1.30

Oem.Hpe.AlertMailSMTPAuthUser

Member of ManagerNetworkProtocol.v1_0_0.ManagerNetworkProtocol
Description The username credential for SMTP server Authentication.
Type string
Read Only False
Added iLO 5 1.30

Oem.Hpe.AlertMailSMTPPort

Member of ManagerNetworkProtocol.v1_0_0.ManagerNetworkProtocol
Description The SMTP server port number.
Type integer
Read Only False
Added iLO 5 1.10

Oem.Hpe.AlertMailSMTPSecureEnabled

Member of ManagerNetworkProtocol.v1_0_0.ManagerNetworkProtocol
Description Indicates whether AlertMail SMTP Secure Connection (SSL/TLS) is enabled.
Type boolean
Read Only False
Added iLO 5 1.30

Oem.Hpe.AlertMailSMTPServer

Member of ManagerNetworkProtocol.v1_0_0.ManagerNetworkProtocol
Description The IP address or DNS name of the SMTP server or the Mail Submission Agent (MSA).
Type string
Read Only False
Added iLO 5 1.10

Oem.Hpe.AlertMailSenderDomain

Member of ManagerNetworkProtocol.v1_0_0.ManagerNetworkProtocol
Description The domain name for the sender email address.
Type string
Read Only False
Added iLO 5 1.10

Oem.Hpe.ConfigurationSettings

Member of ManagerNetworkProtocol.v1_0_0.ManagerNetworkProtocol
Description State of the currently displayed configuration settings.
Type string
Read Only True
Added iLO 5 1.10

The following are the supported values:

Value
Current
SomePendingReset

Oem.Hpe.EnhancedDownloadPerformanceEnabled

Member of ManagerNetworkProtocol.v1_0_0.ManagerNetworkProtocol
Description Indicates whether enhanced download for virtual media and firmware update is enabled or disabled.
Type boolean
Read Only False

Oem.Hpe.FederationEnabled

Member of ManagerNetworkProtocol.v1_0_0.ManagerNetworkProtocol
Description Indicates whether management processor federation management is enabled or disabled.
Type boolean
Read Only False
Added iLO 5 1.10

Oem.Hpe.FederationSupported

Member of ManagerNetworkProtocol.v1_0_0.ManagerNetworkProtocol
Description Indicates whether management processor federation is supported.
Type boolean
Read Only True
Added iLO 5 1.10

Oem.Hpe.IEEE_8021X_Support

Member of ManagerNetworkProtocol.v1_0_0.ManagerNetworkProtocol
Description Indicates whether 802.1X feature is enabled or not.
Type boolean
Read Only False

Oem.Hpe.RemoteSyslogEnabled

Member of ManagerNetworkProtocol.v1_0_0.ManagerNetworkProtocol
Description Indicates whether Remote Syslog is enabled. When enabled, management processor sends notification messages to the specified Syslog server. This can be enabled only when the property RemoteSyslogServer is set or not empty.
Type boolean
Read Only False
Added iLO 5 1.10

Oem.Hpe.RemoteSyslogPort

Member of ManagerNetworkProtocol.v1_0_0.ManagerNetworkProtocol
Description The port number through which the Syslog servers are listening.
Type integer
Read Only False
Added iLO 5 1.10

Oem.Hpe.RemoteSyslogServer

Member of ManagerNetworkProtocol.v1_0_0.ManagerNetworkProtocol
Description The IP address, FQDN, IPv6 name, or short name of the servers running the Syslog service.
Type string
Read Only False
Added iLO 5 1.10

Oem.Hpe.SMTPForTFAEnabled

Member of ManagerNetworkProtocol.v1_0_0.ManagerNetworkProtocol
Description Indicates whether SMTP for Two Factor Authentication is enabled.
Type boolean
Read Only False

Oem.Hpe.SNMPTrapPort

Member of ManagerNetworkProtocol.v1_0_0.ManagerNetworkProtocol
Description The SNMP trap port number.
Type integer
Read Only False
Added iLO 5 1.10

Oem.Hpe.SerialOverLanLogging

Member of ManagerNetworkProtocol.v1_0_0.ManagerNetworkProtocol
Description Indicates whether Serial Over LAN (SOL) or Virtual Serial Port (VSP) logging is enabled.
Type boolean
Read Only False
Added iLO 5 1.10

Oem.Hpe.VirtualMediaEncryptionEnabled

Member of ManagerNetworkProtocol.v1_0_0.ManagerNetworkProtocol
Description Enables or disables encryption on virtual media connections.
Type boolean
Read Only False

Oem.Hpe.WebProxyConfiguration

Oem.Hpe.WebProxyConfiguration.ProxyPassword Member of ManagerNetworkProtocol.v1_0_0.ManagerNetworkProtocol
Description Indicates the proxy password (optional)
Type string or null
Read Only False

Oem.Hpe.WebProxyConfiguration.ProxyPort Member of ManagerNetworkProtocol.v1_0_0.ManagerNetworkProtocol
Description Indicates the proxy port.
Type integer or null
Read Only False

Oem.Hpe.WebProxyConfiguration.ProxyServer Member of ManagerNetworkProtocol.v1_0_0.ManagerNetworkProtocol
Description Indicates the hostname or IP address of proxy server.
Type string
Read Only False

Oem.Hpe.WebProxyConfiguration.ProxyUserName Member of ManagerNetworkProtocol.v1_0_0.ManagerNetworkProtocol
Description Indicates the proxy username (optional)
Type string
Read Only False

Oem.Hpe.XMLResponseEnabled

Member of ManagerNetworkProtocol.v1_0_0.ManagerNetworkProtocol
Description Determines whether management processor responds to anonymous XML discovery requests.
Type boolean
Read Only False
Added iLO 5 1.10

SNMP

SNMP.Port Member of ManagerNetworkProtocol.v1_0_0.ManagerNetworkProtocol
Description The SNMP port number.
Type integer or null
Read Only False
Added iLO 5 1.10

SNMP.ProtocolEnabled Member of ManagerNetworkProtocol.v1_0_0.ManagerNetworkProtocol
Description Indicates whether SNMP is enabled for the manager.
Type boolean or null
Read Only False
Added iLO 5 1.10

SSDP

SSDP.NotifyIPv6Scope Member of ManagerNetworkProtocol.v1_0_0.ManagerNetworkProtocol
Description The scope for IPv6 Notify messages for SSDP.
Type string or null
Read Only False
Added iLO 5 1.10

The following are the supported values:

Value Description
Null A value is temporarily unavailable
Link SSDP Notify messages are sent to addresses in the IPv6 Local Link scope
Site SSDP Notify messages are sent to addresses in the IPv6 Local Site scope.
Organization SSDP Notify messages are sent to addresses in the IPv6 Local Organization scope.

SSDP.NotifyMulticastIntervalSeconds Member of ManagerNetworkProtocol.v1_0_0.ManagerNetworkProtocol
Description Indicates how often multicast is performed for SSDP. Allowed values are 0, 30, 60, 120, 300, 600, 900 or 1800.
Type integer or null
Read Only False
Added iLO 5 1.10

SSDP.NotifyTTL Member of ManagerNetworkProtocol.v1_0_0.ManagerNetworkProtocol
Description The Time to Live (TTL) hop count for SSDP Notify messages.
Type integer or null
Read Only False
Added iLO 5 1.10

SSDP.Port Member of ManagerNetworkProtocol.v1_0_0.ManagerNetworkProtocol
Description The SSDP port number.
Type integer or null
Read Only True
Added iLO 5 1.10

SSDP.ProtocolEnabled Member of ManagerNetworkProtocol.v1_0_0.ManagerNetworkProtocol
Description Indicates whether SSDP is enabled for the manager.
Type boolean or null
Read Only False
Added iLO 5 1.10

SSH

SSH.Port Member of ManagerNetworkProtocol.v1_0_0.ManagerNetworkProtocol
Description The SSH port number. NOTE: When this field is modified, the Manager will reset automatically.
Type integer or null
Read Only False
Added iLO 5 1.10

SSH.ProtocolEnabled Member of ManagerNetworkProtocol.v1_0_0.ManagerNetworkProtocol
Description Indicates whether SSH is enabled for the manager. NOTE: When this field is modified, the Manager will reset automatically.
Type boolean or null
Read Only False
Added iLO 5 1.10

Status

Member of ManagerNetworkProtocol.v1_0_0.ManagerNetworkProtocol See the Redfish standard schema and specification for information on common Status object.

VirtualMedia

VirtualMedia.Port Member of ManagerNetworkProtocol.v1_0_0.ManagerNetworkProtocol
Description The Virtual Media port number.
Type integer or null
Read Only False
Added iLO 5 1.10

VirtualMedia.ProtocolEnabled Member of ManagerNetworkProtocol.v1_0_0.ManagerNetworkProtocol
Description Indicates whether Virtual Media is enabled for the manager.
Type boolean or null
Read Only False
Added iLO 5 1.10

Actions

HpeiLOManagerNetworkService.SendTestAlertMail Member of ManagerNetworkProtocol.v1_0_0.ManagerNetworkProtocol There are no parameters for this action.

HpeiLOManagerNetworkService.SendTestSyslog Member of ManagerNetworkProtocol.v1_0_0.ManagerNetworkProtocol There are no parameters for this action.

Memory.v1_7_1.Memory

@odata.type: "#Memory.v1_7_1.Memory"

The Memory resource describes a memory module.

Resource Instances

Uri HTTP Allow
/redfish/v1/systems/{item}/memory/{item} GET

AllocationAlignmentMiB

Member of Memory.v1_7_1.Memory
Description The boundary which memory regions are allocated on, measured in MiB.
Type number or null
Read Only True
Added iLO 5 1.40

AllocationIncrementMiB

Member of Memory.v1_7_1.Memory
Description The size of the smallest unit of allocation for a memory region, thus it is the multiple in which regions are actually reserved.
Type number or null
Read Only True
Added iLO 5 1.40

BaseModuleType

Member of Memory.v1_7_1.Memory
Description The base module type of the memory.
Type string
Read Only True
Added iLO 5 1.10

The following are the supported values:

Value Description
RDIMM Registered DIMM
UDIMM UDIMM
SO_DIMM SO_DIMM
LRDIMM Load Reduced
Mini_RDIMM Mini_RDIMM
Mini_UDIMM Mini_UDIMM
SO_RDIMM_72b SO_RDIMM_72b
SO_UDIMM_72b SO_UDIMM_72b
SO_DIMM_16b SO_DIMM_16b
SO_DIMM_32b SO_DIMM_32b
Die A die within a package.

BusWidthBits

Member of Memory.v1_7_1.Memory
Description Bus Width in bits.
Type number or null
Read Only True
Added iLO 5 1.10

CacheSizeMiB

Member of Memory.v1_7_1.Memory
Description Total size of the cache portion memory in MiB.
Type number or null
Read Only True
Added iLO 5 1.40

CapacityMiB

Member of Memory.v1_7_1.Memory
Description Memory Capacity in MiB.
Type number or null
Read Only True
Added iLO 5 1.10

ConfigurationLocked

Member of Memory.v1_7_1.Memory
Description Indicates that the configuration of this memory has been locked
Type boolean or null
Read Only True
Added iLO 5 1.40

DataWidthBits

Member of Memory.v1_7_1.Memory
Description Data Width in bits.
Type number or null
Read Only True
Added iLO 5 1.10

DeviceID

Member of Memory.v1_7_1.Memory
Description Device ID
Type string or null
Read Only True
Added iLO 5 1.10

DeviceLocator

Member of Memory.v1_7_1.Memory
Description Location of the Memory in the platform
Type string or null
Read Only True
Added iLO 5 1.10

ErrorCorrection

Member of Memory.v1_7_1.Memory
Type string
Read Only True
Added iLO 5 1.10

The following are the supported values:

Value Description
NoECC No ECC available
SingleBitECC Single bit Data error can be corrected by ECC
MultiBitECC Multi-bit Data errors can be corrected by ECC
AddressParity Address Parity errors can be corrected

FirmwareApiVersion

Member of Memory.v1_7_1.Memory
Description Version of API supported by the firmware
Type string or null
Read Only True
Added iLO 5 1.40

FirmwareRevision

Member of Memory.v1_7_1.Memory
Description The firmware revision of this device
Type string or null
Read Only True
Added iLO 5 1.10

LogicalSizeMiB

Member of Memory.v1_7_1.Memory
Description Total size of the logical memory in MiB.
Type number or null
Read Only True
Added iLO 5 1.40

Manufacturer

Member of Memory.v1_7_1.Memory
Description The Memory manufacturer
Type string or null
Read Only True
Added iLO 5 1.10

MemoryDeviceType

Member of Memory.v1_7_1.Memory
Type string
Read Only True
Added iLO 5 1.10

The following are the supported values:

Value Description
DDR DDR
DDR2 DDR2
DDR3 DDR3
DDR4 DDR4
DDR4_SDRAM DDR4 SDRAM
DDR4E_SDRAM DDR4E SDRAM
LPDDR4_SDRAM LPDDR4 SDRAM
DDR3_SDRAM DDR3 SDRAM
LPDDR3_SDRAM LPDDR3 SDRAM
DDR2_SDRAM DDR2 SDRAM
DDR2_SDRAM_FB_DIMM DDR2 SDRAM FB_DIMM
DDR2_SDRAM_FB_DIMM_PROBE DDR2 SDRAM FB_DIMM PROBE
DDR_SGRAM DDR SGRAM
DDR_SDRAM DDR SDRAM
ROM ROM
SDRAM SDRAM
EDO EDO
FastPageMode Fast Page Mode
PipelinedNibble Pipelined Nibble
Logical Logical Non-volatile device.

MemoryLocation

MemoryLocation.Channel Member of Memory.v1_7_1.Memory
Description Channel number in which Memory is connected
Type number or null
Read Only True
Added iLO 5 1.10

MemoryLocation.MemoryController Member of Memory.v1_7_1.Memory
Description Memory controller number in which Memory is connected
Type number or null
Read Only True
Added iLO 5 1.10

MemoryLocation.Slot Member of Memory.v1_7_1.Memory
Description Slot number in which Memory is connected
Type number or null
Read Only True
Added iLO 5 1.10

MemoryLocation.Socket Member of Memory.v1_7_1.Memory
Description Socket number in which Memory is connected
Type number or null
Read Only True
Added iLO 5 1.10

MemoryMedia (array)

Member of Memory.v1_7_1.Memory MemoryMedia is an array containing elements of:
Type string
Read Only True

The following are the supported values:

Value Description
DRAM DRAM media
NAND NAND media
Intel3DXPoint Intel 3D XPoint media
Proprietary Proprietary media

MemorySubsystemControllerManufacturerID

Member of Memory.v1_7_1.Memory
Description The manufacturer ID of the memory subsystem controller of this memory module.
Type string or null
Read Only True

MemorySubsystemControllerProductID

Member of Memory.v1_7_1.Memory
Description The product ID of the memory subsystem controller of this memory module.
Type string or null
Read Only True

MemoryType

Member of Memory.v1_7_1.Memory
Type string
Read Only True
Added iLO 5 1.10

The following are the supported values:

Value Description
DRAM DRAM
NVDIMM_N NVDIMM_N as defined by JEDEC.
NVDIMM_F NVDIMM_F as defined by JEDEC.
NVDIMM_P NVDIMM_P as defined by JEDEC.
IntelOptane The memory module is Intel Optane DC Persistent Memory and composed of a combination of non-volatile and volatile memory.

ModuleManufacturerID

Member of Memory.v1_7_1.Memory
Description The manufacturer ID of this memory module.
Type string or null
Read Only True

ModuleProductID

Member of Memory.v1_7_1.Memory
Description The product ID of this memory module.
Type string or null
Read Only True

NonVolatileSizeMiB

Member of Memory.v1_7_1.Memory
Description Total size of the non-volatile portion memory in MiB.
Type number or null
Read Only True
Added iLO 5 1.40

Oem.Hpe.Armed

Member of Memory.v1_7_1.Memory
Description Specifies the current backup-ready status of the NVDIMM_N if available.
Type boolean or null
Read Only True
Added iLO 5 1.10

Oem.Hpe.Attributes (array)

Member of Memory.v1_7_1.Memory Attributes is an array containing elements of:
Type string
Read Only True

The following are the supported values:

Value Description
HpeSmartMemory This DIMM is HPE Smart Memory
HpeStandardMemory This DIMM is HPE Standard Memory
HpeLogicalNVDIMM This DIMM is HPE Logical Memory.

Oem.Hpe.BaseModuleType

Member of Memory.v1_7_1.Memory
Type string
Read Only True
Added iLO 5 1.30

The following are the supported values:

Value
BurstEDO
FastPage
Synchronous
EDO
LRDIMM
RDRAM
RDIMM
UDIMM
NVDIMM
NVDIMM-N
LRNVDIMM
SO_RDIMM_72b
SO_UDIMM_72b
PMM

Oem.Hpe.BlocksRead

Member of Memory.v1_7_1.Memory
Description Number of blocks read for the lifetime of the Memory.
Type integer or null
Read Only True
Added iLO 5 1.40

Oem.Hpe.BlocksWritten

Member of Memory.v1_7_1.Memory
Description Number of blocks written for the lifetime of the Memory.
Type integer or null
Read Only True
Added iLO 5 1.40

Oem.Hpe.DIMMManufacturingDate

Member of Memory.v1_7_1.Memory
Description Module manufacturing date in YYWW format.
Type string or null
Read Only True

Oem.Hpe.DIMMStatus

Member of Memory.v1_7_1.Memory
Description Specifies memory module status and whether the module in use.
Type string or null
Read Only True
Added iLO 5 1.10

The following are the supported values:

Value Description
Null A value is temporarily unavailable
Unknown The status of the DIMM is unknown.
Other DIMM status that does not fit any of these definitions.
NotPresent DIMM is not present.
PresentUnused DIMM is present but unused.
GoodInUse DIMM is functioning properly and currently in use.
AddedButUnused DIMM is added but currently unused.
UpgradedButUnused DIMM is upgraded but currently unused.
ExpectedButMissing DIMM is expected but missing.
DoesNotMatch DIMM type does not match.
NotSupported DIMM is not supported.
ConfigurationError Configuration error in DIMM.
Degraded DIMM state is degraded.
PresentSpare DIMM is present but used as spare.
GoodPartiallyInUse DIMM is functioning properly but partially in use.
MapOutConfiguration DIMM mapped out due to configuration error.
MapOutError DIMM mapped out due to training failure.

Oem.Hpe.MaxOperatingSpeedMTs

Member of Memory.v1_7_1.Memory
Description Maximum capable speed of the device, in megatransfers per second (MT/s).
Type integer or null
Read Only True

Oem.Hpe.MinimumVoltageVoltsX10

Member of Memory.v1_7_1.Memory
Description The minimum DIMM voltage multiplied by 10, for example, 1.2v = 12.
Type integer or null
Read Only True
Added iLO 5 1.10

Oem.Hpe.PartNumber

Member of Memory.v1_7_1.Memory
Description The HPE product part number of this device
Type string or null
Read Only True

Oem.Hpe.PredictedMediaLifeLeftPercent

Member of Memory.v1_7_1.Memory
Description The percentage of media life left.
Type integer or null
Read Only True
Added iLO 5 1.10

Oem.Hpe.ProductName

Member of Memory.v1_7_1.Memory
Description friendly product name from SMBIOS 202 record
Type string
Read Only True
Added iLO 5 1.10

Oem.Hpe.RelatedBackupStores (array)

Member of Memory.v1_7_1.Memory RelatedBackupStores is an array containing elements of:

RelatedBackupStores[{item}].@odata.id Member of Memory.v1_7_1.Memory
Type string
Read Only True
Format uri-reference

Oem.Hpe.RelatedPhysicalDIMMs (array)

Member of Memory.v1_7_1.Memory RelatedPhysicalDIMMs is an array containing elements of:

RelatedPhysicalDIMMs[{item}].@odata.id Member of Memory.v1_7_1.Memory
Type string
Read Only True
Format uri-reference

Oem.Hpe.RelatedPowerBackupUnitBays (array)

Member of Memory.v1_7_1.Memory RelatedPowerBackupUnitBays is an array containing elements of:
Description Battery backup unit bay number.
Type integer
Read Only True

Oem.Hpe.SPDBytes (array)

Member of Memory.v1_7_1.Memory SPDBytes is an array containing elements of:
Description The SPD Bytes in the DIMM
Type integer
Read Only True

Oem.Hpe.SpareBlockLeftPercent

Member of Memory.v1_7_1.Memory
Description The percentage of the number of spare blocks remaining.
Type integer or null
Read Only True
Added iLO 5 1.40

Oem.Hpe.VendorName

Member of Memory.v1_7_1.Memory
Description Vendor Name decoded from VendorID
Type string or null
Read Only True

OperatingMemoryModes (array)

Member of Memory.v1_7_1.Memory OperatingMemoryModes is an array containing elements of:
Type string
Read Only True

The following are the supported values:

Value Description
Volatile Volatile memory
PMEM Persistent memory, byte accesible through system address space
Block Block accessible system memory

OperatingSpeedMhz

Member of Memory.v1_7_1.Memory
Description Operating speed of Memory in MHz
Type number or null
Read Only True
Added iLO 5 1.10

PartNumber

Member of Memory.v1_7_1.Memory
Description The product part number of this device
Type string or null
Read Only True
Added iLO 5 1.10

PersistentRegionNumberLimit

Member of Memory.v1_7_1.Memory
Description Total number of persistent regions this Memory can support.
Type number or null
Read Only True
Added iLO 5 1.40

PersistentRegionSizeLimitMiB

Member of Memory.v1_7_1.Memory
Description Total size of persistent regions in MiB
Type number or null
Read Only True
Added iLO 5 1.10

PersistentRegionSizeMaxMiB

Member of Memory.v1_7_1.Memory
Description Maximum size of a single persistent region in MiB.
Type number or null
Read Only True
Added iLO 5 1.40

RankCount

Member of Memory.v1_7_1.Memory
Description Number of ranks available in the Memory
Type number or null
Read Only True
Added iLO 5 1.10

Regions (array)

Member of Memory.v1_7_1.Memory Regions is an array containing elements of:

Regions[{item}].MemoryClassification Member of Memory.v1_7_1.Memory
Description Classification of memory occupied by the given memory region
Type string
Read Only True
Added iLO 5 1.40

The following are the supported values:

Value Description
Volatile Volatile memory
ByteAccessiblePersistent Byte accessible persistent memory
Block Block accesible memory

Regions[{item}].PassphraseEnabled Member of Memory.v1_7_1.Memory
Description State of the passphrase for this region
Type boolean or null
Read Only True
Added iLO 5 1.40

Regions[{item}].RegionId Member of Memory.v1_7_1.Memory
Description Unique region ID representing a specific region within the Memory
Type string or null
Read Only True
Added iLO 5 1.40

Regions[{item}].SizeMiB Member of Memory.v1_7_1.Memory
Description Size of this memory region in MiB
Type number or null
Read Only True
Added iLO 5 1.40

SecurityCapabilities

SecurityCapabilities.ConfigurationLockCapable Member of Memory.v1_7_1.Memory
Description Support for configuration locking
Type boolean or null
Read Only True
Added iLO 5 1.40

SecurityCapabilities.DataLockCapable Member of Memory.v1_7_1.Memory
Description Support for data locking
Type boolean or null
Read Only True
Added iLO 5 1.40

SecurityCapabilities.PassphraseCapable Member of Memory.v1_7_1.Memory
Description Memory passphrase set capability
Type boolean or null
Read Only True
Added iLO 5 1.40

SecurityCapabilities.PassphraseLockLimit Member of Memory.v1_7_1.Memory
Description Maximum number of incorrect passphrase attempts allowed before memory is locked.
Type number or null
Read Only True
Added iLO 5 1.40

SecurityState

Member of Memory.v1_7_1.Memory
Description The current security state of this Memory
Type string or null
Read Only True
Added iLO 5 1.40

The following are the supported values:

Value Description
Enabled Secure mode is enabled and access to the data is unlocked
Disabled Secure mode is disabled
Locked Secure mode is enabled and access to the data is locked
Passphraselimit Number of attempts to unlock the Memory exceeded limit

SerialNumber

Member of Memory.v1_7_1.Memory
Description The serial number of this device
Type string or null
Read Only True
Added iLO 5 1.15

Status

Member of Memory.v1_7_1.Memory See the Redfish standard schema and specification for information on common Status object.

SubsystemDeviceID

Member of Memory.v1_7_1.Memory
Description Subsystem Device ID
Type string or null
Read Only True
Added iLO 5 1.10

SubsystemVendorID

Member of Memory.v1_7_1.Memory
Description SubSystem Vendor ID
Type string or null
Read Only True
Added iLO 5 1.10

VendorID

Member of Memory.v1_7_1.Memory
Description Vendor ID
Type string or null
Read Only True
Added iLO 5 1.10

VolatileRegionNumberLimit

Member of Memory.v1_7_1.Memory
Description Total number of volatile regions this Memory can support.
Type number or null
Read Only True
Added iLO 5 1.40

VolatileRegionSizeLimitMiB

Member of Memory.v1_7_1.Memory
Description Total size of volatile regions in MiB
Type number or null
Read Only True
Added iLO 5 1.10

VolatileRegionSizeMaxMiB

Member of Memory.v1_7_1.Memory
Description Maximum size of a single volatile region in MiB.
Type number or null
Read Only True
Added iLO 5 1.40

VolatileSizeMiB

Member of Memory.v1_7_1.Memory
Description Total size of the volitile portion memory in MiB.
Type number or null
Read Only True
Added iLO 5 1.40

MemoryChunks.v1_2_3.MemoryChunks

@odata.type: "#MemoryChunks.v1_2_3.MemoryChunks"

The MemoryChunks resource describes a Memory Chunk and its configuration.

Resource Instances

Uri HTTP Allow
/redfish/v1/systems/{item}/memorydomains/{item}/memorychunks/{item} GET DELETE

AddressRangeType

Member of MemoryChunks.v1_2_3.MemoryChunks
Description Memory type of this memory chunk
Type string
Read Only True
Added iLO 5 1.40

The following are the supported values:

Value Description
PMEM Byte accessible persistent memory

InterleaveSets (array)

Member of MemoryChunks.v1_2_3.MemoryChunks InterleaveSets is an array containing elements of:

InterleaveSets[{item}].Memory Describes a memory device of the interleave set. Memory is a link ("@odata.id": URI) to another resource.

InterleaveSets[{item}].MemoryLevel Member of MemoryChunks.v1_2_3.MemoryChunks
Description Level of the interleave set for multi-level tiered memory.
Type number or null
Read Only True
Added iLO 5 1.40

InterleaveSets[{item}].OffsetMiB Member of MemoryChunks.v1_2_3.MemoryChunks
Description Offset within the DIMM that corresponds to the start of this memory region, with units in MiB
Type number or null
Read Only True
Added iLO 5 1.40

InterleaveSets[{item}].RegionId Member of MemoryChunks.v1_2_3.MemoryChunks
Description DIMM region identifier
Type string or null
Read Only True
Added iLO 5 1.40

InterleaveSets[{item}].SizeMiB Member of MemoryChunks.v1_2_3.MemoryChunks
Description Size of this memory region in MiB
Type number or null
Read Only True
Added iLO 5 1.40

IsMirrorEnabled

Member of MemoryChunks.v1_2_3.MemoryChunks
Description Mirror Enabled status
Type boolean or null
Read Only True
Added iLO 5 1.40

IsSpare

Member of MemoryChunks.v1_2_3.MemoryChunks
Description Spare enabled status
Type boolean or null
Read Only True
Added iLO 5 1.40

MemoryChunkSizeMiB

Member of MemoryChunks.v1_2_3.MemoryChunks
Description Size of the memory chunk in MiB
Type number or null
Read Only True
Added iLO 5 1.40

Oem.Hpe.MemoryChunkSizePercentage

Member of MemoryChunks.v1_2_3.MemoryChunks
Description Size of chunk in percent of total capacity.
Type integer or null
Read Only False
Added iLO 5 1.40

Status

Member of MemoryChunks.v1_2_3.MemoryChunks See the Redfish standard schema and specification for information on common Status object.

MemoryChunksCollection.MemoryChunksCollection

@odata.type: "#MemoryChunksCollection.MemoryChunksCollection"

A Collection of MemoryChunks resource instances.

Resource Instances

Uri HTTP Allow
/redfish/v1/systems/{item}/memorydomains/{item}/memorychunks GET POST
Link Name Destination type
Members[] MemoryChunks

Members (array)

Member of MemoryChunksCollection.MemoryChunksCollection Members is an array containing elements of:

Members[{item}].@odata.id Member of MemoryChunksCollection.MemoryChunksCollection
Type string
Read Only True
Format uri-reference

Members@odata.count

Member of MemoryChunksCollection.MemoryChunksCollection
Description The total number of collection members.
Type integer
Read Only True

MemoryCollection.MemoryCollection

@odata.type: "#MemoryCollection.MemoryCollection"

A Collection of Memory resource instances.

Resource Instances

Uri HTTP Allow
/redfish/v1/systems/{item}/memory GET
Link Name Destination type
Members[] Memory

Members (array)

Member of MemoryCollection.MemoryCollection Members is an array containing elements of:

Members[{item}].@odata.id Member of MemoryCollection.MemoryCollection
Type string
Read Only True
Format uri-reference

Members@odata.count

Member of MemoryCollection.MemoryCollection
Description The total number of collection members.
Type integer
Read Only True

Oem.Hpe.AmpModeActive

Member of MemoryCollection.MemoryCollection
Type string or null
Read Only True
Added iLO 5 1.10

The following are the supported values:

Value Description
Unknown The management software cannot determine the AMP, host OS may not have provided it yet.
Other
None The management software cannot determine the AMP, or the system is not configured for AMP.
Mirroring The system is configured for mirrored memory protection. All memory banks are duplicated in mirrored memory, as opposed to only one for online spare memory. If enough ECC errors occur, the spare memory is activated and the memory that is experiencing the errors is disabled.
OnlineSpare A single spare bank of memory is set aside at boot time. If enough ECC errors occur, the spare memory is activated and the memory that is experiencing the errors is disabled.
RAIDXOR The system is configured for AMP with the XOR engine.
AdvancedECC The system is configured for AMP with the Advanced ECC engine.
Lockstep
A3DC The system is configured for AMP with A3DC.
DIMMECC The system is configured for AMP with DIMM ECC (Error Correcting Code) only.

Oem.Hpe.AmpModeStatus

Member of MemoryCollection.MemoryCollection
Type string or null
Read Only True
Added iLO 5 1.10

The following are the supported values:

Value Description
Unknown The management software cannot determine the status, host OS may not have provided it yet.
Other The system does not support AMP, or the management software cannot determine the status.
NotProtected The system supports AMP, but the feature is disabled.
Protected The system supports AMP. The feature is enabled but not engaged.
Degraded The system was protected, but AMP is engaged. Therefore, AMP is no longer available.
DIMMECC The system is protected by DIMM ECC (Error Correcting Code) only.
Mirroring The system is protected by AMP in the mirrored mode. No DIMM faults have been detected.
DegradedMirroring The system is protected by AMP in the mirrored mode. One or more DIMM faults have been detected.
OnlineSpare The system is protected by AMP in the hot spare mode. No DIMM faults have been detected.
DegradedOnlineSpare
RAIDXOR The system is protected by AMP in the XOR memory mode. No DIMM faults have been detected.
DegradedRAIDXOR The system is protected by AMP in the XOR memory mode. One or more DIMM faults have been detected.
AdvancedECC The system is protected by AMP in the Advanced ECC mode.
DegradedAdvancedECC The system is protected by AMP in the Advanced ECC mode. One or more DIMM faults have been detected.
Lockstep
DegradedLockstep
A3DC The system is protected by AMP in the A3DC mode.
DegradedA3DC The system is protected by AMP in the A3DC mode. One or more DIMM faults have been deteced.

Oem.Hpe.AmpModeSupported (array)

Member of MemoryCollection.MemoryCollection AmpModeSupported is an array containing elements of:
Type string or null
Read Only True

The following are the supported values:

Value Description
RAIDXOR The system can be configured for AMP using the XOR engine.
DualBoardMirroring The system can be configured for mirrored advanced memory protection in a dual memory board configuration. The mirrored memory can be swapped with memory on the same memory board or with memory on the second memory board.
SingleBoardMirroring The system can be configured for mirrored advanced memory protection in a single memory board.
AdvancedECC The system can be configured for Advanced ECC.
Mirroring The system can be configured for mirrored AMP.
OnlineSpare The system can be configured for online spare AMP.
OnlineSpareRank The system can be configured for Online Spare Rank AMP.
OnlineSpareChannel The system can be configured for Online Spare Channel AMP.
IntersocketMirroring The system can be configured for mirrored intersocket AMP between the memory of two processors or boards.
IntrasocketMirroring The system can be configured for mirrored intrasocket AMP between the memory of a single processor or board.
Lockstep
A3DC The system can be configured for A3DC.
None The system cannot be configured for AMP.
DIMMECC The system can be configured for DIMM ECC (Error Correcting Code) only.

Oem.Hpe.MemoryList (array)

Member of MemoryCollection.MemoryCollection MemoryList is an array containing elements of:

MemoryList[{item}].BoardCpuNumber Member of MemoryCollection.MemoryCollection
Type integer or null
Read Only True

MemoryList[{item}].BoardNumberOfSockets Member of MemoryCollection.MemoryCollection
Description The number of present memory module sockets.
Type integer or null
Read Only True

MemoryList[{item}].BoardOperationalFrequency Member of MemoryCollection.MemoryCollection
Description The frequency at which memory on the board is operating in MHz.
Type integer or null
Read Only True

MemoryList[{item}].BoardOperationalVoltage Member of MemoryCollection.MemoryCollection
Description The voltage at which memory on the board is operating in mV.
Type integer or null
Read Only True

MemoryList[{item}].BoardTotalMemorySize Member of MemoryCollection.MemoryCollection
Description The total size of the memory populated on the board in MB.
Type integer or null
Read Only True

MemoryDomain.v1_2_1.MemoryDomain

@odata.type: "#MemoryDomain.v1_2_1.MemoryDomain"

The MemoryDomain resource describes a Memory Domain and its configuration. Memory Domains are used to indicate to the client which Memory (DIMMs) can be grouped together in Memory Chunks to form interleave sets or otherwise grouped together.

Resource Instances

Uri HTTP Allow
/redfish/v1/systems/{item}/memorydomains/{item} GET

AllowsBlockProvisioning

Member of MemoryDomain.v1_2_1.MemoryDomain
Description Indicates if this Memory Domain supports the provisioning of blocks of memory.
Type boolean or null
Read Only True
Added iLO 5 1.40

AllowsMemoryChunkCreation

Member of MemoryDomain.v1_2_1.MemoryDomain
Description Indicates if this Memory Domain supports the creation of Memory Chunks.
Type boolean or null
Read Only True
Added iLO 5 1.40

AllowsMirroring

Member of MemoryDomain.v1_2_1.MemoryDomain
Description Indicates if this Memory Domain supports the creation of Memory Chunks with mirroring enabled.
Type boolean or null
Read Only True
Added iLO 5 1.40

AllowsSparing

Member of MemoryDomain.v1_2_1.MemoryDomain
Description Indicates if this Memory Domain supports the creation of Memory Chunks with sparing enabled.
Type boolean or null
Read Only True
Added iLO 5 1.40

InterleavableMemorySets (array)

Member of MemoryDomain.v1_2_1.MemoryDomain InterleavableMemorySets is an array containing elements of:

InterleavableMemorySets[{item}].MemorySet (array) Member of MemoryDomain.v1_2_1.MemoryDomain MemorySet is an array containing elements of:

MemorySet[{item}].@odata.id Member of MemoryDomain.v1_2_1.MemoryDomain
Type string
Read Only True
Format uri-reference

InterleavableMemorySets[{item}].MemorySet@odata.count Member of MemoryDomain.v1_2_1.MemoryDomain
Type string
Read Only True
Format uri-reference

MemoryChunks

A reference to the collection of Memory Chunks associated with this Memory Domain. MemoryChunks is a link ("@odata.id": URI) to another resource.

MemoryDomainCollection.MemoryDomainCollection

@odata.type: "#MemoryDomainCollection.MemoryDomainCollection"

A Collection of MemoryDomain resource instances.

Resource Instances

Uri HTTP Allow
/redfish/v1/systems/{item}/memorydomains GET
Link Name Destination type
Members[] MemoryDomain

Members (array)

Member of MemoryDomainCollection.MemoryDomainCollection Members is an array containing elements of:

Members[{item}].@odata.id Member of MemoryDomainCollection.MemoryDomainCollection
Type string
Read Only True
Format uri-reference

Members@odata.count

Member of MemoryDomainCollection.MemoryDomainCollection
Description The total number of collection members.
Type integer
Read Only True

MessageRegistryFile.v1_0_4.MessageRegistryFile

@odata.type: "#MessageRegistryFile.v1_0_4.MessageRegistryFile"

The MessageRegistryFile resource describes the Schema File locator resource.

Resource Instances

Uri HTTP Allow
/redfish/v1/registries/{item} GET

Languages (array)

Member of MessageRegistryFile.v1_0_4.MessageRegistryFile Languages is an array containing elements of:
Type string
Read Only True

Location (array)

Member of MessageRegistryFile.v1_0_4.MessageRegistryFile Location is an array containing elements of:

Location[{item}].Language Member of MessageRegistryFile.v1_0_4.MessageRegistryFile
Description The RFC 5646 language code for this schema or registry item.
Type string
Read Only True
Added iLO 5 1.15

Location[{item}].Uri Member of MessageRegistryFile.v1_0_4.MessageRegistryFile
Description Link to locally available URI for schema.
Type string
Read Only True
Added iLO 5 1.15
Format uri-reference

Registry

Member of MessageRegistryFile.v1_0_4.MessageRegistryFile
Description The Registry Name, Major and Minor version used in MessageID construction.
Type string
Read Only True
Added iLO 5 1.15

MessageRegistryFileCollection.MessageRegistryFileCollection

@odata.type: "#MessageRegistryFileCollection.MessageRegistryFileCollection"

A Collection of MessageRegistryFile resource instances.

Resource Instances

Uri HTTP Allow
/redfish/v1/registries GET
Link Name Destination type
Members[] MessageRegistryFile

Members (array)

Member of MessageRegistryFileCollection.MessageRegistryFileCollection Members is an array containing elements of:

Members[{item}].@odata.id Member of MessageRegistryFileCollection.MessageRegistryFileCollection
Type string
Read Only True
Format uri-reference

Members@odata.count

Member of MessageRegistryFileCollection.MessageRegistryFileCollection
Description The total number of collection members.
Type integer
Read Only True

MetricDefinition.v1_0_0.MetricDefinition

@odata.type: "#MetricDefinition.v1_0_0.MetricDefinition"

The metadata information about a metric.

Resource Instances

Uri HTTP Allow
/redfish/v1/telemetryservice/metricdefinitions/{item} GET

Calculable

Member of MetricDefinition.v1_0_0.MetricDefinition
Description The types of calculations which can be applied to the metric reading. This property provides information to the client on the suitability of calculatiion using the metric reading.
Type string
Read Only True
Added iLO 5 1.40

The following are the supported values:

Value Description
NonCalculatable No calculations should be performed on the metric reading.
Summable The sum of the metric reading across multiple instances is meaningful.
NonSummable The sum of the metric reading across multiple instances is not meaningful.

CalculationAlgorithm

Member of MetricDefinition.v1_0_0.MetricDefinition
Description The calculation which is performed on a source metric to obtain the metric being defined.
Type string
Read Only True
Added iLO 5 1.40

The following are the supported values:

Value Description
Average The metric is calculated as the average of a metric reading over a sliding time interval.
Maximum The metric is calculated as the maximum value of a metric reading over during a time interval.
Minimum The metric is calculated as the minimum value of a metric reading over a sliding time interval.

Implementation

Member of MetricDefinition.v1_0_0.MetricDefinition
Description The implementation of the metric.
Type string
Read Only True
Added iLO 5 1.40

The following are the supported values:

Value Description
PhysicalSensor The metric is implemented as a physical sensor.
Calculated The metric is implemented by applying a calculation on another metric property. The calculation is specified in the CalculationAlgorithm property.
Synthesized The metric is implemented by applying a calculation on one or more metric properties. (The calculation is not specified. For expressing generalized formula, see MathSON).
DigitalMeter The metric is implemented as digital meter.

IsLinear

Member of MetricDefinition.v1_0_0.MetricDefinition
Description Indicates whether the metric values are linear (vs non-linear).
Type boolean or null
Read Only False
Added iLO 5 1.40

MaxReadingRange

Member of MetricDefinition.v1_0_0.MetricDefinition
Description Maximum value for metric reading.
Type number or null
Read Only True
Added iLO 5 1.40

MetricDataType

Member of MetricDefinition.v1_0_0.MetricDefinition
Description The data type of the related metric values. The property provides information to the client on the nature of the metric reading.
Type string
Read Only True
Added iLO 5 1.40

The following are the supported values:

Value Description
Boolean The data type follows the JSON Boolean definition.
DateTime The data type follows the JSON String definition with the Date-Time format applied.
Decimal The data type follows the JSON Decimal definition.
Integer The data type follows the JSON Integer definition.
String The data type follows the JSON String definition.
Enumeration The data type follows the JSON String definition with a set of enumerations defined.

MetricProperties (array)

Member of MetricDefinition.v1_0_0.MetricDefinition MetricProperties is an array containing elements of:
Type string or null
Read Only True

MetricType

Member of MetricDefinition.v1_0_0.MetricDefinition
Description Specifies the type of metric provided. The property provides information to the client on how the metric can be handled.
Type string
Read Only True
Added iLO 5 1.40

The following are the supported values:

Value Description
Numeric The metric is a numeric metric. The metric value is any real number.
Discrete The metric is a discrete metric. The metric value is discrete. The possible values are listed in the DiscreteValues property.
Gauge The metric is a gauge metric. The metric value is a real number. When the metric value reaches the gauges extrema, it stays at that value, until the reading falls within the extrema.
Counter The metric is a counter metric. The metric reading is a non-negative integer which increases monotonically. When a counter reaches its maximum, the value resets to 0 and resumes counting.
Countdown The metric is a countdown metric. The metric reading is a non-negative integer which decreases monotonically. When a counter reaches its minimum, the value resets to preset value and resumes counting down.

MinReadingRange

Member of MetricDefinition.v1_0_0.MetricDefinition
Description Minimum value for metric reading.
Type number or null
Read Only True
Added iLO 5 1.40

Units

Member of MetricDefinition.v1_0_0.MetricDefinition
Description The units of measure for this metric.
Type string or null
Read Only False
Added iLO 5 1.40

MetricDefinitionCollection.MetricDefinitionCollection

@odata.type: "#MetricDefinitionCollection.MetricDefinitionCollection"

A Collection of MetricDefinition resource instances.

Resource Instances

Uri HTTP Allow
/redfish/v1/telemetryservice/metricdefinitions GET
Link Name Destination type
Members[] MetricDefinition

Members (array)

Member of MetricDefinitionCollection.MetricDefinitionCollection Members is an array containing elements of:

Members[{item}].@odata.id Member of MetricDefinitionCollection.MetricDefinitionCollection
Type string
Read Only True
Format uri-reference

Members@odata.count

Member of MetricDefinitionCollection.MetricDefinitionCollection
Description The total number of collection members.
Type integer
Read Only True

MetricReport.v1_0_0.MetricReport

@odata.type: "#MetricReport.v1_0_0.MetricReport"

The metric definitions used to create a metric report.

Resource Instances

Uri HTTP Allow
/redfish/v1/telemetryservice/metricreports/{item} GET

MetricReportDefinition

The metric definitions used to create a metric report. MetricReportDefinition is a link ("@odata.id": URI) to another resource.

MetricValues (array)

Member of MetricReport.v1_0_0.MetricReport MetricValues is an array containing elements of:

MetricValues[{item}].MetricDefinition A link to the Metric Definition. MetricDefinition is a link ("@odata.id": URI) to another resource.

MetricValues[{item}].MetricId Member of MetricReport.v1_0_0.MetricReport
Description The metric definitions identifier for this metric.
Type string or null
Read Only True
Added iLO 5 1.40

MetricValues[{item}].MetricValue Member of MetricReport.v1_0_0.MetricReport
Description The value identifies this resource.
Type string or null
Read Only True
Added iLO 5 1.40

MetricValues[{item}].Timestamp Member of MetricReport.v1_0_0.MetricReport
Description The time when the value of the metric is obtained.
Type string or null
Read Only True
Added iLO 5 1.40
Format date-time

MetricReportCollection.MetricReportCollection

@odata.type: "#MetricReportCollection.MetricReportCollection"

A Collection of MetricReport resource instances.

Resource Instances

Uri HTTP Allow
/redfish/v1/telemetryservice/metricreports GET
Link Name Destination type
Members[] MetricReport

Members (array)

Member of MetricReportCollection.MetricReportCollection Members is an array containing elements of:

Members[{item}].@odata.id Member of MetricReportCollection.MetricReportCollection
Type string
Read Only True
Format uri-reference

Members@odata.count

Member of MetricReportCollection.MetricReportCollection
Description The total number of collection members.
Type integer
Read Only True

MetricReportDefinition.v1_0_0.MetricReportDefinition

@odata.type: "#MetricReportDefinition.v1_0_0.MetricReportDefinition"

A set of metrics that are collected into a metric report.

Resource Instances

Uri HTTP Allow
/redfish/v1/telemetryservice/metricreportdefinitions/{item} GET

MetricProperties (array)

Member of MetricReportDefinition.v1_0_0.MetricReportDefinition MetricProperties is an array containing elements of:
Type string or null
Read Only True

MetricReport

Specifies the location where the resultant metric report is placed. MetricReport is a link ("@odata.id": URI) to another resource.

MetricReportDefinitionType

Member of MetricReportDefinition.v1_0_0.MetricReportDefinition
Description Indicates when the metric report is generated.
Type string
Read Only True
Added iLO 5 1.40

The following are the supported values:

Value Description
Periodic The metric report is generated at a periodic time interval, specified in the Schedule property.
OnChange The metric report is generated when any of the metric values change.
OnRequest The metric report is generated when a HTTP GET is performed on the specified metric report.

Metrics (array)

Member of MetricReportDefinition.v1_0_0.MetricReportDefinition Metrics is an array containing elements of:

Metrics[{item}].CollectionDuration Member of MetricReportDefinition.v1_0_0.MetricReportDefinition
Description Specifies the duration over which the function is computed.
Type string or null
Read Only False
Added iLO 5 1.40

Metrics[{item}].CollectionFunction Member of MetricReportDefinition.v1_0_0.MetricReportDefinition
Description Specifies the function to apply to the list of metric properties.
Type string
Read Only False
Added iLO 5 1.40

The following are the supported values:

Value Description
Average The metric is calculated as the average of a metric reading over a sliding time interval.
Maximum The metric is calculated as the maximum value of a metric reading over during a time interval.
Minimum The metric is calculated as the minimum value of a metric reading over a sliding time interval.
Summation The metric is calculated as the sum of the values over a sliding time interval.

Metrics[{item}].CollectionTimeScope Member of MetricReportDefinition.v1_0_0.MetricReportDefinition
Description The time scope of the related metric values.
Type string
Read Only False
Added iLO 5 1.40

The following are the supported values:

Value Description
Point The corresponding metric values apply to a point in time. On the corresponding metric value instances, the value of Timestamp shall specify the point in time.
Interval The corresponding metric values apply to a time interval. On the corresponding metric value instances, the value of Timestamp shall specify the end of the time interval and Duration shall specify its duration.
StartupInterval The corresponding metric values apply to a time interval that began at the startup of the measured resource (i.e. the Resources associated by Links.MetricDefinitionForResources). On the corresponding metric value instances, the value of Timestamp shall specify the end of the time interval. The value of Duration shall specifies the duration between startup of the resource and TimeStamp.

Metrics[{item}].MetricId Member of MetricReportDefinition.v1_0_0.MetricReportDefinition
Description Specifies the label for the metric definition which is derived by applying the CollectionFunction to the metric property.
Type string or null
Read Only True
Added iLO 5 1.40

Metrics[{item}].MetricProperties (array) Member of MetricReportDefinition.v1_0_0.MetricReportDefinition MetricProperties is an array containing elements of:
Type string or null
Read Only True

Status

Member of MetricReportDefinition.v1_0_0.MetricReportDefinition See the Redfish standard schema and specification for information on common Status object.

MetricReportDefinitionCollection.MetricReportDefinitionCollection

@odata.type: "#MetricReportDefinitionCollection.MetricReportDefinitionCollection"

A Collection of MetricReportDefinition resource instances.

Resource Instances

Uri HTTP Allow
/redfish/v1/telemetryservice/metricreportdefinitions GET
Link Name Destination type
Members[] MetricReportDefinition

Members (array)

Member of MetricReportDefinitionCollection.MetricReportDefinitionCollection Members is an array containing elements of:

Members[{item}].@odata.id Member of MetricReportDefinitionCollection.MetricReportDefinitionCollection
Type string
Read Only True
Format uri-reference

Members@odata.count

Member of MetricReportDefinitionCollection.MetricReportDefinitionCollection
Description The total number of collection members.
Type integer
Read Only True

NetworkAdapter.v1_5_0.NetworkAdapter

@odata.type: "#NetworkAdapter.v1_5_0.NetworkAdapter"

A NetworkAdapter represents the physical network adapter capable of connecting to a computer network. Examples include but are not limited to Ethernet, Fibre Channel, and converged network adapters.

Resource Instances

Uri HTTP Allow
/redfish/v1/chassis/{item}/networkadapters/{item} GET POST PATCH
/redfish/v1/chassis/{item}/networkadapters/{item}/settings GET POST PATCH

@Redfish.Settings

Member of NetworkAdapter.v1_5_0.NetworkAdapter See the Redfish standard schema and specification for information on common @Redfish properties.

Controllers (array)

Member of NetworkAdapter.v1_5_0.NetworkAdapter Controllers is an array containing elements of:

Controllers[{item}].ControllerCapabilities Controllers[{item}].ControllerCapabilities.DataCenterBridging Controllers[{item}].ControllerCapabilities.DataCenterBridging.Capable Member of NetworkAdapter.v1_5_0.NetworkAdapter
Description The value of this property shall be a boolean indicating whether this controller is capable of Data Center Bridging (DCB).
Type boolean or null
Read Only True
Added iLO 5 1.20

Controllers[{item}].ControllerCapabilities.NPAR Controllers[{item}].ControllerCapabilities.NPAR.NparCapable Member of NetworkAdapter.v1_5_0.NetworkAdapter
Description Indicates whether or not NIC function partitioning is supported by a controller.
Type boolean or null
Read Only True
Added iLO 5 1.40

Controllers[{item}].ControllerCapabilities.NPAR.NparEnabled Member of NetworkAdapter.v1_5_0.NetworkAdapter
Description When true, NIC function partitioning is active on this controller.
Type boolean or null
Read Only False
Added iLO 5 1.40

Controllers[{item}].ControllerCapabilities.NPIV Controllers[{item}].ControllerCapabilities.NPIV.MaxDeviceLogins Member of NetworkAdapter.v1_5_0.NetworkAdapter
Description The maximum number of N_Port ID Virtualization (NPIV) logins allowed simultaneously from all ports on this controller.
Type number or null
Read Only True
Added iLO 5 1.20

Controllers[{item}].ControllerCapabilities.NPIV.MaxPortLogins Member of NetworkAdapter.v1_5_0.NetworkAdapter
Description The maximum number of N_Port ID Virtualization (NPIV) logins allowed per physical port on this controller.
Type number or null
Read Only True
Added iLO 5 1.20

Controllers[{item}].ControllerCapabilities.NetworkDeviceFunctionCount Member of NetworkAdapter.v1_5_0.NetworkAdapter
Description The maximum number of physical functions available on this controller.
Type number or null
Read Only True
Added iLO 5 1.20

Controllers[{item}].ControllerCapabilities.NetworkPortCount Member of NetworkAdapter.v1_5_0.NetworkAdapter
Description The number of physical ports on this controller.
Type number or null
Read Only True
Added iLO 5 1.20

Controllers[{item}].ControllerCapabilities.VirtualizationOffload Controllers[{item}].ControllerCapabilities.VirtualizationOffload.SRIOV Controllers[{item}].ControllerCapabilities.VirtualizationOffload.SRIOV.SRIOVVEPACapable Member of NetworkAdapter.v1_5_0.NetworkAdapter
Description The value of this property shall be a boolean indicating whether this controller supports Single Root Input/Output Virtualization (SR-IOV) in Virtual Ethernet Port Aggregator (VEPA) mode.
Type boolean or null
Read Only True
Added iLO 5 1.20

Controllers[{item}].ControllerCapabilities.VirtualizationOffload.VirtualFunction Controllers[{item}].ControllerCapabilities.VirtualizationOffload.VirtualFunction.DeviceMaxCount Member of NetworkAdapter.v1_5_0.NetworkAdapter
Description The maximum number of Virtual Functions (VFs) supported by this controller.
Type number or null
Read Only True
Added iLO 5 1.20

Controllers[{item}].ControllerCapabilities.VirtualizationOffload.VirtualFunction.MinAssignmentGroupSize Member of NetworkAdapter.v1_5_0.NetworkAdapter
Description The minimum number of Virtual Functions (VFs) that can be allocated or moved between physical functions for this controller.
Type number or null
Read Only True
Added iLO 5 1.20

Controllers[{item}].ControllerCapabilities.VirtualizationOffload.VirtualFunction.NetworkPortMaxCount Member of NetworkAdapter.v1_5_0.NetworkAdapter
Description The maximum number of Virtual Functions (VFs) supported per network port for this controller.
Type number or null
Read Only True
Added iLO 5 1.20

Controllers[{item}].FirmwarePackageVersion Member of NetworkAdapter.v1_5_0.NetworkAdapter
Description The version number of the user-facing firmware package.
Type string or null
Read Only True
Added iLO 5 1.20

Controllers[{item}].Links Controllers[{item}].Links.NetworkDeviceFunctions (array) Member of NetworkAdapter.v1_5_0.NetworkAdapter NetworkDeviceFunctions is an array containing elements of:

NetworkDeviceFunctions[{item}].@odata.id Member of NetworkAdapter.v1_5_0.NetworkAdapter
Type string
Read Only True
Format uri-reference

Controllers[{item}].Links.NetworkPorts (array) Member of NetworkAdapter.v1_5_0.NetworkAdapter NetworkPorts is an array containing elements of:

NetworkPorts[{item}].@odata.id Member of NetworkAdapter.v1_5_0.NetworkAdapter
Type string
Read Only True
Format uri-reference

Controllers[{item}].Links.Ports (array) Member of NetworkAdapter.v1_5_0.NetworkAdapter Ports is an array containing elements of:

Ports[{item}].@odata.id Member of NetworkAdapter.v1_5_0.NetworkAdapter
Type string
Read Only True
Format uri-reference

Controllers[{item}].Location Controllers[{item}].Location.PartLocation Controllers[{item}].Location.PartLocation.LocationOrdinalValue Member of NetworkAdapter.v1_5_0.NetworkAdapter
Description The number that represents the location of the part. If LocationType is slot and this unit is in slot 2, the LocationOrdinalValue is 2.
Type integer or null
Read Only True

Controllers[{item}].Location.PartLocation.LocationType Member of NetworkAdapter.v1_5_0.NetworkAdapter
Description The location types for PartLocation.
Type string or null
Read Only True

The following are the supported values:

Value Description
Null A value is temporarily unavailable
Slot The slot as the type of location.
Bay The bay as the type of location.
Connector The connector as the type of location.
Socket The socket as the type of location.

Controllers[{item}].Location.PartLocation.Orientation Member of NetworkAdapter.v1_5_0.NetworkAdapter
Description The orientation for the ordering of the part location ordinal value.
Type string or null
Read Only True

The following are the supported values:

Value Description
Null A value is temporarily unavailable
FrontToBack The ordering for LocationOrdinalValue is front to back.
BackToFront The ordering for the LocationOrdinalValue is back to front.
TopToBottom The ordering for the LocationOrdinalValue is top to bottom.
BottomToTop The ordering for LocationOrdinalValue is bottom to top.
LeftToRight The ordering for the LocationOrdinalValue is left to right.
RightToLeft The ordering for the LocationOrdinalValue is right to left.

Controllers[{item}].Location.PartLocation.Reference Member of NetworkAdapter.v1_5_0.NetworkAdapter
Description The reference area for the location of the part.
Type string or null
Read Only True

The following are the supported values:

Value Description
Null A value is temporarily unavailable
Top The part is in the top of the unit.
Bottom The part is in the bottom of the unit.
Front The part is in the front of the unit.
Rear The part is in the rear of the unit.
Left The part is on the left side of of the unit.
Right The part is on the right side of the unit.
Middle The part is in the middle of the unit.

Controllers[{item}].Location.PartLocation.ServiceLabel Member of NetworkAdapter.v1_5_0.NetworkAdapter
Description The label of the part location, such as a silk-screened name or a printed label.
Type string or null
Read Only True

Controllers[{item}].Location.Placement Controllers[{item}].Location.Placement.AdditionalInfo Member of NetworkAdapter.v1_5_0.NetworkAdapter
Description Area designation or other additional info.
Type string or null
Read Only False

Controllers[{item}].Location.Placement.Rack Member of NetworkAdapter.v1_5_0.NetworkAdapter
Description The name of a rack location within a row.
Type string or null
Read Only False

Controllers[{item}].Location.Placement.RackOffset Member of NetworkAdapter.v1_5_0.NetworkAdapter
Description The vertical location of the item, in terms of RackOffsetUnits.
Type integer or null
Read Only False

Controllers[{item}].Location.Placement.RackOffsetUnits Member of NetworkAdapter.v1_5_0.NetworkAdapter
Description The type of rack unit in use.
Type string or null
Read Only False

The following are the supported values:

Value Description
Null A value is temporarily unavailable
OpenU A rack unit that is equal to 48 mm (1.89 in).
EIA_310 A rack unit that is equal to 1.75 in (44.45 mm).

Controllers[{item}].Location.Placement.Row Member of NetworkAdapter.v1_5_0.NetworkAdapter
Description The name of the row.
Type string or null
Read Only False

Manufacturer

Member of NetworkAdapter.v1_5_0.NetworkAdapter
Description The manufacturer or OEM of this network adapter.
Type string or null
Read Only True
Added iLO 5 1.20

Model

Member of NetworkAdapter.v1_5_0.NetworkAdapter
Description The model string used by the manufacturer to reference this network adapter.
Type string or null
Read Only True
Added iLO 5 1.20

NetworkDeviceFunctions

A reference to the collection of physical network device functions associated with this network adapter. NetworkDeviceFunctions is a link ("@odata.id": URI) to another resource.

NetworkPorts

A reference to the collection of physical network ports associated with this network adapter. NetworkPorts is a link ("@odata.id": URI) to another resource.

Oem.Hpe.CLPVersion

Member of NetworkAdapter.v1_5_0.NetworkAdapter
Description Option ROM Systems Management Architecture for Server Hardware (SMASH) Command Line Protocol (CLP) support version.
Type string or null
Read Only True
Added iLO 5 1.20

Oem.Hpe.Controllers (array)

Member of NetworkAdapter.v1_5_0.NetworkAdapter Controllers is an array containing elements of:

Controllers[{item}].ConfigurationStatus Controllers[{item}].ConfigurationStatus.Detail (array) Member of NetworkAdapter.v1_5_0.NetworkAdapter Detail is an array containing elements of:

Detail[{item}].Group Member of NetworkAdapter.v1_5_0.NetworkAdapter
Description Configuration group identifier.
Type integer or null
Read Only True

Detail[{item}].SubGroup Member of NetworkAdapter.v1_5_0.NetworkAdapter
Description Configuration sub-group identifier.
Type integer or null
Read Only True

Detail[{item}].Summary Member of NetworkAdapter.v1_5_0.NetworkAdapter
Description A digest value representing the current state of configuration for this group/sub-group.
Type integer or null
Read Only True

Controllers[{item}].ConfigurationStatus.Summary Member of NetworkAdapter.v1_5_0.NetworkAdapter
Description A digest value representing the current configuration state of this network adapter controller.
Type integer or null
Read Only True

Controllers[{item}].DeviceLimitationsBitmap Member of NetworkAdapter.v1_5_0.NetworkAdapter
Description Indicates any unique device limitations. A value of 0 indicates no limitations are present. When set, bit 0 indicates that the device cannot validate data received when in standby power. All other bit mappings are reserved.
Type integer or null
Read Only True

Controllers[{item}].EdgeVirtualBridging Controllers[{item}].EdgeVirtualBridging.ChannelDescriptionTLVCapable Member of NetworkAdapter.v1_5_0.NetworkAdapter
Description When true, this controller supports HPE Flex10Qbg Channel Description TLVs.
Type boolean or null
Read Only True

Controllers[{item}].EdgeVirtualBridging.ChannelLinkControlTLVCapable Member of NetworkAdapter.v1_5_0.NetworkAdapter
Description When true, this controller supports HPE Flex10Qbg Channel Link Control TLVs.
Type boolean or null
Read Only True

Controllers[{item}].EmbeddedLLDPFunctions Controllers[{item}].EmbeddedLLDPFunctions.Enabled Member of NetworkAdapter.v1_5_0.NetworkAdapter
Description NOTE: This is a read-only property when the adapter is installed on an HPE Synergy server. When false, globally disables device functions on this controller which utilize HPE defined embedded LLDP. When set false will also disable EVB, FCoE, RoCE, and DCBX capabilities on this controller. This property does not affect Ethernet NPAR functionality.
Type boolean or null
Read Only False

Controllers[{item}].EmbeddedLLDPFunctions.Optional Member of NetworkAdapter.v1_5_0.NetworkAdapter
Description When true, indicates that this controller has the ability to globally disable all network device functions which utilize HPE defined embedded LLDP.
Type boolean or null
Read Only True

Controllers[{item}].FactoryDefaultsCurrentlyActive Member of NetworkAdapter.v1_5_0.NetworkAdapter
Description When true, this controller’s configuration matches factory default settings.
Type boolean or null
Read Only True

Controllers[{item}].FunctionTypeLimits (array) Member of NetworkAdapter.v1_5_0.NetworkAdapter FunctionTypeLimits is an array containing elements of:

FunctionTypeLimits[{item}].ConstraintDescription Member of NetworkAdapter.v1_5_0.NetworkAdapter
Type string or null
Read Only True

FunctionTypeLimits[{item}].EthernetResourcesConsumed Member of NetworkAdapter.v1_5_0.NetworkAdapter
Type integer or null
Read Only True

FunctionTypeLimits[{item}].FCoEResourcesConsumed Member of NetworkAdapter.v1_5_0.NetworkAdapter
Type integer or null
Read Only True

FunctionTypeLimits[{item}].RDMAResourcesConsumed Member of NetworkAdapter.v1_5_0.NetworkAdapter
Type integer or null
Read Only True

FunctionTypeLimits[{item}].TotalSharedResourcesAvailable Member of NetworkAdapter.v1_5_0.NetworkAdapter
Type integer or null
Read Only True

FunctionTypeLimits[{item}].iSCSIResourcesConsumed Member of NetworkAdapter.v1_5_0.NetworkAdapter
Type integer or null
Read Only True

Controllers[{item}].FunctionTypes (array) Member of NetworkAdapter.v1_5_0.NetworkAdapter FunctionTypes is an array containing elements of:
Type string or null
Read Only True

The following are the supported values:

Value Description
Null A value is temporarily unavailable
Ethernet Has Ethernet functionality.
FibreChannel Has native FibreChannel functionality.
iSCSI Has iSCSI functionality.
FCoE Has FibreChannel over Ethernet functionality.
InfiniBand Has InfiniBand functionality.
RoCE Has RDMA over Converged Ethernet protocol functionality.
iWarp Has internet Wide-area RDMA protocol functionality.

Controllers[{item}].MostRecentConfigurationChangeSource Member of NetworkAdapter.v1_5_0.NetworkAdapter
Description Type of the last client to have changed configuration on this device.
Type string or null
Read Only True

The following are the supported values:

Value Description
Null A value is temporarily unavailable
None No change detected.
OS Operating System Driver
VendorControl Vendor Control Software
VirtualConnect Virtual Connect
CNU Converged Network Utility
Other Other configuration or diagnostic software.
Redfish Redfish Client
UEFI-HII UEFI Human Interface Infrastructure

Controllers[{item}].RDMASupport (array) Member of NetworkAdapter.v1_5_0.NetworkAdapter RDMASupport is an array containing elements of:
Type string
Read Only True

The following are the supported values:

Value Description
None No RDMA support.
RoCE RDMA over Converged Ethernet supported.
iWARP iWARP supported.

Controllers[{item}].UnderlyingDataSource Member of NetworkAdapter.v1_5_0.NetworkAdapter
Description Protocol through which Redfish data is supplied for this adapter.
Type string
Read Only True

The following are the supported values:

Value Description
DCi HPE Proprietary DCi protocol
RDE DMTF RDE protocol

Oem.Hpe.FactoryDefaultsActuationBehavior

Member of NetworkAdapter.v1_5_0.NetworkAdapter
Description Indicates the implementation timing of a reset to factory default settings request, when made with the server in the standby power state.
Type string or null
Read Only True
Added iLO 5 1.20

The following are the supported values:

Value Description
Null A value is temporarily unavailable
Immediate Defaults take effect within 2 seconds of being applied.
AtFullPower Defaults take effect within 5 seconds of power being applied.
AtNextReboot Defaults take effect on next reboot to full power.

Oem.Hpe.PCAVersion

Member of NetworkAdapter.v1_5_0.NetworkAdapter
Description Printed Circuit Assembly number for the circuit board comprising this device.
Type string or null
Read Only True
Added iLO 5 1.20

Oem.Hpe.RedfishConfiguration

Member of NetworkAdapter.v1_5_0.NetworkAdapter
Description Controls Redfish configuration write access to network adapters. When present and disabled, network adapter information is read-only. Note that some HPE advanced network adapters will present a reduced level of capability when disabled.
Type string or null
Read Only False
Added iLO 5 1.20

The following are the supported values:

Value Description
Null A value is temporarily unavailable
Enabled The Redfish management interface is enabled to make changes on this network adapter. To return to the Disabled state, a network adapter reset to factory default operation is required.
Disabled The network adapter is operating in read-only mode relative to the Redfish management interface. To transition to this state, a network adapter reset to factory default operation is required.

PartNumber

Member of NetworkAdapter.v1_5_0.NetworkAdapter
Description Manufacturer’s Part number for this network adapter.
Type string or null
Read Only True
Added iLO 5 1.20

Ports

A reference to the collection of physical network ports associated with this network adapter. Ports is a link ("@odata.id": URI) to another resource.

SKU

Member of NetworkAdapter.v1_5_0.NetworkAdapter
Description The value of this property shall contain the Stock Keeping Unit (SKU) for the network adapter.
Type string or null
Read Only True
Added iLO 5 1.20

SerialNumber

Member of NetworkAdapter.v1_5_0.NetworkAdapter
Description The serial number for this network adapter.
Type string or null
Read Only True
Added iLO 5 1.20

Settings

Settings.href Member of NetworkAdapter.v1_5_0.NetworkAdapter
Description Reference to the resource the client may PUT/PATCH to in order to change this resource.
Type string
Read Only True
Added iLO 5 1.20

Status

Member of NetworkAdapter.v1_5_0.NetworkAdapter See the Redfish standard schema and specification for information on common Status object.

Actions

NetworkAdapter.ResetSettingsToDefault Member of NetworkAdapter.v1_5_0.NetworkAdapter There are no parameters for this action.

HpeNetworkAdapter.FlushConfigurationToNVM Member of NetworkAdapter.v1_5_0.NetworkAdapter There are no parameters for this action.

NetworkAdapter.FlushConfigurationToNVM Member of NetworkAdapter.v1_5_0.NetworkAdapter NOTE: Deprecated, will be removed in a future release. Replaced by HpeNetworkAdapter.FlushConfigurationToNVM.

There are no parameters for this action.

NetworkAdapterCollection.NetworkAdapterCollection

@odata.type: "#NetworkAdapterCollection.NetworkAdapterCollection"

A Collection of NetworkAdapter resource instances.

Resource Instances

Uri HTTP Allow
/redfish/v1/chassis/{item}/networkadapters GET
Link Name Destination type
Members[] NetworkAdapter

Members (array)

Member of NetworkAdapterCollection.NetworkAdapterCollection Members is an array containing elements of:

Members[{item}].@odata.id Member of NetworkAdapterCollection.NetworkAdapterCollection
Type string
Read Only True
Format uri-reference

Members@odata.count

Member of NetworkAdapterCollection.NetworkAdapterCollection
Description The total number of collection members.
Type integer
Read Only True

Oem.Hpe.MemberContents

Member of NetworkAdapterCollection.NetworkAdapterCollection
Description Provides the discovery status of this collection. For some server platforms, only partial device discovery is possible under auxiliary power.
Type string or null
Read Only True
Added iLO 5 1.40

The following are the supported values:

Value Description
Null A value is temporarily unavailable
AllDevices The server state allows complete device discovery. All installed devices are listed as members.
AuxPowerDevices The server architecture may not support power to all installed devices in the current auxiliary power state. Only devices capable of operating in this power state are listed as members. Additional devices may be listed when the server is fully powered.

NetworkDeviceFunction.v1_5_0.NetworkDeviceFunction

@odata.type: "#NetworkDeviceFunction.v1_5_0.NetworkDeviceFunction"

A Network Device Function represents a logical interface exposed by the network adapter.

Resource Instances

Uri HTTP Allow
/redfish/v1/chassis/{item}/networkadapters/{item}/networkdevicefunctions/{item} GET POST PATCH
/redfish/v1/chassis/{item}/networkadapters/{item}/networkdevicefunctions/{item}/settings GET POST PATCH
/redfish/v1/systems/{item}/networkinterfaces/{item}/networkdevicefunctions/{item} GET POST PATCH
/redfish/v1/systems/{item}/networkinterfaces/{item}/networkdevicefunctions/{item}/settings GET PATCH
Link Name Destination type
@Redfish.Settings/SettingsObject NetworkDeviceFunction

@Redfish.Settings

Member of NetworkDeviceFunction.v1_5_0.NetworkDeviceFunction See the Redfish standard schema and specification for information on common @Redfish properties.

AssignablePhysicalNetworkPorts (array)

Member of NetworkDeviceFunction.v1_5_0.NetworkDeviceFunction AssignablePhysicalNetworkPorts is an array containing elements of:

AssignablePhysicalNetworkPorts[{item}].@odata.id Member of NetworkDeviceFunction.v1_5_0.NetworkDeviceFunction
Type string
Read Only True
Format uri-reference

AssignablePhysicalPorts (array)

Member of NetworkDeviceFunction.v1_5_0.NetworkDeviceFunction AssignablePhysicalPorts is an array containing elements of:

AssignablePhysicalPorts[{item}].@odata.id Member of NetworkDeviceFunction.v1_5_0.NetworkDeviceFunction
Type string
Read Only True
Format uri-reference

BootMode

Member of NetworkDeviceFunction.v1_5_0.NetworkDeviceFunction
Description Network device boot mode configuration values.
Type string or null
Read Only False
Added iLO 5 1.20

The following are the supported values:

Value Description
Null A value is temporarily unavailable
Disabled Do not indicate to UEFI/BIOS that this device is bootable.
PXE Boot this device using the embedded PXE support. Only applicable if the NetworkDeviceFunctionType is set to Ethernet. Not supported by HPE.
iSCSI Boot this device using the embedded iSCSI boot support and configuration. Only applicable if the NetworkDeviceFunctionType is set to iSCSI.
FibreChannel Boot this device using the embedded Fibre Channel support and configuration. Only applicable if the NetworkDeviceFunctionType is set to FibreChannel.
FibreChannelOverEthernet Boot this device using the embedded Fibre Channel over Ethernet (FCoE) boot support and configuration. Only applicable if the NetworkDeviceFunctionType is set to FibreChannelOverEthernet.

DeviceEnabled

Member of NetworkDeviceFunction.v1_5_0.NetworkDeviceFunction
Description A boolean indicating whether the network device function is enabled. Disabled network device functions shall not be enumerated or seen by the operating system.
Type boolean or null
Read Only False
Added iLO 5 1.20

Ethernet

Ethernet.MACAddress Member of NetworkDeviceFunction.v1_5_0.NetworkDeviceFunction
Description The effective current MAC Address of this network device function. If an assignable MAC address is not supported, this is a read only alias of the PermanentMACAddress.
Type string or null
Read Only False
Added iLO 5 1.20

Ethernet.MTUSize Member of NetworkDeviceFunction.v1_5_0.NetworkDeviceFunction
Description The Maximum Transmission Unit (MTU) configured for this Network Device Function. This value serves as a default for the OS driver when booting. The value only takes-effect on boot.
Type integer or null
Read Only False
Added iLO 5 1.20

Ethernet.PermanentMACAddress Member of NetworkDeviceFunction.v1_5_0.NetworkDeviceFunction
Description The Permanent MAC Address of this network device function (physical function). This value is typically programmed during the manufacturing time. This address is not assignable.
Type string or null
Read Only True
Added iLO 5 1.20

FibreChannel

FibreChannel.AllowFIPVLANDiscovery Member of NetworkDeviceFunction.v1_5_0.NetworkDeviceFunction
Description For FCoE connections, a boolean indicating whether the FIP VLAN Discovery Protocol is used to determine the FCoE VLAN ID selected by the network device function for the FCoE connection. If true, and the FIP VLAN Discovery succeeds, the FCoEActiveVLANId property shall reflect the FCoE VLAN ID to be used for all FCoE traffic. If false, or if the FIP VLAN Discovery protocol fails, the FCoELocalVLANId shall be used for all FCoE traffic and the FCoEActiveVLANId shall reflect the FCoELocalVLANId.
Type boolean or null
Read Only False
Added iLO 5 1.20

FibreChannel.BootTargets (array) Member of NetworkDeviceFunction.v1_5_0.NetworkDeviceFunction BootTargets is an array containing elements of:

BootTargets[{item}].BootPriority Member of NetworkDeviceFunction.v1_5_0.NetworkDeviceFunction
Description The relative priority for this entry in the boot targets array. Lower numbers shall represent higher priority, with zero being the highest priority. The BootPriority shall be unique for all entries of the BootTargets array.
Type integer or null
Read Only False

BootTargets[{item}].LUNID Member of NetworkDeviceFunction.v1_5_0.NetworkDeviceFunction
Description The Logical Unit Number (LUN) ID to boot from on the device referred to by the corresponding WWPN.
Type string or null
Read Only False

BootTargets[{item}].WWPN Member of NetworkDeviceFunction.v1_5_0.NetworkDeviceFunction
Description The value of this property shall be World-Wide Port Name (WWPN) to boot from.
Type string or null
Read Only False

FibreChannel.FCoEActiveVLANId Member of NetworkDeviceFunction.v1_5_0.NetworkDeviceFunction
Description For FCoE connections, the value of this property shall be null or a VLAN ID currently being used for FCoE traffic. When the FCoE link is down this value shall be null. When the FCoE link is up this value shall be either the FCoELocalVLANId property or a VLAN discovered via the FIP protocol.
Type integer or null
Read Only True
Added iLO 5 1.20

FibreChannel.FCoELocalVLANId Member of NetworkDeviceFunction.v1_5_0.NetworkDeviceFunction
Description For FCoE connections, the locally configured VLAN ID. This value shall be used for FCoE traffic to this network device function during boot unless AllowFIPVLANDiscovery is true and a valid FCoE VLAN ID is found via the FIP VLAN Discovery Protocol.
Type integer or null
Read Only False
Added iLO 5 1.20

FibreChannel.PermanentWWNN Member of NetworkDeviceFunction.v1_5_0.NetworkDeviceFunction
Description The permanent World-Wide Node Name (WWNN) of this network device function (physical function). This value is typically programmed during the manufacturing time. This address is not assignable.
Type string or null
Read Only True
Added iLO 5 1.20

FibreChannel.PermanentWWPN Member of NetworkDeviceFunction.v1_5_0.NetworkDeviceFunction
Type string or null
Read Only True
Added iLO 5 1.20

FibreChannel.WWNN Member of NetworkDeviceFunction.v1_5_0.NetworkDeviceFunction
Description The value of this property shall be the effective current World-Wide Node Name (WWNN) of this network device function (physical function). If an assignable WWNN is not supported, this is a read only alias of the PermanentWWNN.
Type string or null
Read Only False
Added iLO 5 1.20

FibreChannel.WWNSource Member of NetworkDeviceFunction.v1_5_0.NetworkDeviceFunction
Description The configuration source of the WWNs for this connection (WWPN and WWNN).
Type string or null
Read Only False
Added iLO 5 1.20

The following are the supported values:

Value Description
Null A value is temporarily unavailable
ConfiguredLocally The set of FC/FCoE boot targets was applied locally through API or UI.
ProvidedByFabric The set of FC/FCoE boot targets was applied by the Fibre Channel fabric.

FibreChannel.WWPN Member of NetworkDeviceFunction.v1_5_0.NetworkDeviceFunction
Description The effective current World-Wide Port Name (WWPN) of this network device function (physical function). If an assignable WWPN is not supported, this is a read only alias of the PermanentWWPN.
Type string or null
Read Only False
Added iLO 5 1.20

MaxVirtualFunctions

Member of NetworkDeviceFunction.v1_5_0.NetworkDeviceFunction
Description The number of virtual functions (VFs) availbale for this network device function.
Type integer or null
Read Only True
Added iLO 5 1.20

NetDevFuncCapabilities (array)

Member of NetworkDeviceFunction.v1_5_0.NetworkDeviceFunction NetDevFuncCapabilities is an array containing elements of:
Type string or null
Read Only True

The following are the supported values:

Value Description
Null A value is temporarily unavailable
Disabled Neither enumerated nor visible to the operating system.
Ethernet Appears to the operating system as an Ethernet device.
FibreChannel Appears to the operating system as a Fibre Channel device.
iSCSI Appears to the operating system as an iSCSI device.
FibreChannelOverEthernet Appears to the operating system as an FCoE device.

NetDevFuncType

Member of NetworkDeviceFunction.v1_5_0.NetworkDeviceFunction
Description The configured capability of this network device function.
Type string or null
Read Only False
Added iLO 5 1.20

The following are the supported values:

Value Description
Null A value is temporarily unavailable
Disabled Neither enumerated nor visible to the operating system.
Ethernet Appears to the operating system as an Ethernet device.
FibreChannel Appears to the operating system as a Fibre Channel device.
iSCSI Appears to the operating system as an iSCSI device.
FibreChannelOverEthernet Appears to the operating system as an FCoE device.

Oem.Hpe.BootTargetSource

Member of NetworkDeviceFunction.v1_5_0.NetworkDeviceFunction
Description Controls the source of boot target parameters for this network device function. This property can only be configured when the network device function is not in the Disabled state.
Type string or null
Read Only False
Added iLO 5 1.30

The following are the supported values:

Value Description
Null A value is temporarily unavailable
UEFI Boot target parameters are under control of UEFI and the device option ROM. Any target parameters configured on this network device function are ignored.
NetworkDeviceFunction Boot target parameters as configured on this network device function will be used.
None Boot mode is configured disabled, and no target source applies.

Oem.Hpe.ConnectionID

Member of NetworkDeviceFunction.v1_5_0.NetworkDeviceFunction
Description The Connection ID to be used with EVB, in IETF RFC-4122 UUID format.
Type string or null
Read Only False
Added iLO 5 1.20

Oem.Hpe.NetDevFuncCapabilities (array)

Member of NetworkDeviceFunction.v1_5_0.NetworkDeviceFunction NetDevFuncCapabilities is an array containing elements of:
Type string or null
Read Only True

The following are the supported values:

Value Description
Null A value is temporarily unavailable
Disabled Neither enumerated nor visible to the operating system.
Ethernet Appears to the operating system as an Ethernet device.
FibreChannel Appears to the operating system as a Fibre Channel device.
iSCSI Appears to the operating system as an iSCSI device.
FCoE Appears to the operating system as an FCoE device.
InfiniBand Appears to the operating system as an InfiniBand device.
RoCE (Deprecated function type for some adapters, in iLO 1.40+) Appears to the operating system as an RDMA over converged Ethernet device.
iWarp (Deprecated function type for some adapters, in iLO 1.40+) Appears to the operating system as an iWarp RDMA device.

Oem.Hpe.NetDevFuncType

Member of NetworkDeviceFunction.v1_5_0.NetworkDeviceFunction
Description The presently configured interconnection capability of this network device function.
Type string or null
Read Only False
Added iLO 5 1.20

The following are the supported values:

Value Description
Null A value is temporarily unavailable
Disabled This function is disabled, and is neither enumerated nor visible to the operating system.
Ethernet This function is configured to operate as an Ethernet device.
FibreChannel This function is configured to operate as a Fibre Channel device.
iSCSI This function is configured to operate as an iSCSI device.
FCoE This function is configured to oeprate as an FCoE device.
InfiniBand
RCoE
iWarp (Deprecated function type for some adapters, in iLO 1.40+) This function is configured to operate as an iWarp RDMA device.

Oem.Hpe.SupportedFCBootTargetCount

Member of NetworkDeviceFunction.v1_5_0.NetworkDeviceFunction
Description The number of Fibre Channel boot targets supported by this network device function.
Type integer or null
Read Only True
Added iLO 5 1.20

Oem.Hpe.VirtualLinkStatus

Member of NetworkDeviceFunction.v1_5_0.NetworkDeviceFunction
Description Current status of the EVB Virtual Link (S-Channel) supporting this function.
Type string or null
Read Only True
Added iLO 5 1.20

The following are the supported values:

Value Description
Null A value is temporarily unavailable
NoChannel Port link is down, or the connected switch has not assigned an SVID.
SwitchChannelDown SVID is assigned but Virtual Link status is down.
HostDriverDown SVID is assigned and Virtual Link status is up, but the host OS driver is inactive.
VirtualLinkUp SVID is assigned, Virual Link status is up, and the host OS driver is active.

Oem.Hpe.WakeOnLANEnabled

Member of NetworkDeviceFunction.v1_5_0.NetworkDeviceFunction
Description Enables Ethernet Wake On LAN (WoL) capability for this function when true.
Type boolean or null
Read Only False
Added iLO 5 1.20

PhysicalNetworkPortAssignment

The physical port to which this network device function is currently assigned. PhysicalNetworkPortAssignment is a link ("@odata.id": URI) to another resource.

PhysicalPortAssignment

A reference to the physical port currently assigned to this network device function. PhysicalPortAssignment is a link ("@odata.id": URI) to another resource.

Settings

Settings.href Member of NetworkDeviceFunction.v1_5_0.NetworkDeviceFunction
Description Reference to the resource the client may PUT/PATCH to in order to change this resource.
Type string
Read Only True
Added iLO 5 1.20

Status

Member of NetworkDeviceFunction.v1_5_0.NetworkDeviceFunction See the Redfish standard schema and specification for information on common Status object.

VirtualFunctionsEnabled

Member of NetworkDeviceFunction.v1_5_0.NetworkDeviceFunction
Description Indicates whether Single Root I/O Virtualization (SR-IOV) Virual Functions (VFs) are enabled for this network device function.
Type boolean or null
Read Only True
Added iLO 5 1.20

iSCSIBoot

iSCSIBoot.AuthenticationMethod Member of NetworkDeviceFunction.v1_5_0.NetworkDeviceFunction
Description iSCSI Boot authentication method configuration values.
Type string or null
Read Only False
Added iLO 5 1.20

The following are the supported values:

Value Description
Null A value is temporarily unavailable
None No iSCSI authentication is used.
CHAP iSCSI Challenge Handshake Authentication Protocol (CHAP) authentication is used.
MutualCHAP iSCSI Mutual Challenge Handshake Authentication Protocol (CHAP) authentication is used.

iSCSIBoot.CHAPSecret Member of NetworkDeviceFunction.v1_5_0.NetworkDeviceFunction
Description The shared secret for CHAP authentication. Must be 0, 12, or 16 characters in length.
Type string or null
Read Only False
Added iLO 5 1.20

iSCSIBoot.CHAPUsername Member of NetworkDeviceFunction.v1_5_0.NetworkDeviceFunction
Description The username for CHAP authentication.
Type string or null
Read Only False
Added iLO 5 1.20

iSCSIBoot.IPAddressType Member of NetworkDeviceFunction.v1_5_0.NetworkDeviceFunction
Description The type of IP address (IPv6 or IPv4) being populated in the iSCSIBoot IP address fields. Mixing of IPv6 and IPv4 addresses on the same network device function is not allowed.
Type string or null
Read Only False
Added iLO 5 1.20

The following are the supported values:

Value Description
Null A value is temporarily unavailable
IPv4 IPv4 addressing is used for all IP-fields in this object.
IPv6 IPv6 addressing is used for all IP-fields in this object.

iSCSIBoot.IPMaskDNSViaDHCP Member of NetworkDeviceFunction.v1_5_0.NetworkDeviceFunction
Description When true, the iSCSI boot initiator will use DHCP to obtain the iniator name, IP address, and netmask.
Type boolean or null
Read Only False
Added iLO 5 1.20

iSCSIBoot.InitiatorDefaultGateway Member of NetworkDeviceFunction.v1_5_0.NetworkDeviceFunction
Description The IPv6 or IPv4 iSCSI boot default gateway.
Type string or null
Read Only False
Added iLO 5 1.20

iSCSIBoot.InitiatorIPAddress Member of NetworkDeviceFunction.v1_5_0.NetworkDeviceFunction
Description The IPv6 or IPv4 address of the iSCSI boot initiator.
Type string or null
Read Only False
Added iLO 5 1.20

iSCSIBoot.InitiatorName Member of NetworkDeviceFunction.v1_5_0.NetworkDeviceFunction
Description The iSCSI initiator name.
Type string or null
Read Only False
Added iLO 5 1.20

iSCSIBoot.InitiatorNetmask Member of NetworkDeviceFunction.v1_5_0.NetworkDeviceFunction
Description The IPv6 or IPv4 netmask of the iSCSI boot initiator.
Type string or null
Read Only False
Added iLO 5 1.20

iSCSIBoot.MutualCHAPSecret Member of NetworkDeviceFunction.v1_5_0.NetworkDeviceFunction
Description The CHAP secret for 2-way CHAP authentication. Must be 0, 12, or 16 characters in length.
Type string or null
Read Only False
Added iLO 5 1.20

iSCSIBoot.MutualCHAPUsername Member of NetworkDeviceFunction.v1_5_0.NetworkDeviceFunction
Description The CHAP username for 2-way CHAP authentication.
Type string or null
Read Only False
Added iLO 5 1.20

iSCSIBoot.PrimaryDNS Member of NetworkDeviceFunction.v1_5_0.NetworkDeviceFunction
Description The IPv6 or IPv4 address of the primary DNS server for the iSCSI boot initiator.
Type string or null
Read Only False
Added iLO 5 1.20

iSCSIBoot.PrimaryLUN Member of NetworkDeviceFunction.v1_5_0.NetworkDeviceFunction
Description The logical unit number (LUN) for the primary iSCSI boot target.
Type integer or null
Read Only False
Added iLO 5 1.20

iSCSIBoot.PrimaryTargetIPAddress Member of NetworkDeviceFunction.v1_5_0.NetworkDeviceFunction
Description The IP address (IPv6 or IPv4) for the primary iSCSI boot target.
Type string or null
Read Only False
Added iLO 5 1.20

iSCSIBoot.PrimaryTargetName Member of NetworkDeviceFunction.v1_5_0.NetworkDeviceFunction
Description The name of the primary iSCSI boot target, iSCSI Qualified Name (IQN).
Type string or null
Read Only False
Added iLO 5 1.20

iSCSIBoot.PrimaryTargetTCPPort Member of NetworkDeviceFunction.v1_5_0.NetworkDeviceFunction
Description The TCP port for the primary iSCSI boot target.
Type integer or null
Read Only False
Added iLO 5 1.20

iSCSIBoot.PrimaryVLANEnable Member of NetworkDeviceFunction.v1_5_0.NetworkDeviceFunction
Description This indicates if the primary VLAN is enabled. Not supported by HPE.
Type boolean or null
Read Only False
Added iLO 5 1.20

iSCSIBoot.PrimaryVLANId Member of NetworkDeviceFunction.v1_5_0.NetworkDeviceFunction
Description The 802.1q VLAN ID to use for iSCSI boot for both the primary and secondary targets. Assign null value to disable.
Type integer or null
Read Only False
Added iLO 5 1.20

iSCSIBoot.RouterAdvertisementEnabled Member of NetworkDeviceFunction.v1_5_0.NetworkDeviceFunction
Description A boolean indicating whether IPv6 router advertisement is enabled for the iSCSI boot target. This setting shall only apply to IPv6 configurations.
Type boolean or null
Read Only False
Added iLO 5 1.20

iSCSIBoot.SecondaryDNS Member of NetworkDeviceFunction.v1_5_0.NetworkDeviceFunction
Description The value of this property shall be the IPv6 or IPv4 address of the secondary DNS server for the iSCSI boot initiator.
Type string or null
Read Only False
Added iLO 5 1.20

iSCSIBoot.SecondaryLUN Member of NetworkDeviceFunction.v1_5_0.NetworkDeviceFunction
Description The logical unit number (LUN) for the secondary iSCSI boot target. Not supported by HPE.
Type integer or null
Read Only False
Added iLO 5 1.20

iSCSIBoot.SecondaryTargetIPAddress Member of NetworkDeviceFunction.v1_5_0.NetworkDeviceFunction
Description The IP address (IPv6 or IPv4) for the secondary iSCSI boot target.
Type string or null
Read Only False
Added iLO 5 1.20

iSCSIBoot.SecondaryTargetName Member of NetworkDeviceFunction.v1_5_0.NetworkDeviceFunction
Description The name of the iSCSI secondary boot target, iSCSI Qualified Name (IQN). Not supported by HPE. The value from PrimaryTargetName will be used for the secondary iSCSI boot target if configured.
Type string or null
Read Only False
Added iLO 5 1.20

iSCSIBoot.SecondaryTargetTCPPort Member of NetworkDeviceFunction.v1_5_0.NetworkDeviceFunction
Description The TCP port for the secondary iSCSI boot target.
Type integer or null
Read Only False
Added iLO 5 1.20

iSCSIBoot.SecondaryVLANEnable Member of NetworkDeviceFunction.v1_5_0.NetworkDeviceFunction
Description This indicates if the secondary VLAN is enabled. Not supported by HPE.
Type boolean or null
Read Only False
Added iLO 5 1.20

iSCSIBoot.SecondaryVLANId Member of NetworkDeviceFunction.v1_5_0.NetworkDeviceFunction
Description The 802.1q VLAN ID to use for iSCSI boot from the secondary target. Not supported by HPE.
Type integer or null
Read Only False
Added iLO 5 1.20

iSCSIBoot.TargetInfoViaDHCP Member of NetworkDeviceFunction.v1_5_0.NetworkDeviceFunction
Description When true indicates the iSCSI boot target name, LUN, IP address, and netmask should be obtained from DHCP.
Type boolean or null
Read Only False
Added iLO 5 1.20

NetworkDeviceFunctionCollection.NetworkDeviceFunctionCollection

@odata.type: "#NetworkDeviceFunctionCollection.NetworkDeviceFunctionCollection"

A Collection of NetworkDeviceFunction resource instances.

Resource Instances

Uri HTTP Allow
/redfish/v1/chassis/{item}/networkadapters/{item}/networkdevicefunctions GET
/redfish/v1/systems/{item}/networkinterfaces/{item}/networkdevicefunctions GET
Link Name Destination type
Members[] NetworkDeviceFunction

Members (array)

Member of NetworkDeviceFunctionCollection.NetworkDeviceFunctionCollection Members is an array containing elements of:

Members[{item}].@odata.id Member of NetworkDeviceFunctionCollection.NetworkDeviceFunctionCollection
Type string
Read Only True
Format uri-reference

Members@odata.count

Member of NetworkDeviceFunctionCollection.NetworkDeviceFunctionCollection
Description The total number of collection members.
Type integer
Read Only True

NetworkInterface.v1_2_0.NetworkInterface

@odata.type: "#NetworkInterface.v1_2_0.NetworkInterface"

A NetworkInterface contains references linking NetworkAdapter, NetworkPort, and NetworkDeviceFunction resources and represents the functionality available to the containing system.

Resource Instances

Uri HTTP Allow
/redfish/v1/systems/{item}/networkinterfaces/{item} GET
Link Name Destination type
NetworkDeviceFunctions Collection of NetworkDeviceFunction

NetworkDeviceFunctions

link to collection of membertype NetworkDeviceFunction. The collection of device functions avaliable on this network interface. NetworkDeviceFunctions is a link ("@odata.id": URI) to another resource.

NetworkPorts

Link to a collection of membertype NetworkPort. The collection of ports avaliable on this network interface. NetworkPorts is a link ("@odata.id": URI) to another resource.

Ports

Link to a collection of membertype Port. The collection of ports avaliable on this network interface. Ports is a link ("@odata.id": URI) to another resource.

Status

Member of NetworkInterface.v1_2_0.NetworkInterface See the Redfish standard schema and specification for information on common Status object.

NetworkInterfaceCollection.NetworkInterfaceCollection

@odata.type: "#NetworkInterfaceCollection.NetworkInterfaceCollection"

A Collection of NetworkInterface resource instances.

Resource Instances

Uri HTTP Allow
/redfish/v1/systems/{item}/networkinterfaces GET
Link Name Destination type
Members[] NetworkInterface

Members (array)

Member of NetworkInterfaceCollection.NetworkInterfaceCollection Members is an array containing elements of:

Members[{item}].@odata.id Member of NetworkInterfaceCollection.NetworkInterfaceCollection
Type string
Read Only True
Format uri-reference

Members@odata.count

Member of NetworkInterfaceCollection.NetworkInterfaceCollection
Description The total number of collection members.
Type integer
Read Only True

Oem.Hpe.MemberContents

Member of NetworkInterfaceCollection.NetworkInterfaceCollection
Description Provides the discovery status of this collection. For some server platforms, only partial device discovery is possible under auxiliary power.
Type string or null
Read Only True
Added iLO 5 1.40

The following are the supported values:

Value Description
Null A value is temporarily unavailable
AllDevices The server state allows complete device discovery. All installed devices are listed as members.
AuxPowerDevices The server is in the auxiliary power state and only devices capable of operating in this power state are listed as members. Additional devices may be listed when the server is fully powered.

NetworkPort.v1_2_5.NetworkPort

@odata.type: "#NetworkPort.v1_2_5.NetworkPort"

A Network Port represents a discrete physical port capable of connecting to a network.

Resource Instances

Uri HTTP Allow
/redfish/v1/chassis/{item}/networkadapters/{item}/networkports/{item} GET POST PATCH
/redfish/v1/chassis/{item}/networkadapters/{item}/networkports/{item}/settings GET POST PATCH
/redfish/v1/systems/{item}/networkinterfaces/{item}/networkports/{item} GET POST PATCH
/redfish/v1/systems/{item}/networkinterfaces/{item}/networkports/{item}/settings GET POST PATCH
Link Name Destination type
@Redfish.Settings/SettingsObject NetworkPort

@Redfish.Settings

Member of NetworkPort.v1_2_5.NetworkPort See the Redfish standard schema and specification for information on common @Redfish properties.

ActiveLinkTechnology

Member of NetworkPort.v1_2_5.NetworkPort
Description Physical link technology values.
Type string or null
Read Only False
Added iLO 5 1.20

The following are the supported values:

Value Description
Null A value is temporarily unavailable
Ethernet The port is capable of connecting to an Ethernet network.
InfiniBand The port is capable of connecting to an InfiniBand network.
FibreChannel The port is capable of connecting to a Fibre Channel network.

AssociatedNetworkAddresses (array)

Member of NetworkPort.v1_2_5.NetworkPort AssociatedNetworkAddresses is an array containing elements of:
Type string or null
Read Only True

CurrentLinkSpeedMbps

Member of NetworkPort.v1_2_5.NetworkPort
Description Network Port Current Link Speed.
Type integer or null
Read Only False
Added iLO 5 1.40

EEEEnabled

Member of NetworkPort.v1_2_5.NetworkPort
Description An indication of whether IEEE 802.3az Energy-Efficient Ethernet (EEE) is enabled for this network port.
Type boolean or null
Read Only False
Added iLO 5 1.20

FlowControlConfiguration

Member of NetworkPort.v1_2_5.NetworkPort
Description Ethernet flow control configuration values.
Type string or null
Read Only False
Added iLO 5 1.20

The following are the supported values:

Value Description
Null A value is temporarily unavailable
None No IEEE 802.3x flow control is enabled on this port.
TX This station can initiate IEEE 802.3x flow control.
RX The link partner can initiate IEEE 802.3x flow control.
TX_RX This station or the link partner can initiate IEEE 802.3x flow control.

FlowControlStatus

Member of NetworkPort.v1_2_5.NetworkPort
Description Ethernet flow control configuration values.
Type string or null
Read Only True
Added iLO 5 1.20

The following are the supported values:

Value Description
Null A value is temporarily unavailable
None No IEEE 802.3x flow control is enabled on this port.
TX This station can initiate IEEE 802.3x flow control.
RX The link partner can initiate IEEE 802.3x flow control.
TX_RX This station or the link partner can initiate IEEE 802.3x flow control.

LinkStatus

Member of NetworkPort.v1_2_5.NetworkPort
Description Physical link status values.
Type string or null
Read Only True
Added iLO 5 1.20

The following are the supported values:

Value Description
Null A value is temporarily unavailable
Down The port is enabled but link is down.
Up The port is enabled and link is good (up).

MaxFrameSize

Member of NetworkPort.v1_2_5.NetworkPort
Description The maximum frame size supported by the port.
Type integer or null
Read Only True

NetDevFuncMaxBWAlloc (array)

Member of NetworkPort.v1_2_5.NetworkPort NetDevFuncMaxBWAlloc is an array containing elements of:

NetDevFuncMaxBWAlloc[{item}].MaxBWAllocPercent Member of NetworkPort.v1_2_5.NetworkPort
Description The maximum bandwidth allocation percentage allocated to the associated network device function.
Type integer or null
Read Only False
Added iLO 5 1.20

NetDevFuncMaxBWAlloc[{item}].NetworkDeviceFunction A reference to the associated network device function that this maximum bandwidth percentage allocation applies to. NetworkDeviceFunction is a link ("@odata.id": URI) to another resource.

NetDevFuncMinBWAlloc (array)

Member of NetworkPort.v1_2_5.NetworkPort NetDevFuncMinBWAlloc is an array containing elements of:

NetDevFuncMinBWAlloc[{item}].MinBWAllocPercent Member of NetworkPort.v1_2_5.NetworkPort
Description The minimum bandwidth allocation percentage allocated to the associated network device function instance. The sum total of all minimum percentages shall not exceed 100.
Type integer or null
Read Only False
Added iLO 5 1.20

NetDevFuncMinBWAlloc[{item}].NetworkDeviceFunction A reference to the associated network device function that this minimum bandwidth percentage allocation applies to. NetworkDeviceFunction is a link ("@odata.id": URI) to another resource.

Oem.Hpe.AutoNegotiationCapable

Member of NetworkPort.v1_2_5.NetworkPort
Description Indicates the ability of this network port to autonegotiate link speed.
Type boolean or null
Read Only True
Added iLO 5 1.20

Member of NetworkPort.v1_2_5.NetworkPort ConfiguredNetworkLinks is an array containing elements of:

ConfiguredNetworkLinks[{item}].ConfiguredLinkSpeedGbps Member of NetworkPort.v1_2_5.NetworkPort
Description The link speed per lane this port is configured to use for autonegotiation.
Type integer or null
Read Only False

ConfiguredNetworkLinks[{item}].ConfiguredWidth Member of NetworkPort.v1_2_5.NetworkPort
Description The number of lanes this port is configured to use for autonegotiation. If this property is omitted, the lane count shall default to one.
Type integer or null
Read Only False

Oem.Hpe.Evb

Edge Virtual Bridging (EVB) information for this port. Evb is a link ("@odata.id": URI) to another resource.

Oem.Hpe.EvbData

Oem.Hpe.EvbData.Receiving Oem.Hpe.EvbData.Receiving.CdcpActive Member of NetworkPort.v1_2_5.NetworkPort
Description True if a currently active IEEE 802.1Qbg CDCP TLV has been received from the link partner.
Type boolean or null
Read Only True

Oem.Hpe.EvbData.Receiving.ChannelActive Member of NetworkPort.v1_2_5.NetworkPort
Description A currently unexpired HPE Channel Link Control or HPE Channel Description TLV has been received from the link partner.
Type boolean or null
Read Only True

Oem.Hpe.EvbData.Receiving.ChannelDescriptionLocalSequenceNumber Member of NetworkPort.v1_2_5.NetworkPort
Description The link partner’s HPE Channel Description sequence number that was last successfully received and processed.
Type integer or null
Read Only True

Oem.Hpe.EvbData.Receiving.ChannelDescriptionRemoteSequenceNumber Member of NetworkPort.v1_2_5.NetworkPort
Description The last HPE Channel Decsription sequence number sent on this link that was successfully received and processed by the link partner.
Type integer or null
Read Only True

Oem.Hpe.EvbData.Receiving.ChannelDescriptionSubtype Member of NetworkPort.v1_2_5.NetworkPort
Description The header subtype field of the last received HPE Channel Description TLV.
Type integer or null
Read Only True

Oem.Hpe.EvbData.Receiving.ChannelLinkControlLocalSequenceNumber Member of NetworkPort.v1_2_5.NetworkPort
Description The link partner’s HPE Channel Link Control sequence number that was last successfully received and processed.
Type integer or null
Read Only True

Oem.Hpe.EvbData.Receiving.ChannelLinkControlMCEnable Member of NetworkPort.v1_2_5.NetworkPort
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.
Type boolean or null
Read Only True

Oem.Hpe.EvbData.Receiving.ChannelLinkControlRemoteSequenceNumber Member of NetworkPort.v1_2_5.NetworkPort
Description The last HPE Channel Link control sequence number sent on this link that was successfully received and processed by the link partner.
Type integer or null
Read Only True

Oem.Hpe.EvbData.Receiving.ChannelLinkControlSubtype Member of NetworkPort.v1_2_5.NetworkPort
Description The header subtype field of the last received HPE Channel Link Control TLV.
Type integer or null
Read Only True

Oem.Hpe.EvbData.Receiving.Role Member of NetworkPort.v1_2_5.NetworkPort
Description The link partner’s IEEE 802.1Qbg operating role.
Type string or null
Read Only True

The following are the supported values:

Value Description
Null A value is temporarily unavailable
bridge Indicates the link partner is operating as a Bridge.
station Indicates the link partner is operating as a Station.

Oem.Hpe.EvbData.Receiving.SChannelAssignments (array) Member of NetworkPort.v1_2_5.NetworkPort SChannelAssignments is an array containing elements of:

SChannelAssignments[{item}].Scid Member of NetworkPort.v1_2_5.NetworkPort
Description SCID value for this S-Channel identifier pairreceived from the link partner on this port.
Type integer or null
Read Only True

SChannelAssignments[{item}].Svid Member of NetworkPort.v1_2_5.NetworkPort
Description SVID assignment value for this S-Channel identifier pair received from the link partner on this port. When 0 it indicates an assignment request is in progress.
Type integer or null
Read Only True

Oem.Hpe.EvbData.Receiving.SChannelMaxCount Member of NetworkPort.v1_2_5.NetworkPort
Description Indicates the number of S-Channels the link partner can support on this physical link.
Type integer or null
Read Only True

Oem.Hpe.EvbData.Receiving.SChannelsSupported Member of NetworkPort.v1_2_5.NetworkPort
Description When true this link supports S-Channels.
Type boolean or null
Read Only True

Oem.Hpe.EvbData.Receiving.VirtualLinkStatusVector Member of NetworkPort.v1_2_5.NetworkPort
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).
Type string or null
Read Only True

Oem.Hpe.EvbData.Transmitting Oem.Hpe.EvbData.Transmitting.ChannelDescriptionData (array) Member of NetworkPort.v1_2_5.NetworkPort ChannelDescriptionData is an array containing elements of:

ChannelDescriptionData[{item}].Descriptor0BandwidthCirMbps Member of NetworkPort.v1_2_5.NetworkPort
Description The bandwidth Commited Information Rate (CIR) for this S-Channel, in Mbps.
Type integer or null
Read Only True

ChannelDescriptionData[{item}].Descriptor0BandwidthPirMbps Member of NetworkPort.v1_2_5.NetworkPort
Description The bandwidth Peak Information Rate (PIR) for this S-Channel, in Mbps.
Type integer or null
Read Only True

ChannelDescriptionData[{item}].Descriptor0ChannelTerminationType Member of NetworkPort.v1_2_5.NetworkPort
Description Indicates the termination provided for this S-Channel.
Type string or null
Read Only True

The following are the supported values:

Value Description
Null A value is temporarily unavailable
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.

ChannelDescriptionData[{item}].Descriptor0EthernetSupport Member of NetworkPort.v1_2_5.NetworkPort
Description When true, this S-Channel supports Ethernet.
Type boolean or null
Read Only True

ChannelDescriptionData[{item}].Descriptor0FCoESupport Member of NetworkPort.v1_2_5.NetworkPort
Description When true, this S-Channel supports Fibre Channel over Ethernet (FCoE).
Type boolean or null
Read Only True

ChannelDescriptionData[{item}].Descriptor0PcpSupport Member of NetworkPort.v1_2_5.NetworkPort
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).
Type string or null
Read Only True

ChannelDescriptionData[{item}].Descriptor0RoCEESupport Member of NetworkPort.v1_2_5.NetworkPort
Description When true, this S-Channel supports RDMA over Converged Enhanced Ethernet (RoCEE).
Type boolean or null
Read Only True

ChannelDescriptionData[{item}].Descriptor0Scid Member of NetworkPort.v1_2_5.NetworkPort
Description The S-Channel identifier for this Descriptor0 instance.
Type integer or null
Read Only True

ChannelDescriptionData[{item}].Descriptor0iSCSISupport Member of NetworkPort.v1_2_5.NetworkPort
Description When true, this S-Channel supports Internet SCSI (iSCSI).
Type boolean or null
Read Only True

ChannelDescriptionData[{item}].Descriptor1ConnectionID Member of NetworkPort.v1_2_5.NetworkPort
Description A unique S-Channel identifer in UUID format.
Type string or null
Read Only True

ChannelDescriptionData[{item}].Descriptor1Scid Member of NetworkPort.v1_2_5.NetworkPort
Description The S-Channel identifier for this Descriptor1 instance.
Type integer or null
Read Only True

Oem.Hpe.EvbData.Transmitting.ChannelDescriptionLocalSequenceNumber Member of NetworkPort.v1_2_5.NetworkPort
Description This station’s channel discovery local sequence number which will be transmitted to the link partner on this port.
Type integer or null
Read Only True

Oem.Hpe.EvbData.Transmitting.ChannelDescriptionRemoteSequenceNumber Member of NetworkPort.v1_2_5.NetworkPort
Description The link partner’s channel discovery local sequence number that was last successfully received and processed.
Type integer or null
Read Only True

Oem.Hpe.EvbData.Transmitting.ChannelDescriptorCount Member of NetworkPort.v1_2_5.NetworkPort
Description The number of channel descriptor pairs being transmitted to the link partner on this port.
Type integer or null
Read Only True

Oem.Hpe.EvbData.Transmitting.ChannelLinkControlLocalSequenceNumber Member of NetworkPort.v1_2_5.NetworkPort
Description This station’s channel link control local sequence number which will be transmitted to the link partner on this port.
Type integer or null
Read Only True

Oem.Hpe.EvbData.Transmitting.ChannelLinkControlMCEnable Member of NetworkPort.v1_2_5.NetworkPort
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.
Type boolean or null
Read Only True

Oem.Hpe.EvbData.Transmitting.ChannelLinkControlRemoteSequenceNumber Member of NetworkPort.v1_2_5.NetworkPort
Description The link partner’s channel link control local sequence number that was last successfully received and processed.
Type integer or null
Read Only True

Oem.Hpe.EvbData.Transmitting.Role Member of NetworkPort.v1_2_5.NetworkPort
Description This port’s IEEE 802.1Qbg role being advertised on the link.
Type string or null
Read Only True

The following are the supported values:

Value Description
Null A value is temporarily unavailable
bridge Indicates this link is operating locally as a Bridge.
station Indicates this link is operating locally as a Station.

Oem.Hpe.EvbData.Transmitting.SChannelAssignments (array) Member of NetworkPort.v1_2_5.NetworkPort SChannelAssignments is an array containing elements of:

SChannelAssignments[{item}].Scid Member of NetworkPort.v1_2_5.NetworkPort
Description SCID value for this S-Channel identifier pair being transmitted to the link partner on this port.
Type integer or null
Read Only True

SChannelAssignments[{item}].Svid Member of NetworkPort.v1_2_5.NetworkPort
Description SVID assignment value for this 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.
Type integer or null
Read Only True

Oem.Hpe.EvbData.Transmitting.SChannelMaxCount Member of NetworkPort.v1_2_5.NetworkPort
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.
Type integer or null
Read Only True

Oem.Hpe.EvbData.Transmitting.SChannelsSupported Member of NetworkPort.v1_2_5.NetworkPort
Description When true, indicates that this physical link has S-Channel capability.
Type boolean or null
Read Only True

Oem.Hpe.EvbData.Transmitting.VirtualLinkStatusVector Member of NetworkPort.v1_2_5.NetworkPort
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).
Type string or null
Read Only True

Oem.Hpe.Lldp

Link-Layer Discovery Protocol (LLDP) information for this port. Lldp is a link ("@odata.id": URI) to another resource.

Oem.Hpe.LldpData

Oem.Hpe.LldpData.Receiving Oem.Hpe.LldpData.Receiving.ChassisID Member of NetworkPort.v1_2_5.NetworkPort
Description The LLDP chassis ID received from the link partner.
Type string or null
Read Only True

Oem.Hpe.LldpData.Receiving.ChassisIDSubtype Member of NetworkPort.v1_2_5.NetworkPort
Description The IEEE 802.1AB-2009 chassis ID subtype received from the link partner.
Type string or null
Read Only True

The following are the supported values:

Value Description
Null A value is temporarily unavailable
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.
MacAddr 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.
AgentId Agent circuit ID, based on the agent-local identifier of the circuit as defined in RFC 3046.
LocalAssign Locally assigned, based on a alpha-numeric value locally assigned.

Oem.Hpe.LldpData.Receiving.Dcb Oem.Hpe.LldpData.Receiving.Dcb.ApplicationPriorityReceived Member of NetworkPort.v1_2_5.NetworkPort
Description True when an unexpired Data Center Bridging (DCB) Application Priority Table TLV has been received.
Type boolean or null
Read Only True

Oem.Hpe.LldpData.Receiving.Dcb.ApplicationPriorityTable (array) Member of NetworkPort.v1_2_5.NetworkPort ApplicationPriorityTable is an array containing elements of:

ApplicationPriorityTable[{item}].ApplicationPriority Member of NetworkPort.v1_2_5.NetworkPort
Description Indicates which priority level is assigned for this application protocol.
Type integer or null
Read Only True

ApplicationPriorityTable[{item}].ApplicationProtocol Member of NetworkPort.v1_2_5.NetworkPort
Description An integer value indicating application protocol identity, of the type described by DCBApplicationSelect.
Type integer or null
Read Only True

ApplicationPriorityTable[{item}].ApplicationSelect Member of NetworkPort.v1_2_5.NetworkPort
Description Indentifies the type of the DCBApplicationProtocol property.
Type string or null
Read Only True

The following are the supported values:

Value Description
Null A value is temporarily unavailable
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.

Oem.Hpe.LldpData.Receiving.Dcb.Ets Oem.Hpe.LldpData.Receiving.Dcb.Ets.BandwidthAssignmentTable (array) Member of NetworkPort.v1_2_5.NetworkPort BandwidthAssignmentTable is an array containing elements of:
Description One entry in the DCB ETS Traffic Class (TC) Bandwidth Assignment Table.
Type integer or null
Read Only True

Oem.Hpe.LldpData.Receiving.Dcb.Ets.CreditBasedShaper Member of NetworkPort.v1_2_5.NetworkPort
Description True if the link partner supports the Credit-based Shaper (CBS) transmmission selection algortithm.
Type boolean or null
Read Only True

Oem.Hpe.LldpData.Receiving.Dcb.Ets.MaximumTrafficClassCount Member of NetworkPort.v1_2_5.NetworkPort
Description The maximum number of traffic classes supported by the link partner.
Type integer or null
Read Only True

Oem.Hpe.LldpData.Receiving.Dcb.Ets.PriorityAssignmentTable (array) Member of NetworkPort.v1_2_5.NetworkPort PriorityAssignmentTable is an array containing elements of:
Description One entry in the DCB ETS Priority Assignment Table indicating this priority’s Traffic Class assignment.
Type integer or null
Read Only True

Oem.Hpe.LldpData.Receiving.Dcb.Ets.TlvReceived Member of NetworkPort.v1_2_5.NetworkPort
Description True when an unexpired DCB Enhanced Transmission Selection (ETS) TLV has been received.
Type boolean or null
Read Only True

Oem.Hpe.LldpData.Receiving.Dcb.Ets.TrafficSelectionAlgorithmTable (array) Member of NetworkPort.v1_2_5.NetworkPort TrafficSelectionAlgorithmTable is an array containing elements of:
Description An assignment of a Traffic Selection Algorithm (TSA) to a traffic class.
Type string or null
Read Only True

The following are the supported values:

Value Description
Null A value is temporarily unavailable
strict Strict priority algorithm.
CBS Credit-Based Shaper algorithm.
ETS Enhanced Traffic Selection algorithm.
vendor Vendor specific algorithm for use with DCB.

Oem.Hpe.LldpData.Receiving.Dcb.Ets.Willing Member of NetworkPort.v1_2_5.NetworkPort
Description True if the link partner is willing to accept ETS configurations.
Type boolean or null
Read Only True

Oem.Hpe.LldpData.Receiving.Dcb.LocalEqualRemote Member of NetworkPort.v1_2_5.NetworkPort
Description True when the transmitted and received contents match for both DCB ETS and PFC TLVs.
Type boolean or null
Read Only True

Oem.Hpe.LldpData.Receiving.Dcb.Pfc Oem.Hpe.LldpData.Receiving.Dcb.Pfc.EnabledTrafficClasses Member of NetworkPort.v1_2_5.NetworkPort
Description A bit string indicating which priority levels have PFC enabled, 1=enabled. PFC levels are bit ordered from 7 (first) to 0 (last).
Type string or null
Read Only True

Oem.Hpe.LldpData.Receiving.Dcb.Pfc.MacSecurityBypassCapability Member of NetworkPort.v1_2_5.NetworkPort
Description True when the link partner has the ability to bypass MAC security in order to improve PFC responsiveness.
Type boolean or null
Read Only True

Oem.Hpe.LldpData.Receiving.Dcb.Pfc.MaximumTrafficClassCount Member of NetworkPort.v1_2_5.NetworkPort
Description Indicates the maximum number of traffic classes that the link partner can simultaneously support.
Type integer or null
Read Only True

Oem.Hpe.LldpData.Receiving.Dcb.Pfc.TlvReceived Member of NetworkPort.v1_2_5.NetworkPort
Description True when an unexpired DCB Priority Flow Control (PFC) TLV has been received.
Type boolean or null
Read Only True

Oem.Hpe.LldpData.Receiving.Dcb.Pfc.Willing Member of NetworkPort.v1_2_5.NetworkPort
Description True if the LLDP link partner is willing to accept PFC configurations.
Type boolean or null
Read Only True

Oem.Hpe.LldpData.Receiving.Dcb.Version Member of NetworkPort.v1_2_5.NetworkPort
Description The DCB version supported by the link partner.
Type string or null
Read Only True

The following are the supported values:

Value Description
Null A value is temporarily unavailable
unknown Unknown
CEE Converged Enhanced Ethernet
IEEE IEEE 802.1Q

Oem.Hpe.LldpData.Receiving.ManagementAddress Member of NetworkPort.v1_2_5.NetworkPort
Description The management address received from the link partner.
Type string or null
Read Only True

Oem.Hpe.LldpData.Receiving.ManagementAddressOID Member of NetworkPort.v1_2_5.NetworkPort
Description An object identifier for the hardware or protocol entity associated with the management address.
Type string or null
Read Only True

Oem.Hpe.LldpData.Receiving.ManagementAddressReceived Member of NetworkPort.v1_2_5.NetworkPort
Description True when a currently unexpired management address TLV has been received from the link partner.
Type boolean or null
Read Only True

Oem.Hpe.LldpData.Receiving.ManagementAddressType Member of NetworkPort.v1_2_5.NetworkPort
Description The type of management address received from the link partner.
Type string or null
Read Only True

The following are the supported values:

Value Description
Null A value is temporarily unavailable
IPv4 Type 1 (IP version 4).
IPv6 Type 2 (IP version 6).
all802 Type 6 (All 802 media plus Ethernet ‘canonical format’).

Oem.Hpe.LldpData.Receiving.ManagementCvlanID Member of NetworkPort.v1_2_5.NetworkPort
Description The management CVLAN ID received from the link partner.
Type integer or null
Read Only True

Oem.Hpe.LldpData.Receiving.ManagementIFNumSubtype Member of NetworkPort.v1_2_5.NetworkPort
Description Management interface number subtype.
Type string or null
Read Only True

The following are the supported values:

Value Description
Null A value is temporarily unavailable
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.

Oem.Hpe.LldpData.Receiving.ManagementIFNumber Member of NetworkPort.v1_2_5.NetworkPort
Description Management interface number received from the link partner represented as a colon delimited string of hexadecimal octets.
Type string or null
Read Only True

Oem.Hpe.LldpData.Receiving.ManagementVlanReceived Member of NetworkPort.v1_2_5.NetworkPort
Description True when a currently unexpired management address VID TLV has been received from the link partner.
Type boolean or null
Read Only True

Oem.Hpe.LldpData.Receiving.NearestBridgeTtlExpired Member of NetworkPort.v1_2_5.NetworkPort
Description True when the LLDP PDU most recently received from the link partner has expired.
Type boolean or null
Read Only True

Oem.Hpe.LldpData.Receiving.PortDescription Member of NetworkPort.v1_2_5.NetworkPort
Description The remote link partner’s port description.
Type string or null
Read Only True

Oem.Hpe.LldpData.Receiving.PortID Member of NetworkPort.v1_2_5.NetworkPort
Description A colon delimited string of hexadecimal octets received from the link partner identifying its port.
Type string or null
Read Only True

Oem.Hpe.LldpData.Receiving.PortIDSubtype Member of NetworkPort.v1_2_5.NetworkPort
Description The port ID subtype enumeration from IEEE 802.1AB-2009 Table 8-3, which indicates the format for the PortID property.
Type string or null
Read Only True

The following are the supported values:

Value Description
Null A value is temporarily unavailable
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.
MacAddr 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.
AgentId Agent circuit ID, based on the agent-local identifier of the circuit as defined in RFC 3046.
LocalAssign Locally assigned, based on a alpha-numeric value locally assigned.

Oem.Hpe.LldpData.Receiving.SystemDescription Member of NetworkPort.v1_2_5.NetworkPort
Description The system description received from the link partner.
Type string or null
Read Only True

Oem.Hpe.LldpData.Transmitting Oem.Hpe.LldpData.Transmitting.ChassisID Member of NetworkPort.v1_2_5.NetworkPort
Description The Link Layer Data Protocol (LLDP) chassis ID being transmitted on this link.
Type string or null
Read Only True

Oem.Hpe.LldpData.Transmitting.ChassisIDSubtype Member of NetworkPort.v1_2_5.NetworkPort
Description The IEEE 802.1AB-2009 chassis ID subtype being transmitted on this link.
Type string or null
Read Only True

The following are the supported values:

Value Description
Null A value is temporarily unavailable
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.
MacAddr 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.
AgentId Agent circuit ID, based on the agent-local identifier of the circuit as defined in RFC 3046.
LocalAssign Locally assigned, based on a alpha-numeric value locally assigned.

Oem.Hpe.LldpData.Transmitting.ManagementAddresses (array) Member of NetworkPort.v1_2_5.NetworkPort ManagementAddresses is an array containing elements of:

ManagementAddresses[{item}].ManagementIPAddress Member of NetworkPort.v1_2_5.NetworkPort
Description A management address.
Type string or null
Read Only True

ManagementAddresses[{item}].ManagementIPAddressType Member of NetworkPort.v1_2_5.NetworkPort
Description The IANA type of this management address.
Type string or null
Read Only True

The following are the supported values:

Value Description
Null A value is temporarily unavailable
IPv4 Type 1 (IP version 4).
IPv6 Type 2 (IP version 6).
all802 Type 6 (All 802 media plus Ethernet ‘canonical format’).

Oem.Hpe.LldpData.Transmitting.ManagementCvlanID Member of NetworkPort.v1_2_5.NetworkPort
Description The management CVLAN ID being transmitted on this link.
Type integer or null
Read Only True

Oem.Hpe.LldpData.Transmitting.ManagementCvlanIDTransmitted Member of NetworkPort.v1_2_5.NetworkPort
Description When true, indicates that a management CVLAN ID is being transmitted on this link.
Type boolean or null
Read Only True

Oem.Hpe.LldpData.Transmitting.PortDescription Member of NetworkPort.v1_2_5.NetworkPort
Description An alphanumeric string describing this link.
Type string or null
Read Only True

Oem.Hpe.LldpData.Transmitting.PortID Member of NetworkPort.v1_2_5.NetworkPort
Description A colon delimited string of hexadecimal octets identifying this port.
Type string or null
Read Only True

Oem.Hpe.LldpData.Transmitting.PortIDSubtype Member of NetworkPort.v1_2_5.NetworkPort
Description The port ID subtype from IEEE 802.1AB-2009 Table 8-3.
Type string or null
Read Only True

The following are the supported values:

Value Description
Null A value is temporarily unavailable
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.
MacAddr 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.
AgentId Agent circuit ID, based on the agent-local identifier of the circuit as defined in RFC 3046.
LocalAssign Locally assigned, based on a alpha-numeric value locally assigned.

Oem.Hpe.LldpData.Transmitting.SystemDescription Member of NetworkPort.v1_2_5.NetworkPort
Description A textual description of this system.
Type string or null
Read Only True

Oem.Hpe.PortDiagnosticEnableLocalLoopback

Member of NetworkPort.v1_2_5.NetworkPort
Description When true, local loopback is active on this port. PortDiagnosticsEnabled must first be true in order to set this property to true.
Type boolean or null
Read Only False
Added iLO 5 1.20

Oem.Hpe.PortDiagnosticEnableRemoteLoopback

Member of NetworkPort.v1_2_5.NetworkPort
Description When true, remote loopback is active on this port. PortDiagnosticsEnabled must first be true in order to set this property to true.
Type boolean or null
Read Only False
Added iLO 5 1.20

Oem.Hpe.PortDiagnosticLocalLoopbackCapable

Member of NetworkPort.v1_2_5.NetworkPort
Description When true, the port has local loopback capability.
Type boolean or null
Read Only True
Added iLO 5 1.20

Oem.Hpe.PortDiagnosticRemoteLoopbackCapable

Member of NetworkPort.v1_2_5.NetworkPort
Description When true, the port has remote loopback capability.
Type boolean or null
Read Only True
Added iLO 5 1.20

Oem.Hpe.PortDiagnosticsEnabled

Member of NetworkPort.v1_2_5.NetworkPort
Description When true, diagnostic features are enabled on this port.
Type boolean or null
Read Only False
Added iLO 5 1.20

Oem.Hpe.VirtualFunctionAllocations (array)

Member of NetworkPort.v1_2_5.NetworkPort VirtualFunctionAllocations is an array containing elements of:

VirtualFunctionAllocations[{item}].NetworkDeviceFunction The logical network device function to which this virtual function allocation applies. NetworkDeviceFunction is a link ("@odata.id": URI) to another resource.

VirtualFunctionAllocations[{item}].VirtualFunctionsAllocated Member of NetworkPort.v1_2_5.NetworkPort
Description The number of virtual functions allocated to this logical network device function instance.
Type number or null
Read Only False

PhysicalPortNumber

Member of NetworkPort.v1_2_5.NetworkPort
Description The physical port number label for this port.
Type string or null
Read Only True
Added iLO 5 1.20

PortMaximumMTU

Member of NetworkPort.v1_2_5.NetworkPort
Description The largest maximum transmission unit (MTU) that can be configured for this network port.
Type number or null
Read Only True
Added iLO 5 1.20

Settings

Settings.href Member of NetworkPort.v1_2_5.NetworkPort
Description Reference to the resource the client may PUT/PATCH to in order to change this resource.
Type string
Read Only True
Added iLO 5 1.20

SignalDetected

Member of NetworkPort.v1_2_5.NetworkPort
Type boolean or null
Read Only True
Added iLO 5 1.20

Status

Member of NetworkPort.v1_2_5.NetworkPort See the Redfish standard schema and specification for information on common Status object.

SupportedEthernetCapabilities (array)

Member of NetworkPort.v1_2_5.NetworkPort SupportedEthernetCapabilities is an array containing elements of:
Type string or null
Read Only True

The following are the supported values:

Value Description
Null A value is temporarily unavailable
WakeOnLAN Wake on LAN (WoL) is supported on this port.
EEE IEEE 802.3az Energy Efficient Ethernet (EEE) is supported on this port.

SupportedLinkCapabilities (array)

Member of NetworkPort.v1_2_5.NetworkPort SupportedLinkCapabilities is an array containing elements of:

SupportedLinkCapabilities[{item}].CapableLinkSpeedMbps (array) Member of NetworkPort.v1_2_5.NetworkPort CapableLinkSpeedMbps is an array containing elements of:
Type integer or null
Read Only True

SupportedLinkCapabilities[{item}].LinkNetworkTechnology Member of NetworkPort.v1_2_5.NetworkPort
Description Physical link technology values.
Type string or null
Read Only True
Added iLO 5 1.20

The following are the supported values:

Value Description
Null A value is temporarily unavailable
Ethernet The port is capable of connecting to an Ethernet network.
InfiniBand The port is capable of connecting to an InfiniBand network.
FibreChannel The port is capable of connecting to a Fibre Channel network.

SupportedLinkCapabilities[{item}].LinkSpeedMbps Member of NetworkPort.v1_2_5.NetworkPort
Description The speed of the link in Mbps when this link network technology is active.
Type integer or null
Read Only True
Added iLO 5 1.20

WakeOnLANEnabled

Member of NetworkPort.v1_2_5.NetworkPort
Description An indication of whether Wake on LAN (WoL) is enabled for this network port.
Type boolean or null
Read Only False
Added iLO 5 1.20

Actions

HpeNetworkPort.DiagnosticsReset Member of NetworkPort.v1_2_5.NetworkPort There are no parameters for this action.

NetworkPort.DiagnosticsReset Member of NetworkPort.v1_2_5.NetworkPort NOTE: Deprecated, will be removed in a future release. Replaced by HpeNetworkPort.DiagnosticsReset

There are no parameters for this action.

NetworkPortCollection.NetworkPortCollection

@odata.type: "#NetworkPortCollection.NetworkPortCollection"

A Collection of NetworkPort resource instances.

Resource Instances

Uri HTTP Allow
/redfish/v1/chassis/{item}/networkadapters/{item}/networkports GET
/redfish/v1/systems/{item}/networkinterfaces/{item}/networkports GET POST PATCH
Link Name Destination type
Members[] NetworkPort

Members (array)

Member of NetworkPortCollection.NetworkPortCollection Members is an array containing elements of:

Members[{item}].@odata.id Member of NetworkPortCollection.NetworkPortCollection
Type string
Read Only True
Format uri-reference

Members@odata.count

Member of NetworkPortCollection.NetworkPortCollection
Description The total number of collection members.
Type integer
Read Only True

PCIeDevice.v1_5_0.PCIeDevice

@odata.type: "#PCIeDevice.v1_5_0.PCIeDevice"

This is the schema definition for the PCIeDevice resource. It represents the properties of a PCIe Device attached to a System.

Resource Instances

Uri HTTP Allow
/redfish/v1/chassis/{item}/pciedevices/{item} GET PATCH
Link Name Destination type
PCIeFunctions PCIeFunction

AssetTag

Member of PCIeDevice.v1_5_0.PCIeDevice
Description The user-assigned asset tag for this PCIe device.
Type string or null
Read Only False

DeviceType

Member of PCIeDevice.v1_5_0.PCIeDevice
Description The device type for this PCIe device.
Type string
Read Only True

The following are the supported values:

Value Description
SingleFunction A single-function PCIe device.
MultiFunction A multi-function PCIe device.
Simulated A PCIe device which is not currently physically present, but is being simulated by the PCIe infrastructure.

FirmwareVersion

Member of PCIeDevice.v1_5_0.PCIeDevice
Description The version of firmware for this PCIe device.
Type string or null
Read Only True

Manufacturer

Member of PCIeDevice.v1_5_0.PCIeDevice
Description The manufacturer of this PCIe device.
Type string or null
Read Only True

Model

Member of PCIeDevice.v1_5_0.PCIeDevice
Description The model number for the PCIe device.
Type string or null
Read Only True

Oem.Hpe.FirmwareVersion (array)

Member of PCIeDevice.v1_5_0.PCIeDevice FirmwareVersion is an array containing elements of:

FirmwareVersion[{item}].ComponentName Member of PCIeDevice.v1_5_0.PCIeDevice
Description Name of GPU cores
Type string or null
Read Only True

FirmwareVersion[{item}].VersionString Member of PCIeDevice.v1_5_0.PCIeDevice
Description Version string of GPU cores
Type string or null
Read Only True

PCIeFunctions

The link to the collection of PCIe functions associated with this PCIe device. PCIeFunctions is a link ("@odata.id": URI) to another resource.

PCIeInterface

PCIeInterface.LanesInUse Member of PCIeDevice.v1_5_0.PCIeDevice
Description The number of PCIe lanes in use by this device.
Type integer or null
Read Only True

PCIeInterface.MaxLanes Member of PCIeDevice.v1_5_0.PCIeDevice
Description The number of PCIe lanes supported by this device.
Type integer or null
Read Only True

PCIeInterface.MaxPCIeType Member of PCIeDevice.v1_5_0.PCIeDevice
Description The highest version of the PCIe specification supported by this device.
Type string
Read Only True

The following are the supported values:

Value Description
Gen1 A PCIe v1.0 slot.
Gen2 A PCIe v2.0 slot.
Gen3 A PCIe v3.0 slot.
Gen4 A PCIe v4.0 slot.
Gen5 A PCIe v5.0 slot.

PCIeInterface.PCIeType Member of PCIeDevice.v1_5_0.PCIeDevice
Description The version of the PCIe specification in use by this device.
Type string
Read Only True

The following are the supported values:

Value Description
Gen1 A PCIe v1.0 slot.
Gen2 A PCIe v2.0 slot.
Gen3 A PCIe v3.0 slot.
Gen4 A PCIe v4.0 slot.
Gen5 A PCIe v5.0 slot.

PartNumber

Member of PCIeDevice.v1_5_0.PCIeDevice
Description The part number for this PCIe device.
Type string or null
Read Only True

SKU

Member of PCIeDevice.v1_5_0.PCIeDevice
Description The SKU for this PCIe device.
Type string or null
Read Only True

SerialNumber

Member of PCIeDevice.v1_5_0.PCIeDevice
Description The serial number for this PCIe device.
Type string or null
Read Only True

Status

Member of PCIeDevice.v1_5_0.PCIeDevice See the Redfish standard schema and specification for information on common Status object.

PCIeDeviceCollection.PCIeDeviceCollection

@odata.type: "#PCIeDeviceCollection.PCIeDeviceCollection"

The collection of PCIeDevice Resource instances.

Resource Instances

Uri HTTP Allow
/redfish/v1/chassis/{item}/pciedevices GET
Link Name Destination type
Members[] PCIeDevice

Members (array)

Member of PCIeDeviceCollection.PCIeDeviceCollection Members is an array containing elements of:

Members[{item}].@odata.id Member of PCIeDeviceCollection.PCIeDeviceCollection
Type string
Read Only True
Format uri-reference

Members@odata.count

Member of PCIeDeviceCollection.PCIeDeviceCollection
Description The total number of collection members.
Type integer
Read Only True

PCIeFunction.v1_2_3.PCIeFunction

@odata.type: "#PCIeFunction.v1_2_3.PCIeFunction"

The schema definition for the PCIeFunction Resource. It represents the properties of a PCIeFunction attached to a System.

Resource Instances

Uri HTTP Allow
/redfish/v1/chassis/{item}/pciedevices/{item}/pciefunctions/{item} GET

ClassCode

Member of PCIeFunction.v1_2_3.PCIeFunction
Description The Class Code of this PCIe function.
Type string or null
Read Only True

DeviceClass

Member of PCIeFunction.v1_2_3.PCIeFunction
Description The class for this PCIe function.
Type string
Read Only True

The following are the supported values:

Value Description
UnclassifiedDevice An unclassified device.
MassStorageController A mass storage controller.
NetworkController A network controller.
DisplayController A display controller.
MultimediaController A multimedia controller.
MemoryController A memory controller.
Bridge A bridge.
CommunicationController A communication controller.
GenericSystemPeripheral A generic system peripheral.
InputDeviceController An input device controller.
DockingStation A docking station.
Processor A processor.
SerialBusController A serial bus controller.
WirelessController A wireless controller.
IntelligentController An intelligent controller.
SatelliteCommunicationsController A satellite communications controller.
EncryptionController An encryption controller.
SignalProcessingController A signal processing controller.
ProcessingAccelerators A processing accelerators.
NonEssentialInstrumentation A non-essential instrumentation.
Coprocessor A coprocessor.
UnassignedClass An unassigned class.
Other A other class. The function Device Class Id needs to be verified.

DeviceId

Member of PCIeFunction.v1_2_3.PCIeFunction
Description The Device ID of this PCIe function.
Type string or null
Read Only True

FunctionId

Member of PCIeFunction.v1_2_3.PCIeFunction
Description The PCIe Function Number.
Type integer or null
Read Only True

FunctionType

Member of PCIeFunction.v1_2_3.PCIeFunction
Description The type of the PCIe function.
Type string
Read Only True

The following are the supported values:

Value Description
Physical A physical PCIe function.
Virtual A virtual PCIe function.

RevisionId

Member of PCIeFunction.v1_2_3.PCIeFunction
Description The Revision ID of this PCIe function.
Type string or null
Read Only True

Status

Member of PCIeFunction.v1_2_3.PCIeFunction See the Redfish standard schema and specification for information on common Status object.

SubsystemId

Member of PCIeFunction.v1_2_3.PCIeFunction
Description The Subsystem ID of this PCIe function.
Type string or null
Read Only True

SubsystemVendorId

Member of PCIeFunction.v1_2_3.PCIeFunction
Description The Subsystem Vendor ID of this PCIe function.
Type string or null
Read Only True

VendorId

Member of PCIeFunction.v1_2_3.PCIeFunction
Description The Vendor ID of this PCIe function.
Type string or null
Read Only True

PCIeFunctionCollection.PCIeFunctionCollection

@odata.type: "#PCIeFunctionCollection.PCIeFunctionCollection"

The collection of PCIeFunction Resource instances.

Resource Instances

Uri HTTP Allow
/redfish/v1/chassis/{item}/pciedevices/{item}/pciefunctions GET
Link Name Destination type
Members[] PCIeFunction

Members (array)

Member of PCIeFunctionCollection.PCIeFunctionCollection Members is an array containing elements of:

Members[{item}].@odata.id Member of PCIeFunctionCollection.PCIeFunctionCollection
Type string
Read Only True
Format uri-reference

Members@odata.count

Member of PCIeFunctionCollection.PCIeFunctionCollection
Description The total number of collection members.
Type integer
Read Only True

PCIeSlots.v1_3_0.PCIeSlots

@odata.type: "#PCIeSlots.v1_3_0.PCIeSlots"

The PCIeSlots schema describes PCIe slot properties.

Resource Instances

Uri HTTP Allow
/redfish/v1/chassis/{item}/pcieslots GET

Slots (array)

Member of PCIeSlots.v1_3_0.PCIeSlots Slots is an array containing elements of:

Slots[{item}].HotPluggable Member of PCIeSlots.v1_3_0.PCIeSlots
Description An indication of whether this PCIe slot supports hotplug.
Type boolean or null
Read Only True

Slots[{item}].Lanes Member of PCIeSlots.v1_3_0.PCIeSlots
Description The number of PCIe lanes supported by this slot.
Type integer or null
Read Only True

Slots[{item}].Location Slots[{item}].Location.PartLocation Slots[{item}].Location.PartLocation.LocationOrdinalValue Member of PCIeSlots.v1_3_0.PCIeSlots
Description The number that represents the location of the part. If LocationType is slot and this unit is in slot 2, the LocationOrdinalValue is 2.
Type integer or null
Read Only True

Slots[{item}].Location.PartLocation.LocationType Member of PCIeSlots.v1_3_0.PCIeSlots
Description The location types for PartLocation.
Type string or null
Read Only True

The following are the supported values:

Value Description
Null A value is temporarily unavailable
Slot The slot as the type of location.
Bay The bay as the type of location.
Connector The connector as the type of location.
Socket The socket as the type of location.

Slots[{item}].Location.PartLocation.Orientation Member of PCIeSlots.v1_3_0.PCIeSlots
Description The orientation for the ordering of the part location ordinal value.
Type string or null
Read Only True

The following are the supported values:

Value Description
Null A value is temporarily unavailable
FrontToBack The ordering for LocationOrdinalValue is front to back.
BackToFront The ordering for the LocationOrdinalValue is back to front.
TopToBottom The ordering for the LocationOrdinalValue is top to bottom.
BottomToTop The ordering for LocationOrdinalValue is bottom to top.
LeftToRight The ordering for the LocationOrdinalValue is left to right.
RightToLeft The ordering for the LocationOrdinalValue is right to left.

Slots[{item}].Location.PartLocation.Reference Member of PCIeSlots.v1_3_0.PCIeSlots
Description The reference area for the location of the part.
Type string or null
Read Only True

The following are the supported values:

Value Description
Null A value is temporarily unavailable
Top The part is in the top of the unit.
Bottom The part is in the bottom of the unit.
Front The part is in the front of the unit.
Rear The part is in the rear of the unit.
Left The part is on the left side of of the unit.
Right The part is on the right side of the unit.
Middle The part is in the middle of the unit.

Slots[{item}].Location.PartLocation.ServiceLabel Member of PCIeSlots.v1_3_0.PCIeSlots
Description The label of the part location, such as a silk-screened name or a printed label.
Type string or null
Read Only True

Slots[{item}].Location.Placement Slots[{item}].Location.Placement.AdditionalInfo Member of PCIeSlots.v1_3_0.PCIeSlots
Description Area designation or other additional info.
Type string or null
Read Only False

Slots[{item}].Location.Placement.Rack Member of PCIeSlots.v1_3_0.PCIeSlots
Description The name of a rack location within a row.
Type string or null
Read Only False

Slots[{item}].Location.Placement.RackOffset Member of PCIeSlots.v1_3_0.PCIeSlots
Description The vertical location of the item, in terms of RackOffsetUnits.
Type integer or null
Read Only False

Slots[{item}].Location.Placement.RackOffsetUnits Member of PCIeSlots.v1_3_0.PCIeSlots
Description The type of rack unit in use.
Type string or null
Read Only False

The following are the supported values:

Value Description
Null A value is temporarily unavailable
OpenU A rack unit that is equal to 48 mm (1.89 in).
EIA_310 A rack unit that is equal to 1.75 in (44.45 mm).

Slots[{item}].Location.Placement.Row Member of PCIeSlots.v1_3_0.PCIeSlots
Description The name of the row.
Type string or null
Read Only False

Slots[{item}].PCIeType Member of PCIeSlots.v1_3_0.PCIeSlots
Description The PCIe specification supported by this slot.
Type string
Read Only True

The following are the supported values:

Value Description
Gen1 A PCIe v1.0 slot.
Gen2 A PCIe v2.0 slot.
Gen3 A PCIe v3.0 slot.
Gen4 A PCIe v4.0 slot.
Gen5 A PCIe v5.0 slot.

Slots[{item}].SlotType Member of PCIeSlots.v1_3_0.PCIeSlots
Description The PCIe slot type for this slot.
Type string
Read Only True

The following are the supported values:

Value Description
FullLength Full-Length PCIe slot.
HalfLength Half-Length PCIe slot.
LowProfile Low-Profile or Slim PCIe slot.
Mini Mini PCIe slot.
M2 PCIe M.2 slot.
OEM An OEM-specific slot.
OCP3Small Open Compute Project 3.0 small form factor slot.
OCP3Large Open Compute Project 3.0 large form factor slot.
U2 PCIe U.2 slot or bay

Slots[{item}].Status Member of PCIeSlots.v1_3_0.PCIeSlots See the Redfish standard schema and specification for information on common Status object.

Port.v1_5_0.Port

@odata.type: "#Port.v1_5_0.Port"

A Port represents a discrete physical port capable of connecting to a network.

Resource Instances

Uri HTTP Allow
/redfish/v1/chassis/{item}/networkadapters/{item}/ports/{item} GET POST PATCH
/redfish/v1/chassis/{item}/networkadapters/{item}/ports/{item}/settings GET PATCH
/redfish/v1/systems/{item}/networkinterfaces/{item}/ports/{item} GET POST PATCH
/redfish/v1/systems/{item}/networkinterfaces/{item}/ports/{item}/settings GET PATCH
/redfish/v1/systems/{item}/storage/{item}/controllers/{item}/ports/{item} GET PATCH
/redfish/v1/systems/{item}/storage/{item}/storagecontrollers/{item}/ports/{item} GET PATCH
Link Name Destination type
Members[] Port

@Redfish.Settings

Member of Port.v1_5_0.Port See the Redfish standard schema and specification for information on common @Redfish properties.

ActiveWidth

Member of Port.v1_5_0.Port
Description The number of active lanes for this interface.
Type integer
Read Only True

CapableProtocolVersions (array)

Member of Port.v1_5_0.Port CapableProtocolVersions is an array containing elements of:
Type string or null
Read Only True

CurrentProtocolVersion

Member of Port.v1_5_0.Port
Description The protocol version being sent over this port.
Type string or null
Read Only True

CurrentSpeedGbps

Member of Port.v1_5_0.Port
Description The current speed of this port.
Type number or null
Read Only True

Enabled

Member of Port.v1_5_0.Port
Description An indication of whether this port is enabled.
Type boolean
Read Only False

Ethernet

Ethernet.AssociatedMACAddresses (array) Member of Port.v1_5_0.Port AssociatedMACAddresses is an array containing elements of:
Type string or null
Read Only True

Ethernet.EEEEnabled Member of Port.v1_5_0.Port
Description Indicates whether IEEE 802.3az Energy-Efficient Ethernet (EEE) is enabled on this port.
Type boolean or null
Read Only False

Ethernet.FlowControlConfiguration Member of Port.v1_5_0.Port
Description The locally configured 802.3x flow control setting for this port.
Type string
Read Only False

The following are the supported values:

Value Description
None No IEEE 802.3x flow control is enabled on this port.
TX IEEE 802.3x flow control may be initiated by this station.
RX IEEE 802.3x flow control may be initiated by the link partner.
TX_RX IEEE 802.3x flow control may be initiated by this station or the link partner.

Ethernet.FlowControlStatus Member of Port.v1_5_0.Port
Description The 802.3x flow control behavior negotiated with the link partner for this port.
Type string
Read Only True

The following are the supported values:

Value Description
None No IEEE 802.3x flow control is enabled on this port.
TX IEEE 802.3x flow control may be initiated by this station.
RX IEEE 802.3x flow control may be initiated by the link partner.
TX_RX IEEE 802.3x flow control may be initiated by this station or the link partner.

Ethernet.LLDPEnabled Member of Port.v1_5_0.Port
Description Enable/disable LLDP for this port.
Type boolean
Read Only False

Ethernet.LLDPReceive Ethernet.LLDPReceive.ChassisId Member of Port.v1_5_0.Port
Description Link Layer Data Protocol (LLDP) chassis ID received from the remote partner across this link.
Type string or null
Read Only True

Ethernet.LLDPReceive.ChassisIdSubtype Member of Port.v1_5_0.Port
Description The type of identifier used for the chassis ID received from the remote partner across this link.
Type string
Read Only True

The following are the supported values:

Value Description
ChassisComp Chassis component, based in the value of entPhysicalAlias in RFC4133.
IfAlias Interface alias, based on the ifAlias MIB object.
PortComp Port component, based in the value of entPhysicalAlias in RFC4133.
MacAddr 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.
AgentId Agent circuit ID, based on the agent-local identifier of the circuit as defined in RFC3046.
LocalAssign Locally assigned, based on a alpha-numeric value locally assigned.
NotTransmitted No data to be sent to/received from remote partner.

Ethernet.LLDPReceive.ManagementAddressIPv4 Member of Port.v1_5_0.Port
Description The IPv4 management address received from the remote partner across this link.
Type string or null
Read Only True

Ethernet.LLDPReceive.ManagementAddressIPv6 Member of Port.v1_5_0.Port
Description The IPv6 management address received from the remote partner across this link.
Type string or null
Read Only True

Ethernet.LLDPReceive.ManagementAddressMAC Member of Port.v1_5_0.Port
Description The management MAC address received from the remote partner across this link.
Type string or null
Read Only True

Ethernet.LLDPReceive.ManagementVlanId Member of Port.v1_5_0.Port
Description The management VLAN ID received from the remote partner across this link.
Type integer or null
Read Only True

Ethernet.LLDPReceive.PortId Member of Port.v1_5_0.Port
Description A colon delimited string of hexadecimal octets identifying a port.
Type string or null
Read Only True

Ethernet.LLDPReceive.PortIdSubtype Member of Port.v1_5_0.Port
Description The port ID subtype received from the remote partner across this link.
Type string
Read Only True

The following are the supported values:

Value Description
ChassisComp Chassis component, based in the value of entPhysicalAlias in RFC4133.
IfAlias Interface alias, based on the ifAlias MIB object.
PortComp Port component, based in the value of entPhysicalAlias in RFC4133.
MacAddr 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.
AgentId Agent circuit ID, based on the agent-local identifier of the circuit as defined in RFC3046.
LocalAssign Locally assigned, based on a alpha-numeric value locally assigned.
NotTransmitted No data to be sent to/received from remote partner.

Ethernet.LLDPTransmit Ethernet.LLDPTransmit.ChassisId Member of Port.v1_5_0.Port
Description Link Layer Data Protocol (LLDP) chassis ID.
Type string or null
Read Only False

Ethernet.LLDPTransmit.ChassisIdSubtype Member of Port.v1_5_0.Port
Description The type of identifier used for the chassis ID.
Type string
Read Only False

The following are the supported values:

Value Description
ChassisComp Chassis component, based in the value of entPhysicalAlias in RFC4133.
IfAlias Interface alias, based on the ifAlias MIB object.
PortComp Port component, based in the value of entPhysicalAlias in RFC4133.
MacAddr 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.
AgentId Agent circuit ID, based on the agent-local identifier of the circuit as defined in RFC3046.
LocalAssign Locally assigned, based on a alpha-numeric value locally assigned.
NotTransmitted No data to be sent to/received from remote partner.

Ethernet.LLDPTransmit.ManagementAddressIPv4 Member of Port.v1_5_0.Port
Description The IPv4 management address to be transmitted from this endpoint.
Type string or null
Read Only False

Ethernet.LLDPTransmit.ManagementAddressIPv6 Member of Port.v1_5_0.Port
Description The IPv6 management address to be transmitted from this endpoint.
Type string or null
Read Only False

Ethernet.LLDPTransmit.ManagementAddressMAC Member of Port.v1_5_0.Port
Description The management MAC address to be transmitted from this endpoint.
Type string or null
Read Only False

Ethernet.LLDPTransmit.ManagementVlanId Member of Port.v1_5_0.Port
Description The management VLAN ID to be transmitted from this endpoint.
Type integer or null
Read Only False

Ethernet.LLDPTransmit.PortId Member of Port.v1_5_0.Port
Description A colon delimited string of hexadecimal octets identifying a port to be transmitted from this endpoint.
Type string or null
Read Only False

Ethernet.LLDPTransmit.PortIdSubtype Member of Port.v1_5_0.Port
Description The port ID subtype to be transmitted from this endpoint.
Type string
Read Only False

The following are the supported values:

Value Description
ChassisComp Chassis component, based in the value of entPhysicalAlias in RFC4133.
IfAlias Interface alias, based on the ifAlias MIB object.
PortComp Port component, based in the value of entPhysicalAlias in RFC4133.
MacAddr 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.
AgentId Agent circuit ID, based on the agent-local identifier of the circuit as defined in RFC3046.
LocalAssign Locally assigned, based on a alpha-numeric value locally assigned.
NotTransmitted No data to be sent to/received from remote partner.

Ethernet.WakeOnLANEnabled Member of Port.v1_5_0.Port
Description Indicates whether Wake on LAN (WoL) is enabled on this port.
Type boolean or null
Read Only False

FibreChannel

FibreChannel.FabricName Member of Port.v1_5_0.Port
Description The Fibre Channel Fabric Name provided by the switch.
Type string or null
Read Only True

FibreChannel.NumberDiscoveredRemotePorts Member of Port.v1_5_0.Port
Description The number of ports not on the associated device that the associated device has discovered through this port.
Type integer or null
Read Only True

FibreChannel.PortConnectionType Member of Port.v1_5_0.Port
Description The connection type of this port.
Type string
Read Only True

The following are the supported values:

Value Description
NotConnected This port is not connected.
NPort This port connects through an N-Port to a switch.
PointToPoint This port connects in a Point-to-point configuration.
PrivateLoop This port connects in a private loop configuration.
PublicLoop This port connects in a public configuration.
Generic This port connection type is a generic fabric port.
ExtenderFabric This port connection type is an extender fabric port.
FPort This port connection type is a fabric port.
EPort This port connection type is an extender fabric port.
TEPort This port connection type is an trunking extender fabric port.
NPPort This port connection type is a proxy N port for N-Port virtualization.
GPort This port connection type is a generic fabric port.
NLPort This port connects in a node loop configuration.
FLPort This port connects in a fabric loop configuration.
EXPort This port connection type is an external fabric port.
UPort This port connection type is unassigned.
DPort This port connection type is a diagnostic port.

FunctionMaxBandwidth (array)

Member of Port.v1_5_0.Port FunctionMaxBandwidth is an array containing elements of:

FunctionMaxBandwidth[{item}].AllocationPercent Member of Port.v1_5_0.Port
Description The maximum bandwidth allocation percentage allocated to the corresponding network device function instance.
Type integer or null
Read Only False

FunctionMaxBandwidth[{item}].NetworkDeviceFunction The link to the network device function associated with this bandwidth setting of this network port. NetworkDeviceFunction is a link ("@odata.id": URI) to another resource.

FunctionMinBandwidth (array)

Member of Port.v1_5_0.Port FunctionMinBandwidth is an array containing elements of:

FunctionMinBandwidth[{item}].AllocationPercent Member of Port.v1_5_0.Port
Description The minimum bandwidth allocation percentage allocated to the corresponding network device function instance.
Type integer or null
Read Only False

FunctionMinBandwidth[{item}].NetworkDeviceFunction The link to the network device function associated with this bandwidth setting of this network port. NetworkDeviceFunction is a link ("@odata.id": URI) to another resource.

InterfaceEnabled

Member of Port.v1_5_0.Port
Description An indication of whether the interface is enabled.
Type boolean or null
Read Only False

LinkConfiguration (array)

Member of Port.v1_5_0.Port LinkConfiguration is an array containing elements of:

LinkConfiguration[{item}].AutoSpeedNegotiationCapable Member of Port.v1_5_0.Port
Description An indication of whether the port is capable of autonegotiating speed.
Type boolean or null
Read Only True

LinkConfiguration[{item}].AutoSpeedNegotiationEnabled Member of Port.v1_5_0.Port
Description Controls whether this port is configured to enable autonegotiating speed.
Type boolean or null
Read Only False

LinkConfiguration[{item}].CapableLinkSpeedGbps (array) Member of Port.v1_5_0.Port CapableLinkSpeedGbps is an array containing elements of:
Type number or null
Read Only True

LinkConfiguration[{item}].ConfiguredNetworkLinks (array) Member of Port.v1_5_0.Port ConfiguredNetworkLinks is an array containing elements of:

ConfiguredNetworkLinks[{item}].ConfiguredLinkSpeedGbps Member of Port.v1_5_0.Port
Description The link speed per lane this port is configured to use for autonegotiation.
Type number or null
Read Only False

ConfiguredNetworkLinks[{item}].ConfiguredWidth Member of Port.v1_5_0.Port
Description The link width this port is configured to use for autonegotiation in conjunction with the link speed.
Type integer or null
Read Only False

LinkNetworkTechnology

Member of Port.v1_5_0.Port
Description The link network technology capabilities of this port.
Type string
Read Only True

The following are the supported values:

Value Description
Ethernet The port is capable of connecting to an Ethernet network.
InfiniBand The port is capable of connecting to an InfiniBand network.
FibreChannel The port is capable of connecting to a Fibre Channel network.
GenZ The port is capable of connecting to a Gen-Z fabric.

LinkState

Member of Port.v1_5_0.Port
Description The desired link state for this interface.
Type string
Read Only False

The following are the supported values:

Value Description
Enabled This link is enabled.
Disabled This link is disabled.

LinkStatus

Member of Port.v1_5_0.Port
Description The desired link status for this interface.
Type string
Read Only True

The following are the supported values:

Value Description
LinkUp This link on this interface is up.
Starting This link on this interface is starting. A physical link has been established, but the port is not able to transfer data.
Training This physical link on this interface is training.
LinkDown The link on this interface is down.
NoLink No physical link detected on this interface.

LinkTransitionIndicator

Member of Port.v1_5_0.Port
Description The number of link state transitions for this interface.
Type integer
Read Only False

Location

Location.PartLocation Location.PartLocation.LocationOrdinalValue Member of Port.v1_5_0.Port
Description The number that represents the location of the part. If LocationType is slot and this unit is in slot 2, the LocationOrdinalValue is 2.
Type integer or null
Read Only True

Location.PartLocation.LocationType Member of Port.v1_5_0.Port
Description The location types for PartLocation.
Type string or null
Read Only True

The following are the supported values:

Value Description
Null A value is temporarily unavailable
Slot The slot as the type of location.
Bay The bay as the type of location.
Connector The connector as the type of location.
Socket The socket as the type of location.

Location.PartLocation.Orientation Member of Port.v1_5_0.Port
Description The orientation for the ordering of the part location ordinal value.
Type string or null
Read Only True

The following are the supported values:

Value Description
Null A value is temporarily unavailable
FrontToBack The ordering for LocationOrdinalValue is front to back.
BackToFront The ordering for the LocationOrdinalValue is back to front.
TopToBottom The ordering for the LocationOrdinalValue is top to bottom.
BottomToTop The ordering for LocationOrdinalValue is bottom to top.
LeftToRight The ordering for the LocationOrdinalValue is left to right.
RightToLeft The ordering for the LocationOrdinalValue is right to left.

Location.PartLocation.Reference Member of Port.v1_5_0.Port
Description The reference area for the location of the part.
Type string or null
Read Only True

The following are the supported values:

Value Description
Null A value is temporarily unavailable
Top The part is in the top of the unit.
Bottom The part is in the bottom of the unit.
Front The part is in the front of the unit.
Rear The part is in the rear of the unit.
Left The part is on the left side of of the unit.
Right The part is on the right side of the unit.
Middle The part is in the middle of the unit.

Location.PartLocation.ServiceLabel Member of Port.v1_5_0.Port
Description The label of the part location, such as a silk-screened name or a printed label.
Type string or null
Read Only True

Location.Placement Location.Placement.AdditionalInfo Member of Port.v1_5_0.Port
Description Area designation or other additional info.
Type string or null
Read Only False

Location.Placement.Rack Member of Port.v1_5_0.Port
Description The name of a rack location within a row.
Type string or null
Read Only False

Location.Placement.RackOffset Member of Port.v1_5_0.Port
Description The vertical location of the item, in terms of RackOffsetUnits.
Type integer or null
Read Only False

Location.Placement.RackOffsetUnits Member of Port.v1_5_0.Port
Description The type of rack unit in use.
Type string or null
Read Only False

The following are the supported values:

Value Description
Null A value is temporarily unavailable
OpenU A rack unit that is equal to 48 mm (1.89 in).
EIA_310 A rack unit that is equal to 1.75 in (44.45 mm).

Location.Placement.Row Member of Port.v1_5_0.Port
Description The name of the row.
Type string or null
Read Only False

LocationIndicatorActive

Member of Port.v1_5_0.Port
Description An indicator allowing an operator to physically locate this resource.
Type boolean or null
Read Only False

MaxFrameSize

Member of Port.v1_5_0.Port
Description The maximum frame size supported by the port.
Type integer or null
Read Only True

MaxSpeedGbps

Member of Port.v1_5_0.Port
Description The maximum speed of this port as currently configured.
Type number or null
Read Only True

Oem.Hpe.AutoNegotiationCapable

Member of Port.v1_5_0.Port
Description Indicates the ability of this network port to autonegotiate link speed.
Type boolean or null
Read Only True
Added iLO 5 1.20

Member of Port.v1_5_0.Port ConfiguredNetworkLinks is an array containing elements of:

ConfiguredNetworkLinks[{item}].ConfiguredLinkSpeedGbps Member of Port.v1_5_0.Port
Description The link speed per lane this port is configured to use for autonegotiation.
Type integer or null
Read Only False

ConfiguredNetworkLinks[{item}].ConfiguredWidth Member of Port.v1_5_0.Port
Description The number of lanes this port is configured to use for autonegotiation. If this property is omitted, the lane count shall default to one.
Type integer or null
Read Only False

Oem.Hpe.Evb

Edge Virtual Bridging (EVB) information for this port. Evb is a link ("@odata.id": URI) to another resource.

Oem.Hpe.EvbData

Oem.Hpe.EvbData.Receiving Oem.Hpe.EvbData.Receiving.CdcpActive Member of Port.v1_5_0.Port
Description True if a currently active IEEE 802.1Qbg CDCP TLV has been received from the link partner.
Type boolean or null
Read Only True

Oem.Hpe.EvbData.Receiving.ChannelActive Member of Port.v1_5_0.Port
Description A currently unexpired HPE Channel Link Control or HPE Channel Description TLV has been received from the link partner.
Type boolean or null
Read Only True

Oem.Hpe.EvbData.Receiving.ChannelDescriptionLocalSequenceNumber Member of Port.v1_5_0.Port
Description The link partner’s HPE Channel Description sequence number that was last successfully received and processed.
Type integer or null
Read Only True

Oem.Hpe.EvbData.Receiving.ChannelDescriptionRemoteSequenceNumber Member of Port.v1_5_0.Port
Description The last HPE Channel Decsription sequence number sent on this link that was successfully received and processed by the link partner.
Type integer or null
Read Only True

Oem.Hpe.EvbData.Receiving.ChannelDescriptionSubtype Member of Port.v1_5_0.Port
Description The header subtype field of the last received HPE Channel Description TLV.
Type integer or null
Read Only True

Oem.Hpe.EvbData.Receiving.ChannelLinkControlLocalSequenceNumber Member of Port.v1_5_0.Port
Description The link partner’s HPE Channel Link Control sequence number that was last successfully received and processed.
Type integer or null
Read Only True

Oem.Hpe.EvbData.Receiving.ChannelLinkControlMCEnable Member of Port.v1_5_0.Port
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.
Type boolean or null
Read Only True

Oem.Hpe.EvbData.Receiving.ChannelLinkControlRemoteSequenceNumber Member of Port.v1_5_0.Port
Description The last HPE Channel Link control sequence number sent on this link that was successfully received and processed by the link partner.
Type integer or null
Read Only True

Oem.Hpe.EvbData.Receiving.ChannelLinkControlSubtype Member of Port.v1_5_0.Port
Description The header subtype field of the last received HPE Channel Link Control TLV.
Type integer or null
Read Only True

Oem.Hpe.EvbData.Receiving.Role Member of Port.v1_5_0.Port
Description The link partner’s IEEE 802.1Qbg operating role.
Type string or null
Read Only True

The following are the supported values:

Value Description
Null A value is temporarily unavailable
bridge Indicates the link partner is operating as a Bridge.
station Indicates the link partner is operating as a Station.

Oem.Hpe.EvbData.Receiving.SChannelAssignments (array) Member of Port.v1_5_0.Port SChannelAssignments is an array containing elements of:

SChannelAssignments[{item}].Scid Member of Port.v1_5_0.Port
Description SCID value for this S-Channel identifier pairreceived from the link partner on this port.
Type integer or null
Read Only True

SChannelAssignments[{item}].Svid Member of Port.v1_5_0.Port
Description SVID assignment value for this S-Channel identifier pair received from the link partner on this port. When 0 it indicates an assignment request is in progress.
Type integer or null
Read Only True

Oem.Hpe.EvbData.Receiving.SChannelMaxCount Member of Port.v1_5_0.Port
Description Indicates the number of S-Channels the link partner can support on this physical link.
Type integer or null
Read Only True

Oem.Hpe.EvbData.Receiving.SChannelsSupported Member of Port.v1_5_0.Port
Description When true this link supports S-Channels.
Type boolean or null
Read Only True

Oem.Hpe.EvbData.Receiving.VirtualLinkStatusVector Member of Port.v1_5_0.Port
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).
Type string or null
Read Only True

Oem.Hpe.EvbData.Transmitting Oem.Hpe.EvbData.Transmitting.ChannelDescriptionData (array) Member of Port.v1_5_0.Port ChannelDescriptionData is an array containing elements of:

ChannelDescriptionData[{item}].Descriptor0BandwidthCirMbps Member of Port.v1_5_0.Port
Description The bandwidth Commited Information Rate (CIR) for this S-Channel, in Mbps.
Type integer or null
Read Only True

ChannelDescriptionData[{item}].Descriptor0BandwidthPirMbps Member of Port.v1_5_0.Port
Description The bandwidth Peak Information Rate (PIR) for this S-Channel, in Mbps.
Type integer or null
Read Only True

ChannelDescriptionData[{item}].Descriptor0ChannelTerminationType Member of Port.v1_5_0.Port
Description Indicates the termination provided for this S-Channel.
Type string or null
Read Only True

The following are the supported values:

Value Description
Null A value is temporarily unavailable
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.

ChannelDescriptionData[{item}].Descriptor0EthernetSupport Member of Port.v1_5_0.Port
Description When true, this S-Channel supports Ethernet.
Type boolean or null
Read Only True

ChannelDescriptionData[{item}].Descriptor0FCoESupport Member of Port.v1_5_0.Port
Description When true, this S-Channel supports Fibre Channel over Ethernet (FCoE).
Type boolean or null
Read Only True

ChannelDescriptionData[{item}].Descriptor0PcpSupport Member of Port.v1_5_0.Port
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).
Type string or null
Read Only True

ChannelDescriptionData[{item}].Descriptor0RoCEESupport Member of Port.v1_5_0.Port
Description When true, this S-Channel supports RDMA over Converged Enhanced Ethernet (RoCEE).
Type boolean or null
Read Only True

ChannelDescriptionData[{item}].Descriptor0Scid Member of Port.v1_5_0.Port
Description The S-Channel identifier for this Descriptor0 instance.
Type integer or null
Read Only True

ChannelDescriptionData[{item}].Descriptor0iSCSISupport Member of Port.v1_5_0.Port
Description When true, this S-Channel supports Internet SCSI (iSCSI).
Type boolean or null
Read Only True

ChannelDescriptionData[{item}].Descriptor1ConnectionID Member of Port.v1_5_0.Port
Description A unique S-Channel identifer in UUID format.
Type string or null
Read Only True

ChannelDescriptionData[{item}].Descriptor1Scid Member of Port.v1_5_0.Port
Description The S-Channel identifier for this Descriptor1 instance.
Type integer or null
Read Only True

Oem.Hpe.EvbData.Transmitting.ChannelDescriptionLocalSequenceNumber Member of Port.v1_5_0.Port
Description This station’s channel discovery local sequence number which will be transmitted to the link partner on this port.
Type integer or null
Read Only True

Oem.Hpe.EvbData.Transmitting.ChannelDescriptionRemoteSequenceNumber Member of Port.v1_5_0.Port
Description The link partner’s channel discovery local sequence number that was last successfully received and processed.
Type integer or null
Read Only True

Oem.Hpe.EvbData.Transmitting.ChannelDescriptorCount Member of Port.v1_5_0.Port
Description The number of channel descriptor pairs being transmitted to the link partner on this port.
Type integer or null
Read Only True

Oem.Hpe.EvbData.Transmitting.ChannelLinkControlLocalSequenceNumber Member of Port.v1_5_0.Port
Description This station’s channel link control local sequence number which will be transmitted to the link partner on this port.
Type integer or null
Read Only True

Oem.Hpe.EvbData.Transmitting.ChannelLinkControlMCEnable Member of Port.v1_5_0.Port
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.
Type boolean or null
Read Only True

Oem.Hpe.EvbData.Transmitting.ChannelLinkControlRemoteSequenceNumber Member of Port.v1_5_0.Port
Description The link partner’s channel link control local sequence number that was last successfully received and processed.
Type integer or null
Read Only True

Oem.Hpe.EvbData.Transmitting.Role Member of Port.v1_5_0.Port
Description This port’s IEEE 802.1Qbg role being advertised on the link.
Type string or null
Read Only True

The following are the supported values:

Value Description
Null A value is temporarily unavailable
bridge Indicates this link is operating locally as a Bridge.
station Indicates this link is operating locally as a Station.

Oem.Hpe.EvbData.Transmitting.SChannelAssignments (array) Member of Port.v1_5_0.Port SChannelAssignments is an array containing elements of:

SChannelAssignments[{item}].Scid Member of Port.v1_5_0.Port
Description SCID value for this S-Channel identifier pair being transmitted to the link partner on this port.
Type integer or null
Read Only True

SChannelAssignments[{item}].Svid Member of Port.v1_5_0.Port
Description SVID assignment value for this 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.
Type integer or null
Read Only True

Oem.Hpe.EvbData.Transmitting.SChannelMaxCount Member of Port.v1_5_0.Port
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.
Type integer or null
Read Only True

Oem.Hpe.EvbData.Transmitting.SChannelsSupported Member of Port.v1_5_0.Port
Description When true, indicates that this physical link has S-Channel capability.
Type boolean or null
Read Only True

Oem.Hpe.EvbData.Transmitting.VirtualLinkStatusVector Member of Port.v1_5_0.Port
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).
Type string or null
Read Only True

Oem.Hpe.Lldp

Link-Layer Discovery Protocol (LLDP) information for this port. Lldp is a link ("@odata.id": URI) to another resource.

Oem.Hpe.LldpData

Oem.Hpe.LldpData.Receiving Oem.Hpe.LldpData.Receiving.ChassisID Member of Port.v1_5_0.Port
Description The LLDP chassis ID received from the link partner.
Type string or null
Read Only True

Oem.Hpe.LldpData.Receiving.ChassisIDSubtype Member of Port.v1_5_0.Port
Description The IEEE 802.1AB-2009 chassis ID subtype received from the link partner.
Type string or null
Read Only True

The following are the supported values:

Value Description
Null A value is temporarily unavailable
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.
MacAddr 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.
AgentId Agent circuit ID, based on the agent-local identifier of the circuit as defined in RFC 3046.
LocalAssign Locally assigned, based on a alpha-numeric value locally assigned.

Oem.Hpe.LldpData.Receiving.Dcb Oem.Hpe.LldpData.Receiving.Dcb.ApplicationPriorityReceived Member of Port.v1_5_0.Port
Description True when an unexpired Data Center Bridging (DCB) Application Priority Table TLV has been received.
Type boolean or null
Read Only True

Oem.Hpe.LldpData.Receiving.Dcb.ApplicationPriorityTable (array) Member of Port.v1_5_0.Port ApplicationPriorityTable is an array containing elements of:

ApplicationPriorityTable[{item}].ApplicationPriority Member of Port.v1_5_0.Port
Description Indicates which priority level is assigned for this application protocol.
Type integer or null
Read Only True

ApplicationPriorityTable[{item}].ApplicationProtocol Member of Port.v1_5_0.Port
Description An integer value indicating application protocol identity, of the type described by DCBApplicationSelect.
Type integer or null
Read Only True

ApplicationPriorityTable[{item}].ApplicationSelect Member of Port.v1_5_0.Port
Description Indentifies the type of the DCBApplicationProtocol property.
Type string or null
Read Only True

The following are the supported values:

Value Description
Null A value is temporarily unavailable
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.

Oem.Hpe.LldpData.Receiving.Dcb.Ets Oem.Hpe.LldpData.Receiving.Dcb.Ets.BandwidthAssignmentTable (array) Member of Port.v1_5_0.Port BandwidthAssignmentTable is an array containing elements of:
Description One entry in the DCB ETS Traffic Class (TC) Bandwidth Assignment Table.
Type integer or null
Read Only True

Oem.Hpe.LldpData.Receiving.Dcb.Ets.CreditBasedShaper Member of Port.v1_5_0.Port
Description True if the link partner supports the Credit-based Shaper (CBS) transmmission selection algortithm.
Type boolean or null
Read Only True

Oem.Hpe.LldpData.Receiving.Dcb.Ets.MaximumTrafficClassCount Member of Port.v1_5_0.Port
Description The maximum number of traffic classes supported by the link partner.
Type integer or null
Read Only True

Oem.Hpe.LldpData.Receiving.Dcb.Ets.PriorityAssignmentTable (array) Member of Port.v1_5_0.Port PriorityAssignmentTable is an array containing elements of:
Description One entry in the DCB ETS Priority Assignment Table indicating this priority’s Traffic Class assignment.
Type integer or null
Read Only True

Oem.Hpe.LldpData.Receiving.Dcb.Ets.TlvReceived Member of Port.v1_5_0.Port
Description True when an unexpired DCB Enhanced Transmission Selection (ETS) TLV has been received.
Type boolean or null
Read Only True

Oem.Hpe.LldpData.Receiving.Dcb.Ets.TrafficSelectionAlgorithmTable (array) Member of Port.v1_5_0.Port TrafficSelectionAlgorithmTable is an array containing elements of:
Description An assignment of a Traffic Selection Algorithm (TSA) to a traffic class.
Type string or null
Read Only True

The following are the supported values:

Value Description
Null A value is temporarily unavailable
strict Strict priority algorithm.
CBS Credit-Based Shaper algorithm.
ETS Enhanced Traffic Selection algorithm.
vendor Vendor specific algorithm for use with DCB.

Oem.Hpe.LldpData.Receiving.Dcb.Ets.Willing Member of Port.v1_5_0.Port
Description True if the link partner is willing to accept ETS configurations.
Type boolean or null
Read Only True

Oem.Hpe.LldpData.Receiving.Dcb.LocalEqualRemote Member of Port.v1_5_0.Port
Description True when the transmitted and received contents match for both DCB ETS and PFC TLVs.
Type boolean or null
Read Only True

Oem.Hpe.LldpData.Receiving.Dcb.Pfc Oem.Hpe.LldpData.Receiving.Dcb.Pfc.EnabledTrafficClasses Member of Port.v1_5_0.Port
Description A bit string indicating which priority levels have PFC enabled, 1=enabled. PFC levels are bit ordered from 7 (first) to 0 (last).
Type string or null
Read Only True

Oem.Hpe.LldpData.Receiving.Dcb.Pfc.MacSecurityBypassCapability Member of Port.v1_5_0.Port
Description True when the link partner has the ability to bypass MAC security in order to improve PFC responsiveness.
Type boolean or null
Read Only True

Oem.Hpe.LldpData.Receiving.Dcb.Pfc.MaximumTrafficClassCount Member of Port.v1_5_0.Port
Description Indicates the maximum number of traffic classes that the link partner can simultaneously support.
Type integer or null
Read Only True

Oem.Hpe.LldpData.Receiving.Dcb.Pfc.TlvReceived Member of Port.v1_5_0.Port
Description True when an unexpired DCB Priority Flow Control (PFC) TLV has been received.
Type boolean or null
Read Only True

Oem.Hpe.LldpData.Receiving.Dcb.Pfc.Willing Member of Port.v1_5_0.Port
Description True if the LLDP link partner is willing to accept PFC configurations.
Type boolean or null
Read Only True

Oem.Hpe.LldpData.Receiving.Dcb.Version Member of Port.v1_5_0.Port
Description The DCB version supported by the link partner.
Type string or null
Read Only True

The following are the supported values:

Value Description
Null A value is temporarily unavailable
unknown Unknown
CEE Converged Enhanced Ethernet
IEEE IEEE 802.1Q

Oem.Hpe.LldpData.Receiving.ManagementAddress Member of Port.v1_5_0.Port
Description The management address received from the link partner.
Type string or null
Read Only True

Oem.Hpe.LldpData.Receiving.ManagementAddressOID Member of Port.v1_5_0.Port
Description An object identifier for the hardware or protocol entity associated with the management address.
Type string or null
Read Only True

Oem.Hpe.LldpData.Receiving.ManagementAddressReceived Member of Port.v1_5_0.Port
Description True when a currently unexpired management address TLV has been received from the link partner.
Type boolean or null
Read Only True

Oem.Hpe.LldpData.Receiving.ManagementAddressType Member of Port.v1_5_0.Port
Description The type of management address received from the link partner.
Type string or null
Read Only True

The following are the supported values:

Value Description
Null A value is temporarily unavailable
IPv4 Type 1 (IP version 4).
IPv6 Type 2 (IP version 6).
all802 Type 6 (All 802 media plus Ethernet ‘canonical format’).

Oem.Hpe.LldpData.Receiving.ManagementCvlanID Member of Port.v1_5_0.Port
Description The management CVLAN ID received from the link partner.
Type integer or null
Read Only True

Oem.Hpe.LldpData.Receiving.ManagementIFNumSubtype Member of Port.v1_5_0.Port
Description Management interface number subtype.
Type string or null
Read Only True

The following are the supported values:

Value Description
Null A value is temporarily unavailable
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.

Oem.Hpe.LldpData.Receiving.ManagementIFNumber Member of Port.v1_5_0.Port
Description Management interface number received from the link partner represented as a colon delimited string of hexadecimal octets.
Type string or null
Read Only True

Oem.Hpe.LldpData.Receiving.ManagementVlanReceived Member of Port.v1_5_0.Port
Description True when a currently unexpired management address VID TLV has been received from the link partner.
Type boolean or null
Read Only True

Oem.Hpe.LldpData.Receiving.NearestBridgeTtlExpired Member of Port.v1_5_0.Port
Description True when the LLDP PDU most recently received from the link partner has expired.
Type boolean or null
Read Only True

Oem.Hpe.LldpData.Receiving.PortDescription Member of Port.v1_5_0.Port
Description The remote link partner’s port description.
Type string or null
Read Only True

Oem.Hpe.LldpData.Receiving.PortID Member of Port.v1_5_0.Port
Description A colon delimited string of hexadecimal octets received from the link partner identifying its port.
Type string or null
Read Only True

Oem.Hpe.LldpData.Receiving.PortIDSubtype Member of Port.v1_5_0.Port
Description The port ID subtype enumeration from IEEE 802.1AB-2009 Table 8-3, which indicates the format for the PortID property.
Type string or null
Read Only True

The following are the supported values:

Value Description
Null A value is temporarily unavailable
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.
MacAddr 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.
AgentId Agent circuit ID, based on the agent-local identifier of the circuit as defined in RFC 3046.
LocalAssign Locally assigned, based on a alpha-numeric value locally assigned.

Oem.Hpe.LldpData.Receiving.SystemDescription Member of Port.v1_5_0.Port
Description The system description received from the link partner.
Type string or null
Read Only True

Oem.Hpe.LldpData.Transmitting Oem.Hpe.LldpData.Transmitting.ChassisID Member of Port.v1_5_0.Port
Description The Link Layer Data Protocol (LLDP) chassis ID being transmitted on this link.
Type string or null
Read Only True

Oem.Hpe.LldpData.Transmitting.ChassisIDSubtype Member of Port.v1_5_0.Port
Description The IEEE 802.1AB-2009 chassis ID subtype being transmitted on this link.
Type string or null
Read Only True

The following are the supported values:

Value Description
Null A value is temporarily unavailable
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.
MacAddr 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.
AgentId Agent circuit ID, based on the agent-local identifier of the circuit as defined in RFC 3046.
LocalAssign Locally assigned, based on a alpha-numeric value locally assigned.

Oem.Hpe.LldpData.Transmitting.ManagementAddresses (array) Member of Port.v1_5_0.Port ManagementAddresses is an array containing elements of:

ManagementAddresses[{item}].ManagementIPAddress Member of Port.v1_5_0.Port
Description A management address.
Type string or null
Read Only True

ManagementAddresses[{item}].ManagementIPAddressType Member of Port.v1_5_0.Port
Description The IANA type of this management address.
Type string or null
Read Only True

The following are the supported values:

Value Description
Null A value is temporarily unavailable
IPv4 Type 1 (IP version 4).
IPv6 Type 2 (IP version 6).
all802 Type 6 (All 802 media plus Ethernet ‘canonical format’).

Oem.Hpe.LldpData.Transmitting.ManagementCvlanID Member of Port.v1_5_0.Port
Description The management CVLAN ID being transmitted on this link.
Type integer or null
Read Only True

Oem.Hpe.LldpData.Transmitting.ManagementCvlanIDTransmitted Member of Port.v1_5_0.Port
Description When true, indicates that a management CVLAN ID is being transmitted on this link.
Type boolean or null
Read Only True

Oem.Hpe.LldpData.Transmitting.PortDescription Member of Port.v1_5_0.Port
Description An alphanumeric string describing this link.
Type string or null
Read Only True

Oem.Hpe.LldpData.Transmitting.PortID Member of Port.v1_5_0.Port
Description A colon delimited string of hexadecimal octets identifying this port.
Type string or null
Read Only True

Oem.Hpe.LldpData.Transmitting.PortIDSubtype Member of Port.v1_5_0.Port
Description The port ID subtype from IEEE 802.1AB-2009 Table 8-3.
Type string or null
Read Only True

The following are the supported values:

Value Description
Null A value is temporarily unavailable
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.
MacAddr 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.
AgentId Agent circuit ID, based on the agent-local identifier of the circuit as defined in RFC 3046.
LocalAssign Locally assigned, based on a alpha-numeric value locally assigned.

Oem.Hpe.LldpData.Transmitting.SystemDescription Member of Port.v1_5_0.Port
Description A textual description of this system.
Type string or null
Read Only True

Oem.Hpe.PortDiagnosticEnableLocalLoopback

Member of Port.v1_5_0.Port
Description When true, local loopback is active on this port. PortDiagnosticsEnabled must first be true in order to set this property to true.
Type boolean or null
Read Only False
Added iLO 5 1.20

Oem.Hpe.PortDiagnosticEnableRemoteLoopback

Member of Port.v1_5_0.Port
Description When true, remote loopback is active on this port. PortDiagnosticsEnabled must first be true in order to set this property to true.
Type boolean or null
Read Only False
Added iLO 5 1.20

Oem.Hpe.PortDiagnosticLocalLoopbackCapable

Member of Port.v1_5_0.Port
Description When true, the port has local loopback capability.
Type boolean or null
Read Only True
Added iLO 5 1.20

Oem.Hpe.PortDiagnosticRemoteLoopbackCapable

Member of Port.v1_5_0.Port
Description When true, the port has remote loopback capability.
Type boolean or null
Read Only True
Added iLO 5 1.20

Oem.Hpe.PortDiagnosticsEnabled

Member of Port.v1_5_0.Port
Description When true, diagnostic features are enabled on this port.
Type boolean or null
Read Only False
Added iLO 5 1.20

Oem.Hpe.VirtualFunctionAllocations (array)

Member of Port.v1_5_0.Port VirtualFunctionAllocations is an array containing elements of:

VirtualFunctionAllocations[{item}].NetworkDeviceFunction The logical network device function to which this virtual function allocation applies. NetworkDeviceFunction is a link ("@odata.id": URI) to another resource.

VirtualFunctionAllocations[{item}].VirtualFunctionsAllocated Member of Port.v1_5_0.Port
Description The number of virtual functions allocated to this logical network device function instance.
Type number or null
Read Only False

PortId

Member of Port.v1_5_0.Port
Description The label of this port on the physical package for this port.
Type string or null
Read Only True

PortMedium

Member of Port.v1_5_0.Port
Description The physical connection medium for this port.
Type string
Read Only True

The following are the supported values:

Value Description
Electrical This port has an electrical cable connection.
Optical This port has an optical cable connection.

PortProtocol

Member of Port.v1_5_0.Port
Description The protocol being sent over this port.
Type string or null
Read Only True

The following are the supported values:

Value Description
Ethernet Ethernet.
FC Fibre Channel.
FCoE Fibre Channel over Ethernet (FCoE).
GenZ GenZ.
InfiniBand InfiniBand.

PortType

Member of Port.v1_5_0.Port
Description The type of this port.
Type string
Read Only True

The following are the supported values:

Value Description
UpstreamPort This port connects to a host device.
DownstreamPort This port connects to a target device.
InterswitchPort This port connects to another switch.
ManagementPort This port connects to a switch manager.
BidirectionalPort This port connects to any type of device.
UnconfiguredPort This port has not yet been configured.

Settings

Settings.href Member of Port.v1_5_0.Port
Description Reference to the resource the client may PUT/PATCH to in order to change this resource.
Type string
Read Only True

SignalDetected

Member of Port.v1_5_0.Port
Description An indication of whether a signal is detected on this interface.
Type boolean or null
Read Only True

Status

Member of Port.v1_5_0.Port See the Redfish standard schema and specification for information on common Status object.

Width

Member of Port.v1_5_0.Port
Description The number of lanes, phys, or other physical transport links that this port contains.
Type integer or null
Read Only True

Actions

Port.Reset Member of Port.v1_5_0.Port

Parameters:

ResetValue (string)

Reset Port

Value Description
ForceOff Turn off the unit immediately (non-graceful shutdown).
ForceOn Turn on the unit immediately.
ForceRestart Shut down immediately and non-gracefully and restart the system.
GracefulRestart Shut down gracefully and restart the system.
GracefulShutdown Shut down gracefully and power off.
Nmi Generate a diagnostic interrupt, which is usually an NMI on x86 systems, to stop normal operations, complete diagnostic actions, and, typically, halt the system.
On Turn on the unit.
PowerCycle Power cycle the unit. Behaves like a full power removal, followed by a power restore to the resource.
PushPowerButton Simulate the pressing of the physical power button on this unit.

target (string)

Link to invoke action

HpeNetworkPort.DiagnosticsReset Member of Port.v1_5_0.Port There are no parameters for this action.

NetworkPort.DiagnosticsReset Member of Port.v1_5_0.Port NOTE: Deprecated, will be removed in a future release. Replaced by HpeNetworkPort.DiagnosticsReset

There are no parameters for this action.

PortCollection.PortCollection

@odata.type: "#PortCollection.PortCollection"

A Collection of NetworkPort resource instances.

Resource Instances

Uri HTTP Allow
/redfish/v1/chassis/{item}/networkadapters/{item}/ports GET
/redfish/v1/systems/{item}/networkinterfaces/{item}/ports GET POST PATCH
Link Name Destination type
Members[] Port

Members (array)

Member of PortCollection.PortCollection Members is an array containing elements of:

Members[{item}].@odata.id Member of PortCollection.PortCollection
Type string
Read Only True
Format uri-reference

Members@odata.count

Member of PortCollection.PortCollection
Description The total number of collection members.
Type integer
Read Only True

Power.v1_3_0.Power

@odata.type: "#Power.v1_3_0.Power"

The Power resource describes the Power Metrics. It represents the properties for Power Consumption and Power Limiting.

Resource Instances

Uri HTTP Allow
/redfish/v1/chassis/{item}/power GET PATCH
Link Name Destination type
Oem/Hpe/Links/FastPowerMeter HpePowerMeter
Oem/Hpe/Links/FederatedGroupCapping HpeiLOFederatedGroupCapping
Oem/Hpe/Links/PowerMeter HpePowerMeter
Redundancy[]/RedundancySet[] Power

Oem.Hpe.BatteryBackedUnits (array)

Member of Power.v1_3_0.Power BatteryBackedUnits is an array containing elements of:

BatteryBackedUnits[{item}].BBUStatus BatteryBackedUnits[{item}].BBUStatus.Health Member of Power.v1_3_0.Power
Description This represents the health state of this resource in the absence of its dependent resources.
Type string or null
Read Only True

The following are the supported values:

Value Description
Null A value is temporarily unavailable
OK Normal
Warning A condition exists that requires attention
Critical A critical condition exists that requires immediate attention

BatteryBackedUnits[{item}].BBUStatus.HealthRollup Member of Power.v1_3_0.Power
Description This represents the overall health state from the view of this resource.
Type string or null
Read Only True

The following are the supported values:

Value Description
Null A value is temporarily unavailable
OK Normal
Warning A condition exists that requires attention
Critical A critical condition exists that requires immediate attention

BatteryBackedUnits[{item}].BBUStatus.State Member of Power.v1_3_0.Power
Description This indicates the known state of the resource, such as if it is enabled.
Type string or null
Read Only True

The following are the supported values:

Value Description
Null A value is temporarily unavailable
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.

BatteryBackedUnits[{item}].BayNumber Member of Power.v1_3_0.Power
Description Bay number of the battery backed unit.
Type integer
Read Only True

BatteryBackedUnits[{item}].CapacityWatts Member of Power.v1_3_0.Power
Description Total capacity (in Watts) of the battery backed unit.
Type integer
Read Only True

BatteryBackedUnits[{item}].CutOffSetPointmAh Member of Power.v1_3_0.Power
Description Cut off threshold (mAh) where battery backed unit stops supplying power to the server.
Type integer
Read Only True

BatteryBackedUnits[{item}].FirmwareVersion Member of Power.v1_3_0.Power
Description Firmware version of the battery backed unit.
Type string
Read Only True

BatteryBackedUnits[{item}].PercentCharge Member of Power.v1_3_0.Power
Description Percentage charge remaining for the battery backed unit.
Type integer
Read Only True

BatteryBackedUnits[{item}].RemainingCapacitymAh Member of Power.v1_3_0.Power
Description Remaining capacity (mAh) of the battery backed unit.
Type integer
Read Only True

BatteryBackedUnits[{item}].SerialNumber Member of Power.v1_3_0.Power
Description Serial number of the battery backed unit.
Type string
Read Only True

BatteryBackedUnits[{item}].TimeToCutOffSeconds Member of Power.v1_3_0.Power
Description Run time (in seconds) available with the battery backed unit until cut off. This is detected only when battery is charging or discharging, otherwise set to 0.
Type integer
Read Only True

BatteryBackedUnits[{item}].TimeToFullChargeMinutes Member of Power.v1_3_0.Power
Description Time required (in minutes) to fully charge the battery backed unit. This is detected only when battery is charging or discharging, otherwise set to 0.
Type integer
Read Only True

BatteryBackedUnits[{item}].UsableCapacitymAh Member of Power.v1_3_0.Power
Description Usable capacity (mAh) of the battery backed unit.
Type integer
Read Only True

Oem.Hpe.BbuPowerSupply

Member of Power.v1_3_0.Power
Description Battery Backup Unit Power Supply action determines what will occur when a server is running on battery power.
Type string
Read Only False
Added iLO 5 1.10

The following are the supported values:

Value Description
DoNothing No action will be taken when a server switches to battery power.
MomentaryPowerButtonPress Momentary virtual power button press which should shutdown host operating system when pressed.
HostShutdown Shutdown message sent to host operating system with installed management software to initiate a shutdown.

Oem.Hpe.BrownoutRecoveryEnabled

Member of Power.v1_3_0.Power
Description When a brownout condition occurs in the server, this setting will determine if the server should recover from it.
Type boolean or null
Read Only False
Added iLO 5 1.20

Oem.Hpe.FanPowerRequirement

Member of Power.v1_3_0.Power
Description Cooling challenge bucket definition.
Type integer
Read Only True

Oem.Hpe.FanPowerRequirementErrors

Member of Power.v1_3_0.Power
Description Cooling challenge errors.
Type string
Read Only True

Oem.Hpe.FanPowerRequirementVersion

Member of Power.v1_3_0.Power
Description Version of the Synergy cooling table bucket definitions.
Type integer
Read Only True

Oem.Hpe.HasCpuPowerMetering

Member of Power.v1_3_0.Power
Description Indicates if the system has CPU power metering.
Type boolean
Read Only True
Added iLO 5 1.40

Oem.Hpe.HasDimmPowerMetering

Member of Power.v1_3_0.Power
Description Indicates if the system has DIMM power metering.
Type boolean
Read Only True
Added iLO 5 1.40

Oem.Hpe.HasGpuPowerMetering

Member of Power.v1_3_0.Power
Description Indicates if the system has GPU power metering.
Type boolean
Read Only True
Added iLO 5 1.40

Oem.Hpe.HasPowerMetering

Member of Power.v1_3_0.Power
Description Indicates if the system has power metering.
Type boolean
Read Only True
Added iLO 5 1.10

Oem.Hpe.HighEfficiencyMode

Member of Power.v1_3_0.Power
Description The redundant power supply mode that will be used when redundant power supplies are configured.
Type string or null
Read Only True
Added iLO 5 1.15

The following are the supported values:

Value
Null
Auto
Balanced
Even
Odd

Oem.Hpe.MinimumSafelyAchievableCap

Member of Power.v1_3_0.Power
Description Minimum Safely Achievable Cap is the lowest cap value that is safe for a group power manager to apply to a particular server. It can either be identical to or slightly greater than the 0 percent cap value calculated during ROM power burn.
Type integer or null
Read Only True
Added iLO 5 1.10

Oem.Hpe.MinimumSafelyAchievableCapValid

Member of Power.v1_3_0.Power
Description Indicates if the msac is valid. msac is valid only if this is true.
Type boolean
Read Only True

Oem.Hpe.SNMPPowerThresholdAlert

Oem.Hpe.SNMPPowerThresholdAlert.DurationInMin Member of Power.v1_3_0.Power
Description Sets the length of time, in minutes, that power consumption must remain above the warning threshold before an SNMP alert is triggered. The maximum duration is 240 minutes, and the duration must be a multiple of 5.
Type integer
Read Only False
Added iLO 5 1.10

Oem.Hpe.SNMPPowerThresholdAlert.ThresholdWatts Member of Power.v1_3_0.Power
Description Sets the power consumption threshold (watts). If power consumption exceeds this value for the specified time duration, an SNMP alert is triggered.
Type integer
Read Only False
Added iLO 5 1.10

Oem.Hpe.SNMPPowerThresholdAlert.Trigger Member of Power.v1_3_0.Power
Description Trigger determines whether alerts are based on peak power consumption, average power consumption, or if they are disabled. Trigger property can only be enabled if the ThresholdWatts and DurationInMin values are specified/configured.
Type string
Read Only False
Added iLO 5 1.10

The following are the supported values:

Value
Disabled
AveragePowerConsumption
PeakPowerConsumption

PowerControl (array)

Member of Power.v1_3_0.Power PowerControl is an array containing elements of:

PowerControl[{item}].@odata.id Member of Power.v1_3_0.Power
Type string
Read Only True
Format uri-reference

PowerControl[{item}].MemberId Member of Power.v1_3_0.Power
Description This is the identifier for the member within the collection.
Type string
Read Only True
Added iLO 5 1.10

PowerControl[{item}].PowerAllocatedWatts Member of Power.v1_3_0.Power
Description The total amount of power that has been allocated (or budegeted)to chassis resources.
Type number or null
Read Only True
Added iLO 5 1.10

PowerControl[{item}].PowerAvailableWatts Member of Power.v1_3_0.Power
Description The amount of power not already budgeted and therefore available for additional allocation. (powerCapacity - powerAllocated). This indicates how much reserve power capacity is left.
Type number or null
Read Only True
Added iLO 5 1.10

PowerControl[{item}].PowerCapacityWatts Member of Power.v1_3_0.Power
Description The total amount of power available to the chassis for allocation. This may the power supply capacity, or power budget assigned to the chassis from an up-stream chassis.
Type number or null
Read Only True
Added iLO 5 1.10

PowerControl[{item}].PowerConsumedWatts Member of Power.v1_3_0.Power
Description The actual power being consumed by the chassis.
Type number or null
Read Only True
Added iLO 5 1.10

PowerControl[{item}].PowerLimit PowerControl[{item}].PowerLimit.CorrectionInMs Member of Power.v1_3_0.Power
Description The time required for the limiting process to reduce power consumption to below the limit.
Type integer or null
Read Only True
Added iLO 5 1.10

PowerControl[{item}].PowerLimit.LimitException Member of Power.v1_3_0.Power
Description The action that is taken if the power cannot be maintained below the LimitInWatts.
Type string
Read Only False
Added iLO 5 1.10

The following are the supported values:

Value Description
NoAction Take no action when the limit is exceeded.
HardPowerOff Turn the power off immediately when the limit is exceeded.
LogEventOnly Log an event when the limit is exceeded, but take no further action.
Oem Take an OEM-defined action.

PowerControl[{item}].PowerLimit.LimitInWatts Member of Power.v1_3_0.Power
Description The Power limit in watts. Set to null to disable power capping.
Type number or null
Read Only False
Added iLO 5 1.10

PowerControl[{item}].PowerMetrics PowerControl[{item}].PowerMetrics.AverageConsumedWatts Member of Power.v1_3_0.Power
Description The average power level over the measurement window (the last IntervalInMin minutes).
Type number or null
Read Only True
Added iLO 5 1.10

PowerControl[{item}].PowerMetrics.IntervalInMin Member of Power.v1_3_0.Power
Description The time interval (or window) in which the PowerMetrics are measured over.
Type integer or null
Read Only True
Added iLO 5 1.10

PowerControl[{item}].PowerMetrics.MaxConsumedWatts Member of Power.v1_3_0.Power
Description The highest power consumption level that has occured over the measurement window (the last IntervalInMin minutes).
Type number or null
Read Only True
Added iLO 5 1.10

PowerControl[{item}].PowerMetrics.MinConsumedWatts Member of Power.v1_3_0.Power
Description The lowest power consumption level over the measurement window (the last IntervalInMin minutes).
Type number or null
Read Only True
Added iLO 5 1.10

PowerControl[{item}].PowerRequestedWatts Member of Power.v1_3_0.Power
Description The potential power that the chassis resources are requesting which may be higher than the current level being consumed since requested power includes budget that the chassis resource wants for future use.
Type number or null
Read Only True
Added iLO 5 1.10

PowerControl[{item}].RelatedItem (array) Member of Power.v1_3_0.Power RelatedItem is an array containing elements of:

RelatedItem[{item}].@odata.id Member of Power.v1_3_0.Power
Type string
Read Only True
Format uri-reference

PowerControl[{item}].Status Member of Power.v1_3_0.Power See the Redfish standard schema and specification for information on common Status object.

PowerSupplies (array)

Member of Power.v1_3_0.Power PowerSupplies is an array containing elements of:

PowerSupplies[{item}].@odata.id Member of Power.v1_3_0.Power
Type string
Read Only True
Format uri-reference

PowerSupplies[{item}].FirmwareVersion Member of Power.v1_3_0.Power
Description The firmware version for this Power Supply
Type string or null
Read Only True
Added iLO 5 1.10

PowerSupplies[{item}].LastPowerOutputWatts Member of Power.v1_3_0.Power
Description The average power output of this Power Supply
Type number or null
Read Only True
Added iLO 5 1.10

PowerSupplies[{item}].LineInputVoltage Member of Power.v1_3_0.Power
Description The line input voltage at which the Power Supply is operating
Type number or null
Read Only True
Added iLO 5 1.10

PowerSupplies[{item}].LineInputVoltageType Member of Power.v1_3_0.Power
Description The line voltage type supported as an input to this Power Supply
Type string or null
Read Only True
Added iLO 5 1.10

The following are the supported values:

Value Description
Null A value is temporarily unavailable
Unknown The power supply line input voltage type cannot be determined.
ACLowLine 100-127V AC input.
ACMidLine 200-240V AC input.
ACHighLine 277V AC input.
DCNeg48V -48V DC input.
HighVoltageDC High Voltage DC input (380V).

PowerSupplies[{item}].Manufacturer Member of Power.v1_3_0.Power
Description This is the manufacturer of this power supply.
Type string or null
Read Only True
Added iLO 5 1.40

PowerSupplies[{item}].MemberId Member of Power.v1_3_0.Power
Description This is the identifier for the member within the collection.
Type string
Read Only True
Added iLO 5 1.10

PowerSupplies[{item}].Model Member of Power.v1_3_0.Power
Description The model number for this Power Supply
Type string or null
Read Only True
Added iLO 5 1.10

PowerSupplies[{item}].Oem.Hpe.AveragePowerOutputWatts Member of Power.v1_3_0.Power
Description The latest observed average power being drawn by the power supply (Watts). This is usually updated every 10 seconds but the period can vary in some circumstances.
Type integer
Read Only True
Added iLO 5 1.10

PowerSupplies[{item}].Oem.Hpe.BayNumber Member of Power.v1_3_0.Power
Description The power supply bay number.
Type integer
Read Only True
Added iLO 5 1.10

PowerSupplies[{item}].Oem.Hpe.HotplugCapable Member of Power.v1_3_0.Power
Description If true, this power supply (and power supply bay) is capable of being hot-plugged.
Type boolean
Read Only True
Added iLO 5 1.10

PowerSupplies[{item}].Oem.Hpe.MaxPowerOutputWatts Member of Power.v1_3_0.Power
Description The latest observed maximum output power being drawn by the power supply (Watts). This is usually updated every 10 seconds but the period can vary in some circumstances.
Type integer
Read Only True
Added iLO 5 1.10

PowerSupplies[{item}].Oem.Hpe.Mismatched Member of Power.v1_3_0.Power
Description If true, this power supply is mismatched with others in the system.
Type boolean
Read Only True
Added iLO 5 1.10

PowerSupplies[{item}].Oem.Hpe.PowerSupplyStatus PowerSupplies[{item}].Oem.Hpe.PowerSupplyStatus.State Member of Power.v1_3_0.Power
Description Indicates the known state of the resource.
Type string or null
Read Only True
Added iLO 5 1.10

The following are the supported values:

Value
Unknown
Ok
Degraded
Failed
OverVoltage
OverCurrent
OverTemperature
ACPowerLost
FanFailure
WarningHighInputVoltage
WarningLowInputVoltage
WarningHighOutputVoltage
WarningLowOutputVoltage
WarningInletTemperature
WarningInternalTemperature
WarningHighAuxiliaryVoltage
WarningLowAuxiliaryVoltage
PowerSupplyMismatch
GoodInStandby

PowerSupplies[{item}].Oem.Hpe.iPDU PowerSupplies[{item}].Oem.Hpe.iPDU.IPAddress Member of Power.v1_3_0.Power
Description The IP address of the iPDU connected to this power supply.
Type string or null
Read Only True
Added iLO 5 1.10

PowerSupplies[{item}].Oem.Hpe.iPDU.MacAddress Member of Power.v1_3_0.Power
Description The Ethernet MAC address of the iPDU connected to this power supply.
Type string or null
Read Only True
Added iLO 5 1.10

PowerSupplies[{item}].Oem.Hpe.iPDU.Model Member of Power.v1_3_0.Power
Description The model number of the iPDU connected to this power supply.
Type string
Read Only True
Added iLO 5 1.10

PowerSupplies[{item}].Oem.Hpe.iPDU.SerialNumber Member of Power.v1_3_0.Power
Description The serial number of the iPDU connected to this power supply.
Type string
Read Only True
Added iLO 5 1.10

PowerSupplies[{item}].Oem.Hpe.iPDU.iPDUStatus PowerSupplies[{item}].Oem.Hpe.iPDU.iPDUStatus.State Member of Power.v1_3_0.Power
Description Indicates the known state of the resource.
Type string or null
Read Only True
Added iLO 5 1.10

The following are the supported values:

Value
Unknown
Ok
Degraded
Failed
OverVoltage
OverCurrent
OverTemperature
ACPowerLost
FanFailure
WarningHighInputVoltage
WarningLowInputVoltage
WarningHighOutputVoltage
WarningLowOutputVoltage
WarningInletTemperature
WarningInternalTemperature
WarningHighAuxiliaryVoltage
WarningLowAuxiliaryVoltage
PowerSupplyMismatch
GoodInStandby

PowerSupplies[{item}].Oem.Hpe.iPDUCapable Member of Power.v1_3_0.Power
Description If true, this power supply is capable of being connected to an iPDUs.
Type boolean
Read Only True
Added iLO 5 1.10

PowerSupplies[{item}].PartNumber Member of Power.v1_3_0.Power
Description The part number for this Power Supply
Type string or null
Read Only True
Added iLO 5 1.10

PowerSupplies[{item}].PowerCapacityWatts Member of Power.v1_3_0.Power
Description The maximum capacity of this Power Supply
Type number or null
Read Only True
Added iLO 5 1.10

PowerSupplies[{item}].PowerSupplyType Member of Power.v1_3_0.Power
Description The Power Supply type (AC or DC)
Type string or null
Read Only True
Added iLO 5 1.10

The following are the supported values:

Value Description
Null A value is temporarily unavailable
Unknown The power supply type cannot be determined
AC Alternating Current (AC) power supply
DC Direct Current (DC) power supply

PowerSupplies[{item}].Redundancy Member of Power.v1_3_0.Power See the Redfish standard schema and specification for information on common Redundancy object.

PowerSupplies[{item}].RelatedItem (array) Member of Power.v1_3_0.Power RelatedItem is an array containing elements of:

RelatedItem[{item}].@odata.id Member of Power.v1_3_0.Power
Type string
Read Only True
Format uri-reference

PowerSupplies[{item}].SerialNumber Member of Power.v1_3_0.Power
Description The serial number for this Power Supply
Type string or null
Read Only True
Added iLO 5 1.10

PowerSupplies[{item}].SparePartNumber Member of Power.v1_3_0.Power
Description The spare part number for this Power Supply
Type string or null
Read Only True
Added iLO 5 1.10

PowerSupplies[{item}].Status Member of Power.v1_3_0.Power See the Redfish standard schema and specification for information on common Status object.

Redundancy

Member of Power.v1_3_0.Power See the Redfish standard schema and specification for information on common Redundancy object.

Status

Member of Power.v1_3_0.Power See the Redfish standard schema and specification for information on common Status object.

Processor.v1_7_2.Processor

@odata.type: "#Processor.v1_7_2.Processor"

The Processor resource describes the Processor resource. It represents the properties of a processor attached to a System.

Resource Instances

Uri HTTP Allow
/redfish/v1/systems/{item}/processors/{item} GET

InstructionSet

Member of Processor.v1_7_2.Processor
Description The instruction set of the processor
Type string
Read Only True
Added iLO 5 1.10

The following are the supported values:

Value Description
x86 x86 32-bit
x86-64 x86 64-bit
IA-64 Intel IA-64
ARM-A32 ARM 32-bit
ARM-A64 ARM 64-bit
MIPS32 MIPS 32-bit
MIPS64 MIPS 64-bit
OEM OEM-defined

Manufacturer

Member of Processor.v1_7_2.Processor
Description The processor manufacturer
Type string or null
Read Only True
Added iLO 5 1.10

MaxSpeedMHz

Member of Processor.v1_7_2.Processor
Description The maximum clock speed of the processor
Type integer or null
Read Only True
Added iLO 5 1.10

Model

Member of Processor.v1_7_2.Processor
Description The product model number of this device
Type string or null
Read Only True
Added iLO 5 1.10

Oem.Hpe.AssetTag

Member of Processor.v1_7_2.Processor
Description The processor asset tag.
Type string or null
Read Only True
Added iLO 5 1.10

Oem.Hpe.Cache (array)

Member of Processor.v1_7_2.Processor Cache is an array containing elements of:

Cache[{item}].Associativity Member of Processor.v1_7_2.Processor
Description The associativity of the cache.
Type string or null
Read Only True

The following are the supported values:

Value Description
DirectMapped Direct Mapped
2waySetAssociative 2-way Set-Associative
4waySetAssociative 4-way Set-Associative
FullyAssociative Fully Associative
8waySetAssociative 8-way Set-Associative
16waySetAssociative 16-way Set-Associative
12waySetAssociative 12-way Set-Associative
24waySetAssociative 24-way Set-Associative
32waySetAssociative 32-way Set-Associative
48waySetAssociative 48-way Set-Associative
64waySetAssociative 64-way Set-Associative
20waySetAssociative 20-way Set-Associative
None

Cache[{item}].CacheSpeedns Member of Processor.v1_7_2.Processor
Description The cache speed (ns).
Type integer or null
Read Only True

Cache[{item}].CurrentSRAMType (array) Member of Processor.v1_7_2.Processor CurrentSRAMType is an array containing elements of:
Description The array of supported SRAM attributes currently used by the cache.
Type string or null
Read Only True

The following are the supported values:

Value Description
NonBurst Non-Burst
Burst Burst
PipelineBurst Pipeline Burst
Synchronous Synchronous
Asynchronous Asynchronous

Cache[{item}].EccType Member of Processor.v1_7_2.Processor
Description The cache memory ECC type.
Type string or null
Read Only True

The following are the supported values:

Value Description
None None
Parity Parity
SingleBitECC Single-bit ECC
MultiBitECC Multi-bit ECC

Cache[{item}].InstalledSizeKB Member of Processor.v1_7_2.Processor
Description The installed cache size (KB).
Type integer or null
Read Only True

Cache[{item}].Location Member of Processor.v1_7_2.Processor
Description The cache location (internal or external).
Type string or null
Read Only True

The following are the supported values:

Value Description
Internal Internal
External External

Cache[{item}].MaximumSizeKB Member of Processor.v1_7_2.Processor
Description The maximum cache size (KB).
Type integer or null
Read Only True

Cache[{item}].Policy Member of Processor.v1_7_2.Processor
Description The caching policy.
Type string or null
Read Only True

The following are the supported values:

Value Description
WriteThrough Write through
WriteBack Write back
Varies Varies with memory address

Cache[{item}].Socketed Member of Processor.v1_7_2.Processor
Description If true, the cache is a socketed component.
Type boolean or null
Read Only True

Cache[{item}].Status Member of Processor.v1_7_2.Processor See the Redfish standard schema and specification for information on common Status object.

Cache[{item}].SupportedSRAMType (array) Member of Processor.v1_7_2.Processor SupportedSRAMType is an array containing elements of:
Type string
Read Only True

The following are the supported values:

Value Description
NonBurst Non-Burst
Burst Burst
PipelineBurst Pipeline Burst
Synchronous Synchronous
Asynchronous Asynchronous

Cache[{item}].SystemCacheType Member of Processor.v1_7_2.Processor
Description The cache type (unified, instructions, or data).
Type string or null
Read Only True

The following are the supported values:

Value Description
Instruction Instruction
Data Data
Unified Unified

Oem.Hpe.Characteristics (array)

Member of Processor.v1_7_2.Processor Characteristics is an array containing elements of:
Type string
Read Only True

The following are the supported values:

Value Description
64Bit 64-bit Capable
MultiCore Multi-Core
HwThread Hardware Thread
ExecuteProtection Execute Protection
EnhancedVirtualization Enhanced Virtualization
PowerPerfControl Power/Performance Control

Oem.Hpe.ConfigStatus

Oem.Hpe.ConfigStatus.Populated Member of Processor.v1_7_2.Processor
Description True if the processor socket is populated with a CPU.
Type boolean or null
Read Only True
Added iLO 5 1.10

Oem.Hpe.ConfigStatus.State Member of Processor.v1_7_2.Processor
Description The current state of the processor.
Type string or null
Read Only True
Added iLO 5 1.10

The following are the supported values:

Value Description
Enabled CPU Enabled
DisabledByUser CPU Disabled by User through BIOS Setup
DisabledByBios CPU Disabled By BIOS (POST Error)
Idle CPU is Idle, waiting to be enabled.

Oem.Hpe.CoresEnabled

Member of Processor.v1_7_2.Processor
Description The number of enabled cores in the processor.
Type integer or null
Read Only True
Added iLO 5 1.10

Oem.Hpe.ExternalClockMHz

Member of Processor.v1_7_2.Processor
Description The processor external clock frequency (MHZ), for example, 1000 = 1 GHZ.
Type integer or null
Read Only True
Added iLO 5 1.10

Oem.Hpe.MicrocodePatches (array)

Member of Processor.v1_7_2.Processor MicrocodePatches is an array containing elements of:

MicrocodePatches[{item}].CpuId Member of Processor.v1_7_2.Processor
Description The microcode patch CPUID.
Type string
Read Only True

MicrocodePatches[{item}].Date Member of Processor.v1_7_2.Processor
Description The microcode patch date.
Type string
Read Only True
Format date-time

MicrocodePatches[{item}].PatchId Member of Processor.v1_7_2.Processor
Description The microcode patch ID.
Type string
Read Only True

Oem.Hpe.PartNumber

Member of Processor.v1_7_2.Processor
Description The processor part number.
Type string or null
Read Only True
Added iLO 5 1.10

Oem.Hpe.RatedSpeedMHz

Member of Processor.v1_7_2.Processor
Description The speed of the processor (in MHz) as of the last system boot, for example, 1000 = 1GHz.
Type integer or null
Read Only True
Added iLO 5 1.10

Oem.Hpe.SerialNumber

Member of Processor.v1_7_2.Processor
Description The processor serial number.
Type string or null
Read Only True
Added iLO 5 1.10

Oem.Hpe.VoltageVoltsX10

Member of Processor.v1_7_2.Processor
Description The processor voltage multiplied by 10, for example, 3.3v = 33.
Type integer or null
Read Only True
Added iLO 5 1.10

PartNumber

Member of Processor.v1_7_2.Processor
Description The processor part number.
Type string or null
Read Only True

ProcessorArchitecture

Member of Processor.v1_7_2.Processor
Description The architecture of the processor
Type string
Read Only True
Added iLO 5 1.10

The following are the supported values:

Value Description
x86 x86 or x86-64
IA-64 Intel Itanium
ARM ARM
MIPS MIPS
OEM OEM-defined

ProcessorId

ProcessorId.EffectiveFamily Member of Processor.v1_7_2.Processor
Description The effective Family for this processor
Type string or null
Read Only True
Added iLO 5 1.10

ProcessorId.EffectiveModel Member of Processor.v1_7_2.Processor
Description The effective Model for this processor
Type string or null
Read Only True
Added iLO 5 1.10

ProcessorId.IdentificationRegisters Member of Processor.v1_7_2.Processor
Description The contents of the Identification Registers (CPUID) for this processor
Type string or null
Read Only True
Added iLO 5 1.10

ProcessorId.MicrocodeInfo Member of Processor.v1_7_2.Processor
Description The Microcode Information for this processor
Type string or null
Read Only True
Added iLO 5 1.10

ProcessorId.Step Member of Processor.v1_7_2.Processor
Description The Step value for this processor
Type string or null
Read Only True
Added iLO 5 1.10

ProcessorId.VendorId Member of Processor.v1_7_2.Processor
Description The Vendor Identification for this processor
Type string or null
Read Only True
Added iLO 5 1.10

ProcessorType

Member of Processor.v1_7_2.Processor
Description The type of processor
Type string
Read Only True
Added iLO 5 1.10

The following are the supported values:

Value Description
CPU A Central Processing Unit
GPU A Graphics Processing Unit
FPGA A Field Programmable Gate Array
DSP A Digital Signal Processor
Accelerator An Accelerator
OEM An OEM-defined Processing Unit

SerialNumber

Member of Processor.v1_7_2.Processor
Description The processor serial number.
Type string or null
Read Only True

Socket

Member of Processor.v1_7_2.Processor
Description The socket or location of the processor
Type string or null
Read Only True
Added iLO 5 1.10

Status

Member of Processor.v1_7_2.Processor See the Redfish standard schema and specification for information on common Status object.

TotalCores

Member of Processor.v1_7_2.Processor
Description The total number of cores contained in this processor
Type integer or null
Read Only True
Added iLO 5 1.10

TotalThreads

Member of Processor.v1_7_2.Processor
Description The total number of execution threads supported by this processor
Type integer or null
Read Only True
Added iLO 5 1.10

ProcessorCollection.ProcessorCollection

@odata.type: "#ProcessorCollection.ProcessorCollection"

A Collection of Processor resource instances.

Resource Instances

Uri HTTP Allow
/redfish/v1/systems/{item}/processors GET
Link Name Destination type
Members[] Processor

Members (array)

Member of ProcessorCollection.ProcessorCollection Members is an array containing elements of:

Members[{item}].@odata.id Member of ProcessorCollection.ProcessorCollection
Type string
Read Only True
Format uri-reference

Members@odata.count

Member of ProcessorCollection.ProcessorCollection
Description The total number of collection members.
Type integer
Read Only True

Role.v1_2_1.Role

@odata.type: "#Role.v1_2_1.Role"

This resource defines a user role to be used in conjunction with a Manager Account.

Resource Instances

Uri HTTP Allow
/redfish/v1/accountservice/roles/{item} GET PATCH

AssignedPrivileges (array)

Member of Role.v1_2_1.Role AssignedPrivileges is an array containing elements of:
Type string
Read Only True

The following are the supported values:

Value Description
Login Able to log into the service and read resources.
ConfigureManager Able to configure Manager resources.
ConfigureUsers Able to configure Users and their Accounts.
ConfigureSelf Able to change the password for the current user Account.
ConfigureComponents Able to configure components managed by this service.

IsPredefined

Member of Role.v1_2_1.Role
Description This property is used to indicate if the Role is one of the Redfish Predefined Roles vs a Custom role.
Type boolean
Read Only True
Added iLO 5 1.40

Oem.Hpe.GroupDn

Member of Role.v1_2_1.Role
Description The complete or shortened distinguished name of the directory group.
Type string
Read Only True
Added iLO 5 1.40

Oem.Hpe.GroupSid

Member of Role.v1_2_1.Role
Description The security identifier of the directory group (for kerberos authentication and Active Directory integration only).
Type string or null
Read Only True

OemPrivileges (array)

Member of Role.v1_2_1.Role OemPrivileges is an array containing elements of:
Type string
Read Only True

The following are the supported values:

Value Description
RemoteConsolePriv Able to remotely access the host system Remote Console, including video, keyboard, and mouse control.
VirtualMediaPriv Able to use the Virtual Media feature on the host system.
VirtualPowerAndResetPriv Able to power-cycle or reset the host system. These activities interrupt system availability. A user with this privilege can diagnose the system by using the Generate NMI to System button.
HostBIOSConfigPriv Able to configure Host BIOS Settings.
HostNICConfigPriv Able to configure Host NIC Settings.
HostStorageConfigPriv Able to configure Host Storage Settings.
SystemRecoveryConfigPriv Able to manage the critical recovery firmware images on the Manager’s Repository.

RoleId

Member of Role.v1_2_1.Role
Description This property contains the name of the Role.
Type string
Read Only True
Added iLO 5 1.40

RoleCollection.RoleCollection

@odata.type: "#RoleCollection.RoleCollection"

A Collection of Role resource instances.

Resource Instances

Uri HTTP Allow
/redfish/v1/accountservice/roles GET
Link Name Destination type
Members[] Role

Members (array)

Member of RoleCollection.RoleCollection Members is an array containing elements of:

Members[{item}].@odata.id Member of RoleCollection.RoleCollection
Type string
Read Only True
Format uri-reference

Members@odata.count

Member of RoleCollection.RoleCollection
Description The total number of collection members.
Type integer
Read Only True

SecureBoot.v1_0_0.SecureBoot

@odata.type: "#SecureBoot.v1_0_0.SecureBoot"

This resource contains UEFI Secure Boot information. It represents properties for managing the UEFI Secure Boot functionality of a system.

Resource Instances

Uri HTTP Allow
/redfish/v1/systems/{item}/secureboot GET POST PATCH

SecureBootCurrentBoot

Member of SecureBoot.v1_0_0.SecureBoot
Description Secure Boot state during the current boot cycle.
Type string
Read Only True
Added iLO 5 1.10

The following are the supported values:

Value Description
Enabled Secure Boot is currently enabled.
Disabled Secure Boot is currently disabled.

SecureBootEnable

Member of SecureBoot.v1_0_0.SecureBoot
Description Enable or disable UEFI Secure Boot (takes effect on next boot).
Type boolean or null
Read Only False
Added iLO 5 1.10

SecureBootMode

Member of SecureBoot.v1_0_0.SecureBoot
Description Current Secure Boot Mode.
Type string
Read Only True
Added iLO 5 1.10

The following are the supported values:

Value Description
SetupMode Secure Boot is currently in Setup Mode.
UserMode Secure Boot is currently in User Mode.
AuditMode Secure Boot is currently in Audit Mode.
DeployedMode Secure Boot is currently in Deployed Mode.

Actions

SecureBoot.ResetKeys Member of SecureBoot.v1_0_0.SecureBoot Action to perform reset of the Secure Boot Keys.

Parameters:

ResetKeysType (string)

This parameter specifies what type of reset action to perform.

Value Description
DeleteAllKeys Delete all Secure Boot keys on next boot.
DeletePK Delete Secure Boot platform keys on next boot.
ResetAllKeysToDefault Reset to default Secure Boot keys on next boot.

SerialInterface.v1_1_7.SerialInterface

@odata.type: "#SerialInterface.v1_1_7.SerialInterface"

This is the schema definition for the Serial Interface.

Resource Instances

Uri HTTP Allow
/redfish/v1/managers/{item}/serialinterfaces/{item} GET PATCH

BitRate

Member of SerialInterface.v1_1_7.SerialInterface
Description The receive and transmit rate of data flow, typically in bits per second (bit/s), over the serial connection.
Type string
Read Only False

The following are the supported values:

Value Description
9600 A bit rate of 9600 bit/s.
19200 A bit rate of 19200 bit/s.
38400 A bit rate of 38400 bit/s.
57600 A bit rate of 57600 bit/s.
115200 A bit rate of 115200 bit/s.

InterfaceEnabled

Member of SerialInterface.v1_1_7.SerialInterface
Description An indication of whether this interface is enabled.
Type boolean or null
Read Only False

SerialInterfaceCollection.SerialInterfaceCollection

@odata.type: "#SerialInterfaceCollection.SerialInterfaceCollection"

A Collection of SerialInterface resource instances.

Resource Instances

Uri HTTP Allow
/redfish/v1/managers/{item}/serialinterfaces GET
Link Name Destination type
Members[] SerialInterface

Members (array)

Member of SerialInterfaceCollection.SerialInterfaceCollection Members is an array containing elements of:

Members[{item}].@odata.id Member of SerialInterfaceCollection.SerialInterfaceCollection
Type string
Read Only True
Format uri-reference

Members@odata.count

Member of SerialInterfaceCollection.SerialInterfaceCollection
Description The total number of collection members.
Type integer
Read Only True

ServiceRoot.v1_5_1.ServiceRoot

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

The ServiceRoot resource describes the Redfish API service root.

Resource Instances

Uri HTTP Allow
/redfish/v1/ GET
Link Name Destination type
AccountService AccountService
Chassis Collection of Chassis
EventService EventService
JsonSchemas Collection of JsonSchemaFile
Links/Sessions Collection of Session
Managers Collection of Manager
Oem/Hpe/Links/ResourceDirectory HpeiLOResourceDirectory
Registries Collection of MessageRegistryFile
SessionService SessionService
Systems Collection of ComputerSystem
UpdateService UpdateService

AccountService

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

CertificateService

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

Chassis

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

EventService

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

JsonSchemas

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

Managers

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

Oem.Hpe.CACLoginUri

Member of ServiceRoot.v1_5_1.ServiceRoot
Description URI for the CAC based authentication.
Type string
Read Only True
Format uri-reference

Oem.Hpe.DebugCode

Member of ServiceRoot.v1_5_1.ServiceRoot
Description Specifies whether the iLO has debug firmware flashed.
Type boolean
Read Only True
Added iLO 5 1.40

Oem.Hpe.DevSystem

Member of ServiceRoot.v1_5_1.ServiceRoot
Description Specifies whether the test key is enabled.
Type boolean
Read Only True
Added iLO 5 1.20

Oem.Hpe.Manager (array)

Member of ServiceRoot.v1_5_1.ServiceRoot Manager is an array containing elements of:

Manager[{item}].Blade Manager[{item}].Blade.BayNumber Member of ServiceRoot.v1_5_1.ServiceRoot
Description Specifies the location of the blade in the enclosure.
Type string
Read Only True

Manager[{item}].Blade.EnclosureName Member of ServiceRoot.v1_5_1.ServiceRoot
Description Specifies the name of the enclosure in which the blade is present.
Type string
Read Only True

Manager[{item}].Blade.RackName Member of ServiceRoot.v1_5_1.ServiceRoot
Description Specifies the name of the rack in which the enclosure is present.
Type string
Read Only True

Manager[{item}].DefaultLanguage Member of ServiceRoot.v1_5_1.ServiceRoot
Description Default language used for the Web interface.
Type string
Read Only True

Manager[{item}].ExternalManager Member of ServiceRoot.v1_5_1.ServiceRoot
Description Reports the current external manager of the system.
Type string or null
Read Only True

Manager[{item}].FQDN Member of ServiceRoot.v1_5_1.ServiceRoot
Description Fully qualified domain name of the management processor.
Type string or null
Read Only True

Manager[{item}].HostName Member of ServiceRoot.v1_5_1.ServiceRoot
Description The name of management processor.
Type string or null
Read Only True

Manager[{item}].IPManager Manager[{item}].Languages (array) Member of ServiceRoot.v1_5_1.ServiceRoot Languages is an array containing elements of:

Languages[{item}].Language Member of ServiceRoot.v1_5_1.ServiceRoot
Description Specifies one of the languages supported by the management processor.
Type string
Read Only True

Languages[{item}].TranslationName Member of ServiceRoot.v1_5_1.ServiceRoot
Description Specifies one of the languages supported by the management processor.
Type string
Read Only True

Languages[{item}].Version Member of ServiceRoot.v1_5_1.ServiceRoot
Description Specifies the version of the management processor in the respective language.
Type string
Read Only True

Manager[{item}].ManagerFirmwareVersion Member of ServiceRoot.v1_5_1.ServiceRoot
Description The major and minor management processor version numbers.
Type string
Read Only True

Manager[{item}].ManagerFirmwareVersionPass Member of ServiceRoot.v1_5_1.ServiceRoot
Description The build or pass number of the management processor version.
Type string
Read Only True

Manager[{item}].ManagerType Member of ServiceRoot.v1_5_1.ServiceRoot
Description The type of the service manager.
Type string
Read Only True

Manager[{item}].SelfTestErrors (array) Member of ServiceRoot.v1_5_1.ServiceRoot SelfTestErrors is an array containing elements of:

SelfTestErrors[{item}].SelfTestName Member of ServiceRoot.v1_5_1.ServiceRoot
Description iLO Self Test Name.
Type string
Read Only True

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

Oem.Hpe.Moniker

Oem.Hpe.Moniker.ADVLIC Member of ServiceRoot.v1_5_1.ServiceRoot
Description Optional Licensed functionality tier name.
Type string
Read Only True
Added iLO 5 1.10

Oem.Hpe.Moniker.BMC Member of ServiceRoot.v1_5_1.ServiceRoot
Description Generic abbreviation for the management processor.
Type string
Read Only True
Added iLO 5 1.10

Oem.Hpe.Moniker.BSYS Member of ServiceRoot.v1_5_1.ServiceRoot
Description Product category name.
Type string
Read Only True
Added iLO 5 1.10

Oem.Hpe.Moniker.CLASS Member of ServiceRoot.v1_5_1.ServiceRoot
Description Management processor product category.
Type string
Read Only True
Added iLO 5 1.10

Oem.Hpe.Moniker.FEDGRP Member of ServiceRoot.v1_5_1.ServiceRoot
Description Default federation group name.
Type string
Read Only True
Added iLO 5 1.10

Oem.Hpe.Moniker.IPROV Member of ServiceRoot.v1_5_1.ServiceRoot
Description Product name for provisioning and deployment suite.
Type string
Read Only True
Added iLO 5 1.10

Oem.Hpe.Moniker.PRODABR Member of ServiceRoot.v1_5_1.ServiceRoot
Description Abbreviated product name.
Type string
Read Only True
Added iLO 5 1.10

Oem.Hpe.Moniker.PRODFAM Member of ServiceRoot.v1_5_1.ServiceRoot
Description Full product family.
Type string
Read Only True
Added iLO 5 1.10

Oem.Hpe.Moniker.PRODGEN Member of ServiceRoot.v1_5_1.ServiceRoot
Description Abbreviated product name and generation.
Type string
Read Only True
Added iLO 5 1.10

Oem.Hpe.Moniker.PRODNAM Member of ServiceRoot.v1_5_1.ServiceRoot
Description Full product name.
Type string
Read Only True
Added iLO 5 1.10

Oem.Hpe.Moniker.PRODTAG Member of ServiceRoot.v1_5_1.ServiceRoot
Description Branded, abbreviated product name.
Type string
Read Only True
Added iLO 5 1.10

Oem.Hpe.Moniker.STDLIC Member of ServiceRoot.v1_5_1.ServiceRoot
Description Base licensed functionality tier name.
Type string
Read Only True
Added iLO 5 1.10

Oem.Hpe.Moniker.SUMABR Member of ServiceRoot.v1_5_1.ServiceRoot
Description Acronym for update deployment suite.
Type string
Read Only True
Added iLO 5 1.10

Oem.Hpe.Moniker.SUMGR Member of ServiceRoot.v1_5_1.ServiceRoot
Description Product name for update deployment suite.
Type string
Read Only True
Added iLO 5 1.10

Oem.Hpe.Moniker.SYSFAM Member of ServiceRoot.v1_5_1.ServiceRoot
Description Host system product family.
Type string
Read Only True
Added iLO 5 1.10

Oem.Hpe.Moniker.SYSMGMT Member of ServiceRoot.v1_5_1.ServiceRoot
Description System Management Experience.
Type string
Read Only True

Oem.Hpe.Moniker.VENDABR Member of ServiceRoot.v1_5_1.ServiceRoot
Description Abbreviated vendor name (like stock ticker).
Type string
Read Only True
Added iLO 5 1.10

Oem.Hpe.Moniker.VENDNAM Member of ServiceRoot.v1_5_1.ServiceRoot
Description Full vendor name.
Type string
Read Only True
Added iLO 5 1.10

Oem.Hpe.Moniker.VNIC Member of ServiceRoot.v1_5_1.ServiceRoot
Description Virtual USB network interface to BMC name.
Type string
Read Only True

Oem.Hpe.Moniker.WWW Member of ServiceRoot.v1_5_1.ServiceRoot
Description Top level public internet vendor URI.
Type string
Read Only True
Added iLO 5 1.10

Oem.Hpe.Moniker.WWWAHSV Member of ServiceRoot.v1_5_1.ServiceRoot
Description Public internet vendor URI for Active Health viewer.
Type string
Read Only True
Added iLO 5 1.10

Oem.Hpe.Moniker.WWWBMC Member of ServiceRoot.v1_5_1.ServiceRoot
Description Public internet vendor URI for the management processor.
Type string
Read Only True
Added iLO 5 1.10

Oem.Hpe.Moniker.WWWDOC Member of ServiceRoot.v1_5_1.ServiceRoot
Description Public internet vendor URI for the management processor documentation / manuals.
Type string
Read Only True
Added iLO 5 1.10

Oem.Hpe.Moniker.WWWERS Member of ServiceRoot.v1_5_1.ServiceRoot
Description Public internet vendor URI for Embedded Remote Support.
Type string
Read Only True
Added iLO 5 1.10

Oem.Hpe.Moniker.WWWGLIS Member of ServiceRoot.v1_5_1.ServiceRoot
Description Public internet vendor URI for management processor licensing infrastructure.
Type string
Read Only True
Added iLO 5 1.10

Oem.Hpe.Moniker.WWWINFOSIGHT Member of ServiceRoot.v1_5_1.ServiceRoot
Description Public internet resource for active health.
Type string
Read Only True

Oem.Hpe.Moniker.WWWIOL Member of ServiceRoot.v1_5_1.ServiceRoot
Description Public internet vendor URI for Online Insight service.
Type string
Read Only True
Added iLO 5 1.10

Oem.Hpe.Moniker.WWWLIC Member of ServiceRoot.v1_5_1.ServiceRoot
Description Public internet vendor URI for the management processor.
Type string
Read Only True
Added iLO 5 1.10

Oem.Hpe.Moniker.WWWLML Member of ServiceRoot.v1_5_1.ServiceRoot
Description Public internet vendor URI for Learn More Links.
Type string
Read Only True
Added iLO 5 1.10

Oem.Hpe.Moniker.WWWPASS Member of ServiceRoot.v1_5_1.ServiceRoot
Description Public internet vendor URI for accessing support account.
Type string
Read Only True
Added iLO 5 1.10

Oem.Hpe.Moniker.WWWPRV Member of ServiceRoot.v1_5_1.ServiceRoot
Description Public internet vendor URI for privacy policy statement.
Type string
Read Only True
Added iLO 5 1.10

Oem.Hpe.Moniker.WWWQSPEC Member of ServiceRoot.v1_5_1.ServiceRoot
Description Public internet vendor URI for Quick Specs.
Type string
Read Only True
Added iLO 5 1.10

Oem.Hpe.Moniker.WWWRESTDOC Member of ServiceRoot.v1_5_1.ServiceRoot
Description Public internet vendor URI for REST API documentation.
Type string
Read Only True
Added iLO 5 1.10

Oem.Hpe.Moniker.WWWSUP Member of ServiceRoot.v1_5_1.ServiceRoot
Description Public internet vendor URI for management processor and product support.
Type string
Read Only True
Added iLO 5 1.10

Oem.Hpe.Moniker.WWWSWLIC Member of ServiceRoot.v1_5_1.ServiceRoot
Description Public internet vendor URI for vendor software licensing.
Type string
Read Only True
Added iLO 5 1.10

Oem.Hpe.PreProd

Member of ServiceRoot.v1_5_1.ServiceRoot
Description Specifies whether the system identifies as pre-production.
Type boolean
Read Only True

Oem.Hpe.Sessions

Oem.Hpe.Sessions.CertCommonName Member of ServiceRoot.v1_5_1.ServiceRoot
Description The name of the management processor as it appears in the digital certificate when a secure web GUI session is established to the management processor.
Type string
Read Only True
Added iLO 5 1.10

Oem.Hpe.Sessions.CertificateLoginEnabled Member of ServiceRoot.v1_5_1.ServiceRoot
Description Specifies whether Certificate login is enabled.
Type boolean
Read Only True
Added iLO 5 1.10

Oem.Hpe.Sessions.KerberosEnabled Member of ServiceRoot.v1_5_1.ServiceRoot
Description Specifies whether Kerberos login is enabled.
Type boolean
Read Only True
Added iLO 5 1.10

Oem.Hpe.Sessions.LDAPAuthLicenced Member of ServiceRoot.v1_5_1.ServiceRoot
Description Specifies whether a valid license is installed for LDAP use.
Type boolean
Read Only True
Added iLO 5 1.10

Oem.Hpe.Sessions.LDAPEnabled Member of ServiceRoot.v1_5_1.ServiceRoot
Description Specifies whether LDAP login is enabled.
Type boolean
Read Only True
Added iLO 5 1.10

Oem.Hpe.Sessions.LocalLoginEnabled Member of ServiceRoot.v1_5_1.ServiceRoot
Description Specifies whether local users can log in.
Type boolean
Read Only True
Added iLO 5 1.10

Oem.Hpe.Sessions.LoginFailureDelay Member of ServiceRoot.v1_5_1.ServiceRoot
Description The delay (seconds) when a management processor login attempt has failed.
Type integer
Read Only True
Added iLO 5 1.10

Oem.Hpe.Sessions.LoginHint Oem.Hpe.Sessions.LoginHint.Hint Member of ServiceRoot.v1_5_1.ServiceRoot
Description The information on how to log in to the management processor.
Type string
Read Only True
Added iLO 5 1.10

Oem.Hpe.Sessions.LoginHint.HintPOSTData Oem.Hpe.Sessions.LoginHint.HintPOSTData.Password Member of ServiceRoot.v1_5_1.ServiceRoot
Description The password for logging in to the management processor.
Type string
Read Only True
Added iLO 5 1.10

Oem.Hpe.Sessions.LoginHint.HintPOSTData.UserName Member of ServiceRoot.v1_5_1.ServiceRoot
Description The user name for logging in to the management processor.
Type string
Read Only True
Added iLO 5 1.10

Oem.Hpe.Sessions.SecurityMessage Member of ServiceRoot.v1_5_1.ServiceRoot
Description The login security banner message that is displayed on the management processor Login page.
Type string
Read Only True
Added iLO 5 1.10

Oem.Hpe.Sessions.SecurityOverride Member of ServiceRoot.v1_5_1.ServiceRoot
Description Specifies whether the security override switch is enabled.
Type boolean
Read Only True
Added iLO 5 1.10

Oem.Hpe.Sessions.ServerName Member of ServiceRoot.v1_5_1.ServiceRoot
Description The name of the server that this management processor is managing.
Type string
Read Only True
Added iLO 5 1.10

Oem.Hpe.System (array)

Member of ServiceRoot.v1_5_1.ServiceRoot System is an array containing elements of:

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

Oem.Hpe.Time

Member of ServiceRoot.v1_5_1.ServiceRoot
Description The current Redfish service time.
Type string or null
Read Only True
Added iLO 5 1.10
Format date-time

Product

Member of ServiceRoot.v1_5_1.ServiceRoot
Description The product associated with this Redfish service.
Type string or null
Read Only True
Added iLO 5 1.40

ProtocolFeaturesSupported

ProtocolFeaturesSupported.ExpandQuery ProtocolFeaturesSupported.ExpandQuery.ExpandAll Member of ServiceRoot.v1_5_1.ServiceRoot
Description This indicates whether the expand support of asterisk (expand all entries) is supported.
Type boolean
Read Only True
Added iLO 5 1.40

ProtocolFeaturesSupported.ExpandQuery.Levels Member of ServiceRoot.v1_5_1.ServiceRoot
Description This indicates whether the expand support of the $levels qualifier is supported by the service.
Type boolean
Read Only True
Added iLO 5 1.40

ProtocolFeaturesSupported.ExpandQuery.MaxLevels Member of ServiceRoot.v1_5_1.ServiceRoot
Description This indicates the maximum number value of the $levels qualifier in expand operations.
Type number
Read Only True
Added iLO 5 1.40

ProtocolFeaturesSupported.ExpandQuery.NoLinks Member of ServiceRoot.v1_5_1.ServiceRoot
Description This indicates whether the expand support of period (expand only entries not in the Links section) is supported.
Type boolean
Read Only True
Added iLO 5 1.40

ProtocolFeaturesSupported.FilterQuery Member of ServiceRoot.v1_5_1.ServiceRoot
Description This indicates whether the filter query parameter is supported.
Type boolean
Read Only True
Added iLO 5 1.40

ProtocolFeaturesSupported.OnlyMemberQuery Member of ServiceRoot.v1_5_1.ServiceRoot
Description This indicates whether Management Processor supports the only query option.
Type boolean
Read Only True

ProtocolFeaturesSupported.SelectQuery Member of ServiceRoot.v1_5_1.ServiceRoot
Description This indicates whether the select query parameter is supported.
Type boolean
Read Only True
Added iLO 5 1.40

RedfishVersion

Member of ServiceRoot.v1_5_1.ServiceRoot
Description The version of the Redfish service
Type string
Read Only True
Added iLO 5 1.10

Registries

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

SessionService

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

Systems

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

Tasks

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

TelemetryService

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

UUID

Member of ServiceRoot.v1_5_1.ServiceRoot
Description Unique identifier for a service instance. This value should be an exact match of the UUID value returned in a 200OK from an SSDP M-SEARCH request during discovery.
Type string or null
Read Only True
Added iLO 5 1.10

UpdateService

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

Vendor

Member of ServiceRoot.v1_5_1.ServiceRoot
Description The vendor of the product associated with this Redfish service.
Type string or null
Read Only True
Added iLO 5 1.40

Session.v1_0_0.Session

@odata.type: "#Session.v1_0_0.Session"

The Session resource describes a single connection (session) between a client and a Redfish service instance.

Resource Instances

Uri HTTP Allow
/redfish/v1/sessionservice/sessions/{item} GET DELETE

Oem.Hpe.AccessTime

Member of Session.v1_0_0.Session
Description User session last-access time
Type string
Read Only True
Added iLO 5 1.10
Format date-time

Oem.Hpe.LoginTime

Member of Session.v1_0_0.Session
Description User session login time
Type string
Read Only True
Added iLO 5 1.10
Format date-time

Oem.Hpe.MySession

Member of Session.v1_0_0.Session
Description Indicates whether this is a session I own.
Type boolean
Read Only True
Added iLO 5 1.10

Oem.Hpe.Privileges

Oem.Hpe.Privileges.HostBIOSConfigPriv Member of Session.v1_0_0.Session
Description This privilege enables a user to configure Host Bios Settings.
Type boolean
Read Only True
Added iLO 5 1.10

Oem.Hpe.Privileges.HostNICConfigPriv Member of Session.v1_0_0.Session
Description This privilege enables a user to configure Host NIC Settings.
Type boolean
Read Only True
Added iLO 5 1.10

Oem.Hpe.Privileges.HostStorageConfigPriv Member of Session.v1_0_0.Session
Description This privilege enables a user to configure Host Storage Settings.
Type boolean
Read Only True
Added iLO 5 1.10

Oem.Hpe.Privileges.LoginPriv Member of Session.v1_0_0.Session
Description This privilege enables a user to log in to the management processor. All local accounts have the login privilege. This privilege is added automatically if it is not specified.
Type boolean
Read Only True
Added iLO 5 1.10

Oem.Hpe.Privileges.RemoteConsolePriv Member of Session.v1_0_0.Session
Description This privilege enables a user to remotely access the host system Remote Console, including video, keyboard, and mouse control.
Type boolean
Read Only True
Added iLO 5 1.10

Oem.Hpe.Privileges.SystemRecoveryConfigPriv Member of Session.v1_0_0.Session
Description This privilege enables a user to manage the critical recovery firmware images on the iLO Repository.
Type boolean
Read Only True
Added iLO 5 1.10

Oem.Hpe.Privileges.UserConfigPriv Member of Session.v1_0_0.Session
Description This privilege enables a user to add, edit, and delete local management processor user accounts. A user with this privilege can change privileges for all users.
Type boolean
Read Only True
Added iLO 5 1.10

Oem.Hpe.Privileges.VirtualMediaPriv Member of Session.v1_0_0.Session
Description This privilege enables a user to use the Virtual Media feature on the host system.
Type boolean
Read Only True
Added iLO 5 1.10

Oem.Hpe.Privileges.VirtualPowerAndResetPriv Member of Session.v1_0_0.Session
Description This privilege enables a user to power-cycle or reset the host system. These activities interrupt system availability. A user with this privilege can diagnose the system by using the Generate NMI to System button.
Type boolean
Read Only True
Added iLO 5 1.10

Oem.Hpe.Privileges.iLOConfigPriv Member of Session.v1_0_0.Session
Description This privilege enables a user to configure most management processor settings, including security settings, and to remotely update the management processor firmware. This privilege does not enable local user account administration.
Type boolean
Read Only True
Added iLO 5 1.10

Oem.Hpe.UserAccount

Member of Session.v1_0_0.Session
Description Login details of the user
Type string
Read Only True
Added iLO 5 1.10

Oem.Hpe.UserDistinguishedName

Member of Session.v1_0_0.Session
Description LDAP user is identified by its distinguished name (DN).
Type string
Read Only True
Added iLO 5 1.10

Oem.Hpe.UserExpires

Member of Session.v1_0_0.Session
Description User session expire time
Type string
Read Only True
Added iLO 5 1.10
Format date-time

Oem.Hpe.UserIP

Member of Session.v1_0_0.Session
Description IP address of the user
Type string
Read Only True
Added iLO 5 1.10

Oem.Hpe.UserTag

Member of Session.v1_0_0.Session
Description Session source
Type string
Read Only True
Added iLO 5 1.10

The following are the supported values:

Value
Web UI
RBSU
Remote Console
SSH
IPMI/RMCP
SM-CLP
RIBCL
RESTHost
RIBCLHost
WSMgmt
Telnet
Federation
USBFrontPort
REST
Unknown

Oem.Hpe.UserType

Member of Session.v1_0_0.Session
Description User type
Type string
Read Only True
Added iLO 5 1.10

The following are the supported values:

Value
Local
Directory
Single Sign On
Kerberos
Trusted Key
Security Override
System
Federation

UserName

Member of Session.v1_0_0.Session
Description Name to use to log in to the management processor.
Type string
Read Only True
Added iLO 5 1.10

SessionCollection.SessionCollection

@odata.type: "#SessionCollection.SessionCollection"

A Collection of Session resource instances.

Resource Instances

Uri HTTP Allow
/redfish/v1/sessionservice/sessions GET POST
Link Name Destination type
Members[] Session
Oem/Hpe/Links/MySession Session

Members (array)

Member of SessionCollection.SessionCollection Members is an array containing elements of:

Members[{item}].@odata.id Member of SessionCollection.SessionCollection
Type string
Read Only True
Format uri-reference

Members@odata.count

Member of SessionCollection.SessionCollection
Description The total number of collection members.
Type integer
Read Only True

SessionService.v1_0_0.SessionService

@odata.type: "#SessionService.v1_0_0.SessionService"

The SessionService resource describes the BMC Redfish Session Service. It represents the properties for the service itself and has links to the actual list of sessions.

Resource Instances

Uri HTTP Allow
/redfish/v1/sessionservice GET PATCH
Link Name Destination type
Sessions Collection of Session

ServiceEnabled

Member of SessionService.v1_0_0.SessionService
Description This indicates whether this service is enabled.
Type boolean or null
Read Only True
Added iLO 5 1.10

SessionTimeout

Member of SessionService.v1_0_0.SessionService
Description This is the number of seconds of inactivity that a session may have before the session service closes the session due to inactivity. Here the value 0 means no timeout or infinite timeout.
Type integer
Read Only False
Added iLO 5 1.10

Sessions

This property references a Collection resource of Sessions. Sessions is a link ("@odata.id": URI) to another resource.

Status

Member of SessionService.v1_0_0.SessionService See the Redfish standard schema and specification for information on common Status object.

SmartStorageConfig.v2_0_0.SmartStorageConfig

@odata.type: "#SmartStorageConfig.v2_0_0.SmartStorageConfig"

Smart Storage Configuration Schema

Resource Instances

Uri HTTP Allow
/redfish/v1/systems/{item}/smartstorageconfig GET
/redfish/v1/systems/{item}/smartstorageconfig/settings GET PATCH
Link Name Destination type
@Redfish.Settings/SettingsObject SmartStorageConfig

Actions (array)

Member of SmartStorageConfig.v2_0_0.SmartStorageConfig Actions is an array containing elements of:

Actions[{item}].Action Member of SmartStorageConfig.v2_0_0.SmartStorageConfig
Description The action to perform
Type string
Read Only False

Actions[{item}].ErasePattern Member of SmartStorageConfig.v2_0_0.SmartStorageConfig
Description The erase pattern used to erase the drive
Type string
Read Only False

The following are the supported values:

Value Description
SanitizeRestrictedBlockErase Use the restricted block erase sanitize block erase method to erase a drive
SanitizeUnrestrictedBlockErase Use the unrestricted block erase sanitize method to erase a drive
SanitizeRestrictedOverwrite Use the restricted overwrite sanitize method to erase a drive
SanitizeUnrestrictedOverwrite Use the unrestricted overwrite sanitize method to erase a drive
SanitizeRestrictedCryptoScramble Use the unrestricted cryptographic scramble sanitize method to erase a drive
SanitizeUnrestrictedCryptoScramble Use the unrestricted cryptographic scramble sanitize method to erase a drive
OnePass Use the controller-based one pass erase method that writes zeroes to every sector of the drive
TwoPass Use the controller-based two pass erase method that writes random data to every sector of the drive on the first pass, and zeroes on the second pass
ThreePass Use the controller-based three pass erase method that writes random data to every sector of the drive on the first two passes, and zeroes on the third pass

Actions[{item}].PhysicalDriveList (array) Member of SmartStorageConfig.v2_0_0.SmartStorageConfig PhysicalDriveList is an array containing elements of:
Description Physical drive in the format specified in DriveLocationFormat
Type string
Read Only True

CurrentParallelSurfaceScanCount

Member of SmartStorageConfig.v2_0_0.SmartStorageConfig
Description This indicates the number of parallel surface scans the controller allows
Type integer or null
Read Only False

DataGuard

Member of SmartStorageConfig.v2_0_0.SmartStorageConfig
Description The value of the field indicates whether or not data destructive actions are allowed on the controller
Type string
Read Only False

The following are the supported values:

Value Description
Strict Data destructive actions are not allowed
Permissive Logical drive delete actions will be ignored
Disabled Data destructive actions are allowed

DegradedPerformanceOptimization

Member of SmartStorageConfig.v2_0_0.SmartStorageConfig
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
Type string or null
Read Only False

The following are the supported values:

Value Description
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

DriveLocationFormat

Member of SmartStorageConfig.v2_0_0.SmartStorageConfig
Description The format of the physical drive locations on this controller
Type string
Read Only True

The following are the supported values:

Value Description
“`ControllerPort:Box:Bay[ ControllerPort:Box:Bay]”`

DriveWriteCache

Member of SmartStorageConfig.v2_0_0.SmartStorageConfig
Description Enables or disables the write cache of the physical drives attached to the controller
Type string or null
Read Only False

The following are the supported values:

Value Description
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

ElevatorSort

Member of SmartStorageConfig.v2_0_0.SmartStorageConfig
Description Enables the controller to sort requests to a physical drive
Type string or null
Read Only False

The following are the supported values:

Value Description
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

EncryptionConfiguration

Member of SmartStorageConfig.v2_0_0.SmartStorageConfig
Description This indicates the type of encryption configured on the controller
Type string
Read Only False

The following are the supported values:

Value Description
ExpressLocal Express local encryption is configured and the controller is being encrypted with internally generated keys
None Encryption is not configured on the controller

EncryptionEULA

Member of SmartStorageConfig.v2_0_0.SmartStorageConfig
Description The value of this field indicates whether or not the user has accepted the encryption EULA
Type string or null
Read Only False

The following are the supported values:

Value Description
Accept The user has read and accepted the encryption EULA
Decline The user has not read and accepted the encryption EULA

ExpandPriority

Member of SmartStorageConfig.v2_0_0.SmartStorageConfig
Description The level of priority that transformations have over handling current operating system requests
Type string or null
Read Only False

The following are the supported values:

Value Description
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

FlexibleLatencySchedulerSetting

Member of SmartStorageConfig.v2_0_0.SmartStorageConfig
Description This allows the controller to process certain high-latency requests after a delay that may time out when elevator sorting
Type string or null
Read Only False

The following are the supported values:

Value Description
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

InconsistencyRepairPolicy

Member of SmartStorageConfig.v2_0_0.SmartStorageConfig
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
Type string or null
Read Only False

The following are the supported values:

Value Description
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

Location

Member of SmartStorageConfig.v2_0_0.SmartStorageConfig
Description The location of the controller
Type string
Read Only True

LocationFormat

Member of SmartStorageConfig.v2_0_0.SmartStorageConfig
Description The format of the Location property on this controller
Type string
Read Only True

The following are the supported values:

Value Description
PCISlot The location of the controller is given as a PCI slot number

LogicalDrives (array)

Member of SmartStorageConfig.v2_0_0.SmartStorageConfig LogicalDrives is an array containing elements of:

LogicalDrives[{item}].Accelerator Member of SmartStorageConfig.v2_0_0.SmartStorageConfig
Description The acceleration method of the logical drive
Type string
Read Only False

The following are the supported values:

Value Description
None Logical drive acceleration is disabled
ControllerCache Read 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

LogicalDrives[{item}].Actions (array) Member of SmartStorageConfig.v2_0_0.SmartStorageConfig Actions is an array containing elements of:

Actions[{item}].Action Member of SmartStorageConfig.v2_0_0.SmartStorageConfig
Description The action to perform
Type string
Read Only False

LogicalDrives[{item}].BlockSizeBytes Member of SmartStorageConfig.v2_0_0.SmartStorageConfig
Description The block size of the disk drive in bytes
Type integer
Read Only False

LogicalDrives[{item}].CapacityBlocks Member of SmartStorageConfig.v2_0_0.SmartStorageConfig
Description Total usable capacity available on this logical drive in block units. Set to -1 to use all remaining space for maximum size
Type integer
Read Only False

LogicalDrives[{item}].CapacityGiB Member of SmartStorageConfig.v2_0_0.SmartStorageConfig
Description Total usable capacity available on this logical drive in GiB units. Set to -1 to use all remaining space for maximum size
Type integer
Read Only False

LogicalDrives[{item}].DataDrives Member of SmartStorageConfig.v2_0_0.SmartStorageConfig LogicalDrives[{item}].DataDrives (array) Member of SmartStorageConfig.v2_0_0.SmartStorageConfig DataDrives is an array containing elements of:
Description Physical drive in the format specified in DriveLocationFormat
Type string
Read Only True

LogicalDrives[{item}].DataDrives LogicalDrives[{item}].DataDrives.DataDriveCount Member of SmartStorageConfig.v2_0_0.SmartStorageConfig
Description Specify the number of data drives for this logical drive
Type integer
Read Only False

LogicalDrives[{item}].DataDrives.DataDriveInterfaceType Member of SmartStorageConfig.v2_0_0.SmartStorageConfig
Description Specify the interface type for the data drives for this logical drive
Type string
Read Only False

The following are the supported values:

Value Description
SAS Use SAS drives when creating the logical drive
SATA Use SATA drives when creating the logical drive

LogicalDrives[{item}].DataDrives.DataDriveLocation Member of SmartStorageConfig.v2_0_0.SmartStorageConfig
Description Specify the location of the data drives for this logical drive
Type string
Read Only False

The following are the supported values:

Value Description
Internal Drives that are attached to an internal port of the controller (front drives)
External Drives that are attached to an external port of the controller (JBOD drives)

LogicalDrives[{item}].DataDrives.DataDriveMediaType Member of SmartStorageConfig.v2_0_0.SmartStorageConfig
Description Specify the media type for the data drives for this logical drive
Type string
Read Only False

The following are the supported values:

Value Description
HDD Use spindle drives when creating the logical drive
SSD Use solid state drives when creating the logical drive

LogicalDrives[{item}].DataDrives.DataDriveMinimumSizeGiB Member of SmartStorageConfig.v2_0_0.SmartStorageConfig
Description Specify the minimum size for the data drive(s) used to create the logical drive
Type integer
Read Only False

LogicalDrives[{item}].LegacyBootPriority Member of SmartStorageConfig.v2_0_0.SmartStorageConfig
Description The boot priority of this logical drive
Type string
Read Only False

The following are the supported values:

Value Description
Primary This logical drive is the primary boot volume
Secondary This logical drive is the secondary boot volume
All This logical drive is both the primary and secondary boot volume
None This logical drive has no legacy boot priority

LogicalDrives[{item}].LogicalDriveName Member of SmartStorageConfig.v2_0_0.SmartStorageConfig
Description Label given to the logical drive
Type string
Read Only False

LogicalDrives[{item}].LogicalDriveNumber Member of SmartStorageConfig.v2_0_0.SmartStorageConfig
Description Logical drive number
Type integer
Read Only True

LogicalDrives[{item}].ParityGroupCount Member of SmartStorageConfig.v2_0_0.SmartStorageConfig
Description The number of parity groups to use in the logical drive; only valid for certain RAID levels
Type integer
Read Only False

LogicalDrives[{item}].ParityInitializationType Member of SmartStorageConfig.v2_0_0.SmartStorageConfig
Description When creating a logical drive with a RAID level that requires parity, parity blocks can be initialized with two different methods
Type string
Read Only False

The following are the supported values:

Value Description
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

LogicalDrives[{item}].Raid Member of SmartStorageConfig.v2_0_0.SmartStorageConfig
Description The current RAID level configured on the logical drive
Type string
Read Only False

The following are the supported values:

Value Description
Raid0 There is no fault tolerance used on this logical drive
Raid1 Two sets of duplicate data is being stored on a pair of drives
Raid1ADM Three sets of duplicate data is being stored on a trio of drives
Raid10 Data is duplicated and striped across pairs of disk drives
Raid10ADM Data is duplicated and striped across trios of disk drives
Raid5 Fault tolerance is achieved by storing parity data across 3 or more disk drives
Raid50 Fault tolerance is achieved by storing parity data and striping the data across 6 or more disk drives
Raid6 Fault tolerance is achieved by storing multiple sets parity data across 4 or more disk drives
Raid60 Fault tolerance is achieved by storing multiple sets parity data and striping the data across 8 or more disk drives

LogicalDrives[{item}].SpareDrives Member of SmartStorageConfig.v2_0_0.SmartStorageConfig LogicalDrives[{item}].SpareDrives (array) Member of SmartStorageConfig.v2_0_0.SmartStorageConfig SpareDrives is an array containing elements of:
Description Physical drive in the format specified in DriveLocationFormat
Type string
Read Only True

LogicalDrives[{item}].SpareDrives LogicalDrives[{item}].SpareDrives.SpareDriveCount Member of SmartStorageConfig.v2_0_0.SmartStorageConfig
Description Specify the number of spare drives for this logical drive
Type integer
Read Only False

LogicalDrives[{item}].SpareRebuildMode Member of SmartStorageConfig.v2_0_0.SmartStorageConfig
Description Type of spare drive used with this logical drive
Type string
Read Only False

The following are the supported values:

Value Description
Dedicated The spare drive temporarily takes over a failed data drive; when the failed data drive is replaced, the spare drive becomes idle again
Roaming The spare drive replaces the failed data drive

LogicalDrives[{item}].StripSizeBytes Member of SmartStorageConfig.v2_0_0.SmartStorageConfig
Description The strip size of the logical drive in bytes
Type integer
Read Only False

LogicalDrives[{item}].StripeSizeBytes Member of SmartStorageConfig.v2_0_0.SmartStorageConfig
Description The stripe size of the logical drive in bytes
Type integer
Read Only False

LogicalDrives[{item}].VolumeUniqueIdentifier Member of SmartStorageConfig.v2_0_0.SmartStorageConfig
Description Logical drive volume unique identifier
Type string
Read Only True

MonitorAndPerformanceAnalysisDelaySeconds

Member of SmartStorageConfig.v2_0_0.SmartStorageConfig
Description This sets the monitor and performance delay on the controller. Valid values range from 0 to 1440 seconds. Set to 60 seconds for default settings and 0 seconds for video-on-demand optimized setting
Type integer or null
Read Only False

NoBatteryWriteCache

Member of SmartStorageConfig.v2_0_0.SmartStorageConfig
Description This indicates if the controller will continue to use write cache even if the backup power source is not available
Type string or null
Read Only False

The following are the supported values:

Value Description
Enabled The controller will continue to use write cache even if the backup power source is not available
Disabled The controller will not continue to use write cache even if the backup power source is not available

PhysicalDrives (array)

Member of SmartStorageConfig.v2_0_0.SmartStorageConfig PhysicalDrives is an array containing elements of:

PhysicalDrives[{item}].LegacyBootPriority Member of SmartStorageConfig.v2_0_0.SmartStorageConfig
Description The boot priority of this physical drive
Type string
Read Only False

The following are the supported values:

Value Description
Primary This physical drive is the primary boot volume
Secondary This physical drive is the secondary boot volume
All This physical drive is both the primary and secondary boot volume
None This physical drive has no legacy boot priority

PhysicalDrives[{item}].PhysicalDriveNumber Member of SmartStorageConfig.v2_0_0.SmartStorageConfig
Description Physical drive number
Type integer
Read Only True

Ports (array)

Member of SmartStorageConfig.v2_0_0.SmartStorageConfig Ports is an array containing elements of:

Ports[{item}].OperatingModeAfterReboot Member of SmartStorageConfig.v2_0_0.SmartStorageConfig
Description The operating mode of this port after a reboot
Type string
Read Only False

The following are the supported values:

Value Description
Mixed The port will be functioning in mixed mode after rebooting. Unassigned drives will be exposed to the OS

Ports[{item}].PortIndex Member of SmartStorageConfig.v2_0_0.SmartStorageConfig
Description The port index
Type integer
Read Only True

PowerModeAfterReboot

Member of SmartStorageConfig.v2_0_0.SmartStorageConfig
Description The power mode of the controller after a reboot
Type string
Read Only False

The following are the supported values:

Value Description
Invalid The controller will be operating in an unknown power mode after a reboot
MinPower The controller will be operating in minimum power mode after a reboot
Balanced The controller will be operating in a balanced mode after a reboot
MaxPerformance The controller will be operating in maximum performance power mode after a reboot

PredictiveSpareRebuild

Member of SmartStorageConfig.v2_0_0.SmartStorageConfig
Description Enables or disables predictive spare rebuild mode
Type string or null
Read Only False

The following are the supported values:

Value Description
Enabled Spare drives will replace physical drives that are predicted to fail preemptively
Disabled Spare drives will replace physical drives only when they fail

QueueDepth

Member of SmartStorageConfig.v2_0_0.SmartStorageConfig
Description This sets the maximum number of requests the controller will submit to a drive at any given time
Type string or null
Read Only False

The following are the supported values:

Value Description
Queue2 2 requests
Queue4 4 requests
Queue8 8 requests
Queue16 16 requests
Queue32 32 requests
Automatic Automatically determine the best queue depth for the controller

ReadCachePercent

Member of SmartStorageConfig.v2_0_0.SmartStorageConfig
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
Type integer or null
Read Only False

RebuildPriority

Member of SmartStorageConfig.v2_0_0.SmartStorageConfig
Description The level of priority that rebuilds have over handling current operating system requests
Type string or null
Read Only False

The following are the supported values:

Value Description
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

SurfaceScanAnalysisDelaySeconds

Member of SmartStorageConfig.v2_0_0.SmartStorageConfig
Description Sets the delay of the controller before beginning surface scan analysis. Only valid if SurfaceScanAnalysisPriority is Idle
Type integer or null
Read Only False

SurfaceScanAnalysisPriority

Member of SmartStorageConfig.v2_0_0.SmartStorageConfig
Description Priority that the controller takes to find and correct disk surface errors
Type string or null
Read Only False

The following are the supported values:

Value Description
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

SurvivalPowerMode

Member of SmartStorageConfig.v2_0_0.SmartStorageConfig
Description Enables or Disables survival mode
Type string
Read Only False

The following are the supported values:

Value Description
Enabled The controller will throttle dynamic power settings to their minimum when temperatures exceed the warning threshold
Disabled The controller will not throttle dynamic power settings

WriteCacheBypassThresholdKiB

Member of SmartStorageConfig.v2_0_0.SmartStorageConfig
Description This value sets the write cache bypass threshold, ranging from 16 KiB to 1040 KiB in multiples of 16 KiB, where all writes larger than the specified value in KiB units will bypass the write cache and be written directly to the disk for non-parity RAID volumes
Type integer or null
Read Only False

SoftwareInventory.v1_2_0.SoftwareInventory

@odata.type: "#SoftwareInventory.v1_2_0.SoftwareInventory"

The SoftwareInventory resource describes the inventory of software or firmware components.

Resource Instances

Uri HTTP Allow
/redfish/v1/updateservice/firmwareinventory/{item} GET
/redfish/v1/updateservice/softwareinventory/{item} GET

Manufacturer

Member of SoftwareInventory.v1_2_0.SoftwareInventory
Description The manufacturer or producer of this software.
Type string or null
Read Only True

Oem.Hpe.DeviceClass

Member of SoftwareInventory.v1_2_0.SoftwareInventory
Description DeviceType GUID rendered by iLO for certain items iLO knows how to flash, and omitted for all other items.
Type string or null
Read Only True
Added iLO 5 1.10

Oem.Hpe.DeviceContext

Member of SoftwareInventory.v1_2_0.SoftwareInventory
Description Friendly text string - same as ‘Location’ in fw inventory - omitted if not available.
Type string
Read Only True
Added iLO 5 1.10

Oem.Hpe.DeviceInstance

Member of SoftwareInventory.v1_2_0.SoftwareInventory
Description UEFI Device Path if a PCI Device - omitted otherwise.
Type string
Read Only True
Added iLO 5 1.10

Oem.Hpe.Targets (array)

Member of SoftwareInventory.v1_2_0.SoftwareInventory Targets is an array containing elements of:
Description A GUID indicating iLO’s knowledge of a possible correlation GUIDs vs. components.
Type string or null
Read Only True

Oem.Hpe.Version

Member of SoftwareInventory.v1_2_0.SoftwareInventory
Description NVIDIA CEC Firmware version
Type string or null
Read Only True

RelatedItem (array)

Member of SoftwareInventory.v1_2_0.SoftwareInventory RelatedItem is an array containing elements of:

RelatedItem[{item}].@odata.id Member of SoftwareInventory.v1_2_0.SoftwareInventory
Type string
Read Only True
Format uri-reference

RelatedItem@odata.count

Member of SoftwareInventory.v1_2_0.SoftwareInventory
Description The number of items in a collection.
Type number
Read Only True

SoftwareId

Member of SoftwareInventory.v1_2_0.SoftwareInventory
Description The implementation-specific label that identifies this software.
Type string
Read Only True

Status

Member of SoftwareInventory.v1_2_0.SoftwareInventory See the Redfish standard schema and specification for information on common Status object.

Updateable

Member of SoftwareInventory.v1_2_0.SoftwareInventory
Description This is true if the item is updatable.
Type boolean or null
Read Only True
Added iLO 5 1.10

Version

Member of SoftwareInventory.v1_2_0.SoftwareInventory
Description same as ‘VersionString’ in existing FwSwVersionInventory
Type string or null
Read Only True
Added iLO 5 1.10

SoftwareInventoryCollection.SoftwareInventoryCollection

@odata.type: "#SoftwareInventoryCollection.SoftwareInventoryCollection"

A Collection of SoftwareInventory resource instances.

Resource Instances

Uri HTTP Allow
/redfish/v1/updateservice/firmwareinventory GET
/redfish/v1/updateservice/softwareinventory GET
Link Name Destination type
Members[] SoftwareInventory

Members (array)

Member of SoftwareInventoryCollection.SoftwareInventoryCollection Members is an array containing elements of:

Members[{item}].@odata.id Member of SoftwareInventoryCollection.SoftwareInventoryCollection
Type string
Read Only True
Format uri-reference

Members@odata.count

Member of SoftwareInventoryCollection.SoftwareInventoryCollection
Description The total number of collection members.
Type integer
Read Only True

Storage.v1_12_0.Storage

@odata.type: "#Storage.v1_12_0.Storage"

Storage defines a storage subsystem and its respective properties. A storage subsystem represents a set of storage controllers (physical or virtual) and the resources such as volumes that can be accessed from that subsystem.

Resource Instances

Uri HTTP Allow
/redfish/v1/systems/{item}/storage/{item} GET POST PATCH
Link Name Destination type
Drives[] Drive
Links/Enclosures[] Chassis
Ports Collection of Port
StorageControllers Collection of StorageController
Volumes Collection of Volume

Controllers

The set of controllers instantiated by this storage subsystem. Controllers is a link ("@odata.id": URI) to another resource.

Drives (array)

Member of Storage.v1_12_0.Storage Drives is an array containing elements of:

Drives[{item}].@odata.id Member of Storage.v1_12_0.Storage
Type string
Read Only True
Format uri-reference

Status

Member of Storage.v1_12_0.Storage See the Redfish standard schema and specification for information on common Status object.

StorageControllers (array)

Member of Storage.v1_12_0.Storage StorageControllers is an array containing elements of:

StorageControllers[{item}].@odata.id Member of Storage.v1_12_0.Storage
Type string
Read Only True
Format uri-reference

StorageControllers[{item}].CacheSummary StorageControllers[{item}].CacheSummary.PersistentCacheSizeMiB Member of Storage.v1_12_0.Storage
Description The portion of the cache memory that is persistent, measured in MiB.
Type integer or null
Read Only True

StorageControllers[{item}].CacheSummary.Status Member of Storage.v1_12_0.Storage See the Redfish standard schema and specification for information on common Status object.

StorageControllers[{item}].CacheSummary.TotalCacheSizeMiB Member of Storage.v1_12_0.Storage
Description The total configured cache memory, measured in MiB.
Type integer or null
Read Only True

StorageControllers[{item}].ControllerRates StorageControllers[{item}].ControllerRates.ConsistencyCheckRatePercent Member of Storage.v1_12_0.Storage
Description The percentage of controller resources used for performing a data consistency check on volumes.
Type integer or null
Read Only False

StorageControllers[{item}].ControllerRates.RebuildRatePercent Member of Storage.v1_12_0.Storage
Description The percentage of controller resources used for rebuilding/repairing volumes.
Type integer or null
Read Only False

StorageControllers[{item}].ControllerRates.TransformationRatePercent Member of Storage.v1_12_0.Storage
Description The percentage of controller resources used for transforming volumes from one configuration to another.
Type integer or null
Read Only False

StorageControllers[{item}].FirmwareVersion Member of Storage.v1_12_0.Storage
Description The firmware version of this storage controller.
Type string or null
Read Only True

StorageControllers[{item}].Identifiers (array) Member of Storage.v1_12_0.Storage Identifiers is an array containing elements of:

Identifiers[{item}].DurableName Member of Storage.v1_12_0.Storage
Description The world-wide, persistent name of the resource.
Type string or null
Read Only True

Identifiers[{item}].DurableNameFormat Member of Storage.v1_12_0.Storage
Description The format of the durable name property.
Type string or null
Read Only True

The following are the supported values:

Value Description
NAA The Name Address Authority (NAA) format.
iQN The iSCSI Qualified Name (iQN).
FC_WWN The Fibre Channel (FC) World Wide Name (WWN).
UUID The Universally Unique Identifier (UUID).
EUI The IEEE-defined 64-bit Extended Unique Identifier (EUI).
NQN The NVMe Qualified Name (NQN).
NGUID The Namespace Globally Unique Identifier (NGUID).

StorageControllers[{item}].Location StorageControllers[{item}].Location.PartLocation StorageControllers[{item}].Location.PartLocation.LocationOrdinalValue Member of Storage.v1_12_0.Storage
Description The number that represents the location of the part. If LocationType is slot and this unit is in slot 2, the LocationOrdinalValue is 2.
Type integer or null
Read Only True

StorageControllers[{item}].Location.PartLocation.LocationType Member of Storage.v1_12_0.Storage
Description The location types for PartLocation.
Type string or null
Read Only True

The following are the supported values:

Value Description
Null A value is temporarily unavailable
Slot The slot as the type of location.
Bay The bay as the type of location.
Connector The connector as the type of location.
Socket The socket as the type of location.

StorageControllers[{item}].Location.PartLocation.Orientation Member of Storage.v1_12_0.Storage
Description The orientation for the ordering of the part location ordinal value.
Type string or null
Read Only True

The following are the supported values:

Value Description
Null A value is temporarily unavailable
FrontToBack The ordering for LocationOrdinalValue is front to back.
BackToFront The ordering for the LocationOrdinalValue is back to front.
TopToBottom The ordering for the LocationOrdinalValue is top to bottom.
BottomToTop The ordering for LocationOrdinalValue is bottom to top.
LeftToRight The ordering for the LocationOrdinalValue is left to right.
RightToLeft The ordering for the LocationOrdinalValue is right to left.

StorageControllers[{item}].Location.PartLocation.Reference Member of Storage.v1_12_0.Storage
Description The reference area for the location of the part.
Type string or null
Read Only True

The following are the supported values:

Value Description
Null A value is temporarily unavailable
Top The part is in the top of the unit.
Bottom The part is in the bottom of the unit.
Front The part is in the front of the unit.
Rear The part is in the rear of the unit.
Left The part is on the left side of of the unit.
Right The part is on the right side of the unit.
Middle The part is in the middle of the unit.

StorageControllers[{item}].Location.PartLocation.ServiceLabel Member of Storage.v1_12_0.Storage
Description The label of the part location, such as a silk-screened name or a printed label.
Type string or null
Read Only True

StorageControllers[{item}].Location.Placement StorageControllers[{item}].Location.Placement.AdditionalInfo Member of Storage.v1_12_0.Storage
Description Area designation or other additional info.
Type string or null
Read Only False

StorageControllers[{item}].Location.Placement.Rack Member of Storage.v1_12_0.Storage
Description The name of a rack location within a row.
Type string or null
Read Only False

StorageControllers[{item}].Location.Placement.RackOffset Member of Storage.v1_12_0.Storage
Description The vertical location of the item, in terms of RackOffsetUnits.
Type integer or null
Read Only False

StorageControllers[{item}].Location.Placement.RackOffsetUnits Member of Storage.v1_12_0.Storage
Description The type of rack unit in use.
Type string or null
Read Only False

The following are the supported values:

Value Description
Null A value is temporarily unavailable
OpenU A rack unit that is equal to 48 mm (1.89 in).
EIA_310 A rack unit that is equal to 1.75 in (44.45 mm).

StorageControllers[{item}].Location.Placement.Row Member of Storage.v1_12_0.Storage
Description The name of the row.
Type string or null
Read Only False

StorageControllers[{item}].Manufacturer Member of Storage.v1_12_0.Storage
Description Controller Manufacturer name.
Type string or null
Read Only True
Added iLO 5 1.10

StorageControllers[{item}].MemberId Member of Storage.v1_12_0.Storage
Description This is the identifier for the member within the collection.
Type string
Read Only True
Added iLO 5 1.40

StorageControllers[{item}].Model Member of Storage.v1_12_0.Storage
Description Controller model name.
Type string or null
Read Only True
Added iLO 5 1.10

StorageControllers[{item}].PCIeInterface StorageControllers[{item}].PCIeInterface.LanesInUse Member of Storage.v1_12_0.Storage
Description This is the number of PCIe lanes in use by this device.
Type integer or null
Read Only True

StorageControllers[{item}].PCIeInterface.MaxLanes Member of Storage.v1_12_0.Storage
Description This is the number of PCIe lanes supported by this device.
Type integer or null
Read Only True

StorageControllers[{item}].PCIeInterface.MaxPCIeType Member of Storage.v1_12_0.Storage
Description The highest version of the PCIe specification supported by this device.
Type string
Read Only True

The following are the supported values:

Value Description
Gen1 A PCIe v1.0 slot.
Gen2 A PCIe v2.0 slot.
Gen3 A PCIe v3.0 slot.
Gen4 A PCIe v4.0 slot.
Gen5 A PCIe v5.0 slot.

StorageControllers[{item}].PCIeInterface.PCIeType Member of Storage.v1_12_0.Storage
Description The version of the PCIe specification in use by this device.
Type string
Read Only True

The following are the supported values:

Value Description
Gen1 A PCIe v1.0 slot.
Gen2 A PCIe v2.0 slot.
Gen3 A PCIe v3.0 slot.
Gen4 A PCIe v4.0 slot.
Gen5 A PCIe v5.0 slot.

StorageControllers[{item}].PartNumber Member of Storage.v1_12_0.Storage
Description The part number for this storage controller.
Type string or null
Read Only True

StorageControllers[{item}].SKU Member of Storage.v1_12_0.Storage
Description The SKU for this storage controller.
Type string or null
Read Only True

StorageControllers[{item}].SerialNumber Member of Storage.v1_12_0.Storage
Description Controller serial number.
Type string or null
Read Only True
Added iLO 5 1.10

StorageControllers[{item}].SpeedGbps Member of Storage.v1_12_0.Storage
Description The maximum speed of the storage controller’s device interface.
Type number or null
Read Only True

StorageControllers[{item}].Status Member of Storage.v1_12_0.Storage See the Redfish standard schema and specification for information on common Status object.

StorageControllers[{item}].SupportedControllerProtocols (array) Member of Storage.v1_12_0.Storage SupportedControllerProtocols is an array containing elements of:
Type string
Read Only True

The following are the supported values:

Value
PCIe

StorageControllers[{item}].SupportedDeviceProtocols (array) Member of Storage.v1_12_0.Storage SupportedDeviceProtocols is an array containing elements of:
Type string
Read Only True

The following are the supported values:

Value Description
NVMe Non-Volatile Memory Express (NVMe).
SAS Serial Attached SCSI.
SATA Serial AT Attachment.
USB Universal Serial Bus (USB).

StorageControllers[{item}].SupportedRAIDTypes (array) Member of Storage.v1_12_0.Storage SupportedRAIDTypes is an array containing elements of:
Type string
Read Only True

The following are the supported values:

Value Description
RAID0 A placement policy where consecutive logical blocks of data are uniformly distributed across a set of independent storage devices without offering any form of redundancy.
RAID1 A placement policy where each logical block of data is stored on more than one independent storage device.
RAID3 A placement policy using parity-based protection where logical bytes of data are uniformly distributed across a set of independent storage devices and where the parity is stored on a dedicated independent storage device.
RAID4 A placement policy using parity-based protection where logical blocks of data are uniformly distributed across a set of independent storage devices and where the parity is stored on a dedicated independent storage device.
RAID5 A placement policy using parity-based protection for storing stripes of ‘n’ logical blocks of data and one logical block of parity across a set of ‘n+1’ independent storage devices where the parity and data blocks are interleaved across the storage devices.
RAID6 A placement policy using parity-based protection for storing stripes of ‘n’ logical blocks of data and two logical blocks of independent parity across a set of ‘n+2’ independent storage devices where the parity and data blocks are interleaved across the storage devices.
RAID10 A placement policy that creates a striped device (RAID 0) over a set of mirrored devices (RAID 1).
RAID01 A data placement policy that creates a mirrored device (RAID 1) over a set of striped devices (RAID 0).
RAID6TP A placement policy that uses parity-based protection for storing stripes of ‘n’ logical blocks of data and three logical blocks of independent parity across a set of ‘n+3’ independent storage devices where the parity and data blocks are interleaved across the storage devices.
RAID1E A placement policy that uses a form of mirroring implemented over a set of independent storage devices where logical blocks are duplicated on a pair of independent storage devices so that data is uniformly distributed across the storage devices.
RAID50 A placement policy that uses a RAID 0 stripe set over two or more RAID 5 sets of independent storage devices.
RAID60 A placement policy that uses a RAID 0 stripe set over two or more RAID 6 sets of independent storage devices.
RAID00 A placement policy that creates a RAID 0 stripe set over two or more RAID 0 sets.
RAID10E A placement policy that uses a RAID 0 stripe set over two or more RAID 10 sets.
RAID1Triple A placement policy where each logical block of data is mirrored three times across a set of three independent storage devices.
RAID10Triple A placement policy that uses a striped device (RAID 0) over a set of triple mirrored devices (RAID 1Triple).
None A placement policy with no redundancy at the device level.

Volumes

A reference to the Volumes associated with this storage system. Volumes is a link ("@odata.id": URI) to another resource.

StorageCollection.StorageCollection

@odata.type: "#StorageCollection.StorageCollection"

A Collection of Storage resource instances.

Resource Instances

Uri HTTP Allow
/redfish/v1/systems/{item}/storage GET
Link Name Destination type
Members[] Storage

Members (array)

Member of StorageCollection.StorageCollection Members is an array containing elements of:

Members[{item}].@odata.id Member of StorageCollection.StorageCollection
Type string
Read Only True
Format uri-reference

Members@odata.count

Member of StorageCollection.StorageCollection
Description The total number of collection members.
Type integer
Read Only True

StorageController.v1_0_0.StorageController

@odata.type: "#StorageController.v1_0_0.StorageController"

The StorageController schema describes a storage controller and its properties. A storage controller represents a physical or virtual storage device that produces volumes.

Resource Instances

Uri HTTP Allow
/redfish/v1/systems/{item}/storage/{item}/controllers/{item} GET

AssetTag

Member of StorageController.v1_0_0.StorageController
Description The user-assigned asset tag for this storage controller.
Type string or null
Read Only False

CacheSummary

CacheSummary.PersistentCacheSizeMiB Member of StorageController.v1_0_0.StorageController
Description The portion of the cache memory that is persistent, measured in MiB.
Type integer or null
Read Only True

CacheSummary.Status Member of StorageController.v1_0_0.StorageController See the Redfish standard schema and specification for information on common Status object.

CacheSummary.TotalCacheSizeMiB Member of StorageController.v1_0_0.StorageController
Description The total configured cache memory, measured in MiB.
Type integer or null
Read Only True

ControllerRates

ControllerRates.ConsistencyCheckRatePercent Member of StorageController.v1_0_0.StorageController
Description The percentage of controller resources used for performing a data consistency check on volumes.
Type integer or null
Read Only False

ControllerRates.RebuildRatePercent Member of StorageController.v1_0_0.StorageController
Description The percentage of controller resources used for rebuilding/repairing volumes.
Type integer or null
Read Only False

ControllerRates.TransformationRatePercent Member of StorageController.v1_0_0.StorageController
Description The percentage of controller resources used for transforming volumes from one configuration to another.
Type integer or null
Read Only False

FirmwareVersion

Member of StorageController.v1_0_0.StorageController
Description The firmware version of this storage controller.
Type string or null
Read Only True

Identifiers (array)

Member of StorageController.v1_0_0.StorageController Identifiers is an array containing elements of:

Identifiers[{item}].DurableName Member of StorageController.v1_0_0.StorageController
Description The world-wide, persistent name of the resource.
Type string or null
Read Only True

Identifiers[{item}].DurableNameFormat Member of StorageController.v1_0_0.StorageController
Description The format of the durable name property.
Type string or null
Read Only True

The following are the supported values:

Value Description
NAA The Name Address Authority (NAA) format.
iQN The iSCSI Qualified Name (iQN).
FC_WWN The Fibre Channel (FC) World Wide Name (WWN).
UUID The Universally Unique Identifier (UUID).
EUI The IEEE-defined 64-bit Extended Unique Identifier (EUI).
NQN The NVMe Qualified Name (NQN).
NGUID The Namespace Globally Unique Identifier (NGUID).

Location

Location.PartLocation Location.PartLocation.LocationOrdinalValue Member of StorageController.v1_0_0.StorageController
Description The number that represents the location of the part. If LocationType is slot and this unit is in slot 2, the LocationOrdinalValue is 2.
Type integer or null
Read Only True

Location.PartLocation.LocationType Member of StorageController.v1_0_0.StorageController
Description The location types for PartLocation.
Type string or null
Read Only True

The following are the supported values:

Value Description
Null A value is temporarily unavailable
Slot The slot as the type of location.
Bay The bay as the type of location.
Connector The connector as the type of location.
Socket The socket as the type of location.

Location.PartLocation.Orientation Member of StorageController.v1_0_0.StorageController
Description The orientation for the ordering of the part location ordinal value.
Type string or null
Read Only True

The following are the supported values:

Value Description
Null A value is temporarily unavailable
FrontToBack The ordering for LocationOrdinalValue is front to back.
BackToFront The ordering for the LocationOrdinalValue is back to front.
TopToBottom The ordering for the LocationOrdinalValue is top to bottom.
BottomToTop The ordering for LocationOrdinalValue is bottom to top.
LeftToRight The ordering for the LocationOrdinalValue is left to right.
RightToLeft The ordering for the LocationOrdinalValue is right to left.

Location.PartLocation.Reference Member of StorageController.v1_0_0.StorageController
Description The reference area for the location of the part.
Type string or null
Read Only True

The following are the supported values:

Value Description
Null A value is temporarily unavailable
Top The part is in the top of the unit.
Bottom The part is in the bottom of the unit.
Front The part is in the front of the unit.
Rear The part is in the rear of the unit.
Left The part is on the left side of of the unit.
Right The part is on the right side of the unit.
Middle The part is in the middle of the unit.

Location.PartLocation.ServiceLabel Member of StorageController.v1_0_0.StorageController
Description The label of the part location, such as a silk-screened name or a printed label.
Type string or null
Read Only True

Location.Placement Location.Placement.AdditionalInfo Member of StorageController.v1_0_0.StorageController
Description Area designation or other additional info.
Type string or null
Read Only False

Location.Placement.Rack Member of StorageController.v1_0_0.StorageController
Description The name of a rack location within a row.
Type string or null
Read Only False

Location.Placement.RackOffset Member of StorageController.v1_0_0.StorageController
Description The vertical location of the item, in terms of RackOffsetUnits.
Type integer or null
Read Only False

Location.Placement.RackOffsetUnits Member of StorageController.v1_0_0.StorageController
Description The type of rack unit in use.
Type string or null
Read Only False

The following are the supported values:

Value Description
Null A value is temporarily unavailable
OpenU A rack unit that is equal to 48 mm (1.89 in).
EIA_310 A rack unit that is equal to 1.75 in (44.45 mm).

Location.Placement.Row Member of StorageController.v1_0_0.StorageController
Description The name of the row.
Type string or null
Read Only False

Manufacturer

Member of StorageController.v1_0_0.StorageController
Description The manufacturer of this storage controller.
Type string or null
Read Only True

Model

Member of StorageController.v1_0_0.StorageController
Description The model number for the storage controller.
Type string or null
Read Only True

PCIeInterface

PCIeInterface.LanesInUse Member of StorageController.v1_0_0.StorageController
Description This is the number of PCIe lanes in use by this device.
Type integer or null
Read Only True

PCIeInterface.MaxLanes Member of StorageController.v1_0_0.StorageController
Description This is the number of PCIe lanes supported by this device.
Type integer or null
Read Only True

PCIeInterface.MaxPCIeType Member of StorageController.v1_0_0.StorageController
Description The highest version of the PCIe specification supported by this device.
Type string
Read Only True

The following are the supported values:

Value Description
Gen1 A PCIe v1.0 slot.
Gen2 A PCIe v2.0 slot.
Gen3 A PCIe v3.0 slot.
Gen4 A PCIe v4.0 slot.
Gen5 A PCIe v5.0 slot.

PCIeInterface.PCIeType Member of StorageController.v1_0_0.StorageController
Description The version of the PCIe specification in use by this device.
Type string
Read Only True

The following are the supported values:

Value Description
Gen1 A PCIe v1.0 slot.
Gen2 A PCIe v2.0 slot.
Gen3 A PCIe v3.0 slot.
Gen4 A PCIe v4.0 slot.
Gen5 A PCIe v5.0 slot.

PartNumber

Member of StorageController.v1_0_0.StorageController
Description The part number for this storage controller.
Type string or null
Read Only True

SKU

Member of StorageController.v1_0_0.StorageController
Description The SKU for this storage controller.
Type string or null
Read Only True

SerialNumber

Member of StorageController.v1_0_0.StorageController
Description The serial number for this storage controller.
Type string or null
Read Only True

SpeedGbps

Member of StorageController.v1_0_0.StorageController
Description The maximum speed of the storage controller’s device interface.
Type number or null
Read Only True

Status

Member of StorageController.v1_0_0.StorageController See the Redfish standard schema and specification for information on common Status object.

SupportedControllerProtocols (array)

Member of StorageController.v1_0_0.StorageController SupportedControllerProtocols is an array containing elements of:
Type string or null
Read Only True

The following are the supported values:

Value Description
SAS Serial Attached SCSI.
NVMe Non-Volatile Memory Express
SATA Serial AT Attachment
USB Universal Serial Bus
PCIe PCI Express

SupportedDeviceProtocols (array)

Member of StorageController.v1_0_0.StorageController SupportedDeviceProtocols is an array containing elements of:
Type string or null
Read Only True

The following are the supported values:

Value Description
SAS Serial Attached SCSI.
NVMe Non-Volatile Memory Express
SATA Serial AT Attachment
USB Universal Serial Bus
PCIe PCI Express

SupportedRAIDTypes (array)

Member of StorageController.v1_0_0.StorageController SupportedRAIDTypes is an array containing elements of:
Type string
Read Only True

The following are the supported values:

Value Description
RAID0 A placement policy where consecutive logical blocks of data are uniformly distributed across a set of independent storage devices without offering any form of redundancy.
RAID1 A placement policy where each logical block of data is stored on more than one independent storage device.
RAID3 A placement policy using parity-based protection where logical bytes of data are uniformly distributed across a set of independent storage devices and where the parity is stored on a dedicated independent storage device.
RAID4 A placement policy using parity-based protection where logical blocks of data are uniformly distributed across a set of independent storage devices and where the parity is stored on a dedicated independent storage device.
RAID5 A placement policy using parity-based protection for storing stripes of ‘n’ logical blocks of data and one logical block of parity across a set of ‘n+1’ independent storage devices where the parity and data blocks are interleaved across the storage devices.
RAID6 A placement policy using parity-based protection for storing stripes of ‘n’ logical blocks of data and two logical blocks of independent parity across a set of ‘n+2’ independent storage devices where the parity and data blocks are interleaved across the storage devices.
RAID10 A placement policy that creates a striped device (RAID 0) over a set of mirrored devices (RAID 1).
RAID01 A data placement policy that creates a mirrored device (RAID 1) over a set of striped devices (RAID 0).
RAID6TP A placement policy that uses parity-based protection for storing stripes of ‘n’ logical blocks of data and three logical blocks of independent parity across a set of ‘n+3’ independent storage devices where the parity and data blocks are interleaved across the storage devices.
RAID1E A placement policy that uses a form of mirroring implemented over a set of independent storage devices where logical blocks are duplicated on a pair of independent storage devices so that data is uniformly distributed across the storage devices.
RAID50 A placement policy that uses a RAID 0 stripe set over two or more RAID 5 sets of independent storage devices.
RAID60 A placement policy that uses a RAID 0 stripe set over two or more RAID 6 sets of independent storage devices.
RAID00 A placement policy that creates a RAID 0 stripe set over two or more RAID 0 sets.
RAID10E A placement policy that uses a RAID 0 stripe set over two or more RAID 10 sets.
RAID1Triple A placement policy where each logical block of data is mirrored three times across a set of three independent storage devices.
RAID10Triple A placement policy that uses a striped device (RAID 0) over a set of triple mirrored devices (RAID 1Triple).
None A placement policy with no redundancy at the device level.

StorageControllerCollection.StorageControllerCollection

@odata.type: "#StorageControllerCollection.StorageControllerCollection"

A Collection of Storage resource instances.

Resource Instances

Uri HTTP Allow
/redfish/v1/systems/{item}/storage/{item}/controllers/ GET
Link Name Destination type
Members[] StorageController

Members (array)

Member of StorageControllerCollection.StorageControllerCollection Members is an array containing elements of:

Members[{item}].@odata.id Member of StorageControllerCollection.StorageControllerCollection
Type string
Read Only True
Format uri-reference

Members@odata.count

Member of StorageControllerCollection.StorageControllerCollection
Description The total number of collection members.
Type integer
Read Only True

Task.v1_3_0.Task

@odata.type: "#Task.v1_3_0.Task"

The Task resource describes a specific Task scheduled by or being executed by a Redfish service’s Task Service.

Resource Instances

Uri HTTP Allow
/redfish/v1/taskservice/tasks/{item} GET

EndTime

Member of Task.v1_3_0.Task
Description The date-time stamp that the task was last completed.
Type string
Read Only True
Added iLO 5 1.40
Format date-time

Messages (array)

Member of Task.v1_3_0.Task Messages is an array containing elements of:

Messages[{item}].Message Member of Task.v1_3_0.Task
Description This is the human readable message, if provided.
Type string or null
Read Only True
Added iLO 5 1.40

Messages[{item}].MessageArgs (array) Member of Task.v1_3_0.Task MessageArgs is an array containing elements of:
Type string
Read Only True

Messages[{item}].MessageId Member of Task.v1_3_0.Task
Description This is the key for this message which can be used to look up the message in a message registry.
Type string
Read Only True
Added iLO 5 1.40

Messages[{item}].RelatedProperties (array) Member of Task.v1_3_0.Task RelatedProperties is an array containing elements of:
Type string
Read Only True

Messages[{item}].Resolution Member of Task.v1_3_0.Task
Description Used to provide suggestions on how to resolve the situation that caused the error.
Type string or null
Read Only True
Added iLO 5 1.40

Messages[{item}].Severity Member of Task.v1_3_0.Task
Description This is the severity of the event.
Type string
Read Only True
Added iLO 5 1.40

The following are the supported values:

Value Description
OK Normal
Warning A condition exists that requires attention
Critical A critical condition exists that requires immediate attention

Payload

Payload.HttpHeaders (array) Member of Task.v1_3_0.Task HttpHeaders is an array containing elements of:
Type string
Read Only True

Payload.HttpOperation Member of Task.v1_3_0.Task
Description The HTTP operation to perform to execute this Task.
Type string
Read Only True
Added iLO 5 1.40

Payload.JsonBody Member of Task.v1_3_0.Task
Description This property contains the JSON payload to use in the execution of this Task.
Type string
Read Only True
Added iLO 5 1.40

Payload.TargetUri Member of Task.v1_3_0.Task
Description The URI of the target for this task.
Type string
Read Only True
Added iLO 5 1.40
Format uri-reference

StartTime

Member of Task.v1_3_0.Task
Description The date-time stamp that the task was last started.
Type string
Read Only True
Added iLO 5 1.40
Format date-time

TaskMonitor

Member of Task.v1_3_0.Task
Description The URI of the Task Monitor for this task.
Type string or null
Read Only True
Added iLO 5 1.40
Format uri-reference

TaskState

Member of Task.v1_3_0.Task
Description The state of the task.
Type string
Read Only True
Added iLO 5 1.40

The following are the supported values:

Value Description
New A new task.
Starting Task is starting.
Running Task is running normally.
Suspended Task has been suspended.
Interrupted Task has been interrupted.
Pending Task is pending and has not started.
Stopping Task is in the process of stopping.
Completed Task has completed.
Killed Task was terminated.
Exception Task has stopped due to an exception condition.
Service Task is running as a service.

TaskStatus

Member of Task.v1_3_0.Task
Description This is the completion status of the task.
Type string
Read Only True
Added iLO 5 1.40

The following are the supported values:

Value Description
OK Normal.
Warning A condition exists that requires attention.
Critical A critical condition exists that requires immediate attention.

TaskCollection.TaskCollection

@odata.type: "#TaskCollection.TaskCollection"

A Collection of Task resource instances.

Resource Instances

Uri HTTP Allow
/redfish/v1/taskservice/tasks GET
Link Name Destination type
Members[] Task

Members (array)

Member of TaskCollection.TaskCollection Members is an array containing elements of:

Members[{item}].@odata.id Member of TaskCollection.TaskCollection
Type string
Read Only True
Format uri-reference

Members@odata.count

Member of TaskCollection.TaskCollection
Description The total number of collection members.
Type integer
Read Only True

TaskService.v1_1_1.TaskService

@odata.type: "#TaskService.v1_1_1.TaskService"

The TaskService resource describes the Task service. It represents the properties for the service itself and has links to the actual list of tasks.

Resource Instances

Uri HTTP Allow
/redfish/v1/taskservice GET
Link Name Destination type
Tasks Collection of Task

CompletedTaskOverWritePolicy

Member of TaskService.v1_1_1.TaskService
Type string
Read Only True
Added iLO 5 1.40

The following are the supported values:

Value Description
Manual Completed tasks are not automatically overwritten.
Oldest Oldest completed tasks are overwritten.

DateTime

Member of TaskService.v1_1_1.TaskService
Description The current DateTime (with offset) setting that the task service is using.
Type string or null
Read Only True
Added iLO 5 1.40
Format date-time

LifeCycleEventOnTaskStateChange

Member of TaskService.v1_1_1.TaskService
Description Send an Event upon Task State Change.
Type boolean
Read Only True
Added iLO 5 1.40

ServiceEnabled

Member of TaskService.v1_1_1.TaskService
Description This indicates whether this service is enabled.
Type boolean or null
Read Only True
Added iLO 5 1.40

Status

Member of TaskService.v1_1_1.TaskService See the Redfish standard schema and specification for information on common Status object.

Tasks

This property references a resource of type Collection with a MemberType of TaskCollection. Tasks is a link ("@odata.id": URI) to another resource.

TelemetryService.v1_0_0.TelemetryService

@odata.type: "#TelemetryService.v1_0_0.TelemetryService"

The TelemetryService resource describes the Metrics Service.

Telemetry not supported on AMD platforms

Telemetry Service is supported only on Intel platform. On AMD systems, performing GET on /redfish/v1/TelemetryService will return 400 Error Operation not supported.

Resource Instances

Uri HTTP Allow
/redfish/v1/telemetryservice GET
Link Name Destination type
MetricReportDefinitions Collection of MetricDefinition
MetricReports Collection of MetricReport
Triggers Collection of Triggers

MaxReports

Member of TelemetryService.v1_0_0.TelemetryService
Description The maximum number of metric reports supported by this service.
Type integer or null
Read Only True
Added iLO 5 1.40

MetricDefinitions

A link to the collection of Metric Definitions. MetricDefinitions is a link ("@odata.id": URI) to another resource.

MetricReportDefinitions

A link to the collection of Metric Reports. MetricReportDefinitions is a link ("@odata.id": URI) to another resource.

MetricReports

A link to the collection of Metric Reports. MetricReports is a link ("@odata.id": URI) to another resource.

MinCollectionInterval

Member of TelemetryService.v1_0_0.TelemetryService
Description The minimum time interval between collections supported by this service.
Type string or null
Read Only True
Added iLO 5 1.40

Status

Member of TelemetryService.v1_0_0.TelemetryService See the Redfish standard schema and specification for information on common Status object.

SupportedCollectionFunctions (array)

Member of TelemetryService.v1_0_0.TelemetryService SupportedCollectionFunctions is an array containing elements of:
Description An operation to perform over the sample.
Type string
Read Only True

The following are the supported values:

Value Description
Average An averaging function.
Maximum A maximum function.
Minimum A minimum function.
Summation A summation function.

Triggers

A link to the collection of Triggers, which apply to metrics. Triggers is a link ("@odata.id": URI) to another resource.

Thermal.v1_7_1.Thermal

@odata.type: "#Thermal.v1_7_1.Thermal"

The Thermal resource describes the system thermal metrics. It represents the properties for temperature and cooling.

Resource Instances

Uri HTTP Allow
/redfish/v1/chassis/{item}/thermal GET POST PATCH

Fans (array)

Member of Thermal.v1_7_1.Thermal Fans is an array containing elements of:

Fans[{item}].@odata.id Member of Thermal.v1_7_1.Thermal
Type string
Read Only True
Format uri-reference

Fans[{item}].CorrelatableID Member of Thermal.v1_7_1.Thermal
Description The CorrelatableID for this fan.
Type string or null
Read Only True
Added iLO 5 1.10

Fans[{item}].LowerThresholdCritical Member of Thermal.v1_7_1.Thermal
Description Below normal range but not yet fatal.
Type integer or null
Read Only True
Added iLO 5 1.10

Fans[{item}].LowerThresholdFatal Member of Thermal.v1_7_1.Thermal
Description Below normal range and is fatal.
Type integer or null
Read Only True
Added iLO 5 1.10

Fans[{item}].LowerThresholdNonCritical Member of Thermal.v1_7_1.Thermal
Description Below normal range.
Type integer or null
Read Only True
Added iLO 5 1.10

Fans[{item}].MaximumValue Member of Thermal.v1_7_1.Thermal
Description Maximum value for CurrentReading.
Type integer or null
Read Only True
Added iLO 5 1.10

Fans[{item}].MemberId Member of Thermal.v1_7_1.Thermal
Description This is the identifier for the member within the collection.
Type string
Read Only True
Added iLO 5 1.40

Fans[{item}].MinimumValue Member of Thermal.v1_7_1.Thermal
Description Minimum value for CurrentReading.
Type integer or null
Read Only True
Added iLO 5 1.10

Fans[{item}].Oem.Hpe.HotPluggable Member of Thermal.v1_7_1.Thermal
Description Indicates if the fan can be replaced while server is running.
Type boolean
Read Only True
Added iLO 5 1.10

Fans[{item}].Oem.Hpe.IsLiquidCooling Member of Thermal.v1_7_1.Thermal
Description Indicates that the device is Liquid cooling device or not.
Type boolean
Read Only True

Fans[{item}].Oem.Hpe.Location Member of Thermal.v1_7_1.Thermal
Description Indicates the component (i.e. CPU, Memory, and Storage) that the fan is being used to cool.
Type string
Read Only True
Added iLO 5 1.10

The following are the supported values:

Value
System
System Board
I/O Board
CPU
Memory
Storage
Removable Media
Power Supply
Ambient
Chassis
Bridge Board
Exhaust
Processor Bay
IO Bay
Blade Slot
Virtual

Fans[{item}].Oem.Hpe.Redundant Member of Thermal.v1_7_1.Thermal
Description Indicates if the fan is in a redundant configuration.
Type boolean
Read Only True
Added iLO 5 1.10

Fans[{item}].PhysicalContext Member of Thermal.v1_7_1.Thermal
Type string
Read Only True
Added iLO 5 1.10

The following are the supported values:

Value Description
Room The room
Intake The intake point of the chassis
Exhaust The exhaust point of the chassis
Front The front of the chassis
Back The back of the chassis
Upper The upper portion of the chassis
Lower The lower portion of the chassis
CPU A Processor (CPU)
GPU A Graphics Processor (GPU)
Backplane A backplane within the chassis
SystemBoard The system board (PCB)
PowerSupply A power supply
VoltageRegulator A voltage regulator device
StorageDevice A storage device
NetworkingDevice A networking device
ComputeBay Within a compute bay
StorageBay Within a storage bay
NetworkBay Within a networking bay
ExpansionBay Within an expansion bay
PowerSupplyBay Within a power supply bay

Fans[{item}].Reading Member of Thermal.v1_7_1.Thermal
Description The current speed of the fan.
Type integer or null
Read Only True
Added iLO 5 1.10

Fans[{item}].ReadingUnits Member of Thermal.v1_7_1.Thermal
Description Units for the CurrentReading.
Type string or null
Read Only True
Added iLO 5 1.10

The following are the supported values:

Value
Null
Percent

Fans[{item}].Status Member of Thermal.v1_7_1.Thermal See the Redfish standard schema and specification for information on common Status object.

Fans[{item}].UpperThresholdCritical Member of Thermal.v1_7_1.Thermal
Description Above normal range but not yet fatal.
Type integer or null
Read Only True
Added iLO 5 1.10

Fans[{item}].UpperThresholdFatal Member of Thermal.v1_7_1.Thermal
Description Above normal range and is fatal.
Type integer or null
Read Only True
Added iLO 5 1.10

Fans[{item}].UpperThresholdNonCritical Member of Thermal.v1_7_1.Thermal
Description Above normal range.
Type integer or null
Read Only True
Added iLO 5 1.10

Oem.Hpe.FanPercentAdjust

Member of Thermal.v1_7_1.Thermal
Description System-wide setting for fan +/- percentage adjustment.
Type integer
Read Only False
Added iLO 5 1.10

Oem.Hpe.FanPercentMinimum

Member of Thermal.v1_7_1.Thermal
Description System-wide setting for fan speed minimum percentage.
Type integer
Read Only False

Oem.Hpe.ThermalConfiguration

Member of Thermal.v1_7_1.Thermal
Description The value of this property selects the fan cooling method for the system.
Type string
Read Only False

The following are the supported values:

Value Description
OptimalCooling
IncreasedCooling
MaximumCooling
EnhancedCooling
AcousticMode Edgeline-only option. Prioritizes minimizing noise from the enclosure.

Status

Member of Thermal.v1_7_1.Thermal See the Redfish standard schema and specification for information on common Status object.

Temperatures (array)

Member of Thermal.v1_7_1.Thermal Temperatures is an array containing elements of:

Temperatures[{item}].@odata.id Member of Thermal.v1_7_1.Thermal
Type string
Read Only True
Format uri-reference

Temperatures[{item}].CorrelatableID Member of Thermal.v1_7_1.Thermal
Description The CorrelatableID for this temperature sensor.
Type string or null
Read Only True
Added iLO 5 1.10

Temperatures[{item}].LowerThresholdCritical Member of Thermal.v1_7_1.Thermal
Description Below normal range but not yet fatal.
Type number or null
Read Only True
Added iLO 5 1.10

Temperatures[{item}].LowerThresholdFatal Member of Thermal.v1_7_1.Thermal
Description Below normal range and is fatal.
Type number or null
Read Only True
Added iLO 5 1.10

Temperatures[{item}].LowerThresholdNonCritical Member of Thermal.v1_7_1.Thermal
Description Below normal range.
Type number or null
Read Only True
Added iLO 5 1.10

Temperatures[{item}].MaximumValue Member of Thermal.v1_7_1.Thermal
Description Maximum value for CurrentReading.
Type integer or null
Read Only True
Added iLO 5 1.10

Temperatures[{item}].MemberId Member of Thermal.v1_7_1.Thermal
Description This is the identifier for the member within the collection.
Type string
Read Only True
Added iLO 5 1.40

Temperatures[{item}].MinimumValue Member of Thermal.v1_7_1.Thermal
Description Minimum value for CurrentReading.
Type integer or null
Read Only True
Added iLO 5 1.10

Temperatures[{item}].Oem.Hpe.CriticalTempUserThreshold Member of Thermal.v1_7_1.Thermal
Description User provided temperature threshold value for the sensor that results in a critical alert.
Type integer
Read Only True

Temperatures[{item}].Oem.Hpe.LocationXmm Member of Thermal.v1_7_1.Thermal
Description The location of the sensor, in millimeters, along the X axis from the logical reference point.
Type integer
Read Only True
Added iLO 5 1.10

Temperatures[{item}].Oem.Hpe.LocationYmm Member of Thermal.v1_7_1.Thermal
Description The location of the sensor, in millimeters, along the Y axis from the logical reference point.
Type integer
Read Only True
Added iLO 5 1.10

Temperatures[{item}].Oem.Hpe.LocationZmm Member of Thermal.v1_7_1.Thermal
Description The location of the sensor, in millimeters, along the Z axis from the logical reference point.
Type integer
Read Only True
Added iLO 5 1.10

Temperatures[{item}].Oem.Hpe.MainSensorName Member of Thermal.v1_7_1.Thermal
Description Sensor name of main temperature sensor that has atleast one sub sensor
Type string
Read Only True

Temperatures[{item}].Oem.Hpe.WarningTempUserThreshold Member of Thermal.v1_7_1.Thermal
Description User provided temperature threshold value for the sensor that results in a warning alert.
Type integer
Read Only True

Temperatures[{item}].PhysicalContext Member of Thermal.v1_7_1.Thermal
Type string
Read Only True
Added iLO 5 1.10

The following are the supported values:

Value Description
Room The room.
Intake The air intake point or points or region of the chassis.
Exhaust The air exhaust point or points or region of the chassis.
LiquidInlet The liquid inlet point of the chassis.
LiquidOutlet The liquid outlet point of the chassis.
Front The front of the chassis.
Back The back of the chassis.
Upper The upper portion of the chassis.
Lower The lower portion of the chassis.
CPU A processor (CPU).
CPUSubsystem The entire processor (CPU) subsystem.
GPU A graphics processor (GPU).
GPUSubsystem The entire graphics processor (GPU) subsystem.
FPGA An FPGA.
Accelerator An accelerator.
ASIC An ASIC device, such as a networking chip or chipset component.
Backplane A backplane within the chassis.
SystemBoard The system board (PCB).
PowerSupply A power supply.
PowerSubsystem The entire power subsystem.
VoltageRegulator A voltage regulator device.
Rectifier A rectifier device.
StorageDevice A storage device.
NetworkingDevice A networking device.
ComputeBay Within a compute bay.
StorageBay Within a storage bay.
NetworkBay Within a networking bay.
ExpansionBay Within an expansion bay.
PowerSupplyBay Within a power supply bay.
Memory A memory device.
MemorySubsystem The entire memory subsystem.
Chassis The entire chassis.
Fan A fan.
CoolingSubsystem The entire cooling, or air and liquid, subsystem.
Motor A motor.
Transformer A transformer.
ACUtilityInput An AC utility input.
ACStaticBypassInput An AC static bypass input.
ACMaintenanceBypassInput An AC maintenance bypass input.
DCBus A DC bus.
ACOutput An AC output.
ACInput An AC input.
TrustedModule A trusted module.
Board A circuit board.
Transceiver A transceiver.
Battery A battery.
Pump A pump.

Temperatures[{item}].ReadingCelsius Member of Thermal.v1_7_1.Thermal
Description The current reading of the temperature sensor.
Type integer or null
Read Only True
Added iLO 5 1.10

Temperatures[{item}].SensorNumber Member of Thermal.v1_7_1.Thermal
Description A numerical identifier to represent the temperature sensor.
Type integer or null
Read Only True
Added iLO 5 1.10

Temperatures[{item}].Status Member of Thermal.v1_7_1.Thermal See the Redfish standard schema and specification for information on common Status object.

Temperatures[{item}].UpperThresholdCritical Member of Thermal.v1_7_1.Thermal
Description Above normal range but not yet fatal.
Type number or null
Read Only True
Added iLO 5 1.10

Temperatures[{item}].UpperThresholdFatal Member of Thermal.v1_7_1.Thermal
Description Above normal range and is fatal.
Type number or null
Read Only True
Added iLO 5 1.10

Temperatures[{item}].UpperThresholdNonCritical Member of Thermal.v1_7_1.Thermal
Description The noncritical temperature threshold.
Type number or null
Read Only True
Added iLO 5 1.10

Actions

HpeThermalExt.SetUserTempThreshold Member of Thermal.v1_7_1.Thermal The action to set a user defined threshold for a PCIe slot temperature sensor.

Parameters:

AlertType (string)

Alert type thrown when user defined temperature threshold is exceeded.

Value Description
Critical Generate a critical alert when user threshold exceeded.
Warning Generate a warning alert when user threshold exceeded.

SensorNumber (integer)

Sensor number of the sensor to be monitored.

ThresholdValue (integer)

Temperature thershold that once passed will issue an alert.

Triggers.v1_0_0.Triggers

@odata.type: "#Triggers.v1_0_0.Triggers"

The Triggers resource describes the a metric trigger, which apply to metrics.

Resource Instances

Uri HTTP Allow
/redfish/v1/telemetryservice/triggers/{item} GET PATCH

MetricProperties (array)

Member of Triggers.v1_0_0.Triggers MetricProperties is an array containing elements of:
Type string or null
Read Only True

MetricType

Member of Triggers.v1_0_0.Triggers
Description Specifies the type of metric for which the trigger is configured.
Type string
Read Only True
Added iLO 5 1.40

The following are the supported values:

Value Description
Numeric The trigger is for numeric sensor.
Discrete The trigger is for a discrete sensor.

NumericThresholds

NumericThresholds.LowerCritical NumericThresholds.LowerCritical.Activation Member of Triggers.v1_0_0.Triggers
Description The direction of crossing that activates this threshold.
Type string
Read Only True
Added iLO 5 1.40

The following are the supported values:

Value Description
Increasing Value increases above the threshold.
Decreasing Value decreases below the threshold.
Either Value crosses the threshold in either direction.

NumericThresholds.LowerCritical.DwellTime Member of Triggers.v1_0_0.Triggers
Description The time interval over which the sensor reading must have passed through this Threshold value before the threshold is considered to be violated.
Type string or null
Read Only False
Added iLO 5 1.40

NumericThresholds.LowerCritical.Reading Member of Triggers.v1_0_0.Triggers
Description The threshold value.
Type number or null
Read Only False
Added iLO 5 1.40

NumericThresholds.LowerWarning NumericThresholds.LowerWarning.Activation Member of Triggers.v1_0_0.Triggers
Description The direction of crossing that activates this threshold.
Type string
Read Only True
Added iLO 5 1.40

The following are the supported values:

Value Description
Increasing Value increases above the threshold.
Decreasing Value decreases below the threshold.
Either Value crosses the threshold in either direction.

NumericThresholds.LowerWarning.DwellTime Member of Triggers.v1_0_0.Triggers
Description The time interval over which the sensor reading must have passed through this Threshold value before the threshold is considered to be violated.
Type string or null
Read Only False
Added iLO 5 1.40

NumericThresholds.LowerWarning.Reading Member of Triggers.v1_0_0.Triggers
Description The threshold value.
Type number or null
Read Only False
Added iLO 5 1.40

NumericThresholds.UpperCritical NumericThresholds.UpperCritical.Activation Member of Triggers.v1_0_0.Triggers
Description The direction of crossing that activates this threshold.
Type string
Read Only True
Added iLO 5 1.40

The following are the supported values:

Value Description
Increasing Value increases above the threshold.
Decreasing Value decreases below the threshold.
Either Value crosses the threshold in either direction.

NumericThresholds.UpperCritical.DwellTime Member of Triggers.v1_0_0.Triggers
Description The time interval over which the sensor reading must have passed through this Threshold value before the threshold is considered to be violated.
Type string or null
Read Only False
Added iLO 5 1.40

NumericThresholds.UpperCritical.Reading Member of Triggers.v1_0_0.Triggers
Description The threshold value.
Type number or null
Read Only False
Added iLO 5 1.40

NumericThresholds.UpperWarning NumericThresholds.UpperWarning.Activation Member of Triggers.v1_0_0.Triggers
Description The direction of crossing that activates this threshold.
Type string
Read Only True
Added iLO 5 1.40

The following are the supported values:

Value Description
Increasing Value increases above the threshold.
Decreasing Value decreases below the threshold.
Either Value crosses the threshold in either direction.

NumericThresholds.UpperWarning.DwellTime Member of Triggers.v1_0_0.Triggers
Description The time interval over which the sensor reading must have passed through this Threshold value before the threshold is considered to be violated.
Type string or null
Read Only False
Added iLO 5 1.40

NumericThresholds.UpperWarning.Reading Member of Triggers.v1_0_0.Triggers
Description The threshold value.
Type number or null
Read Only False
Added iLO 5 1.40

Status

Member of Triggers.v1_0_0.Triggers See the Redfish standard schema and specification for information on common Status object.

TriggerActions (array)

Member of Triggers.v1_0_0.Triggers TriggerActions is an array containing elements of:
Type string
Read Only True

The following are the supported values:

Value Description
LogToLogService Upon a trigger, record in a log.
RedfishEvent Upon a trigger, send a Redfish Event message of type MetricReport.

TriggersCollection.TriggersCollection

@odata.type: "#TriggersCollection.TriggersCollection"

A Collection of Triggers resource instances.

Resource Instances

Uri HTTP Allow
/redfish/v1/telemetryservice/triggers GET
Link Name Destination type
Members[] Triggers

Members (array)

Member of TriggersCollection.TriggersCollection Members is an array containing elements of:

Members[{item}].@odata.id Member of TriggersCollection.TriggersCollection
Type string
Read Only True
Format uri-reference

Members@odata.count

Member of TriggersCollection.TriggersCollection
Description The total number of collection members.
Type integer
Read Only True

UpdateService.v1_2_1.UpdateService

@odata.type: "#UpdateService.v1_2_1.UpdateService"

The UpdateService resource describes the Update Service. It represents the properties for the service itself and has links to collections of firmware and software inventory.

Resource Instances

Uri HTTP Allow
/redfish/v1/updateservice GET POST PATCH
Link Name Destination type
FirmwareInventory Collection of SoftwareInventory
Oem/Hpe/ComponentRepository Collection of HpeComponent
Oem/Hpe/InstallSets Collection of HpeComponentInstallSet
Oem/Hpe/UpdateTaskQueue Collection of HpeComponentUpdateTask
SoftwareInventory Collection of SoftwareInventory

FirmwareInventory

Link to Firmware Inventory. FirmwareInventory is a link ("@odata.id": URI) to another resource.

HttpPushUri

Member of UpdateService.v1_2_1.UpdateService
Description The URI to which a client may POST an update image.
Type string
Read Only True
Added iLO 5 1.10
Format uri-reference

Oem.Hpe.Accept3rdPartyFirmware

Member of UpdateService.v1_2_1.UpdateService
Description Enable or disable support for 3rd party firmware update packages.
Type boolean
Read Only False

Oem.Hpe.BundleUpdateReport

Link to the Bundle Update report. BundleUpdateReport is a link ("@odata.id": URI) to another resource.

Oem.Hpe.Capabilities

Oem.Hpe.Capabilities.BundleDowngradeSupport Member of UpdateService.v1_2_1.UpdateService
Description Indicates whether iLO supports downgrade capability for cloud based updates.
Type boolean
Read Only True

Oem.Hpe.Capabilities.COMBootToUefiShellSupport Member of UpdateService.v1_2_1.UpdateService
Description Indicates whether iLO supports booting to Uefi shell for cloud based updates.
Type boolean
Read Only True

Oem.Hpe.Capabilities.COMVCSupport Member of UpdateService.v1_2_1.UpdateService
Description Indicates whether iLO supports pending reset for bundle update.
Type boolean
Read Only True

Oem.Hpe.Capabilities.OfflineRuntimeBundleUpdate Member of UpdateService.v1_2_1.UpdateService
Description Indicates whether iLO supports offline type D installation.
Type string
Read Only True

The following are the supported values:

Value Description
ProductionMode iLO supports offline type D installation in production security state only.
ProductionAndHighSecurityMode iLO supports offline type D installation in Production and High security state only.
AllModes iLO supports offline type D installation in all security states viz, Production, High security, FIPS and CNSA.

Oem.Hpe.Capabilities.PLDMFirmwareUpdate Member of UpdateService.v1_2_1.UpdateService
Description Indicates whether iLO supports PLDM firmware updates.
Type boolean
Read Only True

Oem.Hpe.Capabilities.UpdateFWPKG Member of UpdateService.v1_2_1.UpdateService
Description Indicates whether iLO supports FWPKG 2.0 firmware images.
Type boolean
Read Only True

Oem.Hpe.ComponentRepository

Link to the Component Repository. ComponentRepository is a link ("@odata.id": URI) to another resource.

Oem.Hpe.CurrentTime

Member of UpdateService.v1_2_1.UpdateService
Description ISO 8601 Redfish-style time string of the current iLO time (the reference for all scheduling)
Type string
Read Only True
Added iLO 5 1.10
Format date-time

Oem.Hpe.DowngradePolicy

Member of UpdateService.v1_2_1.UpdateService
Description Can be used to restrict the firmware downgrade.
Type string
Read Only False
Added iLO 5 1.40

The following are the supported values:

Value Description
AllowDowngrade Downgrading firmware is allowed.
RecoveryDowngrade Downgrading firmware is allowed by a user with the Recovery Set privilege.
NoDowngrade Downgrading firmware is not allowed. This is a permanent setting and cannot be undone.

Oem.Hpe.FirmwareIntegrity

Oem.Hpe.FirmwareIntegrity.EnableBackgroundScan Member of UpdateService.v1_2_1.UpdateService
Description Enables or disables background scan of critical firmware.
Type boolean
Read Only False
Added iLO 5 1.10

Oem.Hpe.FirmwareIntegrity.LastFailedImageUri Member of UpdateService.v1_2_1.UpdateService
Description This is a link to the binary image of the firmware that failed an integrity check and is intended for diagnostic purposes.
Type string or null
Read Only True
Added iLO 5 1.10
Format uri-reference

Oem.Hpe.FirmwareIntegrity.LastScanResult Member of UpdateService.v1_2_1.UpdateService
Description The firmware integrity scan engine status.
Type string or null
Read Only True
Added iLO 5 1.10

The following are the supported values:

Value Description
OK The last firmware integrity scan completed without finding any issues.
Repaired The last firmware integrity scan successfully repaired an issue. Refer to the event log for details.
Failure The last firmware integrity scan failed to complete or repair an issue. Refer to the event log for details.
Stopped The last firmware integrity scan was stopped prior to completion. Refer to the event log for details.

Oem.Hpe.FirmwareIntegrity.LastScanTime Member of UpdateService.v1_2_1.UpdateService
Description The time stamp of the last firmware integrity scan.
Type string or null
Read Only True
Added iLO 5 1.10
Format date-time

Oem.Hpe.FirmwareIntegrity.OnIntegrityFailure Member of UpdateService.v1_2_1.UpdateService
Description Sets the policy for how the firmware integrity check handles integrity failures.
Type string
Read Only False
Added iLO 5 1.10

The following are the supported values:

Value Description
LogOnly Log failures to the iLO event log but do not automatically attempt to repair.
LogAndRepairAutomatically Log failures to the iLO event log and automatically attempt to repair.

Oem.Hpe.FirmwareIntegrity.ScanEveryDays Member of UpdateService.v1_2_1.UpdateService
Description Sets the interval between firmware integrity scans in 24 hour increments.
Type integer or null
Read Only False
Added iLO 5 1.10

Oem.Hpe.FlashProgressPercent

Member of UpdateService.v1_2_1.UpdateService
Description This is the percent complete for an iLO flash operation. It is only valid when State is Updating.
Type integer or null
Read Only True
Added iLO 5 1.10

Oem.Hpe.InstallSets

Link to the Install Sets collection. InstallSets is a link ("@odata.id": URI) to another resource.

Oem.Hpe.InvalidImageRepository

Link to the Invalid Image Repository. InvalidImageRepository is a link ("@odata.id": URI) to another resource.

Oem.Hpe.MaintenanceWindows

Link to the Maintenance Windows. MaintenanceWindows is a link ("@odata.id": URI) to another resource.

Oem.Hpe.Result

Oem.Hpe.Result.MessageArgs (array) Member of UpdateService.v1_2_1.UpdateService MessageArgs is an array containing elements of:
Type string
Read Only True

Oem.Hpe.Result.MessageId Member of UpdateService.v1_2_1.UpdateService
Description The key for this message that can be used to look up the message in a message registry.
Type string
Read Only False
Added iLO 5 1.10

Oem.Hpe.State

Member of UpdateService.v1_2_1.UpdateService
Type string
Read Only True
Added iLO 5 1.10

The following are the supported values:

Value Description
Idle The update service is idle.
Uploading The update service is receiving a new component.
Verifying The update service is verifying the integrity of a new component.
Writing The update service is writing a new component to the iLO Repository.
Updating The update service is updating (flashing) firmware.
Complete The update service has completed up upload or update operation.
Error The upload service encountered an error. See Result for detail.

Oem.Hpe.UpdateTaskQueue

Link to the Update Task Queue. UpdateTaskQueue is a link ("@odata.id": URI) to another resource.

Oem.Hpe.UploadCurrentEtag

Member of UpdateService.v1_2_1.UpdateService
Description client-supplied etag (during component upload) indicating to what UploadStatus is reporting upon.
Type string
Read Only True
Added iLO 5 1.10

ServiceEnabled

Member of UpdateService.v1_2_1.UpdateService
Description Indicates if the Update Service is enabled.
Type boolean or null
Read Only True
Added iLO 5 1.10

SoftwareInventory

Link to Software Inventory. This is only available when the Agentless Management Service is running. SoftwareInventory is a link ("@odata.id": URI) to another resource.

Actions

UpdateService.SimpleUpdate Member of UpdateService.v1_2_1.UpdateService

Parameters:

ImageURI (string)

Password (string)

The password credential required for authentication to fetch image.

Targets (array)

Target Redfish URI

TransferProtocol (string)

Value Description
HTTP Hypertext Transfer Protocol
HTTPS HTTP Secure protocol

Username (string)

The username credential required for authentication to fetch image.

HpeiLOUpdateServiceExt.AddFromUri Member of UpdateService.v1_2_1.UpdateService

Parameters:

CompSigURI (string)

ComponentFileName (string)

File name of landed component. Only required when component to be uploaded is >32MB.

ImageURI (string)

VirtualMedia.v1_3_0.VirtualMedia

@odata.type: "#VirtualMedia.v1_3_0.VirtualMedia"

The VirtualMedia resource describes the BMC virtual media feature.

Resource Instances

Uri HTTP Allow
/redfish/v1/managers/{item}/virtualmedia/{item} GET POST PATCH

ConnectedVia

Member of VirtualMedia.v1_3_0.VirtualMedia
Description Specifies how the virtual media is connected to the server.
Type string or null
Read Only True
Added iLO 5 1.10

The following are the supported values:

Value Description
Null A value is temporarily unavailable
NotConnected No current connection.
URI Connected to a URI location.
Applet Connected to a client application.

Image

Member of VirtualMedia.v1_3_0.VirtualMedia
Description The valid URI indicating the image that is mounted on this server. A null value indicates that no image exists.
Type string or null
Read Only False
Added iLO 5 1.10
Format uri-reference

ImageName

Member of VirtualMedia.v1_3_0.VirtualMedia
Description The name of the image that is mounted on this server. This is usually provided when a URL image is mounted through scripted virtual media.
Type string or null
Read Only True
Added iLO 5 1.10

Inserted

Member of VirtualMedia.v1_3_0.VirtualMedia
Description Indicates whether the virtual media is mounted on the server.
Type boolean or null
Read Only False
Added iLO 5 1.10

MediaTypes (array)

Member of VirtualMedia.v1_3_0.VirtualMedia MediaTypes is an array containing elements of:
Description The array of supported media types for this connection.
Type string
Read Only True

The following are the supported values:

Value Description
CD A CD-ROM format (ISO) image.
Floppy A floppy disk image.
USBStick An emulation of a USB storage device.
DVD A DVD-ROM format image.

Oem.Hpe.BootOnNextServerReset

Member of VirtualMedia.v1_3_0.VirtualMedia
Description If set to true, the server will boot to this image on the next server reboot. The image will be ejected automatically on the second server reboot so that the server does not boot to this image twice.
Type boolean
Read Only False
Added iLO 5 1.10

TransferProtocolType

Member of VirtualMedia.v1_3_0.VirtualMedia
Description Network Protocol to use with the image
Type string
Read Only True

The following are the supported values:

Value Description
CIFS Common Internet File System protocol.
FTP File Transfer Protocol.
SFTP Secure File Transfer Protocol.
HTTP Hypertext Transfer Protocol.
HTTPS HTTP Secure protocol.
NFS Network File System protocol.
SCP Secure File Copy protocol.
TFTP Trivial File Transfer Protocol.
OEM A protocol defined by the manufacturer.

WriteProtected

Member of VirtualMedia.v1_3_0.VirtualMedia
Description Indicates whether the virtual media is protected against write operations.
Type boolean or null
Read Only False
Added iLO 5 1.10

Actions

VirtualMedia.EjectMedia Member of VirtualMedia.v1_3_0.VirtualMedia There are no parameters for this action.

VirtualMedia.InsertMedia Member of VirtualMedia.v1_3_0.VirtualMedia

Parameters:

Image (string)

The URI of the remote media to attach to the virtual media.

Inserted (boolean)

Indicates if the image is to be treated as inserted upon completion of the action. If this parameter is not provided by the client, the service shall default this value to be true.

TransferProtocolType (string)

Network Protocol to use with the image

Value Description
CIFS Common Internet File System protocol.
FTP File Transfer Protocol.
HTTP Hypertext Transfer Protocol.
HTTPS HTTP Secure protocol.
NFS Network File System protocol.
OEM A protocol defined by the manufacturer.
SCP Secure File Copy protocol.
SFTP Secure File Transfer Protocol.
TFTP Trivial File Transfer Protocol.

WriteProtected (boolean)

Indicates whether the virtual media is protected against write operations. If this parameter is not provided by the client, the service shall default this value to be true.

HpeiLOVirtualMedia.EjectVirtualMedia Member of VirtualMedia.v1_3_0.VirtualMedia

Parameters:

Intent (string)

A text description of the reason for this action invocation.

Signature (string)

A RSA2048 SHA-256 signature validating the provided Intent (Base64 encoded).

HpeiLOVirtualMedia.InsertVirtualMedia Member of VirtualMedia.v1_3_0.VirtualMedia

Parameters:

Certificate (string)

A PEM encoded X509 certificate used to validate the https server.

Image (string)

A URL for an ISO, BIN, or IMG file locating the virtual media image.

Intent (string)

A text description of the reason for this action invocation.

Signature (string)

A RSA2048 SHA-256 signature validating the provided Intent (Base64 encoded).

WriteProtected (boolean)

Indicates whether the virtual media is protected against write operations.

VirtualMediaCollection.VirtualMediaCollection

@odata.type: "#VirtualMediaCollection.VirtualMediaCollection"

A Collection of VirtualMedia resource instances.

Resource Instances

Uri HTTP Allow
/redfish/v1/managers/{item}/virtualmedia GET
Link Name Destination type
Members[] VirtualMedia

Members (array)

Member of VirtualMediaCollection.VirtualMediaCollection Members is an array containing elements of:

Members[{item}].@odata.id Member of VirtualMediaCollection.VirtualMediaCollection
Type string
Read Only True
Format uri-reference

Members@odata.count

Member of VirtualMediaCollection.VirtualMediaCollection
Description The total number of collection members.
Type integer
Read Only True

Volume.v1_0_0.Volume

@odata.type: "#Volume.v1_0_0.Volume"

The Volume resource describes a volume, virtual disk, LUN, or other logical storage entity for any system.

Resource Instances

Uri HTTP Allow
/redfish/v1/systems/{item}/storage/{item}/volumes/{item} GET POST PATCH DELETE
Link Name Destination type
Links/Drives[] Drive

CapacityBytes

Member of Volume.v1_0_0.Volume
Description The size in bytes of this Volume
Type integer or null
Read Only True
Added iLO 5 1.10

DedicatedSpareDrives (array)

Member of Volume.v1_0_0.Volume DedicatedSpareDrives is an array containing elements of:

DedicatedSpareDrives[{item}].@odata.id Member of Volume.v1_0_0.Volume
Type string
Read Only True
Format uri-reference

Status

Member of Volume.v1_0_0.Volume See the Redfish standard schema and specification for information on common Status object.

VolumeType

Member of Volume.v1_0_0.Volume
Description The type of this volume.
Type string or null
Read Only True
Added iLO 5 1.10

The following are the supported values:

Value Description
RawDevice The volume is a raw physical device without any RAID or other virtualization applied

VolumeCollection.VolumeCollection

@odata.type: "#VolumeCollection.VolumeCollection"

A Collection of Volume resource instances.

Resource Instances

Uri HTTP Allow
/redfish/v1/systems/{item}/storage/{item}/volumes GET POST
Link Name Destination type
Members[] Volume

Members (array)

Member of VolumeCollection.VolumeCollection Members is an array containing elements of:

Members[{item}].@odata.id Member of VolumeCollection.VolumeCollection
Type string
Read Only True
Format uri-reference

Members@odata.count

Member of VolumeCollection.VolumeCollection
Description The total number of collection members.
Type integer
Read Only True

Response Message Definitions

API Responses are discussed in the section Handling Error Responses. The responses contain one or more “MessageId” properties each corresponding to an entry in a message registry. This section is a reference for the defined message registry entries.

Base.1.17.AccessDenied

While attempting to access, connect to, or transfer to/from another resource, the service was denied access.
Message Format “While attempting to establish a connection to %1, the service was denied access.”
Severity Critical
Resolution Verify that the URI is correct and that the service has the appropriate credentials.

Base.1.17.AccountForSessionNoLongerExists

The account for the current session is removed, and the current session is also removed.
Message Format “The account for the current session is removed, and the current session is also removed.”
Severity OK
Resolution Attempt to connect using a valid account.

Base.1.17.AccountModified

The account was modified successfully.
Message Format “The account was modified successfully.”
Severity OK
Resolution None.

Base.1.17.AccountNotModified

The request was unable to modify the account.
Message Format “The account modification request did not complete.”
Severity Warning
Resolution If the operation did not complete, check the authorization or the request body for issues and resubmit the request.

Base.1.17.AccountRemoved

The account was removed successfully.
Message Format “The account was removed successfully.”
Severity OK
Resolution None.

Base.1.17.ActionNotSupported

The action supplied in the POST operation is not supported by the resource.
Message Format “The action %1 is not supported by the resource.”
Severity Critical
Resolution The action was invalid or the wrong resource was the target. See the implementation documentation for assistance.

Base.1.17.ActionParameterDuplicate

The action was submitted with a duplicate parameter in the request body.
Message Format “The action %1 was submitted with more than one value for the parameter %2.”
Severity Warning
Resolution Resubmit the action with only one instance of the parameter in the request body.

Base.1.17.ActionParameterMissing

The requested action is missing a parameter that is required to process the action.
Message Format “The action %1 requires that the parameter %2 be present in the request body.”
Severity Critical
Resolution Resubmit the action with the required parameter in the request body.

Base.1.17.ActionParameterNotSupported

The action parameter is not supported on the target resource.
Message Format “The parameter %1 for the action %2 is not supported on the target resource.”
Severity Warning
Resolution If the operation did not complete, remove the parameter and resubmit the request.

Base.1.17.ActionParameterUnknown

An action was submitted, but a supplied parameter did not match any of the known parameters.
Message Format “The action %1 was submitted with the invalid parameter %2.”
Severity Warning
Resolution If the operation did not complete, correct the invalid parameter and resubmit the request.

Base.1.17.ActionParameterValueFormatError

The value type is correct, but the format is not supported or the size/length is exceeded.
Message Format “The value %1 for the parameter %2 in the action %3 is in a format that is not supported by the parameter.”
Severity Warning
Resolution If the operation did not complete, correct the parameter value in the request body and resubmit the request.

Base.1.17.ActionParameterValueTypeError

The parameter contains an incorrect value type. For example, a number value for a string parameter type.
Message Format “The value %1 for the parameter %2 in the action %3 is the incorrect parameter type.”
Severity Warning
Resolution If the operation did not complete, correct the parameter value in the request body and resubmit the request.

Base.1.17.AuthenticationTokenRequired

Indicates that the request could not be performed because an authentication token was not provided.
Message Format “The request could not be performed because an authentication token was not provided.”
Severity Critical
Resolution Obtain an authentication token and resubmit the request.

Base.1.17.CouldNotEstablishConnection

An attempt to access the resource, image, or file at the URI was unsuccessful because a session could not be established.
Message Format “The service was unable to establish a connection with the URI %1.”
Severity Critical
Resolution Verify that the URI contains a valid and reachable node name, protocol information, and other URI components.

Base.1.17.CreateFailedMissingReqProperties

A create operation was attempted on a resource, but a required property was missing from the request.
Message Format “The create operation did not complete because the required property %1 was missing from the request.”
Severity Critical
Resolution If the operation did not complete, include the required property with a valid value in the request body and resubmit the request.

Base.1.17.CreateLimitReachedForResource

Additional resources cannot be created.
Message Format “Additional resources cannot be created.”
Severity Critical
Resolution If the operation did not complete, delete resources and resubmit the request.

Base.1.17.Created

The resource has been created successfully.
Message Format “The resource has been created successfully.”
Severity OK
Resolution None

Base.1.17.EmptyJSON

Indicates that the request body contained an empty JSON object when one or more properties are expected in the body.
Message Format “The request body submitted contained an empty JSON object and the service is unable to process it.”
Severity Warning
Resolution Add properties in the JSON object and resubmit the request.

Base.1.17.EventSubscriptionLimitExceeded

The event subscription establishment has been requested, but the operation did not complete. The number of simultaneous subscriptions exceeded the maximum number allowed by the implementation.
Message Format “The event subscription did not complete because the number of simultaneous subscriptions exceeded the maximum number allowed by the implementation.”
Severity Critical
Resolution Before attempting to establish the event subscription, reduce the number of subscriptions or increase the maximum number of simultaneous subscriptions allowed (if supported).

Base.1.17.GeneralError

Indicates that a general error has occurred. Use in ExtendedInfo is discouraged. When used in ExtendedInfo, implementations are expected to include a Resolution property with this error to indicate how to resolve the problem.
Message Format “A general error has occurred. See Resolution for information on how to resolve the error.”
Severity Critical
Resolution None.

Base.1.17.InsufficientPrivilege

The account or credentials associated with the current session are not authorized to perform the requested operation.
Message Format “The account or credentials associated with the current session are not authorized to perform the requested operation.”
Severity Critical
Resolution Retry the operation with an authorized account or credentials.

Base.1.17.InternalError

The request did not complete due to an unknown internal error, but the service is still operational.
Message Format “The request failed due to an internal service error, but the service is still operational.”
Severity Critical
Resolution Resubmit the request. If the problem persists, consider resetting the service.

Base.1.17.InvalidIndex

The Index is not valid.
Message Format “The Index %1 is not a valid offset into the array.”
Severity Warning
Resolution Verify the index value provided is within the bounds of the array.

Base.1.17.InvalidObject

The object is not valid.
Message Format “The object at %1 is not valid.”
Severity Critical
Resolution If the operation did not complete, the object is malformed or the URI is incorrect. Make the appropriate corrections and resubmit the request.

Base.1.17.MalformedJSON

The request body contains malformed JSON.
Message Format “The request body submitted is malformed JSON and cannot be parsed by the receiving service.”
Severity Critical
Resolution Verify that the request body is valid JSON and resubmit the request.

Base.1.17.NoOperation

Indicates that the requested operation will not perform any changes on the service.
Message Format “The request body submitted contain no data to act upon and no changes to the resource took place.”
Severity Warning
Resolution Add properties in the JSON object and resubmit the request.

Base.1.17.NoValidSession

The operation did not complete because a valid session is required in order to access resources.
Message Format “There is no valid session established with the implementation.”
Severity Critical
Resolution Establish a session before attempting any operations.

Base.1.17.OneTimePasscodeSent

Indicates that a required one-time passcode has been sent to the user. The code should be provided as the Token in the request to create a Session.
Message Format “A one-time passcode has been sent to: %1 Supply the passcode as the Token in the request to create a Session.”
Severity OK
Resolution Obtain the one-time passcode sent to the delivery address and resubmit the request using the passcode as the Token.

Base.1.17.PropertyDuplicate

A duplicate property is in the request body.
Message Format “The property %1 is duplicated in the request.”
Severity Warning
Resolution If the operation did not complete, remove the duplicate property from the request body and resubmit the request.

Base.1.17.PropertyMissing

The request does not include a required property.
Message Format “The property %1 is a required property and must be included in the request.”
Severity Warning
Resolution If the operation did not complete, verify the property is in the request body and has a valid value.

Base.1.17.PropertyNotWritable

The request included a value for a read-only property.
Message Format “The property %1 is a read-only property and cannot be assigned a value.”
Severity Warning
Resolution If the operation did not complete, remove the property from the request body and resubmit the request.

Base.1.17.PropertyUnknown

An unknown property is in the request body.
Message Format “The property %1 is not valid for this resource.”
Severity Warning
Resolution If the operation did not complete, remove the unknown property from the request body and resubmit the request.

Base.1.17.PropertyValueFormatError

The value type is correct, but the format is not supported or the size/length is exceeded.
Message Format “The value %1 for the property %2 is in a format that is not supported by the property.”
Severity Warning
Resolution If the operation did not complete, correct the property value in the request body and resubmit the request.

Base.1.17.PropertyValueModified

Indicates that a property was given the correct value type but the value of that property was modified. Examples are truncated or rounded values.
Message Format “The property %1 was assigned the value %2 due to modification by the service.”
Severity Warning
Resolution No resolution is required.

Base.1.17.PropertyValueNotInList

The value type is correct, but the value is not supported.
Message Format “The value %1 for the property %2 is not valid.”
Severity Warning
Resolution If the operation did not complete, choose a value from the enumeration list and resubmit your request.

Base.1.17.PropertyValueTypeError

The property value contains an incorrect property type. For example, a number value for a string property type.
Message Format “The value %1 for the property %2 is the incorrect property type.”
Severity Warning
Resolution If the operation did not complete, correct the property value in the request body and resubmit the request.

Base.1.17.QueryNotSupported

The query is not supported by the implementation.
Message Format “Querying is not supported by the implementation.”
Severity Warning
Resolution If the operation did not complete, remove the query parameter and resubmit the request.

Base.1.17.QueryNotSupportedOnResource

The query is not supported on the resource. For example, a start/count query is attempted on a resource that is not a collection.
Message Format “Querying is not supported on the requested resource.”
Severity Warning
Resolution If the operation did not complete, remove the query parameters and resubmit the request.

Base.1.17.QueryParameterOutOfRange

The query parameter value is out of range for the resource. For example, a page is requested that is outside the valid page range.
Message Format “The value %1 for the query parameter %2 is out of range %3.”
Severity Warning
Resolution Specify a query parameter value that is within range. For example, a page that is within the valid range of pages.

Base.1.17.QueryParameterValueFormatError

The value type is correct, but the format is not supported or the size/length was exceeded.
Message Format “The value %1 for the parameter %2 is in a format that is not supported by the parameter.”
Severity Warning
Resolution If the operation did not complete, correct the value for the query parameter in the request body and resubmit the request.

Base.1.17.QueryParameterValueTypeError

The query parameter contains an incorrect value type. For example, a number supplied for a query parameter that requires a string.
Message Format “The value %1 for the query parameter %2 is the incorrect type of value for the query parameter.”
Severity Warning
Resolution If the operation did not complete, correct the value for the query parameter in the request body and resubmit the request.

Base.1.17.ResourceAlreadyExists

Indicates that a resource change or creation was attempted but that the operation cannot proceed because the resource already exists.
Message Format “The requested resource of type %1 with the property %2 with the value %3 already exists.”
Severity Critical
Resolution Do not repeat the create operation as the resource has already been created.

Base.1.17.ResourceAtUriInUnknownFormat

The URI is valid, but the resource or image at that URI is in a format that is not supported by the service.
Message Format “The resource at %1 is in a format that is not supported by the service.”
Severity Critical
Resolution Place a resource, image, or file that is supported by the service at the URI.

Base.1.17.ResourceAtUriUnauthorized

An attempt to access the resource, image, or file at the URI is unauthorized.
Message Format “While accessing the resource at %1, the service received an authorization error %2.”
Severity Critical
Resolution Verify that the appropriate access is provided for the service to access the URI.

Base.1.17.ResourceCannotBeDeleted

A delete operation was attempted on a resource that cannot be deleted.
Message Format “The delete request did not complete because the resource cannot be deleted.”
Severity Critical
Resolution Do not attempt to delete a resource that does not support the REST API DELETE operation.

Base.1.17.ResourceExhaustion

Indicates that a resource could not satisfy the request due to some unavailability of resources. An example is that available capacity has been allocated.
Message Format “The resource %1 was unable to satisfy the request due to unavailability of resources.”
Severity Critical
Resolution Ensure that the resources are available and resubmit the request.

Base.1.17.ResourceInStandby

Indicates that the request could not be performed because the resource is in standby.
Message Format “The request could not be performed because the resource is in standby.”
Severity Critical
Resolution Ensure that the resource is in the correct power state and resubmit the request.

Base.1.17.ResourceInUse

The request to change the resource was rejected because the resource was in use or in transition.
Message Format “The change to the resource did not complete because the resource is in use or in transition.”
Severity Warning
Resolution If the operation did not complete, wait until the resource is free and resubmit the request.

Base.1.17.ResourceMissingAtURI

The operation expected an image or resource at the provided URI, but found none.
Message Format “The resource at the URI %1 was not found.”
Severity Critical
Resolution Place a valid resource at the URI or correct the URI and resubmit the request.

Base.1.17.ResourceNotFound

Indicates that the operation expected a resource identifier that corresponds to an existing resource but one was not found.
Message Format “The requested resource of type %1 named %2 was not found.”
Severity Critical
Resolution Provide a valid resource identifier and resubmit the request.

Base.1.17.ResourceTypeIncompatible

Indicates that the resource type of the operation does not match that for the operation destination. Examples of when this can happen include during a POST to a collection using the wrong resource type, an update where the @odata.types do not match or on a major version incompatability.
Message Format “The @odata.type of the request body %1 is incompatible with the @odata.type of the resource which is %2.”
Severity Critical
Resolution Resubmit the request with a payload compatible with the resource’s schema.

Base.1.17.ServiceInUnknownState

The operation did not complete because the service is in an unknown state and cannot take incoming requests.
Message Format “The operation did not complete because the service is in an unknown state and cannot take incoming requests.”
Severity Critical
Resolution If the operation did not complete, restart the service and resubmit the request.

Base.1.17.ServiceShuttingDown

The operation did not complete because the service is shutting down.
Message Format “The operation did not complete because the service is shutting down and cannot take incoming requests.”
Severity Critical
Resolution If the operation did not complete, resubmit the request when the service is available.

Base.1.17.ServiceTemporarilyUnavailable

The service is temporarily unavailable.
Message Format “The service is temporarily unavailable. Retry in %1 seconds.”
Severity Critical
Resolution Wait for the indicated retry duration and retry the operation.

Base.1.17.SessionLimitExceeded

Session establishment has been requested, but the operation did not complete because the number of simultaneous sessions exceeded the maximum number allowed by the implementation.
Message Format “The session establishment did not complete because the number of simultaneous sessions exceeded the maximum number allowed by the implementation.”
Severity Critical
Resolution Before attempting to establish the session, reduce the number of sessions or increase the maximum number of simultaneous sessions allowed (if supported).

Base.1.17.SessionTerminated

Indicates that the DELETE operation on the Session resource resulted in the successful termination of the session.
Message Format “The session was successfully terminated.”
Severity OK
Resolution No resolution is required.

Base.1.17.SourceDoesNotSupportProtocol

While attempting to access, connect to, or transfer from another location, the other end of the connection did not support the specified protocol.
Message Format “The other end of the connection at %1 does not support the specified protocol %2.”
Severity Critical
Resolution Change protocols or URIs.

Base.1.17.StringValueTooLong

Indicates that a string value passed to the given resource exceeded its length limit. An example is when a shorter limit is imposed by an implementation than that allowed by the specification.
Message Format “The string %1 exceeds the length limit %2.”
Severity Warning
Resolution Resubmit the request with an appropriate string length.

Base.1.17.Success

The operation completed successfully.
Message Format “The operation completed successfully.”
Severity OK
Resolution None

Base.1.17.UnrecognizedRequestBody

The service detected a request body with malformed JSON.
Message Format “The service detected a request body with malformed JSON.”
Severity Warning
Resolution If the operation did not complete, correct the request body and resubmit the request.

HpeCommon.2.0.ArrayPropertyOutOfBound

The items in the array exceed the maximum number supported.
Message Format “An array %1 was supplied with %2 items that exceeds the maximum supported count of %3.”
Severity Warning
Resolution Retry the operation using the correct number of items for the array.

HpeCommon.2.0.ConditionalSuccess

A property value was successfully changed but the change may be reverted upon system reset.
Message Format “The property %1 was successfully changed to %2, but the change may be reverted upon system reset.”
Severity Warning
Resolution Check the “SettingsResult” messages after the system has reset for errors referring to the corresponding property.

HpeCommon.2.0.InternalErrorWithParam

The operation was not successful due to an internal service error (shown), but the service is still operational.
Message Format “The operation was not successful due to an internal service error (%1), but the service is still operational.”
Severity Critical
Resolution Retry the operation. If the problem persists, consider resetting the service.

HpeCommon.2.0.InvalidConfigurationSpecified

The specified configuration is not valid.
Message Format “The specified configuration is not valid.”
Severity Warning
Resolution Correct the configuration, and then retry the operation.

HpeCommon.2.0.PropertyValueExceedsMaxLength

The value for the property exceeds the maximum length.
Message Format “The value %1 for the property %2 exceeds the maximum length of %3.”
Severity Warning
Resolution Correct the value for the property in the request body, and then retry the operation.

HpeCommon.2.0.PropertyValueIncompatible

The value for the property is the correct type, but this value is incompatible with the current value of another property.
Message Format “The value %1 for the property %2 is incompatible with the value for property %3.”
Severity Warning
Resolution Correct the value for the property in the request body, and then retry the operation.

HpeCommon.2.0.PropertyValueOutOfRange

The value for the property is out of range.
Message Format “The value %1 for the property %2 is out of range %3.”
Severity Warning
Resolution Correct the value for the property in the request body, and then retry the operation.

HpeCommon.2.0.ResetInProgress

A device or service reset is in progress.
Message Format “A reset on %1 is in progress.”
Severity Warning
Resolution Wait for device or service reset to complete, and then retry the operation.

HpeCommon.2.0.ResetRequired

One or more properties were changed, but these changes will not take effect until the device or service is reset.
Message Format “One or more properties were changed, but these changes will not take effect until %1 is reset.”
Severity Warning
Resolution To enable the changed properties, reset the device or service.

HpeCommon.2.0.ResourceNotReadyRetry

The resource is present but is not ready to perform operations due to an internal condition such as initialization or reset.
Message Format “The resource is present but is not ready to perform operations. The resource will be ready in %1 seconds.”
Severity Warning
Resolution Retry the operation when the resource is ready.

HpeCommon.2.0.SuccessFeedback

The operation completed successfully
Message Format “The operation completed successfully”
Severity OK
Resolution None

HpeCommon.2.0.TaskCreated

A task was created in response to the operation.
Message Format “A task was created in response to the operation and is accessible at %1.”
Severity OK
Resolution Perform an HTTP GET request on the supplied URI for task status.

HpeCommon.2.0.UnsupportedHwConfiguration

A previously requested property value change was reverted because the current hardware configuration does not support it.
Message Format “The value %1 for property %2 was reverted because the current hardware configuration does not support it.”
Severity Warning
Resolution Ensure that the system’s hardware configuration supports the property value.

iLO.2.19.AHSDisabled

Modifying AHS properties is not possible with AHS disabled.
Message Format “Modifying AHS properties is not possible with AHS disabled.”
Severity Warning
Resolution Enable AHS, and then modify the AHS properties.

iLO.2.19.Accepted

Indicates that one or more properties were correctly changed, but may not be in effect yet.
Message Format “Indicates that one or more properties were correctly changed, but may not be in effect yet.”
Severity OK
Resolution None

iLO.2.19.ActionParameterValueNotInList

Indicates that the correct value type was supplied for the action parameter, but the value is not supported. (The value is not in the enumeration list.)
Message Format “The value %1 for the property %2 is not in the list of valid values.”
Severity Warning
Resolution Choose a value from the enumeration list and resubmit the request if the operation failed.

iLO.2.19.AlertDestinationAssociationError

AlertDestination cannot be configured with both SNMPv1 and SNMPv3.
Message Format “AlertDestination cannot be configured with both SNMPv1 and SNMPv3.”
Severity Warning
Resolution For SNMPv1 alert, configure SNMPAlertProtocol to SNMPv1. For SNMPv3 alert, configure SNMPAlertProtocol to SNMPv3.

iLO.2.19.AlertMailFeatureDisabled

AlertMail feature is disabled.
Message Format “AlertMail feature is disabled.”
Severity Warning
Resolution Enable AlertMail feature to send test alert message.

iLO.2.19.AlreadyInProgress

An operation is already in progress.
Message Format “An operation is already in progress.”
Severity Warning
Resolution Wait for the current operation to complete, and then retry the operation.

iLO.2.19.AlreadyUpToDate

The update did not occur because the component was already up to date.
Message Format “The update did not occur because the component was already up to date.”
Severity Warning
Resolution None.

iLO.2.19.ApmPowerCapModeInUsed

Operation is currently unavailable because the power regulator is set to APM Power Capping Mode.
Message Format “Operation is currently unavailable because the power regulator is set to APM Power Capping Mode.”
Severity Warning
Resolution Change the power regulator to other modes rather than APM Power Capping Mode through APM interface.

iLO.2.19.ArrayPropertyAlreadyExists

Duplicate value.
Message Format “The property value %1 is already exists in index %2”
Severity Warning
Resolution If the operation did not complete, correct the property value in the request body and resubmit the request.

iLO.2.19.ArrayPropertyOutOfBound

The number of items in the array exceeds the maximum number supported.
Message Format “An array %1 was supplied with %2 items that does not meet the minimum supported count of %3 or exceeds the maximum supported count of %4.”
Severity Warning
Resolution Retry the operation using the correct number of items for the array.

iLO.2.19.ArrayPropertyValueBadParam

The property value is not valid.
Message Format “The property value %1 in index %2 is not valid.”
Severity Warning
Resolution Retry the operation using a corrected value.

iLO.2.19.AuthenticationTokenExpired

Indicates that the request could not be performed because an authentication token was expired.
Message Format “The request could not be performed because an authentication token was expired.”
Severity Critical
Resolution Obtain an authentication token and resubmit the request.

iLO.2.19.BatteryBackupUnitSettingsDisabled

Battery Backup Unit settings are currently disabled.
Message Format “Battery Backup Unit settings are disabled when the system is configured for Scalable Persistent Memory.”
Severity Warning
Resolution To re-enable Battery Backup Unit settings, disable Scalable Persistent Memory functionality in the system ROM RBSU.

iLO.2.19.BiosActionTBD

The BIOS action supplied in the POST operation is not yet implemented.
Message Format “The BIOS action %1 is not implemented yet.”
Severity Critical
Resolution The action was invalid or the wrong resource was the target. See the implementation documentation for assistance.

iLO.2.19.BiosPasswordInfoInvalid

The stored BIOS password information is invalid. A system reboot is necessary to restore password defaults.
Message Format “The stored BIOS password information is invalid. Reboot system.”
Severity Critical
Resolution The system will need to be rebooted to restore BIOS password information to defaults.

iLO.2.19.BiosPasswordMismatch

The provided OldPassword does not match the stored BIOS password.
Message Format “The provided OldPassword does not match the stored BIOS password.”
Severity Critical
Resolution Retry the action with the matching password.

iLO.2.19.BundleUpdateAlreadyInProgress

A component upload operation is already in progress.
Message Format “A component upload operation is already in progress.”
Severity Warning
Resolution Wait for the current upload to complete, and then retry the operation.

iLO.2.19.BundleUpdateComponentDownloadFailed

Download of bundle update component failed.
Message Format “Component %1 download download failed, reason %2. Bundle update aborted.”
Severity OK
Resolution None.

iLO.2.19.BundleUpdateComponentDownloadStatus

Bundle update download status of components.
Message Format “Component %1 download %2. %3 out of %4 downloaded”
Severity OK
Resolution None.

iLO.2.19.BundleUpdateComponentInstallationFailed

Installation of bundle update component failed.
Message Format “Component %1 installation failed, reason %2. Bundle update aborted.”
Severity OK
Resolution None.

iLO.2.19.BundleUpdateComponentInstallationStatus

Bundle update component installation status.
Message Format “Component %1 installation %2. %3 out of %4 installed.”
Severity OK
Resolution None.

iLO.2.19.BundleUpdateInstallSetCreationFailed

Failed to create bundle update install set.
Message Format “Install set %1 creation failed, reason %2. Bundle update aborted.”
Severity OK
Resolution None.

iLO.2.19.BundleUpdateInstallSetCreationSuccess

Bundle update install set created successfully.
Message Format “Install set %1 created successfully”
Severity OK
Resolution None.

iLO.2.19.BundleUpdateInstallSetMetaDownloadFailed

Download of install set meta file failed.
Message Format “Install set meta file %1 download failed, reason %2. Bundle update aborted.”
Severity OK
Resolution None.

iLO.2.19.BundleUpdateInstallSetMetaDownloadStatus

Download status of install set meta file.
Message Format “Install set meta file %1 download %2”
Severity OK
Resolution None.

iLO.2.19.BundleUpdateInstallSetMetaProcessingFailed

Failed to process bundle update install set meta file.
Message Format “Install set meta file %1 processing failed, reason %2. Bundle update aborted.”
Severity OK
Resolution None.

iLO.2.19.BundleUpdateInstallSetMetaProcessingSuccess

Bundle update install set meta file processed successfully.
Message Format “Install set meta file %1 processed successfully”
Severity OK
Resolution None.

iLO.2.19.BundleUpdateInvalidUrl

The Url passed for bundle update is not valid.
Message Format “The Url %1 is not valid.”
Severity Warning
Resolution URL is incorrect. Provide a valid URL and resubmit the request.

iLO.2.19.BundleUpdateResetComplete

Server Reset complete.
Message Format “Server Reset complete.”
Severity Warning
Resolution iLO Pending Reset is performed.

iLO.2.19.BundleUpdateResetFailed

Pending Reset task failed.
Message Format “Pending Reset task failed.”
Severity Warning
Resolution Bundle update Reset failed, Check the CA for more info.

iLO.2.19.BundleUpdateResetPending

Waiting for Server Reset
Message Format “Waiting for Server Reset”
Severity Warning
Resolution Reset the iLO to apply the changes.

iLO.2.19.BundleUpdateSuccess

The status of bundle update installation.
Message Format “Bundle update has completed successfully.”
Severity OK
Resolution None.

iLO.2.19.COMActivationDenied

System already managed by an external manager.
Message Format “System already managed by %1.”
Severity Warning
Resolution System can either be managed by HPE OneView or Compute Ops Manager.

iLO.2.19.CalibrateInProgress

Power calibrate is in progress.
Message Format “Power calibrate is in progress.”
Severity Warning
Resolution Wait for previous power calibrate complete or stop previous power calibrate, and then retry the operation.

iLO.2.19.CannotRemoveDefaultLanguagePack

Cannot remove default language pack.
Message Format “Cannot remove default language pack.”
Severity Warning
Resolution None.

iLO.2.19.CannotRemoveLanguagePack

Cannot remove language pack.
Message Format “Cannot remove %1 language pack.”
Severity Warning
Resolution None.

iLO.2.19.CannotRemoveLicense

Cannot remove the base license.
Message Format “The base license cannot be removed.”
Severity Warning
Resolution None.

iLO.2.19.ChassisPowerDataUnAvailable

Chassis power regulation data is currently unavailable.
Message Format “Chassis power regulation data is currently unavailable.”
Severity Warning
Resolution Reset the management processor or chassis manager, and then retry the operation.

iLO.2.19.ChassisResetRequired

The chassis properties were correctly changed, but will not take effect until the chassis is reset or all nodes in chassis remain powered off for at least 5 seconds.
Message Format “One or more properties were changed and will not take effect until chassis is reset or all nodes in chassis remain powered off for at least 5 seconds.”
Severity Warning
Resolution Reset chassis or remain power off for all nodes in chassis for at least 5 seconds for the settings to take effect.

iLO.2.19.ComponentUploadAlreadyInProgress

A component upload operation is already in progress.
Message Format “A component upload operation is already in progress.”
Severity Warning
Resolution Wait for the current component upload to complete, and then retry the operation.

iLO.2.19.ComponentUploadFailed

A component upload operation failed.
Message Format “A component upload operation failed.”
Severity Warning
Resolution Wait for the current component upload to complete, and then retry the operation.

iLO.2.19.DailyUpdateLimitExceeded

An update operation failed due to exceeding a daily limit.
Message Format “An update operation failed due to exceeding a daily limit.”
Severity Warning
Resolution Retry the operation at a later date.

iLO.2.19.DemoLicenseKeyPreviouslyInstalled

A license was previously activated and now a demo key may not be used.
Message Format “A license was previously activated.”
Severity Warning
Resolution The system is no longer eligible for demo licenses.

iLO.2.19.DeniedHPEOneViewUserCreation

System already managed by Compute Ops Management.
Message Format “System already managed by %1.”
Severity OK
Resolution System can either be managed by HPE OneView or Compute Ops Management.

iLO.2.19.DeviceIsBusy

Device was not available for communication.
Message Format “Device communication response was busy.”
Severity Warning
Resolution Retry the attempted operation after a delay.

iLO.2.19.DeviceResetRequired

Indicates that one or more properties were correctly changed, but will not take effect until device is reset.
Message Format “One or more properties were changed and will not take effect until the device is reset.”
Severity Warning
Resolution Reset the device for the settings to take effect.

iLO.2.19.DiagsTestAlreadyRunning

A diagnostics self test is already running.
Message Format “A diagnostics self test is already running.”
Severity Warning
Resolution Stop the running test and try again.

iLO.2.19.DowngradeNotAllowed

The task did not execute because a downgrade is not allowed by policy.
Message Format “The task did not execute because a downgrade is not allowed by policy.”
Severity Warning
Resolution Obtain the latest available component and retry, and clear the task from the queue so processing can continue.

iLO.2.19.DowngradePolicyAlreadySet

The downgrade policy has been set and cannot be changed.
Message Format “The downgrade policy has been set and cannot be changed.”
Severity Warning
Resolution None.

iLO.2.19.ESKMServersNotConfigured

Enterprise Secure Key Manager Servers are not configured.
Message Format “Enterprise Secure Key Manager Servers are not configured.”
Severity OK
Resolution None.

iLO.2.19.ESXioOrTarImageDownloadAlreadyInProgress

ESXio or tar image download is already in progress.
Message Format “ESXio or tar image download is already in progress.”
Severity Warning
Resolution Wait for the current operation to complete, and then retry the operation.

iLO.2.19.ETagTooLong

The supplied ETag is too long. The maximum supported ETag length is 63 bytes.
Message Format “The supplied ETag is too long. The maximum supported ETag length is 63 bytes.”
Severity Warning
Resolution Retry the operation using an ETag with a length of 63 bytes or less.

iLO.2.19.EmptyDNSName

DNS name is empty.
Message Format “Empty DNS name.”
Severity Warning
Resolution Retry the request with a valid DNS name.

iLO.2.19.ErrorIntializingESKM

Failed to initialize ESKM.
Message Format “Failed to initialize ESKM.”
Severity Warning
Resolution Check if Account Group, Local CA Certificate Name, Login Name and Password are correct and try again.

iLO.2.19.EventLogCleared

Event log cleared successfully.
Message Format “Event log cleared successfully.”
Severity OK
Resolution None.

iLO.2.19.EventSubscriptionModified

The event subscription was modified successfully.
Message Format “The event subscription was modified successfully.”
Severity OK
Resolution None.

iLO.2.19.EventSubscriptionRemoved

The event subscription was removed successfully.
Message Format “The event subscription was removed successfully.”
Severity OK
Resolution None.

iLO.2.19.ExtendedInfo

Indicates that extended information is available.
Message Format “See @Message.ExtendedInfo for more information.”
Severity OK
Resolution See @Message.ExtendedInfo for more information.

iLO.2.19.FWFlashSuccessTPMOverrideEnabled

A Trusted Module is detected in this system. If you have not performed the proper OS encryption procedures, you will lose access to your data if recovery key is not available. Recommended procedure is to suspend encryption software prior to System ROM or Option ROM firmware flash. TPMOverrideFlag is enabled and firmware flash initiated.
Message Format “CAUTION: A Trusted Module is detected in this system. Updating the System ROM or Option Card Firmware may have impact to measurements stored in the TM and may have impact to security functionality on the platform which depends on these measurements.”
Severity OK
Resolution None.

iLO.2.19.FWFlashSuccessTrustedModuleOverrideEnabled

A Trusted Module (type unspecified) is installed in the system and TPMOverrideFlag is enabled. Firmware flash initiated.
Message Format “CAUTION: A Trusted Module (type unspecified) has been detected in this system. If you have not performed the proper OS encryption procedures, you will lose access to your data if recovery key is not available. Recommended procedure for Microsoft Windows® BitLocker™ is to "suspend” BitLocker prior to System ROM or Option ROM firmware flash.“
Severity OK
Resolution None.

iLO.2.19.FWFlashTPMOverrideFlagRequired

A Trusted Module is detected in this system. Failure to perform proper OS encryption procedures will result in loss of access to your data if recovery key is not available. Recommended procedure is to suspend encryption software prior to System ROM or Option ROM firmware flash. If you do not have your recovery key or have not suspended encryption software, cancel this firmware upload. Failure to follow these instructions will result in loss of access to your data. To continue with firmware flash TPMOverrideFlag is required.
Message Format "CAUTION: A Trusted Module is detected in this system. Updating the System ROM or Option Card Firmware may have impact to measurements stored in the TM and may have impact to security functionality on the platform which depends on these measurements.”
Severity Warning
Resolution Please set the TPMOverrideFlag to true and try again.

iLO.2.19.FWFlashTrustedModuleOverrideFlagRequired

A Trusted Module (type unspecified) is installed in the system, TPMOverrideFlag is required for firmware flash to proceed.
Message Format “CAUTION: A Trusted Module (type unspecified) has been detected in this system. Failure to perform proper OS encryption procedures will result in loss of access to your data if recovery key is not available. Recommended procedure for Microsoft Windows® BitLocker™ is to "suspend” BitLocker prior to System ROM or Option ROM firmware flash. If you do not have your recovery key or have not suspended BitLocker, exit this flash: Failure to follow these instructions will result in loss of access to your data.“
Severity Warning
Resolution Please set the TPMOverrideFlag to true and try again.

iLO.2.19.FirmwareFlashAlreadyInProgress

A firmware upgrade operation is already in progress.
Message Format "A firmware flash operation is already in progress.”
Severity Warning
Resolution Wait for the current firmware flash to complete, and then retry the operation.

iLO.2.19.FirmwareVersionNotSupported

Installing this firmware version is not allowed. Check customer advisory for supported versions.
Message Format “Installing this firmware version is not allowed. Check customer advisory for supported versions.”
Severity Warning
Resolution Please install the supported firmware version.

iLO.2.19.GeneratingCertificate

Generating the X509 Certificate.
Message Format “X509 Certificate is being generated and the process might take up to 10 minutes.”
Severity OK
Resolution None.

iLO.2.19.HardDriveZoneBackupFailure

Backup hard drive zoning configuration to BMC has encountered an error.
Message Format “Backup hard drive zoning configuration to BMC has encountered an error.”
Severity Warning
Resolution Retry the operation. If the problem persists, consider resetting the BMC or the entire chassis.

iLO.2.19.HardDriveZoneFailure

Hard Drive Zoning was in error state.
Message Format “Hard Drive Zoning was in error state due to %1.”
Severity Critical
Resolution Retry the operation. If the problem persists, consider resetting the entire chassis.

iLO.2.19.ICRUInvalidAddress

ICRU returned invalid address for translation.
Message Format “ICRU returned invalid address for translation.”
Severity Warning
Resolution Input valid address for translation.

iLO.2.19.ICRUNotSupported

ICRU feature or function is not supported on the system.
Message Format “ICRU feature or function is not supported on the system.”
Severity Warning
Resolution None.

iLO.2.19.IPv6ConfigurationError

The specified IPv6 configuration caused an error.
Message Format “The specified IPv6 configuration was in error due to %1.”
Severity Warning
Resolution Resolve the indicated error in the configuration data.

iLO.2.19.ImportCertFailCSRMissing

Failed to import the Certificate because the corresponding CSR is missing.
Message Format “Failed to import the X509 Certificate because the CSR is missing.”
Severity Warning
Resolution Retry the Certificate Import after generating the CSR on the same machine.

iLO.2.19.ImportCertSuccessful

Import Certificate was successful.
Message Format “Import Certificate was successful.”
Severity OK
Resolution None.

iLO.2.19.ImportCertSuccessfuliLOResetinProgress

Import Certificate was successful and the management processor is being reset.
Message Format “Import Certificate was successful. Management Processor reset is in progress to enable the new certificate.”
Severity Warning
Resolution None.

iLO.2.19.ImportCertificateFailed

Failed importing Certificate.
Message Format “Failed importing the X509 Certificate.”
Severity Warning
Resolution Retry the operation with proper Certificate information.

iLO.2.19.ImportSSOParamError

Not a valid parameter.
Message Format “Invalid Parameter.”
Severity Warning
Resolution Retry the request with valid parameters.

iLO.2.19.ImportSSOUriError

Not a valid Uri to import SSO certificate.
Message Format “Invalid Uri.”
Severity Warning
Resolution Retry the request with valid URI.

iLO.2.19.IndicatorLedInvalidStateChange

The request to change the state of the Indicator LED cannot be granted because the current state is either Blinking or is Unknown.
Message Format “The Indicator LED cannot be changed when its state is Blinking or Unknown.”
Severity Warning
Resolution Please wait until the server has completed its reserved state.

iLO.2.19.InstallSetWriteError

The InstallSet write failed.
Message Format “The InstallSet write of %1 failed.”
Severity Warning
Resolution Ensure a valid name for the item and that space exists to hold the item.

iLO.2.19.InterfaceDisabledResetRequired

Disabling one or more interfaces/features will cause certain functionalities to be not available. Please refer to User Guide for details on the implications. Changes will not take effect until the management processor is reset
Message Format “CAUTION: Disabling one or more interfaces/features will cause certain functionalities to be not available. Please refer to User Guide for details on the implications. Changes will not take effect until the management processor is reset”
Severity OK
Resolution None.

iLO.2.19.InternalErrorWithParam

The operation was not successful due to an internal service error (shown), but the service is still operational.
Message Format “The operation was not successful due to an internal service error (%1), but the service is still operational.”
Severity Critical
Resolution Retry the operation. If the problem persists, consider resetting the service.

iLO.2.19.InvalidConfigurationSpecified

The specified configuration is not valid.
Message Format “The specified configuration is not valid.”
Severity Warning
Resolution Correct the configuration, and then retry the operation.

iLO.2.19.InvalidConfigurationSpecifiedForFederation

iLO Federation Management cannot be supported in the current configuration.
Message Format “iLO Federation Management cannot be supported in the current configuration.”
Severity Warning
Resolution Review the management processor network settings or Onboard Administrator settings and refer to the User Guide.

iLO.2.19.InvalidDwellTime

The dwell time specified is not valid.
Message Format “The dwell time %1 is not valid.”
Severity Warning
Resolution Adhere to the dwell time supported.

iLO.2.19.InvalidEngineID

EngineID should be a hexadecimal number starting with 0x (for example, 0x0102030405abcdef). The string length should be an even number, greater than or equal to 6 characters (excluding the “0x”), and less than or equal to 32 characters.
Message Format “EngineID should be a hexadecimal number starting with 0x (for example, 0x0102030405abcdef). The string length should be an even number, greater than or equal to 6 characters (excluding the "0x”), and less than or equal to 32 characters.“
Severity Warning
Resolution Retry the operation using an EngineID within the specified parameters.

iLO.2.19.InvalidLicenseKey

The license key is not valid.
Message Format "The license key is not valid.”
Severity Warning
Resolution Retry the operation using a valid license key.

iLO.2.19.InvalidOperationForAutoPowerOnState

The operation was not successful because the current auto power on mode specifies power is to remain off.
Message Format “The auto power on delay cannot be set because power is configured to remain off.”
Severity Warning
Resolution Verify that the system auto power on mode is set to turn power on or follow the previous power setting.

iLO.2.19.InvalidOperationForSystemState

The operation was not successful due to the current power state (for example, attempting to turn the power off when it is already off).
Message Format “The operation was not successful due to the current power state.”
Severity Warning
Resolution Verify that the system is in the correct power state, and then retry the operation.

iLO.2.19.InvalidPassphraseLength

The passphrase length is not valid.
Message Format “%1 must contain from %2 to %3 characters.”
Severity Warning
Resolution Correct the passphrase, and then retry the operation.

iLO.2.19.InvalidPasswordComplexity

The password failed the complexity enforcement.
Message Format “A valid password must contain three of the following: uppercase, lowercase, numerals, and other.”
Severity Critical
Resolution Retry the operation using a corrected password.

iLO.2.19.InvalidPasswordLength

The password length is not valid.
Message Format “A valid password must contain between %1 to %2 characters.”
Severity Critical
Resolution Retry the operation using a corrected password.

iLO.2.19.InvalidSerialNumberLength

The serial number length is not valid.
Message Format “A valid serial number must be %1 characters of length.”
Severity Critical
Resolution Adjust the length of the serial number and retry the operation.

iLO.2.19.InvalidUserDefAlertType

The provided alert type is not supported for this feature.
Message Format “The provided alert type is not supported for this feature.”
Severity OK
Resolution The supported alert types are ‘Warning’ and ‘Critical.’

iLO.2.19.InvalidUserDefSensorNumber

The provided sensor number is not supported for this feature.
Message Format “The provided sensor number is not supported for this feature.”
Severity OK
Resolution Verify that the provided sensor number is a supported sensor.

iLO.2.19.InvalidUserDefTemperatureThresholdValue

The user defined temperature threshold value for a sensor cannot exceed the hardware defined cautionary temperature threshold.
Message Format “The user defined temperature threshold value for a sensor cannot exceed the hardware defined cautionary temperature threshold.”
Severity OK
Resolution Enter a value lower than the cautionary threshold defined for the corresponding sensor.

iLO.2.19.LicenseKeyDenied

The license key activation was refused. Includes details.
Message Format “The license activation key cannot be installed. %1”
Severity Warning
Resolution Address the condition or use a valid license activation key.

iLO.2.19.LicenseKeyNotSupported

The license key supplied is unsupported on this system. The key may activate a different product or unsupported tier.
Message Format “The supplied license key is not supported on this system.”
Severity Warning
Resolution None.

iLO.2.19.LicenseKeyRequired

A license key is required to use this operation or feature.
Message Format “A license key is required to use this operation or feature.”
Severity Warning
Resolution Install a license key to use this feature.

iLO.2.19.LocationIndicatorActiveInvalidStateChange

The request to change the state of the Indicator LED cannot be granted because the current state is either Blinking or Unknown.
Message Format “The Indicator LED cannot be changed when its state is Blinking or Unknown.”
Severity Warning
Resolution Please wait until the server has completed its reserved state.

iLO.2.19.LoginAttemptDelayed

The login was not successful, so the service enforces a delay before another login is allowed.
Message Format “The login was not successful, so the service enforces a delay before another login is allowed.”
Severity Warning
Resolution Wait for the delay time to expire, and then retry the login.

iLO.2.19.LoginAttemptDelayedSeconds

The login was not successful, so the service enforces a delay before another login is allowed.
Message Format “The login was not successful, so the service enforces a %1 second delay before another login is allowed.”
Severity Warning
Resolution None.

iLO.2.19.MCTPDiscoveryDisabled

Telemetry service and Workload Performance advisor will be not available with MCTP discovery disabled.
Message Format “Telemetry service and Workload Performance advisor will be not available with MCTP discovery disabled.”
Severity Warning
Resolution Enable MCTP discovery for Telemetry service and Workload Performance advisor.

iLO.2.19.MailNotConfigured

E-mail not configured for two factor authentication to recieve token.
Message Format “E-mail not configured for two factor authentication to receive token.”
Severity Critical
Resolution Configure the E-mail to receive token.

iLO.2.19.MaxProviders

The maximum number of providers are already registered.
Message Format “The maximum number of providers are already registered.”
Severity Warning
Resolution None.

iLO.2.19.MaxVirtualMediaConnectionEstablished

No more Virtual Media connections are available, because the maximum number of connections are already established.
Message Format “No more Virtual Media connections are available, because the maximum number of connections are already established.”
Severity Warning
Resolution Close an established Virtual Media connection, and then retry creating or opening another connection.

iLO.2.19.MembistVariablesNotSupported

Membist variables are not supported on the system.
Message Format “Membist variables are not supported on the system.”
Severity Warning
Resolution None.

iLO.2.19.MemoryInterleaveSetError

The memory set specified in InterleaveSets is not supported.
Message Format “The memory set specified in InterleaveSets is not supported.”
Severity Warning
Resolution Ensure the memory set specified in InterleaveSets matches one of the memory domain’s InterleavableMemrorySets.

iLO.2.19.NandMountFailed

NAND mount failed.
Message Format “NAND mount failed.”
Severity Warning
Resolution Retry with iLO reset.

iLO.2.19.NewerVersionRequired

Update does not meet minimum version requirements.
Message Format “Update does not meet minimum version requirements.”
Severity Warning
Resolution Use newer version.

iLO.2.19.NoContent

The requested resource exists but has no content.
Message Format “The resource exists but has no content.”
Severity OK
Resolution None

iLO.2.19.NoEventSubscriptions

There are no event subscriptions registered.
Message Format “The operation cannot be completed because there are no event subscribers.”
Severity Warning
Resolution

iLO.2.19.NoPowerMetering

No support for power metering available on platform.
Message Format “No support for power metering available on platform.”
Severity OK
Resolution Enable Power Metering on platform if supported.

iLO.2.19.NoSNMPAlertDestinationsConfigured

No SNMP alert destinations configured or none of the configured destinations are associated with SNMPv1 protocol or SNMPv3 protocol and user.
Message Format “No SNMP alert destinations configured or none of the configured destinations are associated with SNMPv1 protocol or SNMPv3 protocol and user.”
Severity Warning
Resolution Configure at least one SNMP alert destination and associate it with SNMPv1 protocol or SNMPv3 protocol and user.

iLO.2.19.NoSamples

No power history samples are available.
Message Format “No power history samples are available.”
Severity OK
Resolution To accumulate power history samples, power on the server, and then wait at least 5 minutes.

iLO.2.19.NoScriptedVirtualMediaConnectionAvailable

No scripted virtual media connections exist to perform the operation.
Message Format “No scripted virtual media connections exist to perform the operation.”
Severity Warning
Resolution Create or open a scripted virtual media connection, and then retry the operation.

iLO.2.19.NoSpaceforDNSName

No space to store DNS name.
Message Format “No space to store DNS name.”
Severity Warning
Resolution Make sure SSO database has enough space to store DNS name.

iLO.2.19.NoVirtualMediaConnectionAvailable

No Virtual Media connections exist to perform the operation.
Message Format “No Virtual Media connections exist to perform the operation.”
Severity Warning
Resolution Create or open a Virtual Media connection, and then retry the operation.

iLO.2.19.NodeAssignedCrossRegion

Each zone can only manage the node in the same region, cannot manage overlap region.
Message Format “Each zone can only manage the node for range %1 or range %2, cannot manage overlap region.”
Severity Warning
Resolution Correct the out of range value, and then retry the operation.

iLO.2.19.NodeNotPresentInZone

Operation is currently unavailable because there is no node installed in the zone.
Message Format “Operation is currently unavailable because there is no node installed in the zone.”
Severity Warning
Resolution Install at least one node in the zone and retry the operation.

iLO.2.19.NonPLDMUpdateableTargetURI

The Target Url passed is for non PLDM updateable device.
Message Format “The Target Url %1 posted is for non PLDM updateable device”
Severity Warning
Resolution Targets URI is for non PLDM updateable device. Provide a valid PLDM updateable Targets URI and resubmit the request.

iLO.2.19.NotSupportedOnNIC

This property is not supported by the indicated network port.
Message Format “%1 is not supported on the %2 Network Port.”
Severity Warning
Resolution Do not specify this property on the indicated network port.

iLO.2.19.NotValidIPAddrOrDNS

The value for the property is not a valid IPv4/v6 address or DNS name.
Message Format “The value for property %1 is not a valid IPv4/v6 address or DNS name.”
Severity Warning
Resolution Correct the IPv4/v6 address or DNS name, and then retry the operation.

iLO.2.19.NotValidIPAddress

The value for the property is not a valid IP address.
Message Format “The value %1 is not a valid IP address for %2”
Severity Warning
Resolution Use a valid IP address.

iLO.2.19.NotValidSubnetMask

The value for the property is not a valid subnet mask.
Message Format “The value %1 is not a valid subnet mask for %2”
Severity Warning
Resolution Use a valid subnet mask.

iLO.2.19.OperationAvailableAfterSystemPOST

The value for the property can not be set until System BIOS POST completes.
Message Format “Property %1 will be settable after the System BIOS completes POST.”
Severity Warning
Resolution Wait to see the change in value until after the System BIOS completes POST.

iLO.2.19.OperationWillCompleteAfterSystemPOST

The value for the property will be applied after System BIOS POST completes.
Message Format “The value for property %1 will be changed after the System BIOS completes POST.”
Severity OK
Resolution Wait to see the change in value until after the System BIOS completes POST.

iLO.2.19.PowerCapOACntrld

The enclosure Onboard Administrator is currently managing the power cap.
Message Format “The enclosure Onboard Administrator is currently managing the power cap.”
Severity Warning
Resolution Use Onboard Administrator to Manage the PowerCap

iLO.2.19.PowerCapROMCntrld

The System ROM is currently managing the power cap.
Message Format “The System ROM is currently managing the power cap.”
Severity Warning
Resolution Enable RESTful API management of the power cap in System ROM

iLO.2.19.PowerLimitMayNotTakeEffect

One of power limit setpoint may become unreachable due to power limit range is unknown. It’s not recommended configure power limit setpoint when power limit range is unknown.
Message Format “One of power limit setpoint may become unreachable due to power limit range is unknown. It’s not recommended configure power limit setpoint when power limit range is unknown.”
Severity Warning
Resolution Please execute calibrate action to get power limit range then reconfigure power limit setpoint.

iLO.2.19.PowerRegulationNotDisable

Operation is currently unavailable because chassis power regulation is enabled.
Message Format “Operation is currently unavailable because chassis power regulation is enabled.”
Severity Warning
Resolution Disable chassis power regulation, and then retry the operation.

iLO.2.19.PowerSettingAdjustRequired

Indicates that one or more power limit setting were correctly changed, but will not take effect until power regulation enable and power regulator mode switch to user configurable mode.
Message Format “Indicates that one or more power limit setting were correctly changed, but will not take effect until power regulation enable and power regulator mode switch to user configurable mode.”
Severity Warning
Resolution Enable power regulation and switch power regulator mode to user configurable mode for the settings to take effect.

iLO.2.19.PowerValueBadParam

The power cap value is not valid.
Message Format “The power cap value is not valid.”
Severity Warning
Resolution Retry the operation using a corrected value.

iLO.2.19.PowerValueInvalidCalibrationData

The request to set the power cap failed. Invalid power cap calibration data. The Power Cap feature is currently unavailable.
Message Format “The request to set the power cap failed. Invalid power cap calibration data. The Power Cap feature is currently unavailable”
Severity Warning
Resolution Restart the server to retrieve calibration data from initial POST.

iLO.2.19.PowerValueNotOptimal

Power caps set below the specified percentage threshold might become unreachable due to changes in the server. It is recommended to not set a cap for less than this threshold.
Message Format “Power caps set below the specified percentage threshold might become unreachable due to changes in the server. It is recommended to not set a cap for less than %1.”
Severity Warning
Resolution Please provide an optimal value in integer considering the power cap range.

iLO.2.19.PowerValueUnAvailable

Advanced power capping is not currently available due to the system configuration or state.
Message Format “Advanced power capping is not currently available due to the system configuration or state.”
Severity Warning
Resolution Change the system configuration or wait for the system to become fully initialized, and then retry the operation.

iLO.2.19.PowerValueUnSupported

Advanced power capping is not supported on this system.
Message Format “Advanced power capping is not supported on this system.”
Severity Warning
Resolution None.

iLO.2.19.PrimaryESKMServerAccessible

Only the primary ESKM server is accessible.
Message Format “No redundancy. Only the primary ESKM server is accessible.”
Severity OK
Resolution None.

iLO.2.19.PrimarySecondaryAddressesResolveToSameServer

Primary and secondary ESKM server addresses resolve to the same server.
Message Format “No redundancy. Primary and secondary ESKM server addresses resolve to the same server.”
Severity OK
Resolution None.

iLO.2.19.PrimarySecondaryESKMServersAccessible

Both primary and secondary ESKM servers are accessible.
Message Format “Redundant solution: Both primary and secondary ESKM servers are accessible.”
Severity OK
Resolution None.

iLO.2.19.PropertyNotSupported

The property is not supported.
Message Format “The property %1 is not supported.”
Severity Warning
Resolution Do not attempt to modify this property.

iLO.2.19.PropertyNotWritableOrUnknown

The request included a value for a read-only or unknown property.
Message Format “The property %1 is a read-only property and cannot be assigned a value, or not valid for this resource.”
Severity Warning
Resolution If the operation did not complete, remove the property from the request body and resubmit the request.

iLO.2.19.PropertyValueAlreadySet

The value being set for the property is same as existing value.
Message Format “The new value %1 is same as existing value for the property %2.”
Severity OK
Resolution None

iLO.2.19.PropertyValueBadParam

The property value is not valid.
Message Format “The property value is not valid.”
Severity Warning
Resolution Retry the operation using a corrected value.

iLO.2.19.PropertyValueExceedsMaxLength

The value for the property exceeds the maximum length.
Message Format “The value %1 for the property %2 exceeds the maximum length of %3.”
Severity Warning
Resolution Correct the value for the property in the request body, and then retry the operation.

iLO.2.19.PropertyValueIncompatible

The value for the property is the correct type, but this value is incompatible with the current value of another property.
Message Format “The value %1 for the property %2 is incompatible with the value for property %3.”
Severity Warning
Resolution Correct the value for the property in the request body, and then retry the operation.

iLO.2.19.PropertyValueOutOfRange

The value for the property is out of range.
Message Format “The value %1 for the property %2 is out of range %3.”
Severity Warning
Resolution Correct the value for the property in the request body, and then retry the operation.

iLO.2.19.PropertyValueRequired

Indicates that a property was required but not specified.
Message Format “%1 requires Property %2 to be specified.”
Severity Warning
Resolution Include the required property in the request body and then retry the operation.

iLO.2.19.RecoveryInstallSetRequired

A recovery install set is required for this action.
Message Format “No recovery install set present.”
Severity Critical
Resolution Create a recovery install set (install set with IsRecovery property set true).

iLO.2.19.RepairNotSupported

IML event with this severity is not supported to be repaired. IML events with Critical or Warning severities can marked as repaired.
Message Format “IML event with %1 severity is not supported to be repaired. IML events with Critical or Warning severities can marked as repaired.”
Severity Warning
Resolution Please do not try to repair IML events with severity other than Critical or Warning.

iLO.2.19.RequiredPropertyMissing

Indicates that a required property is not specified.
Message Format “Required Property %1 needs to be specifed.”
Severity Warning
Resolution Include the required property in the request body and then retry the operation.

iLO.2.19.ResetInProgress

A management processor reset is in progress.
Message Format “A management processor reset is in progress.”
Severity Warning
Resolution Wait for management processor reset to complete, and then retry the operation.

iLO.2.19.ResetRequired

One or more properties were changed, but these changes will not take effect until the management processor is reset.
Message Format “One or more properties were changed, but these changes will not take effect until the management processor is reset.”
Severity Warning
Resolution To enable the changed properties, reset the management processor.

iLO.2.19.ResourceBeingFlashed

The change to the requested resource failed because the resource is being flashed.
Message Format “The change to the requested resource failed because the resource is being flashed.”
Severity Warning
Resolution Retry the operation when the firmware upgrade has completed.

iLO.2.19.ResourceInUseWithDetail

The change could not be made because the resource was in use or in a transitioning state.
Message Format “The change to the resource failed because the resource is in use or in transition.”
Severity Warning
Resolution Retry the request.

iLO.2.19.ResourceNotReadyRetry

The resource is present but is not ready to perform operations due to an internal condition such as initialization or reset.
Message Format “The resource is present but is not ready to perform operations. The resource will be ready in %1 seconds.”
Severity Warning
Resolution Retry the operation when the resource is ready.

iLO.2.19.ResourceTemporarilyUnavailable

The resource is temporarily unavailable because the firmware is being flashed.
Message Format “The resource is temporarily unavailable because the firmware is being flashed.”
Severity Warning
Resolution Retry the operation when the firmware upgrade has completed.

iLO.2.19.SMBIOSRecordNotFound

The SMBIOS record type is not found or is not supported on the system.
Message Format “The SMBIOS record type %1 is not found or is not supported on the system.”
Severity Warning
Resolution Reset the system to update the SMBIOS records. If the problem persists then the SMBIOS record type is not supported.

iLO.2.19.SNMPAlertDisabled

The operation could not be completed because SNMP alerts are disabled.
Message Format “The operation could not be completed because SNMP alerts are disabled.”
Severity Warning
Resolution Enable SNMP alerts and retry the operation.

iLO.2.19.SNMPDisabled

Modifying SNMP properties is not possible with SNMP disabled.
Message Format “Modifying SNMP properties is not possible with SNMP disabled.”
Severity Warning
Resolution Enable SNMP, and then modify the SNMP properties.

iLO.2.19.SNMPTestAlertFailed

The SNMP Test Alert did not send successfully.
Message Format “The SNMP Test Alert did not send successfully.”
Severity Warning
Resolution Verify the test alert content and retry.

iLO.2.19.SNMPv1Disabled

Modifying SNMP v1 properties is not possible with SNMP v1 protocol disabled.
Message Format “Modifying SNMP v1 properties is not possible with SNMP v1 protocol disabled.”
Severity Warning
Resolution Enable SNMP v1, and then modify the SNMP v1 properties.

iLO.2.19.SNMPv3Disabled

Modifying SNMP v3 properties is not possible with SNMP v3 protocol disabled.
Message Format “Modifying SNMP v3 properties is not possible with SNMP v3 protocol disabled.”
Severity Warning
Resolution Enable SNMP v3, and then modify the SNMP v3 properties.

iLO.2.19.SNTPConfigurationManagedByDHCPAndIsReadOnly

SNTP configuration is currently managed by DHCP and is therefore read-only.
Message Format “%1 cannot be changed while DHCP is configured to provide SNTP settings.”
Severity Warning
Resolution Disable SNTP configuration options in both DHCPv4 and DHCPv6 (see /Managers/n/NICs), and then reconfigure SNTP as desired with static settings.

iLO.2.19.SSOCertficateEmpty

SSO Certificate is Empty.
Message Format “Empty SSO Certificate.”
Severity Warning
Resolution None.

iLO.2.19.SSOCertificateReadError

SSO Certificate Read Error.
Message Format “Error reading SSO certificate.”
Severity Warning
Resolution Retry the request with valid SSO certificate.

iLO.2.19.SSONoSpaceError

No space to store SSO certificate.
Message Format “No space to store SSO certificate.”
Severity Warning
Resolution Make sure SSO database has enough space to store SSO certificate.

iLO.2.19.SSORecordNotFound

SSO Record Not Found.
Message Format “SSO Record Not Found.”
Severity Warning
Resolution None.

iLO.2.19.SamplesNotCaptured

Samples are not captured for %1 duration.
Message Format “Samples for metrics are not captured for %1 duration.”
Severity OK
Resolution Wait for the current duration to complete, and then retry.

iLO.2.19.SecondaryESKMServerAccessible

Only the secondary ESKM server is accessible.
Message Format “No redundancy. Only the secondary ESKM server is accessible.”
Severity OK
Resolution None.

iLO.2.19.ServerConfigLockStatusUnknown

The current status of Server Configuration Lock is unknown.
Message Format “The current status of Server Configuration Lock is unknown.”
Severity Warning
Resolution Ensure if the BIOS firmware supports Server Configuration Lock. If supported, reboot the server and retry the operation

iLO.2.19.ServerConfigurationLockEnabled

Server Configuration Lock is enabled.
Message Format “Server Configuration Lock is enabled.”
Severity Warning
Resolution Disable Server Configuration Lock to initiate secure erase of the system

iLO.2.19.SimpleUpdateInvalidImageOrCredentials

The ESXio Image or Username and Password to access the ESXio image URI is not valid.
Message Format “The ESXio image or username and password credentials provided to access the ESXio Image URI : %1 posted in %2 is not valid.”
Severity Warning
Resolution ESXio image URI/Username/Password is incorrect. Please provide valid details and resubmit the request.

iLO.2.19.SimpleUpdateInvalidImageURI

The Url passed for the simple update for firmware image download is not valid.
Message Format “The firmware Image Url %1 posted in %2 is not valid.”
Severity Warning
Resolution FirmwareImage URL is incorrect. Provide a valid firmware Image URL and resubmit the request.

iLO.2.19.SimpleUpdateInvalidTargetsURI

The Targets URI passed for the simple update for esxio image download is not valid.
Message Format “The Targets URI %1 posted in %2 is not valid.”
Severity Warning
Resolution Targets URI is incorrect. Provide a valid Targets URI and resubmit the request.

iLO.2.19.SmartNICDeviceError

SmartNIC DPU operation failed due to SmartNIC device error.
Message Format “SmartNIC DPU operation failed due to SmartNIC device error %1.”
Severity Warning
Resolution None.

iLO.2.19.SmartNICNotPresent

SmartNIC DPU not present in iLO.
Message Format “SmartNIC DPU URI %1 posted in %2 is not present.”
Severity Warning
Resolution System can either be managed by HPE OneView or Compute Ops Management.

iLO.2.19.SuccessFeedback

The operation completed successfully.
Message Format “The operation completed successfully.”
Severity OK
Resolution None

iLO.2.19.SyslogFeatureDisabled

Remote Syslog feature is disabled.
Message Format “Remote syslog feature is disabled.”
Severity Warning
Resolution Enable remote syslog feature to send test syslog message.

iLO.2.19.SystemPowerOffRequired

To perform this operation, power off the system. AutoPowerOn must be set to achieve a power restore.
Message Format “To perform this operation, power off the system.”
Severity OK
Resolution To perform this operation, power off the system.

iLO.2.19.SystemPowerStateChangeFailed

System power state change failed (for example, attempting to turn the system power On/Off failed)
Message Format “System power state change failed”
Severity Warning
Resolution Retry the request.

iLO.2.19.SystemResetRequired

The system properties were correctly changed, but will not take effect until the system is reset.
Message Format “One or more properties were changed and will not take effect until system is reset.”
Severity Warning
Resolution Reset system for the settings to take effect.

iLO.2.19.TargetsLimitExceeded

The Target Url count exceeded the limit.
Message Format “The Target Url count exceeded the limit.”
Severity Warning
Resolution Provide Targets URI’s within maximum allowable range and resubmit the request.

iLO.2.19.TokenRequired

Proper ‘X-HPRESTFULAPI-AuthToken’ authorization token not provided.
Message Format “Proper ‘X-HPRESTFULAPI-AuthToken’ authorization token not provided.”
Severity Critical
Resolution Create proper ‘X-HPRESTFULAPI-AuthToken’ authorization token. Send token in using the proper HTTP header.

iLO.2.19.UnableModifyRights

Unable to modify user rights.
Message Format “Unable to modify user rights.”
Severity Warning
Resolution None.

iLO.2.19.UnableToModifyAfterVirtualMediaInsert

The value for the property cannot be changed after virtual media image is inserted.
Message Format “The value for property %1 cannot be changed after virtual media image is inserted.”
Severity Warning
Resolution Retry the operation during virtual media image insertion.

iLO.2.19.UnableToModifyDueToMissingComponent

The value for the property cannot be changed because a related hardware component is not installed.
Message Format “The value for property %1 cannot be changed because a related hardware component is not installed.”
Severity Warning
Resolution Install the hardware component and retry the operation.

iLO.2.19.UnableToModifyDuringSystemPOST

The value for the property cannot be changed while the computer system BIOS is in POST.
Message Format “The value for property %1 cannot be changed while the computer system BIOS is in POST.”
Severity Warning
Resolution After the computer system is either fully booted or powered off, retry the operation.

iLO.2.19.UnableToModifyWhileKVMIPConnected

The value for the property cannot be changed while a KVMIP connection is in progress.
Message Format “The value for property %1 cannot be changed while a KVMIP connection is in progress.”
Severity Warning
Resolution Retry the operation after disconnecting all KVMIP connections.

iLO.2.19.UnauthorizedLoginAttempt

The login was not successful, because the supplied credentials could not be authorized.
Message Format “The login was not successful, because the supplied credentials could not be authorized.”
Severity Warning
Resolution Log in with authorized user name and password credentials.

iLO.2.19.UnsupportedCipherAlgo

Incompatible Cipher Algorithm in FIPS or CNSA Mode.
Message Format “Incompatible Cipher Algorithm %1 in %2 Mode.”
Severity Warning
Resolution Select compatible Cipher Algorithm.

iLO.2.19.UnsupportedOperation

This operation is not supported by RIS for the current system.
Message Format “This operation is not supported by RIS for the current system.”
Severity Warning
Resolution None.

iLO.2.19.UnsupportedOperationACEEnabled

This operation is not supported when certificate enrollment service is enabled.
Message Format “This operation is not supported when certificate enrollment service is enabled.”
Severity OK
Resolution Disable certificate enrollment Service to initiate import, delete or generate CSR of SSL certificate.

iLO.2.19.UnsupportedOperationInChassisVersion

This operation is not supported by the current version of the XL Chassis firmware.
Message Format “This operation is not supported by the current version of the XL Chassis firmware.”
Severity Warning
Resolution Please update the XL Chassis firmware to latest version.

iLO.2.19.UnsupportedOperationInLegacyBootMode

This operation is not supported when the system Boot Mode is set to Legacy BIOS.
Message Format “ This operation is not supported when the system Boot Mode is set to Legacy BIOS.”
Severity Warning
Resolution Change the Boot Mode to UEFI and retry the operation.

iLO.2.19.UnsupportedOperationInSystemBIOS

This operation is not supported by the current version of the system BIOS.
Message Format “This operation is not supported by the current version of the system BIOS.”
Severity Warning
Resolution None.

iLO.2.19.UnsupportedSecurityState

The operation was not successful due to the current security state of the management processor.
Message Format “The operation was not successful due to the current security state of the management processor.”
Severity Warning
Resolution Retry the operation with the correct security state.

iLO.2.19.UpdateBadParameter

The update failed because a bad parameter was supplied.
Message Format “The update failed because a bad parameter was supplied.”
Severity Critical
Resolution Supply correct parameters to the component and retry the update.

iLO.2.19.UpdateCancelled

The update was canceled by the update process.
Message Format “The update was canceled by the update process.”
Severity Critical
Resolution Retry the update.

iLO.2.19.UpdateDependencyFailure

The update did not complete because the component failed a dependency check.
Message Format “The update did not complete because the component failed a dependency check.”
Severity Critical
Resolution Install any dependent components first and then retry this update.

iLO.2.19.UpdateFailed

The update failed with a component specific error (%1).
Message Format “The update failed with a component specific error (%1).”
Severity Critical
Resolution Retry the update after remedying the component error.

iLO.2.19.UpdateInPOST

System must not be booted past POST in order to perform this update
Message Format “System must not be booted past POST in order to perform this update”
Severity Critical
Resolution Boot to UEFI and retry the update.

iLO.2.19.UpdateInterrupted

The update was interrupted.
Message Format “The update was interrupted.”
Severity Critical
Resolution Retry the update.

iLO.2.19.UpdateInvalidFile

The update operation failed because the file is not valid.
Message Format “The update operation failed because the file is not valid.”
Severity Critical
Resolution Remove and re-add the component to the repository and try the operation again.

iLO.2.19.UpdateInvalidOS

The update did not occur because the running OS is not valid.
Message Format “The update did not occur because the running OS is not valid.”
Severity Critical
Resolution Retry the update while running the correct OS.

iLO.2.19.UpdateNotApplicable

The task was not completed because the component was not applicable to this system.
Message Format “The task was not completed because the component was not applicable to this system.”
Severity Critical
Resolution None.

iLO.2.19.UpdateRepositoryUnavailable

The update operation failed because the component repository is unavailable.
Message Format “The update operation failed because the component repository is unavailable.”
Severity Critical
Resolution None.

iLO.2.19.UpdateSimpleStatus

This is to update the esxio image flashing status into SmartNIC DPU systems.
Message Format “TaskState is %1 and TaskStatus is %2 and Message is %3 and Percent Complete is %4”
Severity Warning
Resolution None

iLO.2.19.UpdateTaskQueueFull

The Invoke action was not successful because the update task queue is full.
Message Format “The Invoke action was not successful because the update task queue is full.”
Severity Critical
Resolution Remove completed tasks from the update task queue to retry the operation.

iLO.2.19.UpdateTaskQueueWriteError

The UpdateTaskQueue write failed.
Message Format “The UpdateTaskQueue write of %1 failed.”
Severity Warning
Resolution Ensure a valid name for the item and that space exists to hold the item.

iLO.2.19.UpdateTemporarilyUnavailable

The system is temporarily unable to perform this update
Message Format “The system is temporarily unable to perform this update”
Severity Critical
Resolution Retry the update, ensuring that power state is stable.

iLO.2.19.UpdateWithPowerOff

System power must be off to perform this update
Message Format “System power must be off to perform this update”
Severity Critical
Resolution Power system on and retry the update.

iLO.2.19.UpdateWithPowerOn

System power must be on to perform this update
Message Format “System power must be on to perform this update”
Severity Critical
Resolution Power system on and retry the update.

iLO.2.19.UserAlreadyExist

The user or login user name already exists.
Message Format “The user or login user name already exists.”
Severity Warning
Resolution Try a different user or login user name.

iLO.2.19.UserNameAlreadyExists

Duplicate SNMPv3 User.
Message Format “The username %1 already exists in the list”
Severity Warning
Resolution Enter a different name and try again.

iLO.2.19.VirtualMediaIsDisabled

Virtual Media has been disabled.
Message Format “Virtual Media has been disabled.”
Severity Warning
Resolution Enable Virtual Media to perform this operation.

iLO.2.19.ZonePowerLimitExceeded

The sum of zone power limit cannot be more than chassis power limit.
Message Format “The value %1 for the sum of %2 cannot be more than chassis power limit %3.”
Severity Warning
Resolution Correct the value avoid the sum of power limit exceeds chassis power limit, and then retry the operation.

iLO.2.19.iLOResetAndSystemRebootRequired

Indicates that one or more properties were correctly changed, but will not take effect until device is reset and system is rebooted.
Message Format “One or more properties were changed and will not take effect until the device is reset and system is rebooted”
Severity Warning
Resolution Reset the management processor and reboot the server.

iLO.2.19.iLOSubnetConflict

The subnet being configured has conflicts.
Message Format “The subnet being configured for %1 conflicts with %2.”
Severity Warning
Resolution Configure this interface with a different IP Address or Subnet Mask.

iLO.2.19.iLOVirtualNICDisabled

The Virtual NIC is disabled.
Message Format “The Virtual NIC is disabled.”
Severity Warning
Resolution Enable iLO Virtual NIC to perform this operation.

iLOeRS.1.0.AuthenticationError

Authentication error.
Message Format “Authentication error.”
Severity Critical
Resolution Please unregister and re-register the device.

iLOeRS.1.0.CannotConnectToProxyServer

Unable to connect to the proxy server.
Message Format “Unable to connect to the proxy server.”
Severity Warning
Resolution Please verify proxy settings and connectivity.

iLOeRS.1.0.CannotConnectToRemoteHost

Can not connect to remote host. Transmission to the HPE Insight Remote Support receiver was unsuccessful.
Message Format “Can not connect to remote host.”
Severity Critical
Resolution Please check connectivity between Management Processor and the Insight Remote Support receiver and retry.

iLOeRS.1.0.CannotEstablishSSLConnection

Protocol error occurred while communicating with the HPE Insight Remote Support receiver.
Message Format “Protocol error occurred while communicating with the HPE Insight Remote Support receiver.”
Severity Critical
Resolution Please retry.

iLOeRS.1.0.ChangeOrResetHPEPassportPassword

The HPE Passport password must be changed or reset.
Message Format “The HPE Passport password must be changed or reset.”
Severity Critical
Resolution Please attempt to register again after correcting the HPE Passport problem.

iLOeRS.1.0.ClientReceiveError

Client Receive Error. Transmission to the HPE Insight Remote Support receiver was unsuccessful.
Message Format “Client Receive Error.”
Severity Critical
Resolution Please check connectivity between Management Processor and the Insight Remote Support receiver and retry.

iLOeRS.1.0.ClientReceiveTimeout

Client Receive Timeout. Transmission to the HPE Insight Remote Support receiver was unsuccessful.
Message Format “Client Receive Timeout.”
Severity Warning
Resolution Please check connectivity between Management Processor and the Insight Remote Support receiver.

iLOeRS.1.0.ClientTransmitTimeout

Client Transmit Timeout. Transmission to the HPE Insight Remote Support receiver was unsuccessful.
Message Format “Client Transmit Timeout.”
Severity Warning
Resolution Please check connectivity between Management Processor and the Insight Remote Support receiver.

iLOeRS.1.0.ConnectBIOerror

Connect BIO error. Transmission to the HPE Insight Remote Support receiver was unsuccessful.
Message Format “Connect BIO error.”
Severity Warning
Resolution Please check connectivity between Management Processor and the Insight Remote Support receiver and retry.

iLOeRS.1.0.CorruptDeviceIdentifiers

Corrupt device identifiers.
Message Format “Corrupt device identifiers.”
Severity Critical
Resolution Please unregister and re-register the device.

iLOeRS.1.0.CorruptGDID

The GDID was found to be corrupted.
Message Format “Corrupt GDID.”
Severity Critical
Resolution Please unregister and re-register the device.

iLOeRS.1.0.CorruptGUID

The GUID is found to be corrupted.
Message Format “Corrupt GUID.”
Severity Critical
Resolution Please retry your last step. If error persists and device is currently registered, unregister and re-register device.

iLOeRS.1.0.CorruptRegistrationInformation

The registration information was found to be corrupted.
Message Format “Corrupt registration information.”
Severity Critical
Resolution Please unregister and re-register the device.

iLOeRS.1.0.CorruptRegistrationToken

The registration token was found to be corrupted.
Message Format “Corrupt registration token.”
Severity Critical
Resolution Please unregister and re-register the device.

iLOeRS.1.0.DataPackageValidationFailed

Data Package validation failed.
Message Format “Data Package validation failed.”
Severity Critical
Resolution Please retry your last step. If error persists and device is currently registered, unregister and re-register device.

iLOeRS.1.0.DestinationURLParseError

Destination URL Parse Error.
Message Format “Destination URL Parse Error.”
Severity Warning
Resolution None.

iLOeRS.1.0.DeviceAlreadyRegistered

Device is already registered.
Message Format “Device is already registered”
Severity Warning
Resolution Please delete the device from Insight Remote Support user interface and retry registration.

iLOeRS.1.0.DeviceDeleted

This device has been previously deleted from the Insight Remote Support user interface.
Message Format “This device has been previously deleted from the Insight Remote Support user interface.”
Severity Critical
Resolution Please unregister and re-register device.

iLOeRS.1.0.DeviceIsNotRegistered

Device is not registered. Remote Support registration has been disabled locally on this device. No service events or data collections will be sent until this device has been re-registered.
Message Format “Device is not registered.”
Severity Warning
Resolution Please register the device.

iLOeRS.1.0.DeviceUnregistrationFailed

Unregistration request was not processed successfully by the HPE Remote Support receiver. Remote Support has been disabled locally. No service events or data collections will be sent until this device has been re-registered.
Message Format “Unregistration request was not processed successfully by the HPE Remote Support receiver.”
Severity Critical
Resolution Please Register the Device.

iLOeRS.1.0.ERSIsDisabled

Embedded Remote Support is disabled.
Message Format “Embedded Remote Support is disabled.”
Severity Critical
Resolution Please retry registration.

iLOeRS.1.0.ErrorReadingERSConfiguration

Error reading Embedded Remote Support configuration.
Message Format “Error reading Embedded Remote Support configuration.”
Severity Warning
Resolution None.

iLOeRS.1.0.ErrorRetrievingRegToken

Error retrieving registration token.
Message Format “Error retrieving registration token.”
Severity Warning
Resolution None.

iLOeRS.1.0.ExpiredHPEPassportCredentials

THe HPE Passport credentials expired.
Message Format “The HPE Passport credentials expired.”
Severity Critical
Resolution Please attempt to register again after correcting the HPE Passport problem.

iLOeRS.1.0.ExpiredRegistrationToken

The registration token was found to be expired.
Message Format “Expired registration token.”
Severity Critical
Resolution Please unregister and re-register the device.

iLOeRS.1.0.GeneralReceiverError

General Receiver Error. HPE Remote Support receiver is temporarily unavailable.
Message Format “General Receiver Error.”
Severity Warning
Resolution Please retry later.

iLOeRS.1.0.GenericTransmitError

Generic Transmit Error. Transmission to the HPE Insight Remote Support receiver was unsuccessful.
Message Format “Generic Transmit Error.”
Severity Critical
Resolution Please check connectivity between Management Processor and the Insight Remote Support receiver.

iLOeRS.1.0.HPEPassportAccountIsLockedOut

HPE Passport account is locked out.
Message Format “HPE Passport account is locked out.”
Severity Warning
Resolution Please reset your password and retry registration.

iLOeRS.1.0.HPEPassportAccountLockedOut

The HPE Passport account is locked out.
Message Format “HPE Passport account locked out.”
Severity Critical
Resolution Please attempt to register again after correcting the HPE Passport problem.

iLOeRS.1.0.HPEPassportPasswordHasExpired

HPE Passport Password has expired.
Message Format “HPE Passport Password has expired.”
Severity Critical
Resolution Please update your password and retry registration.

iLOeRS.1.0.HPEPassportPasswordIsRequired

HPE Passport Password is required.
Message Format “HPE Passport Password is required.”
Severity Warning
Resolution Please retry registration.

iLOeRS.1.0.HPEPassportSecurityQandAIsNotCompliant

HPE Passport Security Q and A is not compliant.
Message Format “HPE Passport Security Q and A is not compliant.”
Severity Warning
Resolution Please update your HPE Passport security Q and A and retry registration.

iLOeRS.1.0.HPEPassportSystemFailureOccurred

HPE Passport System failure occurred. A problem has been detected in the HPE Passport system.
Message Format “HPE Passport System failure occurred.”
Severity Critical
Resolution Please retry later.

iLOeRS.1.0.HPEPassportUserHasBeenAddedToaGroup

HPE Passport user has been added to a group.
Message Format “HPE Passport user has been added to a group.”
Severity Warning
Resolution Please reset your password and retry registration.

iLOeRS.1.0.HPEPassportUserIdentityElementsMissing

HPE Passport user identity elements missing.
Message Format “HPE Passport user identity elements missing.”
Severity Warning
Resolution Please update your HPE Passport profile and retry registration.

iLOeRS.1.0.HttpServerProtocolError

HTTP Server Protocol error occurred while communicating with the HPE Insight Remote Support receiver.
Message Format “HTTP Server Protocol error occurred while communicating with the HPE Insight Remote Support receiver.”
Severity Critical
Resolution Please retry.

iLOeRS.1.0.IncorrectHPEPassportPassword

HPE Passport Password is incorrect.
Message Format “HPE Passport Password is incorrect.”
Severity Warning
Resolution Please retry registration using the correct password.

iLOeRS.1.0.InsufficientDeviceIdentifierInformation

Insufficient device identifier information.
Message Format “Insufficient device identifier information.”
Severity Critical
Resolution Please unregister and re-register the device.

iLOeRS.1.0.InsufficientRegistrationData

Insufficient registration data.
Message Format “Insufficient registration data.”
Severity Warning
Resolution Please retry registration.

iLOeRS.1.0.InvalidCommandForConnectModel

Invalid Command For Connect Model.
Message Format “Invalid Command For Connect Model.”
Severity Warning
Resolution None.

iLOeRS.1.0.InvalidConfigurationForConnectModel

Configuration not supported for current connect model.
Message Format “Configuration not supported for current connect model.”
Severity OK
Resolution None.

iLOeRS.1.0.InvalidConnectFileDescriptor

Invalid Connect File Descriptor. Transmission to the HPE Insight Remote Support receiver was unsuccessful.
Message Format “Invalid Connect File Descriptor.”
Severity Warning
Resolution Please retry.

iLOeRS.1.0.InvalidDeviceIdentifierInformation

Invalid device identifier information.
Message Format “Invalid device identifier information.”
Severity Critical
Resolution Please unregister and re-register the device.

iLOeRS.1.0.InvalidFileDescriptor

Invalid File Descriptor. Transmission to the HPE Insight Remote Support receiver was unsuccessful.
Message Format “Invalid File Descriptor.”
Severity Warning
Resolution Please check connectivity between Management Processor and the Insight Remote Support receiver and retry.

iLOeRS.1.0.InvalidHPEPassportCredentials

Invalid HPE Passport credentials was provided.
Message Format “Invalid HPE Passport credentials.”
Severity Warning
Resolution Please provide valid HPE Passport credentials.

iLOeRS.1.0.InvalidHPEPassportUserID

HPE Passport User ID is invalid.
Message Format “HPE Passport User ID is invalid.”
Severity Warning
Resolution Please retry registration with a valid user ID.

iLOeRS.1.0.InvalidMessageId

Invalid Message Id.
Message Format “Invalid Message Id.”
Severity Warning
Resolution None.

iLOeRS.1.0.InvalidNumberOfDaysToReport

Invalid Number of Days to Report.
Message Format “Invalid Number of Days to Report.”
Severity Warning
Resolution None.

iLOeRS.1.0.InvalidProxyCredentials

Authentication with proxy server failed.
Message Format “Authentication with proxy server failed.”
Severity Warning
Resolution Please provide proper credentials.

iLOeRS.1.0.InvalidProxySettings

Invalid Proxy Settings.
Message Format “Invalid Proxy Settings.”
Severity Warning
Resolution Please verify proxy settings.

iLOeRS.1.0.InvalidReceiveBuffer

Invalid Receive Buffer. Transmission to the HPE Insight Remote Support receiver was unsuccessful.
Message Format “Invalid Receive Buffer.”
Severity Warning
Resolution Please check connectivity between Management Processor and the Insight Remote Support receiver and retry.

iLOeRS.1.0.InvalidSessiontoken

The session token is invalid.
Message Format “The session token is invalid.”
Severity Critical
Resolution Please retry registration.

iLOeRS.1.0.MissingAttachments

Missing Attachments.
Message Format “Missing Attachments.”
Severity Critical
Resolution Please retry your last step. If error persists and device is currently registered, unregister and re-register device.

iLOeRS.1.0.MissingDataPackage

The data package is missing.
Message Format “Missing data package.”
Severity Critical
Resolution Please retry your last step. If error persists and device is currently registered, unregister and re-register device.

iLOeRS.1.0.MissingDeviceIdentifiers

Missing device identifiers.
Message Format “Missing device identifiers.”
Severity Critical
Resolution Please unregister and re-register the device.

iLOeRS.1.0.MissingGDID

The GDID was found to be missing.
Message Format “Missing GDID.”
Severity Critical
Resolution Please unregister and re-register the device.

iLOeRS.1.0.MissingGUID

The GUID is missing.
Message Format “Missing GUID.”
Severity Critical
Resolution Please retry your last step. If error persists and device is currently registered, unregister and re-register device.

iLOeRS.1.0.MissingRegistrationInformation

The registration information was found to be missing.
Message Format “Missing registration information.”
Severity Critical
Resolution Please unregister and re-register the device.

iLOeRS.1.0.MissingRegistrationToken

The registration token was found to be missing.
Message Format “Missing registration token.”
Severity Critical
Resolution Please unregister and re-register the device.

iLOeRS.1.0.MissingSOAPHeader

Missing SOAP header.
Message Format “Missing SOAP header.”
Severity Critical
Resolution Please retry your last step. If error persists and device is currently registered, unregister and re-register device.

iLOeRS.1.0.NoActiveHealthFilestoReport

No Active Health Files to Report.
Message Format “No Active Health Files to Report.”
Severity Ok
Resolution None.

iLOeRS.1.0.NoServerCertificate

Certificate error occurred while communicating with the HPE Insight Remote Support receiver.
Message Format “Certificate error occurred while communicating with the HPE Insight Remote Support receiver.”
Severity Critical
Resolution Please retry.

iLOeRS.1.0.ReceiveBIOError

Receive BIO Error. Transmission to the HPE Insight Remote Support receiver was unsuccessful.
Message Format “Receive BIO Error.”
Severity Warning
Resolution Please check connectivity between Management Processor and the Insight Remote Support receiver and retry.

iLOeRS.1.0.RegistrationRequestCouldNotBeQueued

Registration request could not be queued. HPE Remote Support receiver temporarily unavailable.
Message Format “Registration request could not be queued.”
Severity Warning
Resolution Please retry later.

iLOeRS.1.0.SSLBioError

SSL Bio error.
Message Format “SSL Bio error.”
Severity Warning
Resolution None.

iLOeRS.1.0.ServiceUnavailableTemporarily

HPE Remote Support receiver is temporarily unavailable.
Message Format “HPE Remote Support receiver temporarily unavailable.”
Severity Warning
Resolution Please retry later.

iLOeRS.1.0.StaleDeviceIdentifiers

Stale device identifiers.
Message Format “Stale device identifiers.”
Severity Critical
Resolution Please unregister and re-register the device.

iLOeRS.1.0.TooManyAttachments

Too Many Attachments.
Message Format “Too Many Attachments.”
Severity Critical
Resolution Please retry your last step. If error persists and device is currently registered, unregister and re-register device.

iLOeRS.1.0.TooManyPendingRequests

Too Many Pending Requests.
Message Format “Too Many Pending Requests.”
Severity Warning
Resolution None.

iLOeRS.1.0.TransactionTypeError

Transaction type error.
Message Format “Transaction type error.”
Severity Warning
Resolution None.

iLOeRS.1.0.TransmitBufferTooShort

Transmit Buffer Too Short. Transmission to the HPE Insight Remote Support receiver was unsuccessful.
Message Format “Transmit Buffer Too Short.”
Severity Warning
Resolution Please check connectivity between Management Processor and the Insight Remote Support receiver and retry.

iLOeRS.1.0.UnknownDevice

Unknown device.
Message Format “Unknown device.”
Severity Critical
Resolution Please unregister and re-register the device.

iLOeRS.1.0.UnmatchGDIDAndDeviceIdentifiers

GDID and device identifiers do not match.
Message Format “GDID and device identifiers do not match.”
Severity Warning
Resolution If error persists and device is not currently registered, unregister and re-register device.

iLOeRS.1.0.UserHasReachedHalfTheMaximumAllowedLoginAuthenticationFailures

User has reached half the maximum allowed login authentication failures.
Message Format “User has reached half the maximum allowed login authentication failures.”
Severity Critical
Resolution Please verify your username and password are correct and retry registration.

iLOeRS.1.0.UserIDIsRequiredField

User ID is a required field.
Message Format “User ID is a required field.”
Severity Warning
Resolution Please retry registration.

iLOeRS.1.0.UserMustEnterAnHPEPassportSecurityQandAandChangePassword

User must enter an HPE Passport security Q and A and change password.
Message Format “User must enter an HPE Passport security Q and A and change password.”
Severity Warning
Resolution Please update your security Q and A, update your password and retry registration.

iLOeRS.1.0.UserMustHaveAnActiveAuthenticatedSession

User must have an active authenticated session.
Message Format “User must have an active authenticated session.”
Severity Critical
Resolution Please retry registration.

iLOeRS.1.0.XMLNULLPropertyDetected

XML NULL Property Detected.
Message Format “XML NULL Property Detected.”
Severity OK
Resolution None.

iLOeRS.1.0.XMLNoPrintableCharDetected

XML No Printable Char Detected.
Message Format “XML No Printable Char Detected.”
Severity OK
Resolution None.

iLOeRS.1.0.XMLParseError

XML Parse Error.
Message Format “XML Parse Error.”
Severity Warning
Resolution None.

iLOeRS.1.0.XMLParserAllocationError

XML Parser Allocation Error.
Message Format “XML Parser Allocation Error.”
Severity Warning
Resolution None.

NetworkDevice.1.0.CableInserted

Indicates that a network cable has been inserted.
Message Format “A network cable has been inserted into network adapter ‘%1’ port ‘%2’.”
Severity OK
Resolution Refresh your cached version of the network port to get the updated information from the service.

NetworkDevice.1.0.CableRemoved

Indicates that a network cable has been removed.
Message Format “A cable has been removed from network adapter ‘%1’ port ‘%2’.”
Severity OK
Resolution Refresh your cached version of the network port to get the updated information from the service.

NetworkDevice.1.0.ConnectionDropped

Indicates that a network connection has been dropped.
Message Format “The connection is no longer active for network adapter ‘%1’ port ‘%2’ function ‘%3’.”
Severity OK
Resolution Refresh your cached version of the network port to get the updated information from the service.

NetworkDevice.1.0.ConnectionEstablished

Indicates that a network connection has been established.
Message Format “A network connection has been established for network adapter ‘%1’ port ‘%2’ function ‘%3’.”
Severity OK
Resolution Refresh your cached version of the network port to get the updated information from the service.

NetworkDevice.1.0.DegradedConnectionEstablished

Indicates that a network connection has been established, but at an unexpectedly low link speed.
Message Format “A degraded network connection has been established for network adapter ‘%1’ port ‘%2’ function ‘%3’.”
Severity Warning
Resolution Refresh your cached version of the network port to get the updated information from the service.

NetworkDevice.1.0.LinkFlapDetected

Indicates that a network connection is highly unstable.
Message Format “The network connection for network adapter ‘%1’ port ‘%2’ function ‘%3’ has been established and dropped ‘%4’ times in the last ‘%5’ minutes.”
Severity Warning
Resolution Contact the network administrator for problem resolution.

StorageDevice.1.1.BatteryCharging

A battery charging condition has been detected.
Message Format “A charging condition for the battery located in ‘%1’ has been detected.”
Severity Warning
Resolution No action needed. There may be reduced performance and features while the battery is charging.

StorageDevice.1.1.BatteryFailure

A battery failure condition has been detected.
Message Format “A failure condition for the battery located in ‘%1’ has been detected.”
Severity Critical
Resolution Ensure all cables are properly and securely connected. Replace the failed battery.

StorageDevice.1.1.BatteryMissing

A battery missing condition has been detected.
Message Format “The battery located in ‘%1’ is missing.”
Severity Critical
Resolution Attach the battery. Ensure all cables are properly and securely connected.

StorageDevice.1.1.BatteryOK

The health of a battery has changed to OK.
Message Format “The health of the battery located in ‘%1’ has changed to OK.”
Severity OK
Resolution No action needed.

StorageDevice.1.1.ControllerDegraded

A storage controller degraded condition has been detected.
Message Format “A degraded condition for the storage controller located in ‘%1’ has been detected due to reason ‘%2’.”
Severity Warning
Resolution Reseat the storage controller in the PCI slot. Update the controller to the latest firmware version. If the issue persists, replace the controller.

StorageDevice.1.1.ControllerFailure

A storage controller failure has been detected.
Message Format “A failure condition for the storage controller located in ‘%1’ has been detected.”
Severity Critical
Resolution Reseat the storage controller in the PCI slot. Update the controller to the latest firmware version. If the issue persists, replace the controller.

StorageDevice.1.1.ControllerOK

The storage controller status has changed to OK.
Message Format “The status of the storage controller located in ‘%1’ has changed to OK.”
Severity OK
Resolution No action required.

StorageDevice.1.1.ControllerPasswordAccepted

The storage controller password was entered.
Message Format “A password was entered for the storage controller located in ‘%1’.”
Severity OK
Resolution No action required.

StorageDevice.1.1.ControllerPasswordRequired

The storage controller requires a password.
Message Format “The storage controller located in ‘%1’ requires a password.”
Severity Critical
Resolution Enter the controller password.

StorageDevice.1.1.ControllerPortDegraded

A controller port degraded condition has been detected.
Message Format “A degraded condition for the controller port located in ‘%1’ has been detected due to reason ‘%2’.”
Severity Warning
Resolution Ensure all cables are properly and securly connected. Replace faulty cables.

StorageDevice.1.1.ControllerPortFailure

A controller port failure condition has been detected.
Message Format “A failure condition for the controller port located in ‘%1’ has been detected.”
Severity Critical
Resolution Ensure all cables are properly and securly connected. Replace faulty cables.

StorageDevice.1.1.ControllerPortOK

The health of a controller port has changed to OK.
Message Format “The health of the controller port located in ‘%1’ has changed to OK.”
Severity OK
Resolution No action needed.

StorageDevice.1.1.ControllerPreviousError

A storage controller error has been detected prior to reboot.
Message Format “A previous error condition for the storage controller located in ‘%1’ has been detected due to ‘%2’.”
Severity Warning
Resolution Update the controller to the latest firmware version. If the issue persists, replace the controller.

StorageDevice.1.1.DriveFailure

A drive failure condition has been detected.
Message Format “A failure condition for the drive located in ‘%1’ has been detected.”
Severity Critical
Resolution Ensure all cables are properly and securely connected. Ensure all drives are fully seated. Replace the defective cables, drive, or both.

StorageDevice.1.1.DriveFailureCleared

A previously detected failure condition on a drive has been cleared.
Message Format “A failure condition for the drive located in ‘%1’ has been cleared.”
Severity OK
Resolution No action needed.

StorageDevice.1.1.DriveInserted

A drive has been inserted.
Message Format “The drive located at ‘%1’ was inserted.”
Severity OK
Resolution If the drive is not properly displayed, attempt to refresh the cached data.

StorageDevice.1.1.DriveMissing

A drive missing condition has been detected.
Message Format “A missing condition for the drive located in ‘%1’ has been detected.”
Severity Critical
Resolution Ensure all cables are properly and securely connected. Ensure all drives are fully seated. Replace the defective cables, drive, or both. Delete the volume if no longer needed.

StorageDevice.1.1.DriveMissingCleared

A previous drive missing condition has been cleared.
Message Format “A missing condition for the drive located in ‘%1’ has been cleared.”
Severity OK
Resolution No action needed.

StorageDevice.1.1.DriveOK

The status of a physical drive has changed to OK.
Message Format “The status of the drive located in ‘%1’ has changed to OK.”
Severity OK
Resolution No action needed.

StorageDevice.1.1.DriveOffline

A drive offline condition has been detected.
Message Format “An offline condition for the the drive located in ‘%1’ has been detected.”
Severity Critical
Resolution If the drive is unconfigured or needs an import, configure the drive. If the drive operation is in progress, wait for the operation to complete. If the drive is not supported, replace it.

StorageDevice.1.1.DriveOfflineCleared

A drive offline condition has been cleared.
Message Format “An offline condition for the the drive located in ‘%1’ has been cleared.”
Severity OK
Resolution No action needed.

StorageDevice.1.1.DrivePredictiveFailure

A predictive drive failure condition has been detected.
Message Format “A predictive failure condition for the drive located in ‘%1’ has been detected.”
Severity Warning
Resolution If this drive is not part of a fault-tolerant volume, first back up all data, then replace the drive and restore all data afterward. If this drive is part of a fault-tolerant volume, replace this drive as soon as possible as long as the volume status is OK.

StorageDevice.1.1.DrivePredictiveFailureCleared

A previously detected predictive failure condition on a drive has been cleared.
Message Format “A predictive failure condition for the drive located in ‘%1’ has been cleared.”
Severity OK
Resolution No action needed.

StorageDevice.1.1.DriveRemoved

A drive has been removed.
Message Format “The drive located in ‘%1’ was removed.”
Severity Critical
Resolution If the drive is still displayed, attempt to refresh the cached data.

StorageDevice.1.1.VolumeDegraded

The storage controller has detected a degraded volume condition.
Message Format “The volume ‘%1’ attached to the storage controller located in ‘%2’ is in degraded state.”
Severity Warning
Resolution Ensure all cables are properly and securely connected. Replace failed drives.

StorageDevice.1.1.VolumeFailure

The storage controller has detected a failed volume condition.
Message Format “The volume ‘%1’ attached to the storage controller located in ‘%2’ has failed.”
Severity Critical
Resolution Ensure all cables are properly and securely connected. Ensure all drives are fully seated and operational.

StorageDevice.1.1.VolumeOK

A volume status has changed to OK.
Message Format “The status of volume ‘%1’ that is attached to the storage controller located in ‘%2’ has changed to OK.”
Severity OK
Resolution No action needed.

StorageDevice.1.1.VolumeOffline

The storage controller has detected an offline volume condition.
Message Format “The volume ‘%1’ attached to the storage controller located in ‘%2’ is offline.”
Severity Critical
Resolution Use storage sofware to enable, repair, or import the volume. You may also delete or move volume back to the original controller.

StorageDevice.1.1.VolumeOfflineCleared

The storage controller has detected an online volume condition.
Message Format “The volume ‘%1’ attached to the storage controller located in ‘%2’ is online.”
Severity OK
Resolution No action needed.

StorageDevice.1.1.WriteCacheDataLoss

The write cache is reporting loss of data in posted-writes memory.
Message Format “The write cache on the storage controller located in ‘%1’ has data loss.”
Severity Critical
Resolution Check the controller resource properties to determine cause of the write cache data loss.

StorageDevice.1.1.WriteCacheDegraded

The write cache state is degraded.
Message Format “The write cache state on the storage controller located in ‘%1’ is degraded.”
Severity Critical
Resolution Check the controller to determine the cause of write cache degraded state, such as a missing battery or hardware failure.

StorageDevice.1.1.WriteCacheProtected

A storage controller write cache state is in protected mode.
Message Format “The write cache state on the storage controller located in ‘%1’ is in protected mode.”
Severity OK
Resolution No action needed.

StorageDevice.1.1.WriteCacheTemporarilyDegraded

The write cache state is temporarily degraded.
Message Format “The write cache state on the storage controller located in ‘%1’ is temporarily degraded.”
Severity Warning
Resolution Check the controller to determine the cause of write cache temporarily degraded state, such as a battery is charging or a data recovery rebuild operation is pending.

TaskEvent.1.0.TaskAborted

The task with id %1 has been aborted.
Message Format “The task with id %1 has been aborted.”
Severity Critical
Resolution None.

TaskEvent.1.0.TaskCancelled

The task with id %1 has been cancelled.
Message Format “The task with id %1 has been cancelled.”
Severity Warning
Resolution None.

TaskEvent.1.0.TaskCompletedOK

The task with id %1 has completed.
Message Format “The task with id %1 has completed.”
Severity OK
Resolution None.

TaskEvent.1.0.TaskCompletedWarning

The task with id %1 has completed with warnings.
Message Format “The task with id %1 has completed with warnings.”
Severity Warning
Resolution None.

TaskEvent.1.0.TaskPaused

The task with id %1 has been paused.
Message Format “The task with id %1 has been paused.”
Severity Warning
Resolution None.

TaskEvent.1.0.TaskProgessChanged

The task with id %1 has changed to progress %2 percent complete.
Message Format “The task with id %1 has changed to progress %2 percent complete.”
Severity OK
Resolution None.

TaskEvent.1.0.TaskRemoved

The task with id %1 has been removed.
Message Format “The task with id %1 has been removed.”
Severity Warning
Resolution None.

TaskEvent.1.0.TaskResumed

The task with id %1 has been resumed.
Message Format “The task with id %1 has been resumed.”
Severity OK
Resolution None.

TaskEvent.1.0.TaskStarted

The task with id %1 has started.
Message Format “The task with id %1 has started.”
Severity OK
Resolution None.
cURL python