Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

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.

...