RESTful API Data Model Reference For Moonshot Chassis Manager

Abstract

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

HPE Part Number: 802725-003

Published: July 2016

Edition: 1

Copyright and Acknowledgements

© Copyright 2016 Hewlett Packard Enterprise Development LP

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.

Java and Oracle are registered trademarks of Oracle and/or its affiliates.

UNIX® is a registered trademark of The Open Group.

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

This document has three main sections. 

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.

 
/rest/v1 ServiceRoot HTTP Allow: GET
Links to other resources to resource URI to resource Type

/rest/v1/AccountService AccountService HTTP Allow: GET, PATCH
Links to other resources to resource URI to resource Type

/rest/v1/AccountService/Accounts Collection HTTP Allow: GET, POST
Links to other resources to resource URI to resource Type

/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

/rest/v1/Chassis/{item} Chassis HTTP Allow: GET, PATCH, POST
Links to other resources to resource URI to resource Type

HpMoonshotCartridgeLinkService HTTP Allow: GET, POST
Links to other resources to resource URI to resource Type

/rest/v1/Chassis/{item}/CartridgeLinks/Entries Collection HTTP Allow: GET, POST
Links to other resources to resource URI to resource Type

/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

/rest/v1/Chassis/{item}/Cartridges/{item} HpMoonshotCartridge HTTP Allow: GET, PATCH, POST
Links to other resources to resource URI to resource Type

/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

/rest/v1/Chassis/{item}/Switches/{item} HpMoonshotSwitch HTTP Allow: GET, PATCH, POST
Links to other resources to resource URI to resource Type

/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

/rest/v1/DirectoryService/Groups Collection HTTP Allow: GET, POST
Links to other resources to resource URI to resource Type

/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

/rest/v1/Managers/{item} Manager HTTP Allow: GET, POST
Links to other resources to resource URI to resource Type

/rest/v1/Managers/{item}/DateTime HpiLODateTime HTTP Allow: GET, PATCH
Links to other resources to resource URI to resource Type

/rest/v1/Managers/{item}/LicenseService Collection HTTP Allow: GET, POST
Links to other resources to resource URI to resource Type

/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

/rest/v1/Managers/{item}/NICs/{item} EthernetNetworkInterface HTTP Allow: GET, PATCH
Links to other resources to resource URI to resource Type

/rest/v1/Managers/{item}/NetworkService ManagerNetworkService HTTP Allow: GET, PATCH, POST
Links to other resources to resource URI to resource Type

/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

/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

/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

/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

/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

/rest/v1/Systems/{item} ComputerSystem HTTP Allow: GET, PATCH, POST
Links to other resources to resource URI to resource Type

/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

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

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

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

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

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

"Oem/Hp/BaseFru[]/MfgDateTime"

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

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

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

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

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.

"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

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

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

"BayNumber"

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

This property is a member of ChassisSummary

JSON type:
String

HTTP Operations

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

"Cartridges[]/AutoRev"

This property is a member of ChassisSummary

JSON type:
String

HTTP Operations

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

"Cartridges[]/CartridgeNodeCount"

This property is a member of ChassisSummary

JSON type:
Integer from 0 to 8.

HTTP Operations

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, ...]}

The property "Cartridges[]/Power" 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.

"Cartridges[]/Presence"

This property is a member of ChassisSummary

JSON type:
String

HTTP Operations

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

"Cartridges[]/ProcessorFamily"

This property is a member of ChassisSummary

JSON type:
String

HTTP Operations

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

"Cartridges[]/SKU"

This property is a member of ChassisSummary

JSON type:
String

HTTP Operations

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

"Cartridges[]/SerialNumber"

This property is a member of ChassisSummary

JSON type:
String

HTTP Operations

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

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

"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

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.

"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

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.

"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

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.

"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

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.

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

The property "Switches[]/Power" 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.

"Switches[]/Presence"

This property is a member of ChassisSummary

JSON type:
String

HTTP Operations

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

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

This property is a member of ChassisSummary

JSON type:
String

HTTP Operations

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

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

"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

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.

"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

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

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

"Bios/Current/Date"

This property is a member of ComputerSystem

JSON type:
String

HTTP Operations

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

"Bios/Current/Family"

This property is a member of ComputerSystem

JSON type:
String

HTTP Operations

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

"Bios/Current/VersionString"

This property is a member of ComputerSystem

JSON type:
String

HTTP Operations

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

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.

"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

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.

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

The property "Oem/Hp/Options/CPU/HyperThreading" 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/CPUOptions[]/DefaultValue"

This property is a member of ComputerSystem

Defines the allowable values for this property on this resource.

JSON type:
String

HTTP Operations

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

"Oem/Hp/Options/CPUOptions[]/OptionName"

This property is a member of ComputerSystem

Defines the property name for which the following allowable values apply.

JSON type:
String

HTTP Operations

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

"Oem/Hp/Options/WOL"

This property is a member of ComputerSystem

Wake On LAN

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

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

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

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

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

The property "Oem/Hp/LDAPDirectoryAuthenticationEnabled" 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/LocalLoginEnabled"

This property is a member of DirectoryService

Flag that indicates whether local accounts are enabled.

JSON type:
Boolean ('true' or 'false')

HTTP Operations

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

"Oem/Hp/TestResults/TestInformation[]/TestName"

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/TestResults/TestInformation[]/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/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

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}

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

"FQDN"

This property is a member of EthernetNetworkInterface

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

JSON type:
String

HTTP Operations

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

"FactoryMacAddress"

This property is a member of EthernetNetworkInterface

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

JSON type:
String

HTTP Operations

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

"FullDuplex"

This property is a member of EthernetNetworkInterface

Connection duplex status. If Autosense is enabled, this property cannot be modified. 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:

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

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.

"HpHttpsCert" Resource Type

Resource Instances

See Resource Map for more details.

This is the schema definition for the X509 Certificate.

"HpHttpsCert" defines the following properties:

"CertificateSigningRequest"

This property is a member of HpHttpsCert

GenerateCSR action, wait few minutes (upto 10), perform GET operation, fills CSR. Contains a public and private key pair.

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.

"X509CertificateInformation/Issuer"

This property is a member of HpHttpsCert

The Certificate Authority that issued the certificate.

