vSphere ESXi Performance Counter

Host Template: OS - VMware vSphere ESXi Generic Performance Counter

Monitor generic ESXi metrics via the PerfManager object with performance counters.

See all of the Opsview's virtualization monitoring solutions at VMware Monitoring.

This Host Template includes the following Service Checks:

Service Check Name	Description	Default Thresholds (Warning, Critical)	UOM
vSphere - Generic - Perf Counter Metric	Monitor generic Performance Counters.	N/A	N/A

Usage Instructions

Step 1: Add this Host Template

Add the OS - VMware vSphere ESXi Generic Performance Counter Host Template to your Opsview Monitor host. If the resource you're monitoring has no hostname or public IP, then open the Advanced settings pane and change Host Check Command to Always assumed to be UP.

For more information, refer to Opsview Knowledge Center - Adding Host Templates to Hosts.

Step 2: Add and configure variables required for this Host Template

The Service Checks in this Host Template use the following variables, and they will be added to your Opsview Monitor instance when you import the Opspack:

VSPHERE_ESXI_HOST_NAME

Parameter	Position in Variable	Name	Description
Opsview UI Only	Value	ESXi Host Display Name	Display Name for ESXi Host Service Checks
--esxi-hostname	Arg1	ESXi Host Name	Name of the ESXi Host

VSPHERE_ESXI_PC_GENERIC

Entities must be in the form <entity-type>.<entity-id> - e.g. VirtualMachine.1.Performance Counters must be in the form <groupInfo.key>.<nameInfo.key>.<rollupType> - e.g. disk.read.average.This information can be extracted from the Managed Object Browser.

Parameter	Position in Variable	Name	Description
Opsview UI Only	Value	Service Check Name	The name of your Generic Service Check
--esxi-generic-pc-entities	Arg1	Generic PerfCounter Entities	Comma separated entities for generic ESXi Performance Counters
--esxi-generic-pc-labels	Arg2	Generic PerfCounter Labels	Comma separated labels for generic ESXi Performance Counters
--esxi-generic-pc-counters	Arg3	Generic PerfCounter Counters	Comma separated generic ESXi Performance Counters
--esxi-generic-pc-uoms	Arg4	Generic PerfCounter UOMs	Comma separated units of measurement for generic ESXi Performance Counters

VSPHERE_ESXI_CREDENTIALS

This variable is optional but either 'VSPHERE_ESXI_CREDENTIALS' or 'VSPHERE_VC_CREDENTIALS' needs to be set.

Parameter	Position in Variable	Name	Description
--esxi-username	Arg1	ESXi Username	Username for the ESXi Host
--esxi-password	Arg2	ESXi Password	Password for the ESXi Host

VSPHERE_VC_CREDENTIALS

This variable is optional but either 'VSPHERE_ESXI_CREDENTIALS' or 'VSPHERE_VC_CREDENTIALS' needs to be set. Setting this variable allows for enhanced error handling when carrying out ESXi Service Checks.

Parameter	Position in Variable	Name	Description
--vcenter-username	Arg1	vCenter Username	Username for vCenter instance
--vcenter-password	Arg2	vCenter Password	Password for vCenter instance
--vcenter-server	Arg3	vCenter Instance Name	Name of the vCenter instance

For more information, refer to Opsview Knowledge Center - Adding Variables to Hosts.

For mode-specific help, run the plugin with the -h -m <mode> flags. This will list the required and optional Variable Arguments for that mode. The appropriate mode for each Service Check is listed here:

Service Check Name	Mode
vSphere - Generic - Perf Counter Metric	`ESXiGeneric.Perf.Counters`

SSL Certificates

Additionally, you can use the following variable to pass in your SSL certificates for use when connecting to the service provider to gather metrics:

VSPHERE_CERTIFICATES

Parameter	Position in Variable	Name	Description
--ca-path	Arg1	CA Certificate Path	Path to the CA Certificate
--client-cert	Arg2	Client Certificate Path	Path to the Client Certificate
--client-key	Arg3	Client Key Path	Path to the Client Key