Entities, lookup information, metrics, and API calls for Nutanix - Prism API Extractor
This topic explains the predefined metrics that are available from Nutanix and how they are mapped to the BMC Helix Continuous Optimization metrics.
Entity list
The Nutanix - Prism API Extractor collects metrics of the following entities:
- Cluster
- Host
- Virtual Machine
- Storage Pool
- Project
Lookup information
The following table lists the sequence of field sets for strong lookup and weak lookup.
Entity | BMC Helix Continuous OptimizationEntity name | Entity type | Strong lookup fields |
|---|---|---|---|
Cluster | Cluster - Acropolis | vhc:ahv | UUID |
Host | Host - Acropolis | vh:ahv | UUID |
VM | Virtual Machine - Acropolis | gm:ahv | UUID |
Storage Pool | Storage Pool - Acropolis | sp:ahv | UUID |
Metric mapping
The following tables contain the mapping between the Nutanix metrics and the BMC Helix Continuous Optimization metrics.
Configuration metrics for Cluster
BMC Helix Continuous Optimizationmetric | Nutanix API field |
|---|---|
TIMEZONE | timezone |
HOST_NUM | num_nodes |
NET_IP_ADDRESS | cluster_external_ipaddress |
CLUSTER_NAME | name |
DISK_NUM | disks(count) |
TOTAL_REAL_MEM | SUM of underlying hosts memory_capacity_in_bytes |
CPU_NUM | Sum of underlying hosts num_cpu_cores |
CPU_MHZ | Sum of underlying hosts cpu_capacity_in_hz / Sum of underlying hosts num_cpu_cores host.cpu_capacity_in_hz, host.num_cpu_cores |
CPU_TOTAL_MHZ | Sum of underlying hosts cpu_capacity_in_hz |
Configuration metrics for Host
BMC Helix Continuous Optimizationmetric | Nutanix API field |
|---|---|
CLUSTER_ID | cluster_uuid |
CLUSTER NAME | cluster.name |
CPU_TOTAL_MHZ | cpu_capacity_in_hz |
CPU_MHZ | cpu_frequency_in_hz |
CPU_MODEL | cpu_model |
BYDISK_SIZE | disk.disk_size |
DISK_NUM | disks(count) |
NET_IP_ADDRESS | hypervisor_address |
TOTAL_REAL_MEM | memory_capacity_in_bytes |
CPU_CORES_PER_SOCKET | num_cpu_cores/num_cpu_sockets |
CPU_THREADS_PER_CORE | num_cpu_threads/num_cpu_cores |
SERIAL_NUMBER | serial |
CPU_NUM | num_cpu_cores |
| MAINTENANCE_MODE | host_in_maintenance_mode |
Configuration metrics for Virtual Machine
BMC Helix Continuous Optimizationmetric | Nutanix API field |
|---|---|
VM_LAST_STATUS | powerState |
HOST_ID | hostUuid |
CLUSTER_ID | clusterUuid |
CLUSTER NAME | cluster.name |
TOTAL_REAL_MEM | memoryCapacityInBytes |
CPU_NUM | numVCpus |
NETIF_NUM | numNetworkAdapters |
NET_IP_ADDRESS/ NET_IP_ADDRESSES | ipAddresses |
CPU_MHZ | host.cpu_frequency_in_hz |
CPU_TOTAL_MHZ | host.cpu_frequency_in_hz numVCpus |
| TOTAL_DSTORE_SIZE | diskCapacityInBytes |
Configuration metrics for Storage Pool
BMC Helix Continuous Optimizationmetric | Nutanix API field |
|---|---|
CLUSTER_ID | clusterUuid |
| CLUSTER_NAME | cluster.name |
DISK_NUM | disks (count) |
Configuration metrics for Project
BMC Helix Continuous Optimizationmetric | Description | Nutanix API field |
|---|---|---|
CPU_NUM | Sum of virtual machines under a project | NA |
TOTAL_REAL_MEMORY | Sum of virtual machines under a project | NA |
Performance metrics
Performance metrics for Cluster
BMC Helix Continuous Optimizationmetric | Nutanix metric | Formula | Description |
|---|---|---|---|
CPU_UTIL | hypervisor_cpu_usage_ppm | hypervisor_cpu_usage_ppm/1000000 | Percentage of time the CPU was not idle during the interval |
MEM_UTIL | hypervisor_memory_usage_ppm | hypervisor_memory_usage_ppm/1000000 | Percentage of physical memory in use during the interval |
GM_NUM | vms(count) |
| Number of Guest Machines |
| GM_ON_NUM | vms(count) | Number of powered on Guest Machines | |
DISK_TOTAL_LATENCY | avg_io_latency_usecs | avg_io_latency_usecs/1000 | The disk total latency. |
DISK_IO_RATE | num_iops |
| Disk Average I/O Rate aggregated by host |
DISK_IO_READ_RATE | num_read_iops |
| Disk Average I/O Read Rate aggregated by host |
DISK_IO_WRITE_RATE | num_write_iops |
| Disk Average I/O Write Rate aggregated by host |
DISK_TRANSFER_RATE | total_io_size_kbytes | (total_io_size_kbytes*1024)/3600 | The average number of bytes per second at which data was transferred. |
DISK_READ_RATE | total_read_io_size_kbytes | (total_read_io_size_kbytes*1024)/3600 | The average Bytes per second read from the disk device during the interval. |
DISK_WRITE_RATE | total_io_size_kbytes total_read_io_size_kbytes | (total_io_size_kbytes-total_read_io_size_kbytes)*1024/3600 | The average Bytes per second write to disk device during the interval. |
TOTAL_DSTORE_SIZE | storage.capacity_bytes |
| The sum of the size of the datastores used by this system in bytes. |
TOTAL_DSTORE_FREE | storage.free_bytes |
| The sum of the free space of all the datastores used by this system in bytes. |
TOTAL_DSTORE_USED | storage.usage_bytes |
| Total physical datastore space used by this machine and all its snapshots on the datastores. |
TOTAL_DSTORE_UTIL | storage.usage_bytes storage.capacity_bytes | storage.usage_bytes/storage.capacity_bytes | Total physical storage space utilization % on this system. |
CPU_UTILMHZ | hypervisor_cpu_usage_ppm | (hypervisor_cpu_usage_ppm/1000000) * CPU_TOTAL_MHZ | Average number of MHz the CPU was not idle during the interval |
| VCPU_NUM | Computed as the sum of vCPUs of all VMs in the cluster | Total number of provisioned virtual CPUs in the cluster | |
| VCPU_ON_NUM | Computed as the sum of vCPUs of only the powered-on VMs | Total vCPUs actively in use by running VMs in the cluster |
Performance metrics for Host
BMC Helix Continuous Optimizationmetric | Nutanix metric | Formula | Description |
|---|---|---|---|
CPU_UTIL | hypervisor_cpu_usage_ppm | hypervisor_cpu_usage_ppm/1000000 | Percentage of time the CPU was not idle during the interval. |
MEM_UTIL | hypervisor_memory_usage_ppm | hypervisor_memory_usage_ppm/1000000 | Percentage of physical memory in use during the interval. |
GM_NUM | num_vms |
| Number of Guest Machines |
DISK_TOTAL_LATENCY | avg_io_latency_usecs | avg_io_latency_usecs/1000 | The disk total latency |
DISK_IO_RATE | num_iops |
| Disk Average I/O Rate aggregated by host |
DISK_IO_READ_RATE | num_read_iops |
| Disk Average I/O Read Rate aggregated by host |
DISK_IO_WRITE_RATE | num_write_iops |
| Disk Average I/O Write Rate aggregated by host |
DISK_TRANSFER_RATE | total_io_size_kbytes | (total_io_size_kbytes*1024)/3600 | The average number of bytes per second at which data was transferred |
DISK_READ_RATE | total_read_io_size_kbytes | total_read_io_size_kbytes*1024)/3600 | The average Bytes per second read from disk device during the interval |
DISK_WRITE_RATE | total_io_size_kbytes total_read_io_size_kbytes | (total_io_size_kbytes-total_read_io_size_kbytes)*1024/3600 | The average Bytes per second write to disk device during the interval |
TOTAL_DSTORE_SIZE | storage.capacity_bytes |
| The sum of the size of the datastores used by this system in bytes. |
TOTAL_DSTORE_FREE | storage.free_bytes |
| The sum of the free space of all the datastores used by this system in bytes. |
TOTAL_DSTORE_USED | storage.usage_bytes |
| Total physical datastore space used by this machine and all its snapshots on the datastores. |
TOTAL_DSTORE_UTIL | storage.usage_bytes storage.capacity_bytes | storage.usage_bytes/storage.capacity_bytes | Total physical storage space utilization % on this cloud system. |
CPU_UTILMHZ | hypervisor_cpu_usage_ppm | (hypervisor_cpu_usage_ppm/1000000) * CPU_TOTAL_MHZ | Average number of MHz the CPU was not idle during the interval |
| VCPU_NUM | Manually computed as the sum of vCPUs of all VMs on the host | Total vCPUs provisioned on the host | |
| VCPU_ON_NUM | Sum of vCPUs of Powered On VMs only | Total active vCPUs on the host | |
| GM_ON_NUM | Count of VMs in the Powered On state | Number of active VMs on the host |
Performance metrics for Virtual Machine
BMC Helix Continuous Optimizationmetric | Nutanix metric | Formula | Description |
|---|---|---|---|
CPU_UTIL | hypervisor_cpu_usage_ppm | hypervisor_cpu_usage_ppm/1000000 | Percentage of time the CPU was not idle during the interval. |
CPU_READY | hypervisor.cpu_ready_time_ppm | hypervisor.cpu_ready_time_ppm/1000000 | Percentage of time the CPU was in Ready state during the interval |
DISK_TOTAL_LATENCY | controller_avg_io_latency_usecs | controller_avg_io_latency_usecs/1000 | The disk total latency |
DISK_IO_READ_RATE | controller_num_read_iops |
| Disk Average I/O Read Rate aggregated by host |
DISK_IO_WRITE_RATE | controller_num_write_iops |
| Disk Average I/O Write Rate aggregated by host |
DISK_IO_RATE | controller_num_iops |
| Disk Average I/O Rate aggregated by host |
DISK_TRANSFER_RATE | controller_total_io_size_kbytes | controller_total_io_size_kbytes*1024/3600 | The average number of bytes per second at which data was transferred |
DISK_READ_RATE | controller_total_read_io_size_kbytes | controller_total_read_io_size_kbytes*1024/3600 | The average Bytes per second read from disk device during the interval |
DISK_WRITE_RATE | controller_total_io_size_kbytes controller_total_read_io_size_kbytes | (controller_total_io_size_kbytes-controller_total_read_io_size_kbytes)*1024/3600 | The average Bytes per second write to disk device during the interval |
MEM_UTIL | guest.memory_usage_ppm | guest.memory_usage_ppm/1000000 | Percentage of physical memory in use during the interval. |
MEM_USED | guest.memory_usage_ppm TOTAL_REAL_MEM | (guest.memory_usage_ppm/1000000) * TOTAL_REAL_MEM | The total used memory, in bytes |
MEM_FREE | guest.memory_usage_ppm TOTAL_REAL_MEM | TOTAL_REAL_MEM - ((guest.memory_usage_ppm/1000000) * TOTAL_REAL_MEM) | The total free memory, in bytes |
MEM_REAL_UTIL | memory_usage_ppm | memory_usage_ppm/1000000 | The percentage of memory excluding file system cache and buffers in use |
MEM_REAL_USED | memory_usage_ppm TOTAL_REAL_MEM | (memory_usage_ppm/1000000) * TOTAL_REAL_MEM | The total memory excluding file system cache and buffers in use |
NET_IN_BIT_RATE | hypervisor_num_received_bytes | (hypervisor_num_received_bytes * 8)/interval | Average Bit/s received |
NET_OUT_BIT_RATE | hypervisor_num_transmitted_bytes | (hypervisor_num_transmitted_bytes * 8)/interval | Average Bit/s sent |
NET_BIT_RATE | hypervisor_num_received_bytes hypervisor_num_transmitted_bytes | ((hypervisor_num_received_bytes+hypervisor_num_transmitted_bytes) * 8)/interval | Average Bit/s sent and received |
| NET_BYTE_RATE | hypervisor_num_received_bytes hypervisor_num_transmitted_bytes | (hypervisor_num_received_bytes+hypervisor_num_transmitted_bytes)/interval | Average Bytes per Second sent and received |
CPU_UTILMHZ | hypervisor_cpu_usage_ppm CPU_TOTAL_MHZ | (hypervisor_cpu_usage_ppm/1000000) * CPU_TOTAL_MHZ | Average number of MHz the CPU was not idle during the interval |
| TOTAL_DSTORE_USED | controller_user_bytes | Extracted from Nutanix | Physical datastore used |
| TOTAL_DSTORE_FREE | controller_user_bytes, TOTAL_DSTORE_SIZE | TOTAL_DSTORE_SIZE - controller_user_bytes
| Estimated free space in the VM's datastore |
| TOTAL_DSTORE_UTIL | controller_user_bytes, TOTAL_DSTORE_SIZE | controller_user_bytes / TOTAL_DSTORE_SIZE | utilization % of the VM's datastore |
Performance metrics for Storage Pool
BMC Helix Continuous Optimizationmetric | Nutanix metric | Formula | Description |
|---|---|---|---|
DISK_TOTAL_LATENCY | avg_io_latency_usecs | avg_io_latency_usecs/1000 |
|
DISK_IO_RATE | num_iops |
| Disk Average I/O Rate aggregated by host. |
DISK_IO_READ_RATE | num_read_iops |
| Disk Average I/O Read Rate aggregated by host |
DISK_IO_WRITE_RATE | num_write_iops |
| Disk Average I/O Write Rate aggregated by host |
DISK_TRANSFER_RATE | total_io_size_kbytes | (total_io_size_kbytes*1024)/3600 | The average number of bytes per second at which data was transferred |
DISK_READ_RATE | total_read_io_size_kbytes | (total_read_io_size_kbytes*1024)/3600 | The average Bytes per second read from disk device during the interval |
DISK_WRITE_RATE | total_io_size_kbytes total_read_io_size_kbytes | (total_io_size_kbytes-total_read_io_size_kbytes)*1024/3600 | The average Bytes per second write to disk device during the interval |
TOTAL_DSTORE_SIZE | storage.capacity_bytes |
| The sum of the size of the datastores used by this system in bytes. |
TOTAL_DSTORE_FREE | storage.free_bytes |
| The sum of the free space of all the datastores used by this system in bytes. |
TOTAL_DSTORE_USED | storage.usage_bytes |
| Total physical datastore space used by this machine and all its snapshots on the datastores. |
TOTAL_DSTORE_UTIL | storage.usage_bytes storage.capacity_bytes | storage.usage_bytes/storage.capacity_bytes | Total physical storage space utilization % on this cloud system. |
API calls for Nutanix - Prism API Extractor
The extractor makes the following REST API calls on the Nutanix Acropolis Hypervisor (AHV):
Task | Service Management API call |
|---|---|
Get cluster list | GET https://<prism_host>:<prism_port>/api/nutanix/v3/clusters/list |
Get clusters | GET https://<prism_host>:<prism_port>/PrismGateway/services/rest/v2.0/clusters |
Get cluster stats | GET https://<prism_host>:<prism_port>/PrismGateway/services/rest/v2.0/clusters/<cluster_id>/stats?metrics=%s&start_time_in_usecs=%s&end_time_in_usecs=%s&interval_in_secs=%s |
Get hosts | GET https://<prism_host>:<prism_port>/PrismGateway/services/rest/v2.0/hosts |
Get host stats | GET https://<prism_host>:<prism_port>/PrismGateway/services/rest/v2.0/hosts/<host_id>/stats?metrics=%s&start_time_in_usecs=%s&end_time_in_usecs=%s&interval_in_secs=%s |
Get virtual machines | GET https://<prism_host>:<prism_port>/PrismGateway/services/rest/v1/vms |
Get virtual machine stats | GET https://<prism_host>:<prism_port>/PrismGateway/services/rest/v1/vms/<vm_id>/stats?metrics=%s&startTimeInUsecs=%s&endTimeInUsecs=%s&intervalInSecs=%s |
Get disks | GET https://<prism_host>:<prism_port>/PrismGateway/services/rest/v2.0/disks |
Get storage pools | GET https://<prism_host>:<prism_port>PrismGateway/services/rest/v1/storage_pools |
Get storage pool stats | GET https://<prism_host>:<prism_port>/PrismGateway/services/rest/v1/storage_pools/<storage_pool_id>/stats?metrics=%s&startTimeInUsecs=%s&endTimeInUsecs=%s&intervalInSecs=%s |
Related topic