Bindplane

The Bindplane Developer Hub

Welcome to the Bindplane developer hub. You'll find comprehensive guides and documentation to help you start working with Bindplane as quickly as possible, as well as support if you get stuck. Let's jump right in!

VMware vCenter

Monitor VMware vSphere Hypervisor Clusters

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

vSphere User Role Example

Supported Versions

vSphere vCenter Server:

  • 6.0
  • 6.5
  • 6.7

Connection Parameters

NameRequired?Description
HostRequiredThe VMware vCenter host to connect to.
PortThe port for communication to VMware vCenter.
UsernameRequired
PasswordRequired
SSL ConfigurationThe 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 CountersPerformance 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 PathThe 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

NameDescription
Available CPU (Megahertz)The Available CPU of the Cluster.
Available Memory (Bytes)The Available Memory of the Cluster.
Cluster NameThe Cluster Name of the Cluster.
CPU CoresThe CPU Cores of the Cluster.
CPU Threads (Threads)The CPU Threads of the Cluster.
Datacenter NameThe Datacenter of the Cluster.
Effective CPU (Megahertz)The Effective CPU of the Cluster.
Effective HostsThe Effective Hosts of the Cluster.
Effective Memory (Megabytes)The Effective Memory of the Cluster.
HostsThe Hosts of the Cluster.
Related HostsThe Related Hosts of the Cluster.
StatusThe Status of the Cluster.

Datacenter

NameDescription
Average Host CPU Utilization (%)The Average Host CPU Utilization of the Datacenter.
Clusters In GreenThe Clusters In Green of the Datacenter.
Clusters In GreyThe Clusters In Grey of the Datacenter.
Clusters In RedThe Clusters In Red of the Datacenter.
Clusters In YellowThe Clusters In Yellow of the Datacenter.
CPUsThe CPUs of the Datacenter.
Datastores In GreenThe Datastores In Green of the Datacenter.
Datastores In GreyThe Datastores In Grey of the Datacenter.
Datastores In RedThe Datastores In Red of the Datacenter.
Datastores In YellowThe Datastores In Yellow of the Datacenter.
Disk Space (Terabytes)The Disk Space of the Datacenter.
Host SystemsThe Host Systems of the Datacenter.
Hosts In GreenThe Hosts In Green of the Datacenter.
Hosts In GreyThe Hosts In Grey of the Datacenter.
Hosts In RedThe Hosts In Red of the Datacenter.
Hosts In YellowThe Hosts In Yellow of the Datacenter.
NameThe Name of the Datacenter.
Network AdaptersThe Network Adapters of the Datacenter.
Powered Off HostsThe Powered Off Hosts of the Datacenter.
Powered On HostsThe Powered On Hosts of the Datacenter.
Virtual MachinesThe Virtual Machines of the Datacenter.
Virtual Machines In GreenThe Virtual Machines In Green of the Datacenter.
Virtual Machines In GreyThe Virtual Machines In Grey of the Datacenter.
Virtual Machines In RedThe Virtual Machines In Red of the Datacenter.
Virtual Machines In YellowThe Virtual Machines In Yellow of the Datacenter.

Datastore

NameDescription
AccessibleThe Accessible of the Datastore.
Datacenter NameThe Datacenter of the Datastore.
Datastore NameThe Datastore Name of the Datastore.
Disk NamesThe disk names of the Datastore. Only applies to VMFS datastores.
Free Space (Bytes)The Free Space of the Datastore.
Related HostsThe Related Hosts of the Datastore.
Space Utilization (%)The Space Utilization of the Datastore.
Space Utilization RatioThe Space Utilization Ratio of the Datastore.
StatusThe Status of the Datastore.
Total Space (Bytes)The Total Space of the Datastore.
TypeThe Type of the Datastore.
URLThe URL of the Datastore.
Used Space (Bytes)The Used Space of the Datastore.

Host System

NameDescription
Average CPU Speed (Megahertz)The Average CPU Speed of the Host System.
Bus ResetsThe Bus Resets of the Host System.
Cluster NameThe Cluster Name of the Host System.
CommandsThe Commands of the Host System.
CPU CoresThe CPU Cores of the Host System.
CPU ModelThe 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 RatioThe CPU Utilization Ratio of the Host System.
CPUsThe CPUs of the Host System.
Datacenter NameThe Datacenter of the Host System.
Disk Commands AbortedThe 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 NameThe Host System Name of the Host System.
In Maintenance ModeThe In Maintenance Mode of the Host System.
MAC AddressesThe 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 RatioThe Memory Utilization Ratio of the Host System.
ModelThe Model of the Host System.
Network AdaptersThe 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 StateThe Power State of the Host System.
Product TypeThe Product Type of the Host System.
Product VersionThe Product Version of the Host System.
Reboot RequiredThe Reboot Required of the Host System.
Related VMsThe of the Host System.
StatusThe 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.
UUIDThe UUID of the Host System.
VendorThe Vendor of the Host System.
VMotion EnabledThe VMotion Enabled of the Host System.

