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 “iLO 5 Adaptation Guide” section.

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 modififications.

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 Redfsh 1.6, iLO 5 1.40 changes this 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.

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

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 http://curl.haxx.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 ilorest

# 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 = ilorest.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/", 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 ilorest

# 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 = ilorest.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/{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 ilorest

# 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 = ilorest.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/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 attrbutes 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 ilorest

# 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 = ilorest.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/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 ilorest

# 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 = ilorest.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="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 ilorest

# 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 = ilorest.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")

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 ilorest

# 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 = ilorest.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")

# 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 -H "Content-Type: application/json" -X POST --data "@data.json" https://{iLO}/redfish/v1/Systems/1/Actions/ComputerSystem.Reset/ -u username:password --insecure
For a full Redfish example click here: ex04_reset_server.py

Contents of data.json

{“ResetType”: “ForceRestart”}

alternative pre-Redfish action invocation:

curl -H "Content-Type: application/json" -X POST --data "@data.json" https://{iLO}/redfish/v1/Systems/1 -u username:password --insecure
For a full Rest example click here: ex04_reset_server.py

Contents of data.json

{“Action”: “Reset”, “ResetType”: “ForceRestart”}

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

curl -H "Content-Type: application/json" -X POST --data "@data.json" https://{iLO}/redfish/v1/Systems/1/Actions/ComputerSystem.Reset/ -u username:password --insecure
For a full Redfish example click here: ex04_reset_server.py

Contents of data.json

{“Action”: “PowerButton”, “PushType”: “PressAndHold”, “Target”: “/Oem/Hp”}

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 invokation 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 $expand syntax

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"}

OData services including Redfish might optionally implement a feature called “$expand” that causes the 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:

iLO 5 $expand Support

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

$expand is applicable to HTTP GET only.

$expand=., $expand=*, $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: * The root resource at /redfish/v1/ is available without authentication and has navigational links that can be expanded. An $expand request does not result in expansion unless valid authentication credentials are supplied. * There might be other links that do not support expand.

iLO 5 $expand Example

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

{
  "@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 Parameter

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

{
    "@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",
}

(JSON output is abbreviated)

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: * Includes the Redfish conformance changes * Major version change to v2_0_0

The impacted resources are: * HpeBiosMapping * HpeServerBootSettings * HpeBaseConfigs * HpeiSCSISoftwareInitiator

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: * DeleteAllKeys * ResetAllKeysToDefault * DeletePK

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 HostCorrelcation with Oem/Hpe/HostOS which is avaiable 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 Note
/BIOSPOSTCode none /BIOSPOSTCode is not Redfish conformant.
/Bios/Current /BiosVersion
/Boot/BootSourceOverrideSupported /Boot/BootSourceOverrideTarget@Redfish.AllowableValues /Boot/BootSourceOverrideSupported is not Redfish conformant.
/Boot/UefiTargetBootSourceOverrideSupported /Boot/UefiTargetBootSourceOverride@Redfish.AllowableValues /Boot/UefiTargetBootSourceOverrideSupported is not Redfish conformant.
/HostCorrelation none /HostCorrelation is not Redfish conformant.
/Memory/Status /MemorySummary/Status
/Memory/TotalSystemMemoryGB /MemorySummary/TotalSystemMemoryGiB
/Power /PowerState /Power is not Redfish conformant.
/Processors/Count /ProcessorSummary/Count
/Processors/ProcessorFamily /ProcessorSummary/Model
/Processors/Status /ProcessorSummary/Status
/Version none /Version is not Redfish conformant.
/VirtualSerialNumber none /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.

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

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

This will create a user account jsmith with 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.

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.

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.

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

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

Changing Roles

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.

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

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

Directory Authentication

Enabling or Disabling Local User Accounts

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 ActiveDirectory Authentication

PATCH /redfish/v1/AccountService/

Example 1 (Using default ActiveDirectory server port 636):

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

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

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

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 ActiveDirectory and LDAP Authentication (Generic LDAP)

PATCH /redfish/v1/AccountService/

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

Enable and Configure HPE Extended Schema Authentication (for ActiveDirectory only)

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

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

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

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

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

View LDAP Server CA Certificate Status

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 certficate

{
    "@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)

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

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

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

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

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

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

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

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

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

Start Directory Test

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

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

(empty payload)

{
}

View Directory Test Result

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"
        }
    ]
}

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:

