This document is a reference to the types, properties, and attributes in the RESTFul API for Moonshot Chassis Manager 1.51.

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 HPE Servers Using the RESTful API." This other document is an introduction to using the RESTful API, while this document provides detail on individual properties and messages.

First Things

HPE Moonshot running Chassis Manager 1.30 or later features a new management interface called the “RESTful API.” The 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 RESTful API.

Key Benefits of the RESTful API

This RESTful API will become the main management API for Moonshot. Using this API you can take full inventory of the Moonshot enclosure, control power and reset, configure 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 RESTful API

The RESTful API for iLO is available on Moonshot servers running iLO Chassis Manager and does not require a license.

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

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

"CartridgeLinkEntry" Resource Type

Resource Instances

/rest/v1/Chassis/{item}/CartridgeLinks/Entries/{item}

See Resource Map for more details.

"CartridgeLinkEntry" defines the following properties:

"Architecture"

This property is a member of CartridgeLinkEntry

JSON type:

String

HTTP Operations

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

"CartridgeLinks[]/Architecture"

This property is a member of CartridgeLinkEntry

JSON type:

String

HTTP Operations

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

"CartridgeLinks[]/LinkEnabled"

This property is a member of CartridgeLinkEntry

This property is true if the link is enabled

JSON type:

Boolean ('true' or 'false')

HTTP Operations

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

"CartridgeLinks[]/Speed"

This property is a member of CartridgeLinkEntry

JSON type:

String

HTTP Operations

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

"CartridgeLinks[]/Via"

This property is a member of CartridgeLinkEntry

JSON type:

String

HTTP Operations

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

"LinkEnabled"

This property is a member of CartridgeLinkEntry

This property is true if the link is enabled

JSON type:

Boolean ('true' or 'false')

HTTP Operations

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

"LinkFrom"

This property is a member of CartridgeLinkEntry

JSON type:

String

HTTP Operations

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

"LinkTo"

This property is a member of CartridgeLinkEntry

JSON type:

String

HTTP Operations

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

"Speed"

This property is a member of CartridgeLinkEntry

JSON type:

String

HTTP Operations

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

"Via"

This property is a member of CartridgeLinkEntry

JSON type:

String

HTTP Operations

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

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

The property "IndicatorLED" 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.

"Manufacturer"

This property is a member of Chassis

The chassis manufacturer.

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.

"Model"

This property is a member of Chassis

The chassis model 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.

"Oem/Hp/AutoPowerOn"

This property is a member of Chassis

Auto Power On

JSON type:

String containing one of the following supported values:

"On"
"Off"

HTTP Operations

GET	Rendered if supported by the implementation 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": {"AutoPowerOn": "Off"}}}

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

"Oem/Hp/BayNumber"

This property is a member of Chassis

Position of the chassis inside an enclosure.

JSON type:

Integer greater than or equal to 0.

HTTP Operations

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

"Oem/Hp/ChassisManager[]/IP"

This property is a member of Chassis

JSON type:

String

HTTP Operations

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

"Oem/Hp/ChassisManager[]/MAC"

This property is a member of Chassis

JSON type:

String

HTTP Operations

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

"Oem/Hp/ChassisManager[]/SubnetMask"

This property is a member of Chassis

JSON type:

String

HTTP Operations

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

"Oem/Hp/CliVersion"

This property is a member of Chassis

CLI Version

JSON type:

String

HTTP Operations

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

"Oem/Hp/Firmware/ChassisFirmware/Current/VersionString"

This property is a member of Chassis

JSON type:

String

HTTP Operations

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

"Oem/Hp/Firmware/ChassisFirmwareFrontDisplayPLD/Current/VersionString"

This property is a member of Chassis

JSON type:

String

HTTP Operations

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

"Oem/Hp/Firmware/ChassisFirmwarePLD/Current/VersionString"

This property is a member of Chassis

JSON type:

String

HTTP Operations

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

"Oem/Hp/Firmware/ChassisManagementFirmware/Current/VersionString"

This property is a member of Chassis

JSON type:

String

HTTP Operations

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

"Oem/Hp/Firmware/ChassisManagementModulePLD/Current/VersionString"

This property is a member of Chassis

JSON type:

String

HTTP Operations

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

"Oem/Hp/Images/Front/extref"

This property is a member of Chassis

The URI of an external resource.

JSON type:

String

HTTP Operations

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

"Oem/Hp/Images/Model/extref"

This property is a member of Chassis

The URI of an external resource.

JSON type:

String

HTTP Operations

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

"Oem/Hp/Location/GeographicLocation/RackName"

This property is a member of Chassis

Name of the chassis enclosure.

JSON type:

String

HTTP Operations

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

"Oem/Hp/Location/LocationInRack/RackLdsPartNumber"

This property is a member of Chassis

Part number of the chassis rack.

JSON type:

String

HTTP Operations

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

"Oem/Hp/Location/LocationInRack/RackLdsProductDescription"

This property is a member of Chassis

Product description of the chassis rack.

JSON type:

String

HTTP Operations

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

"Oem/Hp/Location/LocationInRack/RackUHeight"

This property is a member of Chassis

U height of the chassis rack.

JSON type:

Integer greater than or equal to 0.

HTTP Operations

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

"Oem/Hp/Location/LocationInRack/RackUUID"

This property is a member of Chassis

UUID of the chassis rack.

JSON type:

String

HTTP Operations

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

"Oem/Hp/Location/LocationInRack/TagVersion"

This property is a member of Chassis

Tag version of the chassis rack.

JSON type:

Integer greater than or equal to 0.

HTTP Operations

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

"Oem/Hp/Location/LocationInRack/ULocation"

This property is a member of Chassis

U location of the chassis rack.

JSON type:

String

HTTP Operations

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

"Oem/Hp/Location/LocationInRack/UPosition"

This property is a member of Chassis

U position of the chassis in the rack.

JSON type:

Integer greater than or equal to 0.

HTTP Operations

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

"Oem/Hp/Location/LocationOfChassis/UUID"

This property is a member of Chassis

Chassis UUID provided by SMBIOS.

JSON type:

String

HTTP Operations

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

"Oem/Hp/Prompt"

This property is a member of Chassis

CLI Prompt

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": {"Prompt": "<string-value>"}}}

The property "Oem/Hp/Prompt" 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.

"PartNumber"

This property is a member of Chassis

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

"SKU"

This property is a member of Chassis

The chassis SKU.

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:

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

The property "SKU" 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.

"SerialNumber"

This property is a member of Chassis

The chassis 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.
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:

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

The property "SerialNumber" 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.

"Status/Health"

This property is a member of Chassis

Indicates the health state of this resource without considering its dependent resources.

JSON type:

String containing one of the following supported values:

"OK"
"Warning"
"Critical"
"Error"

HTTP Operations

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

"Status/HealthRollUp"

This property is a member of Chassis

Indicates the overall health state of this resource and 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.

"Status/State"

This property is a member of Chassis

Indicates the known state of this resource (for example, if the resource is enabled). Enabled indicates that the resource is available. Disabled indicates that the resource has been made unavailable intentionally, but it can be enabled. Offline indicates that the resource is unavailable intentionally and requires action to be made available. InTest indicates that the component is undergoing testing. Starting indicates that the resource is on its way to becoming available. Absent indicates that the resource is physically unavailable.

JSON type:

String containing one of the following supported values:

"Critical"
"Enabled"
"Disabled"
"Offline"
"InTest"
"Starting"
"Absent"
"Uninitialized"
"OK"
"Not Installed"
"Failed"
"Degraded"
"Removed"
"Redundant"
"Not Redundant"
"Insufficient to Operate"

HTTP Operations

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

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

POST Action "SetAssetTag"

Parameter "Target"

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

"/Oem/Hp"

Parameter "AssetTag"

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

Example

HTTP POST to resource with request JSON:

{ "Action": "SetAssetTag", "Target": "/Oem/Hp", "AssetTag": ""}

POST Action "AutoPowerOnControl"

Parameter "Target"

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

"/Oem/Hp"

Parameter "ControlType"

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

"On"

"Off"

Example

HTTP POST to resource with request JSON:

{ "Action": "AutoPowerOnControl", "Target": "/Oem/Hp", "ControlType": "On"}

POST Action "SetChassisName"

Parameter "Target"

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

"/Oem/Hp"

Parameter "ChassisName"

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

Example

HTTP POST to resource with request JSON:

{ "Action": "SetChassisName", "Target": "/Oem/Hp", "ChassisName": ""}

POST Action "IndicatorLEDControl"

Parameter "ControlType"

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

"Lit"

"Off"

Parameter "Target"

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

"/Oem/Hp"

Example

HTTP POST to resource with request JSON:

{ "Action": "IndicatorLEDControl", "ControlType": "Lit", "Target": "/Oem/Hp"}

"ChassisFirmwareSummary" Resource Type

Resource Instances

/rest/v1/Chassis/{item}/ChassisFirmwareSummary

See Resource Map for more details.

"ChassisFirmwareSummary" defines the following properties:

"BayNumber"

This property is a member of ChassisFirmwareSummary

JSON type:

Integer greater than or equal to 0.

HTTP Operations

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

"Cartridges[]/FirmwareRevisions/CartridgeData/Firmware/Current/VersionString"

This property is a member of ChassisFirmwareSummary

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.

"Cartridges[]/FirmwareRevisions/CartridgeData/Firmware/definitions/FWVersion/VersionString"

This property is a member of ChassisFirmwareSummary

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.

"Cartridges[]/FirmwareRevisions/CartridgeProgrammableLogicDevice/Firmware/Current/VersionString"

This property is a member of ChassisFirmwareSummary

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.

"Cartridges[]/FirmwareRevisions/CartridgeProgrammableLogicDevice/Firmware/definitions/FWVersion/VersionString"

This property is a member of ChassisFirmwareSummary

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.

"Cartridges[]/FirmwareRevisions/CartridgeSatelliteFirmware/Firmware/Current/VersionString"

This property is a member of ChassisFirmwareSummary

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.

"Cartridges[]/FirmwareRevisions/CartridgeSatelliteFirmware/Firmware/definitions/FWVersion/VersionString"

This property is a member of ChassisFirmwareSummary

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.

"Cartridges[]/FirmwareRevisions/CartridgeSystemMEROMFirmware/Firmware/Current/VersionString"

This property is a member of ChassisFirmwareSummary

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.

"Cartridges[]/FirmwareRevisions/CartridgeSystemMEROMFirmware/Firmware/definitions/FWVersion/VersionString"

This property is a member of ChassisFirmwareSummary

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.

"Cartridges[]/FirmwareRevisions/CartridgeSystemROMFirmware/Firmware/Current/VersionString"

This property is a member of ChassisFirmwareSummary

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.

"Cartridges[]/FirmwareRevisions/CartridgeSystemROMFirmware/Firmware/definitions/FWVersion/VersionString"

This property is a member of ChassisFirmwareSummary

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.

"Cartridges[]/FirmwareRevisions/MiscFW[]/Firmware/Current/VersionString"

This property is a member of ChassisFirmwareSummary

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.

"Cartridges[]/FirmwareRevisions/MiscFW[]/Firmware/definitions/FWVersion/VersionString"

This property is a member of ChassisFirmwareSummary

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.

"Cartridges[]/FirmwareRevisions/RomFamily/Firmware/Current/VersionString"

This property is a member of ChassisFirmwareSummary

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.

"Cartridges[]/FirmwareRevisions/RomFamily/Firmware/definitions/FWVersion/VersionString"

This property is a member of ChassisFirmwareSummary

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.

"Cartridges[]/Model"

This property is a member of ChassisFirmwareSummary

JSON type:

String

HTTP Operations

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

"Cartridges[]/Presence"

This property is a member of ChassisFirmwareSummary

JSON type:

String

HTTP Operations

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

"Cartridges[]/SlotOrBayNumber"

This property is a member of ChassisFirmwareSummary

JSON type:

Integer greater than or equal to 1.

HTTP Operations

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

"Firmware/ChassisFirmware/Firmware/Current/VersionString"

This property is a member of ChassisFirmwareSummary

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.

"Firmware/ChassisFirmware/Firmware/definitions/FWVersion/VersionString"

This property is a member of ChassisFirmwareSummary

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.

"Firmware/ChassisFirmwareFrontDisplayPLD/Firmware/Current/VersionString"

This property is a member of ChassisFirmwareSummary

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.

"Firmware/ChassisFirmwareFrontDisplayPLD/Firmware/definitions/FWVersion/VersionString"

This property is a member of ChassisFirmwareSummary

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.

"Firmware/ChassisFirmwarePLD/Firmware/Current/VersionString"

This property is a member of ChassisFirmwareSummary

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.

"Firmware/ChassisFirmwarePLD/Firmware/definitions/FWVersion/VersionString"

This property is a member of ChassisFirmwareSummary

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.

"Firmware/ChassisManagementFirmware/Firmware/Current/VersionString"

This property is a member of ChassisFirmwareSummary

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.

"Firmware/ChassisManagementFirmware/Firmware/definitions/FWVersion/VersionString"

This property is a member of ChassisFirmwareSummary

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.

"Firmware/ChassisManagementModulePLD/Firmware/Current/VersionString"

This property is a member of ChassisFirmwareSummary

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.

"Firmware/ChassisManagementModulePLD/Firmware/definitions/FWVersion/VersionString"

This property is a member of ChassisFirmwareSummary

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.

"PowerSupplies[]/FirmwareVersion"

This property is a member of ChassisFirmwareSummary

This is the firmware version of the power supply.

JSON type:

String

HTTP Operations

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

"PowerSupplies[]/SlotOrBayNumber"

This property is a member of ChassisFirmwareSummary

JSON type:

Integer greater than or equal to 1.

HTTP Operations

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

"PowerSupplies[]/Status/Health"

This property is a member of ChassisFirmwareSummary

Indicates the health state of this resource without considering its dependent resources.

