HP RESTful API Data Model Reference for Moonshot Chassis Manager Abstract This document is a reference to the types, properties, and attributes in the HP RESTFul API for iLO.
© Copyright 2014 Hewlett-Packard Development Company, L.P. Confidential computer software. Valid license from HP 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.
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 HP Servers Using the HP RESTful API." This other document is an introduction to using the HP RESTful API, while this document provides detail on individual properties and messages.
Examples of using PATCH and POST to set properties and perform actions 1. /rest/v1/Sessions a. POST Login { "Password": "", "UserName": "" } b. DELETE Session (Clear session) From the /rest/v1/Sessions URI select the href: for the session to be cleared. An example is href: /rest/v1/Sessions/administrator53d95db4c8098e1d. When the session is verified sending a DELETE request will clear the session. 2. /rest/v1/AccountService a.
"UserConfigPriv": true, "VirtualMediaPriv": true, "VirtualPowerAndResetPriv": true, "iLOConfigPriv": true } } } } Valid values for privileges are true and false. Each account has specific link with an integer (N). Perform a GET /rest/v1/AccountService/Accounts to get a list of valid accounts. b. POST AddSSHPublicKey { "Action": "AddSSHPublicKey", "KeyData": "", "Target": "/Oem/Hp" } This POST adds an SSH public key to account N.
{ "SNTPPollingPeriodSeconds": 95 } This is an integer value with a 60 second minimum. It sets the frequency that the the NTP server(s) are polled for the current time. d. PATCH StaticNTPServers { "StaticNTPServers": [ "16.110.135.123", "16.110.135.124" ] } These are IP address for NTP server(s). Using an IP address of “0.0.0.0” or “” will clear the NTP server. 7. /rest/v1/Managers/1/Logs/IML a. POST ClearLog { "Action": "ClearLog" } This action clears the entire Integrated Management Log. b.
a. POST AutoPowerOn "Action": "AutoPowerOnControl", "ControlType": "Off", "Target": "/Oem/Hp" } Valid ControlType values are “On” and “Off”. b. PATCH AutoPowerOn { "Oem": { "Hp": { "AutoPowerOn": "On" } } } Valid AutoPowerOn values are “On” and “Off”. c. POST IndicatorLED { "Action": "IndicatorLEDControl", “ControlType”: “On”, “Target”: “/Oem/Hp” } Valid ControlType values are “Off” and “Lit”. d. PATCH IndicatorLED (UID) { "IndicatorLED": "Off" } Valid IndicatorLED values are “Off” and “Lit”. e.
11. /rest/v1/Chassis/1/Logs/IML a. POST ClearLog { "Action": "ClearLog" } This action clears the Integrated Management Log of any entries related to the chassis. 12. /rest/v1/Chassis/1/PowerMetrics a. PATCH PowercapMode { "Oem": { "Hp": { "PowercapMode": x } } } Supported PowercapMode values are 0, 1, 2, and 5. 13. /rest/v1/Managers/1/RepositoryService a.
{ "Action": "InstallFromRepository", "FirmwareFileName": "", "ForceUpdate": true, "UpdateTargets": "", "Target": "/Oem/Hp" } This flashes the UpdateTargets with the repository file specified. b. POST InstallFromURI { "Action": "InstallFromURI", "FirmwareURI": "", "ForceUpdate": true, "UpdateTargets": "", "Target": "/Oem/Hp" } This flashes the UpdateTargets with the file at the URI. c. POST ClearUpdateStatus { "Action": "ClearUpdateStatus", "Target": "/Oem/Hp" } This clears the last update status. 15.
{ "HTTPS": { "Port": 443 } } WARNING! Setting the SSL Port will cause an immediate iLO CM reboot. Changing this parameter (to 442 for example) will require a connection to be made with https://name:442/rest/v1 or https://name:442 for the web GUI. e. PATCH SSH { "SSH": { "Enabled": true, "Port": 22 } } WARNING! f. Setting the SSH Port will cause an immediate iLO CM reboot.
{ "Oem": { "Hp": { "TFTPServerEnabled": true } } } This PATCH enables (true) and disables (false) the tftp server. 16. /rest/v1/Managers/1/NICs/1 a. PATCH DHCPv4 { "Oem": { "Hp": { "DHCPv4": { "Enabled": true, "UseDNSServers": true, "UseDomainName": true, "UseGateway": true, "UseNTPServers": false, "UseStaticRoutes": false, "UseWINSServers": true } } } } Changing any of these properties requires an iLO CM reset for the changes to take effect. b.
} } } Use "none" for "StaticRoutes", "Address", "SubnetMask", or "Gateway" to clear the setting. The "DDNSRegistration", "WINSRegistration", "StaticSubnetMask", "DNSServers", "StaticRoutes", and "WINSServers" properties can be PATCHED in any combination. Changing this property requires an iLO CM reset for the changes to take effect. c. PATCH PingGatewayOnStartup { "Oem": { "Hp": { "PingGatewayOnStartup": true } } } Changing this property requires an iLO CM reset for the change to take effect. d.
"Target": "/Oem/Hp" } Valid ControlType values are "Off" and "On". "On" creates a link between cartridges Cx and Cy if there is an appropriate connection path between the two cartridges. It is possible to create a link from a cartridge to more than one other cartridge. "Off" breaks an existing link between two cartridges. c. PATCH Power { "Power": "Press" } Valid Power values are "Press"and "PressAndHold". "PressAndHold"unconditionally removes power from all nodes on a cartridge.
{ "Power": "On" } Valid Power values are "On"and "Off". d. PATCH Serial Number { "SerialNumber": "" } e. PATCH Indicator LED (UID) { "IndicatorLED": "Off" } Valid IndicatorLED values are “Lit” and “Off”. f. PATCH SKU (Product ID) { "SKU": "XXXXXX-B21" } 20. /rest/v1/Chassis/1/Switches/Sx/Logs/IML a. POST ClearLog { "Action": "ClearLog" } This action clears the Integrated Management Log of any entries related to the switch (Sx). 21. /rest/v1/Systems/CxNy a.
} } } } d. PATCH CPU { "Oem": { "Hp": { "Options": { "CPU": { "ClockRate": { "CurrentFrequency": "1.8" } } } } } } The "CurrentFrequency" must be in the list of "AvailableFrequency" values. e. PATCH Options { "Oem": { "Hp": { "Options": { "BootOnce": "HDD", "WOL": "ENABLE", "BootOrder": [ "PXE", "M.2" ] } } } } Valid BootOrder values are "N/A", "PXE", "HDD", "iSCSI", and "M.2". Up to two boot order targets can be specified. f.
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.
Links to other resources /links/ComputerSystems[] /links/LogService /links/ManagedBy[] /links/ThermalMetrics to resource URI to resource Type /rest/v1/Systems/{item} ComputerSystem /rest/v1/Chassis/{item}/Cartridges/{item}/Logs/IML HpMoonshotLogService /rest/v1/Managers/{item} Manager /rest/v1/Chassis/{item}/Cartridges/{item}/ThermalMetrics ThermalMetrics HpMoonshotLogService Links to other resources HTTP Allow: GET, PATCH, POST to resource URI to resource Type HTTP Allow: GET to resource URI to resou
/links/NetworkService /rest/v1/Managers/{item}/NetworkService ManagerNetworkService HpiLODateTime Links to other resources /links/EthernetNICs HTTP Allow: GET, PATCH to resource URI /rest/v1/Managers/{item}/NICs to resource Type Collection Collection Links to other resources /links/Member[] HTTP Allow: GET, POST to resource URI /rest/v1/Managers/{item}/LicenseService/{item} to resource Type HpiLOLicense /rest/v1/Managers/{item}/LicenseService/{item} HpiLOLicense Links to other resources HTTP Allo
/rest/v1/Systems/{item} /rest/v1/Systems/{item}/Logs/IML /rest/v1/SystemsSummary Links to other resources /links/Member[] to resource URI /rest/v1/Systems/{item} to resource Type ComputerSystem ComputerSystem Links to other resources /links/Chassis[] /links/LogService /links/ManagedBy[] HTTP Allow: GET, PATCH, POST to resource URI /rest/v1/Chassis/{item} /rest/v1/Systems/{item}/Logs/IML /rest/v1/Managers/{item} to resource Type Chassis HpMoonshotLogService Manager HpMoonshotLogService Links to other
GET PATCH Rendered if supported by the implementation or omitted if not. This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers. PATCH Example HTTP PATCH to resource with request JSON: {"Oem": {"Hp": {"AuthFailureLoggingThreshold": }}} The property "Oem/Hp/AuthFailureLoggingThreshold" on resource type AccountService may not support PATCH of all values and may result in an HTTP 400 error with response of Type ExtendedError.
This property is a member of Chassis This is a user-assigned asset tag for the chassis. JSON type: String HTTP Operations GET PATCH Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request. This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.
"IndicatorLED" This property is a member of Chassis This is the indicator LED for the chassis, which is used to identify the chassis. This LED can be manipulated by the user. JSON type: String containing one of the following supported values: "Unknown" "Lit" "Blinking" "Off" HTTP Operations GET PATCH Rendered if supported by the 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 PATCH Rendered if supported by the implementation or omitted if not. This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.
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.
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/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/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.
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.
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. "PartNumber" This property is a member of Chassis This is the part number of the chassis. JSON type: String HTTP Operations GET Rendered if supported by the implementation or omitted if not.
This property is a member of Chassis This is the serial number of the chassis. JSON type: String HTTP Operations GET PATCH Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request. This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.
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.
"Target" may be one of the following values: "/Oem/Hp" Parameter "AssetTag" "AssetTag" may be one of the following values: Example HTTP POST to resource with request JSON: { "Action": "SetAssetTag", "Target": "/Oem/Hp", "AssetTag": ""} POST Action "AutoPowerOnControl" Parameter "Target" "Target" may be one of the following values: "/Oem/Hp" Parameter "ControlType" "ControlType" may be one of the following values: "On" "Off" Example HTTP POST to resource with request JSON: { "Action": "AutoPowerOnControl",
{ "Action": "SetChassisName", "Target": "/Oem/Hp", "ChassisName": ""} POST Action "IndicatorLEDControl" Parameter "ControlType" "ControlType" may be one of the following values: "Lit" "Off" Parameter "Target" "Target" may be one of the following values: "/Oem/Hp" Example HTTP POST to resource with request JSON: { "Action": "IndicatorLEDControl", "ControlType": "Lit", "Target": "/Oem/Hp"} "ChassisFirmwareSummary" Resource Type Resource Instances /rest/v1/Chassis/{item}/ChassisFirmwareSummary See Resource M
HTTP Operations GET Rendered if supported by the 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.
GET Rendered if supported by the 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.
HTTP Operations GET Rendered if supported by the 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.
GET Rendered if supported by the 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.
"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.
"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.
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.
"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 PATCH Rendered if supported by the implementation or omitted if not. This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.
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" "CART_TYPE_GRAPHIC" "Switch (network)" "Display (video) cartridge" "CART_TYPE_EXPANSION" "CART_TYPE_NETWORK" "CART_TYPE_FPGA" "CART_TYPE_UNKNOWN" HTTP Operations GET Rendered if supported by the implementation or omitted if not.
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.
"No" HTTP Operations GET Rendered if supported by the implementation or omitted if not. "Cartridges[]/Links[]/Architecture" This property is a member of ChassisSummary JSON type: String HTTP Operations GET Rendered if supported by the implementation or omitted if not. "Cartridges[]/Links[]/LinkedTo" This property is a member of ChassisSummary JSON type: String HTTP Operations GET Rendered if supported by the implementation or omitted if not.
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.
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 PATCH Rendered if supported by the implementation or omitted if not. This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.
"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.
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.
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.
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.
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.
"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.
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.
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. "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.
"Unknown" "Lit" "Blinking" "Off" HTTP Operations GET PATCH Rendered if supported by the implementation or omitted if not. This property may be 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.
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.
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.
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.
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" HTTP Operations GET Rendered if supported by the implementation or omitted if not.
"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.
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.
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.
"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.
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.
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 PATCH Rendered if supported by the implementation or omitted if not.
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.
"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.
"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.
"Collection" Resource Type Resource Instances /rest/v1/AccountService/Accounts /rest/v1/Chassis /rest/v1/Chassis/{item}/Cartridges /rest/v1/Chassis/{item}/Switches /rest/v1/Managers /rest/v1/Managers/{item}/LicenseService /rest/v1/Managers/{item}/NICs /rest/v1/Registries /rest/v1/Schemas /rest/v1/Sessions /rest/v1/Systems See Resource Map for more details.
GET Rendered if supported by the implementation or omitted if not. "links/FirstPage/0/count" This property is a member of Collection The number of resources represented on the referenced page. JSON type: Integer greater than or equal to 0. HTTP Operations GET Rendered if supported by the implementation or omitted if not. "links/FirstPage/0/page" This property is a member of Collection The number of the first page. JSON type: Integer greater than or equal to 0.
This property is a member of Collection The number of resources represented on the referenced page. JSON type: Integer greater than or equal to 0. HTTP Operations GET Rendered if supported by the implementation or omitted if not. "links/LastPage/0/page" This property is a member of Collection The number of the last page. JSON type: Integer greater than or equal to 0. HTTP Operations GET Rendered if supported by the implementation or omitted if not.
JSON type: String HTTP Operations GET Rendered if supported by the implementation or omitted if not. "links/Member[]/id" This property is a member of Collection The identifier value of the linked resource. JSON type: String HTTP Operations GET Rendered if supported by the implementation or omitted if not. "links/NextPage/0/count" This property is a member of Collection The number of resources represented on the referenced page. JSON type: Integer greater than or equal to 0.
HTTP Operations GET Rendered if supported by the implementation or omitted if not. "links/NextPage/1/start" This property is a member of Collection The start value can be used in a query on the URI to get the next page. JSON type: Integer greater than or equal to 0. HTTP Operations GET Rendered if supported by the implementation or omitted if not. "links/PrevPage/0/count" This property is a member of Collection The number of resources represented on the referenced page.
"links/PrevPage/1/start" This property is a member of Collection The start item index of the previous page. JSON type: Integer greater than or equal to 0. HTTP Operations GET Rendered if supported by the implementation or omitted if not. "ComputerSystem" Resource Type Resource Instances /rest/v1/Systems/{item} See Resource Map for more details. The schema definition of a computer system and its properties.
"Bios/Current/BuildNumber" 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. "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/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.
"HDD" "BiosSetup" "Utilities" "Diags" "UefiShell" "UefiTarget" "M.2" "iSCSI" HTTP Operations GET PATCH Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request. This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.
JSON type: String HTTP Operations GET Rendered if supported by the 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.
JSON type: String HTTP Operations GET Rendered if supported by the 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.
"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. "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.
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.
"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.
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[]/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.
BIOS Serial Console JSON type: String containing one of the following supported values: "enabled" "disabled" "DISABLE" "ENABLE" HTTP Operations GET PATCH Rendered if supported by the implementation or omitted if not. This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.
ExtendedError. Multiple properties may be included in a single HTTP PATCH operation as long 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 PATCH 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 PATCH Rendered if supported by the implementation or omitted if not. This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.
placeholders on skipped array entries. "Oem/Hp/VirtualUUID" 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. "PartNumber" This property is a member of ComputerSystem The part number for this system as defined by the manufacturer.
GET Rendered if supported by the 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.
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. "Processors/Status/HealthRollUp" This property is a member of ComputerSystem Indicates the overall health state of this resource and its dependent resources.
"Removed" "Redundant" "Not Redundant" "Insufficient to Operate" HTTP Operations GET Rendered if supported by the implementation or omitted if not. "SKU" This property is a member of ComputerSystem 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.
"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. "Status/State" This property is a member of ComputerSystem Indicates the known state of this resource (for example, if the resource is enabled).
This property is a member of ComputerSystem This property describes the type of computer system represented by this resource. 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.
GET Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.
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 PATCH Rendered if supported by the implementation or omitted if not.
{"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.
HTTP Operations GET PATCH Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request. This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.
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.
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.
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. Applies only when DHCPv4 is enabled. JSON type: Boolean ('true' or 'false') HTTP Operations GET PATCH Rendered if supported by the implementation or omitted if not. This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.
Determines whether to use DHCPv4-supplied WINS servers. Applies only when DHCPv4 is enabled. JSON type: Boolean ('true' or 'false') HTTP Operations GET PATCH Rendered if supported by the implementation or omitted if not. This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.
GET PATCH Rendered if supported by the implementation or omitted if not. This property may be 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": ""}}} 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.
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.
first, insert nulls as placeholders on skipped array entries. "Oem/Hp/IPv4/StaticRoutes[]/SubnetMask" This property is a member of EthernetNetworkInterface IPv4 static route's subnet mask. Applies only when iLO is not configured to use DHCPv4-supplied static routes. JSON type: String HTTP Operations GET PATCH Rendered if supported by the implementation or omitted if not. This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.
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.
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 PATCH Rendered if supported by the implementation or omitted if not. This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.
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.
HTTP Operations GET Rendered if supported by the implementation or omitted if not. "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.
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/Links[]/LinkedTo" This property is a member of HpMoonshotCartridge JSON type: String HTTP Operations GET Rendered if supported by the implementation or omitted if not. "CartridgeInfo/Links[]/Speed" This property is a member of HpMoonshotCartridge JSON type: String 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/Width" This property is a member of HpMoonshotCartridge JSON type: Integer HTTP Operations GET Rendered if supported by the implementation or omitted if not.
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.
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.
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 PATCH Rendered if supported by the implementation or omitted if not. This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.
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.
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 PATCH Rendered if supported by the implementation or omitted if not.
PATCH Example HTTP PATCH to resource with request JSON: {"SKU": ""} 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.
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.
"On" "Off" Parameter "Target" "Target" may be one of the following values: "/Oem/Hp" Parameter "LinkedCartridge" "LinkedCartridge" may be one of the following values: Example HTTP POST to resource with request JSON: { "Action": "LinkControl", "ControlType": "On", "Target": "/Oem/Hp", "LinkedCartridge": ""} POST Action "IndicatorLEDControl" Parameter "ControlType" "ControlType" may be one of the following values: "Lit" "Off" Example HTTP POST to resource with request JSON: { "Action": "IndicatorLEDControl",
This resource represents the log service for the resource or service to which it is associated. "HpMoonshotLogService" defines the following properties specified in JSON-pointer syntax "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.
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.
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.
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.
POST Action "AddMaintenanceNote" Parameter "Message" "Message" may be one of the following values: Example HTTP POST to resource with request JSON: { "Action": "AddMaintenanceNote", "Message": ""} "HpMoonshotPower" Resource Type Resource Instances /rest/v1/Chassis/{item}/PowerMetrics See Resource Map for more details. "HpMoonshotPower" defines the following properties specified in JSON-pointer syntax "Oem/Hp/PowercapDescription" This property is a member of HpMoonshotPower Powercap description.
{"Oem": {"Hp": {"PowercapMode": }}} The property "Oem/Hp/PowercapMode" on resource type HpMoonshotPower may not support PATCH of all values and may result in an HTTP 400 error with response of Type ExtendedError. Multiple properties may be included in a single HTTP PATCH operation as long as the request is properly formatted JSON. To address an array entry other than the first, insert nulls as placeholders on skipped array entries.
GET Rendered if supported by the 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 HpMoonshotPower 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.
HTTP Operations GET PATCH Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request. This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.
This property is a member of HpMoonshotPower 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 HpMoonshotPower Maximum power consumed during the interval specified by 'IntervalInMin'.
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 HpMoonshotPower 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[]/Model" This property is a member of HpMoonshotPower 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 HpMoonshotPower The latest observed average power being drawn by the power supply, in Watts.
This property is a member of HpMoonshotPower The latest observed maximum output power being drawn by the power supply, in 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 HpMoonshotPower If true, this power supply is mismatched with others in the system.
JSON type: String HTTP Operations GET Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request. "PowerSupplies[]/Oem/Hp/iPDU/Model" This property is a member of HpMoonshotPower 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.
GET Rendered if supported by the 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 HpMoonshotPower 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.
HTTP Operations GET Rendered if supported by the 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 HpMoonshotPower Indicates the health state of this resource without considering its dependent resources.
"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 HpMoonshotPower Indicates the health state of this resource without considering its dependent resources.
"Status/State" This property is a member of HpMoonshotPower 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.
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.
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.
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.
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 PATCH Rendered if supported by the implementation or omitted if not.
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 PATCH Rendered if supported by the implementation or omitted if not.
HTTP PATCH to resource with request JSON: {"SerialNumber": ""} 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.
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.
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.
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. "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.
Example HTTP POST to resource with request JSON: { "Action": "IndicatorLEDControl", "ControlType": "Lit"} POST Action "PowerControl" Parameter "ControlType" "ControlType" may be one of the following values: "On" "Off" Example HTTP POST to resource with request JSON: { "Action": "PowerControl", "ControlType": "On"} "HpiLODateTime" Resource Type Resource Instances /rest/v1/Managers/{item}/DateTime See Resource Map for more details. iLO date and time.
This property is a member of HpiLODateTime Date and time used by iLO. JSON type: String HTTP Operations GET PATCH Rendered if supported by the implementation or omitted if not. This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.
"TimeZone/Index" This property is a member of HpiLODateTime Selected time zone index. Set a new time zone by specifying a different time zone index. JSON type: Integer HTTP Operations GET PATCH Rendered if supported by the implementation or omitted if not. This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.
Environment variable value. JSON type: String HTTP Operations GET Rendered if supported by the implementation or omitted if not. "UseStaticNTPServers" This property is a member of HpiLODateTime JSON type: Boolean ('true' or 'false') HTTP Operations GET Rendered if supported by the implementation or omitted if not. "HpiLOLicense" Resource Type Resource Instances /rest/v1/Managers/{item}/LicenseService/{item} See Resource Map for more details.
"LicenseKey" This property is a member of HpiLOLicense The license key installed on iLO. License keys are 25 characters in length and contain both letters and numbers. JSON type: String HTTP Operations GET PATCH Rendered if supported by the implementation or omitted if not. This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.
See Resource Map for more details. "Manager" defines the following properties specified in JSON-pointer syntax "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/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.
Model name of the Manager JSON type: String HTTP Operations GET Rendered if supported by the implementation or omitted if not. "Oem/Hp/License/LicenseKey" This property is a member of Manager Specifies the License Key installed 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 in the iLO.
HTTP Operations GET Rendered if supported by the implementation or omitted if not. POST Action "Reset" Example HTTP POST to resource with request JSON: { "Action": "Reset"} POST Action "SetFactoryDefaults" Example HTTP POST to resource with request JSON: { "Action": "SetFactoryDefaults"} "ManagerAccount" Resource Type Resource Instances /rest/v1/AccountService/Accounts/{item} See Resource Map for more details.
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.
This property is a member of ManagerAccount This privilege enables a user to add, edit, and delete local iLO user accounts. A user with this privilege can change privileges for all users. JSON type: Boolean ('true' or 'false') HTTP Operations GET PATCH Rendered if supported by the implementation or omitted if not. This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.
HTTP Operations GET PATCH Rendered if supported by the implementation or omitted if not. This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.
"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/UserPrivilege" This property is a member of ManagerAccount User privilege compatible with iLO CM CLI.
GET PATCH Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request. This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.
HTTP POST to resource with request JSON: { "Action": "AddSSHPublicKey", "KeyData": "", "Target": "/Oem/Hp"} POST Action "RemoveSSHPublicKey" Parameter "Target" "Target" may be one of the following values: "/Oem/Hp" Example HTTP POST to resource with request JSON: { "Action": "RemoveSSHPublicKey", "Target": "/Oem/Hp"} "ManagerNetworkService" Resource Type Resource Instances /rest/v1/Managers/{item}/NetworkService See Resource Map for more details.
"FQDN" This property is a member of ManagerNetworkService JSON type: String HTTP Operations GET Rendered if supported by the implementation or omitted if not. "HTTP/Enabled" This property is a member of ManagerNetworkService Indicates if HTTP is enabled or disabled. JSON type: Boolean ('true' or 'false') HTTP Operations GET PATCH Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.
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 if HTTPS/SSL is enabled or disabled.
This property is a member of ManagerNetworkService Manager host name JSON type: String HTTP Operations GET PATCH Rendered if supported by the implementation or omitted if not. This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.
HTTP Operations GET Rendered if supported by the implementation or omitted if not. "Oem/Hp/AlertMailEmail" This property is a member of ManagerNetworkService Destination email address for email alerts. JSON type: String HTTP Operations GET PATCH Rendered if supported by the implementation or omitted if not. This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.
This property is a member of ManagerNetworkService Alertmail port number JSON type: Integer from 1 to 65535. HTTP Operations GET PATCH Rendered if supported by the implementation or omitted if not. This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.
HTTP Operations GET PATCH Rendered if supported by the implementation or omitted if not. This property may be 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": ""}}} 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.
GET Rendered if supported by the implementation or omitted if not. "Oem/Hp/DomainSuffix" This property is a member of ManagerNetworkService JSON type: String HTTP Operations GET PATCH Rendered if supported by the implementation or omitted if not. This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.
This property is a member of ManagerNetworkService Indicates whether iLO federation management is enabled or disabled. JSON type: Boolean ('true' or 'false') HTTP Operations GET PATCH Rendered if supported by the implementation or omitted if not. This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.
JSON type: Integer from 1 to 65535. HTTP Operations GET PATCH Rendered if supported by the implementation or omitted if not. This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.
PATCH This property may be 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": }}} 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.
{"Oem": {"Hp": {"SNMPPort": }}} The property "Oem/Hp/SNMPPort" 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/SupportsFlexibleLOM" This property is a member of ManagerNetworkService Determines whether this system supports FlexibleLOM JSON type: Boolean ('true' or 'false') HTTP Operations GET Rendered if supported by the implementation or omitted if not. "Oem/Hp/SupportsLOM" This property is a member of ManagerNetworkService Determines whether this system supports LOM JSON type: Boolean ('true' or 'false') HTTP Operations GET Rendered if supported by the implementation or omitted if not.
HTTP Operations GET PATCH Rendered if supported by the implementation or omitted if not. This property may be 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": {"XMLData": true}}} The property "Oem/Hp/XMLData" on resource type ManagerNetworkService may not support PATCH of all values and may result in an HTTP 400 error with response of Type ExtendedError.
PATCH Example HTTP PATCH to resource with request JSON: {"RDP": {"Port": }} The property "RDP/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.
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.
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.
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.
"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. "Telnet/Enabled" This property is a member of ManagerNetworkService Telnet enable JSON type: Boolean ('true' or 'false') HTTP Operations GET PATCH Rendered if supported by the implementation or omitted if not.
GET PATCH Rendered if supported by the implementation or omitted if not. This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers. PATCH Example HTTP PATCH to resource with request JSON: {"Telnet": {"Port": }} The property "Telnet/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.
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.40 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.40 JSON type: String HTTP Operations GET Rendered if supported by the implementation or omitted if not.
Parameter "FirmwareFileName" "FirmwareFileName" may be one of the following values: Parameter "Target" "Target" may be one of the following values: "/Oem/Hp" Example HTTP POST to resource with request JSON: { "Action": "RemoveFromRepository", "FirmwareFileName": "", "Target": "/Oem/Hp"} POST Action "ScriptAddFromURI" Parameter "ScriptURI" "ScriptURI" may be one of the following values: Parameter "Target" "Target" may be one of the following values: "/Oem/Hp" Example HTTP POST to resource with request JSON:
"ManagerUpdateService" Resource Type Resource Instances /rest/v1/Managers/{item}/UpdateService See Resource Map for more details. "ManagerUpdateService" defines the following properties specified in JSON-pointer syntax "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.
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.
"COMPLETED" "ERROR" 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.
"UPLOADING" "PROGRESSING" "COMPLETED" "ERROR" HTTP Operations GET Rendered if supported by the implementation or omitted if not.
Parameter "FirmwareFileName" "FirmwareFileName" may be one of the following values: Parameter "UpdateTargets" "UpdateTargets" may be one of the following values: Parameter "ForceUpdate" "ForceUpdate" may be one of the following values: Parameter "Target" "Target" may be one of the following values: "/Oem/Hp" Example HTTP POST to resource with request JSON: { "Action": "InstallFromRepository", "FirmwareFileName": "", "UpdateTargets": "", "ForceUpdate": "", "Target": "/Oem/Hp"} "ServiceRoot" Resource Type Re
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.
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 iLO. 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 iLO.
GET Rendered if supported by the implementation or omitted if not. "Oem/Hp/Manager[]/ManagerFirmwareVersionPass" This property is a member of ServiceRoot Build or pass number of the iLO 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 Type of the service manager. JSON type: String 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.
Information on how to log in to iLO. 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 Password for logging in to iLO. 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 User name for logging in to iLO.
HTTP Operations GET Rendered if supported by the implementation or omitted if not. "Oem/Hp/Sessions/ServerName" This property is a member of ServiceRoot Name of the server that this iLO 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 Version of the web service. This is different from the version of the data model.
See Resource Map for more details. "Session" defines the following properties specified in JSON-pointer syntax "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/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/UserConfigPriv" This property is a member of Session This privilege enables a user to add, edit, and delete local iLO user accounts.
This property is a member of Session This privilege enables a user to configure most iLO settings, including security settings, and to remotely update the iLO 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.
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.
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 iLO JSON type: String HTTP Operations GET Rendered if supported by the implementation or omitted if not. "SystemsSummary" Resource Type Resource Instances /rest/v1/SystemsSummary See Resource Map for more details.
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.
HTTP Operations GET PATCH Rendered if supported by the implementation or omitted if not. This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers. PATCH Example HTTP PATCH to resource with request JSON: {"Systems": [null, {"Options": {"BootOnce": "PXE"}}]} The property "Systems[]/Options/BootOnce" on resource type SystemsSummary may not support PATCH of all values and may result in an HTTP 400 error with response of Type ExtendedError.
GET PATCH Rendered if supported by the implementation or omitted if not. This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers. PATCH Example HTTP PATCH to resource with request JSON: {"Systems": [null, {"Options": {"CPU": {"HyperThreading": "disabled"}}}]} The property "Systems[]/Options/CPU/HyperThreading" on resource type SystemsSummary may not support PATCH of all values and may result in an HTTP 400 error with response of Type ExtendedError.
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.
HTTP Operations GET Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request. "ThermalMetrics" Resource Type Resource Instances /rest/v1/Chassis/{item}/Cartridges/{item}/ThermalMetrics /rest/v1/Chassis/{item}/Switches/{item}/ThermalMetrics /rest/v1/Chassis/{item}/ThermalMetrics See Resource Map for more details. This is the schema definition for the Thermal Metrics.
"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.
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.
GET Rendered if supported by the implementation or omitted if not. "Fans[]/Units" This property is a member of ThermalMetrics Represented as percentage. JSON type: String HTTP Operations GET Rendered if supported by the implementation or omitted if not. "Temperatures[]/Context" This property is a member of ThermalMetrics Area or device to which this temperature measurement applies.
This property is a member of ThermalMetrics 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 Critical temperature threshold. JSON type: Integer 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).
"Temperatures[]/Units" This property is a member of ThermalMetrics Represented in degrees Celsius. JSON type: String HTTP Operations GET Rendered if supported by the implementation or omitted if not. "Temperatures[]/UpperThresholdCritical" This property is a member of ThermalMetrics JSON type: Integer HTTP Operations GET Rendered if supported by the implementation or omitted if not.
Severity: OK Resolution: Attempt to connect using a valid account. Base.0.9.AccountModified The account was modified successfully. Severity: OK Resolution: None. Base.0.9.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.0.9.AccountRemoved The account was removed successfully. Severity: OK Resolution: None. Base.0.9.
The parameter supplied for the action is not supported on the target resource. Severity: Warning Resolution: If the operation did not complete, remove the parameter and resubmit the request. Base.0.9.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.0.9.
Base.0.9.Created The resource has been created successfully. Severity: OK Resolution: None Base.0.9.EventSubscriptionLimitExceeded The event subscription establishment has been requested, but the operation failed because the number of simultaneous subscriptions exceeded the maximum number allowed by the implementation.
Severity: Critical Resolution: Verify that the request body is valid JSON and resubmit the request. Base.0.9.NoValidSession The operation failed because a valid session is required in order to access resources. Severity: Critical Resolution: Establish a session before attempting any operations. Base.0.9.PropertyDuplicate A duplicate property is included in the request body.
The correct type of value was supplied for the property, 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.0.9.PropertyValueTypeError An incorrect property type was supplied for the value of a property. For example, a number supplied for a property that requires a string.
Base.0.9.ResourceAlreadyExists The create resource operation failed because the resource already exists. Severity: Critical Resolution: Do not attempt the create operation because the resource already exists. Base.0.9.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.0.9.
Resolution: If the operation did not complete, restart the service and resubmit the request. Base.0.9.ServiceShuttingDown The operation failed because the service is shutting down. Severity: Critical Resolution: If the operation did not complete, resubmit the request when the service is available. Base.0.9.ServiceTemporarilyUnavailable The service is temporarily unavailable. Severity: Critical Resolution: Wait for the indicated retry duration and retry the operation. Base.0.9.
Severity: Warning Resolution: Choose a value from the enumeration list and resubmit the request if the operation failed. iLO.0.9.CannotRemoveLicense Cannot remove iLO Standard/iLO Standard for BladeSystem License. Severity: Warning Resolution: None. iLO.0.9.DemoLicenseKeyPreviouslyInstalled Demo license was previously installed. Severity: Warning Resolution: None. iLO.0.9.ETagTooLong ETag is too long. Severity: Warning Resolution: None. iLO.0.9.
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: None. iLO.0.9.InvalidLicenseKey The supplied license key is not valid. Severity: Warning Resolution: Provide a valid license key. iLO.0.9.
iLO.0.9.LoginAttemptDelayed Failed login attempt. Login delayed. Severity: Warning Resolution: None. iLO.0.9.MaxProviders Maximum number of providers are already registered. Severity: Warning Resolution: None. iLO.0.9.MaxVirtualMediaConnectionEstablished No more Virtual Media connections allowed. Maximum number of connections already established. Severity: Warning Resolution: Close a Virtual Media connection. iLO.0.9.NoSNMPAlertDestinationsConfigured No SNMP alert destinations are configured.
Resolution: Correct the value for the property in the request body and resubmit the request. iLO.0.9.PropertyValueIncompatible Indicates that the correct value type was supplied for a property, but the value for the property was incompatible with the value for another property. Severity: Warning Resolution: Correct the value for the property in the request body and resubmit the request. iLO.0.9.PropertyValueOutOfRange Indicates that a property was supplied with a value that is out of range.
Severity: Warning Resolution: None. iLO.0.9.SNMPTestAlertFailed Failed to send SNMP Test Alert. Severity: Warning Resolution: None. iLO.0.9.SuccessMoreInfo Indicates that all conditions of a successful operation have been met. Severity: OK Resolution: None iLO.0.9.UnableModifyRights Unable to modify user rights. Severity: Warning Resolution: None. iLO.0.9.UnableToModifyDuringSystemPOST Property cannot be changed while the system is in BIOS POST.
This user or login name already exists. Severity: Warning Resolution: Try a different user or login name. MoonshotCM_Data_Model_Reference_edit2.
