LTM Power Hypervisor JSON Specification

Power® Hypervisor JSON Specification for Long Term Monitoring (LTM) metrics

Resource

/rest/api/pcm/ManagedSystem/[Managed System Uuid]/RawMetrics/LongTermMonitor/ LTM_[Managed System MTMS]_phyp_yyyyMMDDThhmmss+0000.json

PCM LTM URI provides the following utilization data that is fetched by the Hardware Management Console (HMC) from the Power Hypervisor (PHYP) when the LongTermMonitorEnabled configuration value for a managed system is enabled. If ComputeLTMEnabled is enabled, the application provides processor and memory metrics; it would not provide network and storage metrics. 

{
	"systemUtil": {
		"utilInfo": {
			"version": "string",
			"metricType": "string",
			"monitoringType": "string",
			"mtms": "string",
			"name": "string"
		},
		"utilSample": {
			"timeStamp": "string",
			"status": "number",
			"errorInfo": [{
				"errId": "string",
				"errMsg": "string"
			}],
			"timeBasedCycles": "number",
			"systemFirmware": {
				"utilizedProcCycles": "number",
				"assignedMem": "number"
			},
			"processor": {
				"totalProcUnits": "number",
				"configurableProcUnits": "number",
				"availableProcUnits": "number",
				"procCyclesPerSecond": "number"
			},
			"memory": {
				"totalMem": "number",
				"availableMem": "number",
				"configurableMem": "number",
				"virtualPersistentMem": "number"
			},
			"sharedMemoryPool": [{
				"id": "number",
				"name": "string",
				"totalMem": "number",
				"assignedMemToLpars": "number",
				"assignedMemToSysFirmware": "number",
				"totalIOMem": "number",
				"mappedIOMemToLpars": "number"
			}],
			"physicalProcessorPool": {
				"totalPoolCycles": "number",
				"utilizedPoolCycles": "number",
				"configurablePoolProcUnits": "number",
				"currAvailablePoolProcUnits": "number",
				"borrowedPoolProcUnits": "number"
			},
			"sharedProcessorPool": [{
				"id": "number",
				"name": "string",
				"assignedProcCycles": "number",
				"utilizedProcCycles": "number",
				"maxProcUnits": "number",
				"borrowedProcUnits": "number"
			}],
			"network": {
				"sriovAdapters": [{
					"drcIndex": "string",
					"physicalPorts": [{
						"id": "number",
						"physicalLocation": "string",
						"receivedPackets": "number",
						"sentPackets": "number",
						"droppedSentPackets": "number",
						"droppedReceivedPackets": "number",
						"sentBytes": "number",
						"receivedBytes": "number",
						"errorIn": "number",
						"errorOut": "number"
					}]
				}],
				"HEAdapters": [{
					"drcIndex": "string",
					"physicalLocation": "string",
					"physicalPorts": [{
						"id": "number",
						"physicalLocation": "string",
						"receivedPackets": "number",
						"sentPackets": "number",
						"droppedPackets": "number",
						"sentBytes": "number",
						"receivedBytes": "number"
					}]
				}]
			},
			"lparsUtil": [{
				"id": "number",
				"uuid": "string",
				"type": "string",
				"osType": "string",
				"name": "string",
				"state": "string",
				"migrationState": "string",
				"affinityScore": "number",
				"memory": {
					"poolId": "number",
					"weight": "number",
					"logicalMem": "number",
					"backedPhysicalMem": "number",
					"totalIOMem": "number",
					"mappedIOMem": "number",
					"virtualPersistentMem": "number"
				},
				"processor": {
					"poolId": "number",
					"mode": "string",
					"maxVirtualProcessors": "number",
					"currentVirtualProcessors": "number",
					"maxProcUnits": "number",
					"weight": "number",
					"entitledProcCycles": "number",
					"entitledProcUnits": "number",
					"utilizedCappedProcCycles": "number",
					"utilizedUnCappedProcCycles": "number",
					"idleProcCycles": "number",
					"donatedProcCycles": "number",
					"timeSpentWaitingForDispatch": "number",
					"totalInstructions": "number",
					"totalInstructionsExecutionTime": "number"
				},
				"network": {
					"virtualEthernetAdapters": [{
						"vlanId": "number",
						"vswitchId": "number",
						"physicalLocation": "string",
						"isPortVLANID": "boolean",
						"receivedPackets": "number",
						"sentPackets": "number",
						"droppedPackets": "number",
						"sentBytes": "number",
						"receivedBytes": "number",
						"receivedPhysicalPackets": "number",
						"sentPhysicalPackets": "number",
						"droppedPhysicalPackets": "number",
						"sentPhysicalBytes": "number",
						"receivedPhysicalBytes": "number"		
					}],
					"sriovLogicalPorts": [{
						"drcIndex": "string",
						"physicalDrcIndex": "string",
						"physicalPortId": "number",
						"clientPartitionUUID": "string",
						"vnicDeviceMode": "string",
						"configurationType": "string",
						"physicalLocation": "string",
						"receivedPackets": "number",
						"sentPackets": "number",
						"droppedSentPackets": "number",
						"droppedReceivedPackets": "number",
						"sentBytes": "number",
						"receivedBytes": "number",
						"errorIn": "number",
						"errorOut": "number"
					}]
				},
				"Storage": {
					"virtualFiberChannelAdapters": [{
						"viosId": "number",
						"wwpnPair": ["wwpn1", "wwpn2"],
						"physicalLocation": "string"
					}],
					"genericVirtualAdapters": [{
						"physicalLocation": "string",
						"viosId": "number",
						"viosAdapterSlotId": "number"
					}]
				}
			}],
			"viosUtil": [{
				"id": "number",
				"uuid": "string",
				"name": "string",
				"state": "string",
				"affinityScore": "number",
				"memory": {
					"assignedMem": "number",
					"virtualPersistentMem": "number"
				},
				"processor": {
					"poolId": "number",
					"mode": "string",
					"maxVirtualProcessors": "number",
					"currentVirtualProcessors": "number",
					"maxProcUnits": "number",
					"weight": "number",
					"entitledProcCycles": "number",
					"entitledProcUnits": "number",
					"utilizedCappedProcCycles": "number",
					"utilizedUnCappedProcCycles": "number",
					"idleProcCycles": "number",
					"donatedProcCycles": "number",
					"timeSpentWaitingForDispatch": "number",
					"totalInstructions": "number",
					"totalInstructionsExecutionTime": "number"
				},
				"network": {
					"virtualEthernetAdapters": [{
						"vlanId": "number",
						"vswitchId": "number",
						"physicalLocation": "string",
						"isPortVLANID": "boolean",
						"receivedPackets": "number",
						"sentPackets": "number",
						"droppedPackets": "number",
						"sentBytes": "number",
						"receivedBytes": "number",
						"receivedPhysicalPackets": "number",
						"sentPhysicalPackets": "number",
						"droppedPhysicalPackets": "number",
						"sentPhysicalBytes": "number",
						"receivedPhysicalBytes": "number"		
					}],
					"sriovLogicalPorts": [{
						"drcIndex": "string",
						"physicalDrcIndex": "string",
						"physicalPortId": "number",
						"clientPartitionUUID": "string",
						"vnicDeviceMode": "string",
						"configurationType": "string",
						"physicalLocation": "string",
						"receivedPackets": "number",
						"sentPackets": "number",
						"droppedSentPackets": "number",
						"droppedReceivedPackets": "number",
						"sentBytes": "number",
						"receivedBytes": "number",
						"errorIn": "number",
						"errorOut": "number"
					}]
				}
			}]
		}
	}
}
The following table provides the details of the metric parameters.
Table 1. Description of metric parameters
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 of the parameter is Raw
monitoringType Type of Monitoring. For Long Term Metrics, the value is LTM. For Short Term Metrics, the value is STM.
mtms Machine Type, Model, and Serial number of the managed system
name Name 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
LPAR / VIOS generic attributes
Id Logical partition Id
Uuid Unique identifier of the logical partition
name Name of the logical partition
type It shows whether this is AIX®, Linux®, or IBM® i partition. Not required for VIOS utilization as the block heading shows that it is of VIOS type
affinityScore Affinity score to indicate good or bad placement. Logical partition affinity score is a unit-less value from 0-100 and, where 100 is perfect affinity placement
State State of the logical partition
MigrationState The migration state of the logical partition.
Compute Resources
timeBasedCycles The processing start time in cycles since PHYP IPL
systemFirmware: Firmware level information
utilizedProcCycles Cycles utilized by PHYP since the IPL
assignedMem The amount of memory (in megabytes) on the managed system that is being assigned to system firmware
Processor: System Processor Utilization
totalProcUnits Total processing units installed on the system
availableProcUnits Number of processing units available for assignment
configurableProcUnits

