API Guide
Table Of Contents
- OpenManage Integration for VMware vCenter Version 5.3 API Guide
- Overview
- Get started
- Security
- Use cases
- Session management
- License management
- Console management
- Repository profile management
- Cluster profile management
- Firmware repository inventory management
- Firmware inventory management
- Firmware update management
- System profile management
- Host management
- Get subsystem health report (OMIVV Host Health)
- Host management
- Request body
- Response body
- OMIVV-Specific error codes
Get subsystem health report (OMIVV Host
Health)
Description: Gets the health of the server components such as Fan, Power Supply, and Memory. The information displayed
here is real-time information.
Command or URL: Services/InventoryService/Hosts/{id}/SubSystemHealth
Method: GET
Authorization: Bearer authentication
Parameters:
Table 55. Parameters
Parameter Value Description Parameter type Data type
id (required) Host ID. Use the host
ID received from /Services/
ConsoleService/Consoles/{id}
or /Services/ConsoleService/
Consoles/{Console-ID}/Hosts
or /Services/ConsoleService/Consoles/
{id}/Hosts?serviceTags={service Tags
1}& serviceTags={service Tags 2}
Path String
vCenter privileges required: Dell.Inventory.Configure Inventory
HTTP response code:
Table 56. HTTP response code
Code Description or response object
200 OK
401 Authorization failure
404 Resource not found
429 Too many requests
500 Internal Server error / timeout
For OMIVV-Specific error codes, see OMIVV-Specific error codes on page 112.
Example Response:
{
"overallHealth": "{{Overall health of a server}}",
"subSystemHealth": [
{
"subSystem": "{Fan}",
"rollUpStatus": "CRITICAL"
},
{
"subSystem": "{Memory}",
"rollUpStatus": "NORMAL"
},
{
"subSystem": "{PSU}",
"rollUpStatus": "NORMAL"
},
15
82 Get subsystem health report (OMIVV Host Health)