This document is a reference to the types, properties, and attributes in the iLO RESTFul API for iLO 4 2.20 and later.

Confidential computer software. Valid license from Hewlett Packard Enterprise required for possession, use, or copying. Consistent with FAR 12.211 and 12.212, Commercial Computer Software, Computer Software Documentation, and Technical Data for Commercial Items are licensed to the U.S. Government under vendor's standard commercial license.

The information contained herein is subject to change without notice. The only warranties for Hewlett Packard Enterprise products and services are set forth in the express warranty statements accompanying such products and services. Nothing herein should be construed as constituting an additional warranty. Hewlett Packard Enterprise shall not be liable for technical or editorial errors or omissions contained herein.

Acknowledgments

Microsoft®, Windows®, Windows® XP, Windows NT®, and Google Chrome® are U.S. registered trademarks of Microsoft Corporation.

Prerequisites and Audience

This paper assumes the reader is familiar with HTTP operations and RESTful web service APIs. The reader should be familiar with JSON and UTF-8 encoding as well as HTTP operations and headers.

This paper is a reference and is intended to be used in conjunction with the paper entitled "Managing Hewlett Packard Enterprise Servers Using the RESTful API." This other document is an introduction to using the iLO RESTful API, while this document provides detail on individual properties and messages.

First Things

HPE Gen9 Servers running iLO 4 2.00 or later feature a new management interface called the “iLO RESTful API.” The iLO RESTful API is a RESTful Web Service API served by iLO’s web server. If you are familiar with RESTful APIs, this should tell you much about how the API works. In short, a RESTful API is an application programming interface using the basic HTTP operations GET, PUT, POST, DELETE, and PATCH. Each HTTP operation either submits or returns a “resource” in the form of UTF-8 encoded JSON. Just as a Web application returns HTML to your browser, a REST interface returns data (in the form of JSON) to your client over the same transport (HTTPS).

All modern scripting languages make it very easy to write simple REST clients for web services. Most, like Python can transform JSON into internal data structures like dictionaries, allowing for easily access to data. This enables you to write custom code directly to the API instead of using intermediate tools.

If you are not familiar with RESTful APIs, you should pause and do internet research on the subject. This tutorial is intended to point out the things you must consider when creating a proper client to interact with the iLO RESTful API.

Key Benefits of the iLO RESTful API

This iLO RESTful API will become the main management API for iLO 4 based HPE Servers. Its feature set will (in time) become larger than the existing ILO XML API (RIBCL) and IPMI interfaces. Using this API you can take full inventory of the server, control power and reset, configure BIOS and iLO 4 settings, fetch event logs as well as many other things.

This 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 easily 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 HPE Management software offerings as well as the entire Software Defined Data Center architecture is built upon REST APIs.

Requirements for using the iLO RESTful API

The iLO RESTful API is available on HPE ProLiant and BladeSystem servers with iLO 4 starting with version 2.00. Because 2.00 firmware is an update to any iLO 4-equiped server, the benefits of the API can be enjoyed on existing Gen8 servers products as well as future servers. In some cases, the data available on Gen8 servers may be less than newer model servers. In particular, the UEFI BIOS configuration features described later is not available on Gen8 servers.

The API is available with the iLO 4 Standard license, although some features in the data may not be available without an Advanced or Select license.

Redfish 1.0

To learn more about Redfish 1.0 and the iLO RESTful API, see Managing Hewlett Packard Enterprise Servers Using the RESTful API at: www.hpe.com/info/restfulinterface/docs.

How to Use This Document

The Resource Map documents the resources in the data model including the URIs and types of the resources as well as the relationships between resources. Not all implementations of the API will contain all the resources in this table and the model may expand in future versions of firmware.

The Data Model Type Reference contains a chapter for each resource type and a section for each property in each resource type.

The Message Reference documents the MessageID values that may be returned in ExtendedError responses to HTTP operations.

Resource Map

This section documents the resource map. Not all resources will be present in all implementations and the resource model may expand in future versions of the firmware. The root resource is /rest/v1.

Data Model Type Reference

This section documents each type of resource. Note that more than one resource may be of the same type. Not all resource instances implement every property specified in the definition.

"AccountService" Resource Type

Resource Instances

/rest/v1/AccountService

See Resource Map for more details.

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

"AccountService" defines the following properties:

"Oem/Hp/AuthFailureDelayTimeSeconds"

This property is a member of AccountService

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

JSON type:

Integer

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

PATCH Example

HTTP PATCH to resource with request JSON:

{"Oem": {"Hp": {"AuthFailureDelayTimeSeconds": <integer-value>}}}

The property "Oem/Hp/AuthFailureDelayTimeSeconds" on resource type AccountService may not support PATCH of all values and may result in an HTTP 400 error with response of Type ExtendedError. Multiple properties may be included in a single HTTP PATCH operation as long as the request is properly formatted JSON. To address an array entry other than the first, insert nulls as placeholders on skipped array entries.

"Oem/Hp/AuthFailureLoggingThreshold"

This property is a member of AccountService

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.

JSON type:

Integer

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

PATCH Example

HTTP PATCH to resource with request JSON:

{"Oem": {"Hp": {"AuthFailureLoggingThreshold": <integer-value>}}}

The property "Oem/Hp/AuthFailureLoggingThreshold" on resource type AccountService may not support PATCH of all values and may result in an HTTP 400 error with response of Type ExtendedError. Multiple properties may be included in a single HTTP PATCH operation as long as the request is properly formatted JSON. To address an array entry other than the first, insert nulls as placeholders on skipped array entries.

"Oem/Hp/AuthFailuresBeforeDelay"

This property is a member of AccountService

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.

JSON type:

Integer

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

PATCH Example

HTTP PATCH to resource with request JSON:

{"Oem": {"Hp": {"AuthFailuresBeforeDelay": <integer-value>}}}

The property "Oem/Hp/AuthFailuresBeforeDelay" on resource type AccountService may not support PATCH of all values and may result in an HTTP 400 error with response of Type ExtendedError. Multiple properties may be included in a single HTTP PATCH operation as long as the request is properly formatted JSON. To address an array entry other than the first, insert nulls as placeholders on skipped array entries.

"Oem/Hp/MinPasswordLength"

This property is a member of AccountService

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.

JSON type:

Integer from 0 to 39.

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

PATCH Example

HTTP PATCH to resource with request JSON:

{"Oem": {"Hp": {"MinPasswordLength": <integer-value>}}}

The property "Oem/Hp/MinPasswordLength" on resource type AccountService may not support PATCH of all values and may result in an HTTP 400 error with response of Type ExtendedError. Multiple properties may be included in a single HTTP PATCH operation as long as the request is properly formatted JSON. To address an array entry other than the first, insert nulls as placeholders on skipped array entries.

"BaseNetworkAdapter" Resource Type

Resource Instances

/rest/v1/Systems/{item}/NetworkAdapters/{item}

See Resource Map for more details.

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.

"PhysicalPorts[]/Status/Health"

This property is a member of BaseNetworkAdapter

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

JSON type:

String containing one of the following supported values:

""
"OK"
"Warning"
"Critical"

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.

"PhysicalPorts[]/Status/HealthRollUp"

This property is a member of BaseNetworkAdapter

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

JSON type:

String containing one of the following supported values:

""
"OK"
"Warning"
"Critical"

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.

"PhysicalPorts[]/Status/HealthRollup"

This property is a member of BaseNetworkAdapter

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

JSON type:

String containing one of the following supported values:

""
"OK"
"Warning"
"Critical"

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.

"PhysicalPorts[]/Status/State"

This property is a member of BaseNetworkAdapter

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

JSON type:

String containing one of the following supported values:

""
"Enabled"
"Disabled"
"Offline"
"InTest"
"Starting"
"Absent"

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.

"PhysicalPorts[]/UEFIDevicePath"

This property is a member of BaseNetworkAdapter

UEFIDevice Path for correlation purposes

JSON type:

String

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.

"SerialNumber"

This property is a member of BaseNetworkAdapter

The device serial number.

JSON type:

String

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.

"Status/Health"

This property is a member of BaseNetworkAdapter

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

JSON type:

String containing one of the following supported values:

""
"OK"
"Warning"
"Critical"

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.

"Status/HealthRollUp"

This property is a member of BaseNetworkAdapter

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

JSON type:

String containing one of the following supported values:

""
"OK"
"Warning"
"Critical"

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.

"Status/HealthRollup"

This property is a member of BaseNetworkAdapter

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

JSON type:

String containing one of the following supported values:

""
"OK"
"Warning"
"Critical"

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.

"Status/State"

This property is a member of BaseNetworkAdapter

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

JSON type:

String containing one of the following supported values:

""
"Enabled"
"Disabled"
"Offline"
"InTest"
"Starting"
"Absent"

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.

"StructuredName"

This property is a member of BaseNetworkAdapter

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

JSON type:

String

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.

"UEFIDevicePath"

This property is a member of BaseNetworkAdapter

UEFIDevice Path for correlation purposes

JSON type:

String

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.

"Chassis" Resource Type

Resource Instances

/rest/v1/Chassis/{item}

See Resource Map for more details.

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

"Chassis" defines the following properties:

"AssetTag"

This property is a member of Chassis

The chassis user-assigned asset tag.

JSON type:

String

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

PATCH Example

HTTP PATCH to resource with request JSON:

{"AssetTag": "<string-value>"}

The property "AssetTag" on resource type Chassis may not support PATCH of all values and may result in an HTTP 400 error with response of Type ExtendedError. Multiple properties may be included in a single HTTP PATCH operation as long as the request is properly formatted JSON. To address an array entry other than the first, insert nulls as placeholders on skipped array entries.

"ChassisType"

This property is a member of Chassis

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

JSON type:

String containing one of the following supported values:

"Rack"
"Blade"
"Enclosure"
"StandAlone"
"RackMount"
"Card"
"Cartridge"
"Row"
"Pod"
"Expansion"
"Sidecar"
"Zone"
"Sled"
"Shelf"
"Other"

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.

"IndicatorLED"

This property is a member of Chassis

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

JSON type:

String containing one of the following supported values:

""
"Unknown"
"Lit"
"Blinking"
"Off"

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

PATCH Example

HTTP PATCH to resource with request JSON:

{"IndicatorLED": "Lit"}

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.

"Status/Health"

This property is a member of Chassis

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

JSON type:

String containing one of the following supported values:

""
"OK"
"Warning"
"Critical"

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.

"Status/HealthRollUp"

This property is a member of Chassis

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

JSON type:

String containing one of the following supported values:

""
"OK"
"Warning"
"Critical"

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.

"Status/HealthRollup"

This property is a member of Chassis

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

JSON type:

String containing one of the following supported values:

""
"OK"
"Warning"
"Critical"

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.

"Status/State"

This property is a member of Chassis

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

JSON type:

String containing one of the following supported values:

""
"Enabled"
"Disabled"
"Offline"
"InTest"
"Starting"
"Absent"

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.

"Version"

This property is a member of Chassis

The chassis version.

JSON type:

String

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.

"ComputerSystem" Resource Type

Resource Instances

/rest/v1/Systems/{item}

See Resource Map for more details.

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.

"ComputerSystem" defines the following properties:

"AssetTag"

This property is a member of ComputerSystem

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

JSON type:

String

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

PATCH Example

HTTP PATCH to resource with request JSON:

{"AssetTag": "<string-value>"}

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.

"Boot/BootSourceOverrideEnabled"

This property is a member of ComputerSystem

BootSourceOverrideTarget must be specified before BootSourceOverrideEnabled can be used.

JSON type:

String containing one of the following supported values:

""
"Disabled"
"Once"
"Continuous"

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

PATCH Example

HTTP PATCH to resource with request JSON:

{"Boot": {"BootSourceOverrideEnabled": "Once"}}

The property "Boot/BootSourceOverrideEnabled" on resource type ComputerSystem may not support PATCH of all values and may result in an HTTP 400 error with response of Type ExtendedError. Multiple properties may be included in a single HTTP PATCH operation as long as the request is properly formatted JSON. To address an array entry other than the first, insert nulls as placeholders on skipped array entries.

"Boot/BootSourceOverrideTarget"

This property is a member of ComputerSystem

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

JSON type:

String containing one of the following supported values:

""
"None"
"Pxe"
"Floppy"
"Cd"
"Usb"
"Hdd"
"BiosSetup"
"Utilities"
"Diags"
"UefiShell"
"UefiTarget"

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

PATCH Example

HTTP PATCH to resource with request JSON:

{"Boot": {"BootSourceOverrideTarget": "Hdd"}}

The property "Boot/BootSourceOverrideTarget" on resource type ComputerSystem may not support PATCH of all values and may result in an HTTP 400 error with response of Type ExtendedError. Multiple properties may be included in a single HTTP PATCH operation as long as the request is properly formatted JSON. To address an array entry other than the first, insert nulls as placeholders on skipped array entries.

"Boot/UefiTargetBootSourceOverride"

This property is a member of ComputerSystem

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

JSON type:

String

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

PATCH Example

HTTP PATCH to resource with request JSON:

{"Boot": {"UefiTargetBootSourceOverride": "<string-value>"}}

The property "Boot/UefiTargetBootSourceOverride" on resource type ComputerSystem may not support PATCH of all values and may result in an HTTP 400 error with response of Type ExtendedError. Multiple properties may be included in a single HTTP PATCH operation as long as the request is properly formatted JSON. To address an array entry other than the first, insert nulls as placeholders on skipped array entries.

"HostCorrelation/HostFQDN"

This property is a member of ComputerSystem

JSON type:

String

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.

"HostCorrelation/HostName"

This property is a member of ComputerSystem

JSON type:

String

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.

"HostName"

This property is a member of ComputerSystem

The DNS Host Name, without any domain information

JSON type:

String

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.

"IndicatorLED"

This property is a member of ComputerSystem

The state of the indicator LED.

JSON type:

String containing one of the following supported values:

""
"Unknown"
"Lit"
"Blinking"
"Off"

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

PATCH Example

HTTP PATCH to resource with request JSON:

{"IndicatorLED": "Lit"}

The property "IndicatorLED" on resource type ComputerSystem may not support PATCH of all values and may result in an HTTP 400 error with response of Type ExtendedError. Multiple properties may be included in a single HTTP PATCH operation as long as the request is properly formatted JSON. To address an array entry other than the first, insert nulls as placeholders on skipped array entries.

"Manufacturer"

This property is a member of ComputerSystem

The manufacturer or OEM of this system.

JSON type:

String

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.

"Memory/Status/Health"

This property is a member of ComputerSystem

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

JSON type:

String containing one of the following supported values:

""
"OK"
"Warning"
"Critical"

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.

"Memory/Status/HealthRollUp"

This property is a member of ComputerSystem

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

JSON type:

String containing one of the following supported values:

""
"OK"
"Warning"
"Critical"

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.

"Memory/Status/HealthRollup"

This property is a member of ComputerSystem

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

JSON type:

String containing one of the following supported values:

""
"OK"
"Warning"
"Critical"

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.

"Memory/Status/State"

This property is a member of ComputerSystem

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

JSON type:

String containing one of the following supported values:

""
"Enabled"
"Disabled"
"Offline"
"InTest"
"Starting"
"Absent"

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.

"Memory/TotalSystemMemoryGB"

This property is a member of ComputerSystem

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

JSON type:

Integer greater than or equal to 0.

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.

"MemorySummary/Status/Health"

This property is a member of ComputerSystem

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

JSON type:

String containing one of the following supported values:

""
"OK"
"Warning"
"Critical"

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.

"MemorySummary/Status/HealthRollUp"

This property is a member of ComputerSystem

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

JSON type:

String containing one of the following supported values:

""
"OK"
"Warning"
"Critical"

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.

"MemorySummary/Status/HealthRollup"

This property is a member of ComputerSystem

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

JSON type:

String containing one of the following supported values:

""
"OK"
"Warning"
"Critical"

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.

"MemorySummary/Status/State"

This property is a member of ComputerSystem

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

JSON type:

String containing one of the following supported values:

""
"Enabled"
"Disabled"
"Offline"
"InTest"
"Starting"
"Absent"

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.

"MemorySummary/TotalSystemMemoryGiB"

This property is a member of ComputerSystem

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

JSON type:

Integer

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.

"Model"

This property is a member of ComputerSystem

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

JSON type:

String

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.

"Oem/Hp/Battery[]/Condition"

This property is a member of ComputerSystem

Condition of battery.

JSON type:

String

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.

"Oem/Hp/Battery[]/ErrorCode"

This property is a member of ComputerSystem

Error Code of battery.

JSON type:

Integer

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.

"Oem/Hp/Battery[]/FirmwareVersion"

This property is a member of ComputerSystem

Firmware Version of battery.

JSON type:

String

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.

"Oem/Hp/Battery[]/Index"

This property is a member of ComputerSystem

Index of battery.

JSON type:

Integer

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.

"Oem/Hp/Battery[]/MaxCapWatts"

This property is a member of ComputerSystem

Maximum Capacity of battery in watts.

JSON type:

Integer

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.

"Oem/Hp/Battery[]/Model"

This property is a member of ComputerSystem

Model of battery.

JSON type:

String

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.

"Oem/Hp/Battery[]/Present"

This property is a member of ComputerSystem

Presence of battery.

JSON type:

String

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.

"Oem/Hp/Battery[]/ProductName"

This property is a member of ComputerSystem

Product Name of battery.

JSON type:

String

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.

"Oem/Hp/Battery[]/SerialNumber"

This property is a member of ComputerSystem

Serial Number of battery.

JSON type:

String

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.

"Oem/Hp/Battery[]/Spare"

This property is a member of ComputerSystem

Spare of battery.

JSON type:

String

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.

"Oem/Hp/Bios/Backup/BuildNumber"

This property is a member of ComputerSystem

The build number of the firmware.

JSON type:

Integer greater than or equal to 0.

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.

"Oem/Hp/Bios/Backup/BuildNumberString"

This property is a member of ComputerSystem

The string version of the build number of the firmware.

JSON type:

String

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.

"Oem/Hp/Bios/Backup/Date"

This property is a member of ComputerSystem

The build date of the firmware.

JSON type:

String

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.

"Oem/Hp/Bios/Backup/DebugBuild"

This property is a member of ComputerSystem

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

JSON type:

Boolean ('true' or 'false')

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.

"Oem/Hp/Bios/Backup/Family"

This property is a member of ComputerSystem

The family of the firmware.

JSON type:

String

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.

"Oem/Hp/Bios/Backup/MajorVersion"

This property is a member of ComputerSystem

The major version of the firmware.

JSON type:

Integer greater than or equal to 0.

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.

"Oem/Hp/Bios/Backup/MinorVersion"

This property is a member of ComputerSystem

The minor version of the firmware.

JSON type:

Integer greater than or equal to 0.

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.

"Oem/Hp/Bios/Backup/Time"

This property is a member of ComputerSystem

The build time of the firmware.

JSON type:

String

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.

"Oem/Hp/Bios/Backup/VersionString"

This property is a member of ComputerSystem

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

JSON type:

String

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.

"Oem/Hp/Bios/Bootblock/BuildNumber"

This property is a member of ComputerSystem

The build number of the firmware.

JSON type:

Integer greater than or equal to 0.

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.

"Oem/Hp/Bios/Bootblock/BuildNumberString"

This property is a member of ComputerSystem

The string version of the build number of the firmware.

JSON type:

String

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.

"Oem/Hp/Bios/Bootblock/Date"

This property is a member of ComputerSystem

The build date of the firmware.

JSON type:

String

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.

"Oem/Hp/Bios/Bootblock/DebugBuild"

This property is a member of ComputerSystem

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

JSON type:

Boolean ('true' or 'false')

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.

"Oem/Hp/Bios/Bootblock/Family"

This property is a member of ComputerSystem

The family of the firmware.

JSON type:

String

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.

"Oem/Hp/Bios/Bootblock/MajorVersion"

This property is a member of ComputerSystem

The major version of the firmware.

JSON type:

Integer greater than or equal to 0.

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.

"Oem/Hp/Bios/Bootblock/MinorVersion"

This property is a member of ComputerSystem

The minor version of the firmware.

JSON type:

Integer greater than or equal to 0.

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.

"Oem/Hp/Bios/Bootblock/Time"

This property is a member of ComputerSystem

The build time of the firmware.

JSON type:

String

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.

"Oem/Hp/Bios/Bootblock/VersionString"

This property is a member of ComputerSystem

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

JSON type:

String

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.

"Oem/Hp/Bios/Current/BuildNumber"

This property is a member of ComputerSystem

The build number of the firmware.

JSON type:

Integer greater than or equal to 0.

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.

"Oem/Hp/Bios/Current/BuildNumberString"

This property is a member of ComputerSystem

The string version of the build number of the firmware.

JSON type:

String

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.

"Oem/Hp/Bios/Current/Date"

This property is a member of ComputerSystem

The build date of the firmware.

JSON type:

String

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.

"Oem/Hp/Bios/Current/DebugBuild"

This property is a member of ComputerSystem

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

JSON type:

Boolean ('true' or 'false')

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.

"Oem/Hp/Bios/Current/Family"

This property is a member of ComputerSystem

The family of the firmware.

JSON type:

String

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.

"Oem/Hp/Bios/Current/MajorVersion"

This property is a member of ComputerSystem

The major version of the firmware.

JSON type:

Integer greater than or equal to 0.

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.

"Oem/Hp/Bios/Current/MinorVersion"

This property is a member of ComputerSystem

The minor version of the firmware.

JSON type:

Integer greater than or equal to 0.

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.

"Oem/Hp/Bios/Current/Time"

This property is a member of ComputerSystem

The build time of the firmware.

JSON type:

String

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.

"Oem/Hp/Bios/Current/VersionString"

This property is a member of ComputerSystem

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

JSON type:

String

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.

"Oem/Hp/Bios/UefiClass"

This property is a member of ComputerSystem

The UEFI BIOS Class value defined in the UEFI specification.

JSON type:

Integer

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.

"Oem/Hp/DeviceDiscoveryComplete/AMSDeviceDiscovery"

This property is a member of ComputerSystem

This property indicates the current AMS Device Discovery Status.

JSON type:

String containing one of the following supported values:

""
"Busy"
"Complete"
"NoAMS"
"Initial"

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.

"Oem/Hp/DeviceDiscoveryComplete/DeviceDiscovery"

This property is a member of ComputerSystem

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

JSON type:

String containing one of the following supported values:

""
"Busy"
"vAuxDeviceDiscoveryComplete"
"vMainDeviceDiscoveryComplete"
"DataIncomplete"
"Initial"

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.

"Oem/Hp/DeviceDiscoveryComplete/SmartArrayDiscovery"

This property is a member of ComputerSystem

This property indicates the current Smart Array Storage Device Discovery Status

JSON type:

String containing one of the following supported values:

""
"Busy"
"PendingSoftwareRAID"
"Complete"
"Initial"

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.

"Oem/Hp/EndOfPostDelaySeconds"

This property is a member of ComputerSystem

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

JSON type:

Integer

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

PATCH Example

HTTP PATCH to resource with request JSON:

{"Oem": {"Hp": {"EndOfPostDelaySeconds": <integer-value>}}}

GET	Rendered if supported by the implementation or omitted if not.

"Oem/Hp/PostMode"

This property is a member of ComputerSystem

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

JSON type:

String containing one of the following supported values:

""
"Normal"
"PostToShutdown"
"PostToReboot"

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

PATCH Example

HTTP PATCH to resource with request JSON:

{"Oem": {"Hp": {"PostMode": "PostToShutdown"}}}

The property "Oem/Hp/PostMode" on resource type ComputerSystem may not support PATCH of all values and may result in an HTTP 400 error with response of Type ExtendedError. Multiple properties may be included in a single HTTP PATCH operation as long as the request is properly formatted JSON. To address an array entry other than the first, insert nulls as placeholders on skipped array entries.

"Oem/Hp/PostState"

This property is a member of ComputerSystem

The current state of system POST.

JSON type:

String containing one of the following supported values:

""
"Unknown"
"Reset"
"PowerOff"
"InPost"
"InPostDiscoveryComplete"
"FinishedPost"

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.

"Oem/Hp/PowerAllocationLimit"

This property is a member of ComputerSystem

The total amount of power allocated to the system.

JSON type:

Integer greater than or equal to 0.

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.

"Oem/Hp/PowerAutoOn"

This property is a member of ComputerSystem

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

JSON type:

String containing one of the following supported values:

"RemainOff"
"PowerOn"
"Restore"

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

PATCH Example

HTTP PATCH to resource with request JSON:

{"Oem": {"Hp": {"PowerAutoOn": "PowerOn"}}}

The property "Oem/Hp/PowerAutoOn" on resource type ComputerSystem may not support PATCH of all values and may result in an HTTP 400 error with response of Type ExtendedError. Multiple properties may be included in a single HTTP PATCH operation as long as the request is properly formatted JSON. To address an array entry other than the first, insert nulls as placeholders on skipped array entries.

"Oem/Hp/PowerOnDelay"

This property is a member of ComputerSystem

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

JSON type:

String containing one of the following supported values:

""
"Minimum"
"15Sec"
"30Sec"
"45Sec"
"60Sec"
"RandomUpTo120Sec"

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

PATCH Example

HTTP PATCH to resource with request JSON:

{"Oem": {"Hp": {"PowerOnDelay": "30Sec"}}}

The property "Oem/Hp/PowerOnDelay" on resource type ComputerSystem may not support PATCH of all values and may result in an HTTP 400 error with response of Type ExtendedError. Multiple properties may be included in a single HTTP PATCH operation as long as the request is properly formatted JSON. To address an array entry other than the first, insert nulls as placeholders on skipped array entries.

"Oem/Hp/PowerRegulatorMode"

This property is a member of ComputerSystem

HP Power Regulator mode.

JSON type:

String containing one of the following supported values:

"OSControl"
"Dynamic"
"Max"
"Min"

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

PATCH Example

HTTP PATCH to resource with request JSON:

{"Oem": {"Hp": {"PowerRegulatorMode": "Max"}}}

The property "Oem/Hp/PowerRegulatorMode" on resource type ComputerSystem may not support PATCH of all values and may result in an HTTP 400 error with response of Type ExtendedError. Multiple properties may be included in a single HTTP PATCH operation as long as the request is properly formatted JSON. To address an array entry other than the first, insert nulls as placeholders on skipped array entries.

"Oem/Hp/ServerSignature"

This property is a member of ComputerSystem

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

JSON type:

Integer

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.

"Oem/Hp/ServerSignatureStatus"

This property is a member of ComputerSystem

The current state of Server Signature.

JSON type:

String containing one of the following supported values:

""
"Initial"
"Busy"
"Invalid"
"Complete"

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.

"Oem/Hp/TrustedModules[]/FWVersion/Backup/BuildNumber"

This property is a member of ComputerSystem

The build number of the firmware.

JSON type:

Integer greater than or equal to 0.

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.

"Oem/Hp/TrustedModules[]/FWVersion/Backup/BuildNumberString"

This property is a member of ComputerSystem

The string version of the build number of the firmware.

JSON type:

String

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.

"Oem/Hp/TrustedModules[]/FWVersion/Backup/Date"

This property is a member of ComputerSystem

The build date of the firmware.

JSON type:

String

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.

"Oem/Hp/TrustedModules[]/FWVersion/Backup/DebugBuild"

This property is a member of ComputerSystem

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

JSON type:

Boolean ('true' or 'false')

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.

"Oem/Hp/TrustedModules[]/FWVersion/Backup/Family"

This property is a member of ComputerSystem

The family of the firmware.

JSON type:

String

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.

"Oem/Hp/TrustedModules[]/FWVersion/Backup/MajorVersion"

This property is a member of ComputerSystem

The major version of the firmware.

JSON type:

Integer greater than or equal to 0.

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.

"Oem/Hp/TrustedModules[]/FWVersion/Backup/MinorVersion"

This property is a member of ComputerSystem

The minor version of the firmware.

JSON type:

Integer greater than or equal to 0.

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.

"Oem/Hp/TrustedModules[]/FWVersion/Backup/Time"

This property is a member of ComputerSystem

The build time of the firmware.

JSON type:

String

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.

"Oem/Hp/TrustedModules[]/FWVersion/Backup/VersionString"

This property is a member of ComputerSystem

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

JSON type:

String

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.

"Oem/Hp/TrustedModules[]/FWVersion/Bootblock/BuildNumber"

This property is a member of ComputerSystem

The build number of the firmware.

JSON type:

Integer greater than or equal to 0.

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.

"Oem/Hp/TrustedModules[]/FWVersion/Bootblock/BuildNumberString"

This property is a member of ComputerSystem

The string version of the build number of the firmware.

JSON type:

String

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.

"Oem/Hp/TrustedModules[]/FWVersion/Bootblock/Date"

This property is a member of ComputerSystem

The build date of the firmware.

JSON type:

String

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.

"Oem/Hp/TrustedModules[]/FWVersion/Bootblock/DebugBuild"

This property is a member of ComputerSystem

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

JSON type:

Boolean ('true' or 'false')

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.

"Oem/Hp/TrustedModules[]/FWVersion/Bootblock/Family"

This property is a member of ComputerSystem

The family of the firmware.

JSON type:

String

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.

"Oem/Hp/TrustedModules[]/FWVersion/Bootblock/MajorVersion"

This property is a member of ComputerSystem

The major version of the firmware.

JSON type:

Integer greater than or equal to 0.

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.

"Oem/Hp/TrustedModules[]/FWVersion/Bootblock/MinorVersion"

This property is a member of ComputerSystem

The minor version of the firmware.

JSON type:

Integer greater than or equal to 0.

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.

"Oem/Hp/TrustedModules[]/FWVersion/Bootblock/Time"

This property is a member of ComputerSystem

The build time of the firmware.

JSON type:

String

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.

"Oem/Hp/TrustedModules[]/FWVersion/Bootblock/VersionString"

This property is a member of ComputerSystem

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

JSON type:

String

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.

"Oem/Hp/TrustedModules[]/FWVersion/Current/BuildNumber"

This property is a member of ComputerSystem

The build number of the firmware.

JSON type:

Integer greater than or equal to 0.

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.

"Oem/Hp/TrustedModules[]/FWVersion/Current/BuildNumberString"

This property is a member of ComputerSystem

The string version of the build number of the firmware.

JSON type:

String

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.

"Oem/Hp/TrustedModules[]/FWVersion/Current/Date"

This property is a member of ComputerSystem

The build date of the firmware.

JSON type:

String

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.

"Oem/Hp/TrustedModules[]/FWVersion/Current/DebugBuild"

This property is a member of ComputerSystem

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

JSON type:

Boolean ('true' or 'false')

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.

"Oem/Hp/TrustedModules[]/FWVersion/Current/Family"

This property is a member of ComputerSystem

The family of the firmware.

JSON type:

String

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.

"Oem/Hp/TrustedModules[]/FWVersion/Current/MajorVersion"

This property is a member of ComputerSystem

The major version of the firmware.

JSON type:

Integer greater than or equal to 0.

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.

"Oem/Hp/TrustedModules[]/FWVersion/Current/MinorVersion"

This property is a member of ComputerSystem

The minor version of the firmware.

JSON type:

Integer greater than or equal to 0.

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.

"Oem/Hp/TrustedModules[]/FWVersion/Current/Time"

This property is a member of ComputerSystem

The build time of the firmware.

JSON type:

String

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.

"Oem/Hp/TrustedModules[]/FWVersion/Current/VersionString"

This property is a member of ComputerSystem

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

JSON type:

String

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.

"Oem/Hp/TrustedModules[]/FWVersion/Pending/BuildNumber"

This property is a member of ComputerSystem

The build number of the firmware.

JSON type:

Integer greater than or equal to 0.

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.

"Oem/Hp/TrustedModules[]/FWVersion/Pending/BuildNumberString"

This property is a member of ComputerSystem

The string version of the build number of the firmware.

JSON type:

String

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.

"Oem/Hp/TrustedModules[]/FWVersion/Pending/Date"

This property is a member of ComputerSystem

The build date of the firmware.

JSON type:

String

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.

"Oem/Hp/TrustedModules[]/FWVersion/Pending/DebugBuild"

This property is a member of ComputerSystem

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

JSON type:

Boolean ('true' or 'false')

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.

"Oem/Hp/TrustedModules[]/FWVersion/Pending/Family"

This property is a member of ComputerSystem

The family of the firmware.

JSON type:

String

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.

"Oem/Hp/TrustedModules[]/FWVersion/Pending/MajorVersion"

This property is a member of ComputerSystem

The major version of the firmware.

JSON type:

Integer greater than or equal to 0.

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.

"Oem/Hp/TrustedModules[]/FWVersion/Pending/MinorVersion"

This property is a member of ComputerSystem

The minor version of the firmware.

JSON type:

Integer greater than or equal to 0.

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.

"Oem/Hp/TrustedModules[]/FWVersion/Pending/Time"

This property is a member of ComputerSystem

The build time of the firmware.

JSON type:

String

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.

"Oem/Hp/TrustedModules[]/FWVersion/Pending/VersionString"

This property is a member of ComputerSystem

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

JSON type:

String

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.

"Oem/Hp/TrustedModules[]/FWVersion/definitions/HpFWVersion/BuildNumber"

This property is a member of ComputerSystem

The build number of the firmware.

JSON type:

Integer greater than or equal to 0.

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.

"Oem/Hp/TrustedModules[]/FWVersion/definitions/HpFWVersion/BuildNumberString"

This property is a member of ComputerSystem

The string version of the build number of the firmware.

JSON type:

String

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.

"Oem/Hp/TrustedModules[]/FWVersion/definitions/HpFWVersion/Date"

This property is a member of ComputerSystem

The build date of the firmware.

JSON type:

String

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.

"Oem/Hp/TrustedModules[]/FWVersion/definitions/HpFWVersion/DebugBuild"

This property is a member of ComputerSystem

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

JSON type:

Boolean ('true' or 'false')

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.

"Oem/Hp/TrustedModules[]/FWVersion/definitions/HpFWVersion/Family"

This property is a member of ComputerSystem

The family of the firmware.

JSON type:

String

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.

"Oem/Hp/TrustedModules[]/FWVersion/definitions/HpFWVersion/MajorVersion"

This property is a member of ComputerSystem

The major version of the firmware.

JSON type:

Integer greater than or equal to 0.

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.

"Oem/Hp/TrustedModules[]/FWVersion/definitions/HpFWVersion/MinorVersion"

This property is a member of ComputerSystem

The minor version of the firmware.

JSON type:

Integer greater than or equal to 0.

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.

"Oem/Hp/TrustedModules[]/FWVersion/definitions/HpFWVersion/Time"

This property is a member of ComputerSystem

The build time of the firmware.

JSON type:

String

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.

"Oem/Hp/TrustedModules[]/FWVersion/definitions/HpFWVersion/VersionString"

This property is a member of ComputerSystem

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

JSON type:

String

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.

"Oem/Hp/TrustedModules[]/ModuleType"

This property is a member of ComputerSystem

This property indicates the type of TPM or TM.

JSON type:

String containing one of the following supported values:

"Unspecified"
"TPM1.2"
"TPM2.0"
"TM1.0"
"Unknown"

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.

"Oem/Hp/TrustedModules[]/Status"

This property is a member of ComputerSystem

This property indicates the TPM or TM status.

JSON type:

String containing one of the following supported values:

"NotPresent"
"PresentEnabled"
"PresentDisabled"
"Unknown"

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.

"Oem/Hp/VirtualProfile"

This property is a member of ComputerSystem

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.

JSON type:

String containing one of the following supported values:

"Active"
"Busy"
"Inactive"
"Unknown"

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.

"Oem/Hp/VirtualUUID"

This property is a member of ComputerSystem

Used in conjunction with the UUID (Logical) value.

JSON type:

String

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.

"PartNumber"

This property is a member of ComputerSystem

The manufacturer's system part number.

JSON type:

String

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.

"Power"

This property is a member of ComputerSystem

The current power state of the system.

JSON type:

String containing one of the following supported values:

""
"On"
"Off"
"Unknown"
"Reset"

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.

"PowerState"

This property is a member of ComputerSystem

This is the current power state of the system

JSON type:

String containing one of the following supported values:

""
"On"
"Off"
"Unknown"
"Reset"

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.

"ProcessorSummary/Count"

This property is a member of ComputerSystem

The number of processors in the system.

JSON type:

Integer

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.

"ProcessorSummary/Model"

This property is a member of ComputerSystem

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

JSON type:

String

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.

"ProcessorSummary/Status/Health"

This property is a member of ComputerSystem

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

JSON type:

String containing one of the following supported values:

""
"OK"
"Warning"
"Critical"

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.

"ProcessorSummary/Status/HealthRollUp"

This property is a member of ComputerSystem

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

JSON type:

String containing one of the following supported values:

""
"OK"
"Warning"
"Critical"

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.

"ProcessorSummary/Status/HealthRollup"

This property is a member of ComputerSystem

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

JSON type:

String containing one of the following supported values:

""
"OK"
"Warning"
"Critical"

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.

"ProcessorSummary/Status/State"

This property is a member of ComputerSystem

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

JSON type:

String containing one of the following supported values:

""
"Enabled"
"Disabled"
"Offline"
"InTest"
"Starting"
"Absent"

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.

"Processors/Count"

This property is a member of ComputerSystem

The number of processors in the system.

JSON type:

Integer greater than or equal to 0.

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.

"Processors/ProcessorFamily"

This property is a member of ComputerSystem

The processor family for the processors in the system.

JSON type:

String

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.

"Processors/Status/Health"

This property is a member of ComputerSystem

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

JSON type:

String containing one of the following supported values:

""
"OK"
"Warning"
"Critical"

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.

"Processors/Status/HealthRollUp"

This property is a member of ComputerSystem

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

JSON type:

String containing one of the following supported values:

""
"OK"
"Warning"
"Critical"

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.

"Processors/Status/HealthRollup"

This property is a member of ComputerSystem

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

JSON type:

String containing one of the following supported values:

""
"OK"
"Warning"
"Critical"

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.

"Processors/Status/State"

This property is a member of ComputerSystem

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

JSON type:

String containing one of the following supported values:

""
"Enabled"
"Disabled"
"Offline"
"InTest"
"Starting"
"Absent"

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.

"SKU"

This property is a member of ComputerSystem

SKU for this system.

JSON type:

String

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.

"SerialNumber"

This property is a member of ComputerSystem

The system serial number.

JSON type:

String

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.

"Status/Health"

This property is a member of ComputerSystem

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

JSON type:

String containing one of the following supported values:

""
"OK"
"Warning"
"Critical"

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.

"Status/HealthRollUp"

This property is a member of ComputerSystem

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

JSON type:

String containing one of the following supported values:

""
"OK"
"Warning"
"Critical"

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.

"Status/HealthRollup"

This property is a member of ComputerSystem

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

JSON type:

String containing one of the following supported values:

""
"OK"
"Warning"
"Critical"

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.

"Status/State"

This property is a member of ComputerSystem

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

JSON type:

String containing one of the following supported values:

""
"Enabled"
"Disabled"
"Offline"
"InTest"
"Starting"
"Absent"

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.

"SystemType"

This property is a member of ComputerSystem

The type of computer system that this resource represents.

JSON type:

String containing one of the following supported values:

"Physical"
"Virtual"
"OS"
"PhysicallyPartitioned"
"VirtuallyPartitioned"

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.

"UUID"

This property is a member of ComputerSystem

The universal unique identifier for this system.

JSON type:

String

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.

"Version"

This property is a member of ComputerSystem

The manufacturer's system version.

JSON type:

String

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.

"VirtualSerialNumber"

This property is a member of ComputerSystem

The system virtual serial number.

JSON type:

String

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.

POST Action "Reset"

Parameter "ResetType"

"ResetType" must be one of the following value(s):

"On"

"ForceOff"

"ForceRestart"

"Nmi"

"PushPowerButton"

Example

HTTP POST to resource with request JSON:

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

POST Action "PowerButton"

The Action to be performed.

Parameter "PushType"

"PushType" must be one of the following value(s):

"Press"

"PressAndHold"

Parameter "Target"

"Target" must be one of the following value(s):

"/Oem/Hp"

Example

HTTP POST to resource with request JSON:

{ "Action": "PowerButton", "PushType": "Press", "Target": "/Oem/Hp"}

POST Action "SystemReset"

The Action to be performed.

Parameter "ResetType"

"ResetType" must be one of the following value(s):

"ColdBoot"

Parameter "Target"

"Target" must be one of the following value(s):

"/Oem/Hp"

Example

HTTP POST to resource with request JSON:

{ "Action": "SystemReset", "ResetType": "ColdBoot", "Target": "/Oem/Hp"}

POST Action "ServerSigRecompute"

The Action to be performed.

Parameter "Target"

"Target" must be one of the following value(s):

"/Oem/Hp"

Example

HTTP POST to resource with request JSON:

{ "Action": "ServerSigRecompute", "Target": "/Oem/Hp"}

"EthernetInterface" Resource Type

Resource Instances

/rest/v1/Managers/{item}/EthernetInterfaces/{item}

See Resource Map for more details.

The schema definition of a simple Ethernet NIC resource.

"EthernetInterface" defines the following properties:

"AutoNeg"

This property is a member of EthernetInterface

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

JSON type:

Boolean ('true' or 'false')

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

PATCH Example

HTTP PATCH to resource with request JSON:

{"AutoNeg": true}

The property "AutoNeg" on resource type EthernetInterface may not support PATCH of all values and may result in an HTTP 400 error with response of Type ExtendedError. Multiple properties may be included in a single HTTP PATCH operation as long as the request is properly formatted JSON. To address an array entry other than the first, insert nulls as placeholders on skipped array entries.

"Autosense"

This property is a member of EthernetInterface

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.

JSON type:

Boolean ('true' or 'false')

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

PATCH Example

HTTP PATCH to resource with request JSON:

{"Autosense": true}

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

PATCH Example

HTTP PATCH to resource with request JSON:

{"FrameSize": <integer-value>}

The property "FrameSize" on resource type EthernetInterface may not support PATCH of all values and may result in an HTTP 400 error with response of Type ExtendedError. Multiple properties may be included in a single HTTP PATCH operation as long as the request is properly formatted JSON. To address an array entry other than the first, insert nulls as placeholders on skipped array entries.

"FullDuplex"

This property is a member of EthernetInterface

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.

JSON type:

Boolean ('true' or 'false')

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

PATCH Example

HTTP PATCH to resource with request JSON:

{"FullDuplex": true}

The property "FullDuplex" on resource type EthernetInterface may not support PATCH of all values and may result in an HTTP 400 error with response of Type ExtendedError. Multiple properties may be included in a single HTTP PATCH operation as long as the request is properly formatted JSON. To address an array entry other than the first, insert nulls as placeholders on skipped array entries.

"HostName"

This property is a member of EthernetInterface

The DNS Host Name, without any domain information.

JSON type:

String

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.

"IPv4Addresses[]/Address"

This property is a member of EthernetInterface

The IPv4 Address.

JSON type:

String

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

PATCH Example

HTTP PATCH to resource with request JSON:

{"IPv4Addresses": [{"Address": "<string-value>"}|null, ...]}

The property "IPv4Addresses[]/Address" on resource type EthernetInterface may not support PATCH of all values and may result in an HTTP 400 error with response of Type ExtendedError. Multiple properties may be included in a single HTTP PATCH operation as long as the request is properly formatted JSON. To address an array entry other than the first, insert nulls as placeholders on skipped array entries.

"IPv4Addresses[]/AddressOrigin"

This property is a member of EthernetInterface

How the address was determined.

JSON type:

String containing one of the following supported values:

""
"DHCP"
"Static"

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.

"IPv4Addresses[]/Gateway"

This property is a member of EthernetInterface

The IPv4 gateway for this address.

JSON type:

String

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

PATCH Example

HTTP PATCH to resource with request JSON:

{"IPv4Addresses": [{"Gateway": "<string-value>"}|null, ...]}

The property "IPv4Addresses[]/Gateway" on resource type EthernetInterface may not support PATCH of all values and may result in an HTTP 400 error with response of Type ExtendedError. Multiple properties may be included in a single HTTP PATCH operation as long as the request is properly formatted JSON. To address an array entry other than the first, insert nulls as placeholders on skipped array entries.

"IPv4Addresses[]/SubnetMask"

This property is a member of EthernetInterface

The IPv4 Subnet mask.

JSON type:

String

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

PATCH Example

HTTP PATCH to resource with request JSON:

{"IPv4Addresses": [{"SubnetMask": "<string-value>"}|null, ...]}

The property "IPv4Addresses[]/SubnetMask" on resource type EthernetInterface may not support PATCH of all values and may result in an HTTP 400 error with response of Type ExtendedError. Multiple properties may be included in a single HTTP PATCH operation as long as the request is properly formatted JSON. To address an array entry other than the first, insert nulls as placeholders on skipped array entries.

"IPv6AddressPolicyTable[]/Label"

This property is a member of EthernetInterface

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

JSON type:

Integer from 0 to 100.

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

PATCH Example

HTTP PATCH to resource with request JSON:

{"IPv6AddressPolicyTable": [{"Label": <integer-value>}|null, ...]}

The property "IPv6AddressPolicyTable[]/Label" on resource type EthernetInterface may not support PATCH of all values and may result in an HTTP 400 error with response of Type ExtendedError. Multiple properties may be included in a single HTTP PATCH operation as long as the request is properly formatted JSON. To address an array entry other than the first, insert nulls as placeholders on skipped array entries.

"IPv6AddressPolicyTable[]/Precedence"

This property is a member of EthernetInterface

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

JSON type:

Integer from 1 to 100.

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

PATCH Example

HTTP PATCH to resource with request JSON:

{"IPv6AddressPolicyTable": [{"Precedence": <integer-value>}|null, ...]}

The property "IPv6AddressPolicyTable[]/Precedence" on resource type EthernetInterface may not support PATCH of all values and may result in an HTTP 400 error with response of Type ExtendedError. Multiple properties may be included in a single HTTP PATCH operation as long as the request is properly formatted JSON. To address an array entry other than the first, insert nulls as placeholders on skipped array entries.

"IPv6AddressPolicyTable[]/Prefix"

This property is a member of EthernetInterface

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

JSON type:

String

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

PATCH Example

HTTP PATCH to resource with request JSON:

{"IPv6AddressPolicyTable": [{"Prefix": "<string-value>"}|null, ...]}

The property "IPv6AddressPolicyTable[]/Prefix" on resource type EthernetInterface may not support PATCH of all values and may result in an HTTP 400 error with response of Type ExtendedError. Multiple properties may be included in a single HTTP PATCH operation as long as the request is properly formatted JSON. To address an array entry other than the first, insert nulls as placeholders on skipped array entries.

"IPv6Addresses[]/Address"

This property is a member of EthernetInterface

The IPv6 Address.

JSON type:

String

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.

"IPv6Addresses[]/AddressOrigin"

This property is a member of EthernetInterface

How the address was determined.

JSON type:

String containing one of the following supported values:

""
"DHCP"
"Static"
"SLAAC"

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.

"IPv6Addresses[]/AddressState"

This property is a member of EthernetInterface

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

JSON type:

String containing one of the following supported values:

""
"Preferred"
"Deprecated"
"Tentative"
"Failed"

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.

"IPv6Addresses[]/PrefixLength"

This property is a member of EthernetInterface

The IPv6 Address Prefix Length.

JSON type:

Integer from 1 to 128.

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.

"IPv6DefaultGateway"

This property is a member of EthernetInterface

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

JSON type:

String

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.

"IPv6StaticAddresses[]/Address"

This property is a member of EthernetInterface

A valid IPv6 address.

JSON type:

String

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

PATCH Example

HTTP PATCH to resource with request JSON:

{"IPv6StaticAddresses": [{"Address": "<string-value>"}|null, ...]}

The property "IPv6StaticAddresses[]/Address" on resource type EthernetInterface may not support PATCH of all values and may result in an HTTP 400 error with response of Type ExtendedError. Multiple properties may be included in a single HTTP PATCH operation as long as the request is properly formatted JSON. To address an array entry other than the first, insert nulls as placeholders on skipped array entries.

"IPv6StaticAddresses[]/PrefixLength"

This property is a member of EthernetInterface

The Prefix Length of this IPv6 address.

JSON type:

Integer from 1 to 128.

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

PATCH Example

HTTP PATCH to resource with request JSON:

{"IPv6StaticAddresses": [{"PrefixLength": <integer-value>}|null, ...]}

The property "IPv6StaticAddresses[]/PrefixLength" on resource type EthernetInterface may not support PATCH of all values and may result in an HTTP 400 error with response of Type ExtendedError. Multiple properties may be included in a single HTTP PATCH operation as long as the request is properly formatted JSON. To address an array entry other than the first, insert nulls as placeholders on skipped array entries.

"LinkTechnology"

This property is a member of EthernetInterface

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

JSON type:

String containing one of the following supported values:

""
"Ethernet"

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.

"MACAddress"

This property is a member of EthernetInterface

The effective current MAC address. If the assignable MAC address is not supported, this is a read-only alias of FactoryMacAddress.

JSON type:

String

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

PATCH Example

HTTP PATCH to resource with request JSON:

{"MACAddress": "<string-value>"}

The property "MACAddress" on resource type EthernetInterface may not support PATCH of all values and may result in an HTTP 400 error with response of Type ExtendedError. Multiple properties may be included in a single HTTP PATCH operation as long as the request is properly formatted JSON. To address an array entry other than the first, insert nulls as placeholders on skipped array entries.

"MacAddress"

This property is a member of EthernetInterface

The effective current MAC address. If the assignable MAC address is not supported, this is a read-only alias of FactoryMacAddress.

JSON type:

String

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

PATCH Example

HTTP PATCH to resource with request JSON:

{"MacAddress": "<string-value>"}

The property "MacAddress" on resource type EthernetInterface may not support PATCH of all values and may result in an HTTP 400 error with response of Type ExtendedError. Multiple properties may be included in a single HTTP PATCH operation as long as the request is properly formatted JSON. To address an array entry other than the first, insert nulls as placeholders on skipped array entries.

"MaxIPv6StaticAddresses"

This property is a member of EthernetInterface

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

JSON type:

Integer

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.

"Oem/Hp/ConfigurationSettings"

This property is a member of EthernetInterface

The state of the currently displayed configuration settings.

JSON type:

String containing one of the following supported values:

"Current"
"SomePendingReset"

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.

"Oem/Hp/DHCPv4/Enabled"

This property is a member of EthernetInterface

Determines whether DHCPv4 is enabled.

JSON type:

Boolean ('true' or 'false')

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

PATCH Example

HTTP PATCH to resource with request JSON:

{"Oem": {"Hp": {"DHCPv4": {"Enabled": true}}}}

The property "Oem/Hp/DHCPv4/Enabled" on resource type EthernetInterface may not support PATCH of all values and may result in an HTTP 400 error with response of Type ExtendedError. Multiple properties may be included in a single HTTP PATCH operation as long as the request is properly formatted JSON. To address an array entry other than the first, insert nulls as placeholders on skipped array entries.

"Oem/Hp/DHCPv4/UseDNSServers"

This property is a member of EthernetInterface

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.

JSON type:

Boolean ('true' or 'false')

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

PATCH Example

HTTP PATCH to resource with request JSON:

{"Oem": {"Hp": {"DHCPv4": {"UseDNSServers": true}}}}

The property "Oem/Hp/DHCPv4/UseDNSServers" on resource type EthernetInterface may not support PATCH of all values and may result in an HTTP 400 error with response of Type ExtendedError. Multiple properties may be included in a single HTTP PATCH operation as long as the request is properly formatted JSON. To address an array entry other than the first, insert nulls as placeholders on skipped array entries.

"Oem/Hp/DHCPv4/UseDomainName"

This property is a member of EthernetInterface

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.

JSON type:

Boolean ('true' or 'false')

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

PATCH Example

HTTP PATCH to resource with request JSON:

{"Oem": {"Hp": {"DHCPv4": {"UseDomainName": true}}}}

The property "Oem/Hp/DHCPv4/UseDomainName" on resource type EthernetInterface may not support PATCH of all values and may result in an HTTP 400 error with response of Type ExtendedError. Multiple properties may be included in a single HTTP PATCH operation as long as the request is properly formatted JSON. To address an array entry other than the first, insert nulls as placeholders on skipped array entries.

"Oem/Hp/DHCPv4/UseGateway"

This property is a member of EthernetInterface

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.

JSON type:

Boolean ('true' or 'false')

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

PATCH Example

HTTP PATCH to resource with request JSON:

{"Oem": {"Hp": {"DHCPv4": {"UseGateway": true}}}}

The property "Oem/Hp/DHCPv4/UseGateway" on resource type EthernetInterface may not support PATCH of all values and may result in an HTTP 400 error with response of Type ExtendedError. Multiple properties may be included in a single HTTP PATCH operation as long as the request is properly formatted JSON. To address an array entry other than the first, insert nulls as placeholders on skipped array entries.

"Oem/Hp/DHCPv4/UseNTPServers"

This property is a member of EthernetInterface

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.

JSON type:

Boolean ('true' or 'false')

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

PATCH Example

HTTP PATCH to resource with request JSON:

{"Oem": {"Hp": {"DHCPv4": {"UseNTPServers": true}}}}

The property "Oem/Hp/DHCPv4/UseNTPServers" on resource type EthernetInterface may not support PATCH of all values and may result in an HTTP 400 error with response of Type ExtendedError. Multiple properties may be included in a single HTTP PATCH operation as long as the request is properly formatted JSON. To address an array entry other than the first, insert nulls as placeholders on skipped array entries.

"Oem/Hp/DHCPv4/UseStaticRoutes"

This property is a member of EthernetInterface

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.

JSON type:

Boolean ('true' or 'false')

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

PATCH Example

HTTP PATCH to resource with request JSON:

{"Oem": {"Hp": {"DHCPv4": {"UseStaticRoutes": true}}}}

The property "Oem/Hp/DHCPv4/UseStaticRoutes" on resource type EthernetInterface may not support PATCH of all values and may result in an HTTP 400 error with response of Type ExtendedError. Multiple properties may be included in a single HTTP PATCH operation as long as the request is properly formatted JSON. To address an array entry other than the first, insert nulls as placeholders on skipped array entries.

"Oem/Hp/DHCPv4/UseWINSServers"

This property is a member of EthernetInterface

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.

JSON type:

Boolean ('true' or 'false')

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

PATCH Example

HTTP PATCH to resource with request JSON:

{"Oem": {"Hp": {"DHCPv4": {"UseWINSServers": true}}}}

The property "Oem/Hp/DHCPv4/UseWINSServers" on resource type EthernetInterface may not support PATCH of all values and may result in an HTTP 400 error with response of Type ExtendedError. Multiple properties may be included in a single HTTP PATCH operation as long as the request is properly formatted JSON. To address an array entry other than the first, insert nulls as placeholders on skipped array entries.

"Oem/Hp/DHCPv6/StatefulModeEnabled"

This property is a member of EthernetInterface

Determines whether DHCPv6 Stateful mode is enabled.

JSON type:

Boolean ('true' or 'false')

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

PATCH Example

HTTP PATCH to resource with request JSON:

{"Oem": {"Hp": {"DHCPv6": {"StatefulModeEnabled": true}}}}

The property "Oem/Hp/DHCPv6/StatefulModeEnabled" on resource type EthernetInterface may not support PATCH of all values and may result in an HTTP 400 error with response of Type ExtendedError. Multiple properties may be included in a single HTTP PATCH operation as long as the request is properly formatted JSON. To address an array entry other than the first, insert nulls as placeholders on skipped array entries.

"Oem/Hp/DHCPv6/StatelessModeEnabled"

This property is a member of EthernetInterface

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

JSON type:

Boolean ('true' or 'false')

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

PATCH Example

HTTP PATCH to resource with request JSON:

{"Oem": {"Hp": {"DHCPv6": {"StatelessModeEnabled": true}}}}

The property "Oem/Hp/DHCPv6/StatelessModeEnabled" on resource type EthernetInterface may not support PATCH of all values and may result in an HTTP 400 error with response of Type ExtendedError. Multiple properties may be included in a single HTTP PATCH operation as long as the request is properly formatted JSON. To address an array entry other than the first, insert nulls as placeholders on skipped array entries.

"Oem/Hp/DHCPv6/UseDNSServers"

This property is a member of EthernetInterface

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.

JSON type:

Boolean ('true' or 'false')

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

PATCH Example

HTTP PATCH to resource with request JSON:

{"Oem": {"Hp": {"DHCPv6": {"UseDNSServers": true}}}}

The property "Oem/Hp/DHCPv6/UseDNSServers" on resource type EthernetInterface may not support PATCH of all values and may result in an HTTP 400 error with response of Type ExtendedError. Multiple properties may be included in a single HTTP PATCH operation as long as the request is properly formatted JSON. To address an array entry other than the first, insert nulls as placeholders on skipped array entries.

"Oem/Hp/DHCPv6/UseDomainName"

This property is a member of EthernetInterface

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.

JSON type:

Boolean ('true' or 'false')

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

PATCH Example

HTTP PATCH to resource with request JSON:

{"Oem": {"Hp": {"DHCPv6": {"UseDomainName": true}}}}

The property "Oem/Hp/DHCPv6/UseDomainName" on resource type EthernetInterface may not support PATCH of all values and may result in an HTTP 400 error with response of Type ExtendedError. Multiple properties may be included in a single HTTP PATCH operation as long as the request is properly formatted JSON. To address an array entry other than the first, insert nulls as placeholders on skipped array entries.

"Oem/Hp/DHCPv6/UseNTPServers"

This property is a member of EthernetInterface

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.

JSON type:

Boolean ('true' or 'false')

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

PATCH Example

HTTP PATCH to resource with request JSON:

{"Oem": {"Hp": {"DHCPv6": {"UseNTPServers": true}}}}

The property "Oem/Hp/DHCPv6/UseNTPServers" on resource type EthernetInterface may not support PATCH of all values and may result in an HTTP 400 error with response of Type ExtendedError. Multiple properties may be included in a single HTTP PATCH operation as long as the request is properly formatted JSON. To address an array entry other than the first, insert nulls as placeholders on skipped array entries.

"Oem/Hp/DHCPv6/UseRapidCommit"

This property is a member of EthernetInterface

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.

JSON type:

Boolean ('true' or 'false')

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

PATCH Example

HTTP PATCH to resource with request JSON:

{"Oem": {"Hp": {"DHCPv6": {"UseRapidCommit": true}}}}

The property "Oem/Hp/DHCPv6/UseRapidCommit" on resource type EthernetInterface may not support PATCH of all values and may result in an HTTP 400 error with response of Type ExtendedError. Multiple properties may be included in a single HTTP PATCH operation as long as the request is properly formatted JSON. To address an array entry other than the first, insert nulls as placeholders on skipped array entries.

"Oem/Hp/DomainName"

This property is a member of EthernetInterface

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.

JSON type:

String

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

PATCH Example

HTTP PATCH to resource with request JSON:

{"Oem": {"Hp": {"DomainName": "<string-value>"}}}

The property "Oem/Hp/DomainName" on resource type EthernetInterface may not support PATCH of all values and may result in an HTTP 400 error with response of Type ExtendedError. Multiple properties may be included in a single HTTP PATCH operation as long as the request is properly formatted JSON. To address an array entry other than the first, insert nulls as placeholders on skipped array entries.

"Oem/Hp/HostName"

This property is a member of EthernetInterface

The management processor host name.

JSON type:

String

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

PATCH Example

HTTP PATCH to resource with request JSON:

{"Oem": {"Hp": {"HostName": "<string-value>"}}}

The property "Oem/Hp/HostName" on resource type EthernetInterface may not support PATCH of all values and may result in an HTTP 400 error with response of Type ExtendedError. Multiple properties may be included in a single HTTP PATCH operation as long as the request is properly formatted JSON. To address an array entry other than the first, insert nulls as placeholders on skipped array entries.

"Oem/Hp/IPv4/DDNSRegistration"

This property is a member of EthernetInterface

Determines whether DDNS registration is enabled.

JSON type:

Boolean ('true' or 'false')

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

PATCH Example

HTTP PATCH to resource with request JSON:

{"Oem": {"Hp": {"IPv4": {"DDNSRegistration": true}}}}

The property "Oem/Hp/IPv4/DDNSRegistration" on resource type EthernetInterface may not support PATCH of all values and may result in an HTTP 400 error with response of Type ExtendedError. Multiple properties may be included in a single HTTP PATCH operation as long as the request is properly formatted JSON. To address an array entry other than the first, insert nulls as placeholders on skipped array entries.

"Oem/Hp/IPv4/StaticRoutes[]/Destination"

This property is a member of EthernetInterface

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.

JSON type:

String

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

PATCH Example

HTTP PATCH to resource with request JSON:

{"Oem": {"Hp": {"IPv4": {"StaticRoutes": [{"Destination": "<string-value>"}|null, ...]}}}}

The property "Oem/Hp/IPv4/StaticRoutes[]/Destination" on resource type EthernetInterface may not support PATCH of all values and may result in an HTTP 400 error with response of Type ExtendedError. Multiple properties may be included in a single HTTP PATCH operation as long as the request is properly formatted JSON. To address an array entry other than the first, insert nulls as placeholders on skipped array entries.

"Oem/Hp/IPv4/StaticRoutes[]/Gateway"

This property is a member of EthernetInterface

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.

JSON type:

String

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

PATCH Example

HTTP PATCH to resource with request JSON:

{"Oem": {"Hp": {"IPv4": {"StaticRoutes": [{"Gateway": "<string-value>"}|null, ...]}}}}

The property "Oem/Hp/IPv4/StaticRoutes[]/Gateway" on resource type EthernetInterface may not support PATCH of all values and may result in an HTTP 400 error with response of Type ExtendedError. Multiple properties may be included in a single HTTP PATCH operation as long as the request is properly formatted JSON. To address an array entry other than the first, insert nulls as placeholders on skipped array entries.

"Oem/Hp/IPv4/StaticRoutes[]/SubnetMask"

This property is a member of EthernetInterface

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.

JSON type:

String

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

PATCH Example

HTTP PATCH to resource with request JSON:

{"Oem": {"Hp": {"IPv4": {"StaticRoutes": [{"SubnetMask": "<string-value>"}|null, ...]}}}}

The property "Oem/Hp/IPv4/StaticRoutes[]/SubnetMask" on resource type EthernetInterface may not support PATCH of all values and may result in an HTTP 400 error with response of Type ExtendedError. Multiple properties may be included in a single HTTP PATCH operation as long as the request is properly formatted JSON. To address an array entry other than the first, insert nulls as placeholders on skipped array entries.

"Oem/Hp/IPv4/WINSRegistration"

This property is a member of EthernetInterface

Determines whether WINS registration is enabled.

JSON type:

Boolean ('true' or 'false')

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

PATCH Example

HTTP PATCH to resource with request JSON:

{"Oem": {"Hp": {"IPv4": {"WINSRegistration": true}}}}

The property "Oem/Hp/IPv4/WINSRegistration" on resource type EthernetInterface may not support PATCH of all values and may result in an HTTP 400 error with response of Type ExtendedError. Multiple properties may be included in a single HTTP PATCH operation as long as the request is properly formatted JSON. To address an array entry other than the first, insert nulls as placeholders on skipped array entries.

"Oem/Hp/IPv6/DDNSRegistration"

This property is a member of EthernetInterface

Determines whether IPv6 DDNS registration is enabled.

JSON type:

Boolean ('true' or 'false')

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

PATCH Example

HTTP PATCH to resource with request JSON:

{"Oem": {"Hp": {"IPv6": {"DDNSRegistration": true}}}}

The property "Oem/Hp/IPv6/DDNSRegistration" on resource type EthernetInterface may not support PATCH of all values and may result in an HTTP 400 error with response of Type ExtendedError. Multiple properties may be included in a single HTTP PATCH operation as long as the request is properly formatted JSON. To address an array entry other than the first, insert nulls as placeholders on skipped array entries.

"Oem/Hp/IPv6/SLAACEnabled"

This property is a member of EthernetInterface

Determines whether StateLess Address Auto-Configuration is enabled.

JSON type:

Boolean ('true' or 'false')

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

PATCH Example

HTTP PATCH to resource with request JSON:

{"Oem": {"Hp": {"IPv6": {"SLAACEnabled": true}}}}

The property "Oem/Hp/IPv6/SLAACEnabled" on resource type EthernetInterface may not support PATCH of all values and may result in an HTTP 400 error with response of Type ExtendedError. Multiple properties may be included in a single HTTP PATCH operation as long as the request is properly formatted JSON. To address an array entry other than the first, insert nulls as placeholders on skipped array entries.

"Oem/Hp/IPv6/StaticDefaultGateway"

This property is a member of EthernetInterface

The IPv6 static default gateway entry.

JSON type:

String

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

PATCH Example

HTTP PATCH to resource with request JSON:

{"Oem": {"Hp": {"IPv6": {"StaticDefaultGateway": "<string-value>"}}}}

The property "Oem/Hp/IPv6/StaticDefaultGateway" on resource type EthernetInterface may not support PATCH of all values and may result in an HTTP 400 error with response of Type ExtendedError. Multiple properties may be included in a single HTTP PATCH operation as long as the request is properly formatted JSON. To address an array entry other than the first, insert nulls as placeholders on skipped array entries.

"Oem/Hp/IPv6/StaticRoutes[]/Destination"

This property is a member of EthernetInterface

The IPv6 static route destination address.

JSON type:

String

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

PATCH Example

HTTP PATCH to resource with request JSON:

{"Oem": {"Hp": {"IPv6": {"StaticRoutes": [{"Destination": "<string-value>"}|null, ...]}}}}

The property "Oem/Hp/IPv6/StaticRoutes[]/Destination" on resource type EthernetInterface may not support PATCH of all values and may result in an HTTP 400 error with response of Type ExtendedError. Multiple properties may be included in a single HTTP PATCH operation as long as the request is properly formatted JSON. To address an array entry other than the first, insert nulls as placeholders on skipped array entries.

"Oem/Hp/IPv6/StaticRoutes[]/Gateway"

This property is a member of EthernetInterface

The IPv6 static route gateway.

JSON type:

String

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

PATCH Example

HTTP PATCH to resource with request JSON:

{"Oem": {"Hp": {"IPv6": {"StaticRoutes": [{"Gateway": "<string-value>"}|null, ...]}}}}

The property "Oem/Hp/IPv6/StaticRoutes[]/Gateway" on resource type EthernetInterface may not support PATCH of all values and may result in an HTTP 400 error with response of Type ExtendedError. Multiple properties may be included in a single HTTP PATCH operation as long as the request is properly formatted JSON. To address an array entry other than the first, insert nulls as placeholders on skipped array entries.

"Oem/Hp/IPv6/StaticRoutes[]/PrefixLength"

This property is a member of EthernetInterface

The prefix length of the IPv6 static route destination address.

JSON type:

Integer from 1 to 128.

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

PATCH Example

HTTP PATCH to resource with request JSON:

{"Oem": {"Hp": {"IPv6": {"StaticRoutes": [{"PrefixLength": <integer-value>}|null, ...]}}}}

The property "Oem/Hp/IPv6/StaticRoutes[]/PrefixLength" on resource type EthernetInterface may not support PATCH of all values and may result in an HTTP 400 error with response of Type ExtendedError. Multiple properties may be included in a single HTTP PATCH operation as long as the request is properly formatted JSON. To address an array entry other than the first, insert nulls as placeholders on skipped array entries.

"Oem/Hp/IPv6/StaticRoutes[]/Status"

This property is a member of EthernetInterface

Status of this static route entry.

JSON type:

String containing one of the following supported values:

"Unknown"
"Pending"
"Active"
"Failed"

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.

"Oem/Hp/NICEnabled"

This property is a member of EthernetInterface

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.

JSON type:

Boolean ('true' or 'false')

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

PATCH Example

HTTP PATCH to resource with request JSON:

{"Oem": {"Hp": {"NICEnabled": true}}}

The property "Oem/Hp/NICEnabled" on resource type EthernetInterface may not support PATCH of all values and may result in an HTTP 400 error with response of Type ExtendedError. Multiple properties may be included in a single HTTP PATCH operation as long as the request is properly formatted JSON. To address an array entry other than the first, insert nulls as placeholders on skipped array entries.

"Oem/Hp/NICSupportsIPv6"

This property is a member of EthernetInterface

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

JSON type:

Boolean ('true' or 'false')

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.

"Oem/Hp/PingGatewayOnStartup"

This property is a member of EthernetInterface

Determines whether to ping the IPv4 gateway on startup.

JSON type:

Boolean ('true' or 'false')

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

PATCH Example

HTTP PATCH to resource with request JSON:

{"Oem": {"Hp": {"PingGatewayOnStartup": true}}}

The property "Oem/Hp/PingGatewayOnStartup" on resource type EthernetInterface may not support PATCH of all values and may result in an HTTP 400 error with response of Type ExtendedError. Multiple properties may be included in a single HTTP PATCH operation as long as the request is properly formatted JSON. To address an array entry other than the first, insert nulls as placeholders on skipped array entries.

"Oem/Hp/SharedNetworkPortOptions/NIC"

This property is a member of EthernetInterface

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

JSON type:

String containing one of the following supported values:

"LOM"
"FlexibleLOM"

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

PATCH Example

HTTP PATCH to resource with request JSON:

{"Oem": {"Hp": {"SharedNetworkPortOptions": {"NIC": "FlexibleLOM"}}}}

The property "Oem/Hp/SharedNetworkPortOptions/NIC" on resource type EthernetInterface may not support PATCH of all values and may result in an HTTP 400 error with response of Type ExtendedError. Multiple properties may be included in a single HTTP PATCH operation as long as the request is properly formatted JSON. To address an array entry other than the first, insert nulls as placeholders on skipped array entries.

"Oem/Hp/SharedNetworkPortOptions/Port"

This property is a member of EthernetInterface

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

JSON type:

Integer from 1 to 2.

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

PATCH Example

HTTP PATCH to resource with request JSON:

{"Oem": {"Hp": {"SharedNetworkPortOptions": {"Port": <integer-value>}}}}

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

PATCH Example

HTTP PATCH to resource with request JSON:

{"Oem": {"Hp": {"VLANEnabled": true}}}

The property "Oem/Hp/VLANEnabled" on resource type EthernetInterface may not support PATCH of all values and may result in an HTTP 400 error with response of Type ExtendedError. Multiple properties may be included in a single HTTP PATCH operation as long as the request is properly formatted JSON. To address an array entry other than the first, insert nulls as placeholders on skipped array entries.

"Oem/Hp/VLANId"

This property is a member of EthernetInterface

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

JSON type:

Integer from 1 to 4094.

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

PATCH Example

HTTP PATCH to resource with request JSON:

{"Oem": {"Hp": {"VLANId": <integer-value>}}}

The property "Oem/Hp/VLANId" on resource type EthernetInterface may not support PATCH of all values and may result in an HTTP 400 error with response of Type ExtendedError. Multiple properties may be included in a single HTTP PATCH operation as long as the request is properly formatted JSON. To address an array entry other than the first, insert nulls as placeholders on skipped array entries.

"PermanentMACAddress"

This property is a member of EthernetInterface

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

JSON type:

String

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.

"SettingsResult/ETag"

This property is a member of EthernetInterface

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

JSON type:

String

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.

"SettingsResult/Operation"

This property is a member of EthernetInterface

Last operation detail.

JSON type:

String containing one of the following supported values:

"SettingsApply"

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.

"SettingsResult/Time"

This property is a member of EthernetInterface

Indicates the time the settings were applied.

JSON type:

String

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.

"SpeedMbps"

This property is a member of EthernetInterface

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.

JSON type:

Integer

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

PATCH Example

HTTP PATCH to resource with request JSON:

{"SpeedMbps": <integer-value>}

The property "SpeedMbps" on resource type EthernetInterface may not support PATCH of all values and may result in an HTTP 400 error with response of Type ExtendedError. Multiple properties may be included in a single HTTP PATCH operation as long as the request is properly formatted JSON. To address an array entry other than the first, insert nulls as placeholders on skipped array entries.

"Status/Health"

This property is a member of EthernetInterface

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

JSON type:

String containing one of the following supported values:

""
"OK"
"Warning"
"Critical"

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.

"Status/HealthRollUp"

This property is a member of EthernetInterface

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

JSON type:

String containing one of the following supported values:

""
"OK"
"Warning"
"Critical"

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.

"Status/HealthRollup"

This property is a member of EthernetInterface

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

JSON type:

String containing one of the following supported values:

""
"OK"
"Warning"
"Critical"

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.

"Status/State"

This property is a member of EthernetInterface

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

JSON type:

String containing one of the following supported values:

""
"Enabled"
"Disabled"
"Offline"
"InTest"
"Starting"
"Absent"

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.

"UEFIDevicePath"

This property is a member of EthernetInterface

The UEFI device path for this NIC.

JSON type:

String

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.

"VLANEnable"

This property is a member of EthernetInterface

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.

JSON type:

Boolean ('true' or 'false')

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.

"VLANId"

This property is a member of EthernetInterface

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.

JSON type:

Integer from 0 to 4095.

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.

"EventService" Resource Type

Resource Instances

/rest/v1/EventService

See Resource Map for more details.

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.

GET	Rendered if supported by the implementation or omitted if not.

"Oem/Hp/TTLUnitsDefault"

This property is a member of EventService

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.

JSON type:

String containing one of the following supported values:

"seconds"
"minutes"
"days"

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.

"Status/Health"

This property is a member of EventService

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

JSON type:

String containing one of the following supported values:

""
"OK"
"Warning"
"Critical"

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.

"Status/HealthRollUp"

This property is a member of EventService

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

JSON type:

String containing one of the following supported values:

""
"OK"
"Warning"
"Critical"

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.

"Status/HealthRollup"

This property is a member of EventService

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

JSON type:

String containing one of the following supported values:

""
"OK"
"Warning"
"Critical"

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.

"Status/State"

This property is a member of EventService

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

JSON type:

String containing one of the following supported values:

""
"Enabled"
"Disabled"
"Offline"
"InTest"
"Starting"
"Absent"

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.

"SubscriptionRemovalAction"

This property is a member of EventService

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

JSON type:

String containing one of the following supported values:

"Remove"
"Disable"
"Ignore"

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.

"SubscriptionRemovalTimeIntervalInMinutes"

This property is a member of EventService

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

JSON type:

Integer

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.

POST Action "SubmitTestEvent"

Parameter "EventType"

"EventType" must be one of the following value(s):

"StatusChange"

"ResourceUpdated"

"ResourceAdded"

"ResourceRemoved"

"Alert"

Parameter "EventID"

"EventID" must be one of the following value(s):

"<string>"

Parameter "EventTimestamp"

"EventTimestamp" must be one of the following value(s):

"<date-time>"

Parameter "Severity"

"Severity" must be one of the following value(s):

"OK"

Resource Instances

/rest/v1/Systems/{item}/FirmwareInventory

See Resource Map for more details.

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.

"HPPowerMeter" Resource Type

Resource Instances

/rest/v1/Chassis/{item}/Power/FastPowerMeter

/rest/v1/Chassis/{item}/Power/PowerMeter

See Resource Map for more details.

GET	Rendered if supported by the implementation or omitted if not.

"PowerDetail[]/PrMode"

This property is a member of HPPowerMeter

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

JSON type:

String containing one of the following supported values:

"dyn"
"min"
"max"
"osc"

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.

"PowerDetail[]/PunCap"

This property is a member of HPPowerMeter

Punitive cap for the power meter.

JSON type:

Boolean ('true' or 'false')

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.

"PowerDetail[]/Time"

This property is a member of HPPowerMeter

Time at which the power detail was captured.

JSON type:

String

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.

"PowerDetail[]/UnachCap"

This property is a member of HPPowerMeter

Unachievable cap for the power meter.

JSON type:

Boolean ('true' or 'false')

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.

"Samples"

This property is a member of HPPowerMeter

Number of samples in the array.

JSON type:

Integer greater than or equal to 0.

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.

"HpBaseConfigs" Resource Type

Resource Instances

/rest/v1/Systems/{item}/Bios/BaseConfigs

/rest/v1/Systems/{item}/Bios/Boot/BaseConfigs

/rest/v1/Systems/{item}/Bios/iScsi/BaseConfigs

See Resource Map for more details.

"HpBaseConfigs" defines the following properties:

"Capabilities/BaseConfig"

This property is a member of HpBaseConfigs

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

JSON type:

Boolean ('true' or 'false')

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.

"Capabilities/BaseConfigs"

This property is a member of HpBaseConfigs

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

JSON type:

Boolean ('true' or 'false')

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.

"HpBios" Resource Type

Resource Instances

/rest/v1/Systems/{item}/Bios

/rest/v1/Systems/{item}/Bios/Settings

See Resource Map for more details.

GET	Rendered if supported by the implementation or omitted if not.

"SettingsResult/definitions/SettingsResult/Messages[]/Severity"

This property is a member of HpBios

This is the severity of the errors.

JSON type:

String containing one of the following supported values:

"OK"
"Warning"
"Critical"

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.

"SettingsResult/definitions/SettingsResult/Operation"

This property is a member of HpBios

Details about the results of applying the settings.

JSON type:

String containing one of the following supported values:

"SettingsApply"

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.

"SettingsResult/definitions/SettingsResult/Time"

This property is a member of HpBios

Time at which the settings were applied.

JSON type:

String

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.

"HpBios Attributes" Resource Type

Resource Instances

/rest/v1/Systems/{item}/Bios

/rest/v1/Systems/{item}/Bios/Settings

See Resource Map for more details.

This registry defines a representation of HP BIOS Attribute instances

"HpBios Attributes" defines the following properties:

"AcpiRootBridgePxm" : Memory Proximity Reporting for I/O

Description

This property is a member of HpBios Attributes

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.

JSON type:

String containing one of the following supported values:

"Enabled"	Enabled
"Disabled"	Disabled

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

"AcpiSlit" : ACPI SLIT

Description

This property is a member of HpBios Attributes

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.

JSON type:

String containing one of the following supported values:

"Enabled"	Enabled
"Disabled"	Disabled

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

"AdjSecPrefetch" : Adjacent Sector Prefetch

Description

This property is a member of HpBios Attributes

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.

JSON type:

String containing one of the following supported values:

"Enabled"	Enabled
"Disabled"	Disabled

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

"AdminEmail" : Administrator E-mail Address

Description

This property is a member of HpBios Attributes

Enter the server administrator's e-mail address.

JSON type:

String from 0 to 28 characters in length.

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

"AdminName" : Administrator Name

Description

This property is a member of HpBios Attributes

Enter the server administrator's name text.

JSON type:

String from 0 to 28 characters in length.

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

"AdminOtherInfo" : Administrator Other Information

Description

This property is a member of HpBios Attributes

Enter the server administrator's information text.

JSON type:

String from 0 to 28 characters in length.

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

"AdminPassword" : Set Admin Password

Description

This property is a member of HpBios Attributes

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.

JSON type:

Password

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

"AdminPhone" : Administrator Phone Number

Description

This property is a member of HpBios Attributes

Enter the server administrator's phone number text.

JSON type:

String from 0 to 28 characters in length.

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

"AdvancedMemProtection" : Advanced Memory Protection

Description

This property is a member of HpBios Attributes

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.

JSON type:

String containing one of the following supported values:

"AdvancedEcc"	Advanced ECC Support
"OnlineSpareAdvancedEcc"	Online Spare with Advanced ECC Support
"MirroredAdvancedEcc"	Mirrored Memory with Advanced ECC Support

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

"AsrStatus" : ASR Status

Description

This property is a member of HpBios Attributes

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

JSON type:

String containing one of the following supported values:

"Enabled"	Enabled
"Disabled"	Disabled

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

"AsrTimeoutMinutes" : ASR Timeout

Description

This property is a member of HpBios Attributes

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.

JSON type:

String containing one of the following supported values:

"10"	10 Minutes
"15"	15 Minutes
"20"	20 Minutes
"30"	30 Minutes
"5"	5 Minutes

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

"AssetTagProtection" : Asset Tag Protection

Description

This property is a member of HpBios Attributes

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.

JSON type:

String containing one of the following supported values:

"Locked"	Locked
"Unlocked"	Unlocked

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

"AutoPowerOn" : Automatic Power-On

Description

This property is a member of HpBios Attributes

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.

JSON type:

String containing one of the following supported values:

"AlwaysPowerOn"	Always Power on
"AlwaysPowerOff"	Always Power Off
"RestoreLastState"	Restore Last Power State

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

"BootMode" : Boot Mode

Description

This property is a member of HpBios Attributes

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.

JSON type:

String containing one of the following supported values:

"Uefi"	UEFI Mode
"LegacyBios"	Legacy BIOS Mode

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

"BootOrderPolicy" : Boot Order Policy

Description

This property is a member of HpBios Attributes

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.

JSON type:

String containing one of the following supported values:

"RetryIndefinitely"	Retry Boot Order Indefinitely
"AttemptOnce"	Attempt Boot Order Once
"ResetAfterFailed"	Reset After Failed Boot Attempt

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

"ChannelInterleaving" : Channel Interleaving

Description

This property is a member of HpBios Attributes

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.

JSON type:

String containing one of the following supported values:

"Enabled"	Enabled
"Disabled"	Disabled

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

"CollabPowerControl" : Collaborative Power Control

Description

This property is a member of HpBios Attributes

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.

JSON type:

String containing one of the following supported values:

"Enabled"	Enabled
"Disabled"	Disabled

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

"ConsistentDevNaming" : Consistent Device Naming

Description

This property is a member of HpBios Attributes

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.

JSON type:

String containing one of the following supported values:

"LomsOnly"	CDN Support for LOMs Only
"Disabled"	Disabled

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

"CustomPostMessage" : Custom POST Message

Description

This property is a member of HpBios Attributes

Enter a message to be displayed during system startup.

JSON type:

String from 0 to 62 characters in length.

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

"DaylightSavingsTime" : Daylight Savings Time

Description

This property is a member of HpBios Attributes

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.

JSON type:

String containing one of the following supported values:

"Disabled"	Disabled
"Enabled"	Enabled

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

"DcuIpPrefetcher" : DCU IP Prefetcher

Description

This property is a member of HpBios Attributes

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.

JSON type:

String containing one of the following supported values:

"Enabled"	Enabled
"Disabled"	Disabled

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

"DcuStreamPrefetcher" : DCU Stream Prefetcher

Description

This property is a member of HpBios Attributes

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.

JSON type:

String containing one of the following supported values:

"Enabled"	Enabled
"Disabled"	Disabled

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

"Dhcpv4" : DHCPv4

Description

This property is a member of HpBios Attributes

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.

JSON type:

String containing one of the following supported values:

"Enabled"	Enabled
"Disabled"	Disabled

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

"DynamicPowerCapping" : Dynamic Power Capping Functionality

Description

This property is a member of HpBios Attributes

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.

JSON type:

String containing one of the following supported values:

"Auto"	Auto
"Enabled"	Enabled
"Disabled"	Disabled

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

"DynamicPowerResponse" : Dynamic Power Savings Mode Response

Description

This property is a member of HpBios Attributes

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.

JSON type:

String containing one of the following supported values:

"Fast"	Fast
"Slow"	Slow

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

"EmbNicEnable" : Embedded NIC

Description

This property is a member of HpBios Attributes

Select this option to enable or disable PCI devices.

JSON type:

String containing one of the following supported values:

"Enabled"	Enabled
"Disabled"	Disabled

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

"EmbSas1Boot" : Embedded SAS Controller 1

Description

This property is a member of HpBios Attributes

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.

JSON type:

String containing one of the following supported values:

"AllTargets"	Boot All Targets
"ThreeTargets"	Boot Limit to 3 Targets
"NoTargets"	Boot No Targets

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

"EmbSasEnable" : Embedded Storage

Description

This property is a member of HpBios Attributes

Select this option to enable or disable PCI devices.

JSON type:

String containing one of the following supported values:

"Enabled"	Enabled
"Disabled"	Disabled

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

"EmbSata1Enable" : Embedded SATA Controller #1

Description

This property is a member of HpBios Attributes

Select this option to enable or disable PCI devices.

JSON type:

String containing one of the following supported values:

"Enabled"	Enabled
"Disabled"	Disabled

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

"EmbSata2Enable" : Embedded SATA Controller #2

Description

This property is a member of HpBios Attributes

Select this option to enable or disable PCI devices.

JSON type:

String containing one of the following supported values:

"Enabled"	Enabled
"Disabled"	Disabled

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

"EmbVideoConnection" : Embedded Video Connection

Description

This property is a member of HpBios Attributes

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.

JSON type:

String containing one of the following supported values:

"Auto"	Auto
"AlwaysDisabled"	Always Disabled
"AlwaysEnabled"	Always Enabled

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

"EmbeddedDiagnostics" : Embedded Diagnostics

Description

This property is a member of HpBios Attributes

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.

JSON type:

String containing one of the following supported values:

"Enabled"	Enabled
"Disabled"	Disabled

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

"EmbeddedDiagsMode" : Embedded Diagnostics Mode

Description

This property is a member of HpBios Attributes

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

JSON type:

String containing one of the following supported values:

"Auto"	Auto
"TextConsole"	Text Console

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

"EmbeddedSata" : Embedded SATA Configuration

Description

This property is a member of HpBios Attributes

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.

JSON type:

String containing one of the following supported values:

"Ahci"	Enable SATA AHCI Support
"Raid"	Enable Dynamic Smart Array RAID Support

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

"EmbeddedSerialPort" : Embedded Serial Port

Description

This property is a member of HpBios Attributes

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.

JSON type:

String containing one of the following supported values:

"Com1Irq4"	COM 1; IRQ4; I/O: 3F8h-3FFh
"Com2Irq3"	COM 2; IRQ3; I/O: 2F8h-2FFh
"Disabled"	Disabled

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

"EmbeddedUefiShell" : Embedded UEFI Shell

Description

This property is a member of HpBios Attributes

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.

JSON type:

String containing one of the following supported values:

"Enabled"	Enabled
"Disabled"	Disabled

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

"EmbeddedUserPartition" : Embedded User Partition

Description

This property is a member of HpBios Attributes

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.

JSON type:

String containing one of the following supported values:

"Enabled"	Enabled
"Disabled"	Disabled

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

"EmsConsole" : EMS Console

Description

This property is a member of HpBios Attributes

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.

JSON type:

String containing one of the following supported values:

"Disabled"	Disabled
"Com1Irq4"	COM 1; IRQ4; I/O: 3F8h-3FFh
"Com2Irq3"	COM 2; IRQ3; I/O: 2F8h-2FFh

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

"EnergyPerfBias" : Energy/Performance Bias

Description

This property is a member of HpBios Attributes

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.

JSON type:

String containing one of the following supported values:

"MaxPerf"	Maximum Performance
"BalancedPerf"	Balanced Performance
"BalancedPower"	Balanced Power
"PowerSavingsMode"	Power Savings Mode

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

"EraseUserDefaults" : Erase User Defaults

Description

This property is a member of HpBios Attributes

Select this option to erase the user defaults backup.

JSON type:

String containing one of the following supported values:

"No"	No, Cancel
"Yes"	Yes, erase the current settings.

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

"ExtendedAmbientTemp" : Extended Ambient Temperature Support

Description

This property is a member of HpBios Attributes

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

JSON type:

String containing one of the following supported values:

"Disabled"	Disabled
"ASHRAE3"	Enabled for 40c Ambient (ASHRAE 3)
"ASHRAE4"	Enabled for 45c Ambient (ASHRAE 4)

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

"ExtendedMemTest" : Extended Memory Test

Description

This property is a member of HpBios Attributes

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.

JSON type:

String containing one of the following supported values:

"Enabled"	Enabled
"Disabled"	Disabled

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

"F11BootMenu" : One-Time Boot Menu (F11 Prompt)

Description

This property is a member of HpBios Attributes

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

JSON type:

String containing one of the following supported values:

"Enabled"	Enabled
"Disabled"	Disabled

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

"FCScanPolicy" : Fibre Channel/FCoE Scan Policy

Description

This property is a member of HpBios Attributes

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.

JSON type:

String containing one of the following supported values:

"AllTargets"	Scan All Targets
"CardConfig"	Scan Configured Targets Only

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

"FanFailPolicy" : Fan Failure Policy

Description

This property is a member of HpBios Attributes

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.

JSON type:

String containing one of the following supported values:

"Shutdown"	Shutdown/Halt on Critical Fan Failures
"Allow"	Allow Operation with Critical Fan Failures

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

"FanInstallReq" : Fan Installation Requirements

Description

This property is a member of HpBios Attributes

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.

JSON type:

String containing one of the following supported values:

"EnableMessaging"	Enable Messaging
"DisableMessaging"	Disable Messaging

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

"FlexLom1Enable" : Embedded FlexibleLOM 1

Description

This property is a member of HpBios Attributes

Select this option to enable or disable PCI devices.

JSON type:

String containing one of the following supported values:

"Enabled"	Enabled
"Disabled"	Disabled

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

"HwPrefetcher" : HW Prefetcher

Description

This property is a member of HpBios Attributes

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.

JSON type:

String containing one of the following supported values:

"Enabled"	Enabled
"Disabled"	Disabled

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

"IntelDmiLinkFreq" : Intel DMI Link Frequency

Description

This property is a member of HpBios Attributes

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

JSON type:

String containing one of the following supported values:

"Auto"	Auto
"DmiGen1"	Gen 1 Speed

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

"IntelNicDmaChannels" : Intel NIC DMA Channels (IOAT)

Description

This property is a member of HpBios Attributes

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

JSON type:

String containing one of the following supported values:

"Enabled"	Enabled
"Disabled"	Disabled

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

"IntelPerfMonitoring" : Intel Performance Monitoring Support

Description

This property is a member of HpBios Attributes

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

JSON type:

String containing one of the following supported values:

"Disabled"	Disabled
"Enabled"	Enabled

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

"IntelProcVtd" : Intel(R) VT-d

Description

This property is a member of HpBios Attributes

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.

JSON type:

String containing one of the following supported values:

"Enabled"	Enabled
"Disabled"	Disabled

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

"IntelQpiFreq" : Intel QPI Link Frequency

Description

This property is a member of HpBios Attributes

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.

JSON type:

String containing one of the following supported values:

"Auto"	Auto
"MinQpiSpeed"	Min QPI Speed

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

"IntelQpiLinkEn" : Intel QPI Link Enablement

Description

This property is a member of HpBios Attributes

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.

JSON type:

String containing one of the following supported values:

"Auto"	Auto
"SingleLink"	Single Link Operation

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

"IntelQpiPowerManagement" : Intel QPI Link Power Management

Description

This property is a member of HpBios Attributes

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.

JSON type:

String containing one of the following supported values:

"Enabled"	Enabled
"Disabled"	Disabled

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

"IntelTxt" : Intel(R) TXT Support

Description

This property is a member of HpBios Attributes

Use this option to modify Intel TXT support.

JSON type:

String containing one of the following supported values:

"Enabled"	Enabled
"Disabled"	Disabled

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

"IntelligentProvisioning" : Intelligent Provisioning (F10 Prompt)

Description

This property is a member of HpBios Attributes

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.

JSON type:

String containing one of the following supported values:

"Enabled"	Enabled
"Disabled"	Disabled

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

"InternalSDCardSlot" : Internal SD Card Slot

Description

This property is a member of HpBios Attributes

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.

JSON type:

String containing one of the following supported values:

"Enabled"	Enabled
"Disabled"	Disabled

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

"IoNonPostedPrefetching" : I/O Non-posted Prefetching

Description

This property is a member of HpBios Attributes

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.

JSON type:

String containing one of the following supported values:

"Enabled"	Enabled
"Disabled"	Disabled

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

"Ipv4Address" : IPv4 Address

Description

This property is a member of HpBios Attributes

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.

JSON type:

String from 0 to 15 characters in length.

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

"Ipv4Gateway" : IPv4 Gateway

Description

This property is a member of HpBios Attributes

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.

JSON type:

String from 0 to 15 characters in length.

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

"Ipv4PrimaryDNS" : IPv4 Primary DNS

Description

This property is a member of HpBios Attributes

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.

JSON type:

String from 0 to 15 characters in length.

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

"Ipv4SecondaryDNS" : IPv4 Secondary DNS

Description

This property is a member of HpBios Attributes

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.

JSON type:

String from 0 to 15 characters in length.

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

"Ipv4SubnetMask" : IPv4 Subnet Mask

Description

This property is a member of HpBios Attributes

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.

JSON type:

String from 0 to 15 characters in length.

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

"Ipv6Duid" : IPv6 DHCP Unique Identifier

Description

This property is a member of HpBios Attributes

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.

JSON type:

String containing one of the following supported values:

"Auto"	Auto
"DuidLlt"	DUID-LLT

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

"MaxMemBusFreqMHz" : Maximum Memory Bus Frequency

Description

This property is a member of HpBios Attributes

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.

JSON type:

String containing one of the following supported values:

"Auto"	Auto
"2133"	2133 MHz
"1867"	1867 MHz
"1600"	1600 MHz
"1333"	1333 MHz

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

"MaxPcieSpeed" : Maximum PCI Express Speed

Description

This property is a member of HpBios Attributes

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.

JSON type:

String containing one of the following supported values:

"MaxSupported"	Maximum Supported
"PcieGen1"	PCIe Generation 1.0

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

"MemFastTraining" : Memory Fast Training

Description

This property is a member of HpBios Attributes

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.

JSON type:

String containing one of the following supported values:

"Enabled"	Enabled
"Disabled"	Disabled

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

"MinProcIdlePkgState" : Minimum Processor Idle Power Package C-State

Description

This property is a member of HpBios Attributes

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

JSON type:

String containing one of the following supported values:

"C6Retention"	Package C6 (retention) State
"C6NonRetention"	Package C6 (non-retention) State
"NoState"	No Package State

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

"MinProcIdlePower" : Minimum Processor Idle Power Core C-State

Description

This property is a member of HpBios Attributes

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

JSON type:

String containing one of the following supported values:

"C6"	C6 State
"C3"	C3 State
"C1E"	C1E State
"NoCStates"	No C-states

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

"MixedPowerSupplyReporting" : Mixed Power Supply Reporting

Description

This property is a member of HpBios Attributes

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.

JSON type:

String containing one of the following supported values:

"Enabled"	Enabled
"Disabled"	Disabled

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

"NetworkBootRetry" : Network Boot Retry Support

Description

This property is a member of HpBios Attributes

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.

JSON type:

String containing one of the following supported values:

"Enabled"	Enabled
"Disabled"	Disabled

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

"NicBoot1" : Embedded NIC 1 Boot

Description

This property is a member of HpBios Attributes

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.

JSON type:

String containing one of the following supported values:

"NetworkBoot"	Network Boot
"Disabled"	Disabled

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

"NicBoot10" : Embedded NIC 10 Boot

Description

This property is a member of HpBios Attributes

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.

JSON type:

String containing one of the following supported values:

"NetworkBoot"	Network Boot
"Disabled"	Disabled

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

"NicBoot11" : Embedded NIC 11 Boot

Description

This property is a member of HpBios Attributes

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.

JSON type:

String containing one of the following supported values:

"NetworkBoot"	Network Boot
"Disabled"	Disabled

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

"NicBoot12" : Embedded NIC 12 Boot

Description

This property is a member of HpBios Attributes

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.

JSON type:

String containing one of the following supported values:

"NetworkBoot"	Network Boot
"Disabled"	Disabled

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

"NicBoot2" : Embedded NIC 2 Boot

Description

This property is a member of HpBios Attributes

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.

JSON type:

String containing one of the following supported values:

"NetworkBoot"	Network Boot
"Disabled"	Disabled

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

"NicBoot3" : Embedded NIC 3 Boot

Description

This property is a member of HpBios Attributes

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.

JSON type:

String containing one of the following supported values:

"NetworkBoot"	Network Boot
"Disabled"	Disabled

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

"NicBoot4" : Embedded NIC 4 Boot

Description

This property is a member of HpBios Attributes

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.

JSON type:

String containing one of the following supported values:

"NetworkBoot"	Network Boot
"Disabled"	Disabled

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

"NicBoot5" : Embedded NIC 5 Boot

Description

This property is a member of HpBios Attributes

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.

JSON type:

String containing one of the following supported values:

"NetworkBoot"	Network Boot
"Disabled"	Disabled

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

"NicBoot6" : Embedded NIC 6 Boot

Description

This property is a member of HpBios Attributes

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.

JSON type:

String containing one of the following supported values:

"NetworkBoot"	Network Boot
"Disabled"	Disabled

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

"NicBoot7" : Embedded NIC 7 Boot

Description

This property is a member of HpBios Attributes

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.

JSON type:

String containing one of the following supported values:

"NetworkBoot"	Network Boot
"Disabled"	Disabled

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

"NicBoot8" : Embedded NIC 8 Boot

Description

This property is a member of HpBios Attributes

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.

JSON type:

String containing one of the following supported values:

"NetworkBoot"	Network Boot
"Disabled"	Disabled

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

"NicBoot9" : Embedded NIC 9 Boot

Description

This property is a member of HpBios Attributes

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.

JSON type:

String containing one of the following supported values:

"NetworkBoot"	Network Boot
"Disabled"	Disabled

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

"NmiDebugButton" : NMI Debug Button

Description

This property is a member of HpBios Attributes

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

JSON type:

String containing one of the following supported values:

"Enabled"	Enabled
"Disabled"	Disabled

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

"NodeInterleaving" : Node Interleaving

Description

This property is a member of HpBios Attributes

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

JSON type:

String containing one of the following supported values:

"Enabled"	Enabled
"Disabled"	Disabled

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

"NumaGroupSizeOpt" : NUMA Group Size Optimization

Description

This property is a member of HpBios Attributes

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.

JSON type:

String containing one of the following supported values:

"Clustered"	Clustered
"Flat"	Flat

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

"NvDimmNBackupPowerPolicy" : NVDIMM-N Backup Power Policy

Description

This property is a member of HpBios Attributes

This option controls whether the system will wait during system boot for batteries to charge if sufficient battery backup power for the installed NVDIMMs of type NVDIMM-N is not available. If this option is configured for 'Continue Boot without Backup Power', the server will boot even if sufficient battery backup power is not installed. In this case, if sufficient battery backup power is not enabled, the installed NVDIMMs of type NVDIMM-N will NOT be used by the operating system as persistent storage or as system memory.

JSON type:

String containing one of the following supported values:

"WaitForBackupPower"	Wait for Backup Power on Boot
"BootWithoutBackupPower"	Continue Boot without Backup Power

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

"NvDimmNForcedRecovery" : NVDIMM-N Forced Data Recovery

Description

This property is a member of HpBios Attributes

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

JSON type:

String containing one of the following supported values:

"Enabled"	Enabled
"Disabled"	Disabled

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

"NvDimmNIntegrityChecking" : NVDIMM-N Data Integrity Checking

Description

This property is a member of HpBios Attributes

When this option is enabled, the NVDIMM-N will be 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 will be mapped out (not usable by the operating system).If this option is disabled, an NVDIMM-N which has issues with the ability to read data or which has bad data may result in the system getting uncorrectable errors that result in machine checks or system resets. Enable this option to ensure any NVDIMM-Ns which are made visible to the operating system will operate appropriately. Enabling this option will increase system boot time. Each installed NVDIMM-N will result in an increased boot time of several seconds.

JSON type:

String containing one of the following supported values:

"Enabled"	Enabled
"Disabled"	Disabled

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

"NvDimmNMemFunctionality" : NVDIMM-N Memory Functionality

Description

This property is a member of HpBios Attributes

This option controls whether NVDIMM-N functionality (including backing up the contents of the memory to flash on power down/reset) is enabled. If this option is configured for Disabled, then the NVDIMMs of type NVDIMM-N in the system will NOT be used by the operating system as persistent storage and will NOT be used by the operating system as system memory.

JSON type:

String containing one of the following supported values:

"Enabled"	Enabled
"Disabled"	Disabled

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

"NvDimmNMemInterleaving" : NVDIMM-N Memory Interleaving

Description

This property is a member of HpBios Attributes

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

JSON type:

String containing one of the following supported values:

"Enabled"	Enabled
"Disabled"	Disabled

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

"NvDimmNSanitizePolicy" : NVDIMM-N Sanitize/Erase on Next Reboot Policy

Description

This property is a member of HpBios Attributes

This option is used to Sanitize/Erase all user data and error status data saved in the selected NVDIMMs of type NVDIMM-N. Selected NVDIMMs of type NVDIMM-N will be sanitized/erased on the next reboot of the system. This process is required BEFORE the NVDIMM-N Memory Interleaving option can be modified. An NVDIMM-N must be sanitized/erased when it is initially installed in the system or installed in a different DIMM slot on the system. In addition, an NVDIMM-N can be recovered to normal operation if it has received an Uncorrectable Memory Error, a Backup Error, a Restore Error, or an Arming Error (if the NVDIMM hardware is functional). Note that the largest group of NVDIMMs of type NVDIMM-N selected will be sanitized/erased. For instance, if 'Sanitize/Erase all NVDIMM-N on Processor 1' is Enabled and 'Sanitize/Erase Processor 1 DIMM 8' is Disabled, all NVDIMMs of type NVDIMM-N on Processor 1 will be sanitized/erased including Processor 1 DIMM 8. There are 3 policies which control the action of the system after NVDIMMs of type NVDIMM-N are sanitized/erased. The options are to power off the system after sanitizing/erasing NVDIMMs, to allow the system to boot to the operating system after sanitizing/erasing NVDIMMs, or to boot to the System Utilities after sanitizing/erasing NVDIMMs.

JSON type:

String containing one of the following supported values:

"Disabled"	Disabled
"SanitizeAndRebootSystem"	Sanitize/Erase and Boot to Operating System
"SanitizeAndShutdownSystem"	Sanitize/Erase and Power System Off
"SanitizeAndBootToFirmwareUI"	Sanitize/Erase and Boot to System Utilities

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

"OldAdminPassword" : Enter previous Admin Password

Description

This property is a member of HpBios Attributes

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

JSON type:

Password

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

"OldPowerOnPassword" : Enter previous Power On Password

Description

This property is a member of HpBios Attributes

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

JSON type:

Password

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

"PciBusPadding" : PCI Bus Padding

Description

This property is a member of HpBios Attributes

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.

JSON type:

String containing one of the following supported values:

"Enabled"	Enabled
"Disabled"	Disabled

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

"PciSlot1Enable" : PCIe Slot 1

Description

This property is a member of HpBios Attributes

Select this option to enable or disable PCI devices.

JSON type:

String containing one of the following supported values:

"Enabled"	Enabled
"Disabled"	Disabled

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

"PciSlot2Enable" : PCIe Slot 2

Description

This property is a member of HpBios Attributes

Select this option to enable or disable PCI devices.

JSON type:

String containing one of the following supported values:

"Enabled"	Enabled
"Disabled"	Disabled

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

"PciSlot3Enable" : PCIe Slot 3

Description

This property is a member of HpBios Attributes

Select this option to enable or disable PCI devices.

JSON type:

String containing one of the following supported values:

"Enabled"	Enabled
"Disabled"	Disabled

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

"PciSlot4Enable" : PCIe Slot 4

Description

This property is a member of HpBios Attributes

Select this option to enable or disable PCI devices.

JSON type:

String containing one of the following supported values:

"Enabled"	Enabled
"Disabled"	Disabled

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

"PciSlot5Enable" : PCIe Slot 5

Description

This property is a member of HpBios Attributes

Select this option to enable or disable PCI devices.

JSON type:

String containing one of the following supported values:

"Enabled"	Enabled
"Disabled"	Disabled

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

"PciSlot6Enable" : PCIe Slot 6

Description

This property is a member of HpBios Attributes

Select this option to enable or disable PCI devices.

JSON type:

String containing one of the following supported values:

"Enabled"	Enabled
"Disabled"	Disabled

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

"PcieExpressEcrcSupport" : PCI Express ECRC Support

Description

This property is a member of HpBios Attributes

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.

JSON type:

String containing one of the following supported values:

"Enabled"	Enabled
"Disabled"	Disabled

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

"PostF1Prompt" : POST F1 Prompt

Description

This property is a member of HpBios Attributes

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.

JSON type:

String containing one of the following supported values:

"Delayed20Sec"	Delayed 20 seconds
"Delayed2Sec"	Delayed 2 seconds
"Disabled"	Disabled

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

"PowerButton" : Power Button Mode

Description

This property is a member of HpBios Attributes

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.

JSON type:

String containing one of the following supported values:

"Enabled"	Enabled
"Disabled"	Disabled

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

"PowerOnDelay" : Power-On Delay

Description

This property is a member of HpBios Attributes

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.

JSON type:

String containing one of the following supported values:

"None"	No Delay
"Random"	Random Delay
"15Sec"	15 Second Delay
"30Sec"	30 Second Delay
"45Sec"	45 Second Delay
"60Sec"	60 Second Delay

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

"PowerOnLogo" : Power-On Logo

Description

This property is a member of HpBios Attributes

Use this option to disable the display of the logo during system boot. This option does not affect system boot times.

JSON type:

String containing one of the following supported values:

"Enabled"	Enabled
"Disabled"	Disabled

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

"PowerOnPassword" : Set Power On Password

Description

This property is a member of HpBios Attributes

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.

JSON type:

Password

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

"PowerProfile" : Power Profile

Description

This property is a member of HpBios Attributes

- Balanced Power and Performance: Provides the optimum settings to maximize power savings with minimal impact to performance for most operating systems and applications. - Minimum Power Usage: Enables power reduction mechanisms that can negatively affect performance. This mode guarantees a lower maximum power usage by the system. - Maximum Performance: Disables all power management options that can negatively affect performance.

JSON type:

String containing one of the following supported values:

"BalancedPowerPerf"	Balanced Power and Performance
"MinPower"	Minimum Power Usage
"MaxPerf"	Maximum Performance
"Custom"	Custom

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

"PowerRegulator" : Power Regulator

Description

This property is a member of HpBios Attributes

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.

JSON type:

String containing one of the following supported values:

"DynamicPowerSavings"	Dynamic Power Savings Mode
"StaticLowPower"	Static Low Power Mode
"StaticHighPerf"	Static High Performance Mode
"OsControl"	OS Control Mode

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

"PreBootNetwork" : Pre-Boot Network Interface

Description

This property is a member of HpBios Attributes

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.

JSON type:

String containing one of the following supported values:

"Auto"	Auto
"EmbNic"	Embedded NIC
"FlexLom1"	Embedded FlexibleLOM 1
"PciSlot1"	PCIe Slot 1
"PciSlot2"	PCIe Slot 2
"PciSlot3"	PCIe Slot 3
"PciSlot4"	PCIe Slot 4
"PciSlot5"	PCIe Slot 5
"PciSlot6"	PCIe Slot 6

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

"ProcAes" : Processor AES-NI Support

Description

This property is a member of HpBios Attributes

Use this option to enable or disable the Advanced Encryption Standard Instruction Set (AES-NI) in the processor.

JSON type:

String containing one of the following supported values:

"Enabled"	Enabled
"Disabled"	Disabled

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

"ProcCoreDisable" : Processor Core Disable

Description

This property is a member of HpBios Attributes

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.

JSON type:

Integer from 0 to 24.

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

"ProcHyperthreading" : Intel(R) Hyperthreading

Description

This property is a member of HpBios Attributes

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.

JSON type:

String containing one of the following supported values:

"Enabled"	Enabled
"Disabled"	Disabled

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

"ProcNoExecute" : No-Execute Protection

Description

This property is a member of HpBios Attributes

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.

JSON type:

String containing one of the following supported values:

"Enabled"	Enabled
"Disabled"	Disabled

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

"ProcTurbo" : Intel(R) Turbo Boost Technology

Description

This property is a member of HpBios Attributes

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.

JSON type:

String containing one of the following supported values:

"Disabled"	Disabled
"Enabled"	Enabled

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

"ProcVirtualization" : Virtualization Technology

Description

This property is a member of HpBios Attributes

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.

JSON type:

String containing one of the following supported values:

"Enabled"	Enabled
"Disabled"	Disabled

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

"ProcX2Apic" : Processor x2APIC Support

Description

This property is a member of HpBios Attributes

x2APIC support enables operating systems to run more efficiently on high core count configurations. It also optimized interrupt distribution in virtualized environments. In most cases, set this option to enabled. This configures the operating system to optionally enable x2APIC support when it loads. Some older hypervisors and operating systems might have issues with optional x2APIC support, in which case disabling x2APIC might be necessary to address those issues. Additionally, some hypervisors and operating systems will not use x2APIC unless this option is set to Force Enabled prior to booting. The Force Enabled option also causes the Intel(R) VT-d setting to be set to enabled.

JSON type:

String containing one of the following supported values:

"Enabled"	Enabled
"ForceEnabled"	Force Enabled
"Disabled"	Disabled

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

"ProductId" : Product ID

Description

This property is a member of HpBios Attributes

Use this option to set the system product ID. This value must always match the product ID sticker located on the chassis.

JSON type:

String from 0 to 16 characters in length.

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

"QpiBandwidthOpt" : QPI Bandwidth Optimization (RTID)

Description

This property is a member of HpBios Attributes

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.

JSON type:

String containing one of the following supported values:

"Balanced"	Balanced
"OptimizedForIo"	Optimized for I/O (Alternate RTID)

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

"QpiHomeSnoopOpt" : QPI Home Snoop Optimization

Description

This property is a member of HpBios Attributes

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.

JSON type:

String containing one of the following supported values:

"DirectoryOsbEnabled"	Directory + OSB Enabled
"DirectoryOsbDisabled"	Directory + OSB Disabled

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

"QpiSnoopConfig" : QPI Snoop Configuration

Description

This property is a member of HpBios Attributes

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.

JSON type:

String containing one of the following supported values:

"Standard"	Home Snoop
"EarlySnoop"	Early Snoop
"ClusterOnDie"	Cluster on Die

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

"RedundantPowerSupply" : Redundant Power Supply Mode

Description

This property is a member of HpBios Attributes

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.

JSON type:

String containing one of the following supported values:

"BalancedMode"	Balanced Mode
"HighEfficiencyAuto"	High Efficiency Mode (Auto)
"HighEfficiencyOddStandby"	High Efficiency Mode (Odd Supply Standby)
"HighEfficiencyEvenStandby"	High Efficiency Mode (Even Supply Standby)

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

"RemovableFlashBootSeq" : Removable Flash Media Boot Sequence

Description

This property is a member of HpBios Attributes

Use this option to select which USB or SD Card devices you want to search for first when enumerating boot devices. You can select whether the system boots to external USB drive keys, internal USB drive keys, or the internal SD card slot. This option does not override the device boot order in the Standard Boot Order (IPL) option. You can only configure this option when Boot Mode is set to Legacy BIOS.

JSON type:

String containing one of the following supported values:

"InternalSdCardFirst"	Internal SD Card First
"InternalKeysFirst"	Internal DriveKeys First
"ExternalKeysFirst"	External DriveKeys First

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

"RestoreDefaults" : Restore Default System Settings

Description

This property is a member of HpBios Attributes

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.

JSON type:

String containing one of the following supported values:

"No"	No, cancel the restore procedure.
"Yes"	Yes, restore the default settings.

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

"RestoreManufacturingDefaults" : Restore Default Manufacturing Settings

Description

This property is a member of HpBios Attributes

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.

JSON type:

String containing one of the following supported values:

"No"	No, cancel restore procedure.
"Yes"	Yes, restore the default settings.

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

"RomSelection" : ROM Selection

Description

This property is a member of HpBios Attributes

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.

JSON type:

String containing one of the following supported values:

"CurrentRom"	Use Current ROM
"BackupRom"	Switch to Backup ROM

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

"SanitizeAllNvDimmN" : Sanitize/Erase all NVDIMM-N in the System

Description

This property is a member of HpBios Attributes

When Enabled, all user data in ALL NVDIMMs of type NVDIMM-N in the system will be erased on the next reboot.

JSON type:

String containing one of the following supported values:

"Enabled"	Enabled
"Disabled"	Disabled

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

"SanitizeProc1Dimm1" : Sanitize/Erase Processor 1 DIMM 1

Description

This property is a member of HpBios Attributes

When Enabled, all user data in the selected NVDIMM-N will be erased on the next reboot.

JSON type:

String containing one of the following supported values:

"Enabled"	Enabled
"Disabled"	Disabled

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

"SanitizeProc1Dimm10" : Sanitize/Erase Processor 1 DIMM 10

Description

This property is a member of HpBios Attributes

When Enabled, all user data in the selected NVDIMM-N will be erased on the next reboot.

JSON type:

String containing one of the following supported values:

"Enabled"	Enabled
"Disabled"	Disabled

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

"SanitizeProc1Dimm11" : Sanitize/Erase Processor 1 DIMM 11

Description

This property is a member of HpBios Attributes

When Enabled, all user data in the selected NVDIMM-N will be erased on the next reboot.

JSON type:

String containing one of the following supported values:

"Enabled"	Enabled
"Disabled"	Disabled

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

"SanitizeProc1Dimm12" : Sanitize/Erase Processor 1 DIMM 12

Description

This property is a member of HpBios Attributes

When Enabled, all user data in the selected NVDIMM-N will be erased on the next reboot.

JSON type:

String containing one of the following supported values:

"Enabled"	Enabled
"Disabled"	Disabled

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

"SanitizeProc1Dimm2" : Sanitize/Erase Processor 1 DIMM 2

Description

This property is a member of HpBios Attributes

When Enabled, all user data in the selected NVDIMM-N will be erased on the next reboot.

JSON type:

String containing one of the following supported values:

"Enabled"	Enabled
"Disabled"	Disabled

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

"SanitizeProc1Dimm3" : Sanitize/Erase Processor 1 DIMM 3

Description

This property is a member of HpBios Attributes

When Enabled, all user data in the selected NVDIMM-N will be erased on the next reboot.

JSON type:

String containing one of the following supported values:

"Enabled"	Enabled
"Disabled"	Disabled

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

"SanitizeProc1Dimm4" : Sanitize/Erase Processor 1 DIMM 4

Description

This property is a member of HpBios Attributes

When Enabled, all user data in the selected NVDIMM-N will be erased on the next reboot.

JSON type:

String containing one of the following supported values:

"Enabled"	Enabled
"Disabled"	Disabled

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

"SanitizeProc1Dimm5" : Sanitize/Erase Processor 1 DIMM 5

Description

This property is a member of HpBios Attributes

When Enabled, all user data in the selected NVDIMM-N will be erased on the next reboot.

JSON type:

String containing one of the following supported values:

"Enabled"	Enabled
"Disabled"	Disabled

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

"SanitizeProc1Dimm6" : Sanitize/Erase Processor 1 DIMM 6

Description

This property is a member of HpBios Attributes

When Enabled, all user data in the selected NVDIMM-N will be erased on the next reboot.

JSON type:

String containing one of the following supported values:

"Enabled"	Enabled
"Disabled"	Disabled

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

"SanitizeProc1Dimm7" : Sanitize/Erase Processor 1 DIMM 7

Description

This property is a member of HpBios Attributes

When Enabled, all user data in the selected NVDIMM-N will be erased on the next reboot.

JSON type:

String containing one of the following supported values:

"Enabled"	Enabled
"Disabled"	Disabled

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

"SanitizeProc1Dimm8" : Sanitize/Erase Processor 1 DIMM 8

Description

This property is a member of HpBios Attributes

When Enabled, all user data in the selected NVDIMM-N will be erased on the next reboot.

JSON type:

String containing one of the following supported values:

"Enabled"	Enabled
"Disabled"	Disabled

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

"SanitizeProc1Dimm9" : Sanitize/Erase Processor 1 DIMM 9

Description

This property is a member of HpBios Attributes

When Enabled, all user data in the selected NVDIMM-N will be erased on the next reboot.

JSON type:

String containing one of the following supported values:

"Enabled"	Enabled
"Disabled"	Disabled

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

"SanitizeProc1NvDimmN" : Sanitize/Erase all NVDIMM-N on Processor 1

Description

This property is a member of HpBios Attributes

When Enabled, all user data in ALL NVDIMMs of type NVDIMM-N installed on the selected processor will be erased on the next reboot.

JSON type:

String containing one of the following supported values:

"Enabled"	Enabled
"Disabled"	Disabled

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

"SanitizeProc2Dimm1" : Sanitize/Erase Processor 2 DIMM 1

Description

This property is a member of HpBios Attributes

When Enabled, all user data in the selected NVDIMM-N will be erased on the next reboot.

JSON type:

String containing one of the following supported values:

"Enabled"	Enabled
"Disabled"	Disabled

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

"SanitizeProc2Dimm10" : Sanitize/Erase Processor 2 DIMM 10

Description

This property is a member of HpBios Attributes

When Enabled, all user data in the selected NVDIMM-N will be erased on the next reboot.

JSON type:

String containing one of the following supported values:

"Enabled"	Enabled
"Disabled"	Disabled

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

"SanitizeProc2Dimm11" : Sanitize/Erase Processor 2 DIMM 11

Description

This property is a member of HpBios Attributes

When Enabled, all user data in the selected NVDIMM-N will be erased on the next reboot.

JSON type:

String containing one of the following supported values:

"Enabled"	Enabled
"Disabled"	Disabled

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

"SanitizeProc2Dimm12" : Sanitize/Erase Processor 2 DIMM 12

Description

This property is a member of HpBios Attributes

When Enabled, all user data in the selected NVDIMM-N will be erased on the next reboot.

JSON type:

String containing one of the following supported values:

"Enabled"	Enabled
"Disabled"	Disabled

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

"SanitizeProc2Dimm2" : Sanitize/Erase Processor 2 DIMM 2

Description

This property is a member of HpBios Attributes

When Enabled, all user data in the selected NVDIMM-N will be erased on the next reboot.

JSON type:

String containing one of the following supported values:

"Enabled"	Enabled
"Disabled"	Disabled

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

"SanitizeProc2Dimm3" : Sanitize/Erase Processor 2 DIMM 3

Description

This property is a member of HpBios Attributes

When Enabled, all user data in the selected NVDIMM-N will be erased on the next reboot.

JSON type:

String containing one of the following supported values:

"Enabled"	Enabled
"Disabled"	Disabled

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

"SanitizeProc2Dimm4" : Sanitize/Erase Processor 2 DIMM 4

Description

This property is a member of HpBios Attributes

When Enabled, all user data in the selected NVDIMM-N will be erased on the next reboot.

JSON type:

String containing one of the following supported values:

"Enabled"	Enabled
"Disabled"	Disabled

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

"SanitizeProc2Dimm5" : Sanitize/Erase Processor 2 DIMM 5

Description

This property is a member of HpBios Attributes

When Enabled, all user data in the selected NVDIMM-N will be erased on the next reboot.

JSON type:

String containing one of the following supported values:

"Enabled"	Enabled
"Disabled"	Disabled

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

"SanitizeProc2Dimm6" : Sanitize/Erase Processor 2 DIMM 6

Description

This property is a member of HpBios Attributes

When Enabled, all user data in the selected NVDIMM-N will be erased on the next reboot.

JSON type:

String containing one of the following supported values:

"Enabled"	Enabled
"Disabled"	Disabled

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

"SanitizeProc2Dimm7" : Sanitize/Erase Processor 2 DIMM 7

Description

This property is a member of HpBios Attributes

When Enabled, all user data in the selected NVDIMM-N will be erased on the next reboot.

JSON type:

String containing one of the following supported values:

"Enabled"	Enabled
"Disabled"	Disabled

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

"SanitizeProc2Dimm8" : Sanitize/Erase Processor 2 DIMM 8

Description

This property is a member of HpBios Attributes

When Enabled, all user data in the selected NVDIMM-N will be erased on the next reboot.

JSON type:

String containing one of the following supported values:

"Enabled"	Enabled
"Disabled"	Disabled

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

"SanitizeProc2Dimm9" : Sanitize/Erase Processor 2 DIMM 9

Description

This property is a member of HpBios Attributes

When Enabled, all user data in the selected NVDIMM-N will be erased on the next reboot.

JSON type:

String containing one of the following supported values:

"Enabled"	Enabled
"Disabled"	Disabled

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

"SanitizeProc2NvDimmN" : Sanitize/Erase all NVDIMM-N on Processor 2

Description

This property is a member of HpBios Attributes

When Enabled, all user data in ALL NVDIMMs of type NVDIMM-N installed on the selected processor will be erased on the next reboot.

JSON type:

String containing one of the following supported values:

"Enabled"	Enabled
"Disabled"	Disabled

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

"SataSecureErase" : SATA Secure Erase

Description

This property is a member of HpBios Attributes

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.

JSON type:

String containing one of the following supported values:

"Enabled"	Enabled
"Disabled"	Disabled

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

"SaveUserDefaults" : Save User Defaults

Description

This property is a member of HpBios Attributes

Select this option to save the current settings as the system defaults.

JSON type:

String containing one of the following supported values:

"No"	No, Cancel
"Yes"	Yes, Save

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

"SecureBootStatus" : Secure Boot Status

Description

This property is a member of HpBios Attributes

The current state of Secure Boot configuration.

JSON type:

String containing one of the following supported values:

"Enabled"	Enabled
"Disabled"	Disabled

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.

"SerialConsoleBaudRate" : BIOS Serial Console Baud Rate

Description

This property is a member of HpBios Attributes

This is the transfer rate at which data is transmitted through the serial port.

JSON type:

String containing one of the following supported values:

"9600"	9600
"19200"	19200
"38400"	38400
"57600"	57600
"115200"	115200

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

"SerialConsoleEmulation" : BIOS Serial Console Emulation Mode

Description

This property is a member of HpBios Attributes

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.

JSON type:

String containing one of the following supported values:

"Vt100"	VT100
"Ansi"	ANSI
"Vt100Plus"	VT100+

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

"SerialConsolePort" : BIOS Serial Console Port

Description

This property is a member of HpBios Attributes

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.

JSON type:

String containing one of the following supported values:

"Auto"	Auto
"Disabled"	Disabled
"Physical"	Physical Serial Port
"Virtual"	Virtual Serial Port

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

"SerialNumber" : Serial Number

Description

This property is a member of HpBios Attributes

Use this option to set the system serial number. This value must always match the serial number sticker located on the chassis.

JSON type:

String from 0 to 16 characters in length.

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

"ServerAssetTag" : Server Asset Tag

Description

This property is a member of HpBios Attributes

Select this option to modify the Server Asset Tag text line.

JSON type:

String from 0 to 32 characters in length.

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

"ServerName" : Server Name

Description

This property is a member of HpBios Attributes

Select this option to modify the server name text line.

JSON type:

String from 0 to 28 characters in length.

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

"ServerOtherInfo" : Server Other Information

Description

This property is a member of HpBios Attributes

Use this option to modify the Other Server text line.

JSON type:

String from 0 to 28 characters in length.

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

"ServerPrimaryOs" : Server Primary OS

Description

This property is a member of HpBios Attributes

Use this option to modify the Server Primary OS text line.

JSON type:

String from 0 to 42 characters in length.

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

"ServiceEmail" : Service Contact E-mail Address

Description

This property is a member of HpBios Attributes

Enter the server service contact e-mail address.

JSON type:

String from 0 to 28 characters in length.

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

"ServiceName" : Service Contact Name

Description

This property is a member of HpBios Attributes

Enter the server service contact name text.

JSON type:

String from 0 to 28 characters in length.

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

"ServiceOtherInfo" : Service Contact Other Information

Description

This property is a member of HpBios Attributes

Enter the other server service contact information text.

JSON type:

String from 0 to 28 characters in length.

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

"ServicePhone" : Service Contact Phone Number

Description

This property is a member of HpBios Attributes

Enter the server service contact phone number text.

JSON type:

String from 0 to 28 characters in length.

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

"Slot1NicBoot1" : Slot 1 NIC Port 1 Boot

Description

This property is a member of HpBios Attributes

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.

JSON type:

String containing one of the following supported values:

"NetworkBoot"	Network Boot
"Disabled"	Disabled

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

"Slot1NicBoot2" : Slot 1 NIC Port 2 Boot

Description

This property is a member of HpBios Attributes

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.

JSON type:

String containing one of the following supported values:

"NetworkBoot"	Network Boot
"Disabled"	Disabled

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

"Slot1NicBoot3" : Slot 1 NIC Port 3 Boot

Description

This property is a member of HpBios Attributes

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.

JSON type:

String containing one of the following supported values:

"NetworkBoot"	Network Boot
"Disabled"	Disabled

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

"Slot1NicBoot4" : Slot 1 NIC Port 4 Boot

Description

This property is a member of HpBios Attributes

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.

JSON type:

String containing one of the following supported values:

"NetworkBoot"	Network Boot
"Disabled"	Disabled

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

"Slot1NicBoot5" : Slot 1 NIC Port 5 Boot

Description

This property is a member of HpBios Attributes

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.

JSON type:

String containing one of the following supported values:

"NetworkBoot"	Network Boot
"Disabled"	Disabled

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

"Slot1NicBoot6" : Slot 1 NIC Port 6 Boot

Description

This property is a member of HpBios Attributes

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.

JSON type:

String containing one of the following supported values:

"NetworkBoot"	Network Boot
"Disabled"	Disabled

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

"Slot1NicBoot7" : Slot 1 NIC Port 7 Boot

Description

This property is a member of HpBios Attributes

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.

JSON type:

String containing one of the following supported values:

"NetworkBoot"	Network Boot
"Disabled"	Disabled

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

"Slot1NicBoot8" : Slot 1 NIC Port 8 Boot

Description

This property is a member of HpBios Attributes

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.

JSON type:

String containing one of the following supported values:

"NetworkBoot"	Network Boot
"Disabled"	Disabled

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

"Slot1StorageBoot" : PCIe Slot 1

Description

This property is a member of HpBios Attributes

JSON type:

String containing one of the following supported values:

"AllTargets"	Boot All Targets
"ThreeTargets"	Boot Limit to 3 Targets
"NoTargets"	Boot No Targets

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

"Slot2NicBoot1" : Slot 2 NIC Port 1 Boot

Description

This property is a member of HpBios Attributes

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.

JSON type:

String containing one of the following supported values:

"NetworkBoot"	Network Boot
"Disabled"	Disabled

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

"Slot2NicBoot2" : Slot 2 NIC Port 2 Boot

Description

This property is a member of HpBios Attributes

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.

JSON type:

String containing one of the following supported values:

"NetworkBoot"	Network Boot
"Disabled"	Disabled

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

"Slot2NicBoot3" : Slot 2 NIC Port 3 Boot

Description

This property is a member of HpBios Attributes

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.

JSON type:

String containing one of the following supported values:

"NetworkBoot"	Network Boot
"Disabled"	Disabled

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

"Slot2NicBoot4" : Slot 2 NIC Port 4 Boot

Description

This property is a member of HpBios Attributes

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.

JSON type:

String containing one of the following supported values:

"NetworkBoot"	Network Boot
"Disabled"	Disabled

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

"Slot2NicBoot5" : Slot 2 NIC Port 5 Boot

Description

This property is a member of HpBios Attributes

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.

JSON type:

String containing one of the following supported values:

"NetworkBoot"	Network Boot
"Disabled"	Disabled

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

"Slot2NicBoot6" : Slot 2 NIC Port 6 Boot

Description

This property is a member of HpBios Attributes

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.

JSON type:

String containing one of the following supported values:

"NetworkBoot"	Network Boot
"Disabled"	Disabled

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

"Slot2NicBoot7" : Slot 2 NIC Port 7 Boot

Description

This property is a member of HpBios Attributes

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.

JSON type:

String containing one of the following supported values:

"NetworkBoot"	Network Boot
"Disabled"	Disabled

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

"Slot2NicBoot8" : Slot 2 NIC Port 8 Boot

Description

This property is a member of HpBios Attributes

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.

JSON type:

String containing one of the following supported values:

"NetworkBoot"	Network Boot
"Disabled"	Disabled

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

"Slot2StorageBoot" : PCIe Slot 2

Description

This property is a member of HpBios Attributes

JSON type:

String containing one of the following supported values:

"AllTargets"	Boot All Targets
"ThreeTargets"	Boot Limit to 3 Targets
"NoTargets"	Boot No Targets

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

"Slot3NicBoot1" : Slot 3 NIC Port 1 Boot

Description

This property is a member of HpBios Attributes

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.

JSON type:

String containing one of the following supported values:

"NetworkBoot"	Network Boot
"Disabled"	Disabled

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

"Slot3NicBoot2" : Slot 3 NIC Port 2 Boot

Description

This property is a member of HpBios Attributes

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.

JSON type:

String containing one of the following supported values:

"NetworkBoot"	Network Boot
"Disabled"	Disabled

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

"Slot3NicBoot3" : Slot 3 NIC Port 3 Boot

Description

This property is a member of HpBios Attributes

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.

JSON type:

String containing one of the following supported values:

"NetworkBoot"	Network Boot
"Disabled"	Disabled

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

"Slot3NicBoot4" : Slot 3 NIC Port 4 Boot

Description

This property is a member of HpBios Attributes

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.

JSON type:

String containing one of the following supported values:

"NetworkBoot"	Network Boot
"Disabled"	Disabled

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

"Slot3NicBoot5" : Slot 3 NIC Port 5 Boot

Description

This property is a member of HpBios Attributes

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.

JSON type:

String containing one of the following supported values:

"NetworkBoot"	Network Boot
"Disabled"	Disabled

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

"Slot3NicBoot6" : Slot 3 NIC Port 6 Boot

Description

This property is a member of HpBios Attributes

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.

JSON type:

String containing one of the following supported values:

"NetworkBoot"	Network Boot
"Disabled"	Disabled

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

"Slot3NicBoot7" : Slot 3 NIC Port 7 Boot

Description

This property is a member of HpBios Attributes

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.

JSON type:

String containing one of the following supported values:

"NetworkBoot"	Network Boot
"Disabled"	Disabled

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

"Slot3NicBoot8" : Slot 3 NIC Port 8 Boot

Description

This property is a member of HpBios Attributes

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.

JSON type:

String containing one of the following supported values:

"NetworkBoot"	Network Boot
"Disabled"	Disabled

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

"Slot3StorageBoot" : PCIe Slot 3

Description

This property is a member of HpBios Attributes

JSON type:

String containing one of the following supported values:

"AllTargets"	Boot All Targets
"ThreeTargets"	Boot Limit to 3 Targets
"NoTargets"	Boot No Targets

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

"Slot4NicBoot1" : Slot 4 NIC Port 1 Boot

Description

This property is a member of HpBios Attributes

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.

JSON type:

String containing one of the following supported values:

"NetworkBoot"	Network Boot
"Disabled"	Disabled

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

"Slot4NicBoot2" : Slot 4 NIC Port 2 Boot

Description

This property is a member of HpBios Attributes

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.

JSON type:

String containing one of the following supported values:

"NetworkBoot"	Network Boot
"Disabled"	Disabled

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

"Slot4NicBoot3" : Slot 4 NIC Port 3 Boot

Description

This property is a member of HpBios Attributes

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.

JSON type:

String containing one of the following supported values:

"NetworkBoot"	Network Boot
"Disabled"	Disabled

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

"Slot4NicBoot4" : Slot 4 NIC Port 4 Boot

Description

This property is a member of HpBios Attributes

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.

JSON type:

String containing one of the following supported values:

"NetworkBoot"	Network Boot
"Disabled"	Disabled

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

"Slot4NicBoot5" : Slot 4 NIC Port 5 Boot

Description

This property is a member of HpBios Attributes

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.

JSON type:

String containing one of the following supported values:

"NetworkBoot"	Network Boot
"Disabled"	Disabled

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

"Slot4NicBoot6" : Slot 4 NIC Port 6 Boot

Description

This property is a member of HpBios Attributes

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.

JSON type:

String containing one of the following supported values:

"NetworkBoot"	Network Boot
"Disabled"	Disabled

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

"Slot4NicBoot7" : Slot 4 NIC Port 7 Boot

Description

This property is a member of HpBios Attributes

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.

JSON type:

String containing one of the following supported values:

"NetworkBoot"	Network Boot
"Disabled"	Disabled

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

"Slot4NicBoot8" : Slot 4 NIC Port 8 Boot

Description

This property is a member of HpBios Attributes

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.

JSON type:

String containing one of the following supported values:

"NetworkBoot"	Network Boot
"Disabled"	Disabled

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

"Slot4StorageBoot" : PCIe Slot 4

Description

This property is a member of HpBios Attributes

JSON type:

String containing one of the following supported values:

"AllTargets"	Boot All Targets
"ThreeTargets"	Boot Limit to 3 Targets
"NoTargets"	Boot No Targets

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

"Slot5NicBoot1" : Slot 5 NIC Port 1 Boot

Description

This property is a member of HpBios Attributes

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.

JSON type:

String containing one of the following supported values:

"NetworkBoot"	Network Boot
"Disabled"	Disabled

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

"Slot5NicBoot2" : Slot 5 NIC Port 2 Boot

Description

This property is a member of HpBios Attributes

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.

JSON type:

String containing one of the following supported values:

"NetworkBoot"	Network Boot
"Disabled"	Disabled

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

"Slot5NicBoot3" : Slot 5 NIC Port 3 Boot

Description

This property is a member of HpBios Attributes

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.

JSON type:

String containing one of the following supported values:

"NetworkBoot"	Network Boot
"Disabled"	Disabled

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

"Slot5NicBoot4" : Slot 5 NIC Port 4 Boot

Description

This property is a member of HpBios Attributes

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.

JSON type:

String containing one of the following supported values:

"NetworkBoot"	Network Boot
"Disabled"	Disabled

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

"Slot5NicBoot5" : Slot 5 NIC Port 5 Boot

Description

This property is a member of HpBios Attributes

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.

JSON type:

String containing one of the following supported values:

"NetworkBoot"	Network Boot
"Disabled"	Disabled

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

"Slot5NicBoot6" : Slot 5 NIC Port 6 Boot

Description

This property is a member of HpBios Attributes

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.

JSON type:

String containing one of the following supported values:

"NetworkBoot"	Network Boot
"Disabled"	Disabled

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

"Slot5NicBoot7" : Slot 5 NIC Port 7 Boot

Description

This property is a member of HpBios Attributes

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.

JSON type:

String containing one of the following supported values:

"NetworkBoot"	Network Boot
"Disabled"	Disabled

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

"Slot5NicBoot8" : Slot 5 NIC Port 8 Boot

Description

This property is a member of HpBios Attributes

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.

JSON type:

String containing one of the following supported values:

"NetworkBoot"	Network Boot
"Disabled"	Disabled

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

"Slot5StorageBoot" : PCIe Slot 5

Description

This property is a member of HpBios Attributes

JSON type:

String containing one of the following supported values:

"AllTargets"	Boot All Targets
"ThreeTargets"	Boot Limit to 3 Targets
"NoTargets"	Boot No Targets

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

"Slot6NicBoot1" : Slot 6 NIC Port 1 Boot

Description

This property is a member of HpBios Attributes

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.

JSON type:

String containing one of the following supported values:

"NetworkBoot"	Network Boot
"Disabled"	Disabled

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

"Slot6NicBoot2" : Slot 6 NIC Port 2 Boot

Description

This property is a member of HpBios Attributes

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.

JSON type:

String containing one of the following supported values:

"NetworkBoot"	Network Boot
"Disabled"	Disabled

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

"Slot6NicBoot3" : Slot 6 NIC Port 3 Boot

Description

This property is a member of HpBios Attributes

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.

JSON type:

String containing one of the following supported values:

"NetworkBoot"	Network Boot
"Disabled"	Disabled

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

"Slot6NicBoot4" : Slot 6 NIC Port 4 Boot

Description

This property is a member of HpBios Attributes

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.

JSON type:

String containing one of the following supported values:

"NetworkBoot"	Network Boot
"Disabled"	Disabled

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

"Slot6NicBoot5" : Slot 6 NIC Port 5 Boot

Description

This property is a member of HpBios Attributes

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.

JSON type:

String containing one of the following supported values:

"NetworkBoot"	Network Boot
"Disabled"	Disabled

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

"Slot6NicBoot6" : Slot 6 NIC Port 6 Boot

Description

This property is a member of HpBios Attributes

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.

JSON type:

String containing one of the following supported values:

"NetworkBoot"	Network Boot
"Disabled"	Disabled

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

"Slot6NicBoot7" : Slot 6 NIC Port 7 Boot

Description

This property is a member of HpBios Attributes

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.

JSON type:

String containing one of the following supported values:

"NetworkBoot"	Network Boot
"Disabled"	Disabled

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

"Slot6NicBoot8" : Slot 6 NIC Port 8 Boot

Description

This property is a member of HpBios Attributes

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.

JSON type:

String containing one of the following supported values:

"NetworkBoot"	Network Boot
"Disabled"	Disabled

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

"Slot6StorageBoot" : PCIe Slot 6

Description

This property is a member of HpBios Attributes

JSON type:

String containing one of the following supported values:

"AllTargets"	Boot All Targets
"ThreeTargets"	Boot Limit to 3 Targets
"NoTargets"	Boot No Targets

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

"Sriov" : SR-IOV

Description

This property is a member of HpBios Attributes

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.

JSON type:

String containing one of the following supported values:

"Enabled"	Enabled
"Disabled"	Disabled

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

"ThermalConfig" : Thermal Configuration

Description

This property is a member of HpBios Attributes

Use this option to select the fan cooling solution for the system. Optimal Cooling provides the most efficient solution by configuring fan speeds to the minimum required speed to provide adequate cooling. Increased Cooling runs fans at higher speeds to provide additional cooling. Select Increased Cooling when third-party storage controllers are cabled to the embedded hard drive cage, or if the system is experiencing thermal issues that cannot be resolved. Maximum cooling provides the maximum cooling available on this platform.

JSON type:

String containing one of the following supported values:

"OptimalCooling"	Optimal Cooling
"IncreasedCooling"	Increased Cooling
"MaxCooling"	Maximum Cooling

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

"ThermalShutdown" : Thermal Shutdown

Description

This property is a member of HpBios Attributes

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.

JSON type:

String containing one of the following supported values:

"Enabled"	Enabled
"Disabled"	Disabled

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

"TimeFormat" : Time Format

Description

This property is a member of HpBios Attributes

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.

JSON type:

String containing one of the following supported values:

"Utc"	Coordinated Universal Time (UTC)
"Local"	Local Time

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

"TimeZone" : Time Zone

Description

This property is a member of HpBios Attributes

This option displays the current time zone setting for the system.

JSON type:

String containing one of the following supported values:

"UtcM12"	UTC-12:00, International Date Line West
"UtcM11"	UTC-11:00, Midway Island, Samoa
"UtcM10"	UTC-10:00, Hawaii
"UtcM9"	UTC-09:00, Alaska
"UtcM8"	UTC-08:00, Pacific Time(US & Canada)
"UtcM7"	UTC-07:00, Mountain Time (US & Canada)
"UtcM6"	UTC-06:00, Central America, Central Time(US & Canada)
"UtcM5"	UTC-05:00, Eastern Time(US & Canada)
"UtcM430"	UTC-04:30, Caracas
"UtcM4"	UTC-04:00, Atlantic Time(Canada), Caracas, Santiago
"UtcM330"	UTC-03:30, Newfoundland
"UtcM3"	UTC-03:00, Brasilia, Buenos Aires, Georgetown, Greenland
"UtcM2"	UTC-02:00, Mid-Atlantic
"UtcM1"	UTC-01:00, Azores, Cape Verde Is.
"Utc0"	UTC-00:00, Greenwich Mean Time, Dublin, London
"UtcP1"	UTC+01:00, Amsterdam, Berlin, Rome, Paris, West Central Africa
"UtcP2"	UTC+02:00, Athens, Istanbul, Cairo, Jerusalem
"UtcP3"	UTC+03:00, Baghdad, Kuwait, Riyadh, Moscow, Nairobi
"UtcP330"	UTC+03:30, Tehran
"UtcP4"	UTC+04:00, Abu Dhabi, Muscat, Baku, Tbilisi, Yerevan
"UtcP430"	UTC+04:30, Kabul
"UtcP5"	UTC+05:00, Ekaterinburg, Islamabad, Karachi, Tashkent
"UtcP530"	UTC+05:30, Chennai, Kolkata, Mumbai, New Delhi
"UtcP545"	UTC+05:45, Kathmandu
"UtcP6"	UTC+06:00, Almaty, Novosibirsk, Astana, Dhaka
"UtcP630"	UTC+06:30, Rangoon
"UtcP7"	UTC+07:00, Bangkok, Hanio, Jakarta, Krasnoyarsk
"UtcP8"	UTC+08:00, Taipei, Beijing, Chongqing, Hong Kong, Urumqi
"UtcP9"	UTC+09:00, Osaka, Sapporo, Tokyo, Seoul, Yakutsk
"UtcP930"	UTC+09:30, Adelaide, Darwin
"UtcP10"	UTC+10:00, Canberra, Melbourne, Sydney, Guam, Hobart, Vladivostok
"UtcP11"	UTC+11:00, Magadan, Solomon Is., New Caledonia
"UtcP12"	UTC+12:00, Auckland, Wellington, Fiji, Kamchatka, Marshall Is.
"UtcP13"	UTC+13:00, Nuku'alofa
"UtcP14"	UTC+14:00, Line Islands
"Unspecified"	Unspecified Time Zone

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

"TmOperation" : TM 1.0 Operation

Description

This property is a member of HpBios Attributes

Use this option to enable the Trusted Module (TM) 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.

JSON type:

String containing one of the following supported values:

"NoAction"	No Action
"Enable"	Enable
"Disable"	Disable
"Clear"	Clear

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

"TmVisibility" : TM 1.0 Visibility

Description

This property is a member of HpBios Attributes

Use this option to hide the Trusted Module (TM) 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.

JSON type:

String containing one of the following supported values:

"Hidden"	Hidden
"Visible"	Visible

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

"Tpm2Operation" : TPM 2.0 Operation

Description

This property is a member of HpBios Attributes

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.

JSON type:

String containing one of the following supported values:

"NoAction"	No Action
"Clear"	Clear

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

"Tpm2Ppi" : TPM 2.0 Physical Presence Confirmation

Description

This property is a member of HpBios Attributes

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.

JSON type:

String containing one of the following supported values:

"Enabled"	Enabled
"Disabled"	Disabled

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

"Tpm2Visibility" : TPM 2.0 Visibility

Description

This property is a member of HpBios Attributes

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.

JSON type:

String containing one of the following supported values:

"Hidden"	Hidden
"Visible"	Visible

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

"TpmBinding" : TPM Binding

Description

This property is a member of HpBios Attributes

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.

JSON type:

String containing one of the following supported values:

"Enabled"	Enabled
"Disabled"	Disabled

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

"TpmOperation" : TPM 1.2 Operation

Description

This property is a member of HpBios Attributes

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.

JSON type:

String containing one of the following supported values:

"NoAction"	No Action
"Enable"	Enable
"Disable"	Disable
"Clear"	Clear

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

"TpmState" : Current TPM State

Description

This property is a member of HpBios Attributes

Current TPM device state: Not Present; Present and Disabled; Present and Enabled.

JSON type:

String containing one of the following supported values:

"NotPresent"	Not Present
"PresentDisabled"	Present and Disabled
"PresentEnabled"	Present and Enabled

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.

"TpmType" : Current TPM Type

Description

This property is a member of HpBios Attributes

Current TPM device type.

JSON type:

String containing one of the following supported values:

"NoTpm"	No TPM
"Tpm12"	TPM 1.2
"Tpm20"	TPM 2.0
"Tm10"	TM 1.0

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.

"TpmUefiOpromMeasuring" : TPM UEFI Option ROM Measurement

Description

This property is a member of HpBios Attributes

Use this option to enable measuring the UEFI PCI option ROMs. Disabling this option skips measuring the UEFI PCI option ROMs.

JSON type:

String containing one of the following supported values:

"Enabled"	Enabled
"Disabled"	Disabled

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

"TpmVisibility" : TPM 1.2 Visibility

Description

This property is a member of HpBios Attributes

JSON type:

String containing one of the following supported values:

"Hidden"	Hidden
"Visible"	Visible

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

"UefiOptimizedBoot" : UEFI Optimized Boot

Description

This property is a member of HpBios Attributes

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.

JSON type:

String containing one of the following supported values:

"Enabled"	Enabled
"Disabled"	Disabled

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

"UefiPxeBoot" : UEFI PXE Boot Policy

Description

This property is a member of HpBios Attributes

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.

JSON type:

String containing one of the following supported values:

"Auto"	Auto
"IPv4ThenIPv6"	IPv4 then IPv6
"IPv4"	IPv4
"IPv6"	IPv6
"IPv6ThenIPv4"	IPv6 then IPv4

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

"UefiShellBootOrder" : Add Embedded UEFI Shell to Boot Order

Description

This property is a member of HpBios Attributes

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.

JSON type:

String containing one of the following supported values:

"Enabled"	Enabled
"Disabled"	Disabled

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

"UefiShellStartup" : UEFI Shell Script Auto-Start

Description

This property is a member of HpBios Attributes

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.

JSON type:

String containing one of the following supported values:

"Enabled"	Enabled
"Disabled"	Disabled

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

"UefiShellStartupLocation" : Shell Auto-Start Script Location

Description

This property is a member of HpBios Attributes

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.

JSON type:

String containing one of the following supported values:

"Auto"	Auto
"AttachedMedia"	File Systems on Attached Media
"NetworkLocation"	Network Location

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

"UefiShellStartupUrl" : Network Location for Shell Auto-Start Script

Description

This property is a member of HpBios Attributes

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.

JSON type:

String from 0 to 255 characters in length.

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

"UrlBootFile" : Boot from URL

Description

This property is a member of HpBios Attributes

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.

JSON type:

String from 0 to 254 characters in length.

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

"Usb3Mode" : USB 3.0 Mode

Description

This property is a member of HpBios Attributes

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.

JSON type:

String containing one of the following supported values:

"Auto"	Auto
"Enabled"	Enabled
"Disabled"	Disabled

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

"UsbBoot" : USB Boot Support

Description

This property is a member of HpBios Attributes

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

JSON type:

String containing one of the following supported values:

"Enabled"	Enabled
"Disabled"	Disabled

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

"UsbControl" : USB Control

Description

This property is a member of HpBios Attributes

USB Enabled: Enables all USB ports and embedded devices. External USB Ports Disabled: Disables only external USB ports.

JSON type:

String containing one of the following supported values:

"UsbEnabled"	USB Enabled
"ExternalUsbDisabled"	External USB Ports Disabled

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

"UtilityLang" : Utility Language

Description

This property is a member of HpBios Attributes

Select this option to adjust the current language for the system.

JSON type:

String containing one of the following supported values:

"English"	English
"Japanese"	日本語
"Chinese"	中文（简体）

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

"VideoOptions" : Video Options

Description

This property is a member of HpBios Attributes

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.

JSON type:

String containing one of the following supported values:

"OptionalVideoOnly"	Add-in Video Enabled, Embedded Video Disabled
"BothVideoEnabled"	Both Add-in and Embedded Video Enabled

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

"VirtualInstallDisk" : Virtual Install Disk

Description

This property is a member of HpBios Attributes

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.

JSON type:

String containing one of the following supported values:

"Enabled"	Enabled
"Disabled"	Disabled

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

"VirtualSerialPort" : Virtual Serial Port

Description

This property is a member of HpBios Attributes

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.

JSON type:

String containing one of the following supported values:

"Com1Irq4"	COM 1; IRQ4; I/O: 3F8h-3FFh
"Com2Irq3"	COM 2; IRQ3; I/O: 2F8h-2FFh
"Disabled"	Disabled

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

"VlanControl" : VLAN Control

Description

This property is a member of HpBios Attributes

Use this option to enable or disable VLAN tagging on all enabled network interfaces.

JSON type:

String containing one of the following supported values:

"Enabled"	Enabled
"Disabled"	Disabled

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

"VlanId" : VLAN ID

Description

This property is a member of HpBios Attributes

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.

JSON type:

Integer from 0 to 4094.

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

"VlanPriority" : VLAN Priority

Description

This property is a member of HpBios Attributes

Use this option to set the priority for the VLAN tagged frames. Possible values are 0 to 7.

JSON type:

Integer from 0 to 7.

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

"WakeOnLan" : Wake-On LAN

Description

This property is a member of HpBios Attributes

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.

JSON type:

String containing one of the following supported values:

"Enabled"	Enabled
"Disabled"	Disabled

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

"HpBiosMapping" Resource Type

Resource Instances

/rest/v1/Systems/{item}/Bios/Mappings

See Resource Map for more details.

GET	Rendered if supported by the implementation or omitted if not.

"HpESKM" Resource Type

Resource Instances

/rest/v1/Managers/{item}/SecurityService/ESKM

See Resource Map for more details.

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.

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

PATCH Example

HTTP PATCH to resource with request JSON:

{"KeyManagerConfig": {"AccountGroup": "<string-value>"}}

The property "KeyManagerConfig/AccountGroup" on resource type HpESKM may not support PATCH of all values and may result in an HTTP 400 error with response of Type ExtendedError. Multiple properties may be included in a single HTTP PATCH operation as long as the request is properly formatted JSON. To address an array entry other than the first, insert nulls as placeholders on skipped array entries.

"KeyManagerConfig/AccountName"

This property is a member of HpESKM

Account name on ESKM.

JSON type:

String

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.

"KeyManagerConfig/ESKMLocalCACertificateName"

This property is a member of HpESKM

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.

JSON type:

String

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

PATCH Example

HTTP PATCH to resource with request JSON:

{"KeyManagerConfig": {"ESKMLocalCACertificateName": "<string-value>"}}

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

PATCH Example

HTTP PATCH to resource with request JSON:

{"KeyManagerConfig": {"LoginName": "<string-value>"}}

The property "KeyManagerConfig/LoginName" on resource type HpESKM may not support PATCH of all values and may result in an HTTP 400 error with response of Type ExtendedError. Multiple properties may be included in a single HTTP PATCH operation as long as the request is properly formatted JSON. To address an array entry other than the first, insert nulls as placeholders on skipped array entries.

"KeyManagerConfig/Password"

This property is a member of HpESKM

ESKM administrator account password. This property always returns null on GET.

JSON type:

String

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

PATCH Example

HTTP PATCH to resource with request JSON:

{"KeyManagerConfig": {"Password": "<string-value>"}}

The property "KeyManagerConfig/Password" on resource type HpESKM may not support PATCH of all values and may result in an HTTP 400 error with response of Type ExtendedError. Multiple properties may be included in a single HTTP PATCH operation as long as the request is properly formatted JSON. To address an array entry other than the first, insert nulls as placeholders on skipped array entries.

"KeyServerRedundancyReq"

This property is a member of HpESKM

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.

JSON type:

Boolean ('true' or 'false')

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

PATCH Example

HTTP PATCH to resource with request JSON:

{"KeyServerRedundancyReq": true}

The property "KeyServerRedundancyReq" on resource type HpESKM may not support PATCH of all values and may result in an HTTP 400 error with response of Type ExtendedError. Multiple properties may be included in a single HTTP PATCH operation as long as the request is properly formatted JSON. To address an array entry other than the first, insert nulls as placeholders on skipped array entries.

"PrimaryKeyServerAddress"

This property is a member of HpESKM

Primary key server IP address or FQDN. Set to null to clear the value.

JSON type:

String

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

PATCH Example

HTTP PATCH to resource with request JSON:

{"PrimaryKeyServerAddress": "<string-value>"}

The property "PrimaryKeyServerAddress" on resource type HpESKM may not support PATCH of all values and may result in an HTTP 400 error with response of Type ExtendedError. Multiple properties may be included in a single HTTP PATCH operation as long as the request is properly formatted JSON. To address an array entry other than the first, insert nulls as placeholders on skipped array entries.

"PrimaryKeyServerPort"

This property is a member of HpESKM

Primary key server port number. Set to null to clear the value.

JSON type:

Integer

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

PATCH Example

HTTP PATCH to resource with request JSON:

{"PrimaryKeyServerPort": <integer-value>}

The property "PrimaryKeyServerPort" on resource type HpESKM may not support PATCH of all values and may result in an HTTP 400 error with response of Type ExtendedError. Multiple properties may be included in a single HTTP PATCH operation as long as the request is properly formatted JSON. To address an array entry other than the first, insert nulls as placeholders on skipped array entries.

"SecondaryKeyServerAddress"

This property is a member of HpESKM

Secondary key server IP address or FQDN. Set to null to clear the value.

JSON type:

String

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

PATCH Example

HTTP PATCH to resource with request JSON:

{"SecondaryKeyServerAddress": "<string-value>"}

The property "SecondaryKeyServerAddress" on resource type HpESKM may not support PATCH of all values and may result in an HTTP 400 error with response of Type ExtendedError. Multiple properties may be included in a single HTTP PATCH operation as long as the request is properly formatted JSON. To address an array entry other than the first, insert nulls as placeholders on skipped array entries.

"SecondaryKeyServerPort"

This property is a member of HpESKM

Secondary key server port number. Set to null to clear the value.

JSON type:

Integer

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

PATCH Example

HTTP PATCH to resource with request JSON:

{"SecondaryKeyServerPort": <integer-value>}

The property "SecondaryKeyServerPort" on resource type HpESKM may not support PATCH of all values and may result in an HTTP 400 error with response of Type ExtendedError. Multiple properties may be included in a single HTTP PATCH operation as long as the request is properly formatted JSON. To address an array entry other than the first, insert nulls as placeholders on skipped array entries.

POST Action "TestESKMConnections"

Test ESKM connections.

Example

HTTP POST to resource with request JSON:

{ "Action": "TestESKMConnections"}

POST Action "ClearESKMLog"

Clears ESKM log.

Example

HTTP POST to resource with request JSON:

{ "Action": "ClearESKMLog"}

"HpHttpsCert" Resource Type

Resource Instances

/rest/v1/Managers/{item}/SecurityService/HttpsCert

See Resource Map for more details.

This is the schema definition for the X509 Certificate.

GET	Rendered if supported by the implementation or omitted if not.

Parameter "Certificate"

"Certificate" must be one of the following value(s):

"<text>"

Example

HTTP POST to resource with request JSON:

{ "Action": "ImportCertificate", "Certificate": "<text>"}

"HpMemory" Resource Type

Resource Instances

/rest/v1/Systems/{item}/Memory/{item}

See Resource Map for more details.

The schema definition for the properties of Memory DIMMs.

"HpMemory" defines the following properties:

"AssetTag"

This property is a member of HpMemory

The asset tag for this memory device.

JSON type:

String

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.

"BankLocator"

This property is a member of HpMemory

Identifies the physically labeled bank, where the memory device is located.

JSON type:

String

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.

"DIMMStatus"

This property is a member of HpMemory

Specifies memory module status and whether the module in use.

JSON type:

String containing one of the following supported values:

""
"Unknown"
"Other"
"NotPresent"
"PresentUnused"
"GoodInUse"
"AddedButUnused"
"UpgradedButUnused"
"ExpectedButMissing"
"DoesNotMatch"
"NotSupported"
"ConfigurationError"
"Degraded"
"PresentSpare"
"GoodPartiallyInUse"

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.

"DIMMTechnology"

This property is a member of HpMemory

The memory module technology type.

JSON type:

String containing one of the following supported values:

""
"BurstEDO"
"FastPage"
"Synchronous"
"EDO"
"LRDIMM"
"RDRAM"
"RDIMM"
"UDIMM"
"NVDIMM"
"RNVDIMM"
"LRNVDIMM"
"Unknown"

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.

"DIMMType"

This property is a member of HpMemory

The type of memory DIMM used in this system.

JSON type:

String containing one of the following supported values:

""
"DDR"
"DDR2"
"DDR3"
"DDR4"
"FBD2"
"LPDD3"
"LPDDR"
"LPDDR2"
"LPDDR4"

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.

"DataWidth"

This property is a member of HpMemory

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.

JSON type:

Integer

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.

"ErrorCorrection"

This property is a member of HpMemory

The error correction used for this DIMM. If the value is null, the error correction is unknown.

JSON type:

String containing one of the following supported values:

""
"None"
"Parity"
"SingleBitECC"
"MultiBitECC"
"CRC"

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.

"HPMemoryType"

This property is a member of HpMemory

Indicates whether or not HP SmartMemory is present.

JSON type:

String containing one of the following supported values:

""
"HPSmartMemory"
"HPStandard"
"Unknown"

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.

"Manufacturer"

This property is a member of HpMemory

Identifies the manufacturer of this memory device.

JSON type:

String

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.

"MaximumFrequencyMHz"

This property is a member of HpMemory

Identifies the maximum, capable speed of the device in megahertz (MHz). If the value is null, the speed is unknown.

JSON type:

Integer

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.

"MinimumVoltageVoltsX10"

This property is a member of HpMemory

The minimum DIMM voltage multiplied by 10, for example, 1.2v = 12.

JSON type:

Integer greater than or equal to 0.

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.

"PartNumber"

This property is a member of HpMemory

The part number for this memory device.

JSON type:

String

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.

"Rank"

This property is a member of HpMemory

Specifies the DIMM rank. A value of null indicates the rank is unknown.

JSON type:

Integer

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.

"SerialNumber"

This property is a member of HpMemory

The serial number for this memory device.

JSON type:

String

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.

"SizeMB"

This property is a member of HpMemory

The size of the memory device in megabytes.

JSON type:

Integer

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.

"SocketLocator"

This property is a member of HpMemory

Identifies the physically labeled socket or board position, where the memory device is located.

JSON type:

String

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.

"Status/Health"

This property is a member of HpMemory

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

JSON type:

String containing one of the following supported values:

""
"OK"
"Warning"
"Critical"

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.

"Status/HealthRollUp"

This property is a member of HpMemory

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

JSON type:

String containing one of the following supported values:

""
"OK"
"Warning"
"Critical"

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.

"Status/HealthRollup"

This property is a member of HpMemory

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

JSON type:

String containing one of the following supported values:

""
"OK"
"Warning"
"Critical"

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.

"Status/State"

This property is a member of HpMemory

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

JSON type:

String containing one of the following supported values:

""
"Enabled"
"Disabled"
"Offline"
"InTest"
"Starting"
"Absent"

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.

"TotalWidth"

This property is a member of HpMemory

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.

JSON type:

Integer

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.

GET	Rendered if supported by the implementation or omitted if not.

"SecureBootEnable"

This property is a member of HpSecureBoot

Enable or disable UEFI Secure Boot (takes effect on next boot).

JSON type:

Boolean ('true' or 'false')

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

PATCH Example

HTTP PATCH to resource with request JSON:

{"SecureBootEnable": true}

The property "SecureBootEnable" on resource type HpSecureBoot may not support PATCH of all values and may result in an HTTP 400 error with response of Type ExtendedError. Multiple properties may be included in a single HTTP PATCH operation as long as the request is properly formatted JSON. To address an array entry other than the first, insert nulls as placeholders on skipped array entries.

"HpSecurityService" Resource Type

Resource Instances

/rest/v1/Managers/{item}/SecurityService

See Resource Map for more details.

"HpSecurityService" defines the following properties:

"HpServerBootSettings" Resource Type

Resource Instances

/rest/v1/Systems/{item}/Bios/Boot

/rest/v1/Systems/{item}/Bios/Boot/Settings

See Resource Map for more details.

The schema definition of the server UEFI Boot Order resource.

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

PATCH Example

HTTP PATCH to resource with request JSON:

{"DesiredBootDevices": [{"CorrelatableID": "<string-value>"}|null, ...]}

The property "DesiredBootDevices[]/CorrelatableID" on resource type HpServerBootSettings may not support PATCH of all values and may result in an HTTP 400 error with response of Type ExtendedError. Multiple properties may be included in a single HTTP PATCH operation as long as the request is properly formatted JSON. To address an array entry other than the first, insert nulls as placeholders on skipped array entries.

"DesiredBootDevices[]/Lun"

This property is a member of HpServerBootSettings

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

JSON type:

String

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

PATCH Example

HTTP PATCH to resource with request JSON:

{"DesiredBootDevices": [{"Lun": "<string-value>"}|null, ...]}

The property "DesiredBootDevices[]/Lun" on resource type HpServerBootSettings may not support PATCH of all values and may result in an HTTP 400 error with response of Type ExtendedError. Multiple properties may be included in a single HTTP PATCH operation as long as the request is properly formatted JSON. To address an array entry other than the first, insert nulls as placeholders on skipped array entries.

"DesiredBootDevices[]/Wwn"

This property is a member of HpServerBootSettings

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

JSON type:

String

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

PATCH Example

HTTP PATCH to resource with request JSON:

{"DesiredBootDevices": [{"Wwn": "<string-value>"}|null, ...]}

The property "DesiredBootDevices[]/Wwn" on resource type HpServerBootSettings may not support PATCH of all values and may result in an HTTP 400 error with response of Type ExtendedError. Multiple properties may be included in a single HTTP PATCH operation as long as the request is properly formatted JSON. To address an array entry other than the first, insert nulls as placeholders on skipped array entries.

"DesiredBootDevices[]/iScsiTargetName"

This property is a member of HpServerBootSettings

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

JSON type:

String from 0 to 223 characters in length.

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

PATCH Example

HTTP PATCH to resource with request JSON:

{"DesiredBootDevices": [{"iScsiTargetName": "<string-value>"}|null, ...]}

GET	Rendered if supported by the implementation or omitted if not.

"SettingsResult/definitions/SettingsResult/Messages[]/Severity"

This property is a member of HpServerBootSettings

This is the severity of the errors.

JSON type:

String containing one of the following supported values:

"OK"
"Warning"
"Critical"

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.

"SettingsResult/definitions/SettingsResult/Operation"

This property is a member of HpServerBootSettings

Details about the results of applying the settings.

JSON type:

String containing one of the following supported values:

"SettingsApply"

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.

"SettingsResult/definitions/SettingsResult/Time"

This property is a member of HpServerBootSettings

Time at which the settings were applied.

JSON type:

String

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.

"HpServerPCISlot" Resource Type

Resource Instances

/rest/v1/Systems/{item}/PCISlots/{item}

See Resource Map for more details.

"HpServerPCISlot" defines the following properties:

"Length"

This property is a member of HpServerPCISlot

PCI slot length

JSON type:

String containing one of the following supported values:

"Short"
"Long"
"Other"

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.

"LinkLanes"

This property is a member of HpServerPCISlot

Bandwidth capacity of the slot, measured by the number of PCI Express Lanes present. Also known as the slot width.

JSON type:

String containing one of the following supported values:

"8 bit"
"16 bit"
"32 bit"
"64 bit"
"128 bit"
"x1"
"x2"
"x4"
"x8"
"x16"
"x32"
"Other"

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.

"Status/EnabledState"

This property is a member of HpServerPCISlot

Specifies whether the slot is enabled or disabled.

JSON type:

String

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.

"Status/OperationalStatus[]/Status"

This property is a member of HpServerPCISlot

Current usage status of the slot: InUse or Empty

JSON type:

String

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.

"SupportsHotPlug"

This property is a member of HpServerPCISlot

Specifies whether the slot supports hot-plug devices.

JSON type:

Boolean ('true' or 'false')

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.

"Technology"

This property is a member of HpServerPCISlot

PCI technology

JSON type:

String containing one of the following supported values:

"PCIExpressGen3"
"PCIExpressGen2"
"PCIExpress"

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.

"UEFIDevicePath"

This property is a member of HpServerPCISlot

Standardized text representation of the UEFI device path, in UTF-8 format

JSON type:

String

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.

"HpServerPciDevice" Resource Type

Resource Instances

/rest/v1/Systems/{item}/PCIDevices/{item}

See Resource Map for more details.

GET	Rendered if supported by the implementation or omitted if not.

"DeviceType"

This property is a member of HpServerPciDevice

Device type value.

JSON type:

String containing one of the following supported values:

"Flexible LOM"
"Embedded LOM"
"NIC"
"HDD Not attached to a SA Controller"
"HDD Attached to a SA Controller"
"Other PCI Device"
"Unknown"
"Other"
"Video"
"SCSI Controller"
"Ethernet"
"Token Ring"
"Sound"
"PATA Controller"
"SATA Controller"
"SAS Controller"

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.

"EnclosureNumber"

This property is a member of HpServerPciDevice

Enclosure number value.

JSON type:

Integer

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.

"FunctionNumber"

This property is a member of HpServerPciDevice

PCI device function number value.

JSON type:

Integer

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.

"SegmentNumber"

This property is a member of HpServerPciDevice

PCI segment group number value.

JSON type:

Integer

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.

"StructuredName"

This property is a member of HpServerPciDevice

PCI device structured name in UTF-8 format.

JSON type:

String

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.

"SubclassCode"

This property is a member of HpServerPciDevice

PCI sub class code of the endpoint.

JSON type:

Integer

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.

"SubsystemDeviceID"

This property is a member of HpServerPciDevice

PCI subsystem device ID of the device.

JSON type:

Integer

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.

"SubsystemVendorID"

This property is a member of HpServerPciDevice

PCI subsystem vendor ID of the device.

JSON type:

Integer

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.

"UEFIDevicePath"

This property is a member of HpServerPciDevice

Standardized text representation of the UEFI device path, in UTF-8 format.

JSON type:

String

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.

"VendorID"

This property is a member of HpServerPciDevice

PCI vendor ID of the device.

JSON type:

Integer

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.

"HpSmartStorage" Resource Type

Resource Instances

/rest/v1/Systems/{item}/SmartStorage

See Resource Map for more details.

HpSmartStorage

"HpSmartStorage" defines the following properties:

"Status/Health"

This property is a member of HpSmartStorage

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

JSON type:

String containing one of the following supported values:

""
"OK"
"Warning"
"Critical"

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.

"Status/HealthRollUp"

This property is a member of HpSmartStorage

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

JSON type:

String containing one of the following supported values:

""
"OK"
"Warning"
"Critical"

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.

"Status/HealthRollup"

This property is a member of HpSmartStorage

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

JSON type:

String containing one of the following supported values:

""
"OK"
"Warning"
"Critical"

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.

"Status/State"

This property is a member of HpSmartStorage

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

JSON type:

String containing one of the following supported values:

""
"Enabled"
"Disabled"
"Offline"
"InTest"
"Starting"
"Absent"

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.

"HpSmartStorageArrayController" Resource Type

Resource Instances

/rest/v1/Systems/{item}/SmartStorage/ArrayControllers/{item}

See Resource Map for more details.

HpSmartStorageArrayController

"HpSmartStorageArrayController" defines the following properties:

"AdapterType"

This property is a member of HpSmartStorageArrayController

Type of Smart controller

JSON type:

String containing one of the following supported values:

"SmartArray"
"SmartHBA"
"DynamicSmartArray"

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.

"ArrayCount"

This property is a member of HpSmartStorageArrayController

The number of arrays configured on this controller

JSON type:

Integer

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.

"BackupPowerSourceStatus"

This property is a member of HpSmartStorageArrayController

The current status of the backup power source (battery, capacitor, megacell etc.)

JSON type:

String containing one of the following supported values:

"Present"
"NotPresent"
"PresentAndCharged"
"PresentAndCharging"

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.

"BootVolumePrimary"

This property is a member of HpSmartStorageArrayController

The primary boot volume of this controller

JSON type:

String

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.

"BootVolumeSecondary"

This property is a member of HpSmartStorageArrayController

The secondary boot volume of this controller

JSON type:

String

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.

"CacheArrayCount"

This property is a member of HpSmartStorageArrayController

The number of cache arrays configured on this controller

JSON type:

Integer

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.

"CacheLogicalDriveCount"

This property is a member of HpSmartStorageArrayController

The number of cache logical drives configured on this controller

JSON type:

Integer

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.

"CacheMemorySizeMiB"

This property is a member of HpSmartStorageArrayController

The total cache memory size for the controller in MiB

JSON type:

Integer

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.

"CachePhysicalDriveCount"

This property is a member of HpSmartStorageArrayController

The number of physical drives assigned as cache drives attached to this controller

JSON type:

Integer

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.

"CurrentOperatingMode"

This property is a member of HpSmartStorageArrayController

The current operating mode of the controller.

JSON type:

String containing one of the following supported values:

"RAID"
"HBA"

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.

"CurrentParallelSurfaceScanCount"

This property is a member of HpSmartStorageArrayController

Number of disks the controller is scanning in parallel

JSON type:

Integer

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.

"DataLogicalDriveCount"

This property is a member of HpSmartStorageArrayController

The number of data logical drives configured on this controller

JSON type:

Integer

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.

"DataPhysicalDriveCount"

This property is a member of HpSmartStorageArrayController

The number of physical drives assigned as data drives attached to this controller

JSON type:

Integer

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.

"DegradedPerformanceOptimization"

This property is a member of HpSmartStorageArrayController

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

JSON type:

String containing one of the following supported values:

"Enabled"
"Disabled"

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.

"DriveWriteCache"

This property is a member of HpSmartStorageArrayController

Enables or disables the write cache of the physical drives attached to the controller

JSON type:

String containing one of the following supported values:

"Enabled"
"Disabled"

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.

"ElevatorSort"

This property is a member of HpSmartStorageArrayController

Enables the controller to sort requests to a physical drive

JSON type:

String containing one of the following supported values:

"Enabled"
"Disabled"

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.

"EncryptionBootPasswordSet"

This property is a member of HpSmartStorageArrayController

True if there is a boot password set, false otherwise

JSON type:

Boolean ('true' or 'false')

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.

"EncryptionCryptoOfficerPasswordSet"

This property is a member of HpSmartStorageArrayController

True if a password has been set for the Encryption Crypto Officer, false otherwise

JSON type:

Boolean ('true' or 'false')

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.

"EncryptionEnabled"

This property is a member of HpSmartStorageArrayController

True if encryption is currently enabled for this controller, false otherwise

JSON type:

Boolean ('true' or 'false')

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.

"EncryptionFwLocked"

This property is a member of HpSmartStorageArrayController

True if the controller firmware has been locked, preventing firmware updates, false otherwise

JSON type:

Boolean ('true' or 'false')

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.

"EncryptionHasLockedVolumes"

This property is a member of HpSmartStorageArrayController

True if the controller has one or more volumes that are locked, false otherwise

JSON type:

Boolean ('true' or 'false')

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.

"EncryptionHasLockedVolumesMissingBootPassword"

This property is a member of HpSmartStorageArrayController

True if there are locked drives due to a missing boot password, false otherwise

JSON type:

Boolean ('true' or 'false')

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.

"EncryptionHasSuspendedVolumes"

This property is a member of HpSmartStorageArrayController

True if the controller password has been temporarily suspended, false otherwise

JSON type:

Boolean ('true' or 'false')

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.

"EncryptionKekSet"

This property is a member of HpSmartStorageArrayController

True if the Master Key has been set, false otherwise

JSON type:

Boolean ('true' or 'false')

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.

"EncryptionLocalKeyCacheEnabled"

This property is a member of HpSmartStorageArrayController

True if the controller caches encryption keys locally when a remote key manager is being used, false otherwise

JSON type:

Boolean ('true' or 'false')

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.

"EncryptionMixedVolumesEnabled"

This property is a member of HpSmartStorageArrayController

True if the controller will allow plaintext and encrypted volumes to exist simultaneously, false otherwise

JSON type:

Boolean ('true' or 'false')

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.

"EncryptionPhysicalDriveCount"

This property is a member of HpSmartStorageArrayController

The number of encrypted physical drives attached to the controller

JSON type:

Integer

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.

"EncryptionRecoveryParamsSet"

This property is a member of HpSmartStorageArrayController

True if the encryption password recovery question and answer have been set, false otherwise

JSON type:

Boolean ('true' or 'false')

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.

"EncryptionStandaloneModeEnabled"

This property is a member of HpSmartStorageArrayController

True if the controller manages encryption keys locally, false if a remote key manager is being used

JSON type:

Boolean ('true' or 'false')

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.

"EncryptionUserPasswordSet"

This property is a member of HpSmartStorageArrayController

True if a password has been set for the Encryption User, false otherwise.

JSON type:

Boolean ('true' or 'false')

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.

"ExpandPriority"

This property is a member of HpSmartStorageArrayController

The level of priority that transformations have over handling current operating system requests

JSON type:

String containing one of the following supported values:

"High"
"Medium"
"Low"

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.

"ExternalPortCount"

This property is a member of HpSmartStorageArrayController

The number of external ports

JSON type:

Integer

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.

"FirmwareVersion/Current/VersionString"

This property is a member of HpSmartStorageArrayController

This string represents the version of the firmware image.

JSON type:

String

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.

"FlexibleLatencySchedulerSetting"

This property is a member of HpSmartStorageArrayController

This allows the controller to process certain high-latency requests after a delay that may time out when elevator sorting

JSON type:

String containing one of the following supported values:

"Default"
"Low250"
"Middle100"
"Middle50"
"Aggressive30"
"Aggressive10"

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.

"HardwareRevision"

This property is a member of HpSmartStorageArrayController

The hardware revision of the controller

JSON type:

String

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.

"InconsistencyRepairPolicy"

This property is a member of HpSmartStorageArrayController

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

JSON type:

String containing one of the following supported values:

"Enabled"
"Disabled"

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.

"InternalPortCount"

This property is a member of HpSmartStorageArrayController

The number of internal ports

JSON type:

Integer

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.

"IsBootController"

This property is a member of HpSmartStorageArrayController

True if this controller is the OS boot controller, false otherwise

JSON type:

Boolean ('true' or 'false')

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.

"Location"

This property is a member of HpSmartStorageArrayController

Location identifier

JSON type:

String

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.

"LocationFormat"

This property is a member of HpSmartStorageArrayController

Format for Location Identifier

JSON type:

String containing one of the following supported values:

"PCISlot"

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.

"LogicalDriveCount"

This property is a member of HpSmartStorageArrayController

The number of logical drives configured on this controller

JSON type:

Integer

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.

"Manufacturer"

This property is a member of HpSmartStorageArrayController

The manufacturer of the controller

JSON type:

String

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.

"MaxParallelSurfaceScanCount"

This property is a member of HpSmartStorageArrayController

Maximum number of disks that the controller supports scanning in parallel

JSON type:

Integer

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.

"Model"

This property is a member of HpSmartStorageArrayController

The model number for the controller

JSON type:

String

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.

"OperatingModeAfterReboot"

This property is a member of HpSmartStorageArrayController

The operating mode the controller will be functioning in (RAID versus HBA) after a reboot

JSON type:

String containing one of the following supported values:

"RAID"
"HBA"

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.

"ParallelSurfaceScanSupported"

This property is a member of HpSmartStorageArrayController

True if the controller supports scanning multiple disk surfaces

JSON type:

Boolean ('true' or 'false')

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.

"PhysicalDriveCount"

This property is a member of HpSmartStorageArrayController

The number of physical drives attached to this controller

JSON type:

Integer

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.

"PowerModeAfterReboot"

This property is a member of HpSmartStorageArrayController

The power mode of the controller after a reboot

JSON type:

String containing one of the following supported values:

"Invalid"
"Low"
"LowAutomated"
"Performant"

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.

"PowerModeConfigured"

This property is a member of HpSmartStorageArrayController

The current power mode of the controller

JSON type:

String containing one of the following supported values:

"Invalid"
"Low"
"LowAutomated"
"Performant"

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.

"PowerModeWarningChangedDrive"

This property is a member of HpSmartStorageArrayController

True if the controller's drive configuration has changed while using configuration based power settings, false otherwise

JSON type:

Boolean ('true' or 'false')

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.

"PowerModeWarningChangedMode"

This property is a member of HpSmartStorageArrayController

True if the controller has a new power mode configured, false otherwise

JSON type:

Boolean ('true' or 'false')

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.

"PowerModeWarningReboot"

This property is a member of HpSmartStorageArrayController

True if a reboot is required to change the active power mode on the controller, false otherwise

JSON type:

String containing one of the following supported values:

"NotRequired"
"RequiredNoReason"
"RequiredPowerSavings"
"RequiredPerformance"

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.

"PowerModeWarningTemperature"

This property is a member of HpSmartStorageArrayController

True if the controller has crossed a critical temperature threshold and performance has been reduced to prevent damage to the controller, false otherwise

JSON type:

Boolean ('true' or 'false')

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.

"PredictiveSpareRebuild"

This property is a member of HpSmartStorageArrayController

Enables or disables predictive spare rebuild mode

JSON type:

String containing one of the following supported values:

"Enabled"
"Disabled"

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.

"QueueDepth"

This property is a member of HpSmartStorageArrayController

This sets the maximum number of requests the controller will submit to a drive at any given time

JSON type:

String containing one of the following supported values:

"2"
"4"
"8"
"16"
"32"
"Automatic"

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.

"RebuildPriority"

This property is a member of HpSmartStorageArrayController

The level of priority that rebuilds have over handling current operating system requests

JSON type:

String containing one of the following supported values:

"High"
"Medium"
"Low"
"RapidHigh"
"RapidMediumHigh"
"RapidMedium"
"RapidLow"

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.

"SerialNumber"

This property is a member of HpSmartStorageArrayController

The serial number for this controller

JSON type:

String

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.

"SoftwareRaidHbaFirmwareRev"

This property is a member of HpSmartStorageArrayController

The firmware version of the underlying HBA that is being used by the software RAID stack

JSON type:

String

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.

"SoftwareRaidHbaModeOptionRomRev"

This property is a member of HpSmartStorageArrayController

The option ROM firmware version used to bootstrap the software RAID stack

JSON type:

String

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.

"SparePhysicalDriveCount"

This property is a member of HpSmartStorageArrayController

he number of physical drives assigned as spare drives attached to this controller

JSON type:

Integer

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.

"Status/Health"

This property is a member of HpSmartStorageArrayController

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

JSON type:

String containing one of the following supported values:

""
"OK"
"Warning"
"Critical"

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.

"Status/HealthRollUp"

This property is a member of HpSmartStorageArrayController

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

JSON type:

String containing one of the following supported values:

""
"OK"
"Warning"
"Critical"

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.

"Status/HealthRollup"

This property is a member of HpSmartStorageArrayController

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

JSON type:

String containing one of the following supported values:

""
"OK"
"Warning"
"Critical"

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.

"Status/State"

This property is a member of HpSmartStorageArrayController

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

JSON type:

String containing one of the following supported values:

""
"Enabled"
"Disabled"
"Offline"
"InTest"
"Starting"
"Absent"

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.

"SurfaceScanAnalysisPriority"

This property is a member of HpSmartStorageArrayController

Priority that the controller takes to find and correct disk surface errors

JSON type:

String containing one of the following supported values:

"Disabled"
"High"
"Medium"
"Low"
"Idle"

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.

"UnassignedPhysicalDriveCount"

This property is a member of HpSmartStorageArrayController

The number of unassigned physical drives attached to this controller

JSON type:

Integer

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.

"HpSmartStorageDiskDrive" Resource Type

Resource Instances

/rest/v1/Systems/{item}/SmartStorage/ArrayControllers/{item}/DiskDrives/{item}

See Resource Map for more details.

HpSmartStorageDiskDrive

GET	Rendered if supported by the implementation or omitted if not.

"CarrierAuthenticationStatus"

This property is a member of HpSmartStorageDiskDrive

Authentication status of the drive carrier

JSON type:

String containing one of the following supported values:

"OK"
"Fail"
"NoCommunication"
"NotApplicable"

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.

"CurrentTemperatureCelsius"

This property is a member of HpSmartStorageDiskDrive

The current temperature of the drive

JSON type:

Integer

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.

"EncryptedDrive"

This property is a member of HpSmartStorageDiskDrive

True if encryption is currently enabled on this disk drive, false otherwise

JSON type:

Boolean ('true' or 'false')

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.

"EraseCompletionPercentage"

This property is a member of HpSmartStorageDiskDrive

The percent complete for an erase operation currently occurring on the disk drive or null if not currently erasing a drive.

JSON type:

Integer

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.

"ErasePattern"

This property is a member of HpSmartStorageDiskDrive

The pattern used for erasing the disk drive

JSON type:

String

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.

"FirmwareVersion/Current/VersionString"

This property is a member of HpSmartStorageDiskDrive

This string represents the version of the firmware image.

JSON type:

String

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.

"IndicatorLED"

This property is a member of HpSmartStorageDiskDrive

The state of the indicator LED.

JSON type:

String containing one of the following supported values:

""
"Unknown"
"Lit"
"Blinking"
"Off"

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.

"InterfaceSpeedMbps"

This property is a member of HpSmartStorageDiskDrive

Native interface speed for the device

JSON type:

Integer greater than or equal to 0.

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.

"InterfaceType"

This property is a member of HpSmartStorageDiskDrive

The connection interface of the drive. The value NVME has been deprecated.

JSON type:

String containing one of the following supported values:

"SAS"
"SATA"
"NVME"
"PCIe"
"Unknown"

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.

"Location"

This property is a member of HpSmartStorageDiskDrive

The location of the drive

JSON type:

String

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.

"LocationFormat"

This property is a member of HpSmartStorageDiskDrive

Format for the location property

JSON type:

String containing one of the following supported values:

"ControllerPort:Box:Bay"
"SwitchPort:Box:Bay"
"SwitchPort:SwitchBay:Bay"

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.

"Manufacturer"

This property is a member of HpSmartStorageDiskDrive

Manufacturer of the disk drive

JSON type:

String

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.

"MaximumTemperatureCelsius"

This property is a member of HpSmartStorageDiskDrive

The maximum recommended temperature for the drive

JSON type:

Integer

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.

"MediaType"

This property is a member of HpSmartStorageDiskDrive

Type of disk

JSON type:

String containing one of the following supported values:

"HDD"
"SSD"

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.

"MinimumGoodFirmwareVersion"

This property is a member of HpSmartStorageDiskDrive

The minimum recommended firmware revision for the drive

JSON type:

String

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.

"Model"

This property is a member of HpSmartStorageDiskDrive

Drive model number

JSON type:

String

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.

"NativeBlockSizeBytes"

This property is a member of HpSmartStorageDiskDrive

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

JSON type:

Integer

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.

"PhyCount"

This property is a member of HpSmartStorageDiskDrive

The number of phys the drive has

JSON type:

Integer

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.

"PortCount"

This property is a member of HpSmartStorageDiskDrive

The number of ports on the drive. Typically 1 (single-domain) or 2 (dual-domain)

JSON type:

Integer greater than or equal to 0.

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.

"PowerOnHours"

This property is a member of HpSmartStorageDiskDrive

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.

JSON type:

Integer

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.

"RotationalSpeedRpm"

This property is a member of HpSmartStorageDiskDrive

The rotational speed of the drive, only applicable on HDDs

JSON type:

Integer

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.

"SSDEnduranceUtilizationPercentage"

This property is a member of HpSmartStorageDiskDrive

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.

JSON type:

Integer

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.

"SerialNumber"

This property is a member of HpSmartStorageDiskDrive

The serial number of the drive

JSON type:

String

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.

"SpareRebuildMode"

This property is a member of HpSmartStorageDiskDrive

Method to used activate this drive when another drive fails, this is only applicable if the drive is configured as a spare drive

JSON type:

String containing one of the following supported values:

"Dedicated"
"Roaming"

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.

"Status/Health"

This property is a member of HpSmartStorageDiskDrive

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

JSON type:

String containing one of the following supported values:

""
"OK"
"Warning"
"Critical"

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.

"Status/HealthRollUp"

This property is a member of HpSmartStorageDiskDrive

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

JSON type:

String containing one of the following supported values:

""
"OK"
"Warning"
"Critical"

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.

"Status/HealthRollup"

This property is a member of HpSmartStorageDiskDrive

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

JSON type:

String containing one of the following supported values:

""
"OK"
"Warning"
"Critical"

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.

"Status/State"

This property is a member of HpSmartStorageDiskDrive

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

JSON type:

String containing one of the following supported values:

""
"Enabled"
"Disabled"
"Offline"
"InTest"
"Starting"
"Absent"

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.

"TransferSpeedMbps"

This property is a member of HpSmartStorageDiskDrive

Effective transfer speed to the device taking into account hardware acceleration such as edge-buffering

JSON type:

Integer

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.

"WWID"

This property is a member of HpSmartStorageDiskDrive

Unique identifier for the device

JSON type:

String

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.

"HpSmartStorageLogicalDrive" Resource Type

Resource Instances

/rest/v1/Systems/{item}/SmartStorage/ArrayControllers/{item}/LogicalDrives/{item}

See Resource Map for more details.

HpSmartStorageLogicalDrive

GET	Rendered if supported by the implementation or omitted if not.

"LegacyBootPriority"

This property is a member of HpSmartStorageLogicalDrive

JSON type:

String containing one of the following supported values:

"Primary"
"Secondary"
"None"

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.

"LogicalDriveEncryption"

This property is a member of HpSmartStorageLogicalDrive

True if encryption is currently enabled on this logical drive, false otherwise

JSON type:

Boolean ('true' or 'false')

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.

"LogicalDriveEncryptionDataKeysVolatile"

This property is a member of HpSmartStorageLogicalDrive

True if volatile keys are enabled for encryption, false otherwise

JSON type:

Boolean ('true' or 'false')

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.

"LogicalDriveEncryptionDataKeysVolatileBackup"

This property is a member of HpSmartStorageLogicalDrive

True if volatile keys are backed up to a remote key manager, false if volatile keys are not backed up

JSON type:

Boolean ('true' or 'false')

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.

"LogicalDriveEncryptionDataKeysVolatileStatus"

This property is a member of HpSmartStorageLogicalDrive

The status of the encryption volatile keys

JSON type:

String containing one of the following supported values:

"NoOp"
"BackupInProgress"
"BackupAndSetInProgress"
"RestoreInProgress"
"DeleteInProgress"

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.

"LogicalDriveName"

This property is a member of HpSmartStorageLogicalDrive

Label given to the logical drive

JSON type:

String

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.

"LogicalDriveNumber"

This property is a member of HpSmartStorageLogicalDrive

logical drive number

JSON type:

Integer

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.

"LogicalDriveType"

This property is a member of HpSmartStorageLogicalDrive

How the logical drive is being used

JSON type:

String containing one of the following supported values:

"Data"
"Cache"
"SplitMirrorSetPrimary"
"SplitMirrorSetBackup"
"SplitMirrorSetBackupOrphan"

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.

"ParityInitializationCompletionPercentage"

This property is a member of HpSmartStorageLogicalDrive

Parity initialization complete percentage for a parity based logical drive (e.g. RAID 5)

JSON type:

Integer

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.

"ParityInitializationType"

This property is a member of HpSmartStorageLogicalDrive

When creating a logical drive with a RAID level that requires parity, parity blocks can be initialized with two different methods

JSON type:

String containing one of the following supported values:

"Default"
"Rapid"

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.

"PartitionInformation"

This property is a member of HpSmartStorageLogicalDrive

OS partition information for the drive

JSON type:

String

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.

"Raid"

This property is a member of HpSmartStorageLogicalDrive

The current RAID level configured on the logical drive

JSON type:

String containing one of the following supported values:

"0"
"1"
"1ADM"
"10"
"10ADM"
"5"
"50"
"6"
"60"

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.

"RebuildCompletionPercentage"

This property is a member of HpSmartStorageLogicalDrive

The percent complete for a rebuild operation currently occurring on the logical drive

JSON type:

Integer

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.

"SmartCacheState"

This property is a member of HpSmartStorageLogicalDrive

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

JSON type:

String containing one of the following supported values:

"Good"
"Limited"
"DDRUnsafe"
"CacheLUNOffline"
"PrimaryLUNOffline"
"Destroyed"
"Flushing"
"Configuring"
"PairFailAtPowerup"
"Unknown"

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.

"Status/Health"

This property is a member of HpSmartStorageLogicalDrive

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

JSON type:

String containing one of the following supported values:

""
"OK"
"Warning"
"Critical"

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.

"Status/HealthRollUp"

This property is a member of HpSmartStorageLogicalDrive

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

JSON type:

String containing one of the following supported values:

""
"OK"
"Warning"
"Critical"

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.

"Status/HealthRollup"

This property is a member of HpSmartStorageLogicalDrive

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

JSON type:

String containing one of the following supported values:

""
"OK"
"Warning"
"Critical"

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.

"Status/State"

This property is a member of HpSmartStorageLogicalDrive

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

JSON type:

String containing one of the following supported values:

""
"Enabled"
"Disabled"
"Offline"
"InTest"
"Starting"
"Absent"

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.

"StripSizeBytes"

This property is a member of HpSmartStorageLogicalDrive

The strip size of the logical drive in bytes

JSON type:

Integer

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.

"StripeSizeBytes"

This property is a member of HpSmartStorageLogicalDrive

The stripe size of the logical drive in bytes

JSON type:

Integer

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.

"TransformationCompletionPercentage"

This property is a member of HpSmartStorageLogicalDrive

The percent complete for any transformations the logical drive may be undergoing such as RAID migration, stripesize migration, capacity expansion etc.

JSON type:

Integer

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.

"VolumeUniqueIdentifier"

This property is a member of HpSmartStorageLogicalDrive

An identifier (typically SCSI Inquiry based such as Inquiry VPD Page 0x83 NAA 64 identifier) used to uniquely identify this volume.

JSON type:

String

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.

"HpSmartStorageStorageEnclosure" Resource Type

Resource Instances

/rest/v1/Systems/{item}/SmartStorage/ArrayControllers/{item}/StorageEnclosures/{item}

See Resource Map for more details.

HpSmartStorageStorageEnclosure

"HpSmartStorageStorageEnclosure" defines the following properties:

"DoorLockLED"

This property is a member of HpSmartStorageStorageEnclosure

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.

JSON type:

String containing one of the following supported values:

""
"Unknown"
"Lit"
"Off"

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.

"DriveBayCount"

This property is a member of HpSmartStorageStorageEnclosure

Number of drive bays supported within the storage enclosure

JSON type:

Integer

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.

"EnclosureLogicalID"

This property is a member of HpSmartStorageStorageEnclosure

Unique ID for the storage enclosure

JSON type:

String

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.

"FaultLED"

This property is a member of HpSmartStorageStorageEnclosure

The state of the Fault LED.

JSON type:

String containing one of the following supported values:

""
"Unknown"
"Lit"
"Off"

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.

"FirmwareVersion/Current/VersionString"

This property is a member of HpSmartStorageStorageEnclosure

This string represents the version of the firmware image.

JSON type:

String

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.

"IndicatorLED"

This property is a member of HpSmartStorageStorageEnclosure

The state of the indicator LED.

JSON type:

String containing one of the following supported values:

""
"Unknown"
"Lit"
"Blinking"
"Off"

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.

"Location"

This property is a member of HpSmartStorageStorageEnclosure

Location identifier

JSON type:

String

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.

"LocationFormat"

This property is a member of HpSmartStorageStorageEnclosure

Format for Location Identifier

JSON type:

String containing one of the following supported values:

"Controller:Box"
"SwitchPort:Box"
"SwitchPort:SwitchBay"

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.

"Manufacturer"

This property is a member of HpSmartStorageStorageEnclosure

The manufacturer of the storage enclosure

JSON type:

String

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.

"Model"

This property is a member of HpSmartStorageStorageEnclosure

The model string for the storage enclosure

JSON type:

String

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.

"PartNumber"

This property is a member of HpSmartStorageStorageEnclosure

Part number of this storage enclosure

JSON type:

String

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.

"SKU"

This property is a member of HpSmartStorageStorageEnclosure

SKU for the storage enclosure

JSON type:

String

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.

"SerialNumber"

This property is a member of HpSmartStorageStorageEnclosure

The serial number for this storage enclosure

JSON type:

String

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.

"Status/Health"

This property is a member of HpSmartStorageStorageEnclosure

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

JSON type:

String containing one of the following supported values:

""
"OK"
"Warning"
"Critical"

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.

"Status/HealthRollUp"

This property is a member of HpSmartStorageStorageEnclosure

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

JSON type:

String containing one of the following supported values:

""
"OK"
"Warning"
"Critical"

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.

"Status/HealthRollup"

This property is a member of HpSmartStorageStorageEnclosure

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

JSON type:

String containing one of the following supported values:

""
"OK"
"Warning"
"Critical"

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.

"Status/State"

This property is a member of HpSmartStorageStorageEnclosure

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

JSON type:

String containing one of the following supported values:

""
"Enabled"
"Disabled"
"Offline"
"InTest"
"Starting"
"Absent"

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.

"SubEnclosureLocation"

This property is a member of HpSmartStorageStorageEnclosure

Location within the chassis if this storage enclosure is part of a larger chassis hosting multiple storage enclosures

JSON type:

String

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.

"HpiLOActiveHealthSystem" Resource Type

Resource Instances

/rest/v1/Managers/{item}/ActiveHealthSystem

See Resource Map for more details.

"HpiLOActiveHealthSystem" defines the following properties:

"AHSEnabled"

This property is a member of HpiLOActiveHealthSystem

Determines whether HP Active Health System logging is enabled or disabled.

JSON type:

Boolean ('true' or 'false')

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

PATCH Example

HTTP PATCH to resource with request JSON:

{"AHSEnabled": true}

GET	Rendered if supported by the implementation or omitted if not.

POST Action "ClearLog"

Example

HTTP POST to resource with request JSON:

{ "Action": "ClearLog"}

"HpiLODateTime" Resource Type

Resource Instances

/rest/v1/Managers/{item}/DateTime

See Resource Map for more details.

The management processor date and time.

"HpiLODateTime" defines the following properties:

"ConfigurationSettings"

This property is a member of HpiLODateTime

The state of the currently displayed configuration settings.

JSON type:

String containing one of the following supported values:

"Current"
"SomePendingReset"

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.

"DateTime"

This property is a member of HpiLODateTime

The date and time used by management processor.

JSON type:

String

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.

"PropagateTimeToHost"

This property is a member of HpiLODateTime

Determines whether the server time is synchronized with the management processor time during the first POST after AC power is applied.

JSON type:

Boolean ('true' or 'false')

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

PATCH Example

HTTP PATCH to resource with request JSON:

{"PropagateTimeToHost": true}

The property "PropagateTimeToHost" on resource type HpiLODateTime may not support PATCH of all values and may result in an HTTP 400 error with response of Type ExtendedError. Multiple properties may be included in a single HTTP PATCH operation as long as the request is properly formatted JSON. To address an array entry other than the first, insert nulls as placeholders on skipped array entries.

"TimeZone/Index"

This property is a member of HpiLODateTime

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.

JSON type:

Integer

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

PATCH Example

HTTP PATCH to resource with request JSON:

{"TimeZone": {"Index": <integer-value>}}

GET	Rendered if supported by the implementation or omitted if not.

"HpiLOEmbeddedMedia" Resource Type

Resource Instances

/rest/v1/Managers/{item}/EmbeddedMedia

See Resource Map for more details.

"HpiLOEmbeddedMedia" defines the following properties:

"Controller/Firmware/Current/VersionString"

This property is a member of HpiLOEmbeddedMedia

The current version of the embedded media controller.

JSON type:

String

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.

"Controller/Status/Health"

This property is a member of HpiLOEmbeddedMedia

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

JSON type:

String containing one of the following supported values:

""
"OK"
"Warning"
"Critical"

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.

"Controller/Status/HealthRollUp"

This property is a member of HpiLOEmbeddedMedia

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

JSON type:

String containing one of the following supported values:

""
"OK"
"Warning"
"Critical"

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.

"Controller/Status/HealthRollup"

This property is a member of HpiLOEmbeddedMedia

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

JSON type:

String containing one of the following supported values:

""
"OK"
"Warning"
"Critical"

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.

"Controller/Status/State"

This property is a member of HpiLOEmbeddedMedia

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

JSON type:

String containing one of the following supported values:

""
"Enabled"
"Disabled"
"Offline"
"InTest"
"Starting"
"Absent"

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.

"SDCard/HpCertified"

This property is a member of HpiLOEmbeddedMedia

True if this is an HP-certified SD card.

JSON type:

Boolean ('true' or 'false')

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.

"SDCard/LBACount"

This property is a member of HpiLOEmbeddedMedia

The LBA count.

JSON type:

Integer greater than or equal to 0.

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.

"SDCard/SizeString"

This property is a member of HpiLOEmbeddedMedia

The size of the SD card present in the server, in a readable format.

JSON type:

String

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.

"SDCard/Status/Health"

This property is a member of HpiLOEmbeddedMedia

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

JSON type:

String containing one of the following supported values:

""
"OK"
"Warning"
"Critical"

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.

"SDCard/Status/HealthRollUp"

This property is a member of HpiLOEmbeddedMedia

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

JSON type:

String containing one of the following supported values:

""
"OK"
"Warning"
"Critical"

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.

"SDCard/Status/HealthRollup"

This property is a member of HpiLOEmbeddedMedia

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

JSON type:

String containing one of the following supported values:

""
"OK"
"Warning"
"Critical"

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.

"SDCard/Status/State"

This property is a member of HpiLOEmbeddedMedia

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

JSON type:

String containing one of the following supported values:

""
"Enabled"
"Disabled"
"Offline"
"InTest"
"Starting"
"Absent"

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.

"SDCard/WriteCount"

This property is a member of HpiLOEmbeddedMedia

The number of writes on the SD card. Rendered only if this is an HP-certified SD card.

JSON type:

Integer greater than or equal to 0.

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.

"HpiLOFederatedGroupCapping" Resource Type

Resource Instances

/rest/v1/Chassis/{item}/Power/FederatedGroupCapping

See Resource Map for more details.

GET	Rendered if supported by the implementation or omitted if not.

"HpiLOFederationGroup" Resource Type

Resource Instances

/rest/v1/Managers/{item}/FederationGroups/{item}

See Resource Map for more details.

"HpiLOFederationGroup" defines the following properties:

"Key"

This property is a member of HpiLOFederationGroup

The password used by the Federation Group.

JSON type:

String

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

PATCH Example

HTTP PATCH to resource with request JSON:

{"Key": "<string-value>"}

The property "Key" on resource type HpiLOFederationGroup may not support PATCH of all values and may result in an HTTP 400 error with response of Type ExtendedError. Multiple properties may be included in a single HTTP PATCH operation as long as the request is properly formatted JSON. To address an array entry other than the first, insert nulls as placeholders on skipped array entries.

"Privileges/LoginPriv"

This property is a member of HpiLOFederationGroup

JSON type:

Boolean ('true' or 'false')

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

PATCH Example

HTTP PATCH to resource with request JSON:

{"Privileges": {"LoginPriv": true}}

The property "Privileges/LoginPriv" on resource type HpiLOFederationGroup may not support PATCH of all values and may result in an HTTP 400 error with response of Type ExtendedError. Multiple properties may be included in a single HTTP PATCH operation as long as the request is properly formatted JSON. To address an array entry other than the first, insert nulls as placeholders on skipped array entries.

"Privileges/RemoteConsolePriv"

This property is a member of HpiLOFederationGroup

Remote console privileges.

JSON type:

Boolean ('true' or 'false')

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

PATCH Example

HTTP PATCH to resource with request JSON:

{"Privileges": {"RemoteConsolePriv": true}}

The property "Privileges/RemoteConsolePriv" on resource type HpiLOFederationGroup may not support PATCH of all values and may result in an HTTP 400 error with response of Type ExtendedError. Multiple properties may be included in a single HTTP PATCH operation as long as the request is properly formatted JSON. To address an array entry other than the first, insert nulls as placeholders on skipped array entries.

"Privileges/UserConfigPriv"

This property is a member of HpiLOFederationGroup

User configuration privileges.

JSON type:

Boolean ('true' or 'false')

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

PATCH Example

HTTP PATCH to resource with request JSON:

{"Privileges": {"UserConfigPriv": true}}

The property "Privileges/UserConfigPriv" on resource type HpiLOFederationGroup may not support PATCH of all values and may result in an HTTP 400 error with response of Type ExtendedError. Multiple properties may be included in a single HTTP PATCH operation as long as the request is properly formatted JSON. To address an array entry other than the first, insert nulls as placeholders on skipped array entries.

"Privileges/VirtualMediaPriv"

This property is a member of HpiLOFederationGroup

Virtual media privileges.

JSON type:

Boolean ('true' or 'false')

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

PATCH Example

HTTP PATCH to resource with request JSON:

{"Privileges": {"VirtualMediaPriv": true}}

The property "Privileges/VirtualMediaPriv" on resource type HpiLOFederationGroup may not support PATCH of all values and may result in an HTTP 400 error with response of Type ExtendedError. Multiple properties may be included in a single HTTP PATCH operation as long as the request is properly formatted JSON. To address an array entry other than the first, insert nulls as placeholders on skipped array entries.

"Privileges/VirtualPowerAndResetPriv"

This property is a member of HpiLOFederationGroup

Virtual power and reset privileges.

JSON type:

Boolean ('true' or 'false')

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

PATCH Example

HTTP PATCH to resource with request JSON:

{"Privileges": {"VirtualPowerAndResetPriv": true}}

The property "Privileges/VirtualPowerAndResetPriv" on resource type HpiLOFederationGroup may not support PATCH of all values and may result in an HTTP 400 error with response of Type ExtendedError. Multiple properties may be included in a single HTTP PATCH operation as long as the request is properly formatted JSON. To address an array entry other than the first, insert nulls as placeholders on skipped array entries.

"Privileges/iLOConfigPriv"

This property is a member of HpiLOFederationGroup

The management processor configuration privileges.

JSON type:

Boolean ('true' or 'false')

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

PATCH Example

HTTP PATCH to resource with request JSON:

{"Privileges": {"iLOConfigPriv": true}}

The property "Privileges/iLOConfigPriv" on resource type HpiLOFederationGroup may not support PATCH of all values and may result in an HTTP 400 error with response of Type ExtendedError. Multiple properties may be included in a single HTTP PATCH operation as long as the request is properly formatted JSON. To address an array entry other than the first, insert nulls as placeholders on skipped array entries.

"HpiLOFederationPeers" Resource Type

Resource Instances

/rest/v1/Managers/{item}/FederationPeers/{item}

See Resource Map for more details.

GET	Rendered if supported by the implementation or omitted if not.

"HpiLOFirmwareUpdate" Resource Type

Resource Instances

/rest/v1/Managers/{item}/UpdateService

See Resource Map for more details.

GET	Rendered if supported by the implementation or omitted if not.

"Flags"

This property is a member of HpiLOFirmwareUpdate

Other flags.

JSON type:

String containing one of the following supported values:

"NONE"
"RESET_ILO"
"REQUEST_SYSTEM_COLD_BOOT"
"REQUEST_SYSTEM_WARM_BOOT"
"DEFERRED_AUX_PWR_CYCLE"

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.

"ImageSizeInBytes"

This property is a member of HpiLOFirmwareUpdate

The size of the firmware image (including any signatures) in bytes.

JSON type:

Integer

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.

"ImageType"

This property is a member of HpiLOFirmwareUpdate

Firmware flash image type.

JSON type:

String containing one of the following supported values:

"NO_DEVICE"
"ILO_DEVICE"
"ILO_DEVICE_FIRMWARE"
"ILO_DEVICE_LANGPK"
"ILO_DEVICE_DEBUGGER"
"BIOS_DEVICE"
"SCD_DEVICE"
"CPLD_DEVICE"
"CARB_DEVICE"
"PM_DEVICE"
"UNKNOWN"

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.

"ProgressPercent"

This property is a member of HpiLOFirmwareUpdate

Firmware flash progress.

JSON type:

Integer greater than or equal to 0.

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.

"State"

This property is a member of HpiLOFirmwareUpdate

Current state of the firmware flash.

JSON type:

String containing one of the following supported values:

"IDLE"
"UPLOADING"
"PROGRESSING"
"COMPLETED"
"ERROR"

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.

"links/UpdateUri/extref"

This property is a member of HpiLOFirmwareUpdate

The URI of an external resource.

JSON type:

String

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.

POST Action "InstallFromURI"

Parameter "FirmwareURI"

"FirmwareURI" must be one of the following value(s):

"<uri>"

Parameter "TPMOverrideFlag"

"TPMOverrideFlag" must be one of the following value(s):

true

false

Example

HTTP POST to resource with request JSON:

{ "Action": "InstallFromURI", "FirmwareURI": "<uri>", "TPMOverrideFlag": true}

"HpiLOLicense" Resource Type

Resource Instances

/rest/v1/Managers/{item}/LicenseService/{item}

See Resource Map for more details.

GET	Rendered if supported by the implementation or omitted if not.

"LicenseType"

This property is a member of HpiLOLicense

The type of license installed on this management processor.

JSON type:

String containing one of the following supported values:

"Unlicensed"
"Evaluation"
"Perpetual"
"Subscription"
"Internal"
"Duration"
"Expired"

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.

"HpiLOResourceDirectory" Resource Type

Resource Instances

/rest/v1/ResourceDirectory

See Resource Map for more details.

"HpiLOResourceDirectory" defines the following properties:

"Instances[]/ETag"

This property is a member of HpiLOResourceDirectory

This is the last known etag of the resource. The property is omitted if not known.

JSON type:

String

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.

"Instances[]/MemberType"

This property is a member of HpiLOResourceDirectory

This property has the type of members for collection resources.

JSON type:

String

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.

"HpiLOSSO" Resource Type

Resource Instances

/rest/v1/Managers/{item}/SecurityService/SSO

See Resource Map for more details.

This is the schema definition for the HP SSO Trusted Server.

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.

"ManagerTrustedCertificates[]/Status"

This property is a member of HpiLOSSO

JSON type:

String containing one of the following supported values:

""
"OK"
"Degraded"
"Failed"

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.

"SSOsettings/AdminPrivilege/LoginPriv"

This property is a member of HpiLOSSO

JSON type:

Boolean ('true' or 'false')

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

PATCH Example

HTTP PATCH to resource with request JSON:

{"SSOsettings": {"AdminPrivilege": {"LoginPriv": true}}}

The property "SSOsettings/AdminPrivilege/LoginPriv" on resource type HpiLOSSO may not support PATCH of all values and may result in an HTTP 400 error with response of Type ExtendedError. Multiple properties may be included in a single HTTP PATCH operation as long as the request is properly formatted JSON. To address an array entry other than the first, insert nulls as placeholders on skipped array entries.

"SSOsettings/AdminPrivilege/PowerandResetPriv"

This property is a member of HpiLOSSO

Power and Reset Privileges.

JSON type:

Boolean ('true' or 'false')

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

PATCH Example

HTTP PATCH to resource with request JSON:

{"SSOsettings": {"AdminPrivilege": {"PowerandResetPriv": true}}}

The property "SSOsettings/AdminPrivilege/PowerandResetPriv" on resource type HpiLOSSO may not support PATCH of all values and may result in an HTTP 400 error with response of Type ExtendedError. Multiple properties may be included in a single HTTP PATCH operation as long as the request is properly formatted JSON. To address an array entry other than the first, insert nulls as placeholders on skipped array entries.

"SSOsettings/AdminPrivilege/RemoteConsolePriv"

This property is a member of HpiLOSSO

Remote Console Privileges.

JSON type:

Boolean ('true' or 'false')

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

PATCH Example

HTTP PATCH to resource with request JSON:

{"SSOsettings": {"AdminPrivilege": {"RemoteConsolePriv": true}}}

The property "SSOsettings/AdminPrivilege/RemoteConsolePriv" on resource type HpiLOSSO may not support PATCH of all values and may result in an HTTP 400 error with response of Type ExtendedError. Multiple properties may be included in a single HTTP PATCH operation as long as the request is properly formatted JSON. To address an array entry other than the first, insert nulls as placeholders on skipped array entries.

"SSOsettings/AdminPrivilege/UserConfigPriv"

This property is a member of HpiLOSSO

User Configuration Privileges.

JSON type:

Boolean ('true' or 'false')

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

PATCH Example

HTTP PATCH to resource with request JSON:

{"SSOsettings": {"AdminPrivilege": {"UserConfigPriv": true}}}

The property "SSOsettings/AdminPrivilege/UserConfigPriv" on resource type HpiLOSSO may not support PATCH of all values and may result in an HTTP 400 error with response of Type ExtendedError. Multiple properties may be included in a single HTTP PATCH operation as long as the request is properly formatted JSON. To address an array entry other than the first, insert nulls as placeholders on skipped array entries.

"SSOsettings/AdminPrivilege/VirtualMediaPriv"

This property is a member of HpiLOSSO

Power and Reset Privileges.

JSON type:

Boolean ('true' or 'false')

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

PATCH Example

HTTP PATCH to resource with request JSON:

{"SSOsettings": {"AdminPrivilege": {"VirtualMediaPriv": true}}}

The property "SSOsettings/AdminPrivilege/VirtualMediaPriv" on resource type HpiLOSSO may not support PATCH of all values and may result in an HTTP 400 error with response of Type ExtendedError. Multiple properties may be included in a single HTTP PATCH operation as long as the request is properly formatted JSON. To address an array entry other than the first, insert nulls as placeholders on skipped array entries.

"SSOsettings/AdminPrivilege/iLOConfigPriv"

This property is a member of HpiLOSSO

iLO Configuration Privileges.

JSON type:

Boolean ('true' or 'false')

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

PATCH Example

HTTP PATCH to resource with request JSON:

{"SSOsettings": {"AdminPrivilege": {"iLOConfigPriv": true}}}

The property "SSOsettings/AdminPrivilege/iLOConfigPriv" on resource type HpiLOSSO may not support PATCH of all values and may result in an HTTP 400 error with response of Type ExtendedError. Multiple properties may be included in a single HTTP PATCH operation as long as the request is properly formatted JSON. To address an array entry other than the first, insert nulls as placeholders on skipped array entries.

"SSOsettings/OperatorPrivilege/LoginPriv"

This property is a member of HpiLOSSO

JSON type:

Boolean ('true' or 'false')

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

PATCH Example

HTTP PATCH to resource with request JSON:

{"SSOsettings": {"OperatorPrivilege": {"LoginPriv": true}}}

The property "SSOsettings/OperatorPrivilege/LoginPriv" on resource type HpiLOSSO may not support PATCH of all values and may result in an HTTP 400 error with response of Type ExtendedError. Multiple properties may be included in a single HTTP PATCH operation as long as the request is properly formatted JSON. To address an array entry other than the first, insert nulls as placeholders on skipped array entries.

"SSOsettings/OperatorPrivilege/PowerandResetPriv"

This property is a member of HpiLOSSO

Power and Reset Privileges.

JSON type:

Boolean ('true' or 'false')

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

PATCH Example

HTTP PATCH to resource with request JSON:

{"SSOsettings": {"OperatorPrivilege": {"PowerandResetPriv": true}}}

The property "SSOsettings/OperatorPrivilege/PowerandResetPriv" on resource type HpiLOSSO may not support PATCH of all values and may result in an HTTP 400 error with response of Type ExtendedError. Multiple properties may be included in a single HTTP PATCH operation as long as the request is properly formatted JSON. To address an array entry other than the first, insert nulls as placeholders on skipped array entries.

"SSOsettings/OperatorPrivilege/RemoteConsolePriv"

This property is a member of HpiLOSSO

Remote Console Privileges.

JSON type:

Boolean ('true' or 'false')

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

PATCH Example

HTTP PATCH to resource with request JSON:

{"SSOsettings": {"OperatorPrivilege": {"RemoteConsolePriv": true}}}

The property "SSOsettings/OperatorPrivilege/RemoteConsolePriv" on resource type HpiLOSSO may not support PATCH of all values and may result in an HTTP 400 error with response of Type ExtendedError. Multiple properties may be included in a single HTTP PATCH operation as long as the request is properly formatted JSON. To address an array entry other than the first, insert nulls as placeholders on skipped array entries.

"SSOsettings/OperatorPrivilege/UserConfigPriv"

This property is a member of HpiLOSSO

User Configuration Privileges.

JSON type:

Boolean ('true' or 'false')

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

PATCH Example

HTTP PATCH to resource with request JSON:

{"SSOsettings": {"OperatorPrivilege": {"UserConfigPriv": true}}}

The property "SSOsettings/OperatorPrivilege/UserConfigPriv" on resource type HpiLOSSO may not support PATCH of all values and may result in an HTTP 400 error with response of Type ExtendedError. Multiple properties may be included in a single HTTP PATCH operation as long as the request is properly formatted JSON. To address an array entry other than the first, insert nulls as placeholders on skipped array entries.

"SSOsettings/OperatorPrivilege/VirtualMediaPriv"

This property is a member of HpiLOSSO

Virtual Media Privileges.

JSON type:

Boolean ('true' or 'false')

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

PATCH Example

HTTP PATCH to resource with request JSON:

{"SSOsettings": {"OperatorPrivilege": {"VirtualMediaPriv": true}}}

The property "SSOsettings/OperatorPrivilege/VirtualMediaPriv" on resource type HpiLOSSO may not support PATCH of all values and may result in an HTTP 400 error with response of Type ExtendedError. Multiple properties may be included in a single HTTP PATCH operation as long as the request is properly formatted JSON. To address an array entry other than the first, insert nulls as placeholders on skipped array entries.

"SSOsettings/OperatorPrivilege/iLOConfigPriv"

This property is a member of HpiLOSSO

iLO Configuration Privileges.

JSON type:

Boolean ('true' or 'false')

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

PATCH Example

HTTP PATCH to resource with request JSON:

{"SSOsettings": {"OperatorPrivilege": {"iLOConfigPriv": true}}}

The property "SSOsettings/OperatorPrivilege/iLOConfigPriv" on resource type HpiLOSSO may not support PATCH of all values and may result in an HTTP 400 error with response of Type ExtendedError. Multiple properties may be included in a single HTTP PATCH operation as long as the request is properly formatted JSON. To address an array entry other than the first, insert nulls as placeholders on skipped array entries.

"SSOsettings/SSOTrustMode"

This property is a member of HpiLOSSO

Represents the SSO Trust Mode.

JSON type:

String containing one of the following supported values:

"TrustNone"
"TrustAll"
"TrustbyName"
"TrustbyCert"

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

PATCH Example

HTTP PATCH to resource with request JSON:

{"SSOsettings": {"SSOTrustMode": "TrustbyName"}}

The property "SSOsettings/SSOTrustMode" on resource type HpiLOSSO may not support PATCH of all values and may result in an HTTP 400 error with response of Type ExtendedError. Multiple properties may be included in a single HTTP PATCH operation as long as the request is properly formatted JSON. To address an array entry other than the first, insert nulls as placeholders on skipped array entries.

"SSOsettings/UserPrivilege/LoginPriv"

This property is a member of HpiLOSSO

JSON type:

Boolean ('true' or 'false')

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

PATCH Example

HTTP PATCH to resource with request JSON:

{"SSOsettings": {"UserPrivilege": {"LoginPriv": true}}}

The property "SSOsettings/UserPrivilege/LoginPriv" on resource type HpiLOSSO may not support PATCH of all values and may result in an HTTP 400 error with response of Type ExtendedError. Multiple properties may be included in a single HTTP PATCH operation as long as the request is properly formatted JSON. To address an array entry other than the first, insert nulls as placeholders on skipped array entries.

"SSOsettings/UserPrivilege/PowerandResetPriv"

This property is a member of HpiLOSSO

Power and Reset Privileges.

JSON type:

Boolean ('true' or 'false')

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

PATCH Example

HTTP PATCH to resource with request JSON:

{"SSOsettings": {"UserPrivilege": {"PowerandResetPriv": true}}}

The property "SSOsettings/UserPrivilege/PowerandResetPriv" on resource type HpiLOSSO may not support PATCH of all values and may result in an HTTP 400 error with response of Type ExtendedError. Multiple properties may be included in a single HTTP PATCH operation as long as the request is properly formatted JSON. To address an array entry other than the first, insert nulls as placeholders on skipped array entries.

"SSOsettings/UserPrivilege/RemoteConsolePriv"

This property is a member of HpiLOSSO

Remote Console Privileges.

JSON type:

Boolean ('true' or 'false')

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

PATCH Example

HTTP PATCH to resource with request JSON:

{"SSOsettings": {"UserPrivilege": {"RemoteConsolePriv": true}}}

The property "SSOsettings/UserPrivilege/RemoteConsolePriv" on resource type HpiLOSSO may not support PATCH of all values and may result in an HTTP 400 error with response of Type ExtendedError. Multiple properties may be included in a single HTTP PATCH operation as long as the request is properly formatted JSON. To address an array entry other than the first, insert nulls as placeholders on skipped array entries.

"SSOsettings/UserPrivilege/UserConfigPriv"

This property is a member of HpiLOSSO

User Configuration Privileges.

JSON type:

Boolean ('true' or 'false')

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

PATCH Example

HTTP PATCH to resource with request JSON:

{"SSOsettings": {"UserPrivilege": {"UserConfigPriv": true}}}

The property "SSOsettings/UserPrivilege/UserConfigPriv" on resource type HpiLOSSO may not support PATCH of all values and may result in an HTTP 400 error with response of Type ExtendedError. Multiple properties may be included in a single HTTP PATCH operation as long as the request is properly formatted JSON. To address an array entry other than the first, insert nulls as placeholders on skipped array entries.

"SSOsettings/UserPrivilege/VirtualMediaPriv"

This property is a member of HpiLOSSO

Virtual Media Privileges.

JSON type:

Boolean ('true' or 'false')

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

PATCH Example

HTTP PATCH to resource with request JSON:

{"SSOsettings": {"UserPrivilege": {"VirtualMediaPriv": true}}}

The property "SSOsettings/UserPrivilege/VirtualMediaPriv" on resource type HpiLOSSO may not support PATCH of all values and may result in an HTTP 400 error with response of Type ExtendedError. Multiple properties may be included in a single HTTP PATCH operation as long as the request is properly formatted JSON. To address an array entry other than the first, insert nulls as placeholders on skipped array entries.

"SSOsettings/UserPrivilege/iLOConfigPriv"

This property is a member of HpiLOSSO

iLO Configuration Privileges.

JSON type:

Boolean ('true' or 'false')

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

PATCH Example

HTTP PATCH to resource with request JSON:

{"SSOsettings": {"UserPrivilege": {"iLOConfigPriv": true}}}

The property "SSOsettings/UserPrivilege/iLOConfigPriv" on resource type HpiLOSSO may not support PATCH of all values and may result in an HTTP 400 error with response of Type ExtendedError. Multiple properties may be included in a single HTTP PATCH operation as long as the request is properly formatted JSON. To address an array entry other than the first, insert nulls as placeholders on skipped array entries.

POST Action "ImportCertificate"

Import the HP SSO Certificate.

Parameter "CertType"

"CertType" must be one of the following value(s):

Delete SSO record by record number.

Parameter "RecordNumber"

"RecordNumber" must be one of the following value(s):

Example

HTTP POST to resource with request JSON:

{ "Action": "DeleteSSORecordbyNumber", "RecordNumber": <integer>}

"HpiSCSISoftwareInitiator" Resource Type

Resource Instances

/rest/v1/Systems/{item}/Bios/iScsi

/rest/v1/Systems/{item}/Bios/iScsi/Settings

See Resource Map for more details.

The schema definition of UEFI iSCSI Software Initiator boot configuration.

GET	Rendered if supported by the implementation or omitted if not.

"SettingsResult/definitions/SettingsResult/Messages[]/Severity"

This property is a member of HpiSCSISoftwareInitiator

This is the severity of the errors.

JSON type:

String containing one of the following supported values:

"OK"
"Warning"
"Critical"

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.

"SettingsResult/definitions/SettingsResult/Operation"

This property is a member of HpiSCSISoftwareInitiator

Details about the results of applying the settings.

JSON type:

String containing one of the following supported values:

"SettingsApply"

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.

"SettingsResult/definitions/SettingsResult/Time"

This property is a member of HpiSCSISoftwareInitiator

Time at which the settings were applied.

JSON type:

String

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.

"iSCSIBootSources[]/StructuredBootString"

This property is a member of HpiSCSISoftwareInitiator

Identifies this iSCSI UEFI boot option within the server.

JSON type:

String

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.

"iSCSIBootSources[]/UEFIDevicePath"

This property is a member of HpiSCSISoftwareInitiator

Standardized text representation of the UEFI device path for this boot option, in UTF-8 format.

JSON type:

String

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.

"iSCSIBootSources[]/iSCSIAuthenticationMethod"

This property is a member of HpiSCSISoftwareInitiator

The iSCSI connection authentication method.

JSON type:

String containing one of the following supported values:

"None"
"CHAP"

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.

"iSCSIBootSources[]/iSCSIBootAttemptInstance"

This property is a member of HpiSCSISoftwareInitiator

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

JSON type:

Integer from 0 to 4.

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.

"iSCSIBootSources[]/iSCSIBootAttemptName"

This property is a member of HpiSCSISoftwareInitiator

Human readable descriptive name for this iSCSI boot attempt configuration

JSON type:

String

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.

"iSCSIBootSources[]/iSCSIBootEnable"

This property is a member of HpiSCSISoftwareInitiator

Enables or Disables iSCSI Boot for a selected iSCSI boot attempt.

JSON type:

String containing one of the following supported values:

"Disabled"
"Enabled"
"EnabledMpio"

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.

"iSCSIBootSources[]/iSCSIBootLUN"

This property is a member of HpiSCSISoftwareInitiator

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

JSON type:

String

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.

"iSCSIBootSources[]/iSCSIChapSecret"

This property is a member of HpiSCSISoftwareInitiator

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.

JSON type:

String

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.

"iSCSIBootSources[]/iSCSIChapType"

This property is a member of HpiSCSISoftwareInitiator

The CHAP authentication type. This is applicable only when the Authentication Method is set to CHAP.

JSON type:

String containing one of the following supported values:

"OneWay"
"Mutual"

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.

"iSCSIBootSources[]/iSCSIChapUsername"

This property is a member of HpiSCSISoftwareInitiator

The password needed for CHAP authentication. This is applicable only when the Authentication Method is set to CHAP.

JSON type:

String

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.

"iSCSIBootSources[]/iSCSIConnectRetry"

This property is a member of HpiSCSISoftwareInitiator

The number of times to retry the iSCSI connection. Zero means no retries.

JSON type:

Integer from 0 to 16.

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.

"iSCSIBootSources[]/iSCSIConnectTimeoutMS"

This property is a member of HpiSCSISoftwareInitiator

The iSCSI connection timeout value in milliseconds.

JSON type:

Integer from 100 to 20000.

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.

"iSCSIBootSources[]/iSCSIInitiatorGateway"

This property is a member of HpiSCSISoftwareInitiator

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.

JSON type:

String

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.

"iSCSIBootSources[]/iSCSIInitiatorInfoViaDHCP"

This property is a member of HpiSCSISoftwareInitiator

If enabled, the iSCSI Initiator information is configured from DHCP. Otherwise, the iSCSI initiator information must be statically configured.

JSON type:

Boolean ('true' or 'false')

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.

"iSCSIBootSources[]/iSCSIInitiatorIpAddress"

This property is a member of HpiSCSISoftwareInitiator

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.

JSON type:

String

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.

"iSCSIBootSources[]/iSCSIInitiatorNetmask"

This property is a member of HpiSCSISoftwareInitiator

The subnet mask of the iSCSI Initiator, if not configured via DHCP. The address must be an IPv4.

JSON type:

String

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.

"iSCSIBootSources[]/iSCSIIpAddressType"

This property is a member of HpiSCSISoftwareInitiator

The iSCSI IP Address type. If set to Auto, IPv4 will be attempted first, followed by IPv6.

JSON type:

String containing one of the following supported values:

"IPv4"
"IPv6"
"Auto"

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.

"iSCSIBootSources[]/iSCSINicSource"

This property is a member of HpiSCSISoftwareInitiator

A BIOS Attribute that describes this selected NIC instance. This must match one of the possible values listed in the iSCSINicSources array.

JSON type:

String

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.

"iSCSIBootSources[]/iSCSIReverseChapSecret"

This property is a member of HpiSCSISoftwareInitiator

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.

JSON type:

String

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.

"iSCSIBootSources[]/iSCSIReverseChapUsername"

This property is a member of HpiSCSISoftwareInitiator

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.

JSON type:

String

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.

"iSCSIBootSources[]/iSCSITargetInfoViaDHCP"

This property is a member of HpiSCSISoftwareInitiator

If enabled, the iSCSI target information are configured from DHCP. Otherwise, the iSCSI target information must be statically configured.

JSON type:

Boolean ('true' or 'false')

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.

"iSCSIBootSources[]/iSCSITargetIpAddress"

This property is a member of HpiSCSISoftwareInitiator

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.

JSON type:

String

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.

"iSCSIBootSources[]/iSCSITargetName"

This property is a member of HpiSCSISoftwareInitiator

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

JSON type:

String

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.

"iSCSIBootSources[]/iSCSITargetTcpPort"

This property is a member of HpiSCSISoftwareInitiator

The iSCSI Target TCP Port number, if not obtained from DHCP.

JSON type:

Integer from 0 to 65535.

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.

"iSCSIInitiatorName"

This property is a member of HpiSCSISoftwareInitiator

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

JSON type:

String

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.

"LogEntry" Resource Type

Resource Instances

/rest/v1/Managers/{item}/LogServices/IEL/Entries/{item}

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

See Resource Map for more details.

"LogEntry" defines the following properties:

"Created"

This property is a member of LogEntry

The date and time when the log entry was created, for example, 2014-04-15T00:38:00Z.

JSON type:

String

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.

"EntryType"

This property is a member of LogEntry

The log entry type.

JSON type:

String containing one of the following supported values:

"Oem"

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.

"Message"

This property is a member of LogEntry

The log entry details.

JSON type:

String

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.

"Number"

This property is a member of LogEntry

The number of duplicate log entries, with the possible exception of timestamps, that are not in the collection.

JSON type:

Integer

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.

"Oem/Hp/Class"

This property is a member of LogEntry

The IML event class.

JSON type:

Integer

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.

"Oem/Hp/Code"

This property is a member of LogEntry

The IML event code.

JSON type:

Integer

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.

"Oem/Hp/EventNumber"

This property is a member of LogEntry

The event log identification number. Events are numbered in the order in which they are generated.

JSON type:

Integer

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.

"Oem/Hp/Repaired"

This property is a member of LogEntry

The repaired status of the IML event.

JSON type:

Boolean ('true' or 'false')

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

PATCH Example

HTTP PATCH to resource with request JSON:

{"Oem": {"Hp": {"Repaired": true}}}

The property "Oem/Hp/Repaired" on resource type LogEntry may not support PATCH of all values and may result in an HTTP 400 error with response of Type ExtendedError. Multiple properties may be included in a single HTTP PATCH operation as long as the request is properly formatted JSON. To address an array entry other than the first, insert nulls as placeholders on skipped array entries.

"Oem/Hp/Updated"

This property is a member of LogEntry

The date and time of the latest log entry update, for example, 2014-04-15T00:38:00Z.

JSON type:

String

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.

"OemRecordFormat"

This property is a member of LogEntry

The format of an OEM record.

JSON type:

String containing one of the following supported values:

"Hp-IML"
"Hp-iLOEventLog"

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.

"RecordId"

This property is a member of LogEntry

The log entry ID.

JSON type:

Integer greater than or equal to 0.

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.

"Severity"

This property is a member of LogEntry

The log entry severity.

JSON type:

String containing one of the following supported values:

"OK"
"Warning"
"Critical"

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.

"LogService" Resource Type

Resource Instances

/rest/v1/Managers/{item}/LogServices/IEL

/rest/v1/Systems/{item}/LogServices/IML

See Resource Map for more details.

"LogService" defines the following properties:

"MaxNumberOfRecords"

This property is a member of LogService

The maximum number of log entries.

JSON type:

Integer greater than or equal to 0.

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.

"OverWritePolicy"

This property is a member of LogService

When the log is full, the overwrite policy is enforced.

JSON type:

String containing one of the following supported values:

"Unknown"
"WrapsWhenFull"
"NeverOverwrites"

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.

POST Action "ClearLog"

Example

HTTP POST to resource with request JSON:

{ "Action": "ClearLog"}

"Manager" Resource Type

Resource Instances

/rest/v1/Managers/{item}

See Resource Map for more details.

This is the schema definition for a manager. Examples of managers are BMCs, Enclosure Managers, Management Controllers and other subsystems assigned manageability functions.

"Manager" defines the following properties:

"CommandShell/Enabled"

This property is a member of Manager

Indicates if the Command Shell service is enabled for this manager.

JSON type:

Boolean ('true' or 'false')

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

PATCH Example

HTTP PATCH to resource with request JSON:

{"CommandShell": {"Enabled": true}}

The property "CommandShell/Enabled" on resource type Manager may not support PATCH of all values and may result in an HTTP 400 error with response of Type ExtendedError. Multiple properties may be included in a single HTTP PATCH operation as long as the request is properly formatted JSON. To address an array entry other than the first, insert nulls as placeholders on skipped array entries.

"CommandShell/MaxConcurrentSessions"

This property is a member of Manager

This is the maximum number of Command Shell sessions, regardless of protocol, that this manager supports.

JSON type:

Integer greater than or equal to 0.

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.

"CommandShell/ServiceEnabled"

This property is a member of Manager

Indicates if the Command Shell service is enabled for this manager.

JSON type:

Boolean ('true' or 'false')

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

PATCH Example

HTTP PATCH to resource with request JSON:

{"CommandShell": {"ServiceEnabled": true}}

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

PATCH Example

HTTP PATCH to resource with request JSON:

{"GraphicalConsole": {"Enabled": true}}

The property "GraphicalConsole/Enabled" on resource type Manager may not support PATCH of all values and may result in an HTTP 400 error with response of Type ExtendedError. Multiple properties may be included in a single HTTP PATCH operation as long as the request is properly formatted JSON. To address an array entry other than the first, insert nulls as placeholders on skipped array entries.

"GraphicalConsole/MaxConcurrentSessions"

This property is a member of Manager

Indicates the maximum number of Graphical Console sessions, regardless of protocol, this manager supports.

JSON type:

Integer greater than or equal to 0.

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.

"GraphicalConsole/ServiceEnabled"

This property is a member of Manager

Indicates if the Command Shell service is enabled for this manager.

JSON type:

Boolean ('true' or 'false')

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

PATCH Example

HTTP PATCH to resource with request JSON:

{"GraphicalConsole": {"ServiceEnabled": true}}

The property "GraphicalConsole/ServiceEnabled" on resource type Manager may not support PATCH of all values and may result in an HTTP 400 error with response of Type ExtendedError. Multiple properties may be included in a single HTTP PATCH operation as long as the request is properly formatted JSON. To address an array entry other than the first, insert nulls as placeholders on skipped array entries.

"ManagerType"

This property is a member of Manager

This property is the manager type for this resource.

JSON type:

String containing one of the following supported values:

"ManagementController"
"EnclosureManager"
"BMC"

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.

"Model"

This property is a member of Manager

Model name of the manager.

JSON type:

String

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.

"Oem/Hp/ClearRestApiStatus"

This property is a member of Manager

Status of external provider data in NVRAM.

JSON type:

String containing one of the following supported values:

""
"DataPresent"
"DataCleared"

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.

"Oem/Hp/FederationConfig/IPv6MulticastScope"

This property is a member of Manager

The IPv6 network scope of multicast announcements.

JSON type:

String containing one of the following supported values:

"Link"
"Site"
"Organization"

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

PATCH Example

HTTP PATCH to resource with request JSON:

{"Oem": {"Hp": {"FederationConfig": {"IPv6MulticastScope": "Site"}}}}

The property "Oem/Hp/FederationConfig/IPv6MulticastScope" on resource type Manager may not support PATCH of all values and may result in an HTTP 400 error with response of Type ExtendedError. Multiple properties may be included in a single HTTP PATCH operation as long as the request is properly formatted JSON. To address an array entry other than the first, insert nulls as placeholders on skipped array entries.

"Oem/Hp/FederationConfig/MulticastAnnouncementInterval"

This property is a member of Manager

The frequency in Seconds at which the iLO system announces itself on the network. A value of 0 disables multicast announcments.

JSON type:

Integer from 0 to 1800.

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

PATCH Example

HTTP PATCH to resource with request JSON:

{"Oem": {"Hp": {"FederationConfig": {"MulticastAnnouncementInterval": <integer-value>}}}}

The property "Oem/Hp/FederationConfig/MulticastAnnouncementInterval" on resource type Manager may not support PATCH of all values and may result in an HTTP 400 error with response of Type ExtendedError. Multiple properties may be included in a single HTTP PATCH operation as long as the request is properly formatted JSON. To address an array entry other than the first, insert nulls as placeholders on skipped array entries.

"Oem/Hp/FederationConfig/MulticastDiscovery"

This property is a member of Manager

Enables or Disables Multicast Discovery for the local iLO system.

JSON type:

String containing one of the following supported values:

"Enabled"
"Disabled"

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

PATCH Example

HTTP PATCH to resource with request JSON:

{"Oem": {"Hp": {"FederationConfig": {"MulticastDiscovery": "Disabled"}}}}

The property "Oem/Hp/FederationConfig/MulticastDiscovery" on resource type Manager may not support PATCH of all values and may result in an HTTP 400 error with response of Type ExtendedError. Multiple properties may be included in a single HTTP PATCH operation as long as the request is properly formatted JSON. To address an array entry other than the first, insert nulls as placeholders on skipped array entries.

"Oem/Hp/FederationConfig/MulticastTimeToLive"

This property is a member of Manager

The maximum number of switches a multicast announcement will traverse before being discarded.

JSON type:

Integer

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

PATCH Example

HTTP PATCH to resource with request JSON:

{"Oem": {"Hp": {"FederationConfig": {"MulticastTimeToLive": <integer-value>}}}}

The property "Oem/Hp/FederationConfig/MulticastTimeToLive" on resource type Manager may not support PATCH of all values and may result in an HTTP 400 error with response of Type ExtendedError. Multiple properties may be included in a single HTTP PATCH operation as long as the request is properly formatted JSON. To address an array entry other than the first, insert nulls as placeholders on skipped array entries.

"Oem/Hp/FederationConfig/iLOFederationManagement"

This property is a member of Manager

Enables or Disables iLO Federation features for the local iLO system.

JSON type:

String containing one of the following supported values:

"Enabled"
"Disabled"

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

PATCH Example

HTTP PATCH to resource with request JSON:

{"Oem": {"Hp": {"FederationConfig": {"iLOFederationManagement": "Disabled"}}}}

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

PATCH Example

HTTP PATCH to resource with request JSON:

{"Oem": {"Hp": {"RequiredLoginForiLORBSU": true}}}

The property "Oem/Hp/RequiredLoginForiLORBSU" on resource type Manager may not support PATCH of all values and may result in an HTTP 400 error with response of Type ExtendedError. Multiple properties may be included in a single HTTP PATCH operation as long as the request is properly formatted JSON. To address an array entry other than the first, insert nulls as placeholders on skipped array entries.

"Oem/Hp/SerialCLISpeed"

This property is a member of Manager

Serial command line interface speed in bits/second.

JSON type:

Integer

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

PATCH Example

HTTP PATCH to resource with request JSON:

{"Oem": {"Hp": {"SerialCLISpeed": <integer-value>}}}

The property "Oem/Hp/SerialCLISpeed" on resource type Manager may not support PATCH of all values and may result in an HTTP 400 error with response of Type ExtendedError. Multiple properties may be included in a single HTTP PATCH operation as long as the request is properly formatted JSON. To address an array entry other than the first, insert nulls as placeholders on skipped array entries.

"Oem/Hp/SerialCLIStatus"

This property is a member of Manager

Status of serial command line interface.

JSON type:

String containing one of the following supported values:

""
"Disabled"
"EnabledNoAuth"
"EnabledAuthReq"

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

PATCH Example

HTTP PATCH to resource with request JSON:

{"Oem": {"Hp": {"SerialCLIStatus": "EnabledNoAuth"}}}

The property "Oem/Hp/SerialCLIStatus" on resource type Manager may not support PATCH of all values and may result in an HTTP 400 error with response of Type ExtendedError. Multiple properties may be included in a single HTTP PATCH operation as long as the request is properly formatted JSON. To address an array entry other than the first, insert nulls as placeholders on skipped array entries.

"Oem/Hp/VSPLogDownloadEnabled"

This property is a member of Manager

This property enables or disables download of Virtual Serial Port (VSP) log.

JSON type:

Boolean ('true' or 'false')

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

PATCH Example

HTTP PATCH to resource with request JSON:

{"Oem": {"Hp": {"VSPLogDownloadEnabled": true}}}

The property "Oem/Hp/VSPLogDownloadEnabled" on resource type Manager may not support PATCH of all values and may result in an HTTP 400 error with response of Type ExtendedError. Multiple properties may be included in a single HTTP PATCH operation as long as the request is properly formatted JSON. To address an array entry other than the first, insert nulls as placeholders on skipped array entries.

"Oem/Hp/iLOFunctionalityRequired"

This property is a member of Manager

iLO is required and can't be disabled on this platform (usually blades).

JSON type:

Boolean ('true' or 'false')

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.

"Oem/Hp/iLORBSUEnabled"

This property is a member of Manager

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.

JSON type:

Boolean ('true' or 'false')

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

PATCH Example

HTTP PATCH to resource with request JSON:

{"Oem": {"Hp": {"iLORBSUEnabled": true}}}

The property "Oem/Hp/iLORBSUEnabled" on resource type Manager may not support PATCH of all values and may result in an HTTP 400 error with response of Type ExtendedError. Multiple properties may be included in a single HTTP PATCH operation as long as the request is properly formatted JSON. To address an array entry other than the first, insert nulls as placeholders on skipped array entries.

"Oem/Hp/iLOSelfTestResults[]/Notes"

This property is a member of Manager

Additional Information (if any) about the Self Test.

JSON type:

String

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.

"Oem/Hp/iLOSelfTestResults[]/SelfTestName"

This property is a member of Manager

iLO Self Test Name.

JSON type:

String containing one of the following supported values:

"UnknownSelfTest"
"CryptographicHardware"
"Memory"
"WebServerCryptography"
"MiscCryptography"
"UART"
"HoodSense"
"NVRAMInterface"
"NVRAMData"
"NVRAMSpace"
"NIC"
"EmbeddedFlash/SDCard"
"StaticRAM"
"EEPROM"
"I2C"
"BootBlock"
"ThreadInit"
"Infrastructure"
"HostRom"
"SupportedHost"
"EEPROMContent"
"PowerManagementController"
"CPLDPAL0"
"CPLDPAL1"
"CPLDPAL2"
"CPLDPAL3"
"CPLDPAL4"
"CPLDPAL5"

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.

"Oem/Hp/iLOSelfTestResults[]/Status"

This property is a member of Manager

Status of the Self Test.

JSON type:

String containing one of the following supported values:

"NA"
"OK"
"Informational"
"Degraded"

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.

"Oem/Hp/links/FederationDispatch/extref"

This property is a member of Manager

The URI of an external resource.

JSON type:

String

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.

"Oem/Hp/links/VSPLogLocation/extref"

This property is a member of Manager

The URI of an external resource.

JSON type:

String

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.

"Redundancy/MaxNumSupported"

This property is a member of Manager

This is the maximum number of members allowable for this particular managers redundancy, including this manager.

JSON type:

Integer

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.

"Redundancy/MemberId"

This property is a member of Manager

This is the identifier for the member within the collection.

JSON type:

String

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.

"Redundancy/MinNumNeeded"

This property is a member of Manager

This is the minumum number of managers needed for this manager to be redundant.

JSON type:

Integer

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.

"Redundancy/Mode"

This property is a member of Manager

This is the redundancy mode of the group.

JSON type:

String containing one of the following supported values:

""
"Failover"
"N+1"
"LoadBalanced"
"Sparing"
"LimitedSparing"

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.

"Redundancy/Status/Health"

This property is a member of Manager

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

JSON type:

String containing one of the following supported values:

""
"OK"
"Warning"
"Critical"

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.

"Redundancy/Status/HealthRollUp"

This property is a member of Manager

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

JSON type:

String containing one of the following supported values:

""
"OK"
"Warning"
"Critical"

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.

"Redundancy/Status/HealthRollup"

This property is a member of Manager

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

JSON type:

String containing one of the following supported values:

""
"OK"
"Warning"
"Critical"

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.

"Redundancy/Status/State"

This property is a member of Manager

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

JSON type:

String containing one of the following supported values:

""
"Enabled"
"Disabled"
"Offline"
"InTest"
"Starting"
"Absent"

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.

"SerialConsole/Enabled"

This property is a member of Manager

Indicates if the Serial Console service is enabled for this manager.

JSON type:

Boolean ('true' or 'false')

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

PATCH Example

HTTP PATCH to resource with request JSON:

{"SerialConsole": {"Enabled": true}}

The property "SerialConsole/Enabled" on resource type Manager may not support PATCH of all values and may result in an HTTP 400 error with response of Type ExtendedError. Multiple properties may be included in a single HTTP PATCH operation as long as the request is properly formatted JSON. To address an array entry other than the first, insert nulls as placeholders on skipped array entries.

"SerialConsole/MaxConcurrentSessions"

This property is a member of Manager

This is the maximum number of Serial Console sessions, regardless of protocol, that this manager supports.

JSON type:

Integer greater than or equal to 0.

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.

"SerialConsole/ServiceEnabled"

This property is a member of Manager

Indicates if the Command Shell service is enabled for this manager.

JSON type:

Boolean ('true' or 'false')

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

PATCH Example

HTTP PATCH to resource with request JSON:

{"SerialConsole": {"ServiceEnabled": true}}

The property "SerialConsole/ServiceEnabled" on resource type Manager may not support PATCH of all values and may result in an HTTP 400 error with response of Type ExtendedError. Multiple properties may be included in a single HTTP PATCH operation as long as the request is properly formatted JSON. To address an array entry other than the first, insert nulls as placeholders on skipped array entries.

"Status/Health"

This property is a member of Manager

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

JSON type:

String containing one of the following supported values:

""
"OK"
"Warning"
"Critical"

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.

"Status/HealthRollUp"

This property is a member of Manager

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

JSON type:

String containing one of the following supported values:

""
"OK"
"Warning"
"Critical"

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.

"Status/HealthRollup"

This property is a member of Manager

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

JSON type:

String containing one of the following supported values:

""
"OK"
"Warning"
"Critical"

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.

"Status/State"

This property is a member of Manager

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

JSON type:

String containing one of the following supported values:

""
"Enabled"
"Disabled"
"Offline"
"InTest"
"Starting"
"Absent"

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.

"UUID"

This property is a member of Manager

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.

JSON type:

String

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.

"/Oem/Hp"

Parameter "ResetType"

"ResetType" must be one of the following value(s):

"Default"

Reset iLO to defaults, clear logs and reboot iLO.

Example

HTTP POST to resource with request JSON:

{ "Action": "ResetToFactoryDefaults", "Target": "/Oem/Hp", "ResetType": "Default"}

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

PATCH Example

HTTP PATCH to resource with request JSON:

{"UserName": "<string-value>"}

The property "UserName" on resource type ManagerAccount may not support PATCH of all values and may result in an HTTP 400 error with response of Type ExtendedError. Multiple properties may be included in a single HTTP PATCH operation as long as the request is properly formatted JSON. To address an array entry other than the first, insert nulls as placeholders on skipped array entries.

"ManagerNetworkProtocol" Resource Type

Resource Instances

/rest/v1/Managers/{item}/NetworkService

See Resource Map for more details.

This resource is used to obtain or modify the network services managed by this manager.

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

PATCH Example

HTTP PATCH to resource with request JSON:

{"HTTP": {"Port": <integer-value>}}

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

PATCH Example

HTTP PATCH to resource with request JSON:

{"HTTPS": {"Port": <integer-value>}}

The property "HTTPS/Port" on resource type ManagerNetworkProtocol may not support PATCH of all values and may result in an HTTP 400 error with response of Type ExtendedError. Multiple properties may be included in a single HTTP PATCH operation as long as the request is properly formatted JSON. To address an array entry other than the first, insert nulls as placeholders on skipped array entries.

"HTTPS/ProtocolEnabled"

This property is a member of ManagerNetworkProtocol

Indicates whether HTTPS/SSL is enabled or disabled.

JSON type:

Boolean ('true' or 'false')

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.

"HostName"

This property is a member of ManagerNetworkProtocol

The host name of the manager that is obtained by DNS and does not include any domain information.

JSON type:

String

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

PATCH Example

HTTP PATCH to resource with request JSON:

{"HostName": "<string-value>"}

The property "HostName" on resource type ManagerNetworkProtocol may not support PATCH of all values and may result in an HTTP 400 error with response of Type ExtendedError. Multiple properties may be included in a single HTTP PATCH operation as long as the request is properly formatted JSON. To address an array entry other than the first, insert nulls as placeholders on skipped array entries.

"IPMI/Enabled"

This property is a member of ManagerNetworkProtocol

Indicates whether IPMI over LAN is enabled for the manager.

JSON type:

Boolean ('true' or 'false')

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

PATCH Example

HTTP PATCH to resource with request JSON:

{"IPMI": {"Enabled": true}}

The property "IPMI/Enabled" on resource type ManagerNetworkProtocol may not support PATCH of all values and may result in an HTTP 400 error with response of Type ExtendedError. Multiple properties may be included in a single HTTP PATCH operation as long as the request is properly formatted JSON. To address an array entry other than the first, insert nulls as placeholders on skipped array entries.

"IPMI/Port"

This property is a member of ManagerNetworkProtocol

The IPMI over LAN port number.

JSON type:

Integer from 1 to 65535.

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

PATCH Example

HTTP PATCH to resource with request JSON:

{"IPMI": {"Port": <integer-value>}}

The property "IPMI/Port" on resource type ManagerNetworkProtocol may not support PATCH of all values and may result in an HTTP 400 error with response of Type ExtendedError. Multiple properties may be included in a single HTTP PATCH operation as long as the request is properly formatted JSON. To address an array entry other than the first, insert nulls as placeholders on skipped array entries.

"IPMI/ProtocolEnabled"

This property is a member of ManagerNetworkProtocol

Indicates whether IPMI over LAN is enabled for the manager.

JSON type:

Boolean ('true' or 'false')

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

PATCH Example

HTTP PATCH to resource with request JSON:

{"IPMI": {"ProtocolEnabled": true}}

The property "IPMI/ProtocolEnabled" on resource type ManagerNetworkProtocol may not support PATCH of all values and may result in an HTTP 400 error with response of Type ExtendedError. Multiple properties may be included in a single HTTP PATCH operation as long as the request is properly formatted JSON. To address an array entry other than the first, insert nulls as placeholders on skipped array entries.

"KVMIP/Enabled"

This property is a member of ManagerNetworkProtocol

Indicates whether KVM-IP is enabled for the manager.

JSON type:

Boolean ('true' or 'false')

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.

"KVMIP/Port"

This property is a member of ManagerNetworkProtocol

The KVM-IP port number.

JSON type:

Integer from 1 to 65535.

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

PATCH Example

HTTP PATCH to resource with request JSON:

{"KVMIP": {"Port": <integer-value>}}

The property "KVMIP/Port" on resource type ManagerNetworkProtocol may not support PATCH of all values and may result in an HTTP 400 error with response of Type ExtendedError. Multiple properties may be included in a single HTTP PATCH operation as long as the request is properly formatted JSON. To address an array entry other than the first, insert nulls as placeholders on skipped array entries.

"KVMIP/ProtocolEnabled"

This property is a member of ManagerNetworkProtocol

Indicates whether KVM-IP is enabled for the manager.

JSON type:

Boolean ('true' or 'false')

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.

"Oem/Hp/AlertMailEmail"

This property is a member of ManagerNetworkProtocol

The destination email address for email alerts.

JSON type:

String

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

PATCH Example

HTTP PATCH to resource with request JSON:

{"Oem": {"Hp": {"AlertMailEmail": "<string-value>"}}}

The property "Oem/Hp/AlertMailEmail" on resource type ManagerNetworkProtocol may not support PATCH of all values and may result in an HTTP 400 error with response of Type ExtendedError. Multiple properties may be included in a single HTTP PATCH operation as long as the request is properly formatted JSON. To address an array entry other than the first, insert nulls as placeholders on skipped array entries.

"Oem/Hp/AlertMailEnabled"

This property is a member of ManagerNetworkProtocol

Indicates whether AlertMail is enabled. This can be enabled only when the properties AlertMailEmail, AlertMailSenderDomain and AlertMailSMTPServer are set or not empty.

JSON type:

Boolean ('true' or 'false')

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

PATCH Example

HTTP PATCH to resource with request JSON:

{"Oem": {"Hp": {"AlertMailEnabled": true}}}

The property "Oem/Hp/AlertMailEnabled" on resource type ManagerNetworkProtocol may not support PATCH of all values and may result in an HTTP 400 error with response of Type ExtendedError. Multiple properties may be included in a single HTTP PATCH operation as long as the request is properly formatted JSON. To address an array entry other than the first, insert nulls as placeholders on skipped array entries.

"Oem/Hp/AlertMailSMTPPort"

This property is a member of ManagerNetworkProtocol

The SMTP server port number.

JSON type:

Integer from 1 to 65535.

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

PATCH Example

HTTP PATCH to resource with request JSON:

{"Oem": {"Hp": {"AlertMailSMTPPort": <integer-value>}}}

The property "Oem/Hp/AlertMailSMTPPort" on resource type ManagerNetworkProtocol may not support PATCH of all values and may result in an HTTP 400 error with response of Type ExtendedError. Multiple properties may be included in a single HTTP PATCH operation as long as the request is properly formatted JSON. To address an array entry other than the first, insert nulls as placeholders on skipped array entries.

"Oem/Hp/AlertMailSMTPServer"

This property is a member of ManagerNetworkProtocol

The IP address or DNS name of the SMTP server or the Mail Submission Agent (MSA).

JSON type:

String

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

PATCH Example

HTTP PATCH to resource with request JSON:

{"Oem": {"Hp": {"AlertMailSMTPServer": "<string-value>"}}}

The property "Oem/Hp/AlertMailSMTPServer" on resource type ManagerNetworkProtocol may not support PATCH of all values and may result in an HTTP 400 error with response of Type ExtendedError. Multiple properties may be included in a single HTTP PATCH operation as long as the request is properly formatted JSON. To address an array entry other than the first, insert nulls as placeholders on skipped array entries.

"Oem/Hp/AlertMailSenderDomain"

This property is a member of ManagerNetworkProtocol

The domain name for the sender email address.

JSON type:

String

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

PATCH Example

HTTP PATCH to resource with request JSON:

{"Oem": {"Hp": {"AlertMailSenderDomain": "<string-value>"}}}

The property "Oem/Hp/AlertMailSenderDomain" on resource type ManagerNetworkProtocol may not support PATCH of all values and may result in an HTTP 400 error with response of Type ExtendedError. Multiple properties may be included in a single HTTP PATCH operation as long as the request is properly formatted JSON. To address an array entry other than the first, insert nulls as placeholders on skipped array entries.

"Oem/Hp/ConfigurationSettings"

This property is a member of ManagerNetworkProtocol

State of the currently displayed configuration settings.

JSON type:

String containing one of the following supported values:

"Current"
"SomePendingReset"

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.

"Oem/Hp/EnforceAES3DESEncryption"

This property is a member of ManagerNetworkProtocol

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.

JSON type:

Boolean ('true' or 'false')

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

PATCH Example

HTTP PATCH to resource with request JSON:

{"Oem": {"Hp": {"EnforceAES3DESEncryption": true}}}

The property "Oem/Hp/EnforceAES3DESEncryption" on resource type ManagerNetworkProtocol may not support PATCH of all values and may result in an HTTP 400 error with response of Type ExtendedError. Multiple properties may be included in a single HTTP PATCH operation as long as the request is properly formatted JSON. To address an array entry other than the first, insert nulls as placeholders on skipped array entries.

"Oem/Hp/FederationEnabled"

This property is a member of ManagerNetworkProtocol

Indicates whether management processor federation management is enabled or disabled.

JSON type:

Boolean ('true' or 'false')

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

PATCH Example

HTTP PATCH to resource with request JSON:

{"Oem": {"Hp": {"FederationEnabled": true}}}

The property "Oem/Hp/FederationEnabled" on resource type ManagerNetworkProtocol may not support PATCH of all values and may result in an HTTP 400 error with response of Type ExtendedError. Multiple properties may be included in a single HTTP PATCH operation as long as the request is properly formatted JSON. To address an array entry other than the first, insert nulls as placeholders on skipped array entries.

"Oem/Hp/FederationSupported"

This property is a member of ManagerNetworkProtocol

Indicates whether management processor federation is supported.

JSON type:

Boolean ('true' or 'false')

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.

"Oem/Hp/HPSystemManagementHomepageAddress"

This property is a member of ManagerNetworkProtocol

The IP address or FQDN of the HP System Management Homepage (HP SMH) server.

JSON type:

String

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

PATCH Example

HTTP PATCH to resource with request JSON:

{"Oem": {"Hp": {"HPSystemManagementHomepageAddress": "<string-value>"}}}

The property "Oem/Hp/HPSystemManagementHomepageAddress" on resource type ManagerNetworkProtocol may not support PATCH of all values and may result in an HTTP 400 error with response of Type ExtendedError. Multiple properties may be included in a single HTTP PATCH operation as long as the request is properly formatted JSON. To address an array entry other than the first, insert nulls as placeholders on skipped array entries.

"Oem/Hp/RemoteSyslogEnabled"

This property is a member of ManagerNetworkProtocol

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.

JSON type:

Boolean ('true' or 'false')

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

PATCH Example

HTTP PATCH to resource with request JSON:

{"Oem": {"Hp": {"RemoteSyslogEnabled": true}}}

The property "Oem/Hp/RemoteSyslogEnabled" on resource type ManagerNetworkProtocol may not support PATCH of all values and may result in an HTTP 400 error with response of Type ExtendedError. Multiple properties may be included in a single HTTP PATCH operation as long as the request is properly formatted JSON. To address an array entry other than the first, insert nulls as placeholders on skipped array entries.

"Oem/Hp/RemoteSyslogPort"

This property is a member of ManagerNetworkProtocol

The port number through which the Syslog server is listening.

JSON type:

Integer from 1 to 65535.

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

PATCH Example

HTTP PATCH to resource with request JSON:

{"Oem": {"Hp": {"RemoteSyslogPort": <integer-value>}}}

The property "Oem/Hp/RemoteSyslogPort" on resource type ManagerNetworkProtocol may not support PATCH of all values and may result in an HTTP 400 error with response of Type ExtendedError. Multiple properties may be included in a single HTTP PATCH operation as long as the request is properly formatted JSON. To address an array entry other than the first, insert nulls as placeholders on skipped array entries.

"Oem/Hp/RemoteSyslogServer"

This property is a member of ManagerNetworkProtocol

The IP address, FQDN, IPv6 name, or short name of the server running the Syslog service.

JSON type:

String

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

PATCH Example

HTTP PATCH to resource with request JSON:

{"Oem": {"Hp": {"RemoteSyslogServer": "<string-value>"}}}

The property "Oem/Hp/RemoteSyslogServer" on resource type ManagerNetworkProtocol may not support PATCH of all values and may result in an HTTP 400 error with response of Type ExtendedError. Multiple properties may be included in a single HTTP PATCH operation as long as the request is properly formatted JSON. To address an array entry other than the first, insert nulls as placeholders on skipped array entries.

"Oem/Hp/SNMPTrapPort"

This property is a member of ManagerNetworkProtocol

The SNMP trap port number.

JSON type:

Integer from 1 to 65535.

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

PATCH Example

HTTP PATCH to resource with request JSON:

{"Oem": {"Hp": {"SNMPTrapPort": <integer-value>}}}

The property "Oem/Hp/SNMPTrapPort" on resource type ManagerNetworkProtocol may not support PATCH of all values and may result in an HTTP 400 error with response of Type ExtendedError. Multiple properties may be included in a single HTTP PATCH operation as long as the request is properly formatted JSON. To address an array entry other than the first, insert nulls as placeholders on skipped array entries.

"Oem/Hp/SerialOverLanLogging"

This property is a member of ManagerNetworkProtocol

Indicates whether Serial Over LAN (SOL) or Virtual Serial Port (VSP) logging is enabled.

JSON type:

Boolean ('true' or 'false')

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

PATCH Example

HTTP PATCH to resource with request JSON:

{"Oem": {"Hp": {"SerialOverLanLogging": true}}}

The property "Oem/Hp/SerialOverLanLogging" on resource type ManagerNetworkProtocol may not support PATCH of all values and may result in an HTTP 400 error with response of Type ExtendedError. Multiple properties may be included in a single HTTP PATCH operation as long as the request is properly formatted JSON. To address an array entry other than the first, insert nulls as placeholders on skipped array entries.

"Oem/Hp/XMLResponseEnabled"

This property is a member of ManagerNetworkProtocol

Determines whether management processor responds to anonymous XML discovery requests.

JSON type:

Boolean ('true' or 'false')

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

PATCH Example

HTTP PATCH to resource with request JSON:

{"Oem": {"Hp": {"XMLResponseEnabled": true}}}

The property "Oem/Hp/XMLResponseEnabled" on resource type ManagerNetworkProtocol may not support PATCH of all values and may result in an HTTP 400 error with response of Type ExtendedError. Multiple properties may be included in a single HTTP PATCH operation as long as the request is properly formatted JSON. To address an array entry other than the first, insert nulls as placeholders on skipped array entries.

"SNMP/Enabled"

This property is a member of ManagerNetworkProtocol

Indicates whether SNMP is enabled for the manager.

JSON type:

Boolean ('true' or 'false')

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

PATCH Example

HTTP PATCH to resource with request JSON:

{"SNMP": {"Enabled": true}}

The property "SNMP/Enabled" on resource type ManagerNetworkProtocol may not support PATCH of all values and may result in an HTTP 400 error with response of Type ExtendedError. Multiple properties may be included in a single HTTP PATCH operation as long as the request is properly formatted JSON. To address an array entry other than the first, insert nulls as placeholders on skipped array entries.

"SNMP/Port"

This property is a member of ManagerNetworkProtocol

The SNMP port number.

JSON type:

Integer from 1 to 65535.

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

PATCH Example

HTTP PATCH to resource with request JSON:

{"SNMP": {"Port": <integer-value>}}

The property "SNMP/Port" on resource type ManagerNetworkProtocol may not support PATCH of all values and may result in an HTTP 400 error with response of Type ExtendedError. Multiple properties may be included in a single HTTP PATCH operation as long as the request is properly formatted JSON. To address an array entry other than the first, insert nulls as placeholders on skipped array entries.

"SNMP/ProtocolEnabled"

This property is a member of ManagerNetworkProtocol

Indicates whether SNMP is enabled for the manager.

JSON type:

Boolean ('true' or 'false')

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

PATCH Example

HTTP PATCH to resource with request JSON:

{"SNMP": {"ProtocolEnabled": true}}

The property "SNMP/ProtocolEnabled" on resource type ManagerNetworkProtocol may not support PATCH of all values and may result in an HTTP 400 error with response of Type ExtendedError. Multiple properties may be included in a single HTTP PATCH operation as long as the request is properly formatted JSON. To address an array entry other than the first, insert nulls as placeholders on skipped array entries.

"SSDP/Enabled"

This property is a member of ManagerNetworkProtocol

Indicates whether SSDP is enabled for the manager.

JSON type:

Boolean ('true' or 'false')

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

PATCH Example

HTTP PATCH to resource with request JSON:

{"SSDP": {"Enabled": true}}

The property "SSDP/Enabled" on resource type ManagerNetworkProtocol may not support PATCH of all values and may result in an HTTP 400 error with response of Type ExtendedError. Multiple properties may be included in a single HTTP PATCH operation as long as the request is properly formatted JSON. To address an array entry other than the first, insert nulls as placeholders on skipped array entries.

"SSDP/NotifyIPv6Scope"

This property is a member of ManagerNetworkProtocol

The scope for IPv6 Notify messages for SSDP.

JSON type:

String containing one of the following supported values:

""
"Link"
"Site"
"Organization"

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

PATCH Example

HTTP PATCH to resource with request JSON:

{"SSDP": {"NotifyIPv6Scope": "Site"}}

The property "SSDP/NotifyIPv6Scope" on resource type ManagerNetworkProtocol may not support PATCH of all values and may result in an HTTP 400 error with response of Type ExtendedError. Multiple properties may be included in a single HTTP PATCH operation as long as the request is properly formatted JSON. To address an array entry other than the first, insert nulls as placeholders on skipped array entries.

"SSDP/NotifyMulticastIntervalSeconds"

This property is a member of ManagerNetworkProtocol

Indicates how often multicast is performed for SSDP.

JSON type:

Integer greater than or equal to 0.

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

PATCH Example

HTTP PATCH to resource with request JSON:

{"SSDP": {"NotifyMulticastIntervalSeconds": <integer-value>}}

The property "SSDP/NotifyMulticastIntervalSeconds" on resource type ManagerNetworkProtocol may not support PATCH of all values and may result in an HTTP 400 error with response of Type ExtendedError. Multiple properties may be included in a single HTTP PATCH operation as long as the request is properly formatted JSON. To address an array entry other than the first, insert nulls as placeholders on skipped array entries.

"SSDP/NotifyTTL"

This property is a member of ManagerNetworkProtocol

The Time to Live (TTL) hop count for SSDP Notify messages.

JSON type:

Integer greater than or equal to 1.

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

PATCH Example

HTTP PATCH to resource with request JSON:

{"SSDP": {"NotifyTTL": <integer-value>}}

The property "SSDP/NotifyTTL" on resource type ManagerNetworkProtocol may not support PATCH of all values and may result in an HTTP 400 error with response of Type ExtendedError. Multiple properties may be included in a single HTTP PATCH operation as long as the request is properly formatted JSON. To address an array entry other than the first, insert nulls as placeholders on skipped array entries.

"SSDP/Port"

This property is a member of ManagerNetworkProtocol

The SSDP port number.

JSON type:

Integer from 1 to 65535.

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.

"SSDP/ProtocolEnabled"

This property is a member of ManagerNetworkProtocol

Indicates whether SSDP is enabled for the manager.

JSON type:

Boolean ('true' or 'false')

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

PATCH Example

HTTP PATCH to resource with request JSON:

{"SSDP": {"ProtocolEnabled": true}}

The property "SSDP/ProtocolEnabled" on resource type ManagerNetworkProtocol may not support PATCH of all values and may result in an HTTP 400 error with response of Type ExtendedError. Multiple properties may be included in a single HTTP PATCH operation as long as the request is properly formatted JSON. To address an array entry other than the first, insert nulls as placeholders on skipped array entries.

"SSH/Enabled"

This property is a member of ManagerNetworkProtocol

Indicates whether SSH is enabled for the manager. NOTE: When this field is modified, the Manager will reset automatically.

JSON type:

Boolean ('true' or 'false')

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

PATCH Example

HTTP PATCH to resource with request JSON:

{"SSH": {"Enabled": true}}

The property "SSH/Enabled" on resource type ManagerNetworkProtocol may not support PATCH of all values and may result in an HTTP 400 error with response of Type ExtendedError. Multiple properties may be included in a single HTTP PATCH operation as long as the request is properly formatted JSON. To address an array entry other than the first, insert nulls as placeholders on skipped array entries.

"SSH/Port"

This property is a member of ManagerNetworkProtocol

The SSH port number. NOTE: When this field is modified, the Manager will reset automatically.

JSON type:

Integer from 1 to 65535.

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

PATCH Example

HTTP PATCH to resource with request JSON:

{"SSH": {"Port": <integer-value>}}

The property "SSH/Port" on resource type ManagerNetworkProtocol may not support PATCH of all values and may result in an HTTP 400 error with response of Type ExtendedError. Multiple properties may be included in a single HTTP PATCH operation as long as the request is properly formatted JSON. To address an array entry other than the first, insert nulls as placeholders on skipped array entries.

"SSH/ProtocolEnabled"

This property is a member of ManagerNetworkProtocol

Indicates whether SSH is enabled for the manager. NOTE: When this field is modified, the Manager will reset automatically.

JSON type:

Boolean ('true' or 'false')

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

PATCH Example

HTTP PATCH to resource with request JSON:

{"SSH": {"ProtocolEnabled": true}}

The property "SSH/ProtocolEnabled" on resource type ManagerNetworkProtocol may not support PATCH of all values and may result in an HTTP 400 error with response of Type ExtendedError. Multiple properties may be included in a single HTTP PATCH operation as long as the request is properly formatted JSON. To address an array entry other than the first, insert nulls as placeholders on skipped array entries.

"SessionTimeoutMinutes"

This property is a member of ManagerNetworkProtocol

The session timeout (minutes). A zero value indicates infinite timeout.

JSON type:

Integer greater than or equal to 0.

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

PATCH Example

HTTP PATCH to resource with request JSON:

{"SessionTimeoutMinutes": <integer-value>}

The property "SessionTimeoutMinutes" on resource type ManagerNetworkProtocol may not support PATCH of all values and may result in an HTTP 400 error with response of Type ExtendedError. Multiple properties may be included in a single HTTP PATCH operation as long as the request is properly formatted JSON. To address an array entry other than the first, insert nulls as placeholders on skipped array entries.

"Status/Health"

This property is a member of ManagerNetworkProtocol

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

JSON type:

String containing one of the following supported values:

""
"OK"
"Warning"
"Critical"

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.

"Status/HealthRollUp"

This property is a member of ManagerNetworkProtocol

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

JSON type:

String containing one of the following supported values:

""
"OK"
"Warning"
"Critical"

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.

"Status/HealthRollup"

This property is a member of ManagerNetworkProtocol

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

JSON type:

String containing one of the following supported values:

""
"OK"
"Warning"
"Critical"

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.

"Status/State"

This property is a member of ManagerNetworkProtocol

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

JSON type:

String containing one of the following supported values:

""
"Enabled"
"Disabled"
"Offline"
"InTest"
"Starting"
"Absent"

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.

"VirtualMedia/Enabled"

This property is a member of ManagerNetworkProtocol

Indicates whether Virtual Media is enabled for the manager.

JSON type:

Boolean ('true' or 'false')

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.

"VirtualMedia/Port"

This property is a member of ManagerNetworkProtocol

The Virtual Media port number.

JSON type:

Integer from 1 to 65535.

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

PATCH Example

HTTP PATCH to resource with request JSON:

{"VirtualMedia": {"Port": <integer-value>}}

The property "VirtualMedia/Port" on resource type ManagerNetworkProtocol may not support PATCH of all values and may result in an HTTP 400 error with response of Type ExtendedError. Multiple properties may be included in a single HTTP PATCH operation as long as the request is properly formatted JSON. To address an array entry other than the first, insert nulls as placeholders on skipped array entries.

"VirtualMedia/ProtocolEnabled"

This property is a member of ManagerNetworkProtocol

Indicates whether Virtual Media is enabled for the manager.

JSON type:

Boolean ('true' or 'false')

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.

POST Action "SendTestSyslog"

Parameter "Target"

"Target" must be one of the following value(s):

"/Oem/Hp"

Example

HTTP POST to resource with request JSON:

{ "Action": "SendTestSyslog", "Target": "/Oem/Hp"}

POST Action "SendTestAlertMail"

Sends test alert mail to configured AlertMail email address.

Parameter "Target"

"Target" must be one of the following value(s):

"/Oem/Hp"

Example

HTTP POST to resource with request JSON:

{ "Action": "SendTestAlertMail", "Target": "/Oem/Hp"}

"Power" Resource Type

Resource Instances

/rest/v1/Chassis/{item}/Power

See Resource Map for more details.

This is the schema definition for the Power Metrics. It represents the properties for Power Consumption and Power Limiting.

"Power" defines the following properties:

"Oem/Hp/BbuPowerSupply"

This property is a member of Power

Battery Backup Unit Power Supply action determines what will occur when a server is running on battery power.

JSON type:

String containing one of the following supported values:

"DoNothing"
"MomentaryPowerButtonPress"
"HostShutdown"

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

PATCH Example

HTTP PATCH to resource with request JSON:

{"Oem": {"Hp": {"BbuPowerSupply": "MomentaryPowerButtonPress"}}}

The property "Oem/Hp/BbuPowerSupply" on resource type Power may not support PATCH of all values and may result in an HTTP 400 error with response of Type ExtendedError. Multiple properties may be included in a single HTTP PATCH operation as long as the request is properly formatted JSON. To address an array entry other than the first, insert nulls as placeholders on skipped array entries.

"Oem/Hp/SNMPPowerThresholdAlert/DurationInMin"

This property is a member of Power

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.

JSON type:

Integer from 0 to 240.

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

PATCH Example

HTTP PATCH to resource with request JSON:

{"Oem": {"Hp": {"SNMPPowerThresholdAlert": {"DurationInMin": <integer-value>}}}}

The property "Oem/Hp/SNMPPowerThresholdAlert/DurationInMin" on resource type Power may not support PATCH of all values and may result in an HTTP 400 error with response of Type ExtendedError. Multiple properties may be included in a single HTTP PATCH operation as long as the request is properly formatted JSON. To address an array entry other than the first, insert nulls as placeholders on skipped array entries.

"Oem/Hp/SNMPPowerThresholdAlert/ThresholdWatts"

This property is a member of Power

Sets the power consumption threshold (watts). If power consumption exceeds this value for the specified time duration, an SNMP alert is triggered.

JSON type:

Integer

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

PATCH Example

HTTP PATCH to resource with request JSON:

{"Oem": {"Hp": {"SNMPPowerThresholdAlert": {"ThresholdWatts": <integer-value>}}}}

The property "Oem/Hp/SNMPPowerThresholdAlert/ThresholdWatts" on resource type Power may not support PATCH of all values and may result in an HTTP 400 error with response of Type ExtendedError. Multiple properties may be included in a single HTTP PATCH operation as long as the request is properly formatted JSON. To address an array entry other than the first, insert nulls as placeholders on skipped array entries.

"Oem/Hp/SNMPPowerThresholdAlert/Trigger"

This property is a member of Power

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.

JSON type:

String containing one of the following supported values:

"Disabled"
"AveragePowerConsumption"
"PeakPowerConsumption"

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

PATCH Example

HTTP PATCH to resource with request JSON:

{"Oem": {"Hp": {"SNMPPowerThresholdAlert": {"Trigger": "AveragePowerConsumption"}}}}

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.

"PowerControl[]/PowerLimit/LimitException"

This property is a member of Power

The action that is taken if the power cannot be maintained below the LimitInWatts.

JSON type:

String containing one of the following supported values:

"NoAction"
"HardPowerOff"
"LogEventOnly"
"Oem"

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

PATCH Example

HTTP PATCH to resource with request JSON:

{"PowerControl": [{"PowerLimit": {"LimitException": "LogEventOnly"}}|null, ...]}

The property "PowerControl[]/PowerLimit/LimitException" on resource type Power may not support PATCH of all values and may result in an HTTP 400 error with response of Type ExtendedError. Multiple properties may be included in a single HTTP PATCH operation as long as the request is properly formatted JSON. To address an array entry other than the first, insert nulls as placeholders on skipped array entries.

"PowerControl[]/PowerLimit/LimitInWatts"

This property is a member of Power

The Power limit in watts. Set to null to disable power capping.

JSON type:

Integer

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

PATCH Example

HTTP PATCH to resource with request JSON:

{"PowerControl": [{"PowerLimit": {"LimitInWatts": <integer-value>}}|null, ...]}

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.

"PowerControl[]/Status/Health"

This property is a member of Power

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

JSON type:

String containing one of the following supported values:

""
"OK"
"Warning"
"Critical"

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.

"PowerControl[]/Status/HealthRollUp"

This property is a member of Power

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

JSON type:

String containing one of the following supported values:

""
"OK"
"Warning"
"Critical"

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.

"PowerControl[]/Status/HealthRollup"

This property is a member of Power

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

JSON type:

String containing one of the following supported values:

""
"OK"
"Warning"
"Critical"

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.

"PowerControl[]/Status/State"

This property is a member of Power

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

JSON type:

String containing one of the following supported values:

""
"Enabled"
"Disabled"
"Offline"
"InTest"
"Starting"
"Absent"

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.

"PowerLimit/CorrectionInMs"

This property is a member of Power

Time in milliseconds that it takes for the limiting process to react and correct the power consumption below the limit.

JSON type:

Integer

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.

"PowerLimit/CorrelatableID"

This property is a member of Power

The value of this property shall represent a reference to the resource that is being limited.

JSON type:

String

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.

"PowerLimit/LimitException"

This property is a member of Power

Action that is taken if the power cannot be maintained below the LimitInWatts.

JSON type:

String containing one of the following supported values:

""
"NoAction"
"HardPowerOff"
"LogEventOnly"
"Oem"

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

PATCH Example

HTTP PATCH to resource with request JSON:

{"PowerLimit": {"LimitException": "HardPowerOff"}}

The property "PowerLimit/LimitException" on resource type Power may not support PATCH of all values and may result in an HTTP 400 error with response of Type ExtendedError. Multiple properties may be included in a single HTTP PATCH operation as long as the request is properly formatted JSON. To address an array entry other than the first, insert nulls as placeholders on skipped array entries.

"PowerLimit/LimitInWatts"

This property is a member of Power

The Power (Watts) limit (also known as 'Power Cap'). Set to null to disable the power cap.

JSON type:

Integer

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

PATCH Example

HTTP PATCH to resource with request JSON:

{"PowerLimit": {"LimitInWatts": <integer-value>}}

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.

"PowerSupplies[]/LineInputVoltageType"

This property is a member of Power

The line voltage type supported as an input to this Power Supply

JSON type:

String containing one of the following supported values:

""
"Unknown"
"ACLowLine"
"ACMidLine"
"ACHighLine"
"DCNeg48V"
"HighVoltageDC"

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.

"PowerSupplies[]/MemberId"

This property is a member of Power

This is the identifier for the member within the collection.

JSON type:

String

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.

"PowerSupplies[]/Model"

This property is a member of Power

The model number for this Power Supply

JSON type:

String

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.

"PowerSupplies[]/Oem/Hp/AveragePowerOutputWatts"

This property is a member of Power

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.

JSON type:

Integer greater than or equal to 0.

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.

"PowerSupplies[]/Oem/Hp/BayNumber"

This property is a member of Power

The power supply bay number.

JSON type:

Integer greater than or equal to 0.

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.

"PowerSupplies[]/Oem/Hp/HotplugCapable"

This property is a member of Power

If true, this power supply (and power supply bay) is capable of being hot-plugged.

JSON type:

Boolean ('true' or 'false')

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.

"PowerSupplies[]/Oem/Hp/MaxPowerOutputWatts"

This property is a member of Power

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.

JSON type:

Integer greater than or equal to 0.

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.

"PowerSupplies[]/Oem/Hp/Mismatched"

This property is a member of Power

If true, this power supply is mismatched with others in the system.

JSON type:

Boolean ('true' or 'false')

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.

"PowerSupplies[]/Oem/Hp/PowerSupplyStatus/State"

This property is a member of Power

Indicates the known state of the resource.

JSON type:

String containing one of the following supported values:

"Unknown"
"Ok"
"Degraded"
"Failed"
"OverVoltage"
"OverCurrent"
"OverTemperature"
"ACPowerLost"
"FanFailure"
"WarningHighInputVoltage"
"WarningLowInputVoltage"
"WarningHighOutputVoltage"
"WarningLowOutputVoltage"
"WarningInletTemperature"
"WarningInternalTemperature"
"WarningHighAuxiliaryVoltage"
"WarningLowAuxiliaryVoltage"
"PowerSupplyMismatch"

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.

"PowerSupplies[]/Oem/Hp/iPDU/IPAddress"

This property is a member of Power

The IP address of the iPDU connected to this power supply.

JSON type:

String

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.

"PowerSupplies[]/Oem/Hp/iPDU/MacAddress"

This property is a member of Power

The Ethernet MAC address of the iPDU connected to this power supply.

JSON type:

String

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.

"PowerSupplies[]/Oem/Hp/iPDU/Model"

This property is a member of Power

The model number of the iPDU connected to this power supply.

JSON type:

String

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.

"PowerSupplies[]/Oem/Hp/iPDU/SerialNumber"

This property is a member of Power

The serial number of the iPDU connected to this power supply.

JSON type:

String

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.

"PowerSupplies[]/Oem/Hp/iPDU/iPDUStatus/State"

This property is a member of Power

Indicates the known state of the resource.

JSON type:

String containing one of the following supported values:

"Unknown"
"Ok"
"Degraded"
"Failed"
"OverVoltage"
"OverCurrent"
"OverTemperature"
"ACPowerLost"
"FanFailure"
"WarningHighInputVoltage"
"WarningLowInputVoltage"
"WarningHighOutputVoltage"
"WarningLowOutputVoltage"
"WarningInletTemperature"
"WarningInternalTemperature"
"WarningHighAuxiliaryVoltage"
"WarningLowAuxiliaryVoltage"
"PowerSupplyMismatch"

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.

"PowerSupplies[]/Oem/Hp/iPDUCapable"

This property is a member of Power

If true, this power supply is capable of being connected to an iPDUs.

JSON type:

Boolean ('true' or 'false')

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.

"PowerSupplies[]/PartNumber"

This property is a member of Power

The part number for this Power Supply

JSON type:

String

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.

"PowerSupplies[]/PowerCapacityWatts"

This property is a member of Power

The maximum capacity of this Power Supply

JSON type:

Integer

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.

"PowerSupplies[]/PowerSupplyType"

This property is a member of Power

The Power Supply type (AC or DC)

JSON type:

String containing one of the following supported values:

""
"Unknown"
"AC"
"DC"

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.

"PowerSupplies[]/Redundancy[]/MaxNumSupported"

This property is a member of Power

This is the maximum number of members allowable for this particular managers redundancy, including this manager.

JSON type:

Integer

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.

"PowerSupplies[]/Redundancy[]/MemberId"

This property is a member of Power

This is the identifier for the member within the collection.

JSON type:

String

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.

"PowerSupplies[]/Redundancy[]/MinNumNeeded"

This property is a member of Power

This is the minumum number of managers needed for this manager to be redundant.

JSON type:

Integer

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.

"PowerSupplies[]/Redundancy[]/Mode"

This property is a member of Power

This is the redundancy mode of the group.

JSON type:

String containing one of the following supported values:

""
"Failover"
"N+1"
"LoadBalanced"
"Sparing"
"LimitedSparing"

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.

"PowerSupplies[]/Redundancy[]/Status/Health"

This property is a member of Power

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

JSON type:

String containing one of the following supported values:

""
"OK"
"Warning"
"Critical"

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.

"PowerSupplies[]/Redundancy[]/Status/HealthRollUp"

This property is a member of Power

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

JSON type:

String containing one of the following supported values:

""
"OK"
"Warning"
"Critical"

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.

"PowerSupplies[]/Redundancy[]/Status/HealthRollup"

This property is a member of Power

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

JSON type:

String containing one of the following supported values:

""
"OK"
"Warning"
"Critical"

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.

"PowerSupplies[]/Redundancy[]/Status/State"

This property is a member of Power

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

JSON type:

String containing one of the following supported values:

""
"Enabled"
"Disabled"
"Offline"
"InTest"
"Starting"
"Absent"

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.

"PowerSupplies[]/SerialNumber"

This property is a member of Power

The serial number for this Power Supply

JSON type:

String

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.

"PowerSupplies[]/SparePartNumber"

This property is a member of Power

The spare part number for this Power Supply

JSON type:

String

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.

"PowerSupplies[]/Status/Health"

This property is a member of Power

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

JSON type:

String containing one of the following supported values:

""
"OK"
"Warning"
"Critical"

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.

"PowerSupplies[]/Status/HealthRollUp"

This property is a member of Power

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

JSON type:

String containing one of the following supported values:

""
"OK"
"Warning"
"Critical"

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.

"PowerSupplies[]/Status/HealthRollup"

This property is a member of Power

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

JSON type:

String containing one of the following supported values:

""
"OK"
"Warning"
"Critical"

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.

"PowerSupplies[]/Status/State"

This property is a member of Power

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

JSON type:

String containing one of the following supported values:

""
"Enabled"
"Disabled"
"Offline"
"InTest"
"Starting"
"Absent"

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.

"Redundancy[]/MaxNumSupported"

This property is a member of Power

This is the maximum number of members allowable for this particular managers redundancy, including this manager.

JSON type:

Integer

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.

"Redundancy[]/MemberId"

This property is a member of Power

This is the identifier for the member within the collection.

JSON type:

String

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.

"Redundancy[]/MinNumNeeded"

This property is a member of Power

This is the minumum number of managers needed for this manager to be redundant.

JSON type:

Integer

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.

"Redundancy[]/Mode"

This property is a member of Power

This is the redundancy mode of the group.

JSON type:

String containing one of the following supported values:

""
"Failover"
"N+1"
"LoadBalanced"
"Sparing"
"LimitedSparing"

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.

"Redundancy[]/Status/Health"

This property is a member of Power

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

JSON type:

String containing one of the following supported values:

""
"OK"
"Warning"
"Critical"

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.

"Redundancy[]/Status/HealthRollUp"

This property is a member of Power

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

JSON type:

String containing one of the following supported values:

""
"OK"
"Warning"
"Critical"

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.

"Redundancy[]/Status/HealthRollup"

This property is a member of Power

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

JSON type:

String containing one of the following supported values:

""
"OK"
"Warning"
"Critical"

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.

"Redundancy[]/Status/State"

This property is a member of Power

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

JSON type:

String containing one of the following supported values:

""
"Enabled"
"Disabled"
"Offline"
"InTest"
"Starting"
"Absent"

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.

"Status/Health"

This property is a member of Power

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

JSON type:

String containing one of the following supported values:

""
"OK"
"Warning"
"Critical"

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.

"Status/HealthRollUp"

This property is a member of Power

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

JSON type:

String containing one of the following supported values:

""
"OK"
"Warning"
"Critical"

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.

"Status/HealthRollup"

This property is a member of Power

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

JSON type:

String containing one of the following supported values:

""
"OK"
"Warning"
"Critical"

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.

"Status/State"

This property is a member of Power

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

JSON type:

String containing one of the following supported values:

""
"Enabled"
"Disabled"
"Offline"
"InTest"
"Starting"
"Absent"

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.

"ServiceRoot" Resource Type

Resource Instances

/rest/v1

See Resource Map for more details.

This object represents the HP RESTful API root service.

GET	Rendered if supported by the implementation or omitted if not.

"Oem/Hp/Manager[]/IPManager"

This property is a member of ServiceRoot

JSON type:

Object

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.

"Oem/Hp/Manager[]/Languages[]/Language"

This property is a member of ServiceRoot

Specifies one of the languages supported by the management processor.

JSON type:

String

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.

"Oem/Hp/Manager[]/Languages[]/TranslationName"

This property is a member of ServiceRoot

Specifies one of the languages supported by the management processor.

JSON type:

String

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.

"Oem/Hp/Manager[]/Languages[]/Version"

This property is a member of ServiceRoot

Specifies the version of the management processor in the respective language.

JSON type:

String

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.

"Oem/Hp/Manager[]/ManagerFirmwareVersion"

This property is a member of ServiceRoot

The major and minor management processor version numbers.

JSON type:

String

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.

"Oem/Hp/Manager[]/ManagerFirmwareVersionPass"

This property is a member of ServiceRoot

The build or pass number of the management processor version.

JSON type:

String

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.

"Oem/Hp/Manager[]/ManagerType"

This property is a member of ServiceRoot

The type of the service manager.

JSON type:

String

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.

"Oem/Hp/Sessions/CertCommonName"

This property is a member of ServiceRoot

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.

JSON type:

String

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.

"Oem/Hp/Sessions/KerberosEnabled"

This property is a member of ServiceRoot

Specifies whether Kerberos login is enabled.

JSON type:

Boolean ('true' or 'false')

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.

"Oem/Hp/Sessions/LDAPAuthLicenced"

This property is a member of ServiceRoot

Specifies whether a valid license is installed for LDAP use.

JSON type:

Boolean ('true' or 'false')

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.

"Oem/Hp/Sessions/LDAPEnabled"

This property is a member of ServiceRoot

Specifies whether LDAP login is enabled.

JSON type:

Boolean ('true' or 'false')

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.

"Oem/Hp/Sessions/LocalLoginEnabled"

This property is a member of ServiceRoot

Specifies whether local users can log in.

JSON type:

Boolean ('true' or 'false')

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.

"Oem/Hp/Sessions/LoginFailureDelay"

This property is a member of ServiceRoot

The delay (seconds) when a management processor login attempt has failed.

JSON type:

Integer greater than or equal to 0.

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.

"Oem/Hp/Sessions/LoginHint/Hint"

This property is a member of ServiceRoot

The information on how to log in to the management processor.

JSON type:

String

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.

"Oem/Hp/Sessions/LoginHint/HintPOSTData/Password"

This property is a member of ServiceRoot

The password for logging in to the management processor.

JSON type:

String

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.

"Oem/Hp/Sessions/LoginHint/HintPOSTData/UserName"

This property is a member of ServiceRoot

The user name for logging in to the management processor.

JSON type:

String

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.

"Oem/Hp/Sessions/SecurityMessage"

This property is a member of ServiceRoot

The login security banner message that is displayed on the management processor Login page.

JSON type:

String

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.

"Oem/Hp/Sessions/SecurityOverride"

This property is a member of ServiceRoot

Specifies whether the security override switch is enabled.

JSON type:

Boolean ('true' or 'false')

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.

"Oem/Hp/Sessions/ServerName"

This property is a member of ServiceRoot

The name of the server that this management processor is managing.

JSON type:

String

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.

"RedfishVersion"

This property is a member of ServiceRoot

The version of the Redfish service

JSON type:

String

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.

"ServiceVersion"

This property is a member of ServiceRoot

The web service version. This is different from the version of the data model.

JSON type:

String

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.

"Time"

This property is a member of ServiceRoot

The current web service time.

JSON type:

String

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.

"UUID"

This property is a member of ServiceRoot

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.

JSON type:

String

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.

"Session" Resource Type

Resource Instances

/rest/v1/SessionService/Sessions/{item}

See Resource Map for more details.

GET	Rendered if supported by the implementation or omitted if not.

"Oem/Hp/Privileges/VirtualPowerAndResetPriv"

This property is a member of Session

JSON type:

Boolean ('true' or 'false')

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.

"Oem/Hp/Privileges/iLOConfigPriv"

This property is a member of Session

JSON type:

Boolean ('true' or 'false')

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.

"Oem/Hp/UserAccount"

This property is a member of Session

JSON type:

String

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.

"Oem/Hp/UserDistinguishedName"

This property is a member of Session

LDAP user is identified by its distinguished name (DN).

JSON type:

String

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.

"Oem/Hp/UserExpires"

This property is a member of Session

User session expire time

JSON type:

String

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.

"Oem/Hp/UserIP"

This property is a member of Session

IP address of the user

JSON type:

String

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.

"Oem/Hp/UserTag"

This property is a member of Session

Session source

JSON type:

String containing one of the following supported values:

"Web UI"
"RBSU"
"Remote Console"
"SSH"
"IPMI/RMCP"
"SM-CLP"
"RIBCL"
"Unknown"

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.

"Oem/Hp/UserType"

This property is a member of Session

User type

JSON type:

String containing one of the following supported values:

"Local"
"Directory"
"Single Sign On"
"Kerberos"
"Trusted Key"
"Security Override"
"System"
"Federation"

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.

"UserName"

This property is a member of Session

Name to use to log in to the management processor.

JSON type:

String

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.

"SessionService" Resource Type

Resource Instances

/rest/v1/SessionService

See Resource Map for more details.

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

"SessionService" defines the following properties:

"ServiceEnabled"

This property is a member of SessionService

This indicates whether this service is enabled.

JSON type:

Boolean ('true' or 'false')

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.

"SessionTimeout"

This property is a member of SessionService

This is the number of seconds of inactivity that a session may have before the session service closes the session due to inactivity.

JSON type:

Integer from 30 to 86400.

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

PATCH Example

HTTP PATCH to resource with request JSON:

{"SessionTimeout": <integer-value>}

The property "SessionTimeout" on resource type SessionService may not support PATCH of all values and may result in an HTTP 400 error with response of Type ExtendedError. Multiple properties may be included in a single HTTP PATCH operation as long as the request is properly formatted JSON. To address an array entry other than the first, insert nulls as placeholders on skipped array entries.

"Status/Health"

This property is a member of SessionService

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

JSON type:

String containing one of the following supported values:

""
"OK"
"Warning"
"Critical"

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.

"Status/HealthRollUp"

This property is a member of SessionService

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

JSON type:

String containing one of the following supported values:

""
"OK"
"Warning"
"Critical"

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.

"Status/HealthRollup"

This property is a member of SessionService

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

JSON type:

String containing one of the following supported values:

""
"OK"
"Warning"
"Critical"

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.

"Status/State"

This property is a member of SessionService

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

JSON type:

String containing one of the following supported values:

""
"Enabled"
"Disabled"
"Offline"
"InTest"
"Starting"
"Absent"

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

PATCH Example

HTTP PATCH to resource with request JSON:

{"Location": "<string-value>"}

The property "Location" on resource type SnmpService may not support PATCH of all values and may result in an HTTP 400 error with response of Type ExtendedError. Multiple properties may be included in a single HTTP PATCH operation as long as the request is properly formatted JSON. To address an array entry other than the first, insert nulls as placeholders on skipped array entries.

"Mode"

This property is a member of SnmpService

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.

JSON type:

String containing one of the following supported values:

"Agentless"
"Passthru"

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

PATCH Example

HTTP PATCH to resource with request JSON:

{"Mode": "Passthru"}

The property "Mode" on resource type SnmpService may not support PATCH of all values and may result in an HTTP 400 error with response of Type ExtendedError. Multiple properties may be included in a single HTTP PATCH operation as long as the request is properly formatted JSON. To address an array entry other than the first, insert nulls as placeholders on skipped array entries.

"Oem/Hp/SNMPColdStartTrapBroadcast"

This property is a member of SnmpService

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.

JSON type:

Boolean ('true' or 'false')

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

PATCH Example

HTTP PATCH to resource with request JSON:

{"Oem": {"Hp": {"SNMPColdStartTrapBroadcast": true}}}

The property "Oem/Hp/SNMPColdStartTrapBroadcast" on resource type SnmpService may not support PATCH of all values and may result in an HTTP 400 error with response of Type ExtendedError. Multiple properties may be included in a single HTTP PATCH operation as long as the request is properly formatted JSON. To address an array entry other than the first, insert nulls as placeholders on skipped array entries.

"Oem/Hp/SNMPForwardInsightManagerAgentAlerts"

This property is a member of SnmpService

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.

JSON type:

Boolean ('true' or 'false')

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

PATCH Example

HTTP PATCH to resource with request JSON:

{"Oem": {"Hp": {"SNMPForwardInsightManagerAgentAlerts": true}}}

The property "Oem/Hp/SNMPForwardInsightManagerAgentAlerts" on resource type SnmpService may not support PATCH of all values and may result in an HTTP 400 error with response of Type ExtendedError. Multiple properties may be included in a single HTTP PATCH operation as long as the request is properly formatted JSON. To address an array entry other than the first, insert nulls as placeholders on skipped array entries.

"Role"

This property is a member of SnmpService

The string of up to 64 characters that describes the server role or function.

JSON type:

String

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

PATCH Example

HTTP PATCH to resource with request JSON:

{"Role": "<string-value>"}

The property "Role" on resource type SnmpService may not support PATCH of all values and may result in an HTTP 400 error with response of Type ExtendedError. Multiple properties may be included in a single HTTP PATCH operation as long as the request is properly formatted JSON. To address an array entry other than the first, insert nulls as placeholders on skipped array entries.

"RoleDetail"

This property is a member of SnmpService

The string of up to 512 characters that describes specific tasks that the server might perform.

JSON type:

String

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

PATCH Example

HTTP PATCH to resource with request JSON:

{"RoleDetail": "<string-value>"}

The property "RoleDetail" on resource type SnmpService may not support PATCH of all values and may result in an HTTP 400 error with response of Type ExtendedError. Multiple properties may be included in a single HTTP PATCH operation as long as the request is properly formatted JSON. To address an array entry other than the first, insert nulls as placeholders on skipped array entries.

"SNMPv1Traps"

This property is a member of SnmpService

When enabled, SNMPv1 traps are sent to the remote management systems configured in the SNMP Alert Destination(s) boxes.

JSON type:

Boolean ('true' or 'false')

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

PATCH Example

HTTP PATCH to resource with request JSON:

{"SNMPv1Traps": true}

The property "SNMPv1Traps" on resource type SnmpService may not support PATCH of all values and may result in an HTTP 400 error with response of Type ExtendedError. Multiple properties may be included in a single HTTP PATCH operation as long as the request is properly formatted JSON. To address an array entry other than the first, insert nulls as placeholders on skipped array entries.

"SNMPv3EngineID"

This property is a member of SnmpService

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

JSON type:

String

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

PATCH Example

HTTP PATCH to resource with request JSON:

{"SNMPv3EngineID": "<string-value>"}

The property "SNMPv3EngineID" on resource type SnmpService may not support PATCH of all values and may result in an HTTP 400 error with response of Type ExtendedError. Multiple properties may be included in a single HTTP PATCH operation as long as the request is properly formatted JSON. To address an array entry other than the first, insert nulls as placeholders on skipped array entries.

"Status/Health"

This property is a member of SnmpService

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

JSON type:

String containing one of the following supported values:

""
"OK"
"Warning"
"Critical"

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.

"Status/HealthRollUp"

This property is a member of SnmpService

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

JSON type:

String containing one of the following supported values:

""
"OK"
"Warning"
"Critical"

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.

"Status/HealthRollup"

This property is a member of SnmpService

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

JSON type:

String containing one of the following supported values:

""
"OK"
"Warning"
"Critical"

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.

"Status/State"

This property is a member of SnmpService

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

JSON type:

String containing one of the following supported values:

""
"Enabled"
"Disabled"
"Offline"
"InTest"
"Starting"
"Absent"

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.

"TrapSourceHostname"

This property is a member of SnmpService

Determines the host name that is used in the SNMP-defined sysName variable when the management processor generates SNMP traps.

JSON type:

String containing one of the following supported values:

"Manager"
"System"

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

PATCH Example

HTTP PATCH to resource with request JSON:

{"TrapSourceHostname": "System"}

The property "TrapSourceHostname" on resource type SnmpService may not support PATCH of all values and may result in an HTTP 400 error with response of Type ExtendedError. Multiple properties may be included in a single HTTP PATCH operation as long as the request is properly formatted JSON. To address an array entry other than the first, insert nulls as placeholders on skipped array entries.

"Users[]/AuthPassphrase"

This property is a member of SnmpService

Sets the passphrase to use for sign operations. Enter a value of 8 to 49 characters.

JSON type:

String

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

PATCH Example

HTTP PATCH to resource with request JSON:

{"Users": [{"AuthPassphrase": "<string-value>"}|null, ...]}

The property "Users[]/AuthPassphrase" on resource type SnmpService may not support PATCH of all values and may result in an HTTP 400 error with response of Type ExtendedError. Multiple properties may be included in a single HTTP PATCH operation as long as the request is properly formatted JSON. To address an array entry other than the first, insert nulls as placeholders on skipped array entries.

"Users[]/AuthProtocol"

This property is a member of SnmpService

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

JSON type:

String containing one of the following supported values:

"MD5"
"SHA"

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

PATCH Example

HTTP PATCH to resource with request JSON:

{"Users": [{"AuthProtocol": "SHA"}|null, ...]}

The property "Users[]/AuthProtocol" on resource type SnmpService may not support PATCH of all values and may result in an HTTP 400 error with response of Type ExtendedError. Multiple properties may be included in a single HTTP PATCH operation as long as the request is properly formatted JSON. To address an array entry other than the first, insert nulls as placeholders on skipped array entries.

"Users[]/PrivacyPassphrase"

This property is a member of SnmpService

Sets the passphrase to use for encrypt operations. Enter a value of 8 to 49 characters.

JSON type:

String

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

PATCH Example

HTTP PATCH to resource with request JSON:

{"Users": [{"PrivacyPassphrase": "<string-value>"}|null, ...]}

The property "Users[]/PrivacyPassphrase" on resource type SnmpService may not support PATCH of all values and may result in an HTTP 400 error with response of Type ExtendedError. Multiple properties may be included in a single HTTP PATCH operation as long as the request is properly formatted JSON. To address an array entry other than the first, insert nulls as placeholders on skipped array entries.

"Users[]/PrivacyProtocol"

This property is a member of SnmpService

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

JSON type:

String containing one of the following supported values:

"DES"
"AES"

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

PATCH Example

HTTP PATCH to resource with request JSON:

{"Users": [{"PrivacyProtocol": "AES"}|null, ...]}

The property "Users[]/PrivacyProtocol" on resource type SnmpService may not support PATCH of all values and may result in an HTTP 400 error with response of Type ExtendedError. Multiple properties may be included in a single HTTP PATCH operation as long as the request is properly formatted JSON. To address an array entry other than the first, insert nulls as placeholders on skipped array entries.

"Users[]/SecurityName"

This property is a member of SnmpService

The user profile name. Enter an alphanumeric string of 1 to 32 characters.

JSON type:

String

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

PATCH Example

HTTP PATCH to resource with request JSON:

{"Users": [{"SecurityName": "<string-value>"}|null, ...]}

The property "Users[]/SecurityName" on resource type SnmpService may not support PATCH of all values and may result in an HTTP 400 error with response of Type ExtendedError. Multiple properties may be included in a single HTTP PATCH operation as long as the request is properly formatted JSON. To address an array entry other than the first, insert nulls as placeholders on skipped array entries.

POST Action "SendSNMPTestAlert"

Example

HTTP POST to resource with request JSON:

{ "Action": "SendSNMPTestAlert"}

"Thermal" Resource Type

Resource Instances

/rest/v1/Chassis/{item}/Thermal

See Resource Map for more details.

The schema definition for the Thermal Metrics. It represents the properties for temperature and cooling.

"Thermal" defines the following properties:

"Fans[]/Context"

This property is a member of Thermal

The area or device to which this temperature measurement applies.

JSON type:

String containing one of the following supported values:

"System"
"System Board"
"I/O Board"
"CPU"
"Memory"
"Storage"
"Removable Media"
"Power Supply"
"Ambient"
"Chassis"
"Bridge Board"
"Exhaust"
"Processor Bay"
"IO Bay"
"Blade Slot"
"Virtual"

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.

"Fans[]/CorrelatableID"

This property is a member of Thermal

The CorrelatableID for this fan.

JSON type:

String

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.

"Fans[]/CurrentReading"

This property is a member of Thermal

The current speed of the fan.

JSON type:

Integer greater than or equal to 0.

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.

"Fans[]/FanName"

This property is a member of Thermal

The name of the fan sensor.

JSON type:

String

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.

"Fans[]/LowerThresholdCritical"

This property is a member of Thermal

Below normal range but not yet fatal.

JSON type:

Integer

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.

"Fans[]/LowerThresholdFatal"

This property is a member of Thermal

Below normal range and is fatal.

JSON type:

Integer

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.

"Fans[]/LowerThresholdNonCritical"

This property is a member of Thermal

Below normal range.

JSON type:

Integer

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.

"Fans[]/MaximumValue"

This property is a member of Thermal

Maximum value for CurrentReading.

JSON type:

Integer

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.

"Fans[]/MinimumValue"

This property is a member of Thermal

Minimum value for CurrentReading.

JSON type:

Integer

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.

"Fans[]/Oem/Hp/Location"

This property is a member of Thermal

Indicates the component (i.e. CPU, Memory, and Storage) that the fan is being used to cool.

JSON type:

String containing one of the following supported values:

"System"
"System Board"
"I/O Board"
"CPU"
"Memory"
"Storage"
"Removable Media"
"Power Supply"
"Ambient"
"Chassis"
"Bridge Board"
"Exhaust"
"Processor Bay"
"IO Bay"
"Blade Slot"
"Virtual"

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.

"Fans[]/PhysicalContext"

This property is a member of Thermal

JSON type:

String containing one of the following supported values:

"Room"
"Intake"
"Exhaust"
"Front"
"Back"
"Upper"
"Lower"
"CPU"
"GPU"
"Backplane"
"SystemBoard"
"PowerSupply"
"VoltageRegulator"
"StorageDevice"
"NetworkingDevice"
"ComputeBay"
"StorageBay"
"NetworkBay"
"ExpansionBay"
"PowerSupplyBay"

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.

"Fans[]/ReadingRPM"

This property is a member of Thermal

The current speed of the fan.

JSON type:

Integer greater than or equal to 0.

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.

"Fans[]/Status/Health"

This property is a member of Thermal

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

JSON type:

String containing one of the following supported values:

""
"OK"
"Warning"
"Critical"

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.

"Fans[]/Status/HealthRollUp"

This property is a member of Thermal

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

JSON type:

String containing one of the following supported values:

""
"OK"
"Warning"
"Critical"

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.

"Fans[]/Status/HealthRollup"

This property is a member of Thermal

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

JSON type:

String containing one of the following supported values:

""
"OK"
"Warning"
"Critical"

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.

"Fans[]/Status/State"

This property is a member of Thermal

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

JSON type:

String containing one of the following supported values:

""
"Enabled"
"Disabled"
"Offline"
"InTest"
"Starting"
"Absent"

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.

"Fans[]/Units"

This property is a member of Thermal

Units for the CurrentReading.

JSON type:

String containing one of the following supported values:

""
"RPM"
"Percent"

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.

"Fans[]/UpperThresholdCritical"

This property is a member of Thermal

Above normal range but not yet fatal.

JSON type:

Integer

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.

"Fans[]/UpperThresholdFatal"

This property is a member of Thermal

Above normal range and is fatal.

JSON type:

Integer

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.

"Fans[]/UpperThresholdNonCritical"

This property is a member of Thermal

Above normal range.

JSON type:

Integer

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.

"Status/Health"

This property is a member of Thermal

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

JSON type:

String containing one of the following supported values:

""
"OK"
"Warning"
"Critical"

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.

"Status/HealthRollUp"

This property is a member of Thermal

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

JSON type:

String containing one of the following supported values:

""
"OK"
"Warning"
"Critical"

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.

"Status/HealthRollup"

This property is a member of Thermal

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

JSON type:

String containing one of the following supported values:

""
"OK"
"Warning"
"Critical"

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.

"Status/State"

This property is a member of Thermal

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

JSON type:

String containing one of the following supported values:

""
"Enabled"
"Disabled"
"Offline"
"InTest"
"Starting"
"Absent"

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.

"Temperatures[]/Context"

This property is a member of Thermal

The area or device to which this temperature measurement applies.

JSON type:

String containing one of the following supported values:

"System"
"System Board"
"I/O Board"
"CPU"
"Memory"
"Storage"
"Removable Media"
"Power Supply"
"Ambient"
"Chassis"
"Bridge Board"
"Exhaust"
"Processor Bay"
"IO Bay"
"Blade Slot"
"Virtual"

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.

"Temperatures[]/CorrelatableID"

This property is a member of Thermal

The CorrelatableID for this temperature sensor.

JSON type:

String

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.

"Temperatures[]/CurrentReading"

This property is a member of Thermal

The current reading of the temperature sensor.

JSON type:

Integer

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.

"Temperatures[]/LowerThresholdCritical"

This property is a member of Thermal

Below normal range but not yet fatal.

JSON type:

Integer

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.

"Temperatures[]/LowerThresholdFatal"

This property is a member of Thermal

Below normal range and is fatal.

JSON type:

Integer

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.

"Temperatures[]/LowerThresholdNonCritical"

This property is a member of Thermal

Below normal range.

JSON type:

Integer

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.

"Temperatures[]/MaximumValue"

This property is a member of Thermal

Maximum value for CurrentReading.

JSON type:

Integer

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.

"Temperatures[]/MinimumValue"

This property is a member of Thermal

Minimum value for CurrentReading.

JSON type:

Integer

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.

"Temperatures[]/Number"

This property is a member of Thermal

A numerical identifier to represent the temperature sensor.

JSON type:

Integer

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.

"Temperatures[]/Oem/Hp/LocationXmm"

This property is a member of Thermal

The location of the sensor, in millimeters, along the X axis from the logical reference point.

JSON type:

Integer greater than or equal to 0.

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.

"Temperatures[]/Oem/Hp/LocationYmm"

This property is a member of Thermal

The location of the sensor, in millimeters, along the Y axis from the logical reference point.

JSON type:

Integer greater than or equal to 0.

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.

"Temperatures[]/Oem/Hp/LocationZmm"

This property is a member of Thermal

The location of the sensor, in millimeters, along the Z axis from the logical reference point.

JSON type:

Integer greater than or equal to 0.

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.

"Temperatures[]/PhysicalContext"

This property is a member of Thermal

JSON type:

String containing one of the following supported values:

"Room"
"Intake"
"Exhaust"
"Front"
"Back"
"Upper"
"Lower"
"CPU"
"GPU"
"Backplane"
"SystemBoard"
"PowerSupply"
"VoltageRegulator"
"StorageDevice"
"NetworkingDevice"
"ComputeBay"
"StorageBay"
"NetworkBay"
"ExpansionBay"
"PowerSupplyBay"

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not.

"Temperatures[]/ReadingCelsius"

This property is a member of Thermal

The current reading of the temperature sensor.

JSON type:

Integer

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.

"Temperatures[]/Status/Health"

This property is a member of Thermal

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

JSON type:

String containing one of the following supported values:

""
"OK"
"Warning"
"Critical"

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.

"Temperatures[]/Status/HealthRollUp"

This property is a member of Thermal

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

JSON type:

String containing one of the following supported values:

""
"OK"
"Warning"
"Critical"

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.

"Temperatures[]/Status/HealthRollup"

This property is a member of Thermal

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

JSON type:

String containing one of the following supported values:

""
"OK"
"Warning"
"Critical"

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.

"Temperatures[]/Status/State"

This property is a member of Thermal

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

JSON type:

String containing one of the following supported values:

""
"Enabled"
"Disabled"
"Offline"
"InTest"
"Starting"
"Absent"

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.

"Temperatures[]/Units"

This property is a member of Thermal

The temperature sensor's units.

JSON type:

String containing one of the following supported values:

""
"Celsius"
"Fahrenheit"

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.

"Temperatures[]/UpperThresholdCritical"

This property is a member of Thermal

Above normal range but not yet fatal.

JSON type:

Integer

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.

"Temperatures[]/UpperThresholdFatal"

This property is a member of Thermal

Above normal range and is fatal.

JSON type:

Integer

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.

"Temperatures[]/UpperThresholdNonCritical"

This property is a member of Thermal

The noncritical temperature threshold.

JSON type:

Integer

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.

"VirtualMedia" Resource Type

Resource Instances

/rest/v1/Managers/{item}/VirtualMedia/{item}

See Resource Map for more details.

This is the schema definition for the Virtual Media service.

"VirtualMedia" defines the following properties:

"ConnectedVia"

This property is a member of VirtualMedia

Specifies how the virtual media is connected to the server.

JSON type:

String containing one of the following supported values:

""
"NotConnected"
"URI"
"Applet"

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.

"Image"

This property is a member of VirtualMedia

The valid URI indicating the image that is mounted on this server. A null value indicates that no image exists.

JSON type:

String

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

PATCH Example

HTTP PATCH to resource with request JSON:

{"Image": "<string-value>"}

GET	Rendered if supported by the implementation or omitted if not.
PATCH	This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

PATCH Example

HTTP PATCH to resource with request JSON:

{"Oem": {"Hp": {"BootOnNextServerReset": true}}}

The property "Oem/Hp/BootOnNextServerReset" on resource type VirtualMedia may not support PATCH of all values and may result in an HTTP 400 error with response of Type ExtendedError. Multiple properties may be included in a single HTTP PATCH operation as long as the request is properly formatted JSON. To address an array entry other than the first, insert nulls as placeholders on skipped array entries.

"WriteProtected"

This property is a member of VirtualMedia

Indicates whether the virtual media is protected against write operations.

JSON type:

Boolean ('true' or 'false')

HTTP Operations

GET	Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.

POST Action "InsertVirtualMedia"

Parameter "Target"

"Target" must be one of the following value(s):

"/Oem/Hp"

Parameter "Image"

"Image" must be one of the following value(s):

Parameter "Intent"

"Intent" must be one of the following value(s):

Parameter "Signature"

"Signature" must be one of the following value(s):

Example

HTTP POST to resource with request JSON:

{ "Action": "InsertVirtualMedia", "Target": "/Oem/Hp", "Image": "", "Intent": "", "Signature": ""}

POST Action "EjectVirtualMedia"

Parameter "Target"

"Target" must be one of the following value(s):

"/Oem/Hp"

Parameter "Intent"

"Intent" must be one of the following value(s):

Parameter "Signature"

"Signature" must be one of the following value(s):

Example

HTTP POST to resource with request JSON:

Duplicate SNMPv3 User.

Severity: Warning

Resolution: Enter a different name and try again.

iLO.iLOResetAndSystemRebootRequired

Indicates that one or more properties were correctly changed, but will not take effect until device is reset and system is rebooted.

Severity: Warning

Resolution: Reset iLO and reboot the server.

/rest/v1	ServiceRoot	HTTP Allow: GET
	Links to other resources	to resource URI	to resource Type
	/Oem/Hp/links/ResourceDirectory	/rest/v1/ResourceDirectory	HpiLOResourceDirectory
	/links/AccountService	/rest/v1/AccountService	AccountService
	/links/Chassis	/rest/v1/Chassis	Collection
	/links/EventService	/rest/v1/EventService	EventService
	/links/Managers	/rest/v1/Managers	Collection
	/links/Registries	/rest/v1/Registries	Collection
	/links/Schemas	/rest/v1/Schemas	Collection
	/links/SessionService	/rest/v1/SessionService	SessionService
	/links/Sessions	/rest/v1/SessionService/Sessions	Collection
	/links/Systems	/rest/v1/Systems	Collection

/rest/v1/AccountService	AccountService	HTTP Allow: GET, PATCH
	Links to other resources	to resource URI	to resource Type
	/links/Accounts	/rest/v1/AccountService/Accounts	Collection

/rest/v1/AccountService/Accounts	Collection	HTTP Allow: GET, POST
	Links to other resources	to resource URI	to resource Type
	/links/Member[]	/rest/v1/AccountService/Accounts/{item}	ManagerAccount

/rest/v1/AccountService/Accounts/{item}	ManagerAccount	HTTP Allow: GET, PATCH, DELETE
	Links to other resources	to resource URI	to resource Type

/rest/v1/Chassis	Collection	HTTP Allow: GET
	Links to other resources	to resource URI	to resource Type
	/links/Member[]	/rest/v1/Chassis/{item}	Chassis

/rest/v1/Chassis/{item}	Chassis	HTTP Allow: GET
	Links to other resources	to resource URI	to resource Type
	/links/ComputerSystems[]	/rest/v1/Systems/{item}	ComputerSystem
	/links/ManagedBy[]	/rest/v1/Managers/{item}	Manager
	/links/PowerMetrics	/rest/v1/Chassis/{item}/Power	Power
	/links/ThermalMetrics	/rest/v1/Chassis/{item}/Thermal	Thermal

/rest/v1/Chassis/{item}/Power	Power	HTTP Allow: GET, PATCH
	Links to other resources	to resource URI	to resource Type
	/Oem/Hp/links/FastPowerMeter	/rest/v1/Chassis/{item}/Power/FastPowerMeter	HPPowerMeter
	/Oem/Hp/links/FederatedGroupCapping	/rest/v1/Chassis/{item}/Power/FederatedGroupCapping	HpiLOFederatedGroupCapping
	/Oem/Hp/links/PowerMeter	/rest/v1/Chassis/{item}/Power/PowerMeter	HPPowerMeter

/rest/v1/Chassis/{item}/Power/FastPowerMeter	HPPowerMeter	HTTP Allow: GET
	Links to other resources	to resource URI	to resource Type

/rest/v1/Chassis/{item}/Power/FederatedGroupCapping	HpiLOFederatedGroupCapping	HTTP Allow: GET, PATCH
	Links to other resources	to resource URI	to resource Type

/rest/v1/Chassis/{item}/Power/PowerMeter	HPPowerMeter	HTTP Allow: GET
	Links to other resources	to resource URI	to resource Type

/rest/v1/Chassis/{item}/Thermal	Thermal	HTTP Allow: GET
	Links to other resources	to resource URI	to resource Type

/rest/v1/EventService	EventService	HTTP Allow: GET, POST
	Links to other resources	to resource URI	to resource Type
	/links/Subscriptions	/rest/v1/EventService/EventSubscriptions	Collection

/rest/v1/EventService/EventSubscriptions	Collection	HTTP Allow: GET, POST
	Links to other resources	to resource URI	to resource Type

/rest/v1/Managers	Collection	HTTP Allow: GET
	Links to other resources	to resource URI	to resource Type
	/links/Member[]	/rest/v1/Managers/{item}	Manager

/rest/v1/Managers/{item}	Manager	HTTP Allow: GET, PATCH, POST
	Links to other resources	to resource URI	to resource Type
	/Oem/Hp/links/ActiveHealthSystem	/rest/v1/Managers/{item}/ActiveHealthSystem	HpiLOActiveHealthSystem
	/Oem/Hp/links/DateTimeService	/rest/v1/Managers/{item}/DateTime	HpiLODateTime
	/Oem/Hp/links/EmbeddedMediaService	/rest/v1/Managers/{item}/EmbeddedMedia	HpiLOEmbeddedMedia
	/Oem/Hp/links/FederationGroups	/rest/v1/Managers/{item}/FederationGroups	Collection
	/Oem/Hp/links/FederationPeers	/rest/v1/Managers/{item}/FederationPeers	Collection
	/Oem/Hp/links/LicenseService	/rest/v1/Managers/{item}/LicenseService	Collection
	/Oem/Hp/links/SecurityService	/rest/v1/Managers/{item}/SecurityService	HpSecurityService
	/Oem/Hp/links/UpdateService	/rest/v1/Managers/{item}/UpdateService	HpiLOFirmwareUpdate
	/links/EthernetNICs	/rest/v1/Managers/{item}/EthernetInterfaces	Collection
	/links/Logs	/rest/v1/Managers/{item}/LogServices	Collection
	/links/ManagerForChassis[]	/rest/v1/Chassis/{item}	Chassis
	/links/ManagerForServers[]	/rest/v1/Systems/{item}	ComputerSystem
	/links/NetworkService	/rest/v1/Managers/{item}/NetworkService	ManagerNetworkProtocol
	/links/VirtualMedia	/rest/v1/Managers/{item}/VirtualMedia	Collection

/rest/v1/Managers/{item}/ActiveHealthSystem	HpiLOActiveHealthSystem	HTTP Allow: GET, PATCH, POST
	Links to other resources	to resource URI	to resource Type

/rest/v1/Managers/{item}/DateTime	HpiLODateTime	HTTP Allow: GET, PATCH
	Links to other resources	to resource URI	to resource Type
	links/EthernetNIC	/rest/v1/Managers/{item}/NICs	Collection

/rest/v1/Managers/{item}/EmbeddedMedia	HpiLOEmbeddedMedia	HTTP Allow: GET
	Links to other resources	to resource URI	to resource Type

/rest/v1/Managers/{item}/EthernetInterfaces	Collection	HTTP Allow: GET
	Links to other resources	to resource URI	to resource Type
	/Items[]/Oem/Hp/links/DateTimeService	/rest/v1/Managers/{item}/DateTime	HpiLODateTime
	/Items[]/links/NetworkServices[]	/rest/v1/Managers/{item}/NetworkService	ManagerNetworkProtocol
	/links/Member[]	/rest/v1/Managers/{item}/EthernetInterfaces/{item}	EthernetInterface

/rest/v1/Managers/{item}/EthernetInterfaces/{item}	EthernetInterface	HTTP Allow: GET, PATCH
	Links to other resources	to resource URI	to resource Type
	/Oem/Hp/links/DateTimeService	/rest/v1/Managers/{item}/DateTime	HpiLODateTime
	/links/NetworkServices[]	/rest/v1/Managers/{item}/NetworkService	ManagerNetworkProtocol

/rest/v1/Managers/{item}/FederationGroups	Collection	HTTP Allow: GET, POST
	Links to other resources	to resource URI	to resource Type
	/links/Member[]	/rest/v1/Managers/{item}/FederationGroups/{item}	HpiLOFederationGroup

/rest/v1/Managers/{item}/FederationGroups/{item}	HpiLOFederationGroup	HTTP Allow: GET, PATCH, DELETE
	Links to other resources	to resource URI	to resource Type

/rest/v1/Managers/{item}/FederationPeers	Collection	HTTP Allow: GET
	Links to other resources	to resource URI	to resource Type
	/links/Member[]	/rest/v1/Managers/{item}/FederationPeers/{item}	HpiLOFederationPeers

/rest/v1/Managers/{item}/FederationPeers/{item}	HpiLOFederationPeers	HTTP Allow: GET
	Links to other resources	to resource URI	to resource Type

/rest/v1/Managers/{item}/LicenseService	Collection	HTTP Allow: GET, POST
	Links to other resources	to resource URI	to resource Type
	/links/Member[]	/rest/v1/Managers/{item}/LicenseService/{item}	HpiLOLicense

/rest/v1/Managers/{item}/LicenseService/{item}	HpiLOLicense	HTTP Allow: GET, DELETE
	Links to other resources	to resource URI	to resource Type

/rest/v1/Managers/{item}/LogServices	Collection	HTTP Allow: GET
	Links to other resources	to resource URI	to resource Type
	/links/Member[]	/rest/v1/Managers/{item}/LogServices/IEL	LogService

/rest/v1/Managers/{item}/LogServices/IEL	LogService	HTTP Allow: GET, POST
	Links to other resources	to resource URI	to resource Type
	/links/Entries[]	/rest/v1/Managers/{item}/LogServices/IEL/Entries	Collection

/rest/v1/Managers/{item}/LogServices/IEL/Entries	Collection	HTTP Allow: GET
	Links to other resources	to resource URI	to resource Type
	/links/Member[]	/rest/v1/Managers/{item}/LogServices/IEL/Entries/{item}	LogEntry

/rest/v1/Managers/{item}/LogServices/IEL/Entries/{item}	LogEntry	HTTP Allow: GET
	Links to other resources	to resource URI	to resource Type

/rest/v1/Managers/{item}/NetworkService	ManagerNetworkProtocol	HTTP Allow: GET, PATCH, POST
	Links to other resources	to resource URI	to resource Type
	/Oem/Hp/links/EthernetNICs	/rest/v1/Managers/{item}/EthernetInterfaces	Collection
	/links/SNMPService	/rest/v1/Managers/{item}/SnmpService	SnmpService

/rest/v1/Managers/{item}/SecurityService	HpSecurityService	HTTP Allow: GET
	Links to other resources	to resource URI	to resource Type
	/links/ESKM	/rest/v1/Managers/{item}/SecurityService/ESKM	HpESKM
	/links/HttpsCert	/rest/v1/Managers/{item}/SecurityService/HttpsCert	HpHttpsCert
	/links/SSO	/rest/v1/Managers/{item}/SecurityService/SSO	HpiLOSSO

/rest/v1/Managers/{item}/SecurityService/ESKM	HpESKM	HTTP Allow: GET, PATCH, POST
	Links to other resources	to resource URI	to resource Type

/rest/v1/Managers/{item}/SecurityService/HttpsCert	HpHttpsCert	HTTP Allow: GET, PATCH, POST
	Links to other resources	to resource URI	to resource Type

/rest/v1/Managers/{item}/SecurityService/SSO	HpiLOSSO	HTTP Allow: GET, PATCH, POST
	Links to other resources	to resource URI	to resource Type

/rest/v1/Managers/{item}/SnmpService	SnmpService	HTTP Allow: GET, PATCH, POST
	Links to other resources	to resource URI	to resource Type

/rest/v1/Managers/{item}/UpdateService	HpiLOFirmwareUpdate	HTTP Allow: GET, POST
	Links to other resources	to resource URI	to resource Type

/rest/v1/Managers/{item}/VirtualMedia	Collection	HTTP Allow: GET
	Links to other resources	to resource URI	to resource Type
	/links/Member[]	/rest/v1/Managers/{item}/VirtualMedia/{item}	VirtualMedia

/rest/v1/Managers/{item}/VirtualMedia/{item}	VirtualMedia	HTTP Allow: GET, PATCH
	Links to other resources	to resource URI	to resource Type

/rest/v1/Registries	Collection	HTTP Allow: GET
	Links to other resources	to resource URI	to resource Type
	/links/Member[]	/rest/v1/Registries/{item}	SchemaFile

/rest/v1/Registries/{item}	SchemaFile	HTTP Allow: GET
	Links to other resources	to resource URI	to resource Type

/rest/v1/ResourceDirectory	HpiLOResourceDirectory	HTTP Allow: GET
	Links to other resources	to resource URI	to resource Type
	/Instances[]	/rest/v1	ServiceRoot

/rest/v1/Schemas	Collection	HTTP Allow: GET
	Links to other resources	to resource URI	to resource Type
	/links/Member[]	/rest/v1/Schemas/{item}	SchemaFile

/rest/v1/Schemas/{item}	SchemaFile	HTTP Allow: GET
	Links to other resources	to resource URI	to resource Type

/rest/v1/SessionService	SessionService	HTTP Allow: GET, PATCH
	Links to other resources	to resource URI	to resource Type
	/links/Sessions	/rest/v1/SessionService/Sessions	Collection

/rest/v1/SessionService/Sessions	Collection	HTTP Allow: GET, POST
	Links to other resources	to resource URI	to resource Type
	/Oem/Hp/links/MySession	/rest/v1/SessionService/Sessions/{item}	Session
	/links/Member[]	/rest/v1/SessionService/Sessions/{item}	Session

/rest/v1/SessionService/Sessions/{item}	Session	HTTP Allow: GET, DELETE
	Links to other resources	to resource URI	to resource Type

/rest/v1/Systems	Collection	HTTP Allow: GET
	Links to other resources	to resource URI	to resource Type
	/links/Member[]	/rest/v1/Systems/{item}	ComputerSystem

/rest/v1/Systems/{item}	ComputerSystem	HTTP Allow: GET, PATCH, POST
	Links to other resources	to resource URI	to resource Type
	/Oem/Hp/links/BIOS	/rest/v1/Systems/{item}/Bios	HpBios
	/Oem/Hp/links/FirmwareInventory	/rest/v1/Systems/{item}/FirmwareInventory	FwSwVersionInventory
	/Oem/Hp/links/Memory	/rest/v1/Systems/{item}/Memory	Collection
	/Oem/Hp/links/NetworkAdapters	/rest/v1/Systems/{item}/NetworkAdapters	Collection
	/Oem/Hp/links/PCIDevices	/rest/v1/Systems/{item}/PCIDevices	Collection
	/Oem/Hp/links/PCISlots	/rest/v1/Systems/{item}/PCISlots	Collection
	/Oem/Hp/links/SecureBoot	/rest/v1/Systems/{item}/SecureBoot	HpSecureBoot
	/Oem/Hp/links/SmartStorage	/rest/v1/Systems/{item}/SmartStorage	HpSmartStorage
	/links/Chassis[]	/rest/v1/Chassis/{item}	Chassis
	/links/Logs	/rest/v1/Systems/{item}/LogServices	Collection
	/links/ManagedBy[]	/rest/v1/Managers/{item}	Manager

/rest/v1/Systems/{item}/Bios	HpBios	HTTP Allow: GET
	Links to other resources	to resource URI	to resource Type
	/links/BaseConfigs	/rest/v1/Systems/{item}/Bios/BaseConfigs	HpBaseConfigs
	/links/Boot	/rest/v1/Systems/{item}/Bios/Boot	HpServerBootSettings
	/links/Mappings	/rest/v1/Systems/{item}/Bios/Mappings	HpBiosMapping
	/links/Settings	/rest/v1/Systems/{item}/Bios/Settings	HpBios
	/links/iScsi	/rest/v1/Systems/{item}/Bios/iScsi	HpiSCSISoftwareInitiator

/rest/v1/Systems/{item}/Bios/BaseConfigs	HpBaseConfigs	HTTP Allow: GET
	Links to other resources	to resource URI	to resource Type

/rest/v1/Systems/{item}/Bios/Boot	HpServerBootSettings	HTTP Allow: GET
	Links to other resources	to resource URI	to resource Type
	/links/BaseConfigs	/rest/v1/Systems/{item}/Bios/Boot/BaseConfigs	HpBaseConfigs
	/links/Settings	/rest/v1/Systems/{item}/Bios/Boot/Settings	HpServerBootSettings

/rest/v1/Systems/{item}/Bios/Boot/BaseConfigs	HpBaseConfigs	HTTP Allow: GET
	Links to other resources	to resource URI	to resource Type

/rest/v1/Systems/{item}/Bios/Boot/Settings	HpServerBootSettings	HTTP Allow: GET, PATCH, PUT
	Links to other resources	to resource URI	to resource Type

/rest/v1/Systems/{item}/Bios/Mappings	HpBiosMapping	HTTP Allow: GET
	Links to other resources	to resource URI	to resource Type

/rest/v1/Systems/{item}/Bios/Settings	HpBios	HTTP Allow: GET, PATCH, PUT
	Links to other resources	to resource URI	to resource Type

/rest/v1/Systems/{item}/Bios/iScsi	HpiSCSISoftwareInitiator	HTTP Allow: GET
	Links to other resources	to resource URI	to resource Type
	/links/BaseConfigs	/rest/v1/Systems/{item}/Bios/iScsi/BaseConfigs	HpBaseConfigs
	/links/Mappings	/rest/v1/Systems/{item}/Bios/Mappings	HpBiosMapping
	/links/Settings	/rest/v1/Systems/{item}/Bios/iScsi/Settings	HpiSCSISoftwareInitiator

/rest/v1/Systems/{item}/Bios/iScsi/BaseConfigs	HpBaseConfigs	HTTP Allow: GET
	Links to other resources	to resource URI	to resource Type

/rest/v1/Systems/{item}/Bios/iScsi/Settings	HpiSCSISoftwareInitiator	HTTP Allow: GET, PATCH, PUT
	Links to other resources	to resource URI	to resource Type

/rest/v1/Systems/{item}/FirmwareInventory	FwSwVersionInventory	HTTP Allow: GET
	Links to other resources	to resource URI	to resource Type

/rest/v1/Systems/{item}/LogServices	Collection	HTTP Allow: GET
	Links to other resources	to resource URI	to resource Type
	/links/Member[]	/rest/v1/Systems/{item}/LogServices/IML	LogService

/rest/v1/Systems/{item}/LogServices/IML	LogService	HTTP Allow: GET, POST
	Links to other resources	to resource URI	to resource Type
	/links/Entries[]	/rest/v1/Systems/{item}/LogServices/IML/Entries	Collection

/rest/v1/Systems/{item}/LogServices/IML/Entries	Collection	HTTP Allow: GET, POST
	Links to other resources	to resource URI	to resource Type
	/links/Member[]	/rest/v1/Systems/{item}/LogServices/IML/Entries/{item}	LogEntry

/rest/v1/Systems/{item}/LogServices/IML/Entries/{item}	LogEntry	HTTP Allow: GET, PATCH
	Links to other resources	to resource URI	to resource Type

/rest/v1/Systems/{item}/Memory	Collection	HTTP Allow: GET
	Links to other resources	to resource URI	to resource Type
	/links/Member[]	/rest/v1/Systems/{item}/Memory/{item}	HpMemory

/rest/v1/Systems/{item}/Memory/{item}	HpMemory	HTTP Allow: GET
	Links to other resources	to resource URI	to resource Type

/rest/v1/Systems/{item}/NetworkAdapters	Collection	HTTP Allow: GET
	Links to other resources	to resource URI	to resource Type
	/links/Member[]	/rest/v1/Systems/{item}/NetworkAdapters/{item}	BaseNetworkAdapter

/rest/v1/Systems/{item}/NetworkAdapters/{item}	BaseNetworkAdapter	HTTP Allow: GET
	Links to other resources	to resource URI	to resource Type

/rest/v1/Systems/{item}/PCIDevices	Collection	HTTP Allow: GET
	Links to other resources	to resource URI	to resource Type
	/links/Member[]	/rest/v1/Systems/{item}/PCIDevices/{item}	HpServerPciDevice

/rest/v1/Systems/{item}/PCIDevices/{item}	HpServerPciDevice	HTTP Allow: GET, PATCH
	Links to other resources	to resource URI	to resource Type

/rest/v1/Systems/{item}/PCISlots	Collection	HTTP Allow: GET
	Links to other resources	to resource URI	to resource Type
	/links/Member[]	/rest/v1/Systems/{item}/PCISlots/{item}	HpServerPCISlot

/rest/v1/Systems/{item}/PCISlots/{item}	HpServerPCISlot	HTTP Allow: GET, PATCH
	Links to other resources	to resource URI	to resource Type

/rest/v1/Systems/{item}/SecureBoot	HpSecureBoot	HTTP Allow: GET, PATCH
	Links to other resources	to resource URI	to resource Type

/rest/v1/Systems/{item}/SmartStorage	HpSmartStorage	HTTP Allow: GET
	Links to other resources	to resource URI	to resource Type
	/links/ArrayControllers	/rest/v1/Systems/{item}/SmartStorage/ArrayControllers	Collection
	/links/HostBusAdapters	/rest/v1/Systems/{item}/SmartStorage/HostBusAdapters	Collection

/rest/v1/Systems/{item}/SmartStorage/ArrayControllers	Collection	HTTP Allow: GET
	Links to other resources	to resource URI	to resource Type
	/links/Member[]	/rest/v1/Systems/{item}/SmartStorage/ArrayControllers/{item}	HpSmartStorageArrayController

/rest/v1/Systems/{item}/SmartStorage/ArrayControllers/{item}	HpSmartStorageArrayController	HTTP Allow: GET
	Links to other resources	to resource URI	to resource Type
	/links/LogicalDrives	/rest/v1/Systems/{item}/SmartStorage/ArrayControllers/{item}/LogicalDrives	Collection
	/links/PhysicalDrives	/rest/v1/Systems/{item}/SmartStorage/ArrayControllers/{item}/DiskDrives	Collection
	/links/StorageEnclosures	/rest/v1/Systems/{item}/SmartStorage/ArrayControllers/{item}/StorageEnclosures	Collection

/rest/v1/Systems/{item}/SmartStorage/ArrayControllers/{item}/DiskDrives	Collection	HTTP Allow: GET
	Links to other resources	to resource URI	to resource Type
	/links/Member[]	/rest/v1/Systems/{item}/SmartStorage/ArrayControllers/{item}/DiskDrives/{item}	HpSmartStorageDiskDrive

/rest/v1/Systems/{item}/SmartStorage/ArrayControllers/{item}/DiskDrives/{item}	HpSmartStorageDiskDrive	HTTP Allow: GET
	Links to other resources	to resource URI	to resource Type

/rest/v1/Systems/{item}/SmartStorage/ArrayControllers/{item}/LogicalDrives	Collection	HTTP Allow: GET
	Links to other resources	to resource URI	to resource Type
	/links/Member[]	/rest/v1/Systems/{item}/SmartStorage/ArrayControllers/{item}/LogicalDrives/{item}	HpSmartStorageLogicalDrive

/rest/v1/Systems/{item}/SmartStorage/ArrayControllers/{item}/LogicalDrives/{item}	HpSmartStorageLogicalDrive	HTTP Allow: GET
	Links to other resources	to resource URI	to resource Type

/rest/v1/Systems/{item}/SmartStorage/ArrayControllers/{item}/StorageEnclosures	Collection	HTTP Allow: GET
	Links to other resources	to resource URI	to resource Type
	/links/Member[]	/rest/v1/Systems/{item}/SmartStorage/ArrayControllers/{item}/StorageEnclosures/{item}	HpSmartStorageStorageEnclosure

/rest/v1/Systems/{item}/SmartStorage/ArrayControllers/{item}/StorageEnclosures/{item}	HpSmartStorageStorageEnclosure	HTTP Allow: GET
	Links to other resources	to resource URI	to resource Type

/rest/v1/Systems/{item}/SmartStorage/HostBusAdapters	Collection	HTTP Allow: GET
	Links to other resources	to resource URI	to resource Type

iLO RESTful API Data Model Reference (iLO 4)

Abstract

Copyright and Acknowledgements

Acknowledgments

Prerequisites and Audience

First Things

Key Benefits of the iLO RESTful API

Requirements for using the iLO RESTful API

Redfish 1.0

How to Use This Document

Resource Map

Data Model Type Reference

"AccountService" Resource Type

Resource Instances

"Oem/Hp/AuthFailureDelayTimeSeconds"

HTTP Operations

PATCH Example

"Oem/Hp/AuthFailureLoggingThreshold"

HTTP Operations

PATCH Example

"Oem/Hp/AuthFailuresBeforeDelay"

HTTP Operations

PATCH Example

"Oem/Hp/MinPasswordLength"

HTTP Operations

PATCH Example

"BaseNetworkAdapter" Resource Type

Resource Instances

"Firmware/Current/VersionString"

HTTP Operations

"PartNumber"

HTTP Operations

"PhysicalPorts[]/FullDuplex"

HTTP Operations

"PhysicalPorts[]/IPv4Addresses[]/Address"

HTTP Operations

"PhysicalPorts[]/IPv6Addresses[]/Address"

HTTP Operations

"PhysicalPorts[]/MacAddress"

HTTP Operations

"PhysicalPorts[]/Oem/Hp/BadReceives"

HTTP Operations

"PhysicalPorts[]/Oem/Hp/BadTransmits"

HTTP Operations

"PhysicalPorts[]/Oem/Hp/GoodReceives"

HTTP Operations

"PhysicalPorts[]/Oem/Hp/GoodTransmits"

HTTP Operations

"PhysicalPorts[]/Oem/Hp/StructuredName"

HTTP Operations

"PhysicalPorts[]/Oem/Hp/Team"

HTTP Operations

"PhysicalPorts[]/SpeedMbps"

HTTP Operations

"PhysicalPorts[]/Status/Health"

HTTP Operations

"PhysicalPorts[]/Status/HealthRollUp"

HTTP Operations

"PhysicalPorts[]/Status/HealthRollup"

HTTP Operations

"PhysicalPorts[]/Status/State"

HTTP Operations

"PhysicalPorts[]/UEFIDevicePath"

HTTP Operations

"SerialNumber"

HTTP Operations

"Status/Health"

HTTP Operations

"Status/HealthRollUp"

HTTP Operations

"Status/HealthRollup"

HTTP Operations

"Status/State"

HTTP Operations

"StructuredName"

HTTP Operations

"UEFIDevicePath"

HTTP Operations

"Chassis" Resource Type

Resource Instances