JSON type:
String

HTTP Operations

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

"X509CertificateInformation/SerialNumber"

This property is a member of HpHttpsCert

The serial number that the Certificate Authority assigned to the certificate.

JSON type:
String

HTTP Operations

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

"X509CertificateInformation/Subject"

This property is a member of HpHttpsCert

The entity to which the certificate was issued.

JSON type:
String

HTTP Operations

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

"X509CertificateInformation/ValidNotAfter"

This property is a member of HpHttpsCert

The date on which the certificate validity period ends.

JSON type:
String

HTTP Operations

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

"X509CertificateInformation/ValidNotBefore"

This property is a member of HpHttpsCert

The date on which the certificate validity period begins.

JSON type:
String

HTTP Operations

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

POST Action "GenerateCSR"

Parameter "Country"

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

"<string>"

Parameter "State"

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

"<string>"

Parameter "City"

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

"<string>"

Parameter "OrgName"

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

"<string>"

Parameter "EmailAddress"

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

"<string>"

Parameter "OrgUnit"

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

"<string>"

Parameter "CommonName"

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

"<string>"

Example

HTTP POST to resource with request JSON:

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

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

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.

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

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

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.

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

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.

POST Action "ClearLog"

Example

HTTP POST to resource with request JSON:

{ "Action": "ClearLog"}

POST Action "MarkRepaired"

Parameter "RecordId"

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

An array of integer values

Example

HTTP POST to resource with request JSON:

{ "Action": "MarkRepaired", "RecordId": [<"integer">]}

POST Action "AddMaintenanceNote"

Parameter "Message"

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

"<string>"

Example

HTTP POST to resource with request JSON:

{ "Action": "AddMaintenanceNote", "Message": "<string>"}

"HpMoonshotSwitch" Resource Type

Resource Instances

See Resource Map for more details.

"HpMoonshotSwitch" defines the following properties:

"BayNumber"

This property is a member of HpMoonshotSwitch

JSON type:
Integer greater than or equal to 0.

HTTP Operations

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

"Dimensions/DepthInMm"

This property is a member of HpMoonshotSwitch

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 HpMoonshotSwitch

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 HpMoonshotSwitch

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 HpMoonshotSwitch

JSON type:
Integer greater than or equal to 0.

HTTP Operations

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

"FirmwareRevisions/SwitchData/Current/VersionString"

This property is a member of HpMoonshotSwitch

JSON type:
String

HTTP Operations

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

"FirmwareRevisions/SwitchFirmware/Current/VersionString"

This property is a member of HpMoonshotSwitch

JSON type:
String

HTTP Operations

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

"FirmwareRevisions/SwitchProgrammableLogicDevice/Current/VersionString"

This property is a member of HpMoonshotSwitch

JSON type:
String

HTTP Operations

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

"FirmwareRevisions/SwitchSatelliteFirmware/Current/VersionString"

This property is a member of HpMoonshotSwitch

JSON type:
String

HTTP Operations

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

"FirmwareRevisions/SwitchSystemROMFirmware/Current/VersionString"

This property is a member of HpMoonshotSwitch

JSON type:
String

HTTP Operations

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

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

"RemoteManagementInterface/IPv4"

This property is a member of HpMoonshotSwitch

JSON type:
String

HTTP Operations

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

"RemoteManagementInterface/IPv6"

This property is a member of HpMoonshotSwitch

JSON type:
String

HTTP Operations

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

"RemoteManagementInterface/MAC"

This property is a member of HpMoonshotSwitch

JSON type:
String

HTTP Operations

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

"SKU"

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:

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

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

"SerialNumber"

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

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.

"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

See Resource Map for more details.

"HpSecurityService" defines the following properties:

"HpiLODateTime" Resource Type

Resource Instances

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

The property "TimeZone/Index" 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/Value"

This property is a member of HpiLODateTime

The environment variable value.

JSON type:
String

HTTP Operations

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

"TimeZoneList[]/Index"

This property is a member of HpiLODateTime

The time zone index.

JSON type:
Integer

HTTP Operations

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

"TimeZoneList[]/Value"

This property is a member of HpiLODateTime

The environment variable value.

JSON type:
String

HTTP Operations

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

"UpdateDateTime"

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.
PATCH This property may be 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

See Resource Map for more details.

"HpiLOLicense" defines the following properties:

"License"

This property is a member of HpiLOLicense

The name of the license installed on this management processor.

JSON type:
String

HTTP Operations

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

"LicenseExpire"

This property is a member of HpiLOLicense

The expiration information of the installed management processor license.

JSON type:
String

HTTP Operations

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

"LicenseKey"

This property is a member of HpiLOLicense

The license key installed on this management processor. License keys are 25 characters in length and contain both letters and numbers.

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:

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

See Resource Map for more details.

This is the schema definition for a manager. Examples of managers are BMCs, Enclosure Managers, Management Controllers and other subsystems assigned manageability functions.

"Manager" defines the following properties:

"Firmware/Current/BuildNumber"

This property is a member of Manager

Build or pass number of the installed firmware

JSON type:
Integer greater than or equal to 0.

HTTP Operations

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

"Firmware/Current/BuildNumberString"

This property is a member of Manager

Build or pass number, in string format, of the installed firmware

JSON type:
String

HTTP Operations

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

"Firmware/Current/Date"

This property is a member of Manager

Date when the firmware was built

JSON type:
String

HTTP Operations

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

"Firmware/Current/DebugBuild"

This property is a member of Manager

Indicates whether this is a debug build.

JSON type:
Boolean ('true' or 'false')

HTTP Operations

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

"Firmware/Current/MajorVersion"

This property is a member of Manager

Major version of the installed firmware

JSON type:
Integer greater than or equal to 0.

HTTP Operations

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

"Firmware/Current/MinorVersion"

This property is a member of Manager

Minor version of the installed firmware

JSON type:
Integer greater than or equal to 0.

HTTP Operations

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

"Firmware/Current/Time"

This property is a member of Manager

Time when the firmware was built

JSON type:
String

HTTP Operations

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

"Firmware/Current/VersionString"

This property is a member of Manager

Version and date of the installed firmware

JSON type:
String

HTTP Operations

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

"Model"

This property is a member of Manager

Model name of the manager.

