Virtual I/O Server
The Virtual I/O Server (VIOS) facilitates the sharing of physical I/O resources between client logical partitions within the server.
Resource
The Virtual IO Server API provides information about all the VIOS managed
by a particular managed system given the
UUID:
/rest/api/uom/ManagedSystem/{ManagedSystem_uuid}/VirtualIOServerThis API provides information about the specific VIOS that is being managed by the specific
managed system given their respective
UUIDs:
/rest/api/uom/ManagedSystem/{ManagedSystem_uuid}/VirtualIOServer/{VirtualIOServer_uuid}This API provides information about all the VIOS managed by the
HMC:
/rest/api/uom/VirtualIOServerThis API provides information about a particular VIOS given its
UUID:
/rest/api/uom/VirtualIOServer/{VirtualIOServer_uuid}Quick properties
User can fetch the only specified property.
Resource
/rest/api/uom/VirtualIOServer/{VirtualIOServer_uuid}/quick/{Property name}Supported property names available at /rest/api/uom/VirtualIOServer/quick URI.
| Quick property | Description |
|---|---|
| IsVirtualServiceAttentionLEDOn | The virtual service attention LED state. |
| APICapable | API capability. |
| PartitionType | The partition environment, as an enumeration key (for example,'AIX_LINUX', 'OS_400', 'VIRTUAL_IO_SERVER'). |
| PartitionName | The name of the partition. |
| PartitionID | The integer ID of the partition. |
| PartitionState | The state of the partition. |
| AssociatedManagedSystem | The REST URI of the partition's parent managed system. |
| RMCState | The state of the partition's Resource Monitoring Control (RMC) connection. |
Extended groups
There are certain attribute which always makes call to its underlying layer to get the data. Those attributes are not cached and populated in REST API unless user requested for them.
Resource
This API provides VIOS information of specified extended group
attributes:
/rest/api/uom/VirtualIOServer?group={Group Name}This
API provides information of specified extended group attributes of
the given instance:
/rest/api/uom/VirtualIOServer/{VirtualIOServer_uuid}?group={Group Name}This
API provides information of specified extended group attributes of
the given instance:
/rest/api/uom/ManagedSystem/{ManagedSystem_uuid}/VirtualIOServer?group={Group Name}This
API provides information of specified extended group attributes of
the given instance:
/rest/api/uom/ManagedSystem/{ManagedSystem_uuid}/VirtualIOServer/{VirtualIOServer_uuid}?group={Group Name}| Group name | Description |
|---|---|
| ViosStorage | This is an extended group that gets data related to storage by making a call to VIOS. |
| None | This is an extended group that provides the default attributes. |
| ViosNetwork | This is an extended group that gets data related to network by making a call to VIOS. |
| ViosFCMapping | This is an extended group that will provide the client and server Fiber Channel mapping details. |
| ViosSCSIMapping | This is an extended group that will provide the client and server SCSI client adapter mapping details. |
| Method | 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=VirtualIOServer |
| PUT | It is used to request the web server to accept the entity enclosed in the request and allow them to create a new instance. | application/vnd.ibm.powervm.uom+xml; Type=VirtualIOServer |
| 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=VirtualIOServer |
| DELETE | It is used to request the web server to delete the requested entity. | application/vnd.ibm.powervm.uom+xml; Type=VirtualIOServer |
Since: Version 1_1_0
Search
User can search a resource by giving a property name and value in the VIOS URI to get the matching instance.
Resource
/rest/api/uom/VirtualIOserver/search/({Property name}=={Property value})Supported property name available at /rest/api/uom/VirtualIOServer/search URI.