JSON type:

String containing one of the following supported values:

"OK"
"Warning"
"Critical"
"Error"

HTTP Operations

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

"PowerSupplies[]/Status/HealthRollUp"

This property is a member of ChassisFirmwareSummary

Indicates the overall health state of this resource and 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.

"PowerSupplies[]/Status/State"

This property is a member of ChassisFirmwareSummary

JSON type:

String containing one of the following supported values:

"Critical"
"Enabled"
"Disabled"
"Offline"
"InTest"
"Starting"
"Absent"
"Uninitialized"
"OK"
"Not Installed"
"Failed"
"Degraded"
"Removed"
"Redundant"
"Not Redundant"
"Insufficient to Operate"

HTTP Operations

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

"Switches[]/FirmwareRevisions/SwitchData/Firmware/Current/VersionString"

This property is a member of ChassisFirmwareSummary

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.

"Switches[]/FirmwareRevisions/SwitchData/Firmware/definitions/FWVersion/VersionString"

This property is a member of ChassisFirmwareSummary

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.

"Switches[]/FirmwareRevisions/SwitchFirmware/Firmware/Current/VersionString"

This property is a member of ChassisFirmwareSummary

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.

"Switches[]/FirmwareRevisions/SwitchFirmware/Firmware/definitions/FWVersion/VersionString"

This property is a member of ChassisFirmwareSummary

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.

"Switches[]/FirmwareRevisions/SwitchProgrammableLogicDevice/Firmware/Current/VersionString"

This property is a member of ChassisFirmwareSummary

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.

"Switches[]/FirmwareRevisions/SwitchProgrammableLogicDevice/Firmware/definitions/FWVersion/VersionString"

This property is a member of ChassisFirmwareSummary

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.

"Switches[]/FirmwareRevisions/SwitchSatelliteFirmware/Firmware/Current/VersionString"

This property is a member of ChassisFirmwareSummary

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.

"Switches[]/FirmwareRevisions/SwitchSatelliteFirmware/Firmware/definitions/FWVersion/VersionString"

This property is a member of ChassisFirmwareSummary

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.

"Switches[]/FirmwareRevisions/SwitchSystemROMFirmware/Firmware/Current/VersionString"

This property is a member of ChassisFirmwareSummary

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.

"Switches[]/FirmwareRevisions/SwitchSystemROMFirmware/Firmware/definitions/FWVersion/VersionString"

This property is a member of ChassisFirmwareSummary

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.

"Switches[]/Model"

This property is a member of ChassisFirmwareSummary

JSON type:

String

HTTP Operations

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

"Switches[]/Presence"

This property is a member of ChassisFirmwareSummary

JSON type:

String

HTTP Operations

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

"Switches[]/SlotOrBayNumber"

This property is a member of ChassisFirmwareSummary

JSON type:

Integer greater than or equal to 1.

HTTP Operations

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

"ChassisSummary" Resource Type

Resource Instances

/rest/v1/Chassis/{item}/ChassisSummary

See Resource Map for more details.

"ChassisSummary" defines the following properties:

"AssetTag"

This property is a member of ChassisSummary

Asset Tag

JSON type:

String

HTTP Operations

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

"AutoPowerOn"

This property is a member of ChassisSummary

Auto Power On

JSON type:

String containing one of the following supported values:

"On"
"Off"

HTTP Operations

GET	Rendered if supported by the implementation 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:

{"AutoPowerOn": "Off"}

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

"Cartridges[]/CartridgeType"

This property is a member of ChassisSummary

JSON type:

String containing one of the following supported values:

"CART_TYPE_RESERVED"
"Compute"
"Storage"
"Graphic"
"Switch (network)"
"Display (video) cartridge"
"Expansion"
"Network"
"FPGA"
"Management"
"CART_TYPE_UNKNOWN"

HTTP Operations

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

"Cartridges[]/FrontLED"

This property is a member of ChassisSummary

This property is indicates the state of the chassis health LED.

JSON type:

String containing one of the following supported values:

"Off"
"Red"
"Amber"
"Green"

HTTP Operations

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

"Cartridges[]/HealthStatus"

This property is a member of ChassisSummary

JSON type:

String

HTTP Operations

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

"Cartridges[]/IndicatorLED"

This property is a member of ChassisSummary

This property is indicates the state of the UID 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.

"Cartridges[]/InstantWattage"

This property is a member of ChassisSummary

JSON type:

Integer

HTTP Operations

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

"Cartridges[]/Length"

This property is a member of ChassisSummary

JSON type:

Integer

HTTP Operations

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

"Cartridges[]/Linked"

This property is a member of ChassisSummary

The linked state of the cartridge.

JSON type:

String containing one of the following supported values:

"Yes"
"No"

HTTP Operations

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

"Cartridges[]/ManagementDevice/Address"

This property is a member of ChassisSummary

JSON type:

String

HTTP Operations

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

"Cartridges[]/ManagementDevice/JarFileName"

This property is a member of ChassisSummary

JSON type:

String

HTTP Operations

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

"Cartridges[]/ManagementDevice/RemoteConsoleCapability"

This property is a member of ChassisSummary

This property is true if remote console is available

JSON type:

Boolean ('true' or 'false')

HTTP Operations

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

"Cartridges[]/ManagementDevice/SessionID"

This property is a member of ChassisSummary

JSON type:

String

HTTP Operations

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

"Cartridges[]/ManagementStatus"

This property is a member of ChassisSummary

JSON type:

String

HTTP Operations

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

"Cartridges[]/Manufacturer"

This property is a member of ChassisSummary

JSON type:

String

HTTP Operations

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

"Cartridges[]/MaxClockSpeedMHz"

This property is a member of ChassisSummary

JSON type:

Integer greater than or equal to 0.

HTTP Operations

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

"Cartridges[]/MaximumWattage"

This property is a member of ChassisSummary

JSON type:

Integer

HTTP Operations

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

"Cartridges[]/Model"

This property is a member of ChassisSummary

JSON type:

String

HTTP Operations

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

"Cartridges[]/NumberOfCores"

This property is a member of ChassisSummary

JSON type:

Integer greater than or equal to 0.

HTTP Operations

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

"Cartridges[]/Power"

This property is a member of ChassisSummary

JSON type:

String containing one of the following supported values:

"On"
"Off"

HTTP Operations

GET	Rendered if supported by the implementation 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:

{"Cartridges": [{"Power": "Off"}|null, ...]}

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

"Cartridges[]/Status/Health"

This property is a member of ChassisSummary

Indicates the health state of this resource without considering its dependent resources.

JSON type:

String containing one of the following supported values:

"OK"
"Warning"
"Critical"
"Error"

HTTP Operations

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

"Cartridges[]/Status/HealthRollUp"

This property is a member of ChassisSummary

Indicates the overall health state of this resource and 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.

"Cartridges[]/Status/State"

This property is a member of ChassisSummary

JSON type:

String containing one of the following supported values:

"Critical"
"Enabled"
"Disabled"
"Offline"
"InTest"
"Starting"
"Absent"
"Uninitialized"
"OK"
"Not Installed"
"Failed"
"Degraded"
"Removed"
"Redundant"
"Not Redundant"
"Insufficient to Operate"

HTTP Operations

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

"Cartridges[]/SubsumedBy"

This property is a member of ChassisSummary

JSON type:

Integer

HTTP Operations

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

"Cartridges[]/Width"

This property is a member of ChassisSummary

JSON type:

Integer

HTTP Operations

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

"ChassisManager[]/IP"

This property is a member of ChassisSummary

JSON type:

String

HTTP Operations

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

"ChassisManager[]/MAC"

This property is a member of ChassisSummary

JSON type:

String

HTTP Operations

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

"ChassisManager[]/SubnetMask"

This property is a member of ChassisSummary

JSON type:

String

HTTP Operations

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

"CliVersion"

This property is a member of ChassisSummary

CLI Version

JSON type:

String

HTTP Operations

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

"Dimensions/DepthInMm"

This property is a member of ChassisSummary

JSON type:

Integer greater than or equal to 0.

HTTP Operations

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

"Dimensions/HeightInMm"

This property is a member of ChassisSummary

JSON type:

Integer greater than or equal to 0.

HTTP Operations

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

"Dimensions/HeightInU"

This property is a member of ChassisSummary

JSON type:

Integer greater than or equal to 0.

HTTP Operations

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

"Dimensions/WidthInMm"

This property is a member of ChassisSummary

JSON type:

Integer greater than or equal to 0.

HTTP Operations

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

"Fans[]/CurrentReading"

This property is a member of ChassisSummary

see legacy json 'health_fans' prop 'speed'

JSON type:

Integer greater than or equal to 0.

HTTP Operations

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

"Fans[]/FanName"

This property is a member of ChassisSummary

see legacy json 'health_fans' prop 'label'

JSON type:

String

HTTP Operations

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

"Fans[]/Oem/Hp/Location"

This property is a member of ChassisSummary

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[]/ProductName"

This property is a member of ChassisSummary

see legacy json 'health_fans' prop 'label'

JSON type:

String

HTTP Operations

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

"Fans[]/SlotOrBayNumber"

This property is a member of ChassisSummary

JSON type:

Integer greater than or equal to 1.

HTTP Operations

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

"Fans[]/Status/Health"

This property is a member of ChassisSummary

Indicates the health state of this resource without considering its dependent resources.

JSON type:

String containing one of the following supported values:

"OK"
"Warning"
"Critical"
"Error"

HTTP Operations

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

"Fans[]/Status/HealthRollUp"

This property is a member of ChassisSummary

Indicates the overall health state of this resource and 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.

"Fans[]/Status/State"

This property is a member of ChassisSummary

JSON type:

String containing one of the following supported values:

"Critical"
"Enabled"
"Disabled"
"Offline"
"InTest"
"Starting"
"Absent"
"Uninitialized"
"OK"
"Not Installed"
"Failed"
"Degraded"
"Removed"
"Redundant"
"Not Redundant"
"Insufficient to Operate"

HTTP Operations

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

"Fans[]/Units"

This property is a member of ChassisSummary

hardcode to 'Percent'

JSON type:

String

HTTP Operations

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

"Firmware/ChassisFirmware/Firmware/Current/VersionString"

This property is a member of ChassisSummary

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.

"Firmware/ChassisFirmware/Firmware/definitions/FWVersion/VersionString"

This property is a member of ChassisSummary

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.

"Firmware/ChassisFirmwareFrontDisplayPLD/Firmware/Current/VersionString"

This property is a member of ChassisSummary

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.

"Firmware/ChassisFirmwareFrontDisplayPLD/Firmware/definitions/FWVersion/VersionString"

This property is a member of ChassisSummary

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.

"Firmware/ChassisFirmwarePLD/Firmware/Current/VersionString"

This property is a member of ChassisSummary

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.

"Firmware/ChassisFirmwarePLD/Firmware/definitions/FWVersion/VersionString"

This property is a member of ChassisSummary

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.

"Firmware/ChassisManagementFirmware/Firmware/Current/VersionString"

This property is a member of ChassisSummary

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.

"Firmware/ChassisManagementFirmware/Firmware/definitions/FWVersion/VersionString"

This property is a member of ChassisSummary

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.

"Firmware/ChassisManagementModulePLD/Firmware/Current/VersionString"

This property is a member of ChassisSummary

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.

"Firmware/ChassisManagementModulePLD/Firmware/definitions/FWVersion/VersionString"

This property is a member of ChassisSummary

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.

"HealthLED"

This property is a member of ChassisSummary

This property is indicates the state of the chassis health LED.

JSON type:

String containing one of the following supported values:

"Unknown"
"Red"
"Amber"
"Green"

HTTP Operations

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

"HealthStatusCount/Critical"

This property is a member of ChassisSummary

JSON type:

String

HTTP Operations

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

"HealthStatusCount/OK"

This property is a member of ChassisSummary

JSON type:

String

HTTP Operations

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

"IndicatorLED"

This property is a member of ChassisSummary

This property is indicates the state of the UID 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.
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 ChassisSummary 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 ChassisSummary

JSON type:

String

HTTP Operations

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

"Model"

This property is a member of ChassisSummary

JSON type:

String

HTTP Operations

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

"PowerCapacityWatts"

This property is a member of ChassisSummary

It is the total power supply capacity

JSON type:

Integer greater than or equal to 0.

HTTP Operations

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

"PowerConsumedWatts"

This property is a member of ChassisSummary

This is the total power consumed in watts

JSON type:

Integer greater than or equal to 0.

HTTP Operations

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

"PowerLED"

This property is a member of ChassisSummary

This property is indicates the state of the chassis power LED.

JSON type:

String containing one of the following supported values:

"Unknown"
"Red"
"Amber"
"Green"

HTTP Operations

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

"PowerSupplies[]/ACInputStatus"

This property is a member of ChassisSummary

Indicates the type of fault present.

JSON type:

String containing one of the following supported values:

"Failed"
"OK"

HTTP Operations

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

"PowerSupplies[]/FirmwareVersion"

This property is a member of ChassisSummary

This is the firmware version of the power supply.

JSON type:

String

HTTP Operations

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

"PowerSupplies[]/LastPowerOutputWatts"

This property is a member of ChassisSummary

This indicates the average power consumed in watts.

JSON type:

Integer greater than or equal to 0.

HTTP Operations

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

"PowerSupplies[]/LineInputVoltage"

This property is a member of ChassisSummary

This is the instant input voltage at which the power supply is operating.

JSON type:

Integer

HTTP Operations

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

"PowerSupplies[]/LineInputVoltageType"

This property is a member of ChassisSummary

Line voltage type can be lowline/midline/highline/-48VDC/420VDC/INVALID

JSON type:

String containing one of the following supported values:

"ACLowLine"
"ACMidLine"
"ACHighLine"
"DCNeg48V"
"DC480V"

HTTP Operations

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

"PowerSupplies[]/Model"

