You are here

vSphere ESXi Host Monitoring

Requires Opsview Monitor 6.2

This Host Template is part of the Vmware Vsphere Opspack

check_circle
Opsview Supported

404: Not Found

Included in the OS - VMware vSphere Opspack

Host Template: OS - VMware vSphere ESXi Host

Monitor your ESXi Hosts with a variety of checks, including CPU, Memory, Disk, Replication, Power, Uptime and Network statistics. Also includes information on Health Issues, Temperature, Host status and hosted VMs status, and connected Datastore information.

This Host Template includes the following Service Checks:

Service Check Name Description Default Thresholds (Warning, Critical) UOM
vSphere - Host - CPU Usage The CPU utilization as a percentage. cpu_usage=70,90 %
vSphere - Host - CPU Used The host CPU capacity, free CPU, and sum of the actively used CPU of all powered on VMs on the host. N/A MHz
vSphere - Host - CPU Time Used CPU Time accounted to the VMs on the host. N/A ms
vSphere - Host - Memory Usage Host memory usage and latency as a percentage of time host VMs are waiting to access swapped or compressed memory. memory_usage=70,90
memory_latency=70,90
%
vSphere - Host - Memory Used Host memory capacity, free and used values. N/A B
vSphere - Host - Memory Swap Amount of host memory that is used by swap - the sum of all VMs and vSphere services. N/A B
vSphere - Host - Memory Swap Rate The rate at which memory is swapped from disk into active memory across VMs on this host. N/A KB/s
vSphere - Host - Disk Usage Aggregated disk I/O rate, and individual read and write rates. This metric includes the rates for all virtual machines running on the host. N/A KB/s
vSphere - Host - Replication Traffic Outgoing host-based replication network traffic for this host, and the amount of data transmitted. N/A KB/s
vSphere - Host - Power Usage The current power usage of the host. N/A W
vSphere - Host - Uptime Total time elapsed since last system startup. N/A s
vSphere - Host - Health The overall health of the host. N/A N/A
vSphere - Host - Health Issues List any health issues affecting the host currently. Names of elements with known issues intended to be ignored can be passed in as an argument. N/A N/A
vSphere - Host - Network Usage Received, transmitted and combined rates of network utilization. N/A KB/s
vSphere - Host - Network Adapters Count and status of virtual network adaptors on the host. If not run with verbose mode, results will be truncated and summarised for an OK result. N/A N/A
vSphere - Host - Port Group Summary The associated vswitch and VLAN ID of the port group. If associated with a host network, will also display the network status and number of VMs on that network. Supports multiple Port Group Name variables. If run across all port groups, and not run with verbose mode, results will be truncated and summarised for an OK result. N/A N/A
vSphere - Host - Virtual Switch Summary The status of the virtual switch, including the total number of ports, ports available, the number of portgroups and the maximum transmission unit (MTU). Supports multiple Virtual Switch Name variables. If run across all virtual switches, and not run with verbose mode, results will be truncated and summarised for an OK result. available_ports=10:,0: N/A
vSphere - Host - NIC Summary The status of all NICs, including linkspeed if running. Returns CRITICAL if NICs are down and not in the list of expected inactive NICs, which can be passed as an argument. If not run with verbose mode, results will be truncated and summarised for an OK result. N/A N/A
vSphere - Host - Datastore Usage The Datastore utilization as a percentage. 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 - Host - Datastore Used The amount of datastore disk space used by the host. 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. N/A B
vSphere - Host - Datastore Latency The average amount of time for read and write operations on the datastore. 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. N/A ms
vSphere - Host - Datastore VM Observed Latency The average datastore latency as seen by VMs on the host. 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. N/A us
vSphere - Host - Datastore Read/Write The rate of reading and writing data from the datastore. 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. N/A KB/s
vSphere - Host - Host Status The status of the host. N/A N/A
vSphere - Host - VM Status The status of all VMs on the host. If not run with verbose mode, results will be truncated and summarised for an OK result. N/A N/A
vSphere - Host - Temperature Temperature checks on the host. If not run with verbose mode, results will be truncated and summarised for an OK result. N/A C

Usage Instructions

vMotion Support

Providing the vCenter Credentials variable will allow for enhanced error handling when carrying out Service Checks.



Step 1: Add this Host Template

Add the OS - VMware vSphere ESXi Host 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_CREDENTIALS

| 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

| 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_ESXI_EXPECTED_ELEMENT_ISSUES

