Managed System
Managed System API provides a list of all system information managed by Hardware Management Console (HMC), such as system name, system machine type, model and serial number, system state, system capabilities, IP address, system migration information, system processor, system memory, and system I/O adapters information for all of the managed system. In addition, each managed system has a list of all child objects, such as:
Resource
/rest/api/uom/ManagedSystemThis API provides all system information in the console.
/rest/api/uom/ManagedSystem/{uuid}This API provides system information of the given instance.
Quick properties
User can fetch only the specified property.
Resource
/rest/api/uom/ManagedSystem/{uuid}/quick/{Property Name}Supported property names available at /rest/api/uom/ManagedSystem/quick URI.
| Property Name | Description |
|---|---|
| State | Fetch current state of the system. |
| SystemName | Fetch name of the system. |
| IPAddress | Fetch IP address of the system. |
| MTMS | Fetch system machine type, model, and Serial number |
| PhysicalSystemAttentionLEDState | Fetch LED state of the system |
| MemoryDefragmentationState | Fetch memory defragmentation state of the system |
Extended groups
Certain attribute always make calls to the underlying layer to get the data. These attributes will not be cached and populated in REST API unless user requested it.
Resource
/rest/api/uom/ManagedSystem?group={Group Name}This API provides system information of the specified extended group attributes.
/rest/api/uom/ManagedSystem/{uuid}?group={Group Name}This API provides the specified extended group attributes of the given instance.
| Group name | Description |
|---|---|
| EnergyManagement | This is an extended group, returns Energy Scale settings and tuanble parameters details. |
| Hypervisor | This is an extended group which makes a call to hypervisor to get the data. |
| SystemNetwork | This extended group returns network related information like network bridge, virtual network and virtual switch. |
| None | This extended group returns only default attributes. |
| Method Name | Description | Internet Media Type |
|---|---|---|
| GET | It retrieves information identified by the Request-URI. Produced data is returned as the entity in the response. | application/vnd.ibm.powervm.uom+xml; Type=ManagedSystem |
| POST | It is used to request the web server to accept the entity enclosed in the request and allow them to change state of the entity. | application/vnd.ibm.powervm.uom+xml; Type=ManagedSystem |
Search
User can search a resource by specifying a property name and value in the managed system URI to get the matching instance.
Resource
/rest/api/uom/ManagedSystem/search/({Property name}=={Property value})Supported property name available at /rest/api/uom/ManagedSystem/search URI.