This property is a member of ChassisSummary

This denotes the model number of the power supply.

JSON type:

String

HTTP Operations

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

"PowerSupplies[]/PowerCapacityWatts"

This property is a member of ChassisSummary

This indicates the power capacity in watts of the power supply

JSON type:

Integer greater than or equal to 0.

HTTP Operations

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

"PowerSupplies[]/PowerSupplyType"

This property is a member of ChassisSummary

The power supply type can be TREES/KHAN BLADE/PANDEMONIUM/BL-IRIS/SL-CARB2/SL-CARB/UNSUPPORTED

JSON type:

String containing one of the following supported values:

"AC"
"DC"

HTTP Operations

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

"PowerSupplies[]/SerialNumber"

This property is a member of ChassisSummary

This denotes the serial number of the PS.

JSON type:

String

HTTP Operations

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

"PowerSupplies[]/SlotOrBayNumber"

This property is a member of ChassisSummary

JSON type:

Integer greater than or equal to 1.

HTTP Operations

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

"PowerSupplies[]/SparePartNumber"

This property is a member of ChassisSummary

This denotes the spare part number of the PS.

JSON type:

String

HTTP Operations

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

"PowerSupplies[]/Status/Health"

This property is a member of ChassisSummary

Indicates the health state of this resource without considering its dependent resources.

JSON type:

String containing one of the following supported values:

"OK"
"Warning"
"Critical"
"Error"

HTTP Operations

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

"PowerSupplies[]/Status/HealthRollUp"

This property is a member of ChassisSummary

Indicates the overall health state of this resource and 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.

"PowerSupplies[]/Status/State"

This property is a member of ChassisSummary

JSON type:

String containing one of the following supported values:

"Critical"
"Enabled"
"Disabled"
"Offline"
"InTest"
"Starting"
"Absent"
"Uninitialized"
"OK"
"Not Installed"
"Failed"
"Degraded"
"Removed"
"Redundant"
"Not Redundant"
"Insufficient to Operate"

HTTP Operations

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

"PowercapDescription"

This property is a member of ChassisSummary

Powercap description.

JSON type:

String

HTTP Operations

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

"PowercapMode"

This property is a member of ChassisSummary

Powercap Mode.

JSON type:

Integer

HTTP Operations

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

"SKU"

This property is a member of ChassisSummary

JSON type:

String

HTTP Operations

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

"SerialNumber"

This property is a member of ChassisSummary

JSON type:

String

HTTP Operations

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

"Status/Health"

This property is a member of ChassisSummary

Indicates the health state of this resource without considering its dependent resources.

JSON type:

String containing one of the following supported values:

"OK"
"Warning"
"Critical"
"Error"

HTTP Operations

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

"Status/HealthRollUp"

This property is a member of ChassisSummary

Indicates the overall health state of this resource and 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.

"Status/State"

This property is a member of ChassisSummary

JSON type:

String containing one of the following supported values:

"Critical"
"Enabled"
"Disabled"
"Offline"
"InTest"
"Starting"
"Absent"
"Uninitialized"
"OK"
"Not Installed"
"Failed"
"Degraded"
"Removed"
"Redundant"
"Not Redundant"
"Insufficient to Operate"

HTTP Operations

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

"Switches[]/AutoRev"

This property is a member of ChassisSummary

JSON type:

String

HTTP Operations

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

"Switches[]/FrontLED"

This property is a member of ChassisSummary

This property is indicates the state of the chassis health LED.

JSON type:

String containing one of the following supported values:

"Off"
"Red"
"Amber"
"Green"

HTTP Operations

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

"Switches[]/HealthStatus"

This property is a member of ChassisSummary

JSON type:

String

HTTP Operations

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

"Switches[]/IPv4"

This property is a member of ChassisSummary

JSON type:

String

HTTP Operations

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

"Switches[]/IPv6"

This property is a member of ChassisSummary

JSON type:

String

HTTP Operations

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

"Switches[]/IndicatorLED"

This property is a member of ChassisSummary

This property is indicates the state of the UID 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.

"Switches[]/InstantWattage"

This property is a member of ChassisSummary

JSON type:

Integer

HTTP Operations

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

"Switches[]/MAC"

This property is a member of ChassisSummary

JSON type:

String

HTTP Operations

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

"Switches[]/ManagementStatus"

This property is a member of ChassisSummary

JSON type:

String

HTTP Operations

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

"Switches[]/Manufacturer"

This property is a member of ChassisSummary

JSON type:

String

HTTP Operations

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

"Switches[]/MaximumWattage"

This property is a member of ChassisSummary

JSON type:

Integer

HTTP Operations

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

"Switches[]/Model"

This property is a member of ChassisSummary

JSON type:

String

HTTP Operations

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

"Switches[]/Power"

This property is a member of ChassisSummary

JSON type:

String containing one of the following supported values:

"On"
"Off"

HTTP Operations

GET	Rendered if supported by the implementation 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:

{"Switches": [{"Power": "Off"}|null, ...]}

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

"Switches[]/Status/Health"

This property is a member of ChassisSummary

Indicates the health state of this resource without considering its dependent resources.

JSON type:

String containing one of the following supported values:

"OK"
"Warning"
"Critical"
"Error"

HTTP Operations

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

"Switches[]/Status/HealthRollUp"

This property is a member of ChassisSummary

Indicates the overall health state of this resource and 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.

"Switches[]/Status/State"

This property is a member of ChassisSummary

JSON type:

String containing one of the following supported values:

"Critical"
"Enabled"
"Disabled"
"Offline"
"InTest"
"Starting"
"Absent"
"Uninitialized"
"OK"
"Not Installed"
"Failed"
"Degraded"
"Removed"
"Redundant"
"Not Redundant"
"Insufficient to Operate"

HTTP Operations

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

"Switches[]/SwitchType"

This property is a member of ChassisSummary

JSON type:

String

HTTP Operations

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

"Switches[]/UUID"

This property is a member of ChassisSummary

JSON type:

String

HTTP Operations

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

"Switches[]/UplinkModule/Model"

This property is a member of ChassisSummary

JSON type:

String

HTTP Operations

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

"Switches[]/UplinkModule/SKU"

This property is a member of ChassisSummary

JSON type:

String

HTTP Operations

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

"Switches[]/UplinkModule/SerialNumber"

This property is a member of ChassisSummary

JSON type:

String

HTTP Operations

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

"UUID"

This property is a member of ChassisSummary

JSON type:

String

HTTP Operations

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

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

"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"
"M.2"
"iSCSI"

HTTP Operations

GET	Rendered if supported by the 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": "BiosSetup"}}

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.

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

"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

Indicates the health state of this resource without considering its dependent resources.

JSON type:

String containing one of the following supported values:

"OK"
"Warning"
"Critical"
"Error"

HTTP Operations

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

"Memory/Status/HealthRollUp"

This property is a member of ComputerSystem

Indicates the overall health state of this resource and 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.

"Memory/Status/State"

This property is a member of ComputerSystem

JSON type:

String containing one of the following supported values:

"Critical"
"Enabled"
"Disabled"
"Offline"
"InTest"
"Starting"
"Absent"
"Uninitialized"
"OK"
"Not Installed"
"Failed"
"Degraded"
"Removed"
"Redundant"
"Not Redundant"
"Insufficient to Operate"

HTTP Operations

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

"Memory/TotalSystemMemoryGB"

This property is a member of ComputerSystem

The total amount of memory in the system, measured in GB.

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.

"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/DiskDrives[]/CapacityGB"

This property is a member of ComputerSystem

JSON type:

Integer greater than or equal to 0.

HTTP Operations

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

"Oem/Hp/DiskDrives[]/DiskNumber"

This property is a member of ComputerSystem

JSON type:

Integer greater than or equal to 0.

HTTP Operations

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

"Oem/Hp/DiskDrives[]/Firmware"

This property is a member of ComputerSystem

JSON type:

String

HTTP Operations

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

"Oem/Hp/DiskDrives[]/Model"

This property is a member of ComputerSystem

JSON type:

String

HTTP Operations

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

"Oem/Hp/DiskDrives[]/SerialNumber"

This property is a member of ComputerSystem

JSON type:

String

HTTP Operations

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

"Oem/Hp/DiskDrives[]/Wear"

This property is a member of ComputerSystem

JSON type:

String

HTTP Operations

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

"Oem/Hp/MemoryModules[]/AssetTag"

This property is a member of ComputerSystem

JSON type:

String

HTTP Operations

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

"Oem/Hp/MemoryModules[]/Attributes"

This property is a member of ComputerSystem

Bits 7-4: reserved, Bits 3-0: rank, Value=0 for unknown rank information.

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/MemoryModules[]/CapacityGB"

This property is a member of ComputerSystem

JSON type:

Integer greater than or equal to 0.

HTTP Operations

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

"Oem/Hp/MemoryModules[]/ClockSpeed"

This property is a member of ComputerSystem

Identifies the configured clock speed to the memory device, in megahertz (MHz). If the value is 0, 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.

"Oem/Hp/MemoryModules[]/DataWidth"

This property is a member of ComputerSystem

JSON type:

Integer

HTTP Operations

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

"Oem/Hp/MemoryModules[]/DeviceSet"

This property is a member of ComputerSystem

Identifies when the Memory Device is one of a set of Memory Devices that must be populated with all devices of the same type and size, and the set to which this device belongs. A value of 0 indicates that the device is not part of a set; a value of 255 indicates that the attribute 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.

"Oem/Hp/MemoryModules[]/FormFactor"

This property is a member of ComputerSystem

JSON type:

String containing one of the following supported values:

"REC_MEM_FF_RESERVED"
"REC_MEM_FF_MASK"
"SODIMM"
"DIMM"
"Embedded"
"DODIMM"
"Unknown"

HTTP Operations

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

"Oem/Hp/MemoryModules[]/Manufacturer"

This property is a member of ComputerSystem

JSON type:

String

HTTP Operations

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

"Oem/Hp/MemoryModules[]/MemoryBusSpeedMhz"

This property is a member of ComputerSystem

JSON type:

Integer

HTTP Operations

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

"Oem/Hp/MemoryModules[]/MemoryType"

This property is a member of ComputerSystem

The type of memory DIMM used in this system.

JSON type:

String containing one of the following supported values:

"DDR"
"DDR2"
"DDR3"
"FBD2"

HTTP Operations

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

"Oem/Hp/MemoryModules[]/PartNumber"

This property is a member of ComputerSystem

JSON type:

String

HTTP Operations

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

"Oem/Hp/MemoryModules[]/SerialNumber"

This property is a member of ComputerSystem

JSON type:

String

HTTP Operations

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

"Oem/Hp/MemoryModules[]/SizeMB"

This property is a member of ComputerSystem

JSON type:

Integer

HTTP Operations

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

"Oem/Hp/MemoryModules[]/SlotOrBayNumber"

This property is a member of ComputerSystem

JSON type:

Integer greater than or equal to 1.

HTTP Operations

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

"Oem/Hp/MemoryModules[]/Status/Health"

This property is a member of ComputerSystem

Indicates the health state of this resource without considering its dependent resources.

JSON type:

String containing one of the following supported values:

"OK"
"Warning"
"Critical"
"Error"

HTTP Operations

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

"Oem/Hp/MemoryModules[]/Status/HealthRollUp"

This property is a member of ComputerSystem

Indicates the overall health state of this resource and 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.

"Oem/Hp/MemoryModules[]/Status/State"

This property is a member of ComputerSystem

JSON type:

String containing one of the following supported values:

"Critical"
"Enabled"
"Disabled"
"Offline"
"InTest"
"Starting"
"Absent"
"Uninitialized"
"OK"
"Not Installed"
"Failed"
"Degraded"
"Removed"
"Redundant"
"Not Redundant"
"Insufficient to Operate"

HTTP Operations

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

"Oem/Hp/MemoryModules[]/TotalWidth"

This property is a member of ComputerSystem

JSON type:

Integer

HTTP Operations

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

"Oem/Hp/NICs[]/Manufacturer"

This property is a member of ComputerSystem

JSON type:

String

HTTP Operations

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

"Oem/Hp/NICs[]/MaximumSpeed"

This property is a member of ComputerSystem

JSON type:

String

HTTP Operations

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

"Oem/Hp/NICs[]/Topology"

This property is a member of ComputerSystem

JSON type:

String

HTTP Operations

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

"Oem/Hp/NodeOptions"

This property is a member of ComputerSystem

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.
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": {"NodeOptions": "<string-value>"}}}

The property "Oem/Hp/NodeOptions" 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/Options/BSC"

This property is a member of ComputerSystem

BIOS Serial Console

JSON type:

String containing one of the following supported values:

"enabled"
"disabled"
"DISABLE"
"ENABLE"

HTTP Operations

GET	Rendered if supported by the implementation 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": {"Options": {"BSC": "DISABLE"}}}}

The property "Oem/Hp/Options/BSC" 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/Options/BootOnce"

This property is a member of ComputerSystem

The current boot source to be used at next boot instead of the normal boot device

JSON type:

String containing one of the following supported values:

"None"
"HDD"
"PXE"
"iSCSI"
"M.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": {"Options": {"BootOnce": "PXE"}}}}

The property "Oem/Hp/Options/BootOnce" 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/Options/BootOnce"

This property is a member of ComputerSystem

The current boot source to be used at next boot instead of the normal boot device

JSON type:

String containing one of the following supported values:

"None"
"HDD"
"PXE"
"iSCSI"
"M.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": {"Options": {"BootOrder": ["M.2","PXE"]}}}}

{"Oem": {"Hp": {"Options": {"BootOrder": ["HDD"]}}}}

The property "Oem/Hp/Options/BootOrder" 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/Options/CPU/ClockRate/CurrentFrequency"

This property is a member of ComputerSystem

Current CPU clock rate

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": {"Options": {"CPU": {"ClockRate": {"CurrentFrequency": "<string-value>"}}}}}}