RedfishObject source code
curl https://{iLO}/redfish/v1/systems/1/bios/settings/ -i --insecure -u username:password -L
import sys
from _redfishobject import RedfishObject

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

#Create a REST object
REDFISH_OBJ = RedfishObject(iLO_host, iLO_account, iLO_password)
#Get the resource you need.
response = REDFISH_OBJ.redfish_get("/redfish/v1/systems/1/bios/")
print response

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 operatoin 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: ex03_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: ex06_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: ex05_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 Arrary 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: ex07_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 -H "Content-Type: application/json" -X POST --data "@data.json" https://{iLO}/redfish/v1/systems/1/ -u username:password --insecure

Contents of data.json

{“Action”:“ComputerSystem.Reset”, “ResetType”:“ForceRestart”}

For a full Redfish example click here: ex04_reset_server.py

Prerequisites

Minimum required session ID privileges: Configure

  1. Iterate through /redfish/v1/Systems/ 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.
    • {"Action":"ComputerSystem.Reset","ResetType":"ForceRestart"}
  4. Change the Action and ResetType properties to {"Action":"ComputerSystem.Reset","ResetType":"ForceRestart"}.
  5. 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: ex46_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: ex09_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: ex10_add_ilo_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: ex31_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: ex11_modify_ilo_user_account.py, ex12_remove_ilo_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 body: “` —————————–64062213329524 Content-Disposition: form-data; name="sessionKey”

—————————–64062213329524 Content-Disposition: form-data; name=“parameters” Content-Type: application/json

{ “UploadCurrentEtag”: “”, }

—————————–64062213329524 Content-Disposition: form-data; name=“compsig”; filename=“compsig-filename” Content-Type: application/octet-stream

—————————–64062213329524 Content-Disposition: form-data; name=“file”; filename=“component-filename” Content-Type: application/octet-stream

“`

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 Type C/D components.
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 Type C/D components.
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: json { "UploadCurrentEtag": "<client-defined-string>", "UpdateRepository": true, "UpdateTarget": true } Smart Component Example: json { "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: * Using iLO 5 over the management network * During server power on by UEFI BISO * Under an Operating System with SUM

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": "<maintence-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.",
    "Sequence": [{
        "Name": "Client supplied friendly name of this task item.",
        "IsRecovery": false,
        "UpdatableBy": [
            "Uefi",
            "RuntimeAgent"
        ],
        "Command": "ApplyUpdate",
        "Component": {
            "@odata.id": "/redfish/v1/updateservice/componentrepository/1/"
        }
    }]
}

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"
}
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": "<maintenence-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: * iLO 5 * System UEFI BIOS * System Programmable Logic Device (CPLD) * Server Platform Services (SPS) Firmware * Innovation Engine (IE) Firmware

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 - Modifable 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

Note the ”\r\n" added at the 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:

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

{
  "NewCertificates": [
    {
      "X509Certificate0":"-----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

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.

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: Configure iLO Settings privilege.

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

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.

example “HpeHttpsCert.GenerateCSR” action:

POST <target-uri>
Content-Type: application/json
OData-Version: 4.0

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

Importing a trusted certificate

Prerequisites: Configure iLO Settings privilege.

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


example “HpeHttpsCert.ImportCertificate” action:

POST <target-uri>
Content-Type: application/json
OData-Version: 4.0

{
    "Certificate": "<text>"
}

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 passthru 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
        }
    }
}

One-button secure erase

One-button 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 Rev.1 (Dec. 2014). For more information about NIST SP 800-88, see https://nvlpubs.nist.gov/nistpubs/specialpublications/nist.sp.800-88r1.pdf.

To view what was erased successfully, view the ROM displays. The process can take up to a day to fully erase and reset all user data. When you activate One-button 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.

Prerequisites

Process Flow

  1. User initiates One-button 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 One-button secure erase from the REST API

Execute the HpeComputerSystemExt.SecureSystemErase action on the computer system resource.

POST /redfish/v1/Systems/{id}/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 resourse.

POST /redfish/v1/Systems/{id}/Actions/ComputerSystem.Reset

{
    "ResetType": "ForceRestart"
}

At this point the UEFI BIOS will begin erasing configuration information.

Impacts to the server after One-button secure erase completes

The server will need to be re-provisioned to be used after this operation.