Resource Pool

NameDescription
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 SharesThe CPU Shares of the Resource Pool.
CPU Shares LevelThe CPU Shares Level of the Resource Pool.
CPU Usage (Megahertz)The CPU Usage of the Resource Pool.
Datacenter NameThe Datacenter of the Resource Pool.
Memory Reservation (Megabytes)The Memory Reservation of the Resource Pool.
Memory SharesThe Memory Shares of the Resource Pool.
Memory Shares LevelThe Memory Shares Level of the Resource Pool.
Private Memory (Megabytes)The Private Memory of the Resource Pool.
Resource Pool NameThe 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

NameDescription
Ballooned Memory (Megabytes)The Ballooned Memory of the Virtual Machine.
CPU Ready (%)The CPU Ready of the Virtual Machine.
CPU Ready RateThe CPU Ready Rate of the Virtual Machine.
CPU Ready RawThe 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 NameThe 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 RatioThe 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 NameThe Guest OS Full Name of the Virtual Machine.
Guest OS Heartbeat StatusThe Guest OS Heartbeat Metric of the Virtual Machine.
Host NameThe Host System Name of the Virtual Machine.
IP AddressesThe IP Addresses of Guest Nics of the Virtual Machine.
Memory Capacity (Megabytes)The Memory Capacity of the Virtual Machine.
Memory Reservation Locked to MaxThe 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 RatioThe Memory Used Ratio of the Virtual Machine.
Network Adapter IP AddressesThe 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 StateThe Power State of the Virtual Machine.
StatusThe Status of the Virtual Machine.
UUIDThe UUID of the Virtual Machine.
Virtual Machine NameThe Virtual Machine Name of the Virtual Machine.
VM DNS NameThe VM DNS Name of the Virtual Machine.
VM Primary IP AddressThe VM Primary IP Address of the Virtual Machine.

vSphere

NameDescription
Available CPU (Gigahertz)The Available CPU of the vSphere.
Available Memory (Gigabytes)The Available Memory of the vSphere.
ClustersThe Clusters of the vSphere.
Clusters In GreenThe Clusters In Green of the vSphere.
Clusters In GreyThe Clusters In Grey of the vSphere.
Clusters In RedThe Clusters In Red of the vSphere.
Clusters In YellowThe Clusters In Yellow of the vSphere.
CPU CoresThe CPU Cores of the vSphere.
CPUsThe CPUs of the vSphere.
DatacentersThe Datacenters of the vSphere.
DatastoresThe Datastores of the vSphere.
Datastores In GreenThe Datastores In Green of the vSphere.
Datastores In GreyThe Datastores In Grey of the vSphere.
Datastores In RedThe Datastores In Red of the vSphere.
Datastores In YellowThe Datastores In Yellow of the vSphere.
Disk Space (Terabytes)The Disk Space of the vSphere.
Host SystemsThe Host Systems of the vSphere.
Hosts In GreenThe Hosts In Green of the vSphere.
Hosts In GreyThe Hosts In Grey of the vSphere.
Hosts In RedThe Hosts In Red of the vSphere.
Hosts In YellowThe Hosts In Yellow of the vSphere.
Network AdaptersThe Network Adapters of the vSphere.
Powered Off HostsThe Powered Off Hosts of the vSphere.
Powered On HostsThe Powered On Hosts of the vSphere.
VersionThe Version of the vSphere.
Virtual MachinesThe Virtual Machines of the vSphere.
Virtual Machines In GreenThe Virtual Machines In Green of the vSphere.
Virtual Machines In GreyThe Virtual Machines In Grey of the vSphere.
Virtual Machines In RedThe Virtual Machines In Red of the vSphere.
Virtual Machines In YellowThe Virtual Machines In Yellow of the vSphere.
VSphere NameThe Name of the vSphere.

Updated 8 months ago

VMware vCenter


Monitor VMware vSphere Hypervisor Clusters

Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.