JSON type:
String

HTTP Operations

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

"Oem/Hp/Firmware/Backup/BuildNumber"

This property is a member of Manager

The build number of the firmware.

JSON type:
Integer greater than or equal to 0.

HTTP Operations

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

"Oem/Hp/Firmware/Backup/BuildNumberString"

This property is a member of Manager

The string version of the build number of the firmware.

JSON type:
String

HTTP Operations

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

"Oem/Hp/Firmware/Backup/Date"

This property is a member of Manager

The build date of the firmware.

JSON type:
String

HTTP Operations

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

"Oem/Hp/Firmware/Backup/DebugBuild"

This property is a member of Manager

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

JSON type:
Boolean ('true' or 'false')

HTTP Operations

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

"Oem/Hp/Firmware/Backup/Family"

This property is a member of Manager

The family of the firmware.

JSON type:
String

HTTP Operations

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

"Oem/Hp/Firmware/Backup/MajorVersion"

This property is a member of Manager

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/Firmware/Backup/MinorVersion"

This property is a member of Manager

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/Firmware/Backup/Time"

This property is a member of Manager

The build time of the firmware.

JSON type:
String

HTTP Operations

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

"Oem/Hp/Firmware/Backup/VersionString"

This property is a member of Manager

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

JSON type:
String

HTTP Operations

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

"Oem/Hp/Firmware/Bootblock/BuildNumber"

This property is a member of Manager

The build number of the firmware.

JSON type:
Integer greater than or equal to 0.

HTTP Operations

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

"Oem/Hp/Firmware/Bootblock/BuildNumberString"

This property is a member of Manager

The string version of the build number of the firmware.

JSON type:
String

HTTP Operations

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

"Oem/Hp/Firmware/Bootblock/Date"

This property is a member of Manager

The build date of the firmware.

JSON type:
String

HTTP Operations

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

"Oem/Hp/Firmware/Bootblock/DebugBuild"

This property is a member of Manager

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

JSON type:
Boolean ('true' or 'false')

HTTP Operations

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

"Oem/Hp/Firmware/Bootblock/Family"

This property is a member of Manager

The family of the firmware.

JSON type:
String

HTTP Operations

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

"Oem/Hp/Firmware/Bootblock/MajorVersion"

This property is a member of Manager

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/Firmware/Bootblock/MinorVersion"

This property is a member of Manager

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/Firmware/Bootblock/Time"

This property is a member of Manager

The build time of the firmware.

JSON type:
String

HTTP Operations

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

"Oem/Hp/Firmware/Bootblock/VersionString"

This property is a member of Manager

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

JSON type:
String

HTTP Operations

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

"Oem/Hp/Firmware/Current/BuildNumber"

This property is a member of Manager

The build number of the firmware.

JSON type:
Integer greater than or equal to 0.

HTTP Operations

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

"Oem/Hp/Firmware/Current/BuildNumberString"

This property is a member of Manager

The string version of the build number of the firmware.

JSON type:
String

HTTP Operations

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

"Oem/Hp/Firmware/Current/Date"

This property is a member of Manager

The build date of the firmware.

JSON type:
String

HTTP Operations

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

"Oem/Hp/Firmware/Current/DebugBuild"

This property is a member of Manager

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

JSON type:
Boolean ('true' or 'false')

HTTP Operations

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

"Oem/Hp/Firmware/Current/Family"

This property is a member of Manager

The family of the firmware.

JSON type:
String

HTTP Operations

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

"Oem/Hp/Firmware/Current/MajorVersion"

This property is a member of Manager

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/Firmware/Current/MinorVersion"

This property is a member of Manager

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/Firmware/Current/Time"

This property is a member of Manager

The build time of the firmware.

JSON type:
String

HTTP Operations

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

"Oem/Hp/Firmware/Current/VersionString"

This property is a member of Manager

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

JSON type:
String

HTTP Operations

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

"Oem/Hp/Firmware/Pending/BuildNumber"

This property is a member of Manager

The build number of the firmware.

JSON type:
Integer greater than or equal to 0.

HTTP Operations

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

"Oem/Hp/Firmware/Pending/BuildNumberString"

This property is a member of Manager

The string version of the build number of the firmware.

JSON type:
String

HTTP Operations

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

"Oem/Hp/Firmware/Pending/Date"

This property is a member of Manager

The build date of the firmware.

JSON type:
String

HTTP Operations

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

"Oem/Hp/Firmware/Pending/DebugBuild"

This property is a member of Manager

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

JSON type:
Boolean ('true' or 'false')

HTTP Operations

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

"Oem/Hp/Firmware/Pending/Family"

This property is a member of Manager

The family of the firmware.

JSON type:
String

HTTP Operations

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

"Oem/Hp/Firmware/Pending/MajorVersion"

This property is a member of Manager

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/Firmware/Pending/MinorVersion"

This property is a member of Manager

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/Firmware/Pending/Time"

This property is a member of Manager

The build time of the firmware.

JSON type:
String

HTTP Operations

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

"Oem/Hp/Firmware/Pending/VersionString"

This property is a member of Manager

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

JSON type:
String

HTTP Operations

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

"Oem/Hp/Firmware/definitions/HpFWVersion/BuildNumber"

This property is a member of Manager

The build number of the firmware.

JSON type:
Integer greater than or equal to 0.

HTTP Operations

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

"Oem/Hp/Firmware/definitions/HpFWVersion/BuildNumberString"

This property is a member of Manager

The string version of the build number of the firmware.

JSON type:
String

HTTP Operations

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

"Oem/Hp/Firmware/definitions/HpFWVersion/Date"

This property is a member of Manager

The build date of the firmware.

JSON type:
String

HTTP Operations

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

"Oem/Hp/Firmware/definitions/HpFWVersion/DebugBuild"

This property is a member of Manager

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

JSON type:
Boolean ('true' or 'false')

HTTP Operations

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

"Oem/Hp/Firmware/definitions/HpFWVersion/Family"

This property is a member of Manager

The family of the firmware.

JSON type:
String

HTTP Operations

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

"Oem/Hp/Firmware/definitions/HpFWVersion/MajorVersion"

This property is a member of Manager

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/Firmware/definitions/HpFWVersion/MinorVersion"

