Page tree
Skip to end of metadata
Go to start of metadata

Command references


Usage: check_vmware_v2 [OPTIONS] [COUNTER]
    Query performance data from a vSphere API server.
    Specify the managed entity and performance counter to query.
    If no managed entity is specified, the query will be made against either
the vCenter Server Appliance virtual machine, or the ESXi host, depending
on whether the targetted vSphere API server is a vCenter or an ESXi host.
    Below is a list of commonly used performance counters and the types of
entities they are available on. Use the --list-counters option to fetch a
full list of available performance counters. Use the --verbose option to
list more information about the fetched counters.
    cpu.usage.average (datacenter, cluster, host, vm)
disk.usage.average (host, vm)
disk.read.average (host, vm)
disk.write.average (host, vm)
mem.usage.average (cluster, host, vm)
net.usage.average (cluster, host, vm)
service.status (host)
service.status.<service_name> (host)
runtime.connected (host, vm)
runtime.status (datacenter, cluster, host, vm)
vmfs.usage (datacenter, cluster, host)
vmfs.usage.<datastore_name> (datacenter, cluster, host)
    The following counters can be useful for one-off checks, but should be
avoided in scheduled use since they are very performance demanding, both
for Monitor and for the vCenter server being monitored:
    runtime.list_vms (datacenter, cluster, host)
runtime.list_hosts (datacenter, cluster)
runtime.tools (datacenter, cluster, host, vm)
device.cddvd (datacenter, cluster, host)
Options:
--service-host TEXT Host name of the plugin service. [default:
http://localhost]
--service-port INTEGER Port of the plugin service. [default: 8000]
-H, --host TEXT Host name of the vSphere API. This option is
required unless the service is configured
for exactly one vSphere host.
-o, --port INTEGER Port of the vSphere API. [default: 443]
--ignore-ssl Use this if the vSphere API has an invalid
SSL certificate. [default: False]
-u, --username TEXT Your vSphere API username. This option is
required unless the service has a configured
username for the given host.
-p, --password TEXT Your vSphere API password. This option is
required unless the service has a configured
password for the given host.
-D, --datacenter TEXT Name of the target datacenter. If used
together with the --cluster, --host-system
or --vm options, it will be used as a
filter.
-C, --cluster TEXT Name of the target cluster. If used together
with the --vm or --host-system options, it
will be used as a filter.
-S, --host-system TEXT Name of the target ESXi host system.
-V, --vm TEXT Name of the target virtual machine.
-t, --entity-type [vm|host|cluster|datacenter]
Type of the target managed entity. Use
together with --entity-name as an
alternative to the --datacenter, --cluster,
--host-system and --vm options.
-n, --entity-name TEXT Name of the target managed entity. Use
together with --entity-type as an
alternative to the --datacenter, --cluster,
--host-system and --vm options.
-r, --regex Treat any optional part of a counter as a
regular expression that includes items
matched by the expression. Counters where
--regex is a valid option are listed by
--list-counters -vv
-b, --blacklist Treat any optional part of a counter as a
blacklist that excludes matching items,
rather than excluding non-matching items.
Counters where --blacklist is a valid option
are listed by --list-counters -vv
-i, --interval INTEGER The sampling period interval in seconds.
[default: 20 for vm and host target
entities, 300 for datacenter and cluster
target entities]
--instance TEXT The counter instance to use. [default: ""]
--timeout FLOAT Timeout in seconds. [default: 10.0]
--list-counters List all available counters for the specific
entity and interval. Add -v to print counter
summaries. Add -vv to print available
counter instances.
--list-all-counters List all counters known by the vSphere
server. Add -v to print counter summaries.
-v, --verbose Print more detailed information. Adding
multiple instances of this flag further
increases the level of verbosity. Level 1
(-v) prints more detailed information about
the most significant metrics (those with the
"worst" state), but prints nothings extra if
all metrics are OK. Level 2 (-vv) prints
more detailed information about the most
significant metrics, also if all metrics are
OK (which is then the most significant
state). Level 3 (-vvv) prints detailed
information for all metrics regardless of
their state.
-c, --critical TEXT Set critical threshold.
-w, --warning TEXT Set warning threshold.
-h, --help Show this message and exit.

Plugin name


check_vmware_v2

Information


Check status of VMware vSphere infrastructure.

Why


The plugin can be used to monitor the infrastructure managed by a VMware vCenter server or a VMware ESXi server; such as its datacenters, clusters, hosts and virtual machines. It can check a large range of different metrics and statuses depending on the targeted infrastructure; for example CPU load, memory usage, network activity, runtime states, etc..

How


The plugin requires a separate service to run on the Monitor host. The plugin talks to the service which in turn talks to the target vSphere API server. The plugin service uses the pyVmomi vSphere API Python bindings from VMware to talk to the VMware vSphere infrastructure.

Supported platforms


VMware vSphere infrastructure: VMware vCenter and VMware ESX and ESXi hypervisor hosts.

Categories


Operating systems

Support level


Support level for this plugin: 5 


Level 5 (Medium and bug support) 
The plugin is not continuously tested by op5. op5 probably do not have a compatible test environment in place and/or resources to test the plugin. If an issue with the plugin is found, op5 will examine the importance and prioritize according to impact and level of effort. op5 monitors the upstream project (if any) and updates the shipped plugin regularly.

Tags


VMware, vSphere, vCenter, ESX, ESXi



  • No labels