Number of processing units that are configurable

The difference value between totalProcUnits and configurableProcUnits provides the unlicensed processing units and the number of processors garded, processors inactive due to failure.
procCyclesPerSecond Cycles per second on one processor
Note: This value is static per server
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
virtualPersistentMem Total virtual persistent memory that is installed on the system.
sharedMemoryPool: Shared Memory Pool utilization
id Memory Pool Id
name Memory Pool name
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) currently mapped by all the 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
totalPoolCycles Total cycles assigned to the pool since PHYP IPL
utilizedPoolCycles Cycles utilized by the logical partitions in the pool since PHYP IPL
configurablePoolProcUnits Configured pool size in processing units
currAvailablePoolProcUnits Currently available processing units
borrowedPoolProcUnits Processing units that are borrowed from dedicated partitions
sharedProcessorPool: Shared Processor Pool utilization
id Shared Processor Pool Id
Name Pool Name
assignedProcCycles Total cycles assigned to the pool since PHYP IPL.
utilizedProcCycles Cycles utilized by the logical partitions in the pool since PHYP IPL.
maxProcUnits Maximum processing units that can be configured. This is summation of configured pool size in processing units and borrowedProcUnits
borrowedProcUnits Processors that are borrowed not assigned to logical partitions. Reported only for default shared processor pool.
LPAR / VIOS level attributes
Memory
poolId Memory pool Id. It is -1 if the memory mode is dedicated
weight Memory weight of the logical partition
logicalMem Current® memory size in megabytes
backedPhysicalMem For an AMS partition, this value 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 will be the size of the partition's logical address space (in megabytes).
totalIOMem Size of memory the logical partition is entitled to I/O map (in megabytes).
mappedIOMem Size of memory the logical partition has I/O mapped (in megabytes).
assignedMem Assigned memory to VIOS
virtualPersistentMem Total virtual persistent memory that is assigned to a logical partition.
Processor
poolId Processor Pool Id. It is -1 if lpar is in dedicated processor mode.
mode