This property is a member of Manager

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/Firmware/definitions/HpFWVersion/Time"

This property is a member of Manager

The build time of the firmware.

JSON type:
String

HTTP Operations

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

"Oem/Hp/Firmware/definitions/HpFWVersion/VersionString"

This property is a member of Manager

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

JSON type:
String

HTTP Operations

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

"Oem/Hp/License/LicenseKey"

This property is a member of Manager

The installed license key.

JSON type:
String

HTTP Operations

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

"Oem/Hp/License/LicenseString"

This property is a member of Manager

Describes the type of license installed on management processor.

JSON type:
String

HTTP Operations

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

"Oem/Hp/License/LicenseType"

This property is a member of Manager

Indicates whether the license is Perpetual or Evaluation.

JSON type:
String

HTTP Operations

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

"UUID"

This property is a member of Manager

This is a universally unique identifier that software (for example, HP SIM) uses to uniquely identify this manager. The UUID is assigned when the system is manufactured.

JSON type:
String

HTTP Operations

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

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

See Resource Map for more details.

"ManagerAccount" defines the following properties:

"Oem/Hp/LoginName"

This property is a member of ManagerAccount

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

The property "Oem/Hp/Privileges/iLOConfigPriv" 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/SSHPublicKey"

This property is a member of ManagerAccount

Indicates whether this user has an SSH Public Key.

JSON type:
Boolean ('true' or 'false')

HTTP Operations

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

"Oem/Hp/SSHPublicKeyHash"

This property is a member of ManagerAccount

Value of SSH Public Key Hash (Fingerprint).

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

This property is a member of ManagerAccount

Indicates whether this user 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": {"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

See Resource Map for more details.

"ManagerGroup" defines the following properties:

"Oem/Hp/GroupName"

This property is a member of ManagerGroup

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

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

See Resource Map for more details.

This resource is used to obtain or modify the network services managed by this manager.

"ManagerNetworkService" defines the following properties:

"FQDN"

This property is a member of ManagerNetworkService

The fully-qualified domain name of the manager that is obtained by DNS and includes the host name and top-level domain name.

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.

"HTTP/Enabled"

This property is a member of ManagerNetworkService

Indicates whether HTTP 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.

"HTTP/Port"

This property is a member of ManagerNetworkService

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

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

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.

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

See Resource Map for more details.

"ManagerRepositoryService" defines the following properties:

"Oem/Hp/Details"

This property is a member of ManagerRepositoryService

see 1.51

JSON type:
String

HTTP Operations

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

"Oem/Hp/ImageType"

This property is a member of ManagerRepositoryService

see 1.51

JSON type:
String

HTTP Operations

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

"Oem/Hp/State"

This property is a member of ManagerRepositoryService

see 1.51

JSON type:
String

HTTP Operations

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

POST Action "RepositoryAddFromURI"

Parameter "FirmwareURI"

"FirmwareURI" 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": "RepositoryAddFromURI", "FirmwareURI": "", "Target": "/Oem/Hp"}

POST Action "RemoveFromRepository"

Parameter "FirmwareFileName"

"FirmwareFileName" 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": "RemoveFromRepository", "FirmwareFileName": "", "Target": "/Oem/Hp"}

POST Action "ScriptAddFromURI"

Parameter "ScriptURI"

"ScriptURI" 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": "ScriptAddFromURI", "ScriptURI": "", "Target": "/Oem/Hp"}

POST Action "RemoveScriptFromRepository"

Parameter "ScriptFileName"

"ScriptFileName" 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": "RemoveScriptFromRepository", "ScriptFileName": "", "Target": "/Oem/Hp"}

"ManagerSerial" Resource Type

Resource Instances

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

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

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

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

"Oem/Hp/WattageHistoryLevel[]/Counter"

This property is a member of MoonshotPowerMetrics

The reset type to be performed.

JSON type:
Integer

HTTP Operations

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

"Oem/Hp/WattageHistoryLevel[]/Cumulator"

This property is a member of MoonshotPowerMetrics

The reset type to be performed.

JSON type:
Integer

HTTP Operations

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

"Oem/Hp/WattageHistoryLevel[]/SampleType"

This property is a member of MoonshotPowerMetrics

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.

"Oem/Hp/WattageHistoryLevel[]/Samples[]/Wattage"

This property is a member of MoonshotPowerMetrics

The reset type to be performed.

JSON type:
String

HTTP Operations

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

"Oem/Hp/WattageHistoryLevel[]/Samples[]/WattageInt"

This property is a member of MoonshotPowerMetrics

The reset type to be performed.

JSON type:
Integer

HTTP Operations

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

"PowerAllocatedWatts"

This property is a member of MoonshotPowerMetrics

This is the total power allocated to the chassis, 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.

"PowerAvailableWatts"

This property is a member of MoonshotPowerMetrics

Amount of power not already budgeted and therefore available for additional allocation, in watts. (powerCapacity - powerAllocated). This indicates how much reserve power capacity is left.

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.

"PowerCapacityWatts"

This property is a member of MoonshotPowerMetrics

This is the total power available to the chassis from all power supplies (adjusting for redundancy settings), 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.

"PowerConsumedWatts"

This property is a member of MoonshotPowerMetrics

The latest observed power being drawn by this chassis, in Watts. The update interval may vary depending upon implementation but is usually measured in seconds.

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.

"PowerLimit/CorrectionInMs"

This property is a member of MoonshotPowerMetrics

Time in milliseconds that it takes for the limiting process to react and correct the power consumption below the limit.

JSON type:
Integer

HTTP Operations

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

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

The property "PowerLimit/LimitInWatts" 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.

"PowerMetrics/AverageConsumedWatts"

This property is a member of MoonshotPowerMetrics

Average power consumed during the interval specified by 'IntervalInMin'.

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.

"PowerMetrics/IntervalInMin"

This property is a member of MoonshotPowerMetrics

The interval between power metric evaluation in minutes.

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.

"PowerMetrics/MaxConsumedWatts"

This property is a member of MoonshotPowerMetrics

Maximum power consumed during the interval specified by 'IntervalInMin'.

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.

"PowerMetrics/MinConsumedWatts"

This property is a member of MoonshotPowerMetrics

