VMware vCenter

Data Collection Setup

Metrics are collected via REST API for Clusters, Hosts, Virtual Machines and Datastores from vCenter servers in a VMware vSphere environment.

Network Requirements

Port: 443 (TCP) Default HTTPS connection to the vCenter server

Least Privileged User

Role: Read Only assigned to a vSphere User with permissions to the vCenter server, cluster and all subsequent resources being monitored. See "svc_vmware_ro" for an example

Supported Versions

vSphere vCenter Server:

Connection Parameters

Name	Required?	Description
Host	Required	The VMware vCenter host to connect to.
Port		The port for communication to VMware vCenter.
Username	Required
Password	Required
SSL Configuration		The SSL mode to use when connecting to the target. Can be configured to not use SSL (No SSL), use SSL but do not verify the target's certificate (No Verify), and use SSL and verify the target's certificate (Verify).
Enable Performance Counters		Performance counters will be collected if enabled. If an environment has more than 2000 VMs, disabling performance counters is recommended to reduce collection time.
Performance Counter Query Timeout (seconds)		The number of seconds to allow for a performance counter query to return a response.
SDK Path		The endpoint to append to the url to access the vCenter SDK.
Connection Timeout (seconds)		The number of seconds to allow for connecting to the target.

Metrics

Cluster

Name	Description
Available CPU (Megahertz)	The Available CPU of the Cluster.
Available Memory (Bytes)	The Available Memory of the Cluster.
Cluster Name	The Cluster Name of the Cluster.
CPU Cores	The CPU Cores of the Cluster.
CPU Threads (Threads)	The CPU Threads of the Cluster.
Datacenter Name	The Datacenter of the Cluster.
Effective CPU (Megahertz)	The Effective CPU of the Cluster.
Effective Hosts	The Effective Hosts of the Cluster.
Effective Memory (Megabytes)	The Effective Memory of the Cluster.
Hosts	The Hosts of the Cluster.
Related Hosts	The Related Hosts of the Cluster.
Status	The Status of the Cluster.

Datacenter

Name	Description
Average Host CPU Utilization (%)	The Average Host CPU Utilization of the Datacenter.
Clusters In Green	The Clusters In Green of the Datacenter.
Clusters In Grey	The Clusters In Grey of the Datacenter.
Clusters In Red	The Clusters In Red of the Datacenter.
Clusters In Yellow	The Clusters In Yellow of the Datacenter.
CPUs	The CPUs of the Datacenter.
Datastores In Green	The Datastores In Green of the Datacenter.
Datastores In Grey	The Datastores In Grey of the Datacenter.
Datastores In Red	The Datastores In Red of the Datacenter.
Datastores In Yellow	The Datastores In Yellow of the Datacenter.
Disk Space (Terabytes)	The Disk Space of the Datacenter.
Host Systems	The Host Systems of the Datacenter.
Hosts In Green	The Hosts In Green of the Datacenter.
Hosts In Grey	The Hosts In Grey of the Datacenter.
Hosts In Red	The Hosts In Red of the Datacenter.
Hosts In Yellow	The Hosts In Yellow of the Datacenter.
Name	The Name of the Datacenter.
Network Adapters	The Network Adapters of the Datacenter.
Powered Off Hosts	The Powered Off Hosts of the Datacenter.
Powered On Hosts	The Powered On Hosts of the Datacenter.
Virtual Machines	The Virtual Machines of the Datacenter.
Virtual Machines In Green	The Virtual Machines In Green of the Datacenter.
Virtual Machines In Grey	The Virtual Machines In Grey of the Datacenter.
Virtual Machines In Red	The Virtual Machines In Red of the Datacenter.
Virtual Machines In Yellow	The Virtual Machines In Yellow of the Datacenter.

Datastore

Name	Description
Accessible	The Accessible of the Datastore.
Datacenter Name	The Datacenter of the Datastore.
Datastore Name	The Datastore Name of the Datastore.
Disk Names	The disk names of the Datastore. Only applies to VMFS datastores.
Free Space (Bytes)	The Free Space of the Datastore.
Related Hosts	The Related Hosts of the Datastore.
Space Utilization (%)	The Space Utilization of the Datastore.
Space Utilization Ratio	The Space Utilization Ratio of the Datastore.
Status	The Status of the Datastore.
Total Space (Bytes)	The Total Space of the Datastore.
Type	The Type of the Datastore.
URL	The URL of the Datastore.
Used Space (Bytes)	The Used Space of the Datastore.

Host System

