VMware API poller template
Use this SAM API poller template to monitor VMware vCenter inventory of entities such as virtual machines (VMs) and hosts.
Prerequisites
- Configure Basic Authentication credentials with read access to entity types. See API poller authorization and authentication.
- The first API request retrieves a session ID that is included in subsequent requests.
- Request headers include
vmware-api-session-id
.
Notes
- Default thresholds are not set for this template.
- For reference, see vCenter (Management) API (© 2020 VMware, Inc., available at code.vmware.com/apis, obtained on March 22, 2020).
- Here is an API request example:
https://${DisplayName}/rest/com/vmware/cis/session
Available metrics
All clusters
The number of visible (subject to permission checks) clusters in vCenter.
Unit: Count
All datacenters
The number of visible (subject to permission checks) datacenters in vCenter.
Unit: Count
All datastores
The number of visible (subject to permission checks) datastores in vCenter.
Unit: Count
All folders
The number of visible (subject to permission checks) folders in vCenter.
Unit: Count
All hosts
The number of visible (subject to permission checks) hosts in vCenter.
Unit: Count
All networks
The number of visible (subject to permission checks) networks in vCenter.
Unit: Count
All resource pools
The number of visible (subject to permission checks) resource pools in vCenter.
Unit: Count
All services
The number of vCenter services.
Unit: Count
All virtual machines
The number of visible (subject to permission checks) virtual machines in vCenter
Unit: Count
All powered on virtual machines
The number of visible (subject to permission checks) virtual machines in vCenter that are powered on.
Unit: Count
All suspended virtual machines
The number of visible (subject to permission checks) virtual machines in vCenter that are suspended.
Unit: Count
All powered off virtual machines
The number of visible (subject to permission checks) virtual machines in the vCenter that are powered off.
Unit: Count