The mode of the processor is as follows:

The value for dedicated processor is donated and the values for shared processors are:
  • capped
  • uncapped
maxVirtualProcessors Maximum virtual processors assigned to the logical partition
currentVirtualProcessors The current value of the virtual processors that are assigned to a logical partition.
maxProcUnits Maximim processing units assigned to the logical partition
weight Processor weight of the logical partition
entitledProcCycles Cycles entitled to this logical partition since PHYP IPL.
entitledProcUnits The current processing units that are assigned to the logical partition
utilizedUnCappedProcCycles Uncapped cycles utilized by this logical partition since PHYP IPL.
utilizedCappedProcCycles Capped cycles utilized by this logical partition since PHYP IPL.
idleProcCycles Partition collected cycles that the logical partition considers as idle cycles since PHYP IPL
donatedProcCycles Dedicated cycles donated by this logical partition since PHYP IPL
timeSpentWaitingForProcessor Timebase cycles spent waiting on uncapped capacity or configured processor entitlement since LPAR IPL
totalInstructions The number of instructions performed by the logical partition since the managed system was started. This attribute will be reported only for P8 systems.
totalInstructionsExecutionTime The amount of time instruction counts were collected since the managed system was started. This attribute is reported only for P8 systems.
Network
sriovAdapters & 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. It is a counter type since PHYP IPL
sentPackets Number of packets sent by the port. It is a counter type since PHYP IPL
droppedSentPackets Number of sent packets dropped by the port since PHYP IPL
droppedReceivedPackets Number of received packets dropped by the port since PHYP IPL
sentBytes Number of bytes sent by a port since PHYP IPL
receivedBytes Number of bytes received by a port since PHYP IPL
errorIn Received Errors
errorOut Transmit Errors
droppedPackets Number of packets that are dropped by a port since PHYP IPL
LPAR / VIOS level attributes
virtualEthernetAdapters & sriovLogicalPorts
vlanId VLAN Id of the virtual Ethernet Adapter
vswitchId Vswitch id of the virtual Ethernet Adapter
physicalLocation Physical location code
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
physicalPortId Physical Port id of associated physical adapter.
receivedPhysicalPackets Number of packets received by the physical adapter associated with LPAR or VIOS virtual adapter since PHYP IPL
sentPhysicalPackets Number of packets sent to the physical adapter associated with LPAR or VIOS virtual adapter since PHYP IPL
droppedPhysicalPackets Number of packets dropped by the physical adapter associated with LPAR or VIOS virtual adapter since PHYP IPL
sentPhysicalBytes Number of bytes sent to the physical adapter associated with LPAR or VIOS virtual adapter since PHYP IPL
receivedPhysicalBytes Number of bytes received by the physical adapter associated with LPAR or VIOS virtual adapter since PHYP IPL
clientPartitionUUID Attribute available for VNIC. It is the UUID of the client Partition
vnicDeviceMode The values can be any of the following:
  • NonVNIC
  • SharedVNIC
  • DedicatedVNIC
configurationType The values can be any of the following:
  • Nonconfigured
  • Ethernet
  • FC
  • FCoE
  • RoCE
Storage
virtualFiberChannelAdapters & genericVirtualAdapters
viosId Corresponding VIOS Id the adapter is attached to
physicalLocation Physical location of the adapter
wwpnPair WWPN pair associated with the FC adapter
viosAdapterSlotId Slot id of the VIOS the adapter is attached to