The property "Oem/Hp/Options/CPU/ClockRate/CurrentFrequency" 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/Options/CPU/HyperThreading"

This property is a member of ComputerSystem

Intel CPU HyperThreading

JSON type:

String containing one of the following supported values:

"enabled"
"disabled"
"DISABLE"
"ENABLE"

HTTP Operations

GET	Rendered if supported by the implementation 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": {"Options": {"CPU": {"HyperThreading": "DISABLE"}}}}}

GET	Rendered if supported by the implementation 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": {"Options": {"WOL": "<string-value>"}}}}

The property "Oem/Hp/Options/WOL" 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

Redundent with HpBios::PowerOnDelay

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.
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": "45Sec"}}}

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/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/HardwareStatus"

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

HTTP Operations

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

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

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

"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/CurrentClockSpeedMHz"

This property is a member of ComputerSystem

Processor Clock Speed in MHz

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/MaxClockSpeedMHz"

This property is a member of ComputerSystem

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/NumberOfCores"

This property is a member of ComputerSystem

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

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

"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

Indicates the health state of this resource without considering its dependent resources.

JSON type:

String containing one of the following supported values:

"OK"
"Warning"
"Critical"
"Error"

HTTP Operations

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

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

POST Action "Reset"

Parameter "ResetType"

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

"On"

"Off"

"Reset"

"ColdReset"

"Nmi"

"GracefulShutdown"

Example

HTTP POST to resource with request JSON:

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

POST Action "PowerButton"

Parameter "PushType"

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

"Press"

"PressAndHold"

Example

HTTP POST to resource with request JSON:

{ "Action": "PowerButton", "PushType": "Press"}

"DirectoryService" Resource Type

Resource Instances

/rest/v1/DirectoryService

See Resource Map for more details.

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

"DirectoryService" defines the following properties:

"Oem/Hp/DirectoryServerAddress"

This property is a member of DirectoryService

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:

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

The property "Oem/Hp/DirectoryServerAddress" on resource type DirectoryService 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/DirectoryServerLDAPPort"

This property is a member of DirectoryService

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": {"DirectoryServerLDAPPort": <integer-value>}}}

The property "Oem/Hp/DirectoryServerLDAPPort" on resource type DirectoryService 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/KerberosEnabled"

This property is a member of DirectoryService

Descriptive login name that helps to easily identify the owner of each user name. The login name does not have to be the same as the user name and must use printable characters. The maximum length for a user name is 39 characters.

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": {"KerberosEnabled": true}}}

The property "Oem/Hp/KerberosEnabled" on resource type DirectoryService 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/KerberosKDCServerAddress"

This property is a member of DirectoryService

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": {"KerberosKDCServerAddress": "<string-value>"}}}

The property "Oem/Hp/KerberosKDCServerAddress" on resource type DirectoryService 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/KerberosKDCServerPort"

This property is a member of DirectoryService

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": {"KerberosKDCServerPort": <integer-value>}}}

The property "Oem/Hp/KerberosKDCServerPort" on resource type DirectoryService 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/KerberosKeytabFileExists"

This property is a member of DirectoryService

Flag that indicates whether a Kerberos Keytab file exists.

JSON type:

Boolean ('true' or 'false')

HTTP Operations

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

"Oem/Hp/KerberosRealm"

This property is a member of DirectoryService

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": {"KerberosRealm": "<string-value>"}}}

The property "Oem/Hp/KerberosRealm" on resource type DirectoryService 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/KeytabEntries[]/KerberosRealm"

This property is a member of DirectoryService

The descriptive name of the test.

JSON type:

String

HTTP Operations

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

"Oem/Hp/KeytabEntries[]/TestResult"

This property is a member of DirectoryService

The results of running the test.

JSON type:

String

HTTP Operations

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

"Oem/Hp/LDAPDirectoryAuthenticationEnabled"

This property is a member of DirectoryService

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": {"LDAPDirectoryAuthenticationEnabled": true}}}

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

"Oem/Hp/TestResults/TestState"

This property is a member of DirectoryService

This privilege enables a user to access one or more of the cartridges in the chassis.

JSON type:

String containing one of the following supported values:

"NotRunning"
"InProgress"
"Complete"
"Aborting"
"Aborted"

HTTP Operations

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

"Oem/Hp/links/UploadKerberosKeytab/extref"

This property is a member of DirectoryService

The URI of an external resource.

JSON type:

String

HTTP Operations

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

POST Action "StartTest"

Starts the LDAP test.

Parameter "Target"

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

"/Oem/Hp"

Parameter "UserName"

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

Parameter "UserPassword"

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

Parameter "AdminName"

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

Parameter "AdminPassword"

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

Example

HTTP POST to resource with request JSON:

{ "Action": "StartTest", "Target": "/Oem/Hp", "UserName": "", "UserPassword": "", "AdminName": "", "AdminPassword": ""}

POST Action "StopTest"

Stops the LDAP test.

Parameter "Target"

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

"/Oem/Hp"

Example

HTTP POST to resource with request JSON:

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

"EthernetNetworkInterface" Resource Type

Resource Instances

/rest/v1/Managers/{item}/NICs/{item}

See Resource Map for more details.

The schema definition of a simple Ethernet NIC resource.

"EthernetNetworkInterface" defines the following properties:

"Autosense"

This property is a member of EthernetNetworkInterface

Autosense speed/duplex enabled or disabled. This property can be disabled only if the SpeedMbps and FullDuplex values are specified. This property is applicable only for a dedicated network port. This property can only be modified on a dedicated network port. It 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.
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.
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 EthernetNetworkInterface 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[]/Address"

This property is a member of EthernetNetworkInterface

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

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 EthernetNetworkInterface

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

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

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.

"Oem/Hp/ConfigurationSettings"

This property is a member of EthernetNetworkInterface

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 EthernetNetworkInterface

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

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

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

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

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

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

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 EthernetNetworkInterface 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/DaisyChainEnabled"

This property is a member of EthernetNetworkInterface

When enabled, the iLO CM Link Port can be used to daisy-chain the management port network to another iLO CM module.

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": {"DaisyChainEnabled": true}}}

The property "Oem/Hp/DaisyChainEnabled" on resource type EthernetNetworkInterface 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 EthernetNetworkInterface

Domain name of the management network to which this iLO belongs. This property can only be modified when iLO is not configured to use a DHCPv4 or DHCPv6 supplied domain 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": {"DomainName": "<string-value>"}}}

The property "Oem/Hp/DomainName" on resource type EthernetNetworkInterface 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 EthernetNetworkInterface

iLO 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 EthernetNetworkInterface 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 EthernetNetworkInterface

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 EthernetNetworkInterface 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[]/Address"

This property is a member of EthernetNetworkInterface

This is a duplicate of Destination kept for compatibility with 1.30. It is now deprecated.

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": [{"Address": "<string-value>"}|null, ...]}}}}

The property "Oem/Hp/IPv4/StaticRoutes[]/Address" on resource type EthernetNetworkInterface 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 EthernetNetworkInterface

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": [{"Destination": "<string-value>"}|null, ...]}}}}

The property "Oem/Hp/IPv4/StaticRoutes[]/Destination" on resource type EthernetNetworkInterface 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 EthernetNetworkInterface

Currently configured WINS servers in order of descending preference. Static values when not configured to use DHCPv4-supplied WINS servers; otherwise this property is read-only indicating the values are provided by DHCPv4.

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

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": [{"SubnetMask": "<string-value>"}|null, ...]}}}}

The property "Oem/Hp/IPv4/StaticRoutes[]/SubnetMask" on resource type EthernetNetworkInterface 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 EthernetNetworkInterface

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 EthernetNetworkInterface 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/NICEnabled"

This property is a member of EthernetNetworkInterface

Determines whether this NIC is enabled or disabled.

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 EthernetNetworkInterface

Determines whether to ping the 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 EthernetNetworkInterface 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.

"SpeedMbps"

This property is a member of EthernetNetworkInterface

Indicates the link speed of the ethernet interface. 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.
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 EthernetNetworkInterface 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 EthernetNetworkInterface

Indicates the health state of this resource without considering its dependent resources.

JSON type:

String containing one of the following supported values:

"OK"
"Warning"
"Critical"
"Error"

HTTP Operations

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

"Status/HealthRollUp"

This property is a member of EthernetNetworkInterface

Indicates the overall health state of this resource and 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.

"Status/State"

This property is a member of EthernetNetworkInterface

JSON type:

String containing one of the following supported values:

"Critical"
"Enabled"
"Disabled"
"Offline"
"InTest"
"Starting"
"Absent"
"Uninitialized"
"OK"
"Not Installed"
"Failed"
"Degraded"
"Removed"
"Redundant"
"Not Redundant"
"Insufficient to Operate"

HTTP Operations

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

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

{ "Action": "GenerateCSR", "Country": "<string>", "State": "<string>", "City": "<string>", "OrgName": "<string>", "EmailAddress": "<string>", "OrgUnit": "<string>", "CommonName": "<string>"}

POST Action "ImportCertificate"

Imports a Trusted Certificate and iLO is reset.

Parameter "Certificate"

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

"<text>"

Example

HTTP POST to resource with request JSON:

{ "Action": "ImportCertificate", "Certificate": "<text>"}

"HpMoonshotCartridge" Resource Type

Resource Instances

/rest/v1/Chassis/{item}/Cartridges/{item}

See Resource Map for more details.

"HpMoonshotCartridge" defines the following properties:

"BayNumber"

This property is a member of HpMoonshotCartridge

JSON type:

Integer greater than or equal to 0.

HTTP Operations

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

"CartridgeInfo/AssetTag"

This property is a member of HpMoonshotCartridge

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:

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

The property "CartridgeInfo/AssetTag" on resource type HpMoonshotCartridge 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.

"CartridgeInfo/AutoRev"

This property is a member of HpMoonshotCartridge

JSON type:

String

HTTP Operations

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

"CartridgeInfo/CartridgeNodeCount"

This property is a member of HpMoonshotCartridge

JSON type:

Integer from 0 to 8.

HTTP Operations

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

"CartridgeInfo/CartridgeType"

This property is a member of HpMoonshotCartridge

JSON type:

String containing one of the following supported values:

"CART_TYPE_RESERVED"
"Compute"
"Storage"
"Graphic"
"Switch (network)"
"DSP"
"Expansion"
"Network"
"FPGA"
"Management"
"CART_TYPE_UNKNOWN"

HTTP Operations

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

"CartridgeInfo/HealthStatus"

This property is a member of HpMoonshotCartridge

JSON type:

String

HTTP Operations

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

"CartridgeInfo/InstantWattage"

This property is a member of HpMoonshotCartridge

JSON type:

Integer

HTTP Operations

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

"CartridgeInfo/Length"

This property is a member of HpMoonshotCartridge

JSON type:

Integer

HTTP Operations

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

"CartridgeInfo/Linked"

This property is a member of HpMoonshotCartridge

The linked state of the cartridge.

JSON type:

String containing one of the following supported values:

"Yes"
"No"

HTTP Operations

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

"CartridgeInfo/ManagementStatus"

This property is a member of HpMoonshotCartridge

JSON type:

String

HTTP Operations

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

"CartridgeInfo/MaximumWattage"

This property is a member of HpMoonshotCartridge

JSON type:

Integer

HTTP Operations

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

"CartridgeInfo/MfgDateTime"

This property is a member of HpMoonshotCartridge

JSON type:

String

HTTP Operations

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

"CartridgeInfo/WattageHistoryLevel[]/Counter"

This property is a member of HpMoonshotCartridge

The reset type to be performed.

JSON type:

Integer

HTTP Operations

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

"CartridgeInfo/WattageHistoryLevel[]/Cumulator"

This property is a member of HpMoonshotCartridge

The reset type to be performed.

JSON type:

Integer

HTTP Operations

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

"CartridgeInfo/WattageHistoryLevel[]/SampleType"

This property is a member of HpMoonshotCartridge

Describes the sample type (time span and sample interval).

JSON type:

String

HTTP Operations

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

"CartridgeInfo/WattageHistoryLevel[]/Samples[]/Wattage"

This property is a member of HpMoonshotCartridge

The reset type to be performed.

JSON type:

String

HTTP Operations

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

"CartridgeInfo/WattageHistoryLevel[]/Samples[]/WattageInt"

This property is a member of HpMoonshotCartridge

The reset type to be performed.

JSON type:

Integer

HTTP Operations

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

"CartridgeInfo/Width"

This property is a member of HpMoonshotCartridge

JSON type:

Integer

HTTP Operations

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

"ChassisType"

This property is a member of HpMoonshotCartridge

JSON type:

String containing one of the following supported values:

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

HTTP Operations

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

"Dimensions/DepthInMm"

This property is a member of HpMoonshotCartridge

JSON type:

Integer greater than or equal to 0.

HTTP Operations

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

"Dimensions/HeightInMm"

This property is a member of HpMoonshotCartridge

JSON type:

Integer greater than or equal to 0.

HTTP Operations

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

"Dimensions/HeightInU"

This property is a member of HpMoonshotCartridge

JSON type:

Integer greater than or equal to 0.

HTTP Operations

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

"Dimensions/WidthInMm"

This property is a member of HpMoonshotCartridge

JSON type:

Integer greater than or equal to 0.

HTTP Operations

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

"FirmwareRevisions/CartridgeData/Current/VersionString"

This property is a member of HpMoonshotCartridge

JSON type:

String

HTTP Operations

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

"FirmwareRevisions/CartridgeProgrammableLogicDevice/Current/VersionString"

This property is a member of HpMoonshotCartridge

JSON type:

String

HTTP Operations

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

"FirmwareRevisions/CartridgeSatelliteFirmware/Current/VersionString"

This property is a member of HpMoonshotCartridge

JSON type:

String

HTTP Operations

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

"FirmwareRevisions/CartridgeSystemMEROMFirmware/Current/VersionString"