Troubleshooting

In some situations the One-button 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 One-button 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 One-button secure erase again using POST action URI.

For more troubleshooting tips and One-button secure erase FAQ, please refer “Intelligent Provisioning User Guide for HPE ProLiant Gen10 Servers and HPE Synergy” https://support.hpe.com/hpsc/doc/public/display?docId=a00017037en_us

SmartStorage configuration

Introduction

HPE ProLiant Gen10 servers with SmartStorage array controllers now provide a way to manage the array controllers using the REST API. This is in addition to the existing SmartStorage inventory and status REST API resources.

SmartStorage adds two new resources to the API per controller: * Current array controller configuration (read only) * Pending array controller configuration (modifiable with HTTP PATCH)

This is very similar to the way BIOS is configured.

The resource sub-tree is linked into the ComputerSystem resource:

GET /redfish/v1/systems/{item}/

{
  "Oem": {
    "Hpe": {
      "SmartStorageConfig": {
        "@odata.id": "/redfish/v1/systems/{item}/smartstorageconfig/"
      }
    }
  }
}

This URI is the GET-only current configuration. This resource links to the pending configuration. The @odata.type is SmartStorageConfig.v2_0_0.SmartStorageConfig

An example of the SmartStorageConfig resource:

{
    "@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 via SSA. A live version of this data is available in iLO-data/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 via SSA. A live version of this data is available in iLO-data/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": []
        }
    ]
}

Create logical drives

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" 
       }
    ]
}

PUT /redfish/v1/Systems/{item}/smartstorageconfig/settings/

{
    "DataGuard": "Disabled",
    "LogicalDrives": [
       {
          "LogicalDriveName": "MyLD",      
          "Raid": "Raid5", 
          "DataDrives": {
             "DataDriveCount": 4,
             "DataDriveMediaType": "HDD",
             "DataDriveInterfaceType": "SAS", 
             "DataDriveMinimumSizeGiB": 1000
          }
       }
    ]
}

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: that 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.)

DataGuard rules

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.

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:

Step 1. Delete MC1

DELETE /redfish/v1/Systems/1/MemoryDomains/PROC1MemoryDomain/MemoryChunks/MC1

Step 2. Delete MC2

DELETE /redfish/v1/Systems/1/MemoryDomains/PROC1MemoryDomain/MemoryChunks/MC2

Step 3. 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/"
               }
           }
       ]
   }

Step 4. 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/"
               }
           }
       ]
   }

Step 5. 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 Memroy 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:

Step 1. Delete MC1

DELETE /redfish/v1/Systems/1/MemoryDomains/PROC1MemoryDomain/MemoryChunks/MC1

Step 2. Delete MC2

DELETE /redfish/v1/Systems/1/MemoryDomains/PROC1MemoryDomain/MemoryChunks/MC2

Step 3. Delete MC3

DELETE /redfish/v1/Systems/1/MemoryDomains/PROC2MemoryDomain/MemoryChunks/MC3

Step 4. Delete MC4

DELETE /redfish/v1/Systems/1/MemoryDomains/PROC2MemoryDomain/MemoryChunks/MC4

Step 5. 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/"
               }
           }
       ]
   }

Step 6. 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/"
               }
           }
       ]
   }

Step 7. 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/"
               }
           }
       ]
   }

Step 8. 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/"
               }
           }
       ]
   }

Step 9. 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 LicenceKey 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 EventSubscriptions located at /redfish/v1/EventService/EventSubscriptions).

Subscribing for Events examples

POST /redfish/v1/EventService/EventSubscriptions/

{
    "Destination": "https://myeventreciever/eventreceiver",
    "EventTypes": [
        "ResourceAdded",
        "ResourceRemoved",
        "ResourceUpdated",
        "StatusChange",
        "Alert"
    ],
    "HttpHeaders": {
        "Header": "HeaderValue"
    },
    "TTLCount": 1440,
    "TTLUnits": "minutes",
    "Context": "context string",
    "Oem": {
        "Hp": {
            "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 EventSubscriptions link at /redfish/v1/EventService/EventSubscriptions. 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.

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 whereit 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 (e.g. 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 resoruce

{
  "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/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}/Drives/{interface}/{item} Drive
/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}/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/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/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}/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/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}/EthernetInterfaces Collection of EthernetInterface
/redfish/v1/Systems/{item}/EthernetInterfaces/{item} EthernetInterface
/redfish/v1/Systems/{item}/LogServices Collection of LogService
/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}/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}/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/{interface}/{item} Storage
/redfish/v1/Systems/{item}/Storage/{interface}/{item}/Volumes Collection of Volume
/redfish/v1/Systems/{item}/Storage/{interface}/{item}/Volumes/{item} Volume
/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 v1_0_0
/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 Trigger
/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

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 presense 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 http://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_3_0.AccountService