Minimum power consumed during the interval specified by 'IntervalInMin'.

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.

"PowerRequestedWatts"

This property is a member of MoonshotPowerMetrics

Potential power that the chassis is requesting, in Watts, which may be higher than the current level being consumed since requested power includes budget that the chassis has reserved for future use.

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

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.

"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

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.

"SecurityBanner" Resource Type

Resource Instances

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

See Resource Map for more details.

This object represents the HP RESTful API root service.

"ServiceRoot" defines the following properties:

"Oem/Hp/Manager[]/Blade/BayNumber"

This property is a member of ServiceRoot

Specifies the location of the blade in the enclosure.

JSON type:
String

HTTP Operations

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

"Oem/Hp/Manager[]/Blade/EnclosureName"

This property is a member of ServiceRoot

Specifies the name of the enclosure in which the blade is present.

JSON type:
String

HTTP Operations

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

"Oem/Hp/Manager[]/Blade/RackName"

This property is a member of ServiceRoot

Specifies the name of the rack in which the enclosure is present.

JSON type:
String

HTTP Operations

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

"Oem/Hp/Manager[]/DefaultLanguage"

This property is a member of ServiceRoot

Default language used for the Web interface.

JSON type:
String

HTTP Operations

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

"Oem/Hp/Manager[]/FQDN"

This property is a member of ServiceRoot

Fully qualified domain name of the management processor.

JSON type:
String

HTTP Operations

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

"Oem/Hp/Manager[]/HostName"

This property is a member of ServiceRoot

The name of management processor.

JSON type:
String

HTTP Operations

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

"Oem/Hp/Manager[]/Languages[]/Language"

This property is a member of ServiceRoot

Specifies one of the languages supported by the management processor.

JSON type:
String

HTTP Operations

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

"Oem/Hp/Manager[]/Languages[]/TranslationName"

This property is a member of ServiceRoot

Specifies one of the languages supported by the management processor.

JSON type:
String

HTTP Operations

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

"Oem/Hp/Manager[]/Languages[]/Version"

This property is a member of ServiceRoot

Specifies the version of the management processor in the respective language.

JSON type:
String

HTTP Operations

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

"Oem/Hp/Manager[]/ManagerFirmwareVersion"

This property is a member of ServiceRoot

The major and minor management processor version numbers.

JSON type:
String

HTTP Operations

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

"Oem/Hp/Manager[]/ManagerFirmwareVersionPass"

This property is a member of ServiceRoot

The build or pass number of the management processor version.

JSON type:
String

HTTP Operations

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

"Oem/Hp/Manager[]/ManagerType"

This property is a member of ServiceRoot

The type of the service manager.

JSON type:
String

HTTP Operations

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

"Oem/Hp/Sessions/CertCommonName"

This property is a member of ServiceRoot

The name of the management processor as it appears in the digital certificate when a secure web GUI session is established to the management processor.

JSON type:
String

HTTP Operations

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

"Oem/Hp/Sessions/KerberosEnabled"

This property is a member of ServiceRoot

Specifies whether Kerberos login is enabled.

JSON type:
Boolean ('true' or 'false')

HTTP Operations

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

"Oem/Hp/Sessions/LDAPAuthLicenced"

This property is a member of ServiceRoot

Specifies whether a valid license is installed for LDAP use.

JSON type:
Boolean ('true' or 'false')

HTTP Operations

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

"Oem/Hp/Sessions/LDAPEnabled"

This property is a member of ServiceRoot

Specifies whether LDAP login is enabled.

JSON type:
Boolean ('true' or 'false')

HTTP Operations

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

"Oem/Hp/Sessions/LocalLoginEnabled"

This property is a member of ServiceRoot

Specifies whether local users can log in.

JSON type:
Boolean ('true' or 'false')

HTTP Operations

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

"Oem/Hp/Sessions/LoginFailureDelay"

This property is a member of ServiceRoot

The delay (seconds) when a management processor login attempt has failed.

JSON type:
Integer greater than or equal to 0.

HTTP Operations

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

"Oem/Hp/Sessions/LoginHint/Hint"

This property is a member of ServiceRoot

The information on how to log in to the management processor.

JSON type:
String

HTTP Operations

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

"Oem/Hp/Sessions/LoginHint/HintPOSTData/Password"

This property is a member of ServiceRoot

The password for logging in to the management processor.

JSON type:
String

HTTP Operations

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

"Oem/Hp/Sessions/LoginHint/HintPOSTData/UserName"

This property is a member of ServiceRoot

The user name for logging in to the management processor.

JSON type:
String

HTTP Operations

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

"Oem/Hp/Sessions/SecurityMessage"

This property is a member of ServiceRoot

The login security banner message that is displayed on the management processor Login page.

JSON type:
String

HTTP Operations

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

"Oem/Hp/Sessions/SecurityOverride"

This property is a member of ServiceRoot

Specifies whether the security override switch is enabled.

JSON type:
Boolean ('true' or 'false')

HTTP Operations

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

"Oem/Hp/Sessions/ServerName"

This property is a member of ServiceRoot

The name of the server that this management processor is managing.

JSON type:
String

HTTP Operations

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

"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

See Resource Map for more details.

"Session" defines the following properties:

"Oem/Hp/AccessTime"

This property is a member of Session

User session last-access time

JSON type:
String

HTTP Operations

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

"Oem/Hp/LoginTime"

This property is a member of Session

User session login time

JSON type:
String

HTTP Operations

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

"Oem/Hp/MySession"

This property is a member of Session

Indicates whether this is a session I own.

JSON type:
Boolean ('true' or 'false')

HTTP Operations

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

"Oem/Hp/Privileges/CartridgeAccessPriv"

This property is a member of Session

This access privilege enables a user to see and modify cartridge(s).

JSON type:
String

HTTP Operations

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

"Oem/Hp/Privileges/ChassisAccessPriv"

This property is a member of Session

This access privilege enables a user to change Moonshot Chassis settings.

JSON type:
Boolean ('true' or 'false')

HTTP Operations

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

"Oem/Hp/Privileges/LoginPriv"

This property is a member of Session

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

JSON type:
Boolean ('true' or 'false')

HTTP Operations

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

"Oem/Hp/Privileges/RemoteConsolePriv"

This property is a member of Session

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.