This property is a member of HpMoonshotCartridge

JSON type:

String

HTTP Operations

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

"FirmwareRevisions/CartridgeSystemROMFirmware/Current/VersionString"

This property is a member of HpMoonshotCartridge

JSON type:

String

HTTP Operations

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

"FirmwareRevisions/MiscFW[]/Firmware/Current/VersionString"

This property is a member of HpMoonshotCartridge

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.

"FirmwareRevisions/MiscFW[]/Firmware/definitions/FWVersion/VersionString"

This property is a member of HpMoonshotCartridge

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.

"FirmwareRevisions/RomFamily/Current/VersionString"

This property is a member of HpMoonshotCartridge

JSON type:

String

HTTP Operations

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

"IndicatorLED"

This property is a member of HpMoonshotCartridge

This property is indicates the state of the UID 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.
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 HpMoonshotCartridge 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.

"ManagementDevice/Address"

This property is a member of HpMoonshotCartridge

JSON type:

String

HTTP Operations

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

"ManagementDevice/JarFileName"

This property is a member of HpMoonshotCartridge

JSON type:

String

HTTP Operations

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

"ManagementDevice/RemoteConsoleCapability"

This property is a member of HpMoonshotCartridge

This property is true if remote console is available

JSON type:

Boolean ('true' or 'false')

HTTP Operations

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

"ManagementDevice/SessionID"

This property is a member of HpMoonshotCartridge

JSON type:

String

HTTP Operations

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

"Manufacturer"

This property is a member of HpMoonshotCartridge

JSON type:

String

HTTP Operations

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

"Mezzanine[]/AutoRev"

This property is a member of HpMoonshotCartridge

JSON type:

String

HTTP Operations

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

"Mezzanine[]/CartridgeMezzData/Current/VersionString"

This property is a member of HpMoonshotCartridge

JSON type:

String

HTTP Operations

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

"Mezzanine[]/MfgDateTime"

This property is a member of HpMoonshotCartridge

JSON type:

String

HTTP Operations

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

"Mezzanine[]/Model"

This property is a member of HpMoonshotCartridge

JSON type:

String

HTTP Operations

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

"Mezzanine[]/SKU"

This property is a member of HpMoonshotCartridge

JSON type:

String

HTTP Operations

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

"Mezzanine[]/SerialNumber"

This property is a member of HpMoonshotCartridge

JSON type:

String

HTTP Operations

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

"Mezzanine[]/SparePartNumber"

This property is a member of HpMoonshotCartridge

JSON type:

String

HTTP Operations

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

"Model"

This property is a member of HpMoonshotCartridge

JSON type:

String

HTTP Operations

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

"Power"

This property is a member of HpMoonshotCartridge

JSON type:

String containing one of the following supported values:

"Off"
"On"
"Press"
"PressAndHold"

HTTP Operations

GET	Rendered if supported by the implementation 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:

{"Power": "Press"}

The property "Power" on resource type HpMoonshotCartridge 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.

"SKU"

This property is a member of HpMoonshotCartridge

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:

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

The property "SKU" on resource type HpMoonshotCartridge 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.

"SerialNumber"

This property is a member of HpMoonshotCartridge

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:

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

The property "SerialNumber" on resource type HpMoonshotCartridge 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 HpMoonshotCartridge

Indicates the health state of this resource without considering its dependent resources.

JSON type:

String containing one of the following supported values:

"OK"
"Warning"
"Critical"
"Error"

HTTP Operations

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

"Status/HealthRollUp"

This property is a member of HpMoonshotCartridge

Indicates the overall health state of this resource and 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.

"Status/State"

This property is a member of HpMoonshotCartridge

JSON type:

String containing one of the following supported values:

"Critical"
"Enabled"
"Disabled"
"Offline"
"InTest"
"Starting"
"Absent"
"Uninitialized"
"OK"
"Not Installed"
"Failed"
"Degraded"
"Removed"
"Redundant"
"Not Redundant"
"Insufficient to Operate"

HTTP Operations

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

POST Action "LinkControl"

Parameter "ControlType"

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

"On"

"Off"

Parameter "LinkedCartridge"

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

"<string>"

Example

HTTP POST to resource with request JSON:

{ "Action": "LinkControl", "ControlType": "On", "LinkedCartridge": "<string>"}

POST Action "IndicatorLEDControl"

Parameter "ControlType"

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

"Lit"

"Off"

Example

HTTP POST to resource with request JSON:

{ "Action": "IndicatorLEDControl", "ControlType": "Lit"}

POST Action "RemoteConsoleSession"

Parameter "UserName"

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

"<string>"

Parameter "Type"

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

"Create"

"Delete"

Example

HTTP POST to resource with request JSON:

{ "UserName": "<string>", "Action": "RemoteConsoleSession", "Type": "Create"}

"HpMoonshotCartridgeLinkService" Resource Type

Resource Instances

/rest/v1/Chassis/{item}/CartridgeLinks

See Resource Map for more details.

"HpMoonshotCartridgeLinkService" defines the following properties:

"Status/Health"

This property is a member of HpMoonshotCartridgeLinkService

Indicates the health state of this resource without considering its dependent resources.

JSON type:

String containing one of the following supported values:

"OK"
"Warning"
"Critical"
"Error"

HTTP Operations

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

"Status/HealthRollUp"

This property is a member of HpMoonshotCartridgeLinkService

Indicates the overall health state of this resource and 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.

"Status/State"

This property is a member of HpMoonshotCartridgeLinkService

JSON type:

String containing one of the following supported values:

"Critical"
"Enabled"
"Disabled"
"Offline"
"InTest"
"Starting"
"Absent"
"Uninitialized"
"OK"
"Not Installed"
"Failed"
"Degraded"
"Removed"
"Redundant"
"Not Redundant"
"Insufficient to Operate"

HTTP Operations

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

POST Action "ChangeLinks"

Parameter "LinkEnabled"

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

"On"

"Off"

Parameter "LinkTargets"

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

"<string>"

Example

HTTP POST to resource with request JSON:

{ "Action": "ChangeLinks", "LinkEnabled": "On", "LinkTargets": "<string>"}

"HpMoonshotLogService" Resource Type

Resource Instances

/rest/v1/Chassis/{item}/Cartridges/{item}/Logs/IML

/rest/v1/Chassis/{item}/Logs/IML

/rest/v1/Chassis/{item}/Switches/{item}/Logs/IML

/rest/v1/Managers/{item}/Logs/IML

/rest/v1/Systems/{item}/Logs/IML

See Resource Map for more details.

This resource represents the log service for the resource or service to which it is associated.

"HpMoonshotLogService" defines the following properties:

"LogEntries[]/Class"

This property is a member of HpMoonshotLogService

Class of log Entry.

JSON type:

String containing one of the following supported values:

"Empty"
"Environment"
"Main Memory"
"Cache"
"CPU"
"Host Bus"
"EISA Bus"
"PCI Bus"
"EXp. Slot"
"POST Message"
"Power"
"ASR"
"OS"
"Network"
"SCSI"
"Drive Array"
"System Error"
"Maintenance"
"Rack Infrastructure"
"iLO Chassis Manager"
"System Revision"
"XNC"
"Smart Carrier"
"Power Cap"
"Error Report"
"Unknown"
"Reserved"

HTTP Operations

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

"LogEntries[]/Count"

This property is a member of HpMoonshotLogService

Number of times a matching event has been logged

JSON type:

Integer greater than or equal to 0.

HTTP Operations

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

"LogEntries[]/Created"

This property is a member of HpMoonshotLogService

The time the log entry was created.

JSON type:

String

HTTP Operations

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

"LogEntries[]/EntryType"

This property is a member of HpMoonshotLogService

Oem type (IML or iLO Log)

JSON type:

String containing one of the following supported values:

"Oem"

HTTP Operations

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

"LogEntries[]/Location"

This property is a member of HpMoonshotLogService

Chassis or Cx or CxNy or SA|SB

JSON type:

String

HTTP Operations

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

"LogEntries[]/OemRecordFormat"

This property is a member of HpMoonshotLogService

IML or iLO Event Log

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.

"LogEntries[]/RecordId"

This property is a member of HpMoonshotLogService

equivalent to legacy json 'id' property

JSON type:

Integer greater than or equal to 0.

HTTP Operations

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

"LogEntries[]/Severity"

This property is a member of HpMoonshotLogService

OK = Informational - ask if problems mapping severitys, equivalent to legacy json 'severity' property

JSON type:

String containing one of the following supported values:

"Informational"
"Repaired"
"Caution"
"Critical"
"Unknown"

HTTP Operations

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

"LogEntries[]/Updated"

This property is a member of HpMoonshotLogService

The time the log entry was created.

JSON type:

String

HTTP Operations

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

"MaxNumberOfRecords"

This property is a member of HpMoonshotLogService

The maximum number of log entries this service can have.

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 HpMoonshotLogService

The overwrite policy for this service that takes place when the log is full.

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.

See Resource Map for more details.

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

"Images/Front/extref"

This property is a member of HpMoonshotSwitch

The URI of an external resource.

JSON type:

String

HTTP Operations

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

"Images/Model/extref"

This property is a member of HpMoonshotSwitch

The URI of an external resource.

JSON type:

String

HTTP Operations

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

"IndicatorLED"

This property is a member of HpMoonshotSwitch

This property is indicates the state of the UID 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.
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 HpMoonshotSwitch 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 HpMoonshotSwitch

JSON type:

String

HTTP Operations

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

"Model"

This property is a member of HpMoonshotSwitch

JSON type:

String

HTTP Operations

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

"Power"

This property is a member of HpMoonshotSwitch

JSON type:

String containing one of the following supported values:

"On"
"Off"

HTTP Operations

GET	Rendered if supported by the implementation 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:

{"Power": "Off"}

This property is a member of HpMoonshotSwitch

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:

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

The property "SerialNumber" on resource type HpMoonshotSwitch 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.

"SparePartNumber"

This property is a member of HpMoonshotSwitch

JSON type:

String

HTTP Operations

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

"Status/Health"

This property is a member of HpMoonshotSwitch

Indicates the health state of this resource without considering its dependent resources.

JSON type:

String containing one of the following supported values:

"OK"
"Warning"
"Critical"
"Error"

HTTP Operations

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

"Status/HealthRollUp"

This property is a member of HpMoonshotSwitch

Indicates the overall health state of this resource and 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.

"Status/State"

This property is a member of HpMoonshotSwitch

JSON type:

String containing one of the following supported values:

"Critical"
"Enabled"
"Disabled"
"Offline"
"InTest"
"Starting"
"Absent"
"Uninitialized"
"OK"
"Not Installed"
"Failed"
"Degraded"
"Removed"
"Redundant"
"Not Redundant"
"Insufficient to Operate"

HTTP Operations

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

"SwitchInfo/AutoRev"

This property is a member of HpMoonshotSwitch

JSON type:

String

HTTP Operations

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

"SwitchInfo/HealthStatus"

This property is a member of HpMoonshotSwitch

JSON type:

String

HTTP Operations

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

"SwitchInfo/InstantWattage"

This property is a member of HpMoonshotSwitch

JSON type:

Integer

HTTP Operations

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

"SwitchInfo/ManagementStatus"

This property is a member of HpMoonshotSwitch

JSON type:

String

HTTP Operations

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

"SwitchInfo/MaximumWattage"

This property is a member of HpMoonshotSwitch

JSON type:

Integer

HTTP Operations

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

"SwitchInfo/MfgDateTime"

This property is a member of HpMoonshotSwitch

JSON type:

String

HTTP Operations

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

"SwitchInfo/SwitchType"

This property is a member of HpMoonshotSwitch

JSON type:

String

HTTP Operations

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

"SwitchInfo/UUID"

This property is a member of HpMoonshotSwitch

JSON type:

String

HTTP Operations

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

"SwitchInfo/WattageHistoryLevel[]/Counter"

This property is a member of HpMoonshotSwitch

The reset type to be performed.

JSON type:

Integer

HTTP Operations

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

"SwitchInfo/WattageHistoryLevel[]/Cumulator"

This property is a member of HpMoonshotSwitch

The reset type to be performed.

JSON type:

Integer

HTTP Operations

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

"SwitchInfo/WattageHistoryLevel[]/SampleType"

This property is a member of HpMoonshotSwitch

Describes the sample type (time span and sample interval).

JSON type:

String

HTTP Operations

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

"SwitchInfo/WattageHistoryLevel[]/Samples[]/Wattage"

This property is a member of HpMoonshotSwitch

The reset type to be performed.

JSON type:

String

HTTP Operations

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

"SwitchInfo/WattageHistoryLevel[]/Samples[]/WattageInt"

This property is a member of HpMoonshotSwitch

The reset type to be performed.

JSON type:

Integer

HTTP Operations

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

"UplinkModule/Model"

This property is a member of HpMoonshotSwitch

JSON type:

String

HTTP Operations

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

"UplinkModule/SKU"

This property is a member of HpMoonshotSwitch

JSON type:

String

HTTP Operations

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

"UplinkModule/SerialNumber"

This property is a member of HpMoonshotSwitch

JSON type:

String

HTTP Operations

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

POST Action "IndicatorLEDControl"

Parameter "ControlType"

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

"Lit"

"Off"

Example

HTTP POST to resource with request JSON:

{ "Action": "IndicatorLEDControl", "ControlType": "Lit"}

POST Action "PowerControl"

Parameter "ControlType"

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

"On"

"Off"

Example

HTTP POST to resource with request JSON:

{ "Action": "PowerControl", "ControlType": "On"}

"HpSecurityService" Resource Type

Resource Instances

/rest/v1/Managers/{item}/SecurityService

See Resource Map for more details.

"HpSecurityService" defines the following properties:

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

"NTPEnabled"

This property is a member of HpiLODateTime

JSON type:

Boolean ('true' or 'false')