@odata.type: "#AccountService.v1_3_0.AccountService"

This is the schema definition for the Account 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 PATCH
Link Name Destination type
Accounts Collection of ManagerAccount

AccountLockoutCounterResetAfter

Member of AccountService.v1_3_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

AccountLockoutDuration

Member of AccountService.v1_3_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_3_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_3_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_3_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_3_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_3_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_3_0.AccountService RemoteRoleMapping is an array containing elements of:

RemoteRoleMapping[{item}].LocalRole Member of AccountService.v1_3_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_3_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_3_0.AccountService ServiceAddresses is an array containing elements of:

Type string or null
Read Only True

ActiveDirectory.ServiceEnabled Member of AccountService.v1_3_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_3_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_3_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_3_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_3_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_3_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.LDAPService LDAP.LDAPService.SearchSettings LDAP.LDAPService.SearchSettings.BaseDistinguishedNames (array) Member of AccountService.v1_3_0.AccountService BaseDistinguishedNames is an array containing elements of:

Type string or null
Read Only True

LDAP.RemoteRoleMapping (array) Member of AccountService.v1_3_0.AccountService RemoteRoleMapping is an array containing elements of:

RemoteRoleMapping[{item}].LocalRole Member of AccountService.v1_3_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_3_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_3_0.AccountService ServiceAddresses is an array containing elements of:

Type string or null
Read Only True

LDAP.ServiceEnabled Member of AccountService.v1_3_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_3_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_3_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_3_0.AccountService

Description The minimum password length for this service.
Type number
Read Only True
Added iLO 5 1.40

Oem.Hpe.AuthFailureDelayTimeSeconds

Member of AccountService.v1_3_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_3_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_3_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_3_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_3_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_3_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_3_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_3_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_3_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_3_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_3_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_3_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

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_3_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
Oem/Hpe/Links/Boot HpeServerBootSettings
Oem/Hpe/Links/ScalablePmem HpeScalablePmem
@Redfish.Settings/SettingsObject Bios
Oem/Hpe/Links/TlsConfig HpeTlsConfig
Oem/Hpe/Links/BaseConfigs HpeBaseConfigs
Oem/Hpe/Links/Mappings HpeBiosMapping
Oem/Hpe/Links/iScsi HpeiSCSISoftwareInitiator

@Redfish.Settings

Member of Bios.v1_0_0.Bios See the Redfish standard schema and specification for information on common @Redfish properties.

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:
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

Certificate.v0_9_0.Certificate

@odata.type: "#Certificate.v0_9_0.Certificate"

This is the schema definition for X509 certificates.

Resource Instances

Uri HTTP Allow
/redfish/v1/accountservice/externalaccountproviders/ldap/certificates/{item} GET PATCH DELETE

CertificateString

Member of Certificate.v0_9_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

Issuer

Member of Certificate.v0_9_0.Certificate

Description The Certificate Authority that issued the certificate.
Type string
Read Only True
Added iLO 5 1.40

SerialNumber

Member of Certificate.v0_9_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

Member of Certificate.v0_9_0.Certificate

Description The entity to which the certificate was issued.
Type string
Read Only True
Added iLO 5 1.40

ValidNotAfter

Member of Certificate.v0_9_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.v0_9_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"

Resource Instances

Uri HTTP Allow
/redfish/v1/accountservice/externalaccountproviders/ldap/certificates GET POST
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

Members@odata.count

Member of CertificateCollection.CertificateCollection

Description The total number of collection members.
Type integer
Read Only True

Chassis.v1_6_0.Chassis

@odata.type: "#Chassis.v1_6_0.Chassis"

The schema definition for the Chassis resource represents the properties for physical components for any system. This object represents racks, rack mount servers, blades, standalone, modular systems, enclosures, and all other containers. The non-CPU/device-centric parts of the schema are accessed either directly or indirectly through this resource.

Resource Instances

