STM Virtual I/O Server JSON Specification
Virtual I/O Server (VIOS) JSON Specification for Short Term Monitoring metrics
Resource
/rest/api/pcm/ManagedSystem/[Managed System uid]/RawMetrics/ShortTermMonitor/STM_[Managed System MTMS]_[VIOS Name]_yyyyMMDDThhmmss+0000.json
{
"systemUtil": {
"utilInfo": {
"version": "string",
"metricType": "string",
"monitoringType": "string",
"mtms": "string"
},
"utilSample": {
"timeStamp": "string",
"status": "number",
"errorInfo": [{
"errId": "string",
"errMsg": "string"
}],
"viosUtil": [{
"id": "string",
"name": "string",
"processor": {
"userCounter": "number",
"kernelCounter": "number",
"purrCounter": "number",
"spurrCounter": "number",
"timeBaseCounter": "number"
},
"memory": {
"utilizedMem": "number",
"usedForNetworkBuffer": "number",
"usedForOtherOperations": "number",
"swapSpaceUsed": "number"
},
"network": {
"genericAdapters": [{
"id": "string",
"type": "string",
"physicalLocation": "string",
"receivedPackets": "number",
"sentPackets": "number",
"droppedPackets": "number",
"sentBytes": "number",
"receivedBytes": "number"
}],
"sharedAdapters": [{
"id": "string",
"type": "string",
"physicalLocation": "string",
"receivedPackets": "number",
"sentPackets": "number",
"droppedPackets": "number",
"sentBytes": "number",
"receivedBytes": "number",
"bridgedAdapters": ["string"]
}]
},
"storage": {
"genericPhysicalAdapters": [{
"id": "string",
"type": "string",
"physicalLocation": "string",
"numOfReads": "number",
"numOfWrites": "number",
"readBytes": "number",
"writeBytes": "number"
}],
"genericVirtualAdapters": [{
"id": "string",
"type": "string",
"physicalLocation": "string",
"numOfReads": "number",
"numOfWrites": "number",
"readBytes": "number",
"writeBytes": "number"
}],
"fiberChannelAdapters": [{
"id": "string",
"wwpn": "string",
"physicalLocation": "string",
"numOfReads": "number",
"numOfWrites": "number",
"readBytes": "number",
"writeBytes": "number",
"runningSpeed": "number",
"ports": [{
"id": "string",
"wwpn": "string",
"physicalLocation": "string",
"numOfReads": "number",
"numOfWrites": "number",
"readBytes": "number",
"writeBytes": "number",
"runningSpeed": "number"
}]
}],
"sharedStoragePools": [{
"id": "string",
"poolDisks": ["string"],
"poolVirtualDevices": ["string"],
"numOfReads": "number",
"numOfWrites": "number",
"totalSpace": "number",
"usedSpace": "number",
"readBytes": "number",
"writeBytes": "number"
}],
"physicalDevices": [{
"id": "string",
"uid": "string",
"diskAdapterId": "string",
"poolId": "string",
"numOfReads": "number",
"numOfWrites": "number",
"readBytes": "number",
"writeBytes": "number",
"readServiceTime": "number",
"writeServiceTime": "number",
"timeSpentInWaitQueue": "number",
"waitQueueSize": "number",
"numOfTimesServiceQueueIsFull": "number"
}],
"virtualDevices": [{
"id": "string",
"uid": "string",
"poolId": "string",
"totalSpace": "number",
"usedSpace": "number",
"numOfReads": "number",
"numOfWrites": "number",
"readBytes": "number",
"writeBytes": "number",
"readServiceTime": "number",
"writeServiceTime": "number",
"timeSpentInWaitQueue": "number",
"waitQueueSize": "number",
"numOfTimesServiceQueueIsFull": "number"
}],
}
}]
}
}
}
| Metric name | Description |
|---|---|
| General Attributes | |
| utilInfo | |
| version |
Specifies the current version of the JSON specification. Version 1.0.0: Metrics data is collected from a managed system with PHYP version lower than 7.8.0. Version 1.1.0: Metrics data is collected from a managed system with PHYP version equal to or greater than 7.8.0. |
| metricType | Type of the Metric. For LTM the value is Raw |
| monitoringType | Type of Monitoring. For Long Term Metrics, the value is LTM. For Short Term Metrics, the value is STM. |
| mtms | MTMS of the managed system |
| utilSample | |
| timeStamp | The collection time of the sample in yyyy-MM-ddTHH:mm:ssZ format |
| status |
Status can have one of the following values: 0: all collections are successful 1: all collections have failed 2: part of the collection is successful |
| errorInfo: Information about any error that occurred | |
| errId | ID of the error |
| errMsg | Detailed information of the error |
| viosUtil | |
| id | VIOS Id |
| name | Name of VIOS |
| Processor | |
| userCounter | Raw number of physical processor ticks in user mode |
| kernelCounter | Raw number of physical processor ticks in kernel mode |
| purrCounter | Number of purr cycles spent in user + kernel mode |
| SpurrCounter | Number of spurr cycles spent in user + kernel mode |
| timeBaseCounter | Total number of clock ticks |
| Memory | |
| utilizedMem | Overall Memory Utilization (in megabytes) |
| usedForNetworkBuffer | Utilized Memory for Network Buffer by IO server (in megabytes) |
| usedForOtherOperations | Utilized Memory for other System Operations by IO server (in megabytes) |
| swapSpaceUsed | Total swap space used (in megabytes) |
| Network | |
| genericAdapters and sharedAdapters | |
| id | Adapter Id |
| type | Type of the adapter |
| physicalLocation | Physical Location of the adapter |
| receivedPackets | Number of Packets received by the adapter. It is a counter type since last reboot of VIOS |
| sentPackets | Number of Packets sent by the adapter. It is a counter type since last reboot of VIOS |
| droppedPackets | Number of packets dropped by the adapter since VIOS reboot |
| sentBytes | Number of bytes sent by the adapter since VIOS reboot |
| receivedBytes | Number of bytes received by the adapter since VIOS reboot |
| bridgedAdapters | List of ids of generic adapters attached to a SEA |
| Storage | |
| genericPhysicalAdapters, genericVirtualAdapters, fiberChannelAdapters, sharedStoragePools | |
| id | Id of the adapter or Fibre Channel port or shared storage pool |
| type | Type of the adapter |
| physicalLocation | Physical Location Code of the adapter or Fibre Channel port |
| numOfReads |
Number of read requests coming to the adapter or Fibre Channel port or shared storage pool. It is a counter type since last reboot of VIOS |
| numOfWrites |
Number of write requests coming to the adapter or Fibre Channel port or shared storage pool. It is a counter type since last reboot of VIOS |
| readBytes |
Number of bytes read through the adapter or Fibre Channel port or shared storage pool. It is a counter type since last reboot of VIOS |
| writeBytes |
Number of bytes written through the adapter or Fibre Channel port or shared storage pool. It is a counter type since last reboot of VIOS |
| runningSpeed | Running speed of the Fibre Channel adapter or Fibre Channel port |
| wwpn | WWPN of the Fibre Channel adapter or Fibre Channel port |
| poolDisks | Ids of physical disks attached to this pool |
| poolVirtualDevices | Ids of virtual devices associated with this storage pool |
| totalSpace | Total space at pool level |
| usedSpace | Used space at pool level |
| physicalDevices and virtualDevices | |
| id | Id of the device |
| uid | Unique id of the device |
| diskAdapterId | Associated disk adapter id |
| poolId | Id of shared storage pool if this disk is attached to any SSP |
| totalSpace | Total space allocated to the virtual device. Reported only if it is associated with SSP |
| usedSpace | Total space used on the virtual device. Reported only if it is associated with SSP |
| numOfReads |
Number of reads requests coming to this disk device. Counter type since last reboot of VIOS or last disk reset |
| numOfWrites |
Number of writes requests coming to this disk device. Counter type since last reboot of VIOS or last disk reset |
| readBytes |
Number of bytes read through this device. Counter type since last reboot of VIOS or last disk reset |
| writeBytes |
Number of bytes written to this physical or virtual disk. Counter type since last reboot of VIOS or last disk reset |
| readServiceTime |
Average Time spent for servicing a read request. Counter type since last reboot of VIOS or last disk reset |
| writeServiceTime |
Average Time spent for servicing a write request. Counter type since last reboot of VIOS or last disk reset |
| timeSpentInWaitQueue |
Average Time spent in wait queue for an I/O operation. Counter type since last reboot of VIOS or last disk reset |
| waitQueueSize |
Size of the wait queue for accommodating I/O operation. Counter type since last reboot of VIOS or last disk reset |
| numOfTimesServiceQueueIsFull |
Number of times the system rejects an I/O request since the service queue is already full. Counter type since last reboot of VIOS or last disk reset |