vsan

Description

The vsan command checks the vSAN system in vCenter. Host endpoints are currently not supported.

Options

Besides the general options, this command supports the following options:

optiondescription
--maintenance-state STATEone of OK, WARNING, CRITICAL, UNKNOWN. The status to use when the host is in maintenance mode, this defaults to UNKNOWN
--mode MODEone of objecthealth, healthtest
--include REGEX(optional) REGEX is checked against the cluster name
--exclude REGEX(optional) REGEX is checked against the cluster name
--include-group REGEX(optional) only with --mode healthtest, REGEX is checked against the tests’ group name
--include-test REGEX(optional) only with --mode healthtest, REGEX is checked against the test name
--exclude-group REGEX(optional) only with --mode healthtest, REGEX is checked against the tests’ group name
--exclude-test REGEX(optional) only with --mode healthtest, REGEX is checked against the test name
--cachefetch cached data from the API when available and not outdated
--verboseshow also tests the where OK

--mode healthtest

This corresponds to the following in vCenter:

If you navigate to Cluster/Monitor/vSAN/Skyline Health, you will see a sidebar with items like “Hardware compatibility”, “Online Health”, and so on. These are groups of tests (you can filter whole groups with --exclude-group/--include-group).

You can expand them to see the names of individual tests. These can be filtered as well (--exclude-test/--include-test).

--mode objecthealth

The REGEX for --include and --exclude is matched against the cluster name.

This is an in-depth check of the “vSAN object health” test. It’s not very well tested yet.

Examples

$ check_vsphere vsan \
    -s vcenter.example.com -u naemon@vsphere.local \
    -m healthtest --include 'Cluster 1'