NAV Navbar
Logo
cURL python

Introduction

The iLO RESTful API for HPE iLO 4 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 4.

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.

This document has been updated with examples from iLO 4 version 2.30 firmware.

Redfish 1.0 Conformance

The iLO RESTful API was first released with iLO 4 2.00 on HPE Gen9 servers. The iLO RESTful API also functioned as the starting point for the new Redfish 1.0 DMTF standard at https://www.dmtf.org/standards/redfish

Since the introduction of the iLO RESTful API, a number of changes were introduced into the Redfish standard by the DMTF SPMF members. At a high level, the changes include:

iLO 4 2.30 is Redfish 1.0 conformant while remaining backward compatible with the existing iLO RESTful API. Moving forward, the iLO RESTful API will become the iLO 4 enhanced implementation of Redfish. While conforming to the Redfish 1.0 standard, the iLO RESTful API is extended with Hewlett Packard Enterprise-specific features such as BIOS configuration. You should plan to update your client code to confirm to the Redfish standard. iLO will eventually remove any properties that do not match the Redfish schema definitions (while preserving the OEM extensions.)

iLO 4 2.30 achieves Redfish 1.0 conformance and backward compatibility by:

  1. Mirroring the resource model at both /redfish/v1/ and /rest/v1.
  2. Returning both compatibility and Redfish properties by default.
  3. Returning only Redfish conformant properties (with Hewlett Packard Enterprise extensions) if the Redfish-required OData header is included in the request (OData-Version: 4.0).

Full details on how Redfish 1.0 was implemented in iLO 4 2.30 and how it impacts clients written for previous versions is found here: http://www.hpe.com/h20195/V2/GetDocument.aspx?docname=4AA6-1727ENW&cc=us&lc=en

REST APIs Architected using HATEOS

Representational State Transfer (REST) is a web service that uses basic CRUD (Create, Read, Update, Delete, and Patch) operations performed on resources using HTTP commands such as POST, GET, PUT, PATCH, and DELETE. The iLO RESTful API is designed using a REST architecture called HATEOS (Hypermedia as the Engine of Application State). This architecture allows the client to interact with iLO through a simple fixed URL (rest/v1) and several other top-level URIs documented in the iLO Data Model. The rest of the data model is discoverable by following clearly identified “links” in the data. This has the advantage that the client does not need to know a set of fixed URLs. When you create a script to automate tasks using the iLO RESTful API, you only need to hardcode this simple URL and design the script to discover the REST API URLs that are needed to complete a task. To learn more about REST and HATEOAS concepts, see:

Key benefits of the iLO RESTful API

The iLO RESTful API is becoming the main management interface for iLO 4 Hewlett Packard Enterprise servers. 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 like Moonshot. 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 Gen9 servers running iLO 4 2.00 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.type": "#ServiceRoot.v1_0_0.ServiceRoot",
    "Name": "Service Root",
    "RedfishVersion": "0.96.0",
    "@odata.id": "/redfish/v1/",
    "@odata.context": "/redfish/v1/$metadata#ServiceRoot",
    "Time": "2014-09-03T11:00:00+00:00",
    "UUID": "92384634-2938-2342-8820-489239905423",
    "Oem": {
        "Hp": {
            "@odata.type": "#HpiLOServiceExt.1.0.0.HpiLOServiceExt",
            "Manager": [{
                "ManagerFirmwareVersion": "2.50",
                "HostName": "ILOHD53NP0108",
                "ManagerType": "iLO 4",
                "IPManager": {
                    "ManagerUrl": {
                        "xref": "https://16.85.178.23"
                    },
                    "Name": "Management Console Information",
                    "ManagerType": "OneView",
                    "OvManagesiLOIP": false,
                    "ManagerProductName": "HP OneView",
                    "FirmwareManaged": false,
                    "SppVersion": null,
                    "StorageManaged": false,
                    "iLOManaged": true,
                    "Type": "HPQ_iLOManagerDescriptor/1.1.0",
                    "BiosManaged": false
                },
                "Blade": {
                    "BayNumber": "Bay 3"
                },
                "FQDN": "ILOHD53NP0108.americas.hpqcorp.net",
                "DefaultLanguage": "en",
                "Languages": [{
                    "Version": "2.50.15",
                    "Language": "en",
                    "TranslationName": "English"
                }],
                "ManagerFirmwareVersionPass": "15"
            }],
            "Sessions": {
                "LocalLoginEnabled": true,
                "LoginFailureDelay": 0,
                "LDAPAuthLicenced": true,
                "KerberosEnabled": false,
                "ServerName": "WIN-MKNP1GNHVSN",
                "SecurityOverride": true,
                "CertCommonName": "ILOHD53NP0108.americas.hpqcorp.net",
                "LoginHint": {
                    "HintPOSTData": {
                        "UserName": "username",
                        "Password": "password"
                    },
                    "Hint": "POST to /Sessions to login using the following JSON object:"
                },
                "LDAPEnabled": false
            }
        }
    },
    "Id": "v1",
    "Chassis": {
        "@odata.id": "/redfish/v1/chassis/"
    },
    "Managers": {
        "@odata.id": "/redfish/v1/managers/"
    },
    "Systems": {
        "@odata.id": "/redfish/v1/systems/"
    },
    "Providers": {
        "@odata.id": "/redfish/v1/providers/"
    },
    "Sessions": {
        "@odata.id": "/redfish/v1/sessions/"
    }
}

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

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

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

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

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

HTTP Resource Operations

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

HTTP Status Return Codes

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

Navigating the Data Model

Unlike some simple REST service, this 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 API does not specify the URIs to various resources. Do not 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.

The supported stable URIs are those referenced directly in this API reference and include:

Iterating Collections

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

import sys
import redfish

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

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

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

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

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

# Logout of the current session
REDFISH_OBJ.logout()

JSON response example:

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

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

Find a Compute Node

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

import sys
import redfish

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

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

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

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

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

# Logout of the current session
REDFISH_OBJ.logout()

JSON response example:

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

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

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

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

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

Find a Chassis

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

import sys
import redfish

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

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

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

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

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

# Logout of the current session
REDFISH_OBJ.logout()

JSON response example:

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

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

A Chassis represents a physical or virtual container of compute resources with 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 4 Management Processor

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

import sys
import redfish

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

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

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

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

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

# Logout of the current session
REDFISH_OBJ.logout()

JSON response example:

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

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

A Manager represents a management processor (or “BMC”) that manages chassis and compute resources. For HPE Servers, the manager is iLO 4. 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

    {
        "@odata.type": "#ExtendedInfo.ExtendedInfo",
        "Messages": [
            {
                "MessageID": "Base.0.10.NoValidSession"
            }
        ],
        "Type": "ExtendedError.1.0.0",
        "error": {
        "@Message.ExtendedInfo": [
            {
                "MessageId": "Base.0.10.NoValidSession"
            }
        ],
        "code": "iLO.0.10.GeneralError",
        "message": "A general error has occurred. See ExtendedInfo for more information."
        }
    }

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

Basic Authentication

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

import sys
import redfish

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

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

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

# Logout of the current session
REDFISH_OBJ.logout()

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

Creating and Using Sessions

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

import redfish

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

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

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

Contents of data.json

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

Successful headers from iLO:

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

Successful response from iLO:

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

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

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

Using a Session

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

Log Out of a Session

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

import redfish

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

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

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

# Logout of the current session
REDFISH_OBJ.logout()

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

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

Performing Actions

Example of a system resource advertising an available action:

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

This action may be invoked by performing:

curl -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}/rest/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 4 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.

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

RestObject source code 
curl https://{iLO}/rest/v1/systems/1/bios/settings -i --insecure -u username:password -L

import sys
from restobject import RestObject

# 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
REST_OBJ = RestObject(iLO_host, iLO_account, iLO_password)
instances = REST_OBJ.search_for_type("HpBios.")

for instance in instances:
    response = REST_OBJ.rest_get(instance["href"])
    print response

Response

{
    "AcpiRootBridgePxm": "Enabled",
    "AcpiSlit": "Enabled",
    "AdjSecPrefetch": "Enabled",
    "AdminEmail": "",
    "AdminName": "",
    ...

    ...
    "WakeOnLan": "Enabled",
    "links": {
        "self": {
            "href": "/rest/v1/systems/1/bios/Settings"
        }
    }
}

To GET the current BIOS configuration:

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 “SettingsResults”

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, you will see that it allows PATCH commands. You can change properties and then PATCH them back to 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 SettingsResults 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}/rest/v1/Systems/1/bios/settings -u username:password --insecure

Contents of data.json

{“AdminName”: “NewName”}

For a full Redfish example click here: change_bios_setting.py

For a full REST example click here: change_bios_setting.py

The minimum required session ID privileges is Configure.

  1. Iterate through /rest/v1/Systems and choose a member ComputerSystem. Result = {ilo-ip-address}/rest/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}/rest/v1/Systems/1/BIOS/Settings
  6. Create a new JSON object with the AdminName property changed to {"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}/rest/v1/Systems/1/BIOS/Settings
  8. Obtain the BIOS settings to verify you made the change to the AdminName property.
    • GET {ilo-ip-address}/rest/v1/Systems/1/BIOS/Settings When the server is reset, the BIOS settings are validated and adopted.

Reading BIOS Defaults example

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

import sys
import redfish

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

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

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

# Do a GET on a given path
response = REDFISH_OBJ.get("/rest/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

{
    "BaseConfigs": [{
        "default": {
            "AcpiRootBridgePxm": "Enabled",
            "AcpiSlit": "Enabled",
            ...

            ...
            "VlanPriority": 0,
            "WakeOnLan": "Enabled"
        }
    }],
    "Capabilities": {
        "BaseConfig": true,
        "BaseConfigs": false
    },
    "Modified": "2016-04-21T01:52:17+00:00",
    "Name": "BIOS Default Settings",
    "Type": "HpBaseConfigs.0.10.0",
    "links": {
        "self": {
            "href": "/rest/v1/systems/1/bios/BaseConfigs"
        }
    }
}

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

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:

Setting or Changing the BIOS Administrator and Setup Password

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

Contents of data.json

{“OldAdminPassword”: “oldpassword”, “AdminPassword”: “newpassword”}

For a full Redfish example click here: change_bios_setting.py

For a full REST example click here: change_bios_setting.py

To change the Administrator and Power On passwords, you must change two properties for each password in the Pending Settings resource: * Administrator password: Set AdminPassword to the new password and OldAdminPassword to the old password. * Power On password: Set PowerOnPassword to the new password and OldPowerOnPassword with the old password.

If you the old password is not set, you must use a blank string (“”) for the old password property.

  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. Create a new JSON object with the AdminPassword and OldAdminPassword property changed to {"AdminPassword":"@Pa$$w0rd", "OldAdminPassword":""}.
  6. Update the BIOS settings. You only need to send the updated AdminName property in the request body.
    • PATCH {ilo-ip-address}/rest/v1/Systems/1/BIOS/Settings

When the server is reset, the BIOS settings are validated and adopted.

Updating the Administrator BIOS password example

curl -H "Content-Type: application/json" -H "X-HPRESTFULAPI-AuthToken: <hash of password>" -X PATCH --data "@data.json" https://{iLO}/rest/v1/Systems/1/bios/settings -u username:password --insecure

Contents of data.json

{“OldAdminPassword”: “oldpassword”, “AdminPassword”: “newpassword”}

For a full Redfish example click here: change_bios_setting.py

For a full REST example click here: change_bios_setting.py

To change the Administrator and Power On passwords, you must change two properties for each password:

HTTP Header Name Value
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().

Example reset all BIOS and boot order settings to factory defaults

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

Reverting BIOS UEFI settings to default example

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

Contents of data.json

{“BaseConfig”: “default”}

For a full Redfish example click here: bios_revert_default.py

For a full REST example click here: bios_revert_default.py

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

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

  1. Iterate through /rest/v1/Systems and choose a member ComputerSystem. Find a child resource of type HpBios that allows PUT operations (there might be more than one but for this exercise, just choose the first one).
    • {ilo-ip-address}/rest/v1/Systems/1/BIOS/Settings
  2. Obtain the BIOS UEFI settings.
    • GET {ilo-ip-address}/rest/v1/Systems/1/BIOS/Settings
  3. Change or add the BaseConfig property to {"BaseConfig":"default"} in the response body.
  4. Update the BIOS UEFI settings.
    • PUT {ilo-ip-address}/rest/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}/rest/v1/Systems/1/SecureBoot -u username:password --insecure

Contents of data.json

{“SecureBootEnable”:true}

For a full Redfish example click here: enable_secure_boot.py

For a full REST example click here: enable_secure_boot.py

The minimum required session ID privileges is Configure.

  1. Iterate through /rest/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, just choose the first one).
    • {ilo-ip-address}/rest/v1/Systems/1/SecureBoot
  2. Obtain the secure boot settings.
    • GET {ilo-ip-address}/rest/v1/Systems/1/SecureBoot
  3. Create a new JSON object with the SecureBootEnable property changed to {"SecureBootEnable":true}.
  4. Update the secure boot settings. You only need to send the updated SecureBootEnable property in the request body.
    • PATCH {ilo-ip-address}/rest/v1/Systems/1/SecureBoot

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

Example iSCSI Software Initiator configuration

Existing example resource:

{
    "iSCSIBootSources": [
        {
             "iSCSIBootAttemptInstance": 1,
             ...
        },
        {
             "iSCSIBootAttemptInstance": 2,
             ...
        },
        {
             "iSCSIBootAttemptInstance": 0,
             ...
        },
        {
             "iSCSIBootAttemptInstance": 0,
             ...
        }
    ],
    ...
}

{
    "iSCSIBootSources": [
        {},
        {
            "iSCSIConnectRetry": 2
        },
        {
            "iSCSIBootAttemptInstance": 3,
            "iSCSIBootAttemptName": "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 HpiSCSISoftwareInitiator. 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 iSCSIBootSources 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 iSCSIBootAttemptInstance, 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 iSCSIBootSources and iSCSIInitiatorName settings can be done through PATCH operations, very similar to how HpBios 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 /rest/v1/Systems and choose a member ComputerSystem. Find a child resource of type HpiSCSISoftwareInitiator that allows PATCH operations.
    • {ilo-address}/rest/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}/rest/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:

....

The Structured Boot String information is part of the BootSources[]property in the HpServerBootSettings object and the StructuredName property in the HpServerPciDevice object.

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: change_boot_order.py

For a full REST example click here: change_boot_order.py

The BIOS current configuration object contains a link to a separate read-only resource of type HpServerBootSettings 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 SettingsResults property in the UEFI Boot Order current configuration resource.

Prerequisites: Minimum required session ID privileges: Configure

  1. Iterate through /rest/v1/Systems and choose a member ComputerSystem. Find a child resource of type HpServerBootSettings that allows PATCH operations (there might be more than one but for this exercise, just choose the first one).
    • {ilo-ip-address}/rest/v1/Systems/1/BIOS/Boot/Settings
  2. Obtain the UEFI boot order.
    • GET {ilo-ip-address}/rest/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}/rest/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}/rest/v1/systems/1 -u username:password --insecure

Contents of data.json

{“Action”:“Reset”}

For a full Redfish example click here: reset_server.py

For a full REST example click here: reset_server.py

Prerequisites

Minimum required session ID privileges: Configure

Procedure: 1. Iterate through /rest/v1/Systems and choose a member ComputerSystem that allows POST operations. * {ilo-ip-address}/rest/v1/Systems/1 2. Construct an Action object to submit to iLO. * {"Action":"Reset","ResetType":"ForceRestart"} 3. Change the Action and ResetType properties to {"Action":"Reset","ResetType":"ForceRestart"}. 4. Reset the server. * POST {ilo-ip-address}/rest/v1/Systems/1

The server resets and reboots.

Download Active Health System Data

For more information click on the python tab.

For a full Redfish example click here: get_ahs_data.py

For a full REST example click here: get_ahs_data.py

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

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

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

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

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

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

Finding the iLO mac address

For more information click on the python tab.

For a full Redfish example click here: find_ilo_mac_address.py

For a full REST example click here: find_ilo_mac_address.py

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

iLO implements two EthernetInterface resources under /redfish/v1/managers/{item}/ethernetinterfaces—the iLO dedicated network interface resource and the shared network interface resource. Only one resource can be enabled at a time. The shared network port has additional options under SharedNetworkPortOptions. Clients should look for the SharedNetworkPortOptions property to identify the shared interface. The number or order of Ethernet interfaces might change in the future.

Adding an iLO user account

For more information click on the python tab.

For a full Redfish example click here: add_user_account.py

For a full REST example click here: 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}/rest/v1/Managers/1/LicenseService -u username:password --insecure

Contents of data.json

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

For a full Redfish example click here: set_license_key.py

For a full REST example click here: set_license_key.py

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

Changing an iLO user account

For more information click on the python tab.

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

For full REST examples click here: modify_user_account.py, 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.

Enabling and Downloading Serial Over LAN Log

To obtain serial over LAN log information from iLO, you must enable the Virtual Serial Port (VSP) Download and the Serial Over LAN Logging features (SOL).

  1. In the Manager resource (/redfish/v1/managers/{item}), use the PATCH operation to set VSPLogDownloadEnabled to true. VSPLogDownloadEnabled is in the OEM section of the Manager resource.
  2. In the ManagerNetworkProtocol resource (/redfish/v1/managers/{item}/networkservice), use the PATCH operation to set SerialOverLanLogging to true. SerialOverLanLogging is in the OEM section of the Manager resource.
  3. Wait until the log content is captured.
  4. Find the URI of the serial over LAN binary download. This is called VSPLogLocation in the OEM section of the Manager resource (/redfish/v1/managers/{item}).
  5. Perform the GET operation on the URI indicated to download the log (GZIP file).

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

Starting with iLO 4 2.30, iLO now features a new 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.

Troubleshooting

Resetting the RESTful API

Symptom

ProLiant Gen9 servers could possibly experience a RESTful API error during system boot that results in inability to configure the BIOS settings using the RESTful API. In addition, the following persistent error message might display during system boot (POST) and is logged to the Integrated Management Log:

335 RESTful API Error- RESTful API PUT request failed (HTTP: Status Code = 404)

With iLO firmware v2.20 or later, you can reset the REST API. You do this through the RESTful API using any 3rd party REST web client, the RESTful Interface Tool, or from the HPE Embedded UEFI shell restclient command.

With a REST client

  1. Execute a POST operation to the resource at URI <ilo-ip>/rest/v1/managers/1 with the following JSON in the request body.

    {“Action”:“ClearRestApiState”, “Target”:“/Oem/Hp”}

  2. Restart the server.

With the RESTful Interface Tool

  1. Download and install the RESTful interface Tool. For more information on using this tool, refer to http://www.hpe.com/info/resttool.

  2. Copy and paste the following JSON into a text file and save it as hprest_tool_clear_api.json.

    { “path”: “/rest/v1/managers/1”, “body”: { “Action”: “ClearRestApiState”, “Target”: “/Oem/Hp” } }

  3. Start the hprest tool.

    hprest

  4. Log in to iLO.

    hprest> login

  5. Run the following command, pointing to the hprest_tool_clear_api.json file.

    hprest> rawpost hprest_tool_clear_api.json

  6. Restart the server.

With the UEFI Shell

  1. Enter the Embedded UEFI Shell. For more information, refer to the UEFI Shell User Guide at http://www.hpe.com/servers/proliant/uefi.

  2. Copy and paste the following JSON into an ASCII text file save it as clear_api.json on FAT formatted USB media.

    { “Action”:“ClearRestApiState”, “Target”:“/Oem/Hp” }

  3. Attach the USB media to the server.

  4. Turn on the server and boot to the Embedded UEFI Shell.

  5. At the UEFI shell prompt, use the partitions command to find the file system that corresponds to the USB media. For example, FS0, FS1, and so on.

  6. To switch to the file system, type the file system name (for example, shell>FS0: ).

  7. Execute the following command:

    Fs0:> restclient –m POST –uri “/rest/v1/managers/1” –i clear_api.json

  8. Restart the server.

With the iLO SSH CLI

  1. Open an SSH connection with iLO, log in using an account with administrator privileges. For more information, see the HPE iLO 4 Scripting and Command Line Guide at http:// www.hpe.com/info/iLO.
  2. At the CLI prompt, execute the command oemhp_clearRESTAPIstate. Note that this command might take a few seconds to complete.
  3. Restart the server.

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 /rest/v1/.../collection/1, or 2. On Moonshot a System collection member might be /rest/v1/systems/c1n1.

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 4 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/…).

API Errata

Using PowerShell with the API

ConvertFrom-Json : Cannot convert the JSON string because a dictionary that was converted from the string contains the duplicated keys 'MACAddress' and 
'MacAddress'.
At line:1 char:6
+ $a | ConvertFrom-Json
+      ~~~~~~~~~~~~~~~~
    + CategoryInfo          : InvalidOperation: (:) [ConvertFrom-Json], InvalidOperationException
    + FullyQualifiedErrorId : DuplicateKeysInJsonString,Microsoft.PowerShell.Commands.ConvertFromJsonCommand

The HP REST API on iLO 4 2.30 and later contains a JSON-formatted resource that is incompatible with PowerShell’s ConvertFrom-Json cmdlet, resulting in an error when a PowerShell script attempts to parse the JSON response string.

A PowerShell script will emit an error parsing JSON when reading the iLO 4 Ethernet configuration and status resource at /redfish/v1/managers/{item}/ethernetinterfaces/{item}:

The cause of the problem is that iLO 4 presents the MAC Address of the network controller in two separate properties differing only by character case. The existing REST API in iLO 4 2.30 and earlier contains a property called MacAddress. Additionally, iLO 4 2.30 adds the Redfish conformant versions of properties, which includes MACAddress. This would not be a problem for clients that treat JSON as case sensitive, but PowerShell’s ConvertFrom-Json is not case sensitive and results in an error.

Three client code fixes are possible:

  1. The client may pre-process the JSON string to replace one of the colliding substrings before converting it to a hash table with ConvertFrom-Json. For instance, one could replace the string MacAddress with MacAddressUnused or alter MACAddress instead.
  2. The client may create or use a different hash table structure in PowerShell that is case sensitive.
  3. The client may include the Redfish mandated HTTP header "OData-Version”: 4.0. This header causes iLO 4 to hide non-Redfish conformant properties including the older MacAddress property.

Solution #3 is the most strategically forward-thinking solution if the clients intends to be Redfish conformant.

Other Web Resources

Reference

The API conforms to the Redfish standard. For more details see http:// www.dmtf.org/standards/redfish

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 4, 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-proliant-sdk.

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

This is the schema definition for the Account service. It represents the properties for this service and has links to the list of accounts.

Properties

Resource Instances of this Type:

  • https://{iLO}/redfish/v1/accountservice

Managing User Accounts with the Accounts Collection

JSONPath: /Accounts/@odata.id

The destination of this link is a collection of user accounts (see ManagerAccount).

AuthFailureDelayTimeSeconds

JSONPath: /Oem/Hp/AuthFailureDelayTimeSeconds (PATCHable integer)

The time in seconds to delay after AuthFailuresBeforeDelay+1 authentication attempts have failed. Values of 2, 5, 10, and 30 seconds are valid.

example PATCH: {“Oem”: {“Hp”: {“AuthFailureDelayTimeSeconds”: <integer-value>}}}

AuthFailureLoggingThreshold

JSONPath: /Oem/Hp/AuthFailureLoggingThreshold (PATCHable integer)

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.

example PATCH: {“Oem”: {“Hp”: {“AuthFailureLoggingThreshold”: <integer-value>}}}

AuthFailuresBeforeDelay

JSONPath: /Oem/Hp/AuthFailuresBeforeDelay (PATCHable integer)

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 each authentication failure.

example PATCH: {“Oem”: {“Hp”: {“AuthFailuresBeforeDelay”: <integer-value>}}}

MinPasswordLength

JSONPath: /Oem/Hp/MinPasswordLength (PATCHable integer)

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.

example PATCH: {“Oem”: {“Hp”: {“MinPasswordLength”: <integer-value>}}}

BaseNetworkAdapter

This represents a network adapter consisting of one or more physical ports.

Properties

Resource Instances of this Type:

  • https://{iLO}/redfish/v1/systems/{item}/networkadapters/{item}

Firmware.Current.VersionString

JSONPath: /Firmware/Current/VersionString (read only string)

This string represents the version of the firmware image.

PartNumber

JSONPath: /PartNumber (read only string)

The device part number.

PhysicalPorts[array-item].FullDuplex

JSONPath: /PhysicalPorts/(array index)/FullDuplex (read only boolean)

Full-duplex data transmission means that data is transmitted in both directions on a signal carrier at the same time.

PhysicalPorts[array-item].IPv4Addresses[array-item].Address

JSONPath: /PhysicalPorts/(array index)/IPv4Addresses/(array index)/Address (read only string)

This is the IPv4 Address.

PhysicalPorts[array-item].IPv6Addresses[array-item].Address

JSONPath: /PhysicalPorts/(array index)/IPv6Addresses/(array index)/Address (read only string)

This is the IPv6 Address.

PhysicalPorts[array-item].MacAddress

JSONPath: /PhysicalPorts/(array index)/MacAddress (read only string)

The port MAC address.

PhysicalPorts[array-item].Oem.Hp.BadReceives

JSONPath: /PhysicalPorts/(array index)/Oem/Hp/BadReceives (read only integer)

A count of frames that were received by the adapter but which had an error. This counter is the sum of mib items cpqNicIfPhysAdapterAlignmentErrors, cpqNicIfPhysAdapterFCSErrors, cpqNicIfPhysAdapterFrameTooLongs, and cpqNicIfPhysAdapterInternalMacReceiveErrors. If this counter increments frequently, check the more detailed error statistics and take appropriate action.

PhysicalPorts[array-item].Oem.Hp.BadTransmits

JSONPath: /PhysicalPorts/(array index)/Oem/Hp/BadTransmits (read only integer)

A count of frames that were not transmitted by the adapter because of an error. This counter is the sum of MIB items cpqNicIfPhysAdapterDeferredTransmissions, cpqNicIfPhysAdapterLateCollisions, cpqNicIfPhysAdapterExcessiveCollisions, cpqNicIfPhysAdapterCarrierSenseErrors, and cpqNicIfPhysAdapterInternalMacTransmitErrors. If this counter increments frequently, check the more detailed error statistics and take appropriate action.

PhysicalPorts[array-item].Oem.Hp.GoodReceives

JSONPath: /PhysicalPorts/(array index)/Oem/Hp/GoodReceives (read only integer)

A count of frames successfully received by the physical adapter.

PhysicalPorts[array-item].Oem.Hp.GoodTransmits

JSONPath: /PhysicalPorts/(array index)/Oem/Hp/GoodTransmits (read only integer)

A count of frames successfully transmitted by the physical adapter.

PhysicalPorts[array-item].Oem.Hp.StructuredName

JSONPath: /PhysicalPorts/(array index)/Oem/Hp/StructuredName (read only string)

PCI device structured name in UTF-8 format (e.g. ‘NIC.LOM.1.1’ - see PCIDevices in /rest/v1/Systems/x/PCIDevices - this comes from SMBIOS

PhysicalPorts[array-item].Oem.Hp.Team

JSONPath: /PhysicalPorts/(array index)/Oem/Hp/Team (read only string)

If a port is configured for NIC teaming, the name of the configured link between the physical ports that form a logical network adapter. This value is displayed for system NICs only (embedded and stand-up).

PhysicalPorts[array-item].SpeedMbps

JSONPath: /PhysicalPorts/(array index)/SpeedMbps (read only integer)

An estimate of the interface’s current bandwidth in Megabits per second. For interfaces which do not vary in bandwidth or for those where no accurate estimation can be made, this object should contain the nominal bandwidth.

PhysicalPorts[array-item].Status.Health

JSONPath: /PhysicalPorts/(array index)/Status/Health (read only enumeration)

This represents the health state of this resource in the absence of its dependent resources.

Defined values:

PhysicalPorts[array-item].Status.HealthRollUp

JSONPath: /PhysicalPorts/(array index)/Status/HealthRollUp (read only enumeration)

This represents the overall health state from the view of this resource.

Defined values:

PhysicalPorts[array-item].Status.HealthRollup

JSONPath: /PhysicalPorts/(array index)/Status/HealthRollup (read only enumeration)

This represents the overall health state from the view of this resource.

Defined values:

PhysicalPorts[array-item].Status.State

JSONPath: /PhysicalPorts/(array index)/Status/State (read only enumeration)

This indicates the known state of the resource, such as if it is enabled.

Defined values:

PhysicalPorts[array-item].UEFIDevicePath

JSONPath: /PhysicalPorts/(array index)/UEFIDevicePath (read only string)

UEFIDevice Path for correlation purposes

SerialNumber

JSONPath: /SerialNumber (read only string)

The device serial number.

Status.Health

JSONPath: /Status/Health (read only enumeration)

This represents the health state of this resource in the absence of its dependent resources.

Defined values:

Status.HealthRollUp

JSONPath: /Status/HealthRollUp (read only enumeration)

This represents the overall health state from the view of this resource.

Defined values:

Status.HealthRollup

JSONPath: /Status/HealthRollup (read only enumeration)

This represents the overall health state from the view of this resource.

Defined values:

Status.State

JSONPath: /Status/State (read only enumeration)

This indicates the known state of the resource, such as if it is enabled.

Defined values:

StructuredName

JSONPath: /StructuredName (read only string)

PCI device structured name in UTF-8 format (e.g. ‘NIC.LOM.1.1’ - see PCIDevices in /rest/v1/Systems/x/PCIDevices - this comes from SMBIOS

UEFIDevicePath

JSONPath: /UEFIDevicePath (read only string)

UEFIDevice Path for correlation purposes

Chassis

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

Properties

Resource Instances of this Type:

  • https://{iLO}/redfish/v1/chassis/{item}

Some properties in Chassis are only represented on blade servers:

AssetTag

JSONPath: /AssetTag (PATCHable string)

The chassis user-assigned asset tag.

example PATCH: {“AssetTag”: “<string-value>”}

ChassisType

JSONPath: /ChassisType (read only enumeration)

This property indicates the physical form factor type of this resource.

Defined values:

IndicatorLED

JSONPath: /IndicatorLED (PATCHable enumeration)

The chassis indicator LED that is used to identify the chassis. The user can manipulate this LED.

example PATCH: {“IndicatorLED”: “Lit”}

Defined values:

Manufacturer

JSONPath: /Manufacturer (read only string)

The chassis manufacturer.

Model

JSONPath: /Model (read only string)

The chassis model number.

BayNumber

JSONPath: /Oem/Hp/BayNumber (read only integer)

The position of the chassis inside an enclosure.

BaysConsumedHeight

JSONPath: /Oem/Hp/BaysConsumedHeight (read only integer)

The number of enclosure bays this chassis consumes in height.

BaysConsumedWidth

JSONPath: /Oem/Hp/BaysConsumedWidth (read only integer)

The number of enclosure bays this chassis consumes in width.

Firmware.PlatformDefinitionTable.Current.VersionString

JSONPath: /Oem/Hp/Firmware/PlatformDefinitionTable/Current/VersionString (read only string)

The version of the Intelligent Platform Abstraction Data.

Firmware.PowerManagementController.Current.VersionString

JSONPath: /Oem/Hp/Firmware/PowerManagementController/Current/VersionString (read only string)

The firmware version of the Power Monitor.

Firmware.PowerManagementControllerBootloader.Current.Family

JSONPath: /Oem/Hp/Firmware/PowerManagementControllerBootloader/Current/Family (read only string)

The family type of the Power Monitor hardware.

Firmware.PowerManagementControllerBootloader.Current.VersionString

JSONPath: /Oem/Hp/Firmware/PowerManagementControllerBootloader/Current/VersionString (read only string)

The firmware version of the Power Monitor boot loader.

Firmware.SASProgrammableLogicDevice.Current.VersionString

JSONPath: /Oem/Hp/Firmware/SASProgrammableLogicDevice/Current/VersionString (read only string)

The firmware version of the SAS controller.

Firmware.SPSFirmwareVersionData.Current.VersionString

JSONPath: /Oem/Hp/Firmware/SPSFirmwareVersionData/Current/VersionString (read only string)

The SPS FW Version number, aka ME FW Version, AAAA.BBBB.CCCC.DDDD.E

Firmware.SystemProgrammableLogicDevice.Current.VersionString

JSONPath: /Oem/Hp/Firmware/SystemProgrammableLogicDevice/Current/VersionString (read only string)

The firmware version of the CPLD.

Location.GeographicLocation.RackName

JSONPath: /Oem/Hp/Location/GeographicLocation/RackName (read only string)

The name of the chassis enclosure.

Location.LocationInRack.RackLdsPartNumber

JSONPath: /Oem/Hp/Location/LocationInRack/RackLdsPartNumber (read only string)

The chassis rack part number.

Location.LocationInRack.RackLdsProductDescription

JSONPath: /Oem/Hp/Location/LocationInRack/RackLdsProductDescription (read only string)

The chassis rack product description.

Location.LocationInRack.RackUHeight

JSONPath: /Oem/Hp/Location/LocationInRack/RackUHeight (read only integer)

The chassis rack U height.

Location.LocationInRack.RackUUID

JSONPath: /Oem/Hp/Location/LocationInRack/RackUUID (read only string)

The chassis rack UUID.

Location.LocationInRack.TagVersion

JSONPath: /Oem/Hp/Location/LocationInRack/TagVersion (read only integer)

The chassis rack tag version.

Location.LocationInRack.ULocation

JSONPath: /Oem/Hp/Location/LocationInRack/ULocation (read only string)

The chassis rack U location.

Location.LocationInRack.UPosition

JSONPath: /Oem/Hp/Location/LocationInRack/UPosition (read only integer)

The chassis U position in the rack.

Location.LocationOfChassis.UUID

JSONPath: /Oem/Hp/Location/LocationOfChassis/UUID (read only string)

The chassis UUID provided by SMBIOS.

PowerAlertMode.Activated

JSONPath: /Oem/Hp/PowerAlertMode/Activated (read only boolean)

The power alert mode activation state.

PowerAlertMode.AlertPowerWatts

JSONPath: /Oem/Hp/PowerAlertMode/AlertPowerWatts (read only integer)

The power consumption of the system when operating in alert mode.

PartNumber

JSONPath: /PartNumber (read only string)

The chassis part number.

SKU

JSONPath: /SKU (read only string)

The chassis SKU.

SerialNumber

JSONPath: /SerialNumber (read only string)

The chassis serial number.

Status.Health

JSONPath: /Status/Health (read only enumeration)

This represents the health state of this resource in the absence of its dependent resources.

Defined values:

Status.HealthRollUp

JSONPath: /Status/HealthRollUp (read only enumeration)

This represents the overall health state from the view of this resource.

Defined values:

Status.HealthRollup

JSONPath: /Status/HealthRollup (read only enumeration)

This represents the overall health state from the view of this resource.

Defined values:

Status.State

JSONPath: /Status/State (read only enumeration)

This indicates the known state of the resource, such as if it is enabled.

Defined values:

Version

JSONPath: /Version (read only string)

The chassis version.

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.

Properties

Resource Instances of this Type:

  • https://{iLO}/redfish/v1/systems/{item}

AssetTag

JSONPath: /AssetTag (PATCHable string)

A user-definable tag that is used to track this system for inventory or other client purposes.

example PATCH: {“AssetTag”: “<string-value>”}

BIOSPOSTCode

JSONPath: /BIOSPOSTCode (read only integer)

The BIOS Power on Self Test code from the last system boot.

Bios.Current.VersionString

JSONPath: /Bios/Current/VersionString (read only string)

This string represents the version of the firmware image.

BiosVersion

JSONPath: /BiosVersion (PATCHable string)

The version of the system BIOS or primary system firmware.

Boot.BootSourceOverrideEnabled

JSONPath: /Boot/BootSourceOverrideEnabled (PATCHable enumeration)

BootSourceOverrideTarget must be specified before BootSourceOverrideEnabled can be used.

example PATCH: {“Boot”: {“BootSourceOverrideEnabled”: “Once”}}

Defined values:

Boot.BootSourceOverrideTarget

JSONPath: /Boot/BootSourceOverrideTarget (PATCHable enumeration)

The current boot source to be used at next boot instead of the normal boot device, if BootSourceOverrideEnabled is not Disabled.

example PATCH: {“Boot”: {“BootSourceOverrideTarget”: “Hdd”}}

Defined values:

Boot.UefiTargetBootSourceOverride

JSONPath: /Boot/UefiTargetBootSourceOverride (PATCHable string)

The UEFI device path of the device to boot from when BootSourceOverrideTarget is UefiTarget.

example PATCH: {“Boot”: {“UefiTargetBootSourceOverride”: “<string-value>”}}

HostCorrelation.HostFQDN

JSONPath: /HostCorrelation/HostFQDN (read only string)

HostCorrelation.HostName

JSONPath: /HostCorrelation/HostName (read only string)

HostName

JSONPath: /HostName (PATCHable string)

The DNS Host Name, without any domain information

IndicatorLED

JSONPath: /IndicatorLED (PATCHable enumeration)

The state of the indicator LED.

example PATCH: {“IndicatorLED”: “Lit”}

Defined values:

Manufacturer

JSONPath: /Manufacturer (read only string)

The manufacturer or OEM of this system.

Memory.Status.Health

JSONPath: /Memory/Status/Health (read only enumeration)

This represents the health state of this resource in the absence of its dependent resources.

Defined values:

Memory.Status.HealthRollUp

JSONPath: /Memory/Status/HealthRollUp (read only enumeration)

This represents the overall health state from the view of this resource.

Defined values:

Memory.Status.HealthRollup

JSONPath: /Memory/Status/HealthRollup (read only enumeration)

This represents the overall health state from the view of this resource.

Defined values:

Memory.Status.State

JSONPath: /Memory/Status/State (read only enumeration)

This indicates the known state of the resource, such as if it is enabled.

Defined values:

Memory.TotalSystemMemoryGB

JSONPath: /Memory/TotalSystemMemoryGB (read only integer)

The total amount of memory (GB) in the system.

MemorySummary.Status.Health

JSONPath: /MemorySummary/Status/Health (read only enumeration)

This represents the health state of this resource in the absence of its dependent resources.

Defined values:

MemorySummary.Status.HealthRollUp

JSONPath: /MemorySummary/Status/HealthRollUp (read only enumeration)

This represents the overall health state from the view of this resource.

Defined values:

MemorySummary.Status.HealthRollup

JSONPath: /MemorySummary/Status/HealthRollup (read only enumeration)

This represents the overall health state from the view of this resource.

Defined values:

MemorySummary.Status.State

JSONPath: /MemorySummary/Status/State (read only enumeration)

This indicates the known state of the resource, such as if it is enabled.

Defined values:

MemorySummary.TotalSystemMemoryGiB

JSONPath: /MemorySummary/TotalSystemMemoryGiB (read only integer)

This is the total amount of memory in the system measured in GiB.

Model

JSONPath: /Model (read only string)

The model information that the manufacturer uses to refer to this system.

Battery[array-item].Condition

JSONPath: /Oem/Hp/Battery/(array index)/Condition (read only string)

Condition of battery.

Battery[array-item].ErrorCode

JSONPath: /Oem/Hp/Battery/(array index)/ErrorCode (read only integer)

Error Code of battery.

Battery[array-item].FirmwareVersion

JSONPath: /Oem/Hp/Battery/(array index)/FirmwareVersion (read only string)

Firmware Version of battery.

Battery[array-item].Index

JSONPath: /Oem/Hp/Battery/(array index)/Index (read only integer)

Index of battery.

Battery[array-item].MaxCapWatts

JSONPath: /Oem/Hp/Battery/(array index)/MaxCapWatts (read only integer)

Maximum Capacity of battery in watts.

Battery[array-item].Model

JSONPath: /Oem/Hp/Battery/(array index)/Model (read only string)

Model of battery.

Battery[array-item].Present

JSONPath: /Oem/Hp/Battery/(array index)/Present (read only string)

Presence of battery.

Battery[array-item].ProductName

JSONPath: /Oem/Hp/Battery/(array index)/ProductName (read only string)

Product Name of battery.

Battery[array-item].SerialNumber

JSONPath: /Oem/Hp/Battery/(array index)/SerialNumber (read only string)

Serial Number of battery.

Battery[array-item].Spare

JSONPath: /Oem/Hp/Battery/(array index)/Spare (read only string)

Spare of battery.

Bios.Backup.BuildNumber

JSONPath: /Oem/Hp/Bios/Backup/BuildNumber (read only integer)

The build number of the firmware.

Bios.Backup.BuildNumberString

JSONPath: /Oem/Hp/Bios/Backup/BuildNumberString (read only string)

The string version of the build number of the firmware.

Bios.Backup.Date

JSONPath: /Oem/Hp/Bios/Backup/Date (read only string)

The build date of the firmware.

Bios.Backup.DebugBuild

JSONPath: /Oem/Hp/Bios/Backup/DebugBuild (read only boolean)

True if the firmware is a debug build; False if it is not.

Bios.Backup.Family

JSONPath: /Oem/Hp/Bios/Backup/Family (read only string)

The family of the firmware.

Bios.Backup.MajorVersion

JSONPath: /Oem/Hp/Bios/Backup/MajorVersion (read only integer)

The major version of the firmware.

Bios.Backup.MinorVersion

JSONPath: /Oem/Hp/Bios/Backup/MinorVersion (read only integer)

The minor version of the firmware.

Bios.Backup.Time

JSONPath: /Oem/Hp/Bios/Backup/Time (read only string)

The build time of the firmware.

Bios.Backup.VersionString

JSONPath: /Oem/Hp/Bios/Backup/VersionString (read only string)

The version string of the firmware. This value might be null if VersionString is unavailable.

Bios.Bootblock.BuildNumber

JSONPath: /Oem/Hp/Bios/Bootblock/BuildNumber (read only integer)

The build number of the firmware.

Bios.Bootblock.BuildNumberString

JSONPath: /Oem/Hp/Bios/Bootblock/BuildNumberString (read only string)

The string version of the build number of the firmware.

Bios.Bootblock.Date

JSONPath: /Oem/Hp/Bios/Bootblock/Date (read only string)

The build date of the firmware.

Bios.Bootblock.DebugBuild

JSONPath: /Oem/Hp/Bios/Bootblock/DebugBuild (read only boolean)

True if the firmware is a debug build; False if it is not.

Bios.Bootblock.Family

JSONPath: /Oem/Hp/Bios/Bootblock/Family (read only string)

The family of the firmware.

Bios.Bootblock.MajorVersion

JSONPath: /Oem/Hp/Bios/Bootblock/MajorVersion (read only integer)

The major version of the firmware.

Bios.Bootblock.MinorVersion

JSONPath: /Oem/Hp/Bios/Bootblock/MinorVersion (read only integer)

The minor version of the firmware.

Bios.Bootblock.Time

JSONPath: /Oem/Hp/Bios/Bootblock/Time (read only string)

The build time of the firmware.

Bios.Bootblock.VersionString

JSONPath: /Oem/Hp/Bios/Bootblock/VersionString (read only string)

The version string of the firmware. This value might be null if VersionString is unavailable.

Bios.Current.BuildNumber

JSONPath: /Oem/Hp/Bios/Current/BuildNumber (read only integer)

The build number of the firmware.

Bios.Current.BuildNumberString

JSONPath: /Oem/Hp/Bios/Current/BuildNumberString (read only string)

The string version of the build number of the firmware.

Bios.Current.Date

JSONPath: /Oem/Hp/Bios/Current/Date (read only string)

The build date of the firmware.

Bios.Current.DebugBuild

JSONPath: /Oem/Hp/Bios/Current/DebugBuild (read only boolean)

True if the firmware is a debug build; False if it is not.

Bios.Current.Family

JSONPath: /Oem/Hp/Bios/Current/Family (read only string)

The family of the firmware.

Bios.Current.MajorVersion

JSONPath: /Oem/Hp/Bios/Current/MajorVersion (read only integer)

The major version of the firmware.

Bios.Current.MinorVersion

JSONPath: /Oem/Hp/Bios/Current/MinorVersion (read only integer)

The minor version of the firmware.

Bios.Current.Time

JSONPath: /Oem/Hp/Bios/Current/Time (read only string)

The build time of the firmware.

Bios.Current.VersionString

JSONPath: /Oem/Hp/Bios/Current/VersionString (read only string)

The version string of the firmware. This value might be null if VersionString is unavailable.

Bios.UefiClass

JSONPath: /Oem/Hp/Bios/UefiClass (read only integer)

The UEFI BIOS Class value defined in the UEFI specification.

DeviceDiscoveryComplete.AMSDeviceDiscovery

JSONPath: /Oem/Hp/DeviceDiscoveryComplete/AMSDeviceDiscovery (read only enumeration)

This property indicates the current AMS Device Discovery Status.

Defined values:

DeviceDiscoveryComplete.DeviceDiscovery

JSONPath: /Oem/Hp/DeviceDiscoveryComplete/DeviceDiscovery (read only enumeration)

This property indicates the current device discovery status of devices that are not Smart Array or AMS related.

Defined values:

DeviceDiscoveryComplete.SmartArrayDiscovery

JSONPath: /Oem/Hp/DeviceDiscoveryComplete/SmartArrayDiscovery (read only enumeration)

This property indicates the current Smart Array Storage Device Discovery Status

Defined values:

EndOfPostDelaySeconds

JSONPath: /Oem/Hp/EndOfPostDelaySeconds (PATCHable integer)

Supported on UEFI based systems only. The number of seconds to delay before finalizing POST with the Mode action (e.g. delay before shutdown).

example PATCH: {“Oem”: {“Hp”: {“EndOfPostDelaySeconds”: <integer-value>}}}

IntelligentProvisioningIndex

JSONPath: /Oem/Hp/IntelligentProvisioningIndex (read only integer)

Index in the Firmware Version Table for Intelligent Provisioning.

IntelligentProvisioningLocation

JSONPath: /Oem/Hp/IntelligentProvisioningLocation (read only string)

Location string of Intelligent Provisioning in Firmware Version Table.

IntelligentProvisioningVersion

JSONPath: /Oem/Hp/IntelligentProvisioningVersion (read only string)

Intelligent Provisioning Version.

PostMode

JSONPath: /Oem/Hp/PostMode (PATCHable enumeration)

Supported on UEFI based systems only. The manner in which the system will operate durring and at completion of POST.

example PATCH: {“Oem”: {“Hp”: {“PostMode”: “PostToShutdown”}}}

Defined values:

PostState

JSONPath: /Oem/Hp/PostState (read only enumeration)

The current state of system POST.

Defined values:

PowerAllocationLimit

JSONPath: /Oem/Hp/PowerAllocationLimit (read only integer)

The total amount of power allocated to the system.

PowerAutoOn

JSONPath: /Oem/Hp/PowerAutoOn (PATCHable enumeration)

Auto Power-On mode defines what occurs when the AC power is applied to the system.

example PATCH: {“Oem”: {“Hp”: {“PowerAutoOn”: “PowerOn”}}}

Defined values:

PowerOnDelay

JSONPath: /Oem/Hp/PowerOnDelay (PATCHable enumeration)

The PowerAutoOn policy delay that can also be found in the HpBios::PowerOnDelay object. Will be null if PowerAutoOn is set to RemainOff.

example PATCH: {“Oem”: {“Hp”: {“PowerOnDelay”: “30Sec”}}}

Defined values:

PowerRegulatorMode

JSONPath: /Oem/Hp/PowerRegulatorMode (PATCHable enumeration)

HP Power Regulator mode.

example PATCH: {“Oem”: {“Hp”: {“PowerRegulatorMode”: “Max”}}}

Defined values:

ServerSignature

JSONPath: /Oem/Hp/ServerSignature (read only integer)

The CRC32 of: All Device Signatures combined together, Blade Slot Location in Enclosure, Enclosure UUID, and OneView Domain IP Address

ServerSignatureStatus

JSONPath: /Oem/Hp/ServerSignatureStatus (read only enumeration)

The current state of Server Signature.

Defined values:

TrustedModules[array-item].FWVersion.Backup.BuildNumber

JSONPath: /Oem/Hp/TrustedModules/(array index)/FWVersion/Backup/BuildNumber (read only integer)

The build number of the firmware.

TrustedModules[array-item].FWVersion.Backup.BuildNumberString

JSONPath: /Oem/Hp/TrustedModules/(array index)/FWVersion/Backup/BuildNumberString (read only string)

The string version of the build number of the firmware.

TrustedModules[array-item].FWVersion.Backup.Date

JSONPath: /Oem/Hp/TrustedModules/(array index)/FWVersion/Backup/Date (read only string)

The build date of the firmware.

TrustedModules[array-item].FWVersion.Backup.DebugBuild

JSONPath: /Oem/Hp/TrustedModules/(array index)/FWVersion/Backup/DebugBuild (read only boolean)

True if the firmware is a debug build; False if it is not.

TrustedModules[array-item].FWVersion.Backup.Family

JSONPath: /Oem/Hp/TrustedModules/(array index)/FWVersion/Backup/Family (read only string)

The family of the firmware.

TrustedModules[array-item].FWVersion.Backup.MajorVersion

JSONPath: /Oem/Hp/TrustedModules/(array index)/FWVersion/Backup/MajorVersion (read only integer)

The major version of the firmware.

TrustedModules[array-item].FWVersion.Backup.MinorVersion

JSONPath: /Oem/Hp/TrustedModules/(array index)/FWVersion/Backup/MinorVersion (read only integer)

The minor version of the firmware.

TrustedModules[array-item].FWVersion.Backup.Time

JSONPath: /Oem/Hp/TrustedModules/(array index)/FWVersion/Backup/Time (read only string)

The build time of the firmware.

TrustedModules[array-item].FWVersion.Backup.VersionString

JSONPath: /Oem/Hp/TrustedModules/(array index)/FWVersion/Backup/VersionString (read only string)

The version string of the firmware. This value might be null if VersionString is unavailable.

TrustedModules[array-item].FWVersion.Bootblock.BuildNumber

JSONPath: /Oem/Hp/TrustedModules/(array index)/FWVersion/Bootblock/BuildNumber (read only integer)

The build number of the firmware.

TrustedModules[array-item].FWVersion.Bootblock.BuildNumberString

JSONPath: /Oem/Hp/TrustedModules/(array index)/FWVersion/Bootblock/BuildNumberString (read only string)

The string version of the build number of the firmware.

TrustedModules[array-item].FWVersion.Bootblock.Date

JSONPath: /Oem/Hp/TrustedModules/(array index)/FWVersion/Bootblock/Date (read only string)

The build date of the firmware.

TrustedModules[array-item].FWVersion.Bootblock.DebugBuild

JSONPath: /Oem/Hp/TrustedModules/(array index)/FWVersion/Bootblock/DebugBuild (read only boolean)

True if the firmware is a debug build; False if it is not.

TrustedModules[array-item].FWVersion.Bootblock.Family

JSONPath: /Oem/Hp/TrustedModules/(array index)/FWVersion/Bootblock/Family (read only string)

The family of the firmware.

TrustedModules[array-item].FWVersion.Bootblock.MajorVersion

JSONPath: /Oem/Hp/TrustedModules/(array index)/FWVersion/Bootblock/MajorVersion (read only integer)

The major version of the firmware.

TrustedModules[array-item].FWVersion.Bootblock.MinorVersion

JSONPath: /Oem/Hp/TrustedModules/(array index)/FWVersion/Bootblock/MinorVersion (read only integer)

The minor version of the firmware.

TrustedModules[array-item].FWVersion.Bootblock.Time

JSONPath: /Oem/Hp/TrustedModules/(array index)/FWVersion/Bootblock/Time (read only string)

The build time of the firmware.

TrustedModules[array-item].FWVersion.Bootblock.VersionString

JSONPath: /Oem/Hp/TrustedModules/(array index)/FWVersion/Bootblock/VersionString (read only string)

The version string of the firmware. This value might be null if VersionString is unavailable.

TrustedModules[array-item].FWVersion.Current.BuildNumber

JSONPath: /Oem/Hp/TrustedModules/(array index)/FWVersion/Current/BuildNumber (read only integer)

The build number of the firmware.

TrustedModules[array-item].FWVersion.Current.BuildNumberString

JSONPath: /Oem/Hp/TrustedModules/(array index)/FWVersion/Current/BuildNumberString (read only string)

The string version of the build number of the firmware.

TrustedModules[array-item].FWVersion.Current.Date

JSONPath: /Oem/Hp/TrustedModules/(array index)/FWVersion/Current/Date (read only string)

The build date of the firmware.

TrustedModules[array-item].FWVersion.Current.DebugBuild

JSONPath: /Oem/Hp/TrustedModules/(array index)/FWVersion/Current/DebugBuild (read only boolean)

True if the firmware is a debug build; False if it is not.

TrustedModules[array-item].FWVersion.Current.Family

JSONPath: /Oem/Hp/TrustedModules/(array index)/FWVersion/Current/Family (read only string)

The family of the firmware.

TrustedModules[array-item].FWVersion.Current.MajorVersion

JSONPath: /Oem/Hp/TrustedModules/(array index)/FWVersion/Current/MajorVersion (read only integer)

The major version of the firmware.

TrustedModules[array-item].FWVersion.Current.MinorVersion

JSONPath: /Oem/Hp/TrustedModules/(array index)/FWVersion/Current/MinorVersion (read only integer)

The minor version of the firmware.

TrustedModules[array-item].FWVersion.Current.Time

JSONPath: /Oem/Hp/TrustedModules/(array index)/FWVersion/Current/Time (read only string)

The build time of the firmware.

TrustedModules[array-item].FWVersion.Current.VersionString

JSONPath: /Oem/Hp/TrustedModules/(array index)/FWVersion/Current/VersionString (read only string)

The version string of the firmware. This value might be null if VersionString is unavailable.

TrustedModules[array-item].FWVersion.Pending.BuildNumber

JSONPath: /Oem/Hp/TrustedModules/(array index)/FWVersion/Pending/BuildNumber (read only integer)

The build number of the firmware.

TrustedModules[array-item].FWVersion.Pending.BuildNumberString

JSONPath: /Oem/Hp/TrustedModules/(array index)/FWVersion/Pending/BuildNumberString (read only string)

The string version of the build number of the firmware.

TrustedModules[array-item].FWVersion.Pending.Date

JSONPath: /Oem/Hp/TrustedModules/(array index)/FWVersion/Pending/Date (read only string)

The build date of the firmware.

TrustedModules[array-item].FWVersion.Pending.DebugBuild

JSONPath: /Oem/Hp/TrustedModules/(array index)/FWVersion/Pending/DebugBuild (read only boolean)

True if the firmware is a debug build; False if it is not.

TrustedModules[array-item].FWVersion.Pending.Family

JSONPath: /Oem/Hp/TrustedModules/(array index)/FWVersion/Pending/Family (read only string)

The family of the firmware.

TrustedModules[array-item].FWVersion.Pending.MajorVersion

JSONPath: /Oem/Hp/TrustedModules/(array index)/FWVersion/Pending/MajorVersion (read only integer)

The major version of the firmware.

TrustedModules[array-item].FWVersion.Pending.MinorVersion

JSONPath: /Oem/Hp/TrustedModules/(array index)/FWVersion/Pending/MinorVersion (read only integer)

The minor version of the firmware.

TrustedModules[array-item].FWVersion.Pending.Time

JSONPath: /Oem/Hp/TrustedModules/(array index)/FWVersion/Pending/Time (read only string)

The build time of the firmware.

TrustedModules[array-item].FWVersion.Pending.VersionString

JSONPath: /Oem/Hp/TrustedModules/(array index)/FWVersion/Pending/VersionString (read only string)

The version string of the firmware. This value might be null if VersionString is unavailable.

TrustedModules[array-item].FWVersion.definitions.HpFWVersion.BuildNumber

JSONPath: /Oem/Hp/TrustedModules/(array index)/FWVersion/definitions/HpFWVersion/BuildNumber (read only integer)

The build number of the firmware.

TrustedModules[array-item].FWVersion.definitions.HpFWVersion.BuildNumberString

JSONPath: /Oem/Hp/TrustedModules/(array index)/FWVersion/definitions/HpFWVersion/BuildNumberString (read only string)

The string version of the build number of the firmware.

TrustedModules[array-item].FWVersion.definitions.HpFWVersion.Date

JSONPath: /Oem/Hp/TrustedModules/(array index)/FWVersion/definitions/HpFWVersion/Date (read only string)

The build date of the firmware.

TrustedModules[array-item].FWVersion.definitions.HpFWVersion.DebugBuild

JSONPath: /Oem/Hp/TrustedModules/(array index)/FWVersion/definitions/HpFWVersion/DebugBuild (read only boolean)

True if the firmware is a debug build; False if it is not.

TrustedModules[array-item].FWVersion.definitions.HpFWVersion.Family

JSONPath: /Oem/Hp/TrustedModules/(array index)/FWVersion/definitions/HpFWVersion/Family (read only string)

The family of the firmware.

TrustedModules[array-item].FWVersion.definitions.HpFWVersion.MajorVersion

JSONPath: /Oem/Hp/TrustedModules/(array index)/FWVersion/definitions/HpFWVersion/MajorVersion (read only integer)

The major version of the firmware.

TrustedModules[array-item].FWVersion.definitions.HpFWVersion.MinorVersion

JSONPath: /Oem/Hp/TrustedModules/(array index)/FWVersion/definitions/HpFWVersion/MinorVersion (read only integer)

The minor version of the firmware.

TrustedModules[array-item].FWVersion.definitions.HpFWVersion.Time

JSONPath: /Oem/Hp/TrustedModules/(array index)/FWVersion/definitions/HpFWVersion/Time (read only string)

The build time of the firmware.

TrustedModules[array-item].FWVersion.definitions.HpFWVersion.VersionString

JSONPath: /Oem/Hp/TrustedModules/(array index)/FWVersion/definitions/HpFWVersion/VersionString (read only string)

The version string of the firmware. This value might be null if VersionString is unavailable.

TrustedModules[array-item].ModuleType

JSONPath: /Oem/Hp/TrustedModules/(array index)/ModuleType (read only enumeration)

This property indicates the type of TPM or TM.

Defined values:

TrustedModules[array-item].Status

JSONPath: /Oem/Hp/TrustedModules/(array index)/Status (read only enumeration)

This property indicates the TPM or TM status.

Defined values:

VirtualProfile

JSONPath: /Oem/Hp/VirtualProfile (read only enumeration)

The current state of the systems virtual profile. This profile is the one that, when the server is rebooted, will set the Virtual properties. Intent is to use this state to determine whether the server needs to be rebooted so these values are set. Additional informaiton about the profile will be considered later.

Defined values:

VirtualUUID

JSONPath: /Oem/Hp/VirtualUUID (read only string)

Used in conjunction with the UUID (Logical) value.

PartNumber

JSONPath: /PartNumber (read only string)

The manufacturer’s system part number.

Power

JSONPath: /Power (read only enumeration)

The current power state of the system.

Defined values:

PowerState

JSONPath: /PowerState (read only enumeration)

This is the current power state of the system

Defined values:

ProcessorSummary.Count

JSONPath: /ProcessorSummary/Count (read only integer)

The number of processors in the system.

ProcessorSummary.Model

JSONPath: /ProcessorSummary/Model (read only string)

The processor model for the primary or majority of processors in this system.

ProcessorSummary.Status.Health

JSONPath: /ProcessorSummary/Status/Health (read only enumeration)

This represents the health state of this resource in the absence of its dependent resources.

Defined values:

ProcessorSummary.Status.HealthRollUp

JSONPath: /ProcessorSummary/Status/HealthRollUp (read only enumeration)

This represents the overall health state from the view of this resource.

Defined values:

ProcessorSummary.Status.HealthRollup

JSONPath: /ProcessorSummary/Status/HealthRollup (read only enumeration)

This represents the overall health state from the view of this resource.

Defined values:

ProcessorSummary.Status.State

JSONPath: /ProcessorSummary/Status/State (read only enumeration)

This indicates the known state of the resource, such as if it is enabled.

Defined values:

Processors.Count

JSONPath: /Processors/Count (read only integer)

The number of processors in the system.

Processors.ProcessorFamily

JSONPath: /Processors/ProcessorFamily (read only string)

The processor family for the processors in the system.

Processors.Status.Health

JSONPath: /Processors/Status/Health (read only enumeration)

This represents the health state of this resource in the absence of its dependent resources.

Defined values:

Processors.Status.HealthRollUp

JSONPath: /Processors/Status/HealthRollUp (read only enumeration)

This represents the overall health state from the view of this resource.

Defined values:

Processors.Status.HealthRollup

JSONPath: /Processors/Status/HealthRollup (read only enumeration)

This represents the overall health state from the view of this resource.

Defined values:

Processors.Status.State

JSONPath: /Processors/Status/State (read only enumeration)

This indicates the known state of the resource, such as if it is enabled.

Defined values:

SKU

JSONPath: /SKU (read only string)

SKU for this system.

SerialNumber

JSONPath: /SerialNumber (read only string)

The system serial number.

Status.Health

JSONPath: /Status/Health (read only enumeration)

This represents the health state of this resource in the absence of its dependent resources.

Defined values:

Status.HealthRollUp

JSONPath: /Status/HealthRollUp (read only enumeration)

This represents the overall health state from the view of this resource.

Defined values:

Status.HealthRollup

JSONPath: /Status/HealthRollup (read only enumeration)

This represents the overall health state from the view of this resource.

Defined values:

Status.State

JSONPath: /Status/State (read only enumeration)

This indicates the known state of the resource, such as if it is enabled.

Defined values:

SystemType

JSONPath: /SystemType (read only enumeration)

The type of computer system that this resource represents.

Defined values:

UUID

JSONPath: /UUID (read only string)

The universal unique identifier for this system.

Version

JSONPath: /Version (read only string)

The manufacturer’s system version.

VirtualSerialNumber

JSONPath: /VirtualSerialNumber (read only string)

The system virtual serial number.

POST Action “Reset”

Resets the computer system using one of the ResetType methods.

Parameters:

“ResetType” (string) with one of the following value(s):

example “Reset” action:

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

{
    "ResetType": "On"
}

POST Action “PowerButton”

Simulates pressing the power button. The PushType parameter simulates a quick button press or a press and hold operation.

Parameters:

“PushType” (string) with one of the following value(s):

example “PowerButton” action:

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

{
    "PushType": "Press"
}

POST Action “SystemReset”

Resets the computer system using a cold boot operation.

Parameters:

“ResetType” (string) with the value “ColdBoot”

example “SystemReset” action:

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

{
    "ResetType": "ColdBoot"
}

EthernetInterface

The schema definition of a simple Ethernet NIC resource.

Properties

Resource Instances of this Type:

  • https://{iLO}/redfish/v1/managers/{item}/ethernetinterfaces/{item}

AutoNeg

JSONPath: /AutoNeg (PATCHable boolean)

This indicates if the speed and duplex is automatically configured by the NIC.

example PATCH: {“AutoNeg”: true}

Autosense

JSONPath: /Autosense (PATCHable boolean)

The autosense speed/duplex enabled or disabled. Autosense can only be disabled if the SpeedMbps and FullDuplex values are specified. Autosense is only applicable and modifiable for a dedicated network port and cannot be modified for blade servers.

example PATCH: {“Autosense”: true}

FQDN

JSONPath: /FQDN (read only string)

The complete, fully qualified domain name obtained by DNS for this NIC.

FactoryMacAddress

JSONPath: /FactoryMacAddress (read only string)

The MAC address assigned to the NIC at the factory.

FrameSize

JSONPath: /FrameSize (PATCHable integer)

The MAC frame size (bytes).

example PATCH: {“FrameSize”: <integer-value>}

FullDuplex

JSONPath: /FullDuplex (PATCHable boolean)

The connection duplex status. If Autosense is enabled, this property cannot be modified. Autosense is only applicable and modifiable for a dedicated network port and cannot be modified for blade servers.

example PATCH: {“FullDuplex”: true}

HostName

JSONPath: /HostName (read only string)

The DNS Host Name, without any domain information.

IPv4Addresses[array-item].Address

JSONPath: /IPv4Addresses/(array index)/Address (PATCHable string)

The IPv4 Address.

example PATCH: {“IPv4Addresses”: [{“Address”: “<string-value>”}|null, …]}

IPv4Addresses[array-item].AddressOrigin

JSONPath: /IPv4Addresses/(array index)/AddressOrigin (read only enumeration)

How the address was determined.

Defined values:

IPv4Addresses[array-item].Gateway

JSONPath: /IPv4Addresses/(array index)/Gateway (PATCHable string)

The IPv4 gateway for this address.

example PATCH: {“IPv4Addresses”: [{“Gateway”: “<string-value>”}|null, …]}

IPv4Addresses[array-item].SubnetMask

JSONPath: /IPv4Addresses/(array index)/SubnetMask (PATCHable string)

The IPv4 Subnet mask.

example PATCH: {“IPv4Addresses”: [{“SubnetMask”: “<string-value>”}|null, …]}

IPv6AddressPolicyTable[array-item].Label

JSONPath: /IPv6AddressPolicyTable/(array index)/Label (PATCHable integer)

The label value for this table entry, as defined in RFC3484 section 2.1.

example PATCH: {“IPv6AddressPolicyTable”: [{“Label”: <integer-value>}|null, …]}

IPv6AddressPolicyTable[array-item].Precedence

JSONPath: /IPv6AddressPolicyTable/(array index)/Precedence (PATCHable integer)

The precedence value for this table entry as defined in RFC3484 section 2.1.

example PATCH: {“IPv6AddressPolicyTable”: [{“Precedence”: <integer-value>}|null, …]}

IPv6AddressPolicyTable[array-item].Prefix

JSONPath: /IPv6AddressPolicyTable/(array index)/Prefix (PATCHable string)

The IPv6 Address Prefix for this table entry as defined in RFC3484 section 2.1.

example PATCH: {“IPv6AddressPolicyTable”: [{“Prefix”: “<string-value>”}|null, …]}

IPv6Addresses[array-item].Address

JSONPath: /IPv6Addresses/(array index)/Address (read only string)

The IPv6 Address.

IPv6Addresses[array-item].AddressOrigin

JSONPath: /IPv6Addresses/(array index)/AddressOrigin (read only enumeration)

How the address was determined.

Defined values:

IPv6Addresses[array-item].AddressState

JSONPath: /IPv6Addresses/(array index)/AddressState (read only enumeration)

The current state of this address as defined in RFC 4862.

Defined values:

IPv6Addresses[array-item].PrefixLength

JSONPath: /IPv6Addresses/(array index)/PrefixLength (read only integer)

The IPv6 Address Prefix Length.

IPv6DefaultGateway

JSONPath: /IPv6DefaultGateway (read only string)

The IPv6 default gateway address that is currently in use on this interface.

IPv6StaticAddresses[array-item].Address

JSONPath: /IPv6StaticAddresses/(array index)/Address (PATCHable string)

A valid IPv6 address.

example PATCH: {“IPv6StaticAddresses”: [{“Address”: “<string-value>”}|null, …]}

IPv6StaticAddresses[array-item].PrefixLength

JSONPath: /IPv6StaticAddresses/(array index)/PrefixLength (PATCHable integer)

The Prefix Length of this IPv6 address.

example PATCH: {“IPv6StaticAddresses”: [{“PrefixLength”: <integer-value>}|null, …]}

LinkTechnology

JSONPath: /LinkTechnology (read only enumeration)

The link technology, such as Ethernet, for this NIC.

Defined values:

MACAddress (Redfish-conformant MAC Address)

JSONPath: /MACAddress (read only string)

The effective current MAC address. If the assignable MAC address is not supported, this is a read-only alias of FactoryMacAddress. This replaces MacAddress which was used prior to the release of the Redfish 1.0 specification.)

example PATCH: {“MACAddress”: “<string-value>”}

MacAddress (pre-Redfish conformant MAC Address)

JSONPath: /MacAddress (read only string)

The effective current MAC address. If the assignable MAC address is not supported, this is a read-only alias of FactoryMacAddress. MacAddress was added to iLO 4 prior to the release of the Redfish 1.0 specification and is replaced by MACAddress.

example PATCH: {“MacAddress”: “<string-value>”}

MaxIPv6StaticAddresses

JSONPath: /MaxIPv6StaticAddresses (read only integer)

The maximum number of IPv6 static addresses that can be configured on this interface.

ConfigurationSettings

JSONPath: /Oem/Hp/ConfigurationSettings (read only enumeration)

The state of the currently displayed configuration settings.

Defined values:

DHCPv4.Enabled

JSONPath: /Oem/Hp/DHCPv4/Enabled (PATCHable boolean)

Determines whether DHCPv4 is enabled.

example PATCH: {“Oem”: {“Hp”: {“DHCPv4”: {“Enabled”: true}}}}

DHCPv4.UseDNSServers

JSONPath: /Oem/Hp/DHCPv4/UseDNSServers (PATCHable boolean)

Determines whether to use DHCPv4-supplied DNS servers. Can only be enabled when DHCPv4 is also enabled; otherwise, this property will be set to false and will be read-only.

example PATCH: {“Oem”: {“Hp”: {“DHCPv4”: {“UseDNSServers”: true}}}}

DHCPv4.UseDomainName

JSONPath: /Oem/Hp/DHCPv4/UseDomainName (PATCHable boolean)

Determines whether to use a DHCPv4-supplied domain name. Can only be enabled when DHCPv4 is also enabled; otherwis,e this property will be set to false and will be read-only.

example PATCH: {“Oem”: {“Hp”: {“DHCPv4”: {“UseDomainName”: true}}}}

DHCPv4.UseGateway

JSONPath: /Oem/Hp/DHCPv4/UseGateway (PATCHable boolean)

Determines whether to use a DHCPv4-supplied gateway. Can only be enabled when DHCPv4 is also enabled; otherwise, this property will be set to false and will be read-only.

example PATCH: {“Oem”: {“Hp”: {“DHCPv4”: {“UseGateway”: true}}}}

DHCPv4.UseNTPServers

JSONPath: /Oem/Hp/DHCPv4/UseNTPServers (PATCHable boolean)

Determines whether to use DHCPv4-supplied NTP servers. Can only be enabled when DHCPv4 is also enabled; otherwise, this property will be set to false and will be read-only.

example PATCH: {“Oem”: {“Hp”: {“DHCPv4”: {“UseNTPServers”: true}}}}

DHCPv4.UseStaticRoutes

JSONPath: /Oem/Hp/DHCPv4/UseStaticRoutes (PATCHable boolean)

Determines whether to use DHCPv4-supplied static routes. Can only be enabled when DHCPv4 is also enabled; otherwise, this property will be set to false and will be read-only.

example PATCH: {“Oem”: {“Hp”: {“DHCPv4”: {“UseStaticRoutes”: true}}}}

DHCPv4.UseWINSServers

JSONPath: /Oem/Hp/DHCPv4/UseWINSServers (PATCHable boolean)

Determines whether to use DHCPv4-supplied WINS servers. Can only be enabled when DHCPv4 is also enabled; otherwise, this property will be set to false and will be read-only.

example PATCH: {“Oem”: {“Hp”: {“DHCPv4”: {“UseWINSServers”: true}}}}

DHCPv6.StatefulModeEnabled

JSONPath: /Oem/Hp/DHCPv6/StatefulModeEnabled (PATCHable boolean)

Determines whether DHCPv6 Stateful mode is enabled.

example PATCH: {“Oem”: {“Hp”: {“DHCPv6”: {“StatefulModeEnabled”: true}}}}

DHCPv6.StatelessModeEnabled

JSONPath: /Oem/Hp/DHCPv6/StatelessModeEnabled (PATCHable boolean)

Determines whether DHCPv6 Stateless mode is enabled. Always enabled by default whenever DHCPv6 Stateful mode is also enabled.

example PATCH: {“Oem”: {“Hp”: {“DHCPv6”: {“StatelessModeEnabled”: true}}}}

DHCPv6.UseDNSServers

JSONPath: /Oem/Hp/DHCPv6/UseDNSServers (PATCHable boolean)

Determines whether to use DHCPv6-supplied DNS servers. Can only be enabled when DHCPv6 Stateless mode is also enabled; otherwise, this property will be set to false and will be read-only.

example PATCH: {“Oem”: {“Hp”: {“DHCPv6”: {“UseDNSServers”: true}}}}

DHCPv6.UseDomainName

JSONPath: /Oem/Hp/DHCPv6/UseDomainName (PATCHable boolean)

Determines whether to use a DHCPv6-supplied domain name. Can only be enabled when DHCPv6 Stateless mode is also enabled; otherwise, this property will be set to false and will be read-only.

example PATCH: {“Oem”: {“Hp”: {“DHCPv6”: {“UseDomainName”: true}}}}

DHCPv6.UseNTPServers

JSONPath: /Oem/Hp/DHCPv6/UseNTPServers (PATCHable boolean)

Determines whether to use DHCPv6-supplied NTP servers. Can only be enabled when DHCPv6 Stateless mode is also enabled; otherwise, this property will be set to false and will be read-only.

example PATCH: {“Oem”: {“Hp”: {“DHCPv6”: {“UseNTPServers”: true}}}}

DHCPv6.UseRapidCommit

JSONPath: /Oem/Hp/DHCPv6/UseRapidCommit (PATCHable boolean)

Determines whether to use DHCPv6 rapid commit mode. Can only be enabled when DHCPv6 Stateful mode is also enabled; otherwise, this property will be set to false and will be read-only. Do not enable in networks where more than one DHCPv6 server is configured to provide address assignments.

example PATCH: {“Oem”: {“Hp”: {“DHCPv6”: {“UseRapidCommit”: true}}}}

DomainName

JSONPath: /Oem/Hp/DomainName (PATCHable string)

Domain name of the network to which this management processor belongs. This property can only be modified when the management processor is not configured to use a DHCP supplied domain name; otherwise this property is read-only indicating the value is provided by DHCP.

example PATCH: {“Oem”: {“Hp”: {“DomainName”: “<string-value>”}}}

HostName

JSONPath: /Oem/Hp/HostName (PATCHable string)

The management processor host name.

example PATCH: {“Oem”: {“Hp”: {“HostName”: “<string-value>”}}}

IPv4.DDNSRegistration

JSONPath: /Oem/Hp/IPv4/DDNSRegistration (PATCHable boolean)

Determines whether DDNS registration is enabled.

example PATCH: {“Oem”: {“Hp”: {“IPv4”: {“DDNSRegistration”: true}}}}

IPv4.StaticRoutes[array-item].Destination

JSONPath: /Oem/Hp/IPv4/StaticRoutes/(array index)/Destination (PATCHable string)

An IPv4 static route destination. Only writeable when use of DHCPv4-supplied static routes is disabled; otherwise this property is read-only indicating the value is provided by DHCPv4.

example PATCH: {“Oem”: {“Hp”: {“IPv4”: {“StaticRoutes”: [{“Destination”: “<string-value>”}|null, …]}}}}

IPv4.StaticRoutes[array-item].Gateway

JSONPath: /Oem/Hp/IPv4/StaticRoutes/(array index)/Gateway (PATCHable string)

An IPv4 static route gateway. Only writeable when use of DHCPv4-supplied static routes is disabled; otherwise this property is read-only indicating the value is provided by DHCPv4.

example PATCH: {“Oem”: {“Hp”: {“IPv4”: {“StaticRoutes”: [{“Gateway”: “<string-value>”}|null, …]}}}}

IPv4.StaticRoutes[array-item].SubnetMask

JSONPath: /Oem/Hp/IPv4/StaticRoutes/(array index)/SubnetMask (PATCHable string)

An IPv4 static route subnet mask. Only writeable when use of DHCPv4-supplied static routes is disabled; otherwise this property is read-only indicating the value is provided by DHCPv4.

example PATCH: {“Oem”: {“Hp”: {“IPv4”: {“StaticRoutes”: [{“SubnetMask”: “<string-value>”}|null, …]}}}}

IPv4.WINSRegistration

JSONPath: /Oem/Hp/IPv4/WINSRegistration (PATCHable boolean)

Determines whether WINS registration is enabled.

example PATCH: {“Oem”: {“Hp”: {“IPv4”: {“WINSRegistration”: true}}}}

IPv6.DDNSRegistration

JSONPath: /Oem/Hp/IPv6/DDNSRegistration (PATCHable boolean)

Determines whether IPv6 DDNS registration is enabled.

example PATCH: {“Oem”: {“Hp”: {“IPv6”: {“DDNSRegistration”: true}}}}

IPv6.SLAACEnabled

JSONPath: /Oem/Hp/IPv6/SLAACEnabled (PATCHable boolean)

Determines whether StateLess Address Auto-Configuration is enabled.

example PATCH: {“Oem”: {“Hp”: {“IPv6”: {“SLAACEnabled”: true}}}}

IPv6.StaticDefaultGateway

JSONPath: /Oem/Hp/IPv6/StaticDefaultGateway (PATCHable string)

The IPv6 static default gateway entry.

example PATCH: {“Oem”: {“Hp”: {“IPv6”: {“StaticDefaultGateway”: “<string-value>”}}}}

IPv6.StaticRoutes[array-item].Destination

JSONPath: /Oem/Hp/IPv6/StaticRoutes/(array index)/Destination (PATCHable string)

The IPv6 static route destination address.

example PATCH: {“Oem”: {“Hp”: {“IPv6”: {“StaticRoutes”: [{“Destination”: “<string-value>”}|null, …]}}}}

IPv6.StaticRoutes[array-item].Gateway

JSONPath: /Oem/Hp/IPv6/StaticRoutes/(array index)/Gateway (PATCHable string)

The IPv6 static route gateway.

example PATCH: {“Oem”: {“Hp”: {“IPv6”: {“StaticRoutes”: [{“Gateway”: “<string-value>”}|null, …]}}}}

IPv6.StaticRoutes[array-item].PrefixLength

JSONPath: /Oem/Hp/IPv6/StaticRoutes/(array index)/PrefixLength (PATCHable integer)

The prefix length of the IPv6 static route destination address.

example PATCH: {“Oem”: {“Hp”: {“IPv6”: {“StaticRoutes”: [{“PrefixLength”: <integer-value>}|null, …]}}}}

IPv6.StaticRoutes[array-item].Status

JSONPath: /Oem/Hp/IPv6/StaticRoutes/(array index)/Status (read only enumeration)

Status of this static route entry.

Defined values:

NICEnabled

JSONPath: /Oem/Hp/NICEnabled (PATCHable boolean)

Determines whether this NIC is enabled or disabled. Enabling one NIC will disable the others. If no NIC is enabled, this management processor is not accessible over the network.

example PATCH: {“Oem”: {“Hp”: {“NICEnabled”: true}}}

NICSupportsIPv6

JSONPath: /Oem/Hp/NICSupportsIPv6 (read only boolean)

Indicates whether or not this NIC can support the IPv6 protocol.

PingGatewayOnStartup

JSONPath: /Oem/Hp/PingGatewayOnStartup (PATCHable boolean)

Determines whether to ping the IPv4 gateway on startup.

example PATCH: {“Oem”: {“Hp”: {“PingGatewayOnStartup”: true}}}

SharedNetworkPortOptions.NIC

JSONPath: /Oem/Hp/SharedNetworkPortOptions/NIC (PATCHable enumeration)

This property is only present on the iLO shared network port interface.

Selects the system NIC that is to be shared with this management processor.

example PATCH: {“Oem”: {“Hp”: {“SharedNetworkPortOptions”: {“NIC”: “FlexibleLOM”}}}}

Defined values:

SharedNetworkPortOptions.Port

JSONPath: /Oem/Hp/SharedNetworkPortOptions/Port (PATCHable integer)

This property is only present on the iLO shared network port interface.

The network adapter port number that is used for sharing. This feature is only applicable on systems and network adapters that support it.

example PATCH: {“Oem”: {“Hp”: {“SharedNetworkPortOptions”: {“Port”: <integer-value>}}}}

SupportsFlexibleLOM

JSONPath: /Oem/Hp/SupportsFlexibleLOM (read only boolean)

Indicates whether this system supports FlexibleLOM. Only applies to Shared Network Port.

SupportsLOM

JSONPath: /Oem/Hp/SupportsLOM (read only boolean)

Indicates whether this system supports LOM. Only applies to Shared Network Port.

VLANEnabled

JSONPath: /Oem/Hp/VLANEnabled (PATCHable boolean)

Determines whether VLAN is enabled. Only applies to Shared Network Port.

example PATCH: {“Oem”: {“Hp”: {“VLANEnabled”: true}}}

VLANId

JSONPath: /Oem/Hp/VLANId (PATCHable integer)

The VLAN ID/tag. Only applies to Shared Network Port.

example PATCH: {“Oem”: {“Hp”: {“VLANId”: <integer-value>}}}

PermanentMACAddress

JSONPath: /PermanentMACAddress (read only string)

This is the MAC address assigned to this NIC at the factory.

SettingsResult.ETag

JSONPath: /SettingsResult/ETag (read only string)

The ETag of the resource to which the settings were applied, after the application.

SettingsResult.Operation

JSONPath: /SettingsResult/Operation (read only enumeration)

Last operation detail.

Defined values:

SettingsResult.Time

JSONPath: /SettingsResult/Time (read only string)

Indicates the time the settings were applied.

SpeedMbps

JSONPath: /SpeedMbps (PATCHable integer)

The link speed of the Ethernet interface in megabits per second. If Autosense is enabled, this property cannot be modified. This property can only be modified on a dedicated network port. It cannot be modified for blade servers.

example PATCH: {“SpeedMbps”: <integer-value>}

Status.Health

JSONPath: /Status/Health (read only enumeration)

This represents the health state of this resource in the absence of its dependent resources.

Defined values:

Status.HealthRollUp

JSONPath: /Status/HealthRollUp (read only enumeration)

This represents the overall health state from the view of this resource.

Defined values:

Status.HealthRollup

JSONPath: /Status/HealthRollup (read only enumeration)

This represents the overall health state from the view of this resource.

Defined values:

Status.State

JSONPath: /Status/State (read only enumeration)

This indicates the known state of the resource, such as if it is enabled.

Defined values:

UEFIDevicePath

JSONPath: /UEFIDevicePath (read only string)

The UEFI device path for this NIC.

VLANEnable

JSONPath: /VLANEnable (read only boolean)

Indicates if VLANs are enabled. If this NIC supports more than one VLAN, this property will not be present and the client should look for VLANs collection in the link section of this resource.

VLANId

JSONPath: /VLANId (read only integer)

The VLAN identifier for this NIC. The VLANId is only present when the VLANEnable is used and when the NIC supports only a single VLAN.

EventService

This is the schema definition for the Event Service. It represents the properties for the service itself and has links to the actual list of subscriptions.

Properties

Resource Instances of this Type:

  • https://{iLO}/redfish/v1/eventservice

DeliveryRetryAttempts

JSONPath: /DeliveryRetryAttempts (read only integer)

This is the number of attempts an event posting is retried before the subscription is terminated.

DeliveryRetryIntervalInSeconds

JSONPath: /DeliveryRetryIntervalInSeconds (read only integer)

This represents the number of seconds between retry attempts for sending any given Event

DeliveryRetryIntervalSeconds

JSONPath: /DeliveryRetryIntervalSeconds (read only integer)

This represents the number of seconds between retry attempts for sending any given Event

RequestedMaxEventsToQueueDefault

JSONPath: /Oem/Hp/RequestedMaxEventsToQueueDefault (read only integer)

This represents the default number of events the service should queue.

RetireOldEventInMinutesDefault

JSONPath: /Oem/Hp/RetireOldEventInMinutesDefault (read only integer)

This represents the default number of minutes until an event is expired.

TTLCountDefault

JSONPath: /Oem/Hp/TTLCountDefault (read only integer)

The default number of TTLUnits until this listener destination subscription expires. It may be renewed prior to expire to reset the Time to Live counter. The value 999999 is reserved to mean a perpetual subscription.

TTLUnitsDefault

JSONPath: /Oem/Hp/TTLUnitsDefault (read only enumeration)

The default time unit used to measure the subscription time of this listener destination. This is the units for TTLCount and is used to express the subscription lifetime of the listener destination.

Defined values:

Status.Health

JSONPath: /Status/Health (read only enumeration)

This represents the health state of this resource in the absence of its dependent resources.

Defined values:

Status.HealthRollUp

JSONPath: /Status/HealthRollUp (read only enumeration)

This represents the overall health state from the view of this resource.

Defined values:

Status.HealthRollup

JSONPath: /Status/HealthRollup (read only enumeration)

This represents the overall health state from the view of this resource.

Defined values:

Status.State

JSONPath: /Status/State (read only enumeration)

This indicates the known state of the resource, such as if it is enabled.

Defined values:

SubscriptionRemovalAction

JSONPath: /SubscriptionRemovalAction (read only enumeration)

This property indicates what the service will do to an event subscription after the number of delivery retry attempts has been exhausted.

Defined values:

SubscriptionRemovalTimeIntervalInMinutes

JSONPath: /SubscriptionRemovalTimeIntervalInMinutes (read only integer)

This is the minimum amount of time after the failed events that the service will wait before doing the SubscriptionRemovalAction.

POST Action “SubmitTestEvent”

Causes iLO 4 to submit a test event to any subscribed event recievers.

Parameters:

“EventType” (string) with one of the following value(s):

“EventID” (string)

“EventTimestamp” (date-time)

“Severity” (string) with one of the following value(s):

“Message” (free form string)

“MessageID” (a message defined in a message registry)

“MessageArgs” (array of strings used to substitute into the MessageID tokens)

“OriginOfCondition” (the uri of the resource associated with this event)

example “SubmitTestEvent” action:

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

{
    "EventType": "StatusChange", 
    "EventID": "<string>", 
    "EventTimestamp": "<date-time>", 
    "Severity": "OK", 
    "Message": "<string>", 
    "MessageID": "<string>", 
    "MessageArgs": "<string>", 
    "OriginOfCondition": "<string>"
}

FwSwVersionInventory

The FwSwVersionInventory resource publishes an inventory of current firmware versions on a specific ComputerSystem.  The list of firmware items will vary by server model and configuration, but some common items include:

The Name property contains the user-readable firmware item name.

Properties

Resource Instances of this Type:

  • https://{iLO}/redfish/v1/systems/{item}/firmwareinventory

Current.{FirmwareItem}[array-item].0.AuthenticationRequired

JSONPath: /Current/{FirmwareItem}/(array index)/0/AuthenticationRequired (PATCHable boolean)

Determines if the item requires authentication to update.

Current.{FirmwareItem}[array-item].0.ImageSizeBytes

JSONPath: /Current/{FirmwareItem}/(array index)/0/ImageSizeBytes (PATCHable integer)

The size of the item’s firmware image in bytes.

Current.{FirmwareItem}[array-item].0.InUse

JSONPath: /Current/{FirmwareItem}/(array index)/0/InUse (PATCHable boolean)

Determines if the item is in use.

Current.{FirmwareItem}[array-item].0.Key

JSONPath: /Current/{FirmwareItem}/(array index)/0/Key (PATCHable string)

The family-specific key of the firmware item used for correlation to a component database.

Current.{FirmwareItem}[array-item].0.Location

JSONPath: /Current/{FirmwareItem}/(array index)/0/Location (PATCHable string)

The location of the item.

Current.{FirmwareItem}[array-item].0.ResetRequired

JSONPath: /Current/{FirmwareItem}/(array index)/0/ResetRequired (PATCHable boolean)

An update of this item requires a device reset to become active.

Current.{FirmwareItem}[array-item].0.UEFIDevicePaths

JSONPath: /Current/{FirmwareItem}/(array index)/0/UEFIDevicePaths (PATCHable array)

The UEFI Device Path of the item.

Current.{FirmwareItem}[array-item].0.UEFIImage

JSONPath: /Current/{FirmwareItem}/(array index)/0/UEFIImage (PATCHable boolean)

Determines if the item uses a UEFI firmware image.

Current.{FirmwareItem}[array-item].0.Updateable

JSONPath: /Current/{FirmwareItem}/(array index)/0/Updateable (PATCHable boolean)

Determines if the item is updatable.

Current.{FirmwareItem}[array-item].0.Version

JSONPath: /Current/{FirmwareItem}/(array index)/0/Version (PATCHable integer)

A version number used for greater-than, less-than, equality comparison.

Current.{FirmwareItem}[array-item].0.VersionString

JSONPath: /Current/{FirmwareItem}/(array index)/0/VersionString (PATCHable string)

The user-displayable version of the firmware item in string format

HPPowerMeter

Properties

Resource Instances of this Type:

  • https://{iLO}/redfish/v1/chassis/{item}/power/fastpowermeter

  • https://{iLO}/redfish/v1/chassis/{item}/power/powermeter

Average

JSONPath: /Average (read only integer)

Average power across all samples, over the last 24 hours.

Maximum

JSONPath: /Maximum (read only integer)

Maximum power across all samples, taken from the 24 hour history.

Minimum

JSONPath: /Minimum (read only integer)

Minimum power across all samples, taken from the 24 hour history.

PowerDetail[array-item].AmbTemp

JSONPath: /PowerDetail/(array index)/AmbTemp (read only integer)

Ambient temperature, in degrees Celsius.

PowerDetail[array-item].Average

JSONPath: /PowerDetail/(array index)/Average (read only integer)

Average power over the sample time.

PowerDetail[array-item].Cap

JSONPath: /PowerDetail/(array index)/Cap (read only integer)

Overall power cap for the power meter.

PowerDetail[array-item].CpuAvgFreq

JSONPath: /PowerDetail/(array index)/CpuAvgFreq (read only integer)

CPU average frequency of the power supply.

PowerDetail[array-item].CpuCapLim

JSONPath: /PowerDetail/(array index)/CpuCapLim (read only integer)

CPU cap limit for the power meter.

PowerDetail[array-item].CpuMax

JSONPath: /PowerDetail/(array index)/CpuMax (read only integer)

CPU maximum power consumed by the power meter.

PowerDetail[array-item].CpuPwrSavLim

JSONPath: /PowerDetail/(array index)/CpuPwrSavLim (read only integer)

CPU power-saving limit for the power meter.

PowerDetail[array-item].CpuUtil

JSONPath: /PowerDetail/(array index)/CpuUtil (read only integer)

CPU power utilization.

PowerDetail[array-item].Minimum

JSONPath: /PowerDetail/(array index)/Minimum (read only integer)

Minimum power over the sample time.

PowerDetail[array-item].Peak

JSONPath: /PowerDetail/(array index)/Peak (read only integer)

Peak power over the sample time.

PowerDetail[array-item].PrMode

JSONPath: /PowerDetail/(array index)/PrMode (read only enumeration)

Power regulator mode, which can be OS Control, Static High, Static Low or Dynamic.

Defined values:

PowerDetail[array-item].PunCap

JSONPath: /PowerDetail/(array index)/PunCap (read only boolean)

Punitive cap for the power meter.

PowerDetail[array-item].Time

JSONPath: /PowerDetail/(array index)/Time (read only string)

Time at which the power detail was captured.

PowerDetail[array-item].UnachCap

JSONPath: /PowerDetail/(array index)/UnachCap (read only boolean)

Unachievable cap for the power meter.

Samples

JSONPath: /Samples (read only integer)

Number of samples in the array.

HpBaseConfigs

Properties

Resource Instances of this Type:

  • https://{iLO}/redfish/v1/systems/{item}/bios/boot/baseconfigs

  • https://{iLO}/redfish/v1/systems/{item}/bios/baseconfigs

  • https://{iLO}/redfish/v1/systems/{item}/bios/iscsi/baseconfigs

Capabilities.BaseConfig

JSONPath: /Capabilities/BaseConfig (read only boolean)

True if the provider supports PUT/PATCH of the named BaseConfig.

Capabilities.BaseConfigs

JSONPath: /Capabilities/BaseConfigs (read only boolean)

True if the provider supports PUT/PATCH of the named BaseConfigs.

HpBios

BIOS configuration settings vary with the server model and firmware version. The per-server settings are described with HpBios Attributes. A GET of the BIOS settings will include a combination of properties from “HpBios” and “HpBios Attributes”.

The BIOS settings are in two resources. One is the current settings and are read only. The second is the pending settings are are modifiable with PUT or PATCH. The pending settings are evaluated and applied upon system restart when UEFI POST runs. At this time the current settings are updated to reflect the changed configuration. The results of the last settings application are in the SettingsResults sub-object of the current settings.

Resetting BIOS Setting to Default

For the modifiyable settings resource, you may PATCH or PUT the property “BaseConfig” with the value “default” to cause the BIOS to revert to default settings on the next reboot. The BIOS will revert to default settings and override them with any other properties specified in the request payload.

e.g. Reset BIOS settings to defaults PUT {“BaseConfig”: “default”, “Slot3NicBoot7”: “PxeBoot”} To cause the BIOS to revert to defaults and also set Slot 3 NIC to boot to PXE.

Properties

Resource Instances of this Type:

  • https://{iLO}/redfish/v1/systems/{item}/bios/settings (PATCHable Pending settings)

  • https://{iLO}/redfish/v1/systems/{item}/bios (read only current settings)

AttributeRegistry

JSONPath: /AttributeRegistry (read only string)

This object represents the type property. It represents the schema used for the resource and indicates the version of the schema in the format ....

SettingsResult.definitions.SettingsResult.ETag

JSONPath: /SettingsResult/definitions/SettingsResult/ETag (read only string)

ETag of this resource after the settings have been applied.

SettingsResult.definitions.SettingsResult.Messages[array-item].Message

JSONPath: /SettingsResult/definitions/SettingsResult/Messages/(array index)/Message (read only string)

Human-readable message.

SettingsResult.definitions.SettingsResult.Messages[array-item].MessageID

JSONPath: /SettingsResult/definitions/SettingsResult/Messages/(array index)/MessageID (read only string)

Key for this message, which is used to look up the message in a message registry. The key is in the format ..:.

SettingsResult.definitions.SettingsResult.Messages[array-item].Resolution

JSONPath: /SettingsResult/definitions/SettingsResult/Messages/(array index)/Resolution (read only string)

Instructions for resolving the issue that caused the error.

SettingsResult.definitions.SettingsResult.Messages[array-item].Severity

JSONPath: /SettingsResult/definitions/SettingsResult/Messages/(array index)/Severity (read only enumeration)

This is the severity of the errors.

Defined values:

SettingsResult.definitions.SettingsResult.Operation

JSONPath: /SettingsResult/definitions/SettingsResult/Operation (read only enumeration)

Details about the results of applying the settings.

Defined values:

SettingsResult.definitions.SettingsResult.Time

JSONPath: /SettingsResult/definitions/SettingsResult/Time (read only string)

Time at which the settings were applied.

HpBios Attributes

This registry defines a representation of HP BIOS Attribute instances

Properties

Resource Instances of this Type:

  • https://{iLO}/redfish/v1/systems/{item}/bios/settings

  • https://{iLO}/redfish/v1/systems/{item}/bios

AcpiRootBridgePxm

JSONPath: /AcpiRootBridgePxm (PATCHable enumeration)

When enabled, the System ROM 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.

Defined values:

AcpiSlit

JSONPath: /AcpiSlit (PATCHable enumeration)

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.

Defined values:

AdjSecPrefetch

JSONPath: /AdjSecPrefetch (PATCHable enumeration)

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.

Defined values:

AdminEmail

JSONPath: /AdminEmail (PATCHable string)

Enter the server administrator’s e-mail address.

AdminName

JSONPath: /AdminName (PATCHable string)

Enter the server administrator’s name text.

AdminOtherInfo

JSONPath: /AdminOtherInfo (PATCHable string)

Enter the server administrator’s information text.

AdminPassword

JSONPath: /AdminPassword (PATCHable password)

Use this option to enter the administrator password to protect the server configuration. When this option is enabled, you are prompted for this password before being allowed to modify the configuration.

AdminPhone

JSONPath: /AdminPhone (PATCHable string)

Enter the server administrator’s phone number text.

AdvancedMemProtection

JSONPath: /AdvancedMemProtection (PATCHable enumeration)

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. Lockstep Mode with DDDC Support keeps all installed memory available for use while error corrections are performed in cases of multiple DRAM device failures. This support enables protection beyond Advanced ECC. Enabling this option might impact memory performance.

Defined values:

AsrStatus

JSONPath: /AsrStatus (PATCHable enumeration)

Use this option to configure the Automatic Server Recovery option, which enables the system to automatically reboot if the server locks up.

Defined values:

AsrTimeoutMinutes

JSONPath: /AsrTimeoutMinutes (PATCHable enumeration)

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.

Defined values:

AssetTagProtection

JSONPath: /AssetTagProtection (PATCHable enumeration)

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.

Defined values:

AutoPowerOn

JSONPath: /AutoPowerOn (PATCHable enumeration)

Use this option to configure the server to automatically power on when AC power is applied to the system. By default, the system returns to its previous power state when AC power is restored after an AC power loss. This option causes the system to always returns to the “on” state whenever power is applied, even if the system is in the “off” state when power is lost.

Defined values:

BootMode

JSONPath: /BootMode (PATCHable enumeration)

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 Boot Mode: Secure Boot, IPv6 PXE Boot, boot > 2.2 TB Disks in AHCI SATA Mode, and Dynamic Smart Array RAID.

Defined values:

BootOrderPolicy

JSONPath: /BootOrderPolicy (PATCHable enumeration)

Use this option to configure how the system attempts to boot devices per the Boot Order when no bootable device is found. If configured to “Retry Boot Order Indefinitely,” the system continuously attempts to process the Boot Order until a bootable device is found. If configured to “Attempt Boot Order Once,” the system attempts to process all items in the Boot Order once. If configured for “Reset After Failed Boot Attempt,” the system attempts to process all items in the Boot Order once, and then reboots the system.

Defined values:

ChannelInterleaving

JSONPath: /ChannelInterleaving (PATCHable enumeration)

You can only configure this option if the Power 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.

Defined values:

CollabPowerControl

JSONPath: /CollabPowerControl (PATCHable enumeration)

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

Defined values:

ConsistentDevNaming

JSONPath: /ConsistentDevNaming (PATCHable enumeration)

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 name until reinstalled under the OS environment.

Defined values:

CustomPostMessage

JSONPath: /CustomPostMessage (PATCHable string)

Enter a message to be displayed during system startup.

DaylightSavingsTime

JSONPath: /DaylightSavingsTime (PATCHable enumeration)

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.

Defined values:

DcuIpPrefetcher

JSONPath: /DcuIpPrefetcher (PATCHable enumeration)

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.

Defined values:

DcuStreamPrefetcher

JSONPath: /DcuStreamPrefetcher (PATCHable enumeration)

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.

Defined values:

Dhcpv4

JSONPath: /Dhcpv4 (PATCHable enumeration)

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.

Defined values:

DynamicPowerCapping

JSONPath: /DynamicPowerCapping (PATCHable enumeration)

Use this option to configure when the System ROM 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 or configuration settings change. When disabled, the calibration does not run and Dynamic Power Capping is not supported. When enabled, the calibration is run on every boot.

Defined values:

DynamicPowerResponse

JSONPath: /DynamicPowerResponse (PATCHable enumeration)

Use this option to enable the System BIOS to control processor performance and power states depending on the processor workload. You can set the response time for switching between power states. - The Fast setting is optimal for most workloads where low latency response to an increase in processor demand is a requirement. - The Slow setting is optimal for workloads where a longer latency response to an increase in processing demand is an acceptable trade-off for reduced power consumption. Selecting this option can have a negative effect on performance, depending on the workload.

Defined values:

EmbNicEnable

JSONPath: /EmbNicEnable (PATCHable enumeration)

Select this option to enable or disable PCI devices.

Defined values:

EmbSas1Boot

JSONPath: /EmbSas1Boot (PATCHable enumeration)

When Boot All Targets is selected, the UEFI BIOS will allow all valid boot targets attached to the storage controller to be made available in the UEFI Boot Order List. If Boot No Targets is selected, no boot targets from this storage controller will be made available in the UEFI Boot Order.If Boot Limit to 3 Targets is selected, 3 boot targets attached to the storage controller will be made available in the UEFI Boot Order.

Defined values:

EmbSasEnable

JSONPath: /EmbSasEnable (PATCHable enumeration)

Select this option to enable or disable PCI devices.

Defined values:

EmbSata1Enable

JSONPath: /EmbSata1Enable (PATCHable enumeration)

Select this option to enable or disable PCI devices.

Defined values:

EmbSata2Enable

JSONPath: /EmbSata2Enable (PATCHable enumeration)

Select this option to enable or disable PCI devices.

Defined values:

EmbVideoConnection

JSONPath: /EmbVideoConnection (PATCHable enumeration)

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.

Defined values:

EmbeddedDiagnostics

JSONPath: /EmbeddedDiagnostics (PATCHable enumeration)

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.

Defined values:

EmbeddedDiagsMode

JSONPath: /EmbeddedDiagsMode (PATCHable enumeration)

Use this option to configure Embedded Diagnostics in Auto or Text Console mode.

Defined values:

EmbeddedSata

JSONPath: /EmbeddedSata (PATCHable enumeration)

Important: Dynamic Smart Array RAID is not supported when the Boot Mode is configured in 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.

Defined values:

EmbeddedSerialPort

JSONPath: /EmbeddedSerialPort (PATCHable enumeration)

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.

Defined values:

EmbeddedUefiShell

JSONPath: /EmbeddedUefiShell (PATCHable enumeration)

Use this option to enable or disable the Embedded UEFI Shell. If enabled, you can launch the Embedded UEFI Shell from the pre-boot environment. When enabled, you can add the Embedded UEFI Shell to the UEFI Boot Order if the boot mode is configured for UEFI 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. 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 ROM and other firmware, and obtain system information and error logs.

Defined values:

EmbeddedUserPartition

JSONPath: /EmbeddedUserPartition (PATCHable enumeration)

Use this option to control the Embedded User Partition. The Embedded User Partition is a general purpose disk partition on non-volatile flash memory that is embedded on the system board.

Defined values:

EmsConsole

JSONPath: /EmsConsole (PATCHable enumeration)

Use this option to configure the ACPI serial port settings, which include redirecting the Windows Server Emergency Management console (EMS) through the serial port. If you select this option for redirecting EMS through a network connection, two options are available: 1) When redirecting EMS through a virtual serial port, select the value (COM1 or COM2) that corresponds to the resources assigned to the Virtual Serial Port in the System Options menu. 2) When redirecting EMS through a physical serial port, select the value (COM1 or COM2) that corresponds to the resources assigned to the embedded serial port in the System Options menu. EMS Console is not supported at 38400 BAUD.

Defined values:

EnergyPerfBias

JSONPath: /EnergyPerfBias (PATCHable enumeration)

You can only configure this option if the Power 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.

Defined values:

EraseUserDefaults

JSONPath: /EraseUserDefaults (PATCHable enumeration)

Select this option to erase the user defaults backup.

Defined values:

ExtendedAmbientTemp

JSONPath: /ExtendedAmbientTemp (PATCHable enumeration)

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

Defined values:

ExtendedMemTest

JSONPath: /ExtendedMemTest (PATCHable enumeration)

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 system boot time.

Defined values:

F11BootMenu

JSONPath: /F11BootMenu (PATCHable enumeration)

Use this option to disable the POST One-Time Boot F11 Prompt.

Defined values:

FCScanPolicy

JSONPath: /FCScanPolicy (PATCHable enumeration)

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 scan only targets that are preconfigured in the devices settings. This option overrides any individual device settings configured in the device specific setup.

Defined values:

FanFailPolicy

JSONPath: /FanFailPolicy (PATCHable enumeration)

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.

Defined values:

FanInstallReq

JSONPath: /FanInstallReq (PATCHable enumeration)

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.

Defined values:

FlexLom1Enable

JSONPath: /FlexLom1Enable (PATCHable enumeration)

Select this option to enable or disable PCI devices.

Defined values:

HwPrefetcher

JSONPath: /HwPrefetcher (PATCHable enumeration)

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.

Defined values:

IntelDmiLinkFreq

JSONPath: /IntelDmiLinkFreq (PATCHable enumeration)

Use this option to force the link speed between the processor and the southbridge to run at slower speeds to save power.

Defined values:

IntelNicDmaChannels

JSONPath: /IntelNicDmaChannels (PATCHable enumeration)

Use this option to select the Intel NIC DMA Channels support. This is a NIC acceleration option that runs only on Intel-based NICs.

Defined values:

IntelPerfMonitoring

JSONPath: /IntelPerfMonitoring (PATCHable enumeration)

This option does not impact performance. When enabled, this option exposes certain chipset devices that can be used with the Intel Performance Monitoring Toolkit.

Defined values:

IntelProcVtd

JSONPath: /IntelProcVtd (PATCHable enumeration)

If enabled, a hypervisor or operating system supporting this option can use hardware capabilities provided by Intel’s Virtualization Technology 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.

Defined values:

IntelQpiFreq

JSONPath: /IntelQpiFreq (PATCHable enumeration)

Use this option to set the QPI 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 Power Profile is set to custom.

Defined values:

IntelQpiLinkEn

JSONPath: /IntelQpiLinkEn (PATCHable enumeration)

Use this option to configure the QPI topology to use fewer links between processors, when available. Changing from the default can reduce QPI bandwidth performance in exchange for less power consumption.

Defined values:

IntelQpiPowerManagement

JSONPath: /IntelQpiPowerManagement (PATCHable enumeration)

Use this option to place the Quick Path Interconnect (QPI) 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 Power Profile is set to custom.

Defined values:

IntelTxt

JSONPath: /IntelTxt (PATCHable enumeration)

Use this option to modify Intel TXT support.

Defined values:

IntelligentProvisioning

JSONPath: /IntelligentProvisioning (PATCHable enumeration)

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.

Defined values:

InternalSDCardSlot

JSONPath: /InternalSDCardSlot (PATCHable enumeration)

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. It will not be visible in the pre-boot environment or under the operating system.

Defined values:

IoNonPostedPrefetching

JSONPath: /IoNonPostedPrefetching (PATCHable enumeration)

Disabling non-posted prefetching for I/O can significantly improve performance for a small set of configurations that require a balanced mix of read/write I/O traffic (for example, configurations that include Infiniband) or multiple x16 devices that utilize max bandwidth of the PCI-e bus. Disabling this feature does, however, have a slight impact on 100% I/O read bandwidth.

Defined values:

Ipv4Address

JSONPath: /Ipv4Address (PATCHable string)

Use this option to specify the pre-boot network IPv4 address. Enter a static IP addresses using dotted-decimal notation (for example, 127.0.0.1). If DHCP is used (DHCPv4 option is enabled), this setting is unavailable because the value is supplied automatically.

Ipv4Gateway

JSONPath: /Ipv4Gateway (PATCHable string)

Use this option to specify the pre-boot network gateway IPv4 address. Enter a static IP addresses using dotted-decimal notation (for example, 127.0.0.1). If DHCP is used (DHCPv4 option is enabled), this setting is unavailable because the value is supplied automatically.

Ipv4PrimaryDNS

JSONPath: /Ipv4PrimaryDNS (PATCHable string)

Use this option to specify the pre-boot network Primary DNS Server IPv4 address. Enter a static IP addresses using dotted-decimal notation (for example, 127.0.0.1). If DHCP is used (DHCPv4 option is enabled), this setting is unavailable because the value is supplied automatically.

Ipv4SecondaryDNS

JSONPath: /Ipv4SecondaryDNS (PATCHable string)

Use this option to specify the pre-boot network Secondary DNS Server IPv4 address. Enter a static IP addresses using dotted-decimal notation (for example, 127.0.0.1). If DHCP is used (DHCPv4 option is enabled), this setting is unavailable because the value is supplied automatically.

Ipv4SubnetMask

JSONPath: /Ipv4SubnetMask (PATCHable string)

Use this option to specify the pre-boot network subnet mask. Enter a static IP addresses using dotted-decimal notation (for example, 255.255.255.0). If DHCP is used (DHCPv4 option is enabled), this setting is unavailable because the value is supplied automatically.

Ipv6Duid

JSONPath: /Ipv6Duid (PATCHable enumeration)

Use this option to control the IPv6 DHCP Unique Identifier (DUID). If configured for Auto, the DUID is set using the server’s Universal Unique Identifier (UUID), or using the DUID-LLT method if the server UUID is not available. If configured for DUID-LLT, the DUID is set based on Link-layer Address Plus Time [DUID-LLT] method. You can configure this option only when Boot Mode is set to UEFI.

Defined values:

MaxMemBusFreqMHz

JSONPath: /MaxMemBusFreqMHz (PATCHable enumeration)

You can only configure this option if the Power Profile is set to Custom. 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.

Defined values:

MaxPcieSpeed

JSONPath: /MaxPcieSpeed (PATCHable enumeration)

You can only configure this option if the Power Profile is set to Custom. 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.

Defined values:

MemFastTraining

JSONPath: /MemFastTraining (PATCHable enumeration)

Use this option to configure memory training on server reboots. When enabled, the platform uses the previously saved memory training parameters determined from the last cold boot of the server, which improves the server boot time. When disabled, the platform performs a full-memory training on every server reboot.

Defined values:

MinProcIdlePkgState

JSONPath: /MinProcIdlePkgState (PATCHable enumeration)

You can configure this option only if the Power 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).

Defined values:

MinProcIdlePower

JSONPath: /MinProcIdlePower (PATCHable enumeration)

You can only configure this option if Power 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).

Defined values:

MixedPowerSupplyReporting

JSONPath: /MixedPowerSupplyReporting (PATCHable enumeration)

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.

Defined values:

NetworkBootRetry

JSONPath: /NetworkBootRetry (PATCHable enumeration)

Use this option to disable the Network Boot Retry setting. By default, the System BIOS attempts to boot the Network device (such as a PXE device) up to 20 times before moving to the next IPL device.

Defined values:

NicBoot1

JSONPath: /NicBoot1 (PATCHable enumeration)

Use this option to enable network boot (PXE, iSCSI, or FCoE) for the selected NIC. You might need to configure the NIC firmware for the boot option to be active.

Defined values:

NicBoot10

JSONPath: /NicBoot10 (PATCHable enumeration)

Use this option to enable network boot (PXE, iSCSI, or FCoE) for the selected NIC. You might need to configure the NIC firmware for the boot option to be active.

Defined values:

NicBoot11

JSONPath: /NicBoot11 (PATCHable enumeration)

Use this option to enable network boot (PXE, iSCSI, or FCoE) for the selected NIC. You might need to configure the NIC firmware for the boot option to be active.

Defined values:

NicBoot12

JSONPath: /NicBoot12 (PATCHable enumeration)

Use this option to enable network boot (PXE, iSCSI, or FCoE) for the selected NIC. You might need to configure the NIC firmware for the boot option to be active.

Defined values:

NicBoot2

JSONPath: /NicBoot2 (PATCHable enumeration)

Use this option to enable network boot (PXE, iSCSI, or FCoE) for the selected NIC. You might need to configure the NIC firmware for the boot option to be active.

Defined values:

NicBoot3

JSONPath: /NicBoot3 (PATCHable enumeration)

Use this option to enable network boot (PXE, iSCSI, or FCoE) for the selected NIC. You might need to configure the NIC firmware for the boot option to be active.

Defined values:

NicBoot4

JSONPath: /NicBoot4 (PATCHable enumeration)

Use this option to enable network boot (PXE, iSCSI, or FCoE) for the selected NIC. You might need to configure the NIC firmware for the boot option to be active.

Defined values:

NicBoot5

JSONPath: /NicBoot5 (PATCHable enumeration)

Use this option to enable network boot (PXE, iSCSI, or FCoE) for the selected NIC. You might need to configure the NIC firmware for the boot option to be active.

Defined values:

NicBoot6

JSONPath: /NicBoot6 (PATCHable enumeration)

Use this option to enable network boot (PXE, iSCSI, or FCoE) for the selected NIC. You might need to configure the NIC firmware for the boot option to be active.

Defined values:

NicBoot7

JSONPath: /NicBoot7 (PATCHable enumeration)

Use this option to enable network boot (PXE, iSCSI, or FCoE) for the selected NIC. You might need to configure the NIC firmware for the boot option to be active.

Defined values:

NicBoot8

JSONPath: /NicBoot8 (PATCHable enumeration)

Use this option to enable network boot (PXE, iSCSI, or FCoE) for the selected NIC. You might need to configure the NIC firmware for the boot option to be active.

Defined values:

NicBoot9

JSONPath: /NicBoot9 (PATCHable enumeration)

Use this option to enable network boot (PXE, iSCSI, or FCoE) for the selected NIC. You might need to configure the NIC firmware for the boot option to be active.

Defined values:

NmiDebugButton

JSONPath: /NmiDebugButton (PATCHable enumeration)

Use this option to generate an NMI via the NMI button/jumper.

Defined values:

NodeInterleaving

JSONPath: /NodeInterleaving (PATCHable enumeration)

Use this option to disable the NUMA architecture properties for the system. All operating system platforms support NUMA architectures. In most cases, disable the Node Interleaving option for optimum performance. When this option is enabled, memory addresses are interleaved across the memory installed for each processor and workloads might experience improved performance. Node Interleaving cannot be enabled when NVDIMMs are present in the system.

Defined values:

NumaGroupSizeOpt

JSONPath: /NumaGroupSizeOpt (PATCHable enumeration)

Use this option to configure how the System ROM 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 the resulting groups being optimized 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.

Defined values:

NvDimmNBackupPowerPolicy

JSONPath: /NvDimmNBackupPowerPolicy (PATCHable enumeration)

If sufficient battery backup power for the installed NVDIMMs of type NVDIMM-N is not available, this option allows the batteries to charge before boot. If this option is configured for ‘Continue Boot without Backup Power’, the server boots with or without sufficient battery backup power. In this case, if sufficient battery backup power is not available, the installed NVDIMMs of type NVDIMM-N are NOT be used by the operating system as persistent storage or as system memory.

Defined values:

NvDimmNForcedRecovery

JSONPath: /NvDimmNForcedRecovery (PATCHable enumeration)

When this option is enabled, all NVDIMM-N devices that are mapped out of the system (not available to the operating system) due to uncorrectable errors are mapped back during the next boot. This option only takes effect on the next reboot. If an NVDIMM-N experiences any additional uncorrectable errors, it is mapped out again. This option can be utilized to assist in recovery of data on an NVDIMM-N that experienced an error but might be functional again.

Defined values:

NvDimmNIntegrityChecking

JSONPath: /NvDimmNIntegrityChecking (PATCHable enumeration)

When this option is enabled, the NVDIMM-N is checked during system boot to determine the integrity of the data stored on the NVDIMM-N. If any data cannot be read properly, the NVDIMM-N is mapped out (not available to the operating system). If this option is disabled, an NVDIMM-N that cannot read data or has corrupt data might result in uncorrectable errors that cause machine checks or system resets. Enable this option to ensure any NVDIMM-Ns that are visible to the operating system operate appropriately. Enabling this option, in addition to each installed NVDIMM-N, results in an increased boot time of several seconds.

Defined values:

NvDimmNMemFunctionality

JSONPath: /NvDimmNMemFunctionality (PATCHable enumeration)

This option enables or disables NVDIMM-N functionality (including backing up the contents of the memory to flash on power down/reset). If this option is Disabled, then the the operating system does NOT use NVDIMM-Ns as persistent storage and system memory.

Defined values:

NvDimmNMemInterleaving

JSONPath: /NvDimmNMemInterleaving (PATCHable enumeration)

This option controls whether the NVDIMM-Ns installed on a particular processor are interleaved with each other in the memory map. This option does NOT impact the interleaving of standard DIMMs, and interleaving is never enabled across NVDIMM-Ns and standard DIMMs. NVDIMM-Ns installed on different processors are never interleaved together. If this option is changed, then all installed NVDIMM-Ns must be sanitized.

Defined values:

NvDimmNSanitizePolicy

JSONPath: /NvDimmNSanitizePolicy (PATCHable enumeration)

This option is used to sanitize/erase all user data and error status data saved in the selected NVDIMM-Ns. Selected NVDIMM-Ns are sanitized/erased on the next reboot. 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). The largest group of NVDIMM-Ns selected are sanitized/erased. For example, if ‘Sanitize/Erase all NVDIMM-N on Processor 1’ is Enabled and ‘Sanitize/Erase Processor 1 DIMM 8’ is Disabled, all NVDIMM-Ns on Processor 1 are sanitized/erased, including Processor 1 DIMM 8. Three policies control the action of the system after NVDIMM-Ns are sanitized/erased. The options are to power off the system after sanitizing/erasing NVDIMMs, to allow the system to boot to the operating system after sanitizing/erasing NVDIMMs, or to boot to the System Utilities after sanitizing/erasing NVDIMMs.

Defined values:

OldAdminPassword

JSONPath: /OldAdminPassword (PATCHable password)

In order to set a new Admin Password, the previous Admin Password must be specified.

OldPowerOnPassword

JSONPath: /OldPowerOnPassword (PATCHable password)

In order to set a new Power On Password, the previous Power On Password must be specified.

PciBusPadding

JSONPath: /PciBusPadding (PATCHable enumeration)

Use this option to disable the default PCI Bus setting where each expansion slot is provided with an extra PCI Bus number. By default, the System BIOS pads one PCI bus per expansion slot so that expansion cards with PCI-PCI bridges do not effect current bus numbering schemes. Disabling this option works around issues with certain expansion cards. It is recommended that you do not disable this option unless a specific issue is encountered.

Defined values:

PciSlot1Enable

JSONPath: /PciSlot1Enable (PATCHable enumeration)

Select this option to enable or disable PCI devices.

Defined values:

PciSlot2Enable

JSONPath: /PciSlot2Enable (PATCHable enumeration)

Select this option to enable or disable PCI devices.

Defined values:

PciSlot3Enable

JSONPath: /PciSlot3Enable (PATCHable enumeration)

Select this option to enable or disable PCI devices.

Defined values:

PciSlot4Enable

JSONPath: /PciSlot4Enable (PATCHable enumeration)

Select this option to enable or disable PCI devices.

Defined values:

PciSlot5Enable

JSONPath: /PciSlot5Enable (PATCHable enumeration)

Select this option to enable or disable PCI devices.

Defined values:

PciSlot6Enable

JSONPath: /PciSlot6Enable (PATCHable enumeration)

Select this option to enable or disable PCI devices.

Defined values:

PcieExpressEcrcSupport

JSONPath: /PcieExpressEcrcSupport (PATCHable enumeration)

Use this option to control the PCI Express End-to-End CRC (ECRC) policy for all installed PCIe Devices. When set to enabled, a PCI Express device that supports this option can take advantage of end-to-end CRC checking to increase the reliability of data transfers.

Defined values:

PostF1Prompt

JSONPath: /PostF1Prompt (PATCHable enumeration)

Use this option to configure the system to display the F1 key in 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.

Defined values:

PowerButton

JSONPath: /PowerButton (PATCHable enumeration)

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.

Defined values:

PowerOnDelay

JSONPath: /PowerOnDelay (PATCHable enumeration)

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 immediately turn on the server. This enables staggering when servers power-up after a power loss to prevent power usage spikes.

Defined values:

JSONPath: /PowerOnLogo (PATCHable enumeration)

Use this option to disable the display of the logo during system boot. This option does not affect system boot times.

Defined values:

PowerOnPassword

JSONPath: /PowerOnPassword (PATCHable password)

When the server powers on, a prompt is displayed to enter a password before continuing the boot process. In the event of an ASR reboot, the Power-On Password is bypassed and the server boots normally.

PowerProfile

JSONPath: /PowerProfile (PATCHable enumeration)

Defined values:

PowerRegulator

JSONPath: /PowerRegulator (PATCHable enumeration)

You can only configure this option if the Power Profile is set to Custom. Use this option to configure the following Power Regulator support: - Dynamic Power Savings Mode: Automatically varies processor speed and power usage based on processor utilization. Allows for the reduction of overall power consumption with little or no impact on performance. Does not require OS support. - Static Low Power Mode: Reduces processor speed and power usage. Guarantees a lower maximum power usage for the system. Performance impacts are greater for environments with higher processor utilization. - Static High Performance Mode: Processors run in their maximum power/performance state at all times regardless of the OS power management policy. - OS Control Mode: Processors run in their maximum power/performance state at all times unless the OS enables a power management policy.

Defined values:

PreBootNetwork

JSONPath: /PreBootNetwork (PATCHable enumeration)

Use this option to select the network interface used for pre-boot network connections. If the selected NIC has more than one port, only the first port with a network connection is used. When the selection is Auto, the system uses the first available port with a network connection.

Defined values:

ProcAes

JSONPath: /ProcAes (PATCHable enumeration)

Use this option to enable or disable the Advanced Encryption Standard Instruction Set (AES-NI) in the processor.

Defined values:

ProcCoreDisable

JSONPath: /ProcCoreDisable (PATCHable integer)

Use this option to disable processor cores using Intel’s Core Multi-Processing (CMP) Technology. This option disables a specific number of the cores on each physical processor, which can reduce processor power usage and can improve performance for some applications, such as those that benefit from higher performance cores rather than more processing cores. This option also addresses issues with software that is licensed on a per-core basis. Enter a value equal to the number of enabled cores per socket.

ProcHyperthreading

JSONPath: /ProcHyperthreading (PATCHable enumeration)

Use this option to enable or disable Intel Hyperthreading. When enabled, each physical processor core operates as two logical processor cores. When disabled, each physical processor core operates as only one logical processor core. Enabling this option can improve overall performance for applications that benefit from a higher processor core count.

Defined values:

ProcNoExecute

JSONPath: /ProcNoExecute (PATCHable enumeration)

Use this option to protect your system against malicious code and viruses. Memory is marked as non-executable unless the location contains executable code. Some viruses attempt to insert and execute code from non-executable memory locations. Attacks are intercepted and an exception is generated. Your operating system must support this option.

Certain operating systems (including Windows 2012 and Windows 2012 R2) require this option to be enabled and override this setting. See your operating system documentation for more details.

Defined values:

ProcTurbo

JSONPath: /ProcTurbo (PATCHable enumeration)

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.

Defined values:

ProcVirtualization

JSONPath: /ProcVirtualization (PATCHable enumeration)

When enabled, a hypervisor or operating system supporting this option can use hardware capabilities provided by Intel’s Virtualization Technology. Some hypervisors require that you enable Virtualization Technology. You can leave this set to enabled even if you are not using a hypervisor or an operating system that uses this option.

Defined values:

ProcX2Apic

JSONPath: /ProcX2Apic (PATCHable enumeration)

+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 do 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.

Defined values:

ProductId

JSONPath: /ProductId (PATCHable string)

Use this option to set the system product ID. This value must always match the product ID sticker located on the chassis.

QpiBandwidthOpt

JSONPath: /QpiBandwidthOpt (PATCHable enumeration)

The QPI link between two processors provides the best performance for most applications. The Balanced option provides the best performance for most applications and benchmarks. The optimized for I/O option can increase bandwidth from I/O devices, such as GPUs that rely on direct access to system memory. This option is only configurable if two or more CPUs are present.

Defined values:

QpiHomeSnoopOpt

JSONPath: /QpiHomeSnoopOpt (PATCHable enumeration)

This option allows the disabling of the Directory and Opportunistic Snoop Broadcast (OSB) functionality that is available when the QPI snoop mode is set to Home Snoop. Directory and OSB provides better memory latency and increased bandwidth and is recommended for the vast majority of workloads that benefit from Home Snoop.

Defined values:

QpiSnoopConfig

JSONPath: /QpiSnoopConfig (PATCHable enumeration)

Use this option to select the snoop mode used by the processor and QPI bus. Changing this option can have an impact on memory performance. The Home Snoop option provides high-memory bandwidth in an average NUMA environment. The Cluster on Die option can provide increased memory bandwidth in highly optimized NUMA workloads. The Early Snoop option can decrease memory latency, but can also result in lower overall bandwidth as compared to the other modes.

Defined values:

RedundantPowerSupply

JSONPath: /RedundantPowerSupply (PATCHable enumeration)

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.

Defined values:

RemovableFlashBootSeq

JSONPath: /RemovableFlashBootSeq (PATCHable enumeration)

When enumerating boot devices, use this option to select which USB or SD Card devices you want to search for first. 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.

Defined values:

RestoreDefaults

JSONPath: /RestoreDefaults (PATCHable enumeration)

Use this option to reset all configuration settings to their default values. Changes that have been made might be lost. You need to reboot the system for changes to take effect.

Defined values:

RestoreManufacturingDefaults

JSONPath: /RestoreManufacturingDefaults (PATCHable enumeration)

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 need to reboot the system for changes to take effect.

Defined values:

RomSelection

JSONPath: /RomSelection (PATCHable enumeration)

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.

Defined values:

SanitizeAllNvDimmN

JSONPath: /SanitizeAllNvDimmN (PATCHable enumeration)

When Enabled, all user data in ALL NVDIMM-Ns in the system is erased on the next reboot.

Defined values:

SanitizeProc1Dimm{DIMM Number} and SanitizeProc2Dimm{DIMM Number}

JSONPath: /SanitizeProc1Dimm1 (PATCHable enumeration) JSONPath: /SanitizeProc1Dimm2 (PATCHable enumeration) JSONPath: /SanitizeProc1Dimm3 (PATCHable enumeration) … JSONPath: /SanitizeProc2Dimm1 (PATCHable enumeration) JSONPath: /SanitizeProc2Dimm2 (PATCHable enumeration) JSONPath: /SanitizeProc2Dimm3 (PATCHable enumeration) …

When Enabled, all user data in the selected NVDIMM-N is erased on the next reboot.

Defined values:

SanitizeProc1NvDimmN

JSONPath: /SanitizeProc1NvDimmN (PATCHable enumeration)

When Enabled, all user data in NVDIMM-Ns installed on the selected processor is erased on the next reboot.

Defined values:

SanitizeProc2NvDimmN

JSONPath: /SanitizeProc2NvDimmN (PATCHable enumeration)

When Enabled, all user data in NVDIMM-Ns installed on the selected processor is erased on the next reboot.

Defined values:

SataSecureErase

JSONPath: /SataSecureErase (PATCHable enumeration)

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.

Defined values:

SaveUserDefaults

JSONPath: /SaveUserDefaults (PATCHable enumeration)

Select this option to save the current settings as the system defaults.

Defined values:

SecureBootStatus

JSONPath: /SecureBootStatus (read only enumeration)

The current state of Secure Boot configuration.

Defined values:

SerialConsoleBaudRate

JSONPath: /SerialConsoleBaudRate (PATCHable enumeration)

This is the transfer rate at which data is transmitted through the serial port.

Defined values:

SerialConsoleEmulation

JSONPath: /SerialConsoleEmulation (PATCHable enumeration)

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.

Defined values:

SerialConsolePort

JSONPath: /SerialConsolePort (PATCHable enumeration)

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.

Defined values:

SerialNumber

JSONPath: /SerialNumber (PATCHable string)

Use this option to set the system serial number. This value must always match the serial number sticker located on the chassis.

ServerAssetTag

JSONPath: /ServerAssetTag (PATCHable string)

Select this option to modify the Server Asset Tag text line.

ServerName

JSONPath: /ServerName (PATCHable string)

Select this option to modify the server name text line.

ServerOtherInfo

JSONPath: /ServerOtherInfo (PATCHable string)

Use this option to modify the Other Server text line.

ServerPrimaryOs

JSONPath: /ServerPrimaryOs (PATCHable string)

Use this option to modify the Server Primary OS text line.

ServiceEmail

JSONPath: /ServiceEmail (PATCHable string)

Enter the server service contact e-mail address.

ServiceName

JSONPath: /ServiceName (PATCHable string)

Enter the server service contact name text.

ServiceOtherInfo

JSONPath: /ServiceOtherInfo (PATCHable string)

Enter the other server service contact information text.

ServicePhone

JSONPath: /ServicePhone (PATCHable string)

Enter the server service contact phone number text.

Slot1NicBoot1

JSONPath: /Slot1NicBoot1 (PATCHable enumeration)

Use this option to enable/disable UEFI network boot for the selected NIC card.This option applies only for PXE Boot and iSCSI Software Initiator boot attempts in UEFI Boot Mode.

Defined values:

Slot1NicBoot2

JSONPath: /Slot1NicBoot2 (PATCHable enumeration)

Use this option to enable/disable UEFI network boot for the selected NIC card.This option applies only for PXE Boot and iSCSI Software Initiator boot attempts in UEFI Boot Mode.

Defined values:

Slot1NicBoot3

JSONPath: /Slot1NicBoot3 (PATCHable enumeration)

Use this option to enable/disable UEFI network boot for the selected NIC card.This option applies only for PXE Boot and iSCSI Software Initiator boot attempts in UEFI Boot Mode.

Defined values:

Slot1NicBoot4

JSONPath: /Slot1NicBoot4 (PATCHable enumeration)

Use this option to enable/disable UEFI network boot for the selected NIC card.This option applies only for PXE Boot and iSCSI Software Initiator boot attempts in UEFI Boot Mode.

Defined values:

Slot1NicBoot5

JSONPath: /Slot1NicBoot5 (PATCHable enumeration)

Use this option to enable/disable UEFI network boot for the selected NIC card.This option applies only for PXE Boot and iSCSI Software Initiator boot attempts in UEFI Boot Mode.

Defined values:

Slot1NicBoot6

JSONPath: /Slot1NicBoot6 (PATCHable enumeration)

Use this option to enable/disable UEFI network boot for the selected NIC card.This option applies only for PXE Boot and iSCSI Software Initiator boot attempts in UEFI Boot Mode.

Defined values:

Slot1NicBoot7

JSONPath: /Slot1NicBoot7 (PATCHable enumeration)

Use this option to enable/disable UEFI network boot for the selected NIC card.This option applies only for PXE Boot and iSCSI Software Initiator boot attempts in UEFI Boot Mode.

Defined values:

Slot1NicBoot8

JSONPath: /Slot1NicBoot8 (PATCHable enumeration)

Use this option to enable/disable UEFI network boot for the selected NIC card.This option applies only for PXE Boot and iSCSI Software Initiator boot attempts in UEFI Boot Mode.

Defined values:

Slot1StorageBoot

JSONPath: /Slot1StorageBoot (PATCHable enumeration)

When Boot All Targets is selected, the UEFI BIOS will allow all valid boot targets attached to the storage controller to be made available in the UEFI Boot Order List. If Boot No Targets is selected, no boot targets from this storage controller will be made available in the UEFI Boot Order.If Boot Limit to 3 Targets is selected, 3 boot targets attached to the storage controller will be made available in the UEFI Boot Order.

Defined values:

Slot2NicBoot1

JSONPath: /Slot2NicBoot1 (PATCHable enumeration)

Use this option to enable/disable UEFI network boot for the selected NIC card.This option applies only for PXE Boot and iSCSI Software Initiator boot attempts in UEFI Boot Mode.

Defined values:

Slot2NicBoot2

JSONPath: /Slot2NicBoot2 (PATCHable enumeration)

Use this option to enable/disable UEFI network boot for the selected NIC card.This option applies only for PXE Boot and iSCSI Software Initiator boot attempts in UEFI Boot Mode.

Defined values:

Slot2NicBoot3

JSONPath: /Slot2NicBoot3 (PATCHable enumeration)

Use this option to enable/disable UEFI network boot for the selected NIC card.This option applies only for PXE Boot and iSCSI Software Initiator boot attempts in UEFI Boot Mode.

Defined values:

Slot2NicBoot4

JSONPath: /Slot2NicBoot4 (PATCHable enumeration)

Use this option to enable/disable UEFI network boot for the selected NIC card.This option applies only for PXE Boot and iSCSI Software Initiator boot attempts in UEFI Boot Mode.

Defined values:

Slot2NicBoot5

JSONPath: /Slot2NicBoot5 (PATCHable enumeration)

Use this option to enable/disable UEFI network boot for the selected NIC card.This option applies only for PXE Boot and iSCSI Software Initiator boot attempts in UEFI Boot Mode.

Defined values:

Slot2NicBoot6

JSONPath: /Slot2NicBoot6 (PATCHable enumeration)

Use this option to enable/disable UEFI network boot for the selected NIC card.This option applies only for PXE Boot and iSCSI Software Initiator boot attempts in UEFI Boot Mode.

Defined values:

Slot2NicBoot7

JSONPath: /Slot2NicBoot7 (PATCHable enumeration)

Use this option to enable/disable UEFI network boot for the selected NIC card.This option applies only for PXE Boot and iSCSI Software Initiator boot attempts in UEFI Boot Mode.

Defined values:

Slot2NicBoot8

JSONPath: /Slot2NicBoot8 (PATCHable enumeration)

Use this option to enable/disable UEFI network boot for the selected NIC card.This option applies only for PXE Boot and iSCSI Software Initiator boot attempts in UEFI Boot Mode.

Defined values:

Slot2StorageBoot

JSONPath: /Slot2StorageBoot (PATCHable enumeration)

When Boot All Targets is selected, the UEFI BIOS will allow all valid boot targets attached to the storage controller to be made available in the UEFI Boot Order List. If Boot No Targets is selected, no boot targets from this storage controller will be made available in the UEFI Boot Order.If Boot Limit to 3 Targets is selected, 3 boot targets attached to the storage controller will be made available in the UEFI Boot Order.

Defined values:

Slot3NicBoot1

JSONPath: /Slot3NicBoot1 (PATCHable enumeration)

Use this option to enable/disable UEFI network boot for the selected NIC card.This option applies only for PXE Boot and iSCSI Software Initiator boot attempts in UEFI Boot Mode.

Defined values:

Slot3NicBoot2

JSONPath: /Slot3NicBoot2 (PATCHable enumeration)

Use this option to enable/disable UEFI network boot for the selected NIC card.This option applies only for PXE Boot and iSCSI Software Initiator boot attempts in UEFI Boot Mode.

Defined values:

Slot3NicBoot3

JSONPath: /Slot3NicBoot3 (PATCHable enumeration)

Use this option to enable/disable UEFI network boot for the selected NIC card.This option applies only for PXE Boot and iSCSI Software Initiator boot attempts in UEFI Boot Mode.

Defined values:

Slot3NicBoot4

JSONPath: /Slot3NicBoot4 (PATCHable enumeration)

Use this option to enable/disable UEFI network boot for the selected NIC card.This option applies only for PXE Boot and iSCSI Software Initiator boot attempts in UEFI Boot Mode.

Defined values:

Slot3NicBoot5

JSONPath: /Slot3NicBoot5 (PATCHable enumeration)

Use this option to enable/disable UEFI network boot for the selected NIC card.This option applies only for PXE Boot and iSCSI Software Initiator boot attempts in UEFI Boot Mode.

Defined values:

Slot3NicBoot6

JSONPath: /Slot3NicBoot6 (PATCHable enumeration)

Use this option to enable/disable UEFI network boot for the selected NIC card.This option applies only for PXE Boot and iSCSI Software Initiator boot attempts in UEFI Boot Mode.

Defined values:

Slot3NicBoot7

JSONPath: /Slot3NicBoot7 (PATCHable enumeration)

Use this option to enable/disable UEFI network boot for the selected NIC card.This option applies only for PXE Boot and iSCSI Software Initiator boot attempts in UEFI Boot Mode.

Defined values:

Slot3NicBoot8

JSONPath: /Slot3NicBoot8 (PATCHable enumeration)

Use this option to enable/disable UEFI network boot for the selected NIC card.This option applies only for PXE Boot and iSCSI Software Initiator boot attempts in UEFI Boot Mode.

Defined values:

Slot3StorageBoot

JSONPath: /Slot3StorageBoot (PATCHable enumeration)

When Boot All Targets is selected, the UEFI BIOS will allow all valid boot targets attached to the storage controller to be made available in the UEFI Boot Order List. If Boot No Targets is selected, no boot targets from this storage controller will be made available in the UEFI Boot Order.If Boot Limit to 3 Targets is selected, 3 boot targets attached to the storage controller will be made available in the UEFI Boot Order.

Defined values:

Slot4NicBoot1

JSONPath: /Slot4NicBoot1 (PATCHable enumeration)

Use this option to enable/disable UEFI network boot for the selected NIC card.This option applies only for PXE Boot and iSCSI Software Initiator boot attempts in UEFI Boot Mode.

Defined values:

Slot4NicBoot2

JSONPath: /Slot4NicBoot2 (PATCHable enumeration)

Use this option to enable/disable UEFI network boot for the selected NIC card.This option applies only for PXE Boot and iSCSI Software Initiator boot attempts in UEFI Boot Mode.

Defined values:

Slot4NicBoot3

JSONPath: /Slot4NicBoot3 (PATCHable enumeration)

Use this option to enable/disable UEFI network boot for the selected NIC card.This option applies only for PXE Boot and iSCSI Software Initiator boot attempts in UEFI Boot Mode.

Defined values:

Slot4NicBoot4

JSONPath: /Slot4NicBoot4 (PATCHable enumeration)

Use this option to enable/disable UEFI network boot for the selected NIC card.This option applies only for PXE Boot and iSCSI Software Initiator boot attempts in UEFI Boot Mode.

Defined values:

Slot4NicBoot5

JSONPath: /Slot4NicBoot5 (PATCHable enumeration)

Use this option to enable/disable UEFI network boot for the selected NIC card.This option applies only for PXE Boot and iSCSI Software Initiator boot attempts in UEFI Boot Mode.

Defined values:

Slot4NicBoot6

JSONPath: /Slot4NicBoot6 (PATCHable enumeration)

Use this option to enable/disable UEFI network boot for the selected NIC card.This option applies only for PXE Boot and iSCSI Software Initiator boot attempts in UEFI Boot Mode.

Defined values:

Slot4NicBoot7

JSONPath: /Slot4NicBoot7 (PATCHable enumeration)

Use this option to enable/disable UEFI network boot for the selected NIC card.This option applies only for PXE Boot and iSCSI Software Initiator boot attempts in UEFI Boot Mode.

Defined values:

Slot4NicBoot8

JSONPath: /Slot4NicBoot8 (PATCHable enumeration)

Use this option to enable/disable UEFI network boot for the selected NIC card.This option applies only for PXE Boot and iSCSI Software Initiator boot attempts in UEFI Boot Mode.

Defined values:

Slot4StorageBoot

JSONPath: /Slot4StorageBoot (PATCHable enumeration)

When Boot All Targets is selected, the UEFI BIOS will allow all valid boot targets attached to the storage controller to be made available in the UEFI Boot Order List. If Boot No Targets is selected, no boot targets from this storage controller will be made available in the UEFI Boot Order.If Boot Limit to 3 Targets is selected, 3 boot targets attached to the storage controller will be made available in the UEFI Boot Order.

Defined values:

Slot5NicBoot1

JSONPath: /Slot5NicBoot1 (PATCHable enumeration)

Use this option to enable/disable UEFI network boot for the selected NIC card.This option applies only for PXE Boot and iSCSI Software Initiator boot attempts in UEFI Boot Mode.

Defined values:

Slot5NicBoot2

JSONPath: /Slot5NicBoot2 (PATCHable enumeration)

Use this option to enable/disable UEFI network boot for the selected NIC card.This option applies only for PXE Boot and iSCSI Software Initiator boot attempts in UEFI Boot Mode.

Defined values:

Slot5NicBoot3

JSONPath: /Slot5NicBoot3 (PATCHable enumeration)

Use this option to enable/disable UEFI network boot for the selected NIC card.This option applies only for PXE Boot and iSCSI Software Initiator boot attempts in UEFI Boot Mode.

Defined values:

Slot5NicBoot4

JSONPath: /Slot5NicBoot4 (PATCHable enumeration)

Use this option to enable/disable UEFI network boot for the selected NIC card.This option applies only for PXE Boot and iSCSI Software Initiator boot attempts in UEFI Boot Mode.

Defined values:

Slot5NicBoot5

JSONPath: /Slot5NicBoot5 (PATCHable enumeration)

Use this option to enable/disable UEFI network boot for the selected NIC card.This option applies only for PXE Boot and iSCSI Software Initiator boot attempts in UEFI Boot Mode.

Defined values:

Slot5NicBoot6

JSONPath: /Slot5NicBoot6 (PATCHable enumeration)

Use this option to enable/disable UEFI network boot for the selected NIC card.This option applies only for PXE Boot and iSCSI Software Initiator boot attempts in UEFI Boot Mode.

Defined values:

Slot5NicBoot7

JSONPath: /Slot5NicBoot7 (PATCHable enumeration)

Use this option to enable/disable UEFI network boot for the selected NIC card.This option applies only for PXE Boot and iSCSI Software Initiator boot attempts in UEFI Boot Mode.

Defined values:

Slot5NicBoot8

JSONPath: /Slot5NicBoot8 (PATCHable enumeration)

Use this option to enable/disable UEFI network boot for the selected NIC card.This option applies only for PXE Boot and iSCSI Software Initiator boot attempts in UEFI Boot Mode.

Defined values:

Slot5StorageBoot

JSONPath: /Slot5StorageBoot (PATCHable enumeration)

When Boot All Targets is selected, the UEFI BIOS will allow all valid boot targets attached to the storage controller to be made available in the UEFI Boot Order List. If Boot No Targets is selected, no boot targets from this storage controller will be made available in the UEFI Boot Order.If Boot Limit to 3 Targets is selected, 3 boot targets attached to the storage controller will be made available in the UEFI Boot Order.

Defined values:

Slot6NicBoot1

JSONPath: /Slot6NicBoot1 (PATCHable enumeration)

Use this option to enable/disable UEFI network boot for the selected NIC card.This option applies only for PXE Boot and iSCSI Software Initiator boot attempts in UEFI Boot Mode.

Defined values:

Slot6NicBoot2

JSONPath: /Slot6NicBoot2 (PATCHable enumeration)

Use this option to enable/disable UEFI network boot for the selected NIC card.This option applies only for PXE Boot and iSCSI Software Initiator boot attempts in UEFI Boot Mode.

Defined values:

Slot6NicBoot3

JSONPath: /Slot6NicBoot3 (PATCHable enumeration)

Use this option to enable/disable UEFI network boot for the selected NIC card.This option applies only for PXE Boot and iSCSI Software Initiator boot attempts in UEFI Boot Mode.

Defined values:

Slot6NicBoot4

JSONPath: /Slot6NicBoot4 (PATCHable enumeration)

Use this option to enable/disable UEFI network boot for the selected NIC card.This option applies only for PXE Boot and iSCSI Software Initiator boot attempts in UEFI Boot Mode.

Defined values:

Slot6NicBoot5

JSONPath: /Slot6NicBoot5 (PATCHable enumeration)

Use this option to enable/disable UEFI network boot for the selected NIC card.This option applies only for PXE Boot and iSCSI Software Initiator boot attempts in UEFI Boot Mode.

Defined values:

Slot6NicBoot6

JSONPath: /Slot6NicBoot6 (PATCHable enumeration)

Use this option to enable/disable UEFI network boot for the selected NIC card.This option applies only for PXE Boot and iSCSI Software Initiator boot attempts in UEFI Boot Mode.

Defined values:

Slot6NicBoot7

JSONPath: /Slot6NicBoot7 (PATCHable enumeration)

Use this option to enable/disable UEFI network boot for the selected NIC card.This option applies only for PXE Boot and iSCSI Software Initiator boot attempts in UEFI Boot Mode.

Defined values:

Slot6NicBoot8

JSONPath: /Slot6NicBoot8 (PATCHable enumeration)

Use this option to enable/disable UEFI network boot for the selected NIC card.This option applies only for PXE Boot and iSCSI Software Initiator boot attempts in UEFI Boot Mode.

Defined values:

Slot6StorageBoot

JSONPath: /Slot6StorageBoot (PATCHable enumeration)

When Boot All Targets is selected, the UEFI BIOS will allow all valid boot targets attached to the storage controller to be made available in the UEFI Boot Order List. If Boot No Targets is selected, no boot targets from this storage controller will be made available in the UEFI Boot Order.If Boot Limit to 3 Targets is selected, 3 boot targets attached to the storage controller will be made available in the UEFI Boot Order.

Defined values:

Sriov

JSONPath: /Sriov (PATCHable enumeration)

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.

Defined values:

ThermalConfig

JSONPath: /ThermalConfig (PATCHable enumeration)

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

Defined values:

ThermalShutdown

JSONPath: /ThermalShutdown (PATCHable enumeration)

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.

Defined values:

TimeFormat

JSONPath: /TimeFormat (PATCHable enumeration)

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.

Defined values:

TimeZone

JSONPath: /TimeZone (PATCHable enumeration)

This option displays the current time zone setting for the system.

Defined values:

TmOperation

JSONPath: /TmOperation (PATCHable enumeration)

Use this option to enable the Trusted Module ™ and BIOS secure startup. When enabled, the TM is fully functional. When disabled, the TM is visible; however, functionality is limited. This option also enables you to reset the TM to factory settings, which clears any assigned passwords, keys, or ownership data. Clearing the TM can prevent the server from booting to a TM-aware operating system if the operating system uses TM’s measurements.

Defined values:

TmVisibility

JSONPath: /TmVisibility (PATCHable enumeration)

Use this option to hide the Trusted Module ™ from the operating system. When the TM is hidden, BIOS secure startup is disabled, and the TM does not respond to any commands. Intended use is for removing the TM option from the system without removing the actual hardware.

Defined values:

Tpm2Operation

JSONPath: /Tpm2Operation (PATCHable enumeration)

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 supported only in UEFI Boot Mode.

Defined values:

Tpm2Ppi

JSONPath: /Tpm2Ppi (PATCHable enumeration)

Use this option to control Physical Presence Interface for TPM 2.0 operation. This option is used to control whether the user is prompted during the next boot after a TPM 2.0 operation request was initiated by the Operating System. When TPM 2.0 Physical Presence Confirmation is Enabled, the system will prompt for confirmation during POST. When TPM 2.0 Physical Presence Confirmation is Disabled, the system will not prompt for confirmation during POST.

Defined values:

Tpm2Visibility

JSONPath: /Tpm2Visibility (PATCHable enumeration)

Use this option to hide 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. TPM 2.0 is only supported in UEFI boot mode.

Defined values:

TpmBinding

JSONPath: /TpmBinding (PATCHable enumeration)

Use this option to bind the TPM module to the system board by using a value that is unique to each server board. This option ensures that the TPM measurement in PCR[0] is unique for every server regardless of hardware and firmware configuration.

Defined values:

TpmOperation

JSONPath: /TpmOperation (PATCHable enumeration)

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.

Defined values:

TpmState

JSONPath: /TpmState (read only enumeration)

Current TPM device state: Not Present; Present and Disabled; Present and Enabled.

Defined values:

TpmType

JSONPath: /TpmType (read only enumeration)

Current TPM device type.

Defined values:

TpmUefiOpromMeasuring

JSONPath: /TpmUefiOpromMeasuring (PATCHable enumeration)

Use this option to enable measuring the UEFI PCI option ROMs. Disabling this option skips measuring the UEFI PCI option ROMs.

Defined values:

TpmVisibility

JSONPath: /TpmVisibility (PATCHable enumeration)

Use this option to hide 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.

Defined values:

UefiOptimizedBoot

JSONPath: /UefiOptimizedBoot (PATCHable enumeration)

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. Set this option to disabled for compatibility with Microsoft Windows 2008 and Windows 2008 R2 operating systems on a system configured for UEFI Boot Mode. Set this option to enabled for compatibility with VMWare ESXi operating systems on a system configured for UEFI Boot Mode.

Defined values:

UefiPxeBoot

JSONPath: /UefiPxeBoot (PATCHable enumeration)

Use this option to control the ordering of network boot targets in the UEFI Boot Order list. If configured for Auto, 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 ROM. If configured for IPv4 then IPv6, the UEFI Boot Order is modified to list all existing IPv4 targets before any existing IPv6 targets. New network boot targets will have IPv4 targets added before IPv6 targets. If configured for IPv6 then IPv4, the UEFI Boot Order is modified to list all existing IPv6 targets before any existing IPv4 targets. If configured for 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 existing IPv4 network boot targets in the UEFI Boot Order are removed. No new IPv4 network boot targets are added to the list. When modifying these settings, changes to the UEFI Boot Order are not reflected until you reboot the system. You can configure this option only when Boot Mode is set to UEFI.

Defined values:

UefiShellBootOrder

JSONPath: /UefiShellBootOrder (PATCHable enumeration)

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 as UEFI, and the Embedded UEFI Shell is enabled.

Defined values:

UefiShellStartup

JSONPath: /UefiShellStartup (PATCHable enumeration)

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. The script file must be named “startup.nsh” and must be placed on local media or a network location accessible to the server.

Defined values:

UefiShellStartupLocation

JSONPath: /UefiShellStartupLocation (PATCHable enumeration)

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 or FTP location accessible to the server. When you select the ‘Auto’ option, the system attempts to retrieve the startup script from the network location first, followed by locally attached media.

Defined values:

UefiShellStartupUrl

JSONPath: /UefiShellStartupUrl (PATCHable string)

Use this option to configure a network URL to a UEFI Shell startup script. URLs in HTTP or FTP formats are accepted using either an IPv4 server address or host name. For example, this can be http://192.168.0.0/file/file.nsh or http://example.com/file/file.nsh. IPv6 server addresses are not supported. 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.

UrlBootFile

JSONPath: /UrlBootFile (PATCHable string)

Use this option to configure a network URL to a bootable ISO or EFI file. URLs in HTTP or FTP formats are accepted using either an IPv4 server address or host name. For example, this can be http://192.168.0.0/file/image.iso or http://example.com/file/image.efi. IPv6 server addresses are not supported. When configured, this URL is listed as a boot option in the UEFI boot menu. Selecting the boot option downloads the file to the system memory and attempts booting from it. This setting requires configuring the pre-boot network settings to access the URL location. It is supported only in UEFI boot mode. Note: Booting from an ISO file is limited to files that enable the system to boot a preliminary OS environment (such as WinPE or a mini Linux) where further installation can proceed over an OS network connection. ISO files that contain the full OS installation media are not supported.

Usb3Mode

JSONPath: /Usb3Mode (PATCHable enumeration)

Use this option to configure the operating mode of the USB 3.0 ports. If set to Auto Mode, USB 3.0 capable devices operate at USB 2.0 speeds in the pre-boot environment and during boot. When a USB 3.0 capable OS USB driver loads, USB 3.0 devices transition to USB 3.0 speeds. This mode provides compatibility with operating systems that do not support USB 3.0, while enabling USB 3.0 devices to operate at USB 3.0 speeds with current operating systems. If enabled, USB 3.0 capable devices operate at USB 3.0 speeds at all times (including the pre-boot environment) when in UEFI Boot Mode. Do not use this mode with operating systems that do not support USB 3.0. If operating in Legacy Boot Mode, the USB 3.0 ports do not function in the pre-boot environment, and are not bootable. If set to disabled, USB 3.0 capable devices function at USB 2.0 speeds at all times.

Defined values:

UsbBoot

JSONPath: /UsbBoot (PATCHable enumeration)

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

Defined values:

UsbControl

JSONPath: /UsbControl (PATCHable enumeration)

USB Enabled: Enables all USB ports and embedded devices. External USB Ports Disabled: Disables only external USB ports.

Defined values:

UtilityLang

JSONPath: /UtilityLang (PATCHable enumeration)

Select this option to adjust the current language for the system.

Defined values:

VideoOptions

JSONPath: /VideoOptions (PATCHable enumeration)

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.

Defined values:

VirtualInstallDisk

JSONPath: /VirtualInstallDisk (PATCHable enumeration)

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.

Defined values:

VirtualSerialPort

JSONPath: /VirtualSerialPort (PATCHable enumeration)

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.

Defined values:

VlanControl

JSONPath: /VlanControl (PATCHable enumeration)

Use this option to enable or disable VLAN tagging on all enabled network interfaces.

Defined values:

VlanId

JSONPath: /VlanId (PATCHable integer)

Use this option to set the global VLAN ID for all enabled network interfaces. Possible values are 0 to 4094.A value of 0 indicates that the device will send untagged frames.

VlanPriority

JSONPath: /VlanPriority (PATCHable integer)

Use this option to set the priority for the VLAN tagged frames. Possible values are 0 to 7.

WakeOnLan

JSONPath: /WakeOnLan (PATCHable enumeration)

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.

Defined values:

HpBiosMapping

Properties

Resource Instances of this Type:

  • https://{iLO}/redfish/v1/systems/{item}/bios/mappings

AttributeRegistry

JSONPath: /AttributeRegistry (read only string)

This object represents the type property. It represents the schema used for the resource and indicates the version of the schema in the format ....

BiosPciSettingsMappings[array-item].CorrelatableID

JSONPath: /BiosPciSettingsMappings/(array index)/CorrelatableID (read only string)

Contains any CorrelatableIDs that represent this PCI device. The CorrelatableID values can be JSON Pointers or UEFI identifiers.

BiosPciSettingsMappings[array-item].Instance

JSONPath: /BiosPciSettingsMappings/(array index)/Instance (read only integer)

The instance number of the parent PCI device for this association set.

BiosPciSettingsMappings[array-item].Subinstances[array-item].CorrelatableID

JSONPath: /BiosPciSettingsMappings/(array index)/Subinstances/(array index)/CorrelatableID (read only string)

Contains any CorrelatableIDs that represent this PCI device. The CorrelatableID values can be JSON Pointers or UEFI identifiers.

BiosPciSettingsMappings[array-item].Subinstances[array-item].Subinstance

JSONPath: /BiosPciSettingsMappings/(array index)/Subinstances/(array index)/Subinstance (read only integer)

The sub-instance number of the child PCI device for this association set.

HpESKM

ESKM (Enterprise Security Key Manager) object enables user to connect to an operational key manager, change redundancy settings, view the key manager connection settings, test the connection, and view key management events.

Properties

Resource Instances of this Type:

  • https://{iLO}/redfish/v1/managers/{item}/securityservice/eskm

ESKMEvents[array-item].Event

JSONPath: /ESKMEvents/(array index)/Event (read only string)

ESKM event description.

ESKMEvents[array-item].Timestamp

JSONPath: /ESKMEvents/(array index)/Timestamp (read only string)

Time of ESKM event.

KeyManagerConfig.AccountGroup

JSONPath: /KeyManagerConfig/AccountGroup (PATCHable string)

Account group on ESKM.

example PATCH: {“KeyManagerConfig”: {“AccountGroup”: “<string-value>”}}

KeyManagerConfig.AccountName

JSONPath: /KeyManagerConfig/AccountName (read only string)

Account name on ESKM.

KeyManagerConfig.ESKMLocalCACertificateName

JSONPath: /KeyManagerConfig/ESKMLocalCACertificateName (PATCHable string)

This is the name of Local CA (Certificate Authority) in ESKM that is used to sign the ESKM server certificate. iLO will retrieve this certificate from the ESKM server.

example PATCH: {“KeyManagerConfig”: {“ESKMLocalCACertificateName”: “<string-value>”}}

KeyManagerConfig.ImportedCertificateIssuer

JSONPath: /KeyManagerConfig/ImportedCertificateIssuer (read only string)

Imported certificate issuer.

KeyManagerConfig.ImportedCertificateSubject

JSONPath: /KeyManagerConfig/ImportedCertificateSubject (read only string)

Imported certificate subject.

KeyManagerConfig.LoginName

JSONPath: /KeyManagerConfig/LoginName (PATCHable string)

ESKM administrator account login name. This property always returns null on GET.

example PATCH: {“KeyManagerConfig”: {“LoginName”: “<string-value>”}}

KeyManagerConfig.Password

JSONPath: /KeyManagerConfig/Password (PATCHable string)

ESKM administrator account password. This property always returns null on GET.

example PATCH: {“KeyManagerConfig”: {“Password”: “<string-value>”}}

KeyServerRedundancyReq

JSONPath: /KeyServerRedundancyReq (PATCHable boolean)

If true encryption keys will be maintained on both the configured key servers. When this option is disabled, iLO will not verify that encryption keys are copied to both of the configured key servers.

example PATCH: {“KeyServerRedundancyReq”: true}

PrimaryKeyServerAddress

JSONPath: /PrimaryKeyServerAddress (PATCHable string)

Primary key server IP address or FQDN. Set to null to clear the value.

example PATCH: {“PrimaryKeyServerAddress”: “<string-value>”}

PrimaryKeyServerPort

JSONPath: /PrimaryKeyServerPort (PATCHable integer)

Primary key server port number. Set to null to clear the value.

example PATCH: {“PrimaryKeyServerPort”: <integer-value>}

SecondaryKeyServerAddress

JSONPath: /SecondaryKeyServerAddress (PATCHable string)

Secondary key server IP address or FQDN. Set to null to clear the value.

example PATCH: {“SecondaryKeyServerAddress”: “<string-value>”}

SecondaryKeyServerPort

JSONPath: /SecondaryKeyServerPort (PATCHable integer)

Secondary key server port number. Set to null to clear the value.

example PATCH: {“SecondaryKeyServerPort”: <integer-value>}

POST Action “TestESKMConnections”

Test Enterprise Storage Key Manager connections.

example “TestESKMConnections” action:

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

{}

POST Action “ClearESKMLog”

Clears the Enterprise Storage Key Manager log.

example “ClearESKMLog” action:

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

{}

HpHttpsCert

This is the schema definition for the X509 Certificate.

Properties

Resource Instances of this Type:

  • https://{iLO}/redfish/v1/managers/{item}/securityservice/httpscert

CertificateSigningRequest

JSONPath: /CertificateSigningRequest (read only string)

GenerateCSR action, wait few minutes (upto 10), perform GET operation, fills CSR. Contains a public and private key pair.

X509CertificateInformation.Issuer

JSONPath: /X509CertificateInformation/Issuer (read only string)

The Certificate Authority that issued the certificate.

X509CertificateInformation.SerialNumber

JSONPath: /X509CertificateInformation/SerialNumber (read only string)

The serial number that the Certificate Authority assigned to the certificate.

X509CertificateInformation.Subject

JSONPath: /X509CertificateInformation/Subject (read only string)

The entity to which the certificate was issued.

X509CertificateInformation.ValidNotAfter

JSONPath: /X509CertificateInformation/ValidNotAfter (read only string)

The date on which the certificate validity period ends.

X509CertificateInformation.ValidNotBefore

JSONPath: /X509CertificateInformation/ValidNotBefore (read only string)

The date on which the certificate validity period begins.

POST Action “GenerateCSR”

Causes iLO 4 to begin creation of a new certificate signing request. The action will return a GeneratingCertificate message while this process is underway. The process may take up to ten minutes. Upon completion, the new request is available upon GET to this same resource in the “CertificateSigningRequest” property.

Parameters:

“Country” (string)

“State” (string)

“City” (string)

“OrgName” (string)

“OrgUnit” (string)

“CommonName” (string)

example “GenerateCSR” action:

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

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

POST Action “ImportCertificate”

Imports a Trusted Certificate and iLO 4 is reset.

Parameters:

“Certificate” (The certificate as a base-64 string)

example “ImportCertificate” action:

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

{
    "Certificate": "<base-64 string>"
}

HpMemory

The schema definition for the properties of Memory DIMMs.

Properties

Resource Instances of this Type:

  • https://{iLO}/redfish/v1/systems/{item}/memory/{item}

AssetTag

JSONPath: /AssetTag (read only string)

The asset tag for this memory device.

BankLocator

JSONPath: /BankLocator (read only string)

Identifies the physically labeled bank, where the memory device is located.

DIMMStatus

JSONPath: /DIMMStatus (read only enumeration)

Specifies memory module status and whether the module in use.

Defined values:

DIMMTechnology

JSONPath: /DIMMTechnology (read only enumeration)

The memory module technology type.

Defined values:

DIMMType

JSONPath: /DIMMType (read only enumeration)

The type of memory DIMM used in this system.

Defined values:

DataWidth

JSONPath: /DataWidth (read only integer)

The data width, in bits, of this memory device. A Data Width value of 0 and a Total Width value of 8 indicates that the device is being used solely to provide 8 error-correction bits. If the width is unknown, the field is set to null.

ErrorCorrection

JSONPath: /ErrorCorrection (read only enumeration)

The error correction used for this DIMM. If the value is null, the error correction is unknown.

Defined values:

HPMemoryType

JSONPath: /HPMemoryType (read only enumeration)

Indicates whether or not HP SmartMemory is present.

Defined values:

Manufacturer

JSONPath: /Manufacturer (read only string)

Identifies the manufacturer of this memory device.

MaximumFrequencyMHz

JSONPath: /MaximumFrequencyMHz (read only integer)

Identifies the maximum, capable speed of the device in megahertz (MHz). If the value is null, the speed is unknown.

MinimumVoltageVoltsX10

JSONPath: /MinimumVoltageVoltsX10 (read only integer)

The minimum DIMM voltage multiplied by 10, for example, 1.2v = 12.

PartNumber

JSONPath: /PartNumber (read only string)

The part number for this memory device.

Rank

JSONPath: /Rank (read only integer)

Specifies the DIMM rank. A value of null indicates the rank is unknown.

SerialNumber

JSONPath: /SerialNumber (read only string)

The serial number for this memory device.

SizeMB

JSONPath: /SizeMB (read only integer)

The size of the memory device in megabytes.

SocketLocator

JSONPath: /SocketLocator (read only string)

Identifies the physically labeled socket or board position, where the memory device is located.

Status.Health

JSONPath: /Status/Health (read only enumeration)

This represents the health state of this resource in the absence of its dependent resources.

Defined values:

Status.HealthRollUp

JSONPath: /Status/HealthRollUp (read only enumeration)

This represents the overall health state from the view of this resource.

Defined values:

Status.HealthRollup

JSONPath: /Status/HealthRollup (read only enumeration)

This represents the overall health state from the view of this resource.

Defined values:

Status.State

JSONPath: /Status/State (read only enumeration)

This indicates the known state of the resource, such as if it is enabled.

Defined values:

TotalWidth

JSONPath: /TotalWidth (read only integer)

The total width, in bits, of this memory device, including any check or error-correction bits. If there are no error-correction bits, this value should be equal to Data Width. If the width is unknown, the field is set to null.

HpSecureBoot

Properties

Resource Instances of this Type:

  • https://{iLO}/redfish/v1/systems/{item}/secureboot

ResetAllKeys

JSONPath: /ResetAllKeys (PATCHable boolean)

If true, clear all Secure Boot keys on next boot.

example PATCH: {“ResetAllKeys”: true}

ResetToDefaultKeys

JSONPath: /ResetToDefaultKeys (PATCHable boolean)

If true, reset to default Secure Boot keys on next boot.

example PATCH: {“ResetToDefaultKeys”: true}

SecureBootCurrentState

JSONPath: /SecureBootCurrentState (read only boolean)

Current enabled state of Secure Boot

SecureBootEnable

JSONPath: /SecureBootEnable (PATCHable boolean)

Enable or disable UEFI Secure Boot (takes effect on next boot).

example PATCH: {“SecureBootEnable”: true}

HpSecurityService

Properties

Resource Instances of this Type:

  • https://{iLO}/redfish/v1/managers/{item}/securityservice

HpServerBootSettings

The schema definition of the server UEFI Boot Order resource.

Properties

Resource Instances of this Type:

  • https://{iLO}/redfish/v1/systems/{item}/bios/boot

  • https://{iLO}/redfish/v1/systems/{item}/bios/boot/settings

AttributeRegistry

JSONPath: /AttributeRegistry (read only string)

This object represents the type property. It represents the schema used for the resource and indicates the version of the schema in the format ....

BootSources[array-item].BootString

JSONPath: /BootSources/(array index)/BootString (PATCHable string)

User-readable string that describes the UEFI boot option.

BootSources[array-item].CorrelatableID

JSONPath: /BootSources/(array index)/CorrelatableID (PATCHable string)

Contains any CorrelatableIDs that represent this boot option. The correlatableID values can be JSON Pointers or UEFI identifiers.

BootSources[array-item].StructuredBootString

JSONPath: /BootSources/(array index)/StructuredBootString (PATCHable string)

Uniquely identifies this boot option within the server.

BootSources[array-item].UEFIDevicePath

JSONPath: /BootSources/(array index)/UEFIDevicePath (PATCHable string)

Standardized text representation of the UEFI device path for this boot option, in UTF-8 format.

DesiredBootDevices[array-item].CorrelatableID

JSONPath: /DesiredBootDevices/(array index)/CorrelatableID (PATCHable string)

Standardized text representation of the UEFI device path of the desired boot device, in UTF-8 format. For example ‘PciRoot(0x0)/Pci(0x2,0x2)/Pci(0x0,0x0)’

example PATCH: {“DesiredBootDevices”: [{“CorrelatableID”: “<string-value>”}|null, …]}

DesiredBootDevices[array-item].Lun

JSONPath: /DesiredBootDevices/(array index)/Lun (PATCHable string)

The Logical Unit Number (LUN) of the desired boot device. This value must be a hexadecimal string with an even number of 2 to 16 characters, excluding the first two characters, 0x (for example, ‘0x01’).

example PATCH: {“DesiredBootDevices”: [{“Lun”: “<string-value>”}|null, …]}

DesiredBootDevices[array-item].Wwn

JSONPath: /DesiredBootDevices/(array index)/Wwn (PATCHable string)

The Fibre Channel World Wide Name (WWN) of the desired boot device. This value must be a hexadecimal string with an even number of 2 to 16 characters, excluding the first two characters, 0x (for example, ‘0x0001020304050607’).

example PATCH: {“DesiredBootDevices”: [{“Wwn”: “<string-value>”}|null, …]}

DesiredBootDevices[array-item].iScsiTargetName

JSONPath: /DesiredBootDevices/(array index)/iScsiTargetName (PATCHable string)

The iSCSI node target name of the desired boot device. The value must be a string based on IETF RFC 3270, and can be up to 223 characters in length (for example, ‘iqn.1991-05.com.microsoft:iscsitarget-iscsidisk-target’).

example PATCH: {“DesiredBootDevices”: [{“iScsiTargetName”: “<string-value>”}|null, …]}

SettingsResult.definitions.SettingsResult.ETag

JSONPath: /SettingsResult/definitions/SettingsResult/ETag (read only string)

ETag of this resource after the settings have been applied.

SettingsResult.definitions.SettingsResult.Messages[array-item].Message

JSONPath: /SettingsResult/definitions/SettingsResult/Messages/(array index)/Message (read only string)

Human-readable message.

SettingsResult.definitions.SettingsResult.Messages[array-item].MessageID

JSONPath: /SettingsResult/definitions/SettingsResult/Messages/(array index)/MessageID (read only string)

Key for this message, which is used to look up the message in a message registry. The key is in the format ..:.

SettingsResult.definitions.SettingsResult.Messages[array-item].Resolution

JSONPath: /SettingsResult/definitions/SettingsResult/Messages/(array index)/Resolution (read only string)

Instructions for resolving the issue that caused the error.

SettingsResult.definitions.SettingsResult.Messages[array-item].Severity

JSONPath: /SettingsResult/definitions/SettingsResult/Messages/(array index)/Severity (read only enumeration)

This is the severity of the errors.

Defined values:

SettingsResult.definitions.SettingsResult.Operation

JSONPath: /SettingsResult/definitions/SettingsResult/Operation (read only enumeration)

Details about the results of applying the settings.

Defined values:

SettingsResult.definitions.SettingsResult.Time

JSONPath: /SettingsResult/definitions/SettingsResult/Time (read only string)

Time at which the settings were applied.

HpServerPCISlot

This describes a PCI slot on a server.

Properties

Resource Instances of this Type:

  • https://{iLO}/redfish/v1/systems/{item}/pcislots/{item}

Length

JSONPath: /Length (read only enumeration)

PCI slot length

Defined values:

LinkLanes

JSONPath: /LinkLanes (read only enumeration)

Bandwidth capacity of the slot, measured by the number of PCI Express Lanes present. Also known as the slot width.

Defined values:

Status.EnabledState

JSONPath: /Status/EnabledState (read only string)

Specifies whether the slot is enabled or disabled.

Status.OperationalStatus[array-item].Status

JSONPath: /Status/OperationalStatus/(array index)/Status (read only string)

Current usage status of the slot: InUse or Empty

SupportsHotPlug

JSONPath: /SupportsHotPlug (read only boolean)

Specifies whether the slot supports hot-plug devices.

Technology

JSONPath: /Technology (read only enumeration)

PCI technology

Defined values:

UEFIDevicePath

JSONPath: /UEFIDevicePath (read only string)

Standardized text representation of the UEFI device path, in UTF-8 format

HpServerPciDevice

This describes a logical PCI Device on a server. This does not necessarily correspond to a specific FRU because a FRU or card might contain mutiple logical PCI devices.

Properties

Resource Instances of this Type:

  • https://{iLO}/redfish/v1/systems/{item}/pcidevices/{item}

BayNumber

JSONPath: /BayNumber (read only integer)

Bay number value.

BusNumber

JSONPath: /BusNumber (read only integer)

PCI device bus number value.

ClassCode

JSONPath: /ClassCode (read only integer)

PCI class code of the endpoint.

DeviceID

JSONPath: /DeviceID (read only integer)

PCI device ID of the device.

DeviceInstance

JSONPath: /DeviceInstance (read only integer)

PCI device instance value.

DeviceLocation

JSONPath: /DeviceLocation (read only string)

PCI device location.

DeviceNumber

JSONPath: /DeviceNumber (read only integer)

PCI device number value.

DeviceSubInstance

JSONPath: /DeviceSubInstance (read only integer)

PCI device sub-instance value.

DeviceType

JSONPath: /DeviceType (read only enumeration)

Device type value.

Defined values:

EnclosureNumber

JSONPath: /EnclosureNumber (read only integer)

Enclosure number value.

FunctionNumber

JSONPath: /FunctionNumber (read only integer)

PCI device function number value.

SegmentNumber

JSONPath: /SegmentNumber (read only integer)

PCI segment group number value.

StructuredName

JSONPath: /StructuredName (read only string)

PCI device structured name in UTF-8 format.

SubclassCode

JSONPath: /SubclassCode (read only integer)

PCI sub class code of the endpoint.

SubsystemDeviceID

JSONPath: /SubsystemDeviceID (read only integer)

PCI subsystem device ID of the device.

SubsystemVendorID

JSONPath: /SubsystemVendorID (read only integer)

PCI subsystem vendor ID of the device.

UEFIDevicePath

JSONPath: /UEFIDevicePath (read only string)

Standardized text representation of the UEFI device path, in UTF-8 format.

VendorID

JSONPath: /VendorID (read only integer)

PCI vendor ID of the device.

HpSmartStorage

This is the HPE Smart Storage subsystem for a server.

Properties

Resource Instances of this Type:

  • https://{iLO}/redfish/v1/systems/{item}/smartstorage

Status.Health

JSONPath: /Status/Health (read only enumeration)

This represents the health state of this resource in the absence of its dependent resources.

Defined values:

Status.HealthRollUp

JSONPath: /Status/HealthRollUp (read only enumeration)

This represents the overall health state from the view of this resource.

Defined values:

Status.HealthRollup

JSONPath: /Status/HealthRollup (read only enumeration)

This represents the overall health state from the view of this resource.

Defined values:

Status.State

JSONPath: /Status/State (read only enumeration)

This indicates the known state of the resource, such as if it is enabled.

Defined values:

HpSmartStorageArrayController

This is a Smart Storage array controller for a server.

Properties

Resource Instances of this Type:

  • https://{iLO}/redfish/v1/systems/{item}/smartstorage/arraycontrollers/{item}

AdapterType

JSONPath: /AdapterType (read only enumeration)

Type of Smart controller

Defined values:

ArrayCount

JSONPath: /ArrayCount (read only integer)

The number of arrays configured on this controller

BackupPowerSourceStatus

JSONPath: /BackupPowerSourceStatus (read only enumeration)

The current status of the backup power source (battery, capacitor, megacell etc.)

Defined values:

BootVolumePrimary

JSONPath: /BootVolumePrimary (read only string)

The primary boot volume of this controller

BootVolumeSecondary

JSONPath: /BootVolumeSecondary (read only string)

The secondary boot volume of this controller

CacheArrayCount

JSONPath: /CacheArrayCount (read only integer)

The number of cache arrays configured on this controller

CacheLogicalDriveCount

JSONPath: /CacheLogicalDriveCount (read only integer)

The number of cache logical drives configured on this controller

CacheMemorySizeMiB

JSONPath: /CacheMemorySizeMiB (read only integer)

The total cache memory size for the controller in MiB

CachePhysicalDriveCount

JSONPath: /CachePhysicalDriveCount (read only integer)

The number of physical drives assigned as cache drives attached to this controller

CurrentOperatingMode

JSONPath: /CurrentOperatingMode (read only enumeration)

The current operating mode of the controller.

Defined values:

CurrentParallelSurfaceScanCount

JSONPath: /CurrentParallelSurfaceScanCount (read only integer)

Number of disks the controller is scanning in parallel

DataLogicalDriveCount

JSONPath: /DataLogicalDriveCount (read only integer)

The number of data logical drives configured on this controller

DataPhysicalDriveCount

JSONPath: /DataPhysicalDriveCount (read only integer)

The number of physical drives assigned as data drives attached to this controller

DegradedPerformanceOptimization

JSONPath: /DegradedPerformanceOptimization (read only enumeration)

Enables the controller to attempt to improve performance on RAID 5/50/6(ADG)/60 logical drives when one or more physical drives in the logical drive are failed

Defined values:

DriveWriteCache

JSONPath: /DriveWriteCache (read only enumeration)

Enables or disables the write cache of the physical drives attached to the controller

Defined values:

ElevatorSort

JSONPath: /ElevatorSort (read only enumeration)

Enables the controller to sort requests to a physical drive

Defined values:

EncryptionBootPasswordSet

JSONPath: /EncryptionBootPasswordSet (read only boolean)

True if there is a boot password set, false otherwise

EncryptionCryptoOfficerPasswordSet

JSONPath: /EncryptionCryptoOfficerPasswordSet (read only boolean)

True if a password has been set for the Encryption Crypto Officer, false otherwise

EncryptionEnabled

JSONPath: /EncryptionEnabled (read only boolean)

True if encryption is currently enabled for this controller, false otherwise

EncryptionFwLocked

JSONPath: /EncryptionFwLocked (read only boolean)

True if the controller firmware has been locked, preventing firmware updates, false otherwise

EncryptionHasLockedVolumes

JSONPath: /EncryptionHasLockedVolumes (read only boolean)

True if the controller has one or more volumes that are locked, false otherwise

EncryptionHasLockedVolumesMissingBootPassword

JSONPath: /EncryptionHasLockedVolumesMissingBootPassword (read only boolean)

True if there are locked drives due to a missing boot password, false otherwise

EncryptionHasSuspendedVolumes

JSONPath: /EncryptionHasSuspendedVolumes (read only boolean)

True if the controller password has been temporarily suspended, false otherwise

EncryptionKekSet

JSONPath: /EncryptionKekSet (read only boolean)

True if the Master Key has been set, false otherwise

EncryptionLocalKeyCacheEnabled

JSONPath: /EncryptionLocalKeyCacheEnabled (read only boolean)

True if the controller caches encryption keys locally when a remote key manager is being used, false otherwise

EncryptionMixedVolumesEnabled

JSONPath: /EncryptionMixedVolumesEnabled (read only boolean)

True if the controller will allow plaintext and encrypted volumes to exist simultaneously, false otherwise

EncryptionPhysicalDriveCount

JSONPath: /EncryptionPhysicalDriveCount (read only integer)

The number of encrypted physical drives attached to the controller

EncryptionRecoveryParamsSet

JSONPath: /EncryptionRecoveryParamsSet (read only boolean)

True if the encryption password recovery question and answer have been set, false otherwise

EncryptionStandaloneModeEnabled

JSONPath: /EncryptionStandaloneModeEnabled (read only boolean)

True if the controller manages encryption keys locally, false if a remote key manager is being used

EncryptionUserPasswordSet

JSONPath: /EncryptionUserPasswordSet (read only boolean)

True if a password has been set for the Encryption User, false otherwise.

ExpandPriority

JSONPath: /ExpandPriority (read only enumeration)

The level of priority that transformations have over handling current operating system requests

Defined values:

ExternalPortCount

JSONPath: /ExternalPortCount (read only integer)

The number of external ports

FirmwareVersion.Current.VersionString

JSONPath: /FirmwareVersion/Current/VersionString (read only string)

This string represents the version of the firmware image.

FlexibleLatencySchedulerSetting

JSONPath: /FlexibleLatencySchedulerSetting (read only enumeration)

This allows the controller to process certain high-latency requests after a delay that may time out when elevator sorting

Defined values:

HardwareRevision

JSONPath: /HardwareRevision (read only string)

The hardware revision of the controller

InconsistencyRepairPolicy

JSONPath: /InconsistencyRepairPolicy (read only enumeration)

Enables the controller to update data on RAID 6(ADG) and 60 volumes based on parity information when an inconsistency is discovered during surface scan

Defined values:

InternalPortCount

JSONPath: /InternalPortCount (read only integer)

The number of internal ports

IsBootController

JSONPath: /IsBootController (read only boolean)

True if this controller is the OS boot controller, false otherwise

Location

JSONPath: /Location (read only string)

Location identifier

LocationFormat

JSONPath: /LocationFormat (read only enumeration)

Format for Location Identifier

Defined values:

LogicalDriveCount

JSONPath: /LogicalDriveCount (read only integer)

The number of logical drives configured on this controller

Manufacturer

JSONPath: /Manufacturer (read only string)

The manufacturer of the controller

MaxParallelSurfaceScanCount

JSONPath: /MaxParallelSurfaceScanCount (read only integer)

Maximum number of disks that the controller supports scanning in parallel

Model

JSONPath: /Model (read only string)

The model number for the controller

OperatingModeAfterReboot

JSONPath: /OperatingModeAfterReboot (read only enumeration)

The operating mode the controller will be functioning in (RAID versus HBA) after a reboot

Defined values:

ParallelSurfaceScanSupported

JSONPath: /ParallelSurfaceScanSupported (read only boolean)

True if the controller supports scanning multiple disk surfaces

PhysicalDriveCount

JSONPath: /PhysicalDriveCount (read only integer)

The number of physical drives attached to this controller

PowerModeAfterReboot

JSONPath: /PowerModeAfterReboot (read only enumeration)

The power mode of the controller after a reboot

Defined values:

PowerModeConfigured

JSONPath: /PowerModeConfigured (read only enumeration)

The current power mode of the controller

Defined values:

PowerModeWarningChangedDrive

JSONPath: /PowerModeWarningChangedDrive (read only boolean)

True if the controller’s drive configuration has changed while using configuration based power settings, false otherwise

PowerModeWarningChangedMode

JSONPath: /PowerModeWarningChangedMode (read only boolean)

True if the controller has a new power mode configured, false otherwise

PowerModeWarningReboot

JSONPath: /PowerModeWarningReboot (read only enumeration)

True if a reboot is required to change the active power mode on the controller, false otherwise

Defined values:

PowerModeWarningTemperature

JSONPath: /PowerModeWarningTemperature (read only boolean)

True if the controller has crossed a critical temperature threshold and performance has been reduced to prevent damage to the controller, false otherwise

PredictiveSpareRebuild

JSONPath: /PredictiveSpareRebuild (read only enumeration)

Enables or disables predictive spare rebuild mode

Defined values:

QueueDepth

JSONPath: /QueueDepth (read only enumeration)

This sets the maximum number of requests the controller will submit to a drive at any given time

Defined values:

RebuildPriority

JSONPath: /RebuildPriority (read only enumeration)

The level of priority that rebuilds have over handling current operating system requests

Defined values:

SerialNumber

JSONPath: /SerialNumber (read only string)

The serial number for this controller

SoftwareRaidHbaFirmwareRev

JSONPath: /SoftwareRaidHbaFirmwareRev (read only string)

The firmware version of the underlying HBA that is being used by the software RAID stack

SoftwareRaidHbaModeOptionRomRev

JSONPath: /SoftwareRaidHbaModeOptionRomRev (read only string)

The option ROM firmware version used to bootstrap the software RAID stack

SparePhysicalDriveCount

JSONPath: /SparePhysicalDriveCount (read only integer)

he number of physical drives assigned as spare drives attached to this controller

Status.Health

JSONPath: /Status/Health (read only enumeration)

This represents the health state of this resource in the absence of its dependent resources.

Defined values:

Status.HealthRollUp

JSONPath: /Status/HealthRollUp (read only enumeration)

This represents the overall health state from the view of this resource.

Defined values:

Status.HealthRollup

JSONPath: /Status/HealthRollup (read only enumeration)

This represents the overall health state from the view of this resource.

Defined values:

Status.State

JSONPath: /Status/State (read only enumeration)

This indicates the known state of the resource, such as if it is enabled.

Defined values:

SurfaceScanAnalysisPriority

JSONPath: /SurfaceScanAnalysisPriority (read only enumeration)

Priority that the controller takes to find and correct disk surface errors

Defined values:

UnassignedPhysicalDriveCount

JSONPath: /UnassignedPhysicalDriveCount (read only integer)

The number of unassigned physical drives attached to this controller

HpSmartStorageDiskDrive

This represents a disk drive managed by Smart Storage.

Properties

Resource Instances of this Type:

  • https://{iLO}/redfish/v1/systems/{item}/smartstorage/arraycontrollers/{item}/diskdrives/{item}

BlockSizeBytes

JSONPath: /BlockSizeBytes (read only integer)

Block size of the drive in bytes. This is the block size presented by the drive to clients such as the array controller or operating system.

CapacityGB

JSONPath: /CapacityGB (read only integer)

Total capacity of the drive in gigabytes. This denotes the marketing capacity (base 10).

CapacityLogicalBlocks

JSONPath: /CapacityLogicalBlocks (read only integer)

Total number of logical blocks in the drive

CapacityMiB

JSONPath: /CapacityMiB (read only integer)

Total capacity of the drive in MiB

CarrierApplicationVersion

JSONPath: /CarrierApplicationVersion (read only string)

Carrier PIC firmware version currently running

CarrierAuthenticationStatus

JSONPath: /CarrierAuthenticationStatus (read only enumeration)

Authentication status of the drive carrier

Defined values:

CurrentTemperatureCelsius

JSONPath: /CurrentTemperatureCelsius (read only integer)

The current temperature of the drive

EncryptedDrive

JSONPath: /EncryptedDrive (read only boolean)

True if encryption is currently enabled on this disk drive, false otherwise

EraseCompletionPercentage

JSONPath: /EraseCompletionPercentage (read only integer)

The percent complete for an erase operation currently occurring on the disk drive or null if not currently erasing a drive.

ErasePattern

JSONPath: /ErasePattern (read only string)

The pattern used for erasing the disk drive

FirmwareVersion.Current.VersionString

JSONPath: /FirmwareVersion/Current/VersionString (read only string)

This string represents the version of the firmware image.

IndicatorLED

JSONPath: /IndicatorLED (read only enumeration)

The state of the indicator LED.

Defined values:

InterfaceSpeedMbps

JSONPath: /InterfaceSpeedMbps (read only integer)

Native interface speed for the device

InterfaceType

JSONPath: /InterfaceType (read only enumeration)

The connection interface of the drive. The value NVME has been deprecated.

Defined values:

Location

JSONPath: /Location (read only string)

The location of the drive

LocationFormat

JSONPath: /LocationFormat (read only enumeration)

Format for the location property

Defined values:

Manufacturer

JSONPath: /Manufacturer (read only string)

Manufacturer of the disk drive

MaximumTemperatureCelsius

JSONPath: /MaximumTemperatureCelsius (read only integer)

The maximum recommended temperature for the drive

MediaType

JSONPath: /MediaType (read only enumeration)

Type of disk

Defined values:

MinimumGoodFirmwareVersion

JSONPath: /MinimumGoodFirmwareVersion (read only string)

The minimum recommended firmware revision for the drive

Model

JSONPath: /Model (read only string)

Drive model number

NativeBlockSizeBytes

JSONPath: /NativeBlockSizeBytes (read only integer)

Native block size of the drive in bytes. This is the underlying sector size used by the physical drive to store data. For example, an advanced format drive that uses 4K sector sizes to store data will return 4K as the NativeBlockSizeBytes but may return 512 for the BlockSizeBytes when running in 512e (emulation) mode for backward compatibility

PhyCount

JSONPath: /PhyCount (read only integer)

The number of phys the drive has

PortCount

JSONPath: /PortCount (read only integer)

The number of ports on the drive. Typically 1 (single-domain) or 2 (dual-domain)

PowerOnHours

JSONPath: /PowerOnHours (read only integer)

The number of lifetime hours that the drive has been powered on. The value is null if the disk power on hours cannot be determined or is not supported.

RotationalSpeedRpm

JSONPath: /RotationalSpeedRpm (read only integer)

The rotational speed of the drive, only applicable on HDDs

SSDEnduranceUtilizationPercentage

JSONPath: /SSDEnduranceUtilizationPercentage (read only integer)

This is the percentage of the drive that has been worn out and can no longer be used. When this values reaches 100%, the drive has 0% usage remaining and is completely worn out. The value is null if percent endurance used cannot be determined or is not supported.

SerialNumber

JSONPath: /SerialNumber (read only string)

The serial number of the drive

SpareRebuildMode

JSONPath: /SpareRebuildMode (read only enumeration)

Method to used activate this drive when another drive fails, this is only applicable if the drive is configured as a spare drive

Defined values:

Status.Health

JSONPath: /Status/Health (read only enumeration)

This represents the health state of this resource in the absence of its dependent resources.

Defined values:

Status.HealthRollUp

JSONPath: /Status/HealthRollUp (read only enumeration)

This represents the overall health state from the view of this resource.

Defined values:

Status.HealthRollup

JSONPath: /Status/HealthRollup (read only enumeration)

This represents the overall health state from the view of this resource.

Defined values:

Status.State

JSONPath: /Status/State (read only enumeration)

This indicates the known state of the resource, such as if it is enabled.

Defined values:

TransferSpeedMbps

JSONPath: /TransferSpeedMbps (read only integer)

Effective transfer speed to the device taking into account hardware acceleration such as edge-buffering

WWID

JSONPath: /WWID (read only string)

Unique identifier for the device

HpSmartStorageLogicalDrive

This represents a logical drive managed by Smart Storage. It may consist of one or more physical drives.

Properties

Resource Instances of this Type:

  • https://{iLO}/redfish/v1/systems/{item}/smartstorage/arraycontrollers/{item}/logicaldrives/{item}

BlockSizeBytes

JSONPath: /BlockSizeBytes (read only integer)

The block size of the disk drive in bytes

CapacityMiB

JSONPath: /CapacityMiB (read only integer)

Total usable capacity available on this logical drive in MiB units

DriveAccessName

JSONPath: /DriveAccessName (read only string)

The access ID of the logical drive given by the OS

DriveGeometryCylinders

JSONPath: /DriveGeometryCylinders (read only string)

The number of cylinders on the drive

DriveGeometryHeads

JSONPath: /DriveGeometryHeads (read only string)

The number of heads on the drive

DriveGeometrySectors

JSONPath: /DriveGeometrySectors (read only string)

The number of sectors on the drive

LegacyBootPriority

JSONPath: /LegacyBootPriority (read only enumeration)

Defined values:

LogicalDriveEncryption

JSONPath: /LogicalDriveEncryption (read only boolean)

True if encryption is currently enabled on this logical drive, false otherwise

LogicalDriveEncryptionDataKeysVolatile

JSONPath: /LogicalDriveEncryptionDataKeysVolatile (read only boolean)

True if volatile keys are enabled for encryption, false otherwise

LogicalDriveEncryptionDataKeysVolatileBackup

JSONPath: /LogicalDriveEncryptionDataKeysVolatileBackup (read only boolean)

True if volatile keys are backed up to a remote key manager, false if volatile keys are not backed up

LogicalDriveEncryptionDataKeysVolatileStatus

JSONPath: /LogicalDriveEncryptionDataKeysVolatileStatus (read only enumeration)

The status of the encryption volatile keys

Defined values:

LogicalDriveName

JSONPath: /LogicalDriveName (read only string)

Label given to the logical drive

LogicalDriveNumber

JSONPath: /LogicalDriveNumber (read only integer)

logical drive number

LogicalDriveType

JSONPath: /LogicalDriveType (read only enumeration)

How the logical drive is being used

Defined values:

ParityInitializationCompletionPercentage

JSONPath: /ParityInitializationCompletionPercentage (read only integer)

Parity initialization complete percentage for a parity based logical drive (e.g. RAID 5)

ParityInitializationType

JSONPath: /ParityInitializationType (read only enumeration)

When creating a logical drive with a RAID level that requires parity, parity blocks can be initialized with two different methods

Defined values:

PartitionInformation

JSONPath: /PartitionInformation (read only string)

OS partition information for the drive

Raid

JSONPath: /Raid (read only enumeration)

The current RAID level configured on the logical drive

Defined values:

RebuildCompletionPercentage

JSONPath: /RebuildCompletionPercentage (read only integer)

The percent complete for a rebuild operation currently occurring on the logical drive

SmartCacheState

JSONPath: /SmartCacheState (read only enumeration)

The state of the SmartCache cache. This is valid if this drive either is a cache drive, or has a cache drive attached to it

Defined values:

Status.Health

JSONPath: /Status/Health (read only enumeration)

This represents the health state of this resource in the absence of its dependent resources.

Defined values:

Status.HealthRollUp

JSONPath: /Status/HealthRollUp (read only enumeration)

This represents the overall health state from the view of this resource.

Defined values:

Status.HealthRollup

JSONPath: /Status/HealthRollup (read only enumeration)

This represents the overall health state from the view of this resource.

Defined values:

Status.State

JSONPath: /Status/State (read only enumeration)

This indicates the known state of the resource, such as if it is enabled.

Defined values:

StripSizeBytes

JSONPath: /StripSizeBytes (read only integer)

The strip size of the logical drive in bytes

StripeSizeBytes

JSONPath: /StripeSizeBytes (read only integer)

The stripe size of the logical drive in bytes

TransformationCompletionPercentage

JSONPath: /TransformationCompletionPercentage (read only integer)

The percent complete for any transformations the logical drive may be undergoing such as RAID migration, stripesize migration, capacity expansion etc.

VolumeUniqueIdentifier

JSONPath: /VolumeUniqueIdentifier (read only string)

An identifier (typically SCSI Inquiry based such as Inquiry VPD Page 0x83 NAA 64 identifier) used to uniquely identify this volume.

HpSmartStorageStorageEnclosure

This represents an enclosure for physical disk drives which may be internal or external to the server.

Properties

Resource Instances of this Type:

  • https://{iLO}/redfish/v1/systems/{item}/smartstorage/arraycontrollers/{item}/storageenclosures/{item}

DoorLockLED

JSONPath: /DoorLockLED (read only enumeration)

The state of the Door Lock LED. When Lit, this indicates that the Enclosure should not be removed since the drives are currently in use.

Defined values:

DriveBayCount

JSONPath: /DriveBayCount (read only integer)

Number of drive bays supported within the storage enclosure

EnclosureLogicalID

JSONPath: /EnclosureLogicalID (read only string)

Unique ID for the storage enclosure

FaultLED

JSONPath: /FaultLED (read only enumeration)

The state of the Fault LED.

Defined values:

FirmwareVersion.Current.VersionString

JSONPath: /FirmwareVersion/Current/VersionString (read only string)

This string represents the version of the firmware image.

IndicatorLED

JSONPath: /IndicatorLED (read only enumeration)

The state of the indicator LED.

Defined values:

Location

JSONPath: /Location (read only string)

Location identifier

LocationFormat

JSONPath: /LocationFormat (read only enumeration)

Format for Location Identifier

Defined values:

Manufacturer

JSONPath: /Manufacturer (read only string)

The manufacturer of the storage enclosure

Model

JSONPath: /Model (read only string)

The model string for the storage enclosure

PartNumber

JSONPath: /PartNumber (read only string)

Part number of this storage enclosure

SKU

JSONPath: /SKU (read only string)

SKU for the storage enclosure

SerialNumber

JSONPath: /SerialNumber (read only string)

The serial number for this storage enclosure

Status.Health

JSONPath: /Status/Health (read only enumeration)

This represents the health state of this resource in the absence of its dependent resources.

Defined values:

Status.HealthRollUp

JSONPath: /Status/HealthRollUp (read only enumeration)

This represents the overall health state from the view of this resource.

Defined values:

Status.HealthRollup

JSONPath: /Status/HealthRollup (read only enumeration)

This represents the overall health state from the view of this resource.

Defined values:

Status.State

JSONPath: /Status/State (read only enumeration)

This indicates the known state of the resource, such as if it is enabled.

Defined values:

SubEnclosureLocation

JSONPath: /SubEnclosureLocation (read only string)

Location within the chassis if this storage enclosure is part of a larger chassis hosting multiple storage enclosures

HpiLOActiveHealthSystem

This resource enables access to Active Health System data.

Properties

Resource Instances of this Type:

  • https://{iLO}/redfish/v1/managers/{item}/activehealthsystem

AHSEnabled

JSONPath: /AHSEnabled (PATCHable boolean)

Determines whether HP Active Health System logging is enabled or disabled.

example PATCH: {“AHSEnabled”: true}

JSONPath: /Links/AHSLocation/extref (read only string) with the Redfish OData-Version header

JSONPath: /links/AHSLocation/extref (read only string) without the Redfish OData-Version header

This is the URI of the Active Health System binary download. This URI is not fixed and must be read from this property. Perform a GET to this URI with the following query parameters to define the download time range and embed customer case information:

e.g. GET /ahsdata/HP_8CW4340017_20340417.ahs?from=2016-02-16&&to=2016-02-19&&case_no=90125&&co_name=HPE&&contact_name=John Smith&&email=dummy-email-address@hpe.com&&phone=555-555-5555

If successful, the response of the GET is a binary download which can be saved to a file.

POST Action “ClearLog”

Clears the Active Health System Log.

example “ClearLog” action:

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

{}

HpiLODateTime

The management processor date and time.

Properties

Resource Instances of this Type:

  • https://{iLO}/redfish/v1/managers/{item}/datetime

ConfigurationSettings

JSONPath: /ConfigurationSettings (read only enumeration)

The state of the currently displayed configuration settings.

Defined values:

DateTime

JSONPath: /DateTime (read only string)

The date and time used by management processor.

PropagateTimeToHost

JSONPath: /PropagateTimeToHost (PATCHable boolean)

Determines whether the server time is synchronized with the management processor time during the first POST after AC power is applied.

example PATCH: {“PropagateTimeToHost”: true}

TimeZone.Index

JSONPath: /TimeZone/Index (PATCHable integer)

The index of the current time zone. To set a new time zone, specify a different time zone index. This property can be set only when DHCPv4 or DHCPv6 supplied time settings are disabled. Since the time zone list might vary from one firmware version to another (which often leads to differences in time zone indices), setting the time zone by name is recommended over setting by index, for better compatibility.

example PATCH: {“TimeZone”: {“Index”: <integer-value>}}

TimeZone.UtcOffset

JSONPath: /TimeZone/UtcOffset (read only string)

The UTC offset of the current time zone, in the format {+/-}hh:mm

TimeZone.Value

JSONPath: /TimeZone/Value (read only string)

The environment variable value.

TimeZoneList[array-item].Index

JSONPath: /TimeZoneList/(array index)/Index (read only integer)

The time zone index.

TimeZoneList[array-item].UtcOffset

JSONPath: /TimeZoneList/(array index)/UtcOffset (read only string)

The UTC offset of the time zone, in the format {+/-}hh:mm

TimeZoneList[array-item].Value

JSONPath: /TimeZoneList/(array index)/Value (read only string)

The environment variable value.

HpiLOEmbeddedMedia

This represent’s the state of iLO’s managed media including the internal SD-Card on Gen8 and Gen9 ProLiant servers.

Properties

Resource Instances of this Type:

  • https://{iLO}/redfish/v1/managers/{item}/embeddedmedia

Controller.Firmware.Current.VersionString

JSONPath: /Controller/Firmware/Current/VersionString (read only string)

The current version of the embedded media controller.

Controller.Status.Health

JSONPath: /Controller/Status/Health (read only enumeration)

This represents the health state of this resource in the absence of its dependent resources.

Defined values:

Controller.Status.HealthRollUp

JSONPath: /Controller/Status/HealthRollUp (read only enumeration)

This represents the overall health state from the view of this resource.

Defined values:

Controller.Status.HealthRollup

JSONPath: /Controller/Status/HealthRollup (read only enumeration)

This represents the overall health state from the view of this resource.

Defined values:

Controller.Status.State

JSONPath: /Controller/Status/State (read only enumeration)

This indicates the known state of the resource, such as if it is enabled.

Defined values:

SDCard.HpCertified

JSONPath: /SDCard/HpCertified (read only boolean)

True if this is an HP-certified SD card.

SDCard.LBACount

JSONPath: /SDCard/LBACount (read only integer)

The LBA count.

SDCard.SizeString

JSONPath: /SDCard/SizeString (read only string)

The size of the SD card present in the server, in a readable format.

SDCard.Status.Health

JSONPath: /SDCard/Status/Health (read only enumeration)

This represents the health state of this resource in the absence of its dependent resources.

Defined values:

SDCard.Status.HealthRollUp

JSONPath: /SDCard/Status/HealthRollUp (read only enumeration)

This represents the overall health state from the view of this resource.

Defined values:

SDCard.Status.HealthRollup

JSONPath: /SDCard/Status/HealthRollup (read only enumeration)

This represents the overall health state from the view of this resource.

Defined values:

SDCard.Status.State

JSONPath: /SDCard/Status/State (read only enumeration)

This indicates the known state of the resource, such as if it is enabled.

Defined values:

SDCard.WriteCount

JSONPath: /SDCard/WriteCount (read only integer)

The number of writes on the SD card. Rendered only if this is an HP-certified SD card.

HpiLOFederatedGroupCapping

This resource manages the system’s participating in iLO Federation group power capping.

Properties

Resource Instances of this Type:

  • https://{iLO}/redfish/v1/chassis/{item}/power/federatedgroupcapping

CapWatts

JSONPath: /CapWatts (read only integer)

The configured power cap for all servers in a group. This value is 0 if the power cap is not configured.

CapacityWatts

JSONPath: /CapacityWatts (read only integer)

The total power supply capacity for all servers in a group.

Throttle

JSONPath: /Throttle (read only string)

High, Med, or Low based on the percentage of power usage.

HpiLOFederationGroup

This manages iLO’s participation in Federation groups.

Properties

Resource Instances of this Type:

  • https://{iLO}/redfish/v1/managers/{item}/federationgroups/{item}

Key

JSONPath: /Key (PATCHable string)

The password used by the Federation Group.

example PATCH: {“Key”: “<string-value>”}

Privileges.LoginPriv

JSONPath: /Privileges/LoginPriv (PATCHable boolean)

Login privileges.

example PATCH: {“Privileges”: {“LoginPriv”: true}}

Privileges.RemoteConsolePriv

JSONPath: /Privileges/RemoteConsolePriv (PATCHable boolean)

Remote console privileges.

example PATCH: {“Privileges”: {“RemoteConsolePriv”: true}}

Privileges.UserConfigPriv

JSONPath: /Privileges/UserConfigPriv (PATCHable boolean)

User configuration privileges.

example PATCH: {“Privileges”: {“UserConfigPriv”: true}}

Privileges.VirtualMediaPriv

JSONPath: /Privileges/VirtualMediaPriv (PATCHable boolean)

Virtual media privileges.

example PATCH: {“Privileges”: {“VirtualMediaPriv”: true}}

Privileges.VirtualPowerAndResetPriv

JSONPath: /Privileges/VirtualPowerAndResetPriv (PATCHable boolean)

Virtual power and reset privileges.

example PATCH: {“Privileges”: {“VirtualPowerAndResetPriv”: true}}

Privileges.iLOConfigPriv

JSONPath: /Privileges/iLOConfigPriv (PATCHable boolean)

The management processor configuration privileges.

example PATCH: {“Privileges”: {“iLOConfigPriv”: true}}

HpiLOFederationPeers

This is a view of iLO’s Federation peers based upon its current group membership.

Properties

Resource Instances of this Type:

  • https://{iLO}/redfish/v1/managers/{item}/federationpeers/{item}

Peers[array-item].HttpErrorCode

JSONPath: /Peers/(array index)/HttpErrorCode (read only integer)

Error code for success or failure.

Peers[array-item].ManagerIPAddress

JSONPath: /Peers/(array index)/ManagerIPAddress (read only string)

Manager IP address of the federation peer.

Peers[array-item].Time

JSONPath: /Peers/(array index)/Time (read only string)

Time when the federation peer was added.

Peers[array-item].URL

JSONPath: /Peers/(array index)/URL (read only string)

URL of the federation peer.

Peers[array-item].UUID

JSONPath: /Peers/(array index)/UUID (read only string)

UUID peers that are part of the federation group.

HpiLOFirmwareUpdate

This is the iLO 4 firmware update service which enables a client to update supported system firmware.

Several of the properties in this resource represent the details of the last firmware update operation, including: * Copyright message * Details * Post-update flags * Image type (recognized by iLO 4) * ProgressPercent - updated during flashing * Flash engine state

Properties

Resource Instances of this Type:

  • https://{iLO}/redfish/v1/managers/{item}/updateservice

JSONPath: /Links/UpdateUri/extref (read only string) with the Redfish OData-Version header

JSONPath: /links/UpdateUri/extref (read only string) without the Redfish OData-Version header

This property indicates the URI location a client my upload a firmware image directly to iLO 4.

Actions

POST Action “InstallFromURI”

Causes iLO 4 to GET and flash the firmware image indicated by FirmwareURI.

Parameters:

“FirmwareURI” (uri) the URI of the firmware image

“TPMOverrideFlag” (boolean) with one of the following value(s):

example “InstallFromURI” action:

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

{
    "FirmwareURI": "<uri>", 
    "TPMOverrideFlag": true
}

HpiLOLicense

This indicates the current iLO license status.

You may install an iLO license by POSTing a JSON object containing {"LicenseKey": "key-string"} to the license service collection. PATCHing an existing LicenseKey property does not alter the license.

e.g. POST https://{iLO}/redfish/v1/managers/{item}/licenseservice/

{
    "LicenseKey": "key-string"
}

Properties

Resource Instances of this Type:

  • https://{iLO}/redfish/v1/managers/{item}/licenseservice/{item}

License

JSONPath: /License (read only string)

The name of the license installed on this management processor.

LicenseExpire

JSONPath: /LicenseExpire (read only string)

The expiration information of the installed management processor license.

LicenseKey

JSONPath: /LicenseKey (read only string)

The license key installed on this management processor. License keys are 25 characters in length and contain both letters and numbers.Use POST method to collection of membertype HpiLOLicense to install / update the license

LicenseType

JSONPath: /LicenseType (read only enumeration)

The type of license installed on this management processor.

Defined values:

HpiLOResourceDirectory

This is a directory of important resources in the REST API. It exists as a performance enhancer for clients that know exactly what kind of resources they are looking for. It does this by flattening the data model and reducing the required number of HTTP GET operations needed to access a resource deep in the model.

Properties

Resource Instances of this Type:

  • https://{iLO}/redfish/v1/resourcedirectory

Instances[array-item].ETag

JSONPath: /Instances/(array index)/ETag (read only string)

This is the last known etag of the resource. The property is omitted if not known.

Instances[array-item].MemberType

JSONPath: /Instances/(array index)/MemberType (read only string)

This property has the type of members for collection resources.

HpiLOSSO

This is the schema definition for the HP SSO Trusted Server.

Properties

Resource Instances of this Type:

  • https://{iLO}/redfish/v1/managers/{item}/securityservice/sso

ManagerTrustedCertificates[array-item].Certificate

JSONPath: /ManagerTrustedCertificates/(array index)/Certificate (read only string)

Contains PEM formatted X509 certificate (Base64 encoded).

ManagerTrustedCertificates[array-item].SerialNumber

JSONPath: /ManagerTrustedCertificates/(array index)/SerialNumber (read only integer)

Contains the Serial number for the SSO records.

ManagerTrustedCertificates[array-item].ServerName

JSONPath: /ManagerTrustedCertificates/(array index)/ServerName (read only string)

The Server name (or certificate subject).

ManagerTrustedCertificates[array-item].Status

JSONPath: /ManagerTrustedCertificates/(array index)/Status (read only enumeration)

Defined values:

SSOsettings.AdminPrivilege.LoginPriv

JSONPath: /SSOsettings/AdminPrivilege/LoginPriv (PATCHable boolean)

Login Privileges.

example PATCH: {“SSOsettings”: {“AdminPrivilege”: {“LoginPriv”: true}}}

SSOsettings.AdminPrivilege.PowerandResetPriv

JSONPath: /SSOsettings/AdminPrivilege/PowerandResetPriv (PATCHable boolean)

Power and Reset Privileges.

example PATCH: {“SSOsettings”: {“AdminPrivilege”: {“PowerandResetPriv”: true}}}

SSOsettings.AdminPrivilege.RemoteConsolePriv

JSONPath: /SSOsettings/AdminPrivilege/RemoteConsolePriv (PATCHable boolean)

Remote Console Privileges.

example PATCH: {“SSOsettings”: {“AdminPrivilege”: {“RemoteConsolePriv”: true}}}

SSOsettings.AdminPrivilege.UserConfigPriv

JSONPath: /SSOsettings/AdminPrivilege/UserConfigPriv (PATCHable boolean)

User Configuration Privileges.

example PATCH: {“SSOsettings”: {“AdminPrivilege”: {“UserConfigPriv”: true}}}

SSOsettings.AdminPrivilege.VirtualMediaPriv

JSONPath: /SSOsettings/AdminPrivilege/VirtualMediaPriv (PATCHable boolean)

Power and Reset Privileges.

example PATCH: {“SSOsettings”: {“AdminPrivilege”: {“VirtualMediaPriv”: true}}}

SSOsettings.AdminPrivilege.iLOConfigPriv

JSONPath: /SSOsettings/AdminPrivilege/iLOConfigPriv (PATCHable boolean)

iLO Configuration Privileges.

example PATCH: {“SSOsettings”: {“AdminPrivilege”: {“iLOConfigPriv”: true}}}

SSOsettings.OperatorPrivilege.LoginPriv

JSONPath: /SSOsettings/OperatorPrivilege/LoginPriv (PATCHable boolean)

Login Privileges.

example PATCH: {“SSOsettings”: {“OperatorPrivilege”: {“LoginPriv”: true}}}

SSOsettings.OperatorPrivilege.PowerandResetPriv

JSONPath: /SSOsettings/OperatorPrivilege/PowerandResetPriv (PATCHable boolean)

Power and Reset Privileges.

example PATCH: {“SSOsettings”: {“OperatorPrivilege”: {“PowerandResetPriv”: true}}}

SSOsettings.OperatorPrivilege.RemoteConsolePriv

JSONPath: /SSOsettings/OperatorPrivilege/RemoteConsolePriv (PATCHable boolean)

Remote Console Privileges.

example PATCH: {“SSOsettings”: {“OperatorPrivilege”: {“RemoteConsolePriv”: true}}}

SSOsettings.OperatorPrivilege.UserConfigPriv

JSONPath: /SSOsettings/OperatorPrivilege/UserConfigPriv (PATCHable boolean)

User Configuration Privileges.

example PATCH: {“SSOsettings”: {“OperatorPrivilege”: {“UserConfigPriv”: true}}}

SSOsettings.OperatorPrivilege.VirtualMediaPriv

JSONPath: /SSOsettings/OperatorPrivilege/VirtualMediaPriv (PATCHable boolean)

Virtual Media Privileges.

example PATCH: {“SSOsettings”: {“OperatorPrivilege”: {“VirtualMediaPriv”: true}}}

SSOsettings.OperatorPrivilege.iLOConfigPriv

JSONPath: /SSOsettings/OperatorPrivilege/iLOConfigPriv (PATCHable boolean)

iLO Configuration Privileges.

example PATCH: {“SSOsettings”: {“OperatorPrivilege”: {“iLOConfigPriv”: true}}}

SSOsettings.SSOTrustMode

JSONPath: /SSOsettings/SSOTrustMode (PATCHable enumeration)

Represents the SSO Trust Mode.

example PATCH: {“SSOsettings”: {“SSOTrustMode”: “TrustbyName”}}

Defined values:

SSOsettings.UserPrivilege.LoginPriv

JSONPath: /SSOsettings/UserPrivilege/LoginPriv (PATCHable boolean)

Login Privileges.

example PATCH: {“SSOsettings”: {“UserPrivilege”: {“LoginPriv”: true}}}

SSOsettings.UserPrivilege.PowerandResetPriv

JSONPath: /SSOsettings/UserPrivilege/PowerandResetPriv (PATCHable boolean)

Power and Reset Privileges.

example PATCH: {“SSOsettings”: {“UserPrivilege”: {“PowerandResetPriv”: true}}}

SSOsettings.UserPrivilege.RemoteConsolePriv

JSONPath: /SSOsettings/UserPrivilege/RemoteConsolePriv (PATCHable boolean)

Remote Console Privileges.

example PATCH: {“SSOsettings”: {“UserPrivilege”: {“RemoteConsolePriv”: true}}}

SSOsettings.UserPrivilege.UserConfigPriv

JSONPath: /SSOsettings/UserPrivilege/UserConfigPriv (PATCHable boolean)

User Configuration Privileges.

example PATCH: {“SSOsettings”: {“UserPrivilege”: {“UserConfigPriv”: true}}}

SSOsettings.UserPrivilege.VirtualMediaPriv

JSONPath: /SSOsettings/UserPrivilege/VirtualMediaPriv (PATCHable boolean)

Virtual Media Privileges.

example PATCH: {“SSOsettings”: {“UserPrivilege”: {“VirtualMediaPriv”: true}}}

SSOsettings.UserPrivilege.iLOConfigPriv

JSONPath: /SSOsettings/UserPrivilege/iLOConfigPriv (PATCHable boolean)

iLO Configuration Privileges.

example PATCH: {“SSOsettings”: {“UserPrivilege”: {“iLOConfigPriv”: true}}}

POST Action “ImportCertificate”

Import an HPE Single Sign On Certificate.

Parameters:

“CertType” (string) with one of the following value(s):

“CertInput” (The certificate as a base-64 string)

example “ImportCertificate” action:

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

{
    "CertType": "DirectImportCert", 
    "CertInput": "<base-64 string>"
}

POST Action “ImportDNSName”

Add DNS Name to the record list.

Parameters:

“DNSName” (string)

example “ImportDNSName” action:

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

{
    "DNSName": "<string>"
}

POST Action “DeleteAllSSORecords”

Delete all the Single Sign On records.

example “DeleteAllSSORecords” action:

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

{}

POST Action “DeleteSSORecordbyNumber”

Delete Single Sign On record by record number.

Parameters:

“RecordNumber” (integer)

example “DeleteSSORecordbyNumber” action:

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

{
    "RecordNumber": "<integer>"
}

HpiSCSISoftwareInitiator

The schema definition of UEFI iSCSI Software Initiator boot configuration.

Properties

Resource Instances of this Type:

  • https://{iLO}/redfish/v1/systems/{item}/bios/iscsi

  • https://{iLO}/redfish/v1/systems/{item}/bios/iscsi/settings

AttributeRegistry

JSONPath: /AttributeRegistry (read only string)

This object represents the type property. It represents the schema used for the resource and indicates the version of the schema in the format ....

SettingsResult.definitions.SettingsResult.ETag

JSONPath: /SettingsResult/definitions/SettingsResult/ETag (read only string)

ETag of this resource after the settings have been applied.

SettingsResult.definitions.SettingsResult.Messages[array-item].Message

JSONPath: /SettingsResult/definitions/SettingsResult/Messages/(array index)/Message (read only string)

Human-readable message.

SettingsResult.definitions.SettingsResult.Messages[array-item].MessageID

JSONPath: /SettingsResult/definitions/SettingsResult/Messages/(array index)/MessageID (read only string)

Key for this message, which is used to look up the message in a message registry. The key is in the format ..:.

SettingsResult.definitions.SettingsResult.Messages[array-item].Resolution

JSONPath: /SettingsResult/definitions/SettingsResult/Messages/(array index)/Resolution (read only string)

Instructions for resolving the issue that caused the error.

SettingsResult.definitions.SettingsResult.Messages[array-item].Severity

JSONPath: /SettingsResult/definitions/SettingsResult/Messages/(array index)/Severity (read only enumeration)

This is the severity of the errors.

Defined values:

SettingsResult.definitions.SettingsResult.Operation

JSONPath: /SettingsResult/definitions/SettingsResult/Operation (read only enumeration)

Details about the results of applying the settings.

Defined values:

SettingsResult.definitions.SettingsResult.Time

JSONPath: /SettingsResult/definitions/SettingsResult/Time (read only string)

Time at which the settings were applied.

iSCSIBootSources[array-item].StructuredBootString

JSONPath: /iSCSIBootSources/(array index)/StructuredBootString (read only string)

Identifies this iSCSI UEFI boot option within the server.

iSCSIBootSources[array-item].UEFIDevicePath

JSONPath: /iSCSIBootSources/(array index)/UEFIDevicePath (read only string)

Standardized text representation of the UEFI device path for this boot option, in UTF-8 format.

iSCSIBootSources[array-item].iSCSIAuthenticationMethod

JSONPath: /iSCSIBootSources/(array index)/iSCSIAuthenticationMethod (PATCHable enumeration)

The iSCSI connection authentication method.

Defined values:

iSCSIBootSources[array-item].iSCSIBootAttemptInstance

JSONPath: /iSCSIBootSources/(array index)/iSCSIBootAttemptInstance (PATCHable integer)

Uniquely identifies this iSCSI boot attempt within iSCSIBootSources array. If set to zero, all other properties in the boot option object are ignored (which will delete an existing boot attempt).

iSCSIBootSources[array-item].iSCSIBootAttemptName

JSONPath: /iSCSIBootSources/(array index)/iSCSIBootAttemptName (PATCHable string)

Human readable descriptive name for this iSCSI boot attempt configuration

iSCSIBootSources[array-item].iSCSIBootEnable

JSONPath: /iSCSIBootSources/(array index)/iSCSIBootEnable (PATCHable enumeration)

Enables or Disables iSCSI Boot for a selected iSCSI boot attempt.

Defined values:

iSCSIBootSources[array-item].iSCSIBootLUN

JSONPath: /iSCSIBootSources/(array index)/iSCSIBootLUN (PATCHable string)

The iSCSI boot target Logical Unit Number (LUN), if not obtained from DHCP. This value must follow the SAM-2 spec. E.g. 0001-1234-5678-9ABC. If the digit number is less then 5 characters, a dash character is not required. E.g. 0001. If the lun number is 12345, input 1234-5

iSCSIBootSources[array-item].iSCSIChapSecret

JSONPath: /iSCSIBootSources/(array index)/iSCSIChapSecret (PATCHable string)

The password needed for CHAP authentication. This is applicable only when the Authentication Method is set to CHAP, and the CHAP Type is set to Mutual.

iSCSIBootSources[array-item].iSCSIChapType

JSONPath: /iSCSIBootSources/(array index)/iSCSIChapType (PATCHable enumeration)

The CHAP authentication type. This is applicable only when the Authentication Method is set to CHAP.

Defined values:

iSCSIBootSources[array-item].iSCSIChapUsername

JSONPath: /iSCSIBootSources/(array index)/iSCSIChapUsername (PATCHable string)

The password needed for CHAP authentication. This is applicable only when the Authentication Method is set to CHAP.

iSCSIBootSources[array-item].iSCSIConnectRetry

JSONPath: /iSCSIBootSources/(array index)/iSCSIConnectRetry (PATCHable integer)

The number of times to retry the iSCSI connection. Zero means no retries.

iSCSIBootSources[array-item].iSCSIConnectTimeoutMS

JSONPath: /iSCSIBootSources/(array index)/iSCSIConnectTimeoutMS (PATCHable integer)

The iSCSI connection timeout value in milliseconds.

iSCSIBootSources[array-item].iSCSIInitiatorGateway

JSONPath: /iSCSIBootSources/(array index)/iSCSIInitiatorGateway (PATCHable string)

The gateway address of the iSCSI Initiator, if not configured via DHCP. The address must be an IPv4 or IPv6 address, depending on the IP Address Type.

iSCSIBootSources[array-item].iSCSIInitiatorInfoViaDHCP

JSONPath: /iSCSIBootSources/(array index)/iSCSIInitiatorInfoViaDHCP (PATCHable boolean)

If enabled, the iSCSI Initiator information is configured from DHCP. Otherwise, the iSCSI initiator information must be statically configured.

iSCSIBootSources[array-item].iSCSIInitiatorIpAddress

JSONPath: /iSCSIBootSources/(array index)/iSCSIInitiatorIpAddress (PATCHable string)

The IP Address of the iSCSI Initiator, if not configured via DHCP. The Initiator IP Address is always auto-assigned if IP address type is IPv6. The address must be an IPv4 or IPv6 address, depending on the IP Address Type.

iSCSIBootSources[array-item].iSCSIInitiatorNetmask

JSONPath: /iSCSIBootSources/(array index)/iSCSIInitiatorNetmask (PATCHable string)

The subnet mask of the iSCSI Initiator, if not configured via DHCP. The address must be an IPv4.

iSCSIBootSources[array-item].iSCSIIpAddressType

JSONPath: /iSCSIBootSources/(array index)/iSCSIIpAddressType (PATCHable enumeration)

The iSCSI IP Address type. If set to Auto, IPv4 will be attempted first, followed by IPv6.

Defined values:

iSCSIBootSources[array-item].iSCSINicSource

JSONPath: /iSCSIBootSources/(array index)/iSCSINicSource (PATCHable string)

A BIOS Attribute that describes this selected NIC instance. This must match one of the possible values listed in the iSCSINicSources array.

iSCSIBootSources[array-item].iSCSIReverseChapSecret

JSONPath: /iSCSIBootSources/(array index)/iSCSIReverseChapSecret (PATCHable string)

The password needed for reverse CHAP authentication (from the target to the initiator). This is applicable only when the Authentication Method is set to CHAP, and the CHAP Type is set to Mutual.

iSCSIBootSources[array-item].iSCSIReverseChapUsername

JSONPath: /iSCSIBootSources/(array index)/iSCSIReverseChapUsername (PATCHable string)

User Name for reverse CHAP authentication (from the target to the initiator). This is applicable only when the Authentication Method is set to CHAP, and the CHAP Type is set to Mutual.

iSCSIBootSources[array-item].iSCSITargetInfoViaDHCP

JSONPath: /iSCSIBootSources/(array index)/iSCSITargetInfoViaDHCP (PATCHable boolean)

If enabled, the iSCSI target information are configured from DHCP. Otherwise, the iSCSI target information must be statically configured.

iSCSIBootSources[array-item].iSCSITargetIpAddress

JSONPath: /iSCSIBootSources/(array index)/iSCSITargetIpAddress (PATCHable string)

The IP Address of the iSCSI Target, if not obtained from DHCP. The address must be an IPv4 or IPv6 address, depending on the IP Address Type.

iSCSIBootSources[array-item].iSCSITargetName

JSONPath: /iSCSIBootSources/(array index)/iSCSITargetName (PATCHable string)

The worldwide unique iSCSI Qualified Name (IQN) of this iSCSI target. Only the IQN format is accepted. EUI format is not supported (for example, ‘iqn.1991-05.com.microsoft:iscsitarget-iscsidisk-target’).

iSCSIBootSources[array-item].iSCSITargetTcpPort

JSONPath: /iSCSIBootSources/(array index)/iSCSITargetTcpPort (PATCHable integer)

The iSCSI Target TCP Port number, if not obtained from DHCP.

iSCSIInitiatorName

JSONPath: /iSCSIInitiatorName (PATCHable string)

The worldwide unique iSCSI Qualified Name (IQN) of this iSCSI Initiator. Only IQN format is accepted. EUI format is not supported (for example, ‘iqn.1986-03.com.hp:init.sn-123456’).

LogEntry

Resources of type “LogEntry” are members of a log entry parent collection. For the Integrated Management Log (IML) a client may create a Maintenance Note log entry by performing a POST of a JSON object to the parent log entry collection with the following format: {“EntryCode”: “Maintenance”, “Message”:“text message here”}

e.g. Create a Maintenance Note. POST json { "EntryCode": "Maintenance", "Message": "text message here" }

Properties

Resource Instances of this Type:

  • https://{iLO}/redfish/v1/systems/{item}/logservices/iml/entries/{item}

  • https://{iLO}/redfish/v1/managers/{item}/logservices/iel/entries/{item}

Created

JSONPath: /Created (read only string)

The date and time when the log entry was created, for example, 2014-04-15T00:38:00Z.

EntryType

JSONPath: /EntryType (read only enumeration)

The log entry type.

Defined values:

Message

JSONPath: /Message (read only string)

The log entry details.

Number

JSONPath: /Number (read only integer)

The number of duplicate log entries, with the possible exception of timestamps, that are not in the collection.

Class

JSONPath: /Oem/Hp/Class (read only integer)

The IML event class.

Code

JSONPath: /Oem/Hp/Code (read only integer)

The IML event code.

EventNumber

JSONPath: /Oem/Hp/EventNumber (read only integer)

The event log identification number. Events are numbered in the order in which they are generated.

Repaired

JSONPath: /Oem/Hp/Repaired (PATCHable boolean)

The repaired status of the IML event.

example PATCH: {“Oem”: {“Hp”: {“Repaired”: true}}}

Updated

JSONPath: /Oem/Hp/Updated (read only string)

The date and time of the latest log entry update, for example, 2014-04-15T00:38:00Z.

OemRecordFormat

JSONPath: /OemRecordFormat (read only enumeration)

The format of an OEM record.

Defined values:

RecordId

JSONPath: /RecordId (read only integer)

The log entry ID.

Severity

JSONPath: /Severity (read only enumeration)

The log entry severity.

Defined values:

LogService

This is the log service for Integrated Management Log and iLO 4 Event Log.

Properties

Resource Instances of this Type:

  • https://{iLO}/redfish/v1/systems/{item}/logservices/iml

  • https://{iLO}/redfish/v1/managers/{item}/logservices/iel

MaxNumberOfRecords

JSONPath: /MaxNumberOfRecords (read only integer)

The maximum number of log entries.

OverWritePolicy

JSONPath: /OverWritePolicy (read only enumeration)

When the log is full, the overwrite policy is enforced.

Defined values:

POST Action “ClearLog”

Clears the Integrated Management Log or iLO Event Log depending upon the resource instance.

example “ClearLog” action:

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

{}

Manager

This represents iLO 4 in the HPE server.

Properties

Resource Instances of this Type:

  • https://{iLO}/redfish/v1/managers/{item}

CommandShell.Enabled

JSONPath: /CommandShell/Enabled (PATCHable boolean)

Indicates if the Command Shell service is enabled for this manager.

example PATCH: {“CommandShell”: {“Enabled”: true}}

CommandShell.MaxConcurrentSessions

JSONPath: /CommandShell/MaxConcurrentSessions (read only integer)

This is the maximum number of Command Shell sessions, regardless of protocol, that this manager supports.

CommandShell.ServiceEnabled

JSONPath: /CommandShell/ServiceEnabled (PATCHable boolean)

Indicates if the Command Shell service is enabled for this manager.

example PATCH: {“CommandShell”: {“ServiceEnabled”: true}}

Firmware.Current.VersionString

JSONPath: /Firmware/Current/VersionString (read only string)

This string represents the version of the firmware image.

FirmwareVersion

JSONPath: /FirmwareVersion (read only string)

The firmware version of this Manager

GraphicalConsole.Enabled

JSONPath: /GraphicalConsole/Enabled (PATCHable boolean)

Indicates if the Graphical Console service is enabled for this manager.

example PATCH: {“GraphicalConsole”: {“Enabled”: true}}

GraphicalConsole.MaxConcurrentSessions

JSONPath: /GraphicalConsole/MaxConcurrentSessions (read only integer)

Indicates the maximum number of Graphical Console sessions, regardless of protocol, this manager supports.

GraphicalConsole.ServiceEnabled

JSONPath: /GraphicalConsole/ServiceEnabled (PATCHable boolean)

Indicates if the Command Shell service is enabled for this manager.

example PATCH: {“GraphicalConsole”: {“ServiceEnabled”: true}}

ManagerType

JSONPath: /ManagerType (read only enumeration)

This property is the manager type for this resource.

Defined values:

Model

JSONPath: /Model (read only string)

Model name of the manager.

ClearRestApiStatus

JSONPath: /Oem/Hp/ClearRestApiStatus (read only enumeration)

Status of external provider data in NVRAM.

Defined values:

FederationConfig.IPv6MulticastScope

JSONPath: /Oem/Hp/FederationConfig/IPv6MulticastScope (PATCHable enumeration)

The IPv6 network scope of multicast announcements.

example PATCH: {“Oem”: {“Hp”: {“FederationConfig”: {“IPv6MulticastScope”: “Site”}}}}

Defined values:

FederationConfig.MulticastAnnouncementInterval

JSONPath: /Oem/Hp/FederationConfig/MulticastAnnouncementInterval (PATCHable integer)

The frequency in Seconds at which the iLO system announces itself on the network. A value of 0 disables multicast announcments.

example PATCH: {“Oem”: {“Hp”: {“FederationConfig”: {“MulticastAnnouncementInterval”: <integer-value>}}}}

FederationConfig.MulticastDiscovery

JSONPath: /Oem/Hp/FederationConfig/MulticastDiscovery (PATCHable enumeration)

Enables or Disables Multicast Discovery for the local iLO system.

example PATCH: {“Oem”: {“Hp”: {“FederationConfig”: {“MulticastDiscovery”: “Disabled”}}}}

Defined values:

FederationConfig.MulticastTimeToLive

JSONPath: /Oem/Hp/FederationConfig/MulticastTimeToLive (PATCHable integer)

The maximum number of switches a multicast announcement will traverse before being discarded.

example PATCH: {“Oem”: {“Hp”: {“FederationConfig”: {“MulticastTimeToLive”: <integer-value>}}}}

FederationConfig.iLOFederationManagement

JSONPath: /Oem/Hp/FederationConfig/iLOFederationManagement (PATCHable enumeration)

Enables or Disables iLO Federation features for the local iLO system.

example PATCH: {“Oem”: {“Hp”: {“FederationConfig”: {“iLOFederationManagement”: “Disabled”}}}}

Defined values:

Firmware.Backup.BuildNumber

JSONPath: /Oem/Hp/Firmware/Backup/BuildNumber (read only integer)

The build number of the firmware.

Firmware.Backup.BuildNumberString

JSONPath: /Oem/Hp/Firmware/Backup/BuildNumberString (read only string)

The string version of the build number of the firmware.

Firmware.Backup.Date

JSONPath: /Oem/Hp/Firmware/Backup/Date (read only string)

The build date of the firmware.

Firmware.Backup.DebugBuild

JSONPath: /Oem/Hp/Firmware/Backup/DebugBuild (read only boolean)

True if the firmware is a debug build; False if it is not.

Firmware.Backup.Family

JSONPath: /Oem/Hp/Firmware/Backup/Family (read only string)

The family of the firmware.

Firmware.Backup.MajorVersion

JSONPath: /Oem/Hp/Firmware/Backup/MajorVersion (read only integer)

The major version of the firmware.

Firmware.Backup.MinorVersion

JSONPath: /Oem/Hp/Firmware/Backup/MinorVersion (read only integer)

The minor version of the firmware.

Firmware.Backup.Time

JSONPath: /Oem/Hp/Firmware/Backup/Time (read only string)

The build time of the firmware.

Firmware.Backup.VersionString

JSONPath: /Oem/Hp/Firmware/Backup/VersionString (read only string)

The version string of the firmware. This value might be null if VersionString is unavailable.

Firmware.Bootblock.BuildNumber

JSONPath: /Oem/Hp/Firmware/Bootblock/BuildNumber (read only integer)

The build number of the firmware.

Firmware.Bootblock.BuildNumberString

JSONPath: /Oem/Hp/Firmware/Bootblock/BuildNumberString (read only string)

The string version of the build number of the firmware.

Firmware.Bootblock.Date

JSONPath: /Oem/Hp/Firmware/Bootblock/Date (read only string)

The build date of the firmware.

Firmware.Bootblock.DebugBuild

JSONPath: /Oem/Hp/Firmware/Bootblock/DebugBuild (read only boolean)

True if the firmware is a debug build; False if it is not.

Firmware.Bootblock.Family

JSONPath: /Oem/Hp/Firmware/Bootblock/Family (read only string)

The family of the firmware.

Firmware.Bootblock.MajorVersion

JSONPath: /Oem/Hp/Firmware/Bootblock/MajorVersion (read only integer)

The major version of the firmware.

Firmware.Bootblock.MinorVersion

JSONPath: /Oem/Hp/Firmware/Bootblock/MinorVersion (read only integer)

The minor version of the firmware.

Firmware.Bootblock.Time

JSONPath: /Oem/Hp/Firmware/Bootblock/Time (read only string)

The build time of the firmware.

Firmware.Bootblock.VersionString

JSONPath: /Oem/Hp/Firmware/Bootblock/VersionString (read only string)

The version string of the firmware. This value might be null if VersionString is unavailable.

Firmware.Current.BuildNumber

JSONPath: /Oem/Hp/Firmware/Current/BuildNumber (read only integer)

The build number of the firmware.

Firmware.Current.BuildNumberString

JSONPath: /Oem/Hp/Firmware/Current/BuildNumberString (read only string)

The string version of the build number of the firmware.

Firmware.Current.Date

JSONPath: /Oem/Hp/Firmware/Current/Date (read only string)

The build date of the firmware.

Firmware.Current.DebugBuild

JSONPath: /Oem/Hp/Firmware/Current/DebugBuild (read only boolean)

True if the firmware is a debug build; False if it is not.

Firmware.Current.Family

JSONPath: /Oem/Hp/Firmware/Current/Family (read only string)

The family of the firmware.

Firmware.Current.MajorVersion

JSONPath: /Oem/Hp/Firmware/Current/MajorVersion (read only integer)

The major version of the firmware.

Firmware.Current.MinorVersion

JSONPath: /Oem/Hp/Firmware/Current/MinorVersion (read only integer)

The minor version of the firmware.

Firmware.Current.Time

JSONPath: /Oem/Hp/Firmware/Current/Time (read only string)

The build time of the firmware.

Firmware.Current.VersionString

JSONPath: /Oem/Hp/Firmware/Current/VersionString (read only string)

The version string of the firmware. This value might be null if VersionString is unavailable.

Firmware.Pending.BuildNumber

JSONPath: /Oem/Hp/Firmware/Pending/BuildNumber (read only integer)

The build number of the firmware.

Firmware.Pending.BuildNumberString

JSONPath: /Oem/Hp/Firmware/Pending/BuildNumberString (read only string)

The string version of the build number of the firmware.

Firmware.Pending.Date

JSONPath: /Oem/Hp/Firmware/Pending/Date (read only string)

The build date of the firmware.

Firmware.Pending.DebugBuild

JSONPath: /Oem/Hp/Firmware/Pending/DebugBuild (read only boolean)

True if the firmware is a debug build; False if it is not.

Firmware.Pending.Family

JSONPath: /Oem/Hp/Firmware/Pending/Family (read only string)

The family of the firmware.

Firmware.Pending.MajorVersion

JSONPath: /Oem/Hp/Firmware/Pending/MajorVersion (read only integer)

The major version of the firmware.

Firmware.Pending.MinorVersion

JSONPath: /Oem/Hp/Firmware/Pending/MinorVersion (read only integer)

The minor version of the firmware.

Firmware.Pending.Time

JSONPath: /Oem/Hp/Firmware/Pending/Time (read only string)

The build time of the firmware.

Firmware.Pending.VersionString

JSONPath: /Oem/Hp/Firmware/Pending/VersionString (read only string)

The version string of the firmware. This value might be null if VersionString is unavailable.

Firmware.definitions.HpFWVersion.BuildNumber

JSONPath: /Oem/Hp/Firmware/definitions/HpFWVersion/BuildNumber (read only integer)

The build number of the firmware.

Firmware.definitions.HpFWVersion.BuildNumberString

JSONPath: /Oem/Hp/Firmware/definitions/HpFWVersion/BuildNumberString (read only string)

The string version of the build number of the firmware.

Firmware.definitions.HpFWVersion.Date

JSONPath: /Oem/Hp/Firmware/definitions/HpFWVersion/Date (read only string)

The build date of the firmware.

Firmware.definitions.HpFWVersion.DebugBuild

JSONPath: /Oem/Hp/Firmware/definitions/HpFWVersion/DebugBuild (read only boolean)

True if the firmware is a debug build; False if it is not.

Firmware.definitions.HpFWVersion.Family

JSONPath: /Oem/Hp/Firmware/definitions/HpFWVersion/Family (read only string)

The family of the firmware.

Firmware.definitions.HpFWVersion.MajorVersion

JSONPath: /Oem/Hp/Firmware/definitions/HpFWVersion/MajorVersion (read only integer)

The major version of the firmware.

Firmware.definitions.HpFWVersion.MinorVersion

JSONPath: /Oem/Hp/Firmware/definitions/HpFWVersion/MinorVersion (read only integer)

The minor version of the firmware.

Firmware.definitions.HpFWVersion.Time

JSONPath: /Oem/Hp/Firmware/definitions/HpFWVersion/Time (read only string)

The build time of the firmware.

Firmware.definitions.HpFWVersion.VersionString

JSONPath: /Oem/Hp/Firmware/definitions/HpFWVersion/VersionString (read only string)

The version string of the firmware. This value might be null if VersionString is unavailable.

License.LicenseKey

JSONPath: /Oem/Hp/License/LicenseKey (read only string)

The installed license key.

License.LicenseString

JSONPath: /Oem/Hp/License/LicenseString (read only string)

Describes the type of license installed on management processor.

License.LicenseType

JSONPath: /Oem/Hp/License/LicenseType (read only string)

Indicates whether the license is Perpetual or Evaluation.

RequiredLoginForiLORBSU

JSONPath: /Oem/Hp/RequiredLoginForiLORBSU (PATCHable boolean)

Determines whether a user-credential prompt is displayed when a user accesses the iLO RBSU or the iLO 4 Configuration Utility. The following settings are valid: Enabled-A login dialog box opens when a user accesses the iLO RBSU or the iLO 4 Configuration Utility. Disabled (default)-No login is required when a user accesses the iLO RBSU or the iLO 4 Configuration Utility.

example PATCH: {“Oem”: {“Hp”: {“RequiredLoginForiLORBSU”: true}}}

SerialCLISpeed

JSONPath: /Oem/Hp/SerialCLISpeed (PATCHable integer)

Serial command line interface speed in bits/second.

example PATCH: {“Oem”: {“Hp”: {“SerialCLISpeed”: <integer-value>}}}

SerialCLIStatus

JSONPath: /Oem/Hp/SerialCLIStatus (PATCHable enumeration)

Status of serial command line interface.

example PATCH: {“Oem”: {“Hp”: {“SerialCLIStatus”: “EnabledNoAuth”}}}

Defined values:

VSPLogDownloadEnabled

JSONPath: /Oem/Hp/VSPLogDownloadEnabled (PATCHable boolean)

This property enables or disables download of Virtual Serial Port (VSP) log.

example PATCH: {“Oem”: {“Hp”: {“VSPLogDownloadEnabled”: true}}}

iLOFunctionalityRequired

JSONPath: /Oem/Hp/iLOFunctionalityRequired (read only boolean)

iLO is required and can’t be disabled on this platform (usually blades).

iLORBSUEnabled

JSONPath: /Oem/Hp/iLORBSUEnabled (PATCHable boolean)

Enables or disables the iLO RBSU or the iLO 4 Configuration Utility. The following settings are valid: Enabled (default)-On servers that support the iLO RBSU, pressing F8 during POST starts the iLO RBSU. On servers that support UEFI, the iLO 4 Configuration Utility is available when you access the UEFI System Utilities. Disabled-On servers that support the iLO RBSU, pressing F8 during POST will not start the iLO RBSU. On servers that support UEFI, the iLO 4 Configuration Utility is not available when you access the UEFI System Utilities.

example PATCH: {“Oem”: {“Hp”: {“iLORBSUEnabled”: true}}}

iLOSelfTestResults[array-item].Notes

JSONPath: /Oem/Hp/iLOSelfTestResults/(array index)/Notes (read only string)

Additional Information (if any) about the Self Test.

iLOSelfTestResults[array-item].SelfTestName

JSONPath: /Oem/Hp/iLOSelfTestResults/(array index)/SelfTestName (read only enumeration)

iLO Self Test Name.

Defined values:

iLOSelfTestResults[array-item].Status

JSONPath: /Oem/Hp/iLOSelfTestResults/(array index)/Status (read only enumeration)

Status of the Self Test.

Defined values:

JSONPath: /Oem/Hp/Links/FederationDispatch/extref (read only URI reference) with the Redfish OData-Version header

JSONPath: /Oem/Hp/links/FederationDispatch/extref (read only URI reference) without the Redfish OData-Version header

Federation commands are dispatched to the URI described by this property.

JSONPath: /Oem/Hp/Links/VSPLogLocation/extref (read only string) with the Redfish OData-Version header

JSONPath: /Oem/Hp/links/VSPLogLocation/extref (read only string) without the Redfish OData-Version header

Redundancy.MaxNumSupported

JSONPath: /Redundancy/MaxNumSupported (read only integer)

This is the maximum number of members allowable for this particular managers redundancy, including this manager.

Redundancy.MemberId

JSONPath: /Redundancy/MemberId (PATCHable string)

This is the identifier for the member within the collection.

Redundancy.MinNumNeeded

JSONPath: /Redundancy/MinNumNeeded (read only integer)

This is the minumum number of managers needed for this manager to be redundant.

Redundancy.Mode

JSONPath: /Redundancy/Mode (read only enumeration)

This is the redundancy mode of the group.

Defined values:

Redundancy.Status.Health

JSONPath: /Redundancy/Status/Health (read only enumeration)

This represents the health state of this resource in the absence of its dependent resources.

Defined values:

Redundancy.Status.HealthRollUp

JSONPath: /Redundancy/Status/HealthRollUp (read only enumeration)

This represents the overall health state from the view of this resource.

Defined values:

Redundancy.Status.HealthRollup

JSONPath: /Redundancy/Status/HealthRollup (read only enumeration)

This represents the overall health state from the view of this resource.

Defined values:

Redundancy.Status.State

JSONPath: /Redundancy/Status/State (read only enumeration)

This indicates the known state of the resource, such as if it is enabled.

Defined values:

SerialConsole.Enabled

JSONPath: /SerialConsole/Enabled (PATCHable boolean)

Indicates if the Serial Console service is enabled for this manager.

example PATCH: {“SerialConsole”: {“Enabled”: true}}

SerialConsole.MaxConcurrentSessions

JSONPath: /SerialConsole/MaxConcurrentSessions (read only integer)

This is the maximum number of Serial Console sessions, regardless of protocol, that this manager supports.

SerialConsole.ServiceEnabled

JSONPath: /SerialConsole/ServiceEnabled (PATCHable boolean)

Indicates if the Command Shell service is enabled for this manager.

example PATCH: {“SerialConsole”: {“ServiceEnabled”: true}}

Status.Health

JSONPath: /Status/Health (read only enumeration)

This represents the health state of this resource in the absence of its dependent resources.

Defined values:

Status.HealthRollUp

JSONPath: /Status/HealthRollUp (read only enumeration)

This represents the overall health state from the view of this resource.

Defined values:

Status.HealthRollup

JSONPath: /Status/HealthRollup (read only enumeration)

This represents the overall health state from the view of this resource.

Defined values:

Status.State

JSONPath: /Status/State (read only enumeration)

This indicates the known state of the resource, such as if it is enabled.

Defined values:

UUID

JSONPath: /UUID (read only string)

This is a universally unique identifier that software (for example, HP SIM) uses to uniquely identify this manager. The UUID is assigned when the system is manufactured.

POST Action “Reset”

Resets iLO 4. iLO 4 will be unresponsive during the reset process and the client should expect to wait for up to a minute for functionality to be restored.

example “Reset” action:

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

{}

POST Action “ClearRestApiState”

Clears the persistent state of the REST API. Some portions of the API may not be available until after the server reboots.

example “ClearRestApiState” action:

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

{}

POST Action “iLOFunctionality”

Specifies whether iLO functionality is available. The following settings are valid: Enabled (default)-The iLO network is available and communications with operating system drivers are active. Disabled-The iLO network and communications with operating system drivers are terminated when iLO Functionality is disabled. For ProLiant Gen8 servers only: To re-enable iLO functionality, disable iLO security with the system maintenance switch, and then use the iLO RBSU to set iLO Functionality to Enabled. For more information about using the system maintenance switch, see the Maintenance and Service Guide for your server model. For ProLiant Gen9 servers only: To re-enable iLO functionality, use the iLO 4 Configuration Utility (in the UEFI System Utilities) to set iLO Functionality to Enabled. For more information see the HP UEFI System Utilities User Guide. The action resets/reboots the manager. iLO functionality cannot be disabled on server blades.

The “iLOFunctionality” action disables iLO 4’s accessibility via the network and resets iLO 4. This should be used with caution as it will render iLO unable to respond to further network operations (including REST operations) until iLO 4 is re-enabled using the RBSU menu.

example “iLOFunctionality” action:

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

{}

POST Action “ResetToFactoryDefaults”

Resets the iLO to Factory Defaults.

ResetToFactoryDefaults performs the following:

Parameters:

“ResetType” (string) with the value “Default”

example “ResetToFactoryDefaults” action:

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

{
    "ResetType": "Default"
}

ManagerAccount

This represents a user account on the REST API service.

You may create an iLO account by building a request JSON object and POSTing to the Accounts collection pointed to by the AccountService.

POST to https://redfish/v1/accountservice/accounts/

{
    "UserName": "the name used to log into the API",
    "Password": "newpassword",
    "Oem": {
        "Hp": {
            "Privileges": {
                "RemoteConsolePriv": true,
                "VirtualMediaPriv": true,
                "UserConfigPriv": true,
                "iLOConfigPriv": true,
                "VirtualPowerAndResetPriv": true
            },
            "LoginName": "the friendly user name"
        }
    }
}

Properties

Resource Instances of this Type:

  • https://{iLO}/redfish/v1/accountservice/accounts/{item}

LoginName

JSONPath: /Oem/Hp/LoginName (PATCHable string)

Descriptive login name that helps to easily identify the owner of each user name. The login name does not have to be the same as the user name and must use printable characters. The maximum length for a user name is 39 characters.

example PATCH: {“Oem”: {“Hp”: {“LoginName”: “<string-value>”}}}

Privileges.LoginPriv

JSONPath: /Oem/Hp/Privileges/LoginPriv (PATCHable boolean)

This privilege enables a user to log in to management processor. All local accounts have the login privilege. This privilege is added automatically if it is not specified.

example PATCH: {“Oem”: {“Hp”: {“Privileges”: {“LoginPriv”: true}}}}

Privileges.RemoteConsolePriv

JSONPath: /Oem/Hp/Privileges/RemoteConsolePriv (PATCHable boolean)

This privilege enables a user to remotely access the host system Remote Console, including video, keyboard, and mouse control.

example PATCH: {“Oem”: {“Hp”: {“Privileges”: {“RemoteConsolePriv”: true}}}}

Privileges.UserConfigPriv

JSONPath: /Oem/Hp/Privileges/UserConfigPriv (PATCHable boolean)

This privilege enables a user to add, edit, and delete local management processor user accounts. A user with this privilege can change privileges for all users.

example PATCH: {“Oem”: {“Hp”: {“Privileges”: {“UserConfigPriv”: true}}}}

Privileges.VirtualMediaPriv

JSONPath: /Oem/Hp/Privileges/VirtualMediaPriv (PATCHable boolean)

This privilege enables a user to use the Virtual Media feature on the host system.

example PATCH: {“Oem”: {“Hp”: {“Privileges”: {“VirtualMediaPriv”: true}}}}

Privileges.VirtualPowerAndResetPriv

JSONPath: /Oem/Hp/Privileges/VirtualPowerAndResetPriv (PATCHable boolean)

This privilege enables a user to power-cycle or reset the host system. These activities interrupt system availability. A user with this privilege can diagnose the system by using the Generate NMI to System button.

example PATCH: {“Oem”: {“Hp”: {“Privileges”: {“VirtualPowerAndResetPriv”: true}}}}

Privileges.iLOConfigPriv

JSONPath: /Oem/Hp/Privileges/iLOConfigPriv (PATCHable boolean)

This privilege enables a user to configure most management processor settings, including security settings, and to remotely update the management processor firmware. This privilege does not enable local user account administration.

example PATCH: {“Oem”: {“Hp”: {“Privileges”: {“iLOConfigPriv”: true}}}}

Password

JSONPath: /Password (PATCHable string)

The password used to log in to the management processor. The maximum length for a password is 39 characters. The minimum length for a password is specified in the MinPasswordLength property of the AccountService schema.

example PATCH: {“Password”: “<string-value>”}

UserName

JSONPath: /UserName (PATCHable string)

The name used to log in to the management processor. The user name does not have to be the same as the login name. The maximum length for the user name is 39 characters. The user name must use printable characters.

example PATCH: {“UserName”: “<string-value>”}

ManagerNetworkProtocol

This resource is used to obtain or modify the network services managed by this manager.

PATCHing the following properties will not take effect until iLO 4 is reset. * HTTP/Port * HTTPS/Port * SSH/Enabled * SSH/Port

iLO 4 responds with “ResetRequired” when the following properties are PATCHed:

Properties

Resource Instances of this Type:

  • https://{iLO}/redfish/v1/managers/{item}/networkservice

FQDN

JSONPath: /FQDN (read only string)

The fully-qualified domain name of the manager that is obtained by DNS and includes the host name and top-level domain name.

HTTP.Enabled

JSONPath: /HTTP/Enabled (read only boolean)

Indicates whether HTTP is enabled or disabled.

HTTP.Port

JSONPath: /HTTP/Port (PATCHable integer)

The HTTP port number. NOTE: When this field is modified, the Manager will reset automatically.

example PATCH: {“HTTP”: {“Port”: <integer-value>}}

HTTP.ProtocolEnabled

JSONPath: /HTTP/ProtocolEnabled (read only boolean)

Indicates whether HTTP is enabled or disabled.

HTTPS.Enabled

JSONPath: /HTTPS/Enabled (read only boolean)

Indicates whether HTTPS/SSL is enabled or disabled.

HTTPS.Port

JSONPath: /HTTPS/Port (PATCHable integer)

The HTTPS/SSL port number. NOTE: When this field is modified, the Manager will reset automatically.

example PATCH: {“HTTPS”: {“Port”: <integer-value>}}

HTTPS.ProtocolEnabled

JSONPath: /HTTPS/ProtocolEnabled (read only boolean)

Indicates whether HTTPS/SSL is enabled or disabled.

HostName

JSONPath: /HostName (PATCHable string)

The host name of the manager that is obtained by DNS and does not include any domain information.

example PATCH: {“HostName”: “<string-value>”}

IPMI.Enabled

JSONPath: /IPMI/Enabled (PATCHable boolean)

Indicates whether IPMI over LAN is enabled for the manager.

example PATCH: {“IPMI”: {“Enabled”: true}}

IPMI.Port

JSONPath: /IPMI/Port (PATCHable integer)

The IPMI over LAN port number.

example PATCH: {“IPMI”: {“Port”: <integer-value>}}

IPMI.ProtocolEnabled

JSONPath: /IPMI/ProtocolEnabled (PATCHable boolean)

Indicates whether IPMI over LAN is enabled for the manager.

example PATCH: {“IPMI”: {“ProtocolEnabled”: true}}

KVMIP.Enabled

JSONPath: /KVMIP/Enabled (read only boolean)

Indicates whether KVM-IP is enabled for the manager.

KVMIP.Port

JSONPath: /KVMIP/Port (PATCHable integer)

The KVM-IP port number.

example PATCH: {“KVMIP”: {“Port”: <integer-value>}}

KVMIP.ProtocolEnabled

JSONPath: /KVMIP/ProtocolEnabled (read only boolean)

Indicates whether KVM-IP is enabled for the manager.

AlertMailEmail

JSONPath: /Oem/Hp/AlertMailEmail (PATCHable string)

The destination email address for email alerts.

example PATCH: {“Oem”: {“Hp”: {“AlertMailEmail”: “<string-value>”}}}

AlertMailEnabled

JSONPath: /Oem/Hp/AlertMailEnabled (PATCHable boolean)

Indicates whether AlertMail is enabled. This can be enabled only when the properties AlertMailEmail, AlertMailSenderDomain and AlertMailSMTPServer are set or not empty.

example PATCH: {“Oem”: {“Hp”: {“AlertMailEnabled”: true}}}

AlertMailSMTPPort

JSONPath: /Oem/Hp/AlertMailSMTPPort (PATCHable integer)

The SMTP server port number.

example PATCH: {“Oem”: {“Hp”: {“AlertMailSMTPPort”: <integer-value>}}}

AlertMailSMTPServer

JSONPath: /Oem/Hp/AlertMailSMTPServer (PATCHable string)

The IP address or DNS name of the SMTP server or the Mail Submission Agent (MSA).

example PATCH: {“Oem”: {“Hp”: {“AlertMailSMTPServer”: “<string-value>”}}}

AlertMailSenderDomain

JSONPath: /Oem/Hp/AlertMailSenderDomain (PATCHable string)

The domain name for the sender email address.

example PATCH: {“Oem”: {“Hp”: {“AlertMailSenderDomain”: “<string-value>”}}}

ConfigurationSettings

JSONPath: /Oem/Hp/ConfigurationSettings (read only enumeration)

State of the currently displayed configuration settings.

Defined values:

EnforceAES3DESEncryption

JSONPath: /Oem/Hp/EnforceAES3DESEncryption (PATCHable boolean)

Indicates whether AES/3DES encryption is enforced for the management processor. When enabled, the management processor accepts only those connections that use AES or 3DES ciphers. The management processor will automatically reset when this field is modified.

example PATCH: {“Oem”: {“Hp”: {“EnforceAES3DESEncryption”: true}}}

FederationEnabled

JSONPath: /Oem/Hp/FederationEnabled (PATCHable boolean)

Indicates whether management processor federation management is enabled or disabled.

example PATCH: {“Oem”: {“Hp”: {“FederationEnabled”: true}}}

FederationSupported

JSONPath: /Oem/Hp/FederationSupported (read only boolean)

Indicates whether management processor federation is supported.

HPSystemManagementHomepageAddress

JSONPath: /Oem/Hp/HPSystemManagementHomepageAddress (PATCHable string)

The IP address or FQDN of the HP System Management Homepage (HP SMH) server.

example PATCH: {“Oem”: {“Hp”: {“HPSystemManagementHomepageAddress”: “<string-value>”}}}

RemoteSyslogEnabled

JSONPath: /Oem/Hp/RemoteSyslogEnabled (PATCHable boolean)

Indicates whether Remote Syslog is enabled. When enabled, management processor sends notification messages to the specified Syslog server. This can be enabled only when the property RemoteSyslogServer is set or not empty.

example PATCH: {“Oem”: {“Hp”: {“RemoteSyslogEnabled”: true}}}

RemoteSyslogPort

JSONPath: /Oem/Hp/RemoteSyslogPort (PATCHable integer)

The port number through which the Syslog server is listening.

example PATCH: {“Oem”: {“Hp”: {“RemoteSyslogPort”: <integer-value>}}}

RemoteSyslogServer

JSONPath: /Oem/Hp/RemoteSyslogServer (PATCHable string)

The IP address, FQDN, IPv6 name, or short name of the server running the Syslog service.

example PATCH: {“Oem”: {“Hp”: {“RemoteSyslogServer”: “<string-value>”}}}

SNMPTrapPort

JSONPath: /Oem/Hp/SNMPTrapPort (PATCHable integer)

The SNMP trap port number.

example PATCH: {“Oem”: {“Hp”: {“SNMPTrapPort”: <integer-value>}}}

SerialOverLanLogging

JSONPath: /Oem/Hp/SerialOverLanLogging (PATCHable boolean)

Indicates whether Serial Over LAN (SOL) or Virtual Serial Port (VSP) logging is enabled.

example PATCH: {“Oem”: {“Hp”: {“SerialOverLanLogging”: true}}}

XMLResponseEnabled

JSONPath: /Oem/Hp/XMLResponseEnabled (PATCHable boolean)

Determines whether management processor responds to anonymous XML discovery requests.

example PATCH: {“Oem”: {“Hp”: {“XMLResponseEnabled”: true}}}

SNMP.Enabled

JSONPath: /SNMP/Enabled (PATCHable boolean)

Indicates whether SNMP is enabled for the manager.

example PATCH: {“SNMP”: {“Enabled”: true}}

SNMP.Port

JSONPath: /SNMP/Port (PATCHable integer)

The SNMP port number.

example PATCH: {“SNMP”: {“Port”: <integer-value>}}

SNMP.ProtocolEnabled

JSONPath: /SNMP/ProtocolEnabled (PATCHable boolean)

Indicates whether SNMP is enabled for the manager.

example PATCH: {“SNMP”: {“ProtocolEnabled”: true}}

SSDP.Enabled

JSONPath: /SSDP/Enabled (PATCHable boolean)

Indicates whether SSDP is enabled for the manager.

example PATCH: {“SSDP”: {“Enabled”: true}}

SSDP.NotifyIPv6Scope

JSONPath: /SSDP/NotifyIPv6Scope (PATCHable enumeration)

The scope for IPv6 Notify messages for SSDP.

example PATCH: {“SSDP”: {“NotifyIPv6Scope”: “Site”}}

Defined values:

SSDP.NotifyMulticastIntervalSeconds

JSONPath: /SSDP/NotifyMulticastIntervalSeconds (PATCHable integer)

Indicates how often multicast is performed for SSDP.

example PATCH: {“SSDP”: {“NotifyMulticastIntervalSeconds”: <integer-value>}}

SSDP.NotifyTTL

JSONPath: /SSDP/NotifyTTL (PATCHable integer)

The Time to Live (TTL) hop count for SSDP Notify messages.

example PATCH: {“SSDP”: {“NotifyTTL”: <integer-value>}}

SSDP.Port

JSONPath: /SSDP/Port (read only integer)

The SSDP port number.

SSDP.ProtocolEnabled

JSONPath: /SSDP/ProtocolEnabled (PATCHable boolean)

Indicates whether SSDP is enabled for the manager.

example PATCH: {“SSDP”: {“ProtocolEnabled”: true}}

SSH.Enabled

JSONPath: /SSH/Enabled (PATCHable boolean)

Indicates whether SSH is enabled for the manager. NOTE: When this field is modified, the Manager will reset automatically.

example PATCH: {“SSH”: {“Enabled”: true}}

SSH.Port

JSONPath: /SSH/Port (PATCHable integer)

The SSH port number. NOTE: When this field is modified, the Manager will reset automatically.

example PATCH: {“SSH”: {“Port”: <integer-value>}}

SSH.ProtocolEnabled

JSONPath: /SSH/ProtocolEnabled (PATCHable boolean)

Indicates whether SSH is enabled for the manager. NOTE: When this field is modified, the Manager will reset automatically.

example PATCH: {“SSH”: {“ProtocolEnabled”: true}}

SessionTimeoutMinutes

JSONPath: /SessionTimeoutMinutes (PATCHable integer)

The session timeout (minutes). A zero value indicates infinite timeout.

example PATCH: {“SessionTimeoutMinutes”: <integer-value>}

Status.Health

JSONPath: /Status/Health (read only enumeration)

This represents the health state of this resource in the absence of its dependent resources.

Defined values:

Status.HealthRollUp

JSONPath: /Status/HealthRollUp (read only enumeration)

This represents the overall health state from the view of this resource.

Defined values:

Status.HealthRollup

JSONPath: /Status/HealthRollup (read only enumeration)

This represents the overall health state from the view of this resource.

Defined values:

Status.State

JSONPath: /Status/State (read only enumeration)

This indicates the known state of the resource, such as if it is enabled.

Defined values:

VirtualMedia.Enabled

JSONPath: /VirtualMedia/Enabled (read only boolean)

Indicates whether Virtual Media is enabled for the manager.

VirtualMedia.Port

JSONPath: /VirtualMedia/Port (PATCHable integer)

The Virtual Media port number.

example PATCH: {“VirtualMedia”: {“Port”: <integer-value>}}

VirtualMedia.ProtocolEnabled

JSONPath: /VirtualMedia/ProtocolEnabled (read only boolean)

Indicates whether Virtual Media is enabled for the manager.

POST Action “SendTestSyslog”

example “SendTestSyslog” action:

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

{}

POST Action “SendTestAlertMail”

Sends test alert mail to configured AlertMail email address.

example “SendTestAlertMail” action:

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

{}

Power

This is the schema definition for the Power Metrics. It represents the properties for Power Consumption and Power Limiting.

Properties

Resource Instances of this Type:

  • https://{iLO}/redfish/v1/chassis/{item}/power

BbuPowerSupply

JSONPath: /Oem/Hp/BbuPowerSupply (PATCHable enumeration)

Battery Backup Unit Power Supply action determines what occurs when a server is running on battery power.

example PATCH: {“Oem”: {“Hp”: {“BbuPowerSupply”: “MomentaryPowerButtonPress”}}}

Defined values:

SNMPPowerThresholdAlert.DurationInMin

JSONPath: /Oem/Hp/SNMPPowerThresholdAlert/DurationInMin (PATCHable integer)

Sets the length of time, in minutes, that power consumption must remain above the warning threshold before an SNMP alert is triggered. The maximum duration is 240 minutes, and the duration must be a multiple of 5.

example PATCH: {“Oem”: {“Hp”: {“SNMPPowerThresholdAlert”: {“DurationInMin”: <integer-value>}}}}

SNMPPowerThresholdAlert.ThresholdWatts

JSONPath: /Oem/Hp/SNMPPowerThresholdAlert/ThresholdWatts (PATCHable integer)

Sets the power consumption threshold (watts). If power consumption exceeds this value for the specified time duration, an SNMP alert is triggered.

example PATCH: {“Oem”: {“Hp”: {“SNMPPowerThresholdAlert”: {“ThresholdWatts”: <integer-value>}}}}

SNMPPowerThresholdAlert.Trigger

JSONPath: /Oem/Hp/SNMPPowerThresholdAlert/Trigger (PATCHable enumeration)

Trigger determines whether alerts are based on peak power consumption, average power consumption, or if they are disabled. Trigger property can only be enabled if the ThresholdWatts and DurationInMin values are specified/configured.

example PATCH: {“Oem”: {“Hp”: {“SNMPPowerThresholdAlert”: {“Trigger”: “AveragePowerConsumption”}}}}

Defined values:

PowerAllocatedWatts

JSONPath: /PowerAllocatedWatts (read only integer)

The total power (Watts) allocated to the chassis.

PowerAvailableWatts

JSONPath: /PowerAvailableWatts (read only integer)

Amount of power (Watts) not already budgeted and therefore available for additional allocation. (PowerCapacity - PowerAllocated). This indicates how much reserve power capacity is left.

PowerCapacityWatts

JSONPath: /PowerCapacityWatts (read only integer)

The total power (Watts) available to the chassis from all power supplies (adjusting for redundancy settings).

PowerConsumedWatts

JSONPath: /PowerConsumedWatts (read only integer)

The latest observed power (Watts) being drawn by this chassis. The update interval may vary depending upon implementation but is usually measured in seconds.

PowerControl[array-item].MemberId

JSONPath: /PowerControl/(array index)/MemberId (PATCHable string)

This is the identifier for the member within the collection.

PowerControl[array-item].PowerAllocatedWatts

JSONPath: /PowerControl/(array index)/PowerAllocatedWatts (read only integer)

The total amount of power that has been allocated (or budegeted)to chassis resources.

PowerControl[array-item].PowerAvailableWatts

JSONPath: /PowerControl/(array index)/PowerAvailableWatts (read only integer)

The amount of power not already budgeted and therefore available for additional allocation. (powerCapacity - powerAllocated). This indicates how much reserve power capacity is left.

PowerControl[array-item].PowerCapacityWatts

JSONPath: /PowerControl/(array index)/PowerCapacityWatts (read only integer)

The total amount of power available to the chassis for allocation. This may the power supply capacity, or power budget assigned to the chassis from an up-stream chassis.

PowerControl[array-item].PowerConsumedWatts

JSONPath: /PowerControl/(array index)/PowerConsumedWatts (read only integer)

The actual power being consumed by the chassis.

PowerControl[array-item].PowerLimit.CorrectionInMs

JSONPath: /PowerControl/(array index)/PowerLimit/CorrectionInMs (read only integer)

The time required for the limiting process to reduce power consumption to below the limit.

PowerControl[array-item].PowerLimit.LimitException

JSONPath: /PowerControl/(array index)/PowerLimit/LimitException (PATCHable enumeration)

The action that is taken if the power cannot be maintained below the LimitInWatts.

example PATCH: {“PowerControl”: [{“PowerLimit”: {“LimitException”: “LogEventOnly”}}|null, …]}

Defined values:

PowerControl[array-item].PowerLimit.LimitInWatts

JSONPath: /PowerControl/(array index)/PowerLimit/LimitInWatts (PATCHable integer)

The Power limit in watts. Set to null to disable power capping.

example PATCH: {“PowerControl”: [{“PowerLimit”: {“LimitInWatts”: <integer-value>}}|null, …]}

PowerControl[array-item].PowerMetrics.AverageConsumedWatts

JSONPath: /PowerControl/(array index)/PowerMetrics/AverageConsumedWatts (read only integer)

The average power level over the measurement window (the last IntervalInMin minutes).

PowerControl[array-item].PowerMetrics.IntervalInMin

JSONPath: /PowerControl/(array index)/PowerMetrics/IntervalInMin (read only integer)

The time interval (or window) in which the PowerMetrics are measured over.

PowerControl[array-item].PowerMetrics.MaxConsumedWatts

JSONPath: /PowerControl/(array index)/PowerMetrics/MaxConsumedWatts (read only integer)

The highest power consumption level that has occured over the measurement window (the last IntervalInMin minutes).

PowerControl[array-item].PowerMetrics.MinConsumedWatts

JSONPath: /PowerControl/(array index)/PowerMetrics/MinConsumedWatts (read only integer)

The lowest power consumption level over the measurement window (the last IntervalInMin minutes).

PowerControl[array-item].PowerRequestedWatts

JSONPath: /PowerControl/(array index)/PowerRequestedWatts (read only integer)

The potential power that the chassis resources are requesting which may be higher than the current level being consumed since requested power includes budget that the chassis resource wants for future use.

PowerControl[array-item].Status.Health

JSONPath: /PowerControl/(array index)/Status/Health (read only enumeration)

This represents the health state of this resource in the absence of its dependent resources.

Defined values:

PowerControl[array-item].Status.HealthRollUp

JSONPath: /PowerControl/(array index)/Status/HealthRollUp (read only enumeration)

This represents the overall health state from the view of this resource.

Defined values:

PowerControl[array-item].Status.HealthRollup

JSONPath: /PowerControl/(array index)/Status/HealthRollup (read only enumeration)

This represents the overall health state from the view of this resource.

Defined values:

PowerControl[array-item].Status.State

JSONPath: /PowerControl/(array index)/Status/State (read only enumeration)

This indicates the known state of the resource, such as if it is enabled.

Defined values:

PowerLimit.CorrectionInMs

JSONPath: /PowerLimit/CorrectionInMs (read only integer)

Time in milliseconds that it takes for the limiting process to react and correct the power consumption below the limit.

PowerLimit.CorrelatableID

JSONPath: /PowerLimit/CorrelatableID (read only string)

The value of this property shall represent a reference to the resource that is being limited.

PowerLimit.LimitException

JSONPath: /PowerLimit/LimitException (PATCHable enumeration)

Action that is taken if the power cannot be maintained below the LimitInWatts.

example PATCH: {“PowerLimit”: {“LimitException”: “HardPowerOff”}}

Defined values:

PowerLimit.LimitInWatts

JSONPath: /PowerLimit/LimitInWatts (PATCHable integer)

The Power (Watts) limit (also known as ‘Power Cap’). Set to null to disable the power cap.

example PATCH: {“PowerLimit”: {“LimitInWatts”: <integer-value>}}

PowerMetrics.AverageConsumedWatts

JSONPath: /PowerMetrics/AverageConsumedWatts (read only integer)

The average power consumed during the interval specified by ‘IntervalInMin’.

PowerMetrics.IntervalInMin

JSONPath: /PowerMetrics/IntervalInMin (read only integer)

The interval between power metric evaluation in minutes.

PowerMetrics.MaxConsumedWatts

JSONPath: /PowerMetrics/MaxConsumedWatts (read only integer)

The maximum power consumed during the interval specified by ‘IntervalInMin’.

PowerMetrics.MinConsumedWatts

JSONPath: /PowerMetrics/MinConsumedWatts (read only integer)

The minimum power consumed during the interval specified by ‘IntervalInMin’.

PowerRequestedWatts

JSONPath: /PowerRequestedWatts (read only integer)

Potential power (Watts) that the chassis is requesting that might be higher than the current level being consumed. This is because the requested power includes budget that the chassis has reserved for future use.

PowerSupplies[array-item].CorrelatableID

JSONPath: /PowerSupplies/(array index)/CorrelatableID (read only string)

CorrelatableID for this power supply.

PowerSupplies[array-item].FirmwareVersion

JSONPath: /PowerSupplies/(array index)/FirmwareVersion (read only string)

The firmware version for this Power Supply

PowerSupplies[array-item].LastPowerOutputWatts

JSONPath: /PowerSupplies/(array index)/LastPowerOutputWatts (read only integer)

The average power output of this Power Supply

PowerSupplies[array-item].LineInputVoltage

JSONPath: /PowerSupplies/(array index)/LineInputVoltage (read only integer)

The line input voltage at which the Power Supply is operating

PowerSupplies[array-item].LineInputVoltageType

JSONPath: /PowerSupplies/(array index)/LineInputVoltageType (read only enumeration)

The line voltage type supported as an input to this Power Supply

Defined values:

PowerSupplies[array-item].MemberId

JSONPath: /PowerSupplies/(array index)/MemberId (PATCHable string)

This is the identifier for the member within the collection.

PowerSupplies[array-item].Model

JSONPath: /PowerSupplies/(array index)/Model (read only string)

The model number for this Power Supply

PowerSupplies[array-item].Oem.Hp.AveragePowerOutputWatts

JSONPath: /PowerSupplies/(array index)/Oem/Hp/AveragePowerOutputWatts (read only integer)

The latest observed average power being drawn by the power supply (Watts). This is usually updated every 10 seconds but the period can vary in some circumstances.

PowerSupplies[array-item].Oem.Hp.BayNumber

JSONPath: /PowerSupplies/(array index)/Oem/Hp/BayNumber (read only integer)

The power supply bay number.

PowerSupplies[array-item].Oem.Hp.HotplugCapable

JSONPath: /PowerSupplies/(array index)/Oem/Hp/HotplugCapable (read only boolean)

If true, this power supply (and power supply bay) is capable of being hot-plugged.

PowerSupplies[array-item].Oem.Hp.MaxPowerOutputWatts

JSONPath: /PowerSupplies/(array index)/Oem/Hp/MaxPowerOutputWatts (read only integer)

The latest observed maximum output power being drawn by the power supply (Watts). This is usually updated every 10 seconds but the period can vary in some circumstances.

PowerSupplies[array-item].Oem.Hp.Mismatched

JSONPath: /PowerSupplies/(array index)/Oem/Hp/Mismatched (read only boolean)

If true, this power supply is mismatched with others in the system.

PowerSupplies[array-item].Oem.Hp.PowerSupplyStatus.State

JSONPath: /PowerSupplies/(array index)/Oem/Hp/PowerSupplyStatus/State (read only enumeration)

Indicates the known state of the resource.

Defined values:

PowerSupplies[array-item].Oem.Hp.iPDU.IPAddress

JSONPath: /PowerSupplies/(array index)/Oem/Hp/iPDU/IPAddress (read only string)

The IP address of the iPDU connected to this power supply.

PowerSupplies[array-item].Oem.Hp.iPDU.MacAddress

JSONPath: /PowerSupplies/(array index)/Oem/Hp/iPDU/MacAddress (read only string)

The Ethernet MAC address of the iPDU connected to this power supply.

PowerSupplies[array-item].Oem.Hp.iPDU.Model

JSONPath: /PowerSupplies/(array index)/Oem/Hp/iPDU/Model (read only string)

The model number of the iPDU connected to this power supply.

PowerSupplies[array-item].Oem.Hp.iPDU.SerialNumber

JSONPath: /PowerSupplies/(array index)/Oem/Hp/iPDU/SerialNumber (read only string)

The serial number of the iPDU connected to this power supply.

PowerSupplies[array-item].Oem.Hp.iPDU.iPDUStatus.State

JSONPath: /PowerSupplies/(array index)/Oem/Hp/iPDU/iPDUStatus/State (read only enumeration)

Indicates the known state of the resource.

Defined values:

PowerSupplies[array-item].Oem.Hp.iPDUCapable

JSONPath: /PowerSupplies/(array index)/Oem/Hp/iPDUCapable (read only boolean)

If true, this power supply is capable of being connected to an iPDUs.

PowerSupplies[array-item].PartNumber

JSONPath: /PowerSupplies/(array index)/PartNumber (read only string)

The part number for this Power Supply

PowerSupplies[array-item].PowerCapacityWatts

JSONPath: /PowerSupplies/(array index)/PowerCapacityWatts (read only integer)

The maximum capacity of this Power Supply

PowerSupplies[array-item].PowerSupplyType

JSONPath: /PowerSupplies/(array index)/PowerSupplyType (read only enumeration)

The Power Supply type (AC or DC)

Defined values:

PowerSupplies[array-item].Redundancy[array-item].MaxNumSupported

JSONPath: /PowerSupplies/(array index)/Redundancy/(array index)/MaxNumSupported (read only integer)

This is the maximum number of members allowable for this particular managers redundancy, including this manager.

PowerSupplies[array-item].Redundancy[array-item].MemberId

JSONPath: /PowerSupplies/(array index)/Redundancy/(array index)/MemberId (PATCHable string)

This is the identifier for the member within the collection.

PowerSupplies[array-item].Redundancy[array-item].MinNumNeeded

JSONPath: /PowerSupplies/(array index)/Redundancy/(array index)/MinNumNeeded (read only integer)

This is the minumum number of managers needed for this manager to be redundant.

PowerSupplies[array-item].Redundancy[array-item].Mode

JSONPath: /PowerSupplies/(array index)/Redundancy/(array index)/Mode (read only enumeration)

This is the redundancy mode of the group.

Defined values:

PowerSupplies[array-item].Redundancy[array-item].Status.Health

JSONPath: /PowerSupplies/(array index)/Redundancy/(array index)/Status/Health (read only enumeration)

This represents the health state of this resource in the absence of its dependent resources.

Defined values:

PowerSupplies[array-item].Redundancy[array-item].Status.HealthRollUp

JSONPath: /PowerSupplies/(array index)/Redundancy/(array index)/Status/HealthRollUp (read only enumeration)

This represents the overall health state from the view of this resource.

Defined values:

PowerSupplies[array-item].Redundancy[array-item].Status.HealthRollup

JSONPath: /PowerSupplies/(array index)/Redundancy/(array index)/Status/HealthRollup (read only enumeration)

This represents the overall health state from the view of this resource.

Defined values:

PowerSupplies[array-item].Redundancy[array-item].Status.State

JSONPath: /PowerSupplies/(array index)/Redundancy/(array index)/Status/State (read only enumeration)

This indicates the known state of the resource, such as if it is enabled.

Defined values:

PowerSupplies[array-item].SerialNumber

JSONPath: /PowerSupplies/(array index)/SerialNumber (read only string)

The serial number for this Power Supply

PowerSupplies[array-item].SparePartNumber

JSONPath: /PowerSupplies/(array index)/SparePartNumber (read only string)

The spare part number for this Power Supply

PowerSupplies[array-item].Status.Health

JSONPath: /PowerSupplies/(array index)/Status/Health (read only enumeration)

This represents the health state of this resource in the absence of its dependent resources.

Defined values:

PowerSupplies[array-item].Status.HealthRollUp

JSONPath: /PowerSupplies/(array index)/Status/HealthRollUp (read only enumeration)

This represents the overall health state from the view of this resource.

Defined values:

PowerSupplies[array-item].Status.HealthRollup

JSONPath: /PowerSupplies/(array index)/Status/HealthRollup (read only enumeration)

This represents the overall health state from the view of this resource.

Defined values:

PowerSupplies[array-item].Status.State

JSONPath: /PowerSupplies/(array index)/Status/State (read only enumeration)

This indicates the known state of the resource, such as if it is enabled.

Defined values:

Redundancy[array-item].MaxNumSupported

JSONPath: /Redundancy/(array index)/MaxNumSupported (read only integer)

This is the maximum number of members allowable for this particular managers redundancy, including this manager.

Redundancy[array-item].MemberId

JSONPath: /Redundancy/(array index)/MemberId (PATCHable string)

This is the identifier for the member within the collection.

Redundancy[array-item].MinNumNeeded

JSONPath: /Redundancy/(array index)/MinNumNeeded (read only integer)

This is the minumum number of managers needed for this manager to be redundant.

Redundancy[array-item].Mode

JSONPath: /Redundancy/(array index)/Mode (read only enumeration)

This is the redundancy mode of the group.

Defined values:

Redundancy[array-item].Status.Health

JSONPath: /Redundancy/(array index)/Status/Health (read only enumeration)

This represents the health state of this resource in the absence of its dependent resources.

Defined values:

Redundancy[array-item].Status.HealthRollUp

JSONPath: /Redundancy/(array index)/Status/HealthRollUp (read only enumeration)

This represents the overall health state from the view of this resource.

Defined values:

Redundancy[array-item].Status.HealthRollup

JSONPath: /Redundancy/(array index)/Status/HealthRollup (read only enumeration)

This represents the overall health state from the view of this resource.

Defined values:

Redundancy[array-item].Status.State

JSONPath: /Redundancy/(array index)/Status/State (read only enumeration)

This indicates the known state of the resource, such as if it is enabled.

Defined values:

Status.Health

JSONPath: /Status/Health (read only enumeration)

This represents the health state of this resource in the absence of its dependent resources.

Defined values:

Status.HealthRollUp

JSONPath: /Status/HealthRollUp (read only enumeration)

This represents the overall health state from the view of this resource.

Defined values:

Status.HealthRollup

JSONPath: /Status/HealthRollup (read only enumeration)

This represents the overall health state from the view of this resource.

Defined values:

Status.State

JSONPath: /Status/State (read only enumeration)

This indicates the known state of the resource, such as if it is enabled.

Defined values:

ServiceRoot

This object represents the HP RESTful API root service.

Properties

Resource Instances of this Type:

  • https://{iLO}/redfish/v1

Manager[array-item].Blade.BayNumber

JSONPath: /Oem/Hp/Manager/(array index)/Blade/BayNumber (read only string)

Specifies the location of the blade in the enclosure.

Manager[array-item].Blade.EnclosureName

JSONPath: /Oem/Hp/Manager/(array index)/Blade/EnclosureName (read only string)

Specifies the name of the enclosure in which the blade is present.

Manager[array-item].Blade.RackName

JSONPath: /Oem/Hp/Manager/(array index)/Blade/RackName (read only string)

Specifies the name of the rack in which the enclosure is present.

Manager[array-item].DefaultLanguage

JSONPath: /Oem/Hp/Manager/(array index)/DefaultLanguage (read only string)

Default language used for the Web interface.

Manager[array-item].FQDN

JSONPath: /Oem/Hp/Manager/(array index)/FQDN (read only string)

Fully qualified domain name of the management processor.

Manager[array-item].HostName

JSONPath: /Oem/Hp/Manager/(array index)/HostName (read only string)

The name of management processor.

Manager[array-item].IPManager

JSONPath: /Oem/Hp/Manager/(array index)/IPManager (read only object)

Manager[array-item].Languages[array-item].Language

JSONPath: /Oem/Hp/Manager/(array index)/Languages/(array index)/Language (read only string)

Specifies one of the languages supported by the management processor.

Manager[array-item].Languages[array-item].TranslationName

JSONPath: /Oem/Hp/Manager/(array index)/Languages/(array index)/TranslationName (read only string)

Specifies one of the languages supported by the management processor.

Manager[array-item].Languages[array-item].Version

JSONPath: /Oem/Hp/Manager/(array index)/Languages/(array index)/Version (read only string)

Specifies the version of the management processor in the respective language.

Manager[array-item].ManagerFirmwareVersion

JSONPath: /Oem/Hp/Manager/(array index)/ManagerFirmwareVersion (read only string)

The major and minor management processor version numbers.

Manager[array-item].ManagerFirmwareVersionPass

JSONPath: /Oem/Hp/Manager/(array index)/ManagerFirmwareVersionPass (read only string)

The build or pass number of the management processor version.

Manager[array-item].ManagerType

JSONPath: /Oem/Hp/Manager/(array index)/ManagerType (read only string)

The type of the service manager.

Sessions.CertCommonName

JSONPath: /Oem/Hp/Sessions/CertCommonName (read only string)

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

Sessions.KerberosEnabled

JSONPath: /Oem/Hp/Sessions/KerberosEnabled (read only boolean)

Specifies whether Kerberos login is enabled.

Sessions.LDAPAuthLicenced

JSONPath: /Oem/Hp/Sessions/LDAPAuthLicenced (read only boolean)

Specifies whether a valid license is installed for LDAP use.

Sessions.LDAPEnabled

JSONPath: /Oem/Hp/Sessions/LDAPEnabled (read only boolean)

Specifies whether LDAP login is enabled.

Sessions.LocalLoginEnabled

JSONPath: /Oem/Hp/Sessions/LocalLoginEnabled (read only boolean)

Specifies whether local users can log in.

Sessions.LoginFailureDelay

JSONPath: /Oem/Hp/Sessions/LoginFailureDelay (read only integer)

The delay (seconds) when a management processor login attempt has failed.

Sessions.LoginHint.Hint

JSONPath: /Oem/Hp/Sessions/LoginHint/Hint (read only string)

The information on how to log in to the management processor.

Sessions.LoginHint.HintPOSTData.Password

JSONPath: /Oem/Hp/Sessions/LoginHint/HintPOSTData/Password (read only string)

The password for logging in to the management processor.

Sessions.LoginHint.HintPOSTData.UserName

JSONPath: /Oem/Hp/Sessions/LoginHint/HintPOSTData/UserName (read only string)

The user name for logging in to the management processor.

Sessions.SecurityMessage

JSONPath: /Oem/Hp/Sessions/SecurityMessage (read only string)

The login security banner message that is displayed on the management processor Login page.

Sessions.SecurityOverride

JSONPath: /Oem/Hp/Sessions/SecurityOverride (read only boolean)

Specifies whether the security override switch is enabled.

Sessions.ServerName

JSONPath: /Oem/Hp/Sessions/ServerName (read only string)

The name of the server that this management processor is managing.

RedfishVersion

JSONPath: /RedfishVersion (read only string)

The version of the Redfish service

ServiceVersion

JSONPath: /ServiceVersion (read only string)

The web service version. This is different from the version of the data model.

Time

JSONPath: /Time (read only string)

The current web service time.

UUID

JSONPath: /UUID (read only string)

Unique identifier for a service instance. This value should be an exact match of the UUID value returned in a 200OK from an SSDP M-SEARCH request during discovery.

Session

This represents a single logged in session. See Authentication and Sessions for more detail.

Properties

Resource Instances of this Type:

  • https://{iLO}/redfish/v1/sessionservice/sessions/{item}

AccessTime

JSONPath: /Oem/Hp/AccessTime (read only string)

User session last-access time

LoginTime

JSONPath: /Oem/Hp/LoginTime (read only string)

User session login time

MySession

JSONPath: /Oem/Hp/MySession (read only boolean)

Indicates whether this is a session I own.

Privileges.LoginPriv

JSONPath: /Oem/Hp/Privileges/LoginPriv (read only boolean)

This privilege enables a user to log in to the management processor. All local accounts have the login privilege. This privilege is added automatically if it is not specified.

Privileges.RemoteConsolePriv

JSONPath: /Oem/Hp/Privileges/RemoteConsolePriv (read only boolean)

This privilege enables a user to remotely access the host system Remote Console, including video, keyboard, and mouse control.

Privileges.UserConfigPriv

JSONPath: /Oem/Hp/Privileges/UserConfigPriv (read only boolean)

This privilege enables a user to add, edit, and delete local management processor user accounts. A user with this privilege can change privileges for all users.

Privileges.VirtualMediaPriv

JSONPath: /Oem/Hp/Privileges/VirtualMediaPriv (read only boolean)

This privilege enables a user to use the Virtual Media feature on the host system.

Privileges.VirtualPowerAndResetPriv

JSONPath: /Oem/Hp/Privileges/VirtualPowerAndResetPriv (read only boolean)

This privilege enables a user to power-cycle or reset the host system. These activities interrupt system availability. A user with this privilege can diagnose the system by using the Generate NMI to System button.

Privileges.iLOConfigPriv

JSONPath: /Oem/Hp/Privileges/iLOConfigPriv (read only boolean)

This privilege enables a user to configure most management processor settings, including security settings, and to remotely update the management processor firmware. This privilege does not enable local user account administration.

UserAccount

JSONPath: /Oem/Hp/UserAccount (read only string)

Login details of the user

UserDistinguishedName

JSONPath: /Oem/Hp/UserDistinguishedName (read only string)

LDAP user is identified by its distinguished name (DN).

UserExpires

JSONPath: /Oem/Hp/UserExpires (read only string)

User session expire time

UserIP

JSONPath: /Oem/Hp/UserIP (read only string)

IP address of the user

UserTag

JSONPath: /Oem/Hp/UserTag (read only enumeration)

Session source

Defined values:

UserType

JSONPath: /Oem/Hp/UserType (read only enumeration)

User type

Defined values:

UserName

JSONPath: /UserName (read only string)

Name to use to log in to the management processor.

SessionService

This represents the REST API’s session manager, enabling clients to create new sessions or end sessions. See the section “Authentication and Sessions” for details on how to manage sessions.

Properties

Resource Instances of this Type:

  • https://{iLO}/redfish/v1/sessionservice

ServiceEnabled

JSONPath: /ServiceEnabled (PATCHable boolean)

This indicates whether this service is enabled.

SessionTimeout

JSONPath: /SessionTimeout (PATCHable integer)

This is the number of seconds of inactivity that a session may have before the session service closes the session due to inactivity.

example PATCH: {“SessionTimeout”: <integer-value>}

Status.Health

JSONPath: /Status/Health (read only enumeration)

This represents the health state of this resource in the absence of its dependent resources.

Defined values:

Status.HealthRollUp

JSONPath: /Status/HealthRollUp (read only enumeration)

This represents the overall health state from the view of this resource.

Defined values:

Status.HealthRollup

JSONPath: /Status/HealthRollup (read only enumeration)

This represents the overall health state from the view of this resource.

Defined values:

Status.State

JSONPath: /Status/State (read only enumeration)

This indicates the known state of the resource, such as if it is enabled.

Defined values:

SnmpService

This represents iLO 4’s SNMP configuration and status

Properties

Resource Instances of this Type:

  • https://{iLO}/redfish/v1/managers/{item}/snmpservice

AlertsEnabled

JSONPath: /AlertsEnabled (PATCHable boolean)

The alert conditions that the management processor detects independently of the host operating system can be sent to specified SNMP alert destinations, such as HP SIM.

example PATCH: {“AlertsEnabled”: true}

Contact

JSONPath: /Contact (PATCHable string)

The string of up to 49 characters that specifies the system administrator or server owner. The string can include a name, email address, or phone number.

example PATCH: {“Contact”: “<string-value>”}

Location

JSONPath: /Location (PATCHable string)

The string of up to 49 characters that specifies the physical location of the server.

example PATCH: {“Location”: “<string-value>”}

Mode

JSONPath: /Mode (PATCHable enumeration)

Agentless Management Mode (default): Use SNMP agents running on the management processor to manage the server. SNMP Pass-thru Mode: Use SNMP agents running on the host operating system to manage the server. This setting does not affect alerts.

example PATCH: {“Mode”: “Passthru”}

Defined values:

SNMPColdStartTrapBroadcast

JSONPath: /Oem/Hp/SNMPColdStartTrapBroadcast (PATCHable boolean)

If set to true, the Cold Start Trap will be enabled. The Cold Start Trap is broadcast to a subnet broadcast address if there are no trap destinations configured in the SNMP Alert Destination(s) boxes.

example PATCH: {“Oem”: {“Hp”: {“SNMPColdStartTrapBroadcast”: true}}}

SNMPForwardInsightManagerAgentAlerts

JSONPath: /Oem/Hp/SNMPForwardInsightManagerAgentAlerts (PATCHable boolean)

If set to true, the alert conditions detected by the host management agents are forwarded to SNMP alert destinations through the management processor. These alerts are generated by the Insight Management Agents, which are available for each supported operating system. Insight Management Agents must be installed on the host server to receive these alerts.

example PATCH: {“Oem”: {“Hp”: {“SNMPForwardInsightManagerAgentAlerts”: true}}}

Role

JSONPath: /Role (PATCHable string)

The string of up to 64 characters that describes the server role or function.

example PATCH: {“Role”: “<string-value>”}

RoleDetail

JSONPath: /RoleDetail (PATCHable string)

The string of up to 512 characters that describes specific tasks that the server might perform.

example PATCH: {“RoleDetail”: “<string-value>”}

SNMPv1Traps

JSONPath: /SNMPv1Traps (PATCHable boolean)

When enabled, SNMPv1 traps are sent to the remote management systems configured in the SNMP Alert Destination(s) boxes.

example PATCH: {“SNMPv1Traps”: true}

SNMPv3EngineID

JSONPath: /SNMPv3EngineID (PATCHable string)

The SNMPv3 Engine ID is the unique identifier of an SNMP engine that belongs to an SNMP agent entity. This value must be a hexadecimal string with an even number of 6 to 32 characters, excluding the first two characters, 0x (for example, 0x01020304abcdef).

example PATCH: {“SNMPv3EngineID”: “<string-value>”}

Status.Health

JSONPath: /Status/Health (read only enumeration)

This represents the health state of this resource in the absence of its dependent resources.

Defined values:

Status.HealthRollUp

JSONPath: /Status/HealthRollUp (read only enumeration)

This represents the overall health state from the view of this resource.

Defined values:

Status.HealthRollup

JSONPath: /Status/HealthRollup (read only enumeration)

This represents the overall health state from the view of this resource.

Defined values:

Status.State

JSONPath: /Status/State (read only enumeration)

This indicates the known state of the resource, such as if it is enabled.

Defined values:

TrapSourceHostname

JSONPath: /TrapSourceHostname (PATCHable enumeration)

Determines the host name that is used in the SNMP-defined sysName variable when the management processor generates SNMP traps.

example PATCH: {“TrapSourceHostname”: “System”}

Defined values:

Users[array-item].AuthPassphrase

JSONPath: /Users/(array index)/AuthPassphrase (PATCHable string)

Sets the passphrase to use for sign operations. Enter a value of 8 to 49 characters.

example PATCH: {“Users”: [{“AuthPassphrase”: “<string-value>”}|null, …]}

Users[array-item].AuthProtocol

JSONPath: /Users/(array index)/AuthProtocol (PATCHable enumeration)

Sets the message digest algorithm to use for encoding the authorization passphrase. The message digest is calculated over an appropriate portion of an SNMP message, and is included as part of the message sent to the recipient. Select MD5 (Message Digest) or SHA (Secure Hash Algorithm).

example PATCH: {“Users”: [{“AuthProtocol”: “SHA”}|null, …]}

Defined values:

Users[array-item].PrivacyPassphrase

JSONPath: /Users/(array index)/PrivacyPassphrase (PATCHable string)

Sets the passphrase to use for encrypt operations. Enter a value of 8 to 49 characters.

example PATCH: {“Users”: [{“PrivacyPassphrase”: “<string-value>”}|null, …]}

Users[array-item].PrivacyProtocol

JSONPath: /Users/(array index)/PrivacyProtocol (PATCHable enumeration)

Sets the encryption algorithm to use for encoding the privacy passphrase. A portion of an SNMP message is encrypted before transmission. Select AES (Advanced Encryption Standard) or DES (Data Encryption Standard).

example PATCH: {“Users”: [{“PrivacyProtocol”: “AES”}|null, …]}

Defined values:

Users[array-item].SecurityName

JSONPath: /Users/(array index)/SecurityName (PATCHable string)

The user profile name. Enter an alphanumeric string of 1 to 32 characters.

example PATCH: {“Users”: [{“SecurityName”: “<string-value>”}|null, …]}

POST Action “SendSNMPTestAlert”

Causes iLO 4 to send a test SNMP trap to registered trap destinations.

example “SendSNMPTestAlert” action:

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

{}

Thermal

The schema definition for the Thermal Metrics. It represents the properties for temperature and cooling.

Properties

Resource Instances of this Type:

  • https://{iLO}/redfish/v1/chassis/{item}/thermal

Fans[array-item].Context

JSONPath: /Fans/(array index)/Context (read only enumeration)

The area or device to which this temperature measurement applies.

Defined values:

Fans[array-item].CorrelatableID

JSONPath: /Fans/(array index)/CorrelatableID (read only string)

The CorrelatableID for this fan.

Fans[array-item].CurrentReading

JSONPath: /Fans/(array index)/CurrentReading (read only integer)

The current speed of the fan.

Fans[array-item].FanName

JSONPath: /Fans/(array index)/FanName (read only string)

The name of the fan sensor.

Fans[array-item].LowerThresholdCritical

JSONPath: /Fans/(array index)/LowerThresholdCritical (read only integer)

Below normal range but not yet fatal.

Fans[array-item].LowerThresholdFatal

JSONPath: /Fans/(array index)/LowerThresholdFatal (read only integer)

Below normal range and is fatal.

Fans[array-item].LowerThresholdNonCritical

JSONPath: /Fans/(array index)/LowerThresholdNonCritical (read only integer)

Below normal range.

Fans[array-item].MaximumValue

JSONPath: /Fans/(array index)/MaximumValue (read only integer)

Maximum value for CurrentReading.

Fans[array-item].MinimumValue

JSONPath: /Fans/(array index)/MinimumValue (read only integer)

Minimum value for CurrentReading.

Fans[array-item].Oem.Hp.Location

JSONPath: /Fans/(array index)/Oem/Hp/Location (read only enumeration)

Indicates the component (i.e. CPU, Memory, and Storage) that the fan is being used to cool.

Defined values:

Fans[array-item].PhysicalContext

JSONPath: /Fans/(array index)/PhysicalContext (PATCHable enumeration)

Defined values:

Fans[array-item].ReadingRPM

JSONPath: /Fans/(array index)/ReadingRPM (read only integer)

The current speed of the fan.

Fans[array-item].Status.Health

JSONPath: /Fans/(array index)/Status/Health (read only enumeration)

This represents the health state of this resource in the absence of its dependent resources.

Defined values:

Fans[array-item].Status.HealthRollUp

JSONPath: /Fans/(array index)/Status/HealthRollUp (read only enumeration)

This represents the overall health state from the view of this resource.

Defined values:

Fans[array-item].Status.HealthRollup

JSONPath: /Fans/(array index)/Status/HealthRollup (read only enumeration)

This represents the overall health state from the view of this resource.

Defined values:

Fans[array-item].Status.State

JSONPath: /Fans/(array index)/Status/State (read only enumeration)

This indicates the known state of the resource, such as if it is enabled.

Defined values:

Fans[array-item].Units

JSONPath: /Fans/(array index)/Units (read only enumeration)

Units for the CurrentReading.

Defined values:

Fans[array-item].UpperThresholdCritical

JSONPath: /Fans/(array index)/UpperThresholdCritical (read only integer)

Above normal range but not yet fatal.

Fans[array-item].UpperThresholdFatal

JSONPath: /Fans/(array index)/UpperThresholdFatal (read only integer)

Above normal range and is fatal.

Fans[array-item].UpperThresholdNonCritical

JSONPath: /Fans/(array index)/UpperThresholdNonCritical (read only integer)

Above normal range.

Status.Health

JSONPath: /Status/Health (read only enumeration)

This represents the health state of this resource in the absence of its dependent resources.

Defined values:

Status.HealthRollUp

JSONPath: /Status/HealthRollUp (read only enumeration)

This represents the overall health state from the view of this resource.

Defined values:

Status.HealthRollup

JSONPath: /Status/HealthRollup (read only enumeration)

This represents the overall health state from the view of this resource.

Defined values:

Status.State

JSONPath: /Status/State (read only enumeration)

This indicates the known state of the resource, such as if it is enabled.

Defined values:

Temperatures[array-item].Context

JSONPath: /Temperatures/(array index)/Context (read only enumeration)

The area or device to which this temperature measurement applies.

Defined values:

Temperatures[array-item].CorrelatableID

JSONPath: /Temperatures/(array index)/CorrelatableID (read only string)

The CorrelatableID for this temperature sensor.

Temperatures[array-item].CurrentReading

JSONPath: /Temperatures/(array index)/CurrentReading (read only integer)

The current reading of the temperature sensor.

Temperatures[array-item].LowerThresholdCritical

JSONPath: /Temperatures/(array index)/LowerThresholdCritical (read only integer)

Below normal range but not yet fatal.

Temperatures[array-item].LowerThresholdFatal

JSONPath: /Temperatures/(array index)/LowerThresholdFatal (read only integer)

Below normal range and is fatal.

Temperatures[array-item].LowerThresholdNonCritical

JSONPath: /Temperatures/(array index)/LowerThresholdNonCritical (read only integer)

Below normal range.

Temperatures[array-item].MaximumValue

JSONPath: /Temperatures/(array index)/MaximumValue (read only integer)

Maximum value for CurrentReading.

Temperatures[array-item].MinimumValue

JSONPath: /Temperatures/(array index)/MinimumValue (read only integer)

Minimum value for CurrentReading.

Temperatures[array-item].Number

JSONPath: /Temperatures/(array index)/Number (read only integer)

A numerical identifier to represent the temperature sensor.

Temperatures[array-item].Oem.Hp.LocationXmm

JSONPath: /Temperatures/(array index)/Oem/Hp/LocationXmm (read only integer)

The location of the sensor, in millimeters, along the X axis from the logical reference point.

Temperatures[array-item].Oem.Hp.LocationYmm

JSONPath: /Temperatures/(array index)/Oem/Hp/LocationYmm (read only integer)

The location of the sensor, in millimeters, along the Y axis from the logical reference point.

Temperatures[array-item].Oem.Hp.LocationZmm

JSONPath: /Temperatures/(array index)/Oem/Hp/LocationZmm (read only integer)

The location of the sensor, in millimeters, along the Z axis from the logical reference point.

Temperatures[array-item].PhysicalContext

JSONPath: /Temperatures/(array index)/PhysicalContext (PATCHable enumeration)

Defined values:

Temperatures[array-item].ReadingCelsius

JSONPath: /Temperatures/(array index)/ReadingCelsius (read only integer)

The current reading of the temperature sensor.

Temperatures[array-item].Status.Health

JSONPath: /Temperatures/(array index)/Status/Health (read only enumeration)

This represents the health state of this resource in the absence of its dependent resources.

Defined values:

Temperatures[array-item].Status.HealthRollUp

JSONPath: /Temperatures/(array index)/Status/HealthRollUp (read only enumeration)

This represents the overall health state from the view of this resource.

Defined values:

Temperatures[array-item].Status.HealthRollup

JSONPath: /Temperatures/(array index)/Status/HealthRollup (read only enumeration)

This represents the overall health state from the view of this resource.

Defined values:

Temperatures[array-item].Status.State

JSONPath: /Temperatures/(array index)/Status/State (read only enumeration)

This indicates the known state of the resource, such as if it is enabled.

Defined values:

Temperatures[array-item].Units

JSONPath: /Temperatures/(array index)/Units (read only enumeration)

The temperature sensor’s units.

Defined values:

Temperatures[array-item].UpperThresholdCritical

JSONPath: /Temperatures/(array index)/UpperThresholdCritical (read only integer)

Above normal range but not yet fatal.

Temperatures[array-item].UpperThresholdFatal

JSONPath: /Temperatures/(array index)/UpperThresholdFatal (read only integer)

Above normal range and is fatal.

Temperatures[array-item].UpperThresholdNonCritical

JSONPath: /Temperatures/(array index)/UpperThresholdNonCritical (read only integer)

The noncritical temperature threshold.

VirtualMedia

This is iLO 4’s Virtual Media service. It enables clients to mount or unmount virtual media images.

Properties

Resource Instances of this Type:

  • https://{iLO}/redfish/v1/managers/{item}/virtualmedia/{item}

ConnectedVia

JSONPath: /ConnectedVia (read only enumeration)

Specifies how the virtual media is connected to the server.

Defined values:

Image

JSONPath: /Image (PATCHable string)

The valid URI indicating the image that is mounted on this server. A null value indicates that no image exists.

example PATCH: {“Image”: “<string-value>”}

ImageName

JSONPath: /ImageName (read only string)

The name of the image that is mounted on this server. This is usually provided when a URL image is mounted through scripted virtual media.

Inserted

JSONPath: /Inserted (read only boolean)

Indicates whether the virtual media is mounted on the server.

BootOnNextServerReset

JSONPath: /Oem/Hp/BootOnNextServerReset (PATCHable boolean)

If set to true, the server will boot to this image on the next server reboot. The image will be ejected automatically on the second server reboot so that the server does not boot to this image twice.

example PATCH: {“Oem”: {“Hp”: {“BootOnNextServerReset”: true}}}

WriteProtected

JSONPath: /WriteProtected (read only boolean)

Indicates whether the virtual media is protected against write operations.

POST Action “InsertVirtualMedia”

Causes iLO 4 to mount a virtual media image from the specified URI.

Parameters:

“Image” (uri)

example “InsertVirtualMedia” action:

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

{
    "Image": "<uri-of-virtual-media-image>" 
}

POST Action “EjectVirtualMedia”

Causes iLO 4 to unmount a virtual media image.

example “EjectVirtualMedia” action:

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

{}

Response Message Definitions

API Responses are discussed in the section Handling Error Responses. The responses contain one or more “MessageId” properties each corresponding to an entry in a message registry. This section is a reference for the defined message registry entries.

MessageId: Base.{version}.AccessDenied

While attempting to access, connect to, or transfer to/from another resource, the service was denied access.

Format: “While attempting to establish a connection to %1, the service was denied access.”

Severity: Critical

Resolution: Verify that the URI is correct and that the service has the appropriate credentials.

MessageId: Base.{version}.AccountForSessionNoLongerExists

The account for current session is removed and the current session is also removed.

Format: “The account for the session is removed and the current session is also removed.”

Severity: OK

Resolution: Attempt to connect using a valid account.

MessageId: Base.{version}.AccountModified

The account was modified successfully.

Format: “The account was modified successfully.”

Severity: OK

Resolution: None.

MessageId: Base.{version}.AccountNotModified

The request was unable to modify the account.

Format: “The account modification request did not complete.”

Severity: Warning

Resolution: If the operation did not complete, check the authorization or the request body for issues and resubmit the request.

MessageId: Base.{version}.AccountRemoved

The account was removed successfully.

Format: “The account was removed successfully.”

Severity: OK

Resolution: None.

MessageId: Base.{version}.ActionNotSupported

The action supplied in the POST operation is not supported by the resource.

Format: “The action %1 is not supported by the resource.”

Severity: Critical

Resolution: The action was invalid or the wrong resource was the target. See the implementation documentation for assistance.

MessageId: Base.{version}.ActionParameterDuplicate

The action was submitted with a duplicate parameter in the request body.

Format: “The action %1 was submitted with more than one value for the parameter %2.”

Severity: Warning

Resolution: Resubmit the action with only one instance of the parameter in the request body.

MessageId: Base.{version}.ActionParameterMissing

The requested action is missing a parameter that is required to process the action.

Format: “The action %1 requires that the parameter %2 be present in the request body.”

Severity: Critical

Resolution: Resubmit the action with the required parameter in the request body.

MessageId: Base.{version}.ActionParameterNotSupported

The action parameter is not supported on the target resource.

Format: “The parameter %1 for the action %2 is not supported on the target resource.”

Severity: Warning

Resolution: If the operation did not complete, remove the parameter and resubmit the request.

MessageId: Base.{version}.ActionParameterUnknown

An action was submitted, but a supplied parameter did not match any of the known parameters.

Format: “The action %1 was submitted with the invalid parameter %2.”

Severity: Warning

Resolution: If the operation did not complete, correct the invalid parameter and resubmit the request.

MessageId: Base.{version}.ActionParameterValueFormatError

The value type is correct, but the format is not supported or the size/length is exceeded

Format: “The value %1 for the parameter %2 in the action %3 is in a format that is not supported by the parameter.”

Severity: Warning

Resolution: If the operation did not complete, correct the parameter value in the request body and resubmit the request.

MessageId: Base.{version}.ActionParameterValueTypeError

The parameter contains an incorrect value type. For example, a number value for a string parameter type.

Format: “The value %1 for the parameter %2 in the action %3 is the incorrect parameter type.”

Severity: Warning

Resolution: If the operation did not complete, correct the parameter value in the request body and resubmit the request.

MessageId: Base.{version}.CouldNotEstablishConnection

An attempt to access the resource, image, or file at the URI was unsuccessful because a session could not be established.

Format: “The service was unable to establish a connection with the URI %1.”

Severity: Critical

Resolution: Verify that the URI contains a valid and reachable node name, protocol information, and other URI components.

MessageId: Base.{version}.CreateFailedMissingReqProperties

A create operation was attempted on a resource, but a required property was missing from the request.

Format: “The create operation did not complete because the required property %1 was missing from the request.”

Severity: Critical

Resolution: If the operation did not complete, include the required property with a valid value in the request body and resubmit the request.

MessageId: Base.{version}.CreateLimitReachedForResource

No more resources can be created.

Format: “No more resources can be created.”

Severity: Critical

Resolution: If the operation did not complete, delete resources and resubmit the request.

MessageId: Base.{version}.Created

The resource has been created successfully.

Format: “The resource has been created successfully.”

Severity: OK

Resolution: None

MessageId: Base.{version}.EventSubscriptionLimitExceeded

The event subscription establishment has been requested, but the operation did not complete because the number of simultaneous subscriptions exceeded the maximum number allowed by the implementation.

Format: “The event subscription did not complete because the number of simultaneous subscriptions exceeded the maximum number allowed by the implementation.”

Severity: Critical

Resolution: Before attempting to establish the event subscription, reduce the number of subscriptions or increase the maximum number of simultaneous subscriptions allowed (if supported).

MessageId: Base.{version}.InsufficientPrivilege

The account or credentials associated with the current session are not authorized to perform the requested operation.

Format: “The account or the credentials associated with the current session are authorized to perform the requested operation.”

Severity: Critical

Resolution: Retry the operation with an authorized account or credentials.

MessageId: Base.{version}.InternalError

The request did not complete due to an unknown internal error, but the service is still operational.

Format: “The request failed due to an internal service error, but the service is still operational.”

Severity: Critical

Resolution: Resubmit the request. If the problem persists, consider resetting the service.

MessageId: Base.{version}.InvalidObject

The object is not valid.

Format: “The object at %1 is not valid.”

Severity: Critical

Resolution: If the operation did not complete, the object is malformed or the URI is incorrect. Make the appropriate corrections and resubmit the request.

MessageId: Base.{version}.MalformedJSON

The request body contains malformed JSON.

Format: “The request body submitted is malformed JSON and cannot be parsed by the receiving service.”

Severity: Critical

Resolution: Verify that the request body is valid JSON and resubmit the request.

MessageId: Base.{version}.NoValidSession

The operation did not complete because a valid session is required in order to access resources.

Format: “There is no valid session established with the implementation.”

Severity: Critical

Resolution: Establish a session before attempting any operations.

MessageId: Base.{version}.PropertyDuplicate

A duplicate property is in the request body.

Format: “The property %1 is duplicated in the request.”

Severity: Warning

Resolution: If the operation did not complete, remove the duplicate property from the request body and resubmit the request.

MessageId: Base.{version}.PropertyMissing

The request does not include a required property.

Format: “The property %1 is a required property and must be included in the request.”

Severity: Warning

Resolution: If the operation did not complete, verify the property is in the request body and has a valid value.

MessageId: Base.{version}.PropertyNotWritable

The request included a value for a read-only property.

Format: “The property %1 is a read-only property and cannot be assigned a value.”

Severity: Warning

Resolution: If the operation did not complete, remove the property from the request body and resubmit the request.

MessageId: Base.{version}.PropertyUnknown

An unknown property is in the request body.

Format: “The property %1 is not valid for this resource.”

Severity: Warning

Resolution: If the operation did not complete, remove the unknown property from the request body and resubmit the request.

MessageId: Base.{version}.PropertyValueFormatError

The value type is correct, but the format is not supported or the size/length is exceeded.

Format: “The value %1 for the property %2 is in a format that is not supported by the property.”

Severity: Warning

Resolution: If the operation did not complete, correct the property value in the request body and resubmit the request.

MessageId: Base.{version}.PropertyValueNotInList

The value type is correct, but the value is not supported.

Format: “The value %1 for the property %2 is not valid.”

Severity: Warning

Resolution: If the operation did not complete, choose a value from the enumeration list and resubmit your request.

MessageId: Base.{version}.PropertyValueTypeError

The property value contains an incorrect property type. For example, a number value for a string property type.

Format: “The value %1 for the property %2 is the incorrect property type.”

Severity: Warning

Resolution: If the operation did not complete, correct the property value in the request body and resubmit the request.

MessageId: Base.{version}.QueryNotSupported

The query is not supported by the implementation.

Format: “Querying is not supported by the implementation.”

Severity: Warning

Resolution: If the operation did not complete, remove the query parameter and resubmit the request.

MessageId: Base.{version}.QueryNotSupportedOnResource

The query is not supported on the resource. For example, a start/count query is attempted on a resource that is not a collection.

Format: “Querying is not supported on the requested resource.”

Severity: Warning

Resolution: If the operation did not complete, remove the query parameters and resubmit the request.

MessageId: Base.{version}.QueryParameterOutOfRange

The query parameter value is out of range for the resource. For example, a page is requested that is outside the valid page range.

Format: “The value %1 for the query parameter %2 is out of range %3.”

Severity: Warning

Resolution: Specify a query parameter value that is within range. For example, a page that is within the valid range of pages.

MessageId: Base.{version}.QueryParameterValueFormatError

The value type is correct, but the format is not supported or the size/length was exceeded.

Format: “The value %1 for the parameter %2 is in a format that is not supported by the parameter.”

Severity: Warning

Resolution: If the operation did not complete, correct the value for the query parameter in the request body and resubmit the request.

MessageId: Base.{version}.QueryParameterValueTypeError

The query parameter contains an incorrect value type. For example, a number supplied for a query parameter that requires a string.

Format: “The value %1 for the query parameter %2 is the incorrect type of value for the query parameter.”

Severity: Warning

Resolution: If the operation did not complete, correct the value for the query parameter in the request body and resubmit the request.

MessageId: Base.{version}.ResourceAlreadyExists

The create resource operation did not complete because the resource already exists.

Format: “The requested resource already exists.”

Severity: Critical

Resolution: Do not attempt the create operation because the resource already exists.

MessageId: Base.{version}.ResourceAtUriInUnknownFormat

The URI is valid, but the resource or image at that URI is in a format that is not supported by the service.

Format: “The resource at %1 is in a format that is not supported by the service.”

Severity: Critical

Resolution: Place a resource, image, or file that is supported by the service at the URI.

MessageId: Base.{version}.ResourceAtUriUnauthorized

An attempt to access the resource, image, or file at the URI is unauthorized.

Format: “While accessing the resource at %1, the service received an authorization error %2.”

Severity: Critical

Resolution: Verify that the appropriate access is provided for the service to access the URI.

MessageId: Base.{version}.ResourceCannotBeDeleted

A delete operation was attempted on a resource that cannot be deleted.

Format: “The delete request did not complete because the resource cannot be deleted.”

Severity: Critical

Resolution: Do not attempt to delete a resource that does not support the REST API DELETE operation.

MessageId: Base.{version}.ResourceInUse

The request to change the resource was rejected because the resource was in use or in transition.

Format: “The change to the resource did not complete because the resource is in use or in transition.”

Severity: Warning

Resolution: If the operation did not complete, wait until the resource is free and resubmit the request.

MessageId: Base.{version}.ResourceMissingAtURI

The operation expected an image or resource at the provided URI, but found none.

Format: “The resource at the URI %1 was not found.”

Severity: Critical

Resolution: Place a valid resource at the URI or correct the URI and resubmit the request.

MessageId: Base.{version}.ServiceInUnknownState

The operation did not complete because the service is in an unknown state and cannot take incoming requests.

Format: “The operation did not complete because the service is in an unknown state and cannot take incoming requests.”

Severity: Critical

Resolution: If the operation did not complete, restart the service and resubmit the request.

MessageId: Base.{version}.ServiceShuttingDown

The operation did not complete because the service is shutting down.

Format: “The operation did not complete because the service is shutting down and cannot take incoming requests.”

Severity: Critical

Resolution: If the operation did not complete, resubmit the request when the service is available.

MessageId: Base.{version}.ServiceTemporarilyUnavailable

The service is temporarily unavailable.

Format: “The service is temporarily unavailable. Retry in %1 seconds.”

Severity: Critical

Resolution: Wait for the indicated retry duration and retry the operation.

MessageId: Base.{version}.SessionLimitExceeded

Session establishment has been requested, but the operation did not complete because the number of simultaneous sessions exceeded the maximum number allowed by the implementation.

Format: “The session establishment did not complete because the number of simultaneous sessions exceeded the maximum number allowed by the implementation.”

Severity: Critical

Resolution: Before attempting to establish the session, reduce the number of sessions or increase the maximum number of simultaneous sessions allowed (if supported).

MessageId: Base.{version}.SourceDoesNotSupportProtocol

While attempting to access, connect to, or transfer from another location, the other end of the connection did not support the specified protocol.

Format: “The other end of the connection at %1 does not support the specified protocol %2.”

Severity: Critical

Resolution: Change protocols or URIs.

MessageId: Base.{version}.Success

The operation completed successfully.

Format: “The operation completed successfully.”

Severity: OK

Resolution: None

MessageId: Base.{version}.UnrecognizedRequestBody

The service detected a request body with malformed JSON.

Format: “The service detected a request body with malformed JSON.”

Severity: Warning

Resolution: If the operation did not complete, correct the request body and resubmit the request.

MessageId: HpCommon.{version}.ArrayPropertyOutOfBound

The items in the array exceed the maximum number supported.

Format: “An array %1 was supplied with %2 items that exceeds the maximum supported count of %3.”

Severity: Warning

Resolution: Retry the operation using the correct number of items for the array.

MessageId: HpCommon.{version}.ConditionalSuccess

A property value was successfully changed but the change may be reverted upon system reset.

Format: “The property %1 was successfully changed to %2, but the change may be reverted upon system reset.”

Severity: Warning

Resolution: Check the “SettingsResult” messages after the system has reset for errors referring to the corresponding property.

MessageId: HpCommon.{version}.InternalErrorWithParam

The operation was not successful due to an internal service error (shown), but the service is still operational.

Format: “The operation was not successful due to an internal service error (%1), but the service is still operational.”

Severity: Critical

Resolution: Retry the operation. If the problem persists, consider resetting the service.

MessageId: HpCommon.{version}.InvalidConfigurationSpecified

The specified configuration is not valid.

Format: “The specified configuration is not valid.”

Severity: Warning

Resolution: Correct the configuration, and then retry the operation.

MessageId: HpCommon.{version}.PropertyValueExceedsMaxLength

The value for the property exceeds the maximum length.

Format: “The value %1 for the property %2 exceeds the maximum length of %3.”

Severity: Warning

Resolution: Correct the value for the property in the request body, and then retry the operation.

MessageId: HpCommon.{version}.PropertyValueIncompatible

The value for the property is the correct type, but this value is incompatible with the current value of another property.

Format: “The value %1 for the property %2 is incompatible with the value for property %3.”

Severity: Warning

Resolution: Correct the value for the property in the request body, and then retry the operation.

MessageId: HpCommon.{version}.PropertyValueOutOfRange

The value for the property is out of range.

Format: “The value %1 for the property %2 is out of range %3.”

Severity: Warning

Resolution: Correct the value for the property in the request body, and then retry the operation.

MessageId: HpCommon.{version}.ResetInProgress

A device or service reset is in progress.

Format: “A reset on %1 is in progress.”

Severity: Warning

Resolution: Wait for device or service reset to complete, and then retry the operation.

MessageId: HpCommon.{version}.ResetRequired

One or more properties were changed, but these changes will not take effect until the device or service is reset.

Format: “One or more properties were changed, but these changes will not take effect until %1 is reset.”

Severity: Warning

Resolution: To enable the changed properties, reset the device or service.

MessageId: HpCommon.{version}.ResourceNotReadyRetry

The resource is present but is not ready to perform operations due to an internal condition such as initialization or reset.

Format: “The resource is present but is not ready to perform operations. The resource will be ready in %1 seconds.”

Severity: Warning

Resolution: Retry the operation when the resource is ready.

MessageId: HpCommon.{version}.SuccessFeedback

The operation completed successfully

Format: “The operation completed successfully”

Severity: OK

Resolution: None

MessageId: HpCommon.{version}.TaskCreated

A task was created in response to the operation.

Format: “A task was created in response to the operation and is accessible at %1.”

Severity: OK

Resolution: Perform an HTTP GET request on the supplied URI for task status.

MessageId: HpCommon.{version}.UnsupportedHwConfiguration

A previously requested property value change was reverted because the current hardware configuration does not support it.

Format: “The value %1 for property %2 was reverted because the current hardware configuration does not support it.”

Severity: Warning

Resolution: Ensure that the system’s hardware configuration supports the property value.

MessageId: iLO.{version}.AHSDisabled

Modifying AHS properties is not possible with AHS disabled.

Format: “Modifying AHS properties is not possible with AHS disabled.”

Severity: Warning

Resolution: Enable AHS, and then modify the AHS properties.

MessageId: iLO.{version}.Accepted

Indicates that one or more properties were correctly changed, but may not be in effect yet.

Format: “Indicates that one or more properties were correctly changed, but may not be in effect yet.”

Severity: OK

Resolution: None

MessageId: iLO.{version}.ActionParameterValueNotInList

Indicates that the correct value type was supplied for the action parameter, but the value is not supported. (The value is not in the enumeration list.)

Format: “The value %1 for the property %2 is not in the list of valid values.”

Severity: Warning

Resolution: Choose a value from the enumeration list and resubmit the request if the operation failed.

MessageId: iLO.{version}.AlertMailFeatureDisabled

AlertMail feature is disabled.

Format: “AlertMail feature is disabled.”

Severity: Warning

Resolution: Enable AlertMail feature to send test alert message.

MessageId: iLO.{version}.ArrayPropertyOutOfBound

The number of items in the array exceeds the maximum number supported.

Format: “An array %1 was supplied with %2 items that exceeds the maximum supported count of %3.”

Severity: Warning

Resolution: Retry the operation using the correct number of items for the array.

MessageId: iLO.{version}.CannotRemoveLicense

Cannot remove iLO Standard/iLO Standard for BladeSystem license.

Format: “Cannot remove iLO Standard/iLO Standard for BladeSystem license.”

Severity: Warning

Resolution: None.

MessageId: iLO.{version}.DemoLicenseKeyPreviouslyInstalled

A demo license was previously installed.

Format: “A demo license was previously installed.”

Severity: Warning

Resolution: None.

MessageId: iLO.{version}.DeviceResetRequired

Indicates that one or more properties were correctly changed, but will not take effect until device is reset.

Format: “One or more properties were changed and will not take effect until the device is reset.”

Severity: Warning

Resolution: Reset the device for the settings to take effect.

MessageId: iLO.{version}.DiagsTestAlreadyRunning

A diagnostics self test is already running.

Format: “A diagnostics self test is already running.”

Severity: Warning

Resolution: Stop the running test and try again.

MessageId: iLO.{version}.ESKMServersNotConfigured

Enterprise Secure Key Manager Servers are not configured.

Format: “Enterprise Secure Key Manager Servers are not configured.”

Severity: OK

Resolution: None.

MessageId: iLO.{version}.ETagTooLong

The supplied ETag is too long. The maximum supported ETag length is 63 bytes.

Format: “The supplied ETag is too long. The maximum supported ETag length is 63 bytes.”

Severity: Warning

Resolution: Retry the operation using an ETag with a length of 63 bytes or less.

MessageId: iLO.{version}.EmptyDNSName

DNS name is empty.

Format: “Empty DNS name.”

Severity: Warning

Resolution: Retry the request with a valid DNS name.

MessageId: iLO.{version}.ErrorIntializingESKM

Failed to initialize ESKM.

Format: “Failed to initialize ESKM.”

Severity: Warning

Resolution: Check if Account Group, Local CA Certificate Name, Login Name and Password are correct and try again.

MessageId: iLO.{version}.EventLogCleared

Event log cleared successfully.

Format: “Event log cleared successfully.”

Severity: OK

Resolution: None.

MessageId: iLO.{version}.EventSubscriptionModified

The event subscription was modified successfully.

Format: “The event subscription was modified successfully.”

Severity: OK

Resolution: None.

MessageId: iLO.{version}.EventSubscriptionRemoved

The event subscription was removed successfully.

Format: “The event subscription was removed successfully.”

Severity: OK

Resolution: None.

MessageId: iLO.{version}.ExtendedInfo

Indicates that extended information is available.

Format: “See @Message.ExtendedInfo for more information.”

Severity: OK

Resolution: See @Message.ExtendedInfo for more information.

MessageId: iLO.{version}.FWFlashSuccessTPMOverrideEnabled

A Trusted Module is detected in this system. If you have not performed the proper OS encryption procedures, you will lose access to your data if recovery key is not available. Recommended procedure is to suspend encryption software prior to System ROM or Option ROM firmware flash. TPMOverrideFlag is enabled and firmware flash initiated.

Format: “CAUTION: A Trusted Module is detected in this system. Updating the System ROM or Option Card Firmware may have impact to measurements stored in the TM and may have impact to security functionality on the platform which depends on these measurements.”

Severity: OK

Resolution: None.

MessageId: iLO.{version}.FWFlashSuccessTrustedModuleOverrideEnabled

A Trusted Module (type unspecified) is installed in the system and TPMOverrideFlag is enabled. Firmware flash initiated.

Format: “CAUTION: A Trusted Module (type unspecified) has been detected in this system. If you have not performed the proper OS encryption procedures, you will lose access to your data if recovery key is not available. Recommended procedure for Microsoft Windows® BitLocker™ is to "suspend” BitLocker prior to System ROM or Option ROM firmware flash.“

Severity: OK

Resolution: None.

MessageId: iLO.{version}.FWFlashTPMOverrideFlagRequired

A Trusted Module is detected in this system. Failure to perform proper OS encryption procedures will result in loss of access to your data if recovery key is not available. Recommended procedure is to suspend encryption software prior to System ROM or Option ROM firmware flash. If you do not have your recovery key or have not suspended encryption software, cancel this firmware upload. Failure to follow these instructions will result in loss of access to your data. To continue with firmware flash TPMOverrideFlag is required.

Format: "CAUTION: A Trusted Module is detected in this system. Updating the System ROM or Option Card Firmware may have impact to measurements stored in the TM and may have impact to security functionality on the platform which depends on these measurements.”

Severity: Warning

Resolution: Please set the TPMOverrideFlag to true and try again.

MessageId: iLO.{version}.FWFlashTrustedModuleOverrideFlagRequired

A Trusted Module (type unspecified) is installed in the system, TPMOverrideFlag is required for firmware flash to proceed.

Format: “CAUTION: A Trusted Module (type unspecified) has been detected in this system. Failure to perform proper OS encryption procedures will result in loss of access to your data if recovery key is not available. Recommended procedure for Microsoft Windows® BitLocker™ is to "suspend” BitLocker prior to System ROM or Option ROM firmware flash. If you do not have your recovery key or have not suspended BitLocker, exit this flash: Failure to follow these instructions will result in loss of access to your data.“

Severity: Warning

Resolution: Please set the TPMOverrideFlag to true and try again.

MessageId: iLO.{version}.FirmwareFlashAlreadyInProgress

A firmware upgrade operation is already in progress.

Format: "A firmware flash operation is already in progress.”

Severity: Warning

Resolution: Wait for the current firmware flash to complete, and then retry the operation.

MessageId: iLO.{version}.GeneratingCertificate

Generating the X509 Certificate.

Format: “X509 Certificate is being generated and the process might take up to 10 minutes.”

Severity: OK

Resolution: None.

MessageId: iLO.{version}.ICRUNotSupported

ICRU feature or function is not supported on the system.

Format: “ICRU feature or function is not supported on the system.”

Severity: Warning

Resolution: None.

MessageId: iLO.{version}.IPv6ConfigurationError

The specified IPv6 configuration caused an error.

Format: “The specified IPv6 configuration was in error due to %1.”

Severity: Warning

Resolution: Resolve the indicated error in the configuration data.

MessageId: iLO.{version}.ImportCertSuccessfuliLOResetinProgress

Import Certificate was successful hence iLO needs to be reset. So automatic iLO reset is performed to enable the new certificate.

Format: “Import Certificate was successful. iLO reset in progress to enable the new certificate.”

Severity: Warning

Resolution: None.

MessageId: iLO.{version}.ImportCertificateFailed

Failed importing Certificate.

Format: “Failed importing the X509 Certificate.”

Severity: Warning

Resolution: Retry the operation with proper Certificate information.

MessageId: iLO.{version}.ImportSSOParamError

Not a valid parameter.

Format: “Invalid Parameter.”

Severity: Warning

Resolution: Retry the request with valid parameters.

MessageId: iLO.{version}.ImportSSOUriError

Not a valid Uri to import SSO certificate.

Format: “Invalid Uri.”

Severity: Warning

Resolution: Retry the request with valid URI.

MessageId: iLO.{version}.IndicatorLedInvalidStateChange

The request to change the state of the Indicator LED cannot be granted because the current state is either Blinking or is Unknown.

Format: “The Indicator LED cannot be changed when its state is Blinking or Unknown.”

Severity: Warning

Resolution: Please wait until the server has completed its reserved state.

MessageId: iLO.{version}.InternalErrorWithParam

The operation was not successful due to an internal service error (shown), but the service is still operational.

Format: “The operation was not successful due to an internal service error (%1), but the service is still operational.”

Severity: Critical

Resolution: Retry the operation. If the problem persists, consider resetting the service.

MessageId: iLO.{version}.InvalidConfigurationSpecified

The specified configuration is not valid.

Format: “The specified configuration is not valid.”

Severity: Warning

Resolution: Correct the configuration, and then retry the operation.

MessageId: iLO.{version}.InvalidConfigurationSpecifiedForFederation

iLO Federation Management cannot be supported in the current configuration.

Format: “iLO Federation Management cannot be supported in the current configuration.”

Severity: Warning

Resolution: Review the iLO network settings or Onboard Administrator settings and refer to the iLO User Guide.

MessageId: iLO.{version}.InvalidEngineID

EngineID should be a hexadecimal number starting with 0x (for example, 0x0102030405abcdef). The string length should be an even number, greater than or equal to 6 characters (excluding the “0x”), and less than or equal to 32 characters.

Format: “EngineID should be a hexadecimal number starting with 0x (for example, 0x0102030405abcdef). The string length should be an even number, greater than or equal to 6 characters (excluding the "0x”), and less than or equal to 32 characters.“

Severity: Warning

Resolution: Retry the operation using an EngineID within the specified parameters.

MessageId: iLO.{version}.InvalidIndex

The Index is not valid.

Format: "The Index provided is not valid.”

Severity: Warning

Resolution: Adhere to the indexes supported in the self links.

MessageId: iLO.{version}.InvalidLicenseKey

The license key is not valid.

Format: “The license key is not valid.”

Severity: Warning

Resolution: Retry the operation using a valid license key.

MessageId: iLO.{version}.InvalidOperationForAutoPowerOnState

The operation was not successful because the current auto power on mode specifies power is to remain off.

Format: “The auto power on delay cannot be set because power is configured to remain off.”

Severity: Warning

Resolution: Verify that the system auto power on mode is set to turn power on or follow the previous power setting.

MessageId: iLO.{version}.InvalidOperationForSystemState

The operation was not successful due to the current power state (for example, attempting to turn the power off when it is already off).

Format: “The operation was not successful due to the current power state.”

Severity: Warning

Resolution: Verify that the system is in the correct power state, and then retry the operation.

MessageId: iLO.{version}.InvalidPassphraseLength

The passphrase must contain 8 to 49 characters.

Format: “%1 must contain 8 to 49 characters.”

Severity: Warning

Resolution: Correct the passphrase, and then retry the operation.

MessageId: iLO.{version}.InvalidPasswordLength

The password length is not valid.

Format: “A valid password must contain between %1 to %2 characters.”

Severity: Critical

Resolution: Retry the operation using a corrected password.

MessageId: iLO.{version}.LicenseKeyNotSupported

The use of a license key is not supported on this system.

Format: “The use of a license key is not supported on this system.”

Severity: Warning

Resolution: None.

MessageId: iLO.{version}.LicenseKeyRequired

An iLO license key is required to use this operation or feature.

Format: “An iLO license key is required to use this operation or feature.”

Severity: Warning

Resolution: Install a license key (Advanced or Scale Out) to use this feature.

MessageId: iLO.{version}.LoginAttemptDelayed

The login was not successful, so the service enforces a delay before another login is allowed.

Format: “The login was not successful, so the service enforces a delay before another login is allowed.”

Severity: Warning

Resolution: Wait for the delay time to expire, and then retry the login.

MessageId: iLO.{version}.LoginAttemptDelayedSeconds

The login was not successful, so the service enforces a delay before another login is allowed.

Format: “The login was not successful, so the service enforces a %1 second delay before another login is allowed.”

Severity: Warning

Resolution: None.

MessageId: iLO.{version}.MaxProviders

The maximum number of providers are already registered.

Format: “The maximum number of providers are already registered.”

Severity: Warning

Resolution: None.

MessageId: iLO.{version}.MaxVirtualMediaConnectionEstablished

No more Virtual Media connections are available, because the maximum number of connections are already established.

Format: “No more Virtual Media connections are available, because the maximum number of connections are already established.”

Severity: Warning

Resolution: Close an established Virtual Media connection, and then retry creating or opening another connection.

MessageId: iLO.{version}.MembistVariablesNotSupported

Membist variables are not supported on the system.

Format: “Membist variables are not supported on the system.”

Severity: Warning

Resolution: None.

MessageId: iLO.{version}.NoEventSubscriptions

There are no event subscriptions registerd.

Format: “The opeartion can not be completed because there are no event subscribers.”

Severity: Warning

Resolution:

MessageId: iLO.{version}.NoPowerMetering

No support for power metering available on platform.

Format: “No support for power metering available on platform.”

Severity: OK

Resolution: Enable Power Metering on platform if supported.

MessageId: iLO.{version}.NoSNMPAlertDestinationsConfigured

No SNMP alert destinations are configured.

Format: “No SNMP alert destinations are configured.”

Severity: Warning

Resolution: Disable SNMP pass-thru, modify the property, and then re-enable SNMP pass-thru.

MessageId: iLO.{version}.NoSamples

No power history samples are available.

Format: “No power history samples are available.”

Severity: OK

Resolution: To accumulate power history samples, power on the server, and then wait at least 5 minutes.

MessageId: iLO.{version}.NoScriptedVirtualMediaConnectionAvailable

No scripted virtual media connections exist to perform the operation.

Format: “No scripted virtual media connections exist to perform the operation.”

Severity: Warning

Resolution: Create or open a scripted virtual media connection, and then retry the operation.

MessageId: iLO.{version}.NoSpaceforDNSName

No space to store DNS name.

Format: “No space to store DNS name.”

Severity: Warning

Resolution: Make sure SSO database has enough space to store DNS name.

MessageId: iLO.{version}.NoVirtualMediaConnectionAvailable

No Virtual Media connections exist to perform the operation.

Format: “No Virtual Media connections exist to perform the operation.”

Severity: Warning

Resolution: Create or open a Virtual Media connection, and then retry the operation.

MessageId: iLO.{version}.NotSupportedOnNIC

This property is not supported by the indicated network port.

Format: “%1 is not supported on the %2 Network Port.”

Severity: Warning

Resolution: Do not specify this property on the indicated network port.

MessageId: iLO.{version}.NotValidIPAddrOrDNS

The value for the property is not a valid IPv4/v6 address or DNS name.

Format: “The value for property %1 is not a valid IPv4/v6 address or DNS name.”

Severity: Warning

Resolution: Correct the IPv4/v6 address or DNS name, and then retry the operation.

MessageId: iLO.{version}.NotValidIPAddress

The value for the property is not a valid IP address.

Format: “The value %1 is not a valid IP address for %2”

Severity: Warning

Resolution: Use a valid IP address.

MessageId: iLO.{version}.NotValidSubnetMask

The value for the property is not a valid subnet mask.

Format: “The value %1 is not a valid subnet mask for %2”

Severity: Warning

Resolution: Use a valid subnet mask.

MessageId: iLO.{version}.OperationWillCompleteAfterSystemPOST

The value for the property will be applied after System BIOS POST completes.

Format: “The value for property %1 will be changed after the System BIOS completes POST.”

Severity: Information

Resolution: Wait to see the change in value until after the System BIOS completes POST.

MessageId: iLO.{version}.PowerCapOACntrld

The enclosure Onboard Administrator is currently managing the power cap.

Format: “The enclosure Onboard Administrator is currently managing the power cap.”

Severity: Warning

Resolution: Use Onboard Administrator to Manage the PowerCap

MessageId: iLO.{version}.PowerCapROMCntrld

The System ROM is currently managing the power cap.

Format: “The System ROM is currently managing the power cap.”

Severity: Warning

Resolution: Enable HP RESTful API management of the power cap in System ROM

MessageId: iLO.{version}.PowerValueBadParam

The power cap value is not valid.

Format: “The power cap value is not valid.”

Severity: Warning

Resolution: Retry the operation using a corrected value.

MessageId: iLO.{version}.PowerValueInvalidCalibrationData

The request to set the power cap failed. Invalid power cap calibration data. The Power Cap feature is currently unavailable.

Format: “The request to set the power cap failed. Invalid power cap calibration data. The Power Cap feature is currently unavailable”

Severity: Warning

Resolution: Restart the server to retrieve calibration data from initial POST.

MessageId: iLO.{version}.PowerValueNotOptimal

Power caps set for less than 50% of the difference between maximum and minimum power may become unreachable due to changes in the server. Power caps set for less than 20% are not recommended.

Format: “Power caps set for less than 50% of the difference between maximum and minimum power may become unreachable due to changes in the server. Power caps set for less than 20% are not recommended.”

Severity: Warning

Resolution: Please provide an optimal value in integer considering the power cap range.

MessageId: iLO.{version}.PowerValueUnAvailable

Advanced power capping is not currently available due to the system configuration or state.

Format: “Advanced power capping is not currently available due to the system configuration or state.”

Severity: Warning

Resolution: Change the system configuration or wait for the system to become fully initialized, and then retry the operation.

MessageId: iLO.{version}.PowerValueUnSupported

Advanced power capping is not supported on this system.

Format: “Advanced power capping is not supported on this system.”

Severity: Warning

Resolution: None.

MessageId: iLO.{version}.PrimaryESKMServerAccessible

Only the primary ESKM server is accessible.

Format: “No redundancy. Only the primary ESKM server is accessible.”

Severity: OK

Resolution: None.

MessageId: iLO.{version}.PrimarySecondaryAddressesResolveToSameServer

Primary and secondary ESKM server addresses resolve to the same server.

Format: “No redundancy. Primary and secondary ESKM server addresses resolve to the same server.”

Severity: OK

Resolution: None.

MessageId: iLO.{version}.PrimarySecondaryESKMServersAccessible

Both primary and secondary ESKM servers are accessible.

Format: “Redundant solution: Both primary and secondary ESKM servers are accessible.”

Severity: OK

Resolution: None.

MessageId: iLO.{version}.PropertyValueBadParam

The property value is not valid.

Format: “The property value is not valid.”

Severity: Warning

Resolution: Retry the operation using a corrected value.

MessageId: iLO.{version}.PropertyValueExceedsMaxLength

The value for the property exceeds the maximum length.

Format: “The value %1 for the property %2 exceeds the maximum length of %3.”

Severity: Warning

Resolution: Correct the value for the property in the request body, and then retry the operation.

MessageId: iLO.{version}.PropertyValueIncompatible

The value for the property is the correct type, but this value is incompatible with the current value of another property.

Format: “The value %1 for the property %2 is incompatible with the value for property %3.”

Severity: Warning

Resolution: Correct the value for the property in the request body, and then retry the operation.

MessageId: iLO.{version}.PropertyValueOutOfRange

The value for the property is out of range.

Format: “The value %1 for the property %2 is out of range %3.”

Severity: Warning

Resolution: Correct the value for the property in the request body, and then retry the operation.

MessageId: iLO.{version}.PropertyValueRequired

Indicates that a property was required but not specified.

Format: “%1 requires Property %2 to be specified.”

Severity: Warning

Resolution: Include the required property in the request body and then retry the operation.

MessageId: iLO.{version}.RepairNotSupported

IML event with this severity is not supported to be repaired. IML events with Critical or Warning severities can marked as repaired.

Format: “IML event with %1 severity is not supported to be repaired. IML events with Critical or Warning severities can marked as repaired.”

Severity: Warning

Resolution: Please do not try to repair IML events with severity other than Critical or Warning.

MessageId: iLO.{version}.RequiredPropertyMissing

Indicates that a required property is not specified.

Format: “Required Property %1 needs to be specifed.”

Severity: Warning

Resolution: Include the required property in the request body and then retry the operation.

MessageId: iLO.{version}.ResetInProgress

An iLO reset is in progress.

Format: “An iLO reset is in progress.”

Severity: Warning

Resolution: Wait for iLO reset to complete, and then retry the operation.

MessageId: iLO.{version}.ResetRequired

One or more properties were changed, but these changes will not take effect until the iLO is reset.

Format: “One or more properties were changed, but these changes will not take effect until the iLO is reset.”

Severity: Warning

Resolution: To enable the changed properties, reset the iLO.

MessageId: iLO.{version}.ResourceBeingFlashed

The change to the requested resource failed because the resource is being flashed.

Format: “The change to the requested resource failed because the resource is being flashed.”

Severity: Warning

Resolution: Retry the operation when the firmware upgrade has completed.

MessageId: iLO.{version}.ResourceInUseWithDetail

The change could not be made because the resource was in use or in a transitioning state.

Format: “The change to the resource failed because the resource is in use or in transition.”

Severity: Warning

Resolution: Retry the request.

MessageId: iLO.{version}.ResourceTemporarilyUnavailable

The resource is temporarily unavailable because the firmware is being flashed.

Format: “The resource is temporarily unavailable because the firmware is being flashed.”

Severity: Warning

Resolution: Retry the operation when the firmware upgrade has completed.

MessageId: iLO.{version}.SMBIOSRecordNotFound

The SMBIOS record type is not found or is not supported on the system.

Format: “The SMBIOS record type %1 is not found or is not supported on the system.”

Severity: Warning

Resolution: Reset the system to update the SMBIOS records. If the problem persists then the SMBIOS record type is not supported.

MessageId: iLO.{version}.SNMPAgentlessEnabled

Modifying SNMP properties is not possible while SNMP is configured in Agentless mode.

Format: “%1 cannot be changed while SNMP is configured in Agentless mode.”

Severity: Warning

Resolution: Disable Agentless mode, modify the properties, and then re-enable Agentless mode.

MessageId: iLO.{version}.SNMPAlertDisabled

The operation could not be completed because SNMP alerts are disabled.

Format: “The operation could not be completed because SNMP alerts are disabled.”

Severity: Warning

Resolution: Enable SNMP alerts and retry the operation.

MessageId: iLO.{version}.SNMPDisabled

Modifying SNMP properties is not possible with SNMP disabled.

Format: “Modifying SNMP properties is not possible with SNMP disabled.”

Severity: Warning

Resolution: Enable SNMP, and then modify the SNMP properties.

MessageId: iLO.{version}.SNMPPassthruEnabled

Modifying SNMP properties is not possible while SNMP is configured in pass-thru mode.

Format: “%1 cannot be changed while SNMP is configured in pass-thru mode.”

Severity: Warning

Resolution: Configure SNMP ‘Agentless’ mode, modify the property, and then re-configure SNMP for ‘Passthru’ mode.

MessageId: iLO.{version}.SNMPTestAlertFailed

The SNMP Test Alert did not send successfully.

Format: “The SNMP Test Alert did not send successfully.”

Severity: Warning

Resolution: Verify the test alert content and retry.

MessageId: iLO.{version}.SNTPConfigurationManagedByDHCPAndIsReadOnly

SNTP configuration is currently managed by DHCP and is therefore read-only.

Format: “%1 cannot be changed while DHCP is configured to provide SNTP settings.”

Severity: Warning

Resolution: Disable SNTP configuration options in both DHCPv4 and DHCPv6 (see /Managers/n/NICs), and then reconfigure SNTP as desired with static settings.

MessageId: iLO.{version}.SSOCertficateEmpty

SSO Certificate is Empty.

Format: “Empty SSO Certificate.”

Severity: Warning

Resolution: None.

MessageId: iLO.{version}.SSOCertificateReadError

SSO Certificate Read Error.

Format: “Error reading SSO certificate.”

Severity: Warning

Resolution: Retry the request with valid SSO certificate.

MessageId: iLO.{version}.SSONoSpaceError

No space to store SSO certificate.

Format: “No space to store SSO certificate.”

Severity: Warning

Resolution: Make sure SSO database has enough space to store SSO certificate.

MessageId: iLO.{version}.SSORecordNotFound

SSO Record Not Found.

Format: “SSO Record Not Found.”

Severity: Warning

Resolution: None.

MessageId: iLO.{version}.SecondaryESKMServerAccessible

Only the secondary ESKM server is accessible.

Format: “No redundancy. Only the secondary ESKM server is accessible.”

Severity: OK

Resolution: None.

MessageId: iLO.{version}.SuccessFeedback

The operation completed successfully.

Format: “The operation completed successfully.”

Severity: OK

Resolution: None

MessageId: iLO.{version}.SyslogFeatureDisabled

Remote Syslog feature is disabled.

Format: “Remote syslog feature is disabled.”

Severity: Warning

Resolution: Enable remote syslog feature to send test syslog message.

MessageId: iLO.{version}.SystemResetRequired

The system properties were correctly changed, but will not take effect until the system is reset.

Format: “One or more properties were changed and will not take effect until system is reset.”

Severity: Warning

Resolution: Reset system for the settings to take effect.

MessageId: iLO.{version}.TokenRequired

Proper ‘X-HPRESTFULAPI-AuthToken’ authorization token not provided.

Format: “Proper ‘X-HPRESTFULAPI-AuthToken’ authorization token not provided.”

Severity: Critical

Resolution: Create proper ‘X-HPRESTFULAPI-AuthToken’ authorization token. Send token in using the proper HTTP header.

MessageId: iLO.{version}.UnableModifyRights

Unable to modify user rights.

Format: “Unable to modify user rights.”

Severity: Warning

Resolution: None.

MessageId: iLO.{version}.UnableToModifyDueToMissingComponent

The value for the property cannot be changed because a related hardware component is not installed.

Format: “The value for property %1 cannot be changed because a related hardware component is not installed.”

Severity: Warning

Resolution: Install the hardware component and retry the operation.

MessageId: iLO.{version}.UnableToModifyDuringSystemPOST

The value for the property cannot be changed while the computer system BIOS is in POST.

Format: “The value for property %1 cannot be changed while the computer system BIOS is in POST.”

Severity: Warning

Resolution: After the computer system is either fully booted or powered off, retry the operation.

MessageId: iLO.{version}.UnauthorizedLoginAttempt

The login was not successful, because the supplied credentials could not be authorized.

Format: “The login was not successful, because the supplied credentials could not be authorized.”

Severity: Warning

Resolution: Log in with authorized user name and password credentials.

MessageId: iLO.{version}.UnsupportedOperation

This operation is not supported by RIS for the current system.

Format: “This operation is not supported by RIS for the current system.”

Severity: Warning

Resolution: None.

MessageId: iLO.{version}.UnsupportedOperationInLegacyBootMode

This operation is not supported when the system Boot Mode is set to Legacy BIOS.

Format: “ This operation is not supported when the system Boot Mode is set to Legacy BIOS.”

Severity: Warning

Resolution: Change the Boot Mode to UEFI and retry the operation.

MessageId: iLO.{version}.UnsupportedOperationInSystemBIOS

This operation is not supported by the current version of the system BIOS.

Format: “This operation is not supported by the current version of the system BIOS.”

Severity: Warning

Resolution: None.

MessageId: iLO.{version}.UserAlreadyExist

The user or login user name already exists.

Format: “The user or login user name already exists.”

Severity: Warning

Resolution: Try a different user or login user name.

MessageId: iLO.{version}.UserNameAlreadyExists

Duplicate SNMPv3 User.

Format: “The username %1 already exists in the list”

Severity: Warning

Resolution: Enter a different name and try again.

MessageId: iLO.{version}.iLOResetAndSystemRebootRequired

Indicates that one or more properties were correctly changed, but will not take effect until device is reset and system is rebooted.

Format: “One or more properties were changed and will not take effect until the device is reset and system is rebooted”

Severity: Warning

Resolution: Reset iLO and reboot the server.

Event Definitions

iLO’s REST API has an event subscription service enabling clients to subscribe to events (in the form of Redfish-style POST operations) to a URI of choice. The following events are defined by iLO.

cURL python