Logical Partition Processed and Aggregated Metrics JSON Specification
The JSON specification for the logical partition 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/LogicalPartition_[Logical Partition Uuid] _yyyyMMDDThhmmss+0000_ yyyyMMDDThhmmss+0000_30.json
/rest/api/pcm/AggregatedMetrics/LogicalPartition_[Logical Partition Uuid] _yyyyMMDDThhmmss+0000_ yyyyMMDDThhmmss+0000_[Tier frequency in seconds].json
PCM Processed or Aggregated metrics URI provides the following logical partition utilization data when 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"
}]
},
"lparsUtil": [{
"id": "number",
"uuid": "string",
"name": "string",
"state": "string",
"type": "string",
"osType": "string",
"affinityScore": "number",
"memory": {
"poolId": "number",
"weight": "number",
"logicalMem": ["number", "number", "number"],
"backedPhysicalMem": ["number", "number", "number"],
"totalIOMem": ["number", "number", "number"],
"mappedIOMem": ["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"],
"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": {
"virtualEthernetAdapters": [{
"physicalLocation": "string",
"vlanId": "number",
"vswitchId": "number",
"isPortVLANID": "boolean",
"viosId": "number",
"sharedEthernetAdapterId": "string",
"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",
"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": {
"genericVirtualAdapters": [{
"id": "string",
"type": "string",
"viosId": "number",
"physicalLocation": "string",
"numOfReads": ["number", "number", "number"],
"numOfWrites": ["number", "number", "number"],
"readBytes": ["number", "number", "number"],
"writeBytes": ["number", "number", "number"],
"transmittedBytes": ["number", "number", "number"]
}],
"virtualFiberChannelAdapters": [{
"id": "string",
"wwpn": "string",
"wwpn2": "string",
"physicalLocation": "string",
"physicalPortWWPN": "string",
"viosId": "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"]
}]
}
}]
}]
}
}
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"] |
sampleType | Entity type of the sample. For logical partition, it is ‘LogicalPartition’ |
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 how many times the same error has occurred in the specified time interval |
lparsUtil | |
id | Logical partition Id |
uuid | Unique identifier of the logical partition. |
name | Name of the logical partition. |
state | State of the logical partition. |
type | Type of the logical partition. The logical partition can be an AIX®, Linux®, or IBM®. |
osType | The type of operating system that is installed on 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 Resource | |
memory | |
poolId | Memory pool id if the logical partition is shared memory logical partition |
weight | Memory weight of the logical partition |
logicalMem | Minimum, maximum, and average memory in megabytes of the logical partition during the interval. |
backedPhysicalMem |
For an AMS partition, this is the number of bytes of physical memory from the Shared Memory pool that is backing the partition's logical address space. For a dedicated memory partition, this value denotes the size of the partition's logical address space (in megabytes). It gives the minimum, maximum, and average values during the interval. |
totalIOMem |
Size of memory the logical partition is entitled to I/O map (in megabytes). It gives the minimum, maximum and average values during the interval. |
mappedIOMem |
Size of memory the logical partition has I/O mapped (in megabytes). It gives the minimum, maximum and average values during the interval. |
virtualPersistentMem | Virtual persistent memory that is assigned to the logical partition during the given time interval. |
processor | |
poolId | Processor Pool Id. It is -1 if lpar is in dedicated processor mode. |
mode |
The modes of the processor are as follows: Valid modes for dedicated processor -donated Valid modes for shared processor -Capped -Uncapped |
weight | Processor weight of the logical partition |
maxVirtualProcessors | Maximum virtual processors that are assigned to the logical partition for a given time interval |
currentVirtualProcessors | Virtual processors assigned to the logical partition during the interval |
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 given time interval. It is sum of utilizedUnCappedProcUnits + utilizedCappedProcUnits - idleProcUnits. |
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 |
timePerInstructionExecution | The amount of time taken for the execution of each instruction in the time interval |
Network | |
virtualEthernetAdapters and sriovLogicalPorts | |
physicalLocation | Physical location of the adapter or SR-IOV logical port |
receivedPackets | Number of packets received by the adapter or the port in the time interval |
sentPackets | Number of packets sent by the adapter or the port in the time interval |
droppedPackets | Number of packets dropped by the adapter or the port in the time interval |
sentBytes | Number of bytes sent by the adapter or the port in the time interval |
receivedBytes | Number of bytes received by the adapter or the port in the time interval |
transferredBytes | Total number of bytes transferred per second for a specified time interval through the adapter or the port. The value is the sum of sentBytes and receivedBytes |
virtualEthernetAdapters | |
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 |
viosId | Id of the VIOS the adapter is connected to |
sharedEthernetAdapterId | Id of the shared ethernet adapter |
receivedPhysicalPackets | Number of physical packets received by the adapter for the time interval |
sentPhysicalPackets | Number of physical packets sent by the adapter for the time interval |
droppedPhysicalPackets | Number of physical packets dropped by the adapter for the time interval |
sentPhysicalBytes | Number of bytes sent to the physical adapter associated with virtual adapter. It is per second for a specified time interval. |
receivedPhysicalBytes | Number of bytes received by physical adapter associated with virtual adapter. It is per second for a specified time interval. |
transferredPhysicalBytes | Total number of bytes transferred per second for a given time interval through the physical adapter associated with virtual adapter. |
sriovLogicalPorts | |
drcIndex | DRC index of the SR-IOV logical port |
physicalDrcIndex | DRC index of the associated physical adapter of the SR-IOV logical port |
physicalPortId | Physical Port id of the associated physical adapter for the SR-IOV logical port |
vnicDeviceMode | VNIC device mode. Valid values are as follows:
|
configurationType | Configuration type of the SR-IOV logical port. The configuration type can be any of these: Nonconfigured, Ethernet, FC, FCoE, or RoCE |
errorIn | Received errors per second for a specified time interval |
errorOut | Transmit errors per second for a specified time interval |
Storage | |
genericVirtualAdapters and virtualFiberChannelAdapters | |
id | Id of the adapter |
viosId | Id of the VIOS that the adapter is connected to |
physicalLocation | Physical Location of the 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 given 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. The value is the sum of read Bytes and writeBytes |
genericVirtualAdapters | |
type | Type of the virtual adapter |
virtualFiberChannelAdapters | |
wwpn | WWPN of the Fibre Channel adapter |
Wwpn2 | WWPN2 of the Fibre Channel adapter |
physicalPortWWPN | WWPN of the physical port |
runningSpeed | Running speed of the Fibre channel adapter in GBPS |