Managed System Processed and Aggregated Metrics JSON Specification
The JSON specification for the managed system Processed and Aggregated metrics. All the parameters for the Processed and Aggregated metrics are same except that the Processed metrics provide only Average metrics. It does not provide Minimum and Maximum records.
Resource
/rest/api/pcm/ProcessedMetrics/ManagedSystem_[Managed System Uuid]_yyyyMMDDThhmmss+0000_yyyyMMDDThhmmss+0000_30.json
/rest/api/pcm/AggregatedMetrics/ManagedSystem_[Managed System Uuid]_yyyyMMDDThhmmss+0000_yyyyMMDDThhmmss+0000_[Tier frequency in seconds].json
PCM Processed or aggregated metrics URI provides the following managed system utilization data when the AggregationEnabled configuration value for a managed system is enabled.
{
"systemUtil": {
"utilInfo": {
"version": "string",
"metricType": "string",
"frequency": "number",
"startTimeStamp": "string",
"endTimeStamp": "string",
"mtms": "string",
"name": "string",
"uuid": "string",
"metricArrayOrder": ["Avg", "Min", "Max"]
},
"utilSamples": [{
"sampleType": "string",
"sampleInfo": {
"timeStamp": "string",
"numOfSamplesAggregated": "number",
"status": "number",
"errorInfo": [{
"errId": "string",
"errMsg": "string",
"uuid": "string",
"reportedBy": "string",
"occurenceCount": "number"
}]
},
"systemFirmwareUtil": {
"utilizedProcUnits": ["number", "number", "number"],
"assignedMem": ["number", "number", "number"]
},
"serverUtil": {
"processor": {
"totalProcUnits": ["number", "number", "number"],
"utilizedProcUnits": ["number", "number", "number"],
"utilizedProcUnitsDeductIdle": ["number", "number", "number"],
"availableProcUnits": ["number", "number", "number"],
"configurableProcUnits": ["number", "number", "number"]
},
"memory": {
"totalMem": ["number", "number", "number"],
"availableMem": ["number", "number", "number"],
"configurableMem": ["number", "number", "number"],
"assignedMemToLpars": ["number", "number", "number"],
"virtualPersistentMem": ["number", "number", "number"]
},
"physicalProcessorPool": {
"assignedProcUnits": ["number", "number", "number"],
"utilizedProcUnits": ["number", "number", "number"],
"availableProcUnits": ["number", "number", "number"],
"configuredProcUnits": ["number", "number", "number"],
"borrowedProcUnits": ["number", "number", "number"]
},
"sharedMemoryPool": [{
"id": "number",
"totalMem": ["number", "number", "number"],
"assignedMemToLpars": ["number", "number", "number"],
"totalIOMem": ["number", "number", "number"],
"mappedIOMemToLpars": ["number", "number", "number"],
"assignedMemToSysFirmware": ["number", "number", "number"]
}],
"sharedProcessorPool": [{
"id": "number",
"name": "string",
"assignedProcUnits": ["number", "number", "number"],
"utilizedProcUnits": ["number", "number", "number"],
"availableProcUnits": ["number", "number", "number"],
"configuredProcUnits": ["number", "number", "number"],
"borrowedProcUnits": ["number", "number", "number"]
}],
"network": {
"sriovAdapters": [{
"drcIndex": "string",
"physicalPorts": [{
"id": "number",
"physicalLocation": "string",
"receivedPackets": ["number", "number", "number"],
"sentPackets": ["number", "number", "number"],
"droppedPackets": ["number", "number", "number"],
"sentBytes": ["number", "number", "number"],
"receivedBytes": ["number", "number", "number"],
"errorIn": ["number", "number", "number"],
"errorOut": ["number", "number", "number"],
"transferredBytes": ["number", "number", "number"]
}]
}],
"HEAdapters": [{
"drcIndex": "string",
"physicalPorts": [{
"id": "number",
"physicalLocation": "string",
"receivedPackets": ["number", "number", "number"],
"sentPackets": ["number", "number", "number"],
"droppedPackets": ["number", "number", "number"],
"sentBytes": ["number", "number", "number"],
"receivedBytes": ["number", "number", "number"],
"transferredBytes": ["number", "number", "number"]
}]
}]
}
},
"viosUtil": [{
"id": "number",
"uuid": "string",
"name": "string",
"state": "string",
"affinityScore": "number",
"memory": {
"assignedMem": ["number", "number", "number"],
"utilizedMem": ["number", "number", "number"],
"virtualPersistentMem": ["number", "number", "number"]
},
"processor": {
"poolId": "number",
"weight": "number",
"mode": "string",
"maxVirtualProcessors": ["number", "number", "number"],
"currentVirtualProcessors": ["number", "number", "number"],
"maxProcUnits": ["number", "number", "number"],
"entitledProcUnits": ["number", "number", "number"],
"utilizedProcUnits": ["number", "number", "number"],
"utilizedProcUnitsDeductIdle": ["number", "number", "number"],
"utilizedCappedProcUnits": ["number", "number", "number"],
"utilizedUncappedProcUnits": ["number", "number", "number"],
"idleProcUnits": ["number", "number", "number"],
"donatedProcUnits": ["number", "number", "number"],
"timeSpentWaitingForDispatch": ["number", "number", "number"],
"timePerInstructionExecution": ["number", "number", "number"]
},
"network": {
"clientLpars": "string[]",
"genericAdapters": [{
"id": "string",
"type": "string",
"physicalLocation": "string",
"receivedPackets": ["number", "number", "number"],
"sentPackets": ["number", "number", "number"],
"droppedPackets": ["number", "number", "number"],
"sentBytes": ["number", "number", "number"],
"receivedBytes": ["number", "number", "number"],
"transferredBytes": ["number", "number", "number"]
}],
"sharedAdapters": [{
"id": "string",
"type": "string",
"physicalLocation": "string",
"receivedPackets": ["number", "number", "number"],
"sentPackets": ["number", "number", "number"],
"droppedPackets": ["number", "number", "number"],
"sentBytes": ["number", "number", "number"],
"receivedBytes": ["number", "number", "number"],
"transferredBytes": ["number", "number", "number"],
"bridgedAdapters": ["string"]
}],
"virtualEthernetAdapters": [{
"physicalLocation": "string",
"vlanId": "number",
"vswitchId": "number",
"isPortVLANID": "boolean",
"receivedPackets": ["number", "number", "number"],
"sentPackets": ["number", "number", "number"],
"droppedPackets": ["number", "number", "number"],
"sentBytes": ["number", "number", "number"],
"receivedBytes": ["number", "number", "number"],
"receivedPhysicalPackets": ["number", "number", "number"],
"sentPhysicalPackets": ["number", "number", "number"],
"droppedPhysicalPackets": ["number", "number", "number"],
"sentPhysicalBytes": ["number", "number", "number"],
"receivedPhysicalBytes": ["number", "number", "number"],
"transferredBytes": ["number", "number", "number"],
"transferredPhysicalBytes": ["number", "number", "number"]
}],
"sriovLogicalPorts": [{
"drcIndex": "string",
"physicalLocation": "string",
"physicalDrcIndex": "string",
"physicalPortId": "number",
"clientPartitionUUID": "string",
"vnicDeviceMode": "string",
"configurationType": "string",
"receivedPackets": ["number", "number", "number"],
"sentPackets": ["number", "number", "number"],
"droppedPackets": ["number", "number", "number"],
"sentBytes": ["number", "number", "number"],
"receivedBytes": ["number", "number", "number"],
"errorIn": ["number", "number", "number"],
"errorOut": ["number", "number", "number"],
"transferredBytes": ["number", "number", "number"]
}]
},
"storage": {
"clientLpars": "string[]",
"genericVirtualAdapters": [{
"id": "string",
"type": "string",
"physicalLocation": "string",
"numOfReads": ["number", "number", "number"],
"numOfWrites": ["number", "number", "number"],
"readBytes": ["number", "number", "number"],
"writeBytes": ["number", "number", "number"],
"transmittedBytes": ["number", "number", "number"]
}],
"genericPhysicalAdapters": [{
"id": "string",
"type": "string",
"physicalLocation": "string",
"numOfReads": ["number", "number", "number"],
"numOfWrites": ["number", "number", "number"],
"readBytes": ["number", "number", "number"],
"writeBytes": ["number", "number", "number"],
"transmittedBytes": ["number", "number", "number"]
}],
"fiberChannelAdapters": [{
"id": "string",
"wwpn": "string",
"physicalLocation": "string",
"numOfPorts": "number",
"numOfReads": ["number", "number", "number"],
"numOfWrites": ["number", "number", "number"],
"readBytes": ["number", "number", "number"],
"writeBytes": ["number", "number", "number"],
"runningSpeed": ["number", "number", "number"],
"transmittedBytes": ["number", "number", "number"]
}],
"sharedStoragePools": [{
"id": "string",
"totalSpace": ["number", "number", "number"],
"usedSpace": ["number", "number", "number"],
"numOfReads": ["number", "number", "number"],
"numOfWrites": ["number", "number", "number"],
"readBytes": ["number", "number", "number"],
"writeBytes": ["number", "number", "number"],
"transmittedBytes": ["number", "number", "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. Processed or Aggregated |
frequency |
Frequency at which utilization records are generated. Time (in seconds) Values: 30 for Processed metrics 300 (5 mins), 7200 (2 hours), 86400 (1 day) for Aggregated metrics |
startTimeStamp | Timestamp (in UTC format) of the oldest sample in the JSON file. Or user specified value from the query string |
endTimeStamp | Timestamp (in UTC format) of the latest sample in the JSON file. Or user specified value from the query string |
mtms | MTMS of the managed system |
name | Name of the managed system. |
uuid | Uuid of the managed system |
metricArrayOrder |
Template to represent the order used to report Avg, Min, Max values for different utilization attributes reported in aggregated and processed metrics.
Processed metrics: [“AVG”] Aggregated metrics: ["AVG","MIN","MAX"] |
utilSample | |
sampleType | Entity type of the sample. For managed system, it is ‘ManagedSystem' |
timeStamp | The time of the sample in yyyy-MM-ddTHH:mm:ssZ format |
numOfSamplesAggregated | Number of the samples rolled up to generate the aggregated or processed utilization data |
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 |
uuid | Uuid of the resource |
reportedBy | The name of the source the data is collected from. Like: PHYP, FSP, VIOS |
occurenceCount | Specifies the number of times the same error has occurred in the specified time interval. |
VIOS generic attributes | |
id | Logical partition Id |
uuid | Unique identifier of the logical partition |
name | Name of the logical partition |
state | State of the logical partition |
affinityScore |
Affinity score to indicate good or bad placement. Logical partition affinity score, unit-less value from 0 - 100 where 100 is perfect affinity placement. |
Compute Resources | |
systemFirmware: Firmware level information | |
utilizedProcUnits | Processor units utilized by PHYP for the time interval. |
assignedMem | The amount of memory (in megabytes) on the managed system that is being assigned to system firmware for a time interval. |
Processor: System Processor Utilization | |
totalProcUnits | Total processor units installed on the system |
utilizedProcUnits | Processor units utilized by all logical partitions for a specified time interval. Idle proc units are included in this parameter. |
utilizedProcUnitsDeductIdle | Processor units utilized by all logical partitions for a specified time interval. Idle proc units are deducted in this parameter. |
availableProcUnits | Number of processor units available for assignment |
configurableProcUnits |
Number of processor units that are configurable. totalProcUnits minus configurableProcUnits provides the unlicensed processor units plus the number of processors garded, processors inactive due to failure. |
Memory: System Memory Utilization | |
totalMem | Total Memory (in megabytes) installed on the system |
availableMem | Free memory (in megabytes) which is available for assignment. |
configurableMem | Configurable memory |
assignedMemToLpars | The total amount of physical memory (in megabytes) used by the system |
virtualPersistentMem | The virtual persistent memory of the system. |
sharedMemoryPool: Shared Memory Pool utilization | |
id | Memory Pool Id |
totalMem | The total amount of physical memory in the VRM pool (in megabytes). |
assignedMemToLpars |
The total amount of physical memory (in megabytes) used by all logical partitions in the shared memory pool. |
assignedMemToSysFirmware |
The amount of memory (in megabytes) in the shared memory pool that is being used by system firmware. |
totalIOMem | The total amount of I/O entitled memory (in megabytes) mapped by all logical partitions in the shared memory pool. |
mappedIOMemToLpars | The total I/O mapped memory (in megabytes) of all active logical partitions served by pool. |
physicalProcessorPool: Physical Processor Pool utilization | |
assignedProcUnits | Number of processor units assigned to the pool for a specified time interval. |
utilizedProcUnits | Number of processor units utilized by the logical partitions in the pool for a specified time interval. |
availableProcUnits | No of processor units available for assignment for the time interval |
configuredProcUnits | Configured pool size in processing units. |
borrowedProcUnits | Processing units that are borrowed from dedicated logical partitions |
sharedProcessorPool: Shared Processor Pool utilization | |
id | Shared Processor Pool Id |
name | Pool name |
assignedProcUnits | Number of processor units assigned to the pool for a specified time interval. |
utilizedProcUnits | Number of processor units utilized by the logical partitions in the pool for a specified time interval. |
availableProcUnits | No of processor units available for assignment for the time interval |
configuredProcUnits | Configured pool size in processing units |
borrowedProcUnits | Processors that are borrowed not assigned to logical partitions. Reported only for default shared processor pool. |
VIOS level attributes | |
Memory | |
assignedMem | Assigned memory to VIOS |
utilizedMem | Overall Memory Utilization (in megabytes) for the time interval |
virtualPersistentMem | Virtual persistent memory that is assigned to the VIOS for a specified time interval. |
Processor | |
poolId | Processor Pool Id. It is -1 if VIOS is in dedicated processor mode. |
weight | Processor weight of the logical partition |
mode |
The modes of the processor are as follows: Valid modes for dedicated processor -donated Valid modes for shared processor -Capped -Uncapped |
maxVirtualProcessors | Maximum virtual processors that are assigned to the logical partition in the time interval |
CurrentVirtualProcessors | Number of virtual processors that are assigned to the logical partition |
maxProcUnits | Maximum processor units assigned to the logical partition for a specified time interval |
entitledProcUnits | Entitled processor units to a logical partition for a specified time interval |
utilizedProcUnits | Total processor units utilized for a specified time interval. It is the sum of utilizedUnCappedProcUnits and utilizedCappedProcUnits. |
utilizedProcUnitsDeductIdle | Processor units utilized by all logical partitions for a specified time interval. Idle proc units are deducted in this parameter. |
utilizedCappedProcUnits | Capped processor units utilized for a specified time interval |
utilizedUncappedProcUnits | Uncapped processor units utilized for a specified time interval |
idleProcUnits | Idle processor units for a specified time interval. |
donatedProcUnits | Dedicated processor units donated by a logical partition for a specified time interval |
timeSpentWaitingForDispatch | Timebase cycles spent waiting on physical processor in the time interval |
timePerInstructionExecution | The amount of time taken for the execution of each instruction in the time interval |
Network | |
sriovAdapters and HEAdapters | |
drcIndex | DRC index of the SR-IOV adapter |
physicalPorts | Physical Ports configured under SR-IOV adapter |
id | Physical Port Id |
physicalLocation | Physical Location Code of the port |
receivedPackets | Number of packets received by the port in the time interval |
sentPackets | Number of packets sent by the port in the time interval |
droppedPackets | Number of packets dropped by a port in the time interval |
sentBytes | Number of bytes sent by a port in the time interval |
receivedBytes | Number of bytes received by a port in the time interval |
errorIn | Received Errors |
errorOut | Transmit Errors |
VIOS level attributes | |
clientLpars | List of logical partitions the VIOS has served in the time interval |
id | Id of the adapter (for genericAdapters and sharedAdapters) |
type | Type of the adapter (for genericAdapters and sharedAdapters). Valid values can be sea or virtual |
physicalLocation | Physical location of the adapter |
vlanId | VLAN Id of the virtual Ethernet Adapter |
vswitchId | Vswitch id of the virtual Ethernet Adapter |
isPortVLANID | A value of True indicates that it is a Port VLAN Id and a value of False indicates that it is one of the additional VLAN Ids |
drcIndex | DRC index of SR-IOV logical port |
physicalDrcIndex | DRC index of associated physical adapter of the SR-IOV logical port |
physicalPortId | Physical port id of associated physical adapter for the SR-IOV logical port |
clientPartitionUUID | UUID of the client partition |
vnicDeviceMode | VNIC device mode. Valid values are NonVNIC, SharedVNIC, DedicatedVNIC |
configurationType | Configuration type of the SR-IOV logical port. The configuration type can be any of these: Nonconfigured, Ethernet, FC, FCoE, RoCE |
bridgedAdapters | List of ids of generic adapters that are attached to the SEA |
receivedPackets | Number of packets received by the adapter per second for a specified time interval. |
sentPackets | Number of packets transmitted by the adapter per second for a specified time interval. |
droppedPackets | Number of packets dropped by the adapter per second for a specified time interval. |
sentBytes | Number of bytes sent by the adapter per second for a specified time interval. |
receivedBytes | Number of bytes received by the adapter per second for a specified time interval. |
receivedPhysicalPackets | Number of packets that are received by the physical adapter that is associated with lpar/vios virtual adapter per second for a specified time interval |
sentPhysicalPackets | Number of packets sent to the physical adapter associated with lpar/vios virtual adapter per second for a specified time interval |
droppedPhysicalPackets | Number of packets dropped by the physical adapter that is associated with lpar/vios virtual adapter per second for a specified time interval |
sentPhysicalBytes | Number of bytes sent to the physical adapter associated with lpar/vios virtual adapter per second for a specified time interval |
receivedPhysicalBytes | Number of bytes received by the physical adapter associated with lpar/vios virtual adapter per second for a specified time interval |
transferredBytes | Total number of bytes transferred per second for a specified time interval. It is the summation of sentBytes and receivedBytes |
transferredPhysicalBytes | Number of bytes transferred by the physical adapter for a specified time interval. It is the summation of sentPhysicalBytes and receivedPhysicalBytes |
errorIn | Received errors per second for a specified time interval |
errorOut | Transmit errors per second for a specified time interval |
Storage | |
VIOS attributes | |
clientLpars | List of logical partitions that the VIOS has served in the time interval |
id | Id of the adapter |
type | Type of the adapter |
physicalLocation | Physical Location of the adapter |
wwpn | Wwpn of the Fibre Channel adapter |
numOfReads | Number of read requests coming to the adapter per second for a specified time interval. |
numOfWrites | Number of write requests coming to the adapter per second for a specified time interval. |
readBytes | Number of bytes read through the adapter per second for a specified time interval. |
writeBytes | Number of bytes written through the adapter per second for a specified time interval. |
transmittedBytes | Number of bytes transmitted through the adapter per second for a specified time interval. It is the summation of readBytes and writeBytes |
runningSpeed | Running speed of the Fibre Channel adapter in GBPS |
sharedStoragePools | |
id | Id of the Shared Storage Pool |
totalSpace | Total space of the pool at the end of the time interval |
usedSpace | Used space of the pool at the end of time interval |