"Oem/Hp/Privileges/SwitchAccessPriv"

This property is a member of Session

This access privilege enables a user to see and modify cartridge(s).

JSON type:
String

HTTP Operations

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

"Oem/Hp/Privileges/UserConfigPriv"

This property is a member of Session

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.

"Oem/Hp/Privileges/VirtualMediaPriv"

This property is a member of Session

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.

"Oem/Hp/Privileges/VirtualPowerAndResetPriv"

This property is a member of Session

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.

"Oem/Hp/Privileges/iLOConfigPriv"

This property is a member of Session

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.

"Oem/Hp/UserAccount"

This property is a member of Session

Login details of the user

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.

"SnmpService" Resource Type

Resource Instances

See Resource Map for more details.

"SnmpService" defines the following properties:

"AlertCommunityString"

This property is a member of SnmpService

The string of up to 216 characters that describes the alert community string.

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:

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

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

"AlertsEnabled"

This property is a member of SnmpService

The alert conditions that the management processor detects independently of the host operating system can be sent to specified SNMP alert destinations, such as HP SIM.

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:

{"AlertsEnabled": true}

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

"Contact"

This property is a member of SnmpService

The string of up to 49 characters that specifies the system administrator or server owner. The string can include a name, email address, or phone number.

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:

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

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

"Location"

This property is a member of SnmpService

The string of up to 49 characters that specifies the physical location of the server.

JSON type:
String

HTTP Operations

GET Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.
PATCH This property may be 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

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

OK

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

See Resource Map for more details.

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

"ThermalMetrics" defines the following properties:

"Fans[]/CorrelatableID"

This property is a member of ThermalMetrics

The CorrelatableID for this fan.

JSON type:
String

HTTP Operations

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

"Fans[]/CurrentReading"

This property is a member of ThermalMetrics

The current speed of the fan.

JSON type:
Integer greater than or equal to 0.

HTTP Operations

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

"Fans[]/FanName"

This property is a member of ThermalMetrics

The name of the fan sensor.

JSON type:
String

HTTP Operations

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

"Fans[]/LowerThresholdCritical"

This property is a member of 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.

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

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

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

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

"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

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.

"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

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.

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

Message Reference

This section documents the MessageID values that may be returned in ExtendedError responses to HTTP operations.

 

Base.AccessDenied

While attempting to access, connect to, or transfer to/from another resource, the service was denied access.

Severity: Critical

Resolution: Verify that the URI is correct and that the service has the appropriate credentials.

Base.AccountForSessionNoLongerExists

The account for current session is removed and the current session is also removed.

Severity: OK

Resolution: Attempt to connect using a valid account.

Base.AccountModified

The account was modified successfully.

Severity: OK

Resolution: None.

Base.AccountNotModified

The request was unable to modify the account.

Severity: Warning

Resolution: If the operation did not complete, check the authorization or the request body for issues and resubmit the request.

Base.AccountRemoved

The account was removed successfully.

Severity: OK

Resolution: None.

Base.ActionNotSupported

The action supplied in the POST operation is not supported by the resource.

Severity: Critical

Resolution: The action was invalid or the wrong resource was the target. See the implementation documentation for assistance.

Base.ActionParameterDuplicate

The action was submitted with a duplicate parameter in the request body.

Severity: Warning

Resolution: Resubmit the action with only one instance of the parameter in the request body.

Base.ActionParameterMissing

The requested action is missing a parameter that is required to process the action.

Severity: Critical

Resolution: Resubmit the action with the required parameter in the request body.

Base.ActionParameterNotSupported

The action parameter is not supported on the target resource.

Severity: Warning

Resolution: If the operation did not complete, remove the parameter and resubmit the request.

Base.ActionParameterUnknown

An action was submitted, but a supplied parameter did not match any of the known parameters.

Severity: Warning

Resolution: If the operation did not complete, correct the invalid parameter and resubmit the request.

Base.ActionParameterValueFormatError

The value type is correct, but the format is not supported or the size/length is exceeded

Severity: Warning

Resolution: If the operation did not complete, correct the parameter value in the request body and resubmit the request.

Base.ActionParameterValueTypeError

The parameter contains an incorrect value type. For example, a number value for a string parameter type.

Severity: Warning

Resolution: If the operation did not complete, correct the parameter value in the request body and resubmit the request.

Base.CouldNotEstablishConnection

An attempt to access the resource, image, or file at the URI was unsuccessful because a session could not be established.

Severity: Critical

Resolution: Verify that the URI contains a valid and reachable node name, protocol information, and other URI components.

Base.CreateFailedMissingReqProperties

A create operation was attempted on a resource, but a required property was missing from the request.

Severity: Critical

Resolution: If the operation did not complete, include the required property with a valid value in the request body and resubmit the request.

Base.CreateLimitReachedForResource

No more resources can be created.

Severity: Critical

Resolution: If the operation did not complete, delete resources and resubmit the request.

Base.Created

The resource has been created successfully.

Severity: OK

Resolution: None

Base.EventSubscriptionLimitExceeded

The event subscription establishment has been requested, but the operation did not complete because the number of simultaneous subscriptions exceeded the maximum number allowed by the implementation.

Severity: Critical

Resolution: Before attempting to establish the event subscription, reduce the number of subscriptions or increase the maximum number of simultaneous subscriptions allowed (if supported).

Base.GroupForSessionNoLongerExists

The group for current session is removed and the current session is also removed.

Severity: OK

Resolution: Attempt to connect using a valid group.

Base.GroupModified

The group was modified successfully.

Severity: OK

Resolution: None.

Base.GroupNotModified

The request was unable to modify the group.

Severity: Warning

Resolution: If the operation did not complete, check the authorization or the request body for issues and resubmit the request.

Base.GroupRemoved

The group was removed successfully.

Severity: OK

Resolution: None.

Base.InsufficientPrivilege

The account or credentials associated with the current session are not authorized to perform the requested operation.

Severity: Critical

Resolution: Retry the operation with an authorized account or credentials.

Base.InternalError

The request did not complete due to an unknown internal error, but the service is still operational.

Severity: Critical

Resolution: Resubmit the request. If the problem persists, consider resetting the service.

Base.InvalidObject

The object is not valid.

Severity: Critical