Uri HTTP Allow
/redfish/v1/chassis/{item} GET POST
Link Name Destination type
Links/ComputerSystems[] ComputerSystem
Links/ManagedBy[] Manager
Oem/Hpe/Links/Devices Collection of HpeServerDevice
NetworkAdapters Collection of NetworkAdapter
Power Power
Thermal Thermal
Links/Drives[] Drive

AssetTag

Member of Chassis.v1_6_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_6_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_6_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.

Manufacturer

Member of Chassis.v1_6_0.Chassis

Description The chassis manufacturer.
Type string or null
Read Only True
Added iLO 5 1.10

Model

Member of Chassis.v1_6_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_6_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_6_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_6_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.EnclosureIndicatorLED

Member of Chassis.v1_6_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_6_0.Chassis

Description Type of enclosure.
Type string
Read Only True
Added iLO 5 1.40

Oem.Hpe.EnclosureUUID

Member of Chassis.v1_6_0.Chassis

Description The UUID of the enclosure.
Type string
Read Only True
Added iLO 5 1.40

Oem.Hpe.Firmware

Oem.Hpe.Firmware.PlatformDefinitionTable Oem.Hpe.Firmware.PlatformDefinitionTable.Current Oem.Hpe.Firmware.PlatformDefinitionTable.Current.VersionString Member of Chassis.v1_6_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_6_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_6_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_6_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_6_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_6_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_6_0.Chassis

Description The firmware version of the CPLD.
Type string
Read Only True
Added iLO 5 1.10

Oem.Hpe.Images

Oem.Hpe.Images.Front Oem.Hpe.Images.Front.extref Member of Chassis.v1_6_0.Chassis

Description The URI of an external resource.
Type string
Read Only True
Added iLO 5 1.10
Format uri

Oem.Hpe.Images.Model Oem.Hpe.Images.Model.extref Member of Chassis.v1_6_0.Chassis

Description The URI of an external resource.
Type string
Read Only True
Added iLO 5 1.10
Format uri

Oem.Hpe.Location

Oem.Hpe.Location.GeographicLocation Oem.Hpe.Location.GeographicLocation.RackName Member of Chassis.v1_6_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_6_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_6_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_6_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_6_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_6_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_6_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_6_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_6_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_6_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.OnboardAdministrator

Oem.Hpe.OnboardAdministrator.IPv4Address Member of Chassis.v1_6_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_6_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_6_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_6_0.Chassis StaticAddress is an array containing elements of:

Type string
Read Only True
Format ipv6

Oem.Hpe.OnboardAdministrator.MacAddress Member of Chassis.v1_6_0.Chassis

Description MAC address of the chassis.
Type string or null
Read Only True
Added iLO 5 1.20

Oem.Hpe.PowerAlertMode

Oem.Hpe.PowerAlertMode.Activated Member of Chassis.v1_6_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_6_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.RackName

Member of Chassis.v1_6_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_6_0.Chassis SmartStorageBattery is an array containing elements of:

SmartStorageBattery[{item}].BatteryWearLevelPercent Member of Chassis.v1_6_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_6_0.Chassis

Description State of charge of the battery.
Type integer or null
Read Only True

SmartStorageBattery[{item}].ErrorCode Member of Chassis.v1_6_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_6_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_6_0.Chassis

Description Firmware version of the battery.
Type string
Read Only True

SmartStorageBattery[{item}].Index Member of Chassis.v1_6_0.Chassis

Description Index of the battery.
Type integer
Read Only True

SmartStorageBattery[{item}].MaximumCapWatts Member of Chassis.v1_6_0.Chassis

Description Maximum capacity of the battery in watts.
Type integer
Read Only True

SmartStorageBattery[{item}].Model Member of Chassis.v1_6_0.Chassis

Description Model of the battery.
Type string
Read Only True

SmartStorageBattery[{item}].ProductName Member of Chassis.v1_6_0.Chassis

Description Product name of the battery.
Type string
Read Only True

SmartStorageBattery[{item}].RemainingChargeTimeSeconds Member of Chassis.v1_6_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_6_0.Chassis

Description Serial number of the battery.
Type string
Read Only True

SmartStorageBattery[{item}].SparePartNumber Member of Chassis.v1_6_0.Chassis

Description Spare part number of the battery.
Type string
Read Only True

