Introduction
The iLO Amplifier Pack RESTful API is a programming interface enabling state-of-the-art server management. This document contains helpful information about how to interact with the iLO Amplifier Pack RESTful API. The iLO Amplifier Pack RESTful API uses basic HTTP operations (GET, PUT, POST, DELETE, and PATCH) to submit or return a JSON formatted resource to or from a URI on iLO Amplifier Pack.
With modern scripting languages, you can easily write simple REST clients for RESTful APIs. Most languages, like Python, can transform JSON into internal-data structures, like dictionaries, allowing for easy access to data. This enables you to write custom code directly to the iLO Amplifier Pack RESTful API.
Redfish Compliance
iLO Amplifier Pack implements the RESTful API as per Redfish Scalable Platforms API specification v1.4.0 DSP0266.
RESTful APIs Architected Using Redfish®
The Redfish® Scalable Platforms Management API ("Redfish") is a standard that uses RESTful interface semantics to access data defined in model format to perform systems management. It is suitable for a wide range of servers, from stand-alone servers to rack mount and bladed environments, but it also scales equally well for large scale server environments.
The Redfish® standard API is designed to deliver simple and secure management for converged, hybrid IT and the Software Defined Data Center (SDDC). Both human readable and machine capable, Redfish leverages common Internet and web services standards to expose information directly to the modern tool chain.
Key benefits of the iLO Amplifier Pack RESTful API
- Based on Redfish APIs which provides an interface using JSON Payload and Entity Data Model.
- Separation of protocol from the data model.
- Leverages the strength of Internet Protocol standards such as JSON, HTTP, OData, etc.
- Aggregated access of basic and detailed inventory of servers managed by iLO Amplifier Pack.
- Simplifies permforming actions on multiple servers and federation groups.
- Simplifies update management tasks on multiple servers.
Getting Started
Tips for Using the RESTful API
The RESTful API for HPE iLO Amplifier Pack is available on version 1.25 or later.
To access the RESTful API, you need an HTTPS-capable client, such as a web browser with a REST Client plugin extension, or a Desktop REST Client application (such as Postman), or cURL (a popular command line HTTP utility).
Using RESTful Interface with cURL and Python
The Python Redfish library is a generic Redfish client library developed by DMTF and is available at https://github.com/DMTF/python-redfish-library. It's main purpose is to simplify the communication to any RESTful API. REST (Representational State Transfer) is a web based software architectural style consisting of a set of constraints that focus on a system's resource. The Redfish library performs the basic HTTP operations GET, POST, PUT, PATCH and DELETE on resources using the HATEOS (Hypermedia as the Engine of Application State) REST architecture. Most API's allow the clients to manage and interact with a fixed URL and several URIs.
cURL is a command line utility available for many Operating Systems that enables easy access to the RESTful API. cURL is available at http://curl.haxx.se/. Note that all the cURL examples will use a flag -insecure
. This causes cURL to bypass validation of the HTTPS certificate. In actual usage, iLO Amplifier Pack should be configured to use a user-supplied certificate and this option is not necessary. Notice also that we use the -L
option to force cURL to follow HTTP redirect responses. If iLO Amplifier Pack changes URI locations for various items, it can indicate to the client where the new location is and automatically follow the new link.
Example REST API operation with cURL and Python
$ curl https://{iLOAmpServer}/redfish/v1/ -i --insecure -L
# Perform GET operation against a resource at /redfish/v1
import sys
import redfish
# Specify the remote iLO Amp address
login_host = "https://{iLOAmpServer}"
# Create a REDFISH object
REDFISH_OBJ = redfish.redfish_client(base_url=login_host)
# Do a GET on service root resource
response = REDFISH_OBJ.get("/redfish/v1")
# Print out the response
sys.stdout.write("%s\n" % response)
The above command (or program) returns HTTP response headers and a JSON response body structured like this:
HTTP/1.1 200 OK
Date: Tue, 17 Apr 2018 05:33:52 GMT
Server: Apache
Allow: GET, HEAD
OData-Version: 4.0
Link: </json/schema/ServiceRoot.json>; rel=describedby
ETag: W/"4A1C99B7"
Content-Length: 1254
X-Frame-Options: sameorigin
Set-Cookie: HttpOnly;Secure
Content-Type: application/json
{
"@odata.context": "/redfish/v1/$metadata#ServiceRoot.ServiceRoot",
"@odata.etag": "W/\"4A1C99B7\"",
"@odata.id": "/redfish/v1",
"@odata.type": "#ServiceRoot.v1_1_1.ServiceRoot",
"AccountService": {
"@odata.id": "/redfish/v1/AccountService"
},
"Chassis": {
"@odata.id": "/redfish/v1/Chassis"
},
"Id": "v1",
"JsonSchemas": {
"@odata.id": "/redfish/v1/Schemas"
},
"Links": {
"Sessions": {
"@odata.id": "/redfish/v1/SessionService/Sessions"
}
},
"Managers": {
"@odata.id": "/redfish/v1/Managers"
},
"Name": "HPE RESTful Root Service",
"Oem": {
"Hpe": {
"@odata.etag": "W/\"8D7A95D7\"",
"@odata.type": "#HpeWfmServiceExt.v1_1_0.HpeWfmServiceExt",
"Links": {
"AggregatorService": {
"@odata.id": "/redfish/v1/AggregatorService"
}
},
"Manager": [
{
"ManagerFirmwareVersion": "1.25",
"ManagerFirmwareVersionPass": "8",
"Model": "iLO Amplifier Pack"
}
],
"Sessions": {
"LoginHint": {
"Hint": "POST to /SessionService/Sessions to login using the following JSON object:",
"HintPOSTData": {
"Password": "password",
"UserName": "username"
}
}
}
}
},
"RedfishVersion": "1.0.1",
"Registries": {
"@odata.id": "/redfish/v1/Registries"
},
"SessionService": {
"@odata.id": "/redfish/v1/SessionService"
},
"Systems": {
"@odata.id": "/redfish/v1/Systems"
},
"Tasks": {
"@odata.id": "/redfish/v1/TaskService"
},
"UUID": "00000000-0000-6e2d-e5a8-000000000000"
}
Let's perform our first GET operation using the RESTful API. We will do an HTTP GET on the iLO Amplifier Pack HTTPS port 443. Your client should be prepared to handle the HTTPS certificate challenge. The interface is not available over open HTTP (port 80), so you must use HTTPS.
Our GET operation will be against a resource at /redfish/v1/
(with a trailing slash):
It is best to perform this initial GET with a tool like CURL or the Postman REST Client tool. Later you will want to do this with your own scripting code. The options used with the CURL command are:
-i
returns HTTP response headers--insecure
bypasses TLS/SSL certification verification-L
follows HTTP redirect
It's also useful to see the HTTP header information exchanged using a browser or REST Client tool.
In JSON, there is no strong ordering of property names, so iLO Amplifier Pack may return JSON properties in any order. Likewise, iLO Amplifier Pack cannot assume the order of properties in any submitted JSON. This is why the best scripting data structure for a RESTful client is a dictionary: a simple set of unordered key/value pairs. This lack of ordering is also the reason you see embedded structure within objects (objects within objects). This allows us to keep related data together that is more logically organized, aesthetically pleasing to view, and helps avoid property name conflicts or ridiculously long property names. It also allows us to use identical blocks of JSON in many places in the data model, like Status
.
HTTP Resource Operations
Operation | HTTP Command | Description |
---|---|---|
Create | POST resource URI (payload = resource data) | Creates a new resource or invokes a custom action. A synchronous POST returns the newly created resource. |
Read | GET resource URI | Returns the requested resource representation. |
Update | PATCH or PUT resource URI (payload = update data) | Updates an existing resource. You can only PATCH properties that are marked readonly = false in the schema. |
Delete | DELETE resource URI | Deletes the specified resource. |
HTTP Status Return Codes
Return Status | Description |
---|---|
2xx | Successful operation. |
308 | The resource has moved |
400 | Bad Request -- Request is invalid. |
401 | Unauthorized -- Provided credentials are incorrect or is not authorized to perform the operation. |
403 | Forbidden -- The request is hidden for administrators only. |
404 | Not Found -- The specified request or URI could not be found. |
405 | Method Not Allowed -- The requested method is not allowed. |
406 | Not Acceptable -- The requested format is not correct. |
410 | Gone -- The requested URI has been removed. |
429 | Too Many Requests -- Too many requests to the server! Slow down! |
500 | Internal Server Error -- A problem occured within the server. Try again later. |
503 | Service Unavailable -- Temporarily offline for maintenance. Please try again later. |
Navigating the Data Model
Unlike some simple REST services, this API is designed to be implemented on many different management appliances, different models of servers, and other IT infrastructure devices for years to come. These devices may be quite different from one another. For this reason, the API does not specify the URIs to various resources. Do not assume that the BIOS version information is always at a particular URI.
This is more complex for the client, but is necessary to make sure the data model can change to accommodate various future server architectures without requiring specification changes. As an example, if the BIOS version is at /redfish/v1/systems/1/
, and a client assumed it is always there, the client would then break when the interface is implemented on a different type of architecture with many compute nodes, each with its own BIOS version.
The supported stable URIs are those referenced directly in this API reference and include:
- /redfish/v1/
- /redfish/v1/systems/
- /redfish/v1/chassis/
- /redfish/v1/managers/
- /redfish/v1/sessions/
Iterating Collections
curl https://{iLOAmpServer}/redfish/v1/systems/ --insecure -u username:password -L
# Perform GET operation against a resource at /redfish/v1/systems/
import sys
import redfish
# When running remotely connect using the address, account name,
# and password to send https requests
login_host = "https://{iLOAmpServer}"
login_account = "username"
login_password = "password"
## Create a REDFISH object
REDFISH_OBJ = redfish.redfish_client(base_url=login_host, \
username=login_account, \
password=login_password)
# Login into the server and create a session
REDFISH_OBJ.login(auth="session")
# Do a GET on a given path
response = REDFISH_OBJ.get("/redfish/v1/systems/")
# Print out the response
sys.stdout.write("%s\n" % response.text)
# Logout of the current session
REDFISH_OBJ.logout()
The above command (or program) returns the JSON response body as below:
{
"@odata.context" : "/redfish/v1/$metadata#ComputerSystemCollection.ComputerSystemCollection",
"@odata.etag" : "W/\"09FA012B\"",
"@odata.id" : "/redfish/v1/Systems",
"@odata.type" : "#ComputerSystemCollection.ComputerSystemCollection",
"Description" : "System Collection View",
"Id" : "Systems",
"Members" : [{
"@odata.id" : "/redfish/v1/Systems/E1D8B426"
}, {
"@odata.id" : "/redfish/v1/Systems/E905C3FF"
}, {
"@odata.id" : "/redfish/v1/Systems/EF2BF486"
}
],
"Members@odata.count" : 3,
"Name" : "ComputerSystemCollection"
}
Many operations will require you to locate the resource you wish to use. Most of these resources are members of "collections" (arrays of similar items). The method to find collection members is consistent for compute nodes, chassis, management processors, and many other resources in the data model.
Find a Compute Node
curl https://{iLOAmpServer}/redfish/v1/systems/{item}/ --insecure -u username:password -L
# Perform GET operation against a resource at /redfish/v1/systems/{item}
import sys
import redfish
# When running remotely connect using the address, account name,
# and password to send https requests
login_host = "https://{iLOAmpServer}"
login_account = "username"
login_password = "password"
## Create a REDFISH object
REDFISH_OBJ = redfish.redfish_client(base_url=login_host, \
username=login_account, \
password=login_password)
# Login into the server and create a session
REDFISH_OBJ.login(auth="session")
# Do a GET on a given path
response = REDFISH_OBJ.get("/redfish/v1/systems/{item}/")
# Print out the response
sys.stdout.write("%s\n" % response.text)
# Logout of the current session
REDFISH_OBJ.logout()
JSON response body example:
{
"@odata.context" : "/redfish/v1/$metadata#ComputerSystem.ComputerSystem",
"@odata.etag" : "W/\"404C537A\"",
"@odata.id" : "/redfish/v1/Systems/E1E4C0C1",
"@odata.type" : "#ComputerSystem.v1_3_0.ComputerSystem",
"Description" : "Computer System View",
"EthernetInterfaces" : {
"@odata.id" : "/redfish/v1/Systems/E1E4C0C1/EthernetInterfaces"
},
"HostName" : "ESX-e1e4c0c1e82fbfa4",
"Id" : "E1E4C0C1",
"IndicatorLED" : "Lit",
"Manufacturer" : "HPE",
"Memory" : {
"@odata.id" : "/redfish/v1/Systems/E1E4C0C1/Memory"
},
"MemorySummary" : {
"Status" : {
"Health" : "OK"
},
"TotalSystemMemoryGiB" : 8
},
"Model" : "ProLiant DL160 Gen9",
"Name" : "Computer System",
"PCIeDevices" : {
"@odata.id" : "/redfish/v1/Systems/E1E4C0C1/PCIeDevices"
},
"PowerState" : "Off",
"ProcessorSummary" : {
"Count" : 1,
"Model" : "Intel(R) Xeon(R) CPU E5-2603 v4 @ 1.70GHz",
"Status" : {
"Health" : "OK"
}
},
"Processors" : {
"@odata.id" : "/redfish/v1/Systems/E1E4C0C1/Processors"
},
"SKU" : "830570-B21",
"SerialNumber" : "JBX4TXEARD",
"Status" : {
"Health" : "OK",
"State" : "Enabled"
},
"Storage" : {
"@odata.id" : "/redfish/v1/Systems/E1E4C0C1/Storage"
},
"SystemType" : "Physical",
"UUID" : "00000000-0000-4286-9d93-000000000000"
}
A Compute node represents a logical computer system with attributes such as processors, memory, BIOS, power state, firmware version, etc. To find a compute node GET /redfish/v1/systems/
and iterate the "Members" array in the returned JSON. Each member has a link to a compute node.
Find a compute node by iterating the systems collection at /redfish/v1/systems/
.
Find a Chassis
curl https://{iLOAmpServer}/redfish/v1/chassis/{item}/ --insecure -u username:password -L
# Perform GET operation against a resource at /redfish/v1/chassis/{item}
import sys
import redfish
# When running remotely connect using the address, account name,
# and password to send https requests
login_host = "https://{iLOAmpServer}"
login_account = "username"
login_password = "password"
## Create a REDFISH object
REDFISH_OBJ = redfish.redfish_client(base_url=login_host, \
username=login_account, \
password=login_password)
# Login into the server and create a session
REDFISH_OBJ.login(auth="session")
# Do a GET on a given path
response = REDFISH_OBJ.get("/redfish/v1/chassis/{item}/")
# Print out the response
sys.stdout.write("%s\n" % response.text)
# Logout of the current session
REDFISH_OBJ.logout()
JSON response example:
{
"@odata.context" : "/redfish/v1/$metadata#Chassis.Chassis",
"@odata.etag" : "W/\"A23FA931\"",
"@odata.id" : "/redfish/v1/Chassis/E1E4C0C1",
"@odata.type" : "#Chassis.v1_4_0.Chassis",
"Description" : "Computer System Chassis",
"Id" : "E1E4C0C1",
"IndicatorLED" : "Lit",
"Manufacturer" : "HPE",
"Model" : "ProLiant DL160 Gen9",
"Name" : "Computer System Chassis",
"Power" : {
"@odata.id" : "/redfish/v1/Chassis/E1E4C0C1/Power"
},
"PowerState" : "Off",
"SKU" : "830570-B21",
"SerialNumber" : "JBX4TXEARD",
"Status" : {
"Health" : "OK",
"State" : "Enabled"
},
"Thermal" : {
"@odata.id" : "/redfish/v1/Chassis/E1E4C0C1/Thermal"
}
}
A Chassis represents a physical or virtual container of compute resources with attributes such as FRU information, power supplies, temperature, etc. To find a chassis GET /redfish/v1/chassis
and iterate the "Members" array in the returned JSON. Each member has a link to a chassis.
Find a chassis by iterating the chassis collection at /redfish/v1/chassis/
.
Find the iLO Management Processor
curl https://{iLOAmpPack}/redfish/v1/managers/{item}/ --insecure -u username:password -L
# Perform GET operation against a resource at /redfish/v1/managers/{item}
import sys
import redfish
# When running remotely connect using the address, account name,
# and password to send https requests
login_host = "https://{iLOAmpServer}"
login_account = "username"
login_password = "password"
## Create a REDFISH object
REDFISH_OBJ = redfish.redfish_client(base_url=login_host, \
username=login_account, \
password=login_password)
# Login into the server and create a session
REDFISH_OBJ.login(auth="session")
# Do a GET on a given path
response = REDFISH_OBJ.get("/redfish/v1/managers/{item}/")
# Print out the response
sys.stdout.write("%s\n" % response.text)
# Logout of the current session
REDFISH_OBJ.logout()
JSON response example:
{
"@odata.context" : "/redfish/v1/$metadata#Manager.Manager",
"@odata.etag" : "W/\"BEB98442\"",
"@odata.id" : "/redfish/v1/Managers/E1E4C0C1",
"@odata.type" : "#Manager.v1_3_0.Manager",
"Description" : "Manager View",
"EthernetInterfaces" : {
"@odata.id" : "/redfish/v1/Managers/E1E4C0C1/EthernetInterfaces"
},
"FirmwareVersion" : "iLO 4 v2.53",
"Id" : "E1E4C0C1",
"ManagerType" : "BMC",
"Name" : "Manager",
"UUID" : "00000000-0000-4c8a-a283-000000000000"
}
A Manager represents a management processor (or "BMC") that manages chassis and compute resources. For HPE Gen10 Servers, the manager is iLO 5. Managers contain attributes such as networking state and configuration, management services, security configuration, etc. To find a manager GET /redfish/v1/managers
and iterate the "Members" array in the returned JSON. Each member has a link to a manager.
Find a manager by iterating the manager collection at /redfish/v1/managers/
.
Authentication and Sessions
$ curl https://{iLOAmpServer}/redfish/v1/systems/ -i --insecure -L
# Perform GET operation against a resource at /redfish/v1/systems
import sys
import redfish
# Specify the remote iLO Amp address
login_host = "https://{iLOAmpServer}"
# Create a REDFISH object
REDFISH_OBJ = redfish.redfish_client(base_url=login_host)
# Do a GET on service root resource
response = REDFISH_OBJ.get("/redfish/v1/systems/")
# Print out the response
sys.stdout.write("%s\n" % response)
The following shows the error displayed on
GET /redfish/v1/systems/
when no authentication is attempted:
HTTP/1.1 401 Unauthorized
Date: Wed, 18 Apr 2018 08:26:29 GMT
Server: Apache
ETag: W/"0990574D"
Content-Length: 291
X-Frame-Options: sameorigin
Set-Cookie: HttpOnly;Secure
Connection: close
Content-Type: application/json
{
"@odata.etag" : "W/\"0990574D\"",
"@odata.type" : "#ExtendedInfo.1.0.0.ExtendedInfo",
"error" : {
"@Message.ExtendedInfo" : [{
"@odata.type" : "#Message.1.0.0.Message",
"MessageId" : "Base.1.1.NoValidSession"
}
],
"code" : "Wolfram.1.0.ExtendedInfo",
"message" : "See @Message.ExtendedInfo for more information."
}
}
If you perform an HTTP operation (without providing authentication) on any resource other than the root /redfish/v1/
resource, you will receive an HTTP 401 Unauthorized
error indicating that you don’t have the authentication needed to access the resource.
Basic Authentication
curl https://{iLOAmpServer}/redfish/v1/systems/ --insecure -u username:password -L
# Perform GET operation against a resource at /redfish/v1/systems/
import sys
import redfish
# When running remotely connect using the address, account name,
# and password to send https requests
login_host = "https://{iLOAmpServer}"
login_account = "username"
login_password = "password"
## Create a REDFISH object
REDFISH_OBJ = redfish.redfish_client(base_url=login_host, \
username=login_account, \
password=login_password)
# Login into the server and create a session
REDFISH_OBJ.login(auth="basic")
# Do a GET on a given path
response = REDFISH_OBJ.get("/redfish/v1/systems/")
# Print out the response
sys.stdout.write("%s\n" % response.text)
# Logout of the current session
REDFISH_OBJ.logout()
The above command (or program) returns the JSON response body as below:
{
"@odata.context" : "/redfish/v1/$metadata#ComputerSystemCollection.ComputerSystemCollection",
"@odata.etag" : "W/\"09FA012B\"",
"@odata.id" : "/redfish/v1/Systems",
"@odata.type" : "#ComputerSystemCollection.ComputerSystemCollection",
"Description" : "System Collection View",
"Id" : "Systems",
"Members" : [{
"@odata.id" : "/redfish/v1/Systems/E1D8B426"
}, {
"@odata.id" : "/redfish/v1/Systems/E905C3FF"
}, {
"@odata.id" : "/redfish/v1/Systems/EF2BF486"
}
],
"Members@odata.count" : 3,
"Name" : "ComputerSystemCollection"
}
The RESTful API allows you to use HTTP Basic Authentication using a valid iLO Amplifier Pack user name and password.
Creating and Using Sessions
curl https://{iLOAmpServer}/redfish/v1/SessionService/Sessions/
-X POST
-H "Content-Type: application/json"
--data "@data.json"
--insecure
-i
Contents of data.json file
{ "UserName": "username", "Password": "password" }
# Creating a session
import sys
import redfish
# When running remotely connect using the address, account name,
# and password to send https requests
login_host = "https://{iLOAmpServer}"
login_account = "username"
login_password = "password"
## Create a REDFISH object
REDFISH_OBJ = redfish.redfish_client(base_url=login_host, \
username=login_account, \
password=login_password)
# Login into the server and create a session
REDFISH_OBJ.login(auth="session")
Successful HTTP headers from iLO Amplifier Pack:
HTTP/1.1 201 Created
Date: Wed, 18 Apr 2018 10:05:28 GMT
Server: Apache
Allow: GET, HEAD, POST
OData-Version: 4.0
X-Auth-Token: 4899e7dd7b23d25ec1adefcd92353db76a8cc310d4691797669f9d3b28b818ce
Link: </redfish/v1/SessionService/Sessions/1352958942>; rel=self
Location: https://{iLOAmpServer}/redfish/v1/SessionService/Sessions/1352958942
ETag: W/"822C5474"
Content-Length: 284
X-Frame-Options: sameorigin
Set-Cookie: HttpOnly;Secure
Content-Type: application/json
Successful JSON response body from iLO Amplifier Pack:
{
"@odata.etag" : "W/\"822C5474\"",
"@odata.type" : "#ExtendedInfo.1.0.0.ExtendedInfo",
"error" : {
"@Message.ExtendedInfo" : [{
"@odata.type" : "#Message.1.0.0.Message",
"MessageId" : "Base.1.1.Created"
}
],
"code" : "Wolfram.1.0.ExtendedInfo",
"message" : "See @Message.ExtendedInfo for more information."
}
}
For more complex multi-resource operations, you should log in and establish a session. To log in, iLO Amplifier Pack has a session manager object at the documented URI /redfish/v1/SessionService/Sessions/
. To create a session POST a JSON object to the Session manager:
If the session is created successfully, you receive an HTTP 201 Created
response from iLO Amplifier Pack. There will also be two important HTTP response headers.
X-Auth-Token: Your session token (string). This is a unique string for your login session. It must be included as a header in all subsequent HTTP operations in the session.
Location: The URI of the newly created session resource. iLO Amplifier Pack allocates a new session resource describing your session. This is the URI that you must DELETE against, in order to log out. If you lose this location URI, you can find it by crawling the HREF links in the Sessions collection. Store this URI to facilitate logging out.
The above process is implemented by the login method provided by REDFISH_OBJ of Redfish Python Library. It automatically stores the session key in REDFISH_OBJ.
Using a Session
To use a session, simply include the X-Auth-Token
header supplied by the login response in all REST requests.
If REDFISH_OBJ of Redfish Python Library is used, then the login method automatically caches the session key and it is included in any future calls made using that object.
Log Out of a Session
curl https://{iLOAmpServer}/redfish/v1/SessionService/Sessions/{item}/
-X "DELETE"
-u username:password
--insecure
# Creating and deleting a session
import sys
import redfish
# When running remotely connect using the address, account name,
# and password to send https requests
login_host = "https://{iLOAmpServer}"
login_account = "username"
login_password = "password"
## Create a REDFISH object
REDFISH_OBJ = redfish.redfish_client(base_url=login_host, \
username=login_account, \
password=login_password)
# Login into the server and create a session
REDFISH_OBJ.login(auth="session")
# Logout of the current session
REDFISH_OBJ.logout()
iLO Amplifier Pack supports a limited number of simultaneous sessions. If you do not log out of a session it will expire automatically after a time of inactivity. However, it is good practice to log out when finished with a session.
To log out perform an HTTP DELETE
to the URI that was returned in the "Location" header when you created the session.
If REDFISH_OBJ of Redfish Python Library is used, then the logout method delete's the session using the location URI that was previously cached.
Performing Actions
Example of a system resource advertising an available action:
{
"Actions": {
"#ComputerSystem.Reset": {
"ResetType@Redfish.AllowableValues": [
"On",
"ForceOff",
"ForceRestart",
"Nmi",
"PushPowerButton"
],
"target": "/redfish/v1/Systems/{item}/Actions/ComputerSystem.Reset/"
}
}
}
This action may be invoked by performing:
curl https://{iLOAmpServer}/redfish/v1/Systems/{item}/Actions/ComputerSystem.Reset/
-H "Content-Type: application/json"
-X POST
--data "@data.json"
-u username:password
--insecure
Contents of data.json file
{
"ResetType": "ForceRestart" }
# Performing an action
import sys
import redfish
# When running remotely connect using the address, account name,
# and password to send https requests
login_host = "https://{iLOAmpServer}"
login_account = "username"
login_password = "password"
## Create a REDFISH object
REDFISH_OBJ = redfish.redfish_client(base_url=login_host, \
username=login_account, \
password=login_password)
# Login into the server and create a session
REDFISH_OBJ.login(auth="session")
body = dict()
body["ResetType"] = "ForceRestart"
# Do a GET on a given path
response = REDFISH_OBJ.post("/redfish/v1/systems/{item}/Actions/ComputerSystem.Reset/", body=body)
# Print out the response
sys.stdout.write("%s\n" % response.text)
# Logout of the current session
REDFISH_OBJ.logout()
REST resources usually support HTTP GET to read the current state, and some support modification and removal with HTTP POST, PUT, PATCH, or DELETE.
There are some resources that support other types of operations not easily mapped to HTTP operations. For this reason the Redfish specification defines "Actions". Actions are HTTP POST operations with a specifically formatted JSON request including the operation to perform on any parameters. For instance, it is not enough to simply tell a server to reset, but it is also necessary to specify the type of reset: cold boot, warm boot, PCI reset, etc. Actions are often used when the operation causes iLO Amplifier Pack to not just update a value, but to change the system state.
In Redfish, the available actions that can be invoked are identified by a "target" property in the resource's "Actions" object definitions. The parameters identify the supported values with the annotation @Redfish.AllowableValues.
Actions on HPE-specific Extensions
Example of an extended manager resource advertising an available action:
{
"Oem" : {
"Hpe" : {
"Actions" : {
"#HpeWfmManagerExt.Backup" : {
"target" : "/redfish/v1/Managers/iLOAmplifier/Actions/Oem/Hpe/HpeWfmManagerExt.Backup"
},
"#HpeWfmManagerExt.Restore" : {
"target" : "/redfish/v1/Managers/iLOAmplifier/Actions/Oem/Hpe/HpeWfmManagerExt.Restore"
}
}
}
}
}
This action may be invoked by performing:
curl https://{iLOAmpServer}/redfish/v1/Managers/iLOAmplifier/Actions/Oem/Hpe/HpeWfmManagerExt.Backup/
-H "Content-Type: application/json"
-X POST
--data "@data.json"
-u username:password
--insecure
Contents of data.json file
{
"StorageType" : "USB",
"Password" : "password",
"DestinationPath" : "folder/filename",
"RemovableStorageDeviceName" : "sd1_vol1"
}
# Performing an OEM extended action
import sys
import redfish
# When running remotely connect using the address, account name,
# and password to send https requests
login_host = "https://{iLOAmpServer}"
login_account = "username"
login_password = "password"
## Create a REDFISH object
REDFISH_OBJ = redfish.redfish_client(base_url=login_host, \
username=login_account, \
password=login_password)
# Login into the server and create a session
REDFISH_OBJ.login(auth="session")
body = dict()
body["ResetType"] = "ForceRestart"
body["StorageType"] = "USB"
body["Password"] = "password"
body["DestinationPath"] = "folder/filename"
body["RemovableStorageDeviceName"] = "sd1_vol1"
# Do a GET on a given path
response = REDFISH_OBJ.post("/redfish/v1/Managers/iLOAmplifier/Actions/Oem/Hpe/HpeWfmManagerExt.Backup/", body=body)
# Print out the response
sys.stdout.write("%s\n" % response.text)
# Logout of the current session
REDFISH_OBJ.logout()
The embedded OEM extensions may also have Actions not specified by the Redfish standard. They are invoked in a similar way. The POST URI indicates the HPE specific nature of the action.
RESTful Events and the Event Service
iLO Amplifier Pack now features an event subscription service that enables you to receive notifications when certain alerts occur in the iLOs discovered by iLO Amplifier Pack. These notifications are in the form of HTTPS POST operations to a URI of your choice. The maximum number of subscriptions that can be created is 8.
The event service is located in the data model at /redfish/v1/EventService.
This resource includes
a link to a collection of subscriptions (called EventSubscriptions
located at
/redfish/v1/EventService/EventSubscriptions
).
Modifying EventService ServiceEnabled
POST /redfish/v1/EventService/
A field "ServiceEnabled" is provided at the EventService level, that can be used to stop/start notifications at the configured subscription URIs. If this value is set to TRUE, notifications will be routed to all the subscriptions, else it will be blocked for all subscriptions. It is set to TRUE by default.
{
"ServiceEnabled": false
}
Example POST payload to enable/disable EventService
ServiceEnabled
can be set to true or false based on choice.
Subscribing for Events examples
POST /redfish/v1/EventService/EventSubscriptions/
{
"Destination": "https://myeventreciever/eventreceiver",
"EventTypes": [
"Alert"
],
"Protocol": "Redfish",
"Context": "Context string",
"Description": "Description String",
"HttpHeaders":[
{
"X-Auth-Token":"X-Auth-Token String",
}
],
"Oem" : {
"Hpe" : {
"DeliveryRetryAttempts": 3,
"DeliveryRetryIntervalSeconds": 30,
"NotificationCategory": {
"Administration": true,
"GeneralFailure": true,
"HardwareFailure": true,
"Maintenance": true,
"Other": true,
"Security": true,
"Storage": true
},
"NotificationSeverity": {
"Critical": true,
"Info": true,
"Warning": true
}
}
}
}
In order to receive events, you must provide an HTTPS server accessible to iLO Amplifier Pack's network with a URI you designate as the target for iLO Amplifier Pack initiated HTTPS POST operations.
Construct a JSON object conforming to the type EventDestination
(see example) and
POST this to the collection indicated by the EventSubscriptions
link at
/redfish/v1/EventService/EventSubscriptions.
If you receive an HTTP 201 created
response, a new subscription has been added. Note that iLO Amplifier Pack does not test the destination URI
during this phase, so if the indicated URI is not valid, it will not be flagged until events are
emitted and the connection to the destination fails.
Example POST payload to create a new subscription
Much of the above content depends entirely upon your needs and setup:
Destination
must be an HTTPS URI accessible to iLO Amplifier Pack’s network.EventTypes
can currently only be Alert.HttpHeaders
gives you an opportunity to specify any arbitrary HTTP headers you need for the event POST operation (e.g., X-Auth-Token). This will be a part of the payload during GET of Alerts.Context
may be any string.Description
may be any string.Protocol
must be set to Redfish.DeliveryRetryAttempts
indicates the number of retries that will be made to deliver an alert to a configured destination (In case the destination is not reachable). If a failure is observed even after this, an entry will be made in the iLOAmplifier Alert logs. Default is set to 3. Can be modified to other values.DeliveryRetryIntervalSeconds
indicates the number of seconds before which, each retry will be attempted. Default is set to 30. Can be modified to other values.NotificationCategory
gives you an opportunity to choose a specific category/set of categories for which a notification need to be received. By default all the values are set to true.NotificationSeverity
gives you an opportunity to choose a specific severity/set of severities for which a notification needs to be received. By default all the values are set to true.
Consult the EventDestination
schema for more details on each property.
Submitting a Test Event
POST /redfish/v1/EventService/Actions/EventService.SubmitTestEvent
Once the subscriptions are created, a test event can be posted to test if the subscription is working and you are able to recieve the events via iLO Amplifier Pack.
{
"EventId": "TestEventId",
"EventTimestamp": "2019-07-29T15:13:49Z",
"EventType": "Alert",
"Message": "Test Event",
"MessageArgs": [
"NoAMS",
"Busy",
"Cached"
],
"MessageId": "iLOEvents.2.1.ServerPoweredOff",
"OriginOfCondition": "/redfish/v1/Systems/1/",
"Severity": "OK"
}
Example POST payload to test a subscription
EventId
must be set to string "TestEventId".EventTimestamp
any arbitrary timestamp.EventType
must be set to "Alert".Message
any message string.MessageArgs
array of any set of message arguments.MessageId
any message id string.OriginOfCondition
any arbitrary string.Severity
send it for the one configured while creating the subscription.
Use Cases
This section covers the basic use cases of RESTful APIs provided by iLO Amplifier Pack.
Discovering Servers
The discovery APIs allow users to add assets to manage with iLO Amplifier Pack. These APIs allow users to discover individual servers, servers in iLO Federation groups, servers within an IPv4 range, and servers listed in a CSV file.
Adding a single server
curl https://{iLOAmpServer}//redfish/v1/AggregatorService/ManagedSystems/
-H "Content-Type: application/json"
-X POST
--data "@data.json"
-u username:password
--insecure
Contents of data.json file
{
"ManagerAddress":"{iLOAddress}", "UserName":"{iLOUsername}", "Password":"{iLOPassword}" }
# Discovering a server
import sys
import redfish
import time
# When running remotely connect using the address, account name,
# and password to send https requests
login_host = "https://{iLOAmpServer}"
login_account = "username"
login_password = "password"
## Create a REDFISH object
REDFISH_OBJ = redfish.redfish_client(base_url=login_host, \
username=login_account, \
password=login_password)
# Login into the server and create a session
REDFISH_OBJ.login(auth="session")
body = dict()
body["ManagerAddress"] = "{iLOAddress}"
body["UserName"] = "{iLOUsername}"
body["Password"] = "{iLOPassword}"
# Do a GET on a given path
sys.stdout.write("Adding server %s\n" % body["ManagerAddress"])
response = REDFISH_OBJ.post("/redfish/v1/AggregatorService/ManagedSystems/", body=body)
location = None
slash = 0
if response.status == 201:
location = response.getheader("Location")
if location is None:
sys.stdout.write("Unable to add server\n")
sys.stdout.write("%s\n" % response)
# find the 3rd slash in location
slash = location.find("/", slash)
slash = location.find("/", slash+2)
location = location[slash:]
sys.stdout.write("location: %s\n" % location)
dstate = "InProgress"
while dstate != "Complete":
managed_system = REDFISH_OBJ.get(location)
if managed_system.status != 200:
sys.stdout.write("Unable to get status of discovery\n")
sys.stdout.write("%s\n" % managed_system)
break
dstate = managed_system.dict["SystemSummary"]["Discovery"]["State"]
sys.stdout.write("Discovery %s\n" % dstate)
time.sleep(1)
# Logout of the current session
REDFISH_OBJ.logout()
The /redfish/v1/AggregatorService/ManagedSystems
collection lists all the servers managed by iLO Amplifier Pack. Performing a POST
on this collection adds a server in iLO Amplifier Pack. When POST
is performed on this URI, the response header contains the Location
and Link
of the newly added server. A GET
on the link will retrieve the discovery state of the server. The discovery state of the server can be one of the following:
- NotInitiated
- Processing
- InProgress
- Complete
- NotResponding
- NotReachable
- FirmwareUpdateInProgress
- Discovered
- Refreshing
Viewing the information of a managed server
When a server is added, iLO Amplifier Pack performs a detailed inventory of the server which takes a few seconds. Once the inventory is complete, different server information can be obtained. Performing a GET on the below Redfish APIs obtains the corresponding server information.
Inventory | URI |
---|---|
System Overview | /redfish/v1/Systems/{item} |
CPU Details | /redfish/v1/Systems/{item}/Processor/{item} |
Memory Detials | /redfish/v1/Systems/{item}/Memory/{item} |
PCIe Devices | /redfish/Systems/{item}/PCIeDevices |
Chassis | /redfish/v1/Chassis/{item} |
Fan Details | /redfish/v1/Chassis/{item}/Thermal |
Power Details | /redfish/v1/Chassis/{item}/Power |
Storage | /redfish/v1/Systems/{item}/Storage |
iLO Details | /redfish/v1/Managers/{item} |
Firmware Inventory | /redfish/v1/UpdateService/FirmwareInventory |
Software Inventory | /redfish/v1/UpdateService/SoftwareInventory |
Adding a range of Servers
curl https://{iLOAmpServer}/redfish/v1/AggregatorService/Actions/HpeWfmAggregatorService.DiscoverServersInRange/
-H "Content-Type: application/json"
-X POST
--data "@data.json"
-u username:password
--insecure
Contents of data.json file
{ "StartAddress":"{IP_Address_Range_Start}", "EndAddress":"{IP_Address_Range_End}", "UserName":"username", "Password":"password", "PortNumber":443 }
# Discovering a server
import sys
import redfish
import time
# When running remotely connect using the address, account name,
# and password to send https requests
login_host = "https://{iLOAmpServer}"
login_account = "username"
login_password = "password"
## Create a REDFISH object
REDFISH_OBJ = redfish.redfish_client(base_url=login_host, \
username=login_account, \
password=login_password)
# Login into the server and create a session
REDFISH_OBJ.login(auth="session")
body = dict()
body["StartAddress"] = "{IP_Address_Range_Start}"
body["EndAddress"] = "{IP_Address_Range_End}"
body["PortNumber"] = 443
body["UserName"] = "username"
body["Password"] = "password"
# Do a GET on a given path
sys.stdout.write("Adding servers in range %s to %s\n" % (body["StartAddress"], body["EndAddress"]))
response = REDFISH_OBJ.post("/redfish/v1/AggregatorService/Actions/HpeWfmAggregatorService.DiscoverServersInRange/", body=body)
location = None
slash = 0
if response.status != 202:
sys.stdout.write("Unable to initiate discovering servers in range\n")
sys.stdout.write("%s" % response)
REDFISH_OBJ.logout()
exit()
dstate = "InProgress"
while dstate != "Complete" and dstate != "Successful":
managed_system = REDFISH_OBJ.get("/redfish/v1/AggregatorService/")
if managed_system.status != 200:
sys.stdout.write("Unable to get status of IP range discovery\n")
sys.stdout.write("%s\n" % managed_system)
break
dstate = managed_system.dict["ActionStatus"]["DiscoverServersInRange"]["DiscoveryStatus"]
sys.stdout.write("Discovery %s\n" % dstate)
time.sleep(1)
# Logout of the current session
REDFISH_OBJ.logout()
iLO Amplifier Pack allows users to discover more than one server at a time. Using IP range discovery, iLO Amplifier Pack can discover multiple servers simultaneously. The IP range discovery is advertised as an action on /redfish/v1/AggregatorService
URI.
Once the action is triggered, the IP range discovery is performed as a task by iLO Amplifier Pack. The discovery process can take a while to complete. To know the progress of the discovery status, perform a GET on /redfish/v1/AggregatorService
URI and look at the ActionStatus.DiscoverServersInRange
object. The DiscoveryStatus
field will be set to Complete
once the discovery process is complete.
Performing Jobs
curl https://{iLOAmpServer}/redfish/v1/JobService/Actions/Oem/Hpe/HpeWfmJobServiceExt.RefreshJob/
-H "Content-Type: application/json"
-X POST
--data "@data.json"
-u username:password
--insecure
Contents of data.json file
{ "SelectedSystemsManagerAddress": [ "{Manager1_IP_Address}", "{Manager2_IP_Address}" ] }
# Perform refresh of servers job
import sys
import redfish
import time
# When running remotely connect using the address, account name,
# and password to send https requests
login_host = "https://{iLOAmpServer}"
login_account = "username"
login_password = "password"
## Create a REDFISH object
REDFISH_OBJ = redfish.redfish_client(base_url=login_host, \
username=login_account, \
password=login_password)
# Login into the server and create a session
REDFISH_OBJ.login(auth="session")
body = dict()
sel_sys = body["SelectedSystemsManagerAddress"] = list()
sel_sys.append("{Manager1_IP_Address}")
sel_sys.append("{Manager2_IP_Address}")
# Perform a POST to trigger the action
sys.stdout.write("Refreshing %d servers\n" % (len(body["SelectedSystemsManagerAddress"])))
response = REDFISH_OBJ.post("/redfish/v1/JobService/Actions/Oem/Hpe/HpeWfmJobServiceExt.RefreshJob/", body=body)
location = None
slash = 0
if response.status != 202:
sys.stdout.write("Unable to initiate refresh of servers\n")
sys.stdout.write("%s" % response)
REDFISH_OBJ.logout()
exit()
# Extract the newly created job
refresh_job_uri = response.dict["error"]["@Message.ExtendedInfo"][0]["MessageArgs"][0]
# Check for the job status
dstate = "InProgress"
while dstate != "Completed" and dstate != "Successful":
refresh_job = REDFISH_OBJ.get(refresh_job_uri)
if refresh_job.status != 200:
sys.stdout.write("Unable to get status of refresh job\n")
sys.stdout.write("%s\n" % refresh_job)
break
dstate = refresh_job.dict["JobState"]
sys.stdout.write("Refreshing servers %s\n" % dstate)
time.sleep(1)
# Logout of the current session
REDFISH_OBJ.logout()
iLO Amplifier Pack v1.50 introduces the JobService and Jobs API. Users can create a job by performing a POST
action on the URIs listed in JobService. A Job can be initiated on multiple servers at a time by specifiying the manager address of the systems or by specifying the group name in which case the job will run on the servers in the group. Below are the list of jobs that can be performed.
Jobs | Description |
---|---|
AhsDownloadJobs | Download AHS files from the specified systems |
ApplyConfigurationBaselineJobs | Apply a configuration baseline on specified systems |
AssignRecoveryPolicyJob | Assign a recovery policy for specified systems |
ConfigureRemoteSyslogJobs | Configure remote syslog of the iLO for specified systems |
CreateGroupJobs | Create a federation group on iLO for specified systems |
DeleteCompletedJobs | Delete completed jobs from the appliance |
DeleteJobs | Remove managed systems from the appliance |
DownloadAuditLogsJobs | Download audit logs from the appliance |
DownloadReportJobs | Download report for specified systems |
ExcludeServersFromInfoSight | Exclude systems from sending data to HPE InfoSight |
ImportBaselineJobs | Import a firmware basline into the appliance |
ImportConfigurationBaselineJobs | Import a configuration baseline from a system |
ImportOSBaselineJobs | Import an OS baseline into the appliance |
ManualRecoveryJobs | Initiate a recovery job on selected systems |
OnDemandAhsJobs | Send AHS logs to HPE InfoSight for selected systems |
RefreshJob | Refresh the inventory for selected systems |
ResetSystemJobs | Perform power actions on selected systems |
ServerGroupActionJobs | Perform actions on server groups |
ServerUpdateJobs | Perform fimrware/software update on selected systems |
SetIndicatorLedJobs | Change indicator LED status on selected systems |
SppComplianceJobs | Peform SPP compliance for selected systems |
UnAssignRecoveryPolicyJob | Unassign recovery policy for specified systems |
UpdateFirmwareJobs | Update core platform firmware on selected systems |
VirtualMediaJobs | Mount or unmount virtual media on selected systems |
When any of the above actions are performed, iLO Amplifier Pack creates a Job and the response body of the action specifies the URI for the job. A job may take a while to complete. In order to know the status of the job, perform a GET
on the job URI. The JobState
property in the job resource specifies if the job is completed or not.
Creating a Server Group
curl https://{iLOAmpServer}/redfish/v1/JobService/Actions/Oem/Hpe/HpeWfmJobServiceExt.ServerGroupJobs
-H "Content-Type: application/json"
-X POST
--data "@data.json"
-u admin:admin
--insecure
Contents of data.json file
{
"Name":"{groupName}", "ServerList":"{serversList}", "OperationType":"{operationType}", "GroupDescription":"{groupDescription}" }
import sys
import redfish
# Connect using iLO Amplifier address, username and password
login_host = "https://{iLOAmpServer}"
login_account = "username"
login_password = "password"
# Create a REDFISH object
REDFISH_OBJ = redfish.redfish_client(base_url=login_host, \
username=login_account, \
password=login_password)
# Login into the server and create a session
REDFISH_OBJ.login(auth="session")
body = dict()
body["Name"] = "{GroupName}"
body["ServerList"] = "{ServerList}"
body["OperationType"] = "{CreateGroup}"
body["GroupDescription"] = "{description}"
# Do a POST on a given path
response = REDFISH_OBJ.post("/redfish/v1/JobService/Actions/Oem/Hpe/HpeWfmJobServiceExt.ServerGroupJobs", body=body)
if response.status != 202:
sys.stdout.write("Unable to create server group\n")
sys.stdout.write("%s" % response)
REDFISH_OBJ.logout()
exit()
# Logout of the current session
REDFISH_OBJ.logout()
Performing a GET
operation on the /redfish/v1/AggregatorService/ManagedServerGroups
collection, will list all the Server Groups created in iLO Amplifier Pack.
Prerequisites
Users with the following privileges can create a Server Group:
- Configure Manager with Security
- Configure Manager
- Configure User
- Configure Devices
Performing the Job
To create a new Server Group, perform a POST
operation on the /redfish/v1/JobService/Actions/Oem/Hpe/HpeWfmJobServiceExt.ServerGroupJobs
action, with the folowing properties:
Property | Type | Description |
---|---|---|
GroupDescription | string | The description of the group that is to be created |
Name | string | The name of the group that is to be created |
OperationType | string | The type of operation to be performed on the group. Value for this action will be "CreateGroup" |
ServerList | array | The list of servers to add to the group |
Sample payload is as shown below:
{
"GroupDescription
": "Group1",
"Name"
: "Group1",
"OperationType"
: "CreateGroup",
"ServerList"
: ["123.123.12.12", "123.123.12.15"]
}
When POST
operation is performed on this URI, a job will be created. A GET
operation on the URI /redfish/v1/JobService/Jobs/{jobID}
will retrieve the state of the job created.
When the job has successfully completed, all the groups added can be viewed by performing a GET
operation on the URI /redfish/v1/AggregatorService/ManagedServerGroups
.
Group Actions
curl https://{iLOAmpServer}/redfish/v1/JobService/Actions/Oem/Hpe/HpeWfmJobServiceExt.ServerGroupActionJobs
-H "Content-Type: application/json"
-X POST
--data "@data.json"
-u admin:admin
--insecure
import sys
import redfish
# Connect using iLO Amplifier address, username and password
login_host = "https://{iLOAmpServer}"
login_account = "username"
login_password = "password"
# Create a REDFISH object
REDFISH_OBJ = redfish.redfish_client(base_url=login_host, \
username=login_account, \
password=login_password)
# Login into the server and create a session
REDFISH_OBJ.login(auth="session")
OperationType = "{OperationType}"
body = dict()
body["GroupName"] = "{GroupName}"
body["AllSystemsInGroup"] = "{boolValue}"
body["OperationType"] = OperationType
if OperationType.lower() == "refreshgroup":
body["OperationType"] = "RefreshGroup"
elif OperationType.lower() == "deletegroup":
body["OperationType"] = "DeleteGroup"
elif OperationType.lower() == "uid":
body["IndicatorLED"] = "{IndicatorLED}"
body["OperationType"] = "UID"
elif OperationType.lower() == "power":
body["OperationType"] = "Power"
body["ResetType"] = "{ResetType}"
# Do a POST on a given path
response = REDFISH_OBJ.post("/redfish/v1/JobService/Actions/Oem/Hpe/HpeWfmJobServiceExt.ServerGroupActionJobs", body=body)
if response.status != 202:
sys.stdout.write("Unable to perform server group action\n")
sys.stdout.write("%s" % response)
REDFISH_OBJ.logout()
exit()
sys.stdout.write("Group action job has been created successfully\n")
# Logout of the current session
REDFISH_OBJ.logout()
Prerequisites
Users with the following privileges can perform actions on the Server Group:
- Configure Manager with Security
- Configure Manager
- Configure User
- Configure Devices
Performing the Job
The following actions can be performed on all the servers in a Server Group:
1. Managing UID status
The UID status for all the servers in a Server Group can be changed by performing a POST
operation on the URI redfish/v1/JobService/Actions/Oem/Hpe/HpeWfmJobServiceExt.ServerGroupActionJob
with the following properties:
Property | Type | Description |
---|---|---|
GroupDescription | string | The name of the group on which action is to be performed |
OperationType | string | The action to be performed on the group. Value for this action will be "UID" |
AllSystemsInGroup | boolean | This flag suggests whether all the servers in the group are selected |
IndicatorLED | string | The Indicator State of the UID to which it needs to be changed |
Sample payload is as shown below:
{
"GroupName"
: "Group1",
"OperationType"
: "UID",
"AllSystemsInGroup"
: true,
"IndicatorLED"
: "UID"
}
2. Managing Power Status
The Power status for all the servers in a Server Group can be changed by performing a POST
operation on the URI redfish/v1/JobService/Actions/Oem/Hpe/HpeWfmJobServiceExt.ServerGroupActionJob
with the following properties:
Property | Type | Description |
---|---|---|
GroupName | string | The name of the group on which action is to be performed |
OperationType | string | The action to be performed on the group. Value for this action will be "Power" |
AllSystemsInGroup | boolean | This flag suggests whether all the servers in the group are selected |
ResetType | string | The reset type to be performed for the system |
Sample payload is as shown below:
{
"GroupName"
: "Group1",,
"OperationType"
: "Power",
"AllSystemsInGroup"
: true,
"ResetType"
: "On"
}
3. Refresh
Refresh of all the servers in a Server Group can be performed by a POST
operation on the URI /redfish/v1/JobService/Actions/Oem/Hpe/HpeWfmJobServiceExt.ServerGroupActionJob/
with the following properties:
Property | Type | Description |
---|---|---|
Name | string | The name of the group that is to be created or joined to |
OperationType | string | The action to be performed on the group. Value for this action will be "RefreshGroup" |
AllSystemsInGroup | boolean | This flag suggests whether all the servers in the group are selected |
Sample payload is as shown below:
{
"Name"
: "Group1",
"OperationType"
:"RefreshGroup",
"AllSystemsInGroup"
:true
}
4. Deletion
Deletion of all the servers of a Server Group can be performed by a POST
operation on the URI /redfish/v1/JobService/Actions/Oem/Hpe/HpeWfmJobServiceExt.ServerGroupActionJob/
with the following properties:
Property | Type | Description |
---|---|---|
Name | string | The name of the group that is to be deleted |
OperationType | string | The action to be performed on the group. Value for this action will be "DeleteGroup" |
DeleteServers | boolean | This flag specifies if Servers in the group should be deleted |
Sample payload is as shown below:
{
"Name"
: "Group1",
"OperationType"
:"DeleteGroup",
"DeleteServers"
:true
}
Post Condition:
When POST
operation is performed on the above URIs for different actions, jobs are created. A GET
operation on the URI /redfish/v1/JobService/Jobs/{jobID}/
will retrieve the state of the job created.
The results of these jobs can be checked by performing a GET
operation on /redfish/v1/JobService/Results/ServerGroupActionJobs/{jobID}/1/
Join Server Group
curl https://{iLOAmpServer}/redfish/v1/JobService/Actions/Oem/Hpe/HpeWfmJobServiceExt.ServerGroupJobs
-H "Content-Type: application/json"
-X POST
--data "@data.json"
-u admin:admin
--insecure
Contents of data.json file
{
"Name":"{groupName}", "ServerList":"{serversList}", "OperationType":"{operationType}" }
import sys
import redfish
import time
import json
# Connect using iLO Amplifier address, username and password
login_host = "https://{iLOAmpServer}"
login_account = "username"
login_password = "password"
# Create a REDFISH object
REDFISH_OBJ = redfish.redfish_client(base_url=login_host, \
username=login_account, \
password=login_password)
# Login into the server and create a session
REDFISH_OBJ.login(auth="session")
body = dict()
body["Name"] = "{GroupName}"
body["ServerList"] = "{ServerAddress}"
body["OperationType"] = "{JoinGroup}"
# Do a POST on a given path
response = REDFISH_OBJ.post("/redfish/v1/JobService/Actions/Oem/Hpe/HpeWfmJobServiceExt.ServerGroupJobs", body=body)
errMessage = ""
if response.status != 202:
sys.stdout.write("Unable to join the server into the group\n")
sys.stdout.write("Response %s\n" % response)
REDFISH_OBJ.logout()
exit()
jobCreatedLink = response.getheader("Location")
if jobCreatedLink == None:
jobCreatedLink = response.getheader("Link")
if jobCreatedLink == None:
jobCreatedLink = response.dict['error']['@Message.ExtendedInfo'][0]['MessageArgs'][0]
jobID = jobCreatedLink.split("/")[-1]
sys.stdout.write("Join Server group job has been created successfully\n")
sys.stdout.write("check job status using jobID %s\n" % jobID)
# Logout of the current session
REDFISH_OBJ.logout()
Prerequisites
Users with the following privileges can Join Servers to a Group: * Configure Manager with Security * Configure Manager * Configure User * Configure Devices
Performing the Job:
To add servers to an existing Server Group, perform a POST
operation on the URI /redfish/v1/JobService/Actions/Oem/Hpe/HpeWfmJobServiceExt.ServerGroupJobs/
with the following properties:
Property | Type | Description |
---|---|---|
Name | string | The name of the group that is to be joined to |
OperationType | string | The action to be performed on the group. Value for this action will be "JoinGroup" |
ServerList | array | All the selected servers to join to the group |
Sample payload is as shown below:
{
"Name"
: "Group1",
"OperationType"
:"JoinGroup",
"ServerList"
:["123.123.12.12", "123.123.12.15"]
}
When POST
is performed on this URI, a job will be created. A GET
on the URI /redfish/v1/JobService/Jobs/{jobID}/
will retrieve the state of the job created.
When the Job has successfully completed, the servers that belong to a Server Group can be obtained by doing a GET
operation on the URI /redfish/v1/AggregatorService/ManagedServerGroups/{groupName}/ManagedSystems/Summary/
to check if the servers have been added to the group.
Unjoin Server Group
curl https://{iLOAmpServer}/redfish/v1/JobService/Actions/Oem/Hpe/HpeWfmJobServiceExt.ServerGroupJobs
-H "Content-Type: application/json"
-X POST
--data "@data.json"
-u admin:admin
--insecure
Contents of data.json file
{
"Name":"{groupName}", "ServerList":"{serversList}", "OperationType":"{operationType}" }
import sys
import redfish
import time
import json
# Connect using iLO Amplifier address, username and password
login_host = "https://{iLOAmpServer}"
login_account = "username"
login_password = "password"
# Create a REDFISH object
REDFISH_OBJ = redfish.redfish_client(base_url=login_host, \
username=login_account, \
password=login_password)
# Login into the server and create a session
REDFISH_OBJ.login(auth="session")
body = dict()
body["Name"] = "{GroupName}"
body["ServerList"] = "{ServerAddress}"
body["OperationType"] = "{UnjoinGroup}"
# Do a POST on a given path
response = REDFISH_OBJ.post("/redfish/v1/JobService/Actions/Oem/Hpe/HpeWfmJobServiceExt.ServerGroupJobs", body=body)
errMessage = ""
if response.status != 202:
sys.stdout.write("Unable to unjoin server from group\n")
sys.stdout.write("Response %s\n" % response)
REDFISH_OBJ.logout()
exit()
jobCreatedLink = response.getheader("Location")
if jobCreatedLink == None:
jobCreatedLink = response.getheader("Link")
if jobCreatedLink == None:
jobCreatedLink = response.dict['error']['@Message.ExtendedInfo'][0]['MessageArgs'][0]
jobID = jobCreatedLink.split("/")[-1]
sys.stdout.write("Unjoin Server from group job has been created successfully\n")
sys.stdout.write("check job status using jobID %s\n" % jobID)
if args.OutputFileName != None:
sys.stdout.close()
# Logout of the current session
REDFISH_OBJ.logout()
Prerequisites
Users with the following privileges can Unjoin Servers from a Server Group:
* Configure Manager with Security
* Configure Manager
* Configure User
* Configure Devices
Performing the Job:
To unjoin servers from an existing Server Group, perform a POST
operation on the URI /redfish/v1/JobService/Actions/Oem/Hpe/HpeWfmJobServiceExt.ServerGroupJobs
with the following properties:
Property | Type | Description |
---|---|---|
Name | string | The name of the group from which servers are to be unjoined |
OperationType | string | The action to be performed on the group. Value for this action will be "UnjoinGroup" |
ServerList | array | All the selected servers to unjoin from a group |
Sample payload is as shown below:
{
"Name"
: "Group1",
"OperationType"
:"UnjoinGroup",
"ServerList"
:["123.123.12.12", "123.123.12.15"]
}
When POST
operation is performed on this URI, a job will be created. A GET
operation on the URI /redfish/v1/JobService/Jobs/{jobID}/
will retrieve the state of the job created.
When the Job has successfully completed, the servers that belong to a Server Group be obtained by performing a GET
operation on the URI /redfish/v1/AggregatorService/ManagedServerGroups/{groupName}/ManagedSystems/Summary/
to check if the servers have been removed from the group.
Importing a firmware baseline
curl https://{iLOAmpServer}/redfish/v1/JobService/Actions/Oem/Hpe/HpeWfmJobServiceExt.ImportBaselineJobs/
-H "Content-Type: application/json"
-X POST
--data "@data.json"
-u admin:admin
--insecure
import sys
import redfish
import time
import json
# Connect using iLO Amplifier address, username and password
login_host = "https://{iLOAmpServer}"
login_account = "username"
login_password = "password"
# Create a REDFISH object
REDFISH_OBJ = redfish.redfish_client(base_url=login_host, \
username=login_account, \
password=login_password)
# Login into the server and create a session
REDFISH_OBJ.login(auth="session")
body = dict()
body["SourcePath"] = args.SourcePath
body["StorageType"] = args.StorageType
# Do a POST on a given path
response = REDFISH_OBJ.post("/redfish/v1/JobService/Actions/Oem/Hpe/HpeWfmJobServiceExt.ImportBaselineJobs", body=body)
errMessage = ""
if response.status != 202:
sys.stdout.write("Unable to import baseline\n")
sys.stdout.write("status code %s\n" % response.status)
try:
sys.stdout.write(
"ErrorType: %s\n" % response.dict["error"]["@Message.ExtendedInfo"][0]["MessageId"].split(".")[-1])
for errStr in response.dict["error"]["@Message.ExtendedInfo"][0]["MessageArgs"]:
errMessage += errStr + ", "
sys.stdout.write("errMessage: %s\n" % errMessage)
except:
pass
REDFISH_OBJ.logout()
exit()
jobCreatedLink = response.getheader("Location")
if jobCreatedLink == None:
jobCreatedLink = response.getheader("Link")
if jobCreatedLink == None:
jobCreatedLink = response.dict['error']['@Message.ExtendedInfo'][0]['MessageArgs'][0]
jobId = jobCreatedLink.split("/")[-1]
sys.stdout.write("Import baseline job has been created successfully\n")
sys.stdout.write("check job status using jobId %s\n" % jobId)
if args.OutputFileName != None:
sys.stdout.close()
# Logout of the current session
REDFISH_OBJ.logout()
The /redfish/v1/Managers/iLOAmplifier/BaselineService/Baselines/
collection lists all the Firmware Baselines imported to iLO Amplifier Pack.
Prerequisite
- iLO Amplifier Pack supports up to 80 GB of baseline storage (which includes both firmware, OS baseline files and components downloaded from InfoSight). Please ensure that required space is available before importing any SPP.
- Users with the following privileges can import a firmware baseline:
- Configure Manager with Security
- Configure Manager
- Configure User
- Configure Devices
Performing Job
Firmware baseline can be imported with the following methods:
1)Network Share (NFS)
Perform a POST
operation on the /redfish/v1/JobService/Actions/Oem/Hpe/HpeWfmJobServiceExt.ImportBaselineJobs/
action.
Property | Type | Description |
---|---|---|
StorageType | string | Type of storage on which the SPP Image is available. Value should be "NetworkShare". |
SourcePath | string | Path to the SPP ISO file. This could be an http/https path or a normal file path. |
NetworkShareAddress | string | Network share IP address or DNS name where the SPP ISO Image is hosted. |
MountPath | string | Mount path of the network share server where the SPP ISO Image is hosted. |
Sample payload is as shown below:
{
"StorageType": "NetworkShare",
"SourcePath": "",
"NetworkShareAddress": "",
"MountPath": ""
}
2)HTTP/HTTPS Share
Perform a POST
operation on the redfish/v1/JobService/Actions/Oem/Hpe/HpeWfmJobServiceExt.ImportBaselineJobs/
action.
Property | Type | Description |
---|---|---|
StorageType | string | Type of storage on which the SPP Image is available. Value should be "HttpPath". |
SourcePath | string | Path to the SPP ISO file. This could be an http/https path or a normal file path. |
NetworkShareAddress | string | Network share IP address or DNS name where the SPP ISO Image is hosted. |
MountPath | string | Mount path of the network share server where the SPP ISO Image is hosted. |
Sample payload is as shown below:
{
"StorageType": ""HttpPath"",
"SourcePath": "",
}
When POST
is performed on this URI, a job will be created. A GET
on the URI /redfish/v1/JobService/Jobs/{jobID}/
will retrieve the state of the job created.
Firmware and driver updates for Gen9 servers
curl https://{iLOAmpServer}/redfish/v1/JobService/Actions/Oem/Hpe/HpeWfmJobServiceExt.ServerUpdateJobs
-H "Content-Type: application/json"
-X POST
--data "@data.json"
-u admin:admin
--insecure
# Gen9_Server_Update
import sys
import redfish
# Connect using iLO Amplifier address, username and password
login_host = "https://{iLOAmpServer}"
login_account = "username"
login_password = "password"
# Create a REDFISH object
REDFISH_OBJ = redfish.redfish_client(base_url=login_host, \
username=login_account, \
password=login_password)
# Login into the server and create a session
REDFISH_OBJ.login(auth="session")
body = dict()
body["OperationStrategy"] = "{OperationStrategy}"
if body["OperationStrategy"] != "DeployOnly":
body["BaselineID"] = "{BaselineID}"
body["BatchSize"] = "{BatchSize}"
body["CleanUpRepository"] = "{boolValue}"
body["OperationType"] = "{OperationType}"
if body["OperationStrategy"] == "StageAndDeploy":
if body["OperationType"] == "LegacyOffline":
body["DowngradeFlag"] = False
body["ResetFlag"] = False
else:
body["ResetFlag"] = False
body["DowngradeFlag"] = False
elif body["OperationStrategy"] == "StageOnly":
body["DowngradeFlag"] = False
body["ResetFlag"] = False
else:
body["ResetFlag"] = False
body["CleanUpRepository"] = False
body["SelectedSystemsManagerAddress"] = "{updateServerList}"
ManagerCredentials = dict()
ManagerCredentials["UserName"] = ""
ManagerCredentials["Password"]: ""
body["ManagerCredentials"] = ManagerCredentials
body["UseExternalWebServer"] = False
response = REDFISH_OBJ.post("/redfish/v1/JobService/Actions/Oem/Hpe/HpeWfmJobServiceExt.ServerUpdateJobs", body=body)
if response.status != 202:
sys.stdout.write("Unable to update gen 9 server\n")
sys.stdout.write("%s" % response)
REDFISH_OBJ.logout()
exit()
sys.stdout.write("Gen9 server update job has been created successfully\n")
# Logout of the current session
REDFISH_OBJ.logout()
Firmware and driver updates for Gen9 servers can be performed on selected servers of type iLO4 using below methods: - Online Method - Offline Method
Offline Method
Prerequisite
- Bootable baseline ISO image of the firmware update imported into iLO Amplifier Pack. (Please refer to Importing a Firmware Baseline use case) / Bootable baseline ISO image of the firmware update extracted to a shared HTTP/HTTPS location on the network and a dedicated web server for hosting SPP (HPE Support Pack for ProLiant) ISO images and files.
- Firmware and driver updates can be triggered only on supported server models. Please refer to user guide (Server firmware and driver updates chapter) for more details.
- Servers managed by HPE OneView or vCenter Lifecycle Manager (vLCM) cannot be updated by iLO Amplifier.
- iLO Advanced License is required to perform an update.
- Users with the following privileges can import a firmware baseline.
- Configure Manager with Security
- Configure Manager
- Configure User
- Configure Devices
Payload Properties for an Update
Property | Type | Description |
---|---|---|
SelectedSystemsManagerAddress | array | An array of servers selected to perform server updates. |
UseExternalWebServer | boolean | Specifies whether to use external webserver or to use the internal webserver to host baselines. True if you want to use external web server else false. |
BaselineID | number | Specifies the ID of the imported Baseline. |
BaselineUri | string | The URL of the SPP baseline extracted ISO image. |
BaselineUriISO | string | The URL of the SPP baseline ISO image. |
OperationType | string | Specifies the type of operation to be performed for an update. Values for this property field can be "iLORepositoryOnline", "LegacyOnlineBaselineAutomatic", "iLORepositoryOffline", "iLORepositoryOffline". |
OperationStrategy | string | Specifies the kind of operation to be performed during an online update. Values for this property field can be "StageAndDeploy", "StageOnly" and "DeployOnly". |
ResetFlag | boolean | Specified whether to reboot the server during an update if required. |
DowngradeFlag | boolean | Support downgrade.True-support,false-not support. |
CleanUpRepository | boolean | Specifies whether to delete the uploaded components from repository after the update. |
ForceInstall | boolean | HPSUM performs a forcible upgrade or downgrade of the firmware and drivers in the baseline when set to true. |
MediaPath | string | The URL of the baseline ISO image. |
BatchSize | number | The batch size of the update which is, number of parallel updates supported. |
ManagerCredentials | string | Username and Password to be provided only in case of federated nodes. |
Performing Job:
Offline Updates of iLO4 supports only "Stage and Deploy" strategy. To update a server of type iLO4, perform a POST
operation on /redfish/v1/JobService/Actions/Oem/Hpe/HpeWfmJobServiceExt.ServerUpdateJobs/
action.
Sample payload for imported baseline is as shown below:
{
"SelectedSystemsManagerAddress": [
IPAddress1,
IPAddress2, .
],
"ManagerCredentials": {
"UserName": "",
"Password": ""
},
"OperationStrategy": "StageAndDeploy",
"OperationType": "LegacyOffline",
"ResetFlag": false/true,
"DowngradeFlag": true/false,
"CleanUpRepository": false/true,
"BaselineID": ,
"BatchSize": (Any value between 10-30),
"UseExternalWebServer": false
}
Sample payload for using external web server is as shown below:
{
"SelectedSystemsManagerAddress": [
IPAddress1,
IPAddress2, .
],
"ManagerCredentials": {
"UserName": "",
"Password": ""
},
"OperationStrategy": "StageAndDeploy",
"OperationType": "LegacyOffline",
"ResetFlag": false/true,
"DowngradeFlag": true/false,
"CleanUpRepository": false/true,
"BatchSize": (Any value between 10-50),
"UseExternalWebServer": true
"MediaPath": ""
}
NOTE
1) "BaselineID"
to be used for server update can be retrieved by performing a GET
on /redfish/v1/Managers/iLOAmplifier/BaselineService/Baselines/
.
2) Up to 30 parallel updates are supported if an imported baseline is used. Up to 50 parallel updates are supported if external webserver is selected.
3) Other actions like Power toggling, Virtual Media Mounting etc. Cannot be performed on the selected servers being used for updates.
When POST
is performed on this URI, a job will be created. A GET
on the URI /redfish/v1/JobService/Jobs/{jobID}/
will retrieve the state of the job created and the following states will appear in progression:
- Pending
- Staging
- Staged
- Installing
- Installed
- Installed Pending Reboot
- Activated
Please refer to iLO Amplifier Pack user Guide for more information.
Online Method (Baseline Automatic)
Prerequisite
Refer to the prerequisites of offline method. Additional requirements for an online update are:
- Please refer iLO Amplifier User Guide (servers ad firmware updates chapter) for supported OSes, and iLO f/w version and SUT version details.
- SUT Mode should be in either "AutoDeploy" or "AutoDeployReboot" or "AutoStage" mode.
- SUT Service should always be running.
- AMS Status should be "Complete".
- AMS Version should be greater than 10.7 for Windows and 2.6.1 for Linux.
Performing Job
Baseline Automatic Online Updates of iLO4 supports three different strategies, namely:
- Stage Only
To stage firmware and driver components on selected servers, perform a POST
operation on /redfish/v1/JobService/Actions/Oem/Hpe/HpeWfmJobServiceExt.ServerUpdateJobs/
action.
Sample payload for imported baseline is as shown below:
{
"SelectedSystemsManagerAddress": [
IPAddress1,
IPAddress2,
],
"ManagerCredentials": {
"UserName": "",
"Password": ""
},
"OperationStrategy": "StageOnly",
"OperationType": "LegacyOnlineBaselineAutomatic",
"ResetFlag": false/true,
"DowngradeFlag": false/true,
"CleanUpRepository": false/true,
"BaselineID": ,
"BatchSize": Any value ranging between 10-30,
"UseExternalWebServer": false
}
Sample payload for using external web server is as shown below:
{
"SelectedSystemsManagerAddress": [
IPAddress1,
IPAddress2,
],
"ManagerCredentials": {
"UserName": "",
"Password": ""},
"OperationStrategy": "StageOnly",
"OperationType": "LegacyOnlineBaselineAutomatic",
"ResetFlag": false/true,
"DowngradeFlag": false/true,
"CleanUpRepository": false/true,
"BatchSize": Any value ranging between 10-50,
"UseExternalWebServer": true
"BaselineUri": "",
"BaselineUriISO": ""
}
When POST
is performed on this URI, a job will be created. A GET
on the URI /redfish/v1/JobService/Jobs/{jobID}/
will retrieve the state of the job created and the following states will appear in progression:
- Pending
- Staging
Staged
Deploy Only
To deploy staged firmware and driver components on selected servers, perform a POST
operation on /redfish/v1/JobService/Actions/Oem/Hpe/HpeWfmJobServiceExt.ServerUpdateJobs/
action.
Sample payload is as shown below:
{
"SelectedSystemsManagerAddress": [
IPAddress1,
IPAddress2, ...],
"ManagerCredentials": {
"UserName": ",
"Password": ""},
"BatchSize": Any value between 10 and 200,
"OperationStrategy": "DeployOnly",
"ResetFlag": true,
"DowngradeFlag": false,
"CleanUpRepository": true,
}
When POST
is performed on this URI, a job will be created. A GET
on the URI /redfish/v1/JobService/Jobs/{jobID}/
will retrieve the state of the job created and the following states will appear in progression:
- Installing
- Installed
- Installed Pending Reboot
Activated
Stage and Deploy
To update a server of type iLO4, perform a POST
operation on /redfish/v1/JobService/Actions/Oem/Hpe/HpeWfmJobServiceExt.ServerUpdateJobs
action.
Sample payload for imported baseline is as shown below:
{
"SelectedSystemsManagerAddress": [
IPAddress1,
IPAddress2, ...
],
"ManagerCredentials": {
"UserName": "",
"Password": ""
},
"OperationStrategy": "StageAndDeploy",
"OperationType": "LegacyOnlineBaselineAutomatic",
"ResetFlag": false/true,
"DowngradeFlag": false/true,
"CleanUpRepository": false/true,
"BaselineID": ,
"BatchSize": Any value ranging between 10-30,
"UseExternalWebServer": false
}
Sample payload for using external web server is as shown below:
{
"SelectedSystemsManagerAddress": [
IPAddress1,
IPAddress2, ...
],
"ManagerCredentials": {
"UserName": "",
"Password": ""},
"OperationStrategy": "StageAndDeploy",
"OperationType": "LegacyOnlineBaselineAutomatic",
"ResetFlag": false/true,
"DowngradeFlag": false/true,
"CleanUpRepository": false/true,
"BatchSize": Any value ranging between 10-50,
"UseExternalWebServer": true
"BaselineUriISO": ""
}
When POST
is performed on this URI, a job will be created. A GET
on the URI /redfish/v1/JobService/Jobs/{jobID}/
will retrieve the state of the job created and the following states will appear in progression:
- Pending
- Staging
- Staged
- Installing
- Installed
- Installed Pending Reboot
- Activated
NOTE:
1) "BaselineID"
to be used for server update can be retrieved by performing a GET
on /redfish/v1/Managers/iLOAmplifier/BaselineService/Baselines/
.
2) Up to 30 parallel updates are supported if an imported baseline is used. Up to 50 parallel updates are supported if external webserver is selected.
3) Other actions like Power toggling, Virtual Media Mounting etc. Cannot be performed on the selected servers being used for updates.
Please refer to iLO Amplifier Pack user Guide for more information.
Firmware and driver updates for Gen10 servers:
curl https://{iLOAmpServer}/redfish/v1/JobService/Actions/Oem/Hpe/HpeWfmJobServiceExt.ServerUpdateJobs/
-H "Content-Type: application/json"
-X POST
--data "@data.json"
-u admin:admin
--insecure
# Gen10_Server_Update
import sys
import redfish
# Connect using iLO Amplifier address, username and password
login_host = "https://{iLOAmpServer}"
login_account = "username"
login_password = "password"
# Create a REDFISH object
REDFISH_OBJ = redfish.redfish_client(base_url=login_host, \
username=login_account, \
password=login_password)
# Login into the server and create a session
REDFISH_OBJ.login(auth="session")
body = dict()
body["BaselineID"] = "{BaselineID}"
body["BatchSize"] = "{BatchSize}"
body["OperationStrategy"] = "{OperationStrategy}"
body["OperationType"] = "{OperationType}"
body["DowngradeFlag"] = "{boolValue}"
if body["OperationType"] == "iLORepositoryOffline":
body["ResetFlag"] = False
else:
body["ResetFlag"] = "{boolValue}"
body["CleanUpRepository"] = "{boolValue}"
body["SelectedSystemsManagerAddress"] = "{updateServerList}"
ManagerCredentials = dict()
ManagerCredentials["UserName"] = ""
ManagerCredentials["Password"]: ""
body["ManagerCredentials"] = ManagerCredentials
response = REDFISH_OBJ.post("/redfish/v1/JobService/Actions/Oem/Hpe/HpeWfmJobServiceExt.ServerUpdateJobs", body=body)
if response.status != 202:
sys.stdout.write("Unable to update gen 10 server\n")
sys.stdout.write("%s" % response)
REDFISH_OBJ.logout()
exit()
sys.stdout.write("Gen10 server update job has been created successfully\n")
# Logout of the current session
REDFISH_OBJ.logout()
Gen10 server updates can be performed on selected servers using below two methods:
- Online Method
- Offline Method
Offline Method
Prerequisite
- Bootable baseline ISO image of the firmware update imported into iLO Amplifier Pack. (Please refer to Importing a Firmware Baseline use case) / Bootable baseline ISO image of the firmware update extracted to a shared HTTP/HTTPS location on the network and a dedicated web server for hosting SPP (HPE Support Pack for ProLiant) ISO images and files.
- Firmware and driver updates can be triggered only on supported server models. Please refer to user guide (Server firmware and driver updates chapter) for more details.
- Servers managed by HPE OneView or vCenter Lifecycle Manager (vLCM) cannot be updated by iLO Amplifier.
- iLO Advanced License is required to perform an update.
- For servers set to the HighSecurity/FIPS/CNSA state, please refer to user guide (Server firmware and driver updates chapter) for supported iLO and SPP versions.
- Users with the following privileges can import a firmware baseline:
- Configure Manager with Security
- Configure Manager
- Configure User
- Configure Devices
Possible Payload Properties for an Update
Property | Type | Description |
---|---|---|
SelectedSystemsManagerAddress | array | An array of servers selected to perform server updates. |
UseExternalWebServer | boolean | Specifies whether to use external webserver or to use the internal webserver to host baselines. True if you want to use external web server else false. |
BaselineID | number | Specifies the ID of the imported Baseline. |
BaselineUri | string | The URL of the SPP baseline extracted ISO image. |
BaselineUriISO | string | The URL of the SPP baseline ISO image. |
OperationType | string | Specifies the type of operation to be performed for an update. Values for this property field can be "iLORepositoryOnline", "LegacyOnlineBaselineAutomatic", "iLORepositoryOffline", "iLORepositoryOffline". |
OperationStrategy | string | Specifies the kind of operation to be performed during an online update. Values for this property field can be "StageAndDeploy", "StageOnly" and "DeployOnly". |
ResetFlag | boolean | Specified whether to reboot the server during an update if required. |
DowngradeFlag | boolean | Support downgrade.True-support,false-not support. |
CleanUpRepository | boolean | Specifies whether to delete the uploaded components from repository after the update. |
ForceInstall | boolean | HPSUM performs a forcible upgrade or downgrade of the firmware and drivers in the baseline when set to true. |
MediaPath | string | The URL of the baseline ISO image. |
BatchSize | number | The batch size of the update which is, number of parallel updates supported. |
ManagerCredentials | string | Username and Password to be provided only in case of federated nodes. |
Performing Job
Offline Updates of iLO5 supports only "Stage and Deploy" strategy. To update a server of type iLO5, perform a POST
operation on /redfish/v1/JobService/Actions/Oem/Hpe/HpeWfmJobServiceExt.ServerUpdateJobs/
action.
Sample Payload for Offline Update is shown as below:
{
"SelectedSystemsManagerAddress": [
IPAddress1, ...
],
"ManagerCredentials": {
"UserName": "",
"Password": ""
},
"OperationStrategy": "StageAndDeploy",
"OperationType": "iLORepositoryOffline",
"ResetFlag": false/true,
"DowngradeFlag": true/false,
"CleanUpRepository": true/false,
"BaselineID": 15,
"BatchSize": 10-30
}
NOTE:
1) "BaselineID"
to be used for server update can be retrieved by performing a GET
on /redfish/v1/Managers/iLOAmplifier/BaselineService/Baselines/
.
2) Up to 30 parallel updates are supported if an imported baseline is used.
3) Other actions like Power toggling, Virtual Media Mounting etc. Cannot be performed on the selected servers being used for updates.
When POST
is performed on this URI, a job will be created. A GET
on the URI /redfish/v1/JobService/Jobs/{jobID}/
will retrieve the state of the job created.
Please refer to iLO Amplifier Pack user Guide for more information.
Online Method
Prerequisite
Refer to the prerequisites of offline method. Additional requirements for an online update are:
- iSUT (Integrated Smart Update Tools) should be greater than v2.3.0 and above for Gen10 servers.
- iSUT should be greater than v2.5.0 and above for Gen10 Plus servers.
- iSUT should be greater than 2.3.6 and above for Gen10 servers running VMware ESXi OS.
Performing Job
iLO Repository Online Updates of supports three different strategies:
- Stage Only
To stage firmware and driver components on selected servers, perform a POST
operation on /redfish/v1/JobService/Actions/Oem/Hpe/HpeWfmJobServiceExt.ServerUpdateJobs/
action.
Sample Payload for Stage Only operation is shown as below::
{
"SelectedSystemsManagerAddress": [
IPAddress1, ...
],
"ManagerCredentials": {
"UserName": "",
"Password": ""
},
"OperationStrategy": "StageOnly",
"OperationType": "iLORepositoryOnline",
"ResetFlag": false/true,
"DowngradeFlag": false/true,
"CleanUpRepository": false/true,
"BaselineID": 16,
"BatchSize": 10-30
} ?????
When POST
is performed on this URI, a job will be created. A GET
on the URI /redfish/v1/JobService/Jobs/{jobID}/
will retrieve the state of the job created.
- Deploy Only
To deploy staged firmware and driver components on selected servers, perform a POST
operation on /redfish/v1/JobService/Actions/Oem/Hpe/HpeWfmJobServiceExt.ServerUpdateJobs/
** action.
Sample Payload for Deploy Only operation is shown as below::
{
"ManagerCredentials": {
"UserName": "",
"Password": ""
},
"BatchSize": 10-200,
"OperationStrategy": "DeployOnly",
"ResetFlag": true/false,
"DowngradeFlag": false/true,
"CleanUpRepository": true/false,
"SelectedSystemsManagerAddress":
[IPAddress1, ...]
}
When POST
is performed on this URI, a job will be created. A GET
on the URI /redfish/v1/JobService/Jobs/{jobID}/
will retrieve the state of the job created.
- Stage and Deploy
To update a server of type iLO5, perform a POST
operation on /redfish/v1/JobService/Actions/Oem/Hpe/HpeWfmJobServiceExt.ServerUpdateJobs/
** action.
Sample Payload for StageAndDeploy operation strategy is shown as below:
{
"SelectedSystemsManagerAddress": [
IPAddress1, ...
],
"ManagerCredentials": {
"UserName": "",
"Password": ""
},
"OperationStrategy": "StageAndDeploy",
"OperationType": "iLORepositoryOffline",
"ResetFlag": false/true,
"DowngradeFlag": false/true,
"CleanUpRepository": false/true,
"BaselineID": 16,
"BatchSize": 10-30
}
When POST
is performed on this URI, a job will be created. A GET
on the URI /redfish/v1/JobService/Jobs/{jobID}/
will retrieve the state of the job created.
NOTE:
1) "BaselineID"
to be used for server update can be retrieved by performing a GET
on /redfish/v1/Managers/iLOAmplifier/BaselineService/Baselines/
.
2) Other actions like Power toggling, Virtual Media Mounting etc. Cannot be performed on the selected servers being used for updates.
Please refer to iLO Amplifier Pack user Guide for more information.
Delete baseline
curl https://{iLOAmpServer}/redfish/v1/Managers/iLOAmplifier/BaselineService/Baselines/{BaselineID}
-X DELETE
-u username:password
--insecure
import sys
import redfish
# Connect using iLO Amplifier address, username and password
login_host = "https://{iLOAmpServer}"
login_account = "username"
login_password = "password"
# Create a REDFISH object
REDFISH_OBJ = redfish.redfish_client(base_url=login_host, \
username=login_account, \
password=login_password)
# Login into the server and create a session
REDFISH_OBJ.login(auth="session")
uri = "/redfish/v1/Managers/iLOAmplifier/BaselineService/Baselines/" + "{BaselineID}"
response = REDFISH_OBJ.delete(uri)
print("exception for DELETE request %s" %uri)
if response.status != 200:
sys.stdout.write("%s" % response)
REDFISH_OBJ.logout()
exit()
sys.stdout.write("Baseline has been deleted successfully\n")
# Logout of the current session
REDFISH_OBJ.logout()
To delete baseline, perform DELETE on the uri /redfish/v1/Managers/iLOAmplifier/BaselineService/Baselines/{BaselineID} with the baseline ID corrosponding to ISOImage needed to be deleted. on successful POST baseline will be deleted from iLO Amplifier Pack
Create user
curl https://{iLOAmpServer}/redfish/v1/AccountService/Accounts
-H "Content-Type: application/json"
-X POST
--data "@data.json"
-u username:password
--insecure
Contents of data.json file
{
"UserName": "{userName}",
"Password": "{Password}",
"Oem": {
"Hpe": {
"Enabled": true,
"DisplayName": "{displayName}",
"Privilege": "{privilege}"
}
}
}
import sys
import redfish
# When running remotely connect using the address, account name,
# and password to send https requests
login_host = "https://{iLOAmpServer}"
login_account = "username"
login_password = "password"
# Create a REDFISH object
REDFISH_OBJ = redfish.redfish_client(base_url=login_host, \
username=login_account, \
password=login_password)
# Login into the server and create a session
REDFISH_OBJ.login(auth="session")
Hpe = dict()
Hpe["DisplayName"] = "{DisplayName}"
Hpe["Enabled"] = True
# Set the required privilege for the user, here "login" privilege is assigned
Hpe["Privilege"] = "Login"
Oem = dict()
Oem["Hpe"] = Hpe
body = dict()
body["UserName"] = "{createUserName}"
body["Password"] = "{createPassword}"
body["Oem"] = Oem
# Do a POST on a given path
response = REDFISH_OBJ.post("/redfish/v1/AccountService/Accounts", body=body)
if response.status != 201:
sys.stdout.write("Unable to to create user\n")
sys.stdout.write("%s" % response)
REDFISH_OBJ.logout()
exit()
The /redfish/v1/AccountService/Accounts
collection list all the users created in iLO Amplifier Pack. Perform POST operation on this collection to add user in iLO Amplifier Pack. The payload for POST must contains user name, display name, password and user privilege need to add user. User name - must use printable characters, privilege - can be one of the following
Configure Manager with Security
- Allows all operations including recovery management.Configure Manager
- Allows all operations except recovery management.Configure User
- Allows configuring users with device privilegesConfigure Devices
- Allows configuring and performing actions on devices and login privileges.Login
- Allows report generating and read operations, such as viewing discovered servers and groups.
All the users and their ID's can be obtained by peroforming GET on the uri /redfish/v1/AccountService/Accounts
Delete user
curl https://{iLOAmpServer}/redfish/v1/AccountService/Accounts/{ID}
-X DELETE
-u username:password
--insecure
import sys
import redfish
# When running remotely connect using the address, account name,
# and password to send https requests
login_host = "https://{iLOAmpServer}"
login_account = "username"
login_password = "password"
# Create a REDFISH object
REDFISH_OBJ = redfish.redfish_client(base_url=login_host, \
username=login_account, \
password=login_password)
# Login into the server and create a session
REDFISH_OBJ.login(auth="session")
uri = "/redfish/v1/AccountService/Accounts/{UserID}"
# Do a POST on a given path
response = REDFISH_OBJ.delete(uri)
if response.status != 200:
sys.stdout.write("Failed to delete user\n")
sys.stdout.write("%s" % response)
REDFISH_OBJ.logout()
exit()
sys.stdout.write("User has been deleted successfully\n")
# Logout of the current session
REDFISH_OBJ.logout()
To delete user, first get the user ID's by perform GET on the uri /redfish/v1/AccountService/Accounts
, which lists all the users and their respective user ID's.
Performing DELETE operation on the uri /redfish/v1/AccountService/Accounts/{ID}
with the user ID corrosponding to user needed to be deleted will delete user
Get job status
curl https://{iLOAmpServer}/redfish/v1/JobService/Jobs/{JobID}
-X GET
-u username:password
--insecure
import sys
import redfish
# Connect using iLO Amplifier address, username and password
login_host = "https://{iLOAmpServer}"
login_account = "username"
login_password = "password"
# Create a REDFISH object
REDFISH_OBJ = redfish.redfish_client(base_url=login_host, \
username=login_account, \
password=login_password)
# Login into the server and create a session
REDFISH_OBJ.login(auth="session")
jobList = "{[JobID]}"
if len(jobList) == 1 and jobList[0].lower() == "all":
totalJobsListed = 0
skip = 0
while True:
queryString = "/?$skip=%s" % skip
getRunningJob = "/redfish/v1/JobService/Jobs" + queryString
try:
managed_system = REDFISH_OBJ.get(getRunningJob)
except:
sys.stdout.write("GET request to %s failed\n" % getRunningJob)
sys.stdout.write("%s\n" % getRunningJob)
exit()
if managed_system.dict["Members@odata.count"] == 0:
sys.stdout.write("iLO Amp doesn't have any jobs to show\n")
exit()
for jobInfo in managed_system.dict["Members"]:
jobList.append(jobInfo["ID"])
totalJobsListed += 1
skip += 1
if managed_system.dict["Members@odata.count"] <= totalJobsListed:
break
if jobList == []:
sys.stdout.write("Please provide jobID\n")
for jobID in jobList:
jobCreatedLink = "/redfish/v1/JobService/Jobs/" + jobID
sys.stdout.write("******** jobID %s ********\n" % jobID)
dstate = "InProgress"
managed_system = REDFISH_OBJ.get(jobCreatedLink)
dstate = managed_system.dict["JobState"]
PercentComplete = managed_system.dict["PercentComplete"]
sys.stdout.write("JobID = %s, JobState = %s, PercentComplete %s\n" % (jobID, dstate, PercentComplete))
# Logout of the current session
REDFISH_OBJ.logout()
To know the status and completion percentage of job created in iLO Amplifier pack, perform GET operation on the uri /redfish/v1/JobService/Jobs/{jobID}
using respective job ID generated during job creation. Job state can be any of the following
- Starting
- Running
- Pending
- Completed
- Cancelled
- Exception
- Failed
Compliance report
curl https://{iLOAmpServer}/redfish/v1/JobService/Actions/Oem/Hpe/HpeWfmJobServiceExt.SppComplianceJobs
-H "Content-Type: application/json"
-X POST
--data "@data.json"
-u username:password
--insecure
curl https://{iLOAmpServer}/report/ComplianceReport_{jobID}.csv
-X GET
-u admin:admin
--insecure
Contents of data.json file
{
"BaselineID" : "{BaselineID}",
"SelectedSystemsManagerAddress" :"[{iLOAddress}]",
}
import sys
import redfish
import json
import csv
import time
from datetime import datetime
# Connect using iLO Amplifier address, username and password
login_host = "https://{iLOAmpServer}"
login_account = "username"
login_password = "password"
# Create a REDFISH object
REDFISH_OBJ = redfish.redfish_client(base_url=login_host, \
username=login_account, \
password=login_password)
# Login into the server and create a session
REDFISH_OBJ.login(auth="session")
serverVsJobID = dict()
jobList = []
body = dict()
body["BaselineID"] = "{BaselineID}"
body["SelectedSystemsManagerAddress"] = "[{iLOAddress}]"
response = REDFISH_OBJ.post("/redfish/v1/JobService/Actions/Oem/Hpe/HpeWfmJobServiceExt.SppComplianceJobs",
body=body)
if response.status != 202:
sys.stdout.write("Unable to create compliance report for server %s\n" % "{iLOAddress}")
sys.stdout.write("%s" % response)
REDFISH_OBJ.logout()
exit()
jobCreatedLink = response.getheader("Location")
if jobCreatedLink == None:
jobCreatedLink = response.getheader("Link")
if jobCreatedLink == None:
jobCreatedLink = response.dict['error']['@Message.ExtendedInfo'][0]['MessageArgs'][0]
jobID = jobCreatedLink.split("/")[-1]
sys.stdout.write("Compliance report job for server %s has been created successfully\n" % "{iLOAddress}")
jobCreatedLink = "/redfish/v1/JobService/Jobs/" + jobID
dstate = "InProgress"
while dstate != "Complete" and dstate != "Successful":
managed_system = REDFISH_OBJ.get(jobCreatedLink)
if managed_system.status != 200:
jobList.remove(jobID)
continue
PercentComplete = managed_system.dict["PercentComplete"]
if PercentComplete == 100:
sys.stdout.write("job %s is completed\n" % jobID)
else:
sys.stdout.write("job %s is inprogress\n" % jobID)
downloadReportUri = "/report/ComplianceReport_" + jobID + ".csv"
response = REDFISH_OBJ.get(downloadReportUri)
now = datetime.now()
current_time = now.strftime("%Y-%m-%d_%H-%M-%S")
fd = open('ComplianceReport_' + current_time + '.csv','w')
fd.write(response.text)
fd.close()
# Logout of the current session
REDFISH_OBJ.logout()
Prerequisites
- Firmware baseline ISO image has to be imported into iLO Amplifier Pack (Please refer import firmware baseline use case)
Create baseline compliance report
Perform POST operation on the redfish action uri /redfish/v1/JobService/Actions/Oem/Hpe/HpeWfmJobServiceExt.SppComplianceJobs
with the baseline ID corresponding to the respective baseline(Please refer Get baseline info use case) and server for which compliance report has to be created. on successful POST a job will be created, a GET on uri /redfish/v1/JobService/Jobs/{jobID}
or get job status use case to check the status of job.
Download compliance report
Perform GET operation on the uri /report/ComplianceReport_{jobID}.csv
will download the compliance report in csv format. Corresponding
create baseline compliance report jobID has to be provided in uri during GET operation.
On successful download csv file conatining compliance information will be saved in local folder.
Create recovery policy
curl https://{iLOAmpServer}/redfish/v1/ManagedNodes/RecoveryPolicy
-H "Content-Type: application/json"
-X POST
--data "@data.json"
-u username:password
--insecure
Contents of data.json file
{
"Name": "{PolicyName}",
"BaselineID": "{FirmwareBaselineID}",
"PersonaID": "{ConfigurationBaselineID}",
"OperatingSystemID": "{OsBaseline}",
"UseNANDBackupRestoreIfAvailable": "{bool}"
}
# Create recovery policy
import sys
import redfish
import time
import json
# Connect using iLO Amplifier address, username and password
login_host = "https://{iLOAmpServer}"
login_account = "username"
login_password = "password"
# Create a REDFISH object
REDFISH_OBJ = redfish.redfish_client(base_url=login_host, \
username=login_account, \
password=login_password)
# Login into the server and create a session
REDFISH_OBJ.login(auth="session")
body = dict()
body["Name"] = "{PolicyName}"
body["BaselineID"] = "{FirmwareBaselineID}"
body["PersonaID"] = "{ConfigurationBaselineID}"
body["OperatingSystemID"] = "{OsBaseline}"
body["UseNANDBackupRestoreIfAvailable"] = "{bool}"
# Do a POST on a given path
response = REDFISH_OBJ.post("/redfish/v1/ManagedNodes/RecoveryPolicy", body=body)
if response.status != 201:
sys.stdout.write("Failed to create recovery policy\n")
sys.stdout.write("%s" % response)
REDFISH_OBJ.logout()
exit()
sys.stdout.write("Recovery policy has been created successfully\n")
# Logout of the current session
REDFISH_OBJ.logout()
Prerequisites
- Users with the following privileges can create recovery policy
- Configure Manager with Security
- Firmware baseline ISO image has to be imported into iLO Amplifier Pack(Please refer import firmware baseline use case)
- Create or import a configuration baseline from a server(optional)
- OS baseline ISO image has to be imported into iLO Amplifier Pack(optional)
Creating a recovery policy
Perform POST operation on the redfish uri /redfish/v1/ManagedNodes/RecoveryPolicy
with the payload containing policy name, firmware baseline ID, OS baseline ID and configuration baseline ID. All baselines are not mandatory, supported combinations are as following
- Firmware only
- Firmware + Configuration
- Operating System only
- Firmware + Configuration + Operating System Policy will be created in iLO Amplifier Pack on successful POST operation
Assign recovery policy
curl https://{iLOAmpServer}/redfish/v1/JobService/Actions/Oem/Hpe/HpeWfmJobServiceExt.AssignRecoveryPolicyJob
-H "Content-Type: application/json"
-X POST
--data "@data.json"
-u username:password
--insecure
Contents of data.json file
{
"ActionType" : "{ActionType}",
"SelectedSystemsManagerAddress" : "{ServerAddress}",
"RecoveryPolicyID" : "{RecoveryPolicyID}",
}
#Assign recovery policy
import sys
import redfish
import time
import json
# Connect using iLO Amplifier address, username and password
login_host = "https://{iLOAmpServer}"
login_account = "username"
login_password = "password"
# Create a REDFISH object
REDFISH_OBJ = redfish.redfish_client(base_url=login_host, \
username=login_account, \
password=login_password)
# Login into the server and create a session
REDFISH_OBJ.login(auth="session")
ServerAddress = "{[serverlist]}"
body = dict()
body["ActionType"] = "{ActionType}"
body["SelectedSystemsManagerAddress"] = ServerAddress
if body["ActionType"] != "Quarantine":
body["RecoveryPolicyID"] = "{RecoveryPolicyID}"
# Do a POST on a given path
response = REDFISH_OBJ.post("/redfish/v1/JobService/Actions/Oem/Hpe/HpeWfmJobServiceExt.AssignRecoveryPolicyJob", body=body)
if response.status != 202:
sys.stdout.write("Unable to assign recovery policy\n")
sys.stdout.write("%s" % response)
REDFISH_OBJ.logout()
exit()
jobCreatedLink = response.getheader("Location")
if jobCreatedLink == None:
jobCreatedLink = response.getheader("Link")
if jobCreatedLink == None:
jobCreatedLink = response.dict['error']['@Message.ExtendedInfo'][0]['MessageArgs'][0]
jobID = jobCreatedLink.split("/")[-1]
sys.stdout.write("Assign recovery policy job has been created successfully\n")
sys.stdout.write("check job status using jobID %s\n" % jobID)
# Logout of the current session
REDFISH_OBJ.logout()
Prerequisites
- Users with the following privileges can create recovery policy
- Configure Manager with Security
- Servers must be gen10 or gen10+(for more information on iLO versions refer user guide)
- Server must be in monitored state
- Recovery policy containing necessary baselines needed to perform action
Assign recovery policy
There are three different types of recovery action iLO Amplifier Pack can assign it to servers and are mentioned below
- Auto Recovery Policy
- Quarantine
- Device Initiated Full Auto Recovery
Perform POST operation on the redfish action uri /redfish/v1/JobService/Actions/Oem/Hpe/HpeWfmJobServiceExt.AssignRecoveryPolicyJob
with the payload containing recovery action type, recovery policy ID corresponding to the respective recovery policy and server list for while policy has to be assigned. For device initiated action, recovery policy must contain all three baselines. Provide one of the action types mentioned below
*Quarantine
*Auto
*DeviceInitiated
on successful POST a job will be created, a GET on uri /redfish/v1/JobService/Jobs/{jobID}
or get job status use case to check the status of job.
Error messages and registries
HTTP response 400
{
"@odata.type": "#ExtendedInfo.1.0.0.ExtendedInfo",
"error": {
"@Message.ExtendedInfo": [
{
"@odata.type": "#Message.1.0.0.Message",
"MessageId": "HpeWolfram.1.0.InvalidActivationKey"
}
],
"code": "Wolfram.1.0.ExtendedInfo",
"message": "See @Message.ExtendedInfo for more information."
}
}
"InvalidActivationKey": {
"Description": "Invalid Activation Key",
"Message": "Invalid Activation Key",
"Severity": "Warning",
"NumberOfArgs": 0,
"ParamTypes": [],
"Resolution": "Retry Installation with a valid Activation Key"
}
Error messages appear in the iLO Amplifier Pack RESTful API as an immediate response to an HTTP operation.
All error cases use a basic error JSON structure called ExtendedInfo
. The most important property in ExtendedInfo
is MessageId
, a string containing a lookup key into a message registry.
MessageId
helps to keep the iLO Amplifier Pack service small by keeping much of the explanatory text for an error out of the code. Instead, iLO Amplifier Pack supplies an ExtendedInfo
response, where the MessageId
provides enough information for you to look up more details from another file.
For example, if you POST
to the iLO Amplifier Pack license service to install an iLO Amplifier Pack license, but you supply an incorrect LicenceKey
string, iLO Amplifier Pack responds with an error similar to the following:
HTTP response 400 is the standard RESTful API response to an error. In the example above, the error is easy to understand, but some errors are not easy to understand. To display a more meaningful error message, parse the string HpeWolfram.1.0.InvalidActivationKey
into the following
components:
HpeWolfram.1.0
—This is the base name of the message registry to consult. Look for a matching registry file.InvalidActivationKey
—This is the lookup key into the message registry.
The search returns a result similar to the following:
Many error messages can also return parameters. These parameters may be plugged into the strings in the registry to form detailed messages tailored to the instance of the error message.
Resource Map
URI | Type |
---|---|
/redfish/v1 |
ServiceRoot |
/redfish/v1/AccountService |
AccountService |
/redfish/v1/AccountService/Accounts |
Collection of ManagerAccount |
/redfish/v1/AccountService/Accounts/{item} |
ManagerAccount |
/redfish/v1/AccountService/PrivilegeRegistry |
PrivilegeRegistry |
/redfish/v1/AccountService/Roles |
Collection of Role |
/redfish/v1/AddOnServices |
Collection of HpeWfmAddOnServices |
/redfish/v1/AggregatorService |
HpeWfmAggregatorService |
/redfish/v1/AggregatorService/Dashboard/Alerts |
HpeWfmDashboardAlerts |
/redfish/v1/AggregatorService/Dashboard/Assets |
HpeWfmDashboardAssets |
/redfish/v1/AggregatorService/Dashboard/Compliance |
HpeWfmDashboardCompliance |
/redfish/v1/AggregatorService/Dashboard/InfoSightAlerts |
HpeWfmDashboardInfoSightAlerts |
/redfish/v1/AggregatorService/Dashboard/ServerGroups |
HpeWfmDashboardServerGroups |
/redfish/v1/AggregatorService/FederationGroups |
Collection of HpeWfmFederationGroup |
/redfish/v1/AggregatorService/LicenseInfo |
HpeWfmLicenseInfo |
/redfish/v1/AggregatorService/LogServices |
Collection of LogService |
/redfish/v1/AggregatorService/LogServices/AlertLog |
LogService |
/redfish/v1/AggregatorService/LogServices/AlertLog/Entries |
Collection of LogEntry |
/redfish/v1/AggregatorService/ManagedGroups |
Collection of HpeWfmManagedGroup |
/redfish/v1/AggregatorService/ManagedServerGroups |
Collection of HpeWfmManagedServerGroups |
/redfish/v1/AggregatorService/ManagedServerGroups/{item} |
HpeWfmManagedServerGroups |
/redfish/v1/AggregatorService/ManagedServerGroups/{item}/ManagedSystems |
Collection of HpeWfmManagedSystem |
/redfish/v1/AggregatorService/ManagedServerGroups/{item}/ManagedSystems/{item} |
HpeWfmManagedSystem |
/redfish/v1/AggregatorService/ManagedServerGroups/{item}/ManagedSystems/{item} |
Collection of HpeWfmSystemSummary |
/redfish/v1/AggregatorService/ManagedServerGroups/{item}/ManagedSystems/{item}/Summary |
HpeWfmSystemSummary |
/redfish/v1/AggregatorService/ManagedSystems |
Collection of HpeWfmManagedSystem |
/redfish/v1/AggregatorService/ManagedSystems/{item} |
HpeWfmManagedSystem |
/redfish/v1/AggregatorService/ManagedSystems/{item} |
Collection of HpeWfmSystemSummary |
/redfish/v1/AggregatorService/ManagedSystems/{item}/Summary |
HpeWfmSystemSummary |
/redfish/v1/AggregatorService/Reports |
Collection of HpeWfmManagedSystem |
/redfish/v1/AggregatorService/ServerGroups |
Collection of HpeWfmServerGroups |
/redfish/v1/AggregatorService/ServerGroups/{item} |
HpeWfmServerGroups |
/redfish/v1/AggregatorService/ServerGroups/{item}/Systems |
Collection of ComputerSystem |
/redfish/v1/AggregatorService/Systems |
Collection of ComputerSystem |
/redfish/v1/Chassis |
Collection of Chassis |
/redfish/v1/Chassis/{item} |
Chassis |
/redfish/v1/Chassis/{item}/Power |
Power |
/redfish/v1/Chassis/{item}/Thermal |
Thermal |
/redfish/v1/EventService |
EventService |
/redfish/v1/EventService/Subscriptions |
Collection of EventDestination |
/redfish/v1/JobService |
JobService |
/redfish/v1/JobService/Jobs |
Collection of Job |
/redfish/v1/JobService/Jobs/{item} |
Job |
/redfish/v1/JobService/Jobs/{item}/Steps |
Collection of Job |
/redfish/v1/JobService/Jobs/{item}/Steps/{item} |
Job |
/redfish/v1/JobService/Results/BaselineComplianceJobs/{item} |
HpeWfmSppComplianceJobResults |
/redfish/v1/JobService/Results/ServerUpdateJobs/{item} |
Collection of HpeWfmUpdateJobResults |
/redfish/v1/JobService/Results/ServerUpdateJobs/{item}/{item} |
HpeWfmUpdateJobResults |
/redfish/v1/Managers |
Collection of Manager |
/redfish/v1/Managers/iLOAmplifier |
Manager |
/redfish/v1/Managers/iLOAmplifier/AddOnServicesManager |
Collection of HpeWfmAddOnServicesManager |
/redfish/v1/Managers/iLOAmplifier/AddOnServicesManager/hpehsm |
HpeWfmAddOnServicesManager |
/redfish/v1/Managers/iLOAmplifier/BaselineService |
HpeWfmBaselineService |
/redfish/v1/Managers/iLOAmplifier/BaselineService/Baselines |
Collection of HpeWfmBaseline |
/redfish/v1/Managers/iLOAmplifier/BaselineService/Baselines/{item} |
HpeWfmBaseline |
/redfish/v1/Managers/iLOAmplifier/DateTime |
HpeWfmDateTime |
/redfish/v1/Managers/iLOAmplifier/EthernetInterfaces |
Collection of EthernetInterface |
/redfish/v1/Managers/iLOAmplifier/EthernetInterfaces/{item} |
EthernetInterface |
/redfish/v1/Managers/iLOAmplifier/InfoSightPolicy |
HpeWfmInfoSightAggregation |
/redfish/v1/Managers/iLOAmplifier/LicenseService |
Collection of HpeWfmLicense |
/redfish/v1/Managers/iLOAmplifier/LicenseService/{item} |
HpeWfmLicense |
/redfish/v1/Managers/iLOAmplifier/LogServices |
Collection of LogService |
/redfish/v1/Managers/iLOAmplifier/LogServices/DeviceAlertLog |
LogService |
/redfish/v1/Managers/iLOAmplifier/LogServices/DeviceAlertLog/Entries |
Collection of LogEntry |
/redfish/v1/Managers/iLOAmplifier/NetworkProtocol |
ManagerNetworkProtocol |
/redfish/v1/Managers/iLOAmplifier/SecurityService |
HpeSecurityService |
/redfish/v1/Managers/iLOAmplifier/SecurityService/HttpsCACerts |
Collection of HpeWfmHttpsCert |
/redfish/v1/Managers/iLOAmplifier/SecurityService/HttpsCert |
HpeHttpsCert |
/redfish/v1/Registries |
Collection of MessageRegistryFile |
/redfish/v1/Registries/{item} |
MessageRegistryFile |
/redfish/v1/Schemas |
Collection of JsonSchemaFile |
/redfish/v1/Schemas/{item} |
JsonSchemaFile |
/redfish/v1/SessionService |
SessionService |
/redfish/v1/SessionService/Sessions |
Collection of Session |
/redfish/v1/SessionService/Sessions/{item} |
Session |
/redfish/v1/Systems |
Collection of ComputerSystem |
/redfish/v1/Systems/{item} |
ComputerSystem |
/redfish/v1/Systems/{item}/EthernetInterfaces |
Collection of EthernetInterface |
/redfish/v1/Systems/{item}/EthernetInterfaces/{item} |
EthernetInterface |
/redfish/v1/Systems/{item}/FirmwareInventory |
Collection of SoftwareInventory |
/redfish/v1/Systems/{item}/Memory |
Collection of Memory |
/redfish/v1/Systems/{item}/Memory/{item} |
Memory |
/redfish/v1/Systems/{item}/Processor |
Collection of Processor |
/redfish/v1/Systems/{item}/Processor/{item} |
Processor |
/redfish/v1/Systems/{item}/SoftwareInventory |
Collection of SoftwareInventory |
/redfish/v1/Systems/{item}/Storage |
Collection of Storage |
/redfish/v1/Systems/{item}/Storage/{item} |
Storage |
/redfish/v1/Systems/{item}/Storage/{item}/Drives/{item} |
Drive |
/redfish/v1/Systems/{item}/Storage/{item}/Volumes |
Collection of Volume |
/redfish/v1/Systems/{item}/Storage/{item}/Volumes/{item} |
Volume |
/redfish/v1/TaskService |
TaskService |
/redfish/v1/TaskService/Tasks |
Collection of Task |
/redfish/v1/TaskService/Tasks/{item} |
Task |
/redfish/v1/UpdateService |
UpdateService |
/redfish/v1/UpdateService/FirmwareInventory |
Collection of SoftwareInventory |
/redfish/v1/UpdateService/FirmwareInventory/{item} |
SoftwareInventory |
/redfish/v1/UpdateService/SoftwareInventory |
Collection of SoftwareInventory |
/redfish/v1/UpdateService/SoftwareInventory/{item} |
SoftwareInventory |
Resource Definitions
Each resource in the API has a "type" that defines its properties. See the Redfish specification for @odata.type
for details.
This section defines the supported types and lists the typical instances of each type. Because this API document is applicable to iLO Amplifier Pack managing various HPE servers, you may find variations such as:
- Properties implemented on one type of server and not another
- Resources that are read on only one type of server and not another
- The number of resources of a particular type (e.g. multiple compute nodes or enclosing chassis)
Collections
GET https://{iLOAmpServer}/redfish/v1/systems/ showing a collection response (JSON)
{
"@odata.id": "/redfish/v1/systems/",
"@odata.context": "/redfish/v1/$metadata/",
"@odata.type": "#ComputerSystemCollection.ComputerSystemCollection",
"Members@odata.count": 1,
"Members": [
{
"@odata.id": "/redfish/v1/systems/1/"
}
]
}
Many resource types in the API are members of "collections." Collections are groups of similar resources and are typically an array of Member links.
Redfish does not define a generic collection "type" (@odata.type) but all collections are identical in structure. A ComputerSystemCollection
is identical in structure to a ChassisCollection
although they have slightly different names. Typically, collection types are suffixed with the word collection and are recognizable by the presence of the Members
array of links.
Collections may be GET-only in the sense that they may not be added to or removed from. Examples of GET-only collections are the Systems collection at /redfish/v1/systems/
. In a typical systems collection describing physical hardware, it wouldn't make sense to be able to create or remove members using POST or DELETE.
Other collections may be editable. Examples of these might be the Accounts collection at /redfish/v1/accountservice/accounts
. The API supports the addition or removal of user accounts. To add a new member to an editable collection, perform an HTTP POST to the collection resource with a body consisting of the required JSON properties needed to create a new member (this does not necessarily require you to POST every property because many may take a unique service-assigned value or a default value.)
For more information on collections see the Redfish 1.0 DMTF standard at https://www.dmtf.org/standards/redfish and the example Python code: https://github.com/DMTF/python-redfish-library.
Properties
Members@odata.count
JSONPath: /Members@odata.count
(read only integer)
The number of members in the collection.
Members[]
JSONPath: /Members
(read only array of links)
The Members array consists of links (@odata.id
) to the members of the collection.
AccountService 1.3.0
The AccountService schema contains properties for managing user accounts. The properties are common to all user accounts, such as password requirements, and control features such as account lockout. The schema also contains links to the collections of Manager Accounts and Roles.
AccountLockoutCounterResetAfter | number (seconds) read-write |
The interval of time in seconds between the last failed login attempt and reset of the lockout threshold counter. This value must be less than or equal to AccountLockoutDuration. Reset sets the counter to zero. |
AccountLockoutDuration | number (seconds) read-write (null) |
The time in seconds an account is locked out. The value must be greater than or equal to the value of the AccountLockoutCounterResetAfter property. If set to 0, no lockout occurs. |
AccountLockoutThreshold | number read-write (null) |
The number of failed login attempts allowed before a user account is locked for a specified duration. A value of 0 means it is never locked. |
Accounts { | object | A link to a collection of Manager Accounts. Contains a link to a resource. |
@odata.id | string read-only |
Link to Collection of ManagerAccount. See the ManagerAccount schema for details. |
} | ||
ActiveDirectory { | object | The first ActiveDirectory external account provider this AccountService supports. |
AccountProviderType | string (enum) read-only (null) |
This property contains the type of external account provider this resource references. For the possible property values, see AccountProviderType in Property Details. |
Authentication { | object (null) |
This property contains the authentication information for the external account provider. |
AuthenticationType | string (enum) read-write (null) |
This property contains the type of authentication used to connect to the external account provider. For the possible property values, see AuthenticationType in Property Details. |
KerberosKeytab | string read-write (null) |
This property is used with a PATCH or PUT to write a base64 encoded version of the kerberos keytab for the account. This property is null on a GET. |
Oem {} | object | Oem extension object. See the Resource schema for details on this property. |
Password | string read-write (null) |
This property is used with a PATCH or PUT to write the password for the account service. This property is null on a GET. |
Token | string read-write (null) |
This property is used with a PATCH or PUT to write the token for the account. This property is null on a GET. |
Username | string read-write |
This property contains the user name for the account service. |
} | ||
LDAPService { | object (null) |
This property contains additional mapping information needed to parse a generic LDAP service. |
Oem {} | object | Oem extension object. See the Resource schema for details on this property. |
SearchSettings { | object (null) |
This property contains the settings needed to search an external LDAP service. |
BaseDistinguishedNames [ ] | array (string, null) read-write |
The base distinguished names to use when searching the LDAP service. |
GroupNameAttribute | string read-write (null) |
The attribute name that contains the name of the Group. |
GroupsAttribute | string read-write (null) |
The attribute name that contains the Groups for a user. |
UsernameAttribute | string read-write (null) |
The attribute name that contains the Username. |
} | ||
} | ||
RemoteRoleMapping [ { | array | This property contains a collection of the mapping rules to convert the external account providers account information to the local Redfish Role. |
LocalRole | string read-write (null) |
The name of the local role in which to map the remote user or group. |
Oem {} | object | Oem extension object. See the Resource schema for details on this property. |
RemoteGroup | string read-write (null) |
This property is the name of the remote group (or in the case of a Redfish Service, remote role) that will be mapped to the local role referenced by this entity. |
RemoteUser | string read-write (null) |
This property is the name of the remote user that will be mapped to the local role referenced by this entity. |
} ] | ||
ServiceAddresses [ ] | array (string, null) read-write |
This property contains the addresses of the user account providers this resource references. The format of this field depends on the Type. |
ServiceEnabled | boolean read-write (null) |
This indicates whether this service is enabled. |
} | ||
AdditionalExternalAccountProviders { | object | The additional external account providers this AccountService is using. Contains a link to a resource. |
@odata.id | string read-only |
Link to Collection of ExternalAccountProvider. See the ExternalAccountProvider schema for details. |
} | ||
AuthFailureLoggingThreshold | number read-write |
The number of authorization failures allowed before the failure attempt is logged to the manager log. |
Description | string read-only (null) |
Provides a description of this resource and is used for commonality in the schema definitions. |
Id | string read-only required |
Uniquely identifies the resource within the collection of like resources. |
LDAP { | object | The first LDAP external account provider this AccountService supports. |
AccountProviderType | string (enum) read-only (null) |
This property contains the type of external account provider this resource references. For the possible property values, see AccountProviderType in Property Details. |
Authentication { | object (null) |
This property contains the authentication information for the external account provider. |
AuthenticationType | string (enum) read-write (null) |
This property contains the type of authentication used to connect to the external account provider. For the possible property values, see AuthenticationType in Property Details. |
KerberosKeytab | string read-write (null) |
This property is used with a PATCH or PUT to write a base64 encoded version of the kerberos keytab for the account. This property is null on a GET. |
Oem {} | object | Oem extension object. See the Resource schema for details on this property. |
Password | string read-write (null) |
This property is used with a PATCH or PUT to write the password for the account service. This property is null on a GET. |
Token | string read-write (null) |
This property is used with a PATCH or PUT to write the token for the account. This property is null on a GET. |
Username | string read-write |
This property contains the user name for the account service. |
} | ||
LDAPService { | object (null) |
This property contains additional mapping information needed to parse a generic LDAP service. |
Oem {} | object | Oem extension object. See the Resource schema for details on this property. |
SearchSettings { | object (null) |
This property contains the settings needed to search an external LDAP service. |
BaseDistinguishedNames [ ] | array (string, null) read-write |
The base distinguished names to use when searching the LDAP service. |
GroupNameAttribute | string read-write (null) |
The attribute name that contains the name of the Group. |
GroupsAttribute | string read-write (null) |
The attribute name that contains the Groups for a user. |
UsernameAttribute | string read-write (null) |
The attribute name that contains the Username. |
} | ||
} | ||
RemoteRoleMapping [ { | array | This property contains a collection of the mapping rules to convert the external account providers account information to the local Redfish Role. |
LocalRole | string read-write (null) |
The name of the local role in which to map the remote user or group. |
Oem {} | object | Oem extension object. See the Resource schema for details on this property. |
RemoteGroup | string read-write (null) |
This property is the name of the remote group (or in the case of a Redfish Service, remote role) that will be mapped to the local role referenced by this entity. |
RemoteUser | string read-write (null) |
This property is the name of the remote user that will be mapped to the local role referenced by this entity. |
} ] | ||
ServiceAddresses [ ] | array (string, null) read-write |
This property contains the addresses of the user account providers this resource references. The format of this field depends on the Type. |
ServiceEnabled | boolean read-write (null) |
This indicates whether this service is enabled. |
} | ||
LocalAccountAuth | string (enum) read-write |
Controls when this service will use the accounts defined withing this AccountService as part of authentication. For the possible property values, see LocalAccountAuth in Property Details. |
MaxPasswordLength | number read-only |
The maximum password length for this service. |
MinPasswordLength | number read-only |
The minimum password length for this service. |
Name | string read-only required |
The name of the resource or array element. |
Oem {} | object | This is the manufacturer/provider specific extension moniker used to divide the Oem object into sections. See the Resource schema for details on this property. |
PrivilegeMap { | object | A reference to the Privilege mapping that defines the privileges needed to perform a requested operation on a URI associated with this service. See the PrivilegeRegistry schema for details on this property. |
@odata.id | string read-only |
Link to a PrivilegeRegistry resource. See the Links section and the PrivilegeRegistry schema for details. |
} | ||
Roles { | object | A link to a collection of Roles. Contains a link to a resource. |
@odata.id | string read-only |
Link to Collection of Role. See the Role schema for details. |
} | ||
ServiceEnabled | boolean read-write (null) |
Indicates whether this service is enabled. If set to false, the AccountService is disabled. This means no users can be created, deleted or modified. Any service attempting to access the AccountService resource (for example, the Session Service) will fail. New sessions cannot be started when the service is disabled. However, established sessions may still continue operating. This does not affect Basic AUTH connections. |
Status {} | object | This type describes the status and health of a resource and its children. See the Resource schema for details on this property. |
Property Details
AccountProviderType:
This property contains the type of external account provider this resource references.
string | Description |
---|---|
ActiveDirectoryService | An external Active Directory Service. |
LDAPService | A generic external LDAP Service. |
OEM | An OEM specific external authentication or directory service. |
RedfishService | An external Redfish Service. |
AuthenticationType:
This property contains the type of authentication used to connect to the external account provider.
string | Description |
---|---|
KerberosKeytab | A kerberos keytab. |
OEM | An OEM specific authentication mechanism. |
Token | An opaque authentication token. |
UsernameAndPassword | Username and password combination. |
LocalAccountAuth:
Controls when this service will use the accounts defined withing this AccountService as part of authentication.
string | Description |
---|---|
Disabled | Authentication via accounts defined in this AccountService is disabled. |
Enabled | Authentication via accounts defined in this AccountService is enabled. |
Fallback | Authentication via accounts defined in this AccountService is only used if there are external account providers that are currently unreachable. |
ActionInfo 1.0.3
The ActionInfo schema describes the parameters and other information necessary to perform a Redfish Action on a particular Action target. Parameter support can differ between vendors and even between instances of a resource. This data can be used to ensure Action requests from applications contain supported parameters.
Description | string read-only (null) |
Provides a description of this resource and is used for commonality in the schema definitions. |
Id | string read-only required |
Uniquely identifies the resource within the collection of like resources. |
Name | string read-only required |
The name of the resource or array element. |
Oem {} | object | This is the manufacturer/provider specific extension moniker used to divide the Oem object into sections. See the Resource schema for details on this property. |
Parameters [ { | array | The parameters associated with the specified Redfish Action. |
AllowableValues [ ] | array (string, null) read-only |
A list of values for this parameter supported by this Action target. |
DataType | string (enum) read-only (null) |
The JSON property type used for this parameter. For the possible property values, see DataType in Property Details. |
Name | string read-only required |
The name of the parameter for this Action. |
ObjectDataType | string read-only (null) |
The OData Type of an object-based parameter. |
Required | boolean read-only |
Indicates whether the parameter is required to perform this Action. |
} ] |
Property Details
DataType:
The JSON property type used for this parameter.
string | Description |
---|---|
Boolean | A boolean (true or false). |
Number | A number. |
NumberArray | An array of numbers. |
Object | An embedded JSON object. |
ObjectArray | An array of JSON objects. |
String | A string. |
StringArray | An array of strings. |
Chassis 1.7.0
The Chassis schema represents the physical components of a system. This resource represents the sheet-metal confined spaces and logical zones such as racks, enclosures, chassis and all other containers. Subsystems (like sensors) that operate outside of a system's data plane (meaning the resources are not accessible to software running on the system) are linked either directly or indirectly through this resource.
Assembly {} | object | A reference to the Assembly resource associated with this chassis. See the Assembly schema for details on this property. |
AssetTag | string read-write (null) |
The user assigned asset tag of this chassis. |
ChassisType | string (enum) read-only required |
The type of physical form factor of the chassis. For the possible property values, see ChassisType in Property Details. |
DepthMm | number (mm) read-only (null) |
The depth of the chassis. |
Description | string read-only (null) |
Provides a description of this resource and is used for commonality in the schema definitions. |
HeightMm | number (mm) read-only (null) |
The height of the chassis. |
Id | string read-only required |
Uniquely identifies the resource within the collection of like resources. |
IndicatorLED | string (enum) read-write (null) |
The state of the indicator LED, used to identify the chassis. For the possible property values, see IndicatorLED in Property Details. |
Links { | object | Contains references to other resources that are related to this resource. |
ComputerSystems [ { | array | An array of references to the computer systems contained in this chassis. This will only reference ComputerSystems that are directly and wholly contained in this chassis. |
@odata.id | string read-only |
Link to a ComputerSystem resource. See the Links section and the ComputerSystem schema for details. |
} ] | ||
ContainedBy { | object | A reference to the chassis that this chassis is contained by. |
@odata.id | string read-only |
Link to another Chassis resource. |
} | ||
Contains [ { | array | An array of references to any other chassis that this chassis has in it. |
@odata.id | string read-only |
Link to another Chassis resource. |
} ] | ||
CooledBy [ { | array | An array of ID[s] of resources that cool this chassis. Normally the ID will be a chassis or a specific set of fans. |
@odata.id | string read-only |
The unique identifier for a resource. |
} ] | ||
Drives [ { | array | An array of references to the disk drives located in this Chassis. |
@odata.id | string read-only |
Link to a Drive resource. See the Links section and the Drive schema for details. |
} ] | ||
ManagedBy [ { | array | An array of references to the Managers responsible for managing this chassis. |
@odata.id | string read-only |
Link to a Manager resource. See the Links section and the Manager schema for details. |
} ] | ||
ManagersInChassis [ { | array | An array of references to the managers located in this Chassis. |
@odata.id | string read-only |
Link to a Manager resource. See the Links section and the Manager schema for details. |
} ] | ||
Oem {} | object | Oem extension object. See the Resource schema for details on this property. |
PCIeDevices [ { | array | An array of references to the PCIe Devices located in this Chassis. |
@odata.id | string read-only |
Link to a PCIeDevice resource. See the Links section and the PCIeDevice schema for details. |
} ] | ||
PoweredBy [ { | array | An array of ID[s] of resources that power this chassis. Normally the ID will be a chassis or a specific set of Power Supplies. |
@odata.id | string read-only |
The unique identifier for a resource. |
} ] | ||
ResourceBlocks [ { } ] | array (object) | An array of references to the Resource Blocks located in this Chassis. This schema defines a Resource Block resource. See the ResourceBlock schema for details on this property. |
Storage [ { | array | An array of references to the storage subsystems connected to or inside this Chassis. |
@odata.id | string read-only |
Link to a Storage resource. See the Links section and the Storage schema for details. |
} ] | ||
Switches [ { } ] | array (object) | An array of references to the Switches located in this Chassis. Switch contains properties describing a simple fabric switch. See the Switch schema for details on this property. |
} | ||
Location {} | object | This type describes the location of a resource. See the Resource schema for details on this property. |
LogServices { | object | A reference to the logs for this chassis. Contains a link to a resource. |
@odata.id | string read-only |
Link to Collection of LogService. See the LogService schema for details. |
} | ||
Manufacturer | string read-only (null) |
The manufacturer of this chassis. |
Model | string read-only (null) |
The model number of the chassis. |
Name | string read-only required |
The name of the resource or array element. |
NetworkAdapters { | object | A reference to the collection of Network Adapters associated with this chassis. Contains a link to a resource. |
@odata.id | string read-only |
Link to Collection of NetworkAdapter. See the NetworkAdapter schema for details. |
} | ||
Oem {} | object | This is the manufacturer/provider specific extension moniker used to divide the Oem object into sections. See the Resource schema for details on this property. |
PartNumber | string read-only (null) |
The part number of the chassis. |
PhysicalSecurity { | object | The state of the physical security sensor. |
IntrusionSensor | string (enum) read-write (null) |
This indicates the known state of the physical security sensor, such as if it is hardware intrusion detected. For the possible property values, see IntrusionSensor in Property Details. |
IntrusionSensorNumber | number read-only (null) |
A numerical identifier to represent the physical security sensor. |
IntrusionSensorReArm | string (enum) read-only (null) |
This indicates how the Normal state to be restored. For the possible property values, see IntrusionSensorReArm in Property Details. |
} | ||
Power { | object | A reference to the power properties (power supplies, power policies, sensors) of this chassis. See the Power schema for details on this property. |
@odata.id | string read-only |
Link to a Power resource. See the Links section and the Power schema for details. |
} | ||
PowerState | string (enum) read-only (null) |
The current power state of the chassis. For the possible property values, see PowerState in Property Details. |
SerialNumber | string read-only (null) |
The serial number of the chassis. |
SKU | string read-only (null) |
The SKU of the chassis. |
Status {} | object | This type describes the status and health of a resource and its children. See the Resource schema for details on this property. |
Thermal { | object | A reference to the thermal properties (fans, cooling, sensors) of this chassis. See the Thermal schema for details on this property. |
@odata.id | string read-only |
Link to a Thermal resource. See the Links section and the Thermal schema for details. |
} | ||
UUID | string read-only (null) |
The Universal Unique Identifier (UUID) for this Chassis. |
WeightKg | number (kg) read-only (null) |
The weight of the chassis. |
WidthMm | number (mm) read-only (null) |
The width of the chassis. |
Actions
Reset
This action is used to reset the chassis. This action resets the chassis, not Systems or other contained resources, although side effects may occur which affect those resources.
URIs:
The following table shows the parameters for the action which are included in the POST body to the URI shown in the "target" property of the Action.
{ | ||
ResetType | string (enum) read-write |
The type of reset to be performed. For the possible property values, see ResetType in Property Details. |
} |
Property Details
ChassisType:
The type of physical form factor of the chassis.
string | Description |
---|---|
Blade | An enclosed or semi-enclosed, typically vertically-oriented, system chassis which must be plugged into a multi-system chassis to function normally. |
Card | A loose device or circuit board intended to be installed in a system or other enclosure. |
Cartridge | A small self-contained system intended to be plugged into a multi-system chassis. |
Component | A small chassis, card, or device which contains devices for a particular subsystem or function. |
Drawer | An enclosed or semi-enclosed, typically horizontally-oriented, system chassis which may be slid into a multi-system chassis. |
Enclosure | A generic term for a chassis that does not fit any other description. |
Expansion | A chassis which expands the capabilities or capacity of another chassis. |
IPBasedDrive | A chassis in a drive form factor with IP-based network connections. |
Module | A small, typically removable, chassis or card which contains devices for a particular subsystem or function. |
Other | A chassis that does not fit any of these definitions. |
Pod | A collection of equipment racks in a large, likely transportable, container. |
Rack | An equipment rack, typically a 19-inch wide freestanding unit. |
RackGroup | A group of racks which form a single entity or share infrastructure. |
RackMount | A single system chassis designed specifically for mounting in an equipment rack. |
Row | A collection of equipment racks. |
Shelf | An enclosed or semi-enclosed, typically horizontally-oriented, system chassis which must be plugged into a multi-system chassis to function normally. |
Sidecar | A chassis that mates mechanically with another chassis to expand its capabilities or capacity. |
Sled | An enclosed or semi-enclosed, system chassis which must be plugged into a multi-system chassis to function normally similar to a blade type chassis. |
StandAlone | A single, free-standing system, commonly called a tower or desktop chassis. |
StorageEnclosure | A chassis which encloses storage. |
Zone | A logical division or portion of a physical chassis that contains multiple devices or systems that cannot be physically separated. |
IndicatorLED:
The state of the indicator LED, used to identify the chassis.
string | Description |
---|---|
Blinking | The Indicator LED is blinking. |
Lit | The Indicator LED is lit. |
Off | The Indicator LED is off. |
Unknown | The state of the Indicator LED cannot be determined. This value has been Deprecated in favor of returning null if the state is unknown. |
IntrusionSensor:
This indicates the known state of the physical security sensor, such as if it is hardware intrusion detected.
string | Description |
---|---|
HardwareIntrusion | A door, lock, or other mechanism protecting the internal system hardware from being accessed is detected as being in an insecure state. |
Normal | No abnormal physical security conditions are detected at this time. |
TamperingDetected | Physical tampering of the monitored entity is detected. |
IntrusionSensorReArm:
This indicates how the Normal state to be restored.
string | Description |
---|---|
Automatic | This sensor would be restored to the Normal state automatically as no abnormal physical security conditions are detected. |
Manual | This sensor would be restored to the Normal state by a manual re-arm. |
PowerState:
The current power state of the chassis.
string | Description |
---|---|
Off | The components within the chassis has no power, except some components may continue to have AUX power such as management controller. |
On | The components within the chassis has power on. |
PoweringOff | A temporary state between On and Off. The components within the chassis can take time to process the power off action. |
PoweringOn | A temporary state between Off and On. The components within the chassis can take time to process the power on action. |
ResetType:
The type of reset to be performed.
string | Description |
---|---|
ForceOff | Turn the unit off immediately (non-graceful shutdown). |
ForceOn | Turn the unit on immediately. |
ForceRestart | Perform an immediate (non-graceful) shutdown, followed by a restart. |
GracefulRestart | Perform a graceful shutdown followed by a restart of the system. |
GracefulShutdown | Perform a graceful shutdown and power off. |
Nmi | Generate a Diagnostic Interrupt (usually an NMI on x86 systems) to cease normal operations, perform diagnostic actions and typically halt the system. |
On | Turn the unit on. |
PowerCycle | Perform a power cycle of the unit. |
PushPowerButton | Simulate the pressing of the physical power button on this unit. |
ComputerSystem 1.5.0
This schema defines a computer system and its respective properties. A computer system represents a machine (physical or virtual) and the local resources such as memory, cpu and other devices that can be accessed from that machine.
AssetTag | string read-write (null) |
The user definable tag that can be used to track this computer system for inventory or other client purposes. |
Bios {} | object | A reference to the BIOS settings associated with this system. See the Bios schema for details on this property. |
BiosVersion | string read-only (null) |
The version of the system BIOS or primary system firmware. |
Boot { | object | Information about the boot settings for this system. |
BootNext | string read-write (null) |
This property is the BootOptionReference of the Boot Option to perform a one time boot from when BootSourceOverrideTarget is UefiBootNext. |
BootOptions { | object | A reference to the collection of the UEFI Boot Options associated with this Computer System. Contains a link to a resource. |
@odata.id | string read-only |
Link to Collection of BootOption. See the BootOption schema for details. |
} | ||
BootOrder [ ] | array (string, null) read-write |
Ordered array of BootOptionReference strings representing the persistent Boot Order associated with this computer system. |
BootSourceOverrideEnabled | string (enum) read-write (null) |
Describes the state of the Boot Source Override feature. For the possible property values, see BootSourceOverrideEnabled in Property Details. |
BootSourceOverrideMode | string (enum) read-write (null) |
The BIOS Boot Mode (either Legacy or UEFI) to be used when BootSourceOverrideTarget boot source is booted from. For the possible property values, see BootSourceOverrideMode in Property Details. |
BootSourceOverrideTarget | string (enum) read-write (null) |
The current boot source to be used at next boot instead of the normal boot device, if BootSourceOverrideEnabled is true. For the possible property values, see BootSourceOverrideTarget in Property Details. |
UefiTargetBootSourceOverride | string read-write (null) |
This property is the UEFI Device Path of the device to boot from when BootSourceOverrideTarget is UefiTarget. |
} | ||
Description | string read-only (null) |
Provides a description of this resource and is used for commonality in the schema definitions. |
EthernetInterfaces { | object | A reference to the collection of Ethernet interfaces associated with this system. Contains a link to a resource. |
@odata.id | string read-only |
Link to Collection of EthernetInterface. See the EthernetInterface schema for details. |
} | ||
HostedServices { | object | The services that this computer system supports. |
Oem {} | object | Oem extension object. See the Resource schema for details on this property. |
StorageServices | read-only |
A reference to a collection of storage services supported by this computer system. |
} | ||
HostingRoles [ ] | array (string (enum)) read-only |
The hosing roles that this computer system supports. The enumerations of HostingRoles specify different features that the hosting ComputerSystem supports. For the possible property values, see HostingRoles in Property Details. |
HostName | string read-write (null) |
The DNS Host Name, without any domain information. |
HostWatchdogTimer { | object | This object describes the Host Watchdog Timer functionality for this system. |
FunctionEnabled | boolean read-write required (null) |
This indicates if the Host Watchdog Timer functionality has been enabled. Additional host-based software is necessary to activate the timer function. |
Oem {} | object | Oem extension object. See the Resource schema for details on this property. |
Status {} | object | This type describes the status and health of a resource and its children. See the Resource schema for details on this property. |
TimeoutAction | string (enum) read-write required (null) |
This property indicates the action to perform when the Watchdog Timer reaches its timeout value. For the possible property values, see TimeoutAction in Property Details. |
WarningAction | string (enum) read-write (null) |
This property indicates the action to perform when the Watchdog Timer is close (typically 3-10 seconds) to reaching its timeout value. For the possible property values, see WarningAction in Property Details. |
} | ||
Id | string read-only required |
Uniquely identifies the resource within the collection of like resources. |
IndicatorLED | string (enum) read-write (null) |
The state of the indicator LED, used to identify the system. For the possible property values, see IndicatorLED in Property Details. |
Links { | object | Contains references to other resources that are related to this resource. |
Chassis [ { | array | An array of references to the chassis in which this system is contained. |
@odata.id | string read-only |
Link to a Chassis resource. See the Links section and the Chassis schema for details. |
} ] | ||
ConsumingComputerSystems [ { | array | An array of references to ComputerSystems that are realized, in whole or in part, from this ComputerSystem. |
@odata.id | string read-only |
Link to another ComputerSystem resource. |
} ] | ||
CooledBy [ { | array | An array of ID[s] of resources that cool this computer system. Normally the ID will be a chassis or a specific set of fans. |
@odata.id | string read-only |
The unique identifier for a resource. |
} ] | ||
Endpoints [ { } ] | array (object) | An array of references to the endpoints that connect to this system. This is the schema definition for the Endpoint resource. It represents the properties of an entity that sends or receives protocol defined messages over a transport. See the Endpoint schema for details on this property. |
ManagedBy [ { | array | An array of references to the Managers responsible for this system. |
@odata.id | string read-only |
Link to a Manager resource. See the Links section and the Manager schema for details. |
} ] | ||
Oem {} | object | Oem extension object. See the Resource schema for details on this property. |
PoweredBy [ { | array | An array of ID[s] of resources that power this computer system. Normally the ID will be a chassis or a specific set of Power Supplies. |
@odata.id | string read-only |
The unique identifier for a resource. |
} ] | ||
ResourceBlocks [ { } ] | array (object) | An array of references to the Resource Blocks that are used in this Computer System. This schema defines a Resource Block resource. See the ResourceBlock schema for details on this property. |
SupplyingComputerSystems [ { | array | An array of references to ComputerSystems that contribute, in whole or in part, to the implementation of this ComputerSystem. |
@odata.id | string read-only |
Link to another ComputerSystem resource. |
} ] | ||
} | ||
LogServices { | object | A reference to the collection of Log Services associated with this system. Contains a link to a resource. |
@odata.id | string read-only |
Link to Collection of LogService. See the LogService schema for details. |
} | ||
Manufacturer | string read-only (null) |
The manufacturer or OEM of this system. |
Memory { | object | A reference to the collection of Memory associated with this system. Contains a link to a resource. |
@odata.id | string read-only |
Link to Collection of Memory. See the Memory schema for details. |
} | ||
MemoryDomains { | object (null) |
A reference to the collection of Memory Domains associated with this system. Contains a link to a resource. |
@odata.id | string read-only |
Link to Collection of MemoryDomain. See the MemoryDomain schema for details. |
} | ||
MemorySummary { | object | This object describes the central memory of the system in general detail. |
MemoryMirroring | string (enum) read-only (null) |
The ability and type of memory mirroring supported by this system. For the possible property values, see MemoryMirroring in Property Details. |
Status {} | object | This type describes the status and health of a resource and its children. See the Resource schema for details on this property. |
TotalSystemMemoryGiB | number read-only (null) |
The total configured operating system-accessible memory (RAM), measured in GiB. |
TotalSystemPersistentMemoryGiB | number read-only (null) |
The total configured, system-accessible persistent memory, measured in GiB. |
} | ||
Model | string read-only (null) |
The product name for this system, without the manufacturer name. |
Name | string read-only required |
The name of the resource or array element. |
NetworkInterfaces { | object | A reference to the collection of Network Interfaces associated with this system. Contains a link to a resource. |
@odata.id | string read-only |
Link to Collection of NetworkInterface. See the NetworkInterface schema for details. |
} | ||
Oem {} | object | This is the manufacturer/provider specific extension moniker used to divide the Oem object into sections. See the Resource schema for details on this property. |
PartNumber | string read-only (null) |
The part number for this system. |
PCIeDevices [ { | array | A reference to a collection of PCIe Devices used by this computer system. |
@odata.id | string read-only |
Link to a PCIeDevice resource. See the Links section and the PCIeDevice schema for details. |
} ] | ||
PCIeFunctions [ { | array | A reference to a collection of PCIe Functions used by this computer system. |
@odata.id | string read-only |
Link to a PCIeFunction resource. See the Links section and the PCIeFunction schema for details. |
} ] | ||
PowerState | string (enum) read-only (null) |
This is the current power state of the system. For the possible property values, see PowerState in Property Details. |
Processors { | object | A reference to the collection of Processors associated with this system. Contains a link to a resource. |
@odata.id | string read-only |
Link to Collection of Processor. See the Processor schema for details. |
} | ||
ProcessorSummary { | object | This object describes the central processors of the system in general detail. |
Count | number read-only (null) |
The number of physical processors in the system. |
LogicalProcessorCount | number read-only (null) |
The number of logical processors in the system. |
Model | string read-only (null) |
The processor model for the primary or majority of processors in this system. |
Status {} | object | This type describes the status and health of a resource and its children. See the Resource schema for details on this property. |
} | ||
Redundancy [ { | array | A reference to a collection of Redundancy entities that each name a set of computer systems that provide redundancy for this ComputerSystem. |
@odata.id | string read-only |
The unique identifier for a resource. |
} ] | ||
SecureBoot { | object | A reference to the UEFI SecureBoot resource associated with this system. See the SecureBoot schema for details on this property. |
@odata.id | string read-only |
Link to a SecureBoot resource. See the Links section and the SecureBoot schema for details. |
} | ||
SerialNumber | string read-only (null) |
The serial number for this system. |
SimpleStorage { | object | A reference to the collection of storage devices associated with this system. Contains a link to a resource. |
@odata.id | string read-only |
Link to Collection of SimpleStorage. See the SimpleStorage schema for details. |
} | ||
SKU | string read-only (null) |
The manufacturer SKU for this system. |
Status {} | object | This type describes the status and health of a resource and its children. See the Resource schema for details on this property. |
Storage { | object | A reference to the collection of storage devices associated with this system. Contains a link to a resource. |
@odata.id | string read-only |
Link to Collection of Storage. See the Storage schema for details. |
} | ||
SubModel | string read-only (null) |
The sub-model for this system. |
SystemType | string (enum) read-only |
The type of computer system represented by this resource. For the possible property values, see SystemType in Property Details. |
TrustedModules [ { | array | This object describes the array of Trusted Modules in the system. |
FirmwareVersion | string read-only (null) |
The firmware version of this Trusted Module. |
FirmwareVersion2 | string read-only (null) |
The 2nd firmware version of this Trusted Module, if applicable. |
InterfaceType | string (enum) read-only (null) |
This property indicates the interface type of the Trusted Module. For the possible property values, see InterfaceType in Property Details. |
InterfaceTypeSelection | string (enum) read-only (null) |
The Interface Type selection supported by this Trusted Module. For the possible property values, see InterfaceTypeSelection in Property Details. |
Oem {} | object | Oem extension object. See the Resource schema for details on this property. |
Status {} | object | This type describes the status and health of a resource and its children. See the Resource schema for details on this property. |
} ] | ||
UUID | string read-only (null) |
The universal unique identifier (UUID) for this system. |
Actions
Reset
This action is used to reset the system.
URIs:
The following table shows the parameters for the action which are included in the POST body to the URI shown in the "target" property of the Action.
{ | ||
ResetType | string (enum) read-write |
The type of reset to be performed. For the possible property values, see ResetType in Property Details. |
} |
SetDefaultBootOrder
This action is used to set the Boot Order to the default settings.
URIs:
(This action takes no parameters.)
Property Details
BootSourceOverrideEnabled:
Describes the state of the Boot Source Override feature.
string | Description |
---|---|
Continuous | The system will boot to the target specified in the BootSourceOverrideTarget until this property is set to Disabled. |
Disabled | The system will boot normally. |
Once | On its next boot cycle, the system will boot (one time) to the Boot Source Override Target. The value of BootSourceOverrideEnabled is then reset back to Disabled. |
BootSourceOverrideMode:
The BIOS Boot Mode (either Legacy or UEFI) to be used when BootSourceOverrideTarget boot source is booted from.
string | Description |
---|---|
Legacy | The system will boot in non-UEFI boot mode to the Boot Source Override Target. |
UEFI | The system will boot in UEFI boot mode to the Boot Source Override Target. |
BootSourceOverrideTarget:
The current boot source to be used at next boot instead of the normal boot device, if BootSourceOverrideEnabled is true.
string | Description |
---|---|
BiosSetup | Boot to the BIOS Setup Utility. |
Cd | Boot from the CD/DVD disc. |
Diags | Boot the manufacturer's Diagnostics program. |
Floppy | Boot from the floppy disk drive. |
Hdd | Boot from a hard drive. |
None | Boot from the normal boot device. |
Pxe | Boot from the Pre-Boot EXecution (PXE) environment. |
RemoteDrive | Boot from a remote drive (e.g. iSCSI). |
SDCard | Boot from an SD Card. |
UefiBootNext | Boot to the UEFI Device specified in the BootNext property. |
UefiHttp | Boot from a UEFI HTTP network location. |
UefiShell | Boot to the UEFI Shell. |
UefiTarget | Boot to the UEFI Device specified in the UefiTargetBootSourceOverride property. |
Usb | Boot from a USB device as specified by the system BIOS. |
Utilities | Boot the manufacturer's Utilities program(s). |
HostingRoles:
The hosing roles that this computer system supports. The enumerations of HostingRoles specify different features that the hosting ComputerSystem supports.
string | Description |
---|---|
ApplicationServer | The system hosts functionality that supports general purpose applications. |
StorageServer | The system hosts functionality that supports the system acting as a storage server. |
Switch | The system hosts functionality that supports the system acting as a switch. |
IndicatorLED:
The state of the indicator LED, used to identify the system.
string | Description |
---|---|
Blinking | The Indicator LED is blinking. |
Lit | The Indicator LED is lit. |
Off | The Indicator LED is off. |
Unknown | The state of the Indicator LED cannot be determined. This value has been Deprecated in favor of returning null if the state is unknown. |
InterfaceType:
This property indicates the interface type of the Trusted Module.
string | Description |
---|---|
TCM1_0 | Trusted Cryptography Module (TCM) 1.0. |
TPM1_2 | Trusted Platform Module (TPM) 1.2. |
TPM2_0 | Trusted Platform Module (TPM) 2.0. |
InterfaceTypeSelection:
The Interface Type selection supported by this Trusted Module.
string | Description |
---|---|
BiosSetting | The TrustedModule supports switching InterfaceType via platform software, such as a BIOS configuration Attribute. |
FirmwareUpdate | The TrustedModule supports switching InterfaceType via a firmware update. |
None | The TrustedModule does not support switching the InterfaceType. |
OemMethod | The TrustedModule supports switching InterfaceType via an OEM proprietary mechanism. |
MemoryMirroring:
The ability and type of memory mirroring supported by this system.
string | Description |
---|---|
DIMM | The system supports DIMM mirroring at the DIMM level. Individual DIMMs can be mirrored. |
Hybrid | The system supports a hybrid mirroring at the system and DIMM levels. Individual DIMMs can be mirrored. |
None | The system does not support DIMM mirroring. |
System | The system supports DIMM mirroring at the System level. Individual DIMMs are not paired for mirroring in this mode. |
PowerState:
This is the current power state of the system.
string | Description |
---|---|
Off | The system is powered off, although some components may continue to have AUX power such as management controller. |
On | The system is powered on. |
PoweringOff | A temporary state between On and Off. The power off action can take time while the OS is in the shutdown process. |
PoweringOn | A temporary state between Off and On. This temporary state can be very short. |
ResetType:
The type of reset to be performed.
string | Description |
---|---|
ForceOff | Turn the unit off immediately (non-graceful shutdown). |
ForceOn | Turn the unit on immediately. |
ForceRestart | Perform an immediate (non-graceful) shutdown, followed by a restart. |
GracefulRestart | Perform a graceful shutdown followed by a restart of the system. |
GracefulShutdown | Perform a graceful shutdown and power off. |
Nmi | Generate a Diagnostic Interrupt (usually an NMI on x86 systems) to cease normal operations, perform diagnostic actions and typically halt the system. |
On | Turn the unit on. |
PowerCycle | Perform a power cycle of the unit. |
PushPowerButton | Simulate the pressing of the physical power button on this unit. |
SystemType:
The type of computer system represented by this resource.
string | Description |
---|---|
Composed | A computer system that has been created by binding resource blocks together. |
OS | An operating system instance. |
Physical | A computer system. |
PhysicallyPartitioned | A hardware-based partition of a computer system. |
Virtual | A virtual machine instance running on this system. |
VirtuallyPartitioned | A virtual or software-based partition of a computer system. |
TimeoutAction:
This property indicates the action to perform when the Watchdog Timer reaches its timeout value.
string | Description |
---|---|
None | No action taken. |
OEM | Perform an OEM-defined action. |
PowerCycle | Power cycle the system. |
PowerDown | Power down the system. |
ResetSystem | Reset the system. |
WarningAction:
This property indicates the action to perform when the Watchdog Timer is close (typically 3-10 seconds) to reaching its timeout value.
string | Description |
---|---|
DiagnosticInterrupt | Raise a (typically non-maskable) Diagnostic Interrupt. |
MessagingInterrupt | Raise a legacy IPMI messaging interrupt. |
None | No action taken. |
OEM | Perform an OEM-defined action. |
SCI | Raise an interrupt using the ACPI System Control Interrupt (SCI). |
SMI | Raise a Systems Management Interrupt (SMI). |
Drive 1.4.0
The Drive schema represents a single physical disk drive for a system, including links to associated Volumes.
Assembly {} | object | A reference to the Assembly resource associated with this drive. See the Assembly schema for details on this property. |
AssetTag | string read-write (null) |
The user assigned asset tag for this drive. |
BlockSizeBytes | number (Bytes) read-only (null) |
The size of the smallest addressible unit (Block) of this drive in bytes. |
CapableSpeedGbs | number (Gbit/s) read-only (null) |
The speed which this drive can communicate to a storage controller in ideal conditions in Gigabits per second. |
CapacityBytes | number (Bytes) read-only (null) |
The size in bytes of this Drive. |
Description | string read-only (null) |
Provides a description of this resource and is used for commonality in the schema definitions. |
EncryptionAbility | string (enum) read-only (null) |
The encryption abilities of this drive. For the possible property values, see EncryptionAbility in Property Details. |
EncryptionStatus | string (enum) read-only (null) |
The status of the encrytion of this drive. For the possible property values, see EncryptionStatus in Property Details. |
FailurePredicted | boolean read-only (null) |
Is this drive currently predicting a failure in the near future. |
HotspareType | string (enum) read-only (null) |
The type of hotspare this drive is currently serving as. For the possible property values, see HotspareType in Property Details. |
Id | string read-only required |
Uniquely identifies the resource within the collection of like resources. |
Identifiers [ { } ] | array (object) | The Durable names for the drive. This type describes any additional identifiers for a resource. See the Resource schema for details on this property. |
IndicatorLED | string (enum) read-write (null) |
The state of the indicator LED, used to identify the drive. For the possible property values, see IndicatorLED in Property Details. |
Links { | object | Contains references to other resources that are related to this resource. |
Chassis { | object | A reference to the Chassis which contains this Drive. See the Chassis schema for details on this property. |
@odata.id | string read-only |
Link to a Chassis resource. See the Links section and the Chassis schema for details. |
} | ||
Endpoints [ { } ] | array (object) | An array of references to the endpoints that connect to this drive. This is the schema definition for the Endpoint resource. It represents the properties of an entity that sends or receives protocol defined messages over a transport. See the Endpoint schema for details on this property. |
Oem {} | object | Oem extension object. See the Resource schema for details on this property. |
Volumes [ { | array | An array of references to the volumes contained in this drive. This will reference Volumes that are either wholly or only partly contained by this drive. |
@odata.id | string read-only |
Link to a Volume resource. See the Links section and the Volume schema for details. |
} ] | ||
} | ||
Location [ { } ] | array (object) | The Location of the drive. This type describes the location of a resource. See the Resource schema for details on this property. |
Manufacturer | string read-only (null) |
This is the manufacturer of this drive. |
MediaType | string (enum) read-only (null) |
The type of media contained in this drive. For the possible property values, see MediaType in Property Details. |
Model | string read-only (null) |
This is the model number for the drive. |
Name | string read-only required |
The name of the resource or array element. |
NegotiatedSpeedGbs | number (Gbit/s) read-only (null) |
The speed which this drive is currently communicating to the storage controller in Gigabits per second. |
Oem {} | object | This is the manufacturer/provider specific extension moniker used to divide the Oem object into sections. See the Resource schema for details on this property. |
Operations [ { | array | The operations currently running on the Drive. |
AssociatedTask { | object | A reference to the task associated with the operation if any. See the Task schema for details on this property. |
@odata.id | string read-only |
Link to a Task resource. See the Links section and the Task schema for details. |
} | ||
OperationName | string read-only (null) |
The name of the operation. |
PercentageComplete | number read-only (null) |
The percentage of the operation that has been completed. |
} ] | ||
PartNumber | string read-only (null) |
The part number for this drive. |
PhysicalLocation {} | object | The Location of the drive. See the Resource schema for details on this property. |
PredictedMediaLifeLeftPercent | number read-only (null) |
The percentage of reads and writes that are predicted to still be available for the media. |
Protocol | string (enum) read-only (null) |
The protocol this drive is using to communicate to the storage controller. For the possible property values, see Protocol in Property Details. |
Revision | string read-only (null) |
The revision of this Drive. This is typically the firmware/hardware version of the drive. |
RotationSpeedRPM | number (RPM) read-only (null) |
The rotation speed of this Drive in Revolutions per Minute (RPM). |
SerialNumber | string read-only (null) |
The serial number for this drive. |
SKU | string read-only (null) |
This is the SKU for this drive. |
Status {} | object | This type describes the status and health of a resource and its children. See the Resource schema for details on this property. |
StatusIndicator | string (enum) read-write (null) |
The state of the status indicator, used to communicate status information about this drive. For the possible property values, see StatusIndicator in Property Details. |
Actions
SecureErase
This action is used to securely erase the contents of the drive.
URIs:
(This action takes no parameters.)
Property Details
EncryptionAbility:
The encryption abilities of this drive.
string | Description |
---|---|
None | The drive is not capable of self encryption. |
Other | The drive is capable of self encryption through some other means. |
SelfEncryptingDrive | The drive is capable of self encryption per the Trusted Computing Group's Self Encrypting Drive Standard. |
EncryptionStatus:
The status of the encrytion of this drive.
string | Description |
---|---|
Foreign | The drive is currently encrypted, the data is not accessible to the user, and the system requires user intervention to expose the data. |
Locked | The drive is currently encrypted and the data is not accessible to the user, however the system has the ability to unlock the drive automatically. |
Unecrypted | The drive is not currently encrypted. This value has been Deprecated in favor of Unencrypted. |
Unencrypted | The drive is not currently encrypted. |
Unlocked | The drive is currently encrypted but the data is accessible to the user unencrypted. |
HotspareType:
The type of hotspare this drive is currently serving as.
string | Description |
---|---|
Chassis | The drive is currently serving as a hotspare for all other drives in the chassis. |
Dedicated | The drive is currently serving as a hotspare for a user defined set of drives. |
Global | The drive is currently serving as a hotspare for all other drives in the storage system. |
None | The drive is not currently a hotspare. |
IndicatorLED:
The state of the indicator LED, used to identify the drive.
string | Description |
---|---|
Blinking | The Indicator LED is blinking. |
Lit | The Indicator LED is lit. |
Off | The Indicator LED is off. |
MediaType:
The type of media contained in this drive.
string | Description |
---|---|
HDD | The drive media type is traditional magnetic platters. |
SMR | The drive media type is shingled magnetic recording. |
SSD | The drive media type is solid state or flash memory. |
Protocol:
The protocol this drive is using to communicate to the storage controller.
string | Description |
---|---|
AHCI | Advanced Host Controller Interface. |
FC | Fibre Channel. |
FCoE | Fibre Channel over Ethernet. |
FCP | Fibre Channel Protocol for SCSI. |
FICON | FIbre CONnection (FICON). |
FTP | File Transfer Protocol. |
HTTP | Hypertext Transport Protocol. |
HTTPS | Secure Hypertext Transport Protocol. |
iSCSI | Internet SCSI. |
iWARP | Internet Wide Area Remote Direct Memory Access Protocol. |
NFSv3 | Network File System version 3. |
NFSv4 | Network File System version 4. |
NVMe | Non-Volatile Memory Express. |
NVMeOverFabrics | NVMe over Fabrics. |
OEM | OEM specific. |
PCIe | PCI Express (Vendor Proprietary). |
RoCE | RDMA over Converged Ethernet Protocol. |
RoCEv2 | RDMA over Converged Ethernet Protocol Version 2. |
SAS | Serial Attached SCSI. |
SATA | Serial AT Attachment. |
SFTP | Secure File Transfer Protocol. |
SMB | Server Message Block (aka CIFS Common Internet File System). |
UHCI | Universal Host Controller Interface. |
USB | Universal Serial Bus. |
StatusIndicator:
The state of the status indicator, used to communicate status information about this drive.
string | Description |
---|---|
Fail | The drive has failed. |
Hotspare | The drive is marked to be automatically rebuilt and used as a replacement for a failed drive. |
InACriticalArray | The array that this drive is a part of is degraded. |
InAFailedArray | The array that this drive is a part of is failed. |
OK | The drive is OK. |
PredictiveFailureAnalysis | The drive is still working but predicted to fail soon. |
Rebuild | The drive is being rebuilt. |
EthernetInterface 1.6.0
The EthernetInterface schema represents a single, logical Ethernet interface or network interface controller (NIC).
AutoNeg | boolean read-write (null) |
An indication of whether the speed and duplex are automatically negotiated and configured on this interface. |
Description | string read-only (null) |
Provides a description of this resource and is used for commonality in the schema definitions. |
DHCPv4 { | object (null) |
DHCPv4 configuration for this interface. |
DHCPEnabled | boolean read-write (null) |
An indication of whether DHCP v4 is enabled on this Ethernet interface. |
UseDNSServers | boolean read-write (null) |
An indication of whether this interface uses DHCP v4-supplied DNS servers. |
UseDomainName | boolean read-write (null) |
An indication of whether this interface uses a DHCP v4-supplied domain name. |
UseGateway | boolean read-write (null) |
An indication of whether this interface uses a DHCP v4-supplied gateway. |
UseNTPServers | boolean read-write (null) |
An indication of whether the interface uses DHCP v4-supplied NTP servers. |
UseStaticRoutes | boolean read-write (null) |
An indication of whether the interface uses DHCP v4-supplied static routes. |
} | ||
DHCPv6 { | object (null) |
DHCPv6 configuration for this interface. |
OperatingMode | string (enum) read-write (null) |
Determines the DHCPv6 operating mode for this interface. For the possible property values, see OperatingMode in Property Details. |
UseDNSServers | boolean read-write (null) |
An indication of whether the interface uses DHCP v6-supplied DNS servers. |
UseDomainName | boolean read-write (null) |
An indication of whether the interface uses a domain name supplied through DHCP v6 stateless mode. |
UseNTPServers | boolean read-write (null) |
An indication of whether the interface uses DHCP v6-supplied NTP servers. |
UseRapidCommit | boolean read-write (null) |
An indication of whether the interface uses DHCP v6 rapid commit mode for stateful mode address assignments. Do not enable this option in networks where more than one DHCP v6 server is configured to provide address assignments. |
} | ||
FQDN | string read-write (null) |
The complete, fully qualified domain name that DNS obtains for this interface. |
FullDuplex | boolean read-write (null) |
An indication of whether full-duplex mode is enabled on the Ethernet connection for this interface. |
HostName | string read-write (null) |
The DNS host name, without any domain information. |
Id | string read-only required |
Uniquely identifies the resource within the collection of like resources. |
InterfaceEnabled | boolean read-write (null) |
An indication of whether this interface is enabled. |
IPv4Addresses [ { } ] | array (object) | The IPv4 addresses currently assigned to this interface. This type describes an IPv4 Address. See the redfish.dmtf.org/schemas/v1/IPAddresses.v1_0_6.json schema for details on this property. |
IPv4StaticAddresses [ { } ] | array (object) | The IPv4 static addresses assigned to this interface. This type describes an IPv4 Address. See the redfish.dmtf.org/schemas/v1/IPAddresses.v1_0_6.json schema for details on this property. |
IPv6Addresses [ { } ] | array (object) | An array of the currently assigned IPv6 addresses on this interface. This type describes an IPv6 Address. See the redfish.dmtf.org/schemas/v1/IPAddresses.v1_0_6.json schema for details on this property. |
IPv6AddressPolicyTable [ { | array | An array that represents the RFC6724-defined address selection policy table. |
Label | integer read-write (null) |
The IPv6 label, as defined in RFC6724, section 2.1. |
Precedence | integer read-write (null) |
The IPv6 precedence, as defined in RFC6724, section 2.1. |
Prefix | string read-write (null) |
The IPv6 address prefix, as defined in RFC6724, section 2.1. |
} ] | ||
IPv6DefaultGateway | string read-only (null) |
The IPv6 default gateway address in use on this interface. |
IPv6StaticAddresses [ { } ] | array (object) | An array of the IPv6 static addresses to assign on this interface. This object represents a single IPv6 static address to be assigned on a network interface. See the redfish.dmtf.org/schemas/v1/IPAddresses.v1_0_6.json schema for details on this property. |
IPv6StaticDefaultGateways [ { } ] | array (object) | The IPv6 static default gateways for this interface. This object represents a single IPv6 static address to be assigned on a network interface. See the IPAddresses schema for details on this property. |
Links { | object | The links to other resources that are related to this resource. |
Chassis { | object | The link to the chassis that contains this Ethernet interface. |
@odata.id | string read-only |
The unique identifier for a resource. |
} | ||
Endpoints [ { } ] | array (object) | An array of references to the endpoints that connect to this ethernet interface. This is the schema definition for the Endpoint resource. It represents the properties of an entity that sends or receives protocol defined messages over a transport. See the Endpoint schema for details on this property. |
HostInterface {} | object | This is a reference to a Host Interface that is associated with this Ethernet Interface. See the HostInterface schema for details on this property. |
Oem {} | object | Oem extension object. See the Resource schema for details on this property. |
} | ||
LinkStatus | string (enum) read-only (null) |
The link status of this interface, or port. For the possible property values, see LinkStatus in Property Details. |
MACAddress | string read-write (null) |
The currently configured MAC address of the interface, or logical port. |
MaxIPv6StaticAddresses | integer read-only (null) |
The maximum number of static IPv6 addresses that can be configured on this interface. |
MTUSize | integer read-write (null) |
The currently configured maximum transmission unit (MTU), in bytes, on this interface. |
Name | string read-only required |
The name of the resource or array element. |
NameServers [ ] | array (string) read-only |
The DNS servers in use on this interface. |
NameServersIPv6 [ ] | array (string, null) read-only |
The IPV6 DNS name servers to be used for retrieving the host name. |
Oem {} | object | The OEM extension property. See the redfish.dmtf.org/schemas/v1/Resource.json schema for details on this property. |
PermanentMACAddress | string read-only (null) |
The permanent MAC address assigned to this interface, or port. |
SpeedMbps | integer (Mbit/s) read-write (null) |
The current speed, in Mbit/s, of this interface. |
StatelessAddressAutoConfig { | object (null) |
Stateless address autoconfiguration (SLAAC) parameters for this interface. |
IPv4AutoConfigEnabled | boolean read-write (null) |
An indication of whether IPv4 stateless address autoconfiguration (SLAAC) is enabled for this interface. |
IPv6AutoConfigEnabled | boolean read-write (null) |
An indication of whether IPv6 stateless address autoconfiguration (SLAAC) is enabled for this interface. |
} | ||
StaticNameServers [ ] | array (string) read-write |
The statically-defined set of DNS server IPv4 and IPv6 addresses. |
Status {} | object (null) |
The status and health of the resource and its subordinate or dependent resources. See the redfish.dmtf.org/schemas/v1/Resource.json schema for details on this property. |
UefiDevicePath | string read-only (null) |
The UEFI device path for this interface. |
VLAN {} | object (null) |
If this network interface supports more than one VLAN, this property is absent. VLAN collections appear in the Links property of this resource. See the redfish.dmtf.org/schemas/v1/VLanNetworkInterface.v1_1_2.json schema for details on this property. |
VLANs { | object | The link to a collection of VLANs, which applies only if the interface supports more than one VLAN. If this property applies, the VLANEnabled and VLANId properties do not apply. |
@odata.id | string read-only |
Link to Collection of VLanNetworkInterface. See the VLanNetworkInterface schema for details. |
} |
Property Details
LinkStatus:
The link status of this interface (port).
string | Description |
---|---|
LinkDown | There is no link on this interface, but the interface is connected. |
LinkUp | The link is available for communication on this interface. |
NoLink | There is no link or connection detected on this interface. |
OperatingMode:
Determines the DHCPv6 operating mode for this interface.
string | Description |
---|---|
Disabled | DHCPv6 is disabled. |
Stateful | DHCPv6 stateful mode. |
Stateless | DHCPv6 stateless mode. |
Event 1.2.1
The Event schema describes the JSON payload received by an Event Destination (which has subscribed to event notification) when events occurs. This resource contains data about event(s), including descriptions, severity and MessageId reference to a Message Registry that can be accessed for further information.
Context | string read-only |
A context can be supplied at subscription time. This property is the context value supplied by the subscriber. |
Description | string read-only (null) |
Provides a description of this resource and is used for commonality in the schema definitions. |
Events [ { | array * required* |
Each event in this array has a set of properties that describe the event. Since this is an array, more than one event can be sent simultaneously. |
Actions {} | object | The available actions for this resource. |
Context | string read-only |
A context can be supplied at subscription time. This property is the context value supplied by the subscriber. |
EventId | string read-only |
This is a unique instance identifier of an event. |
EventTimestamp | string read-only |
This is time the event occurred. |
EventType | string (enum) read-only required |
This indicates the type of event sent, according to the definitions in the EventService. For the possible property values, see EventType in Property Details. |
MemberId | string read-only |
This is the identifier for the member within the collection. |
Message | string read-only |
This is the human readable message, if provided. |
MessageArgs [ ] | array (string) read-only |
This array of message arguments are substituted for the arguments in the message when looked up in the message registry. |
MessageId | string read-only required |
This is the key for this message which can be used to look up the message in a message registry. |
Oem {} | object | This is the manufacturer/provider specific extension moniker used to divide the Oem object into sections. See the Resource schema for details on this property. |
OriginOfCondition { | object | This indicates the resource that originated the condition that caused the event to be generated. |
@odata.id | string read-only |
The unique identifier for a resource. |
} | ||
Severity | string read-only |
This is the severity of the event. |
} ] | ||
Id | string read-only required |
Uniquely identifies the resource within the collection of like resources. |
Name | string read-only required |
The name of the resource or array element. |
Oem {} | object | This is the manufacturer/provider specific extension moniker used to divide the Oem object into sections. See the Resource schema for details on this property. |
Property Details
EventType:
This indicates the type of event sent, according to the definitions in the EventService.
string | Description |
---|---|
Alert | A condition exists which requires attention. |
ResourceAdded | A resource has been added. |
ResourceRemoved | A resource has been removed. |
ResourceUpdated | The value of this resource has been updated. |
StatusChange | The status of this resource has changed. |
EventDestination 1.3.0
An Event Destination desribes the target of an event subscription, including the types of events subscribed and context to provide to the target in the Event payload.
Context | string read-write required (null) |
A client-supplied string that is stored with the event destination subscription. |
Description | string read-only (null) |
Provides a description of this resource and is used for commonality in the schema definitions. |
Destination | string read-only required on create |
The URI of the destination Event Service. |
EventTypes [ ] | array (string (enum)) read-only |
This property shall contain the types of events that shall be sent to the desination. For the possible property values, see EventTypes in Property Details. |
HttpHeaders [ { | array | This is for setting HTTP headers, such as authorization information. This object will be null on a GET. |
(pattern) | string read-write |
Property names follow regular expression pattern "^[^:\\s]+$" |
} ] | ||
Id | string read-only required |
Uniquely identifies the resource within the collection of like resources. |
MessageIds [ ] | array (string, null) read-only |
A list of MessageIds that the service will only send. If this property is absent or the array is empty, then Events with any MessageId will be sent to the subscriber. |
Name | string read-only required |
The name of the resource or array element. |
Oem {} | object | This is the manufacturer/provider specific extension moniker used to divide the Oem object into sections. See the Resource schema for details on this property. |
OriginResources [ { | array | A list of resources for which the service will only send related events. If this property is absent or the array is empty, then Events originating from any resource will be sent to the subscriber. |
@odata.id | string read-only |
The unique identifier for a resource. |
} ] | ||
Protocol | string (enum) read-only required on create |
The protocol type of the event connection. For the possible property values, see Protocol in Property Details. |
SubscriptionType | string (enum) read-only required (null) |
Indicates the subscription type for events. For the possible property values, see SubscriptionType in Property Details. |
Property Details
EventTypes:
This property shall contain the types of events that shall be sent to the desination.
string | Description |
---|---|
Alert | A condition exists which requires attention. |
ResourceAdded | A resource has been added. |
ResourceRemoved | A resource has been removed. |
ResourceUpdated | The value of this resource has been updated. |
StatusChange | The status of this resource has changed. |
Protocol:
The protocol type of the event connection.
string | Description |
---|---|
Redfish | The destination follows the Redfish specification for event notifications. |
SubscriptionType:
Indicates the subscription type for events.
string | Description |
---|---|
RedfishEvent | The subscription follows the Redfish specification for event notifications, which is done by a service sending an HTTP POST to the subscriber's destination URI. |
SSE | The subscription follows the HTML5 Server-Sent Event definition for event notifications. |
EventService 1.1.0
The Event Service resource contains properties for managing event subcriptions and generates the events sent to subscribers. The resource has links to the actual collection of subscriptions (called Event Destinations).
DeliveryRetryAttempts | number read-write |
This is the number of attempts an event posting is retried before the subscription is terminated. This retry is at the service level, meaning the HTTP POST to the Event Destination was returned by the HTTP operation as unsuccessful (4xx or 5xx return code) or an HTTP timeout occurred this many times before the Event Destination subscription is terminated. |
DeliveryRetryIntervalSeconds | number (seconds) read-write |
This represents the number of seconds between retry attempts for sending any given Event. |
Description | string read-only (null) |
Provides a description of this resource and is used for commonality in the schema definitions. |
EventTypesForSubscription [ ] | array (string (enum)) read-only |
This is the types of Events that can be subscribed to. For the possible property values, see EventTypesForSubscription in Property Details. |
Id | string read-only required |
Uniquely identifies the resource within the collection of like resources. |
Name | string read-only required |
The name of the resource or array element. |
Oem {} | object | This is the manufacturer/provider specific extension moniker used to divide the Oem object into sections. See the Resource schema for details on this property. |
ServerSentEventUri | string read-only |
Link to a URI for receiving Sever Sent Event representations of the events generated by this service. |
ServiceEnabled | boolean read-write (null) |
This indicates whether this service is enabled. |
Status {} | object | This type describes the status and health of a resource and its children. See the Resource schema for details on this property. |
Subscriptions { | object | This is a reference to a collection of Event Destination resources. Contains a link to a resource. |
@odata.id | string read-only |
Link to Collection of EventDestination. See the EventDestination schema for details. |
} |
Actions
SubmitTestEvent
This action is used to generate a test event.
URIs:
The following table shows the parameters for the action which are included in the POST body to the URI shown in the "target" property of the Action.
{ | ||
EventId | string read-write required |
This is the ID of event to be added. |
EventTimestamp | string read-write required |
This is the time stamp of event to be added. |
EventType | string (enum) read-write |
This is the type of event to be added. For the possible property values, see EventType in Property Details. |
Message | string read-write required |
This is the human readable message of event to be added. |
MessageArgs [ ] | array (string) read-write required |
This is the array of message arguments of the event to be added. |
MessageId | string read-write required |
This is the message ID of event to be added. |
OriginOfCondition | string read-write required |
This is the OriginOfCondition property of event to be added. |
Severity | string read-write required |
This is the Severity of event to be added. |
} |
Property Details
EventType:
This is the type of event to be added.
string | Description |
---|---|
Alert | A condition exists which requires attention. |
ResourceAdded | A resource has been added. |
ResourceRemoved | A resource has been removed. |
ResourceUpdated | The value of this resource has been updated. |
StatusChange | The status of this resource has changed. |
EventTypesForSubscription:
This is the types of Events that can be subscribed to.
string | Description |
---|---|
Alert | A condition exists which requires attention. |
ResourceAdded | A resource has been added. |
ResourceRemoved | A resource has been removed. |
ResourceUpdated | The value of this resource has been updated. |
StatusChange | The status of this resource has changed. |
HpeFwRev
Backup { | object | |
BuildNumber | integer read-only |
The build number of the firmware. |
BuildNumberString | string read-only |
The string version of the build number of the firmware. |
Date | string read-only |
The build date of the firmware. |
DebugBuild | boolean read-only |
True if the firmware is a debug build; False if it is not. |
Family | string read-only |
The family of the firmware. |
MajorVersion | integer read-only |
The major version of the firmware. |
MinorVersion | integer read-only |
The minor version of the firmware. |
Time | string read-only |
The build time of the firmware. |
VersionString | string read-only (null) |
The version string of the firmware. This value might be null if VersionString is unavailable. |
} | ||
Bootblock { | object | |
BuildNumber | integer read-only |
The build number of the firmware. |
BuildNumberString | string read-only |
The string version of the build number of the firmware. |
Date | string read-only |
The build date of the firmware. |
DebugBuild | boolean read-only |
True if the firmware is a debug build; False if it is not. |
Family | string read-only |
The family of the firmware. |
MajorVersion | integer read-only |
The major version of the firmware. |
MinorVersion | integer read-only |
The minor version of the firmware. |
Time | string read-only |
The build time of the firmware. |
VersionString | string read-only (null) |
The version string of the firmware. This value might be null if VersionString is unavailable. |
} | ||
Current { | object | |
BuildNumber | integer read-only |
The build number of the firmware. |
BuildNumberString | string read-only |
The string version of the build number of the firmware. |
Date | string read-only |
The build date of the firmware. |
DebugBuild | boolean read-only |
True if the firmware is a debug build; False if it is not. |
Family | string read-only |
The family of the firmware. |
MajorVersion | integer read-only |
The major version of the firmware. |
MinorVersion | integer read-only |
The minor version of the firmware. |
Time | string read-only |
The build time of the firmware. |
VersionString | string read-only (null) |
The version string of the firmware. This value might be null if VersionString is unavailable. |
} | ||
Pending { | object | |
BuildNumber | integer read-only |
The build number of the firmware. |
BuildNumberString | string read-only |
The string version of the build number of the firmware. |
Date | string read-only |
The build date of the firmware. |
DebugBuild | boolean read-only |
True if the firmware is a debug build; False if it is not. |
Family | string read-only |
The family of the firmware. |
MajorVersion | integer read-only |
The major version of the firmware. |
MinorVersion | integer read-only |
The minor version of the firmware. |
Time | string read-only |
The build time of the firmware. |
VersionString | string read-only (null) |
The version string of the firmware. This value might be null if VersionString is unavailable. |
} |
HpeHttpsCert
This is the schema definition for HpeHttpsCert.
CertificateSigningRequest | string read-only (null) |
When a GenerateCSR action is performed, this field contains the generated CSR (in Base64 format). Contains a public and private key pair. |
CertificateSigningRequestInformation { | object | The Country, State, City, OrgName, OrgUnit and CommonName with which the CSR was generated. |
City | string read-only |
The city or locality where the company or organization that owns this device is located. |
CommonName | string read-only |
The FQDN of this device. |
Country | string read-only |
The two-character country code where the company or organization that owns this device is located. Eg: US |
OrgName | string read-only |
The name of the company or organization that owns this device. |
OrgUnit | string read-only |
The unit within the company or organization that owns this device. |
State | string read-only |
The state where the company or organization that owns this device is located. |
} | ||
Id | string read-write |
Uniquely identifies the resource within the collection of like resources. |
Type | read-write |
|
X509CertificateInformation { | object | Contains the X509 Certificate Information. |
Issuer | string read-only |
The Certificate Authority that issued the certificate. |
SerialNumber | string read-only |
The serial number that the Certificate Authority assigned to the certificate. |
Subject | string read-only |
The entity to which the certificate was issued. |
ValidNotAfter | string read-only |
The date on which the certificate validity period ends. |
ValidNotBefore | string read-only |
The date on which the certificate validity period begins. |
} |
Actions
GenerateCSR
URIs:
(This action takes no parameters.)
GenerateSelfSignedCertificate
URIs:
(This action takes no parameters.)
ImportCACertificate
URIs:
(This action takes no parameters.)
ImportCertificate
URIs:
(This action takes no parameters.)
HpeMemoryExt
This is the schema definition for HpeMemoryExt.
DIMMStatus | string (enum) read-only (null) |
Specifies memory module status and whether the module in use. For the possible property values, see DIMMStatus in Property Details. |
Id | read-write |
|
Name | read-write |
|
Type | read-write |
Property Details
DIMMStatus:
Specifies memory module status and whether the module in use.
string | Description |
---|---|
AddedButUnused | DIMM is added but currently unused. |
ConfigurationError | Configuration error in DIMM. |
Degraded | DIMM state is degraded. |
DoesNotMatch | DIMM type does not match. |
ExpectedButMissing | DIMM is expected but missing. |
GoodInUse | DIMM is functioning properly and currently in use. |
GoodPartiallyInUse | DIMM is functioning properly but partially in use. |
None | |
NotPresent | DIMM is not present. |
NotSupported | DIMM is not supported. |
Other | DIMM status that does not fit any of these definitions. |
PresentSpare | DIMM is present but used as spare. |
PresentUnused | DIMM is present but unused. |
Unknown | The status of the DIMM is unknown. |
UpgradedButUnused | DIMM is upgraded but currently unused. |
HpeProcessorsExt
This is the schema definition for HpeProcessorsExt.
CoresEnabled | integer read-only (null) |
The number of enabled cores in the processor. |
Description | read-write |
|
Id | read-write |
|
Name | read-write |
|
Type | read-write |
HpeSecurityService
This is the schema definition for a HpeSecurityService.
Description | read-write |
|
Id | read-write |
|
Links { | object | The links array contains the links to other resources that are related to this resource. |
HttpsCaCerts { | object | The value of this property shall be a reference to a resource of Type HpeWfmHttpsCaCerts. |
@odata.id | read-write |
|
} | ||
HttpsCert { | object | The value of this property shall be a reference to a resource of Type HpeHttpsCert. |
@odata.id | read-write |
|
} | ||
} | ||
Name | read-write |
|
Oem { | object | |
Hpe | read-write |
|
} | ||
Type | read-write |
HpeWfmAccountExt
This is the schema definition for HpeWfmAccountExt.
Description | read-write |
|
DisplayName | string read-write |
Descriptive display name that helps to easily identify the owner of each user name. The display name does not have to be the same as the user name and must use printable characters. The maximum length for a display name is 127 characters. |
Enabled | boolean read-write |
Indicates whether the user account is enabled or not. |
Id | read-write |
|
InfoSightGuidedTour | boolean read-write |
Specifies InfoSight guided tour status for the user account created with the manager/security privilage.The value is set to TRUE by default. |
InfoSightSetupNotificationDismissed | boolean read-write |
Indicates if InfoSight setup noification updates have been disabled by the user. |
Name | read-write |
|
Privilege | string (enum) read-write |
This privilege enables a user to log in to management processor. All local accounts have the login privilege. This privilege is added automatically if it is not specified. For the possible property values, see Privilege in Property Details. |
SalientFeaturesGuidedTour | boolean read-write |
Specifies OPA sailent feature tour status for the user accounts with any privilage.The value is set to TRUE by default. |
Property Details
Privilege:
This privilege enables a user to log in to management processor. All local accounts have the login privilege. This privilege is added automatically if it is not specified.
string | Description |
---|---|
Device | Allows configuring and performing actions on devices includes login privilege |
Login | Read operations allowed like viewing discovered nodes and groups and generate reports |
Manager | All operations allowed |
Security | |
User | Allows configuring users with device privilege |
HpeWfmAccountServiceExt
This is the schema definition for HpeWfmAccountServiceExt.
Description | read-write |
|
MinPasswordLength | number read-write |
The minimum password length for this service. |
HpeWfmActivityLogs
This is the schema definition for a HpeWfmActivityLogs.
ActivityLogsLocation [ ] | array (string) read-only |
List of the activity log files. |
Description | read-write |
|
Id | read-write |
|
Name | read-write |
Actions
ClearLog
URIs:
(This action takes no parameters.)
HpeWfmAddOnServices
This is the schema definition for HpeWfmAddOnServices.
AddOnServiceId | string read-write |
Describes the ID of the add-on service available in iLO Amplifier. |
AddOnServiceVersion | string read-only |
This property contains the add-on service version as defined by the developer for the associated service. |
Description | string read-only |
Brief description about the add-on service available in iLO Amplifier |
Id | read-write |
|
Name | string read-only |
Describes the name of the add-on service available in iLO Amplifier. |
Oem | read-write |
|
PackageName | string read-only |
Describes the package name of the add-on service available in iLO Amplifier. |
Status {} | object | This type describes the status and health of a resource and its children. See the Resource schema for details on this property. |
HpeWfmAddOnServicesManager
This is the schema definition for HpeWfmAddOnServicesManager.
AddOnServiceAvailableVersion | string read-only |
Describes the new version of the add-on service available in iLO Amplifier. |
AddOnServiceId | string read-only |
Describes the ID of the add-on service available in iLO Amplifier. |
AddOnServiceVersion | string read-only |
Describes the installed version of the add-on service in iLO Amplifier. |
BinaryPath | string read-only |
The path where the binary to be used for the installation of the add-on service is available in iLO Amplifier. |
Description | string read-only |
Brief description about the add-on service available in iLO Amplifier |
Id | read-write |
|
InstallationStatus | string (enum) read-only |
Describes the current installation status of the add-on service. For the possible property values, see InstallationStatus in Property Details. |
MenuHtmlRef | string read-only |
Describes the menu html reference and js file of the add-on service installed in iLO Amplifier |
MenuName | string read-only |
Describes the menu name of the add-on service installed in iLO Amplifier |
Name | string read-only |
Describes the name of the add-on service available in iLO Amplifier. |
Oem | read-write |
|
PackageName | string read-only |
Describes the package name of the add-on service available in iLO Amplifier. |
Status {} | object | This type describes the status and health of a resource and its children. See the Resource schema for details on this property. |
Actions
Reset
The reset action to reset the specified add-on service.
URIs:
(This action takes no parameters.)
Start
The start action to start the specified add-on service.
URIs:
(This action takes no parameters.)
Stop
The stop action to start the specified add-on service.
URIs:
(This action takes no parameters.)
Property Details
InstallationStatus:
Describes the current installation status of the add-on service.
string |
---|
Installed |
NotInstalled |
HpeWfmAggregatorService
This is the schema definition for HpeWfmAggregatorService.
ActionStatus { | object | The detailed and collated status of the action performed |
DiscoverServersFromCSV { | object | The detailed and collated status of discovering multiple servers added through csv file |
DiscoveryStatus | string (enum) read-only |
The status of the discovery process. For the possible property values, see DiscoveryStatus in Property Details. |
ProgressPercent | integer read-only |
The progress percent of the discovery process. |
} | ||
DiscoverServersInRange { | object | The detailed and collated status of discovering multiple servers |
DiscoveryStatus | string (enum) read-only |
The status of the discovery process. For the possible property values, see DiscoveryStatus in Property Details. |
EndAddress | string read-only |
The ending address at which the discovery process stops. |
ProgressPercent | integer read-only |
The progress percent of the discovery process. |
StartAddress | string read-only |
The starting address at which the discovery process begins. |
} | ||
RefreshAll { | object | The detailed and collated status of refreshing multiple servers. |
IsUserInitiated | boolean read-only |
The flag indicates whether the refresh is initiated by user. |
ProgressPercent | integer read-only |
The progress percent of the Refresh process. |
RefreshStatus | string (enum) read-only |
The status of the refresh process. For the possible property values, see RefreshStatus in Property Details. |
} | ||
} | ||
AggregatedHealth { | object | The aggregated health of all systems managed by this device. |
Critical | integer read-only |
The number of systems with Critical health status that are managed by this device. |
OK | integer read-only |
The number of systems with OK health status that are managed by this device. |
Unknown | integer read-only |
The number of systems with Unknown health status that are managed by this device. |
Warning | integer read-only |
The number of systems with Warning health status that are managed by this device. |
} | ||
AllowAlertBasedRefresh | boolean read-write |
If enabled, servers will be refreshed on alerts on the managed Nodes. |
AnonymousUsageFeatureEnabled | boolean read-write |
Indicates if Sends Anonymous Data to HPE Backend Feature is enabled by the user. |
AutoRefreshMode | boolean read-write |
If enabled, servers will be refreshed automatically in intervals based on the total number of managed Nodes. |
ContinousDiscovery | boolean read-write |
If enabled, the information of nodes and groups are refreshed at a regular interval. The regular interval is specified by RefreshInterval. |
Description | read-write |
|
FederationGroups { | object | This property references a resource of type Collection with a MemberType of Federation groups. |
@odata.id | read-write |
|
} | ||
Id | read-write required |
|
iLOHTTPSConnectionTimeOut | integer read-write |
Connection timeout for any Redfish or REST Calls to iLO in seconds. Default timeout is set to 30 seconds. |
LastScannedTime | string read-only (null) |
Last time when IPv4 range got scanned. |
Links { | object | |
Dashboard { | object | |
Alerts { | object | The value of this property shall be a reference to a resource of Type Alerts. |
@odata.id | read-write |
|
} | ||
Assets { | object | The value of this property shall be a reference to a resource of Type Assets. |
@odata.id | read-write |
|
} | ||
Compliance { | object | The value of this property shall be a reference to a resource of Type Compliance. |
@odata.id | read-write |
|
} | ||
InfoSightAlerts { | object | The value of this property shall be a reference to a resource of Type InfoSight Alerts. |
@odata.id | read-write |
|
} | ||
ServerGroups { | object | The value of this property shall be a reference to a resource of Type Server Groups. |
@odata.id | read-write |
|
} | ||
} | ||
IPv4Range { | object | The value of this property shall be a reference to a resource of Type Assets Scan. |
@odata.id | read-write |
|
} | ||
LicenseInfo { | object | The value of this property shall be a reference to a resource of Type LicenseInfo. |
@odata.id | read-write |
|
} | ||
LogServices { | object | The value of this property shall be resource of type LogServices. |
@odata.id | read-write |
|
} | ||
ManagedGroups { | object | The value of this property shall be a reference to a resource of Type ManagedGroups. |
@odata.id | read-write |
|
} | ||
ManagedServerGroups { | object | The value of this property shall be a reference to a resource of Type ManagedServerGroups. |
@odata.id | read-write |
|
} | ||
ManagedSystems { | object | The value of this property shall be a reference to a resource of Type ManagedSystems. |
@odata.id | read-write |
|
} | ||
ManagedSystemsSummary { | object | The value of this property shall be a reference to a resource of Type ManagedSystemsSummary. |
@odata.id | read-write |
|
} | ||
Reports { | object | The value of this property shall be a reference to a resource of Type Reports. |
@odata.id | read-write |
|
} | ||
} | ||
Name | read-write required |
|
NotifyAnonymousUsageFeature | boolean read-write |
Indicates whether to notify the user about send anonymous data to HPE backend feature. |
RefreshIntervalInHours | integer (enum) read-write |
The time interval in minutes when refresh of information of nodes and groups are initiated again. For the possible property values, see RefreshIntervalInHours in Property Details. |
ScheduledScanTime | integer read-write |
Scheduled Scan time for IPv4 range scan in seconds which by default is set to 0(00:00 hours). |
ServerGroups { | object | This property references a resource of type Collection with a MemberType of Server groups. |
@odata.id | read-write |
|
} | ||
Systems { | object | This property references a resource of type Collection with a MemberType of Systems. |
@odata.id | read-write |
|
} | ||
SystemsCount | integer read-only |
The number of systems managed by Central Management Device. |
Actions
DiscoverServersFromCSV
URIs:
(This action takes no parameters.)
DiscoverServersInRange
URIs:
(This action takes no parameters.)
RefreshAll
URIs:
(This action takes no parameters.)
Property Details
DiscoveryStatus:
The status of the discovery process.
string | Description |
---|---|
Failed | Discovery process is completed and is failed |
InProgress | Discovery process is in progress |
NotInitiated | Discovery process is not initiated |
PartiallySuccessful | Discovery process is partially successful and completed |
Queued | Discovery process is queued |
Successful | Discovery process is successfully completed |
RefreshIntervalInHours:
The time interval in minutes when refresh of information of nodes and groups are initiated again.
integer |
---|
6 |
8 |
12 |
24 |
RefreshStatus:
The status of the refresh process.
string | Description |
---|---|
Failed | Refresh process is completed and is failed |
InProgress | Refresh process is in progress |
NotInitiated | Refresh process is not initiated |
Successful | Refresh process is successfully completed |
HpeWfmAlertService
This is the schema definition for a HpeWfmAlertService.
AlertMail { | object | AlertMail options. |
Authentication | read-write |
|
EmailAddress | string read-write |
The Email Address to which Mail Alerts are sent. |
Enabled | boolean read-write |
Specifies whether Alert Mail is enabled or not. |
MailServer { | object | Specifies the configurations for Mail Server. |
DomainName | string read-write |
Specifies the DomainName of the Mail Server. |
HostName | string read-write |
Specifies the HostName of the Mail Server. |
Port | integer read-write |
Specifies the port number to be used for Mail Server. |
SecureMailServerEnabled | boolean read-write |
Indicates whether to use secure alert mail server relay. When enabled, alert mail server is connected using secure protocol |
} | ||
NotificationCategory { | object | The properties of the object specify the category of alerts for which the mails will be sent when AlertMail is Enabled. |
Administration | boolean read-write |
All alerts related to Administration are sent to the configured Mail address if it is set to true. |
All | boolean read-write |
All alerts are sent to the configured Mail address if it is set to true. |
GeneralFailure | boolean read-write |
All alerts related to General Failure are sent to the configured Mail address if it is set to true. |
HardwareFailure | boolean read-write |
All alerts related to Hardware Failure are sent to the configured Mail address if it is set to true. |
Maintenance | boolean read-write |
All alerts related to Maintenance are sent to the configured Mail address if it is set to true. |
Other | boolean read-write |
All other alerts are sent to the configured Mail address if it is set to true. |
Security | boolean read-write |
All alerts related to Security are sent to the configured Mail address if it is set to true. |
Storage | boolean read-write |
All alerts related to Storage are sent to the configured Mail address if it is set to true. |
} | ||
NotificationSeverity { | object | The properties of the object specify the severity of alerts for which the mails will be sent when AlertMail is Enabled. |
Critical | boolean read-write |
All alerts with severity Critical are sent to the configured Mail address if it is set to true. |
Info | boolean read-write |
All alerts with severity Info are sent to the configured Mail address if it is set to true. |
Warning | boolean read-write |
All alerts with severity Warning are sent to the configured Mail address if it is set to true. |
} | ||
} | ||
Description | read-write |
|
Id | read-write |
|
IFTTT { | object | IFTTT options. |
Enabled | boolean read-write |
Specifies whether IFTTT is enabled or not. |
Key | string read-write |
IFTTT Key. |
} | ||
InfoSightAlertsEnabled | boolean read-write |
Specifies whether InfoSight Alerts are enabled or not. |
Links { | object | The URIs for the resources related to the alert mail service resource. |
AlertLogs { | object | The URI for alert logs resource. |
@odata.id | read-write |
|
} | ||
} | ||
Name | read-write |
|
SensorThreshold { | object | Specifies the threshold configuration of several hardware sensors. |
AltitudeSensor { | object | Specifies the threshold configuration of altitude sensor. |
IsAlertEnabled | boolean read-write |
|
MaxThreshold | integer read-write |
|
MinThreshold | integer read-write |
|
UserConfig | string (enum) read-write |
For the possible property values, see UserConfig in Property Details. |
} | ||
HumiditySensor { | object | Specifies the threshold configuration of humidity sensor. |
IsAlertEnabled | boolean read-write |
|
MaxThreshold | integer read-write |
|
MinThreshold | integer read-write |
|
UserConfig | string (enum) read-write |
For the possible property values, see UserConfig in Property Details. |
} | ||
TempratureSensor { | object | Specifies the threshold configuration of temprature sensor. |
IsAlertEnabled | boolean read-write |
|
MaxThreshold | integer read-write |
|
MinThreshold | integer read-write |
|
UserConfig | string (enum) read-write |
For the possible property values, see UserConfig in Property Details. |
} | ||
} | ||
WolframAlertsEnabled | boolean read-write |
Specifies whether Wolfram Alerts are enabled or not. |
Actions
SendTestAlertMail
Send a test Alert mail to the configured mail address.
URIs:
(This action takes no parameters.)
Property Details
UserConfig:
string | Description |
---|---|
Celsius | It specifies that measuring unit of temperature is Celsius. |
Fahrenheit | It specifies that measuring unit of temperature is Fahrenheit. |
None | It specifies that no measuring unit has been configured for temperature. |
HpeWfmAssetsScan
This is the schema definition for HpeWfmAssetsScan.
Description | read-write |
|
Id | read-write |
|
IPv4Range { | object | Collated details of IPv4 Ranges for automated discovery at scheduled time. |
EndAddress | string read-write required |
The ending address at which the discovery process stops. |
Password | string read-write required |
Password to use to log in to the management processor. |
PortNumber | integer read-write |
SSL Port of the managed systems.Default to 443. |
ServerGroupName | string read-write |
Group to which Server will be added. |
StartAddress | string read-write required |
The starting address at which the discovery process begins. |
UserName | string read-write required |
Name to use to log in to the management processor. |
} | ||
Name | read-write |
HpeWfmBaseline
This is the schema definition for HpeWfmBaseline.
BaselineState | string (enum) read-only |
This property indicates the state of inventory for this resource. For the possible property values, see BaselineState in Property Details. |
Components { | object | The URI refers to collection of components in the baseline. |
@odata.id | read-write |
|
} | ||
Description | read-write |
|
Id | read-write |
|
Name | read-write |
|
RelatedTask { | object | The URI refers to the task which is created to import this baseline. |
@odata.id | read-write |
|
} | ||
SizeInMB | integer read-only |
Space on disk (in MB) used by this baseline. |
Version | string read-only |
The version of the Baseline. |
Property Details
BaselineState:
This property indicates the state of inventory for this resource.
string | Description |
---|---|
ImportFailed | Import of the baseline failed. |
ImportInProgress | Import of the baseline is in progress. |
ImportSuccess | Import of the baseline was completed successfully. |
HpeWfmBaselineComponents
This is the schema definition for HpeWfmBaselineComponents.
Description | read-write |
|
Id | read-write |
|
Name | read-write |
|
Recommendation | string (enum) read-only |
This property indicates the upgrade recommendation for the component. For the possible property values, see Recommendation in Property Details. |
Version | string read-only |
The version of this component. |
Property Details
Recommendation:
This property indicates the upgrade recommendation for the component.
string | Description |
---|---|
Critical | HPE requires users update to this version immediately. |
Optional | Users should update to this version if their system is affected by one of the documented fixes or if there is a desire to utilize any of the enhanced functionality provided by this version. |
Recommended | HPE recommends users update to this version at their earliest convenience. |
Unknown | Unknown recommendation |
HpeWfmBaselineService
This is the schema definition for HpeWfmBaselineService.
Baselines { | object | This property references a collection resource of imported baselines. |
@odata.id | read-write |
|
} | ||
ComponentsRepositoryFreeSpaceInMB | integer read-only |
Total free space of disk (in MB) remaining for hotfix update. |
DateTime | string read-only (null) |
The current DateTime (with offset) setting that the task service is using. |
Description | read-write |
|
FreeSpaceInMB | integer read-only |
Free space of disk (in MB) remaining for importing baselines. |
Id | read-write |
|
Name | read-write |
|
Oem | read-write |
This is the manufacturer/provider specific extension moniker used to divide the Oem object into sections. |
ServiceEnabled | boolean read-only (null) |
This indicates whether this service is enabled. |
Status | read-write |
|
TotalComponentsRepositoryUsageSpace | integer read-only |
Total space of disk (in MB) allocated for hotfix update. |
TotalSpaceInMB | integer read-only |
Total space of disk (in MB) allocated for importing baselines . |
Actions
ClearComponentRepsoitory
Delete autodownloaded hotfix components.
URIs:
(This action takes no parameters.)
HpeWfmComputerSystem
This is the schema definition for HpeWfmComputerSystem.
Description | read-write |
|
Id | read-write |
|
Links { | object | The URIs for the resources related to the date time service resource. |
FirmwareInventory { | object | The URI for for Firmware Inventory of Computer System. |
@odata.id | read-write |
|
} | ||
SoftwareInventory { | object | The URI for Software Inventory of Computer System. |
@odata.id | read-write |
|
} | ||
} | ||
Name | read-write |
HpeWfmDashboardAlerts
AlertsInfo { | object | This indicates the count of various categories of alerts received from managed systems. |
Critical | integer read-only (null) |
Count of Critical alerts received from managed systems. |
OK | integer read-only (null) |
Count of Info alerts received from managed systems. |
Security | integer read-only (null) |
Count of Security alerts received from managed systems. |
Warning | integer read-only (null) |
Count of Warning alerts received from managed systems. |
} | ||
Description | read-write |
|
Id | read-write |
|
Monitoring { | object | Indicates information about servers being monitored by iLO Amplifier Pack. |
MonitoredCount | integer read-only (null) |
Count of servers being monitored by iLO Amplifier Pack. |
TotalServersCount | integer read-only (null) |
Total Count of managed servers. |
} | ||
Name | read-write |
HpeWfmDashboardAssets
AggregatedHealth { | object | This indicates the aggregated health status of all the servers managed by iLO Amplifier Pack. |
Critical | integer read-only (null) |
Count of all the servers whose health status is Critical. |
OK | integer read-only (null) |
Count of all the servers whose health status is Ok. |
Security | integer read-only (null) |
Count of all the security related events/alerts recieved from managed servers. |
Warning | integer read-only (null) |
Count of all the servers whose health status is Warning. |
} | ||
Description | read-write |
|
Id | read-write |
|
Name | read-write |
|
ServerGenerations [ { | array | |
Count | integer read-only (null) |
This indicates the total count of servers of a server generation. |
Name | string read-only (null) |
This indicates the server generation's name. |
} ] | ||
ServerModels [ { | array | |
Count | integer read-only (null) |
This indicates the total count of servers of a server model. |
Name | string read-only (null) |
This indicates the server model's name. |
} ] | ||
ServerPlatforms [ { | array | |
Count | integer read-only (null) |
This indicates the total count of servers of a server platform. |
Name | string read-only (null) |
This indicates the name of a server platform. |
} ] |
HpeWfmDashboardCompliance
BaselineComplianceTasks [ { | array | |
BaselineId | read-write |
|
BaselineName | string read-only (null) |
Indicates the name of this firmware baseline. |
BaselineVersion | string read-only (null) |
Indicates the version of this firmware baseline. |
CompliantCount | integer read-only (null) |
Indicates the number of servers compliant to this firmware baseline. |
NotCompliantCount | integer read-only (null) |
Count of servers not compliant to this firmware baseline. |
TaskId | read-write |
|
} ] | ||
Description | read-write |
|
Id | read-write |
|
Name | read-write |
|
NotRunCount | integer read-only (null) |
Count of servers for which compliance has never been run for any imported firmware baseline. |
TotalServersCount | integer read-only (null) |
Total number of servers managed by this iLO Amp. |
HpeWfmDashboardInfoSightAlerts
Description | read-write |
|
Id | read-write |
|
InfoSightAlertsCount { | object | This indicates the count of various categories of InfoSight alerts. |
CustomerAdvisoryAlerts | integer read-only (null) |
Count of InfoSight Customer Advisory Alerts. |
HotfixAlerts | integer read-only (null) |
Count of InfoSight Hotfix Alerts. |
Others | integer read-only (null) |
Count of InfoSight misc. Alerts. |
Total | integer read-only (null) |
Count of all InfoSight Alerts. |
WellnessAlerts | integer read-only (null) |
Count of InfoSight Wellness Alerts. |
} | ||
Name | read-write |
HpeWfmDashboardServerGroups
ActionStatus { | object | The detailed and collated status of action performed |
ServerGroupsHealthStatus { | object | The status of task initiated for fetching details of health status of various servers in all server groups managed by iLO Amplifier. |
HealthActionStatus | string (enum) read-only |
The status of the process. For the possible property values, see HealthActionStatus in Property Details. |
ProgressPercent | integer read-only |
The progress percent of the HealthStatus process. |
} | ||
} | ||
Description | read-write |
|
Id | read-write |
|
Name | read-write |
|
ServerGroupsInfo [ { | array | |
Critical | integer read-only (null) |
Count of all the servers whose health status is Critical. |
Name | string read-only (null) |
Indicates the server group name. |
OK | integer read-only (null) |
Count of all the servers whose health status is Ok. |
Unknown | integer read-only (null) |
Count of all the servers whose health status is Unknown. |
Warning | integer read-only (null) |
Count of all the servers whose health status is Warning. |
} ] |
Actions
ServerGroupsHealthStatus
URIs:
(This action takes no parameters.)
Property Details
HealthActionStatus:
The status of the process.
string | Description |
---|---|
Failed | HealthStatus process is completed and is failed |
InProgress | HealthStatus process is in progress |
NotInitiated | HealthStatus process is not initiated |
PartiallySuccessful | HealthStatus process is partially successful and completed |
Queued | HealthStatus process is queued |
Successful | HealthStatus process is successfully completed |
HpeWfmDateTime
This is the schema definition for HpeWfmDateTime.
ConfigurationSettings | string (enum) read-only |
The state of the currently displayed configuration settings. For the possible property values, see ConfigurationSettings in Property Details. |
DateTime | string read-only |
The date and time used by management processor. |
Description | read-write |
|
Id | read-write |
|
Modified | read-write |
|
Name | read-write |
|
NTPServers [ ] | array (string) read-only |
The NTP servers, in order of preference. |
StaticNTPServers [ ] | array (string) read-write |
The static NTP servers, in order of preference. |
StaticNTPServersEnabled | boolean read-write |
Specifies whether manually specified NTP servers are enabled or not. |
TimeZone { | object | The currently selected time zone. |
Index | number read-write |
The index of the current time zone. To set a new time zone, specify a different time zone index. This property can be set only when DHCPv4 or DHCPv6 supplied time settings are disabled. Since the time zone list might vary from one firmware version to another (which often leads to differences in time zone indices), setting the time zone by name is recommended over setting by index, for better compatibility. |
Name | string read-only |
The name of the current time zone. Patch this field to set the time zone by name - recommended over patching the index. When this field is specified in the patch, the Index field, if specified, will be ignored. |
UtcOffset | string read-only |
The UTC offset of the current time zone, in the format {+/-}hh:mm |
Value | string read-only |
The environment variable value. |
} | ||
TimeZoneList [ { | array | |
Index | number read-only |
The time zone index. |
Name | string read-only |
The time zone name. |
UtcOffset | string read-only |
The UTC offset of the time zone, in the format {+/-}hh:mm |
Value | string read-only |
The environment variable value. |
} ] |
Property Details
ConfigurationSettings:
The state of the currently displayed configuration settings.
string |
---|
Current |
SomePendingReset |
HpeWfmDirectory
This is the schema definition for HpeWfmDirectory.
BaseDN | string read-write |
The group identifier in LDAP Server. |
DirectoryAddress | string read-write |
The IP Address of the LDAP Server. |
DirectoryEnabled | boolean read-write |
LDAP login status |
DirectoryName | string read-write |
The name of the LDAP Server. |
DirectoryPort | integer read-write |
The port number of LDAP Server. |
DirectorySecureConnection | boolean read-write |
LDAP secure connection |
DirectoryType | string read-write |
The type of the LDAP Server. |
DirectoryVersion | integer read-write |
The version number of the LDAP server. |
Id | read-write |
|
Links { | object | The links array contains the related resource URIs. |
Groups [ { | array | The groups URI associated with this resource. |
@odata.id | read-write |
|
} ] | ||
} | ||
Name | read-write |
|
OrganizationalUnit | string read-write |
The organizational unit which the LDAP Server is part of. |
UserNamingAttribute | string read-write |
The user naming attribute of the LDAP Server. |
HpeWfmDirectoryAccessService
This is the schema definition for a HpeWfmDirectoryAccessService.
Directories { | object | This property references a resource of type Collection with a MemberType of directories. |
@odata.id | read-write |
|
} | ||
Id | read-write |
|
Name | read-write |
|
ServiceEnabled | boolean read-write |
This indicates whether this service is enabled. |
HpeWfmDirectoryGroup
This is the schema definition for a HpeWfmDirectoryGroup.
GroupEnabled | boolean read-write |
This indicates whether this group is enabled. |
GroupName | string read-write |
The name of the group in the LDAP Server. |
Id | read-write |
|
Name | read-write |
|
privilege | string read-write |
The type of privilege this group is entitled to. |
HpeWfmDiscoverFederationGroup
This is the schema definition for a HpeWfmDiscoverFederationGroup.
Description | read-write |
|
FedrationGroup [ ] | array (string) read-only |
Name to use to log in to the management processor. |
ManagerAddress | string read-only |
The IP address or DNS name of the management processor. |
Name | read-write |
HpeWfmDiscoveryJobResults
This is the schema definition for HpeWfmDiscoveryJobResults.
Description | read-write |
|
DiscoveryJobInfo [ { | array | |
InventoryStatus | string read-only |
Progress status associated with the job. |
ManagerAddress | string read-only |
The Manager address of the Server. |
StatusMessage | string read-only |
Progress message associated with the job. |
} ] | ||
Name | read-write |
HpeWfmEnvironmentMetrics
This is the schema definition for a HpeWfmEnvironmentMetrics.
Description | read-write |
|
EnvironmentMetrics [ { | array | |
Altitude | number read-only |
The altitude reading of the sensor at time. |
AtTime | string read-only |
The time, when the sensor data was captured. |
Humidity | number read-only |
The humidity reading of the sensor at time. |
Temperature | number read-only |
The temperature reading of sensor at time. |
} ] | ||
Id | read-write |
|
Name | read-write |
HpeWfmEnvironmentMetricsExt
This is the schema definition for a HpeWfmEnvironmentMetricsExt.
Description | read-write |
|
EnvironmentMetrics { | object | |
@odata.id | read-write |
|
} | ||
Id | read-write |
|
Name | read-write |
HpeWfmEthernetNetworkInterface
This is the schema definition for a HpeWfmEthernetNetworkInterface.
ConfigurationSettings | string (enum) read-only |
The state of the currently displayed configuration settings. For the possible property values, see ConfigurationSettings in Property Details. |
Description | read-write |
|
DHCPv4 { | object | DHCPv4 options. |
Enabled | boolean read-write |
Determines whether DHCPv4 is enabled. |
UseDNSServers | boolean read-write |
Determines whether to use DHCPv4-supplied DNS servers. Can only be enabled when DHCPv4 is also enabled; otherwise, this property will be set to false and will be read-only. |
UseDomainName | boolean read-write |
Determines whether to use a DHCPv4-supplied domain name. Can only be enabled when DHCPv4 is also enabled; otherwis,e this property will be set to false and will be read-only. |
UseGateway | boolean read-write |
Determines whether to use a DHCPv4-supplied gateway. Can only be enabled when DHCPv4 is also enabled; otherwise, this property will be set to false and will be read-only. |
UseNTPServers | boolean read-write |
Determines whether to use DHCPv4-supplied NTP servers. Can only be enabled when DHCPv4 is also enabled; otherwise, this property will be set to false and will be read-only. |
UseStaticRoutes | boolean read-write |
Determines whether to use DHCPv4-supplied static routes. Can only be enabled when DHCPv4 is also enabled; otherwise, this property will be set to false and will be read-only. |
UseWINSServers | boolean read-write |
Determines whether to use DHCPv4-supplied WINS servers. Can only be enabled when DHCPv4 is also enabled; otherwise, this property will be set to false and will be read-only. |
} | ||
DHCPv6 { | object | DHCPv6 options. |
Enabled | boolean read-write |
Determines whether DHCPv6 is enabled. |
UseDNSServers | boolean read-write |
Determines whether to use DHCPv6-supplied DNS servers. Can only be enabled when DHCPv6 is also enabled; otherwise, this property will be set to false and will be read-only. |
UseDomainName | boolean read-write |
Determines whether to use a DHCPv6-supplied domain name. Can only be enabled when DHCPv6 is also enabled; otherwis,e this property will be set to false and will be read-only. |
UseGateway | boolean read-write |
Determines whether to use a DHCPv6-supplied gateway. Can only be enabled when DHCPv6 is also enabled; otherwise, this property will be set to false and will be read-only. |
UseNTPServers | boolean read-write |
Determines whether to use DHCPv6-supplied NTP servers. Can only be enabled when DHCPv6 is also enabled; otherwise, this property will be set to false and will be read-only. |
UseStaticRoutes | boolean read-write |
Determines whether to use DHCPv6-supplied static routes. Can only be enabled when DHCPv6 is also enabled; otherwise, this property will be set to false and will be read-only. |
UseWINSServers | boolean read-write |
Determines whether to use DHCPv6-supplied WINS servers. Can only be enabled when DHCPv6 is also enabled; otherwise, this property will be set to false and will be read-only. |
} | ||
DomainName | string read-write |
Domain name of the network to which this management processor belongs. This property can only be modified when the management processor is not configured to use a DHCP supplied domain name; otherwise this property is read-only indicating the value is provided by DHCP. |
HostName | string read-write |
The management processor host name. |
Id | read-write |
|
IPv4 { | object | The Management Processor IPv4 Configuration Settings. |
CurrentStaticRoutes [ { | array | The current configured IPv4 static routes. |
Destination | string read-only |
An IPv4 static route destination. Only writeable when use of DHCPv4-supplied static routes is disabled; otherwise this property is read-only indicating the value is provided by DHCPv4. |
Gateway | string read-only |
An IPv4 static route gateway. Only writeable when use of DHCPv4-supplied static routes is disabled; otherwise this property is read-only indicating the value is provided by DHCPv4. |
SubnetMask | string read-only |
An IPv4 static route subnet mask. Only writeable when use of DHCPv4-supplied static routes is disabled; otherwise this property is read-only indicating the value is provided by DHCPv4. |
} ] | ||
DDNSRegistration | boolean read-write |
Determines whether DDNS registration is enabled. |
DNSSearch { | object | |
AvailableSettings | string read-only |
Currently configured IPv4 DNS Domain servers. |
CurrentSettings | string read-write |
Currently configured IPv4 DNS Domain servers. |
} | ||
DNSServers [ ] | array (string) read-write |
Currently configured IPv4 DNS servers in order of descending preference. Static values when not configured to use DHCPv4-supplied DNS servers; otherwise this property is read-only indicating the values are provided by DHCPv4. |
IPv4Addresses [ { | array | The IPv4 connection characteristics for this interface. |
Address | string read-write (null) |
The IPv4 Address. |
Gateway | string read-write (null) |
The IPv4 gateway for this address. |
SubnetMask | string read-write (null) |
The IPv4 Subnet mask. |
} ] | ||
StaticRoutes [ { | array | The current configured IPv4 static routes. |
Destination | string read-write |
An IPv4 static route destination. Only writeable when use of DHCPv4-supplied static routes is disabled; otherwise this property is read-only indicating the value is provided by DHCPv4. |
Gateway | string read-write |
An IPv4 static route gateway. Only writeable when use of DHCPv4-supplied static routes is disabled; otherwise this property is read-only indicating the value is provided by DHCPv4. |
SubnetMask | string read-write |
An IPv4 static route subnet mask. Only writeable when use of DHCPv4-supplied static routes is disabled; otherwise this property is read-only indicating the value is provided by DHCPv4. |
} ] | ||
WINSRegistration | boolean read-write |
Determines whether WINS registration is enabled. |
WINSServers [ ] | array (string) read-write |
Currently configured WINS servers in order of descending preference. Static values when not configured to use DHCPv4-supplied WINS servers; otherwise this property is read-only indicating the values are provided by DHCPv4 |
} | ||
IPv6 { | object | The Management Processor IPv6 Configuration Settings. |
CurrentStaticRoutes [ { | array | The current configured IPv6 static routes. |
Destination | string read-only |
An IPv6 static route destination. Only writeable when use of DHCPv6-supplied static routes is disabled; otherwise this property is read-only indicating the value is provided by DHCPv6. |
Gateway | string read-only |
An IPv6 static route gateway. Only writeable when use of DHCPv6-supplied static routes is disabled; otherwise this property is read-only indicating the value is provided by DHCPv6. |
PrefixLength | integer read-only |
Prefix Length |
} ] | ||
DNSSearch { | object | |
AvailableSettings | string read-only |
Currently configured IPv6 DNS Domain servers. |
CurrentSettings | string read-write |
Currently configured IPv6 DNS Domain servers. |
} | ||
DNSServers [ ] | array (string) read-write |
Currently configured IPv6 DNS servers in order of descending preference. Static values when not configured to use DHCPv4-supplied DNS servers; otherwise this property is read-only indicating the values are provided by DHCPv4. |
IPv6Addresses [ { | array | The IPv6 connection characteristics for this interface. |
Address | string read-write (null) |
The IPv6 Address. |
Gateway | string read-write (null) |
The IPv6 gateway for this address. |
PrefixLength | integer read-write (null) |
Prefix Length |
} ] | ||
StaticRoutes [ { | array | The current configured IPv6 static routes. |
Destination | string read-write (null) |
An IPv6 static route destination. Only writeable when use of DHCPv6-supplied static routes is disabled; otherwise this property is read-only indicating the value is provided by DHCPv6. |
Gateway | string read-write (null) |
An IPv6 static route gateway. Only writeable when use of DHCPv6-supplied static routes is disabled; otherwise this property is read-only indicating the value is provided by DHCPv6. |
PrefixLength | integer read-write (null) |
Prefix Length |
} ] | ||
} | ||
Links { | object | The URIs for the resources related to the date time service resource. |
DateTimeService { | object | The URI for this date time service resource. |
@odata.id | read-write |
|
} | ||
} | ||
Name | read-write |
|
NICEnabled { | object | |
AvailableSettings | boolean read-only |
Determines whether this NIC is enabled or disabled. Enabling one NIC will disable the others. If no NIC is enabled, this management processor is not accessible over the network. |
CurrentSettings | boolean read-write |
Determines whether this NIC is enabled or disabled. Enabling one NIC will disable the others. If no NIC is enabled, this management processor is not accessible over the network. |
} | ||
PreferredMode | string (enum) read-write (null) |
Determines which is the IP Address for receiving Alerts. For the possible property values, see PreferredMode in Property Details. |
PreferredNIC | string (enum) read-write (null) |
Determines which NIC is the preferred NIC for receiving Alerts. For the possible property values, see PreferredNIC in Property Details. |
Property Details
ConfigurationSettings:
The state of the currently displayed configuration settings.
string | Description |
---|---|
Current | All configuration settings for this NIC are currently in use. |
SomePendingReset | One or more configuration settings on this NIC are not yet in use. They require a reset of this management processor in order to take effect. |
PreferredMode:
Determines which IP Address is used for receiving Alerts.
string | Description |
---|---|
IPv4 | IPv4 Address will be used |
IPv6 | IPv6 Address will be used |
PreferredNIC:
Determines which NIC is the preferred NIC for receiving Alerts.
string | Description |
---|---|
NIC1 | NIC1 is the preferred NIC |
NIC2 | NIC2 is the preferred NIC |
HpeWfmEventDestinationExt
This is the schema definition for HpeWfmEventDestinationExt.
DeliveryRetryAttempts | integer read-write |
Specifies number of delivery retry attempts that will be made while forwarding events. |
DeliveryRetryIntervalSeconds | integer read-write |
Specifies number of seconds after which a retry will be made for forwarding the events. |
EnableActivityAlerts | boolean read-write |
Flag to be enabled to allow forwarding of iLO Amplifier Alerts to the subscriber. By default, it is set to false. |
NotificationCategory { | object | The properties of the object specify the category of alerts for which the events will be sent. |
Administration | boolean read-write |
All alerts related to Administration are sent to the configured subscription destination if it is set to true. |
GeneralFailure | boolean read-write |
All alerts related to General Failure are sent to the configured subscription destination if it is set to true. |
HardwareFailure | boolean read-write |
All alerts related to Hardware Failure are sent to the configured subscription destination if it is set to true. |
Maintenance | boolean read-write |
All alerts related to Maintenance are sent to the configured subscription destination if it is set to true. |
Other | boolean read-write |
All other alerts are sent to the configured subscription destination if it is set to true. |
Security | boolean read-write |
All alerts related to Security are sent to the configured subscription destination if it is set to true. |
Storage | boolean read-write |
All alerts related to Storage are sent to the configured subscription destination if it is set to true. |
} | ||
NotificationSeverity { | object | The properties of the object specify the severity of alerts for which the events will be sent. |
Critical | boolean read-write |
All alerts with severity Critical are sent to the configured subscription destination, if it is set to true. |
Info | boolean read-write |
All alerts with severity Info are sent to the configured subscription destination, if it is set to true. |
Warning | boolean read-write |
All alerts with severity Warning are sent to the configured subscription destination, if it is set to true. |
} |
HpeWfmFederationGroup
This is the schema definition for HpeWfmFederationGroup.
Description | read-write |
|
Id | read-write |
|
Name | read-write |
|
Systems { | object | This property references a resource of type Collection with a MemberType of Systems in the federation groups. |
@odata.id | read-write |
|
} |
HpeWfmFederationGroupJobResults
This is the schema definition for HpeWfmFederationGroupJobResults.
Description | read-write |
|
FederationGroupJobInfo [ { | array | |
JobStatus | string read-only |
Progress message associated with the job. |
ManagerAddress | string read-only |
The Manager address of the Server. |
StatusMessage | string read-only |
Progress message associated with the job. |
} ] | ||
Name | read-write |
HpeWfmHttpsCert
This is the schema definition for HpeWfmHttpsCert.
Description | read-write |
|
Id | read-write |
|
Name | read-write |
|
X509CACertificateInformation { | object | Contains the X509 Certificate Information. |
Issuer | string read-only |
The Certificate Authority that issued the certificate. |
SerialNumber | string read-only |
The serial number that the Certificate Authority assigned to the certificate. |
Subject | string read-only |
The entity to which the certificate was issued. |
ValidNotAfter | string read-only |
The date on which the certificate validity period ends. |
ValidNotBefore | string read-only |
The date on which the certificate validity period begins. |
} |
HpeWfmInfoSightAggregation
This is the schema definition for HpeWfmInfoSightAggregation.
AHSDownloadErrorCount | integer read-only |
This is the number of errors that happened during AHS Downloads for all servers in the current cycle(24 hours). |
AHSScheduleStartTime | integer read-write |
This is the AHS Schedule Start time in seconds. |
AHSUploadErrorCount | integer read-only |
This is the number of errors that happened during AHS Uploads for all servers in the current cycle(24 hours). |
ApplianceSerialNumber | string read-only (null) |
This is the unqiue iLO Amplifier Serial Number. |
AverageAHSFileSize | integer read-only |
The average file size in KB of an AHS file in the current cyle for all servers (in a day). |
ClaimId | string read-only (null) |
Claim Id from the claim token |
ClaimToken | string read-write (null) |
Claim token associated with the user |
ClaimTokenValidationStatus | string (enum) read-only |
This property shows the current status of the connection to HPE InfoSight from this device. For the possible property values, see ClaimTokenValidationStatus in Property Details. |
CompletedAHSDownloadCount | integer read-only |
This is the number of AHS downloads completed in the current cycle (a day). |
CompletedAHSUploadCount | integer read-only |
This is the number of AHS Uploads completed in the current cycle (a day). |
CompletedHeartBeatUploadCount | integer read-only |
This is the number of HeartBeat Uploads completed in the current cycle(10 mins). |
ConcurrentAHSDownloadCount | integer read-only |
This is the number of AHS Downloads happening concurrently. |
ConcurrentAHSUploadCount | integer read-only |
This is the number of AHS Uploads happening concurrently. |
ConnectionStatus | string (enum) read-only |
This property shows the current status of the connection to HPE InfoSight from this device. For the possible property values, see ConnectionStatus in Property Details. |
ConnectionStatusErrorDetails | string read-only (null) |
Detailed error string in case of connection failure |
DatacenterLocation | string read-write (null) |
Location of the Datacenter |
Description | read-write |
|
HeartBeatUploadErrorCount | integer read-only |
This is the number of errors that happened during HeartBeat Uploads for all servers in the current cycle (10mins). |
Id | read-write |
|
InfoSightPolicy | string (enum) read-write |
This property indicates if server operations are allowed or restricted from HPE InfoSight portal. For the possible property values, see InfoSightPolicy in Property Details. |
MaxAHSFileSize | integer read-only |
The largest file size in KB of an AHS file in the current cycle for all servers (in a day). |
Name | read-write |
|
NewAHSCycleStartTime | string read-only (null) |
Time at which the AHS download and upload was started for all servers. |
PreviousHeartBeatCycleCompleteTime | string read-only (null) |
Time at which the HeartBeat upload was completed for all the servers in the previous cycle. |
ServerPIIDataEnabled | boolean read-write |
Indicates if sending the Server Identifiable Information like IP address and Hostname in the heartbeat is enabled. |
ServiceEnabled | boolean read-write |
Indicates if HPE InfoSight Integration is enabled. |
TenantName | string read-only (null) |
Tenant Name from the claim token |
Property Details
ClaimTokenValidationStatus:
This property shows the current status of the connection to HPE InfoSight from this device.
string | Description |
---|---|
ConnectionFailed | Connection to HPE InfoSight failed. |
NotInitiated | Validation of claim token was not initiated. |
TokenExpired | The claim token has expired. |
ValidationFailed | The claim token entered is not a valid claim token. |
ValidationInProgress | Validation of the entered claim token is being attempted. |
ValidationSuccess |
ConnectionStatus:
This property shows the current status of the connection to HPE InfoSight from this device.
string | Description |
---|---|
Connected | Connection to HPE InfoSight was successful . |
Connecting | Connection to HPE InfoSight is being attempted. |
ConnectionFailed | Connection to HPE InfoSight failed. |
NotInitiated | Connection to HPE InfoSight was not initiated. |
InfoSightPolicy:
This property indicates if server operations are allowed or restricted from HPE InfoSight portal.
string | Description |
---|---|
AllowInfoSightServerOperations | This option indicates if server operations are allowed from HPE InfoSight portal. |
RestrictInfoSightServerOperations | This option indicates if server operations are restricted from HPE InfoSight portal. |
HpeWfmJobResults
Description | read-write |
|
Id | read-write |
|
Name | read-write |
|
OutputDownloadFile | read-only |
The URI for the output download file after a successfull run. |
Results { | object | |
@odata.id | read-write |
|
} |
HpeWfmJobServiceExt
This is the schema definition for HpeWfmJobServiceExt.
Description | read-write |
|
Id | read-write |
|
Name | read-write |
Actions
AhsDownloadJobs
Download AHS Jobs.
URIs:
(This action takes no parameters.)
ApplyConfigurationBaselineJobs
Apply Configuration Baseline jobs.
URIs:
(This action takes no parameters.)
AssignRecoveryPolicyJob
Assign Recovery Policy.
URIs:
(This action takes no parameters.)
ConfigureRemoteSyslogJobs
Setting Indicator LED.
URIs:
(This action takes no parameters.)
CreateGroupJobs
Creating group jobs.
URIs:
(This action takes no parameters.)
DeleteCompletedJobs
Delete all the completed Jobs.
URIs:
(This action takes no parameters.)
DeleteJobs
Delete Server.
URIs:
(This action takes no parameters.)
DownloadAuditLogsJobs
Download Audit jobs.
URIs:
(This action takes no parameters.)
DownloadReportJobs
Download Report jobs.
URIs:
(This action takes no parameters.)
ExcludeServersFromInfoSight
Exclude servers from InfoSight.
URIs:
(This action takes no parameters.)
ImportBaselineJobs
Import Baseline jobs.
URIs:
(This action takes no parameters.)
ImportConfigurationBaselineJobs
Import Configuration Baseline jobs.
URIs:
(This action takes no parameters.)
ImportOSBaselineJobs
Import Baseline jobs.
URIs:
(This action takes no parameters.)
ManualRecoveryJobs
Manual Recovery.
URIs:
(This action takes no parameters.)
OnDemandAhsJobs
Download AHS Jobs.
URIs:
(This action takes no parameters.)
QuarantineActionJobs
Quarantine Action.
URIs:
(This action takes no parameters.)
RefreshJob
Server Refresh.
URIs:
(This action takes no parameters.)
ResetSystemJobs
Resetting Systems.
URIs:
(This action takes no parameters.)
ServerGroupActionJobs
Delete Server.
URIs:
(This action takes no parameters.)
ServerGroupJobs
Server group jobs.
URIs:
(This action takes no parameters.)
ServerUpdateJobs
Server Updatejobs.
URIs:
(This action takes no parameters.)
SetIndicatorLedJobs
Setting Indicator LED.
URIs:
(This action takes no parameters.)
SppComplianceJobs
Baseline Compliance jobs.
URIs:
(This action takes no parameters.)
UnAssignRecoveryPolicyJob
Unassign Recovery Policy.
URIs:
(This action takes no parameters.)
UpdateFirmwareJobs
Updating firmwares on servers.
URIs:
(This action takes no parameters.)
VirtualMediaJobs
Mounting Virtual Media.
URIs:
(This action takes no parameters.)
HpeWfmLicense
This is the schema definition for HpeWfmLicense.
Description | read-write |
|
EntitlementEULAViewed | boolean read-write |
Indicates whether the entitlement is viewed or not |
Id | read-write |
|
License | string read-only |
Describes the name of the license installed on management processor. |
LicenseType | string read-only |
Indicates whether the license is Perpetual or Evaluation. |
Name | read-write |
|
Oem | read-write |
HpeWfmLicenseInfo
Description | read-write |
|
Id | read-write |
|
LicenseInfo [ { | array | |
Count | integer read-only (null) |
This indicates the total count of servers that hold this license. |
Name | string read-only (null) |
This indicates the license name. |
} ] | ||
Name | read-write |
HpeWfmLogEntry
This is the schema definition for HpeWfmLogEntry.
ActionAvailable | boolean read-only |
This flag is to indicate if the alert has an action associated that the end user can choose to perform. |
ActionRequired | string read-only |
The ActionRequired is to be done in order to possibly resolve the problem occured. |
ActionUri | read-only |
This is a reference to the schema that has definitions of recommended actions on servers |
AdditionalInfo { | object | This indicates the additional info associated to InfoSight alert logs. |
HotfixInfo { | object | This indicates the additional info associated to hotfix InfoSight alert logs. |
Firmware [ { | array | |
AvailableSupportURL | string read-only |
Indicates the available support URL of the server for which InfoSight alert log has been generated. |
AvailableVersion | string read-only |
Indicates the available version of firmware of the server for which InfoSight alert log has been generated. |
Criticality | integer read-only |
Indicates the criticality level of the firmware related InfoSight alert log generated. |
CriticalityStr | string read-only |
Indicates the criticality detail of the firmware related InfoSight alert log generated. |
Name | string read-only |
Indicates the firmware name of the server for which InfoSight alert log has been generated. |
Version | string read-only |
Indicates the firmware version of the server for which InfoSight alert log has been generated. |
} ] | ||
Software [ { | array | |
AvailableSupportURL | string read-only |
Indicates the available support URL of the server for which InfoSight alert log has been generated. |
AvailableVersion | string read-only |
Indicates the available version of software of the server for which InfoSight alert log has been generated. |
Criticality | integer read-only |
Indicates the criticality level of the software related InfoSight alert log generated. |
CriticalityStr | string read-only |
Indicates the criticality detail of the software related InfoSight alert log generated. |
Name | string read-only |
Indicates the software name of the server for which InfoSight alert log has been generated. |
Version | string read-only |
Indicates the software version of the server for which InfoSight alert log has been generated. |
} ] | ||
SPPVersion | string read-only |
Indicates the SPP version of the server for which InfoSight alert log has been generated. |
} | ||
} | ||
AlertAcknowledged | string read-only |
This string is to indicate if an InfoSight alert has been acknowledged by the end user.Initially it is set to no for all InfoSight alerts. |
Category | string read-only |
The log entry category. |
Description | read-write |
|
DisplayTime | string read-only |
This field stores the updated timestamp for InfoSight Alert in mm/dd/yy hh:mm:ss format |
Id | read-write |
|
iLOIPAddress | string read-only |
The IP address of iLo. |
InfoSightAlertId | string read-only |
The InfoSight alert Id. |
InfoSightAlertType | string (enum) read-write (null) |
This field indicates the various InfoSight alert categories. For the possible property values, see InfoSightAlertType in Property Details. |
IsMarkedForDeletion | string read-only |
This string is to indicate if the server for which InfoSight alert has been parsed, has been deleted or alert itself is deleted.Initially it is set to No for all parsed InfoSight alerts. |
Name | read-write |
|
Recommendation | string read-only |
Recommended action to be performed for the alert. |
ServerInfo { | object | |
ManagerAddress | string read-only |
Indicates the manager address of the server for which InfoSight alert log has been generated. |
ManagerHostname | string read-only |
Indicates the hostname of the server for which InfoSight alert log has been generated. |
OPAServerGroup | string read-only |
Indicates the server group name of the server for which InfoSight alert log has been generated. |
ProductID | string read-only |
Indicates the productID of the server for which InfoSight alert log has been generated. |
SerialNumber | string read-only |
Indicates the serial number of the server for which InfoSight alert log has been generated. |
ServerName | string read-only |
Indicates the name of the server for which InfoSight alert log has been generated. |
} | ||
Summary | string read-only |
The log entry summary. |
Updated | string read-only |
The date and time of the latest log entry update, for example, 2014-04-15T00:38:00Z. |
Property Details
InfoSightAlertType:
This field indicates the various InfoSight alert categories.
string |
---|
Wellness |
Hotfix |
CustomerAdvisory |
Others |
All |
HpeWfmLogServiceExt
This is the schema definition for a HpeWfmLogServiceExt.
AcknowledgeTaskStatus | string (enum) read-only |
This field indicates the current status of InfoSight Alerts acknowledge task. For the possible property values, see AcknowledgeTaskStatus in Property Details. |
ClearTaskStatus | string (enum) read-only |
This field indicates the current status of InfoSight Alerts clear task. For the possible property values, see ClearTaskStatus in Property Details. |
Description | read-write |
|
Id | read-write |
|
Name | read-write |
Actions
AcknowledgeAlerts
Acknowledge InfoSight Alerts job
URIs:
(This action takes no parameters.)
ClearAlerts
Clear InfoSight Alerts job
URIs:
(This action takes no parameters.)
Property Details
AcknowledgeTaskStatus:
This field indicates the current status of InfoSight Alerts acknowledge task.
string |
---|
Idle |
InProgress |
ClearTaskStatus:
This field indicates the current status of InfoSight Alerts clear task.
string |
---|
Idle |
InProgress |
HpeWfmManagedGroup
This is the schema definition for HpeWfmManagedGroup.
AggregatedHealth { | object | The aggregated health of all systems in the Federation group. |
Critical | integer read-only |
The number of systems with Critical health status in the Federation group. |
OK | integer read-only |
The number of systems with OK health status in the Federation group. |
Unknown | integer read-only |
The number of systems with unknown health status in the Federation group. |
Warning | integer read-only |
The number of systems with Warning health status in the Federation group. |
} | ||
Description | read-write |
|
Discovery | read-write |
|
FirmwareUpdateRequired | boolean read-only |
The group has servers with incompatible iLO firmware versions. Hence a firmware update is required |
Id | read-write |
|
LastTaskStatus | read-write |
|
Links { | object | |
ManagedSystems { | object | The value of this property shall be a reference to a resource of Type ManagedSystems for this group. |
@odata.id | read-write |
|
} | ||
ManagedSystemsSummary { | object | The value of this property shall be a reference to a resource of Type ManagedSystemsSummary for this group. |
@odata.id | read-write |
|
} | ||
Reports { | object | The value of this property shall be a reference to a resource of Type ReportsSummary for this group. |
@odata.id | read-write |
|
} | ||
} | ||
ManagerAddressWithCredentials | read-write |
|
Name | string read-only |
The name of the Federation Group. |
RefreshRequired | boolean read-only |
The group is newly formed / a server is newly added to the group. |
SystemsCount | integer read-only |
The number of systems in the Federation group. |
HpeWfmManagedGroupSession
This is the schema definition for HpeWfmManagedGroupSession.
Description | read-write |
|
Id | read-write |
|
Name | read-write |
|
Password | string read-write |
The password for the managed system. |
SessionKey | string read-only |
The session key for the managed system. |
SessionURL | string read-only |
The session URL for the managed system. |
UserName | string read-write |
The username for the managed system. |
HpeWfmManagedServerGroups
This is the schema definition for HpeWfmManagedServerGroups.
Description | read-write |
|
Discovery | read-write |
|
FirmwareUpdateRequired | boolean read-only |
The group has servers with incompatible iLO firmware versions. Hence a firmware update is required. |
GroupDescription | string read-write |
The description of the Server Group. |
Id | read-write |
|
LastTaskStatus | read-write |
|
Links { | object | |
ManagedSystems { | object | The value of this property shall be a reference to a resource of Type ManagedSystems for this group. |
@odata.id | read-write |
|
} | ||
ManagedSystemsSummary { | object | The value of this property shall be a reference to a resource of Type ManagedSystemsSummary for this group. |
@odata.id | read-write |
|
} | ||
Reports { | object | The value of this property shall be a reference to a resource of Type ReportsSummary for this group. |
@odata.id | read-write |
|
} | ||
} | ||
Name | string read-only |
The name of the Server Group. |
RefreshRequired | boolean read-only |
The group is newly formed / a server is newly added to the group. |
SystemsCount | integer read-only |
The number of systems in the server group. |
HpeWfmManagedSystem
This is the schema definition for HpeWfmManagedSystem.
ArrayControllers [ { | array | |
CacheMemorySizeMiB | integer read-only |
Indicates the Cache Memory size of the Array Controller. |
FirmwareVersion | string read-only |
Indicates the Firmware Version of the Array Controller. |
HealthStatus | string read-only |
Indicates the Health Status of the Array Controller. |
Location | string read-only |
Indicates the Location of the Array Controller. |
LocationFormat | string read-only |
Indicates the Location format of the Array Controller. |
LogicalDrives [ { | array | |
CapacityMiB | integer read-only (null) |
Capacity of the Logical Drive in MiB. |
HealthStatus | string read-only (null) |
Health Status of the Logical Drive. |
LogicalDriveEncryption | boolean read-only (null) |
Logical Drive Encryption is Enabled on the Drive if True, Disabled if False. |
LogicalDriveNumber | integer read-only (null) |
Number of the Logical Drive. |
LogicalDriveType | string read-only (null) |
Type of the Logical Drive. |
Name | string read-only (null) |
Name of the Logical Drive. |
Raid | string read-only (null) |
Raid level of the Logical Drive. |
State | string read-only (null) |
State of the Logical Drive. |
VolumeUniqueIdentifier | string read-only (null) |
Volume Unique Identifier of the Logical Drive. |
} ] | ||
Model | string read-only |
Indicates the Model of the Array Controller. |
Name | string read-only |
Indicates the Name of the Array Controller. |
PhysicalDrives [ { | array | |
CapacityGB | integer read-only (null) |
Capacity of the Physical Drive in GB. |
CapacityMiB | integer read-only (null) |
Capacity of the Physical Drive in MiB. |
FirmwareVersion | string read-only (null) |
Firmware Version of the Physical Drive. |
HealthStatus | string read-only (null) |
Health Status of the Physical Drive. |
InterfaceSpeedMbps | integer read-only (null) |
Interface Speed of the Physical Drive. |
InterfaceType | string read-only (null) |
Interface Type of the Physical Drive. |
Location | string read-only (null) |
Location of the Physical Drive. |
LocationFormat | string read-only (null) |
Location Format of the Physical Drive. |
MediaType | string read-only (null) |
Media Type of the Physical Drive. |
Model | string read-only (null) |
Model of the Physical Drive. |
RotationalSpeedRpm | integer read-only (null) |
Rotational Speed of the Physical Drive. |
SerialNumber | string read-only (null) |
Serial Number of the Physical Drive. |
State | string read-only (null) |
State of the Physical Drive. |
} ] | ||
SerialNumber | string read-only |
Indicates the Serial Number of the Array Controller. |
State | string read-only |
Indicates the State of the Array Controller. |
StorageEnclosures [ { | array | |
DriveBayCount | integer read-only (null) |
Drive Bay Count of the Storage Enclosure. |
FirmwareVersion | string read-only (null) |
Firmware Version of the Storage Enclosure. |
HealthStatus | string read-only (null) |
Health Status of the Storage Enclosure. |
Location | string read-only (null) |
Location of the Storage Enclosure. |
LocationFormat | string read-only (null) |
Location Format of the Storage Enclosure. |
Name | string read-only (null) |
Name of the Storage Enclosure. |
SerialNumber | string read-only (null) |
Serial Number of the Storage Enclosure. |
State | string read-only (null) |
State of the Storage Enclosure. |
} ] | ||
} ] | ||
Description | read-write |
|
DeviceInventory [ { | array | The information relating to the Manager of this system |
read-write |
||
} ] | ||
FansSummary { | object | This object describes the system's fan details. |
Count | integer read-only (null) |
The number of fans in the system. |
Details [ { | array | |
CurrentReading | integer read-only (null) |
The current speed of the fan. |
FanName | string read-only (null) |
The name of the fan sensor. |
ReadingRPM | integer read-only (null) |
The current speed of the fan. |
Status | read-write |
|
Units | string (enum) read-only (null) |
Units for the CurrentReading. For the possible property values, see Units in Property Details. |
} ] | ||
} | ||
FirmwareInventory [ { | array | The information relating to the Manager of this system |
read-write |
||
} ] | ||
HealthSummary { | object | This object describes the health status of the system. |
AgentlessManagementService | string read-only (null) |
The status of the Agentless Management Service. |
BiosOrHardwareHealth | string read-only (null) |
The Health status of the Bios or Hardware. |
FanRedundancy | string read-only (null) |
This is the fan redundancy state of the system. |
Fans | string read-only (null) |
The Health status of the Fans. |
iLOHealth | string read-only (null) |
The status of the iLO Health. |
Memory | string read-only (null) |
The Health status of the Memory. |
Network | string read-only (null) |
The Health status of the Network. |
PowerSupplies | string read-only (null) |
The Health status of the Power Supplies. |
PowerSupplyRedundancy | string read-only (null) |
This is the power supply redundancy state of the system. |
Processors | string read-only (null) |
The Health status of the Processors. |
SmartStorageBattery | string read-only (null) |
The Smart Storage Battery state of the system. |
Storage | string read-only (null) |
The Health status of the Storage. |
Temperatures | string read-only (null) |
The Health status of Temperatures. |
} | ||
HostBusAdapters [ { | array | |
Drives [ { | array | |
CapacityMiB | integer read-only (null) |
Capacity of the drive in MiB. |
FirmwareVersion | string read-only (null) |
Firmware Version of the Disk Drive. |
HealthStatus | string read-only (null) |
Health Status of the Disk. |
Location | string read-only (null) |
Location of the Disk Drive. |
Model | string read-only (null) |
Model of the Disk. |
Name | string read-only (null) |
Name of the Disk. |
SerialNumber | string read-only (null) |
Serial Number of the Disk. |
State | string read-only (null) |
State of the Disk. |
} ] | ||
FirmwareVersion | string read-only |
Indicates the Firmware Version of the Host Bus Adapter. |
HealthStatus | string read-only |
Indicates the Health Status of the Host Bus Adapter. |
Location | string read-only |
Indicates the Location of the Host Bus Adapter. |
Model | string read-only |
Indicates the Model of the Host Bus Adapter. |
Name | string read-only |
Indicates the Name of the Host Bus Adapter. |
SerialNumber | string read-only |
Indicates the Serial Number of the Host Bus Adapter. |
State | string read-only |
Indicates the State of the Host Bus Adapter. |
} ] | ||
Id | read-write |
|
InfoSightMetrics { | object | |
AHSData { | object | Indicates the AHS download and upload status. |
AHSDownloadErrorDetails | string read-only |
Indicates the error details of why the AHS Download Failed. |
AHSFileSizeKB | integer read-only |
The Size of the AHS File Downloaded in KB. |
DownloadEndTime | string read-only |
Indicates the end time of the last AHS file downloaded for this node. |
DownloadStartTime | string read-only |
Indicates the start time of the last AHS file downloaded for this node. |
DownloadStatus | string (enum) read-only |
Indicates the status of the last AHS file downloaded for this node. For the possible property values, see DownloadStatus in Property Details. |
UploadEndTime | string read-only |
Indicates the end time of the last AHS file uploaded to InfoSight for this node. |
UploadStartTime | string read-only |
Indicates the start time of the last AHS file uploaded to InfoSight for this node. |
UploadStatus | string (enum) read-only |
Indicates the status of the last AHS file uploaded to InfoSight for this node. For the possible property values, see UploadStatus in Property Details. |
} | ||
HeartBeatLastUpdated | string read-only |
Indicates the last updated heartbeat timestamp. |
InventoryLastUpdated | string read-only |
Indicates the last updated inventory timestamp. |
} | ||
Manager { | object | The information relating to the Manager of this system. |
Credentials | read-write |
|
DateTime | string read-only |
iLO Date and Time |
FirmwareVersion | string read-only (null) |
The firmware version of this Manager. |
License { | object | The information relating to the Manager license of this system. |
LicenseKey | string read-only |
The license key installed on this management processor. License keys are 25 characters in length and contain both letters and numbers. Use POST method to collection of membertype HpiLOLicense to install / update the license. |
LicenseType | string (enum) read-only |
The type of license installed on this management processor. For the possible property values, see LicenseType in Property Details. |
Name | string read-only |
The name of the license installed on this management processor. |
} | ||
ManagerEthernetAddresses [ { | array | This array of objects is used to represent the IPv4 connection characteristics for this interface. |
IPv4Address | string read-only |
Indicates the IPv4 Address of the Manager Ethernet Interface. |
IPv6Address1 | string read-only |
Indicates the IPv6 Address of the Manager Ethernet Interface. |
IPv6Address2 | string read-only |
Indicates the IPv6 Address of the Manager Ethernet Interface. |
IPv6Address3 | string read-only |
Indicates the IPv6 Address of the Manager Ethernet Interface. |
IPv6Address4 | string read-only |
Indicates the IPv6 Address of the Manager Ethernet Interface. |
ManagerFQDN | string read-only |
Indicates the FQDN of the Manager Ethernet Interface. |
NICEnabled | boolean read-only |
Indicates whether the NIC is enabled or not. |
} ] | ||
ManagerType | string (enum) read-only |
This property is the manager type for this resource. For the possible property values, see ManagerType in Property Details. |
Model | string read-only (null) |
Model name of the manager. |
RemoteSyslog { | object | The information relating to the remote syslog configuration of the Manager of this system |
Enabled | boolean read-write |
Indicates whether Remote Syslog is enabled. When enabled, management processor sends notification messages to the specified Syslog server. This can be enabled only when the property RemoteSyslogServer is set or not empty. |
Port | integer read-write |
The port number through which the Syslog server is listening. |
Server | string read-write |
The IP address, FQDN, IPv6 name, or short name of the server running the Syslog service. |
} | ||
UpdateService { | object | The information relating to the update service of the Manager of this system. |
Details | string read-only |
Details about the current firmware flash status. |
Flags | string (enum) read-only |
Other flags. For the possible property values, see Flags in Property Details. |
ImageType | string (enum) read-only |
Firmware flash image type. For the possible property values, see ImageType in Property Details. |
ProgressPercent | integer read-only |
Firmware flash progress. |
State | string (enum) read-only |
Current state of the firmware flash. For the possible property values, see State in Property Details. |
} | ||
UUID | string read-only (null) |
The universal unique identifier for this Manager. |
VirtualMedia { | object | The information relating to the Manager virtual media of this system. |
ConnectedVia | string (enum) read-only (null) |
Specifies how the virtual media is connected to the server. For the possible property values, see ConnectedVia in Property Details. |
} | ||
} | ||
MemorySummary { | object | This object describes the central memory of the system in general detail. |
Count | integer read-only (null) |
The number of processors in the system. |
Details [ { | array | |
DIMMStatus | string (enum) read-only (null) |
Specifies memory module status and whether the module in use. For the possible property values, see DIMMStatus in Property Details. |
DIMMTechnology | string (enum) read-only (null) |
The memory module technology type. For the possible property values, see DIMMTechnology in Property Details. |
DIMMType | string (enum) read-only (null) |
The type of memory DIMM used in this system. For the possible property values, see DIMMType in Property Details. |
MaximumFrequencyMHz | integer read-only (null) |
Identifies the maximum, capable speed of the device in megahertz (MHz). If the value is null, the speed is unknown. |
SizeMB | integer read-only (null) |
The size of the memory device in megabytes. |
SocketLocator | string read-only (null) |
The socket of this device. |
} ] | ||
Status | read-write |
|
TotalSystemMemoryGiB | integer read-only (null) |
This is the total amount of memory in the system measured in GiB. |
} | ||
Name | read-write |
|
NetworkAdapters [ { | array | |
FirmwareVersion | string read-only (null) |
Network Adapter firmware version |
Name | string read-only (null) |
Network Adapter name. |
PhysicalPorts [ { | array | |
FullDuplex | boolean read-only (null) |
Full-duplex data transmission allows data to be transmitted in both directions on a signal carrier at the same time. |
IPv4Addresses [ { | array | This array of objects is used to represent the IPv4 connection characteristics for this interface. |
Address | string read-only (null) |
This is the IPv4 Address. |
} ] | ||
IPv6Addresses [ { | array | This array of objects enumerates all of the currently assigned IPv6 addresses on this interface. |
Address | string read-only (null) |
This is the IPv6 Address. |
} ] | ||
MacAddress | string read-only (null) |
The port MAC address. |
SpeedMbps | integer read-only (null) |
An estimate of the interface's current bandwidth in Megabits per second. For interfaces which do not vary in bandwidth or for those where no accurate estimation can be made, this object should contain the nominal bandwidth. |
Status | read-write |
|
} ] | ||
} ] | ||
PCIDeviceSummary [ { | array | The information relating to the PCI Devices of the Manager of this system. |
DeviceID | integer read-write |
Indicates the Device ID of the PCI Device. |
DeviceLocation | string read-write |
Indicates the location of the PCI Device. |
DeviceType | string read-write |
Indicates the device type of the PCI Device. |
DeviceVersion | string read-write |
Indicates the device Version of the PCI Device. |
Name | string read-only |
Indicates the name of the PCI Device. |
SubsystemDeviceID | integer read-only |
Indicates the Subsystem Device ID of the PCI Device. |
SubsystemVendorID | integer read-write |
Indicates the Subsystem Vendor ID of the PCI Device. |
VendorID | integer read-only |
Indicates the Vendor ID of the PCI Device. |
} ] | ||
Persona { | object | The information relating to the profile or persona applied on this system. |
AppliedDetails { | object | The result of the persona applied on this system. |
LastApplied | string read-only |
The date and time when the persona was applied on this system. |
PersonaId | integer read-only |
The name of the presona that was applied on this system. |
Status | string (enum) read-only |
The status result of the persona that was applied on this system. For the possible property values, see Status in Property Details. |
} | ||
ValidationDetails { | object | The results of the persona validation performed on this system. |
LastValidated | string read-only |
The date and time when the persona was validated on this system. |
PersonaId | integer read-only |
The name of the presona that was validated on this system. |
Status | string (enum) read-only |
The status result of the persona validation that was applied on this system. For the possible property values, see Status in Property Details. |
} | ||
} | ||
PowerSummary { | object | This object describes the power supplies of the system in general detail. |
Count | integer read-only (null) |
The number of power supplies in the system. |
PowerConsumedWatts | integer read-only (null) |
The amount of power consumed in Watts. |
PowerSupplies [ { | array | |
BayNumber | integer read-only (null) |
The bay number of this processor. |
FirmwareVersion | string read-only (null) |
The Firmware version of the power supply. |
HealthStatus | string read-only (null) |
The health status of the power supply. |
HotplugCapable | boolean read-only |
The Firmware version of the power supply. |
Model | string read-only (null) |
The product model of this device. |
Name | string read-only (null) |
The Name of the power supply. |
PowerCapacityWatts | integer read-only (null) |
The total Power Capacity in Watts. |
PowerSupplyStatus | string read-only (null) |
The Status of the power supply. |
SerialNumber | string read-only (null) |
The power supply Serial Number. |
SparePartNumber | string read-only (null) |
The power supply Spare Part Number. |
State | string read-only (null) |
The state of the power supply. |
} ] | ||
} | ||
ProcessorSummary { | object | This object describes the central processors of the system in general detail. |
Count | integer read-only (null) |
The number of processors in the system. |
Details [ { | array | |
CoresEnabled | integer read-only (null) |
The total number of cores enabled in this processor. |
Manufacturer | string read-only (null) |
The processor manufacturer. |
Model | string read-only (null) |
The product model number of this device. |
Socket | string read-only (null) |
The socket of this device. |
SpeedMHz | integer read-only (null) |
The maximum clock speed of the processor. |
Status | read-write |
|
TotalCores | integer read-only (null) |
The total number of cores contained in this processor. |
TotalThreads | integer read-only (null) |
The total number of execution threads supported by this processor. |
} ] | ||
Model | string read-only (null) |
The processor model for the primary or majority of processors in this system. |
Status | read-write |
|
} | ||
ServerGroups [ ] | array (string) read-only |
|
SmartStorageBatterySummary [ { | array | This object describes the Smart Storage Battery details of the system. |
ChargeLevelPercent | integer read-only |
Charge Level Percent of Smart Storage Battery. |
FirmwareVersion | string read-only |
Firmware Version of Smart Storage Battery. |
HealthStatus | string (enum) read-only |
This represents the health status of the system For the possible property values, see HealthStatus in Property Details. |
Index | integer read-only |
Index of Smart Storage Battery. |
MaximumCapWatts | integer read-only |
Maximum Capacity of Smart Storage Battery in Watts. |
Model | string read-only |
Model name of Smart Storage Battery. |
ProductName | string read-only |
Product name of Smart Storage Battery. |
RemainingChargeTimeSeconds | integer read-only |
Remaining Charge Time Seconds of Smart Storage Battery. |
SerialNumber | string read-only |
Serial Number of Smart Storage Battery. |
SparePartNumber | string read-only |
Spare Part Number of Smart Storage Battery. |
State | string read-only |
Indicates the State of the System. |
} ] | ||
SoftwareInventory [ { | array | |
Description | string read-only |
Indicates the description about the Software. |
Name | string read-only |
Indicates the Name of the Software. |
SoftwareId | integer read-only |
Indicates the ID of the Software. |
Version | string read-only |
Indicates the Version of the Software. |
} ] | ||
SystemSummary | read-write |
|
TaskHistory [ { | array | Contains the members of this collection. |
@odata.id | read-write |
|
} ] |
Property Details
ConnectedVia:
Specifies how the virtual media is connected to the server.
string | Description |
---|---|
Applet | Connected to a client application. |
None | |
NotConnected | No current connection. |
URI | Connected to a URI location. |
DIMMStatus:
Specifies memory module status and whether the module in use.
string | Description |
---|---|
AddedButUnused | DIMM is added but currently unused. |
ConfigurationError | Configuration error in DIMM. |
Degraded | DIMM state is degraded. |
DoesNotMatch | DIMM type does not match. |
ExpectedButMissing | DIMM is expected but missing. |
GoodInUse | DIMM is functioning properly and currently in use. |
GoodPartiallyInUse | DIMM is functioning properly but partially in use. |
None | |
NotPresent | DIMM is not present. |
NotSupported | DIMM is not supported. |
Other | DIMM status that does not fit any of these definitions. |
PresentSpare | DIMM is present but used as spare. |
PresentUnused | DIMM is present but unused. |
Unknown | The status of the DIMM is unknown. |
UpgradedButUnused | DIMM is upgraded but currently unused. |
DIMMTechnology:
The memory module technology type.
string |
---|
None |
BurstEDO |
FastPage |
Synchronous |
EDO |
LRDIMM |
RDRAM |
RDIMM |
UDIMM |
NVDIMM |
RNVDIMM |
LRNVDIMM |
Unknown |
DIMMType:
The type of memory DIMM used in this system.
string |
---|
None |
DDR |
DDR2 |
DDR3 |
DDR4 |
FBD2 |
LPDD3 |
LPDDR |
LPDDR2 |
LPDDR4 |
DownloadStatus:
Indicates the status of the last AHS file downloaded for this node.
string |
---|
Pending |
Running |
Done |
Failed |
Flags:
Other flags.
string |
---|
NONE |
RESET_ILO |
REQUEST_SYSTEM_COLD_BOOT |
REQUEST_SYSTEM_WARM_BOOT |
DEFERRED_AUX_PWR_CYCLE |
HealthStatus:
This represents the health status of the system
string | Description |
---|---|
Critical | A critical condition exists that requires immediate attention |
OK | Normal |
Warning | A condition exists that requires attention |
ImageType:
Firmware flash image type.
string |
---|
NO_DEVICE |
ILO_DEVICE |
ILO_DEVICE_FIRMWARE |
ILO_DEVICE_LANGPK |
ILO_DEVICE_DEBUGGER |
BIOS_DEVICE |
SCD_DEVICE |
CPLD_DEVICE |
CARB_DEVICE |
PM_DEVICE |
UNKNOWN |
LicenseType:
The type of license installed on this management processor.
string |
---|
Unlicensed |
Evaluation |
Perpetual |
Subscription |
Internal |
Duration |
Expired |
ManagerType:
This property is the manager type for this resource.
string | Description |
---|---|
BMC | A controller which provides management functions for a single computer system. |
EnclosureManager | A controller which provides management functions for a chassis or group of devices or systems. |
ManagementController | A controller used primarily to monitor or manage the operation of a device or system. |
State:
Current state of the firmware flash.
string |
---|
IDLE |
UPLOADING |
PROGRESSING |
COMPLETED |
ERROR |
Status:
The status result of the persona validation that was applied on this system.
string |
---|
NotInitiated |
Queued |
InProgress |
Failed |
Aborted |
Successful |
PartiallySuccessful |
NotSuccessful |
Unknown |
Units:
Units for the CurrentReading.
string |
---|
None |
RPM |
Percent |
UploadStatus:
Indicates the status of the last AHS file uploaded to InfoSight for this node.
string |
---|
Pending |
Running |
Done |
Failed |
HpeWfmManagerExt
This is the schema definition for HpeWfmManagerExt.
Description | read-write |
|
Firmware | read-write |
|
Id | read-write |
|
License | read-write |
|
Links { | object | The links array contains the links to other resources that are related to this resource. |
AddOnServicesManager { | object | The URI for the add-on services manager resource. |
@odata.id | read-write |
|
} | ||
BaselineService { | object | The URI for this security service resource. |
@odata.id | read-write |
|
} | ||
DateTimeService { | object | The URI for this date time service resource. |
@odata.id | read-write |
|
} | ||
InfoSightAggregationPolicy { | object | Reference to a resource of InfoSight Aggregation Policy. |
@odata.id | read-write |
|
} | ||
LicenseService { | object | The URI for this license service resource. |
@odata.id | read-write |
|
} | ||
LoggerPolicy { | object | Reference to a resource of Debug LoggerPolicy. |
@odata.id | read-write |
|
} | ||
SecurityService { | object | The URI for this security service resource. |
@odata.id | read-write |
|
} | ||
Telemetry { | object | The URI for telemetry service resource. |
@odata.id | read-write |
|
} | ||
UpdateService { | object | The URI for this update service resource. |
@odata.id | read-write |
|
} | ||
} | ||
Name | read-write |
|
SerialCLISpeed | integer (enum) read-write |
Serial command line interface speed in bits/second. For the possible property values, see SerialCLISpeed in Property Details. |
SerialCLIStatus | string (enum) read-write (null) |
Status of serial command line interface. For the possible property values, see SerialCLIStatus in Property Details. |
Type | read-write |
|
WatchdogTimerActive | boolean read-write |
Specifies whether Watchdog is enabled or not. |
Actions
Backup
URIs:
(This action takes no parameters.)
ResetToFactoryDefaults
URIs:
(This action takes no parameters.)
Restore
URIs:
(This action takes no parameters.)
Shutdown
URIs:
(This action takes no parameters.)
Property Details
SerialCLISpeed:
Serial command line interface speed in bits/second.
integer |
---|
9600 |
19200 |
38400 |
57600 |
115200 |
SerialCLIStatus:
Status of serial command line interface.
string | Description |
---|---|
Disabled | Serial command line interface is disabled. |
EnabledAuthReq | Serial command line interface is enabled with authentication required. |
EnabledNoAuth | Serial command line interface is enabled with no authentication required. |
None |
HpeWfmManagerNetworkService
This is the schema definition for HpeWfmManagerNetworkService.
Description | read-write |
|
Id | read-write |
|
Links { | object | The resource URIs related to the network services managed by this manager. |
EthernetInterfaces { | object | The URIs of the Ethernet NICs. |
@odata.id | read-write |
|
} | ||
} | ||
Name | read-write |
|
ProxyServer { | object | Proxy Server options. |
BypassProxyEnabled | boolean read-write |
Indicates whether to bypass the proxy or not. When enabled, management processor sends alerts without using the proxy server otherwise it will use the proxy server. |
BypassProxyServers | string read-write |
Bypass Proxy Servers list. The list should be comma separated values. The valid entries are ipv4/ipv6 address, FQDN, Domain name, CIDR format like 15.146.0.0/12 and domain name prefixed with "." to match *.domain names (.hpe.com) |
Enabled | boolean read-write |
Indicates whether to use proxy server or not. When enabled, management processor sends alerts via proxy server otherwise it will not use the proxy server. |
Port | integer read-write |
The port number through which the Proxy server is listening. |
ProxyPassword | string read-write |
Password for proxy server authentication. |
ProxyUsername | string read-write |
Username for proxy server authentication. |
SecureProxyEnabled | boolean read-write |
Indicates whether to connect to proxy server securely. When enabled, proxy server is connected via https, else uses http. |
Server | string read-write |
The IP address, FQDN, IPv6 name, or short name of the Proxy server. |
} | ||
RemoteSyslog { | object | Remote Syslog options. |
Enabled | boolean read-write |
Indicates whether Remote Syslog is enabled. When enabled, management processor sends notification messages to the specified Syslog server. This can be enabled only when the property RemoteSyslogServer is set or not empty. |
Port | integer read-write |
The port number through which the Syslog server is listening. |
PrimaryServer | string read-write |
The IP address, FQDN, IPv6 name, or short name of the server running the Syslog service. |
SecondaryServer | string read-write |
The IP address, FQDN, IPv6 name, or short name of the server running the Syslog service. |
} | ||
TestConnectionResults { | object | Results of the last run test. |
DetailString | string read-only |
Detailed message string for the status of connection. |
LastTestRunDate | string read-only (null) |
Time at which the tests were run last time. |
Status | string (enum) read-only |
Status of the last run test For the possible property values, see Status in Property Details. |
} |
Actions
SendTestSyslog
URIs:
(This action takes no parameters.)
TestConnection
Test Connectivity to HPE InfoSight Backend.
URIs:
(This action takes no parameters.)
Property Details
Status:
Status of the last run test
string | Description |
---|---|
Failed | Test connection failed. |
NotInitiated | Test was not initiated. |
PartialSuccess | Partial success. See DetailString. |
Success | Test connection succeeded. |
Testing | Testing in progress |
HpeWfmManualRecoveryJobResults
This is the schema definition for HpeWfmManualRecoveryJobResults.
Description | read-write |
|
Id | read-write |
|
InstallSetInfo { | object | The Install Set Details. |
InstallSetComponents [ { | array | |
ComponentInfo [ { | array | |
ActiveVersion | string read-write |
The component active version. |
AvailableVersion | string read-write |
The component version available for update. |
ComponentDescription | string read-write |
The component description of the install component. |
ComponentName | string read-write |
The component name of the install component. |
ComponentType | string read-write |
The component type(Firmware/Driver etc.) |
CurrentVersion | string read-write |
The component current version. |
DependencyFailed | boolean read-write |
The component install dependency failed flag. |
DeploymentResult | string read-write |
The result after the deployment. |
InstalledVersion | string read-write |
The final installed version. |
IsForcedFlag | boolean read-write |
The component isForced flag. |
IsSelectedFlag | boolean read-write |
The component isSelected flag. |
PreviousInstalledVersion | string read-write |
The previous installed version. |
ProductFamilyName | string read-write |
The component product family name. |
StatusMessage | string read-write |
The component install status message. |
} ] | ||
ManagerAddress | string read-write |
The IP address of the Managed Server. |
TotalErrors | integer read-write |
Gives the total errors/failed dependencies during the calculate Install set for the Managed Node. |
} ] | ||
} | ||
Name | read-write |
HpeWfmNonFedGroupJobResults
This is the schema definition for HpeWfmNonFedGroupJobResults.
Description | read-write |
|
Name | read-write |
|
ServerGroupJobInfo [ { | array | |
JobStatus | string read-only |
Progress message associated with the job. |
ManagerAddress | string read-only |
The Manager address of the Server. |
StatusMessage | string read-only |
Progress message associated with the job. |
} ] |
HpeWfmOSBaseline
This is the schema definition for HpeWfmOSBaseline.
BaselineState | string (enum) read-only |
This property indicates the state of inventory for this resource. For the possible property values, see BaselineState in Property Details. |
Description | read-write |
|
Id | read-write |
|
Name | read-write |
|
RelatedTask { | object | The URI refers to the task which is created to import this OS baseline. |
@odata.id | read-write |
|
} | ||
SizeInMB | integer read-only |
Space on disk (in MB) used by this OS baseline. |
Property Details
BaselineState:
This property indicates the state of inventory for this resource.
string | Description |
---|---|
ImportFailed | Import of the OS baseline failed. |
ImportInProgress | Import of the OS baseline is in progress. |
ImportSuccess | Import of the OS baseline was completed successfully. |
HpeWfmOSBaselineService
This is the schema definition for HpeWfmOSBaselineService.
DateTime | string read-only (null) |
The current DateTime (with offset) setting that the task service is using. |
Description | read-write |
|
FreeSpaceInMB | integer read-only |
Free space of disk (in MB) remaining for importing OS baselines . |
Id | read-write |
|
Name | read-write |
|
Oem | read-write |
This is the manufacturer/provider specific extension moniker used to divide the Oem object into sections. |
OSBaselines { | object | This property references a collection resource of imported OS baselines. |
@odata.id | read-write |
|
} | ||
ServiceEnabled | boolean read-only (null) |
This indicates whether this service is enabled. |
Status | read-write |
|
TotalSpaceInMB | integer read-only |
Total space of disk (in MB) allocated for importing OS baselines . |
HpeWfmRecoveryPolicy
This is the schema definition for HpeWfmRecoveryPolicy.
BaselineID | integer read-write |
The Baseline ID used for this recovery policy. |
CreatedBy | string read-only |
The name of the user that created the recovery policy. |
CreatedTime | string read-only |
The recovery policy creation time. |
Description | read-write |
|
Id | read-write |
|
LastUpdatedBy | string read-only |
The name of the user that last updated the recovery policy. |
LastUpdatedTime | string read-only |
The recovery policy modification time. |
Name | string read-write |
The name of the recovery policy. |
OperatingSystemID | integer read-write |
The Operating System ID used for this recovery policy. |
PersonaID | integer read-write |
The Persona ID used for this recovery policy. |
Type | read-write |
|
UseNANDBackupRestoreIfAvailable | boolean read-write |
Describes whether we should use the iLO Backup and Restore feature. |
Version | integer read-only |
The recovery policy version. |
HpeWfmSecurityServiceExt
This is the schema definition for HpeWfmSecurityServiceExt.
Description | read-write |
|
Id | read-write |
|
LoginBanner { | object | |
IsEnabled | boolean read-write |
The login security banner message that is displayed on the management processor Login page. |
Message | string read-write |
The is to enable the message that is displayed on the management processor Login page. |
} | ||
Name | read-write |
HpeWfmServerGroups
This is the schema definition for HpeWfmServerGroups.
Description | read-write |
|
Id | read-write |
|
Name | read-write |
|
Systems { | object | This property references a resource of type Collection with a MemberType of Systems in the server groups. |
@odata.id | read-write |
|
} |
HpeWfmServiceExt
This is the schema definition for HpeWfmServiceExt.
Description | read-write |
|
Id | read-write |
|
Language | string read-write |
Specifies the Language to be used. |
Links { | object | The links array contains the links to other resources that are related to this resource. |
AddOnServices { | object | The URI to Add-on Services resource. |
@odata.id | read-write |
|
} | ||
AggregatorService { | object | The URI to this Aggregator service resource. |
@odata.id | read-write |
|
} | ||
ResourceDirectory { | object | The URI for the resource directory. |
@odata.id | read-write |
|
} | ||
} | ||
Manager [ { | array | |
FQDN | string read-only |
Fully qualified domain name of the management processor. |
HostName | string read-only |
The name of management processor. |
ManagerFirmwareVersion | string read-only |
The major and minor management processor version numbers. |
ManagerFirmwareVersionPass | string read-only |
The build or pass number of the management processor version. |
Model | string (enum) read-only |
The type of the service manager. For the possible property values, see Model in Property Details. |
} ] | ||
Name | read-write |
|
Sessions { | object | |
CertCommonName | string read-only |
The name of the management processor as it appears in the digital certificate when a secure web GUI session is established to the management processor. |
KerberosEnabled | boolean read-only |
Specifies whether Kerberos login is enabled. |
LDAPAuthLicenced | boolean read-only |
Specifies whether a valid license is installed for LDAP use. |
LDAPEnabled | boolean read-only |
Specifies whether LDAP login is enabled. |
LocalLoginEnabled | boolean read-only |
Specifies whether local users can log in. |
LoginFailureDelay | integer read-only |
The delay (seconds) when a management processor login attempt has failed. |
LoginHint { | object | |
Hint | string read-only |
The information on how to log in to the management processor. |
HintPOSTData { | object | The POST information on how to log in to the management processor. |
Password | string read-only |
The password for logging in to the management processor. |
UserName | string read-only |
The user name for logging in to the management processor. |
} | ||
} | ||
SecurityMessage | string read-only |
The login security banner message that is displayed on the management processor Login page. |
SecurityOverride | boolean read-only |
Specifies whether the security override switch is enabled. |
ServerName | string read-only |
The name of the server that this management processor is managing. |
} |
HpeWfmSessionExt
This is the schema definition for HpeWfmSessionExt.
AccessTime | string read-only |
User session last-access time |
Description | read-write |
|
Id | read-write |
|
Links { | object | Contains references to other resources that are related to this resource. |
Account { | object | The user accounts, owned by a Manager, are defined in this resource. Changes to a Manager Account may affect the current Redfish service connection if this manager is responsible for the Redfish service. See the ManagerAccount schema for details on this property. |
@odata.id | string read-only |
Link to a ManagerAccount resource. See the Links section and the ManagerAccount schema for details. |
} | ||
} | ||
LoginTime | string read-only |
User session login time |
MySession | boolean read-only |
Indicates whether this is a session you own. |
Name | read-write |
|
Privilege | string (enum) read-write |
Account privileges available for the user For the possible property values, see Privilege in Property Details. |
Type | read-write |
|
UserAccount | string read-only |
Login details of the user |
UserExpires | string read-only |
User session expire time |
UserIP | string read-only |
IP address of the user |
UserTag | string (enum) read-only |
Session source For the possible property values, see UserTag in Property Details. |
UserType | string (enum) read-only |
User type For the possible property values, see UserType in Property Details. |
Property Details
Privilege:
Account privileges available for the user
string | Description |
---|---|
Device | Allows configuring and performing actions on devices includes login privilege |
Login | Read operations allowed like viewing discovered nodes and groups and generate reports |
Manager | All operations allowed |
User | Allows configuring users with device privilege |
UserTag:
Session source
string |
---|
Web UI |
SSH |
Console |
Unknown |
UserType:
User type
string |
---|
Local |
Directory |
Single Sign On |
Kerberos |
Trusted Key |
Security Override |
System |
Federation |
HpeWfmSoftwareInventory
This is the schema definition for HpeWfmSoftwareInventory.
Description | read-write |
|
DeviceClass | string read-only |
The Device Class of the firmware. |
DeviceContext | string read-only |
The Device Context of the firmware. |
Id | read-write |
|
Name | read-write |
|
OSType | string read-only |
The OS type for the driver/software. |
HpeWfmSppComplianceJobResults
This is the schema definition for HpeWfmSppComplianceJobResults.
BaselineComplianceInfo { | object | The Install Set Details. |
ComponentInfo [ { | array | |
AvailableVersion | string read-only |
The component version available in the baseline. |
ComponentDescription | string read-only |
The component description of the install component. |
ComponentName | string read-only |
The component name of the install component. |
InstalledVersion | string read-only |
The current component version. |
Status | string read-only |
Status of the component. |
} ] | ||
IsCompliantFlag | boolean read-only |
The Server compliance flag. |
IsFirmwareOnly | boolean read-only |
This describes whether the compliance is only for firmware or not. |
ManagerAddress | string read-only |
The IP address of the Managed Server. |
StatusMessage | string read-only |
Progress message associated with the job. |
} | ||
Description | read-write |
|
Name | read-write |
|
Results { | object | Result for the compliance run. |
JobStatusMessage | string read-only |
Progress message associated with the job. |
OutputCsvFile | read-only |
The URI for the output CSV file after a successfull run. |
ResultSummary [ { | array | Summary results for each node |
DetailedResultsUri | string read-only |
The url for Detailed Results. |
IpAddress | string read-only |
The system/group on which the job is applied. |
IsCompliant | boolean read-only |
Specifies whether the server is compliant with the baseline. |
StatusMessage | string read-only |
Progress message associated with the system. |
} ] | ||
} |
HpeWfmSystemSummary
This is the schema definition for HpeWfmSystemSummary.
ActionCapabilities { | object | This object describes the Actions that can be performed on the system. |
AbsarokaOfflineUpdate | boolean read-only |
The Action capability for Absaroka Offline Update. |
AbsarokaOnlineUpdate | boolean read-only |
The Action capability for Absaroka Online Update. |
AHSDownload | boolean read-only |
The Action capability for AHS Download. |
AssignRecovery | boolean read-only |
The Action capability for Assign Recovery. |
BaselineAutomaticUpdate | boolean read-only |
The Action capability for Baseline Automatic Update. |
Delete | boolean read-only |
The Action capability for Delete. |
DeployUpdate | boolean read-only |
The Action capability for Deploy Capable Servers. |
ExcludeFromInfoSight | boolean read-only |
This property indicates whether the server is excluded from sending data to InfoSight. If set to true the data is not sent to InfoSight, if set to false the data is sent to InfoSight. |
FirmwareUpdate | boolean read-only |
The Action capability for Firmware Update. |
GroupManage | boolean read-only |
The Action capability for Group Manage. |
ImportConfigBaseline | boolean read-only |
The Action capability for Import config baseline. |
ManualRecovery | boolean read-only |
The Action capability for Manual Recovery. |
OfflineFirmwareUpdate | boolean read-only |
The Action capability for Offline Firmware Update. |
OnlineFirmwareUpdate | boolean read-only |
The Action capability for Online Firmware Update. |
Power | boolean read-only |
The Action capability for Power. |
Refresh | boolean read-only |
The Action capability for Refresh. |
RemoteSyslog | boolean read-only |
The Action capability for Remote Syslog. |
UID | boolean read-only |
The Action capability for UID. |
UnAssignRecovery | boolean read-only |
The Action capability for Unassign Recovery. |
VirtualMedia | boolean read-only |
The Action capability for Virtual Media. |
} | ||
ActionErrorMessage { | object | This object describes the Actions that can be performed on the system. |
AbsarokaOfflineUpdate | string read-only |
The error message for Absaroka Offline Update. |
AbsarokaOnlineUpdate | string read-only |
The error message for Absaroka Online Update. |
AssignRecovery | string read-only |
The error message for Assign Recovery. |
BaselineAutomaticUpdate | string read-only |
The error message for Baseline Automatic Update. |
GroupManage | string read-only |
The error message for Manage Group. |
ImportConfigBaseline | string read-only |
The error message for Import Config Baseline. |
OfflineFirmwareUpdate | string read-only |
The error message for Offline Firmware Update. |
OnlineFirmwareUpdate | string read-only |
The error message for Online Firmware Update. |
} | ||
AllowActions | boolean read-only |
Indicates if the action is allowed on a server. |
AMSStatus | string read-only |
Gives the status of AMS. |
ChassisType | string read-only |
The chassis type. |
Description | read-write |
|
Discovery | read-write |
|
EncryptionSecurityState | string (enum) read-only |
Indicates the Encryption Security State of the Server. For the possible property values, see EncryptionSecurityState in Property Details. |
ExternalManagementEntity | string read-only |
Indicates the external management entity information. |
FederationActionGroupName | string read-only |
Gives the name of the Federation Group the server belongs to. |
FederationEnabled | boolean read-only |
Indicates whether management processor Federation management is enabled or disabled. |
FederationSupported | boolean read-only |
Indicates whether management processor Federation is supported. |
GatewayManaged | boolean read-only |
Indicates if the Server is Gateway Managed (Federation Group). |
HealthStatus | string (enum) read-only |
This represents the health status of the system. For the possible property values, see HealthStatus in Property Details. |
HostName | string read-only |
The DNS Host Name, without any domain information. |
HostOSDescription | string read-only |
Gives description about OS on the Host. |
HostOSName | string read-only |
Gives the OS Name of the Host. |
HostOSType | integer read-only |
Gives the OS Type of the Host. |
HostOSVersion | string read-only |
Gives the OS Version of the Host. |
Id | read-write |
|
iLOBackupFileForRestore | string read-only |
Indicates the date on which the backup was created on the iLO NAND. Otherwise says No. |
iLOHealth | string read-only |
The status of the iLO Health. |
iLOType | string read-only |
The iLO type of this Manager. |
iLOUUID | string read-only |
The universal unique identifier for the iLO. |
IndicatorLED | string (enum) read-write |
The state of the indicator LED. For the possible property values, see IndicatorLED in Property Details. |
LastTaskStatus | read-write |
|
ManagerAddress | string read-only |
The IP address or DNS of the manager which was added by user. |
ManagerFirmwareVersion | string read-only |
Gives the Firmware Version of the manager. |
ManagerFQDN | string read-only |
The fully qualified domain name of the manager. |
ManagerIPAddress | string read-only |
The IPv4 address of the manager. |
ManagerIPv6Address1 | string read-only |
The IPv6 address of the manager. |
ManagerIPv6Address2 | string read-only |
The IPv6 address of the manager. |
ManagerIPv6Address3 | string read-only |
The IPv6 address of the manager. |
ManagerIPv6Address4 | string read-only |
The IPv6 address of the manager. |
ManagerLicense | string read-only |
Gives the License of the manager. |
ManagerSSLPort | integer read-only |
The Web Server SSL Port of the manager. |
ManagerVirtualMediaImage | string read-write |
The valid URI indicating the image that is mounted on this server. A null value indicates that no image exists. |
ManualRecoveryFlag | boolean read-only |
Indicates if the Server is set for Manual or Automatic Recovery. |
Manufacturer | string read-only |
The manufacturer of the system. |
MasterManagerType | string read-only |
The type of the manager. |
MasterManagerTypeUrl | string read-only |
The url of the master manager type. |
Model | string read-only |
The model information that the manufacturer uses to refer to this system. |
Name | read-write |
|
NumOfGrpsNodeBelongs | integer read-only |
Gives the number of Federation Groups this iLO is part of. |
PowerState | string (enum) read-only |
This is the current power state of the system. For the possible property values, see PowerState in Property Details. |
ProductID | string read-only |
The system product ID. |
RecoveryAction | string read-only |
Indicates the Action that is set for recovery. |
RecoveryPolicyId | integer read-only |
Gives the Recovery Policy Id. |
RecoveryPolicyName | string read-only |
Indicates the Recovery Persona Applied on the System. |
RecoveryStatus | string read-only |
Indicates the Status of the System. If the recovery install set is applied or not, and its status once recovery starts. |
SecurityState | string read-only |
Indicates the Security State of the System. |
SerialNumber | string read-only |
The system serial number. |
ServerPlatformType | string (enum) read-only |
This property is the server platform type for this resource. For the possible property values, see ServerPlatformType in Property Details. |
ServerUpdateInfo { | object | This object describes the status of the update operations. |
BaselineId | integer read-only |
The baseline that is applied for the server update. |
BaselineName | string read-only |
The name of the baseline that the server was staged with. |
State | string (enum) read-only |
The state field indicates whether the server is staged/deployed etc. For the possible property values, see State in Property Details. |
StoredSUTMode | string read-only |
The previous SUT mode before starting the update. |
} | ||
StandAloneManaged | boolean read-only |
Indicates if the Server is Standalone Managed with Credentials. |
StatusState | string read-only |
Indicates the State of the System. |
SummaryForSystem { | object | Link to the Managed System with detailed information. |
@odata.id | read-write |
|
} | ||
SUTMode | string read-only |
Gives the Mode of HPSUT. |
SUTServiceState | string read-only |
Gives the Service state of HPSUT. |
SUTServiceVersion | string read-only |
Gives the Service Version of HPSUT. |
SystemCategory | string (enum) read-only |
The category of the system based on discovery. For the possible property values, see SystemCategory in Property Details. |
SystemType | string read-only |
The system type. |
TPMModuleType | string read-only |
Gives the Module Type of TPM on the Server. |
TPMStatus | string read-only |
Gives the Status of TPM on the Server. |
UUID | string read-only |
The universal unique identifier for this system. |
Property Details
EncryptionSecurityState:
Indicates the Encryption Security State of the Server.
string |
---|
Production |
HighSecurity |
FIPS |
HealthStatus:
This represents the health status of the system.
string | Description |
---|---|
Critical | A critical condition exists that requires immediate attention |
OK | Normal |
Warning | A condition exists that requires attention |
IndicatorLED:
The state of the indicator LED.
string | Description |
---|---|
Blinking | The Indicator LED is blinking. |
Lit | The Indicator LED is lit. |
Off | The Indicator LED is off. |
Unknown | The state of the Indicator LED cannot be determined. |
PowerState:
This is the current power state of the system.
string |
---|
On |
Off |
Unknown |
Reset |
ServerPlatformType:
This property is the server platform type for this resource.
string |
---|
Edgeline |
Proliant |
Apollo |
Synergy |
State:
The state field indicates whether the server is staged/deployed etc.
string | Description |
---|---|
Deployed | Server is successfully Deployed. |
DeployFailed | Server deployment failed. |
NotInitiated | No server update initiated. |
Staged | Server is successfully Staged. |
StageFailed | Server staging failed. |
SystemCategory:
The category of the system based on discovery.
string |
---|
Discovered |
Managed |
NotReachable |
HpeWfmTaskExt
This is the schema definition for HpeWfmTaskExt.
CreatedBy | string read-only |
The name of the user that created this task. |
Description | read-write |
|
DetailedTaskLink { | object | Detailed status of the task. |
@odata.id | read-write |
|
} | ||
History | string read-only |
The history of the task. |
Id | read-write |
|
Name | read-write |
|
ProgressMessages [ ] | array (string) read-only |
This is an array of messages associated with the task. |
ProgressPercent | integer read-only |
The progress percent of this task. |
SelectedAddress [ ] | array (string) read-only |
This is an array of IP addresses associated with the task. |
SelectedGroups [ { | array | This is the list of the groups associated with the task, if any. |
allSystemsInGroup | boolean read-only |
The flag suggests whether all the servers in the group are selected. |
GroupName | string read-only |
The Group name of the selected group. |
SelectedAddress [ ] | array (string) read-only |
This is an array of IP addresses selected within the group. |
} ] | ||
SubTaskCount | integer read-only |
Number of subtasks for this task. |
TaskIdentifier | integer read-only |
A unique task identifier number for this task. |
HpeWfmTaskServiceExt
This is the schema definition for HpeWfmTaskServiceExt.
Description | read-write |
|
Id | read-write |
|
Name | read-write |
Actions
DeleteCompletedTasks
Delete all the completed Tasks.
URIs:
(This action takes no parameters.)
HpeWfmUpdateJobResults
This is the schema definition for HpeWfmUpdateJobResults.
Description | read-write |
|
Id | read-write |
|
InstallSetInfo { | object | The Install Set Details. |
InstallSetComponents [ { | array | |
BaselineName | string read-write |
The Baseline name with which the server is updated. |
ComponentInfo [ { | array | |
ActiveVersion | string read-write |
The component active version. |
AvailableVersion | string read-write |
The component version available for update. |
ComponentDescription | string read-write |
The component description of the install component. |
ComponentName | string read-write |
The component name of the install component. |
ComponentType | string read-write |
The component type(Firmware/Driver etc.) |
CurrentVersion | string read-write |
The component current version. |
DependencyFailed | boolean read-write |
The component install dependency failed flag. |
DeploymentResult | string read-write |
The result after the deployment. |
InstalledVersion | string read-write |
The final installed version. |
IsForcedFlag | boolean read-write |
The component isForced flag. |
IsSelectedFlag | boolean read-write |
The component isSelected flag. |
PreviousInstalledVersion | string read-write |
The previous installed version. |
ProductFamilyName | string read-write |
The component product family name. |
StagingResult | string read-write |
The result after the staging. |
StatusMessage | string read-write |
The component install status message. |
VersionInBaseline | string read-write |
The previous installed version. |
} ] | ||
HostOSType | string read-write |
The Host OS Type of the Managed Server. |
ManagerAddress | string read-write |
The IP address Managed Server. |
TotalErrors | integer read-write |
Gives the total errors/failed dependencies during the calculate Install set for the Managed Node |
} ] | ||
} | ||
Name | read-write |
HpeWfmUpdateService
This is the schema definition for HpeWfmUpdateService.
AddOnServiceStatusInfo { | object | Status of add-on service installation and uninstallation action |
ProgressPercent | integer read-only |
The progress percentage of add-on service installation/uninstallation action. |
State | string read-only |
The state of add-on service installation/ uninstallation action. |
} | ||
AddOnServicesUpdatesAvailable | boolean read-only |
Indicates if add-on services updates are available. |
AddOnServicesUpdatesDismissed | boolean read-write |
Indicates if add-on services updates have been disabled by the user. |
AutoUpdateFeatureEnabled | boolean read-write |
Indicates if Automatic Self Update of iLO Amplifier Pack Feature is enabled by the user. |
AutoUpdatePackageInfo { | object | The Automatic Self Update Firmware Package Details. |
BuildNumber | integer read-only |
The build number of the firmware. |
Filename | string read-only |
The Filename of the new firmware. |
MinimumVersionString | string read-only (null) |
The minimum version string of the firmware required to perform the self update. |
ReadmeLocation { | object | The Automatic Self Update Firmware Package Readme file link location. |
extref | string read-only |
The file path of the ReadMe file. |
} | ||
Recommendation | string read-only |
The update recommendation of the new firmware. |
ReleaseDate | string read-only |
The build date of the new firmware. |
VersionString | string read-only (null) |
The version string of the firmware. This value might be null if VersionString is unavailable. |
} | ||
AutoUpdateStatus | string (enum) read-only |
This property shows the current status of the automatic self update. For the possible property values, see AutoUpdateStatus in Property Details. |
AutoUpdateStatusErrorDetails | string read-only (null) |
Detailed string describing the auto self update status. |
Description | read-write |
|
Id | read-write |
|
MidwayConnectionStatus | string (enum) read-only |
This property shows the current status of the connection to HPE Midway from this device. For the possible property values, see MidwayConnectionStatus in Property Details. |
MidwayConnectionStatusErrorDetails | string read-only (null) |
Detailed error string in case of connection failure. |
Name | read-write |
|
ProgressPercent | integer read-only |
The progress percentage of firmware update. |
SelfUpdateMethod | string (enum) read-write |
Specifies the Automatic Self Update Method For the possible property values, see SelfUpdateMethod in Property Details. |
State | string (enum) read-only |
The State of firmware update. For the possible property values, see State in Property Details. |
Actions
AddOnServiceInstallation
URIs:
(This action takes no parameters.)
AddOnServiceUnInstallation
The uninstall action to uninstall the specified add-on service.
URIs:
(This action takes no parameters.)
CheckForUpdates
URIs:
(This action takes no parameters.)
ManagerUpdate
URIs:
(This action takes no parameters.)
Property Details
AutoUpdateStatus:
This property shows the current status of the automatic self update.
string | Description |
---|---|
Already Up-to-date | iLO Amplifier Pack is already updated to the latest version. |
Automatic Update Completed | Automatic update of iLO Amplifier Pack Completed. |
Automatic Update In Progress | Automatic update of iLO Amplifier Pack In Progress. |
Automatic Update Initiated | Automatic update of iLO Amplifier Pack Initiated. |
New Update Available | New version of iLO Amplifier Pack is available for update. |
Not Available | Update Status information not available. |
MidwayConnectionStatus:
This property shows the current status of the connection to HPE Midway from this device.
string | Description |
---|---|
Connected | Connection to HPE Midway was successful . |
Connecting | Connection to HPE Midway is being attempted. |
ConnectionFailed | Connection to HPE Midway failed. |
NotInitiated | Connection to HPE Midway was not initiated. |
SelfUpdateMethod:
Specifies the Automatic Self Update Method
string |
---|
CheckForUpdatesOnly |
FullAutomaticUpdate |
State:
The State of firmware update.
string |
---|
Idle |
In Progress |
Completed |
Error |
Job 1.0.1
v1.0 |
2018.2 |
This resource contains information about a specific Job scheduled or being executed by a Redfish service's Job Service.
URIs:
/redfish/v1/JobService/Jobs/{JobId} /redfish/v1/JobService/Jobs/{JobId}/Steps/{JobId2}
CreatedBy | string read-only |
The person or program that created this job entry. |
Description | string read-only (null) |
Provides a description of this resource and is used for commonality in the schema definitions. |
EndTime | string read-only (null) |
The date-time stamp that the job was completed. |
HidePayload | boolean read-only |
Indicates that the contents of the Payload should be hidden from view after the Job has been created. When set to True, the Payload object will not be returned on GET. |
Id | string read-only required |
Uniquely identifies the resource within the collection of like resources. |
JobState | string (enum) read-write |
The state of the job. For the possible property values, see JobState in Property Details. |
JobStatus | string (enum) read-only |
The status of the job. For the possible property values, see JobStatus in Property Details. |
MaxExecutionTime | string read-write (null) |
The maximum amount of time the job is allowed to execute. |
Messages [ { } ] | array (object) | This is an array of messages associated with the job. This type describes a Message returned by the Redfish service. See the Message schema for details on this property. |
Name | string read-only required |
The name of the resource or array element. |
Oem {} | object | This is the manufacturer/provider specific extension moniker used to divide the Oem object into sections. See the Resource schema for details on this property. |
Payload { | object | The HTTP and JSON payload details for this job. |
HttpHeaders [ ] | array (string) read-only |
This represents the HTTP headers used in the operation of this job. |
HttpOperation | string read-only |
The HTTP operation to perform to execute this job. |
JsonBody | string read-only |
This property contains the JSON payload to use in the execution of this Job. |
TargetUri | string read-only |
The URI of the target for this job. |
} | ||
PercentComplete | integer (%) read-only (null) |
The completion percentage of this job. |
Schedule {} | object | The Schedule Settings for this Job. See the Schedule schema for details on this property. |
StartTime | string read-only |
The date-time stamp that the job was started or is scheduled to start. |
StepOrder [ ] | array (string) read-only |
This represents the serialized execution order of the Job Steps. |
Steps { | object | A link to a collection of Steps for this Job. Contains a link to a resource. |
@odata.id | string read-only |
Link to Collection of Job. See the Job schema for details. |
} |
Property Details
JobState:
The state of the job.
string | Description |
---|---|
Cancelled | Job was cancelled.. |
Completed | Job has completed. |
Continue | Job is to resume operation. |
Exception | Job has stopped due to an exception condition. |
Interrupted | Job has been interrupted. |
New | A new job. |
Pending | Job is pending and has not started. |
Running | Job is running normally. |
Service | Job is running as a service. |
Starting | Job is starting. |
Stopping | Job is in the process of stopping. |
Suspended | Job has been suspended. |
UserIntervention | Job is waiting for user intervention. |
JobStatus:
The status of the job.
string | Description |
---|---|
Critical | A critical condition exists that requires immediate attention. |
OK | Normal. |
Warning | A condition exists that requires attention. |
JobService 1.0.0
This is the schema definition for the Job Service. It represents the properties for the service itself and has links to the actual list of tasks.
URIs:
/redfish/v1/JobService
DateTime | string read-only (null) |
The current DateTime (with offset) setting that the job service is using. |
Description | string read-only (null) |
Provides a description of this resource and is used for commonality in the schema definitions. |
Id | string read-only required |
Uniquely identifies the resource within the collection of like resources. |
Jobs { | object | References to the Jobs collection. Contains a link to a resource. |
@odata.id | string read-only |
Link to Collection of Job. See the Job schema for details. |
} | ||
Log { | object | This is a reference to a Log Service used by the Job Service. See the LogService schema for details on this property. |
@odata.id | string read-only |
Link to a LogService resource. See the Links section and the LogService schema for details. |
} | ||
Name | string read-only required |
The name of the resource or array element. |
Oem {} | object | This is the manufacturer/provider specific extension moniker used to divide the Oem object into sections. See the Resource schema for details on this property. |
ServiceCapabilities { | object | This object describes the supported capabilities of this Job Service implementation. |
MaxJobs | integer read-only (null) |
Maximum number of Jobs supported. |
MaxSteps | integer read-only (null) |
Maximum number of Job Steps supported. |
Scheduling | boolean read-only (null) |
Indicates whether scheduling of Jobs is supported. |
} | ||
ServiceEnabled | boolean read-write (null) |
This indicates whether this service is enabled. |
Status {} | object | This property describes the status and health of the resource and its children. See the Resource schema for details on this property. |
JsonSchemaFile 1.1.0
This is the schema definition for the Schema File locator resource.
Description | string read-only (null) |
Provides a description of this resource and is used for commonality in the schema definitions. |
Id | string read-only required |
Uniquely identifies the resource within the collection of like resources. |
Languages [ ] | array (string) read-only required |
Language codes for the schemas available. |
Location [ { | array * required* |
Location information for this schema file. |
ArchiveFile | string read-only |
If the schema is hosted on the service in an archive file, this is the name of the file within the archive. |
ArchiveUri | string read-only |
If the schema is hosted on the service in an archive file, this is the link to the archive file. |
Language | string read-only |
The language code for the file the schema is in. |
PublicationUri | string read-only |
Link to publicly available (canonical) URI for schema. |
Uri | string read-only |
Link to locally available URI for schema. |
} ] | ||
Name | string read-only required |
The name of the resource or array element. |
Oem {} | object | This is the manufacturer/provider specific extension moniker used to divide the Oem object into sections. See the Resource schema for details on this property. |
Schema | string read-only required |
The @odata.type name this schema describes. |
LogEntry 1.3.0
This resource defines the record format for a log. It is designed to be used for SEL logs (from IPMI) as well as Event Logs and OEM-specific log formats. The EntryType field indicates the type of log and the resource includes several additional properties dependent on the EntryType.
Created | string read-only |
The time the log entry was created. |
Description | string read-only (null) |
Provides a description of this resource and is used for commonality in the schema definitions. |
EntryCode | string (enum) read-only (null) |
If the EntryType is SEL, this will have the entry code for the log entry. For the possible property values, see EntryCode in Property Details. |
EntryType | string (enum) read-only required |
his is the type of log entry. For the possible property values, see EntryType in Property Details. |
EventId | string read-only |
This is a unique instance identifier of an event. |
EventTimestamp | string read-only |
This is time the event occurred. |
EventType | string (enum) read-only |
This indicates the type of an event recorded in this log. For the possible property values, see EventType in Property Details. |
Id | string read-only required |
Uniquely identifies the resource within the collection of like resources. |
Links { | object | Contains references to other resources that are related to this resource. |
Oem {} | object | Oem extension object. See the Resource schema for details on this property. |
OriginOfCondition { | object | This is the URI of the resource that caused the log entry. |
@odata.id | string read-only |
The unique identifier for a resource. |
} | ||
} | ||
Message | string read-only (null) |
This property decodes from EntryType: If it is Event then it is a message string. Otherwise, it is SEL or Oem specific. In most cases, this will be the actual Log Entry. |
MessageArgs [ ] | array (string) read-only |
The values of this property shall be any arguments for the message. |
MessageId | string read-only |
This property decodes from EntryType: If it is Event then it is a message id. Otherwise, it is SEL or Oem specific. This value is only used for registries - for more information, see the specification. |
Name | string read-only required |
The name of the resource or array element. |
Oem {} | object | This is the manufacturer/provider specific extension moniker used to divide the Oem object into sections. See the Resource schema for details on this property. |
OemLogEntryCode | string read-only (null) |
If the LogEntryCode type is OEM, this will contain the OEM-specific entry code. |
OemRecordFormat | string read-only (null) |
If the entry type is Oem, this will contain more information about the record format from the Oem. |
OemSensorType | string read-only (null) |
If the Sensor Type is OEM, this will contain the OEM-specific sensor type. |
SensorNumber | number read-only (null) |
This property decodes from EntryType: If it is SEL, it is the sensor number; if Event then the count of events. Otherwise, it is Oem specific. |
SensorType | string (enum) read-only (null) |
If the EntryType is SEL, this will have the sensor type that the log entry pertains to. For the possible property values, see SensorType in Property Details. |
Severity | string (enum) read-only (null) |
This is the severity of the log entry. For the possible property values, see Severity in Property Details. |
Property Details
EntryCode:
If the EntryType is SEL, this will have the entry code for the log entry.
string | Description |
---|---|
Assert | The condition has been asserted. |
D0 Power State | The ACPI defined D0 Power State. |
D1 Power State | The ACPI defined D1 Power State. |
D2 Power State | The ACPI defined D2 Power State. |
D3 Power State | The ACPI defined D3 Power State. |
Deassert | The condition has been deasserted. |
Device Disabled | A device has been disabled. |
Device Enabled | A device has been enabled. |
Device Inserted / Device Present | A device has been inserted or is now present. |
Device Removed / Device Absent | A device has been removed or is now absent. |
Fully Redundant | Indicates that full redundancy has been regained. |
Informational | An Informational event. |
Install Error | An Install Error has been detected. |
Limit Exceeded | A limit has been exceeded. |
Limit Not Exceeded | A limit has not been exceeded. |
Lower Critical - going high | The reading crossed the Lower Critical threshold while going high. |
Lower Critical - going low | The reading crossed the Lower Critical threshold while going low. |
Lower Non-critical - going high | The reading crossed the Lower Non-critical threshold while going high. |
Lower Non-critical - going low | The reading crossed the Lower Non-critical threshold while going low. |
Lower Non-recoverable - going high | The reading crossed the Lower Non-recoverable threshold while going high. |
Lower Non-recoverable - going low | The reading crossed the Lower Non-recoverable threshold while going low. |
Monitor | A Monitor event. |
Non-redundant:Insufficient Resources | Unit is non-redundant and has insufficient resource to maintain normal operation. |
Non-redundant:Sufficient Resources from Insufficient Resources | Unit has regianed minimum resources needed for normal operation. |
Non-redundant:Sufficient Resources from Redundant | Redundancy has been lost but unit is functioning with minimum resources needed for normal operation. |
OEM | An OEM defined event. |
Performance Lags | Performance does not meet expectations. |
Performance Met | Performance meets expectations. |
Predictive Failure asserted | A Predictive Failure has been detected. |
Predictive Failure deasserted | A Predictive Failure is no longer present. |
Redundancy Degraded | Redundancy still exists, but at less than full level. |
Redundancy Degraded from Fully Redundant | Unit has lost some redundant resource(s) but is still in a redundant state. |
Redundancy Degraded from Non-redundant | Unit has regained some resource(s) and is redundant but not fully redundant. |
Redundancy Lost | Entered any non-redundant state, including Non-redundant: Insufficient Resources. |
State Asserted | The state has been asserted. |
State Deasserted | The state has been deasserted. |
Transition to Active | The state transitioned to active. |
Transition to Busy | The state transitioned to busy. |
Transition to Critical from less severe | A state has changed to Critical from less severe. |
Transition to Critical from Non-recoverable | A state has changed to Critical from Non-recoverable. |
Transition to Degraded | A state has transitioned to Degraded. |
Transition to Idle | The state transitioned to idle. |
Transition to In Test | A state has transitioned to In Test. |
Transition to Non-Critical from more severe | A state has changed to Non-Critical from more severe. |
Transition to Non-Critical from OK | A state has changed to Non-Critical from OK. |
Transition to Non-recoverable | A state has changed to Non-recoverable. |
Transition to Non-recoverable from less severe | A state has changed to Non-recoverable from less severe. |
Transition to Off Duty | A state has transitioned to Off Duty. |
Transition to Off Line | A state has transitioned to Off Line. |
Transition to OK | A state has changed to OK. |
Transition to On Line | A state has transitioned to On Line. |
Transition to Power Off | A state has transitioned to Power Off. |
Transition to Power Save | A state has transitioned to Power Save. |
Transition to Running | A state has transitioned to Running. |
Upper Critical - going high | The reading crossed the Upper Critical threshold while going high. |
Upper Critical - going low | The reading crossed the Upper Critical threshold while going low. |
Upper Non-critical - going high | The reading crossed the Upper Non-critical threshold while going high. |
Upper Non-critical - going low | The reading crossed the Upper Non-critical threshold while going low. |
Upper Non-recoverable - going high | The reading crossed the Upper Non-recoverable threshold while going high. |
Upper Non-recoverable - going low | The reading crossed the Upper Non-recoverable threshold while going low. |
EntryType:
his is the type of log entry.
string | Description |
---|---|
Event | Contains a Redfish-defined message (event). |
Oem | Contains an entry in an OEM-defined format. |
SEL | Contains a legacy IPMI System Event Log (SEL) entry. |
EventType:
This indicates the type of an event recorded in this log.
string | Description |
---|---|
Alert | A condition exists which requires attention. |
ResourceAdded | A resource has been added. |
ResourceRemoved | A resource has been removed. |
ResourceUpdated | The value of this resource has been updated. |
StatusChange | The status of this resource has changed. |
SensorType:
If the EntryType is SEL, this will have the sensor type that the log entry pertains to.
string | Description |
---|---|
Add-in Card | A sensor for an add-in card. |
BaseOSBoot/InstallationStatus | A sensor for a base OS boot or installation status event. |
Battery | A sensor for a battery. |
Boot Error | A sensor for a boot error event. |
Button/Switch | A sensor for a button or switch. |
Cable/Interconnect | A sensor for a cable or interconnect type of device. |
Chassis | A sensor for a chassis. |
ChipSet | A sensor for a chipset. |
CoolingDevice | A sensor for a cooling device. |
Critical Interrupt | A sensor for a critical interrupt event. |
Current | A current sensor. |
Drive Slot/Bay | A sensor for a drive slot or bay. |
Entity Presence | A sensor for an entity presence event. |
Event Logging Disabled | A sensor for the event log. |
Fan | A fan sensor. |
FRUState | A sensor for a FRU state event. |
LAN | A sensor for a LAN device. |
Management Subsystem Health | A sensor for a management subsystem health event. |
Memory | A sensor for a memory device. |
Microcontroller/Coprocessor | A sensor for a microcontroller or coprocessor. |
Module/Board | A sensor for a module or board. |
Monitor ASIC/IC | A sensor for a monitor ASIC or IC. |
OEM | An OEM defined sensor. |
OS Stop/Shutdown | A sensor for an OS stop or shutdown event |
Other FRU | A sensor for an other type of FRU. |
Other Units-based Sensor | A sensor for a miscellaneous analog sensor. |
Physical Chassis Security | A physical security sensor. |
Platform Alert | A sensor for a platform alert event. |
Platform Security Violation Attempt | A platform security sensor. |
POST Memory Resize | A sensor for a POST memory resize event. |
Power Supply / Converter | A sensor for a power supply or DC-to-DC converter. |
PowerUnit | A sensor for a power unit. |
Processor | A sensor for a processor. |
Session Audit | A sensor for a session audit event. |
Slot/Connector | A sensor for a slot or connector. |
System ACPI PowerState | A sensor for an ACPI power state event. |
System Event | A sensor for a system event. |
System Firmware Progress | A sensor for a system firmware progress event. |
SystemBoot/Restart | A sensor for a system boot or restart event. |
Temperature | A temperature sensor. |
Terminator | A sensor for a terminator. |
Version Change | A sensor for a version change event. |
Voltage | A voltage sensor. |
Watchdog | A sensor for a watchdog event. |
Severity:
This is the severity of the log entry.
string | Description |
---|---|
Critical | A critical condition requiring immediate attention. |
OK | Informational or operating normally. |
Warning | A condition requiring attention. |
LogService 1.1.0
This resource represents the log service for the resource or service to which it is associated.
DateTime | string read-write (null) |
The current DateTime (with offset) for the log service, used to set or read time. |
DateTimeLocalOffset | string read-write (null) |
The time offset from UTC that the DateTime property is set to in format: +06:00 . |
Description | string read-only (null) |
Provides a description of this resource and is used for commonality in the schema definitions. |
Entries { | object | References to the log entry collection. Contains a link to a resource. |
@odata.id | string read-only |
Link to Collection of LogEntry. See the LogEntry schema for details. |
} | ||
Id | string read-only required |
Uniquely identifies the resource within the collection of like resources. |
LogEntryType | string (enum) read-only (null) |
The format of the Entries of this log. For the possible property values, see LogEntryType in Property Details. |
MaxNumberOfRecords | number read-only |
The maximum number of log entries this service can have. |
Name | string read-only required |
The name of the resource or array element. |
Oem {} | object | This is the manufacturer/provider specific extension moniker used to divide the Oem object into sections. See the Resource schema for details on this property. |
OverWritePolicy | string (enum) read-only |
The overwrite policy for this service that takes place when the log is full. For the possible property values, see OverWritePolicy in Property Details. |
ServiceEnabled | boolean read-write (null) |
This indicates whether this service is enabled. |
Status {} | object (null) |
This type describes the status and health of a resource and its children. See the Resource schema for details on this property. |
Actions
ClearLog
This action is used to clear the log for this Log Service.
URIs:
(This action takes no parameters.)
Property Details
LogEntryType:
The format of the Entries of this log.
string | Description |
---|---|
Event | The log contains Redfish-defined messages (events). |
Multiple | The log contains multiple Log Entry types or a single entry type cannot be guaranteed by the Log Service. |
OEM | The log contains entries in an OEM-defined format. |
SEL | The log contains legacy IPMI System Event Log (SEL) entries. |
OverWritePolicy:
The overwrite policy for this service that takes place when the log is full.
string | Description |
---|---|
NeverOverWrites | When full, new entries to the Log will be discarded. |
Unknown | The overwrite policy is not known or is undefined. |
WrapsWhenFull | When full, new entries to the Log will overwrite previous entries. |
Manager 1.4.0
This is the schema definition for a Manager. Examples of managers are BMCs, Enclosure Managers, Management Controllers and other subsystems assigned managability functions.
AutoDSTEnabled | boolean read-write |
Indicates whether the manager is configured for automatic DST adjustment. |
CommandShell { | object | Information about the Command Shell service provided by this manager. |
ConnectTypesSupported [ ] | array (string (enum)) read-only |
This object is used to enumerate the Command Shell connection types allowed by the implementation. For the possible property values, see ConnectTypesSupported in Property Details. |
MaxConcurrentSessions | number read-only |
Indicates the maximum number of service sessions, regardless of protocol, this manager is able to support. |
ServiceEnabled | boolean read-write |
Indicates if the service is enabled for this manager. |
} | ||
DateTime | string read-write (null) |
The current DateTime (with offset) for the manager, used to set or read time. |
DateTimeLocalOffset | string read-write (null) |
The time offset from UTC that the DateTime property is set to in format: +06:00 . |
Description | string read-only (null) |
Provides a description of this resource and is used for commonality in the schema definitions. |
EthernetInterfaces { | object | This is a reference to a collection of NICs that this manager uses for network communication. It is here that clients will find NIC configuration options and settings. Contains a link to a resource. |
@odata.id | string read-only |
Link to Collection of EthernetInterface. See the EthernetInterface schema for details. |
} | ||
FirmwareVersion | string read-only (null) |
The firmware version of this Manager. |
GraphicalConsole { | object | The value of this property shall contain the information about the Graphical Console (KVM-IP) service of this manager. |
ConnectTypesSupported [ ] | array (string (enum)) read-only |
This object is used to enumerate the Graphical Console connection types allowed by the implementation. For the possible property values, see ConnectTypesSupported in Property Details. |
MaxConcurrentSessions | number read-only |
Indicates the maximum number of service sessions, regardless of protocol, this manager is able to support. |
ServiceEnabled | boolean read-write |
Indicates if the service is enabled for this manager. |
} | ||
HostInterfaces { | object | This is a reference to a collection of Host Interfaces that this manager uses for local host communication. It is here that clients will find Host Interface configuration options and settings. Contains a link to a resource. |
@odata.id | string read-only |
Link to Collection of HostInterface. See the HostInterface schema for details. |
} | ||
Id | string read-only required |
Uniquely identifies the resource within the collection of like resources. |
Links { | object | Contains references to other resources that are related to this resource. |
ManagerForChassis [ { | array | This property is an array of references to the chassis that this manager has control over. |
@odata.id | string read-only |
Link to a Chassis resource. See the Links section and the Chassis schema for details. |
} ] | ||
ManagerForServers [ { | array | This property is an array of references to the systems that this manager has control over. |
@odata.id | string read-only |
Link to a ComputerSystem resource. See the Links section and the ComputerSystem schema for details. |
} ] | ||
ManagerForSwitches [ { } ] | array (object) | This property is an array of references to the switches that this manager has control over. Switch contains properties describing a simple fabric switch. See the Switch schema for details on this property. |
ManagerInChassis { | object | This property is a reference to the chassis that this manager is located in. See the Chassis schema for details on this property. |
@odata.id | string read-only |
Link to a Chassis resource. See the Links section and the Chassis schema for details. |
} | ||
Oem {} | object | Oem extension object. See the Resource schema for details on this property. |
} | ||
LogServices { | object | This is a reference to a collection of Logs used by the manager. Contains a link to a resource. |
@odata.id | string read-only |
Link to Collection of LogService. See the LogService schema for details. |
} | ||
ManagerType | string (enum) read-only |
This property represents the type of manager that this resource represents. For the possible property values, see ManagerType in Property Details. |
Model | string read-only (null) |
The model information of this Manager as defined by the manufacturer. |
Name | string read-only required |
The name of the resource or array element. |
NetworkProtocol { | object | This is a reference to the network services and their settings that the manager controls. It is here that clients will find network configuration options as well as network services. See the ManagerNetworkProtocol schema for details on this property. |
@odata.id | string read-only |
Link to a ManagerNetworkProtocol resource. See the Links section and the ManagerNetworkProtocol schema for details. |
} | ||
Oem {} | object | This is the manufacturer/provider specific extension moniker used to divide the Oem object into sections. See the Resource schema for details on this property. |
PowerState | string (enum) read-only (null) |
This is the current power state of the Manager. For the possible property values, see PowerState in Property Details. |
Redundancy [ { | array | Redundancy information for the managers of this system. |
@odata.id | string read-only |
The unique identifier for a resource. |
} ] | ||
SerialConsole { | object | Information about the Serial Console service provided by this manager. |
ConnectTypesSupported [ ] | array (string (enum)) read-only |
This object is used to enumerate the Serial Console connection types allowed by the implementation. For the possible property values, see ConnectTypesSupported in Property Details. |
MaxConcurrentSessions | number read-only |
Indicates the maximum number of service sessions, regardless of protocol, this manager is able to support. |
ServiceEnabled | boolean read-write |
Indicates if the service is enabled for this manager. |
} | ||
SerialInterfaces { | object | This is a reference to a collection of serial interfaces that this manager uses for serial and console communication. It is here that clients will find serial configuration options and settings. Contains a link to a resource. |
@odata.id | string read-only |
Link to Collection of SerialInterface. See the SerialInterface schema for details. |
} | ||
ServiceEntryPointUUID | string read-only (null) |
The UUID of the Redfish Service provided by this manager. |
Status {} | object | This type describes the status and health of a resource and its children. See the Resource schema for details on this property. |
UUID | string read-only (null) |
The Universal Unique Identifier (UUID) for this Manager. |
VirtualMedia { | object | This is a reference to the Virtual Media services for this particular manager. Contains a link to a resource. |
@odata.id | string read-only |
Link to Collection of VirtualMedia. See the VirtualMedia schema for details. |
} |
Actions
ForceFailover
The ForceFailover action forces a failover of this manager to the manager used in the parameter.
URIs:
The following table shows the parameters for the action which are included in the POST body to the URI shown in the "target" property of the Action.
{ | ||
NewManager { | object | This parameter specifies the Manager in which to fail over. In this case, a valid reference is supported. |
@odata.id | string read-only |
Link to another Manager resource. |
} | ||
} |
ModifyRedundancySet
The ModifyRedundancySet operation is used to add or remove members to a redundant group of manager.
URIs:
The following table shows the parameters for the action which are included in the POST body to the URI shown in the "target" property of the Action.
{ | ||
Add [ { | array | This array defines the Managers to add to the redundancy set. In this case, a valid reference is supported. |
@odata.id | string read-only |
Link to another Manager resource. |
} ] | ||
Remove [ { | array | This array defines the Managers to remove from the redundancy set. In this case, a valid reference is supported. |
@odata.id | string read-only |
Link to another Manager resource. |
} ] | ||
} |
Reset
The reset action resets/reboots the manager.
URIs:
The following table shows the parameters for the action which are included in the POST body to the URI shown in the "target" property of the Action.
{ | ||
ResetType | string (enum) read-write |
This is the type of reset to be performed. For the possible property values, see ResetType in Property Details. |
} |
Property Details
ConnectTypesSupported:
This object is used to enumerate the Serial Console connection types allowed by the implementation.
string | Description |
---|---|
IPMI | The controller supports a Serial Console connection using the IPMI Serial-over-LAN (SOL) protocol. |
Oem | The controller supports a Serial Console connection using an OEM-specific protocol. |
SSH | The controller supports a Serial Console connection using the SSH protocol. |
Telnet | The controller supports a Serial Console connection using the Telnet protocol. |
ManagerType:
This property represents the type of manager that this resource represents.
string | Description |
---|---|
AuxiliaryController | A controller which provides management functions for a particular subsystem or group of devices. |
BMC | A controller which provides management functions for a single computer system. |
EnclosureManager | A controller which provides management functions for a chassis or group of devices or systems. |
ManagementController | A controller used primarily to monitor or manage the operation of a device or system. |
RackManager | A controller which provides management functions for a whole or part of a rack. |
Service | A software-based service which provides management functions. |
PowerState:
This is the current power state of the Manager.
string | Description |
---|---|
Off | The state is powered Off. |
On | The state is powered On. |
PoweringOff | A temporary state between On and Off. |
PoweringOn | A temporary state between Off and On. |
ResetType:
This is the type of reset to be performed.
string | Description |
---|---|
ForceOff | Turn the unit off immediately (non-graceful shutdown). |
ForceOn | Turn the unit on immediately. |
ForceRestart | Perform an immediate (non-graceful) shutdown, followed by a restart. |
GracefulRestart | Perform a graceful shutdown followed by a restart of the system. |
GracefulShutdown | Perform a graceful shutdown and power off. |
Nmi | Generate a Diagnostic Interrupt (usually an NMI on x86 systems) to cease normal operations, perform diagnostic actions and typically halt the system. |
On | Turn the unit on. |
PowerCycle | Perform a power cycle of the unit. |
PushPowerButton | Simulate the pressing of the physical power button on this unit. |
ManagerAccount 1.1.2
The user accounts, owned by a Manager, are defined in this resource. Changes to a Manager Account may affect the current Redfish service connection if this manager is responsible for the Redfish service.
Description | string read-only (null) |
Provides a description of this resource and is used for commonality in the schema definitions. |
Enabled | boolean read-write |
This property is used by a User Administrator to disable an account w/o having to delet the user information. When set to true, the user can login. When set to false, the account is administratively disabled and the user cannot login. |
Id | string read-only required |
Uniquely identifies the resource within the collection of like resources. |
Links { | object | Contains references to other resources that are related to this resource. |
Oem {} | object | Oem extension object. See the Resource schema for details on this property. |
Role { | object | A reference to the Role object defining Privileges for this account--returned when the resource is read. The ID of the role is the same as property RoleId. See the Role schema for details on this property. |
@odata.id | string read-only |
Link to a Role resource. See the Links section and the Role schema for details. |
} | ||
} | ||
Locked | boolean read-write |
This property indicates that the account has been auto-locked by the account service because the lockout threshold has been exceeded. When set to true, the account is locked. A user admin can write the property to false to manually unlock, or the account service will unlock it once the lockout duration period has passed. |
Name | string read-only required |
The name of the resource or array element. |
Oem {} | object | This is the manufacturer/provider specific extension moniker used to divide the Oem object into sections. See the Resource schema for details on this property. |
Password | string read-write required on create (null) |
This property is used with a PATCH or PUT to write the password for the account. This property is null on a GET. |
RoleId | string read-write required on create |
This property contains the Role for this account. |
UserName | string read-write required on create |
This property contains the user name for the account. |
ManagerNetworkProtocol 1.2.0
This resource is used to obtain or modify the network services managed by a given manager.
Description | string read-only (null) |
Provides a description of this resource and is used for commonality in the schema definitions. |
DHCP { | object | Settings for this Manager's DHCP protocol support. |
Port | number read-write (null) |
Indicates the protocol port. |
ProtocolEnabled | boolean read-write (null) |
Indicates if the protocol is enabled or disabled. |
} | ||
FQDN | string read-only (null) |
This is the fully qualified domain name for the manager obtained by DNS including the host name and top-level domain name. |
HostName | string read-only (null) |
The DNS Host Name of this manager, without any domain information. |
HTTP { | object | Settings for this Manager's HTTP protocol support. |
Port | number read-write (null) |
Indicates the protocol port. |
ProtocolEnabled | boolean read-write (null) |
Indicates if the protocol is enabled or disabled. |
} | ||
HTTPS { | object | Settings for this Manager's HTTPS protocol support. |
Port | number read-write (null) |
Indicates the protocol port. |
ProtocolEnabled | boolean read-write (null) |
Indicates if the protocol is enabled or disabled. |
} | ||
Id | string read-only required |
Uniquely identifies the resource within the collection of like resources. |
IPMI { | object | Settings for this Manager's IPMI-over-LAN protocol support. |
Port | number read-write (null) |
Indicates the protocol port. |
ProtocolEnabled | boolean read-write (null) |
Indicates if the protocol is enabled or disabled. |
} | ||
KVMIP { | object | Settings for this Manager's KVM-IP protocol support. |
Port | number read-write (null) |
Indicates the protocol port. |
ProtocolEnabled | boolean read-write (null) |
Indicates if the protocol is enabled or disabled. |
} | ||
Name | string read-only required |
The name of the resource or array element. |
NTP { | object | Settings for this Manager's NTP protocol support. |
NTPServers [ ] | array (string, null) read-write |
Indicates to which NTP servers this manager is subscribed. |
Port | number read-write (null) |
Indicates the protocol port. |
ProtocolEnabled | boolean read-write (null) |
Indicates if the protocol is enabled or disabled. |
} | ||
Oem {} | object | This is the manufacturer/provider specific extension moniker used to divide the Oem object into sections. See the Resource schema for details on this property. |
SNMP { | object | Settings for this Manager's SNMP support. |
Port | number read-write (null) |
Indicates the protocol port. |
ProtocolEnabled | boolean read-write (null) |
Indicates if the protocol is enabled or disabled. |
} | ||
SSDP { | object | Settings for this Manager's SSDP support. |
NotifyIPv6Scope | string (enum) read-write (null) |
Indicates the scope for the IPv6 Notify messages for SSDP. For the possible property values, see NotifyIPv6Scope in Property Details. |
NotifyMulticastIntervalSeconds | number (seconds) read-write (null) |
Indicates how often the Multicast is done from this service for SSDP. |
NotifyTTL | number read-write (null) |
Indicates the time to live hop count for SSDPs Notify messages. |
Port | number read-write (null) |
Indicates the protocol port. |
ProtocolEnabled | boolean read-write (null) |
Indicates if the protocol is enabled or disabled. |
} | ||
SSH { | object | Settings for this Manager's SSH (Secure Shell) protocol support. |
Port | number read-write (null) |
Indicates the protocol port. |
ProtocolEnabled | boolean read-write (null) |
Indicates if the protocol is enabled or disabled. |
} | ||
Status {} | object | This type describes the status and health of a resource and its children. See the Resource schema for details on this property. |
Telnet { | object | Settings for this Manager's Telnet protocol support. |
Port | number read-write (null) |
Indicates the protocol port. |
ProtocolEnabled | boolean read-write (null) |
Indicates if the protocol is enabled or disabled. |
} | ||
VirtualMedia { | object | Settings for this Manager's Virtual Media support. |
Port | number read-write (null) |
Indicates the protocol port. |
ProtocolEnabled | boolean read-write (null) |
Indicates if the protocol is enabled or disabled. |
} |
Property Details
NotifyIPv6Scope:
Indicates the scope for the IPv6 Notify messages for SSDP.
string | Description |
---|---|
Link | SSDP Notify messages are sent to addresses in the IPv6 Local Link scope. |
Organization | SSDP Notify messages are sent to addresses in the IPv6 Local Organization scope. |
Site | SSDP Notify messages are sent to addresses in the IPv6 Local Site scope. |
Memory 1.5.0
This is the schema definition for definition of a Memory and its configuration.
AllocationAlignmentMiB | number read-only (null) |
The boundary which memory regions are allocated on, measured in mebibytes (MiB). |
AllocationIncrementMiB | number read-only (null) |
The size of the smallest unit of allocation for a memory region in mebibytes (MiB). |
AllowedSpeedsMHz [ ] | array (number) read-only |
Speed bins supported by this Memory. |
Assembly {} | object | A reference to the Assembly resource associated with this memory. See the Assembly schema for details on this property. |
BaseModuleType | string (enum) read-only (null) |
The base module type of Memory. For the possible property values, see BaseModuleType in Property Details. |
BusWidthBits | number read-only (null) |
Bus Width in bits. |
CacheSizeMiB | number (MiBy) read-only (null) |
Total size of the cache portion memory in MiB. |
CapacityMiB | number (MiBy) read-only (null) |
Memory Capacity in mebibytes (MiB). |
DataWidthBits | number read-only (null) |
Data Width in bits. |
Description | string read-only (null) |
Provides a description of this resource and is used for commonality in the schema definitions. |
DeviceID | string read-only (null) |
Device ID. |
DeviceLocator | string read-only (null) |
Location of the Memory in the platform. |
ErrorCorrection | string (enum) read-only (null) |
Error correction scheme supported for this memory. For the possible property values, see ErrorCorrection in Property Details. |
FirmwareApiVersion | string read-only (null) |
Version of API supported by the firmware. |
FirmwareRevision | string read-only (null) |
Revision of firmware on the Memory controller. |
FunctionClasses [ ] | array (string) read-only |
Function Classes by the Memory. |
Id | string read-only required |
Uniquely identifies the resource within the collection of like resources. |
IsRankSpareEnabled | boolean read-only (null) |
Rank spare enabled status. |
IsSpareDeviceEnabled | boolean read-only (null) |
Spare device enabled status. |
Links { | object | Contains references to other resources that are related to this resource. |
Chassis { | object | A reference to the Chassis which contains this Memory. See the Chassis schema for details on this property. |
@odata.id | string read-only |
Link to a Chassis resource. See the Links section and the Chassis schema for details. |
} | ||
Oem {} | object | Oem extension object. See the Resource schema for details on this property. |
} | ||
Location {} | object | This type describes the location of a resource. See the Resource schema for details on this property. |
LogicalSizeMiB | number (MiBy) read-only (null) |
Total size of the logical memory in MiB. |
Manufacturer | string read-only (null) |
The Memory manufacturer. |
MaxTDPMilliWatts [ ] | array (number) read-only |
Maximum TDPs in milli Watts. |
MemoryDeviceType | string (enum) read-only (null) |
Type details of the Memory. For the possible property values, see MemoryDeviceType in Property Details. |
MemoryLocation { | object | Memory connection information to sockets and memory controllers. |
Channel | number read-only (null) |
Channel number in which Memory is connected. |
MemoryController | number read-only (null) |
Memory controller number in which Memory is connected. |
Slot | number read-only (null) |
Slot number in which Memory is connected. |
Socket | number read-only (null) |
Socket number in which Memory is connected. |
} | ||
MemoryMedia [ ] | array (string (enum)) read-only |
Media of this Memory. For the possible property values, see MemoryMedia in Property Details. |
MemorySubsystemControllerManufacturerID | string read-only (null) |
The manufacturer ID of the memory subsystem controller of this memory module. |
MemorySubsystemControllerProductID | string read-only (null) |
The product ID of the memory subsystem controller of this memory module. |
MemoryType | string (enum) read-only (null) |
The type of Memory. For the possible property values, see MemoryType in Property Details. |
Metrics { | object | A reference to the Metrics associated with this Memory. See the MemoryMetrics schema for details on this property. |
@odata.id | string read-only |
Link to a MemoryMetrics resource. See the Links section and the MemoryMetrics schema for details. |
} | ||
ModuleManufacturerID | string read-only (null) |
The manufacturer ID of this memory module. |
ModuleProductID | string read-only (null) |
The product ID of this memory module. |
Name | string read-only required |
The name of the resource or array element. |
NonVolatileSizeMiB | number (MiBy) read-only (null) |
Total size of the non-volatile portion memory in MiB. |
Oem {} | object | This is the manufacturer/provider specific extension moniker used to divide the Oem object into sections. See the Resource schema for details on this property. |
OperatingMemoryModes [ ] | array (string (enum)) read-only |
Memory modes supported by the Memory. For the possible property values, see OperatingMemoryModes in Property Details. |
OperatingSpeedMhz | number read-only (null) |
Operating speed of Memory in MHz or MT/s as appropriate. |
PartNumber | string read-only (null) |
The product part number of this device. |
PersistentRegionNumberLimit | number read-only (null) |
Total number of persistent regions this Memory can support. |
PersistentRegionSizeLimitMiB | number read-only (null) |
Total size of persistent regions in mebibytes (MiB). |
PersistentRegionSizeMaxMiB | number read-only (null) |
Maximum size of a single persistent region in mebibytes (MiB). |
PowerManagementPolicy { | object | Power management policy information. |
AveragePowerBudgetMilliWatts | number (mW) read-only (null) |
Average power budget in milli watts. |
MaxTDPMilliWatts | number (mW) read-only (null) |
Maximum TDP in milli watts. |
PeakPowerBudgetMilliWatts | number (mW) read-only (null) |
Peak power budget in milli watts. |
PolicyEnabled | boolean read-only (null) |
Power management policy enabled status. |
} | ||
RankCount | number read-only (null) |
Number of ranks available in the Memory. |
Regions [ { | array | Memory regions information within the Memory. |
MemoryClassification | string (enum) read-only (null) |
Classification of memory occupied by the given memory region. For the possible property values, see MemoryClassification in Property Details. |
OffsetMiB | number (MiBy) read-only (null) |
Offset with in the Memory that corresponds to the starting of this memory region in mebibytes (MiB). |
PassphraseEnabled | boolean read-only (null) |
Indicates if the passphrase is enabled for this region. |
PassphraseState | boolean read-only (null) |
State of the passphrase for this region. |
RegionId | string read-only (null) |
Unique region ID representing a specific region within the Memory. |
SizeMiB | number (MiBy) read-only (null) |
Size of this memory region in mebibytes (MiB). |
} ] | ||
SecurityCapabilities { | object | This object contains security capabilities of the Memory. |
MaxPassphraseCount | number read-only (null) |
Maximum number of passphrases supported for this Memory. |
PassphraseCapable | boolean read-only (null) |
Memory passphrase set capability. |
SecurityStates [ ] | array (string (enum)) read-only |
Security states supported by the Memory. For the possible property values, see SecurityStates in Property Details. |
} | ||
SerialNumber | string read-only (null) |
The product serial number of this device. |
SpareDeviceCount | number read-only (null) |
Number of unused spare devices available in the Memory. |
Status {} | object | This type describes the status and health of a resource and its children. See the Resource schema for details on this property. |
SubsystemDeviceID | string read-only (null) |
Subsystem Device ID. |
SubsystemVendorID | string read-only (null) |
SubSystem Vendor ID. |
VendorID | string read-only (null) |
Vendor ID. |
VolatileRegionNumberLimit | number read-only (null) |
Total number of volatile regions this Memory can support. |
VolatileRegionSizeLimitMiB | number read-only (null) |
Total size of volatile regions in mebibytes (MiB). |
VolatileRegionSizeMaxMiB | number read-only (null) |
Maximum size of a single volatile region in mebibytes (MiB). |
VolatileSizeMiB | number (MiBy) read-only (null) |
Total size of the volitile portion memory in MiB. |
Actions
DisablePassphrase
Disable passphrase for given regions.
URIs:
The following table shows the parameters for the action which are included in the POST body to the URI shown in the "target" property of the Action.
{ | ||
Passphrase | string read-write required |
Passphrase for doing the operation. |
RegionId | string read-write required |
Memory region ID for which this action to be applied. |
} |
SecureEraseUnit
This defines the action for securely erasing given regions.
URIs:
The following table shows the parameters for the action which are included in the POST body to the URI shown in the "target" property of the Action.
{ | ||
Passphrase | string read-write required |
Passphrase for doing the operation. |
RegionId | string read-write required |
Memory region ID for which this action to be applied. |
} |
SetPassphrase
Set passphrase for the given regions.
URIs:
The following table shows the parameters for the action which are included in the POST body to the URI shown in the "target" property of the Action.
{ | ||
Passphrase | string read-write required |
Passphrase for doing the operation. |
RegionId | string read-write required |
Memory region ID for which this action to be applied. |
} |
UnlockUnit
This defines the action for unlocking given regions.
URIs:
The following table shows the parameters for the action which are included in the POST body to the URI shown in the "target" property of the Action.
{ | ||
Passphrase | string read-write required |
Passphrase for doing the operation. |
RegionId | string read-write required |
Memory region ID for which this action to be applied. |
} |
Property Details
BaseModuleType:
The base module type of Memory.
string | Description |
---|---|
LRDIMM | Load Reduced. |
Mini_RDIMM | Mini_RDIMM. |
Mini_UDIMM | Mini_UDIMM. |
RDIMM | Registered DIMM. |
SO_DIMM | SO_DIMM. |
SO_DIMM_16b | SO_DIMM_16b. |
SO_DIMM_32b | SO_DIMM_32b. |
SO_RDIMM_72b | SO_RDIMM_72b. |
SO_UDIMM_72b | SO_UDIMM_72b. |
UDIMM | UDIMM. |
ErrorCorrection:
Error correction scheme supported for this memory.
string | Description |
---|---|
AddressParity | Address Parity errors can be corrected. |
MultiBitECC | Multi-bit Data errors can be corrected by ECC. |
NoECC | No ECC available. |
SingleBitECC | Single bit Data error can be corrected by ECC. |
MemoryClassification:
Classification of memory occupied by the given memory region.
string | Description |
---|---|
Block | Block accesible memory. |
ByteAccessiblePersistent | Byte accessible persistent memory. |
Volatile | Volatile memory. |
MemoryDeviceType:
Type details of the Memory.
string | Description |
---|---|
DDR | DDR. |
DDR2 | DDR2. |
DDR2_SDRAM | DDR2 SDRAM. |
DDR2_SDRAM_FB_DIMM | DDR2 SDRAM FB_DIMM. |
DDR2_SDRAM_FB_DIMM_PROBE | DDR2 SDRAM FB_DIMM PROBE. |
DDR3 | DDR3. |
DDR3_SDRAM | DDR3 SDRAM. |
DDR4 | DDR4. |
DDR4_SDRAM | DDR4 SDRAM. |
DDR4E_SDRAM | DDR4E SDRAM. |
DDR_SDRAM | DDR SDRAM. |
DDR_SGRAM | DDR SGRAM. |
EDO | EDO. |
FastPageMode | Fast Page Mode. |
Logical | Logical Non-volatile device. |
LPDDR3_SDRAM | LPDDR3 SDRAM. |
LPDDR4_SDRAM | LPDDR4 SDRAM. |
PipelinedNibble | Pipelined Nibble. |
ROM | ROM. |
SDRAM | SDRAM. |
MemoryMedia:
Media of this Memory.
string | Description |
---|---|
DRAM | DRAM media. |
NAND | NAND media. |
Proprietary | Proprietary media. |
MemoryType:
The type of Memory.
string | Description |
---|---|
DRAM | The memory module is composed of volatile memory. |
NVDIMM_F | The memory module is composed of non-volatile memory. |
NVDIMM_N | The memory module is composed of volatile memory backed by non-volatile memory. |
NVDIMM_P | The memory module is composed of a combination of non-volatile and volatile memory. |
OperatingMemoryModes:
Memory modes supported by the Memory.
string | Description |
---|---|
Block | Block accessible system memory. |
PMEM | Persistent memory, byte accesible through system address space. |
Volatile | Volatile memory. |
SecurityStates:
Security states supported by the Memory.
string | Description |
---|---|
Disabled | Secure mode is disabled. |
Enabled | Secure mode is enabled. |
Frozen | Secure state is frozen and can not be modified until reset. |
Locked | Secure mode is enabled and access to the data is locked. |
Passphraselimit | Number of attempts to unlock the Memory exceeded limit. |
Unlocked | Secure mode is enabled and access to the data is unlocked. |
MemoryDomain 1.2.0
This is the schema definition of a Memory Domain and its configuration. Memory Domains are used to indicate to the client which Memory (DIMMs) can be grouped together in Memory Chunks to form interleave sets or otherwise grouped together.
AllowsBlockProvisioning | boolean read-only (null) |
Indicates if this Memory Domain supports the provisioning of blocks of memory. |
AllowsMemoryChunkCreation | boolean read-only (null) |
Indicates if this Memory Domain supports the creation of Memory Chunks. |
AllowsMirroring | boolean read-only (null) |
Indicates if this Memory Domain supports the creation of Memory Chunks with mirroring enabled. |
AllowsSparing | boolean read-only (null) |
Indicates if this Memory Domain supports the creation of Memory Chunks with sparing enabled. |
Description | string read-only (null) |
Provides a description of this resource and is used for commonality in the schema definitions. |
Id | string read-only required |
Uniquely identifies the resource within the collection of like resources. |
InterleavableMemorySets [ { | array | This is the interleave sets for the memory chunk. |
MemorySet [ { | array | This is the collection of memory for a particular interleave set. |
@odata.id | string read-only |
Link to a Memory resource. See the Links section and the Memory schema for details. |
} ] | ||
} ] | ||
MemoryChunks { | object (null) |
A reference to the collection of Memory Chunks associated with this Memory Domain. Contains a link to a resource. |
@odata.id | string read-only |
Link to Collection of MemoryChunks. See the MemoryChunks schema for details. |
} | ||
Name | string read-only required |
The name of the resource or array element. |
Oem {} | object | This is the manufacturer/provider specific extension moniker used to divide the Oem object into sections. See the Resource schema for details on this property. |
MemoryMetrics 1.1.3
MemoryMetrics contains usage and health statistics for a single Memory module or device instance.
BlockSizeBytes | number (Bytes) read-only (null) |
Block size in bytes. |
CurrentPeriod { | object | This object contains the Memory metrics since last reset or ClearCurrentPeriod action. |
BlocksRead | number read-only (null) |
Number of blocks read since reset. |
BlocksWritten | number read-only (null) |
Number of blocks written since reset. |
} | ||
Description | string read-only (null) |
Provides a description of this resource and is used for commonality in the schema definitions. |
HealthData { | object | This object describes the health information of the memory. |
AlarmTrips { | object | Alarm trip information about the memory. |
AddressParityError | boolean read-only (null) |
Address parity error detected status. |
CorrectableECCError | boolean read-only (null) |
Correctable data error threshold crossing alarm trip detected status. |
SpareBlock | boolean read-only (null) |
Spare block capacity crossing alarm trip detected status. |
Temperature | boolean read-only (null) |
Temperature threshold crossing alarm trip detected status. |
UncorrectableECCError | boolean read-only (null) |
Uncorrectable data error threshold crossing alarm trip detected status. |
} | ||
DataLossDetected | boolean read-only (null) |
Data loss detection status. |
LastShutdownSuccess | boolean read-only (null) |
Status of last shutdown. |
PerformanceDegraded | boolean read-only (null) |
Performance degraded mode status. |
PredictedMediaLifeLeftPercent | number read-only (null) |
The percentage of reads and writes that are predicted to still be available for the media. |
RemainingSpareBlockPercentage | number read-only (null) |
Remaining spare blocks in percentage. |
} | ||
Id | string read-only required |
Uniquely identifies the resource within the collection of like resources. |
LifeTime { | object | This object contains the Memory metrics for the lifetime of the Memory. |
BlocksRead | number read-only (null) |
Number of blocks read for the lifetime of the Memory. |
BlocksWritten | number read-only (null) |
Number of blocks written for the lifetime of the Memory. |
} | ||
Name | string read-only required |
The name of the resource or array element. |
Oem {} | object | This is the manufacturer/provider specific extension moniker used to divide the Oem object into sections. See the Resource schema for details on this property. |
Actions
ClearCurrentPeriod
This sets the CurrentPeriod object values to zero.
URIs:
(This action takes no parameters.)
MessageRegistry 1.1.1
This is the schema definition for all Message Registries. It represents the properties for the registries themselves. The MessageId is formed per the Redfish specification. It consists of the RegistryPrefix concatenated with the version concatenated with the unique identifier for the message registry entry.
Description | string read-only (null) |
Provides a description of this resource and is used for commonality in the schema definitions. |
Id | string read-only required |
Uniquely identifies the resource within the collection of like resources. |
Language | string read-only required |
This is the RFC 5646 compliant language code for the registry. |
Messages { | object * required* |
The pattern property indicates that a free-form string is the unique identifier for the message within the registry. |
(pattern) { | object | Property names follow regular expression pattern "[A-Za-z0-9]+" |
Description | string read-only required |
This is a short description of how and when this message is to be used. |
Message | string read-only required |
The actual message. |
NumberOfArgs | number read-only required |
The number of arguments to be expected to be passed in as MessageArgs for this message. |
Oem {} | object | Oem extension object. See the Resource schema for details on this property. |
ParamTypes [ ] | array (string (enum)) read-only |
The MessageArg types, in order, for the message. For the possible property values, see ParamTypes in Property Details. |
Resolution | string read-only required |
Used to provide suggestions on how to resolve the situation that caused the error. |
Severity | string read-only required |
This is the severity of the message. |
} | ||
(pattern) {} [ ] | array, boolean, number, object, string (null) |
Property names follow regular expression pattern "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata\ |
} | ||
Name | string read-only required |
The name of the resource or array element. |
Oem {} | object | This is the manufacturer/provider specific extension moniker used to divide the Oem object into sections. See the Resource schema for details on this property. |
OwningEntity | string read-only required |
This is the organization or company that publishes this registry. |
RegistryPrefix | string read-only required |
This is the single word prefix used to form a messageID structure. |
RegistryVersion | string read-only required |
This is the message registry version which is used in the middle portion of a messageID. |
Property Details
ParamTypes:
The MessageArg types, in order, for the message.
string | Description |
---|---|
number | The parameter is a number. |
string | The parameter is a string. |
MessageRegistryFile 1.1.0
This is the schema definition for the Schema File locator resource.
Description | string read-only (null) |
Provides a description of this resource and is used for commonality in the schema definitions. |
Id | string read-only required |
Uniquely identifies the resource within the collection of like resources. |
Languages [ ] | array (string) read-only required |
Language codes for the schemas available. |
Location [ { | array * required* |
Location information for this schema file. |
ArchiveFile | string read-only |
If the schema is hosted on the service in an archive file, this is the name of the file within the archive. |
ArchiveUri | string read-only |
If the schema is hosted on the service in an archive file, this is the link to the archive file. |
Language | string read-only |
The language code for the file the schema is in. |
PublicationUri | string read-only |
Link to publicly available (canonical) URI for schema. |
Uri | string read-only |
Link to locally available URI for schema. |
} ] | ||
Name | string read-only required |
The name of the resource or array element. |
Oem {} | object | This is the manufacturer/provider specific extension moniker used to divide the Oem object into sections. See the Resource schema for details on this property. |
Registry | string read-only required |
The Registry Name, Major and Minor version used in MessageID construction. |
NetworkAdapter 1.1.0
A NetworkAdapter represents the physical network adapter capable of connecting to a computer network. Examples include but are not limited to Ethernet, Fibre Channel, and converged network adapters.
Assembly {} | object | A reference to the Assembly resource associated with this adapter. See the Assembly schema for details on this property. |
Controllers [ { | array | The set of network controllers ASICs that make up this NetworkAdapter. |
ControllerCapabilities { | object (null) |
The capabilities of this controller. |
DataCenterBridging { | object (null) |
Data Center Bridging (DCB) for this controller. |
Capable | boolean read-only (null) |
Whether this controller is capable of Data Center Bridging (DCB). |
} | ||
NetworkDeviceFunctionCount | number read-only (null) |
The maximum number of physical functions available on this controller. |
NetworkPortCount | number read-only (null) |
The number of physical ports on this controller. |
NPIV { | object (null) |
N_Port ID Virtualization (NPIV) capabilties for this controller. |
MaxDeviceLogins | number read-only (null) |
The maximum number of N_Port ID Virtualization (NPIV) logins allowed simultaneously from all ports on this controller. |
MaxPortLogins | number read-only (null) |
The maximum number of N_Port ID Virtualization (NPIV) logins allowed per physical port on this controller. |
} | ||
VirtualizationOffload { | object (null) |
Virtualization offload for this controller. |
SRIOV { | object (null) |
Single-Root Input/Output Virtualization (SR-IOV) capabilities. |
SRIOVVEPACapable | boolean read-only (null) |
Whether this controller supports Single Root Input/Output Virtualization (SR-IOV) in Virtual Ethernet Port Aggregator (VEPA) mode. |
} | ||
VirtualFunction { | object (null) |
A virtual function of a controller. |
DeviceMaxCount | number read-only (null) |
The maximum number of Virtual Functions (VFs) supported by this controller. |
MinAssignmentGroupSize | number read-only (null) |
The minimum number of Virtual Functions (VFs) that can be allocated or moved between physical functions for this controller. |
NetworkPortMaxCount | number read-only (null) |
The maximum number of Virtual Functions (VFs) supported per network port for this controller. |
} | ||
} | ||
} | ||
FirmwarePackageVersion | string read-only (null) |
The version of the user-facing firmware package. |
Links { | object | Links. |
NetworkDeviceFunctions [ { | array | Contains the members of this collection. |
@odata.id | string read-only |
Link to a NetworkDeviceFunction resource. See the Links section and the NetworkDeviceFunction schema for details. |
} ] | ||
NetworkPorts [ { | array | Contains the members of this collection. |
@odata.id | string read-only |
Link to a NetworkPort resource. See the Links section and the NetworkPort schema for details. |
} ] | ||
Oem {} | object | Oem extension object. See the Resource schema for details on this property. |
PCIeDevices [ { | array | Contains the members of this collection. |
@odata.id | string read-only |
Link to a PCIeDevice resource. See the Links section and the PCIeDevice schema for details. |
} ] | ||
} | ||
Location {} | object | This type describes the location of a resource. See the Resource schema for details on this property. |
} ] | ||
Description | string read-only (null) |
Provides a description of this resource and is used for commonality in the schema definitions. |
Id | string read-only required |
Uniquely identifies the resource within the collection of like resources. |
Manufacturer | string read-only (null) |
The manufacturer or OEM of this network adapter. |
Model | string read-only (null) |
The model string for this network adapter. |
Name | string read-only required |
The name of the resource or array element. |
NetworkDeviceFunctions { | object | Contains the members of this collection. Contains a link to a resource. |
@odata.id | string read-only |
Link to Collection of NetworkDeviceFunction. See the NetworkDeviceFunction schema for details. |
} | ||
NetworkPorts { | object | Contains the members of this collection. Contains a link to a resource. |
@odata.id | string read-only |
Link to Collection of NetworkPort. See the NetworkPort schema for details. |
} | ||
Oem {} | object | This is the manufacturer/provider specific extension moniker used to divide the Oem object into sections. See the Resource schema for details on this property. |
PartNumber | string read-only (null) |
Part number for this network adapter. |
SerialNumber | string read-only (null) |
The serial number for this network adapter. |
SKU | string read-only (null) |
The manufacturer SKU for this network adapter. |
Status {} | object (null) |
This type describes the status and health of a resource and its children. See the Resource schema for details on this property. |
Actions
ResetSettingsToDefault
This action is to clear the settings back to factory defaults.
URIs:
(This action takes no parameters.)
NetworkDeviceFunction 1.2.1
A Network Device Function represents a logical interface exposed by the network adapter.
AssignablePhysicalPorts [ { | array | The array of physical port references that this network device function may be assigned to. |
@odata.id | string read-only |
Link to a NetworkPort resource. See the Links section and the NetworkPort schema for details. |
} ] | ||
BootMode | string (enum) read-write (null) |
The boot mode configured for this network device function. For the possible property values, see BootMode in Property Details. |
Description | string read-only (null) |
Provides a description of this resource and is used for commonality in the schema definitions. |
DeviceEnabled | boolean read-write (null) |
Whether the network device function is enabled. |
Ethernet { | object (null) |
Ethernet. |
MACAddress | string read-write (null) |
This is the currently configured MAC address of the (logical port) network device function. |
MTUSize | number read-write (null) |
The Maximum Transmission Unit (MTU) configured for this network device function. |
PermanentMACAddress | string read-only (null) |
This is the permanent MAC address assigned to this network device function (physical function). |
} | ||
FibreChannel { | object (null) |
Fibre Channel. |
AllowFIPVLANDiscovery | boolean read-write (null) |
Whether the FCoE Initialization Protocol (FIP) is used for populating the FCoE VLAN Id. |
BootTargets [ { | array | An array of Fibre Channel boot targets configured for this network device function. |
BootPriority | number read-write (null) |
The relative priority for this entry in the boot targets array. |
LUNID | string read-write (null) |
The Logical Unit Number (LUN) ID to boot from on the device referred to by the corresponding WWPN. |
WWPN | string read-write (null) |
The World-Wide Port Name to boot from. |
} ] | ||
FCoEActiveVLANId | number read-only (null) |
The active FCoE VLAN ID. |
FCoELocalVLANId | number read-write (null) |
The locally configured FCoE VLAN ID. |
PermanentWWNN | string read-only (null) |
This is the permanent WWNN address assigned to this network device function (physical function). |
PermanentWWPN | string read-only (null) |
This is the |