Host Template: OS - VMware vSphere ESXi Resource Pool
Overview Copied
Monitor your ESXi Resource Pools with a variety of checks including CPU Usage, Memory Usage and Memory Ballooning.
This Host Template includes the following Service Checks:
Service Check Name | Description | Default Thresholds (Metric: Warning, Critical) | UOM |
---|---|---|---|
vSphere - Resource Pool - CPU Used | CPU Used in MHz. | N/A | MHz |
vSphere - Resource Pool - Memory Used | Amount of host physical memory consumed, and the amount used for virtualization infrastructure. | N/A | B |
vSphere - Resource Pool - Memory Balloon | Amount of memory allocated by the Virtual Machine memory control driver, which controls ballooning. | N/A | B |
Note
See details about Monitoring Plugin thresholds here.
Usage Instructions Copied
Please review the overall OS - VMware vSphere Opspack documentation for details on prerequisites, known issues, and other necessary configurations that apply to all Host Templates in the Opspack.
Add this Host Template Copied
Add the OS - VMware vSphere ESXi Resource Pool 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.
Note
For more information, refer to the documentation on Adding Host Templates to Hosts.
Add and configure Variables Copied
The Service Checks in this Host Template use the following variables, and they will be added to your Opsview Monitor instance alongside the Host Template:
- VSPHERE_ESXI_CREDENTIALS
- VSPHERE_ESXI_RES_POOL_NAME
- VSPHERE_CERTIFICATES
- VSPHERE_ESXI_HOST_NAME
- VSPHERE_VC_CREDENTIALS
Note
For more information, refer to the documentation on Adding Variables to Hosts.
Apply Changes Copied
Apply Changes and the system will now be monitored:
Additional Information Copied
NOTE: Resource Pool metrics are only supported when authenticating with ESXi credentials.
NOTE: To monitor a Resource Pool within a Cluster, the Cluster must contain Hosts.
vCenter Support Copied
Providing the vCenter Credentials variable will allow for enhanced error handling when carrying out Service Checks.
Available Variables Copied
VSPHERE_ESXI_CREDENTIALS Copied
Plugin 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_ESXI_RES_POOL_NAME Copied
Plugin Parameter | Position in Variable | Name | Description |
---|---|---|---|
--esxi-res-pool-name |
Value | ESXi Resource Pool Name | Name of the ESXi Resource Pool |
VSPHERE_ESXI_HOST_NAME Copied
Plugin Parameter | Position in Variable | Name | Description |
---|---|---|---|
N/A (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_VC_CREDENTIALS Copied
Setting this variable allows for enhanced error handling when carrying out ESXi Service Checks.
Plugin 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 |
SSL Certificates: VSPHERE_CERTIFICATES Copied
Opsview Cloud
For Opsview Cloud customers, please contact ITRS Support for assistance with setting up certificate files, as they require Orchestrator access.
Additionally, you can use the VSPHERE_CERTIFICATES variable to pass in your SSL certificates for use when connecting to the service provider to gather metrics:
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 |
Plugin help Copied
Plugin: check_vsphere
Secure Args
This plugin uses the Secure Args feature for argument passing.
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 - Resource Pool - CPU Used | ESXiResPool.CPU.Used |
vSphere - Resource Pool - Memory Used | ESXiResPool.Mem.Used |
vSphere - Resource Pool - Memory Balloon | ESXiResPool.Mem.Balloon |