HTTP Operations

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

"NTPPollingPeriodSeconds"

This property is a member of HpiLODateTime

JSON type:

Integer greater than or equal to 60.

HTTP Operations

GET	Rendered if supported by the implementation 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:

{"NTPPollingPeriodSeconds": <integer-value>}

The property "NTPPollingPeriodSeconds" 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 selected time zone index. To set a new time zone, specify a different time zone index.

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

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

The property "UpdateDateTime" 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.

"UseStaticNTPServers"

This property is a member of HpiLODateTime

JSON type:

Boolean ('true' or 'false')

HTTP Operations

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

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

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

The property "LicenseKey" on resource type HpiLOLicense 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.

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

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

GET	Rendered if supported by the 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"

Example

HTTP POST to resource with request JSON:

{ "Action": "Reset"}

POST Action "SetFactoryDefaults"

Example

HTTP POST to resource with request JSON:

{ "Action": "SetFactoryDefaults"}

"ManagerAccount" Resource Type

Resource Instances

/rest/v1/AccountService/Accounts/{item}

See Resource Map for more details.

"ManagerAccount" defines the following properties:

"Oem/Hp/LoginName"

This property is a member of ManagerAccount

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": {"LoginName": "<string-value>"}}}

The property "Oem/Hp/LoginName" 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.

"Oem/Hp/Privileges/CartridgeAccessPriv"

This property is a member of ManagerAccount

This privilege enables a user to access one or more of the cartridges in the chassis.

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": {"Privileges": {"CartridgeAccessPriv": "<string-value>"}}}}

The property "Oem/Hp/Privileges/CartridgeAccessPriv" 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.

"Oem/Hp/Privileges/ChassisAccessPriv"

This property is a member of ManagerAccount

This privilege enables a user to access properties in the chassis.

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": {"Privileges": {"ChassisAccessPriv": true}}}}

The property "Oem/Hp/Privileges/ChassisAccessPriv" 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.

"Oem/Hp/Privileges/LoginPriv"

This property is a member of ManagerAccount

This privilege enables a user to log in to management processor. All local accounts have the login privilege. This privilege is added automatically if it is not specified.

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": {"Privileges": {"LoginPriv": true}}}}

The property "Oem/Hp/Privileges/LoginPriv" 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.

"Oem/Hp/Privileges/RemoteConsolePriv"

This property is a member of ManagerAccount

This privilege enables a user to remotely access the host system Remote Console, including video, keyboard, and mouse control.

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": {"Privileges": {"RemoteConsolePriv": true}}}}

The property "Oem/Hp/Privileges/RemoteConsolePriv" 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.

"Oem/Hp/Privileges/SwitchAccessPriv"

This property is a member of ManagerAccount

This privilege enables a user to access one or more of the switches in the chassis.

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": {"Privileges": {"SwitchAccessPriv": "<string-value>"}}}}

The property "Oem/Hp/Privileges/SwitchAccessPriv" 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.

"Oem/Hp/Privileges/UserConfigPriv"

This property is a member of ManagerAccount

This privilege enables a user to add, edit, and delete local management processor user accounts. A user with this privilege can change privileges for all users.

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": {"Privileges": {"UserConfigPriv": true}}}}

The property "Oem/Hp/Privileges/UserConfigPriv" 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.

"Oem/Hp/Privileges/VirtualMediaPriv"

This property is a member of ManagerAccount

This privilege enables a user to use the Virtual Media feature on the host system.

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": {"Privileges": {"VirtualMediaPriv": true}}}}

The property "Oem/Hp/Privileges/VirtualMediaPriv" 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.

"Oem/Hp/Privileges/VirtualPowerAndResetPriv"

This property is a member of ManagerAccount

This privilege enables a user to power-cycle or reset the host system. These activities interrupt system availability. A user with this privilege can diagnose the system by using the Generate NMI to System button.

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": {"Privileges": {"VirtualPowerAndResetPriv": true}}}}

The property "Oem/Hp/Privileges/VirtualPowerAndResetPriv" 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.

"Oem/Hp/Privileges/iLOConfigPriv"

This property is a member of ManagerAccount

This privilege enables a user to configure most management processor settings, including security settings, and to remotely update the management processor firmware. This privilege does not enable local user account administration.

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": {"Privileges": {"iLOConfigPriv": 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:

{"Oem": {"Hp": {"UserEnabled": true}}}

The property "Oem/Hp/UserEnabled" 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.

"Oem/Hp/UserPrivilege"

This property is a member of ManagerAccount

User privilege compatible with iLO CM CLI.

JSON type:

String containing one of the following supported values:

"Administrator"
"User"
"Operator"
"None"

HTTP Operations

GET	Rendered if supported by the implementation 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": {"UserPrivilege": "Operator"}}}

The property "Oem/Hp/UserPrivilege" 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.

"Password"

This property is a member of ManagerAccount

The password used to log in to the management processor. The maximum length for a password is 39 characters. The minimum length for a password is specified in the MinPasswordLength property of the AccountService schema.

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:

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

The property "Password" 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.

"UserName"

This property is a member of ManagerAccount

The name used to log in to the management processor. The user name does not have to be the same as the login name. The maximum length for the user name is 39 characters. The user name must use printable characters.

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:

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

POST Action "AddSSHPublicKey"

Parameter "KeyData"

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

Parameter "Target"

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

"/Oem/Hp"

Example

HTTP POST to resource with request JSON:

{ "Action": "AddSSHPublicKey", "KeyData": "", "Target": "/Oem/Hp"}

POST Action "RemoveSSHPublicKey"

Parameter "Target"

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

"/Oem/Hp"

Example

HTTP POST to resource with request JSON:

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

"ManagerGroup" Resource Type

Resource Instances

/rest/v1/DirectoryService/Groups/{item}

See Resource Map for more details.

"ManagerGroup" defines the following properties:

"Oem/Hp/GroupName"

This property is a member of ManagerGroup

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": {"GroupName": "<string-value>"}}}

The property "Oem/Hp/GroupName" on resource type ManagerGroup 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/GroupPrivilege"

This property is a member of ManagerGroup

User privilege compatible with iLO CM CLI.

JSON type:

String containing one of the following supported values:

"Administrator"
"User"
"Operator"
"None"

HTTP Operations

GET	Rendered if supported by the implementation 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": {"GroupPrivilege": "Operator"}}}

The property "Oem/Hp/GroupPrivilege" on resource type ManagerGroup 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/Privileges/CartridgeAccessPriv"

This property is a member of ManagerGroup

This privilege enables a user to access one or more of the cartridges in the chassis.

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": {"Privileges": {"CartridgeAccessPriv": "<string-value>"}}}}

The property "Oem/Hp/Privileges/CartridgeAccessPriv" on resource type ManagerGroup 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/Privileges/ChassisAccessPriv"

This property is a member of ManagerGroup

This privilege enables a user to access properties in the chassis.

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": {"Privileges": {"ChassisAccessPriv": true}}}}

The property "Oem/Hp/Privileges/ChassisAccessPriv" on resource type ManagerGroup 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/Privileges/SwitchAccessPriv"

This property is a member of ManagerGroup

This privilege enables a user to access one or more of the switches in the chassis.

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": {"Privileges": {"SwitchAccessPriv": "<string-value>"}}}}

The property "Oem/Hp/Privileges/SwitchAccessPriv" on resource type ManagerGroup 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/SID"

This property is a member of ManagerGroup

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": {"SID": "<string-value>"}}}

The property "Oem/Hp/SID" on resource type ManagerGroup 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.

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

The property "HTTP/Port" on resource type ManagerNetworkService 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/Enabled"

This property is a member of ManagerNetworkService

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.

"HTTPS/Port"

This property is a member of ManagerNetworkService

The HTTPS/SSL 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:

{"HTTPS": {"Port": <integer-value>}}

The property "HTTPS/Port" on resource type ManagerNetworkService 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 ManagerNetworkService

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

IPMI enable

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:

{"IPMI": {"Enabled": true}}

The property "IPMI/Enabled" on resource type ManagerNetworkService 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 ManagerNetworkService

IPMI port number

JSON type:

Integer from 1 to 65535.

HTTP Operations

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

"Oem/Hp/AlertMailEmail"

This property is a member of ManagerNetworkService

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

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

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

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

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

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/FederationEnabled"

This property is a member of ManagerNetworkService

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

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 ManagerNetworkService

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

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

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

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

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

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 ManagerNetworkService 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/TFTPServerEnabled"

This property is a member of ManagerNetworkService

Indicates whether TFTP server 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": {"TFTPServerEnabled": true}}}

The property "Oem/Hp/TFTPServerEnabled" on resource type ManagerNetworkService 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 ManagerNetworkService

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

SSDP enable

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:

{"SSDP": {"Enabled": true}}

The property "SSDP/Enabled" on resource type ManagerNetworkService 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 ManagerNetworkService

The time interval, in seconds, between transmissions of the multicast NOTIFY ALIVE message. A setting of 0 seconds disables this functionality. The recommended value is 600 seconds.

JSON type:

Integer greater than or equal to 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.

PATCH Example

HTTP PATCH to resource with request JSON:

{"SSDP": {"NotifyMulticastIntervalSeconds": <integer-value>}}

The property "SSDP/NotifyMulticastIntervalSeconds" on resource type ManagerNetworkService 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 ManagerNetworkService

The Time-To-Live hop count used for multicast NOTIFY messages. The recommended value is 5.

JSON type:

Integer greater than or equal to 1.

HTTP Operations

GET	Rendered if supported by the implementation 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:

{"SSDP": {"NotifyTTL": <integer-value>}}

The property "SSDP/NotifyTTL" on resource type ManagerNetworkService 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 ManagerNetworkService

SSDP port number

JSON type:

Integer from 1 to 65535.

HTTP Operations

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

"SSH/Enabled"

This property is a member of ManagerNetworkService

SSH enable

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:

{"SSH": {"Enabled": true}}

The property "SSH/Enabled" on resource type ManagerNetworkService 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 ManagerNetworkService

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

{"SSH": {"Port": <integer-value>}}

The property "SSH/Port" on resource type ManagerNetworkService 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 ManagerNetworkService

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

Indicates the health state of this resource without considering its dependent resources.

JSON type:

String containing one of the following supported values:

"OK"
"Warning"
"Critical"
"Error"

HTTP Operations

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

"Status/HealthRollUp"

This property is a member of ManagerNetworkService

Indicates the overall health state of this resource and 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.

"Status/State"

This property is a member of ManagerNetworkService

JSON type:

String containing one of the following supported values:

"Critical"
"Enabled"
"Disabled"
"Offline"
"InTest"
"Starting"
"Absent"
"Uninitialized"
"OK"
"Not Installed"
"Failed"
"Degraded"
"Removed"
"Redundant"
"Not Redundant"
"Insufficient to Operate"

HTTP Operations

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

POST Action "TestAlertMail"

Test AlertMail feature with current settings.

Parameter "Target"

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

"/Oem/Hp"

Example

HTTP POST to resource with request JSON:

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

POST Action "TestRemoteSyslog"

Test Remote Syslog feature with current settings.

Parameter "Target"

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

"/Oem/Hp"

Example

HTTP POST to resource with request JSON:

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

"ManagerRepositoryService" Resource Type

Resource Instances

/rest/v1/Managers/{item}/RepositoryService

See Resource Map for more details.

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

"ManagerSerial" Resource Type

Resource Instances

/rest/v1/Managers/{item}/SerialService

See Resource Map for more details.

"ManagerSerial" defines the following properties:

"BaudRate"

This property is a member of ManagerSerial

JSON type:

Integer

HTTP Operations

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

"DataBits"

This property is a member of ManagerSerial

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:

{"DataBits": <integer-value>}

The property "DataBits" on resource type ManagerSerial 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.

"Parity"

This property is a member of ManagerSerial

JSON type:

String containing one of the following supported values:

"None"
"Even"
"Odd"
"Space"
"Mark"
"Unknown"

HTTP Operations

GET	Rendered if supported by the implementation 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:

{"Parity": "Space"}

The property "Parity" on resource type ManagerSerial 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.

"SerialEnabled"

This property is a member of ManagerSerial

JSON type:

Boolean ('true' or 'false')

HTTP Operations

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

"StopBits"

This property is a member of ManagerSerial

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:

{"StopBits": <integer-value>}

The property "StopBits" on resource type ManagerSerial 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.

"ManagerUpdateService" Resource Type

Resource Instances

/rest/v1/Managers/{item}/UpdateService

See Resource Map for more details.

"ManagerUpdateService" defines the following properties:

"Oem/Hp/CompletionInstructions"

This property is a member of ManagerUpdateService

Completion instructions embedded in the binary flash file.

JSON type:

String

HTTP Operations

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

"Oem/Hp/Details"

This property is a member of ManagerUpdateService

Details about the current firmware flash status.

JSON type:

String

HTTP Operations

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

"Oem/Hp/Flags"

This property is a member of ManagerUpdateService

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.

"Oem/Hp/ImageType"

This property is a member of ManagerUpdateService

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.

"Oem/Hp/ProgressPercent"

This property is a member of ManagerUpdateService

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.

"Oem/Hp/State"

This property is a member of ManagerUpdateService

Current state of the firmware flash.

JSON type:

String containing one of the following supported values:

"IDLE"
"UPLOADING"
"PROGRESSING"
"COMPLETED"
"ERROR"
"NOT AUTHORIZED"
"NO ACTION"
"PENDING"

HTTP Operations

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

"Oem/Hp/UpdateStatus[]/CompletionStatus"

This property is a member of ManagerUpdateService

Completion status of the firmware flash for this item.

JSON type:

String

HTTP Operations

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

"Oem/Hp/UpdateStatus[]/ProgressPercent"

This property is a member of ManagerUpdateService

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.

"Oem/Hp/UpdateStatus[]/SlotOrBayNumber"