| Parameter | Position in Variable | Name | Description | |:---------:|:--------------------:|:-----|:------------| | --esxi-expected-element-issues | Arg1 | ESXi Expected Hardware Element Issues | Comma-separated list of names of ESXi host hardware elements/numeric sensors which have expected issues. Supports wildcard asterisk. |

VSPHERE_ESXI_PORT_GROUP_NAME

This variable can be added multiple times to monitor each port group individually. Additionally, giving this argument a value of '.' (period character, no quotes) will run the check across all Port Groups on the appropriate entity.

| Parameter | Position in Variable | Name | Description | |:---------:|:--------------------:|:-----|:------------| | Opsview UI Only | Value | ESXi Port Group Display Name | Display Name for Port Group Service Checks | | --esxi-port-group-name | Arg1 | ESXi Port Group Name | Name of the ESXi Port Group |

VSPHERE_ESXI_VSWITCH_NAME

This variable can be added multiple times to monitor each virtual switch individually. Additionally, giving this argument a value of '.' (period character, no quotes) will run the check across all Virtual Switches on the appropriate entity.

| Parameter | Position in Variable | Name | Description | |:---------:|:--------------------:|:-----|:------------| | Opsview UI Only | Value | ESXi Virtual Switch Display Name | Display Name for Virtual Switch Service Checks | | --esxi-vswitch-name | Arg1 | ESXi Virtual Switch Name | Name of the ESXi Virtual Switch |

VSPHERE_ESXI_INACTIVE_NICS

| Parameter | Position in Variable | Name | Description | |:---------:|:--------------------:|:-----|:------------| | --esxi-expected-inactive-nics | Arg1 | ESXi Expected Inactive NICs | Comma-separated list of ESXi NICs expected to be inactive. Supports wildcard asterisk. |

VSPHERE_ESXI_LINKED_DATASTORE_NAME

This variable can be added multiple times to monitor each datastore linked to your resource individually. Additionally, giving this argument a value of '.' (period character, no quotes) will run the check across all Datastores on the appropriate entity.

| Parameter | Position in Variable | Name | Description | |:---------:|:--------------------:|:-----|:------------| | Opsview UI Only | Value | ESXi Linked Datastore Display Name | Display Name for Service Checks using this ESXi Datastore when linked to a resource | | --esxi-linked-datastore-name | Arg1 | ESXi Linked Datastore Name | Name of the ESXi Datastore linked to a resource |

VSPHERE_ESXI_INACTIVE_VMS

Parameter Position in Variable Name Description
--esxi-expected-inactive-vms Arg1 ESXi Expected Inactive VMs Comma-separated list of ESXi VMs expected to be inactive. 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 - Host - CPU Usage ESXiHost.CPU.Usage
vSphere - Host - CPU Used ESXiHost.CPU.Used
vSphere - Host - CPU Time Used ESXiHost.CPU.Time.Used
vSphere - Host - Memory Usage ESXiHost.Mem.Usage
vSphere - Host - Memory Used ESXiHost.Mem.Used
vSphere - Host - Memory Swap ESXiHost.Mem.Swap
vSphere - Host - Memory Swap Rate ESXiHost.Mem.Swap.Rate
vSphere - Host - Disk Usage ESXiHost.Disk.Usage
vSphere - Host - Replication Traffic ESXiHost.Repl.Traffic
vSphere - Host - Power Usage ESXiHost.Power.Usage
vSphere - Host - Uptime ESXiHost.Uptime
vSphere - Host - Health ESXiHost.Health
vSphere - Host - Health Issues ESXiHost.Health.Issues
vSphere - Host - Network Usage ESXiHost.Net.Usage
vSphere - Host - Network Adapters ESXiHost.Net.Adapters
vSphere - Host - Port Group Summary ESXiHost.PGroup.Summary
vSphere - Host - Virtual Switch Summary ESXiHost.VSwitch.Summary
vSphere - Host - NIC Summary ESXiHost.NIC.Summary
vSphere - Host - Datastore Usage ESXiHost.Datastore.Usage
vSphere - Host - Datastore Used ESXiHost.Datastore.Used
vSphere - Host - Datastore Latency ESXiHost.Datastore.Latency
vSphere - Host - Datastore VM Observed Latency ESXiHost.Datastore.VM.Latency
vSphere - Host - Datastore Read/Write ESXiHost.Datastore.RW
vSphere - Host - Host Status ESXiHost.Host.Status
vSphere - Host - VM Status ESXiHost.VM.Status
vSphere - Host - Temperature ESXiHost.Temperature

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



Step 3: Apply changes and the system will now be monitored

View Output

v1.0-opsview-6

ODI-2906 Vmware-vSphere Opspack

Initial release for Vmware-vSphere Opspack