Resolution: If the operation did not complete, the object is malformed or the URI is incorrect. Make the appropriate corrections and resubmit the request.

Base.MalformedJSON

The request body contains malformed JSON.

Severity: Critical

Resolution: Verify that the request body is valid JSON and resubmit the request.

Base.NoValidSession

The operation did not complete because a valid session is required in order to access resources.

Severity: Critical

Resolution: Establish a session before attempting any operations.

Base.PropertyDuplicate

A duplicate property is in the request body.

Severity: Warning

Resolution: If the operation did not complete, remove the duplicate property from the request body and resubmit the request.

Base.PropertyMissing

The request does not include a required property.

Severity: Warning

Resolution: If the operation did not complete, verify the property is in the request body and has a valid value.

Base.PropertyNotWritable

The request included a value for a read-only property.

Severity: Warning

Resolution: If the operation did not complete, remove the property from the request body and resubmit the request.

Base.PropertyUnknown

An unknown property is in the request body.

Severity: Warning

Resolution: If the operation did not complete, remove the unknown property from the request body and resubmit the request.

Base.PropertyValueFormatError

The value type is correct, but the format is not supported or the size/length is exceeded.

Severity: Warning

Resolution: If the operation did not complete, correct the property value in the request body and resubmit the request.

Base.PropertyValueNotInList

The value type is correct, but the value is not supported.

Severity: Warning

Resolution: If the operation did not complete, choose a value from the enumeration list and resubmit your request.

Base.PropertyValueTypeError

The property value contains an incorrect property type. For example, a number value for a string property type.

Severity: Warning

Resolution: If the operation did not complete, correct the property value in the request body and resubmit the request.

Base.QueryNotSupported

The query is not supported by the implementation.

Severity: Warning

Resolution: If the operation did not complete, remove the query parameter and resubmit the request.

Base.QueryNotSupportedOnResource

The query is not supported on the resource. For example, a start/count query is attempted on a resource that is not a collection.

Severity: Warning

Resolution: If the operation did not complete, remove the query parameters and resubmit the request.

Base.QueryParameterOutOfRange

The query parameter value is out of range for the resource. For example, a page is requested that is outside the valid page range.

Severity: Warning

Resolution: Specify a query parameter value that is within range. For example, a page that is within the valid range of pages.

Base.QueryParameterValueFormatError

The value type is correct, but the format is not supported or the size/length was exceeded.

Severity: Warning

Resolution: If the operation did not complete, correct the value for the query parameter in the request body and resubmit the request.

Base.QueryParameterValueTypeError

The query parameter contains an incorrect value type. For example, a number supplied for a query parameter that requires a string.

Severity: Warning

Resolution: If the operation did not complete, correct the value for the query parameter in the request body and resubmit the request.

Base.ResourceAlreadyExists

The create resource operation did not complete because the resource already exists.

Severity: Critical

Resolution: Do not attempt the create operation because the resource already exists.

Base.ResourceAtUriInUnknownFormat

The URI is valid, but the resource or image at that URI is in a format that is not supported by the service.

Severity: Critical

Resolution: Place a resource, image, or file that is supported by the service at the URI.

Base.ResourceAtUriUnauthorized

An attempt to access the resource, image, or file at the URI is unauthorized.

Severity: Critical

Resolution: Verify that the appropriate access is provided for the service to access the URI.

Base.ResourceCannotBeDeleted

A delete operation was attempted on a resource that cannot be deleted.

Severity: Critical

Resolution: Do not attempt to delete a resource that does not support the REST API DELETE operation.

Base.ResourceInUse

The request to change the resource was rejected because the resource was in use or in transition.

Severity: Warning

Resolution: If the operation did not complete, wait until the resource is free and resubmit the request.

Base.ResourceMissingAtURI

The operation expected an image or resource at the provided URI, but found none.

Severity: Critical

Resolution: Place a valid resource at the URI or correct the URI and resubmit the request.

Base.ServiceInUnknownState

The operation did not complete because the service is in an unknown state and cannot take incoming requests.

Severity: Critical

Resolution: If the operation did not complete, restart the service and resubmit the request.

Base.ServiceShuttingDown

The operation did not complete because the service is shutting down.

Severity: Critical

Resolution: If the operation did not complete, resubmit the request when the service is available.

Base.ServiceTemporarilyUnavailable

The service is temporarily unavailable.

Severity: Critical

Resolution: Wait for the indicated retry duration and retry the operation.

Base.SessionLimitExceeded

Session establishment has been requested, but the operation did not complete because the number of simultaneous sessions exceeded the maximum number allowed by the implementation.

Severity: Critical

Resolution: Before attempting to establish the session, reduce the number of sessions or increase the maximum number of simultaneous sessions allowed (if supported).

Base.SourceDoesNotSupportProtocol

While attempting to access, connect to, or transfer from another location, the other end of the connection did not support the specified protocol.

Severity: Critical

Resolution: Change protocols or URIs.

Base.Success

The operation completed successfully.

Severity: OK

Resolution: None

Base.UnrecognizedRequestBody

The service detected a request body with malformed JSON.

Severity: Warning

Resolution: If the operation did not complete, correct the request body and resubmit the request.

HpCommon.ArrayPropertyOutOfBound

The items in the array exceed the maximum number supported.

Severity: Warning

Resolution: Retry the operation using the correct number of items for the array.

HpCommon.ConditionalSuccess

A property value was successfully changed but the change may be reverted upon system reset.

Severity: Warning

Resolution: Check the "SettingsResult" messages after the system has reset for errors referring to the corresponding property.

HpCommon.InternalErrorWithParam

The operation was not successful due to an internal service error (shown), but the service is still operational.

Severity: Critical

Resolution: Retry the operation. If the problem persists, consider resetting the service.

HpCommon.InvalidConfigurationSpecified

The specified configuration is not valid.

Severity: Warning

Resolution: Correct the configuration, and then retry the operation.

HpCommon.PropertyValueExceedsMaxLength

The value for the property exceeds the maximum length.

Severity: Warning

Resolution: Correct the value for the property in the request body, and then retry the operation.

HpCommon.PropertyValueIncompatible

The value for the property is the correct type, but this value is incompatible with the current value of another property.

Severity: Warning

