check_vmware_nsxt

Icinga check plugin for the VMware NSX-T REST API

check_vmware_nsxt

Icinga check plugin for the VMware NSX-T REST API.

Supported Modes:

  • cluster-status - retrieves the overall NSX-T cluster status from the API
  • alarms - Retrieve and display open alarms from the API
  • capacity-usage - Retrieves and checks capacity indicators from the API

Installation

Python 3 is required, and you need the Python requests module.

Please prefer installation via system packages like python3-requests.

Alternatively you can install with pip:

pip3 install requests

Make sure to modify the shebang to your environment, one of the following should be fine.

#!/usr/bin/env python3
#!/usr/bin/python3

Then copy the file to your plugin dir:

cp check_vmware_nsxt.py /usr/lib*/nagios/plugins/check_vmware_nsxt
chmod 755 /usr/lib*/nagios/plugins/check_vmware_nsxt

Also see the Icinga 2 example command.

Usage

$ ./check_vmware_nsxt.py --help
...
optional arguments:
  -h, --help            show this help message and exit
  --api API, -A API     VMware NSX-T URL without any sub-path (e.g. https://vmware-nsx.local)
  --username USERNAME, -u USERNAME
                        Username for Basic Auth
  --password PASSWORD, -p PASSWORD
                        Password for Basic Auth
  --mode MODE, -m MODE  Check mode
$ ./check_vmware_nsxt.py --api 'https://vmware-nsx.local' -u icinga -p password --mode cluster-status
[OK] control_cluster_status=STABLE - mgmt_cluster_status=STABLE - control_cluster_status=STABLE - nodes_online=3

[OK] DATASTORE: STABLE - 3 members
[OK] CLUSTER_BOOT_MANAGER: STABLE - 3 members
[OK] CONTROLLER: STABLE - 3 members
[OK] MANAGER: STABLE - 3 members
[OK] POLICY: STABLE - 3 members
[OK] HTTPS: STABLE - 3 members
[OK] ASYNC_REPLICATOR: STABLE - 3 members
[OK] MONITORING: STABLE - 3 members
[OK] IDPS_REPORTING: STABLE - 3 members
[OK] CORFU_NONCONFIG: STABLE - 3 members
| nodes_online=3;;;0
$ ./check_vmware_nsxt.py --api 'https://vmware-nsx.local' -u icinga -p password --mode alarms
[WARNING] 1 alarms - 1 medium

[MEDIUM] (2021-04-26 17:25:18) (node1) Intelligence Health/Storage Latency High - Intelligence node storage latency is high.
| alarms=1;;;0
$ ./check_vmware_nsxt.py --api 'https://vmware-nsx.local' -u icinga -p password --mode capacity-usage
[OK] 28 info - no usages - last update: 2021-04-29 19:06:12

[OK] [INFO] System-wide NAT rules: 0 of 25000 (0%)
[OK] [INFO] Network Introspection Rules: 1 of 10000 (0.01%)
[OK] [INFO] System-wide Endpoint Protection Enabled Hosts: 0 of 256 (0%)
...
| number_of_nat_rules=0%;70;100;0;100
number_of_si_rules=0.01%;70;100;0;100
number_of_gi_protected_hosts=0%;70;100;0;100
...

API Documentation

VMware-NSX-T-Data-Center docs

General API Documentation: code.vmware.com

Endpoints the check uses:

License

VMware NSX® is a trademark of VMware, Inc.

Copyright (C) 2021 info@netways.de" rel="nofollow">NETWAYS GmbH

This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program. If not, see .