How it Works
HP
Loading...
M
Loading...
Loading...
Moonshot-45G
User Manual
76 pgs2.4 Mb0
Reference Guide
221 pgs930.07 Kb0
Command Reference Guide
719 pgs2.94 Mb0
Installation Manual
5 pgs3.84 Mb0
Table of contents
Loading...

HP Moonshot-45G Reference Guide

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.
HP Part Number: 802725-001a Published: November 2014 Edition: 1
© Copyright 2014 Hewlett-Packard Development Company, L.P.
The information contained herein is subject to change without notice. The only warranties for HP products and services are set forth in the express warranty statements accompanying such products and services. Nothing herein should be construed as constituting an additional warranty. HP shall not be liable for technical or editorial errors or omissions contained herein.
Acknowledgments
Windows Server® is a trademark of the Microsoft Group of companies.

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.

First Things

HP Moonshot running Chassis Manager 1.30 or later features a new management interface called the “HP RESTful API.” The HP RESTful API is a RESTful Web Service API served by iLO’s web server. If you are familiar with RESTful APIs, this should tell you much about how the API works. In short, a RESTful API is an application programming interface using the basic HTTP operations GET, PUT, POST, DELETE, and PATCH. Each HTTP operation either submits or returns a “resource” in the form of UTF-8 encoded JSON. Just as a Web application returns HTML to your browser, a REST interface returns data (in the form of JSON) to your client over the same transport (HTTPS).
All modern scripting languages make it very easy to write simple REST clients for web services. Most, like Python can transform JSON into internal data structures like dictionaries, allowing for easily access to data. This enables you to write custom code directly to the API instead of using intermediate tools.
If you are not familiar with RESTful APIs, you should pause and do internet research on the subject. This tutorial is intended to point out the things you must consider when creating a proper client to interact with The HP RESTful API.

Key Benefits of the HP RESTful API

This HP RESTful API will become the main management API for Moonshot. Using this API you can take full inventory of the Moonshot enclosure, control power and reset, configure settings, fetch event logs as well as many other things.
This API follows the trend of the Internet in moving to a common pattern for new software interfaces. Many web services in a variety of industries use REST APIs because they are easily to implement, easy to consume, and offer scalability advantages over previous technologies. HP OneView, OpenStack, and many other server management APIs are now REST APIs. Most HP Management software offerings as well as the entire Software Defined Data Center architecture is built upon REST APIs.

Requirements for using the HP RESTful API

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

How to Use This Document