This property is a member of ManagerUpdateService

JSON type:

Integer greater than or equal to 1.

HTTP Operations

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

"Oem/Hp/UpdateStatus[]/State"

This property is a member of ManagerUpdateService

Current state of the firmware flash.

JSON type:

String containing one of the following supported values:

"IDLE"
"UPLOADING"
"PROGRESSING"
"COMPLETED"
"ERROR"
"NOT SELECTED FOR UPDATE"
"EMPTY SLOT"
"NOT AUTHORIZED"
"NO ACTION"
"PENDING"

HTTP Operations

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

"Oem/Hp/links/UpdateUri/extref"

This property is a member of ManagerUpdateService

The URI of an external resource.

JSON type:

String

HTTP Operations

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

POST Action "ClearUpdateStatus"

Parameter "Target"

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

"/Oem/Hp"

Example

HTTP POST to resource with request JSON:

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

POST Action "InstallFromURI"

Parameter "FirmwareURI"

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

Parameter "UpdateTargets"

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

Parameter "ForceUpdate"

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

Parameter "Target"

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

"/Oem/Hp"

Example

HTTP POST to resource with request JSON:

{ "Action": "InstallFromURI", "FirmwareURI": "", "UpdateTargets": "", "ForceUpdate": , "Target": "/Oem/Hp"}

POST Action "InstallParameters"

Parameter "FirmwareFileName"

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

Parameter "UpdateTargets"

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

Parameter "Target"

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

"/Oem/Hp"

Example

HTTP POST to resource with request JSON:

{ "Action": "InstallParameters", "FirmwareFileName": "", "UpdateTargets": "", "Target": "/Oem/Hp"}

POST Action "InstallFromRepository"

Parameter "FirmwareFileName"

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

Parameter "UpdateTargets"

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

Parameter "ForceUpdate"

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

Parameter "Target"

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

"/Oem/Hp"

Example

HTTP POST to resource with request JSON:

{ "Action": "InstallFromRepository", "FirmwareFileName": "", "UpdateTargets": "", "ForceUpdate": , "Target": "/Oem/Hp"}

"MoonshotPowerMetrics" Resource Type

Resource Instances

/rest/v1/Chassis/{item}/Cartridges/{item}/PowerMetrics

/rest/v1/Chassis/{item}/PowerMetrics

/rest/v1/Chassis/{item}/Switches/{item}/PowerMetrics

See Resource Map for more details.

"MoonshotPowerMetrics" defines the following properties:

"Oem/Hp/InstantWattage"

This property is a member of MoonshotPowerMetrics

JSON type:

Integer

HTTP Operations

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

"Oem/Hp/MaximumWattage"

This property is a member of MoonshotPowerMetrics

JSON type:

Integer

HTTP Operations

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

"Oem/Hp/PowercapDescription"

This property is a member of MoonshotPowerMetrics

Powercap description.

JSON type:

String

HTTP Operations

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

"Oem/Hp/PowercapMode"

This property is a member of MoonshotPowerMetrics

Powercap Mode.

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": {"PowercapMode": <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.

"PowerLimit/LimitException"

This property is a member of MoonshotPowerMetrics

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

The property "PowerLimit/LimitException" on resource type MoonshotPowerMetrics 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 MoonshotPowerMetrics

Power limit (also known as 'Power Cap') in Watts. Set to null to disable the power cap.

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:

{"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[]/ACInputStatus"

This property is a member of MoonshotPowerMetrics

Indicates the type of fault present.

JSON type:

String containing one of the following supported values:

"Failed"
"OK"

HTTP Operations

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

"PowerSupplies[]/FirmwareVersion"

This property is a member of MoonshotPowerMetrics

Firmware version of the 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[]/LastPowerOutputWatts"

This property is a member of MoonshotPowerMetrics

Average power consumed, in watts.

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.

"PowerSupplies[]/LineInputVoltage"

This property is a member of MoonshotPowerMetrics

Line input voltage at which the power supply is operating at this moment (in Volts).

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[]/LineInputVoltageType"

This property is a member of MoonshotPowerMetrics

Line voltage type: ACLowLine, ACMidLine, ACHighLine, DCNeg48V, DC420V, or Unknown.

JSON type:

String containing one of the following supported values:

"Unknown"
"ACLowLine"
"ACMidLine"
"ACHighLine"
"DCNeg48V"
"DC480V"

HTTP Operations

GET	Rendered if supported by the 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[]/Model"

This property is a member of MoonshotPowerMetrics

Model name of the 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 MoonshotPowerMetrics

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 MoonshotPowerMetrics

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 MoonshotPowerMetrics

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 MoonshotPowerMetrics

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 MoonshotPowerMetrics

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 MoonshotPowerMetrics

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 MoonshotPowerMetrics

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 MoonshotPowerMetrics

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 MoonshotPowerMetrics

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 MoonshotPowerMetrics

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 MoonshotPowerMetrics

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 MoonshotPowerMetrics

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 MoonshotPowerMetrics

Part number of the 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 MoonshotPowerMetrics

Power capacity of the power supply, in watts.

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.

"PowerSupplies[]/PowerSupplyType"

This property is a member of MoonshotPowerMetrics

Power supply type: AC, DC, or Unknown.

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[]/SerialNumber"

This property is a member of MoonshotPowerMetrics

Serial number of the 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 MoonshotPowerMetrics

Spare part number of the 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 MoonshotPowerMetrics

Indicates the health state of this resource without considering its dependent resources.

JSON type:

String containing one of the following supported values:

"OK"
"Warning"
"Critical"
"Error"

HTTP Operations

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

"PowerSupplies[]/Status/HealthRollUp"

This property is a member of MoonshotPowerMetrics

Indicates the overall health state of this resource and 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.

"PowerSupplies[]/Status/State"

This property is a member of MoonshotPowerMetrics

JSON type:

String containing one of the following supported values:

"Critical"
"Enabled"
"Disabled"
"Offline"
"InTest"
"Starting"
"Absent"
"Uninitialized"
"OK"
"Not Installed"
"Failed"
"Degraded"
"Removed"
"Redundant"
"Not Redundant"
"Insufficient to Operate"

HTTP Operations

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

"Status/Health"

This property is a member of MoonshotPowerMetrics

Indicates the health state of this resource without considering its dependent resources.

JSON type:

String containing one of the following supported values:

"OK"
"Warning"
"Critical"
"Error"

HTTP Operations

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

"Status/HealthRollUp"

This property is a member of MoonshotPowerMetrics

Indicates the overall health state of this resource and 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.

"Status/State"

This property is a member of MoonshotPowerMetrics

JSON type:

String containing one of the following supported values:

"Critical"
"Enabled"
"Disabled"
"Offline"
"InTest"
"Starting"
"Absent"
"Uninitialized"
"OK"
"Not Installed"
"Failed"
"Degraded"
"Removed"
"Redundant"
"Not Redundant"
"Insufficient to Operate"

HTTP Operations

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

"SecurityBanner" Resource Type

Resource Instances

/rest/v1/Managers/{item}/SecurityService/SecurityBanner

See Resource Map for more details.

"SecurityBanner" defines the following properties:

"LoginSecurityBannerEnabled"

This property is a member of SecurityBanner

The login security banner message will be displayed on the management processor Login page.

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:

{"LoginSecurityBannerEnabled": true}

The property "LoginSecurityBannerEnabled" on resource type SecurityBanner 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.

"SecurityMessage"

This property is a member of SecurityBanner

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

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

The property "SecurityMessage" on resource type SecurityBanner 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.

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

"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 containing one of the following supported values:

"0.9.5"
"0.91.0"

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

GET	Rendered if supported by the 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.

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

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

POST Action "SendSNMPTestAlert"

Example

HTTP POST to resource with request JSON:

{ "Action": "SendSNMPTestAlert"}

"SystemsSummary" Resource Type

Resource Instances

/rest/v1/SystemsSummary

See Resource Map for more details.

"SystemsSummary" defines the following properties:

"SystemsInChassis"

This property is a member of SystemsSummary

The total number of systems (nodes) in the physical chassis.

JSON type:

Integer

HTTP Operations

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

"SystemsOnThisPage"

This property is a member of SystemsSummary

The number of systems (nodes) presented on this page.

JSON type:

Integer

HTTP Operations

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

"Systems[]/Health"

This property is a member of SystemsSummary

JSON type:

String

HTTP Operations

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

"Systems[]/Memory"

This property is a member of SystemsSummary

32 GB

JSON type:

String

HTTP Operations

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

"Systems[]/Model"

This property is a member of SystemsSummary

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

"Systems[]/NodeOptions"

This property is a member of SystemsSummary

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.

"Systems[]/Options/BSC"

This property is a member of SystemsSummary

BIOS Serial Console

JSON type:

String containing one of the following supported values:

"enabled"
"disabled"
"DISABLE"
"ENABLE"

HTTP Operations

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

"Systems[]/Options/BootOnce"

This property is a member of SystemsSummary

The current boot source to be used at next boot instead of the normal boot device

JSON type:

String containing one of the following supported values:

"None"
"HDD"
"PXE"
"iSCSI"
"M.2"

HTTP Operations

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

"Systems[]/Options/CPU/ClockRate/CurrentFrequency"

This property is a member of SystemsSummary

Current CPU clock rate

JSON type:

String

HTTP Operations

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

"Systems[]/Options/CPU/HyperThreading"

This property is a member of SystemsSummary

Intel CPU HyperThreading

JSON type:

String containing one of the following supported values:

"enabled"
"disabled"
"DISABLE"
"ENABLE"

HTTP Operations

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

"Systems[]/Options/WOL"

This property is a member of SystemsSummary

Wake On LAN

JSON type:

String

HTTP Operations

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

"Systems[]/Power"

This property is a member of SystemsSummary

On/Off

JSON type:

String

HTTP Operations

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

"Systems[]/ProcessorFamily"

This property is a member of SystemsSummary

ARM Architecture

JSON type:

String

HTTP Operations

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

"Systems[]/ProcessorManufacturer"

This property is a member of SystemsSummary

AppliedMicro (APM)

JSON type:

String

HTTP Operations

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

"Systems[]/SKU"

This property is a member of SystemsSummary

The manufacturer's 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.

"Systems[]/SerialNumber"

This property is a member of SystemsSummary

The serial number 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.

"Systems[]/UUID"

This property is a member of SystemsSummary

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.

"ThermalMetrics" Resource Type

Resource Instances

/rest/v1/Chassis/{item}/Cartridges/{item}/ThermalMetrics

/rest/v1/Chassis/{item}/Switches/{item}/ThermalMetrics

/rest/v1/Chassis/{item}/ThermalMetrics

See Resource Map for more details.

The schema definition for the Thermal Metrics. It represents the properties for temperature and cooling.

GET	Rendered if supported by the 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 ThermalMetrics

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[]/ProductName"

This property is a member of ThermalMetrics

see legacy json 'health_fans' prop 'label'

JSON type:

String

HTTP Operations

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

"Fans[]/Status/Health"

This property is a member of ThermalMetrics

Indicates the health state of this resource without considering its dependent resources.

JSON type:

String containing one of the following supported values:

"OK"
"Warning"
"Critical"
"Error"

HTTP Operations

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

"Fans[]/Status/HealthRollUp"

This property is a member of ThermalMetrics

Indicates the overall health state of this resource and 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.

"Fans[]/Status/State"

This property is a member of ThermalMetrics

JSON type:

String containing one of the following supported values:

"Critical"
"Enabled"
"Disabled"
"Offline"
"InTest"
"Starting"
"Absent"
"Uninitialized"
"OK"
"Not Installed"
"Failed"
"Degraded"
"Removed"
"Redundant"
"Not Redundant"
"Insufficient to Operate"

HTTP Operations

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

"Fans[]/Units"

This property is a member of ThermalMetrics

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 ThermalMetrics

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 ThermalMetrics

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 ThermalMetrics

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.

"Temperatures[]/CorrelatableID"

This property is a member of ThermalMetrics

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 ThermalMetrics

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 ThermalMetrics

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 ThermalMetrics

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 ThermalMetrics

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 ThermalMetrics

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 ThermalMetrics

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 ThermalMetrics

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[]/Status/Health"

This property is a member of ThermalMetrics

Indicates the health state of this resource without considering its dependent resources.

JSON type:

String containing one of the following supported values:

"OK"
"Warning"
"Critical"
"Error"

HTTP Operations

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

"Temperatures[]/Status/HealthRollUp"

This property is a member of ThermalMetrics

Indicates the overall health state of this resource and 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.

"Temperatures[]/Status/State"

This property is a member of ThermalMetrics

JSON type:

String containing one of the following supported values:

"Critical"
"Enabled"
"Disabled"
"Offline"
"InTest"
"Starting"
"Absent"
"Uninitialized"
"OK"
"Not Installed"
"Failed"
"Degraded"
"Removed"
"Redundant"
"Not Redundant"
"Insufficient to Operate"

HTTP Operations

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

"Temperatures[]/TemperatureHistoryLevel[]/Counter"

This property is a member of ThermalMetrics

The reset type to be performed.

JSON type:

Integer

HTTP Operations

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

"Temperatures[]/TemperatureHistoryLevel[]/Cumulator"

This property is a member of ThermalMetrics

The reset type to be performed.

JSON type:

Integer

HTTP Operations

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

"Temperatures[]/TemperatureHistoryLevel[]/SampleType"

This property is a member of ThermalMetrics

Describes the sample type (time span and sample interval).

JSON type:

String

HTTP Operations

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

"Temperatures[]/TemperatureHistoryLevel[]/Samples[]/Temperature"

This property is a member of ThermalMetrics

The reset type to be performed.

JSON type:

Integer

HTTP Operations

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

"Temperatures[]/Units"

This property is a member of ThermalMetrics

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 ThermalMetrics

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 ThermalMetrics

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 ThermalMetrics

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.

Severity: Warning

Resolution: Try a different user or login user name.

iLO.UserNameAlreadyExists

Duplicate SNMPv3 User.

Severity: Warning

Resolution: Enter a different name and try again.

/rest/v1	ServiceRoot	HTTP Allow: GET
	Links to other resources	to resource URI	to resource Type
	/Oem/Hp/links/DirectoryService	/rest/v1/DirectoryService	DirectoryService
	/Oem/Hp/links/Systems[]	/rest/v1/SystemsSummary	SystemsSummary
	/links/AccountService	/rest/v1/AccountService	AccountService
	/links/Chassis	/rest/v1/Chassis	Collection
	/links/Managers	/rest/v1/Managers	Collection
	/links/Registries	/rest/v1/Registries	Collection
	/links/Schemas	/rest/v1/Schemas	Collection
	/links/Sessions	/rest/v1/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, POST, 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, PATCH, POST
	Links to other resources	to resource URI	to resource Type
	/Oem/Hp/links/CartridgeLinks	/rest/v1/Chassis/{item}/CartridgeLinks	HpMoonshotCartridgeLinkService
	/Oem/Hp/links/Cartridges	/rest/v1/Chassis/{item}/Cartridges	Collection
	/Oem/Hp/links/ChassisFirmwareSummary	/rest/v1/Chassis/{item}/ChassisFirmwareSummary	ChassisFirmwareSummary
	/Oem/Hp/links/ChassisSummary	/rest/v1/Chassis/{item}/ChassisSummary	ChassisSummary
	/Oem/Hp/links/Switches	/rest/v1/Chassis/{item}/Switches	Collection
	/links/LogService	/rest/v1/Chassis/{item}/Logs/IML	HpMoonshotLogService
	/links/ManagedBy[]	/rest/v1/Managers/{item}	Manager
	/links/PowerMetrics	/rest/v1/Chassis/{item}/PowerMetrics	MoonshotPowerMetrics
	/links/ThermalMetrics	/rest/v1/Chassis/{item}/ThermalMetrics	ThermalMetrics

/rest/v1/Chassis/{item}/CartridgeLinks	HpMoonshotCartridgeLinkService	HTTP Allow: GET, POST
	Links to other resources	to resource URI	to resource Type
	/links/Entries	/rest/v1/Chassis/{item}/CartridgeLinks/Entries	Collection

/rest/v1/Chassis/{item}/CartridgeLinks/Entries	Collection	HTTP Allow: GET, POST
	Links to other resources	to resource URI	to resource Type
	/links/Member[]	/rest/v1/Chassis/{item}/CartridgeLinks/Entries/{item}	CartridgeLinkEntry

/rest/v1/Chassis/{item}/CartridgeLinks/Entries/{item}	CartridgeLinkEntry	HTTP Allow: GET, PATCH, POST
	Links to other resources	to resource URI	to resource Type

/rest/v1/Chassis/{item}/Cartridges	Collection	HTTP Allow: GET
	Links to other resources	to resource URI	to resource Type
	/links/Member[]	/rest/v1/Chassis/{item}/Cartridges/{item}	HpMoonshotCartridge

/rest/v1/Chassis/{item}/Cartridges/{item}	HpMoonshotCartridge	HTTP Allow: GET, PATCH, POST
	Links to other resources	to resource URI	to resource Type
	/links/ComputerSystems[]	/rest/v1/Systems/{item}	ComputerSystem
	/links/LogService	/rest/v1/Chassis/{item}/Cartridges/{item}/Logs/IML	HpMoonshotLogService
	/links/ManagedBy[]	/rest/v1/Managers/{item}	Manager
	/links/PowerMetrics	/rest/v1/Chassis/{item}/Cartridges/{item}/PowerMetrics	MoonshotPowerMetrics
	/links/ThermalMetrics	/rest/v1/Chassis/{item}/Cartridges/{item}/ThermalMetrics	ThermalMetrics

/rest/v1/Chassis/{item}/Cartridges/{item}/Logs/IML	HpMoonshotLogService	HTTP Allow: GET, PATCH, POST
	Links to other resources	to resource URI	to resource Type

/rest/v1/Chassis/{item}/Cartridges/{item}/PowerMetrics	MoonshotPowerMetrics	HTTP Allow: GET, PATCH
	Links to other resources	to resource URI	to resource Type

/rest/v1/Chassis/{item}/Cartridges/{item}/ThermalMetrics	ThermalMetrics	HTTP Allow: GET
	Links to other resources	to resource URI	to resource Type

/rest/v1/Chassis/{item}/ChassisFirmwareSummary	ChassisFirmwareSummary	HTTP Allow: GET
	Links to other resources	to resource URI	to resource Type

/rest/v1/Chassis/{item}/ChassisSummary	ChassisSummary	HTTP Allow: GET
	Links to other resources	to resource URI	to resource Type

/rest/v1/Chassis/{item}/Logs/IML	HpMoonshotLogService	HTTP Allow: GET, PATCH, POST
	Links to other resources	to resource URI	to resource Type

/rest/v1/Chassis/{item}/PowerMetrics	MoonshotPowerMetrics	HTTP Allow: GET, PATCH
	Links to other resources	to resource URI	to resource Type

/rest/v1/Chassis/{item}/Switches	Collection	HTTP Allow: GET
	Links to other resources	to resource URI	to resource Type
	/links/Member[]	/rest/v1/Chassis/{item}/Switches/{item}	HpMoonshotSwitch

/rest/v1/Chassis/{item}/Switches/{item}	HpMoonshotSwitch	HTTP Allow: GET, PATCH, POST
	Links to other resources	to resource URI	to resource Type
	/links/LogService	/rest/v1/Chassis/{item}/Switches/{item}/Logs/IML	HpMoonshotLogService
	/links/ManagedBy[]	/rest/v1/Managers/{item}	Manager
	/links/PowerMetrics	/rest/v1/Chassis/{item}/Switches/{item}/PowerMetrics	MoonshotPowerMetrics
	/links/ThermalMetrics	/rest/v1/Chassis/{item}/Switches/{item}/ThermalMetrics	ThermalMetrics

/rest/v1/Chassis/{item}/Switches/{item}/Logs/IML	HpMoonshotLogService	HTTP Allow: GET, PATCH, POST
	Links to other resources	to resource URI	to resource Type

/rest/v1/Chassis/{item}/Switches/{item}/PowerMetrics	MoonshotPowerMetrics	HTTP Allow: GET, PATCH
	Links to other resources	to resource URI	to resource Type

/rest/v1/Chassis/{item}/Switches/{item}/ThermalMetrics	ThermalMetrics	HTTP Allow: GET
	Links to other resources	to resource URI	to resource Type

/rest/v1/Chassis/{item}/ThermalMetrics	ThermalMetrics	HTTP Allow: GET
	Links to other resources	to resource URI	to resource Type

/rest/v1/DirectoryService	DirectoryService	HTTP Allow: GET, PATCH, POST
	Links to other resources	to resource URI	to resource Type
	/links/Groups	/rest/v1/DirectoryService/Groups	Collection

/rest/v1/DirectoryService/Groups	Collection	HTTP Allow: GET, POST
	Links to other resources	to resource URI	to resource Type
	/links/Member[]	/rest/v1/DirectoryService/Groups/{item}	ManagerGroup

/rest/v1/DirectoryService/Groups/{item}	ManagerGroup	HTTP Allow: GET, PATCH, POST, DELETE
	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, POST
	Links to other resources	to resource URI	to resource Type
	/Oem/Hp/links/DateTime	/rest/v1/Managers/{item}/DateTime	HpiLODateTime
	/Oem/Hp/links/LicenseService	/rest/v1/Managers/{item}/LicenseService	Collection
	/Oem/Hp/links/LogService[]	/rest/v1/Managers/{item}/Logs/IML	HpMoonshotLogService
	/Oem/Hp/links/RepositoryService	/rest/v1/Managers/{item}/RepositoryService	ManagerRepositoryService
	/Oem/Hp/links/SecurityService	/rest/v1/Managers/{item}/SecurityService	HpSecurityService
	/Oem/Hp/links/SerialService	/rest/v1/Managers/{item}/SerialService	ManagerSerial
	/Oem/Hp/links/UpdateService	/rest/v1/Managers/{item}/UpdateService	ManagerUpdateService
	/links/EthernetNICs	/rest/v1/Managers/{item}/NICs	Collection
	/links/NetworkService	/rest/v1/Managers/{item}/NetworkService	ManagerNetworkService

/rest/v1/Managers/{item}/DateTime	HpiLODateTime	HTTP Allow: GET, PATCH
	Links to other resources	to resource URI	to resource Type
	/links/EthernetNICs	/rest/v1/Managers/{item}/NICs	Collection

/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}/Logs/IML	HpMoonshotLogService	HTTP Allow: GET, PATCH, POST
	Links to other resources	to resource URI	to resource Type

