You are here
Host Template: OS - VMware vSphere vCenter Monitoring
Monitor VMware vCenter Server Appliance (VCSA) environments with a variety of checks, including CPU, Memory, Disk, Uptime and Backup. Also includes information on Health Issues, Clusters, Hosts, Datastores and Network.
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 - vCenter - Backup Status | The status of backup jobs in VCSA. By default, displays the five most recent backup jobs, but this can be overridden by specifying the VC_BACKUP_DISP_LIMIT variable. If not run with verbose mode, results will be truncated and summarised for an OK result. | N/A | N/A |
vSphere - vCenter - Cluster Status | The status of clusters in VCSA. Support for multiple Cluster Name variables. If run across all clusters, and not run with verbose mode, results will be truncated and summarised for an OK result. | N/A | N/A |
vSphere - vCenter - VCHA Cluster Status | The status of vCenter High Availability (VCHA) clusters in VCSA. | N/A | N/A |
vSphere - vCenter - Host Status | The status of ESXi Hosts in VCSA (discounting all Hosts in Standby mode). Support for multiple Host Name variables. If run across all hosts, and not run with verbose mode, results will be truncated and summarised for an OK result. | N/A | N/A |
vSphere - vCenter - Virtual Machine Status | The status of ESXi Virtual Machines in VCSA. Support for multiple Virtual Machine Name variables. If run across all virtual machines, and not run with verbose mode, results will be truncated and summarised for an OK result. | N/A | B |
vSphere - vCenter - Datastore Status | The status of ESXi Datastores in VCSA. Support for multiple Datastore Name variables. If run across all datastores, and not run with verbose mode, results will be truncated and summarised for an OK result. | datastore_usage=70,90 | % |
vSphere - vCenter - Filesystem Status | The status of Filesystems in VCSA. Support for multiple Filesystem Name variables. If run across all filesystems, and not run with verbose mode, results will be truncated and summarised for an OK result. | filesystem_usage=70,90 | % |
vSphere - vCenter - Service Status | The status of services in VCSA. | N/A | N/A |
vSphere - vCenter - NIC Status | The status of NICs in VCSA. | N/A | N/A |
vSphere - vCenter - CPU Usage | The CPU utilization as a percentage and the system load. | cpu_usage=70,90 | % |
vSphere - vCenter - Memory Usage | The memory utilization as a percentage and the amount of memory used. | memory_usage=70,90 | % |
vSphere - vCenter - Swap Usage | The memory swap utilization as a percentage and the amount of swap memory used. | swap_usage=70,90 | % |
vSphere - vCenter - DNS Status | The status of DNS servers in VCSA. | N/A | N/A |
vSphere - vCenter - NTP Status | The status of NTP servers in VCSA. | N/A | N/A |
vSphere - vCenter - Proxy Servers Status | The status of Proxy servers in VCSA. | N/A | N/A |
vSphere - vCenter - Health Status | The health status of VCSA. | N/A | N/A |
vSphere - vCenter - Time Synchronization | Check the time synchronization mode. | N/A | N/A |
vSphere - vCenter - Uptime | The uptime of VCSA. | N/A | s |
vSphere - vCenter - Updates | Check if new updates are available. | N/A | N/A |
vSphere - vCenter - Version | The version of VCSA. | N/A | N/A |
VMware vSphere vCenter Monitoring Usage Instructions
NOTE: This host template requires the user to be added to the SystemConfiguration.Administrators
and Global.VCServer
groups.
Step 1: Add this Host Template
Add the OS - VMware vSphere vCenter 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_VC_CREDENTIALS
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 |
VSPHERE_VC_BACKUP_DISP_LIMIT
Giving this variable a value of '0
' will display all backup jobs.
Parameter | Position in Variable | Name | Description |
---|---|---|---|
--vc-backup-disp-limit | Value | vCenter Backup Display Limit | The maximum number of backup jobs to display |
VSPHERE_VC_CLUSTER_NAME
This variable can be added multiple times to monitor each cluster individually. Additionally, giving this argument a value of '.
' (period character, no quotes) will run the check across all Clusters.
Parameter | Position in Variable | Name | Description |
---|---|---|---|
Opsview UI Only | Value | vCenter Cluster Display Name | Display Name for vCenter Cluster Service Checks |
--vc-cluster-name | Arg1 | vCenter Cluster Name | Name of the vCenter Cluster |
--vc-ignored-clusters | Arg2 | vCenter Ignored Clusters | Comma separated names of vCenter Clusters to ignore, only used if running the check across all clusters |
VSPHERE_VC_HOST_NAME
This variable can be added multiple times to monitor each host individually. Additionally, giving this argument a value of '.
' (period character, no quotes) will run the check across all Hosts.
Parameter | Position in Variable | Name | Description |
---|---|---|---|
Opsview UI Only | Value | vCenter Host Display Name | Display Name for vCenter Host Service Checks |
--vc-host-name | Arg1 | vCenter Host Name | Name of the vCenter Host |
--vc-ignored-hosts | Arg2 | vCenter Ignored Hosts | Comma separated names of vCenter Hosts to ignore, only used if running the check across all hosts. Supports wildcard asterisk. |
VSPHERE_VC_VM_NAME
This variable can be added multiple times to monitor each virtual machine individually. Additionally, giving this argument a value of '.
' (period character, no quotes) will run the check across all Virtual Machines.
Parameter | Position in Variable | Name | Description |
---|---|---|---|
Opsview UI Only | Value | vCenter Virtual Machine Display Name | Display Name for vCenter Virtual Machine Service Checks |
--vc-vm-name | Arg1 | vCenter Virtual Machine Name | Name of the vCenter Virtual Machine |
--vc-ignored-vms | Arg2 | vCenter Ignored Virtual Machines | Comma separated names of vCenter Virtual Machines to ignore, only used if running the check across all virtual machines. Supports wildcard asterisk. |
VSPHERE_VC_DATASTORE_NAME
This variable can be added multiple times to monitor each datastore individually. Additionally, giving this argument a value of '.
' (period character, no quotes) will run the check across all Datastores.
Parameter | Position in Variable | Name | Description |
---|---|---|---|
Opsview UI Only | Value | vCenter Datastore Display Name | Display Name for vCenter Datastore Service Checks |
--vc-datastore-name | Arg1 | vCenter Datastore Name | Name of the vCenter Datastore |
--vc-ignored-datastores | Arg2 | vCenter Ignored Datastores | Comma separated names of vCenter Datastores to ignore, only used if running the check across all datastores. Supports wildcard asterisk. |
VSPHERE_VC_FILESYSTEM_NAME
This variable can be added multiple times to monitor each filesystem individually. Additionally, giving this argument a value of '.
' (period character, no quotes) will run the check across all Filesystems.
Parameter | Position in Variable | Name | Description |
---|---|---|---|
Opsview UI Only | Value | vCenter Filesystem Display Name | Display Name for vCenter Filesystem Service Checks |
--vc-filesystem-name | Arg1 | vCenter Filesystem Name | Name of the vCenter Filesystem |
--vc-ignored-filesystems | Arg2 | vCenter Ignored Filesystems | Comma separated names of vCenter Filesystems to ignore, only used if running the check across all filesystems. Supports wildcard asterisk. |
VSPHERE_VC_SERVICE_NAME
This variable can be added multiple times to monitor each service individually. Additionally, giving this argument a value of '.
' (period character, no quotes) will run the check across all Services.
Parameter | Position in Variable | Name | Description |
---|---|---|---|
Opsview UI Only | Value | vCenter Service Display Name | Display Name for vCenter Service Service Checks |
--vc-service-name | Arg1 | vCenter Service Name | Name of the vCenter Service |
--vc-ignored-services | Arg2 | vCenter Ignored Services | Comma separated names of vCenter Services to ignore, only used if running the check across all services. Supports wildcard asterisk. |
VSPHERE_VC_NIC_NAME
This variable can be added multiple times to monitor each NIC individually. Additionally, giving this argument a value of '.
' (period character, no quotes) will run the check across all NICs.
Parameter | Position in Variable | Name | Description |
---|---|---|---|
Opsview UI Only | Value | vCenter NIC Display Name | Display Name for vCenter NIC Service Checks |
--vc-nic-name | Arg1 | vCenter NIC Name | Name of the vCenter NIC |
--vc-ignored-nics | Arg2 | vCenter Ignored NICs | Comma separated names of vCenter NICs to ignore, only used if running the check across all NICs. Supports wildcard asterisk. |
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 - vCenter - Backup Status | vCenter.Backup.Status |
vSphere - vCenter - Cluster Status | vCenter.Cluster.Status |
vSphere - vCenter - VCHA Cluster Status | vCenter.VCHA.Cluster.Status |
vSphere - vCenter - Host Status | vCenter.Host.Status |
vSphere - vCenter - Virtual Machine Status | vCenter.VM.Status |
vSphere - vCenter - Datastore Status | vCenter.Datastore.Usage |
vSphere - vCenter - Filesystem Status | vCenter.FS.Usage |
vSphere - vCenter - Service Status | vCenter.Service.Status |
vSphere - vCenter - NIC Status | vCenter.NIC.Status |
vSphere - vCenter - CPU Usage | vCenter.CPU.Usage |
vSphere - vCenter - Memory Usage | vCenter.Memory.Usage |
vSphere - vCenter - Swap Usage | vCenter.Memory.Swap.Usage |
vSphere - vCenter - DNS Status | vCenter.DNS.Status |
vSphere - vCenter - NTP Status | vCenter.NTP.Status |
vSphere - vCenter - Proxy Servers Status | vCenter.Proxy.Status |
vSphere - vCenter - Health Status | vCenter.Health.Status |
vSphere - vCenter - Time Synchronization | vCenter.TimeSync |
vSphere - vCenter - Uptime | vCenter.Uptime |
vSphere - vCenter - Updates | vCenter.Updates |
vSphere - vCenter - Version | vCenter.Version |
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 |