This document has three main sections.
Examples of using PATCH and POST to set properties and perform actions.
Resource Map documents the resources in the data model including the URIs and types of the resources as well as the relationships between resources. Not all implementations of the
The API will contain all the resources in this table and the model may expand in future versions of firmware.
Data Model Type Reference contains a chapter for each resource type and a section for each property in each resource type.
The
The Message Reference documents the MessageID values that may be returned in ExtendedError responses to HTTP operations.
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. PATCH Minimum Password Length
{ "Oem": {
"Hp": {
"MinPasswordLength": 8
} } }
This changes the Minimum Password Length. Acceptable values are 0 through 39.
b. PATCH Authentification Failure Logging Threshold
{ "Oem": {
"Hp": {
"AuthFailureLoggingThreshold": 3
} } }
This changes the threshold at which an SSH login failure is logged.
3. /rest/v1/AccountService/Accounts
a. POST New User
{ "UserName": "", "Password": "", "Oem": {
"Hp": {
"LoginName": ""
} } }
This adds a new user.
4. /rest/v1/AccountService/Accounts/N
a. PATCH Modify User Account privileges
{ "Oem": { "Hp": {
"Privileges": {
"LoginPriv": true,
"RemoteConsolePriv": true,
"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. The maximum length of the key that can be supplied for "KetData" is 1366 bytes including the overhead.
c. POST RemoveSSHPublicKey
{ "Action": "RemoveSSHPublicKey", "Target": "/Oem/Hp" }
This POST removes the SSH public key associated with account N.
5. /rest/v1/Managers/1
a. POST Reset
{ "Action": "Reset" }
The performs a reset on iLO CM.
b. POST Set Factory Defaults
{ "Action": "SetFactoryDefaults" }
6. /rest/v1/Managers/1/DateTime
a. PATCH DateTime
{ "DateTime": "YYYY-MM-DDTHH:MM:SS+hh:mm" }
The DateTime format follows the ISO 8601 standard. The time is set using local time and the +hh:mm section is the offset from UTC to the local standard time zone. Daylight savings time is automatically determined. CST/CDT is +06:00.
b. PATCH TimeZone.Index
{ "TimeZone": {
"Index": 296 } }
The Timezone Indexes that are available are listed in the TimeZoneList array with a GET /rest/v1/Managers/1/DateTime.
c. PATCH SNTPPollingPeriodSeconds
{ "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. POST AddMaintenanceNote
{ "Action": "AddMaintenanceNote", "Message": "" }
This action adds a maintenance note to the IML. The text for the "Message" property is placed in the description field of the event.
c. POST MarkRepaired
{ "Action": "MarkRepaired", "RecordId":
[
n1,n2,n3,n4,n5,n6,n7,n8,n9,n10,…
]
}
This action marks a log entry as “Repaired” The "RecordId" property is an array of integers and must be existing log entries.
8. /rest/v1/Managers/1/Logs/IEL
a. POST ClearLog
{ "Action": "ClearLog" }
This action clears the entire iLO Event Log.
9. /rest/v1/Managers/1/LicenseService
a. POST LicenseKey
{ "LicenseKey": "" }
The LicenseKey is either submitted as VVVVV-WWWWW-XXXXX-YYYYY-ZZZZZ or VVVVVWWWWWXXXXXYYYYYZZZZZ.
10. /rest/v1/Chassis/1
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. POST AssetTag
{ "Action": "SetAssetTag", "AssetTag ": "", "Target": "/Oem/Hp" }
The maximum length for asset tag is 32.
f. POST ChassisName
{ "Action”: “SetChassisName", "ChassisName": "", "Target": "/Oem/Hp" }
The maximum length for chassis name is 63.
g. PATCH SKU (Product ID)
{ "SKU”: “" }
The SKU must be 2 through 16 characters in length.
h. PATCH SerialNumber
{ "SerialNumber": "" }
The SerialNumber must be 2 through 16 characters in length.
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. POST RemoveFromRepository
{ "Action": "RemoveFromRepository", "FirmwareFileName": "", "Target": "/Oem/Hp" }
This removes the named firmware file from the repository. The firmware files currently in the repository are listed in the FirmwareRepositoryFiles array.
b. POST RepositoryAddFromURI
{ "Action”: “RepositoryAddFromURI", "FirmwareURI”: “", "Target": "/Oem/Hp" }
This uploads a file to the repository. If the file already exists then it is overwritten by the new copy.
c. POST RemoveScriptFromRepository
{ "Action": "RemoveScriptFromRepository", "ScriptFileName": "", "Target": "/Oem/Hp" }
This removes the named script file from the repository. The script files currently in the repository are listed in the ScriptRepositoryFiles array.
d. POST ScriptAddFromURI
{ "Action": "ScriptAddFromURI", "ScriptURI": "", "Target": "/Oem/Hp" }
This uploads a file to the repository. If the file already exists then it is overwritten by the new copy.
14. /rest/v1/Managers/1/UpdateService
a. POST InstallFromRepository
{ "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. /rest/v1/Managers/1/NetworkService
a. PATCH Alert Mail
{ "Oem": { "Hp": {
"AlertMailSenderDomain": "", "AlertMailEmail": "", "AlertMailEnabled": false, "AlertMailSMTPServer": "",
"AlertMailSenderDomain": "" } } }
b. PATCH Remote Syslog
{ "Oem": {
"Hp": {
"RemoteSyslogServer": "xxx.xxx.xxx.xxx", "RemoteSyslogEnabled": true "RemoteSyslogPort": 514
} } }
c. PATCH HTTP Port
{ "HTTP": {
"Port": 80 } }
WARNING! Setting the HTTP Port will cause an immediate iLO CM reboot.
d. PATCH HTTPS Port
{ "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! Setting the SSH Port will cause an immediate iLO CM reboot.
f. PATCH FederationEnabled
{ "Oem": {
"Hp": {
"FederationEnabled": true
} } }
FederationEnabled can only be set true if FederationSupported is true.
g. PATCH SSDP
{ "SSDP": {
"Enabled": true,
"NotifyMulticastIntervalSeconds": 600,
"NotifyTTL": 255,
"Port": 1900 }
Valid NotifyMulticastIntervalSeconds values are 0, 30, 60, 120, 300, 600, 900, and 1800. Valid NotifyTTL values are 1 through 255.
h. PATCH IPMI
{ "IPMI": {
"Enabled": true } }
i. PATCH HostName
{ "HostName ": "" }
j. PATCH SessionTimeoutMinutes
{ "SessionTimeoutMinutes": 0 }
Valid SessionTimeoutMinutes values are 0 (disabled), 15, 30, 60, and 120.
k. PATCH TFTP Server
{ "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. PATCH IPv4 settings ("DDNSRegistration", "WINSRegistration",
"StaticSubnetMask", "DNSServers", "StaticRoutes", and "WINSServers"):
{ "Oem": {
"Hp": {
"IPv4": {
"DDNSRegistration": true, "WINSRegistration": true, "DNSServers": [
"0.0.0.0", "0.0.0.0", "0.0.0.0"
],
"StaticRoutes": [
{
"Address": "none", "SubnetMask": "none",
"Gateway": "none" }, {
"Address": "none",
"SubnetMask": "none",
"Gateway": "none" }, {
"Address": "none",
"SubnetMask": "none",
"Gateway": "none" }
], "WINSServers": [
"0.0.0.0", "0.0.0.0"
]
}
} } }
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. PATCH DaisyChainEnabled
{ "IPv4Addresses": { "StaticRoutes": [
{
"Address": "none", "SubnetMask": "none", "Gateway": "none"
}
], } }
e. PATCH IPv4Addresses
{ "IPv4Addresses": [
{
"Address": "16.100.109.82", "Gateway": "16.100.108.1", "SubnetMask": "255.255.252.0"
} ] }
Use "none" for "Address", "SubnetMask", or "Gateway" to clear the setting. "Address", "Gateway", and "SubnetMask" require that "DHCPv4" be disabled.
17. /rest/v1/Chassis/1/Cartridges/Cx
a. POST IndicatorLEDControl
{ "Action": "IndicatorLEDControl", "ControlType": "Lit" }
Valid ControlType values are “Off” and “Lit”.
b. POST LinkControl
{ "Action": "IndicatorLEDControl", "ControlType": "On", “LinkedCartridge”: “Cy”
"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. "Press"(when all nodes are off) sends a power on signal to all nodes. "Press" (when
any nodes are on) sends a power off signal to all nodes that have power applied. This requires a running OS for a response.
d. PATCH SKU (Product ID)
{ "SKU": "XXXXXX-B21" }
e. PATCH Serial Number
{ "SerialNumber": "" }
f. PATCH IndicatorLED (UID)
{ "IndicatorLED": "Lit" }
Valid IndicatorLED values are "Off" and "Lit".
18. /rest/v1/Chassis/1/Cartridges/Cx/Logs/IML
a. POST ClearLog
{ "Action": "ClearLog" }
This action clears the Integrated Management Log of any entries related to the cartridge (Cx) or any node(s) (CxNy) on the cartridge.
19. /rest/v1/Chassis/1/Switches/Sx
a. POST IndicatorLEDControl
{ "Action": "IndicatorLEDControl", "ControlType": "Lit" }
Valid ControlType values are "Off" and "Lit".
b. POST PowerControl
{ "Action": "PowerControl", "ControlType": "On }
Valid ControlType values are “Off” and “On”.
c. PATCH Power
{ "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. POST PowerButton
{ "Action": "PowerButton", “PushType”: “” }
Valid PushType values are "Press" and "PressAndHold". "PressAndHold" unconditionally removes power from the node. "Press" (when the node is off) sends a power on signal to the node. "Press" (when the node is on) sends a power off signal the node. This requires a running OS for a response.
b. POST Reset
{ "Action": "Reset", "ResetType": "" }
Valid ResetType values are "On", "Off", "Reset", "ColdReset", and "GracefulShutdown". "ResetType": "On" changes the power state of the node to "On". "ResetType": "Off" forces the power state of the node to "Off". "ResetType": " GracefulShutdown " changes the power state of the node to "Off" based on the OS services running on the node. "ResetType": "Reset" and "ResetType": "ColdReset" forces the power state of the node to "Off" and then back to "On".
c. PATCH BSC
{ "Oem": {
"Hp": {
"Options": {
"BSC": "Enable"
}
} } }
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. PATCH BootSourceOverride
{ "Boot": {
"BootSourceOverrideEnabled": "Once",
"BootSourceOverrideTarget": "M.2" } }
The list of valid targets for "BootSourceOverrideTarget" is listed in "BootSourceOverrideSupported".
22. /rest/v1/Systems/CxNy/Logs/IML
a. POST ClearLog
{ "Action": "ClearLog" }
This action clears the Integrated Management Log of any entries related to the node (CxNy).

Resource Map

This section documents the resource map. Not all resources will be present in all implementations and the resource model may expand in future versions of the firmware. The root resource is /rest/v1.
/rest/v1
/rest/v1/AccountService AccountService HTTP Allow: GET, PATCH
/rest/v1/AccountService/Accounts Collection HTTP Allow: GET, POST
/rest/v1/AccountService/Accounts/{item} ManagerAccount HTTP Allow: GET, PATCH, POST, DELETE
/rest/v1/Chassis
/rest/v1/Chassis/{item} Chassis HTTP Allow: GET, PATCH, POST
/rest/v1/Chassis/{item}/Cartridges Collection HTTP Allow: GET
/rest/v1/Chassis/{item}/Cartridges/{item} HpMoonshotCartridge HTTP Allow: GET, PATCH, POST
ServiceRoot HTTP Allow: GET
Links to other resources to resource URI to resource Type
/Oem/Hp/links/Systems /links/AccountService /rest/v1/AccountService AccountService /links/Chassis /rest/v1/Chassis Collection /links/Managers /rest/v1/Managers Collection /links/Registries /rest/v1/Registries Collection /links/Schemas /rest/v1/Schemas Collection /links/Sessions /rest/v1/Sessions Collection /links/Systems /rest/v1/Systems Collection
Links to other resources to resource URI to resource Type
/links/Accounts
Links to other resources to resource URI to resource Type
/links/Member[]
Links to other resources to resource URI to resource Type
Collection HTTP Allow: GET
Links to other resources to resource URI to resource Type
/links/Member[]
Links to other resources to resource URI to resource Type
/Oem/Hp/links/Cartridges /Oem/Hp/links/ChassisFirmwareSummary /rest/v1/Chassis/{item}/ChassisFirmwareSummary ChassisFirmwareSummary /Oem/Hp/links/ChassisSummary /rest/v1/Chassis/{item}/ChassisSummary ChassisSummary /Oem/Hp/links/Switches /rest/v1/Chassis/{item}/Switches Collection /links/LogService /rest/v1/Chassis/{item}/Logs/IML HpMoonshotLogService /links/ManagedBy[] /rest/v1/Managers/{item} Manager /links/PowerMetrics /rest/v1/Chassis/{item}/PowerMetrics HpMoonshotPower /links/ThermalMetrics /rest/v1/Chassis/{item}/ThermalMetrics ThermalMetrics
Links to other resources to resource URI to resource Type
/links/Member[]
/rest/v1/SystemsSummary SystemsSummary
/rest/v1/AccountService/Accounts Collection
/rest/v1/AccountService/Accounts/{item} ManagerAccount
/rest/v1/Chassis/{item} Chassis
/rest/v1/Chassis/{item}/Cartridges Collection
/rest/v1/Chassis/{item}/Cartridges/{item} HpMoonshotCartridge
Links to other resources to resource URI to resource Type
/links/EthernetNICs /rest/v1/Managers/{item}/NICs Collection
/links/ComputerSystems[] /links/LogService /rest/v1/Chassis/{item}/Cartridges/{item}/Logs/IML HpMoonshotLogService /links/ManagedBy[] /rest/v1/Managers/{item} Manager /links/ThermalMetrics /rest/v1/Chassis/{item}/Cartridges/{item}/ThermalMetrics ThermalMetrics
/rest/v1/Chassis/{item}/Cartridges/{item}/Logs/IML HpMoonshotLogService HTTP Allow: GET, PATCH, POST
Links to other resources to resource URI to resource Type
/rest/v1/Chassis/{item}/Cartridges/{item}/ThermalMetrics
/rest/v1/Chassis/{item}/ChassisFirmwareSummary
/rest/v1/Chassis/{item}/ChassisSummary
/rest/v1/Chassis/{item}/Logs/IML
/rest/v1/Chassis/{item}/PowerMetrics
/rest/v1/Chassis/{item}/Switches
/rest/v1/Chassis/{item}/Switches/{item} HpMoonshotSwitch HTTP Allow: GET, PATCH, POST
/rest/v1/Chassis/{item}/Switches/{item}/Logs/IML HpMoonshotLogService HTTP Allow: GET, PATCH, POST
/rest/v1/Chassis/{item}/Switches/{item}/ThermalMetrics
/rest/v1/Chassis/{item}/ThermalMetrics
/rest/v1/Managers
/rest/v1/Managers/{item} Manager HTTP Allow: GET, POST
ThermalMetrics HTTP Allow: GET
Links to other resources to resource URI to resource Type
ChassisFirmwareSummary HTTP Allow: GET
Links to other resources to resource URI to resource Type
ChassisSummary HTTP Allow: GET
Links to other resources to resource URI to resource Type
HpMoonshotLogService HTTP Allow: GET, PATCH, POST
Links to other resources to resource URI to resource Type
HpMoonshotPower HTTP Allow: GET, PATCH
Links to other resources to resource URI to resource Type
Collection HTTP Allow: GET
Links to other resources to resource URI to resource Type
/links/Member[]
Links to other resources to resource URI to resource Type
/links/LogService /links/ManagedBy[] /rest/v1/Managers/{item} Manager /links/ThermalMetrics /rest/v1/Chassis/{item}/Switches/{item}/ThermalMetrics ThermalMetrics
Links to other resources to resource URI to resource Type
ThermalMetrics HTTP Allow: GET
Links to other resources to resource URI to resource Type
ThermalMetrics HTTP Allow: GET
Links to other resources to resource URI to resource Type
Collection HTTP Allow: GET
Links to other resources to resource URI to resource Type
/links/Member[]
Links to other resources to resource URI to resource Type
/Oem/Hp/links/DateTime /Oem/Hp/links/LicenseService /rest/v1/Managers/{item}/LicenseService Collection /Oem/Hp/links/LogService[] /rest/v1/Managers/{item}/Logs/IML HpMoonshotLogService /Oem/Hp/links/RepositoryService /rest/v1/Managers/{item}/RepositoryService ManagerRepositoryService /Oem/Hp/links/UpdateService /rest/v1/Managers/{item}/UpdateService ManagerUpdateService
/rest/v1/Systems/{item} ComputerSystem
/rest/v1/Chassis/{item}/Switches/{item} HpMoonshotSwitch
/rest/v1/Chassis/{item}/Switches/{item}/Logs/IML HpMoonshotLogService
/rest/v1/Managers/{item} Manager
/rest/v1/Managers/{item}/DateTime HpiLODateTime
/links/NetworkService /rest/v1/Managers/{item}/NetworkService ManagerNetworkService
/rest/v1/Managers/{item}/DateTime HpiLODateTime HTTP Allow: GET, PATCH
Links to other resources to resource URI to resource Type
/links/EthernetNICs
/rest/v1/Managers/{item}/NICs Collection
/rest/v1/Managers/{item}/LicenseService Collection HTTP Allow: GET, POST
Links to other resources to resource URI to resource Type
/links/Member[]
/rest/v1/Managers/{item}/LicenseService/{item} HpiLOLicense
/rest/v1/Managers/{item}/LicenseService/{item} HpiLOLicense HTTP Allow: GET, DELETE
Links to other resources to resource URI to resource Type
/rest/v1/Managers/{item}/Logs/IML
HpMoonshotLogService HTTP Allow: GET, PATCH, POST
Links to other resources to resource URI to resource Type
/rest/v1/Managers/{item}/NICs
Collection HTTP Allow: GET
Links to other resources to resource URI to resource Type
/links/Member[]
/rest/v1/Managers/{item}/NICs/{item} EthernetNetworkInterface
/rest/v1/Managers/{item}/NICs/{item} EthernetNetworkInterface HTTP Allow: GET, PATCH
Links to other resources to resource URI to resource Type
/links/NetworkServices[]
/rest/v1/Managers/{item}/NetworkService ManagerNetworkService
/rest/v1/Managers/{item}/NetworkService ManagerNetworkService HTTP Allow: GET, PATCH
Links to other resources to resource URI to resource Type
/Oem/Hp/links/EthernetNICs
/rest/v1/Managers/{item}/NICs Collection
/rest/v1/Managers/{item}/RepositoryService ManagerRepositoryService HTTP Allow: GET, PATCH, POST
Links to other resources to resource URI to resource Type
/rest/v1/Managers/{item}/UpdateService
ManagerUpdateService HTTP Allow: GET, PATCH, POST
Links to other resources to resource URI to resource Type
/rest/v1/Registries
Collection HTTP Allow: GET
Links to other resources to resource URI to resource Type
/links/Member[]
/rest/v1/Registries/{item} SchemaFile
/rest/v1/Registries/{item} SchemaFile HTTP Allow: GET
Links to other resources to resource URI to resource Type
/rest/v1/Schemas
Collection HTTP Allow: GET
Links to other resources to resource URI to resource Type
/links/Member[]
/rest/v1/Schemas/{item} SchemaFile
/rest/v1/Schemas/{item} SchemaFile HTTP Allow: GET
Links to other resources to resource URI to resource Type
/rest/v1/Sessions
Collection HTTP Allow: GET, POST
Links to other resources to resource URI to resource Type
/Oem/Hp/links/MySession
/rest/v1/Sessions/{item} Session
/links/Member[] /rest/v1/Sessions/{item} Session
/rest/v1/Sessions/{item} Session HTTP Allow: GET, DELETE
Links to other resources to resource URI to resource Type
/rest/v1/Systems
Collection HTTP Allow: GET
MoonshotCM_Data_Model_Reference_edit2.html[10/29/2014 1:09:23 AM]
Links to other resources to resource URI to resource Type
/links/Member[]
/rest/v1/Systems/{item} ComputerSystem HTTP Allow: GET, PATCH, POST
Links to other resources to resource URI to resource Type
/links/Chassis[] /links/LogService /rest/v1/Systems/{item}/Logs/IML HpMoonshotLogService /links/ManagedBy[] /rest/v1/Managers/{item} Manager
/rest/v1/Systems/{item}/Logs/IML HpMoonshotLogService HTTP Allow: GET, PATCH, POST
Links to other resources to resource URI to resource Type
/rest/v1/SystemsSummary
SystemsSummary HTTP Allow: GET
Links to other resources to resource URI to resource Type
/rest/v1/Systems/{item} ComputerSystem
/rest/v1/Chassis/{item} Chassis

Data Model Type Reference

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

"AccountService" Resource Type

Resource Instances
/rest/v1/AccountService
See Resource Map for more details.
This is the schema definition for
"AuthFailureLoggingThreshold"
You may create an iLO account by building a request JSON object of type
POST {"UserName": "VirtualMediaPriv": true,
"newuser"}}}
"AccountService"
defines the following properties specified in JSON-pointer syntax
the Account service. It represents the properties for this service and has links to the list of accounts.
may be PATCHed to the values 0, 1, 2, 3, or 5. The value of 4 is not supported by
ManagerAccount and POSTing it to the Collection pointed to by the "Accounts" link. For Example:
"newuser", "Password": "newpassword", "Oem": {"Hp": {"Privileges": {"RemoteConsolePriv": true,
"UserConfigPriv": true, "iLOConfigPriv": true, "VirtualPowerAndResetPriv": true}, "LoginName":
iLO
4.
"Oem/Hp/AuthFailureLoggingThreshold"
This property is a member of AccountService
This property enables you to view and configure logging criteria for failed authentications. A failed login log entry is recorded after the configured number of attempts. 0 = feature disabled; 1­3 and 5 are allowable values.
JSON type:
HTTP Operations
Integer
GET Rendered if supported by the implementation or omitted if not. PATCH This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.
PATCH Example
HTTP PATCH to resource with request JSON:
{"Oem": {"Hp": {"AuthFailureLoggingThreshold": <integer-value>}}}
The property "Oem/Hp/AuthFailureLoggingThreshold" on resource type
ExtendedError. Multiple properties may be included in a single HTTP PATCH operation as long as the request is properly formatted JSON. To address an array entry other than the first, insert
nulls as placeholders on skipped array entries.
AccountService may not support PATCH of all values and may result in an HTTP 400 error with response of Type
"Oem/Hp/MinPasswordLength"
This property is a member of AccountService
This property specifies the minimum number of characters allowed when a user password is set or changed. It must be a value from 0 to 39.
JSON type: Integer from 0 to 39.
HTTP Operations
GET Rendered if supported by the implementation or omitted if not. PATCH This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.
PATCH Example
HTTP PATCH to resource with request JSON:
{"Oem": {"Hp": {"MinPasswordLength": <integer-value>}}}
The property "Oem/Hp/MinPasswordLength" on resource type Multiple properties may be included in a single HTTP PATCH operation as long as the request is properly formatted JSON. To address an array entry other than the first, insert nulls as placeholders on skipped array entries.
AccountService may not support PATCH of all values and may result in an HTTP 400 error with response of Type ExtendedError.

"Chassis" Resource Type

Resource Instances
/rest/v1/Chassis/{item}
See Resource Map for more details.
The schema definition for the Chassis resource. It represents the properties for physical components for any system. This object represents racks, rackmount servers, blades, standalone, modular systems, enclosures, and all other containers. The non-CPU/device-centric parts of the schema are accessed either directly or indirectly through this resource.
Chassis resources are members of the Chassis collection at /rest/v1/Chassis. Each Chassis contains an OEM section with HP-specific properties.
"Chassis" defines the following properties specified in JSON-pointer syntax
"AssetTag"
MoonshotCM_Data_Model_Reference_edit2.html[10/29/2014 1:09:23 AM]
This property is a member of Chassis
This is a user-assigned asset tag for the chassis.
JSON type: String
HTTP Operations
GET Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request. PATCH This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.
PATCH Example
HTTP PATCH to resource with request JSON:
{"AssetTag": "<string-value>"}
The property "AssetTag" on resource type
Chassis may not support PATCH of all values and may result in an HTTP 400 error with response of Type ExtendedError. Multiple properties may be
included in a single HTTP PATCH operation as long as the request is properly formatted JSON. To address an array entry other than the first, insert nulls as placeholders on skipped array entries.
"ChassisType"
This property is a member of Chassis
This property indicates the type of physical form factor of this resource.
JSON type: String containing one of the following supported values:
"Rack"
"Blade" "Enclosure" "StandAlone" "RackMount" "Card" "Cartridge" "Row" "Pod" "Expansion" "Sidecar" "Zone" "Sled" "Shelf" "Other"
HTTP Operations
GET Rendered if supported by the implementation or omitted if not.
MoonshotCM_Data_Model_Reference_edit2.html[10/29/2014 1:09:23 AM]
"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 Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request. PATCH This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.
PATCH Example
HTTP PATCH to resource with request JSON:
{"IndicatorLED": "Lit"}
The property "IndicatorLED" on resource type be included in a single HTTP PATCH operation as long as the request is properly formatted JSON. To address an array entry other than the first, insert nulls as placeholders on skipped array entries.
Chassis may not support PATCH of all values and may result in an HTTP 400 error with response of Type ExtendedError. Multiple properties may
"Manufacturer"
This property is a member of Chassis
This is the manufacturer of this chassis.
JSON type: String
HTTP Operations
GET Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.
"Model"
This property is a member of Chassis
This is the model number for the chassis.
JSON type: String
HTTP Operations
GET Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.
MoonshotCM_Data_Model_Reference_edit2.html[10/29/2014 1:09:23 AM]
"Oem/Hp/AutoPowerOn"
This property is a member of Chassis
Auto Power On
JSON type: String containing one of the following supported values:
"On"
"Off"
HTTP Operations
GET Rendered if supported by the implementation or omitted if not. PATCH This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.
PATCH Example
HTTP PATCH to resource with request JSON:
{"Oem": {"Hp": {"AutoPowerOn": "Off"}}}
The property "Oem/Hp/AutoPowerOn" on resource type properties may be included in a single HTTP PATCH operation as long as the request is properly formatted JSON. To address an array entry other than the first, insert nulls as placeholders on skipped array entries.
Chassis may not support PATCH of all values and may result in an HTTP 400 error with response of Type ExtendedError. Multiple
"Oem/Hp/BaseFru[]/MfgDateTime"
This property is a member of Chassis
JSON type: String
HTTP Operations
GET Rendered if supported by the implementation or omitted if not.
"Oem/Hp/BaseFru[]/ProductName"
This property is a member of Chassis
JSON type: String
HTTP Operations
GET Rendered if supported by the implementation or omitted if not.
"Oem/Hp/BaseFru[]/SparePartNumber"
This property is a member of Chassis
MoonshotCM_Data_Model_Reference_edit2.html[10/29/2014 1:09:23 AM]
JSON type: String
HTTP Operations
GET Rendered if supported by the implementation or omitted if not.
"Oem/Hp/BayNumber"
This property is a member of Chassis
Position of the chassis inside an enclosure.
JSON type: Integer greater than or equal to 0.
HTTP Operations
GET Rendered if supported by the implementation or omitted if not.
"Oem/Hp/ChassisManager[]/IP"
This property is a member of Chassis
JSON type: String
HTTP Operations
GET Rendered if supported by the implementation or omitted if not.
"Oem/Hp/ChassisManager[]/MAC"
This property is a member of Chassis
JSON type: String
HTTP Operations
GET Rendered if supported by the implementation or omitted if not.
"Oem/Hp/ChassisManager[]/SubnetMask"
This property is a member of Chassis
JSON type: String
HTTP Operations
GET Rendered if supported by the implementation or omitted if not.
"Oem/Hp/CliVersion"
MoonshotCM_Data_Model_Reference_edit2.html[10/29/2014 1:09:23 AM]
This property is a member of Chassis
CLI Version
JSON type: String
HTTP Operations
GET Rendered if supported by the implementation or omitted if not.
"Oem/Hp/Firmware/ChassisFirmware/Current/VersionString"
This property is a member of Chassis
JSON type: String
HTTP Operations
GET Rendered if supported by the implementation or omitted if not.
"Oem/Hp/Firmware/ChassisFirmwareFrontDisplayPLD/Current/VersionString"
This property is a member of Chassis
JSON type: String
HTTP Operations
GET Rendered if supported by the implementation or omitted if not.
"Oem/Hp/Firmware/ChassisFirmwarePLD/Current/VersionString"
This property is a member of Chassis
JSON type: String
HTTP Operations
GET Rendered if supported by the implementation or omitted if not.
"Oem/Hp/Firmware/ChassisManagementFirmware/Current/VersionString"
This property is a member of Chassis
JSON type: String
HTTP Operations
GET Rendered if supported by the implementation or omitted if not.
MoonshotCM_Data_Model_Reference_edit2.html[10/29/2014 1:09:23 AM]
"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.
"Oem/Hp/Location/LocationInRack/RackLdsPartNumber"
This property is a member of Chassis
Part number of the chassis rack.
JSON type: String
HTTP Operations
GET Rendered if supported by the implementation or omitted if not.
"Oem/Hp/Location/LocationInRack/RackLdsProductDescription"
This property is a member of Chassis
Product description of the chassis rack.
JSON type: String
HTTP Operations
GET Rendered if supported by the implementation or omitted if not.
"Oem/Hp/Location/LocationInRack/RackUHeight"
This property is a member of Chassis
U height of the chassis rack.
MoonshotCM_Data_Model_Reference_edit2.html[10/29/2014 1:09:23 AM]
JSON type: Integer greater than or equal to 0.
HTTP Operations
HTTP Operations
GET Rendered if supported by the implementation or omitted if not.
"Oem/Hp/Location/LocationInRack/RackUUID"
This property is a member of Chassis
UUID of the chassis rack.
JSON type: String
HTTP Operations
GET Rendered if supported by the implementation or omitted if not.
"Oem/Hp/Location/LocationInRack/TagVersion"
This property is a member of Chassis
Tag version of the chassis rack.
JSON type: Integer greater than or equal to 0.
HTTP Operations
GET Rendered if supported by the implementation or omitted if not.
"Oem/Hp/Location/LocationInRack/ULocation"
This property is a member of Chassis
U location of the chassis rack.
JSON type: String
HTTP Operations
GET Rendered if supported by the implementation or omitted if not.
"Oem/Hp/Location/LocationInRack/UPosition"
This property is a member of Chassis
U position of the chassis in the rack.
JSON type: Integer greater than or equal to 0.
MoonshotCM_Data_Model_Reference_edit2.html[10/29/2014 1:09:23 AM]
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. The value of this property may also be null if it is unavailable at the time of the request.
"SKU"
This property is a member of Chassis
This is the SKU of the chassis.
JSON type: String
HTTP Operations
GET Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request. PATCH This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.
PATCH Example
HTTP PATCH to resource with request JSON:
{"SKU": "<string-value>"}
The property "SKU" on resource type included in a single HTTP PATCH operation as long as the request is properly formatted JSON. To address an array entry other than the first, insert nulls as placeholders on skipped array entries.
Chassis may not support PATCH of all values and may result in an HTTP 400 error with response of Type ExtendedError. Multiple properties may be
"SerialNumber"
MoonshotCM_Data_Model_Reference_edit2.html[10/29/2014 1:09:23 AM]
This property is a member of Chassis
This is the serial number of the chassis.
JSON type: String
HTTP Operations
GET Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request. PATCH This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.
PATCH Example
HTTP PATCH to resource with request JSON:
{"SerialNumber": "<string-value>"}
The property "SerialNumber" on resource type
Chassis may not support PATCH of all values and may result in an HTTP 400 error with response of Type ExtendedError. Multiple properties
may be included in a single HTTP PATCH operation as long as the request is properly formatted JSON. To address an array entry other than the first, insert nulls as placeholders on skipped array entries.
"Status/Health"
This property is a member of Chassis
Indicates the health state of this resource without considering its dependent resources.
JSON type: String containing one of the following supported values:
"OK"
"Warning" "Critical"
HTTP Operations
GET Rendered if supported by the implementation or omitted if not.
"Status/HealthRollUp"
This property is a member of Chassis
Indicates the overall health state of this resource and its dependent resources.
JSON type: String containing one of the following supported values:
"OK"
"Warning" "Critical"
HTTP Operations
MoonshotCM_Data_Model_Reference_edit2.html[10/29/2014 1:09:23 AM]
GET Rendered if supported by the implementation or omitted if not.
"Status/State"
This property is a member of Chassis
Indicates the known state of this resource (for example, if the resource is enabled). Enabled indicates that the resource is available. Disabled indicates that the resource has been made unavailable intentionally, but it can be enabled. Offline indicates that the resource is unavailable intentionally and requires action to be made available. InTest indicates that the component is undergoing testing. Starting indicates that the resource is on its way to becoming available. Absent indicates that the resource is physically unavailable.
JSON type: String containing one of the following supported values:
"Critical"
"Enabled" "Disabled" "Offline" "InTest" "Starting" "Absent" "Uninitialized" "OK" "Not Installed" "Failed" "Degraded" "Removed" "Redundant" "Not Redundant" "Insufficient to Operate"
HTTP Operations
GET Rendered if supported by the implementation or omitted if not.
"Version"
This property is a member of Chassis
This is the version of the chassis.
JSON type: String
HTTP Operations
GET Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.
POST Action "SetAssetTag"
Parameter "Target"
MoonshotCM_Data_Model_Reference_edit2.html[10/29/2014 1:09:23 AM]
Loading...
+ 191 hidden pages
Buy Points How it Works FAQ Contact Us Questions and Suggestions Privacy Policy Cookie Policy Terms of Use