/rest/v1/Managers/{item}/NICs	Collection	HTTP Allow: GET
	Links to other resources	to resource URI	to resource Type
	/links/Member[]	/rest/v1/Managers/{item}/NICs/{item}	EthernetNetworkInterface

/rest/v1/Managers/{item}/NICs/{item}	EthernetNetworkInterface	HTTP Allow: GET, PATCH
	Links to other resources	to resource URI	to resource Type
	/links/NetworkServices[]	/rest/v1/Managers/{item}/NetworkService	ManagerNetworkService

/rest/v1/Managers/{item}/NetworkService	ManagerNetworkService	HTTP Allow: GET, PATCH, POST
	Links to other resources	to resource URI	to resource Type
	/Oem/Hp/links/EthernetNICs	/rest/v1/Managers/{item}/NICs	Collection
	/links/SNMPService	/rest/v1/Managers/{item}/SnmpService	SnmpService

/rest/v1/Managers/{item}/RepositoryService	ManagerRepositoryService	HTTP Allow: GET, PATCH, POST
	Links to other resources	to resource URI	to resource Type

/rest/v1/Managers/{item}/SecurityService	HpSecurityService	HTTP Allow: GET, PATCH
	Links to other resources	to resource URI	to resource Type
	/links/HttpsCert	/rest/v1/Managers/{item}/SecurityService/HTTPSCert	HpHttpsCert
	/links/SecurityBanner	/rest/v1/Managers/{item}/SecurityService/SecurityBanner	SecurityBanner

/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/SecurityBanner	SecurityBanner	HTTP Allow: GET, PATCH
	Links to other resources	to resource URI	to resource Type

/rest/v1/Managers/{item}/SerialService	ManagerSerial	HTTP Allow: GET, PATCH
	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	ManagerUpdateService	HTTP Allow: GET, PATCH, POST
	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/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/Sessions	Collection	HTTP Allow: GET, POST
	Links to other resources	to resource URI	to resource Type
	/Oem/Hp/links/MySession	/rest/v1/Sessions/{item}	Session
	/links/Member[]	/rest/v1/Sessions/{item}	Session

/rest/v1/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
	/links/Chassis[]	/rest/v1/Chassis/{item}	Chassis
	/links/LogService	/rest/v1/Systems/{item}/Logs/IML	HpMoonshotLogService
	/links/ManagedBy[]	/rest/v1/Managers/{item}	Manager

/rest/v1/Systems/{item}/Logs/IML	HpMoonshotLogService	HTTP Allow: GET, PATCH, POST
	Links to other resources	to resource URI	to resource Type

/rest/v1/SystemsSummary	SystemsSummary	HTTP Allow: GET
	Links to other resources	to resource URI	to resource Type

RESTful API Data Model Reference For Moonshot Chassis Manager

Abstract

Copyright and Acknowledgements

Acknowledgments

Prerequisites and Audience

First Things

Key Benefits of the RESTful API

Requirements for using the RESTful API

How to Use This Document

Resource Map

Data Model Type Reference

"AccountService" Resource Type

Resource Instances

"Oem/Hp/AuthFailureLoggingThreshold"

HTTP Operations

"Oem/Hp/MinPasswordLength"

HTTP Operations

PATCH Example

"CartridgeLinkEntry" Resource Type

Resource Instances

"Architecture"

HTTP Operations

"CartridgeLinks[]/Architecture"

HTTP Operations

"CartridgeLinks[]/LinkEnabled"

HTTP Operations

"CartridgeLinks[]/Speed"

HTTP Operations

"CartridgeLinks[]/Via"

HTTP Operations

"LinkEnabled"

HTTP Operations

"LinkFrom"

HTTP Operations

"LinkTo"

HTTP Operations

"Speed"

HTTP Operations

"Via"

HTTP Operations

"Chassis" Resource Type

Resource Instances

"AssetTag"

HTTP Operations

PATCH Example

"ChassisType"

HTTP Operations

"IndicatorLED"

HTTP Operations

PATCH Example

"Manufacturer"

HTTP Operations

"Model"

HTTP Operations

"Oem/Hp/AutoPowerOn"

HTTP Operations

PATCH Example

"Oem/Hp/BaseFru[]/MfgDateTime"

HTTP Operations

"Oem/Hp/BaseFru[]/ProductName"

HTTP Operations

"Oem/Hp/BaseFru[]/SparePartNumber"

HTTP Operations

"Oem/Hp/BayNumber"

HTTP Operations

"Oem/Hp/ChassisManager[]/IP"

HTTP Operations

"Oem/Hp/ChassisManager[]/MAC"

HTTP Operations

"Oem/Hp/ChassisManager[]/SubnetMask"

HTTP Operations

"Oem/Hp/CliVersion"

HTTP Operations

"Oem/Hp/Firmware/ChassisFirmware/Current/VersionString"

HTTP Operations

"Oem/Hp/Firmware/ChassisFirmwareFrontDisplayPLD/Current/VersionString"

HTTP Operations

"Oem/Hp/Firmware/ChassisFirmwarePLD/Current/VersionString"

HTTP Operations

"Oem/Hp/Firmware/ChassisManagementFirmware/Current/VersionString"