Nutanix SNMP
Connector dependencies​
The following monitoring connectors will be installed when you install the Nutanix SNMP connector through the Configuration > Monitoring Connector Manager menu:
Pack assets​
Templates​
The Monitoring Connector Nutanix SNMP brings 4 host templates:
- Virt-Nutanix-Container-SNMP-custom
- Virt-Nutanix-Hypervisor-SNMP-custom
- Virt-Nutanix-SNMP-custom
- Virt-Nutanix-VM-SNMP-custom
The connector brings the following service templates (sorted by the host template they are attached to):
- Virt-Nutanix-Container-SNMP-custom
- Virt-Nutanix-Hypervisor-SNMP-custom
- Virt-Nutanix-SNMP-custom
- Virt-Nutanix-VM-SNMP-custom
Service Alias | Service Template | Service Description |
---|---|---|
Iops | Virt-Nutanix-Container-Iops-SNMP-custom | Check Nutanix containers IOPS |
Latency | Virt-Nutanix-Container-Latency-SNMP-custom | Check Nutanix containers latency |
Storage | Virt-Nutanix-Container-Storage-SNMP-custom | Check Nutanix container storage usage |
The services listed above are created automatically when the Virt-Nutanix-Container-SNMP-custom host template is used.
Service Alias | Service Template | Service Description |
---|---|---|
Cpu | Virt-Nutanix-Hypervisor-Cpu-SNMP-custom | Check Nutanix hypervisor CPU usage |
Iops | Virt-Nutanix-Hypervisor-Iops-SNMP-custom | Check Nutanix hypervisors IOPS |
Latency | Virt-Nutanix-Hypervisor-Latency-SNMP-custom | Check Nutanix hypervisor latency |
Memory | Virt-Nutanix-Hypervisor-Memory-SNMP-custom | Check Nutanix hypervisor memory usage |
Vm-count | Virt-Nutanix-Hypervisor-Vm-Count-SNMP-custom | Check hypervisor virtual machines count |
The services listed above are created automatically when the Virt-Nutanix-Hypervisor-SNMP-custom host template is used.
Service Alias | Service Template | Service Description | Discovery |
---|---|---|---|
Cluster-Usage | Virt-Nutanix-Cluster-Usage-SNMP-custom | Check cluster usage | |
Container-Usage | Virt-Nutanix-Container-Usage-SNMP-custom | Check container usage | |
Disk-Usage | Virt-Nutanix-Disk-Usage-SNMP-custom | Check disk usage | X |
Hypervisor-Usage | Virt-Nutanix-Hypervisor-Usage-SNMP-custom | Check hypervisor usage | |
Storage-Pool-Usage | Virt-Nutanix-Storage-Pool-Usage-SNMP-custom | Check storage pool usage | X |
Vm-Usage | Virt-Nutanix-Vm-Usage-SNMP-custom | Check virtual machine usage |
The services listed above are created automatically when the Virt-Nutanix-SNMP-custom host template is used.
If Discovery is checked, it means a service discovery rule exists for this service template.
Service Alias | Service Template | Service Description |
---|---|---|
Cpu | Virt-Nutanix-VM-Cpu-SNMP-custom | Check Nutanix virtual machine CPU usage |
Iops | Virt-Nutanix-VM-Iops-SNMP-custom | Check Nutanix virtual machine IOPS |
Latency | Virt-Nutanix-VM-Latency-SNMP-custom | Check Nutanix virtual machine latency |
Power-State | Virt-Nutanix-VM-Power-State-SNMP-custom | Check Nutanix virtual machine power state |
Traffic | Virt-Nutanix-VM-Traffic-SNMP-custom | Check Nutanix virtual machine traffic |
The services listed above are created automatically when the Virt-Nutanix-VM-SNMP-custom host template is used.
Discovery rules​
Host discovery​
Rule name | Description |
---|---|
Nutanix VM | Discover Nutanix virtual machines by querying its SNMP agent |
Nutanix Container | Discover Nutanix containers by querying its SNMP agent |
Nutanix Hypervisor | Discover Nutanix hypervisors by querying its SNMP agent |
More information about discovering hosts automatically is available on the dedicated page.
Service discovery​
Rule name | Description |
---|---|
Virt-Nutanix-SNMP-Disk-Name | Discover disk partitions and monitor space occupation |
Virt-Nutanix-SNMP-Storage-Pools | Discover storage pools and their usage |
More information about discovering services automatically is available on the dedicated page and in the following chapter.
Collected metrics & status​
Here is the list of services for this connector, detailing all metrics and statuses linked to each service.
- Cluster-Usage
- Container-Usage
- Cpu
- Disk-Usage
- Hypervisor-Usage
- Iops
- Latency
- Memory
- Power-State
- Storage
- Storage-Pool-Usage
- Traffic
- Vm-Usage
- Vm-count
Name | Unit |
---|---|
status | N/A |
cluster.storage.space.usage.bytes | B |
cluster.average.io.latency.microseconds | µs |
cluster.operations.iops | iops |
To obtain this new metric format, include --use-new-perfdata in the EXTRAOPTIONS service macro.
Name | Unit |
---|---|
container#container.storage.space.usage.bytes | B |
container#container.average.io.latency.microseconds | µs |
container#container.operations.iops | iops |
To obtain this new metric format, include --use-new-perfdata in the EXTRAOPTIONS service macro.
Name | Unit |
---|---|
hypervisor#hypervisor.cpu.utilization.percentage | % |
hypervisor#hypervisor.memory.usage.bytes | B |
hypervisor#hypervisor.average.io.latency.microseconds | µs |
hypervisor#hypervisor.read.usage.iops | iops |
hypervisor#hypervisor.write.usage.iops | iops |
hypervisor#hypervisor.vm.count | count |
To obtain this new metric format, include --use-new-perfdata in the EXTRAOPTIONS service macro.
Name | Unit |
---|---|
status | N/A |
controllervm~disk_name#disk.storage.space.usage.bytes | B |
controllervm~disk_name#disk.storage.inodes.usage.percentage | % |
controllervm~disk_name#disk.average.io.latency.milliseconds | ms |
controllervm~disk_name#disk.operations.iops | iops |
Name | Unit |
---|---|
hypervisor#hypervisor.cpu.utilization.percentage | % |
hypervisor#hypervisor.memory.usage.bytes | B |
hypervisor#hypervisor.average.io.latency.microseconds | µs |
hypervisor#hypervisor.read.usage.iops | iops |
hypervisor#hypervisor.write.usage.iops | iops |
hypervisor#hypervisor.vm.count | count |
To obtain this new metric format, include --use-new-perfdata in the EXTRAOPTIONS service macro.
Name | Unit |
---|---|
container#container.storage.space.usage.bytes | B |
container#container.average.io.latency.microseconds | µs |
container#container.operations.iops | iops |
To obtain this new metric format, include --use-new-perfdata in the EXTRAOPTIONS service macro.
Name | Unit |
---|---|
container#container.storage.space.usage.bytes | B |
container#container.average.io.latency.microseconds | µs |
container#container.operations.iops | iops |
To obtain this new metric format, include --use-new-perfdata in the EXTRAOPTIONS service macro.
Name | Unit |
---|---|
hypervisor#hypervisor.cpu.utilization.percentage | % |
hypervisor#hypervisor.memory.usage.bytes | B |
hypervisor#hypervisor.average.io.latency.microseconds | µs |
hypervisor#hypervisor.read.usage.iops | iops |
hypervisor#hypervisor.write.usage.iops | iops |
hypervisor#hypervisor.vm.count | count |
To obtain this new metric format, include --use-new-perfdata in the EXTRAOPTIONS service macro.
Name | Unit |
---|---|
vm-power-state | N/A |
vm#vm.cpu.utilization.percentage | % |
vm#vm.memory.usage.bytes | B |
vm#vm.average.io.latency.microseconds | µs |
vm#vm.read.usage.iops | iops |
vm#vm.write.usage.iops | iops |
vm#vm.traffic.in.bitspersecond | b/s |
vm#vm.traffic.out.bitspersecond | b/s |
To obtain this new metric format, include --use-new-perfdata in the EXTRAOPTIONS service macro.
Name | Unit |
---|---|
container#container.storage.space.usage.bytes | B |
container#container.average.io.latency.microseconds | µs |
container#container.operations.iops | iops |
To obtain this new metric format, include --use-new-perfdata in the EXTRAOPTIONS service macro.
Name | Unit |
---|---|
sp#storagepool.storage.space.usage.bytes | B |
sp#storagepool.average.io.latency.microseconds | µs |
sp#storagepool.operations.iops | iops |
To obtain this new metric format, include --use-new-perfdata in the EXTRAOPTIONS service macro.
Name | Unit |
---|---|
vm-power-state | N/A |
vm#vm.cpu.utilization.percentage | % |
vm#vm.memory.usage.bytes | B |
vm#vm.average.io.latency.microseconds | µs |
vm#vm.read.usage.iops | iops |
vm#vm.write.usage.iops | iops |
vm#vm.traffic.in.bitspersecond | b/s |
vm#vm.traffic.out.bitspersecond | b/s |
To obtain this new metric format, include --use-new-perfdata in the EXTRAOPTIONS service macro.
Name | Unit |
---|---|
vm-power-state | N/A |
vm#vm.cpu.utilization.percentage | % |
vm#vm.memory.usage.bytes | B |
vm#vm.average.io.latency.microseconds | µs |
vm#vm.read.usage.iops | iops |
vm#vm.write.usage.iops | iops |
vm#vm.traffic.in.bitspersecond | b/s |
vm#vm.traffic.out.bitspersecond | b/s |
To obtain this new metric format, include --use-new-perfdata in the EXTRAOPTIONS service macro.
Name | Unit |
---|---|
hypervisor#hypervisor.cpu.utilization.percentage | % |
hypervisor#hypervisor.memory.usage.bytes | B |
hypervisor#hypervisor.average.io.latency.microseconds | µs |
hypervisor#hypervisor.read.usage.iops | iops |
hypervisor#hypervisor.write.usage.iops | iops |
hypervisor#hypervisor.vm.count | count |
To obtain this new metric format, include --use-new-perfdata in the EXTRAOPTIONS service macro.
Prerequisites​
SNMP Configuration​
The SNMP agent must be enabled and configured on the resource. Please refer to the official documentation from the manufacturer/publisher. Your resource may require a list of addresses authorized to query it to be set up. Please ensure that the addresses of the Centreon pollers are included in this list.
Network flow​
The target resource must be reachable from the Centreon poller on the UDP/161 SNMP port.
Installing the monitoring connector​
Pack​
- If the platform uses an online license, you can skip the package installation instruction below as it is not required to have the connector displayed within the Configuration > Monitoring Connector Manager menu. If the platform uses an offline license, install the package on the central server with the command corresponding to the operating system's package manager:
- Alma / RHEL / Oracle Linux 8
- Alma / RHEL / Oracle Linux 9
- Debian 11 & 12
- CentOS 7
dnf install centreon-pack-virtualization-nutanix-snmp
dnf install centreon-pack-virtualization-nutanix-snmp
apt install centreon-pack-virtualization-nutanix-snmp
yum install centreon-pack-virtualization-nutanix-snmp
- Whatever the license type (online or offline), install the Nutanix SNMP connector through the Configuration > Monitoring Connector Manager menu.
Plugin​
Since Centreon 22.04, you can benefit from the 'Automatic plugin installation' feature. When this feature is enabled, you can skip the installation part below.
You still have to manually install the plugin on the poller(s) when:
- Automatic plugin installation is turned off
- You want to run a discovery job from a poller that doesn't monitor any resource of this kind yet
More information in the Installing the plugin section.
Use the commands below according to your operating system's package manager:
- Alma / RHEL / Oracle Linux 8
- Alma / RHEL / Oracle Linux 9
- Debian 11 & 12
- CentOS 7
dnf install centreon-plugin-Virtualization-Nutanix-Snmp
dnf install centreon-plugin-Virtualization-Nutanix-Snmp
apt install centreon-plugin-virtualization-nutanix-snmp
yum install centreon-plugin-Virtualization-Nutanix-Snmp
Using the monitoring connector​
Using a host template provided by the connector​
- Virt-Nutanix-Container-SNMP-custom
- Virt-Nutanix-Hypervisor-SNMP-custom
- Virt-Nutanix-SNMP-custom
- Virt-Nutanix-VM-SNMP-custom
- Log into Centreon and add a new host through Configuration > Hosts.
- Fill in the Name, Alias & IP Address/DNS fields according to your resource's settings.
- Apply the Virt-Nutanix-Container-SNMP-custom template to the host.
When using SNMP v3, use the SNMPEXTRAOPTIONS macro to add specific authentication parameters. More information in the Troubleshooting SNMP section.
Macro | Description | Default value | Mandatory |
---|---|---|---|
FILTERNAME | Filter container name (can be a regexp) | ||
SNMPEXTRAOPTIONS | Any extra option you may want to add to every command (a --verbose flag for example). All options are listed here. |
- Deploy the configuration. The host appears in the list of hosts, and on the Resources Status page. The command that is sent by the connector is displayed in the details panel of the host: it shows the values of the macros.
- Log into Centreon and add a new host through Configuration > Hosts.
- Fill in the Name, Alias & IP Address/DNS fields according to your resource's settings.
- Apply the Virt-Nutanix-Hypervisor-SNMP-custom template to the host.
When using SNMP v3, use the SNMPEXTRAOPTIONS macro to add specific authentication parameters. More information in the Troubleshooting SNMP section.
Macro | Description | Default value | Mandatory |
---|---|---|---|
FILTERNAME | Filter hypervisor name (can be a regexp) | ||
SNMPEXTRAOPTIONS | Any extra option you may want to add to every command (a --verbose flag for example). All options are listed here. |
- Deploy the configuration. The host appears in the list of hosts, and on the Resources Status page. The command that is sent by the connector is displayed in the details panel of the host: it shows the values of the macros.
- Log into Centreon and add a new host through Configuration > Hosts.
- Fill in the Name, Alias & IP Address/DNS fields according to your resource's settings.
- Apply the Virt-Nutanix-SNMP-custom template to the host.
When using SNMP v3, use the SNMPEXTRAOPTIONS macro to add specific authentication parameters. More information in the Troubleshooting SNMP section.
Macro | Description | Default value | Mandatory |
---|---|---|---|
SNMPEXTRAOPTIONS | Any extra option you may want to add to every command (a --verbose flag for example). All options are listed here. |
- Deploy the configuration. The host appears in the list of hosts, and on the Resources Status page. The command that is sent by the connector is displayed in the details panel of the host: it shows the values of the macros.
- Log into Centreon and add a new host through Configuration > Hosts.
- Fill in the Name, Alias & IP Address/DNS fields according to your resource's settings.
- Apply the Virt-Nutanix-VM-SNMP-custom template to the host.
When using SNMP v3, use the SNMPEXTRAOPTIONS macro to add specific authentication parameters. More information in the Troubleshooting SNMP section.
Macro | Description | Default value | Mandatory |
---|---|---|---|
FILTERNAME | Filter virtual machine name (can be a regexp) | ||
SNMPEXTRAOPTIONS | Any extra option you may want to add to every command (a --verbose flag for example). All options are listed here. |
- Deploy the configuration. The host appears in the list of hosts, and on the Resources Status page. The command that is sent by the connector is displayed in the details panel of the host: it shows the values of the macros.
Using a service template provided by the connector​
- If you have used a host template and checked Create Services linked to the Template too, the services linked to the template have been created automatically, using the corresponding service templates. Otherwise, create manually the services you want and apply a service template to them.
- Fill in the macros you want (e.g. to change the thresholds for the alerts). Some macros are mandatory (see the table below).
- Cluster-Usage
- Container-Usage
- Cpu
- Disk-Usage
- Hypervisor-Usage
- Iops
- Latency
- Memory
- Power-State
- Storage
- Storage-Pool-Usage
- Traffic
- Vm-Usage
- Vm-count
Macro | Description | Default value | Mandatory |
---|---|---|---|
WARNINGAVGLATENCY | Threshold | ||
CRITICALAVGLATENCY | Threshold | ||
WARNINGIOPS | Threshold | ||
CRITICALIOPS | Threshold | ||
CRITICALSTATUS | Define the conditions to match for the status to be CRITICAL. You can use the following variables: %{status}, %{display} | %{status} ne "started" | |
WARNINGSTATUS | Define the conditions to match for the status to be WARNING. You can use the following variables: %{status}, %{display} | ||
WARNINGUSAGE | Threshold | ||
CRITICALUSAGE | Threshold | ||
EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). All options are listed here. |
Macro | Description | Default value | Mandatory |
---|---|---|---|
FILTERNAME | Filter container name (can be a regexp) | ||
WARNINGAVGLATENCY | Threshold | ||
CRITICALAVGLATENCY | Threshold | ||
WARNINGIOPS | Threshold | ||
CRITICALIOPS | Threshold | ||
WARNINGUSAGE | Threshold | ||
CRITICALUSAGE | Threshold | ||
EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). All options are listed here. | --verbose |
Macro | Description | Default value | Mandatory |
---|---|---|---|
FILTERCOUNTERS | Only display some counters (regexp can be used). Example: --filter-counters='^memory$' | ^cpu$ | |
WARNINGCPU | Threshold | ||
CRITICALCPU | Threshold | ||
EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). All options are listed here. | --verbose |
Macro | Description | Default value | Mandatory |
---|---|---|---|
FILTERCONTROLLERVM | Filter controllervm name (can be a regexp) | ||
FILTERNAME | Filter disk name (can be a regexp) | ||
WARNINGAVGLATENCY | Threshold | ||
CRITICALAVGLATENCY | Threshold | ||
WARNINGIOPS | Threshold | ||
CRITICALIOPS | Threshold | ||
WARNINGSTATUS | Define the conditions to match for the status to be WARNING. You can use the following variables: %{state}, %{crtName}, %{diskId} | ||
CRITICALSTATUS | Define the conditions to match for the status to be CRITICAL. You can use the following variables: %{state}, %{crtName}, %{diskId} | ||
WARNINGUSAGE | Threshold | ||
CRITICALUSAGE | Threshold | ||
EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). All options are listed here. | --verbose |
Macro | Description | Default value | Mandatory |
---|---|---|---|
FILTERNAME | Filter hypervisor name (can be a regexp) | ||
WARNINGAVGLATENCY | Threshold | ||
CRITICALAVGLATENCY | Threshold | ||
WARNINGCPU | Threshold | ||
CRITICALCPU | Threshold | ||
WARNINGMEMORY | Threshold | ||
CRITICALMEMORY | Threshold | ||
WARNINGREADIOPS | Threshold | ||
CRITICALREADIOPS | Threshold | ||
WARNINGVMCOUNT | Threshold | ||
CRITICALVMCOUNT | Threshold | ||
WARNINGWRITEIOPS | Threshold | ||
CRITICALWRITEIOPS | Threshold | ||
EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). All options are listed here. | --verbose |
Macro | Description | Default value | Mandatory |
---|---|---|---|
FILTERCOUNTERS | Only display some counters (regexp can be used). Example: --filter-counters='^memory$' | ^iops$ | |
WARNINGIOPS | Threshold | ||
CRITICALIOPS | Threshold | ||
EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). All options are listed here. | --verbose |
Macro | Description | Default value | Mandatory |
---|---|---|---|
FILTERCOUNTERS | Only display some counters (regexp can be used). Example: --filter-counters='^memory$' | ^avg-latency$ | |
WARNINGAVGLATENCY | Threshold | ||
CRITICALAVGLATENCY | Threshold | ||
EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). All options are listed here. | --verbose |
Macro | Description | Default value | Mandatory |
---|---|---|---|
FILTERCOUNTERS | Only display some counters (regexp can be used). Example: --filter-counters='^memory$' | ^memory$ | |
WARNINGMEMORY | Threshold | ||
CRITICALMEMORY | Threshold | ||
EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). All options are listed here. | --verbose |
Macro | Description | Default value | Mandatory |
---|---|---|---|
WARNINGVMPOWERSTATE | Set warning threshold for the virtual machine power state. You can use the following variables: %{vmPowerState} | ||
CRITICALVMPOWERSTATE | Set critical threshold for the virtual machine power state. You can use the following variables: %{vmPowerState} | ||
EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). All options are listed here. | --verbose |
Macro | Description | Default value | Mandatory |
---|---|---|---|
FILTERCOUNTERS | Only display some counters (regexp can be used). Example: --filter-counters='^usage$' | ^usage$ | |
WARNINGUSAGE | Threshold | ||
CRITICALUSAGE | Threshold | ||
EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). All options are listed here. | --verbose |
Macro | Description | Default value | Mandatory |
---|---|---|---|
FILTERNAME | Filter storage pool name (can be a regexp) | ||
WARNINGAVGLATENCY | Threshold | ||
CRITICALAVGLATENCY | Threshold | ||
WARNINGIOPS | Threshold | ||
CRITICALIOPS | Threshold | ||
WARNINGUSAGE | Threshold | ||
CRITICALUSAGE | Threshold | ||
EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). All options are listed here. | --verbose |
Macro | Description | Default value | Mandatory |
---|---|---|---|
FILTERCOUNTERS | Only display some counters (regexp can be used). Example: --filter-counters='^memory$' | ^traffic.*$ | |
WARNINGTRAFFICIN | Threshold | ||
CRITICALTRAFFICIN | Threshold | ||
WARNINGTRAFFICOUT | Threshold | ||
CRITICALTRAFFICOUT | Threshold | ||
EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). All options are listed here. | --verbose |
Macro | Description | Default value | Mandatory |
---|---|---|---|
FILTERNAME | Filter virtual machine name (can be a regexp) | ||
WARNINGAVGLATENCY | Threshold | ||
CRITICALAVGLATENCY | Threshold | ||
WARNINGCPU | Threshold | ||
CRITICALCPU | Threshold | ||
WARNINGREADIOPS | Threshold | ||
CRITICALREADIOPS | Threshold | ||
WARNINGTRAFFICIN | Threshold | ||
CRITICALTRAFFICIN | Threshold | ||
WARNINGTRAFFICOUT | Threshold | ||
CRITICALTRAFFICOUT | Threshold | ||
WARNINGWRITEIOPS | Threshold | ||
CRITICALWRITEIOPS | Threshold | ||
EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). All options are listed here. | --verbose |
Macro | Description | Default value | Mandatory |
---|---|---|---|
FILTERCOUNTERS | Only display some counters (regexp can be used). Example: --filter-counters='^memory$' | ^vm-count$ | |
WARNINGVMCOUNT | Threshold | ||
CRITICALVMCOUNT | Threshold | ||
EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). All options are listed here. | --verbose |
- Deploy the configuration. The service appears in the list of services, and on the Resources Status page. The command that is sent by the connector is displayed in the details panel of the service: it shows the values of the macros.
How to check in the CLI that the configuration is OK and what are the main options for?​
Once the plugin is installed, log into your Centreon poller's CLI using the
centreon-engine user account (su - centreon-engine
). Test that the connector
is able to monitor a resource using a command like this one (replace the sample values by yours):
/usr/lib/centreon/plugins/centreon_nutanix_snmp.pl \
--plugin=cloud::nutanix::snmp::plugin \
--mode=hypervisor-usage \
--hostname=10.0.0.1 \
--snmp-version='2c' \
--snmp-community='my-snmp-community' \
--filter-name='' \
--warning-count='' \
--critical-count='' \
--filter-counters='^vm-count$' \
--verbose
The expected command output is shown below:
OK: Hypervisor 'abc-123ntx1' VM Count : 2 | 'abc-123ntx1#hypervisor.vm.count'=2;;;0;
Troubleshooting​
Please find the troubleshooting documentation for Centreon Plugins typical issues.
Available modes​
In most cases, a mode corresponds to a service template. The mode appears in the execution command for the connector. In the Centreon interface, you don't need to specify a mode explicitly: its use is implied when you apply a service template. However, you will need to specify the correct mode for the template if you want to test the execution command for the connector in your terminal.
All available modes can be displayed by adding the --list-mode
parameter to
the command:
/usr/lib/centreon/plugins/centreon_nutanix_snmp.pl \
--plugin=cloud::nutanix::snmp::plugin \
--list-mode
The plugin brings the following modes:
Mode | Linked service template |
---|---|
cluster-usage [code] | Virt-Nutanix-Cluster-Usage-SNMP-custom |
container-usage [code] | Virt-Nutanix-Container-Usage-SNMP-custom Virt-Nutanix-Container-Iops-SNMP-custom Virt-Nutanix-Container-Latency-SNMP-custom Virt-Nutanix-Container-Storage-SNMP-custom |
discovery [code] | Used for host discovery |
disk-usage [code] | Virt-Nutanix-Disk-Usage-SNMP-custom |
hypervisor-usage [code] | Virt-Nutanix-Hypervisor-Cpu-SNMP-custom Virt-Nutanix-Hypervisor-Usage-SNMP-custom Virt-Nutanix-Hypervisor-Iops-SNMP-custom Virt-Nutanix-Hypervisor-Latency-SNMP-custom Virt-Nutanix-Hypervisor-Memory-SNMP-custom Virt-Nutanix-Hypervisor-Vm-Count-SNMP-custom |
list-containers [code] | Not used in this Monitoring Connector |
list-disks [code] | Used for service discovery |
list-hypervisors [code] | Not used in this Monitoring Connector |
list-storage-pools [code] | Used for service discovery |
list-vms [code] | Not used in this Monitoring Connector |
storage-pool-usage [code] | Virt-Nutanix-Storage-Pool-Usage-SNMP-custom |
vm-usage [code] | Virt-Nutanix-VM-Cpu-SNMP-custom Virt-Nutanix-VM-Iops-SNMP-custom Virt-Nutanix-VM-Latency-SNMP-custom Virt-Nutanix-VM-Power-State-SNMP-custom Virt-Nutanix-VM-Traffic-SNMP-custom Virt-Nutanix-Vm-Usage-SNMP-custom |
Available options​
Generic options​
All generic options are listed here:
Option | Description |
---|---|
--mode | Define the mode in which you want the plugin to be executed (see --list-mode). |
--dyn-mode | Specify a mode with the module's path (advanced). |
--list-mode | List all available modes. |
--mode-version | Check minimal version of mode. If not, unknown error. |
--version | Return the version of the plugin. |
--pass-manager | Define the password manager you want to use. Supported managers are: environment, file, keepass, hashicorpvault and teampass. |
--hostname | Name or address of the host to monitor (mandatory). |
--snmp-community | SNMP community (default value: public). It is recommended to use a read-only community. |
--snmp-version | Version of the SNMP protocol. 1 for SNMP v1 (default), 2 for SNMP v2c, 3 for SNMP v3. |
--snmp-port | UDP port to send the SNMP request to (default: 161). |
--snmp-timeout | Time to wait before sending the request again if no reply has been received, in seconds (default: 1). See also --snmp-retries. |
--snmp-retries | Maximum number of retries (default: 5). |
--maxrepetitions | Max repetitions value (default: 50) (only for SNMP v2 and v3). |
--subsetleef | How many OID values per SNMP request (default: 50) (for get_leef method. Be cautious when you set it. Prefer to let the default value). |
--snmp-autoreduce | Progressively reduce the number of requested OIDs in bulk mode. Use it in case of SNMP errors (by default, the number is divided by 2). |
--snmp-force-getnext | Use SNMP getnext function in SNMP v2c and v3. This will request one OID at a time. |
--snmp-cache-file | Use SNMP cache file. |
--snmp-username | SNMP v3 only: User name (securityName). |
--authpassphrase | SNMP v3 only: Pass phrase hashed using the authentication protocol defined in the --authprotocol option. |
--authprotocol | SNMP v3 only: Authentication protocol: MD5|SHA. Since net-snmp 5.9.1: SHA224|SHA256|SHA384|SHA512. |
--privpassphrase | SNMP v3 only: Privacy pass phrase (privPassword) to encrypt messages using the protocol defined in the --privprotocol option. |
--privprotocol | SNMP v3 only: Privacy protocol (privProtocol) used to encrypt messages. Supported protocols are: DES|AES and since net-snmp 5.9.1: AES192|AES192C|AES256|AES256C. |
--contextname | SNMP v3 only: Context name (contextName), if relevant for the monitored host. |
--contextengineid | SNMP v3 only: Context engine ID (contextEngineID), if relevant for the monitored host, given as a hexadecimal string. |
--securityengineid | SNMP v3 only: Security engine ID, given as a hexadecimal string. |
--snmp-errors-exit | Expected status in case of SNMP error or timeout. Possible values are warning, critical and unknown (default). |
--snmp-tls-transport | Transport protocol for TLS communication (can be: 'dtlsudp', 'tlstcp'). |
--snmp-tls-our-identity | X.509 certificate to identify ourselves. Can be the path to the certificate file or its contents. |
--snmp-tls-their-identity | X.509 certificate to identify the remote host. Can be the path to the certificate file or its contents. This option is unnecessary if the certificate is already trusted by your system. |
--snmp-tls-their-hostname | Common Name (CN) expected in the certificate sent by the host if it differs from the value of the --hostname parameter. |
--snmp-tls-trust-cert | A trusted CA certificate used to verify a remote host's certificate. If you use this option, you must also define --snmp-tls-their-hostname. |
--verbose | Display extended status information (long output). |
--debug | Display debug messages. |
--filter-perfdata | Filter perfdata that match the regexp. Example: adding --filter-perfdata='avg' will remove all metrics that do not contain 'avg' from performance data. |
--filter-perfdata-adv | Filter perfdata based on a "if" condition using the following variables: label, value, unit, warning, critical, min, max. Variables must be written either %{variable} or %(variable). Example: adding --filter-perfdata-adv='not (%(value) == 0 and %(max) eq "")' will remove all metrics whose value equals 0 and that don't have a maximum value. |
--explode-perfdata-max | Create a new metric for each metric that comes with a maximum limit. The new metric will be named identically with a '_max' suffix. Example: it will split 'used_prct'=26.93%;0:80;0:90;0;100 into 'used_prct'=26.93%;0:80;0:90;0;100 'used_prct_max'=100%;;;; |
--change-perfdata --extend-perfdata | Change or extend perfdata. Syntax: --extend-perfdata=searchlabel,newlabel,target[,[<new-unit-of-mesure>],[min],[max]] Common examples: =over 4 Convert storage free perfdata into used: --change-perfdata='free,used,invert()' Convert storage free perfdata into used: --change-perfdata='used,free,invert()' Scale traffic values automatically: --change-perfdata='traffic,,scale(auto)' Scale traffic values in Mbps: --change-perfdata='traffic_in,,scale(Mbps),mbps' Change traffic values in percent: --change-perfdata='traffic_in,,percent()' =back |
--change-perfdata | Change or extend perfdata. Syntax: --extend-perfdata=searchlabel,newlabel,target[,[<new-unit-of-mesure>],[min],[max]] Common examples: =over 4 Convert storage free perfdata into used: --change-perfdata='free,used,invert()' Convert storage free perfdata into used: --change-perfdata='used,free,invert()' Scale traffic values automatically: --change-perfdata='traffic,,scale(auto)' Scale traffic values in Mbps: --change-perfdata='traffic_in,,scale(Mbps),mbps' Change traffic values in percent: --change-perfdata='traffic_in,,percent()' =back |
--extend-perfdata | Change or extend perfdata. Syntax: --extend-perfdata=searchlabel,newlabel,target[,[<new-unit-of-mesure>],[min],[max]] Common examples: =over 4 Convert storage free perfdata into used: --change-perfdata='free,used,invert()' Convert storage free perfdata into used: --change-perfdata='used,free,invert()' Scale traffic values automatically: --change-perfdata='traffic,,scale(auto)' Scale traffic values in Mbps: --change-perfdata='traffic_in,,scale(Mbps),mbps' Change traffic values in percent: --change-perfdata='traffic_in,,percent()' =back |
--extend-perfdata-group | Add new aggregated metrics (min, max, average or sum) for groups of metrics defined by a regex match on the metrics' names. Syntax: --extend-perfdata-group=regex,<names-of-new-metrics>,calculation[,[<new-unit-of-mesure>],[min],[max]] regex: regular expression <names-of-new-metrics>: how the new metrics' names are composed (can use $1, $2... for groups defined by () in regex). calculation: how the values of the new metrics should be calculated <new-unit-of-mesure> (optional): unit of measure for the new metrics min (optional): lowest value the metrics can reach max (optional): highest value the metrics can reach Common examples: =over 4 Sum wrong packets from all interfaces (with interface need --units-errors=absolute): --extend-perfdata-group=',packets_wrong,sum(packets_(discard|error)_(in|out))' Sum traffic by interface: --extend-perfdata-group='traffic_in_(.*),traffic_$1,sum(traffic_(in|out)_$1)' =back |
--change-short-output --change-long-output | Modify the short/long output that is returned by the plugin. Syntax: --change-short-output=pattern |
--change-short-output | Modify the short/long output that is returned by the plugin. Syntax: --change-short-output=pattern |
--change-long-output | Modify the short/long output that is returned by the plugin. Syntax: --change-short-output=pattern |
--change-exit | Replace an exit code with one of your choice. Example: adding --change-exit=unknown=critical will result in a CRITICAL state instead of an UNKNOWN state. |
--change-output-adv | Replace short output and exit code based on a "if" condition using the following variables: short_output, exit_code. Variables must be written either %{variable} or %(variable). Example: adding --change-output-adv='%(short_ouput) =~ /UNKNOWN: No daemon/,OK: No daemon,OK' will change the following specific UNKNOWN result to an OK result. |
--range-perfdata | Rewrite the ranges displayed in the perfdata. Accepted values: 0: nothing is changed. 1: if the lower value of the range is equal to 0, it is removed. 2: remove the thresholds from the perfdata. |
--filter-uom | Mask the units when they don't match the given regular expression. |
--opt-exit | Replace the exit code in case of an execution error (i.e. wrong option provided, SSH connection refused, timeout, etc). Default: unknown. |
--output-ignore-perfdata | Remove all the metrics from the service. The service will still have a status and an output. |
--output-ignore-label | Remove the status label ("OK:", "WARNING:", "UNKNOWN:", CRITICAL:") from the beginning of the output. Example: 'OK: Ram Total:...' will become 'Ram Total:...' |
--output-xml | Return the output in XML format (to send to an XML API). |
--output-json | Return the output in JSON format (to send to a JSON API). |
--output-openmetrics | Return the output in OpenMetrics format (to send to a tool expecting this format). |
--output-file | Write output in file (can be combined with JSON, XML and OpenMetrics options). Example: --output-file=/tmp/output.txt will write the output in /tmp/output.txt. |
--disco-format | Applies only to modes beginning with 'list-'. Returns the list of available macros to configure a service discovery rule (formatted in XML). |
--disco-show | Applies only to modes beginning with 'list-'. Returns the list of discovered objects (formatted in XML) for service discovery. |
--float-precision | Define the float precision for thresholds (default: 8). |
--source-encoding | Define the character encoding of the response sent by the monitored resource Default: 'UTF-8'. =head1 DESCRIPTION B<output>. =cut |
Modes options​
All available options for each service template are listed below:
- Cluster-Usage
- Container-Usage
- Cpu
- Disk-Usage
- Hypervisor-Usage
- Iops
- Latency
- Memory
- Power-State
- Storage
- Storage-Pool-Usage
- Traffic
- Vm-Usage
- Vm-count
Option | Description |
---|---|
--filter-counters | Only display some counters (regexp can be used). Example: --filter-counters='^usage$' |
--warning-status | Define the conditions to match for the status to be WARNING. You can use the following variables: %{status}, %{display} |
--critical-status | Define the conditions to match for the status to be CRITICAL. You can use the following variables: %{status}, %{display} |
--warning-* | Warning threshold. Can be: 'usage', 'avg-latency', 'iops'. |
--critical-* | Critical threshold. Can be: 'usage', 'avg-latency', 'iops'. |
--units | Units of thresholds (default: '%') ('%', 'B'). |
--free | Thresholds are on free space left. |
Option | Description |
---|---|
--filter-counters | Only display some counters (regexp can be used). Example: --filter-counters='^usage$' |
--filter-name | Filter container name (can be a regexp). |
--warning-* | Warning threshold. Can be: 'usage', 'avg-latency', 'iops'. |
--critical-* | Critical threshold. Can be: 'usage', 'avg-latency', 'iops'. |
--units | Units of thresholds (default: '%') ('%', 'B'). |
--free | Thresholds are on free space left. |
Option | Description |
---|---|
--filter-counters | Only display some counters (regexp can be used). Example: --filter-counters='^memory$' |
--filter-name | Filter hypervisor name (can be a regexp). |
--warning-vm-power-state | Set warning threshold for the virtual machine power state. You can use the following variables: %{vmPowerState}. |
--critical-vm-power-state | Set critical threshold for the virtual machine power state. You can use the following variables: %{vmPowerState}. |
--warning-* | Warning threshold. Can be: 'memory' (%), 'avg-latency', 'read-iops', 'write-iops', 'cpu' (%), 'vm-count'. |
--critical-* | Critical threshold. Can be: 'memory' (%), 'avg-latency', 'read-iops', 'write-iops', 'cpu' (%), 'vm-count'. |
Option | Description |
---|---|
--filter-counters | Only display some counters (regexp can be used). Example: --filter-counters='^usage$' |
--filter-name | Filter disk name (can be a regexp). |
--filter-controllervm | Filter controllervm name (can be a regexp). |
--warning-status | Define the conditions to match for the status to be WARNING. You can use the following variables: %{state}, %{crtName}, %{diskId} |
--critical-status | Define the conditions to match for the status to be CRITICAL. You can use the following variables: %{state}, %{crtName}, %{diskId} |
--warning-* | Warning threshold. Can be: 'usage', 'inodes' (%), 'avg-latency', 'iops'. |
--critical-* | Critical threshold. Can be: 'usage', 'inodes' (%), 'avg-latency', 'iops'. |
--units | Units of thresholds (default: '%') ('%', 'B'). |
--free | Thresholds are on free space left. |
Option | Description |
---|---|
--filter-counters | Only display some counters (regexp can be used). Example: --filter-counters='^memory$' |
--filter-name | Filter hypervisor name (can be a regexp). |
--warning-* | Warning threshold. Can be: 'memory' (%), 'avg-latency', 'read-iops', 'write-iops', 'cpu' (%), 'vm-count'. |
--critical-* | Critical threshold. Can be: 'memory' (%), 'avg-latency', 'read-iops', 'write-iops', 'cpu' (%), 'vm-count'. |
Option | Description |
---|---|
--filter-counters | Only display some counters (regexp can be used). Example: --filter-counters='^memory$' |
--filter-name | Filter hypervisor name (can be a regexp). |
--warning-* | Warning threshold. Can be: 'memory' (%), 'avg-latency', 'read-iops', 'write-iops', 'cpu' (%), 'vm-count'. |
--critical-* | Critical threshold. Can be: 'memory' (%), 'avg-latency', 'read-iops', 'write-iops', 'cpu' (%), 'vm-count'. |
--units | Units of thresholds (default: '%') ('%', 'B'). |
--free | Thresholds are on free space left. |
--warning-vm-power-state | Set warning threshold for the virtual machine power state. You can use the following variables: %{vmPowerState}. |
--critical-vm-power-state | Set critical threshold for the virtual machine power state. You can use the following variables: %{vmPowerState}. |
Option | Description |
---|---|
--filter-counters | Only display some counters (regexp can be used). Example: --filter-counters='^memory$' |
--filter-name | Filter hypervisor name (can be a regexp). |
--warning-* | Warning threshold. Can be: 'memory' (%), 'avg-latency', 'read-iops', 'write-iops', 'cpu' (%), 'vm-count'. |
--critical-* | Critical threshold. Can be: 'memory' (%), 'avg-latency', 'read-iops', 'write-iops', 'cpu' (%), 'vm-count'. |
--units | Units of thresholds (default: '%') ('%', 'B'). |
--free | Thresholds are on free space left. |
--warning-vm-power-state | Set warning threshold for the virtual machine power state. You can use the following variables: %{vmPowerState}. |
--critical-vm-power-state | Set critical threshold for the virtual machine power state. You can use the following variables: %{vmPowerState}. |
Option | Description |
---|---|
--filter-counters | Only display some counters (regexp can be used). Example: --filter-counters='^memory$' |
--filter-name | Filter hypervisor name (can be a regexp). |
--warning-* | Warning threshold. Can be: 'memory' (%), 'avg-latency', 'read-iops', 'write-iops', 'cpu' (%), 'vm-count'. |
--critical-* | Critical threshold. Can be: 'memory' (%), 'avg-latency', 'read-iops', 'write-iops', 'cpu' (%), 'vm-count'. |
Option | Description |
---|---|
--filter-counters | Only display some counters (regexp can be used). Example: --filter-counters='^memory$' |
--filter-name | Filter virtual machine name (can be a regexp). |
--warning-vm-power-state | Set warning threshold for the virtual machine power state. You can use the following variables: %{vmPowerState}. |
--critical-vm-power-state | Set critical threshold for the virtual machine power state. You can use the following variables: %{vmPowerState}. |
--warning-* | Warning threshold. Can be: 'avg-latency', 'read-iops', 'write-iops', 'cpu' (%), 'memory' (%s), 'traffic-in', 'traffic-out'. |
--critical-* | Critical threshold. Can be: 'avg-latency', 'read-iops', 'write-iops', 'cpu' (%), 'memory' (%s), 'traffic-in', 'traffic-out'. |
Option | Description |
---|---|
--filter-counters | Only display some counters (regexp can be used). Example: --filter-counters='^usage$' |
--filter-name | Filter container name (can be a regexp). |
--warning-* | Warning threshold. Can be: 'usage', 'avg-latency', 'iops'. |
--critical-* | Critical threshold. Can be: 'usage', 'avg-latency', 'iops'. |
--units | Units of thresholds (default: '%') ('%', 'B'). |
--free | Thresholds are on free space left. |
Option | Description |
---|---|
--filter-counters | Only display some counters (regexp can be used). Example: --filter-counters='^usage$' |
--filter-name | Filter storage pool name (can be a regexp). |
--warning-* | Warning threshold. Can be: 'usage', 'avg-latency', 'iops'. |
--critical-* | Critical threshold. Can be: 'usage', 'avg-latency', 'iops'. |
--units | Units of thresholds (default: '%') ('%', 'B'). |
--free | Thresholds are on free space left. |
Option | Description |
---|---|
--filter-counters | Only display some counters (regexp can be used). Example: --filter-counters='^memory$' |
--filter-name | Filter virtual machine name (can be a regexp). |
--warning-vm-power-state | Set warning threshold for the virtual machine power state. You can use the following variables: %{vmPowerState}. |
--critical-vm-power-state | Set critical threshold for the virtual machine power state. You can use the following variables: %{vmPowerState}. |
--warning-* | Warning threshold. Can be: 'avg-latency', 'read-iops', 'write-iops', 'cpu' (%), 'memory' (%s), 'traffic-in', 'traffic-out'. |
--critical-* | Critical threshold. Can be: 'avg-latency', 'read-iops', 'write-iops', 'cpu' (%), 'memory' (%s), 'traffic-in', 'traffic-out'. |
Option | Description |
---|---|
--filter-counters | Only display some counters (regexp can be used). Example: --filter-counters='^memory$' |
--filter-name | Filter virtual machine name (can be a regexp). |
--warning-vm-power-state | Set warning threshold for the virtual machine power state. You can use the following variables: %{vmPowerState}. |
--critical-vm-power-state | Set critical threshold for the virtual machine power state. You can use the following variables: %{vmPowerState}. |
--warning-* | Warning threshold. Can be: 'avg-latency', 'read-iops', 'write-iops', 'cpu' (%), 'memory' (%s), 'traffic-in', 'traffic-out'. |
--critical-* | Critical threshold. Can be: 'avg-latency', 'read-iops', 'write-iops', 'cpu' (%), 'memory' (%s), 'traffic-in', 'traffic-out'. |
Option | Description |
---|---|
--filter-counters | Only display some counters (regexp can be used). Example: --filter-counters='^memory$' |
--filter-name | Filter hypervisor name (can be a regexp). |
--warning-* | Warning threshold. Can be: 'memory' (%), 'avg-latency', 'read-iops', 'write-iops', 'cpu' (%), 'vm-count'. |
--critical-* | Critical threshold. Can be: 'memory' (%), 'avg-latency', 'read-iops', 'write-iops', 'cpu' (%), 'vm-count'. |
All available options for a given mode can be displayed by adding the
--help
parameter to the command:
/usr/lib/centreon/plugins/centreon_nutanix_snmp.pl \
--plugin=cloud::nutanix::snmp::plugin \
--mode=hypervisor-usage \
--help