Name	Description
Average CPU Speed (Megahertz)	The Average CPU Speed of the Host System.
Bus Resets	The Bus Resets of the Host System.
Cluster Name	The Cluster Name of the Host System.
Commands	The Commands of the Host System.
CPU Cores	The CPU Cores of the Host System.
CPU Model	The CPU Model of the Host System.
CPU Reserved Capacity (Megahertz)	The CPU Reserved Capacity of the Host System.
CPU Total (Megahertz)	The CPU Total of the Host System.
CPU Utilization (%)	The CPU Utilization of the Host System.
CPU Utilization Ratio	The CPU Utilization Ratio of the Host System.
CPUs	The CPUs of the Host System.
Datacenter Name	The Datacenter of the Host System.
Disk Commands Aborted	The Commands Aborted of the Host System.
Disk Kernel Latency (Milliseconds)	The Disk Kernel Latency of the Host System.
Disk Queue Latency (Milliseconds)	The Disk Queue Latency of the Host System.
Disk Read Latency (Milliseconds)	The Disk Read Latency of the Host System.
Disk Read Throughput (Kilobytes per Second)	The Read Throughput of the Host System.
Disk Throughput (Kilobytes per Second)	The Disk Throughput of the Host System.
Disk Total Latency (Milliseconds)	The Disk Total Latency of the Host System.
Disk Write Latency (Milliseconds)	The Disk Write Latency of the Host System.
Disk Write Throughput (Kilobytes per Second)	The Write Throughput of the Host System.
Host Name	The Host System Name of the Host System.
In Maintenance Mode	The In Maintenance Mode of the Host System.
MAC Addresses	The MAC addresses of the Host System.
Memory Swap In Rate (Kilobytes per Second)	The Swapin Rate of the Host System.
Memory Swap Out Rate (Kilobytes per Second)	The Swapout Rate of the Host System.
Memory Utilization (%)	The Memory Utilization of the Host System.
Memory Utilization Ratio	The Memory Utilization Ratio of the Host System.
Model	The Model of the Host System.
Network Adapters	The Network Adapters of the Host System.
Network Dropped Received Packets (Packets)	The Dropped Received Packets of the Host System.
Network Dropped Transmitted Packets (Packets)	The Dropped Transmitted Packets of the Host System.
Network Received Packets (Packets)	The Received Packets of the Host System.
Network Received Throughput (Kilobytes per Second)	The Received Throughput of the Host System.
Network Transmitted Packets (Packets)	The Transmitted Packets of the Host System.
Network Transmitted Throughput (Kilobytes per Second)	The Transmitted Throughput of the Host System.
Power State	The Power State of the Host System.
Product Type	The Product Type of the Host System.
Product Version	The Product Version of the Host System.
Reboot Required	The Reboot Required of the Host System.
Related VMs	The of the Host System.
Status	The Status of the Host System.
Total Memory (Bytes)	The Total Memory of the Host System.
Used CPU (Megahertz)	The Used CPU of the Host System.
Used Memory (Megabytes)	The Used Memory of the Host System.
UUID	The UUID of the Host System.
Vendor	The Vendor of the Host System.
VMotion Enabled	The VMotion Enabled of the Host System.

Resource Pool

Name	Description
Active Guest Memory Usage (Megabytes)	The Active Guest Memory of the Resource Pool.
Balloon Memory Size (Megabytes)	The Balloon Memory Size of the Resource Pool.
Consumed Host Memory Usage (Megabytes)	The Consumed Host Memory of the Resource Pool.
Consumed Overhead Memory (Megabytes)	The Consumed Overhead Memory of the Resource Pool.
CPU Reservation (Megahertz)	The CPU Reservation of the Resource Pool.
CPU Shares	The CPU Shares of the Resource Pool.
CPU Shares Level	The CPU Shares Level of the Resource Pool.
CPU Usage (Megahertz)	The CPU Usage of the Resource Pool.
Datacenter Name	The Datacenter of the Resource Pool.
Memory Reservation (Megabytes)	The Memory Reservation of the Resource Pool.
Memory Shares	The Memory Shares of the Resource Pool.
Memory Shares Level	The Memory Shares Level of the Resource Pool.
Private Memory (Megabytes)	The Private Memory of the Resource Pool.
Resource Pool Name	The Resource Pool Name of the Resource Pool.
Shared Memory (Megabytes)	The Shared Memory of the Resource Pool.
Swapped Memory (Megabytes)	The Swapped Memory of the Resource Pool.

Virtual Machine