SmartStorageBattery[{item}].Status Member of Chassis.v1_6_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_6_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_6_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_6_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_6_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_6_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_6_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_6_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_6_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_6_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_6_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_6_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_6_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).

PartNumber

Member of Chassis.v1_6_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_6_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_6_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.

SKU

Member of Chassis.v1_6_0.Chassis

Description The chassis SKU.
Type string or null
Read Only True
Added iLO 5 1.10

SerialNumber

Member of Chassis.v1_6_0.Chassis

Description The chassis serial number.
Type string or null
Read Only True
Added iLO 5 1.10

Status

Member of Chassis.v1_6_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_6_0.Chassis There are no parameters for this action.

HpeServerChassis.FactoryResetMCTP Member of Chassis.v1_6_0.Chassis There are no parameters for this action.

ChassisCollection.ChassisCollection

@odata.type: "#ChassisCollection.ChassisCollection"

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

Members@odata.count

Member of ChassisCollection.ChassisCollection

Description The total number of collection members.
Type integer
Read Only True

ComputerSystem.v1_4_0.ComputerSystem

@odata.type: "#ComputerSystem.v1_4_0.ComputerSystem"

The schema definition of a computer system and its properties. A computer system represents a physical or virtual machine and the local resources, such as memory, CPU, and other devices that can be accessed from that machine.

Resource Instances

Uri HTTP Allow
/redfish/v1/systems/{item} GET POST PATCH
Link Name Destination type
EthernetInterfaces Collection of EthernetInterface
Oem/Hpe/Links/USBDevices Collection of HpeUSBDevice
Links/Chassis[] Chassis
Memory Collection of Memory
Oem/Hpe/Links/USBPorts Collection of HpeUSBPort
Oem/Hpe/Links/NetworkAdapters Collection of HpeBaseNetworkAdapter
Oem/Hpe/SmartStorageConfig[] SmartStorageConfig
Processors Collection of Processor
SecureBoot SecureBoot
Storage Collection of Storage
Bios Bios
Oem/Hpe/Links/EthernetInterfaces Collection of EthernetInterface
LogServices Collection of LogService
Oem/Hpe/Links/SmartStorage HpeSmartStorage
Oem/Hpe/Links/PCISlots Collection of HpeServerPCISlot
NetworkInterfaces Collection of NetworkInterface
Links/ManagedBy[] Manager
Oem/Hpe/Links/PCIDevices Collection of HpeServerPciDevice

AssetTag

Member of ComputerSystem.v1_4_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_4_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.BootSourceOverrideEnabled Member of ComputerSystem.v1_4_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_4_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_4_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_4_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_4_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_4_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

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_4_0.ComputerSystem

Description The DNS Host Name, without any domain information
Type string or null
Read Only False
Added iLO 5 1.10

IndicatorLED

Member of ComputerSystem.v1_4_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.

LogServices

The LogService collection URI for this resource. LogServices is a link ("@odata.id": URI) to another resource.

Manufacturer

Member of ComputerSystem.v1_4_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_4_0.ComputerSystem See the Redfish standard schema and specification for information on common Status object.

MemorySummary.TotalSystemMemoryGiB Member of ComputerSystem.v1_4_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_4_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_4_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_4_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.BiosOrHardwareHealth Oem.Hpe.AggregateHealthStatus.BiosOrHardwareHealth.Status Member of ComputerSystem.v1_4_0.ComputerSystem See the Redfish standard schema and specification for information on common Status object.

Oem.Hpe.AggregateHealthStatus.FanRedundancy Member of ComputerSystem.v1_4_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_4_0.ComputerSystem See the Redfish standard schema and specification for information on common Status object.

Oem.Hpe.AggregateHealthStatus.Memory Oem.Hpe.AggregateHealthStatus.Memory.Status Member of ComputerSystem.v1_4_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_4_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_4_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_4_0.ComputerSystem See the Redfish standard schema and specification for information on common Status object.

Oem.Hpe.AggregateHealthStatus.PowerSupplyRedundancy Member of ComputerSystem.v1_4_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_4_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_4_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_4_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_4_0.ComputerSystem See the Redfish standard schema and specification for information on common Status object.

Oem.Hpe.Bios

Oem.Hpe.Bios.Backup Oem.Hpe.Bios.Backup.BuildNumber Member of ComputerSystem.v1_4_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_4_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_4_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_4_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.H