Resolution: Correct the value for the property in the request body, and then retry the operation.

HpCommon.PropertyValueOutOfRange

The value for the property is out of range.

Severity: Warning

Resolution: Correct the value for the property in the request body, and then retry the operation.

HpCommon.ResetInProgress

A device or service reset is in progress.

Severity: Warning

Resolution: Wait for device or service reset to complete, and then retry the operation.

HpCommon.ResetRequired

One or more properties were changed, but these changes will not take effect until the device or service is reset.

Severity: Warning

Resolution: To enable the changed properties, reset the device or service.

HpCommon.ResourceNotReadyRetry

The resource is present but is not ready to perform operations due to an internal condition such as initialization or reset.

Severity: Warning

Resolution: Retry the operation when the resource is ready.

HpCommon.SuccessFeedback

The operation completed successfully

Severity: OK

Resolution: None

HpCommon.TaskCreated

A task was created in response to the operation.

Severity: OK

Resolution: Perform an HTTP GET request on the supplied URI for task status.

HpCommon.UnsupportedHwConfiguration

A previously requested property value change was reverted because the current hardware configuration does not support it.

Severity: Warning

Resolution: Ensure that the system's hardware configuration supports the property value.

iLO.AHSDisabled

Modifying AHS properties is not possible with AHS disabled.

Severity: Warning

Resolution: Enable AHS, and then modify the AHS properties.

iLO.Accepted

Indicates that one or more properties were correctly changed, but may not be in effect yet.

Severity: OK

Resolution: None

iLO.ActionParameterValueNotInList

Indicates that the correct value type was supplied for the action parameter, but the value is not supported. (The value is not in the enumeration list.)

Severity: Warning

Resolution: Choose a value from the enumeration list and resubmit the request if the operation failed.

iLO.AlertMailDisabled

Modifying AlertMail properties is not possible with AlertMail disabled.

Severity: Warning

Resolution: Enable AlertMail, and then modify the AlertMail properties.

iLO.AlertMailTestFailed

The AlertMail Test Alert did not send successfully.

Severity: Warning

Resolution: Verify the test alert content and retry.

iLO.ArrayPropertyOutOfBound

The number of items in the array exceeds the maximum number supported.

Severity: Warning

Resolution: Retry the operation using the correct number of items for the array.

iLO.CannotRemoveLicense

Cannot remove iLO Standard/iLO Standard for BladeSystem license.

Severity: Warning

Resolution: None.

iLO.DemoLicenseKeyPreviouslyInstalled

A demo license was previously installed.

Severity: Warning

Resolution: None.

iLO.DeviceResetRequired

Indicates that one or more properties were correctly changed, but will not take effect until device is reset.

Severity: Warning

Resolution: Reset the device for the settings to take effect.

iLO.DiagsTestAlreadyRunning

A diagnostics self test is already running.

Severity: Warning

Resolution: Stop the running test and try again.

iLO.ESKMServersNotConfigured

Enterprise Secure Key Manager Servers are not configured.

Severity: OK

Resolution: None.

iLO.ETagTooLong

The supplied ETag is too long. The maximum supported ETag length is 63 bytes.

Severity: Warning

Resolution: Retry the operation using an ETag with a length of 63 bytes or less.

iLO.EmptyDNSName

DNS name is empty.

Severity: Warning

Resolution: Retry the request with a valid DNS name.

iLO.ErrorIntializingESKM

Failed to initialize ESKM.

Severity: Warning

Resolution: Check if Account Group, Local CA Certificate Name, Login Name and Password are correct and try again.

iLO.EventLogCleared

Event log cleared successfully.

Severity: OK

Resolution: None.

iLO.EventSubscriptionModified

The event subscription was modified successfully.

Severity: OK

Resolution: None.

iLO.EventSubscriptionRemoved

The event subscription was removed successfully.

Severity: OK

Resolution: None.

iLO.FailedToComplete

The operation failed to complete successfully

Severity: Critical

Resolution: None

iLO.FirmwareFlashAlreadyInProgress

A firmware upgrade operation is already in progress.

Severity: Warning

Resolution: Wait for the current firmware flash to complete, and then retry the operation.

iLO.GeneratingCertificate

Generating the X509 Certificate.

Severity: OK

Resolution: None.

iLO.ICRUNotSupported

ICRU feature or function is not supported on the system.

Severity: Warning

Resolution: None.

iLO.IPv6ConfigurationError

The specified IPv6 configuration caused an error.

Severity: Warning

Resolution: Resolve the indicated error in the configuration data.

iLO.ImportCertificateFailed

Failed importing Certificate.

Severity: Warning

Resolution: Retry the operation with proper Certificate information.

iLO.ImportSSOParamError

Not a valid parameter.

Severity: Warning

Resolution: Retry the request with valid parameters.

iLO.ImportSSOUriError

Not a valid Uri to import SSO certificate.

Severity: Warning

Resolution: Retry the request with valid URI.

iLO.IndicatorLedInvalidStateChange

The request to change the state of the Indicator LED cannot be granted because the current state is either Blinking or is Unknown.

Severity: Warning

Resolution: Please wait until the server has completed its reserved state.

iLO.InternalErrorWithParam

The operation was not successful due to an internal service error (shown), but the service is still operational.

Severity: Critical

Resolution: Retry the operation. If the problem persists, consider resetting the service.

iLO.InvalidConfigurationSpecified

The specified configuration is not valid.

Severity: Warning

Resolution: Correct the configuration, and then retry the operation.

iLO.InvalidConfigurationSpecifiedForFederation

iLO Federation Management cannot be supported in the current configuration.

Severity: Warning

Resolution: Review the iLO network settings or Onboard Administrator settings and refer to the iLO User Guide.

iLO.InvalidEngineID

EngineID should be a hexadecimal number starting with 0x (for example, 0x0102030405abcdef). The string length should be an even number, greater than or equal to 6 characters (excluding the "0x"), and less than or equal to 32 characters.

Severity: Warning

Resolution: Retry the operation using an EngineID within the specified parameters.

iLO.InvalidIndex

The Index is not valid.

Severity: Warning

Resolution: Adhere to the indexes supported in the self links.

iLO.InvalidLicenseKey

The license key is not valid.

Severity: Warning