Name	Description
Ballooned Memory (Megabytes)	The Ballooned Memory of the Virtual Machine.
CPU Ready (%)	The CPU Ready of the Virtual Machine.
CPU Ready Rate	The CPU Ready Rate of the Virtual Machine.
CPU Ready Raw	The CPU Ready Raw of the Virtual Machine.
CPU Usage (Megahertz)	The CPU Usage of the Virtual Machine.
CPU Usage Raw (%)	The CPU Usage Raw of the Virtual Machine.
CPU Used (%)	The CPU Used of the Virtual Machine.
Datacenter Name	The Datacenter of the Virtual Machine.
Disk Read Latency (Milliseconds)	The Disk Read Latency of the Virtual Machine.
Disk Space Capacity (Bytes)	The Disk Space Capacity of the Virtual Machine.
Disk Space Free (Bytes)	The Disk Space Free of the Virtual Machine.
Disk Space Usage (Bytes)	The Disk Space Usage of the Virtual Machine.
Disk Space Used (%)	The Disk Space Used of the Virtual Machine.
Disk Space Used Ratio	The Disk Space Used Ratio of the Virtual Machine.
Disk Throughput (Kilobytes per Second)	The Disk Throughput Counter of the Virtual Machine.
Disk Total Latency (Milliseconds)	The Disk Total Latency of the Virtual Machine.
Disk Write Latency (Milliseconds)	The Disk Write Latency of the Virtual Machine.
Guest OS Full Name	The Guest OS Full Name of the Virtual Machine.
Guest OS Heartbeat Status	The Guest OS Heartbeat Metric of the Virtual Machine.
Host Name	The Host System Name of the Virtual Machine.
IP Addresses	The IP Addresses of Guest Nics of the Virtual Machine.
Memory Capacity (Megabytes)	The Memory Capacity of the Virtual Machine.
Memory Reservation Locked to Max	The Memory Reservation Locked to Max of the Virtual Machine.
Memory Usage (Megabytes)	The Memory Usage of the Virtual Machine.
Memory Used (%)	The Memory Used of the Virtual Machine.
Memory Used Ratio	The Memory Used Ratio of the Virtual Machine.
Network Adapter IP Addresses	The Network Adapter IP Addresses of Guest Nics of the Virtual Machine.
Network Throughput (Kilobytes per Second)	The Network Throughput Counter of the Virtual Machine.
Power State	The Power State of the Virtual Machine.
Status	The Status of the Virtual Machine.
UUID	The UUID of the Virtual Machine.
Virtual Machine Name	The Virtual Machine Name of the Virtual Machine.
VM DNS Name	The VM DNS Name of the Virtual Machine.
VM Primary IP Address	The VM Primary IP Address of the Virtual Machine.

vSphere

Name	Description
Available CPU (Gigahertz)	The Available CPU of the vSphere.
Available Memory (Gigabytes)	The Available Memory of the vSphere.
Clusters	The Clusters of the vSphere.
Clusters In Green	The Clusters In Green of the vSphere.
Clusters In Grey	The Clusters In Grey of the vSphere.
Clusters In Red	The Clusters In Red of the vSphere.
Clusters In Yellow	The Clusters In Yellow of the vSphere.
CPU Cores	The CPU Cores of the vSphere.
CPUs	The CPUs of the vSphere.
Datacenters	The Datacenters of the vSphere.
Datastores	The Datastores of the vSphere.
Datastores In Green	The Datastores In Green of the vSphere.
Datastores In Grey	The Datastores In Grey of the vSphere.
Datastores In Red	The Datastores In Red of the vSphere.
Datastores In Yellow	The Datastores In Yellow of the vSphere.
Disk Space (Terabytes)	The Disk Space of the vSphere.
Host Systems	The Host Systems of the vSphere.
Hosts In Green	The Hosts In Green of the vSphere.
Hosts In Grey	The Hosts In Grey of the vSphere.
Hosts In Red	The Hosts In Red of the vSphere.
Hosts In Yellow	The Hosts In Yellow of the vSphere.
Network Adapters	The Network Adapters of the vSphere.
Powered Off Hosts	The Powered Off Hosts of the vSphere.
Powered On Hosts	The Powered On Hosts of the vSphere.
Version	The Version of the vSphere.
Virtual Machines	The Virtual Machines of the vSphere.
Virtual Machines In Green	The Virtual Machines In Green of the vSphere.
Virtual Machines In Grey	The Virtual Machines In Grey of the vSphere.
Virtual Machines In Red	The Virtual Machines In Red of the vSphere.
Virtual Machines In Yellow	The Virtual Machines In Yellow of the vSphere.
VSphere Name	The Name of the vSphere.