From dc1e3febbd4a530ca72b6f22632c5d26d22d1791 Mon Sep 17 00:00:00 2001 From: lucie-tirand Date: Mon, 22 Jun 2026 15:24:02 +0200 Subject: [PATCH 1/6] fix missing from CTOR-2360) --- .../procedures/applications-protocol-snmp.md | 48 +++++++++++-------- .../procedures/operatingsystems-hpux-snmp.md | 3 -- .../procedures/operatingsystems-linux-snmp.md | 3 -- .../procedures/operatingsystems-mac-snmp.md | 3 -- .../procedures/applications-protocol-snmp.md | 48 +++++++++++-------- 5 files changed, 58 insertions(+), 47 deletions(-) diff --git a/i18n/fr/docusaurus-plugin-content-docs-pp/current/integrations/plugin-packs/procedures/applications-protocol-snmp.md b/i18n/fr/docusaurus-plugin-content-docs-pp/current/integrations/plugin-packs/procedures/applications-protocol-snmp.md index 4085c84efc40..984d175a5b4c 100644 --- a/i18n/fr/docusaurus-plugin-content-docs-pp/current/integrations/plugin-packs/procedures/applications-protocol-snmp.md +++ b/i18n/fr/docusaurus-plugin-content-docs-pp/current/integrations/plugin-packs/procedures/applications-protocol-snmp.md @@ -76,9 +76,9 @@ Rendez-vous sur la [documentation dédiée](/docs/monitoring/discovery/hosts-dis #### Découverte de services -| Nom de la règle | Description | -|:----------------------------------|:------------| -| App-Protocol-SNMP-Collection-Name | Découvre les données SNMP en utilisant des collections | +| Nom de la règle | Description | +|:----------------------------------|:-------------------------------------------------------| +| App-Protocol-SNMP-Collection-Name | Découvre les données SNMP en utilisant des collections | Rendez-vous sur la [documentation dédiée](/docs/monitoring/discovery/services-discovery) pour en savoir plus sur la découverte automatique de services et sa [planification](/docs/monitoring/discovery/services-discovery/#règles-de-découverte). @@ -234,9 +234,14 @@ yum install centreon-plugin-Applications-Protocol-Snmp 2. Complétez les champs **Nom**, **Alias** & **IP Address/DNS** correspondant à votre ressource. 3. Appliquez le modèle d'hôte **App-Protocol-SNMP-custom**. -| Macro | Description | Valeur par défaut | Obligatoire | -|:-----------------|:---------------------------------------------------------------------------------------------------------------------------------------------------|:------------------|:-----------:| -| SNMPEXTRAOPTIONS | Any extra option you may want to add to every command (a --verbose flag for example). Toutes les options sont listées [ici](#options-disponibles). | | | +| Macro | Description | Valeur par défaut | Obligatoire | +|:------------------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------|:------------------|:-----------:| +| SNMP_V3_USERNAME | SNMP v3 only: User name (`securityName`) | | | +| SNMP_V3_AUTH_PROTOCOL | SNMP v3 only: Authentication protocol: MD5\|SHA. Since net-snmp 5.9.1: SHA224\|SHA256\|SHA384\|SHA512 | | | +| SNMP_V3_PRIV_PROTOCOL | 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 | | | +| SNMP_V3_AUTH_PASSPHRASE | SNMP v3 only: Pass phrase hashed using the authentication protocol defined in the --authprotocol option | | | +| SNMP_V3_PRIV_PASSPHRASE | SNMP v3 only: Privacy pass phrase (`privPassword`) to encrypt messages using the protocol defined in the --privprotocol option | | | +| SNMPEXTRAOPTIONS | Any extra option you may want to add to every command (a --verbose flag for example). Toutes les options sont listées [ici](#options-disponibles). | | | 4. [Déployez la configuration](/docs/monitoring/monitoring-servers/deploying-a-configuration). L'hôte apparaît dans la liste des hôtes supervisés, et dans la page **Statut des ressources**. La commande envoyée par le connecteur est indiquée dans le panneau de détails de l'hôte : celle-ci montre les valeurs des macros. @@ -250,9 +255,14 @@ yum install centreon-plugin-Applications-Protocol-Snmp > Si vous utilisez SNMP en version 3, vous devez configurer les paramètres spécifiques associés via la macro **SNMPEXTRAOPTIONS**. > Plus d'informations dans la section [Troubleshooting SNMP](../getting-started/how-to-guides/troubleshooting-plugins.md#mapping-des-options-snmpv3). -| Macro | Description | Valeur par défaut | Obligatoire | -|:-----------------|:---------------------------------------------------------------------------------------------------------------------------------------------------|:------------------|:-----------:| -| SNMPEXTRAOPTIONS | Any extra option you may want to add to every command (a --verbose flag for example). Toutes les options sont listées [ici](#options-disponibles). | | | +| Macro | Description | Valeur par défaut | Obligatoire | +|:------------------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------|:------------------|:-----------:| +| SNMP_V3_USERNAME | SNMP v3 only: User name (`securityName`) | | | +| SNMP_V3_AUTH_PROTOCOL | SNMP v3 only: Authentication protocol: MD5\|SHA. Since net-snmp 5.9.1: SHA224\|SHA256\|SHA384\|SHA512 | | | +| SNMP_V3_PRIV_PROTOCOL | 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 | | | +| SNMP_V3_AUTH_PASSPHRASE | SNMP v3 only: Pass phrase hashed using the authentication protocol defined in the --authprotocol option | | | +| SNMP_V3_PRIV_PASSPHRASE | SNMP v3 only: Privacy pass phrase (`privPassword`) to encrypt messages using the protocol defined in the --privprotocol option | | | +| SNMPEXTRAOPTIONS | Any extra option you may want to add to every command (a --verbose flag for example). Toutes les options sont listées [ici](#options-disponibles). | | | 4. [Déployez la configuration](/docs/monitoring/monitoring-servers/deploying-a-configuration). L'hôte apparaît dans la liste des hôtes supervisés, et dans la page **Statut des ressources**. La commande envoyée par le connecteur est indiquée dans le panneau de détails de l'hôte : celle-ci montre les valeurs des macros. @@ -281,16 +291,16 @@ yum install centreon-plugin-Applications-Protocol-Snmp -| Macro | Description | Valeur par défaut | Obligatoire | -|:---------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:-------------------------------|:-----------:| -| FORMATOK | Output format according to the threshold. : '%\{filter_rows\} value(s)'), 'warning' (default: 'value(s): %\{details_warning\}'), 'critical' (default: 'value(s): %\{details_critical\}'), 'unknown' (default: 'value(s): %\{details_unknown\}'). You can use the following variables: %\{rows\}, %\{filter_rows\}, %\{details_warning\}, %\{details_ok\}, %\{details_critical\}, %\{details_unknown\} | %\{filter_rows\} value(s) | | -| FORMATUNKNOWN | Output format according to the threshold. : '%\{filter_rows\} value(s)'), 'warning' (default: 'value(s): %\{details_warning\}'), 'critical' (default: 'value(s): %\{details_critical\}'), 'unknown' (default: 'value(s): %\{details_unknown\}'). You can use the following variables: %\{rows\}, %\{filter_rows\}, %\{details_warning\}, %\{details_ok\}, %\{details_critical\}, %\{details_unknown\} | value(s): %\{details_unknown\} | | -| OID | OID value to check (numeric format only) | | | -| WARNING | Return Warning if an oid value match the regexp | | | -| CRITICAL | Return Critical if an oid value match the regexp | | | -| FORMATWARNING | Output format according to the threshold. : '%\{filter_rows\} value(s)'), 'warning' (default: 'value(s): %\{details_warning\}'), 'critical' (default: 'value(s): %\{details_critical\}'), 'unknown' (default: 'value(s): %\{details_unknown\}'). You can use the following variables: %\{rows\}, %\{filter_rows\}, %\{details_warning\}, %\{details_ok\}, %\{details_critical\}, %\{details_unknown\} | value(s): %\{details_warning\} | | -| FORMATCRITICAL | Output format according to the threshold. : '%\{filter_rows\} value(s)'), 'warning' (default: 'value(s): %\{details_warning\}'), 'critical' (default: 'value(s): %\{details_critical\}'), 'unknown' (default: 'value(s): %\{details_unknown\}'). You can use the following variables: %\{rows\}, %\{filter_rows\}, %\{details_warning\}, %\{details_ok\}, %\{details_critical\}, %\{details_unknown\} | value(s): %\{details_critical\} | | -| EXTRAOPTIONS | Any extra option you may want to add to the command (E.g. a --verbose flag). Toutes les options sont listées [ici](#options-disponibles) | | | +| Macro | Description | Valeur par défaut | Obligatoire | +|:---------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:-------------------------------|:-----------:| +| FORMATOK | Output format according to the threshold. You can use the following variables: %\{rows\}, %\{filter_rows\}, %\{details_warning\}, %\{details_ok\}, %\{details_critical\}, %\{details_unknown\} | %\{filter_rows\} value(s) | | +| FORMATUNKNOWN | Output format according to the threshold. You can use the following variables: %\{rows\}, %\{filter_rows\}, %\{details_warning\}, %\{details_ok\}, %\{details_critical\}, %\{details_unknown\} | value(s): %\{details_unknown\} | | +| OID | OID value to check (numeric format only) | | | +| WARNING | Return Warning if an oid value match the regexp | | | +| CRITICAL | Return Critical if an oid value match the regexp | | | +| FORMATWARNING | Output format according to the threshold. You can use the following variables: %\{rows\}, %\{filter_rows\}, %\{details_warning\}, %\{details_ok\}, %\{details_critical\}, %\{details_unknown\} | value(s): %\{details_warning\} | | +| FORMATCRITICAL | Output format according to the threshold. You can use the following variables: %\{rows\}, %\{filter_rows\}, %\{details_warning\}, %\{details_ok\}, %\{details_critical\}, %\{details_unknown\} | value(s): %\{details_critical\} | | +| EXTRAOPTIONS | Any extra option you may want to add to the command (E.g. a --verbose flag). Toutes les options sont listées [ici](#options-disponibles) | | | diff --git a/i18n/fr/docusaurus-plugin-content-docs-pp/current/integrations/plugin-packs/procedures/operatingsystems-hpux-snmp.md b/i18n/fr/docusaurus-plugin-content-docs-pp/current/integrations/plugin-packs/procedures/operatingsystems-hpux-snmp.md index 715d7e9a6ac6..c05e95a9f6db 100644 --- a/i18n/fr/docusaurus-plugin-content-docs-pp/current/integrations/plugin-packs/procedures/operatingsystems-hpux-snmp.md +++ b/i18n/fr/docusaurus-plugin-content-docs-pp/current/integrations/plugin-packs/procedures/operatingsystems-hpux-snmp.md @@ -230,9 +230,6 @@ yum install centreon-plugin-Operatingsystems-Hpux-Snmp 2. Complétez les champs **Nom**, **Alias** & **IP Address/DNS** correspondant à votre ressource. 3. Appliquez le modèle d'hôte **OS-Hpux-SNMP-custom**. -> Si vous utilisez SNMP en version 3, vous devez configurer les paramètres spécifiques associés via la macro **SNMPEXTRAOPTIONS**. -> Plus d'informations dans la section [Troubleshooting SNMP](../getting-started/how-to-guides/troubleshooting-plugins.md#mapping-des-options-snmpv3). - | Macro | Description | Valeur par défaut | Obligatoire | |:------------------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------|:------------------|:-----------:| | SNMP_V3_USERNAME | SNMP v3 only: User name (`securityName`) | | | diff --git a/i18n/fr/docusaurus-plugin-content-docs-pp/current/integrations/plugin-packs/procedures/operatingsystems-linux-snmp.md b/i18n/fr/docusaurus-plugin-content-docs-pp/current/integrations/plugin-packs/procedures/operatingsystems-linux-snmp.md index 1437beca2508..a2580b14e895 100644 --- a/i18n/fr/docusaurus-plugin-content-docs-pp/current/integrations/plugin-packs/procedures/operatingsystems-linux-snmp.md +++ b/i18n/fr/docusaurus-plugin-content-docs-pp/current/integrations/plugin-packs/procedures/operatingsystems-linux-snmp.md @@ -426,9 +426,6 @@ yum install centreon-plugin-Operatingsystems-Linux-Snmp 2. Complétez les champs **Nom**, **Alias** & **IP Address/DNS** correspondant à votre ressource. 3. Appliquez le modèle d'hôte **OS-Linux-SNMP-custom**. -> Si vous utilisez SNMP en version 3, vous devez configurer les paramètres spécifiques associés via la macro **SNMPEXTRAOPTIONS**. -> Plus d'informations dans la section [Troubleshooting SNMP](../getting-started/how-to-guides/troubleshooting-plugins.md#mapping-des-options-snmpv3). - | Macro | Description | Valeur par défaut | Obligatoire | |:------------------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------|:------------------|:-----------:| | SNMP_V3_USERNAME | SNMP v3 only: User name (`securityName`) | | | diff --git a/i18n/fr/docusaurus-plugin-content-docs-pp/current/integrations/plugin-packs/procedures/operatingsystems-mac-snmp.md b/i18n/fr/docusaurus-plugin-content-docs-pp/current/integrations/plugin-packs/procedures/operatingsystems-mac-snmp.md index 2a38caf8922a..224efb0045dc 100644 --- a/i18n/fr/docusaurus-plugin-content-docs-pp/current/integrations/plugin-packs/procedures/operatingsystems-mac-snmp.md +++ b/i18n/fr/docusaurus-plugin-content-docs-pp/current/integrations/plugin-packs/procedures/operatingsystems-mac-snmp.md @@ -303,9 +303,6 @@ yum install centreon-plugin-Operatingsystems-Mac-Snmp 2. Complétez les champs **Nom**, **Alias** & **IP Address/DNS** correspondant à votre ressource. 3. Appliquez le modèle d'hôte **OS-Mac-SNMP-custom**. -> Si vous utilisez SNMP en version 3, vous devez configurer les paramètres spécifiques associés via la macro **SNMPEXTRAOPTIONS**. -> Plus d'informations dans la section [Troubleshooting SNMP](../getting-started/how-to-guides/troubleshooting-plugins.md#mapping-des-options-snmpv3). - | Macro | Description | Valeur par défaut | Obligatoire | |:------------------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------|:------------------|:-----------:| | SNMP_V3_USERNAME | SNMP v3 only: User name (`securityName`) | | | diff --git a/pp/integrations/plugin-packs/procedures/applications-protocol-snmp.md b/pp/integrations/plugin-packs/procedures/applications-protocol-snmp.md index 74fbcc779a36..fbcdff64b1b5 100644 --- a/pp/integrations/plugin-packs/procedures/applications-protocol-snmp.md +++ b/pp/integrations/plugin-packs/procedures/applications-protocol-snmp.md @@ -75,9 +75,9 @@ More information about discovering hosts automatically is available on the [dedi #### Service discovery -| Rule name | Description | -|:----------------------------------|:------------| -| App-Protocol-SNMP-Collection-Name | Discover SNMP data using collections | +| Rule name | Description | +|:----------------------------------|:-------------------------------------| +| App-Protocol-SNMP-Collection-Name | Discover SNMP data using collections | More information about discovering services automatically is available on the [dedicated page](/docs/monitoring/discovery/services-discovery) and in the [following chapter](/docs/monitoring/discovery/services-discovery/#discovery-rules). @@ -235,9 +235,14 @@ yum install centreon-plugin-Applications-Protocol-Snmp 2. Fill in the **Name**, **Alias** & **IP Address/DNS** fields according to your resource's settings. 3. Apply the **App-Protocol-SNMP-custom** template to the host. -| 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](#available-options). | | | +| Macro | Description | Default value | Mandatory | +|:------------------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------|:--------------|:---------:| +| SNMP_V3_USERNAME | SNMP v3 only: User name (`securityName`) | | | +| SNMP_V3_AUTH_PROTOCOL | SNMP v3 only: Authentication protocol: MD5\|SHA. Since net-snmp 5.9.1: SHA224\|SHA256\|SHA384\|SHA512 | | | +| SNMP_V3_PRIV_PROTOCOL | 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 | | | +| SNMP_V3_AUTH_PASSPHRASE | SNMP v3 only: Pass phrase hashed using the authentication protocol defined in the --authprotocol option | | | +| SNMP_V3_PRIV_PASSPHRASE | SNMP v3 only: Privacy pass phrase (`privPassword`) to encrypt messages using the protocol defined in the --privprotocol option | | | +| SNMPEXTRAOPTIONS | Any extra option you may want to add to every command (a --verbose flag for example). All options are listed [here](#available-options). | | | 4. [Deploy the configuration](/docs/monitoring/monitoring-servers/deploying-a-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. @@ -251,9 +256,14 @@ yum install centreon-plugin-Applications-Protocol-Snmp > When using SNMP v3, use the **SNMPEXTRAOPTIONS** macro to add specific authentication parameters. > More information in the [Troubleshooting SNMP](../getting-started/how-to-guides/troubleshooting-plugins.md#snmpv3-options-mapping) 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](#available-options). | | | +| Macro | Description | Default value | Mandatory | +|:------------------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------|:--------------|:---------:| +| SNMP_V3_USERNAME | SNMP v3 only: User name (`securityName`) | | | +| SNMP_V3_AUTH_PROTOCOL | SNMP v3 only: Authentication protocol: MD5\|SHA. Since net-snmp 5.9.1: SHA224\|SHA256\|SHA384\|SHA512 | | | +| SNMP_V3_PRIV_PROTOCOL | 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 | | | +| SNMP_V3_AUTH_PASSPHRASE | SNMP v3 only: Pass phrase hashed using the authentication protocol defined in the --authprotocol option | | | +| SNMP_V3_PRIV_PASSPHRASE | SNMP v3 only: Privacy pass phrase (`privPassword`) to encrypt messages using the protocol defined in the --privprotocol option | | | +| SNMPEXTRAOPTIONS | Any extra option you may want to add to every command (a --verbose flag for example). All options are listed [here](#available-options). | | | 4. [Deploy the configuration](/docs/monitoring/monitoring-servers/deploying-a-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. @@ -282,16 +292,16 @@ yum install centreon-plugin-Applications-Protocol-Snmp -| Macro | Description | Default value | Mandatory | -|:---------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:-------------------------------|:-----------:| -| FORMATOK | Output format according to the threshold. : '%\{filter_rows\} value(s)'), 'warning' (default: 'value(s): %\{details_warning\}'), 'critical' (default: 'value(s): %\{details_critical\}'), 'unknown' (default: 'value(s): %\{details_unknown\}'). You can use the following variables: %\{rows\}, %\{filter_rows\}, %\{details_warning\}, %\{details_ok\}, %\{details_critical\}, %\{details_unknown\} | %\{filter_rows\} value(s) | | -| FORMATUNKNOWN | Output format according to the threshold. : '%\{filter_rows\} value(s)'), 'warning' (default: 'value(s): %\{details_warning\}'), 'critical' (default: 'value(s): %\{details_critical\}'), 'unknown' (default: 'value(s): %\{details_unknown\}'). You can use the following variables: %\{rows\}, %\{filter_rows\}, %\{details_warning\}, %\{details_ok\}, %\{details_critical\}, %\{details_unknown\} | value(s): %\{details_unknown\} | | -| OID | OID value to check (numeric format only) | | | -| WARNING | Return Warning if an oid value match the regexp | | | -| CRITICAL | Return Critical if an oid value match the regexp | | | -| FORMATWARNING | Output format according to the threshold. : '%\{filter_rows\} value(s)'), 'warning' (default: 'value(s): %\{details_warning\}'), 'critical' (default: 'value(s): %\{details_critical\}'), 'unknown' (default: 'value(s): %\{details_unknown\}'). You can use the following variables: %\{rows\}, %\{filter_rows\}, %\{details_warning\}, %\{details_ok\}, %\{details_critical\}, %\{details_unknown\} | value(s): %\{details_warning\} | | -| FORMATCRITICAL | Output format according to the threshold. : '%\{filter_rows\} value(s)'), 'warning' (default: 'value(s): %\{details_warning\}'), 'critical' (default: 'value(s): %\{details_critical\}'), 'unknown' (default: 'value(s): %\{details_unknown\}'). You can use the following variables: %\{rows\}, %\{filter_rows\}, %\{details_warning\}, %\{details_ok\}, %\{details_critical\}, %\{details_unknown\} | value(s): %\{details_critical\} | | -| EXTRAOPTIONS | Any extra option you may want to add to the command (E.g. a --verbose flag). All options are listed [here](#available-options) | | | +| Macro | Description | Default value | Mandatory | +|:---------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:-------------------------------|:-----------:| +| FORMATOK | Output format according to the threshold. You can use the following variables: %\{rows\}, %\{filter_rows\}, %\{details_warning\}, %\{details_ok\}, %\{details_critical\}, %\{details_unknown\} | %\{filter_rows\} value(s) | | +| FORMATUNKNOWN | Output format according to the threshold. You can use the following variables: %\{rows\}, %\{filter_rows\}, %\{details_warning\}, %\{details_ok\}, %\{details_critical\}, %\{details_unknown\} | value(s): %\{details_unknown\} | | +| OID | OID value to check (numeric format only) | | | +| WARNING | Return Warning if an oid value match the regexp | | | +| CRITICAL | Return Critical if an oid value match the regexp | | | +| FORMATWARNING | Output format according to the threshold. You can use the following variables: %\{rows\}, %\{filter_rows\}, %\{details_warning\}, %\{details_ok\}, %\{details_critical\}, %\{details_unknown\} | value(s): %\{details_warning\} | | +| FORMATCRITICAL | Output format according to the threshold. You can use the following variables: %\{rows\}, %\{filter_rows\}, %\{details_warning\}, %\{details_ok\}, %\{details_critical\}, %\{details_unknown\} | value(s): %\{details_critical\} | | +| EXTRAOPTIONS | Any extra option you may want to add to the command (E.g. a --verbose flag). All options are listed [here](#available-options) | | | From 720558d08fb62006f4400ce99fc1ce399d964eb9 Mon Sep 17 00:00:00 2001 From: lucie-tirand Date: Thu, 16 Jul 2026 14:43:22 +0200 Subject: [PATCH 2/6] wip --- .../applications-microsoft-dhcp-snmp.md | 205 ++-- .../procedures/hardware-pdu-apc-snmp.md | 320 ++--- .../procedures/hardware-servers-hp-snmp.md | 437 +++---- .../procedures/hardware-storage-qnap-snmp.md | 604 ++++----- .../procedures/hardware-ups-apc-snmp.md | 428 +++---- .../procedures/hardware-ups-powerware-snmp.md | 102 +- .../procedures/network-aruba-aoscx-snmp.md | 551 +++++---- .../procedures/network-aruba-instant-snmp.md | 266 ++-- .../procedures/network-cisco-meraki-snmp.md | 256 ++-- .../procedures/network-cisco-wlc-snmp.md | 722 ++++++----- .../network-firewalls-cisco-asa-snmp.md | 428 ++++--- .../network-firewalls-pfsense-snmp.md | 430 ++++--- .../network-fortinet-fortimanager-snmp.md | 261 ++-- .../procedures/network-stormshield-snmp.md | 966 ++++++++------- .../network-switchs-aruba-standard-snmp.md | 438 ++++--- .../network-switchs-brocade-snmp.md | 79 +- ...itchs-cisco-smallbusiness-standard-snmp.md | 390 +++--- .../procedures/network-ubiquiti-unifi-snmp.md | 752 +++++++----- .../applications-microsoft-dhcp-snmp.md | 216 ++-- .../procedures/hardware-pdu-apc-snmp.md | 359 +++--- .../procedures/hardware-servers-hp-snmp.md | 416 +++---- .../procedures/hardware-storage-qnap-snmp.md | 695 ++++++----- .../procedures/hardware-ups-apc-snmp.md | 576 ++++----- .../procedures/hardware-ups-powerware-snmp.md | 106 +- .../procedures/network-aruba-aoscx-snmp.md | 743 ++++++------ .../procedures/network-aruba-instant-snmp.md | 276 +++-- .../procedures/network-cisco-meraki-snmp.md | 277 +++-- .../procedures/network-cisco-wlc-snmp.md | 741 ++++++------ .../network-firewalls-cisco-asa-snmp.md | 444 ++++--- .../network-firewalls-pfsense-snmp.md | 747 ++++++------ .../network-fortinet-fortimanager-snmp.md | 318 ++--- .../procedures/network-stormshield-snmp.md | 1075 +++++++++-------- .../network-switchs-aruba-standard-snmp.md | 436 ++++--- .../network-switchs-brocade-snmp.md | 81 +- ...itchs-cisco-smallbusiness-standard-snmp.md | 382 +++--- .../procedures/network-ubiquiti-unifi-snmp.md | 830 +++++++------ 36 files changed, 8849 insertions(+), 7504 deletions(-) diff --git a/i18n/fr/docusaurus-plugin-content-docs-pp/current/integrations/plugin-packs/procedures/applications-microsoft-dhcp-snmp.md b/i18n/fr/docusaurus-plugin-content-docs-pp/current/integrations/plugin-packs/procedures/applications-microsoft-dhcp-snmp.md index c9a33fdcd44e..da0353a58ec3 100644 --- a/i18n/fr/docusaurus-plugin-content-docs-pp/current/integrations/plugin-packs/procedures/applications-microsoft-dhcp-snmp.md +++ b/i18n/fr/docusaurus-plugin-content-docs-pp/current/integrations/plugin-packs/procedures/applications-microsoft-dhcp-snmp.md @@ -5,10 +5,13 @@ title: Microsoft DHCP SNMP import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; -## Contenu du pack +## Dépendances du connecteur de supervision + +Les connecteurs de supervision suivants sont automatiquement installés lors de l'installation du connecteur **Microsoft DHCP SNMP** +depuis la page **Configuration > Connecteurs > Connecteurs de supervision** : +* [Base Pack](./base-generic.md) -Attention, ce connecteur n'est compatible qu'avec les serveurs Windows jusqu'à la version 2012. Avec les versions plus récentes, -les OIDs ne sont plus requêtables (pour plus d'informations voir [ici](https://learn.microsoft.com/en-us/archive/msdn-technet-forums/73c00321-496a-4898-ad5b-5ceb909610c7)). +## Contenu du pack ### Modèles @@ -37,31 +40,31 @@ Le connecteur apporte le modèle de service suivant #### Découverte d'hôtes -| Nom de la règle | Description | -|:----------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| SNMP Agents | Découvre les ressources via un scan réseau SNMP. Installez le connecteur [Generic SNMP](applications-protocol-snmp.md) pour obtenir la règle de découverte et créez un modificateur pour le modèle d'hôte **App-Microsoft-Dhcp-SNMP-custom** | +| Nom de la règle | Description | +|:----------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| SNMP Agents | Découvre les ressources via un scan réseau SNMP. Installez le connecteur [Generic SNMP](./applications-protocol-snmp.md) pour obtenir la règle de découverte et créez un modificateur pour le modèle d'hôte **App-Microsoft-Dhcp-SNMP-custom**. | Rendez-vous sur la [documentation dédiée](/docs/monitoring/discovery/hosts-discovery) pour en savoir plus sur la découverte automatique d'hôtes. #### Découverte de services -| Nom de la règle | Description | -|:--------------------------------|:------------| -| App-Microsoft-Dhcp-SNMP-Subnets | Découverte des sous-réseaux DHCP | +| Nom de la règle | Description | +|:--------------------------------|:---------------------------------| +| App-Microsoft-Dhcp-SNMP-Subnets | Découverte des sous-réseaux DHCP | Rendez-vous sur la [documentation dédiée](/docs/monitoring/discovery/services-discovery) pour en savoir plus sur la découverte automatique de services et sa [planification](/docs/monitoring/discovery/services-discovery/#règles-de-découverte). ### Métriques & statuts collectés -Voici le tableau des services pour ce connecteur, détaillant les métriques rattachées à chaque service. +Voici le tableau des services pour ce connecteur, détaillant les métriques et statuts rattachés à chaque service. -| Métrique | Unité | +| Nom | Unité | |:--------------------------------------------|:------| -| *subnets*#status | N/A | +| status | N/A | | *subnets*#subnet.addresses.usage.count | count | | *subnets*#subnet.addresses.free.count | count | | *subnets*#subnet.addresses.usage.percentage | % | @@ -74,7 +77,10 @@ Voici le tableau des services pour ce connecteur, détaillant les métriques rat ### Configuration SNMP -Le service SNMP doit être activé et configuré sur l'équipement. Veuillez vous référer à la documentation officielle du constructeur/éditeur. +L'agent SNMP doit être activé et configuré sur l'équipement. +Veuillez vous référer à la documentation officielle. +Il se peut que votre équipement nécessite qu'une liste d'adresses autorisées à l'interroger soit paramétrée. +Veillez à ce que les adresses des collecteurs Centreon y figurent bien. ### Flux réseau @@ -176,12 +182,14 @@ yum install centreon-plugin-Applications-Microsoft-Dhcp-Snmp 2. Complétez les champs **Nom**, **Alias** & **IP Address/DNS** correspondant à votre ressource. 3. Appliquez le modèle d'hôte **App-Microsoft-Dhcp-SNMP-custom**. -> Si vous utilisez SNMP en version 3, vous devez configurer les paramètres spécifiques associés via la macro **SNMPEXTRAOPTIONS**. -> Plus d'informations dans la section [Troubleshooting SNMP](../getting-started/how-to-guides/troubleshooting-plugins.md#mapping-des-options-snmpv3). - -| Macro | Description | Valeur par défaut | Obligatoire | -|:-----------------|:-----------------------------------------------------------------------------------------------------|:------------------|:-----------:| -| SNMPEXTRAOPTIONS | Any extra option you may want to add to every command (a --verbose flag for example). Toutes les options sont listées [ici](#options-disponibles). | | | +| Macro | Description | Valeur par défaut | Obligatoire | +|:------------------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------|:------------------|:-----------:| +| SNMP_V3_USERNAME | SNMP v3 only: User name (`securityName`) | | | +| SNMP_V3_AUTH_PROTOCOL | SNMP v3 only: Authentication protocol: MD5\|SHA. Since net-snmp 5.9.1: SHA224\|SHA256\|SHA384\|SHA512 | | | +| SNMP_V3_PRIV_PROTOCOL | 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 | | | +| SNMP_V3_AUTH_PASSPHRASE | SNMP v3 only: Pass phrase hashed using the authentication protocol defined in the --authprotocol option | | | +| SNMP_V3_PRIV_PASSPHRASE | SNMP v3 only: Privacy pass phrase (`privPassword`) to encrypt messages using the protocol defined in the --privprotocol option | | | +| SNMPEXTRAOPTIONS | Any extra option you may want to add to every command (a --verbose flag for example). Toutes les options sont listées [ici](#options-disponibles). | | | 4. [Déployez la configuration](/docs/monitoring/monitoring-servers/deploying-a-configuration). L'hôte apparaît dans la liste des hôtes supervisés, et dans la page **Statut des ressources**. La commande envoyée par le connecteur est indiquée dans le panneau de détails de l'hôte : celle-ci montre les valeurs des macros. @@ -193,17 +201,17 @@ yum install centreon-plugin-Applications-Microsoft-Dhcp-Snmp -| Macro | Description | Valeur par défaut | Obligatoire | -|:---------------------------|:---------------------------------------------------------------------------------------------------|:------------------|:-----------:| -| FILTERSUBNETADDRESS | Filter subnets by address (can be a regexp) | | | -| WARNINGADDRESSESUSAGE | Thresholds | | | -| CRITICALADDRESSESUSAGE | Thresholds | | | -| WARNINGADDRESSESUSAGEFREE | Thresholds | | | -| CRITICALADDRESSESUSAGEFREE | Thresholds | | | -| WARNINGADDRESSESUSAGEPRCT | Thresholds | | | -| CRITICALADDRESSESUSAGEPRCT | Thresholds | | | -| WARNINGPENDINGOFFERS | Thresholds | | | -| CRITICALPENDINGOFFERS | Thresholds | | | +| Macro | Description | Valeur par défaut | Obligatoire | +|:---------------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------|:------------------|:-----------:| +| FILTERSUBNETADDRESS | Filter subnets by address (can be a regexp) | | | +| WARNINGADDRESSESUSAGE | Threshold | | | +| CRITICALADDRESSESUSAGE | Threshold | | | +| WARNINGADDRESSESUSAGEFREE | Threshold | | | +| CRITICALADDRESSESUSAGEFREE | Threshold | | | +| WARNINGADDRESSESUSAGEPRCT | Threshold | | | +| CRITICALADDRESSESUSAGEPRCT | Threshold | | | +| WARNINGPENDINGOFFERS | Threshold | | | +| CRITICALPENDINGOFFERS | Threshold | | | | EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). Toutes les options sont listées [ici](#options-disponibles). | --verbose | | @@ -225,7 +233,12 @@ telle que celle-ci (remplacez les valeurs d'exemple par les vôtres) : --mode=subnets \ --hostname='10.0.0.1' \ --snmp-version='2c' \ - --snmp-community='my-snmp-community' \ + --snmp-community='my-snmp-community' \ + --snmp-username='username' \ + --authpassphrase='' \ + --authprotocol='' \ + --privpassphrase='' \ + --privprotocol='' \ --filter-subnet-address='' \ --warning-addresses-usage='' \ --critical-addresses-usage='' \ @@ -251,7 +264,7 @@ pour le diagnostic des erreurs communes des plugins Centreon. ### Modes disponibles -Dans la plupart des cas, un mode correspond à un modèle de service. Le mode est renseigné dans la commande d'exécution +Dans la plupart des cas, un mode correspond à un modèle de service. Le mode est renseigné dans la commande d'exécution du connecteur. Dans l'interface de Centreon, il n'est pas nécessaire de les spécifier explicitement, leur utilisation est implicite dès lors que vous utilisez un modèle de service. En revanche, vous devrez spécifier le mode correspondant à ce modèle si vous voulez tester la commande d'exécution du connecteur dans votre terminal. @@ -269,7 +282,7 @@ Le plugin apporte les modes suivants : | Mode | Modèle de service associé | |:----------------------------------------------------------------------------------------------------------------------------------|:---------------------------------------| -| list-subnets [[code](https://github.com/centreon/centreon-plugins/blob/develop/src/apps/microsoft/dhcp/snmp/mode/listsubnets.pm)] | Used for service discovery | +| list-subnets [[code](https://github.com/centreon/centreon-plugins/blob/develop/src/apps/microsoft/dhcp/snmp/mode/listsubnets.pm)] | Utilisé pour la découverte de services | | subnets [[code](https://github.com/centreon/centreon-plugins/blob/develop/src/apps/microsoft/dhcp/snmp/mode/subnets.pm)] | App-Microsoft-Dhcp-Subnets-SNMP-custom | ### Options disponibles @@ -281,67 +294,71 @@ Les options disponibles pour chaque modèle de services sont listées ci-dessous -| 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. | -| --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\[,\[newuom\],\[min\],\[m ax\]\] Common examples: 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()' | -| --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,namesofnewmetrics,calculation\[,\[ne wuom\],\[min\],\[max\]\] regex: regular expression namesofnewmetrics: 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 newuom (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: 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(traf fic\_(in\|out)\_$1)' | -| --change-short-output --change-long-output | Modify the short/long output that is returned by the plugin. Syntax: --change-short-output=pattern~replacement~modifier Most commonly used modifiers are i (case insensitive) and g (replace all occurrences). Example: adding --change-short-output='OK\~Up\~gi' will replace all occurrences of 'OK', 'ok', 'Ok' or 'oK' with 'Up' | -| --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. | -| --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). E.g.: --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'. | -| --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 ok, 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. | -| --filter-counters | Only display some counters (regexp can be used). Example: --filter-counters='pending' | -| --filter-subnet-address | Filter subnets by address (can be a regexp). | -| --unknown-status | Define the conditions to match for the status to be UNKNOWN. You can use the following variables: %\{status\}, %\{name\} | -| --warning-status | Define the conditions to match for the status to be WARNING. You can use the following variables: %\{status\}, %\{name\} | -| --critical-status | Define the conditions to match for the status to be CRITICAL. You can use the following variables: %\{status\}, %\{name\} | -| --warning-* --critical-* | Thresholds. Can be: 'addresses-usage', 'addresses-usage-free', 'addresses-usage-prct', 'pending-offers'. | +| Option | Description | +|:-------------------------------------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| --filter-counters | Only display some counters (regexp can be used). Example: --filter-counters='pending' | +| --warning-xxx | Warning threshold. | +| --critical-xxx | Critical threshold. | +| --filter-subnet-address | Filter subnets by address (can be a regexp). | +| --unknown-status | Define the conditions to match for the status to be UNKNOWN. You can use the following variables: %\{status\}, %\{name\} | +| --warning-status | Define the conditions to match for the status to be WARNING. You can use the following variables: %\{status\}, %\{name\} | +| --critical-status | Define the conditions to match for the status to be CRITICAL. You can use the following variables: %\{status\}, %\{name\} | +| --warning-* --critical-* | Thresholds. Can be: 'addresses-usage', 'addresses-usage-free', 'addresses-usage-prct', 'pending-offers'. | +| --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 get-next 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 ok, 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. | +| --show-password | By default, sensitive information in command lines is hidden in debug output and replaced with `***` (however, debug logs may still display sensitive information). Using the C option will display the passwords in plain text. | +| --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\[,\[\\],\[min\],\[max\]\] Common examples: onvert 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,\,calculation\[,\[\\],\[min\],\[max\]\] regex: regular expression \: 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 \ (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: um 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~replacement~modifier Most commonly used modifiers are i (case insensitive) and g (replace all occurrences). Example: adding --change-short-output='OK~Up~gi' will replace all occurrences of 'OK', 'ok', 'Ok' or 'oK' with 'Up' | +| --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'. \. | diff --git a/i18n/fr/docusaurus-plugin-content-docs-pp/current/integrations/plugin-packs/procedures/hardware-pdu-apc-snmp.md b/i18n/fr/docusaurus-plugin-content-docs-pp/current/integrations/plugin-packs/procedures/hardware-pdu-apc-snmp.md index bd2261bde89b..c374320e074a 100644 --- a/i18n/fr/docusaurus-plugin-content-docs-pp/current/integrations/plugin-packs/procedures/hardware-pdu-apc-snmp.md +++ b/i18n/fr/docusaurus-plugin-content-docs-pp/current/integrations/plugin-packs/procedures/hardware-pdu-apc-snmp.md @@ -28,7 +28,7 @@ Le connecteur apporte les modèles de service suivants | Alias | Modèle de service | Description | |:---------|:--------------------------------|:----------------------------------------| | Hardware | HW-Pdu-Apc-Hardware-SNMP-custom | Contrôle le matériel | -| Load | HW-Pdu-Apc-SNMP-Load-custom | Contrôle la charge (courant en ampères) | +| Load | HW-Pdu-Apc-SNMP-Load-custom | Contrôle la charge (courant en Amperes) | | Outlet | HW-Pdu-Apc-SNMP-Outlet-custom | Contrôle les sorties PDU | > Les services listés ci-dessus sont créés automatiquement lorsque le modèle d'hôte **HW-Pdu-Apc-SNMP-custom** est utilisé. @@ -63,16 +63,14 @@ Voici le tableau des services pour ce connecteur, détaillant les métriques et -| Nom | Unité | -|:------------------------------------|:------| -| hardware.psu.status | N/A | -| hardware.humidity.status | N/A | -| hardware.temperature.status | N/A | -| hardware.psu.count | count | -| hardware.humidity.count | count | -| hardware.temperature.count | count | -| hardware.sensor.humidity.percentage | % | -| hardware.sensor.temperature.celsius | C | +| Nom | Unité | +|:---------------------------|:------| +| hardware.psu.count | count | +| psu status | N/A | +| hardware.humidity.count | count | +| humidity status | N/A | +| hardware.temperature.count | count | +| temperature status | N/A | @@ -92,16 +90,13 @@ Voici le tableau des services pour ce connecteur, détaillant les métriques et | Nom | Unité | |:--------------------|:------| | time.offset.seconds | s | - -| Nom | Unité | -|:--------------------------------|:------| -| status | N/A | -| status | N/A | -| *outlet1*#outlet.current.ampere | A | -| *outlet2*#outlet.current.ampere | A | +| Nom | Unité | +|:-------------------------------|:------| +| status | N/A | +| *outlet*#outlet.current.ampere | A | @@ -119,7 +114,8 @@ Voici le tableau des services pour ce connecteur, détaillant les métriques et ### Configuration SNMP -L'agent SNMP doit être activé et configuré sur l'équipement. Référez vous à la documentation officielle. +L'agent SNMP doit être activé et configuré sur l'équipement. +Référez vous à la documentation officielle. Il se peut que votre équipement nécessite qu'une liste d'adresses autorisées à l'interroger soit paramétrée. Veillez à ce que les adresses des collecteurs Centreon y figurent bien. @@ -132,6 +128,8 @@ Centreon vers la ressource supervisée. ### Pack +La procédure d'installation des connecteurs de supervision diffère légèrement [suivant que votre licence est offline ou online](../getting-started/how-to-guides/connectors-licenses.md). + 1. Si la plateforme est configurée avec une licence *online*, l'installation d'un paquet n'est pas requise pour voir apparaître le connecteur dans le menu **Configuration > Connecteurs > Connecteurs de supervision**. Au contraire, si la plateforme utilise une licence *offline*, installez le paquet @@ -222,12 +220,14 @@ yum install centreon-plugin-Hardware-Pdu-Apc-Snmp 2. Complétez les champs **Nom**, **Alias** & **IP Address/DNS** correspondant à votre ressource. 3. Appliquez le modèle d'hôte **HW-Pdu-Apc-SNMP-custom**. -> Si vous utilisez SNMP en version 3, vous devez configurer les paramètres spécifiques associés via la macro **SNMPEXTRAOPTIONS**. -> Plus d'informations dans la section [Troubleshooting SNMP](../getting-started/how-to-guides/troubleshooting-plugins.md#mapping-des-options-snmpv3). - -| Macro | Description | Valeur par défaut | Obligatoire | -|:-----------------|:---------------------------------------------------------------------------------------------------------------------------------------------------|:------------------|:-----------:| -| SNMPEXTRAOPTIONS | Any extra option you may want to add to every command (a --verbose flag for example). Toutes les options sont listées [ici](#options-disponibles). | | | +| Macro | Description | Valeur par défaut | Obligatoire | +|:------------------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------|:------------------|:-----------:| +| SNMP_V3_USERNAME | SNMP v3 only: User name (`securityName`) | | | +| SNMP_V3_AUTH_PROTOCOL | SNMP v3 only: Authentication protocol: MD5\|SHA. Since net-snmp 5.9.1: SHA224\|SHA256\|SHA384\|SHA512 | | | +| SNMP_V3_PRIV_PROTOCOL | 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 | | | +| SNMP_V3_AUTH_PASSPHRASE | SNMP v3 only: Pass phrase hashed using the authentication protocol defined in the --authprotocol option | | | +| SNMP_V3_PRIV_PASSPHRASE | SNMP v3 only: Privacy pass phrase (`privPassword`) to encrypt messages using the protocol defined in the --privprotocol option | | | +| SNMPEXTRAOPTIONS | Any extra option you may want to add to every command (a --verbose flag for example). Toutes les options sont listées [ici](#options-disponibles). | | | 4. [Déployez la configuration](/docs/monitoring/monitoring-servers/deploying-a-configuration). L'hôte apparaît dans la liste des hôtes supervisés, et dans la page **Statut des ressources**. La commande envoyée par le connecteur est indiquée dans le panneau de détails de l'hôte : celle-ci montre les valeurs des macros. @@ -241,7 +241,7 @@ yum install centreon-plugin-Hardware-Pdu-Apc-Snmp | Macro | Description | Valeur par défaut | Obligatoire | |:-------------|:-------------------------------------------------------------------------------------------------------------------------------------------------|:------------------|:-----------:| -| COMPONENT | Which component to check (default: '.*'). Can be: 'psu', 'humidity', 'temperature' | | | +| COMPONENT | Which component to check. Can be: 'psu', 'humidity', 'temperature' | .* | | | WARNING | Set warning threshold for temperatures (syntax: type,instance,threshold) Example: --warning='temperature,.*,30' | | | | CRITICAL | Set critical threshold for temperatures (syntax: type,instance,threshold) Example: --critical='temperature,.*,40' | | | | EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). Toutes les options sont listées [ici](#options-disponibles). | --verbose | | @@ -256,14 +256,14 @@ yum install centreon-plugin-Hardware-Pdu-Apc-Snmp -| Macro | Description | Valeur par défaut | Obligatoire | -|:-------------|:-------------------------------------------------------------------------------------------------------------------------------------------------|:------------------|:-----------:| -| NTPADDR | Set the ntp hostname (if not set, localtime is used) | | | -| NTPPORT | Set the ntp port (default: 123) | | | -| TIMEZONE | Set the timezone of distant server. For Windows, you need to set it. Can use format: 'Europe/London' or '+0100' | | | -| WARNING | Time warning threshold range (in seconds), in the format `-n:n` (e.g., `-5:5`). Returns WARNING when the offset is less than -n seconds or greater than n seconds. | -1:1 | | -| CRITICAL | Time critical threshold range (in seconds), in the format `-n:n` (e.g., `-5:5`). Returns CRITICAL when the offset is less than -n seconds or greater than n seconds. | -2:2 | | -| EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). Toutes les options sont listées [ici](#options-disponibles). | | | +| Macro | Description | Valeur par défaut | Obligatoire | +|:-------------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------|:------------------|:-----------:| +| NTPADDR | Set the NTP hostname (if not set, localtime is used) | | | +| NTPPORT | Set the NTP port | 123 | | +| TIMEZONE | Set the timezone of distant server. For Windows, you need to set it. Can use format: 'Europe/London' or '+0100' | | | +| WARNING | Time warning threshold range (in seconds), in the format -n:n (e.g., -5:5). Returns WARNING when the offset is less than -n seconds or greater than n seconds | -1:1 | | +| CRITICAL | Time critical threshold range (in seconds), in the format -n:n (e.g., -5:5). Returns CRITICAL when the offset is less than -n seconds or greater than n seconds | -2:2 | | +| EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). Toutes les options sont listées [ici](#options-disponibles). | | | @@ -301,14 +301,19 @@ telle que celle-ci (remplacez les valeurs d'exemple par les vôtres) : --mode=outlet \ --hostname=10.0.0.1 \ --snmp-version='2c' \ - --snmp-community='my-snmp-community' \ + --snmp-community='my-snmp-community' \ + --snmp-username='username' \ + --authpassphrase='' \ + --authprotocol='' \ + --privpassphrase='' \ + --privprotocol='' \ --verbose ``` La commande devrait retourner un message de sortie similaire à : ```bash -OK: All outlets are ok | 'outlet1#outlet.current.ampere'=60547A;;;0; 'outlet2#outlet.current.ampere'=35084A;;;0; +OK: All outlets are ok | 'outlet1#outlet.current.ampere'=8A;;;0; 'outlet2#outlet.current.ampere'=9A;;;0; ``` ### Diagnostic des erreurs communes @@ -348,66 +353,67 @@ Le plugin apporte les modes suivants : Les options génériques sont listées ci-dessous : -| 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 ok, 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\[,\[\\],\[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\[,\[\\],\[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\[,\[\\],\[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,\,calculation\[,\[\\],\[min\],\[max\]\] regex: regular expression \: 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 \ (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~replacement~modifier Most commonly used modifiers are i (case insensitive) and g (replace all occurrences). Example: adding --change-short-output='OK\~Up\~gi' will replace all occurrences of 'OK', 'ok', 'Ok' or 'oK' with 'Up' | -| --change-short-output | Modify the short/long output that is returned by the plugin. Syntax: --change-short-output=pattern~replacement~modifier Most commonly used modifiers are i (case insensitive) and g (replace all occurrences). Example: adding --change-short-output='OK\~Up\~gi' will replace all occurrences of 'OK', 'ok', 'Ok' or 'oK' with 'Up' | -| --change-long-output | Modify the short/long output that is returned by the plugin. Syntax: --change-short-output=pattern~replacement~modifier Most commonly used modifiers are i (case insensitive) and g (replace all occurrences). Example: adding --change-short-output='OK\~Up\~gi' will replace all occurrences of 'OK', 'ok', 'Ok' or 'oK' with 'Up' | -| --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\. =cut | +| 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 get-next 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 ok, 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. | +| --show-password | By default, sensitive information in command lines is hidden in debug output and replaced with `***` (however, debug logs may still display sensitive information). Using the C option will display the passwords in plain text. | +| --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\[,\[\\],\[min\],\[max\]\] Common examples: onvert 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\[,\[\\],\[min\],\[max\]\] Common examples: onvert 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\[,\[\\],\[min\],\[max\]\] Common examples: onvert 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,\,calculation\[,\[\\],\[min\],\[max\]\] regex: regular expression \: 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 \ (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: um 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~replacement~modifier Most commonly used modifiers are i (case insensitive) and g (replace all occurrences). Example: adding --change-short-output='OK~Up~gi' will replace all occurrences of 'OK', 'ok', 'Ok' or 'oK' with 'Up' | +| --change-short-output | Modify the short/long output that is returned by the plugin. Syntax: --change-short-output=pattern~replacement~modifier Most commonly used modifiers are i (case insensitive) and g (replace all occurrences). Example: adding --change-short-output='OK~Up~gi' will replace all occurrences of 'OK', 'ok', 'Ok' or 'oK' with 'Up' | +| --change-long-output | Modify the short/long output that is returned by the plugin. Syntax: --change-short-output=pattern~replacement~modifier Most commonly used modifiers are i (case insensitive) and g (replace all occurrences). Example: adding --change-short-output='OK~Up~gi' will replace all occurrences of 'OK', 'ok', 'Ok' or 'oK' with 'Up' | +| --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'. \. | #### Options des modes @@ -416,79 +422,87 @@ Les options disponibles pour chaque modèle de services sont listées ci-dessous -| Option | Description | -|:---------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| --component | Which component to check (default: '.*'). Can be: 'psu', 'humidity', 'temperature'. | -| --filter | Exclude the items given as a comma-separated list (example: --filter=temperature --filter=humidity). You can also exclude items from specific instances: --filter=temperature,1 | -| --absent-problem | Return an error if an entity is not 'present' (default is skipping) (comma separated list) Can be specific or global: --absent-problem=psu | -| --no-component | Define the expected status if no components are found (default: critical). | -| --threshold-overload | Use this option to override the status returned by the plugin when the status label matches a regular expression (syntax: section,\[instance,\]status,regexp). Example: --threshold-overload='temperature,CRITICAL,^(?!(normal)$)' | -| --warning | Set warning threshold for temperatures (syntax: type,instance,threshold) Example: --warning='temperature,.*,30' | -| --critical | Set critical threshold for temperatures (syntax: type,instance,threshold) Example: --critical='temperature,.*,40' | +| Option | Description | +|:---------------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| --component | Which component to check (default: '.*'). Can be: 'psu', 'humidity', 'temperature'. | +| --filter | Exclude the items given as a comma-separated list (example: --filter=temperature --filter=humidity). You can also exclude items from specific instances: --filter=temperature,1 | +| --absent-problem | Return an error if an entity is not 'present' (default is skipping) (comma separated list) Can be specific or global: --absent-problem=psu | +| --no-component | Define the expected status if no components are found (default: critical). | +| --threshold-overload | Use this option to override the status returned by the plugin when the status label matches a regular expression (syntax: section,\[instance,\]status,regexp). Example: --threshold-overload='temperature,CRITICAL,^(?!(normal)$)' | +| --warning | Set warning threshold for temperatures (syntax: type,instance,threshold) Example: --warning='temperature,.*,30' | +| --critical | Set critical threshold for temperatures (syntax: type,instance,threshold) Example: --critical='temperature,.*,40' | -| Option | Description | -|:-------------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| --filter-counters | Only display some counters (regexp can be used). Example to check SSL connections only : --filter-counters='^xxxx\|yyyy$' | -| --unknown-bank-status | Define the conditions to match for the status to be WARNING. You can use the following variables: %\{type\}, %\{status\}, %\{display\} | -| --warning-bank-status | Define the conditions to match for the status to be WARNING (default: '%\{status\} =~ /low\|nearOverload/i'). You can use the following variables: %\{type\}, %\{status\}, %\{display\} | -| --critical-bank-status | Define the conditions to match for the status to be CRITICAL (default: '%\{status\} =~ /^overload/'). You can use the following variables: %\{type\}, %\{status\}, %\{display\} | -| --unknown-phase-status | Define the conditions to match for the status to be WARNING. You can use the following variables: %\{status\}, %\{display\} | -| --warning-phase-status | Define the conditions to match for the status to be WARNING (default: '%\{status\} =~ /low\|nearOverload/i'). You can use the following variables: %\{status\}, %\{display\} | -| --critical-phase-status | Define the conditions to match for the status to be CRITICAL (default: '%\{status\} =~ /^overload/i'). You can use the following variables: %\{status\}, %\{display\} | -| --warning-* --critical-* | Thresholds. Can be: 'current', 'power'. | +| Option | Description | +|:-------------------------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| --filter-counters | Only display some counters (regexp can be used). Example to check SSL connections only : --filter-counters='^xxxx\|yyyy$' | +| --warning-xxx | Warning threshold. | +| --critical-xxx | Critical threshold. | +| --unknown-bank-status | Define the conditions to match for the status to be WARNING. You can use the following variables: %\{type\}, %\{status\}, %\{display\} | +| --warning-bank-status | Define the conditions to match for the status to be WARNING (default: '%\{status\} =~ /low\|nearOverload/i'). You can use the following variables: %\{type\}, %\{status\}, %\{display\} | +| --critical-bank-status | Define the conditions to match for the status to be CRITICAL (default: '%\{status\} =~ /^overload/'). You can use the following variables: %\{type\}, %\{status\}, %\{display\} | +| --unknown-phase-status | Define the conditions to match for the status to be WARNING. You can use the following variables: %\{status\}, %\{display\} | +| --warning-phase-status | Define the conditions to match for the status to be WARNING (default: '%\{status\} =~ /low\|nearOverload/i'). You can use the following variables: %\{status\}, %\{display\} | +| --critical-phase-status | Define the conditions to match for the status to be CRITICAL (default: '%\{status\} =~ /^overload/i'). You can use the following variables: %\{status\}, %\{display\} | +| --warning-* --critical-* | Thresholds. Can be: 'current', 'power'. | -| Option | Description | -|:------------------|:------------------------------------------------------------------------------------------------------------------------------| -| --filter-counters | Only display some counters (regexp can be used). Example to check SSL connections only : --filter-counters='^xxxx\|yyyy$' | -| --oid | Override default OID. | -| --warning-offset | Time warning threshold range (in seconds), in the format `-n:n` (e.g., `-5:5`). Returns WARNING when the offset is less than -n seconds or greater than n seconds. | -| --critical-offset | Time critical threshold range (in seconds), in the format `-n:n` (e.g., `-5:5`). Returns CRITICAL when the offset is less than -n seconds or greater than n seconds. | -| --ntp-hostname | Set the ntp hostname (if not set, localtime is used). | -| --ntp-port | Set the ntp port (default: 123). | -| --timezone | Set the timezone of distant server. For Windows, you need to set it. Can use format: 'Europe/London' or '+0100'. | +| Option | Description | +|:------------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------| +| --filter-counters | Only display some counters (regexp can be used). Example to check SSL connections only : --filter-counters='^xxxx\|yyyy$' | +| --warning-xxx | Warning threshold. | +| --critical-xxx | Critical threshold. | +| --oid | Override default OID. | +| --warning-offset | Time warning threshold range (in seconds), in the format -n:n (e.g., -5:5). Returns WARNING when the offset is less than -n seconds or greater than n seconds. | +| --critical-offset | Time critical threshold range (in seconds), in the format -n:n (e.g., -5:5). Returns CRITICAL when the offset is less than -n seconds or greater than n seconds. | +| --ntp-hostname | Set the NTP hostname (if not set, localtime is used). | +| --ntp-port | Set the NTP port (default: 123). | +| --timezone | Set the timezone of distant server. For Windows, you need to set it. Can use format: 'Europe/London' or '+0100'. | -| Option | Description | -|:-------------------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| --filter-counters | Only display some counters (regexp can be used). Example to check SSL connections only : --filter-counters='^xxxx\|yyyy$' | -| --unknown-status | Define the conditions to match for the status to be UNKNOWN. You can use the following variables: %\{status\}, %\{display\} | -| --warning-status | Define the conditions to match for the status to be WARNING (default: ''). You can use the following variables: %\{status\}, %\{phase\}, %\{bank\}, %\{display\} | -| --critical-status | Define the conditions to match for the status to be CRITICAL (default: '%\{status\} =~ /off/'). You can use the following variables: %\{status\}, %\{phase\}, %\{bank\}, %\{display\} | -| --warning-* --critical-* | Thresholds. Can be: 'current'. | +| Option | Description | +|:-------------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| --filter-counters | Only display some counters (regexp can be used). Example to check SSL connections only : --filter-counters='^xxxx\|yyyy$' | +| --warning-xxx | Warning threshold. | +| --critical-xxx | Critical threshold. | +| --unknown-status | Define the conditions to match for the status to be UNKNOWN. You can use the following variables: %\{status\}, %\{display\} | +| --warning-status | Define the conditions to match for the status to be WARNING (default: ''). You can use the following variables: %\{status\}, %\{phase\}, %\{bank\}, %\{display\} | +| --critical-status | Define the conditions to match for the status to be CRITICAL (default: '%\{status\} =~ /off/'). You can use the following variables: %\{status\}, %\{phase\}, %\{bank\}, %\{display\} | +| --warning-* --critical-* | Thresholds. Can be: 'current'. | -| Option | Description | -|:-----------------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| --filter-counters | Only display some counters (regexp can be used). Example to check SSL connections only : --filter-counters='^xxxx\|yyyy$' | -| --memcached | Memcached server to use (only one server). | -| --redis-server | Redis server to use (only one server). Syntax: address\[:port\] | -| --redis-attribute | Set Redis Options (--redis-attribute="cnx\_timeout=5"). | -| --redis-db | Set Redis database index. | -| --failback-file | Fall back on a local file if Redis connection fails. | -| --memexpiration | Time to keep data in seconds (default: 86400). | -| --statefile-dir | Define the cache directory (default: '/var/lib/centreon/centplugins'). | -| --statefile-suffix | Define a suffix to customize the statefile name (default: ''). | -| --statefile-concat-cwd | If used with the '--statefile-dir' option, the latter's value will be used as a sub-directory of the current working directory. Useful on Windows when the plugin is compiled, as the file system and permissions are different from Linux. | -| --statefile-format | Define the format used to store the cache. Available formats: 'dumper', 'storable', 'json' (default). | -| --statefile-key | Define the key to encrypt/decrypt the cache. | -| --statefile-cipher | Define the cipher algorithm to encrypt the cache (default: 'AES'). | -| --warning-uptime | Warning threshold. | -| --critical-uptime | Critical threshold. | -| --add-sysdesc | Display system description. | -| --force-oid | Can choose your OID (numeric format only). | -| --check-overload | Uptime counter limit is 4294967296 and overflow. With that option, we manage the counter going back. But there is a few chance we can miss a reboot. | -| --reboot-window | To be used with check-overload option. Time in milliseconds (default: 5000) You increase the chance of not missing a reboot if you decrease that value. | -| --unit | Select the time unit for thresholds. May be 's' for seconds, 'm' for minutes, 'h' for hours, 'd' for days, 'w' for weeks. Default is seconds. | +| Option | Description | +|:-----------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| --filter-counters | Only display some counters (regexp can be used). Example to check SSL connections only : --filter-counters='^xxxx\|yyyy$' | +| --warning-xxx | Warning threshold. | +| --critical-xxx | Critical threshold. | +| --memcached | Memcached server to use (only one server). | +| --redis-server | Redis server to use (only one server). Syntax: address\[:port\] | +| --redis-attribute | Set Redis Options (--redis-attribute="cnx\_timeout=5"). | +| --redis-db | Set Redis database index. | +| --failback-file | Fall back on a local file if Redis connection fails. | +| --memexpiration | Time to keep data in seconds (default: 86400). | +| --statefile-dir | Define the cache directory (default: '/var/lib/centreon/centplugins'). | +| --statefile-suffix | Define a suffix to customize the statefile name (default: ''). | +| --statefile-concat-cwd | If used with the '--statefile-dir' option, the latter's value will be used as a sub-directory of the current working directory. Useful on Windows when the plugin is compiled, as the file system and permissions are different from Linux. | +| --statefile-format | Define the format used to store the cache. Available formats: 'dumper', 'storable', 'json' (default). | +| --statefile-key | Define the key to encrypt/decrypt the cache. | +| --statefile-cipher | Define the cipher algorithm to encrypt the cache (default: 'AES'). | +| --warning-uptime | Warning threshold. | +| --critical-uptime | Critical threshold. | +| --add-sysdesc | Display system description. | +| --force-oid | Can choose your OID (numeric format only). | +| --check-overload | Uptime counter limit is 4294967296 and overflow. With that option, we manage the counter going back. But there is a few chance we can miss a reboot. | +| --reboot-window | To be used with check-overload option. Time in milliseconds (default: 5000) You increase the chance of not missing a reboot if you decrease that value. | +| --unit | Select the time unit for thresholds. May be 's' for seconds, 'm' for minutes, 'h' for hours, 'd' for days, 'w' for weeks. Default is seconds. | diff --git a/i18n/fr/docusaurus-plugin-content-docs-pp/current/integrations/plugin-packs/procedures/hardware-servers-hp-snmp.md b/i18n/fr/docusaurus-plugin-content-docs-pp/current/integrations/plugin-packs/procedures/hardware-servers-hp-snmp.md index 1e1dfc0ba61a..5fee5cb7663e 100644 --- a/i18n/fr/docusaurus-plugin-content-docs-pp/current/integrations/plugin-packs/procedures/hardware-servers-hp-snmp.md +++ b/i18n/fr/docusaurus-plugin-content-docs-pp/current/integrations/plugin-packs/procedures/hardware-servers-hp-snmp.md @@ -5,11 +5,17 @@ title: HP Proliant SNMP import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; +## Dépendances du connecteur de supervision + +Les connecteurs de supervision suivants sont automatiquement installés lors de l'installation du connecteur **HP Proliant SNMP** +depuis la page **Configuration > Connecteurs > Connecteurs de supervision** : +* [Base Pack](./base-generic.md) + ## Contenu du pack ### Modèles -Le connecteur de supervision **HP Proliant** apporte un modèle d'hôte : +Le connecteur de supervision **HP Proliant SNMP** apporte un modèle d'hôte : * **HW-Server-Hp-Server-SNMP-custom** @@ -19,9 +25,9 @@ Le connecteur apporte les modèles de service suivants -| Alias | Modèle de service | Description | -|:----------------|:-----------------------------------------|:--------------------------------| -| Hardware-Global | HW-Hp-Server-Hardware-Global-SNMP-custom | Contrôle l'ensemble des sondes | +| Alias | Modèle de service | Description | +|:----------------|:-----------------------------------------|:-----------------------------------------------------------------------------------------| +| Hardware-Global | HW-Hp-Server-Hardware-Global-SNMP-custom | Contrôle l'ensemble des sondes ('cpu', 'ventilateur', 'température', 'alimentation',...) | > Les services listés ci-dessus sont créés automatiquement lorsque le modèle d'hôte **HW-Server-Hp-Server-SNMP-custom** est utilisé. @@ -30,9 +36,9 @@ Le connecteur apporte les modèles de service suivants | Alias | Modèle de service | Description | |:---------------------|:----------------------------------------------|:-----------------------------------------| -| Hardware-Cpu | HW-Hp-Server-Hardware-Cpu-SNMP-custom | Contrôle les CPUs | +| Hardware-Cpu | HW-Hp-Server-Hardware-Cpu-SNMP-custom | Contrôle les cpus | | Hardware-Fan | HW-Hp-Server-Hardware-Fan-SNMP-custom | Contrôle les ventilateurs | -| Hardware-Network | HW-Hp-Server-Hardware-Network-SNMP-custom | Contrôle les cartes réseau | +| Hardware-Network | HW-Hp-Server-Hardware-Network-SNMP-custom | Contrôle les cartes réseaux | | Hardware-Pc | HW-Hp-Server-Hardware-Pc-SNMP-custom | Contrôle les convertisseurs de puissance | | Hardware-Psu | HW-Hp-Server-Hardware-Psu-SNMP-custom | Contrôle les alimentations | | Hardware-Storage | HW-Hp-Server-Hardware-Storage-SNMP-custom | Contrôle le stockage | @@ -47,75 +53,75 @@ Le connecteur apporte les modèles de service suivants #### Découverte d'hôtes -| Nom de la règle | Description | -|:----------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| SNMP Agents | Découvre les ressources via un scan réseau SNMP. Installez le connecteur [Generic SNMP](./applications-protocol-snmp.md) pour obtenir la règle de découverte et créez un modificateur pour le modèle d'hôte **HW-Server-Hp-Server-SNMP-custom** | +| Nom de la règle | Description | +|:----------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| SNMP Agents | Découvre les ressources via un scan réseau SNMP. Installez le connecteur [Generic SNMP](./applications-protocol-snmp.md) pour obtenir la règle de découverte et créez un modificateur pour le modèle d'hôte **HW-Server-Hp-Server-SNMP-custom**. | Rendez-vous sur la [documentation dédiée](/docs/monitoring/discovery/hosts-discovery) pour en savoir plus sur la découverte automatique d'hôtes. ### Métriques & statuts collectés -Voici le tableau des services pour ce connecteur, détaillant les métriques rattachées à chaque service. +Voici le tableau des services pour ce connecteur, détaillant les métriques et statuts rattachés à chaque service. -| Métrique | Description | Unité | -|:------------|:------------|:------| -| status | CPU status | N/A | +| Nom | Unité | +|:-------|:------| +| status | N/A | -| Métrique | Description | Unité | -|:-----------------------|:------------|:------| -| status | Fan status | N/A | -| hardware.fan.speed.rpm | Fan speed | Rpm | +| Nom | Unité | +|:-----------------------|:------| +| status | N/A | +| hardware.fan.speed.rpm | Rpm | -| Métrique | Description | Unité | -|:------------|:-------------------------|:------| -| status | Components global status | N/A | +| Nom | Unité | +|:-------|:------| +| status | N/A | -| Métrique | Description | Unité | -|:------------|:------------|:------| -| status | NIC status | N/A | +| Nom | Unité | +|:-------|:------| +| status | N/A | -| Métrique | Description | Unité | -|:------------|:-----------------------|:------| -| status | Power Converter status | N/A | +| Nom | Unité | +|:-------|:------| +| status | N/A | -| Métrique | Description | Unité | -|:----------------------------------|:--------------------------------|:------| -| status | Power supply status | N/A | -| hardware.powersupply.power.watt | Power supply watt capacity used | W | -| hardware.powersupply.voltage.volt | Power supply voltage | V | +| Nom | Unité | +|:----------------------------------|:------| +| status | N/A | +| hardware.powersupply.power.watt | W | +| hardware.powersupply.voltage.volt | V | -| Métrique | Description | Unité | -|:------------|:---------------|:------| -| status | Storage status | N/A | +| Nom | Unité | +|:-------|:------| +| status | N/A | -| Métrique | Description | Unité | -|:-----------------------------|:------------------------|:------| -| status | Temperature status | N/A | -| hardware.temperature.celsius | Temperature in celsius | C | +| Nom | Unité | +|:-----------------------------|:------| +| status | N/A | +| hardware.temperature.celsius | C | @@ -124,45 +130,16 @@ Voici le tableau des services pour ce connecteur, détaillant les métriques rat ### Configuration SNMP -Pour utiliser ce connecteur de supervision, le service SNMP doit démarré et configuré sur le serveur **HP Proliant**. +L'agent SNMP doit être activé et configuré sur l'équipement. +Veuillez vous référer à la documentation officielle. +Il se peut que votre équipement nécessite qu'une liste d'adresses autorisées à l'interroger soit paramétrée. +Veillez à ce que les adresses des collecteurs Centreon y figurent bien. ### Flux réseau La communication doit être possible sur le port UDP 161 depuis le collecteur Centreon vers le serveur supervisé. -## Configuration de l'agent snmp HP sur le collecteur Centreon - -> Attention : La procédure qui suit est valide seulement pour Centos 7. Les paquets HP health et HP snmp-agents sont en version 10.50 et disponibles uniquement pour Centos 7. - -> Pour le bon fonctionnement de l'agent et du plugin, le collecteur Centreon doit être installé sur un HP Proliant. - - - - -Installez les paquets HP health et snmp-agents sur le collecteur Centreon : - -```bash -yum install https://downloads.linux.hpe.com/SDR/repo/mcp/centos/7.0/x86_64/10.50/hp-health-10.50-1826.40.rhel7.x86_64.rpm -yum install https://downloads.linux.hpe.com/SDR/repo/mcp/centos/7.0/x86_64/10.50/hp-snmp-agents-10.50-2926.49.rhel7.x86_64.rpm -``` - -Ajoutez la ligne suivante dans */etc/snmp/snmpd.conf* : - -```bash -dlmod cmaX /usr/lib64/libcmaX64.so -``` - -Redémarrez les services suivants : - -```bash -systemctl restart hp-snmp-agents -systemctl restart snmpd -``` - - - - ## Installer le connecteur de supervision ### Pack @@ -206,7 +183,7 @@ yum install centreon-pack-hardware-servers-hp-snmp -2. Quel que soit le type de la licence (*online* ou *offline*), installez le connecteur **HP Proliant** +2. Quel que soit le type de la licence (*online* ou *offline*), installez le connecteur **HP Proliant SNMP** depuis l'interface web et le menu **Configuration > Connecteurs > Connecteurs de supervision**. ### Plugin @@ -259,12 +236,14 @@ yum install centreon-plugin-Hardware-Servers-Hp-Snmp 2. Complétez les champs **Nom**, **Alias** & **IP Address/DNS** correspondant à votre ressource. 3. Appliquez le modèle d'hôte **HW-Server-Hp-Server-SNMP-custom**. -> Si vous utilisez SNMP en version 3, vous devez configurer les paramètres spécifiques associés via la macro **SNMPEXTRAOPTIONS**. -> Plus d'informations dans la section [Troubleshooting SNMP](../getting-started/how-to-guides/troubleshooting-plugins.md#mapping-des-options-snmpv3). - -| Macro | Description | Valeur par défaut | Obligatoire | -|:-----------------|:---------------------------------------------------------------------------------------------------------------------------------------------------|:------------------|:-----------:| -| SNMPEXTRAOPTIONS | Any extra option you may want to add to every command (a --verbose flag for example). Toutes les options sont listées [ici](#options-disponibles). | | | +| Macro | Description | Valeur par défaut | Obligatoire | +|:------------------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------|:------------------|:-----------:| +| SNMP_V3_USERNAME | SNMP v3 only: User name (`securityName`) | | | +| SNMP_V3_AUTH_PROTOCOL | SNMP v3 only: Authentication protocol: MD5\|SHA. Since net-snmp 5.9.1: SHA224\|SHA256\|SHA384\|SHA512 | | | +| SNMP_V3_PRIV_PROTOCOL | 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 | | | +| SNMP_V3_AUTH_PASSPHRASE | SNMP v3 only: Pass phrase hashed using the authentication protocol defined in the --authprotocol option | | | +| SNMP_V3_PRIV_PASSPHRASE | SNMP v3 only: Privacy pass phrase (`privPassword`) to encrypt messages using the protocol defined in the --privprotocol option | | | +| SNMPEXTRAOPTIONS | Any extra option you may want to add to every command (a --verbose flag for example). Toutes les options sont listées [ici](#options-disponibles). | | | 4. [Déployez la configuration](/docs/monitoring/monitoring-servers/deploying-a-configuration). L'hôte apparaît dans la liste des hôtes supervisés, et dans la page **Statut des ressources**. La commande envoyée par le connecteur est indiquée dans le panneau de détails de l'hôte : celle-ci montre les valeurs des macros. @@ -276,18 +255,18 @@ yum install centreon-plugin-Hardware-Servers-Hp-Snmp -| Macro | Description | Valeur par défaut | Obligatoire | -|:-------------|:-------------------------------------------------------------------------------------------------------------------------------------------------|:------------------|:-----------:| -| COMPONENT | Which component to check. | cpu | | -| EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). Toutes les options sont listées [ici](#options-disponibles). | --verbose | | +| Macro | Description | Valeur par défaut | Obligatoire | +|:-------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------|:------------------|:-----------:| +| COMPONENT | Which component to check. Can be: 'cpu', 'psu', 'pc', 'fan', 'temperature', 'lnic', 'pnic',... There are some magic words like: 'network', 'storage' | cpu | | +| EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). Toutes les options sont listées [ici](#options-disponibles). | --verbose | | -| Macro | Description | Valeur par défaut | Obligatoire | -|:-------------|:-------------------------------------------------------------------------------------------------------------------------------------------------|:------------------|:-----------:| -| COMPONENT | Which component to check. | fan | | -| EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). Toutes les options sont listées [ici](#options-disponibles). | --verbose | | +| Macro | Description | Valeur par défaut | Obligatoire | +|:-------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------|:------------------|:-----------:| +| COMPONENT | Which component to check. Can be: 'cpu', 'psu', 'pc', 'fan', 'temperature', 'lnic', 'pnic',... There are some magic words like: 'network', 'storage' | fan | | +| EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). Toutes les options sont listées [ici](#options-disponibles). | --verbose | | @@ -300,42 +279,42 @@ yum install centreon-plugin-Hardware-Servers-Hp-Snmp -| Macro | Description | Valeur par défaut | Obligatoire | -|:-------------|:-------------------------------------------------------------------------------------------------------------------------------------------------|:------------------|:-----------:| -| COMPONENT | Which component to check. | network | | -| EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). Toutes les options sont listées [ici](#options-disponibles). | --verbose | | +| Macro | Description | Valeur par défaut | Obligatoire | +|:-------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------|:------------------|:-----------:| +| COMPONENT | Which component to check. Can be: 'cpu', 'psu', 'pc', 'fan', 'temperature', 'lnic', 'pnic',... There are some magic words like: 'network', 'storage' | network | | +| EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). Toutes les options sont listées [ici](#options-disponibles). | --verbose | | -| Macro | Description | Valeur par défaut | Obligatoire | -|:-------------|:-------------------------------------------------------------------------------------------------------------------------------------------------|:------------------|:-----------:| -| COMPONENT | Which component to check | pc | | -| EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). Toutes les options sont listées [ici](#options-disponibles). | --verbose | | +| Macro | Description | Valeur par défaut | Obligatoire | +|:-------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------|:------------------|:-----------:| +| COMPONENT | Which component to check. Can be: 'cpu', 'psu', 'pc', 'fan', 'temperature', 'lnic', 'pnic',... There are some magic words like: 'network', 'storage' | pc | | +| EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). Toutes les options sont listées [ici](#options-disponibles). | --verbose | | -| Macro | Description | Valeur par défaut | Obligatoire | -|:-------------|:-------------------------------------------------------------------------------------------------------------------------------------------------|:------------------|:-----------:| -| COMPONENT | Which component to check | psu | | -| EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). Toutes les options sont listées [ici](#options-disponibles). | --verbose | | +| Macro | Description | Valeur par défaut | Obligatoire | +|:-------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------|:------------------|:-----------:| +| COMPONENT | Which component to check. Can be: 'cpu', 'psu', 'pc', 'fan', 'temperature', 'lnic', 'pnic',... There are some magic words like: 'network', 'storage' | psu | | +| EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). Toutes les options sont listées [ici](#options-disponibles). | --verbose | | -| Macro | Description | Valeur par défaut | Obligatoire | -|:-------------|:-------------------------------------------------------------------------------------------------------------------------------------------------|:------------------|:-----------:| -| COMPONENT | Which component to check | storage | | -| EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). Toutes les options sont listées [ici](#options-disponibles). | --verbose | | +| Macro | Description | Valeur par défaut | Obligatoire | +|:-------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------|:------------------|:-----------:| +| COMPONENT | Which component to check. Can be: 'cpu', 'psu', 'pc', 'fan', 'temperature', 'lnic', 'pnic',... There are some magic words like: 'network', 'storage' | storage | | +| EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). Toutes les options sont listées [ici](#options-disponibles). | --verbose | | -| Macro | Description | Valeur par défaut | Obligatoire | -|:-------------|:-------------------------------------------------------------------------------------------------------------------------------------------------|:------------------|:-----------:| -| COMPONENT | Which component to check | temperature | | -| EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). Toutes les options sont listées [ici](#options-disponibles). | --verbose | | +| Macro | Description | Valeur par défaut | Obligatoire | +|:-------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------|:------------------|:-----------:| +| COMPONENT | Which component to check. Can be: 'cpu', 'psu', 'pc', 'fan', 'temperature', 'lnic', 'pnic',... There are some magic words like: 'network', 'storage' | temperature | | +| EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). Toutes les options sont listées [ici](#options-disponibles). | --verbose | | @@ -356,8 +335,13 @@ telle que celle-ci (remplacez les valeurs d'exemple par les vôtres) : --mode=hardware \ --hostname=10.0.0.1 \ --snmp-version='2c' \ - --snmp-community='my-snmp-community' \ - --component='cpu' \ + --snmp-community='my-snmp-community' \ + --snmp-username='username' \ + --authpassphrase='' \ + --authprotocol='' \ + --privpassphrase='' \ + --privprotocol='' \ + --component='temperature' \ --verbose ``` @@ -365,7 +349,6 @@ La commande devrait retourner un message de sortie similaire à : ```bash OK: All 18 components are ok [1/1 cpus, 1/1 da accelerator boards, 1/1 da controllers, 3/3 da logical drives, 12/12 da physical drives]. | 'hardware.cpu.count'=1;;;; 'hardware.daacc.count'=1;;;; 'hardware.dactl.count'=1;;;; 'hardware.daldrive.count'=3;;;; 'hardware.dapdrive.count'=12;;;; - ``` ### Diagnostic des erreurs communes @@ -393,7 +376,7 @@ Le plugin apporte les modes suivants : | Mode | Modèle de service associé | |:--------------------------------------------------------------------------------------------------------------------------------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| global-status [[code](https://github.com/centreon/centreon-plugins/blob/develop/src/hardware/server/hp/proliant/snmp/mode/globalstatus.pm)] | Not used in this Monitoring Connector | +| global-status [[code](https://github.com/centreon/centreon-plugins/blob/develop/src/hardware/server/hp/proliant/snmp/mode/globalstatus.pm)] | Non utilisé dans ce connecteur de supervision | | hardware [[code](https://github.com/centreon/centreon-plugins/blob/develop/src/hardware/server/hp/proliant/snmp/mode/hardware.pm)] | HW-Hp-Server-Hardware-Cpu-SNMP-custom
HW-Hp-Server-Hardware-Fan-SNMP-custom
HW-Hp-Server-Hardware-Global-SNMP-custom
HW-Hp-Server-Hardware-Network-SNMP-custom
HW-Hp-Server-Hardware-Pc-SNMP-custom
HW-Hp-Server-Hardware-Psu-SNMP-custom
HW-Hp-Server-Hardware-Storage-SNMP-custom
HW-Hp-Server-Hardware-Temperature-SNMP-custom | ### Options disponibles @@ -402,172 +385,74 @@ Le plugin apporte les modes suivants : Les options génériques sont listées ci-dessous : -| 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. | -| --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\[,\[newuom\],\[min\],\[m ax\]\] Common examples: 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()' | -| --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,namesofnewmetrics,calculation\[,\[ne wuom\],\[min\],\[max\]\] regex: regular expression namesofnewmetrics: 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 newuom (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: 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(traf fic\_(in\|out)\_$1)' | -| --change-short-output --change-long-output | Modify the short/long output that is returned by the plugin. Syntax: --change-short-output=pattern~replacement~modifier Most commonly used modifiers are i (case insensitive) and g (replace all occurrences). Example: adding --change-short-output='OK\~Up\~gi' will replace all occurrences of 'OK', 'ok', 'Ok' or 'oK' with 'Up' | -| --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. | -| --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). E.g.: --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'. | -| --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 ok, 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. | - -#### Options des modes - -Les options disponibles pour chaque modèle de services sont listées ci-dessous : - - - - -| Option | Description | -|:---------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| --component | Which component to check (default: '.*'). Can be: 'cpu', 'psu', 'pc', 'fan', 'temperature', 'lnic', 'pnic',... There are some magic words like: 'network', 'storage'. | -| --filter | Exclude the items given as a comma-separated list (example: --filter=fan --filter=temperature). You can also exclude items from specific instances: --filter=fan,1.2 --filter=lnic,1 | -| --absent-problem | Return an error if an entity is not 'present' (default is skipping Can be specific or global: --absent-problem=fan,1.2 | -| --no-component | Define the expected status if no components are found (default: critical). | -| --threshold-overload | Use this option to override the status returned by the plugin when the status label matches a regular expression (syntax: section,status,regexp). Example: --threshold-overload='temperature,CRITICAL,^(?!(ok)$)' | -| --warning | Set warning threshold for temperatures (syntax: type,regexp,threshold) Example: --warning='temperature,.*,30' | -| --critical | Set critical threshold for temperatures (syntax: type,regexp,threshold) Example: --critical='temperature,.*,40' | - - - - -| Option | Description | -|:---------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| --component | Which component to check (default: '.*'). Can be: 'cpu', 'psu', 'pc', 'fan', 'temperature', 'lnic', 'pnic',... There are some magic words like: 'network', 'storage'. | -| --filter | Exclude the items given as a comma-separated list (example: --filter=fan --filter=temperature). You can also exclude items from specific instances: --filter=fan,1.2 --filter=lnic,1 | -| --absent-problem | Return an error if an entity is not 'present' (default is skipping Can be specific or global: --absent-problem=fan,1.2 | -| --no-component | Define the expected status if no components are found (default: critical). | -| --threshold-overload | Use this option to override the status returned by the plugin when the status label matches a regular expression (syntax: section,status,regexp). Example: --threshold-overload='temperature,CRITICAL,^(?!(ok)$)' | -| --warning | Set warning threshold for temperatures (syntax: type,regexp,threshold) Example: --warning='temperature,.*,30' | -| --critical | Set critical threshold for temperatures (syntax: type,regexp,threshold) Example: --critical='temperature,.*,40' | - - - - -| Option | Description | -|:---------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| --component | Which component to check (default: '.*'). Can be: 'cpu', 'psu', 'pc', 'fan', 'temperature', 'lnic', 'pnic',... There are some magic words like: 'network', 'storage'. | -| --filter | Exclude the items given as a comma-separated list (example: --filter=fan --filter=temperature). You can also exclude items from specific instances: --filter=fan,1.2 --filter=lnic,1 | -| --absent-problem | Return an error if an entity is not 'present' (default is skipping Can be specific or global: --absent-problem=fan,1.2 | -| --no-component | Define the expected status if no components are found (default: critical). | -| --threshold-overload | Use this option to override the status returned by the plugin when the status label matches a regular expression (syntax: section,status,regexp). Example: --threshold-overload='temperature,CRITICAL,^(?!(ok)$)' | -| --warning | Set warning threshold for temperatures (syntax: type,regexp,threshold) Example: --warning='temperature,.*,30' | -| --critical | Set critical threshold for temperatures (syntax: type,regexp,threshold) Example: --critical='temperature,.*,40' | - - - - -| Option | Description | -|:---------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| --component | Which component to check (default: '.*'). Can be: 'cpu', 'psu', 'pc', 'fan', 'temperature', 'lnic', 'pnic',... There are some magic words like: 'network', 'storage'. | -| --filter | Exclude the items given as a comma-separated list (example: --filter=fan --filter=temperature). You can also exclude items from specific instances: --filter=fan,1.2 --filter=lnic,1 | -| --absent-problem | Return an error if an entity is not 'present' (default is skipping Can be specific or global: --absent-problem=fan,1.2 | -| --no-component | Define the expected status if no components are found (default: critical). | -| --threshold-overload | Use this option to override the status returned by the plugin when the status label matches a regular expression (syntax: section,status,regexp). Example: --threshold-overload='temperature,CRITICAL,^(?!(ok)$)' | -| --warning | Set warning threshold for temperatures (syntax: type,regexp,threshold) Example: --warning='temperature,.*,30' | -| --critical | Set critical threshold for temperatures (syntax: type,regexp,threshold) Example: --critical='temperature,.*,40' | - - - - -| Option | Description | -|:---------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| --component | Which component to check (default: '.*'). Can be: 'cpu', 'psu', 'pc', 'fan', 'temperature', 'lnic', 'pnic',... There are some magic words like: 'network', 'storage'. | -| --filter | Exclude the items given as a comma-separated list (example: --filter=fan --filter=temperature). You can also exclude items from specific instances: --filter=fan,1.2 --filter=lnic,1 | -| --absent-problem | Return an error if an entity is not 'present' (default is skipping Can be specific or global: --absent-problem=fan,1.2 | -| --no-component | Define the expected status if no components are found (default: critical). | -| --threshold-overload | Use this option to override the status returned by the plugin when the status label matches a regular expression (syntax: section,status,regexp). Example: --threshold-overload='temperature,CRITICAL,^(?!(ok)$)' | -| --warning | Set warning threshold for temperatures (syntax: type,regexp,threshold) Example: --warning='temperature,.*,30' | -| --critical | Set critical threshold for temperatures (syntax: type,regexp,threshold) Example: --critical='temperature,.*,40' | - - - - -| Option | Description | -|:---------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| --component | Which component to check (default: '.*'). Can be: 'cpu', 'psu', 'pc', 'fan', 'temperature', 'lnic', 'pnic',... There are some magic words like: 'network', 'storage'. | -| --filter | Exclude the items given as a comma-separated list (example: --filter=fan --filter=temperature). You can also exclude items from specific instances: --filter=fan,1.2 --filter=lnic,1 | -| --absent-problem | Return an error if an entity is not 'present' (default is skipping Can be specific or global: --absent-problem=fan,1.2 | -| --no-component | Define the expected status if no components are found (default: critical). | -| --threshold-overload | Use this option to override the status returned by the plugin when the status label matches a regular expression (syntax: section,status,regexp). Example: --threshold-overload='temperature,CRITICAL,^(?!(ok)$)' | -| --warning | Set warning threshold for temperatures (syntax: type,regexp,threshold) Example: --warning='temperature,.*,30' | -| --critical | Set critical threshold for temperatures (syntax: type,regexp,threshold) Example: --critical='temperature,.*,40' | - - - - -| Option | Description | -|:---------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| --component | Which component to check (default: '.*'). Can be: 'cpu', 'psu', 'pc', 'fan', 'temperature', 'lnic', 'pnic',... There are some magic words like: 'network', 'storage'. | -| --filter | Exclude the items given as a comma-separated list (example: --filter=fan --filter=temperature). You can also exclude items from specific instances: --filter=fan,1.2 --filter=lnic,1 | -| --absent-problem | Return an error if an entity is not 'present' (default is skipping Can be specific or global: --absent-problem=fan,1.2 | -| --no-component | Define the expected status if no components are found (default: critical). | -| --threshold-overload | Use this option to override the status returned by the plugin when the status label matches a regular expression (syntax: section,status,regexp). Example: --threshold-overload='temperature,CRITICAL,^(?!(ok)$)' | -| --warning | Set warning threshold for temperatures (syntax: type,regexp,threshold) Example: --warning='temperature,.*,30' | -| --critical | Set critical threshold for temperatures (syntax: type,regexp,threshold) Example: --critical='temperature,.*,40' | - - - - -| Option | Description | -|:---------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| --component | Which component to check (default: '.*'). Can be: 'cpu', 'psu', 'pc', 'fan', 'temperature', 'lnic', 'pnic',... There are some magic words like: 'network', 'storage'. | -| --filter | Exclude the items given as a comma-separated list (example: --filter=fan --filter=temperature). You can also exclude items from specific instances: --filter=fan,1.2 --filter=lnic,1 | -| --absent-problem | Return an error if an entity is not 'present' (default is skipping Can be specific or global: --absent-problem=fan,1.2 | -| --no-component | Define the expected status if no components are found (default: critical). | -| --threshold-overload | Use this option to override the status returned by the plugin when the status label matches a regular expression (syntax: section,status,regexp). Example: --threshold-overload='temperature,CRITICAL,^(?!(ok)$)' | -| --warning | Set warning threshold for temperatures (syntax: type,regexp,threshold) Example: --warning='temperature,.*,30' | -| --critical | Set critical threshold for temperatures (syntax: type,regexp,threshold) Example: --critical='temperature,.*,40' | - - - +| 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 get-next 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 ok, 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. | +| --show-password | By default, sensitive information in command lines is hidden in debug output and replaced with `***` (however, debug logs may still display sensitive information). Using the C option will display the passwords in plain text. | +| --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\[,\[\\],\[min\],\[max\]\] Common examples: onvert 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\[,\[\\],\[min\],\[max\]\] Common examples: onvert 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\[,\[\\],\[min\],\[max\]\] Common examples: onvert 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,\,calculation\[,\[\\],\[min\],\[max\]\] regex: regular expression \: 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 \ (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: um 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~replacement~modifier Most commonly used modifiers are i (case insensitive) and g (replace all occurrences). Example: adding --change-short-output='OK~Up~gi' will replace all occurrences of 'OK', 'ok', 'Ok' or 'oK' with 'Up' | +| --change-short-output | Modify the short/long output that is returned by the plugin. Syntax: --change-short-output=pattern~replacement~modifier Most commonly used modifiers are i (case insensitive) and g (replace all occurrences). Example: adding --change-short-output='OK~Up~gi' will replace all occurrences of 'OK', 'ok', 'Ok' or 'oK' with 'Up' | +| --change-long-output | Modify the short/long output that is returned by the plugin. Syntax: --change-short-output=pattern~replacement~modifier Most commonly used modifiers are i (case insensitive) and g (replace all occurrences). Example: adding --change-short-output='OK~Up~gi' will replace all occurrences of 'OK', 'ok', 'Ok' or 'oK' with 'Up' | +| --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'. \. | +| --component | Which component to check (default: '.*'). Can be: 'cpu', 'psu', 'pc', 'fan', 'temperature', 'lnic', 'pnic',... There are some magic words like: 'network', 'storage'. | +| --filter | Exclude the items given as a comma-separated list (example: --filter=fan --filter=temperature). You can also exclude items from specific instances: --filter=fan,1.2 --filter=lnic,1 | +| --absent-problem | Return an error if an entity is not 'present' (default is skipping Can be specific or global: --absent-problem=fan,1.2 | +| --no-component | Define the expected status if no components are found (default: critical). | +| --threshold-overload | Use this option to override the status returned by the plugin when the status label matches a regular expression (syntax: section,status,regexp). Example: --threshold-overload='temperature,CRITICAL,^(?!(ok)$)' | +| --warning | Set warning threshold for temperatures (syntax: type,regexp,threshold) Example: --warning='temperature,.*,30' | +| --critical | Set critical threshold for temperatures (syntax: type,regexp,threshold) Example: --critical='temperature,.*,40' | Pour un mode, la liste de toutes les options disponibles et leur signification peut être affichée en ajoutant le paramètre `--help` à la commande : diff --git a/i18n/fr/docusaurus-plugin-content-docs-pp/current/integrations/plugin-packs/procedures/hardware-storage-qnap-snmp.md b/i18n/fr/docusaurus-plugin-content-docs-pp/current/integrations/plugin-packs/procedures/hardware-storage-qnap-snmp.md index 2f1a1c30ff78..8d1185660014 100644 --- a/i18n/fr/docusaurus-plugin-content-docs-pp/current/integrations/plugin-packs/procedures/hardware-storage-qnap-snmp.md +++ b/i18n/fr/docusaurus-plugin-content-docs-pp/current/integrations/plugin-packs/procedures/hardware-storage-qnap-snmp.md @@ -7,19 +7,15 @@ import TabItem from '@theme/TabItem'; ## Dépendances du connecteur de supervision -Les connecteurs de supervision suivants sont automatiquement installés lors de l'installation du connecteur **Qnap** +Les connecteurs de supervision suivants sont automatiquement installés lors de l'installation du connecteur **Qnap SNMP** depuis la page **Configuration > Connecteurs > Connecteurs de supervision** : * [Base Pack](./base-generic.md) ## Contenu du pack -### Modèles d'équipement supportés - -* EKI utilisant le système d'opération QTS et QuTS hero. - ### Modèles -Le connecteur de supervision **Qnap** apporte un modèle d'hôte : +Le connecteur de supervision **Qnap SNMP** apporte un modèle d'hôte : * **HW-Storage-Qnap-SNMP-custom** @@ -32,7 +28,7 @@ Le connecteur apporte les modèles de service suivants | Alias | Modèle de service | Description | |:----------------|:--------------------------------------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | Cpu | HW-Storage-Qnap-Cpu-SNMP-custom | Contrôle du taux d'utilisation du CPU de la machine. Ce contrôle pourra remonter la moyenne du taux d'utilisation des CPU ainsi que le taux par CPU pour les CPU multi-coeur | -| Hardware-Global | HW-Storage-Qnap-Hardware-Global-SNMP-custom | Contrôle le matériel | +| Hardware-Global | HW-Storage-Qnap-Hardware-Global-SNMP-custom | Contrôle le matériel ('ventilateur', 'température', 'disque') | | Memory | HW-Storage-Qnap-Memory-SNMP-custom | Contrôle du taux d'utilisation mémoire | | Volumes | HW-Storage-Qnap-Volumes-SNMP-custom | Contrôle les volumes | @@ -41,13 +37,13 @@ Le connecteur apporte les modèles de service suivants -| Alias | Modèle de service | Description | Découverte | -|:---------------------|:-------------------------------------------------|:-------------------------------------------------------------------------------------------------------------------------|:----------:| -| Disk-Global | HW-Storage-Qnap-Disk-Global-SNMP-custom | Contrôle du taux d'espace libre disponible des disques. Pour chaque contrôle apparaîtra le point de montage des disques | X | -| Pools | HW-Storage-Qnap-Pools-SNMP-custom | Contrôle les pools | | -| Traffic-Generic-Id | HW-Storage-Qnap-Traffic-Generic-Id-SNMP-custom | Contrôle le traffic réseau d'une interface réseau | | -| Traffic-Generic-Name | HW-Storage-Qnap-Traffic-Generic-Name-SNMP-custom | Contrôle le traffic réseau d'une interface réseau | | -| Traffic-Global | HW-Storage-Qnap-Traffic-Global-SNMP-custom | Contrôle le traffic réseau de plusieurs interfaces réseau | X | +| Alias | Modèle de service | Description | Découverte | +|:---------------------|:-------------------------------------------------|:--------------------------------------------------------------------------------------------------------------------------|:----------:| +| Disk-Global | HW-Storage-Qnap-Disk-Global-SNMP-custom | Contrôle du taux d'espace libre disponible des disques. Pour chaque contrôle apparaîtra le point de montage des disques | X | +| Pools | HW-Storage-Qnap-Pools-SNMP-custom | Contrôle les pools | | +| Traffic-Generic-Id | HW-Storage-Qnap-Traffic-Generic-Id-SNMP-custom | Contrôle le traffic réseau d'une interface réseau | | +| Traffic-Generic-Name | HW-Storage-Qnap-Traffic-Generic-Name-SNMP-custom | Contrôle le traffic réseau d'une interface réseau | | +| Traffic-Global | HW-Storage-Qnap-Traffic-Global-SNMP-custom | Contrôle le traffic réseau de plusieurs interfaces réseau | X | > Les services listés ci-dessus ne sont pas créés automatiquement lorsqu'un modèle d'hôte est appliqué. Pour les utiliser, [créez un service manuellement](/docs/monitoring/basic-objects/services) et appliquez le modèle de service souhaité. @@ -68,10 +64,10 @@ Rendez-vous sur la [documentation dédiée](/docs/monitoring/discovery/hosts-dis #### Découverte de services -| Nom de la règle | Description | -|:----------------------------------|:---------------------------------------------------------------------------| -| HW-Storage-Qnap-SNMP-Disk-Name | Découvre les partitions du disque et supervise l'occupation de son espace | -| HW-Storage-Qnap-SNMP-Traffic-Name | Découvre les interfaces réseau et en supervise le statut et l'utilisation | +| Nom de la règle | Description | +|:----------------------------------|:-------------------------------------------------------------------------------------------------------| +| HW-Storage-Qnap-SNMP-Disk-Name | Découvre les partitions du disque en utilisant son nom et supervise l'espace occupé | +| HW-Storage-Qnap-SNMP-Traffic-Name | Utilise le nom du disque pour découvrir les partitions du disque et supervise l'occupation de l'espace | Rendez-vous sur la [documentation dédiée](/docs/monitoring/discovery/services-discovery) pour en savoir plus sur la découverte automatique de services et sa [planification](/docs/monitoring/discovery/services-discovery/#règles-de-découverte). @@ -105,12 +101,19 @@ Voici le tableau des services pour ce connecteur, détaillant les métriques et | Nom | Unité | -|:-----------------------------------|:------| -| hardware.temperature.celsius | C | -| hardware.disk.temperature.celsius | C | -| hardware.mdisk.temperature.celsius | C | -| hardware.fan.speed.rpm | rpm | -| hardware.powersupply.fan.speed.rpm | N/A | +|:---------------------------|:------| +| hardware.disk.count | count | +| disk status | N/A | +| hardware.fan.count | count | +| fan status | N/A | +| hardware.mdisk.count | count | +| mdisk status | N/A | +| hardware.psu.count | count | +| psu status | N/A | +| hardware.raid.count | count | +| raid status | N/A | +| hardware.temperature.count | count | +| temperature status | N/A | @@ -212,7 +215,7 @@ yum install centreon-pack-hardware-storage-qnap-snmp -2. Quel que soit le type de la licence (*online* ou *offline*), installez le connecteur **Qnap** +2. Quel que soit le type de la licence (*online* ou *offline*), installez le connecteur **Qnap SNMP** depuis l'interface web et le menu **Configuration > Connecteurs > Connecteurs de supervision**. ### Plugin @@ -265,12 +268,14 @@ yum install centreon-plugin-Hardware-Storage-Qnap-Snmp 2. Complétez les champs **Nom**, **Alias** & **IP Address/DNS** correspondant à votre ressource. 3. Appliquez le modèle d'hôte **HW-Storage-Qnap-SNMP-custom**. -> Si vous utilisez SNMP en version 3, vous devez configurer les paramètres spécifiques associés via la macro **SNMPEXTRAOPTIONS**. -> Plus d'informations dans la section [Troubleshooting SNMP](../getting-started/how-to-guides/troubleshooting-plugins.md#mapping-des-options-snmpv3). - -| Macro | Description | Valeur par défaut | Obligatoire | -|:-----------------|:---------------------------------------------------------------------------------------------------------------------------------------------------|:------------------|:-----------:| -| SNMPEXTRAOPTIONS | Any extra option you may want to add to every command (a --verbose flag for example). Toutes les options sont listées [ici](#options-disponibles). | | | +| Macro | Description | Valeur par défaut | Obligatoire | +|:------------------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------|:------------------|:-----------:| +| SNMP_V3_USERNAME | SNMP v3 only: User name (`securityName`) | | | +| SNMP_V3_AUTH_PROTOCOL | SNMP v3 only: Authentication protocol: MD5\|SHA. Since net-snmp 5.9.1: SHA224\|SHA256\|SHA384\|SHA512 | | | +| SNMP_V3_PRIV_PROTOCOL | 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 | | | +| SNMP_V3_AUTH_PASSPHRASE | SNMP v3 only: Pass phrase hashed using the authentication protocol defined in the --authprotocol option | | | +| SNMP_V3_PRIV_PASSPHRASE | SNMP v3 only: Privacy pass phrase (`privPassword`) to encrypt messages using the protocol defined in the --privprotocol option | | | +| SNMPEXTRAOPTIONS | Any extra option you may want to add to every command (a --verbose flag for example). Toutes les options sont listées [ici](#options-disponibles). | | | 4. [Déployez la configuration](/docs/monitoring/monitoring-servers/deploying-a-configuration). L'hôte apparaît dans la liste des hôtes supervisés, et dans la page **Statut des ressources**. La commande envoyée par le connecteur est indiquée dans le panneau de détails de l'hôte : celle-ci montre les valeurs des macros. @@ -285,7 +290,7 @@ yum install centreon-plugin-Hardware-Storage-Qnap-Snmp | Macro | Description | Valeur par défaut | Obligatoire | |:-------------|:-------------------------------------------------------------------------------------------------------------------------------------------------|:------------------|:-----------:| | WARNING | Warning threshold average CPU utilization | 80 | | -| CRITICAL | Critical threshold average CPU utilization | 90 | | +| CRITICAL | Critical threshold average CPU utilization | 90 | | | EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). Toutes les options sont listées [ici](#options-disponibles). | | | @@ -305,7 +310,7 @@ yum install centreon-plugin-Hardware-Storage-Qnap-Snmp | Macro | Description | Valeur par défaut | Obligatoire | |:-------------|:-------------------------------------------------------------------------------------------------------------------------------------------------|:------------------|:-----------:| -| COMPONENT | Which component to check (default: '.*'). Can be: 'disk', 'fan', 'mdisk', 'psu', 'raid', 'temperature' | .* | | +| COMPONENT | Which component to check. Can be: 'disk', 'fan', 'mdisk', 'psu', 'raid', 'temperature' | .* | | | EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). Toutes les options sont listées [ici](#options-disponibles). | --verbose | | @@ -324,71 +329,71 @@ yum install centreon-plugin-Hardware-Storage-Qnap-Snmp -| Macro | Description | Valeur par défaut | Obligatoire | -|:-----------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------|:----------------------------------|:-----------:| -| FILTERNAME | Filter pools by name (can be a regexp) | | | -| WARNINGPOOLSTATUS | Define the conditions to match for the status to be WARNING. You can use the following variables: %\{status\}, %\{name\} | %\{status\} =~ /degraded\|warning/i | | -| CRITICALPOOLSTATUS | Define the conditions to match for the status to be CRITICAL. You can use the following variables: %\{status\}, %\{name\} | %\{status\} =~ /error\|critical/i | | -| WARNINGSPACEUSAGE | Threshold | | | -| CRITICALSPACEUSAGE | Threshold | | | -| WARNINGSPACEUSAGEFREE | Threshold | | | -| CRITICALSPACEUSAGEFREE | Threshold | | | -| WARNINGSPACEUSAGEPRCT | Threshold | | | -| CRITICALSPACEUSAGEPRCT | Threshold | | | -| EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). Toutes les options sont listées [ici](#options-disponibles). | --verbose | | +| Macro | Description | Valeur par défaut | Obligatoire | +|:-----------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------|:------------------------------------|:-----------:| +| FILTERNAME | Filter pools by name (can be a regexp) | | | +| WARNINGPOOLSTATUS | Define the conditions to match for the status to be WARNING. You can use the following variables: %\{status\}, %\{name\} | %\{status\} =~ /degraded\|warning/i | | +| CRITICALPOOLSTATUS | Define the conditions to match for the status to be CRITICAL. You can use the following variables: %\{status\}, %\{name\} | %\{status\} =~ /error\|critical/i | | +| WARNINGSPACEUSAGE | Threshold | | | +| CRITICALSPACEUSAGE | Threshold | | | +| WARNINGSPACEUSAGEFREE | Threshold | | | +| CRITICALSPACEUSAGEFREE | Threshold | | | +| WARNINGSPACEUSAGEPRCT | Threshold | | | +| CRITICALSPACEUSAGEPRCT | Threshold | | | +| EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). Toutes les options sont listées [ici](#options-disponibles). | --verbose | | -| Macro | Description | Valeur par défaut | Obligatoire | -|:-------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------|:------------------|:-----------:| -| INTERFACEID | Define the interface filter on IDs (OID indexes, e.g.: 1,2,...). If empty, all interfaces will be monitored. To filter on interface names, see --name | | | -| CRITICALIN | Threshold | 90 | | -| WARNINGIN | Threshold | 80 | | -| CRITICALOUT | Threshold | 90 | | -| WARNINGOUT | Threshold | 80 | | -| EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). Toutes les options sont listées [ici](#options-disponibles). | | | +| Macro | Description | Valeur par défaut | Obligatoire | +|:-------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------|:------------------|:-----------:| +| INTERFACEID | Check only the interfaces with the specified IDs (OID indexes, e.g.: 1,2,...). If empty, all interfaces will be monitored. To filter on interface names, see --name | | | +| CRITICALIN | Thresholds | 90 | | +| WARNINGIN | Thresholds | 80 | | +| CRITICALOUT | Thresholds | 90 | | +| WARNINGOUT | Thresholds | 80 | | +| EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). Toutes les options sont listées [ici](#options-disponibles). | | | -| Macro | Description | Valeur par défaut | Obligatoire | -|:--------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------|:------------------|:-----------:| -| INTERFACENAME | Define the interface filter on IDs (OID indexes, e.g.: 1,2,...). If empty, all interfaces will be monitored. To filter on interface names, see --name | | | -| CRITICALIN | Threshold | 90 | | -| WARNINGIN | Threshold | 80 | | -| CRITICALOUT | Threshold | 90 | | -| WARNINGOUT | Threshold | 80 | | -| EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). Toutes les options sont listées [ici](#options-disponibles). | | | +| Macro | Description | Valeur par défaut | Obligatoire | +|:--------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------|:------------------|:-----------:| +| INTERFACENAME | Check only the interfaces with the specified IDs (OID indexes, e.g.: 1,2,...). If empty, all interfaces will be monitored. To filter on interface names, see --name | | | +| CRITICALIN | Thresholds | 90 | | +| WARNINGIN | Thresholds | 80 | | +| CRITICALOUT | Thresholds | 90 | | +| WARNINGOUT | Thresholds | 80 | | +| EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). Toutes les options sont listées [ici](#options-disponibles). | | | -| Macro | Description | Valeur par défaut | Obligatoire | -|:---------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:------------------|:-----------:| -| FILTER | Define the interface filter on IDs (OID indexes, e.g.: 1,2,...). If empty, all interfaces will be monitored. To filter on interface names, see --name | .* | | -| CRITICALIN | Threshold | 90 | | -| WARNINGIN | Threshold | 80 | | -| CRITICALOUT | Threshold | 90 | | -| WARNINGOUT | Threshold | 80 | | -| CRITICALSTATUS | Define the conditions to match for the status to be CRITICAL (default: '%\{admstatus\} eq "up" and %\{opstatus\} ne "up"'). You can use the following variables: %\{admstatus\}, %\{opstatus\}, %\{duplexstatus\}, %\{display\} | | | -| EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). Toutes les options sont listées [ici](#options-disponibles). | --verbose | | +| Macro | Description | Valeur par défaut | Obligatoire | +|:---------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------|:-------------------------------------------------|:-----------:| +| FILTER | Check only the interfaces with the specified IDs (OID indexes, e.g.: 1,2,...). If empty, all interfaces will be monitored. To filter on interface names, see --name | .* | | +| CRITICALIN | Thresholds | 90 | | +| WARNINGIN | Thresholds | 80 | | +| CRITICALOUT | Thresholds | 90 | | +| WARNINGOUT | Thresholds | 80 | | +| CRITICALSTATUS | Define the conditions to match for the status to be CRITICAL. You can use the following variables: %\{admstatus\}, %\{opstatus\}, %\{duplexstatus\}, %\{display\} | %\{admstatus\} eq "up" and %\{opstatus\} ne "up" | | +| EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). Toutes les options sont listées [ici](#options-disponibles). | --verbose | | -| Macro | Description | Valeur par défaut | Obligatoire | -|:-----------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------|:----------------------------------|:-----------:| -| FILTERNAME | Filter volumes by name (can be a regexp) | | | -| WARNINGSPACEUSAGE | Threshold | | | -| CRITICALSPACEUSAGE | Threshold | | | -| WARNINGSPACEUSAGEFREE | Threshold | | | -| CRITICALSPACEUSAGEFREE | Threshold | | | -| WARNINGSPACEUSAGEPRCT | Threshold | | | -| CRITICALSPACEUSAGEPRCT | Threshold | | | -| WARNINGVOLUMESTATUS | Define the conditions to match for the status to be WARNING. You can use the following variables: %\{status\}, %\{name\} | %\{status\} =~ /degraded\|warning/i | | -| CRITICALVOLUMESTATUS | Define the conditions to match for the status to be CRITICAL. You can use the following variables: %\{status\}, %\{name\} | %\{status\} =~ /critical/i | | -| EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). Toutes les options sont listées [ici](#options-disponibles). | --verbose | | +| Macro | Description | Valeur par défaut | Obligatoire | +|:-----------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------|:------------------------------------|:-----------:| +| FILTERNAME | Filter volumes by name (can be a regexp) | | | +| WARNINGSPACEUSAGE | Threshold | | | +| CRITICALSPACEUSAGE | Threshold | | | +| WARNINGSPACEUSAGEFREE | Threshold | | | +| CRITICALSPACEUSAGEFREE | Threshold | | | +| WARNINGSPACEUSAGEPRCT | Threshold | | | +| CRITICALSPACEUSAGEPRCT | Threshold | | | +| WARNINGVOLUMESTATUS | Define the conditions to match for the status to be WARNING. You can use the following variables: %\{status\}, %\{name\} | %\{status\} =~ /degraded\|warning/i | | +| CRITICALVOLUMESTATUS | Define the conditions to match for the status to be CRITICAL. You can use the following variables: %\{status\}, %\{name\} | %\{status\} =~ /critical/i | | +| EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). Toutes les options sont listées [ici](#options-disponibles). | --verbose | | @@ -409,12 +414,17 @@ telle que celle-ci (remplacez les valeurs d'exemple par les vôtres) : --mode=interfaces \ --hostname=10.0.0.1 \ --snmp-version='2c' \ - --snmp-community='my-snmp-community' \ + --snmp-community='my-snmp-community' \ + --snmp-username='username' \ + --authpassphrase='' \ + --authprotocol='' \ + --privpassphrase='' \ + --privprotocol='' \ --interface='.*' \ --name \ --add-status \ --add-traffic \ - --critical-status='' \ + --critical-status='%\{admstatus\} eq "up" and %\{opstatus\} ne "up"' \ --warning-in-traffic='80' \ --critical-in-traffic='90' \ --warning-out-traffic='80' \ @@ -456,16 +466,16 @@ Le plugin apporte les modes suivants : | cpu [[code](https://github.com/centreon/centreon-plugins/blob/develop/src/snmp_standard/mode/cpu.pm)] | HW-Storage-Qnap-Cpu-SNMP-custom | | hardware [[code](https://github.com/centreon/centreon-plugins/blob/develop/src/storage/qnap/snmp/mode/hardware.pm)] | HW-Storage-Qnap-Hardware-Global-SNMP-custom | | interfaces [[code](https://github.com/centreon/centreon-plugins/blob/develop/src/snmp_standard/mode/interfaces.pm)] | HW-Storage-Qnap-Traffic-Generic-Id-SNMP-custom
HW-Storage-Qnap-Traffic-Generic-Name-SNMP-custom
HW-Storage-Qnap-Traffic-Global-SNMP-custom | -| list-interfaces [[code](https://github.com/centreon/centreon-plugins/blob/develop/src/snmp_standard/mode/listinterfaces.pm)] | Used for service discovery | -| list-processes [[code](https://github.com/centreon/centreon-plugins/blob/develop/src/snmp_standard/mode/listprocesses.pm)] | Not used in this Monitoring Connector | -| list-storages [[code](https://github.com/centreon/centreon-plugins/blob/develop/src/snmp_standard/mode/liststorages.pm)] | Used for service discovery | +| list-interfaces [[code](https://github.com/centreon/centreon-plugins/blob/develop/src/snmp_standard/mode/listinterfaces.pm)] | Utilisé pour la découverte de services | +| list-processes [[code](https://github.com/centreon/centreon-plugins/blob/develop/src/snmp_standard/mode/listprocesses.pm)] | Non utilisé dans ce connecteur de supervision | +| list-storages [[code](https://github.com/centreon/centreon-plugins/blob/develop/src/snmp_standard/mode/liststorages.pm)] | Utilisé pour la découverte de services | | memory [[code](https://github.com/centreon/centreon-plugins/blob/develop/src/storage/qnap/snmp/mode/memory.pm)] | HW-Storage-Qnap-Memory-SNMP-custom | | pools [[code](https://github.com/centreon/centreon-plugins/blob/develop/src/storage/qnap/snmp/mode/pools.pm)] | HW-Storage-Qnap-Pools-SNMP-custom | -| processcount [[code](https://github.com/centreon/centreon-plugins/blob/develop/src/snmp_standard/mode/processcount.pm)] | Not used in this Monitoring Connector | +| processcount [[code](https://github.com/centreon/centreon-plugins/blob/develop/src/snmp_standard/mode/processcount.pm)] | Non utilisé dans ce connecteur de supervision | | storage [[code](https://github.com/centreon/centreon-plugins/blob/develop/src/snmp_standard/mode/storage.pm)] | HW-Storage-Qnap-Disk-Global-SNMP-custom | -| time [[code](https://github.com/centreon/centreon-plugins/blob/develop/src/snmp_standard/mode/ntp.pm)] | Not used in this Monitoring Connector | -| upgrade [[code](https://github.com/centreon/centreon-plugins/blob/develop/src/storage/qnap/snmp/mode/upgrade.pm)] | Not used in this Monitoring Connector | -| uptime [[code](https://github.com/centreon/centreon-plugins/blob/develop/src/snmp_standard/mode/uptime.pm)] | Not used in this Monitoring Connector | +| time [[code](https://github.com/centreon/centreon-plugins/blob/develop/src/snmp_standard/mode/ntp.pm)] | Non utilisé dans ce connecteur de supervision | +| upgrade [[code](https://github.com/centreon/centreon-plugins/blob/develop/src/storage/qnap/snmp/mode/upgrade.pm)] | Non utilisé dans ce connecteur de supervision | +| uptime [[code](https://github.com/centreon/centreon-plugins/blob/develop/src/snmp_standard/mode/uptime.pm)] | Non utilisé dans ce connecteur de supervision | | volumes [[code](https://github.com/centreon/centreon-plugins/blob/develop/src/storage/qnap/snmp/mode/volumes.pm)] | HW-Storage-Qnap-Volumes-SNMP-custom | ### Options disponibles @@ -474,65 +484,67 @@ Le plugin apporte les modes suivants : Les options génériques sont listées ci-dessous : -| 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 ok, 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\[,\[newuom\],\[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\[,\[newuom\],\[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\[,\[newuom\],\[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,namesofnewmetrics,calculation\[,\[newuom\],\[min\],\[max\]\] regex: regular expression namesofnewmetrics: 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 newuom (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~replacement~modifier Most commonly used modifiers are i (case insensitive) and g (replace all occurrences). Example: adding --change-short-output='OK\~Up\~gi' will replace all occurrences of 'OK', 'ok', 'Ok' or 'oK' with 'Up' | -| --change-short-output | Modify the short/long output that is returned by the plugin. Syntax: --change-short-output=pattern~replacement~modifier Most commonly used modifiers are i (case insensitive) and g (replace all occurrences). Example: adding --change-short-output='OK\~Up\~gi' will replace all occurrences of 'OK', 'ok', 'Ok' or 'oK' with 'Up' | -| --change-long-output | Modify the short/long output that is returned by the plugin. Syntax: --change-short-output=pattern~replacement~modifier Most commonly used modifiers are i (case insensitive) and g (replace all occurrences). Example: adding --change-short-output='OK\~Up\~gi' will replace all occurrences of 'OK', 'ok', 'Ok' or 'oK' with 'Up' | -| --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. | -| --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). E.g.: --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\. =cut | +| 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 get-next 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 ok, 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. | +| --show-password | By default, sensitive information in command lines is hidden in debug output and replaced with `***` (however, debug logs may still display sensitive information). Using the C option will display the passwords in plain text. | +| --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\[,\[\\],\[min\],\[max\]\] Common examples: onvert 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\[,\[\\],\[min\],\[max\]\] Common examples: onvert 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\[,\[\\],\[min\],\[max\]\] Common examples: onvert 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,\,calculation\[,\[\\],\[min\],\[max\]\] regex: regular expression \: 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 \ (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: um 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~replacement~modifier Most commonly used modifiers are i (case insensitive) and g (replace all occurrences). Example: adding --change-short-output='OK~Up~gi' will replace all occurrences of 'OK', 'ok', 'Ok' or 'oK' with 'Up' | +| --change-short-output | Modify the short/long output that is returned by the plugin. Syntax: --change-short-output=pattern~replacement~modifier Most commonly used modifiers are i (case insensitive) and g (replace all occurrences). Example: adding --change-short-output='OK~Up~gi' will replace all occurrences of 'OK', 'ok', 'Ok' or 'oK' with 'Up' | +| --change-long-output | Modify the short/long output that is returned by the plugin. Syntax: --change-short-output=pattern~replacement~modifier Most commonly used modifiers are i (case insensitive) and g (replace all occurrences). Example: adding --change-short-output='OK~Up~gi' will replace all occurrences of 'OK', 'ok', 'Ok' or 'oK' with 'Up' | +| --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'. \. | #### Options des modes @@ -541,152 +553,200 @@ Les options disponibles pour chaque modèle de services sont listées ci-dessous -| Option | Description | -|:-------------------|:------------------------------------------------------------------------------------------------------------------------------| -| --filter-counters | Only display some counters (regexp can be used). Example to check SSL connections only : --filter-counters='^xxxx\|yyyy$' | -| --use-ucd | Use UCD mib for CPU average. | -| --warning-average | Warning threshold average CPU utilization. | -| --critical-average | Critical threshold average CPU utilization. | -| --warning-core | Warning thresholds for each CPU core | -| --critical-core | Critical thresholds for each CPU core | +| Option | Description | +|:-------------------|:--------------------------------------------------------------------------------------------------------------------------| +| --filter-counters | Only display some counters (regexp can be used). Example to check SSL connections only : --filter-counters='^xxxx\|yyyy$' | +| --warning-xxx | Warning threshold. | +| --critical-xxx | Critical threshold. | +| --use-ucd | Use UCD MIB for CPU average. | +| --warning-average | Warning threshold average CPU utilization. | +| --critical-average | Critical threshold average CPU utilization. | +| --warning-core | Warning thresholds for each CPU core | +| --critical-core | Critical thresholds for each CPU core | -| Option | Description | -|:------------------------------------------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| --filter-counters | Only display some counters (regexp can be used). Example to check SSL connections only : --filter-counters='^xxxx\|yyyy$' | -| --memcached | Memcached server to use (only one server). | -| --redis-server | Redis server to use (only one server). Syntax: address\[:port\] | -| --redis-attribute | Set Redis Options (--redis-attribute="cnx\_timeout=5"). | -| --redis-db | Set Redis database index. | -| --failback-file | Fall back on a local file if Redis connection fails. | -| --memexpiration | Time to keep data in seconds (default: 86400). | -| --statefile-dir | Define the cache directory (default: '/var/lib/centreon/centplugins'). | -| --statefile-suffix | Define a suffix to customize the statefile name (default: ''). | -| --statefile-concat-cwd | If used with the '--statefile-dir' option, the latter's value will be used as a sub-directory of the current working directory. Useful on Windows when the plugin is compiled, as the file system and permissions are different from Linux. | -| --statefile-format | Define the format used to store the cache. Available formats: 'dumper', 'storable', 'json' (default). | -| --statefile-key | Define the key to encrypt/decrypt the cache. | -| --statefile-cipher | Define the cipher algorithm to encrypt the cache (default: 'AES'). | -| --warning-usage | Warning threshold. | -| --critical-usage | Critical threshold. | -| --warning-access | Warning threshold. | -| --critical-access | Critical threshold. Check if storage is readOnly: --critical-access=readOnly | -| --add-access | Check storage access (readOnly, readWrite). | -| --units | Units of thresholds (default: '%') ('%', 'B'). | -| --free | Thresholds are on free space left. | -| --storage | Set the storage (number expected) example: 1, 2,... (empty means 'check all storage'). | -| --name | Allows to use storage name with option --storage instead of storage oid index. | -| --regexp | Allows to use regexp to filter storage (with option --name). | -| --regexp-insensitive | Allows to use regexp non case-sensitive (with --regexp). | -| --path-best-match | Allows to select best path mount point (with --name). | -| --reload-cache-time | Time in minutes before reloading cache file (default: 180). | -| --oid-filter | Choose OID used to filter storage (default: hrStorageDescr) (values: hrStorageDescr, hrFSMountPoint). | -| --oid-display | Choose OID used to display storage (default: hrStorageDescr) (values: hrStorageDescr, hrFSMountPoint). | -| --display-transform-src --display-transform-dst | Modify the storage name displayed by using a regular expression. Example: adding --display-transform-src='dev' --display-transform-dst='run' will replace all occurrences of 'dev' with 'run' | -| --show-cache | Display cache storage data. | -| --space-reservation | Some filesystem has space reserved (like ext4 for root). The value is in percent of total (default: none) (results like 'df' command). | -| --filter-duplicate | Filter duplicate storages (in used size and total size). | -| --filter-storage-type | Filter storage types with a regexp (default: '^(hrStorageFixedDisk\|hrStorageNetworkDisk\|hrFSBerkeleyFFS)$'). | +| Option | Description | +|:------------------------------------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| --filter-counters | Only display some counters (regexp can be used). Example to check SSL connections only : --filter-counters='^xxxx\|yyyy$' | +| --warning-xxx | Warning threshold. | +| --critical-xxx | Critical threshold. | +| --memcached | Memcached server to use (only one server). | +| --redis-server | Redis server to use (only one server). Syntax: address\[:port\] | +| --redis-attribute | Set Redis Options (--redis-attribute="cnx\_timeout=5"). | +| --redis-db | Set Redis database index. | +| --failback-file | Fall back on a local file if Redis connection fails. | +| --memexpiration | Time to keep data in seconds (default: 86400). | +| --statefile-dir | Define the cache directory (default: '/var/lib/centreon/centplugins'). | +| --statefile-suffix | Define a suffix to customize the statefile name (default: ''). | +| --statefile-concat-cwd | If used with the '--statefile-dir' option, the latter's value will be used as a sub-directory of the current working directory. Useful on Windows when the plugin is compiled, as the file system and permissions are different from Linux. | +| --statefile-format | Define the format used to store the cache. Available formats: 'dumper', 'storable', 'json' (default). | +| --statefile-key | Define the key to encrypt/decrypt the cache. | +| --statefile-cipher | Define the cipher algorithm to encrypt the cache (default: 'AES'). | +| --warning-usage | Warning threshold. | +| --critical-usage | Critical threshold. | +| --warning-access | Warning threshold. | +| --critical-access | Critical threshold. Check if storage is readOnly: --critical-access=readOnly | +| --add-access | Check storage access (readOnly, readWrite). | +| --units | Units of thresholds (default: '%') ('%', 'B'). | +| --free | Thresholds are on free space left. | +| --storage | Set the storage (number expected) example: 1, 2,... (empty means 'check all storage'). | +| --name | Allows to use storage name with option --storage instead of storage oid index. | +| --regexp | Allows to use regexp to filter storage (with option --name). | +| --regexp-insensitive | Allows to use regexp non case-sensitive (with --regexp). | +| --path-best-match | Allows to select best path mount point (with --name). | +| --reload-cache-time | Time in minutes before reloading cache file (default: 180). | +| --oid-filter | Choose OID used to filter storage (default: hrStorageDescr) (values: hrStorageDescr, hrFSMountPoint). | +| --oid-display | Choose OID used to display storage (default: hrStorageDescr) (values: hrStorageDescr, hrFSMountPoint). | +| --display-transform-src --display-transform-dst | Modify the storage name displayed by using a regular expression. Example: adding --display-transform-src='dev' --display-transform-dst='run' will replace all occurrences of 'dev' with 'run' | +| --show-cache | Display cache storage data. | +| --space-reservation | Some filesystem has space reserved (like ext4 for root). The value is in percent of total (default: none) (results like 'df' command). | +| --filter-duplicate | Filter duplicate storages (in used size and total size). | +| --filter-storage-type | Filter storage types with a regexp (default: '^(hrStorageFixedDisk\|hrStorageNetworkDisk\|hrFSBerkeleyFFS)$'). | -| Option | Description | -|:---------------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| --component | Which component to check (default: '.*'). Can be: 'disk', 'fan', 'mdisk', 'psu', 'raid', 'temperature'. | -| --filter | Exclude the items given as a comma-separated list (example: --filter=disk). You can also exclude items from specific instances: --filter=disk,1 | -| --absent-problem | Return an error if an entity is not 'present' (default is skipping) (comma separated list) Can be specific or global: --absent-problem=disk | -| --no-component | Define the expected status if no components are found (default: critical). | -| --threshold-overload | Use this option to override the status returned by the plugin when the status label matches a regular expression (syntax: section,status,regexp). Example: --threshold-overload='disk,CRITICAL,^(?!(ready)$)' | -| --warning | Set warning threshold for temperatures (syntax: type,regexp,threshold) Example: --warning='temperature,cpu,30' --warning='fan,.*,1500' | -| --critical | Set critical threshold for temperatures (syntax: type,regexp,threshold) Example: --critical='temperature,system,40' --critical='disk,.*,40' | -| --warning-count-* | Define the warning threshold for the number of components of one type (replace '*' with the component type). | -| --critical-count-* | Define the critical threshold for the number of components of one type (replace '*' with the component type). | +| Option | Description | +|:---------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| --component | Which component to check (default: '.*'). Can be: 'disk', 'fan', 'mdisk', 'psu', 'raid', 'temperature'. | +| --filter | Exclude the items given as a comma-separated list (example: --filter=disk). You can also exclude items from specific instances: --filter=disk,1 | +| --absent-problem | Return an error if an entity is not 'present' (default is skipping) (comma separated list) Can be specific or global: --absent-problem=disk | +| --no-component | Define the expected status if no components are found (default: critical). | +| --threshold-overload | Use this option to override the status returned by the plugin when the status label matches a regular expression (syntax: section,status,regexp). Example: --threshold-overload='disk,CRITICAL,^(?!(ready)$)' | +| --warning | Set warning threshold for temperatures (syntax: type,regexp,threshold) Example: --warning='temperature,cpu,30' --warning='fan,.*,1500' | +| --critical | Set critical threshold for temperatures (syntax: type,regexp,threshold) Example: --critical='temperature,system,40' --critical='disk,.*,40' | +| --warning-count-* | Define the warning threshold for the number of components of one type (replace '*' with the component type). | +| --critical-count-* | Define the critical threshold for the number of components of one type (replace '*' with the component type). | -| Option | Description | -|:-------------------------|:------------------------------------------------------------------------------------------------------------------------------| -| --filter-counters | Only display some counters (regexp can be used). Example to check SSL connections only : --filter-counters='^xxxx\|yyyy$' | -| --force-counters-legacy | Force to use legacy counters. Should be used when EX/ES/QTS counters are buggy. | -| --warning-* --critical-* | Thresholds. Can be: 'memory-usage' (B), 'memory-usage-free' (B), 'memory-usage-prct' (%). | +| Option | Description | +|:-------------------------|:--------------------------------------------------------------------------------------------------------------------------| +| --filter-counters | Only display some counters (regexp can be used). Example to check SSL connections only : --filter-counters='^xxxx\|yyyy$' | +| --warning-xxx | Warning threshold. | +| --critical-xxx | Critical threshold. | +| --force-counters-legacy | Force to use legacy counters. Should be used when EX/ES/QTS counters are buggy. | +| --warning-* --critical-* | Thresholds. Can be: 'memory-usage' (B), 'memory-usage-free' (B), 'memory-usage-prct' (%). | -| Option | Description | -|:-------------------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| --filter-counters | Only display some counters (regexp can be used). Example to check SSL connections only : --filter-counters='^xxxx\|yyyy$' | -| --filter-name | Filter pools by name (can be a regexp). | -| --unknown-pool-status | Define the conditions to match for the status to be UNKNOWN. You can use the following variables: %\{status\}, %\{name\} | -| --warning-pool-status | Define the conditions to match for the status to be WARNING (default: '%\{status\} =~ /degraded\|warning/i'). You can use the following variables: %\{status\}, %\{name\} | -| --critical-pool-status | Define the conditions to match for the status to be CRITICAL (default: '%\{status\} =~ /error\|critical/i'). You can use the following variables: %\{status\}, %\{name\} | -| --warning-* --critical-* | Thresholds. Can be: 'space-usage-prct', 'space-usage', 'space-usage-free'. | +| Option | Description | +|:-------------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| --filter-counters | Only display some counters (regexp can be used). Example to check SSL connections only : --filter-counters='^xxxx\|yyyy$' | +| --warning-xxx | Warning threshold. | +| --critical-xxx | Critical threshold. | +| --filter-name | Filter pools by name (can be a regexp). | +| --unknown-pool-status | Define the conditions to match for the status to be UNKNOWN. You can use the following variables: %\{status\}, %\{name\} | +| --warning-pool-status | Define the conditions to match for the status to be WARNING (default: '%\{status\} =~ /degraded\|warning/i'). You can use the following variables: %\{status\}, %\{name\} | +| --critical-pool-status | Define the conditions to match for the status to be CRITICAL (default: '%\{status\} =~ /error\|critical/i'). You can use the following variables: %\{status\}, %\{name\} | +| --warning-* --critical-* | Thresholds. Can be: 'space-usage-prct', 'space-usage', 'space-usage-free'. | -| Option | Description | -|:------------------------------------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| --filter-counters | Only display some counters (regexp can be used). Example to check SSL connections only : --filter-counters='^xxxx\|yyyy$' | -| --memcached | Memcached server to use (only one server). | -| --redis-server | Redis server to use (only one server). Syntax: address\[:port\] | -| --redis-attribute | Set Redis Options (--redis-attribute="cnx\_timeout=5"). | -| --redis-db | Set Redis database index. | -| --failback-file | Fall back on a local file if Redis connection fails. | -| --memexpiration | Time to keep data in seconds (default: 86400). | -| --statefile-dir | Define the cache directory (default: '/var/lib/centreon/centplugins'). | -| --statefile-suffix | Define a suffix to customize the statefile name (default: ''). | -| --statefile-concat-cwd | If used with the '--statefile-dir' option, the latter's value will be used as a sub-directory of the current working directory. Useful on Windows when the plugin is compiled, as the file system and permissions are different from Linux. | -| --statefile-format | Define the format used to store the cache. Available formats: 'dumper', 'storable', 'json' (default). | -| --statefile-key | Define the key to encrypt/decrypt the cache. | -| --statefile-cipher | Define the cipher algorithm to encrypt the cache (default: 'AES'). | -| --add-global | Check global port statistics (by default if no --add-* option is set). | -| --add-status | Check interface status. | -| --add-duplex-status | Check duplex status (with --warning-status and --critical-status). | -| --add-traffic | Check interface traffic. | -| --add-errors | Check interface errors. | -| --add-cast | Check interface cast. | -| --add-speed | Check interface speed. | -| --add-volume | Check interface data volume between two checks (not supposed to be graphed, useful for BI reporting). | -| --check-metrics | If the expression is true, metrics are checked (default: '%\{opstatus\} eq "up"'). | -| --warning-status | Define the conditions to match for the status to be WARNING. You can use the following variables: %\{admstatus\}, %\{opstatus\}, %\{duplexstatus\}, %\{display\} | -| --critical-status | Define the conditions to match for the status to be CRITICAL (default: '%\{admstatus\} eq "up" and %\{opstatus\} ne "up"'). You can use the following variables: %\{admstatus\}, %\{opstatus\}, %\{duplexstatus\}, %\{display\} | -| --warning-* --critical-* | Thresholds. Can be: 'total-port', 'total-admin-up', 'total-admin-down', 'total-oper-up', 'total-oper-down', 'in-traffic', 'out-traffic', 'in-error', 'in-discard', 'out-error', 'out-discard', 'in-ucast', 'in-bcast', 'in-mcast', 'out-ucast', 'out-bcast', 'out-mcast', 'speed' (b/s). | -| --units-traffic | Units of thresholds for the traffic (default: 'percent\_delta') ('percent\_delta', 'bps', 'counter'). | -| --units-errors | Units of thresholds for errors/discards (default: 'percent\_delta') ('percent\_delta', 'percent', 'delta', 'deltaps', 'counter'). | -| --units-cast | Units of thresholds for communication types (default: 'percent\_delta') ('percent\_delta', 'percent', 'delta', 'deltaps', 'counter'). | -| --nagvis-perfdata | Display traffic perfdata to be compatible with NagVis widget. | -| --interface | Define the interface filter on IDs (OID indexes, e.g.: 1,2,...). If empty, all interfaces will be monitored. To filter on interface names, see --name. | -| --name | With this option, the interfaces will be filtered by name (given in option --interface) instead of OID index. The name matching mode supports regular expressions. | -| --regex-id | With this option, interface IDs will be filtered using the --interface parameter as a regular expression instead of a list of IDs. | -| --speed | Set interface speed for incoming/outgoing traffic (in Mb). | -| --speed-in | Set interface speed for incoming traffic (in Mb). | -| --speed-out | Set interface speed for outgoing traffic (in Mb). | -| --map-speed-dsl | Get interface speed configuration for interfaces of type 'ADSL' and 'VDSL2'. Syntax: --map-speed-dsl=interface-src-name,interface-dsl-name E.g: --map-speed-dsl=Et0.835,Et0-vdsl2 | -| --force-counters64 | Force to use 64 bits counters only. Can be used to improve performance. | -| --force-counters32 | Force to use 32-bits counters (even with SNMP versions 2c and 3). To use when 64 bits counters are buggy. | -| --reload-cache-time | Time in minutes before reloading cache file (default: 180). | -| --oid-filter | Define the OID to be used to filter interfaces (default: ifName) (values: ifDesc, ifAlias, ifName, IpAddr). | -| --oid-display | Define the OID that will be used to name the interfaces (default: ifName) (values: ifDesc, ifAlias, ifName, IpAddr). | -| --oid-extra-display | Add an OID to display. | -| --display-transform-src --display-transform-dst | Modify the interface name displayed by using a regular expression. Example: adding --display-transform-src='eth' --display-transform-dst='ens' will replace all occurrences of 'eth' with 'ens' | -| --show-cache | Display cache interface data. | +| Option | Description | +|:------------------------------------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| --filter-counters | Only display some counters (regexp can be used). Example to check SSL connections only : --filter-counters='^xxxx\|yyyy$' | +| --warning-xxx | Warning threshold. | +| --critical-xxx | Critical threshold. | +| --memcached | Memcached server to use (only one server). | +| --redis-server | Redis server to use (only one server). Syntax: address\[:port\] | +| --redis-attribute | Set Redis Options (--redis-attribute="cnx\_timeout=5"). | +| --redis-db | Set Redis database index. | +| --failback-file | Fall back on a local file if Redis connection fails. | +| --memexpiration | Time to keep data in seconds (default: 86400). | +| --statefile-dir | Define the cache directory (default: '/var/lib/centreon/centplugins'). | +| --statefile-suffix | Define a suffix to customize the statefile name (default: ''). | +| --statefile-concat-cwd | If used with the '--statefile-dir' option, the latter's value will be used as a sub-directory of the current working directory. Useful on Windows when the plugin is compiled, as the file system and permissions are different from Linux. | +| --statefile-format | Define the format used to store the cache. Available formats: 'dumper', 'storable', 'json' (default). | +| --statefile-key | Define the key to encrypt/decrypt the cache. | +| --statefile-cipher | Define the cipher algorithm to encrypt the cache (default: 'AES'). | +| --add-global | Check global port statistics (by default if no --add-* option is set). | +| --add-status | Check interface status. | +| --add-duplex-status | Check duplex status (with --warning-status and --critical-status). | +| --add-traffic | Check interface traffic. | +| --add-errors | Check interface errors. | +| --add-cast | Check interface cast. | +| --add-speed | Check interface speed. | +| --add-volume | Check interface data volume between two checks (not supposed to be graphed, useful for BI reporting). | +| --check-metrics | If the expression is true, metrics are checked (default: '%\{opstatus\} eq "up"'). | +| --warning-status | Define the conditions to match for the status to be WARNING. You can use the following variables: %\{admstatus\}, %\{opstatus\}, %\{duplexstatus\}, %\{display\} | +| --critical-status | Define the conditions to match for the status to be CRITICAL (default: '%\{admstatus\} eq "up" and %\{opstatus\} ne "up"'). You can use the following variables: %\{admstatus\}, %\{opstatus\}, %\{duplexstatus\}, %\{display\} | +| --warning-total-port | Thresholds. | +| --critical-total-port | Thresholds. | +| --warning-total-admin-up | Thresholds. | +| --critical-total-admin-up | Thresholds. | +| --warning-total-admin-down | Thresholds. | +| --critical-total-admin-down | Thresholds. | +| --warning-total-oper-up | Thresholds. | +| --critical-total-oper-up | Thresholds. | +| --warning-total-oper-down | Thresholds. | +| --critical-total-oper-down | Thresholds. | +| --warning-in-traffic | Thresholds. | +| --critical-in-traffic | Thresholds. | +| --warning-out-traffic | Thresholds. | +| --critical-out-traffic | Thresholds. | +| --warning-in-error | Thresholds. | +| --critical-in-error | Thresholds. | +| --warning-in-discard | Thresholds. | +| --critical-in-discard | Thresholds. | +| --warning-out-error | Thresholds. | +| --critical-out-error | Thresholds. | +| --warning-out-discard | Thresholds. | +| --critical-out-discard | Thresholds. | +| --warning-in-ucast | Thresholds. | +| --critical-in-ucast | Thresholds. | +| --warning-in-bcast | Thresholds. | +| --critical-in-bcast | Thresholds. | +| --warning-in-mcast | Thresholds. | +| --critical-in-mcast | Thresholds. | +| --warning-out-ucast | Thresholds. | +| --critical-out-ucast | Thresholds. | +| --warning-out-bcast | Thresholds. | +| --critical-out-bcast | Thresholds. | +| --warning-out-mcast | Thresholds. | +| --critical-out-mcast | Thresholds. | +| --warning-speed | Thresholds in b/s. | +| --critical-speed | Thresholds in b/s. | +| --units-traffic | Units of thresholds for the traffic (default: 'percent\_delta') ('percent\_delta', 'bps', 'counter'). | +| --units-errors | Units of thresholds for errors/discards (default: 'percent\_delta') ('percent\_delta', 'delta', 'deltaps', 'counter'). | +| --units-cast | Units of thresholds for communication types (default: 'percent\_delta') ('percent\_delta', 'percent', 'delta', 'deltaps', 'counter'). | +| --nagvis-perfdata | Display traffic perfdata to be compatible with NagVis widget. | +| --interface | Check only the interfaces with the specified IDs (OID indexes, e.g.: 1,2,...). If empty, all interfaces will be monitored. To filter on interface names, see --name. | +| --name | With this option, the interfaces will be filtered by name (given in option --interface) instead of OID index. The name matching mode supports regular expressions. | +| --regex-id | With this option, interface IDs will be filtered using the --interface parameter as a regular expression instead of a list of IDs. | +| --speed | Set interface speed for incoming/outgoing traffic (in Mb). | +| --speed-in | Set interface speed for incoming traffic (in Mb). | +| --speed-out | Set interface speed for outgoing traffic (in Mb). | +| --map-speed-dsl | Get interface speed configuration for interfaces of type 'ADSL' and 'VDSL2'. Syntax: --map-speed-dsl=interface-src-name,interface-dsl-name E.g: --map-speed-dsl=Et0.835,Et0-vdsl2 | +| --force-counters64 | Force to use 64 bits counters only. Can be used to improve performance. | +| --force-counters32 | Force to use 32-bit counters (even with SNMP versions 2c and 3). To use when 64 bits counters are buggy. | +| --reload-cache-time | Time in minutes before reloading cache file (default: 180). | +| --oid-filter | Define the OID to be used to filter interfaces (default: ifName) (values: ifDesc, ifAlias, ifName, IpAddr). | +| --oid-display | Define the OID that will be used to name the interfaces (default: ifName) (values: ifDesc, ifAlias, ifName, IpAddr). | +| --oid-extra-display | Add an OID to display. | +| --display-transform-src --display-transform-dst | Modify the interface name displayed by using a regular expression. Example: adding --display-transform-src='eth' --display-transform-dst='ens' will replace all occurrences of 'eth' with 'ens' | +| --show-cache | Display cache interface data. | +| --no-cache-lock | Set to disable locking when accessing cache. | -| Option | Description | -|:-------------------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| --filter-counters | Only display some counters (regexp can be used). Example to check SSL connections only : --filter-counters='^xxxx\|yyyy$' | -| --filter-name | Filter volumes by name (can be a regexp). | -| --force-counters-legacy | Force to use legacy counters. Should be used when EX/QTS counters are buggy. | -| --unknown-volume-status | Define the conditions to match for the status to be UNKNOWN. You can use the following variables: %\{status\}, %\{name\} | -| --warning-volume-status | Define the conditions to match for the status to be WARNING (default: '%\{status\} =~ /degraded\|warning/i'). You can use the following variables: %\{status\}, %\{name\} | -| --critical-volume-status | Define the conditions to match for the status to be CRITICAL (default: '%\{status\} =~ /critical/i'). You can use the following variables: %\{status\}, %\{name\} | -| --warning-* --critical-* | Thresholds. Can be: 'space-usage-prct', 'space-usage', 'space-usage-free'. | +| Option | Description | +|:-------------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| --filter-counters | Only display some counters (regexp can be used). Example to check SSL connections only : --filter-counters='^xxxx\|yyyy$' | +| --warning-xxx | Warning threshold. | +| --critical-xxx | Critical threshold. | +| --filter-name | Filter volumes by name (can be a regexp). | +| --force-counters-legacy | Force to use legacy counters. Should be used when EX/QTS counters are buggy. | +| --unknown-volume-status | Define the conditions to match for the status to be UNKNOWN. You can use the following variables: %\{status\}, %\{name\} | +| --warning-volume-status | Define the conditions to match for the status to be WARNING (default: '%\{status\} =~ /degraded\|warning/i'). You can use the following variables: %\{status\}, %\{name\} | +| --critical-volume-status | Define the conditions to match for the status to be CRITICAL (default: '%\{status\} =~ /critical/i'). You can use the following variables: %\{status\}, %\{name\} | +| --warning-* --critical-* | Thresholds. Can be: 'space-usage-prct', 'space-usage', 'space-usage-free'. | diff --git a/i18n/fr/docusaurus-plugin-content-docs-pp/current/integrations/plugin-packs/procedures/hardware-ups-apc-snmp.md b/i18n/fr/docusaurus-plugin-content-docs-pp/current/integrations/plugin-packs/procedures/hardware-ups-apc-snmp.md index e935e9ca45f2..485906914a7e 100644 --- a/i18n/fr/docusaurus-plugin-content-docs-pp/current/integrations/plugin-packs/procedures/hardware-ups-apc-snmp.md +++ b/i18n/fr/docusaurus-plugin-content-docs-pp/current/integrations/plugin-packs/procedures/hardware-ups-apc-snmp.md @@ -5,10 +5,6 @@ title: APC UPS SNMP import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; -## Compatibilité - -Ce connecteur est conçu pour superviser les onduleurs APC UPS, y compris les modèles de la série Galaxy VS. - ## Dépendances du connecteur de supervision Les connecteurs de supervision suivants sont automatiquement installés lors de l'installation du connecteur **APC UPS SNMP** @@ -19,7 +15,7 @@ depuis la page **Configuration > Connecteurs > Connecteurs de supervision** : ### Modèles -Le connecteur de supervision **APC UPS** apporte un modèle d'hôte : +Le connecteur de supervision **APC UPS SNMP** apporte un modèle d'hôte : * **HW-UPS-Apc-SNMP-custom** @@ -110,11 +106,10 @@ Voici le tableau des services pour ce connecteur, détaillant les métriques et -| Nom | Unité | -|:--------------------------------------|:------| -| sensor.universal.temperature.celsius | C | -| sensor.universal.humidity.percentage | % | -| sensor.integrated.humidity.percentage | % | +| Nom | Unité | +|:------------------------|:------| +| hardware. sensor .count | count | +| sensor status | N/A | @@ -122,14 +117,12 @@ Voici le tableau des services pour ce connecteur, détaillant les métriques et | Metric name | Unité | |:--------------------|:------| | time.offset.seconds | s | - | Metric name | Unité | |:----------------------|:------| | system.uptime.seconds | s | - @@ -190,7 +183,7 @@ yum install centreon-pack-hardware-ups-apc-snmp -2. Quel que soit le type de la licence (*online* ou *offline*), installez le connecteur **APC UPS** +2. Quel que soit le type de la licence (*online* ou *offline*), installez le connecteur **APC UPS SNMP** depuis l'interface web et le menu **Configuration > Connecteurs > Connecteurs de supervision**. ### Plugin @@ -243,12 +236,14 @@ yum install centreon-plugin-Hardware-Ups-Apc-Snmp 2. Complétez les champs **Nom**, **Alias** & **IP Address/DNS** correspondant à votre ressource. 3. Appliquez le modèle d'hôte **HW-UPS-Apc-SNMP-custom**. -> Si vous utilisez SNMP en version 3, vous devez configurer les paramètres spécifiques associés via la macro **SNMPEXTRAOPTIONS**. -> Plus d'informations dans la section [Troubleshooting SNMP](../getting-started/how-to-guides/troubleshooting-plugins.md#mapping-des-options-snmpv3). - -| Macro | Description | Valeur par défaut | Obligatoire | -|:-----------------|:---------------------------------------------------------------------------------------------------------------------------------------------------|:------------------|:-----------:| -| SNMPEXTRAOPTIONS | Any extra option you may want to add to every command (a --verbose flag for example). Toutes les options sont listées [ici](#options-disponibles). | | | +| Macro | Description | Valeur par défaut | Obligatoire | +|:------------------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------|:------------------|:-----------:| +| SNMP_V3_USERNAME | SNMP v3 only: User name (`securityName`) | | | +| SNMP_V3_AUTH_PROTOCOL | SNMP v3 only: Authentication protocol: MD5\|SHA. Since net-snmp 5.9.1: SHA224\|SHA256\|SHA384\|SHA512 | | | +| SNMP_V3_PRIV_PROTOCOL | 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 | | | +| SNMP_V3_AUTH_PASSPHRASE | SNMP v3 only: Pass phrase hashed using the authentication protocol defined in the --authprotocol option | | | +| SNMP_V3_PRIV_PASSPHRASE | SNMP v3 only: Privacy pass phrase (`privPassword`) to encrypt messages using the protocol defined in the --privprotocol option | | | +| SNMPEXTRAOPTIONS | Any extra option you may want to add to every command (a --verbose flag for example). Toutes les options sont listées [ici](#options-disponibles). | | | 4. [Déployez la configuration](/docs/monitoring/monitoring-servers/deploying-a-configuration). L'hôte apparaît dans la liste des hôtes supervisés, et dans la page **Statut des ressources**. La commande envoyée par le connecteur est indiquée dans le panneau de détails de l'hôte : celle-ci montre les valeurs des macros. @@ -263,13 +258,13 @@ yum install centreon-plugin-Hardware-Ups-Apc-Snmp | Macro | Description | Valeur par défaut | Obligatoire | |:----------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------|:-----------------------------|:-----------:| | UNKNOWNSTATUS | Define the conditions to match for the status to be UNKNOWN. You can use the following variables: %\{status\}, %\{replace\} | %\{status\} =~ /unknown/i | | -| REPLACELASTTIMEFORMAT | Define the date format (default: C\<%m/%d/%Y\>) | | | +| REPLACELASTTIMEFORMAT | Define the date format | `%m/%d/%Y` | | | WARNINGCURRENT | Warning threshold for battery current (in A) | | | | CRITICALCURRENT | Critical threshold for battery current (in A) | | | | WARNINGLOAD | Warning threshold for battery load (in %) | | | | CRITICALLOAD | Critical threshold for battery load (in %) | | | -| WARNINGSTATUS | Define the conditions to match for the status to be WARNING. You can use the following variables: C\<%\{status\}\>, C\<%\{replace\}\> | %\{status\} =~ /batteryLow/i | | -| CRITICALSTATUS | Define the conditions to match for the status to be CRITICAL. You can use the following variables: C\<%\{status\}\>, C\<%\{replace\}\> | %\{replace\} =~ /yes/i | | +| WARNINGSTATUS | Define the conditions to match for the status to be WARNING. You can use the following variables: `%\{status\}`, `%\{replace\}` | %\{status\} =~ /batteryLow/i | | +| CRITICALSTATUS | Define the conditions to match for the status to be CRITICAL. You can use the following variables: `%\{status\}`, `%\{replace\}` | %\{replace\} =~ /yes/i | | | WARNINGTEMPERATURE | Warning threshold for battery temperature (in C) | | | | CRITICALTEMPERATURE | Critical threshold for battery temperature (in C) | | | | WARNINGTIME | Warning threshold for battery remaining time (in minutes) | | | @@ -283,8 +278,8 @@ yum install centreon-plugin-Hardware-Ups-Apc-Snmp | Macro | Description | Valeur par défaut | Obligatoire | |:-------------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------|:------------------|:-----------:| -| WARNINGFREQUENCE | Threshold | | | -| CRITICALFREQUENCE | Threshold | | | +| WARNINGFREQUENCE | Threshold in Hertz | | | +| CRITICALFREQUENCE | Threshold in Hertz | | | | WARNINGLINEFREQUENCE | Threshold | | | | CRITICALLINEFREQUENCE | Threshold | | | | WARNINGLINEPHASECURRENT | Threshold | | | @@ -295,8 +290,8 @@ yum install centreon-plugin-Hardware-Ups-Apc-Snmp | CRITICALLINEPHASEVOLTAGE | Threshold | | | | WARNINGSTATUS | Define the conditions to match for the status to be WARNING. You can use the following variables: %\{last\_cause\} | | | | CRITICALSTATUS | Define the conditions to match for the status to be CRITICAL. You can use the following variables: %\{last\_cause\} | | | -| WARNINGVOLTAGE | Threshold | | | -| CRITICALVOLTAGE | Threshold | | | +| WARNINGVOLTAGE | Threshold in Volts | | | +| CRITICALVOLTAGE | Threshold in Volts | | | | EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). Toutes les options sont listées [ici](#options-disponibles). | | | @@ -305,16 +300,16 @@ yum install centreon-plugin-Hardware-Ups-Apc-Snmp | Macro | Description | Valeur par défaut | Obligatoire | |:------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------|:------------------------------------|:-----------:| | UNKNOWNSTATUS | Define the conditions to match for the status to be UNKNOWN. You can use the following variables: %\{status\} | %\{status\} =~ /unknown/i | | -| WARNINGCURRENT | Threshold | | | -| CRITICALCURRENT | Threshold | | | -| WARNINGFREQUENCE | Threshold | | | -| CRITICALFREQUENCE | Threshold | | | -| WARNINGLOAD | Threshold | 90 | | -| CRITICALLOAD | Threshold | 95 | | +| WARNINGCURRENT | Threshold in Amperes | | | +| CRITICALCURRENT | Threshold in Amperes | | | +| WARNINGFREQUENCE | Threshold in Hertz | | | +| CRITICALFREQUENCE | Threshold in Hertz | | | +| WARNINGLOAD | Threshold in percentage | 90 | | +| CRITICALLOAD | Threshold in percentage | 95 | | | CRITICALSTATUS | Define the conditions to match for the status to be CRITICAL. You can use the following variables: %\{status\} | %\{status\} !~ /onLine\|rebooting/i | | | WARNINGSTATUS | Define the conditions to match for the status to be WARNING. You can use the following variables: %\{status\} | | | -| WARNINGVOLTAGE | Threshold | | | -| CRITICALVOLTAGE | Threshold | | | +| WARNINGVOLTAGE | Threshold in Volts | | | +| CRITICALVOLTAGE | Threshold in Volts | | | | EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). Toutes les options sont listées [ici](#options-disponibles). | | | @@ -327,23 +322,24 @@ yum install centreon-plugin-Hardware-Ups-Apc-Snmp -| Macro | Description | Valeur par défaut | Obligatoire | -|:---------------|:-------------------------------------------------------------------------------------------------------------------------------------------------|:------------------|:-----------:| -| NTPHOSTNAME | Set the ntp hostname (if not set, localtime is used) | | | -| NTPPORT | Set the ntp port (default: 123) | | | -| TIMEZONE | Set the timezone of distant server. For Windows, you need to set it. Can use format: 'Europe/London' | | | -| WARNINGOFFSET | Time warning threshold range (in seconds), in the format `-n:n` (e.g., `-5:5`). Returns WARNING when the offset is less than -n seconds or greater than n seconds. | | | -| CRITICALOFFSET | Time critical threshold range (in seconds), in the format `-n:n` (e.g., `-5:5`). Returns CRITICAL when the offset is less than -n seconds or greater than n seconds. | | | -| EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). Toutes les options sont listées [ici](#options-disponibles). | | | +| Macro | Description | Valeur par défaut | Obligatoire | +|:---------------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------|:------------------|:-----------:| +| NTPHOSTNAME | Set the NTP hostname (if not set, localtime is used) | | | +| NTPPORT | Set the NTP port | 123 | | +| TIMEZONE | Set the timezone of distant server. For Windows, you need to set it. Can use format: 'Europe/London' | | | +| WARNINGOFFSET | Time warning threshold range (in seconds), in the format -n:n (e.g., -5:5). Returns WARNING when the offset is less than -n seconds or greater than n seconds | | | +| CRITICALOFFSET | Time critical threshold range (in seconds), in the format -n:n (e.g., -5:5). Returns CRITICAL when the offset is less than -n seconds or greater than n seconds | | | +| EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). Toutes les options sont listées [ici](#options-disponibles). | | | -| Macro | Description | Valeur par défaut | Obligatoire | -|:---------------|:-------------------------------------------------------------------------------------------------------------------------------------------------|:------------------|:-----------:| -| WARNINGUPTIME | Warning threshold | | | -| CRITICALUPTIME | Critical threshold | | | -| EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). Toutes les options sont listées [ici](#options-disponibles). | | | +| Macro | Description | Valeur par défaut | Obligatoire | +|:---------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:------------------|:-----------:| +| UNIT | Select the time unit for the performance data and thresholds. May be 's' for seconds, 'm' for minutes, 'h' for hours, 'd' for days, 'w' for weeks. Default is secondss. =back | | | +| WARNINGUPTIME | Warning threshold | | | +| CRITICALUPTIME | Critical threshold | | | +| EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). Toutes les options sont listées [ici](#options-disponibles). | --check-overload | | @@ -361,27 +357,22 @@ telle que celle-ci (remplacez les valeurs d'exemple par les vôtres) : ```bash /usr/lib/centreon/plugins/centreon_ups_apc.pl \ --plugin=hardware::ups::apc::snmp::plugin \ - --mode=output-lines \ + --mode=sensors \ --hostname=10.0.0.1 \ --snmp-version='2c' \ - --snmp-community='my-snmp-community' \ - --warning-status='' \ - --critical-status='%\{status\} !~ /onLine|rebooting/i' \ - --unknown-status='%\{status\} =~ /unknown/i' \ - --warning-load='90' \ - --critical-load='95' \ - --warning-voltage='' \ - --critical-voltage='' \ - --warning-current='' \ - --critical-current='' \ - --warning-frequence='' \ - --critical-frequence='' + --snmp-community='my-snmp-community' \ + --snmp-username='username' \ + --authpassphrase='' \ + --authprotocol='' \ + --privpassphrase='' \ + --privprotocol='' \ + --verbose ``` La commande devrait retourner un message de sortie similaire à : ```bash -OK: load: 21 % current: 6 A voltage: 277 V frequence: 677 Hz | 'lines.output.load.percentage'=21%;0:90;0:95;0;100 'lines.output.current.ampere'=6A;;;0; 'lines.output.voltage.volt'=277V;;;; 'lines.output.frequence.hertz'=677Hz;;;; +OK: All 1 components are ok [1/1 sensor ]. | 'hardware. sensor .count'=1;;;; ``` ### Diagnostic des erreurs communes @@ -422,66 +413,67 @@ Le plugin apporte les modes suivants : Les options génériques sont listées ci-dessous : -| 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 ok, 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\[,\[\\],\[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\[,\[\\],\[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\[,\[\\],\[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,\,calculation\[,\[\\],\[min\],\[max\]\] regex: regular expression \: 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 \ (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~replacement~modifier Most commonly used modifiers are i (case insensitive) and g (replace all occurrences). Example: adding --change-short-output='OK\~Up\~gi' will replace all occurrences of 'OK', 'ok', 'Ok' or 'oK' with 'Up' | -| --change-short-output | Modify the short/long output that is returned by the plugin. Syntax: --change-short-output=pattern~replacement~modifier Most commonly used modifiers are i (case insensitive) and g (replace all occurrences). Example: adding --change-short-output='OK\~Up\~gi' will replace all occurrences of 'OK', 'ok', 'Ok' or 'oK' with 'Up' | -| --change-long-output | Modify the short/long output that is returned by the plugin. Syntax: --change-short-output=pattern~replacement~modifier Most commonly used modifiers are i (case insensitive) and g (replace all occurrences). Example: adding --change-short-output='OK\~Up\~gi' will replace all occurrences of 'OK', 'ok', 'Ok' or 'oK' with 'Up' | -| --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\. =cut | +| 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 get-next 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 ok, 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. | +| --show-password | By default, sensitive information in command lines is hidden in debug output and replaced with `***` (however, debug logs may still display sensitive information). Using the C option will display the passwords in plain text. | +| --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\[,\[\\],\[min\],\[max\]\] Common examples: onvert 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\[,\[\\],\[min\],\[max\]\] Common examples: onvert 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\[,\[\\],\[min\],\[max\]\] Common examples: onvert 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,\,calculation\[,\[\\],\[min\],\[max\]\] regex: regular expression \: 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 \ (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: um 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~replacement~modifier Most commonly used modifiers are i (case insensitive) and g (replace all occurrences). Example: adding --change-short-output='OK~Up~gi' will replace all occurrences of 'OK', 'ok', 'Ok' or 'oK' with 'Up' | +| --change-short-output | Modify the short/long output that is returned by the plugin. Syntax: --change-short-output=pattern~replacement~modifier Most commonly used modifiers are i (case insensitive) and g (replace all occurrences). Example: adding --change-short-output='OK~Up~gi' will replace all occurrences of 'OK', 'ok', 'Ok' or 'oK' with 'Up' | +| --change-long-output | Modify the short/long output that is returned by the plugin. Syntax: --change-short-output=pattern~replacement~modifier Most commonly used modifiers are i (case insensitive) and g (replace all occurrences). Example: adding --change-short-output='OK~Up~gi' will replace all occurrences of 'OK', 'ok', 'Ok' or 'oK' with 'Up' | +| --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'. \. | #### Options des modes @@ -490,108 +482,136 @@ Les options disponibles pour chaque modèle de services sont listées ci-dessous -| Option | Description | -|:-------------------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| --filter-counters | Only display some counters (regexp can be used). Example: C\<--filter-counters='^status\|load$'\> | -| --replace-lasttime-format | Define the date format (default: C\<%m/%d/%Y\>). | -| --unknown-status | Define the conditions to match for the status to be UNKNOWN (default: C\<%\{status\} =~ /unknown/i\>). You can use the following variables: %\{status\}, %\{replace\} | -| --warning-status | Define the conditions to match for the status to be WARNING (default: C\<%\{status\} =~ /batteryLow/i\>). You can use the following variables: C\<%\{status\}\>, C\<%\{replace\}\> | -| --critical-status | Define the conditions to match for the status to be CRITICAL (default: C\<%\{replace\} =~ /yes/i\>). You can use the following variables: C\<%\{status\}\>, C\<%\{replace\}\> | -| --unknown-battery-pack-status | Define the conditions to match for the status to be UNKNOWN. You can use the following variables: C\<%\{status\}\> | -| --warning-battery-pack-status | Define the conditions to match for the status to be WARNING. You can use the following variables: C\<%\{status\}\> | -| --critical-battery-pack-status | Define the conditions to match for the status to be CRITICAL (default: C\<%\{status\} ne "OK"\>). You can use the following variables: C\<%\{status\}\> | -| --unknown-cartridge-status | Define the conditions to match for the status to be UNKNOWN. You can use the following variables: C\<%\{status\}\> | -| --warning-cartridge-status | Define the conditions to match for the status to be WARNING. You can use the following variables: C\<%\{status\}\> | -| --critical-cartridge-status | Define the conditions to match for the status to be CRITICAL (default: C\<%\{status\} ne "OK"\>). You can use the following variables: C\<%\{status\}\> | -| --warning-load | Warning threshold for battery load (in %). | -| --critical-load | Critical threshold for battery load (in %). | -| --warning-voltage | Warning threshold for battery voltage (in V). | -| --critical-voltage | Critical threshold for battery voltage (in V). | -| --warning-current | Warning threshold for battery current (in A). | -| --critical-current | Critical threshold for battery current (in A). | -| --warning-temperature | Warning threshold for battery temperature (in C). | -| --critical-temperature | Critical threshold for battery temperature (in C). | -| --warning-time | Warning threshold for battery remaining time (in minutes). | -| --critical-time | Critical threshold for battery remaining time (in minutes). | -| --warning-replace-lasttime | Warning threshold for battery last replace time (in seconds). | -| --critical-replace-lasttime | Critical threshold for battery last replace time (in seconds). | -| --warning-timeon | Warning threshold for time on battery (in minutes). | -| --critical-timeon | Critical threshold for time on battery (in minutes). | +| Option | Description | +|:-------------------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| --filter-counters | Only display some counters (regexp can be used). Example: `--filter-counters='^status\|load$'` | +| --warning-xxx | Warning threshold. | +| --critical-xxx | Critical threshold. | +| --replace-lasttime-format | Define the date format (default: `%m/%d/%Y`). | +| --unknown-status | Define the conditions to match for the status to be UNKNOWN (default: `%\{status\} =~ /unknown/i`). You can use the following variables: %\{status\}, %\{replace\} | +| --warning-status | Define the conditions to match for the status to be WARNING (default: `%\{status\} =~ /batteryLow/i`). You can use the following variables: `%\{status\}`, `%\{replace\}` | +| --critical-status | Define the conditions to match for the status to be CRITICAL (default: `%\{replace\} =~ /yes/i`). You can use the following variables: `%\{status\}`, `%\{replace\}` | +| --unknown-battery-pack-status | Define the conditions to match for the status to be UNKNOWN. You can use the following variables: `%\{status\}` | +| --warning-battery-pack-status | Define the conditions to match for the status to be WARNING. You can use the following variables: `%\{status\}` | +| --critical-battery-pack-status | Define the conditions to match for the status to be CRITICAL (default: `%\{status\} ne "OK"`). You can use the following variables: `%\{status\}` | +| --unknown-cartridge-status | Define the conditions to match for the status to be UNKNOWN. You can use the following variables: `%\{status\}` | +| --warning-cartridge-status | Define the conditions to match for the status to be WARNING. You can use the following variables: `%\{status\}` | +| --critical-cartridge-status | Define the conditions to match for the status to be CRITICAL (default: `%\{status\} ne "OK"`). You can use the following variables: `%\{status\}` | +| --warning-load | Warning threshold for battery load (in %). | +| --critical-load | Critical threshold for battery load (in %). | +| --warning-voltage | Warning threshold for battery voltage (in V). | +| --critical-voltage | Critical threshold for battery voltage (in V). | +| --warning-current | Warning threshold for battery current (in A). | +| --critical-current | Critical threshold for battery current (in A). | +| --warning-temperature | Warning threshold for battery temperature (in C). | +| --critical-temperature | Critical threshold for battery temperature (in C). | +| --warning-time | Warning threshold for battery remaining time (in minutes). | +| --critical-time | Critical threshold for battery remaining time (in minutes). | +| --warning-replace-lasttime | Warning threshold for battery last replace time (in seconds). | +| --critical-replace-lasttime | Critical threshold for battery last replace time (in seconds). | +| --warning-timeon | Warning threshold for time on battery (in minutes). | +| --critical-timeon | Critical threshold for time on battery (in minutes). | -| Option | Description | -|:-------------------------|:-----------------------------------------------------------------------------------------------------------------------------------| -| --filter-counters | Only display some counters (regexp can be used). Example: --filter-counters='^frequence\|voltage$' | -| --warning-status | Define the conditions to match for the status to be WARNING. You can use the following variables: %\{last\_cause\} | -| --critical-status | Define the conditions to match for the status to be CRITICAL. You can use the following variables: %\{last\_cause\} | -| --warning-* --critical-* | Thresholds. Can be: 'voltage', 'frequence', 'line-frequence', 'line-phase-voltage', 'line-phase-current', 'line-phase-power'. | +| Option | Description | +|:------------------------------|:--------------------------------------------------------------------------------------------------------------------| +| --filter-counters | Only display some counters (regexp can be used). Example: --filter-counters='^frequence\|voltage$' | +| --warning-xxx | Warning threshold. | +| --critical-xxx | Critical threshold. | +| --warning-status | Define the conditions to match for the status to be WARNING. You can use the following variables: %\{last\_cause\} | +| --critical-status | Define the conditions to match for the status to be CRITICAL. You can use the following variables: %\{last\_cause\} | +| --warning-frequence | Threshold in Hertz. | +| --critical-frequence | Threshold in Hertz. | +| --warning-line-frequence | Threshold. | +| --critical-line-frequence | Threshold. | +| --warning-line-phase-current | Threshold. | +| --critical-line-phase-current | Threshold. | +| --warning-line-phase-power | Threshold. | +| --critical-line-phase-power | Threshold. | +| --warning-line-phase-voltage | Threshold. | +| --critical-line-phase-voltage | Threshold. | +| --warning-voltage | Threshold in Volts. | +| --critical-voltage | Threshold in Volts. | -| Option | Description | -|:-------------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| --filter-counters | Only display some counters (regexp can be used). Example: --filter-counters='^status\|load$' | -| --unknown-status | Define the conditions to match for the status to be UNKNOWN (default: '%\{status\} =~ /unknown/i'). You can use the following variables: %\{status\} | -| --warning-status | Define the conditions to match for the status to be WARNING (default: ''). You can use the following variables: %\{status\} | -| --critical-status | Define the conditions to match for the status to be CRITICAL (default: '%\{status\} !~ /onLine\|rebooting/i'). You can use the following variables: %\{status\} | -| --warning-* --critical-* | Thresholds. Can be: 'load', 'voltage', 'current', 'frequence'. | +| Option | Description | +|:---------------------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------| +| --filter-counters | Only display some counters (regexp can be used). Example: --filter-counters='^status\|load$' | +| --warning-xxx | Warning threshold. | +| --critical-xxx | Critical threshold. | +| --unknown-status | Define the conditions to match for the status to be UNKNOWN (default: '%\{status\} =~ /unknown/i'). You can use the following variables: %\{status\} | +| --warning-status | Define the conditions to match for the status to be WARNING (default: ''). You can use the following variables: %\{status\} | +| --critical-status | Define the conditions to match for the status to be CRITICAL (default: '%\{status\} !~ /online\|rebooting/i'). You can use the following variables: %\{status\} | +| --warning-current | Threshold in Amperes. | +| --critical-current | Threshold in Amperes. | +| --warning-frequence | Threshold in Hertz. | +| --critical-frequence | Threshold in Hertz. | +| --warning-load | Threshold in percentage. | +| --critical-load | Threshold in percentage. | +| --warning-voltage | Threshold in Volts. | +| --critical-voltage | Threshold in Volts. | -| Option | Description | -|:---------------------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| --component | Define which component should be monitored based on their names. This option will be treated as a regular expression. All components are included by default ('.*'). | -| --filter | Exclude some parts (comma separated list) You can also exclude items from specific instances: --filter=sensor,1.1 | -| --absent-problem | Return an error if a component is not 'present' (default is skipping). It can be set globally or for a specific instance: --absent-problem='component\_name' or --absent-problem='component\_name,instance\_value'. | -| --no-component | Define the expected status if no components are found (default: critical). | -| --threshold-overload | Use this option to override the status returned by the plugin when the status label matches a regular expression (syntax: section,\[instance,\]status,regexp). Example: --threshold-overload='sensor,CRITICAL,sensorStatusNotApplicable' | -| --warning | Set warning threshold for 'temperature', 'humidity' (syntax: type,regexp,threshold) Example: --warning='temperature,.*,40' | -| --critical | Set critical threshold for 'temperature', 'humidity' (syntax: type,regexp,threshold) Example: --critical='temperature,.*,50' package hardware::ups::apc::snmp::mode::components::sensor; use strict; use warnings; my $map\_alarm\_status = \{ 1 =\> 'uioNormal', 2 =\> 'uioWarning', 3 =\> 'uioCritical', 4 =\> 'sensorStatusNotApplicable' \}; my $map\_iem\_status = \{ 1 =\> 'disconnected', 2 =\> 'connected' \}; my $map\_iem\_unit = \{ 1 =\> 'celsius', 2 =\> 'fahrenheit' \}; my $mapping = \{ uioSensorStatusSensorName =\> \{ oid =\> '.1.3.6.1.4.1.318.1.1.25.1.2.1.3' \}, uioSensorStatusTemperatureDegC =\> \{ oid =\> '.1.3.6.1.4.1.318.1.1.25.1.2.1.6' \}, uioSensorStatusHumidity =\> \{ oid =\> '.1.3.6.1.4.1.318.1.1.25.1.2.1.7' \}, uioSensorStatusAlarmStatus =\> \{ oid =\> '.1.3.6.1.4.1.318.1.1.25.1.2.1.9', map =\> $map\_alarm\_status \} \}; my $mapping\_iem = \{ iemStatusProbeName =\> \{ oid =\> '.1.3.6.1.4.1.318.1.1.10.2.3.2.1.2' \}, iemStatusProbeStatus =\> \{ oid =\> '.1.3.6.1.4.1.318.1.1.10.2.3.2.1.3', map =\> $map\_iem\_status \}, iemStatusProbeCurrentTemp =\> \{ oid =\> '.1.3.6.1.4.1.318.1.1.10.2.3.2.1.4' \}, iemStatusProbeTempUnits =\> \{ oid =\> '.1.3.6.1.4.1.318.1.1.10.2.3.2.1.5', map =\> $map\_iem\_unit \}, iemStatusProbeCurrentHumid =\> \{ oid =\> '.1.3.6.1.4.1.318.1.1.10.2.3.2.1.6' \} \}; my $oid\_uioSensorStatusEntry = '.1.3.6.1.4.1.318.1.1.25.1.2.1'; my $oid\_iemStatusProbesEntry = '.1.3.6.1.4.1.318.1.1.10.2.3.2.1'; sub load \{ my ($self) = @\_; push @\{$self-\>\{request\}\}, \{ oid =\> $oid\_uioSensorStatusEntry, start =\> $mapping-\>\{uioSensorStatusSensorName\}-\>\{oid\}, end =\> $mapping-\>\{uioSensorStatusAlarmStatus\}-\>\{oid\} \}, \{ oid =\> $oid\_iemStatusProbesEntry, start =\> $mapping\_iem-\>\{iemStatusProbeName\}-\>\{oid\}, end =\> $mapping\_iem-\>\{iemStatusProbeCurrentHumid\}-\>\{oid\} \}; \} sub check\_uoi \{ my ($self) = @\_; my ($exit, $warn, $crit, $checked); foreach my $oid ($self-\>\{snmp\}-\>oid\_lex\_sort(keys %\{$self-\>\{results\}-\>\{$oid\_uioSensorStatusEntry\}\})) \{ next if ($oid !~ /^$mapping-\>\{uioSensorStatusSensorName\}-\>\{oid\}\.(.*)$/); my $instance = $1; my $result = $self-\>\{snmp\}-\>map\_instance(mapping =\> $mapping, results =\> $self-\>\{results\}-\>\{$oid\_uioSensorStatusEntry\}, instance =\> $instance); $instance = 'universal-' . $1; next if ($self-\>check\_filter(section =\> 'sensor', instance =\> $instance)); $self-\>\{components\}-\>\{sensor\}-\>\{total\}++; $self-\>\{output\}-\>output\_add( long\_msg =\> sprintf( "universal sensor '%s' status is '%s' \[instance = %s\] \[temperature = %s C\] \[humidity = %s %%\]", $result-\>\{uioSensorStatusSensorName\}, $result-\>\{uioSensorStatusAlarmStatus\}, $instance, $result-\>\{uioSensorStatusTemperatureDegC\} != -1 ? $result-\>\{uioSensorStatusTemperatureDegC\} : '-', $result-\>\{uioSensorStatusHumidity\} != -1 ? $result-\>\{uioSensorStatusHumidity\} : '-' ) ); $exit = $self-\>get\_severity(section =\> 'sensor', value =\> $result-\>\{uioSensorStatusAlarmStatus\}); if (!$self-\>\{output\}-\>is\_status(value =\> $exit, compare =\> 'ok', litteral =\> 1)) \{ $self-\>\{output\}-\>output\_add( severity =\> $exit, short\_msg =\> sprintf("universal sensor '%s' status is '%s'", $result-\>\{uioSensorStatusSensorName\}, $result-\>\{uioSensorStatusAlarmStatus\}) ); \} if ($result-\>\{uioSensorStatusTemperatureDegC\} != -1) \{ ($exit, $warn, $crit, $checked) = $self-\>get\_severity\_numeric(section =\> 'temperature', instance =\> $instance, value =\> $result-\>\{uioSensorStatusTemperatureDegC\}); if (!$self-\>\{output\}-\>is\_status(value =\> $exit, compare =\> 'ok', litteral =\> 1)) \{ $self-\>\{output\}-\>output\_add( severity =\> $exit, short\_msg =\> sprintf( "universal sensor temperature '%s' is %s C", $result-\>\{uioSensorStatusSensorName\}, $result-\>\{uioSensorStatusTemperatureDegC\} ) ); \} $self-\>\{output\}-\>perfdata\_add( nlabel =\> 'sensor.universal.temperature.celsius', unit =\> 'C', instances =\> $result-\>\{uioSensorStatusSensorName\}, value =\> $result-\>\{uioSensorStatusTemperatureDegC\}, warning =\> $warn, critical =\> $crit ); \} next if ($result-\>\{uioSensorStatusHumidity\} == -1); ($exit, $warn, $crit, $checked) = $self-\>get\_severity\_numeric(section =\> 'humidity', instance =\> $instance, value =\> $result-\>\{uioSensorStatusHumidity\}); if (!$self-\>\{output\}-\>is\_status(value =\> $exit, compare =\> 'ok', litteral =\> 1)) \{ $self-\>\{output\}-\>output\_add( severity =\> $exit, short\_msg =\> sprintf( "universal sensor humidity '%s' is %s %%", $result-\>\{uioSensorStatusSensorName\}, $result-\>\{uioSensorStatusHumidity\} ) ); \} $self-\>\{output\}-\>perfdata\_add( nlabel =\> 'sensor.universal.humidity.percentage', unit =\> '%', instances =\> $result-\>\{uioSensorStatusSensorName\}, value =\> $result-\>\{uioSensorStatusHumidity\}, warning =\> $warn, critical =\> $crit, min =\> 0, max =\> 100 ); \} \} sub check\_iem \{ my ($self) = @\_; my ($exit, $warn, $crit, $checked); foreach my $oid ($self-\>\{snmp\}-\>oid\_lex\_sort(keys %\{$self-\>\{results\}-\>\{$oid\_iemStatusProbesEntry\}\})) \{ next if ($oid !~ /^$mapping\_iem-\>\{iemStatusProbeName\}-\>\{oid\}\.(.*)$/); my $instance = $1; my $result = $self-\>\{snmp\}-\>map\_instance(mapping =\> $mapping\_iem, results =\> $self-\>\{results\}-\>\{$oid\_iemStatusProbesEntry\}, instance =\> $instance); $instance = 'integrated-' . $1; next if ($self-\>check\_filter(section =\> 'sensor', instance =\> $instance)); $self-\>\{components\}-\>\{sensor\}-\>\{total\}++; $self-\>\{output\}-\>output\_add( long\_msg =\> sprintf( "integrated sensor '%s' status is '%s' \[instance = %s\] \[temperature = %s %s\] \[humidity = %s %%\]", $result-\>\{iemStatusProbeName\}, $result-\>\{iemStatusProbeStatus\}, $instance, $result-\>\{iemStatusProbeCurrentTemp\} != -1 ? $result-\>\{iemStatusProbeCurrentTemp\} : '-', $result-\>\{iemStatusProbeTempUnits\}, $result-\>\{iemStatusProbeCurrentHumid\} != -1 ? $result-\>\{iemStatusProbeCurrentHumid\} : '-' ) ); $exit = $self-\>get\_severity(section =\> 'sensor', value =\> $result-\>\{iemStatusProbeStatus\}); if (!$self-\>\{output\}-\>is\_status(value =\> $exit, compare =\> 'ok', litteral =\> 1)) \{ $self-\>\{output\}-\>output\_add( severity =\> $exit, short\_msg =\> sprintf("integrated sensor '%s' status is '%s'", $result-\>\{iemStatusProbeName\}, $result-\>\{iemStatusProbeStatus\}) ); \} next if ($result-\>\{iemStatusProbeStatus\} eq 'disconnected'); if ($result-\>\{iemStatusProbeCurrentTemp\} != -1) \{ ($exit, $warn, $crit, $checked) = $self-\>get\_severity\_numeric(section =\> 'temperature', instance =\> $instance, value =\> $result-\>\{iemStatusProbeCurrentTemp\}); if (!$self-\>\{output\}-\>is\_status(value =\> $exit, compare =\> 'ok', litteral =\> 1)) \{ $self-\>\{output\}-\>output\_add( severity =\> $exit, short\_msg =\> sprintf( "integrated sensor temperature '%s' is %s %s", $result-\>\{iemStatusProbeName\}, $result-\>\{iemStatusProbeCurrentTemp\}, $result-\>\{iemStatusProbeTempUnits\} ) ); \} $self-\>\{output\}-\>perfdata\_add( unit =\> $result-\>\{iemStatusProbeTempUnits\} eq 'celsius' ? 'C' : 'F', nlabel =\> 'sensor.integrated.temperature.' . $result-\>\{iemStatusProbeTempUnits\}, instances =\> $result-\>\{iemStatusProbeName\}, value =\> $result-\>\{iemStatusProbeCurrentTemp\}, warning =\> $warn, critical =\> $crit ); \} next if ($result-\>\{iemStatusProbeCurrentHumid\} == -1); ($exit, $warn, $crit, $checked) = $self-\>get\_severity\_numeric(section =\> 'humidity', instance =\> $instance, value =\> $result-\>\{iemStatusProbeCurrentHumid\}); if (!$self-\>\{output\}-\>is\_status(value =\> $exit, compare =\> 'ok', litteral =\> 1)) \{ $self-\>\{output\}-\>output\_add( severity =\> $exit, short\_msg =\> sprintf( "integrated sensor humidity '%s' is %s %%", $result-\>\{iemStatusProbeName\}, $result-\>\{iemStatusProbeCurrentHumid\} ) ); \} $self-\>\{output\}-\>perfdata\_add( nlabel =\> 'sensor.integrated.humidity.percentage', unit =\> '%', instances =\> $result-\>\{iemStatusProbeName\}, value =\> $result-\>\{iemStatusProbeCurrentHumid\}, warning =\> $warn, critical =\> $crit, min =\> 0, max =\> 100 ); \} \} sub check \{ my ($self) = @\_; $self-\>\{output\}-\>output\_add(long\_msg =\> 'checking sensors'); $self-\>\{components\}-\>\{sensor\} = \{name =\> 'sensors', total =\> 0, skip =\> 0\}; return if ($self-\>check\_filter(section =\> 'sensor')); check\_uoi($self); check\_iem($self); \} 1; | -| --warning-count-* | Define the warning threshold for the number of components of one type (replace '*' with the component type). | -| --critical-count-* | Define the critical threshold for the number of components of one type (replace '*' with the component type). | +| Option | Description | +|:---------------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| --component | Which component to check (default: '.*'). Can be: 'sensor'. | +| --filter | Exclude some parts (comma separated list) You can also exclude items from specific instances: --filter=sensor,1.1 | +| --absent-problem | Return an error if a component is not 'present' (default is skipping). It can be set globally or for a specific instance: --absent-problem='component\_name' or --absent-problem='component\_name,instance\_value'. | +| --no-component | Define the expected status if no components are found (default: critical). | +| --threshold-overload | Use this option to override the status returned by the plugin when the status label matches a regular expression (syntax: section,\[instance,\]status,regexp). Example: --threshold-overload='sensor,CRITICAL,sensorStatusNotApplicable' | +| --warning | Set warning threshold for 'temperature', 'humidity' (syntax: type,regexp,threshold) Example: --warning='temperature,.*,40' | +| --critical | Set critical threshold for 'temperature', 'humidity' (syntax: type,regexp,threshold) Example: --critical='temperature,.*,50' | +| --warning-count-* | Define the warning threshold for the number of components of one type (replace '*' with the component type). | +| --critical-count-* | Define the critical threshold for the number of components of one type (replace '*' with the component type). | -| Option | Description | -|:------------------|:--------------------------------------------------------------------------------------------------------------------------| -| --filter-counters | Only display some counters (regexp can be used). Example to check SSL connections only : --filter-counters='^xxxx\|yyyy$' | -| --oid | Override default OID. | -| --warning-offset | Time warning threshold range (in seconds), in the format `-n:n` (e.g., `-5:5`). Returns WARNING when the offset is less than -n seconds or greater than n seconds. | -| --critical-offset | Time critical threshold range (in seconds), in the format `-n:n` (e.g., `-5:5`). Returns CRITICAL when the offset is less than -n seconds or greater than n seconds. | -| --ntp-hostname | Set the ntp hostname (if not set, localtime is used). | -| --ntp-port | Set the ntp port (default: 123). | -| --timezone | Set the timezone of distant server. For Windows, you need to set it. Can use format: 'Europe/London'. | +| Option | Description | +|:------------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------| +| --filter-counters | Only display some counters (regexp can be used). Example to check SSL connections only : --filter-counters='^xxxx\|yyyy$' | +| --warning-xxx | Warning threshold. | +| --critical-xxx | Critical threshold. | +| --oid | Override default OID. | +| --warning-offset | Time warning threshold range (in seconds), in the format -n:n (e.g., -5:5). Returns WARNING when the offset is less than -n seconds or greater than n seconds. | +| --critical-offset | Time critical threshold range (in seconds), in the format -n:n (e.g., -5:5). Returns CRITICAL when the offset is less than -n seconds or greater than n seconds. | +| --ntp-hostname | Set the NTP hostname (if not set, localtime is used). | +| --ntp-port | Set the NTP port (default: 123). | +| --timezone | Set the timezone of distant server. For Windows, you need to set it. Can use format: 'Europe/London'. | -| Option | Description | -|:-----------------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| --filter-counters | Only display some counters (regexp can be used). Example to check SSL connections only : --filter-counters='^xxxx\|yyyy$' | -| --warning-uptime | Warning threshold. | -| --critical-uptime | Critical threshold. | -| --add-sysdesc | Display system description. | -| --force-oid | Can choose your oid (numeric format only). | -| --check-overload | Uptime counter limit is 4294967296 and overflow. With that option, we manage the counter going back. But there is a few chance we can miss a reboot. | -| --reboot-window | To be used with check-overload option. Time in milliseconds (default: 5000) You increase the chance of not missing a reboot if you decrease that value. | -| --unit | Select the time unit for the performance data and thresholds. May be 's' for seconds, 'm' for minutes, 'h' for hours, 'd' for days, 'w' for weeks. Default is secondss. =back | -| --memcached | Memcached server to use (only one server). | -| --redis-server | Redis server to use (only one server). Syntax: address\[:port\] | -| --redis-attribute | Set Redis Options (--redis-attribute="cnx\_timeout=5"). | -| --redis-db | Set Redis database index. | -| --failback-file | Fall back on a local file if Redis connection fails. | -| --memexpiration | Time to keep data in seconds (default: 86400). | -| --statefile-dir | Define the cache directory (default: '/var/lib/centreon/centplugins'). | -| --statefile-suffix | Define a suffix to customize the statefile name (default: ''). | -| --statefile-concat-cwd | If used with the '--statefile-dir' option, the latter's value will be used as a sub-directory of the current working directory. Useful on Windows when the plugin is compiled, as the file system and permissions are different from Linux. | -| --statefile-format | Define the format used to store the cache. Available formats: 'dumper', 'storable', 'json' (default). | -| --statefile-key | Define the key to encrypt/decrypt the cache. | -| --statefile-cipher | Define the cipher algorithm to encrypt the cache (default: 'AES'). | +| Option | Description | +|:-----------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| --filter-counters | Only display some counters (regexp can be used). Example to check SSL connections only : --filter-counters='^xxxx\|yyyy$' | +| --warning-xxx | Warning threshold. | +| --critical-xxx | Critical threshold. | +| --warning-uptime | Warning threshold. | +| --critical-uptime | Critical threshold. | +| --add-sysdesc | Display system description. | +| --force-oid | Can choose your oid (numeric format only). | +| --check-overload | Uptime counter limit is 4294967296 and overflow. With that option, we manage the counter going back. But there is a few chance we can miss a reboot. | +| --reboot-window | To be used with check-overload option. Time in milliseconds (default: 5000) You increase the chance of not missing a reboot if you decrease that value. | +| --unit | Select the time unit for the performance data and thresholds. May be 's' for seconds, 'm' for minutes, 'h' for hours, 'd' for days, 'w' for weeks. Default is secondss. =back | +| --memcached | Memcached server to use (only one server). | +| --redis-server | Redis server to use (only one server). Syntax: address\[:port\] | +| --redis-attribute | Set Redis Options (--redis-attribute="cnx\_timeout=5"). | +| --redis-db | Set Redis database index. | +| --failback-file | Fall back on a local file if Redis connection fails. | +| --memexpiration | Time to keep data in seconds (default: 86400). | +| --statefile-dir | Define the cache directory (default: '/var/lib/centreon/centplugins'). | +| --statefile-suffix | Define a suffix to customize the statefile name (default: ''). | +| --statefile-concat-cwd | If used with the '--statefile-dir' option, the latter's value will be used as a sub-directory of the current working directory. Useful on Windows when the plugin is compiled, as the file system and permissions are different from Linux. | +| --statefile-format | Define the format used to store the cache. Available formats: 'dumper', 'storable', 'json' (default). | +| --statefile-key | Define the key to encrypt/decrypt the cache. | +| --statefile-cipher | Define the cipher algorithm to encrypt the cache (default: 'AES'). | @@ -602,6 +622,6 @@ affichée en ajoutant le paramètre `--help` à la commande : ```bash /usr/lib/centreon/plugins/centreon_ups_apc.pl \ --plugin=hardware::ups::apc::snmp::plugin \ - --mode=output-lines \ + --mode=sensors \ --help ``` diff --git a/i18n/fr/docusaurus-plugin-content-docs-pp/current/integrations/plugin-packs/procedures/hardware-ups-powerware-snmp.md b/i18n/fr/docusaurus-plugin-content-docs-pp/current/integrations/plugin-packs/procedures/hardware-ups-powerware-snmp.md index 973e4b816228..15565d48bcd6 100644 --- a/i18n/fr/docusaurus-plugin-content-docs-pp/current/integrations/plugin-packs/procedures/hardware-ups-powerware-snmp.md +++ b/i18n/fr/docusaurus-plugin-content-docs-pp/current/integrations/plugin-packs/procedures/hardware-ups-powerware-snmp.md @@ -95,12 +95,9 @@ Voici le tableau des services pour ce connecteur, détaillant les métriques et -| Nom | Unité | -|:----------------------------------|:------| -| lines.input.frequence.hertz | Hz | -| *iline*#line.input.current.ampere | A | -| *iline*#line.input.voltage.volt | V | -| *iline*#line.input.power.watt | W | +| Nom | Unité | +|:----------------------------|:------| +| lines.input.frequency.hertz | Hz | > Pour obtenir ce nouveau format de métrique, incluez la valeur **--use-new-perfdata** dans la macro de service **EXTRAOPTIONS**. @@ -237,12 +234,14 @@ yum install centreon-plugin-Hardware-Ups-Powerware-Snmp 2. Complétez les champs **Nom**, **Alias** & **IP Address/DNS** correspondant à votre ressource. 3. Appliquez le modèle d'hôte **HW-UPS-Powerware-SNMP-custom**. -> Si vous utilisez SNMP en version 3, vous devez configurer les paramètres spécifiques associés via la macro **SNMPEXTRAOPTIONS**. -> Plus d'informations dans la section [Troubleshooting SNMP](../getting-started/how-to-guides/troubleshooting-plugins.md#mapping-des-options-snmpv3). - -| Macro | Description | Valeur par défaut | Obligatoire | -|:-----------------|:---------------------------------------------------------------------------------------------------------------------------------------------------|:------------------|:-----------:| -| SNMPEXTRAOPTIONS | Any extra option you may want to add to every command (a --verbose flag for example). Toutes les options sont listées [ici](#options-disponibles). | | | +| Macro | Description | Valeur par défaut | Obligatoire | +|:------------------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------|:------------------|:-----------:| +| SNMP_V3_USERNAME | SNMP v3 only: User name (`securityName`) | | | +| SNMP_V3_AUTH_PROTOCOL | SNMP v3 only: Authentication protocol: MD5\|SHA. Since net-snmp 5.9.1: SHA224\|SHA256\|SHA384\|SHA512 | | | +| SNMP_V3_PRIV_PROTOCOL | 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 | | | +| SNMP_V3_AUTH_PASSPHRASE | SNMP v3 only: Pass phrase hashed using the authentication protocol defined in the --authprotocol option | | | +| SNMP_V3_PRIV_PASSPHRASE | SNMP v3 only: Privacy pass phrase (`privPassword`) to encrypt messages using the protocol defined in the --privprotocol option | | | +| SNMPEXTRAOPTIONS | Any extra option you may want to add to every command (a --verbose flag for example). Toutes les options sont listées [ici](#options-disponibles). | | | 4. [Déployez la configuration](/docs/monitoring/monitoring-servers/deploying-a-configuration). L'hôte apparaît dans la liste des hôtes supervisés, et dans la page **Statut des ressources**. La commande envoyée par le connecteur est indiquée dans le panneau de détails de l'hôte : celle-ci montre les valeurs des macros. @@ -294,17 +293,17 @@ yum install centreon-plugin-Hardware-Ups-Powerware-Snmp -| Macro | Description | Valeur par défaut | Obligatoire | -|:------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------|:------------------|:-----------:| -| WARNINGCURRENT | Threshold | | | -| CRITICALCURRENT | Threshold | | | -| WARNINGFREQUENCE | Threshold | | | -| CRITICALFREQUENCE | Threshold | | | -| WARNINGPOWER | Threshold | | | -| CRITICALPOWER | Threshold | | | -| WARNINGVOLTAGE | Threshold | | | -| CRITICALVOLTAGE | Threshold | | | -| EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). Toutes les options sont listées [ici](#options-disponibles). | | | +| Macro | Description | Valeur par défaut | Obligatoire | +|:------------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:------------------|:-----------:| +| WARNINGCURRENT | Threshold in Amperes | | | +| CRITICALCURRENT | Threshold in Amperes | | | +| WARNINGFREQUENCE | Threshold in Hertz | | | +| CRITICALFREQUENCE | Threshold in Hertz | | | +| WARNINGPOWER | Threshold in Watts | | | +| CRITICALPOWER | Threshold in Watts | | | +| WARNINGVOLTAGE | Threshold in Volts | | | +| CRITICALVOLTAGE | Threshold in Volts. If --warning-voltage and --critical-voltage are not specified the connector uses the SNMP values `upsConfigLowVoltageTransferPoint` ( OID .1.3.6.1.2.1.33.1.9.9 ) and `upsConfigHighVoltageTransferPoint` ( OID .1.3.6.1.2.1.33.1.9.10 ) to set the CRITICAL threshold if these values are different from zero | | | +| EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). Toutes les options sont listées [ici](#options-disponibles). | | | @@ -349,7 +348,12 @@ telle que celle-ci (remplacez les valeurs d'exemple par les vôtres) : --mode=output-lines \ --hostname=10.0.0.1 \ --snmp-version='2c' \ - --snmp-community='my-snmp-community' \ + --snmp-community='my-snmp-community' \ + --snmp-username='username' \ + --authpassphrase='' \ + --authprotocol='' \ + --privpassphrase='' \ + --privprotocol='' \ --warning-load='90' \ --critical-load='95' \ --warning-voltage='' \ @@ -423,24 +427,25 @@ Les options génériques sont listées ci-dessous : | --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-force-getnext | Use SNMP get-next 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). | +| --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. | +| --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 ok, warning, critical and unknown (default). | -| --snmp-tls-transport | Transport protocol for TLS communication (can be: 'dtlsudp', 'tlstcp'). | +| --snmp-errors-exit | Expected status in case of SNMP error or timeout. Possible values are ok, 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-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. | +| --show-password | By default, sensitive information in command lines is hidden in debug output and replaced with `***` (however, debug logs may still display sensitive information). Using the C option will display the passwords in plain text. | | --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%;;;; | @@ -448,9 +453,9 @@ Les options génériques sont listées ci-dessous : | --change-perfdata | Change or extend perfdata. Syntax: --extend-perfdata=searchlabel,newlabel,target\[,\[\\],\[min\],\[max\]\] Common examples: onvert 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\[,\[\\],\[min\],\[max\]\] Common examples: onvert 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,\,calculation\[,\[\\],\[min\],\[max\]\] regex: regular expression \: 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 \ (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: um 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~replacement~modifier Most commonly used modifiers are i (case insensitive) and g (replace all occurrences). Example: adding --change-short-output='OK\~Up\~gi' will replace all occurrences of 'OK', 'ok', 'Ok' or 'oK' with 'Up' | -| --change-short-output | Modify the short/long output that is returned by the plugin. Syntax: --change-short-output=pattern~replacement~modifier Most commonly used modifiers are i (case insensitive) and g (replace all occurrences). Example: adding --change-short-output='OK\~Up\~gi' will replace all occurrences of 'OK', 'ok', 'Ok' or 'oK' with 'Up' | -| --change-long-output | Modify the short/long output that is returned by the plugin. Syntax: --change-short-output=pattern~replacement~modifier Most commonly used modifiers are i (case insensitive) and g (replace all occurrences). Example: adding --change-short-output='OK\~Up\~gi' will replace all occurrences of 'OK', 'ok', 'Ok' or 'oK' with 'Up' | +| --change-short-output --change-long-output | Modify the short/long output that is returned by the plugin. Syntax: --change-short-output=pattern~replacement~modifier Most commonly used modifiers are i (case insensitive) and g (replace all occurrences). Example: adding --change-short-output='OK~Up~gi' will replace all occurrences of 'OK', 'ok', 'Ok' or 'oK' with 'Up' | +| --change-short-output | Modify the short/long output that is returned by the plugin. Syntax: --change-short-output=pattern~replacement~modifier Most commonly used modifiers are i (case insensitive) and g (replace all occurrences). Example: adding --change-short-output='OK~Up~gi' will replace all occurrences of 'OK', 'ok', 'Ok' or 'oK' with 'Up' | +| --change-long-output | Modify the short/long output that is returned by the plugin. Syntax: --change-short-output=pattern~replacement~modifier Most commonly used modifiers are i (case insensitive) and g (replace all occurrences). Example: adding --change-short-output='OK~Up~gi' will replace all occurrences of 'OK', 'ok', 'Ok' or 'oK' with 'Up' | | --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. | @@ -498,6 +503,8 @@ Les options disponibles pour chaque modèle de services sont listées ci-dessous | Option | Description | |:-------------------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------| | --filter-counters | Only display some counters (regexp can be used). Example: --filter-counters='status\|current' | +| --warning-xxx | Warning threshold. | +| --critical-xxx | Critical threshold. | | --unknown-status | Define the conditions to match for the status to be UNKNOWN (default: '%\{status\} =~ /unknown/i'). You can use the following variables: %\{status\}. | | --warning-status | Define the conditions to match for the status to be WARNING (default: '%\{status\} =~ /batteryDischarging/i'). You can use the following variables: %\{status\}. | | --critical-status | Define the conditions to match for the status to be CRITICAL (default: ''). You can use the following variables: %\{status\}. | @@ -509,16 +516,27 @@ Les options disponibles pour chaque modèle de services sont listées ci-dessous | Option | Description | |:-------------------------|:--------------------------------------------------------------------------------------------------------------------------| | --filter-counters | Only display some counters (regexp can be used). Example to check SSL connections only : --filter-counters='^xxxx\|yyyy$' | +| --warning-xxx | Warning threshold. | +| --critical-xxx | Critical threshold. | | --warning-* --critical-* | Thresholds. Can be: 'internal-temperature', 'internal-humidity', 'remote-temperature', 'remote-humidity'. | -| Option | Description | -|:-------------------------|:--------------------------------------------------------------------------------------------------------------------------| -| --filter-counters | Only display some counters (regexp can be used). Example to check SSL connections only : --filter-counters='^xxxx\|yyyy$' | -| --filter-iline | Filter input lines that match the regexp | -| --warning-* --critical-* | Thresholds. Can be: 'frequence', 'voltage', 'current', 'power'. | +| Option | Description | +|:---------------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| --filter-counters | Only display some counters (regexp can be used). Example to check SSL connections only : --filter-counters='^xxxx\|yyyy$' | +| --warning-xxx | Warning threshold. | +| --critical-xxx | Critical threshold. | +| --filter-iline | Filter input lines that match the regexp | +| --warning-current | Threshold in Amperes. | +| --critical-current | Threshold in Amperes. | +| --warning-frequency | Threshold in Hertz. | +| --critical-frequency | Threshold in Hertz. | +| --warning-power | Threshold in Watts. | +| --critical-power | Threshold in Watts. | +| --warning-voltage | Threshold in Volts. | +| --critical-voltage | Threshold in Volts. If --warning-voltage and --critical-voltage are not specified the connector uses the SNMP values `upsConfigLowVoltageTransferPoint` ( OID .1.3.6.1.2.1.33.1.9.9 ) and `upsConfigHighVoltageTransferPoint` ( OID .1.3.6.1.2.1.33.1.9.10 ) to set the CRITICAL threshold if these values are different from zero. | @@ -526,6 +544,8 @@ Les options disponibles pour chaque modèle de services sont listées ci-dessous | Option | Description | |:------------------|:--------------------------------------------------------------------------------------------------------------------------| | --filter-counters | Only display some counters (regexp can be used). Example to check SSL connections only : --filter-counters='^xxxx\|yyyy$' | +| --warning-xxx | Warning threshold. | +| --critical-xxx | Critical threshold. | | --warning-* | Warning threshold. Can be: 'load', 'voltage', 'current', 'power'. Load is a rate for X phase. | | --critical-* | Critical threshold. Can be: 'load', 'voltage', 'current', 'power'. Load is a rate for X phase. | diff --git a/i18n/fr/docusaurus-plugin-content-docs-pp/current/integrations/plugin-packs/procedures/network-aruba-aoscx-snmp.md b/i18n/fr/docusaurus-plugin-content-docs-pp/current/integrations/plugin-packs/procedures/network-aruba-aoscx-snmp.md index 1d948d26315a..d0c9bbde0889 100644 --- a/i18n/fr/docusaurus-plugin-content-docs-pp/current/integrations/plugin-packs/procedures/network-aruba-aoscx-snmp.md +++ b/i18n/fr/docusaurus-plugin-content-docs-pp/current/integrations/plugin-packs/procedures/network-aruba-aoscx-snmp.md @@ -11,9 +11,7 @@ Les connecteurs de supervision suivants sont automatiquement installés lors de depuis la page **Configuration > Connecteurs > Connecteurs de supervision** : * [Base Pack](./base-generic.md) -## Contenu du connecteur - -> Depuis le rachat d'Aruba par HP, certaines MIB peuvent avoir changé. Si votre équipement Aruba n'est plus supervisé correctement par le connecteur Aruba, utilisez le connecteur [HP Procurve SNMP](network-switchs-hp-procurve-snmp.md). +## Contenu du pack ### Modèles @@ -88,14 +86,16 @@ Voici le tableau des services pour ce connecteur, détaillant les métriques et -| Metric name | Unité | -|:-------------------------------------------|:------| -| *fan_name*#hardware.fan.speed.rpm | rpm | -| fan tray status | N/A | -| psu status | N/A | -| *psu_name*#hardware.psu.power.watt | W | -| temperature status | N/A | -| *sensor_name*#hardware.temperature.celsius | C | +| Nom | Unité | +|:---------------------------|:------| +| hardware.psu.count | count | +| psu status | N/A | +| hardware.temperature.count | count | +| temperature status | N/A | +| hardware.fan.count | count | +| fan status | N/A | +| hardware.fantray.count | count | +| fantray status | N/A | @@ -123,7 +123,6 @@ Voici le tableau des services pour ce connecteur, détaillant les métriques et | Nom | Unité | |:-------|:------| | status | N/A | -| status | N/A | > Pour obtenir ce nouveau format de métrique, incluez la valeur **--use-new-perfdata** dans la macro de service **EXTRAOPTIONS**. @@ -189,6 +188,8 @@ Centreon vers l'équipement supervisé. ### Pack +La procédure d'installation des connecteurs de supervision diffère légèrement [suivant que votre licence est offline ou online](../getting-started/how-to-guides/connectors-licenses.md). + 1. Si la plateforme est configurée avec une licence *online*, l'installation d'un paquet n'est pas requise pour voir apparaître le connecteur dans le menu **Configuration > Connecteurs > Connecteurs de supervision**. Au contraire, si la plateforme utilise une licence *offline*, installez le paquet @@ -279,12 +280,14 @@ yum install centreon-plugin-Network-Aruba-Aoscx-Snmp 2. Complétez les champs **Nom**, **Alias** & **IP Address/DNS** correspondant à votre ressource. 3. Appliquez le modèle d'hôte **Net-Aruba-Aoscx-SNMP-custom**. -> Si vous utilisez SNMP en version 3, vous devez configurer les paramètres spécifiques associés via la macro **SNMPEXTRAOPTIONS**. -> Plus d'informations dans la section [Troubleshooting SNMP](../getting-started/how-to-guides/troubleshooting-plugins.md#mapping-des-options-snmpv3). - -| Macro | Description | Valeur par défaut | Obligatoire | -|:-----------------|:---------------------------------------------------------------------------------------------------------------------------------------------------|:------------------|:-----------:| -| SNMPEXTRAOPTIONS | Any extra option you may want to add to every command (a --verbose flag for example). Toutes les options sont listées [ici](#options-disponibles). | | | +| Macro | Description | Valeur par défaut | Obligatoire | +|:------------------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------|:------------------|:-----------:| +| SNMP_V3_USERNAME | SNMP v3 only: User name (`securityName`) | | | +| SNMP_V3_AUTH_PROTOCOL | SNMP v3 only: Authentication protocol: MD5\|SHA. Since net-snmp 5.9.1: SHA224\|SHA256\|SHA384\|SHA512 | | | +| SNMP_V3_PRIV_PROTOCOL | 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 | | | +| SNMP_V3_AUTH_PASSPHRASE | SNMP v3 only: Pass phrase hashed using the authentication protocol defined in the --authprotocol option | | | +| SNMP_V3_PRIV_PASSPHRASE | SNMP v3 only: Privacy pass phrase (`privPassword`) to encrypt messages using the protocol defined in the --privprotocol option | | | +| SNMPEXTRAOPTIONS | Any extra option you may want to add to every command (a --verbose flag for example). Toutes les options sont listées [ici](#options-disponibles). | | | 4. [Déployez la configuration](/docs/monitoring/monitoring-servers/deploying-a-configuration). L'hôte apparaît dans la liste des hôtes supervisés, et dans la page **Statut des ressources**. La commande envoyée par le connecteur est indiquée dans le panneau de détails de l'hôte : celle-ci montre les valeurs des macros. @@ -308,7 +311,7 @@ yum install centreon-plugin-Network-Aruba-Aoscx-Snmp | Macro | Description | Valeur par défaut | Obligatoire | |:-------------|:-------------------------------------------------------------------------------------------------------------------------------------------------|:------------------|:-----------:| -| COMPONENT | Which component to check (default: '.*'). Can be: 'psu', 'temperature', 'fan', 'fantray' | | | +| COMPONENT | Which component to check. Can be: `psu`, `temperature`, `fan`, `fantray` | .* | | | EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). Toutes les options sont listées [ici](#options-disponibles). | --verbose | | @@ -319,18 +322,18 @@ yum install centreon-plugin-Network-Aruba-Aoscx-Snmp | OIDFILTER | Define the OID to be used to filter interfaces (values: ifDesc, ifAlias, ifName, IpAddr) | ifname | | | OIDDISPLAY | Define the OID that will be used to name the interfaces (values: ifDesc, ifAlias, ifName, IpAddr) | ifname | | | INTERFACENAME | Check only the interfaces with the specified IDs (OID indexes, e.g.: 1,2,...). If empty, all interfaces will be monitored. To filter on interface names, see --name | | | -| WARNINGINDISCARD | Threshold | | | -| CRITICALINDISCARD | Threshold | | | -| WARNINGINERROR | Threshold | | | -| CRITICALINERROR | Threshold | | | -| WARNINGINTRAFFIC | Threshold | | | -| CRITICALINTRAFFIC | Threshold | | | -| WARNINGOUTDISCARD | Threshold | | | -| CRITICALOUTDISCARD | Threshold | | | -| WARNINGOUTERROR | Threshold | | | -| CRITICALOUTERROR | Threshold | | | -| WARNINGOUTTRAFFIC | Threshold | | | -| CRITICALOUTTRAFFIC | Threshold | | | +| WARNINGINDISCARD | Thresholds | | | +| CRITICALINDISCARD | Thresholds | | | +| WARNINGINERROR | Thresholds | | | +| CRITICALINERROR | Thresholds | | | +| WARNINGINTRAFFIC | Thresholds | | | +| CRITICALINTRAFFIC | Thresholds | | | +| WARNINGOUTDISCARD | Thresholds | | | +| CRITICALOUTDISCARD | Thresholds | | | +| WARNINGOUTERROR | Thresholds | | | +| CRITICALOUTERROR | Thresholds | | | +| WARNINGOUTTRAFFIC | Thresholds | | | +| CRITICALOUTTRAFFIC | Thresholds | | | | CRITICALSTATUS | Define the conditions to match for the status to be CRITICAL. You can use the following variables: %\{admstatus\}, %\{opstatus\}, %\{duplexstatus\}, %\{display\} | %\{admstatus\} eq "up" and %\{opstatus\} !~ /up\|dormant/ | | | WARNINGSTATUS | Define the conditions to match for the status to be WARNING. You can use the following variables: %\{admstatus\}, %\{opstatus\}, %\{duplexstatus\}, %\{display\} | | | | EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). Toutes les options sont listées [ici](#options-disponibles). | --verbose --no-skipped-counters | | @@ -358,19 +361,20 @@ yum install centreon-plugin-Network-Aruba-Aoscx-Snmp -| Macro | Description | Valeur par défaut | Obligatoire | -|:---------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------|:----------------------------------------------------------|:-----------:| -| CRITICALMEMBERSTATUS | Define the conditions to match for the status to be CRITICAL. You can use the following variables: %\{role\}, %\{roleLast\}, %\{state\}, %\{stateLast\} | %\{role\} ne %\{roleLast\} | | -| WARNINGMEMBERSTATUS | Define the conditions to match for the status to be WARNING. You can use the following variables: %\{role\}, %\{roleLast\}, %\{state\}, %\{stateLast\} | | | -| CRITICALPORTSTATUS | Define the conditions to match for the status to be CRITICAL. You can use the following variables: %\{admin\_status\}, %\{oper\_status\}, %\{display\} | %\{admin\_status\} eq "up" and %\{oper\_status\} ne "up" | | -| WARNINGPORTSTATUS | Define the conditions to match for the status to be WARNING . You can use the following variables: %\{admin\_status\}, %\{oper\_status\}, %\{display\} | | | -| EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). Toutes les options sont listées [ici](#options-disponibles). | --verbose | | +| Macro | Description | Valeur par défaut | Obligatoire | +|:---------------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:----------------------------------------------------------|:-----------:| +| CRITICALMEMBERSTATUS | Define the conditions to match for the status to be CRITICAL (Default: '%\{role\} ne %\{roleLast\}'). You can use the following variables: %\{role\}, %\{roleLast\}, %\{state\}, %\{stateLast\} | %\{role\} ne %\{roleLast\} | | +| WARNINGMEMBERSTATUS | Define the conditions to match for the status to be WARNING (Default: ''). You can use the following variables: %\{role\}, %\{roleLast\}, %\{state\}, %\{stateLast\} | | | +| CRITICALPORTSTATUS | Define the conditions to match for the status to be CRITICAL (Default: '%\{admin\_status\} eq "up" and %\{oper\_status\} ne "up"'). You can use the following variables: %\{admin\_status\}, %\{oper\_status\}, %\{display\} | %\{admin\_status\} eq "up" and %\{oper\_status\} ne "up" | | +| WARNINGPORTSTATUS | Define the conditions to match for the status to be WARNING (Default: ''). You can use the following variables: %\{admin\_status\}, %\{oper\_status\}, %\{display\} | | | +| EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). Toutes les options sont listées [ici](#options-disponibles). | --verbose | | | Macro | Description | Valeur par défaut | Obligatoire | |:-------------|:-------------------------------------------------------------------------------------------------------------------------------------------------|:------------------|:-----------:| +| UNIT | Select the time unit for thresholds. May be 's' for seconds, 'm' for minutes, 'h' for hours, 'd' for days, 'w' for weeks. Default is seconds | | | | WARNING | Warning threshold | | | | CRITICAL | Critical threshold | | | | EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). Toutes les options sont listées [ici](#options-disponibles). | --check-overload | | @@ -428,36 +432,26 @@ telle que celle-ci (remplacez les valeurs d'exemple par les vôtres) : ```bash /usr/lib/centreon/plugins/centreon_aruba_aoscx_snmp.pl \ - --plugin=network::aruba::aoscx::snmp::plugin \ - --mode=vsf \ - --hostname=10.30.2.114 \ - --snmp-version='2c' \ - --snmp-community='aruba_ro' \ - --warning-cpu-utilization='90' \ - --critical-cpu-utilization='95' \ - --verbose + --plugin=network::aruba::aoscx::snmp::plugin \ + --mode=spanning-tree \ + --hostname=10.0.0.1 \ + --snmp-version='2c' \ + --snmp-community='my-snmp-community' \ + --snmp-username='username' \ + --authpassphrase='' \ + --authprotocol='' \ + --privpassphrase='' \ + --privprotocol='' \ + --filter-port='.*' \ + --warning-status='' \ + --critical-status='%\{state\} =~ /blocking|broken/' \ + --verbose ``` La commande devrait retourner un message de sortie similaire à : ```bash -OK: vsf operational status: no_split - All stack members are ok | '1#member.cpu.utilization.percentage'=16.00%;0:90;0:95;0;100 '1#member.memory.usage.percentage'=24.00%;;;0;100 '2#member.cpu.utilization.percentage'=4.00%;0:90;0:95;0;100 '2#member.memory.usage.percentage'=14.00%;;;0;100 '3#member.cpu.utilization.percentage'=4.00%;0:90;0:95;0;100 '3#member.memory.usage.percentage'=8.00%;;;0;100 '4#member.cpu.utilization.percentage'=4.00%;0:90;0:95;0;100 '4#member.memory.usage.percentage'=8.00%;;;0;100 -checking stack member '1' - role: master [status: ready] - cpu usage: 16.00% - memory used: 24.00 % -checking stack member '2' - role: standby [status: ready] - cpu usage: 4.00% - memory used: 14.00 % -checking stack member '3' - role: member [status: ready] - cpu usage: 4.00% - memory used: 8.00 % -checking stack member '4' - role: member [status: ready] - cpu usage: 4.00% - memory used: 8.00 % +OK: All spanning trees are ok ``` ### Diagnostic des erreurs communes @@ -488,8 +482,8 @@ Le plugin apporte les modes suivants : | cpu [[code](https://github.com/centreon/centreon-plugins/blob/develop/src/network/aruba/aoscx/snmp/mode/cpu.pm)] | Net-Aruba-Aoscx-Cpu-SNMP-custom | | hardware [[code](https://github.com/centreon/centreon-plugins/blob/develop/src/network/aruba/aoscx/snmp/mode/hardware.pm)] | Net-Aruba-Aoscx-Hardware-SNMP-custom | | interfaces [[code](https://github.com/centreon/centreon-plugins/blob/develop/src/snmp_standard/mode/interfaces.pm)] | Net-Aruba-Aoscx-Interfaces-SNMP-custom | -| list-interfaces [[code](https://github.com/centreon/centreon-plugins/blob/develop/src/snmp_standard/mode/listinterfaces.pm)] | Used for service discovery | -| list-spanning-trees [[code](https://github.com/centreon/centreon-plugins/blob/develop/src/snmp_standard/mode/listspanningtrees.pm)] | Used for service discovery | +| list-interfaces [[code](https://github.com/centreon/centreon-plugins/blob/develop/src/snmp_standard/mode/listinterfaces.pm)] | Utilisé pour la découverte de services | +| list-spanning-trees [[code](https://github.com/centreon/centreon-plugins/blob/develop/src/snmp_standard/mode/listspanningtrees.pm)] | Utilisé pour la découverte de services | | memory [[code](https://github.com/centreon/centreon-plugins/blob/develop/src/network/aruba/aoscx/snmp/mode/memory.pm)] | Net-Aruba-Aoscx-Memory-SNMP-custom | | spanning-tree [[code](https://github.com/centreon/centreon-plugins/blob/develop/src/snmp_standard/mode/spanningtree.pm)] | Net-Aruba-Aoscx-SpanningTree-SNMP-custom | | stack [[code](https://github.com/centreon/centreon-plugins/blob/develop/src/network/aruba/aoscx/snmp/mode/stack.pm)] | Net-Aruba-Aoscx-Stack-SNMP-custom | @@ -503,66 +497,67 @@ Le plugin apporte les modes suivants : Les options génériques sont listées ci-dessous : -| 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 ok, 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\[,\[\\],\[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\[,\[\\],\[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\[,\[\\],\[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,\,calculation\[,\[\\],\[min\],\[max\]\] regex: regular expression \: 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 \ (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~replacement~modifier Most commonly used modifiers are i (case insensitive) and g (replace all occurrences). Example: adding --change-short-output='OK\~Up\~gi' will replace all occurrences of 'OK', 'ok', 'Ok' or 'oK' with 'Up' | -| --change-short-output | Modify the short/long output that is returned by the plugin. Syntax: --change-short-output=pattern~replacement~modifier Most commonly used modifiers are i (case insensitive) and g (replace all occurrences). Example: adding --change-short-output='OK\~Up\~gi' will replace all occurrences of 'OK', 'ok', 'Ok' or 'oK' with 'Up' | -| --change-long-output | Modify the short/long output that is returned by the plugin. Syntax: --change-short-output=pattern~replacement~modifier Most commonly used modifiers are i (case insensitive) and g (replace all occurrences). Example: adding --change-short-output='OK\~Up\~gi' will replace all occurrences of 'OK', 'ok', 'Ok' or 'oK' with 'Up' | -| --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\. =cut | +| 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 get-next 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 ok, 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. | +| --show-password | By default, sensitive information in command lines is hidden in debug output and replaced with `***` (however, debug logs may still display sensitive information). Using the C option will display the passwords in plain text. | +| --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\[,\[\\],\[min\],\[max\]\] Common examples: onvert 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\[,\[\\],\[min\],\[max\]\] Common examples: onvert 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\[,\[\\],\[min\],\[max\]\] Common examples: onvert 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,\,calculation\[,\[\\],\[min\],\[max\]\] regex: regular expression \: 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 \ (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: um 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~replacement~modifier Most commonly used modifiers are i (case insensitive) and g (replace all occurrences). Example: adding --change-short-output='OK~Up~gi' will replace all occurrences of 'OK', 'ok', 'Ok' or 'oK' with 'Up' | +| --change-short-output | Modify the short/long output that is returned by the plugin. Syntax: --change-short-output=pattern~replacement~modifier Most commonly used modifiers are i (case insensitive) and g (replace all occurrences). Example: adding --change-short-output='OK~Up~gi' will replace all occurrences of 'OK', 'ok', 'Ok' or 'oK' with 'Up' | +| --change-long-output | Modify the short/long output that is returned by the plugin. Syntax: --change-short-output=pattern~replacement~modifier Most commonly used modifiers are i (case insensitive) and g (replace all occurrences). Example: adding --change-short-output='OK~Up~gi' will replace all occurrences of 'OK', 'ok', 'Ok' or 'oK' with 'Up' | +| --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'. \. | #### Options des modes @@ -571,165 +566,217 @@ Les options disponibles pour chaque modèle de services sont listées ci-dessous -| Option | Description | -|:-------------------------|:------------------------------------------------------------------------------------------------------------------------------| -| --filter-counters | Only display some counters (regexp can be used). Example to check SSL connections only : --filter-counters='^xxxx\|yyyy$' | -| --filter-module-name | Filter modules by name (can be a regexp). | -| --warning-* --critical-* | Thresholds. Can be: 'cpu-utilization' (%). | +| Option | Description | +|:-------------------------|:--------------------------------------------------------------------------------------------------------------------------| +| --filter-counters | Only display some counters (regexp can be used). Example to check SSL connections only : --filter-counters='^xxxx\|yyyy$' | +| --warning-xxx | Warning threshold. | +| --critical-xxx | Critical threshold. | +| --filter-module-name | Filter modules by name (can be a regexp). | +| --warning-* --critical-* | Thresholds. Can be: 'cpu-utilization' (%). | -| Option | Description | -|:---------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| --component | Which component to check (default: '.*'). Can be: 'psu', 'temperature', 'fan', 'fantray'. | -| --filter | Exclude the items given as a comma-separated list (example: --filter=psu). You can also exclude items from specific instances: --filter=fan,1.1 | -| --absent-problem | Return an error if a component is not 'present' (default is skipping). It can be set globally or for a specific instance: --absent-problem='component\_name' or --absent-problem='component\_name,instance\_value'. | -| --no-component | Define the expected status if no components are found (default: critical). | -| --threshold-overload | Use this option to override the status returned by the plugin when the status label matches a regular expression (syntax: section,status,regexp). Example: --threshold-overload='fan,WARNING,string' | -| --warning | Set warning threshold for 'temperature', 'fan.speed', 'psu.power' (syntax: section,\[instance,\]status,regexp) Example: --warning='temperature,.*,30' --warning='fan.speed,.*,1000' | -| --critical | Set critical threshold for 'temperature', 'fan.speed', 'psu.power' (syntax: section,\[instance,\]status,regexp) Example: --critical='temperature,.*,40' | -| --warning-count-* | Define the warning threshold for the number of components of one type (replace '*' with the component type). | -| --critical-count-* | Define the critical threshold for the number of components of one type (replace '*' with the component type). | +| Option | Description | +|:---------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| --component | Which component to check (default: '.*'). Can be: `psu`, `temperature`, `fan`, `fantray`. | +| --filter | Exclude the items given as a comma-separated list (example: --filter=psu). You can also exclude items from specific instances: --filter=fan,1.1 | +| --absent-problem | Return an error if a component is not 'present' (default is skipping). It can be set globally or for a specific instance: --absent-problem='component\_name' or --absent-problem='component\_name,instance\_value'. | +| --no-component | Define the expected status if no components are found (default: critical). | +| --threshold-overload | Use this option to override the status returned by the plugin when the status label matches a regular expression (syntax: section,status,regexp). Example: --threshold-overload='fan,WARNING,string' | +| --warning | Set warning threshold for 'temperature', 'fan.speed', 'psu.power' (syntax: section,\[instance,\]status,regexp) Example: --warning='temperature,.*,30' --warning='fan.speed,.*,1000' | +| --critical | Set critical threshold for 'temperature', 'fan.speed', 'psu.power' (syntax: section,\[instance,\]status,regexp) Example: --critical='temperature,.*,40' | +| --warning-count-* | Define the warning threshold for the number of components of one type (replace '*' with the component type). | +| --critical-count-* | Define the critical threshold for the number of components of one type (replace '*' with the component type). | -| Option | Description | -|:------------------------------------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| --filter-counters | Only display some counters (regexp can be used). Example to check SSL connections only : --filter-counters='^xxxx\|yyyy$' | -| --memcached | Memcached server to use (only one server). | -| --redis-server | Redis server to use (only one server). Syntax: address\[:port\] | -| --redis-attribute | Set Redis Options (--redis-attribute="cnx\_timeout=5"). | -| --redis-db | Set Redis database index. | -| --failback-file | Fall back on a local file if Redis connection fails. | -| --memexpiration | Time to keep data in seconds (default: 86400). | -| --statefile-dir | Define the cache directory (default: '/var/lib/centreon/centplugins'). | -| --statefile-suffix | Define a suffix to customize the statefile name (default: ''). | -| --statefile-concat-cwd | If used with the '--statefile-dir' option, the latter's value will be used as a sub-directory of the current working directory. Useful on Windows when the plugin is compiled, as the file system and permissions are different from Linux. | -| --statefile-format | Define the format used to store the cache. Available formats: 'dumper', 'storable', 'json' (default). | -| --statefile-key | Define the key to encrypt/decrypt the cache. | -| --statefile-cipher | Define the cipher algorithm to encrypt the cache (default: 'AES'). | -| --add-global | Check global port statistics (by default if no --add-* option is set). | -| --add-status | Check interface status. | -| --add-duplex-status | Check duplex status (with --warning-status and --critical-status). | -| --add-traffic | Check interface traffic. | -| --add-errors | Check interface errors. | -| --add-cast | Check interface cast. | -| --add-speed | Check interface speed. | -| --add-volume | Check interface data volume between two checks (not supposed to be graphed, useful for BI reporting). | -| --check-metrics | If the expression is true, metrics are checked (default: '%\{opstatus\} eq "up"'). | -| --warning-status | Define the conditions to match for the status to be WARNING. You can use the following variables: %\{admstatus\}, %\{opstatus\}, %\{duplexstatus\}, %\{display\} | -| --critical-status | Define the conditions to match for the status to be CRITICAL (default: '%\{admstatus\} eq "up" and %\{opstatus\} ne "up"'). You can use the following variables: %\{admstatus\}, %\{opstatus\}, %\{duplexstatus\}, %\{display\} | -| --warning-* --critical-* | Thresholds. Can be: 'total-port', 'total-admin-up', 'total-admin-down', 'total-oper-up', 'total-oper-down', 'in-traffic', 'out-traffic', 'in-error', 'in-discard', 'out-error', 'out-discard', 'in-ucast', 'in-bcast', 'in-mcast', 'out-ucast', 'out-bcast', 'out-mcast', 'speed' (b/s). | -| --units-traffic | Units of thresholds for the traffic (default: 'percent\_delta') ('percent\_delta', 'bps', 'counter'). | -| --units-errors | Units of thresholds for errors/discards (default: 'percent\_delta') ('percent\_delta', 'percent', 'delta', 'deltaps', 'counter'). | -| --units-cast | Units of thresholds for communication types (default: 'percent\_delta') ('percent\_delta', 'percent', 'delta', 'deltaps', 'counter'). | -| --nagvis-perfdata | Display traffic perfdata to be compatible with NagVis widget. | -| --interface | Check only the interfaces with the specified IDs (OID indexes, e.g.: 1,2,...). If empty, all interfaces will be monitored. To filter on interface names, see --name. | -| --name | With this option, the interfaces will be filtered by name (given in option --interface) instead of OID index. The name matching mode supports regular expressions. | -| --regex-id | With this option, interface IDs will be filtered using the --interface parameter as a regular expression instead of a list of IDs. | -| --speed | Set interface speed for incoming/outgoing traffic (in Mb). | -| --speed-in | Set interface speed for incoming traffic (in Mb). | -| --speed-out | Set interface speed for outgoing traffic (in Mb). | -| --map-speed-dsl | Get interface speed configuration for interfaces of type 'ADSL' and 'VDSL2'. Syntax: --map-speed-dsl=interface-src-name,interface-dsl-name E.g: --map-speed-dsl=Et0.835,Et0-vdsl2 | -| --force-counters64 | Force to use 64 bits counters only. Can be used to improve performance. | -| --force-counters32 | Force to use 32-bit counters (even with SNMP versions 2c and 3). To use when 64 bits counters are buggy. | -| --reload-cache-time | Time in minutes before reloading cache file (default: 180). | -| --oid-filter | Define the OID to be used to filter interfaces (default: ifName) (values: ifDesc, ifAlias, ifName, IpAddr). | -| --oid-display | Define the OID that will be used to name the interfaces (default: ifName) (values: ifDesc, ifAlias, ifName, IpAddr). | -| --oid-extra-display | Add an OID to display. | -| --display-transform-src --display-transform-dst | Modify the interface name displayed by using a regular expression. Example: adding --display-transform-src='eth' --display-transform-dst='ens' will replace all occurrences of 'eth' with 'ens' | -| --show-cache | Display cache interface data. | +| Option | Description | +|:------------------------------------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| --filter-counters | Only display some counters (regexp can be used). Example to check SSL connections only : --filter-counters='^xxxx\|yyyy$' | +| --warning-xxx | Warning threshold. | +| --critical-xxx | Critical threshold. | +| --memcached | Memcached server to use (only one server). | +| --redis-server | Redis server to use (only one server). Syntax: address\[:port\] | +| --redis-attribute | Set Redis Options (--redis-attribute="cnx\_timeout=5"). | +| --redis-db | Set Redis database index. | +| --failback-file | Fall back on a local file if Redis connection fails. | +| --memexpiration | Time to keep data in seconds (default: 86400). | +| --statefile-dir | Define the cache directory (default: '/var/lib/centreon/centplugins'). | +| --statefile-suffix | Define a suffix to customize the statefile name (default: ''). | +| --statefile-concat-cwd | If used with the '--statefile-dir' option, the latter's value will be used as a sub-directory of the current working directory. Useful on Windows when the plugin is compiled, as the file system and permissions are different from Linux. | +| --statefile-format | Define the format used to store the cache. Available formats: 'dumper', 'storable', 'json' (default). | +| --statefile-key | Define the key to encrypt/decrypt the cache. | +| --statefile-cipher | Define the cipher algorithm to encrypt the cache (default: 'AES'). | +| --add-global | Check global port statistics (by default if no --add-* option is set). | +| --add-status | Check interface status. | +| --add-duplex-status | Check duplex status (with --warning-status and --critical-status). | +| --add-traffic | Check interface traffic. | +| --add-errors | Check interface errors. | +| --add-cast | Check interface cast. | +| --add-speed | Check interface speed. | +| --add-volume | Check interface data volume between two checks (not supposed to be graphed, useful for BI reporting). | +| --check-metrics | If the expression is true, metrics are checked (default: '%\{opstatus\} eq "up"'). | +| --warning-status | Define the conditions to match for the status to be WARNING. You can use the following variables: %\{admstatus\}, %\{opstatus\}, %\{duplexstatus\}, %\{display\} | +| --critical-status | Define the conditions to match for the status to be CRITICAL (default: '%\{admstatus\} eq "up" and %\{opstatus\} ne "up"'). You can use the following variables: %\{admstatus\}, %\{opstatus\}, %\{duplexstatus\}, %\{display\} | +| --warning-total-port | Thresholds. | +| --critical-total-port | Thresholds. | +| --warning-total-admin-up | Thresholds. | +| --critical-total-admin-up | Thresholds. | +| --warning-total-admin-down | Thresholds. | +| --critical-total-admin-down | Thresholds. | +| --warning-total-oper-up | Thresholds. | +| --critical-total-oper-up | Thresholds. | +| --warning-total-oper-down | Thresholds. | +| --critical-total-oper-down | Thresholds. | +| --warning-in-traffic | Thresholds. | +| --critical-in-traffic | Thresholds. | +| --warning-out-traffic | Thresholds. | +| --critical-out-traffic | Thresholds. | +| --warning-in-error | Thresholds. | +| --critical-in-error | Thresholds. | +| --warning-in-discard | Thresholds. | +| --critical-in-discard | Thresholds. | +| --warning-out-error | Thresholds. | +| --critical-out-error | Thresholds. | +| --warning-out-discard | Thresholds. | +| --critical-out-discard | Thresholds. | +| --warning-in-ucast | Thresholds. | +| --critical-in-ucast | Thresholds. | +| --warning-in-bcast | Thresholds. | +| --critical-in-bcast | Thresholds. | +| --warning-in-mcast | Thresholds. | +| --critical-in-mcast | Thresholds. | +| --warning-out-ucast | Thresholds. | +| --critical-out-ucast | Thresholds. | +| --warning-out-bcast | Thresholds. | +| --critical-out-bcast | Thresholds. | +| --warning-out-mcast | Thresholds. | +| --critical-out-mcast | Thresholds. | +| --warning-speed | Thresholds in b/s. | +| --critical-speed | Thresholds in b/s. | +| --units-traffic | Units of thresholds for the traffic (default: 'percent\_delta') ('percent\_delta', 'bps', 'counter'). | +| --units-errors | Units of thresholds for errors/discards (default: 'percent\_delta') ('percent\_delta', 'delta', 'deltaps', 'counter'). | +| --units-cast | Units of thresholds for communication types (default: 'percent\_delta') ('percent\_delta', 'percent', 'delta', 'deltaps', 'counter'). | +| --nagvis-perfdata | Display traffic perfdata to be compatible with NagVis widget. | +| --interface | Check only the interfaces with the specified IDs (OID indexes, e.g.: 1,2,...). If empty, all interfaces will be monitored. To filter on interface names, see --name. | +| --name | With this option, the interfaces will be filtered by name (given in option --interface) instead of OID index. The name matching mode supports regular expressions. | +| --regex-id | With this option, interface IDs will be filtered using the --interface parameter as a regular expression instead of a list of IDs. | +| --speed | Set interface speed for incoming/outgoing traffic (in Mb). | +| --speed-in | Set interface speed for incoming traffic (in Mb). | +| --speed-out | Set interface speed for outgoing traffic (in Mb). | +| --map-speed-dsl | Get interface speed configuration for interfaces of type 'ADSL' and 'VDSL2'. Syntax: --map-speed-dsl=interface-src-name,interface-dsl-name E.g: --map-speed-dsl=Et0.835,Et0-vdsl2 | +| --force-counters64 | Force to use 64 bits counters only. Can be used to improve performance. | +| --force-counters32 | Force to use 32-bit counters (even with SNMP versions 2c and 3). To use when 64 bits counters are buggy. | +| --reload-cache-time | Time in minutes before reloading cache file (default: 180). | +| --oid-filter | Define the OID to be used to filter interfaces (default: ifName) (values: ifDesc, ifAlias, ifName, IpAddr). | +| --oid-display | Define the OID that will be used to name the interfaces (default: ifName) (values: ifDesc, ifAlias, ifName, IpAddr). | +| --oid-extra-display | Add an OID to display. | +| --display-transform-src --display-transform-dst | Modify the interface name displayed by using a regular expression. Example: adding --display-transform-src='eth' --display-transform-dst='ens' will replace all occurrences of 'eth' with 'ens' | +| --show-cache | Display cache interface data. | +| --no-cache-lock | Set to disable locking when accessing cache. | -| Option | Description | -|:-------------------------|:------------------------------------------------------------------------------------------------------------------------------| -| --filter-counters | Only display some counters (regexp can be used). Example to check SSL connections only : --filter-counters='^xxxx\|yyyy$' | -| --filter-module-name | Filter modules by name (can be a regexp). | -| --warning-* --critical-* | Thresholds. Can be: 'memory-usage-prct' (%). | +| Option | Description | +|:-------------------------|:--------------------------------------------------------------------------------------------------------------------------| +| --filter-counters | Only display some counters (regexp can be used). Example to check SSL connections only : --filter-counters='^xxxx\|yyyy$' | +| --warning-xxx | Warning threshold. | +| --critical-xxx | Critical threshold. | +| --filter-module-name | Filter modules by name (can be a regexp). | +| --warning-* --critical-* | Thresholds. Can be: 'memory-usage-prct' (%). | -| Option | Description | -|:------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| --filter-counters | Only display some counters (regexp can be used). Example to check SSL connections only : --filter-counters='^xxxx\|yyyy$' | -| --filter-port | Filter on port description (can be a regexp). | -| --warning-status | Define the conditions to match for the status to be WARNING. You can use the following variables: %\{state\}, %\{op\_status\}, %\{admin\_status\}, %\{port\}, %\{index\}. | -| --critical-status | Define the conditions to match for the status to be CRITICAL (default: '%\{op\_status\} =~ /up/ && %\{state\} =~ /blocking\|broken/'). You can use the following variables: %\{state\}, %\{op\_status\}, %\{admin\_status\}, %\{port\}, %\{index\}. | +| Option | Description | +|:------------------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| --filter-counters | Only display some counters (regexp can be used). Example to check SSL connections only : --filter-counters='^xxxx\|yyyy$' | +| --warning-xxx | Warning threshold. | +| --critical-xxx | Critical threshold. | +| --filter-port | Filter on port description (can be a regexp). | +| --warning-status | Define the conditions to match for the status to be WARNING. You can use the following variables: %\{state\}, %\{op\_status\}, %\{admin\_status\}, %\{port\}, %\{index\}. | +| --critical-status | Define the conditions to match for the status to be CRITICAL (default: '%\{op\_status\} =~ /up/ && %\{state\} =~ /blocking\|broken/'). You can use the following variables: %\{state\}, %\{op\_status\}, %\{admin\_status\}, %\{port\}, %\{index\}. | -| Option | Description | -|:-------------------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| --filter-counters | Only display some counters (regexp can be used). Example to check SSL connections only : --filter-counters='^xxxx\|yyyy$' | -| --unknown-member-status | Define the conditions to match for the status to be UNKNOWN (Default: ''). You can use the following variables: %\{role\}, %\{roleLast\}, %\{state\}, %\{stateLast\} | -| --warning-member-status | Define the conditions to match for the status to be WARNING (Default: ''). You can use the following variables: %\{role\}, %\{roleLast\}, %\{state\}, %\{stateLast\} | -| --critical-member-status | Define the conditions to match for the status to be CRITICAL (Default: '%\{role\} ne %\{roleLast\}'). You can use the following variables: %\{role\}, %\{roleLast\}, %\{state\}, %\{stateLast\} | -| --unknown-port-status | Define the conditions to match for the status to be UNKNOWN (Default: ''). You can use the following variables: %\{admin\_status\}, %\{oper\_status\}, %\{display\} | -| --warning-port-status | Define the conditions to match for the status to be WARNING (Default: ''). You can use the following variables: %\{admin\_status\}, %\{oper\_status\}, %\{display\} | -| --critical-port-status | Define the conditions to match for the status to be CRITICAL (Default: '%\{admin\_status\} eq "up" and %\{oper\_status\} ne "up"'). You can use the following variables: %\{admin\_status\}, %\{oper\_status\}, %\{display\} | +| Option | Description | +|:-------------------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| --filter-counters | Only display some counters (regexp can be used). Example to check SSL connections only : --filter-counters='^xxxx\|yyyy$' | +| --warning-xxx | Warning threshold. | +| --critical-xxx | Critical threshold. | +| --unknown-member-status | Define the conditions to match for the status to be UNKNOWN (Default: ''). You can use the following variables: %\{role\}, %\{roleLast\}, %\{state\}, %\{stateLast\} | +| --warning-member-status | Define the conditions to match for the status to be WARNING (Default: ''). You can use the following variables: %\{role\}, %\{roleLast\}, %\{state\}, %\{stateLast\} | +| --critical-member-status | Define the conditions to match for the status to be CRITICAL (Default: '%\{role\} ne %\{roleLast\}'). You can use the following variables: %\{role\}, %\{roleLast\}, %\{state\}, %\{stateLast\} | +| --unknown-port-status | Define the conditions to match for the status to be UNKNOWN (Default: ''). You can use the following variables: %\{admin\_status\}, %\{oper\_status\}, %\{display\} | +| --warning-port-status | Define the conditions to match for the status to be WARNING (Default: ''). You can use the following variables: %\{admin\_status\}, %\{oper\_status\}, %\{display\} | +| --critical-port-status | Define the conditions to match for the status to be CRITICAL (Default: '%\{admin\_status\} eq "up" and %\{oper\_status\} ne "up"'). You can use the following variables: %\{admin\_status\}, %\{oper\_status\}, %\{display\} | -| Option | Description | -|:-----------------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| --filter-counters | Only display some counters (regexp can be used). Example to check SSL connections only : --filter-counters='^xxxx\|yyyy$' | -| --memcached | Memcached server to use (only one server). | -| --redis-server | Redis server to use (only one server). Syntax: address\[:port\] | -| --redis-attribute | Set Redis Options (--redis-attribute="cnx\_timeout=5"). | -| --redis-db | Set Redis database index. | -| --failback-file | Fall back on a local file if Redis connection fails. | -| --memexpiration | Time to keep data in seconds (default: 86400). | -| --statefile-dir | Define the cache directory (default: '/var/lib/centreon/centplugins'). | -| --statefile-suffix | Define a suffix to customize the statefile name (default: ''). | -| --statefile-concat-cwd | If used with the '--statefile-dir' option, the latter's value will be used as a sub-directory of the current working directory. Useful on Windows when the plugin is compiled, as the file system and permissions are different from Linux. | -| --statefile-format | Define the format used to store the cache. Available formats: 'dumper', 'storable', 'json' (default). | -| --statefile-key | Define the key to encrypt/decrypt the cache. | -| --statefile-cipher | Define the cipher algorithm to encrypt the cache (default: 'AES'). | -| --warning-uptime | Warning threshold. | -| --critical-uptime | Critical threshold. | -| --add-sysdesc | Display system description. | -| --force-oid | Can choose your OID (numeric format only). | -| --check-overload | Uptime counter limit is 4294967296 and overflow. With that option, we manage the counter going back. But there is a few chance we can miss a reboot. | -| --reboot-window | To be used with check-overload option. Time in milliseconds (default: 5000) You increase the chance of not missing a reboot if you decrease that value. | -| --unit | Select the time unit for thresholds. May be 's' for seconds, 'm' for minutes, 'h' for hours, 'd' for days, 'w' for weeks. Default is seconds. | +| Option | Description | +|:-----------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| --filter-counters | Only display some counters (regexp can be used). Example to check SSL connections only : --filter-counters='^xxxx\|yyyy$' | +| --warning-xxx | Warning threshold. | +| --critical-xxx | Critical threshold. | +| --memcached | Memcached server to use (only one server). | +| --redis-server | Redis server to use (only one server). Syntax: address\[:port\] | +| --redis-attribute | Set Redis Options (--redis-attribute="cnx\_timeout=5"). | +| --redis-db | Set Redis database index. | +| --failback-file | Fall back on a local file if Redis connection fails. | +| --memexpiration | Time to keep data in seconds (default: 86400). | +| --statefile-dir | Define the cache directory (default: '/var/lib/centreon/centplugins'). | +| --statefile-suffix | Define a suffix to customize the statefile name (default: ''). | +| --statefile-concat-cwd | If used with the '--statefile-dir' option, the latter's value will be used as a sub-directory of the current working directory. Useful on Windows when the plugin is compiled, as the file system and permissions are different from Linux. | +| --statefile-format | Define the format used to store the cache. Available formats: 'dumper', 'storable', 'json' (default). | +| --statefile-key | Define the key to encrypt/decrypt the cache. | +| --statefile-cipher | Define the cipher algorithm to encrypt the cache (default: 'AES'). | +| --warning-uptime | Warning threshold. | +| --critical-uptime | Critical threshold. | +| --add-sysdesc | Display system description. | +| --force-oid | Can choose your OID (numeric format only). | +| --check-overload | Uptime counter limit is 4294967296 and overflow. With that option, we manage the counter going back. But there is a few chance we can miss a reboot. | +| --reboot-window | To be used with check-overload option. Time in milliseconds (default: 5000) You increase the chance of not missing a reboot if you decrease that value. | +| --unit | Select the time unit for thresholds. May be 's' for seconds, 'm' for minutes, 'h' for hours, 'd' for days, 'w' for weeks. Default is seconds. | -| Option | Description | -|:-------------------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| --filter-counters | Only display some counters (regexp can be used). Example to check SSL connections only : --filter-counters='^xxxx\|yyyy$' | -| --unknown-status | Define the conditions to match for the status to be UNKNOWN. You can use the following variables: %\{status\} | -| --warning-status | Define the conditions to match for the status to be WARNING. You can use the following variables: %\{status\} | -| --critical-status | Define the conditions to match for the status to be CRITICAL (default: '%\{status\} !~ /no\_split/i'). You can use the following variables: %\{status\} | -| --unknown-member-status | Define the conditions to match for the status to be UNKNOWN. You can use the following variables: %\{status\}, %\{role\}, %\{roleLast\}, %\{id\} | -| --warning-member-status | Define the conditions to match for the status to be WARNING. You can use the following variables: %\{status\}, %\{role\}, %\{roleLast\}, %\{id\} | -| --critical-member-status | Define the conditions to match for the status to be CRITICAL (default: '%\{role\} ne %\{roleLast\} \|\| %\{status\} !~ /ready\|booting/i'). You can use the following variables: %\{status\}, %\{role\}, %\{roleLast\}, %\{id\} | -| --warning-* --critical-* | Thresholds. Can be: 'members-total', 'memory-usage-prct', 'cpu-utilization'. | +| Option | Description | +|:-------------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| --filter-counters | Only display some counters (regexp can be used). Example to check SSL connections only : --filter-counters='^xxxx\|yyyy$' | +| --warning-xxx | Warning threshold. | +| --critical-xxx | Critical threshold. | +| --unknown-status | Define the conditions to match for the status to be UNKNOWN. You can use the following variables: %\{status\} | +| --warning-status | Define the conditions to match for the status to be WARNING. You can use the following variables: %\{status\} | +| --critical-status | Define the conditions to match for the status to be CRITICAL (default: '%\{status\} !~ /no\_split/i'). You can use the following variables: %\{status\} | +| --unknown-member-status | Define the conditions to match for the status to be UNKNOWN. You can use the following variables: %\{status\}, %\{role\}, %\{roleLast\}, %\{id\} | +| --warning-member-status | Define the conditions to match for the status to be WARNING. You can use the following variables: %\{status\}, %\{role\}, %\{roleLast\}, %\{id\} | +| --critical-member-status | Define the conditions to match for the status to be CRITICAL (default: '%\{role\} ne %\{roleLast\} \|\| %\{status\} !~ /ready\|booting/i'). You can use the following variables: %\{status\}, %\{role\}, %\{roleLast\}, %\{id\} | +| --warning-* --critical-* | Thresholds. Can be: 'members-total', 'memory-usage-prct', 'cpu-utilization'. | -| Option | Description | -|:----------------------------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| --filter-counters | Only display some counters (regexp can be used). Example to check SSL connections only : --filter-counters='^xxxx\|yyyy$' | -| --unknown-device-status | Define the conditions to match for the status to be UNKNOWN. You can use the following variables: %\{role\}, %\{config\_sync\} | -| --warning-device-status | Define the conditions to match for the status to be WARNING. You can use the following variables: %\{role\}, %\{config\_sync\} | -| --critical-device-status | Define the conditions to match for the status to be CRITICAL. You can use the following variables: %\{role\}, %\{config\_sync\} | -| --unknown-isl-status | Define the conditions to match for the status to be UNKNOWN. You can use the following variables: %\{isl\_status\} | -| --warning-isl-status | Define the conditions to match for the status to be WARNING. You can use the following variables: %\{isl\_status\} | -| --critical-isl-status | Define the conditions to match for the status to be CRITICAL (default: '%\{isl\_status\} =~ /outSync/'). You can use the following variables: %\{isl\_status\} | -| --unknown-keepalive-status | Define the conditions to match for the status to be UNKNOWN. You can use the following variables: %\{keepalive\_status\} | -| --warning-keepalive-status | Define the conditions to match for the status to be WARNING. You can use the following variables: %\{keepalive\_status\} | -| --critical-keepalive-status | Define the conditions to match for the status to be CRITICAL (default: '%\{keepalive\_status\} =~ /outofSyncEstablished\|failed/'). You can use the following variables: %\{keepalive\_status\} | -| --warning-* --critical-* | Thresholds. Can be: 'isl-packets-in', 'isl-packets-out', 'keepalive-packets-in', 'keepalive-packets-out'. | +| Option | Description | +|:----------------------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| --filter-counters | Only display some counters (regexp can be used). Example to check SSL connections only : --filter-counters='^xxxx\|yyyy$' | +| --warning-xxx | Warning threshold. | +| --critical-xxx | Critical threshold. | +| --unknown-device-status | Define the conditions to match for the status to be UNKNOWN. You can use the following variables: %\{role\}, %\{config\_sync\} | +| --warning-device-status | Define the conditions to match for the status to be WARNING. You can use the following variables: %\{role\}, %\{config\_sync\} | +| --critical-device-status | Define the conditions to match for the status to be CRITICAL. You can use the following variables: %\{role\}, %\{config\_sync\} | +| --unknown-isl-status | Define the conditions to match for the status to be UNKNOWN. You can use the following variables: %\{isl\_status\} | +| --warning-isl-status | Define the conditions to match for the status to be WARNING. You can use the following variables: %\{isl\_status\} | +| --critical-isl-status | Define the conditions to match for the status to be CRITICAL (default: '%\{isl\_status\} =~ /outSync/'). You can use the following variables: %\{isl\_status\} | +| --unknown-keepalive-status | Define the conditions to match for the status to be UNKNOWN. You can use the following variables: %\{keepalive\_status\} | +| --warning-keepalive-status | Define the conditions to match for the status to be WARNING. You can use the following variables: %\{keepalive\_status\} | +| --critical-keepalive-status | Define the conditions to match for the status to be CRITICAL (default: '%\{keepalive\_status\} =~ /outofSyncEstablished\|failed/'). You can use the following variables: %\{keepalive\_status\} | +| --warning-* --critical-* | Thresholds. Can be: 'isl-packets-in', 'isl-packets-out', 'keepalive-packets-in', 'keepalive-packets-out'. | diff --git a/i18n/fr/docusaurus-plugin-content-docs-pp/current/integrations/plugin-packs/procedures/network-aruba-instant-snmp.md b/i18n/fr/docusaurus-plugin-content-docs-pp/current/integrations/plugin-packs/procedures/network-aruba-instant-snmp.md index 3fdd4e9d28e9..59dc83c408f7 100644 --- a/i18n/fr/docusaurus-plugin-content-docs-pp/current/integrations/plugin-packs/procedures/network-aruba-instant-snmp.md +++ b/i18n/fr/docusaurus-plugin-content-docs-pp/current/integrations/plugin-packs/procedures/network-aruba-instant-snmp.md @@ -5,9 +5,13 @@ title: Aruba Instant SNMP import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; -## Contenu du connecteur +## Dépendances du connecteur de supervision -> Depuis le rachat d'Aruba par HP, certaines MIB peuvent avoir changé. Si votre équipement Aruba n'est plus supervisé correctement par le connecteur Aruba, utilisez le connecteur [HP Procurve SNMP](network-switchs-hp-procurve-snmp.md). +Les connecteurs de supervision suivants sont automatiquement installés lors de l'installation du connecteur **Aruba Instant SNMP** +depuis la page **Configuration > Connecteurs > Connecteurs de supervision** : +* [Base Pack](./base-generic.md) + +## Contenu du pack ### Modèles @@ -23,8 +27,8 @@ Le connecteur apporte les modèles de service suivants | Alias | Modèle de service | Description | |:------------|:------------------------------------------|:----------------------------| -| Ap-Usage | Net-Aruba-Instant-Ap-Usage-SNMP-custom | Contrôle les points d'accès. | -| Ssid-Status | Net-Aruba-Instant-Ssid-Status-SNMP-custom | Contrôle le status des SSID. | +| Ap-Usage | Net-Aruba-Instant-Ap-Usage-SNMP-custom | Contrôle les points d'accès | +| Ssid-Status | Net-Aruba-Instant-Ssid-Status-SNMP-custom | Contrôle le status des SSID | > Les services listés ci-dessus sont créés automatiquement lorsque le modèle d'hôte **Net-Aruba-Instant-SNMP-custom** est utilisé. @@ -35,23 +39,23 @@ Le connecteur apporte les modèles de service suivants #### Découverte d'hôtes -| Nom de la règle | Description | -|:----------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| SNMP Agents | Discover your resources through an SNMP subnet scan. You need to install the [Generic SNMP](./applications-protocol-snmp.md) connector to get the discovery rule and create a template mapper for the **Net-Aruba-Instant-SNMP-custom** host template. | +| Nom de la règle | Description | +|:----------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| SNMP Agents | Découvre les ressources via un scan réseau SNMP. Installez le connecteur [Generic SNMP](./applications-protocol-snmp.md) pour obtenir la règle de découverte et créez un modificateur pour le modèle d'hôte **Net-Aruba-Instant-SNMP-custom**. | Rendez-vous sur la [documentation dédiée](/docs/monitoring/discovery/hosts-discovery) pour en savoir plus sur la découverte automatique d'hôtes. ### Métriques & statuts collectés -Voici le tableau des services pour ce connecteur, détaillant les métriques rattachées à chaque service. +Voici le tableau des services pour ce connecteur, détaillant les métriques et statuts rattachés à chaque service. -| Métrique | Unité | +| Nom | Unité | |:--------------------------------|:------| | accesspoints.total.count | count | -| *ap*#status | N/A | +| status | N/A | | *ap*#clients.current.count | count | | *ap*#cpu.utilization.percentage | % | | *ap*#memory.usage.bytes | B | @@ -61,18 +65,24 @@ Voici le tableau des services pour ce connecteur, détaillant les métriques rat -| Métrique | Unité | -|:--------------|:------| -| *ssid*#status | N/A | +| Nom | Unité | +|:-------|:------| +| status | N/A | ## Prérequis -La communauté SNMP doit être activée sur l'équipement en mode Read-only. +### Configuration SNMP + +L'agent SNMP doit être activé et configuré sur l'équipement. +Veuillez vous référer à la documentation officielle. +Il se peut que votre équipement nécessite qu'une liste d'adresses autorisées à l'interroger soit paramétrée. +Veillez à ce que les adresses des collecteurs Centreon y figurent bien. -La communication doit être possible sur le port UDP 161 depuis le collecteur Centreon vers la borne d'accès sans fil Aruba. +### Flux réseau +La communication doit être possible sur le port UDP 161 depuis le collecteur Centreon vers la ressource supervisée. ## Installer le connecteur de supervision @@ -170,12 +180,14 @@ yum install centreon-plugin-Network-Aruba-Instant-Snmp 2. Complétez les champs **Nom**, **Alias** & **IP Address/DNS** correspondant à votre ressource. 3. Appliquez le modèle d'hôte **Net-Aruba-Instant-SNMP-custom**. -> Si vous utilisez SNMP en version 3, vous devez configurer les paramètres spécifiques associés via la macro **SNMPEXTRAOPTIONS**. -> Plus d'informations dans la section [Troubleshooting SNMP](../getting-started/how-to-guides/troubleshooting-plugins.md#mapping-des-options-snmpv3). - -| Macro | Description | Valeur par défaut | Obligatoire | -|:-----------------|:-----------------------------------------------------------------------------------------------------|:------------------|:-----------:| -| SNMPEXTRAOPTIONS | Any extra option you may want to add to every command (a --verbose flag for example). Toutes les options sont listées [ici](#options-disponibles). | | | +| Macro | Description | Valeur par défaut | Obligatoire | +|:------------------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------|:------------------|:-----------:| +| SNMP_V3_USERNAME | SNMP v3 only: User name (`securityName`) | | | +| SNMP_V3_AUTH_PROTOCOL | SNMP v3 only: Authentication protocol: MD5\|SHA. Since net-snmp 5.9.1: SHA224\|SHA256\|SHA384\|SHA512 | | | +| SNMP_V3_PRIV_PROTOCOL | 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 | | | +| SNMP_V3_AUTH_PASSPHRASE | SNMP v3 only: Pass phrase hashed using the authentication protocol defined in the --authprotocol option | | | +| SNMP_V3_PRIV_PASSPHRASE | SNMP v3 only: Privacy pass phrase (`privPassword`) to encrypt messages using the protocol defined in the --privprotocol option | | | +| SNMPEXTRAOPTIONS | Any extra option you may want to add to every command (a --verbose flag for example). Toutes les options sont listées [ici](#options-disponibles). | | | 4. [Déployez la configuration](/docs/monitoring/monitoring-servers/deploying-a-configuration). L'hôte apparaît dans la liste des hôtes supervisés, et dans la page **Statut des ressources**. La commande envoyée par le connecteur est indiquée dans le panneau de détails de l'hôte : celle-ci montre les valeurs des macros. @@ -187,32 +199,32 @@ yum install centreon-plugin-Network-Aruba-Instant-Snmp -| Macro | Description | Valeur par défaut | Obligatoire | -|:---------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------|:-------------------|:-----------:| -| FILTERNAME | Filter access point name (can be a regexp) | | | -| WARNINGCLIENTS | Thresholds | | | -| CRITICALCLIENTS | Thresholds | | | -| WARNINGCPU | Thresholds | | | -| CRITICALCPU | Thresholds | | | -| WARNINGMEMUSAGE | Thresholds | | | -| CRITICALMEMUSAGE | Thresholds | | | -| WARNINGMEMUSAGEFREE | Thresholds | | | -| CRITICALMEMUSAGEFREE | Thresholds | | | -| WARNINGMEMUSAGEPRCT | Thresholds | | | -| CRITICALMEMUSAGEPRCT | Thresholds | | | -| CRITICALSTATUS | Define the conditions to match for the status to be CRITICAL (default: '%\{status\} !~ /up/i'). You can use the following variables: %\{status\}, %\{display\} | %\{status\} !~ /up/i | | -| WARNINGSTATUS | Define the conditions to match for the status to be WARNING (default: ''). You can use the following variables: %\{status\}, %\{display\} | | | -| EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). Toutes les options sont listées [ici](#options-disponibles). | --verbose | | +| Macro | Description | Valeur par défaut | Obligatoire | +|:---------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------|:---------------------|:-----------:| +| FILTERNAME | Filter access point name (can be a regexp) | | | +| WARNINGCLIENTS | Threshold | | | +| CRITICALCLIENTS | Threshold | | | +| WARNINGCPU | Threshold | | | +| CRITICALCPU | Threshold | | | +| WARNINGMEMUSAGE | Threshold | | | +| CRITICALMEMUSAGE | Threshold | | | +| WARNINGMEMUSAGEFREE | Threshold | | | +| CRITICALMEMUSAGEFREE | Threshold | | | +| WARNINGMEMUSAGEPRCT | Threshold | | | +| CRITICALMEMUSAGEPRCT | Threshold | | | +| CRITICALSTATUS | Define the conditions to match for the status to be CRITICAL. You can use the following variables: %\{status\}, %\{display\} | %\{status\} !~ /up/i | | +| WARNINGSTATUS | Define the conditions to match for the status to be WARNING. You can use the following variables: %\{status\}, %\{display\} | | | +| EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). Toutes les options sont listées [ici](#options-disponibles). | --verbose | | -| Macro | Description | Valeur par défaut | Obligatoire | -|:---------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------|:-----------------------|:-----------:| -| FILTERNAME | Filter SSID name (can be a regexp) | | | -| CRITICALSTATUS | Define the conditions to match for the status to be CRITICAL (default: '%\{status\} !~ /enable/i'). You can use the following variables: %\{status\}, %\{display\} | %\{status\} !~ /enable/i | | -| WARNINGSTATUS | Define the conditions to match for the status to be WARNING (default: ''). You can use the following variables: %\{status\}, %\{display\} | | | -| EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). Toutes les options sont listées [ici](#options-disponibles). | --verbose | | +| Macro | Description | Valeur par défaut | Obligatoire | +|:---------------|:-------------------------------------------------------------------------------------------------------------------------------------------------|:-------------------------|:-----------:| +| FILTERNAME | Filter SSID name (can be a regexp) | | | +| CRITICALSTATUS | Define the conditions to match for the status to be CRITICAL. You can use the following variables: %\{status\}, %\{display\} | %\{status\} !~ /enable/i | | +| WARNINGSTATUS | Define the conditions to match for the status to be WARNING. You can use the following variables: %\{status\}, %\{display\} | | | +| EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). Toutes les options sont listées [ici](#options-disponibles). | --verbose | | @@ -230,30 +242,25 @@ telle que celle-ci (remplacez les valeurs d'exemple par les vôtres) : ```bash /usr/lib/centreon/plugins/centreon_aruba_instant_snmp.pl \ --plugin=network::aruba::instant::snmp::plugin \ - --mode=ap-usage \ + --mode=ssid-status \ --hostname=10.0.0.1 \ --snmp-version='2c' \ - --snmp-community='my-snmp-community' \ + --snmp-community='my-snmp-community' \ + --snmp-username='username' \ + --authpassphrase='' \ + --authprotocol='' \ + --privpassphrase='' \ + --privprotocol='' \ --filter-name='' \ --warning-status='' \ - --critical-status='%\{status\} !~ /up/i' \ - --warning-cpu='' \ - --critical-cpu='' \ - --warning-clients='' \ - --critical-clients='' \ - --warning-mem-usage='' \ - --critical-mem-usage='' \ - --warning-mem-usage-free='' \ - --critical-mem-usage-free='' \ - --warning-mem-usage-prct='' \ - --critical-mem-usage-prct='' \ + --critical-status='%\{status\} !~ /enable/i' \ --verbose ``` La commande devrait retourner un message de sortie similaire à : ```bash -OK: total access points: 88 All access points are ok | 'accesspoints.total.count'=88;;;0;'*ap*#clients.current.count'=;;;0;'*ap*#cpu.utilization.percentage'=%;;;0;100'*ap*#memory.usage.bytes'=B;;;0;total'*ap*#memory.free.bytes'=B;;;0;total'*ap*#memory.usage.percentage'=%;;;0;100 +OK: All SSIDs are ok ``` ### Diagnostic des erreurs communes @@ -263,7 +270,7 @@ pour le diagnostic des erreurs communes des plugins Centreon. ### Modes disponibles -Dans la plupart des cas, un mode correspond à un modèle de service. Le mode est renseigné dans la commande d'exécution +Dans la plupart des cas, un mode correspond à un modèle de service. Le mode est renseigné dans la commande d'exécution du connecteur. Dans l'interface de Centreon, il n'est pas nécessaire de les spécifier explicitement, leur utilisation est implicite dès lors que vous utilisez un modèle de service. En revanche, vous devrez spécifier le mode correspondant à ce modèle si vous voulez tester la commande d'exécution du connecteur dans votre terminal. @@ -290,61 +297,70 @@ Le plugin apporte les modes suivants : Les options génériques sont listées ci-dessous : -| 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. | -| --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 an "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\[,\[newuom\],\[min\],\[m ax\]\] Common examples: 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() | -| --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,namesofnewmetrics,calculation\[,\[ne wuom\],\[min\],\[max\]\] regex: regular expression namesofnewmetrics: 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 newuom (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: 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(traf fic\_(in\|out)\_$1)' | -| --change-short-output --change-long-output | Modify the short/long output that is returned by the plugin. Syntax: --change-short-output=pattern~replacement~modifier Most commonly used modifiers are i (case insensitive) and g (replace all occurrences). Example: adding --change-short-output='OK\~Up\~gi' will replace all occurrences of 'OK', 'ok', 'Ok' or 'oK' with 'Up' | -| --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. | -| --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). E.g.: --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'. | -| --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 ok, 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. | +| 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 get-next 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 ok, 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. | +| --show-password | By default, sensitive information in command lines is hidden in debug output and replaced with `***` (however, debug logs may still display sensitive information). Using the C option will display the passwords in plain text. | +| --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\[,\[\\],\[min\],\[max\]\] Common examples: onvert 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\[,\[\\],\[min\],\[max\]\] Common examples: onvert 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\[,\[\\],\[min\],\[max\]\] Common examples: onvert 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,\,calculation\[,\[\\],\[min\],\[max\]\] regex: regular expression \: 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 \ (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: um 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~replacement~modifier Most commonly used modifiers are i (case insensitive) and g (replace all occurrences). Example: adding --change-short-output='OK~Up~gi' will replace all occurrences of 'OK', 'ok', 'Ok' or 'oK' with 'Up' | +| --change-short-output | Modify the short/long output that is returned by the plugin. Syntax: --change-short-output=pattern~replacement~modifier Most commonly used modifiers are i (case insensitive) and g (replace all occurrences). Example: adding --change-short-output='OK~Up~gi' will replace all occurrences of 'OK', 'ok', 'Ok' or 'oK' with 'Up' | +| --change-long-output | Modify the short/long output that is returned by the plugin. Syntax: --change-short-output=pattern~replacement~modifier Most commonly used modifiers are i (case insensitive) and g (replace all occurrences). Example: adding --change-short-output='OK~Up~gi' will replace all occurrences of 'OK', 'ok', 'Ok' or 'oK' with 'Up' | +| --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'. \. | +| --filter-counters | Only display some counters (regexp can be used). Example to check SSL connections only : --filter-counters='^xxxx\|yyyy$' | +| --warning-xxx | Warning threshold. | +| --critical-xxx | Critical threshold. | #### Options des modes @@ -353,22 +369,22 @@ Les options disponibles pour chaque modèle de services sont listées ci-dessous -| Option | Description | -|:-------------------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------| -| --filter-counters | Only display some counters (regexp can be used). Example: --filter-counters='^cpu$' | -| --filter-name | Filter access point name (can be a regexp). | +| Option | Description | +|:-------------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------| +| --filter-counters | Only display some counters (regexp can be used). Example: --filter-counters='^cpu$' | +| --filter-name | Filter access point name (can be a regexp). | | --warning-status | Define the conditions to match for the status to be WARNING (default: ''). You can use the following variables: %\{status\}, %\{display\} | -| --critical-status | Define the conditions to match for the status to be CRITICAL (default: '%\{status\} !~ /up/i'). You can use the following variables: %\{status\}, %\{display\} | -| --warning-* --critical-* | Thresholds. Can be: 'total-ap', 'cpu', 'clients', 'mem-usage' (B), 'mem-usage-free' (B), 'mem-usage-prct' (%). | +| --critical-status | Define the conditions to match for the status to be CRITICAL (default: '%\{status\} !~ /up/i'). You can use the following variables: %\{status\}, %\{display\} | +| --warning-* --critical-* | Thresholds. Can be: 'total-ap', 'cpu', 'clients', 'mem-usage' (B), 'mem-usage-free' (B), 'mem-usage-prct' (%). | -| Option | Description | -|:------------------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------| -| --filter-name | Filter SSID name (can be a regexp). | -| --warning-status | Define the conditions to match for the status to be WARNING (default: ''). You can use the following variables: %\{status\}, %\{display\} | -| --critical-status | Define the conditions to match for the status to be CRITICAL (default: '%\{status\} !~ /enable/i'). You can use the following variables: %\{status\}, %\{display\} | +| Option | Description | +|:------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| --filter-name | Filter SSID name (can be a regexp). | +| --warning-status | Define the conditions to match for the status to be WARNING (default: ''). You can use the following variables: %\{status\}, %\{display\} | +| --critical-status | Define the conditions to match for the status to be CRITICAL (default: '%\{status\} !~ /enable/i'). You can use the following variables: %\{status\}, %\{display\} | @@ -379,6 +395,6 @@ affichée en ajoutant le paramètre `--help` à la commande : ```bash /usr/lib/centreon/plugins/centreon_aruba_instant_snmp.pl \ --plugin=network::aruba::instant::snmp::plugin \ - --mode=ap-usage \ + --mode=ssid-status \ --help ``` diff --git a/i18n/fr/docusaurus-plugin-content-docs-pp/current/integrations/plugin-packs/procedures/network-cisco-meraki-snmp.md b/i18n/fr/docusaurus-plugin-content-docs-pp/current/integrations/plugin-packs/procedures/network-cisco-meraki-snmp.md index 6c5e77819dca..2f144ebf55e3 100644 --- a/i18n/fr/docusaurus-plugin-content-docs-pp/current/integrations/plugin-packs/procedures/network-cisco-meraki-snmp.md +++ b/i18n/fr/docusaurus-plugin-content-docs-pp/current/integrations/plugin-packs/procedures/network-cisco-meraki-snmp.md @@ -5,6 +5,12 @@ title: Cisco Meraki SNMP import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; +## Dépendances du connecteur de supervision + +Les connecteurs de supervision suivants sont automatiquement installés lors de l'installation du connecteur **Cisco Meraki SNMP** +depuis la page **Configuration > Connecteurs > Connecteurs de supervision** : +* [Base Pack](./base-generic.md) + ## Contenu du pack ### Modèles @@ -34,35 +40,35 @@ Le connecteur apporte le modèle de service suivant #### Découverte d'hôtes -| Nom de la règle | Description | -|:----------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| SNMP Agents | Discover your resources through an SNMP subnet scan. You need to install the [Generic SNMP](./applications-protocol-snmp.md) connector to get the discovery rule and create a template mapper for the **Net-Cisco-Meraki-Cloudcontroller-SNMP-custom** host template | +| Nom de la règle | Description | +|:----------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| SNMP Agents | Découvre les ressources via un scan réseau SNMP. Installez le connecteur [Generic SNMP](./applications-protocol-snmp.md) pour obtenir la règle de découverte et créez un modificateur pour le modèle d'hôte **Net-Cisco-Meraki-Cloudcontroller-SNMP-custom**. | Rendez-vous sur la [documentation dédiée](/docs/monitoring/discovery/hosts-discovery) pour en savoir plus sur la découverte automatique d'hôtes. #### Découverte de services -| Nom de la règle | Description | -|:---------------------------------------------------|:------------| -| Net-Cisco-Meraki-Cloudcontroller-SNMP-Device-Usage | Découvre les composants pour en contrôler le statut et l'utilisation. | +| Nom de la règle | Description | +|:---------------------------------------------------|:---------------------------------------------------------------------| +| Net-Cisco-Meraki-Cloudcontroller-SNMP-Device-Usage | Découvre les composants pour en contrôler le statut et l'utilisation | Rendez-vous sur la [documentation dédiée](/docs/monitoring/discovery/services-discovery) pour en savoir plus sur la découverte automatique de services et sa [planification](/docs/monitoring/discovery/services-discovery/#règles-de-découverte). ### Métriques & statuts collectés -Voici le tableau des services pour ce connecteur, détaillant les métriques rattachées à chaque service. +Voici le tableau des services pour ce connecteur, détaillant les métriques et statuts rattachés à chaque service. -| Métrique | Unité | -|:---------------------|:------| -| total-devices | N/A | -| *device*#status | N/A | -| *device*#clients | N/A | -| *interface*#traffic_ | b/s | -| *interface*#traffic_ | b/s | +| Nom | Unité | +|:----------------|:------| +| total-devices | N/A | +| status | N/A | +| clients | N/A | +| *interface*#in | b/s | +| *interface*#out | b/s | > Pour obtenir ce nouveau format de métrique, incluez la valeur **--use-new-perfdata** dans la macro de service **EXTRAOPTIONS**. @@ -73,7 +79,10 @@ Voici le tableau des services pour ce connecteur, détaillant les métriques rat ### Configuration SNMP -Le service SNMP doit être activé et configuré sur l'équipement. Veuillez vous référer à la documentation officielle du constructeur/éditeur. +L'agent SNMP doit être activé et configuré sur l'équipement. +Veuillez vous référer à la documentation officielle. +Il se peut que votre équipement nécessite qu'une liste d'adresses autorisées à l'interroger soit paramétrée. +Veillez à ce que les adresses des collecteurs Centreon y figurent bien. ### Flux réseau @@ -176,12 +185,14 @@ yum install centreon-plugin-Network-Cisco-Meraki-Snmp 2. Complétez les champs **Nom**, **Alias** & **IP Address/DNS** correspondant à votre ressource. 3. Appliquez le modèle d'hôte **Net-Cisco-Meraki-Cloudcontroller-SNMP-custom**. -> Si vous utilisez SNMP en version 3, vous devez configurer les paramètres spécifiques associés via la macro **SNMPEXTRAOPTIONS**. -> Plus d'informations dans la section [Troubleshooting SNMP](../getting-started/how-to-guides/troubleshooting-plugins.md#mapping-des-options-snmpv3). - -| Macro | Description | Valeur par défaut | Obligatoire | -|:-----------------|:-----------------------------------------------------------------------------------------------------|:------------------|:-----------:| -| SNMPEXTRAOPTIONS | Any extra option you may want to add to every command (a --verbose flag for example). Toutes les options sont listées [ici](#options-disponibles). | | | +| Macro | Description | Valeur par défaut | Obligatoire | +|:------------------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------|:------------------|:-----------:| +| SNMP_V3_USERNAME | SNMP v3 only: User name (`securityName`) | | | +| SNMP_V3_AUTH_PROTOCOL | SNMP v3 only: Authentication protocol: MD5\|SHA. Since net-snmp 5.9.1: SHA224\|SHA256\|SHA384\|SHA512 | | | +| SNMP_V3_PRIV_PROTOCOL | 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 | | | +| SNMP_V3_AUTH_PASSPHRASE | SNMP v3 only: Pass phrase hashed using the authentication protocol defined in the --authprotocol option | | | +| SNMP_V3_PRIV_PASSPHRASE | SNMP v3 only: Privacy pass phrase (`privPassword`) to encrypt messages using the protocol defined in the --privprotocol option | | | +| SNMPEXTRAOPTIONS | Any extra option you may want to add to every command (a --verbose flag for example). Toutes les options sont listées [ici](#options-disponibles). | | | 4. [Déployez la configuration](/docs/monitoring/monitoring-servers/deploying-a-configuration). L'hôte apparaît dans la liste des hôtes supervisés, et dans la page **Statut des ressources**. La commande envoyée par le connecteur est indiquée dans le panneau de détails de l'hôte : celle-ci montre les valeurs des macros. @@ -193,20 +204,20 @@ yum install centreon-plugin-Network-Cisco-Meraki-Snmp -| Macro | Description | Valeur par défaut | Obligatoire | -|:---------------------|:---------------------------------------------------------------------------------------------------|:------------------|:-----------:| -| FILTERPRODUCT | Filter device product code (can be a regexp) | | | -| FILTERNETWORK | Filter by network name (can be a regexp) | | | -| FILTERNAME | Filter device name (can be a regexp) | | | -| FILTERINTERFACE | Filter interface name (can be a regexp) | | | -| WARNINGCLIENTS | Warning threshold | | | -| CRITICALCLIENTS | Critical threshold | | | -| WARNINGIN | Warning threshold | | | -| CRITICALIN | Critical threshold | | | -| WARNINGOUT | Warning threshold | | | -| CRITICALOUT | Critical threshold | | | -| WARNINGTOTALDEVICES | Warning threshold | | | -| CRITICALTOTALDEVICES | Critical threshold | | | +| Macro | Description | Valeur par défaut | Obligatoire | +|:---------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------|:------------------|:-----------:| +| FILTERPRODUCT | Filter device product code (can be a regexp) | | | +| FILTERNETWORK | Filter by network name (can be a regexp) | | | +| FILTERNAME | Filter device name (can be a regexp) | | | +| FILTERINTERFACE | Filter interface name (can be a regexp) | | | +| WARNINGCLIENTS | Threshold | | | +| CRITICALCLIENTS | Threshold | | | +| WARNINGIN | Threshold | | | +| CRITICALIN | Threshold | | | +| WARNINGOUT | Threshold | | | +| CRITICALOUT | Threshold | | | +| WARNINGTOTALDEVICES | Threshold | | | +| CRITICALTOTALDEVICES | Threshold | | | | EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). Toutes les options sont listées [ici](#options-disponibles). | --verbose | | @@ -228,7 +239,12 @@ telle que celle-ci (remplacez les valeurs d'exemple par les vôtres) : --mode=device-usage \ --hostname=10.0.0.1 \ --snmp-version='2c' \ - --snmp-community='my-snmp-community' \ + --snmp-community='my-snmp-community' \ + --snmp-username='username' \ + --authpassphrase='' \ + --authprotocol='' \ + --privpassphrase='' \ + --privprotocol='' \ --filter-product='' \ --filter-network='' \ --filter-name='' \ @@ -247,7 +263,7 @@ telle que celle-ci (remplacez les valeurs d'exemple par les vôtres) : La commande devrait retourner un message de sortie similaire à : ```bash -OK: All devices are ok All device interfaces are ok | 'total-devices'=49;;;0;'*device*#clients'=;;;0;'*interface*#traffic_'=b/s;;;;'*interface*#traffic_'=b/s;;;; +OK: All devices are ok All device interfaces are ok | 'interface1#in'=52709b/s;;;; 'interface2#in'=51764b/s;;;; 'interface1#out'=48864b/s;;;; 'interface2#out'=26672b/s;;;; ``` ### Diagnostic des erreurs communes @@ -276,7 +292,7 @@ Le plugin apporte les modes suivants : | Mode | Modèle de service associé | |:---------------------------------------------------------------------------------------------------------------------------------------------------|:----------------------------------------------------------| | device-usage [[code](https://github.com/centreon/centreon-plugins/blob/develop/src/network/cisco/meraki/cloudcontroller/snmp/mode/deviceusage.pm)] | Net-Cisco-Meraki-Cloudcontroller-Device-Usage-SNMP-custom | -| list-devices [[code](https://github.com/centreon/centreon-plugins/blob/develop/src/network/cisco/meraki/cloudcontroller/snmp/mode/listdevices.pm)] | Used for service discovery | +| list-devices [[code](https://github.com/centreon/centreon-plugins/blob/develop/src/network/cisco/meraki/cloudcontroller/snmp/mode/listdevices.pm)] | Utilisé pour la découverte de services | ### Options disponibles @@ -287,86 +303,90 @@ Les options disponibles pour chaque modèle de services sont listées ci-dessous -| 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. | -| --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 an "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\[,\[newuom\],\[min\],\[m ax\]\] Common examples: 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() | -| --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,namesofnewmetrics,calculation\[,\[ne wuom\],\[min\],\[max\]\] regex: regular expression namesofnewmetrics: 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 newuom (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: 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(traf fic\_(in\|out)\_$1)' | -| --change-short-output --change-long-output | Modify the short/long output that is returned by the plugin. Syntax: --change-short-output=pattern~replacement~modifier Most commonly used modifiers are i (case insensitive) and g (replace all occurrences). Example: adding --change-short-output='OK\~Up\~gi' will replace all occurrences of 'OK', 'ok', 'Ok' or 'oK' with 'Up' | -| --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. | -| --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). E.g.: --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'. | -| --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 ok, 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. | -| --memcached | Memcached server to use (only one server). | -| --redis-server | Redis server to use (only one server). Syntax: address\[:port\] | -| --redis-attribute | Set Redis Options (--redis-attribute="cnx\_timeout=5"). | -| --redis-db | Set Redis database index. | -| --failback-file | Failback on a local file if Redis connection fails. | -| --memexpiration | Time to keep data in seconds (default: 86400). | -| --statefile-dir | Define the cache directory (default: '/var/lib/centreon/centplugins'). | -| --statefile-suffix | Define a suffix to customize the statefile name (default: ''). | -| --statefile-concat-cwd | If used with the '--statefile-dir' option, the latter's value will be used as a sub-directory of the current working directory. Useful on Windows when the plugin is compiled, as the file system and permissions are different from Linux. | -| --statefile-format | Define the format used to store the cache. Available formats: 'dumper', 'storable', 'json' (default). | -| --statefile-key | Define the key to encrypt/decrypt the cache. | -| --statefile-cipher | Define the cipher algorithm to encrypt the cache (default: 'AES'). | -| --filter-counters | Only display some counters (regexp can be used). Example: --filter-counters='^clients$' | -| --filter-name | Filter device name (can be a regexp). | -| --filter-product | Filter device product code (can be a regexp). | -| --filter-network | Filter by network name (can be a regexp). | -| --filter-interface | Filter interface name (can be a regexp). | -| --cache-expires-on | Use cache file to speed up mode execution (X seconds before refresh cache file). | -| --speed-in | Set interface speed for incoming traffic (in Mb). | -| --speed-out | Set interface speed for outgoing traffic (in Mb). | -| --units-traffic | Units of thresholds for the traffic (default: '%') ('%', 'b/s'). | -| --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 (default: '%\{status\} =~ /offline/'). You can use the following variables: %\{status\}, %\{display\} | -| --warning-* | Warning threshold. Can be: 'total-devices', 'clients', 'in', 'out'. | -| --critical-* | Critical threshold. Can be: 'total-devices', 'clients', 'in', 'out'. | +| Option | Description | +|:-------------------------------------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| --filter-counters | Only display some counters (regexp can be used). Example: --filter-counters='^clients$' | +| --warning-xxx | Warning threshold. | +| --critical-xxx | Critical threshold. | +| --memcached | Memcached server to use (only one server). | +| --redis-server | Redis server to use (only one server). Syntax: address\[:port\] | +| --redis-attribute | Set Redis Options (--redis-attribute="cnx\_timeout=5"). | +| --redis-db | Set Redis database index. | +| --failback-file | Fall back on a local file if Redis connection fails. | +| --memexpiration | Time to keep data in seconds (default: 86400). | +| --statefile-dir | Define the cache directory (default: '/var/lib/centreon/centplugins'). | +| --statefile-suffix | Define a suffix to customize the statefile name (default: ''). | +| --statefile-concat-cwd | If used with the '--statefile-dir' option, the latter's value will be used as a sub-directory of the current working directory. Useful on Windows when the plugin is compiled, as the file system and permissions are different from Linux. | +| --statefile-format | Define the format used to store the cache. Available formats: 'dumper', 'storable', 'json' (default). | +| --statefile-key | Define the key to encrypt/decrypt the cache. | +| --statefile-cipher | Define the cipher algorithm to encrypt the cache (default: 'AES'). | +| --filter-name | Filter device name (can be a regexp). | +| --filter-product | Filter device product code (can be a regexp). | +| --filter-network | Filter by network name (can be a regexp). | +| --filter-interface | Filter interface name (can be a regexp). | +| --cache-expires-on | Use cache file to speed up mode execution (X seconds before refresh cache file). | +| --speed-in | Set interface speed for incoming traffic (in Mb). | +| --speed-out | Set interface speed for outgoing traffic (in Mb). | +| --units-traffic | Units of thresholds for the traffic (default: '%') ('%', 'b/s'). | +| --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 (default: '%\{status\} =~ /offline/'). You can use the following variables: %\{status\}, %\{display\} | +| --warning-* | Warning threshold. Can be: 'total-devices', 'clients', 'in', 'out'. | +| --critical-* | Critical threshold. Can be: 'total-devices', 'clients', 'in', 'out'. | +| --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 get-next 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 ok, 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. | +| --show-password | By default, sensitive information in command lines is hidden in debug output and replaced with `***` (however, debug logs may still display sensitive information). Using the C option will display the passwords in plain text. | +| --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\[,\[\\],\[min\],\[max\]\] Common examples: onvert 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,\,calculation\[,\[\\],\[min\],\[max\]\] regex: regular expression \: 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 \ (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: um 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~replacement~modifier Most commonly used modifiers are i (case insensitive) and g (replace all occurrences). Example: adding --change-short-output='OK~Up~gi' will replace all occurrences of 'OK', 'ok', 'Ok' or 'oK' with 'Up' | +| --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'. \. | diff --git a/i18n/fr/docusaurus-plugin-content-docs-pp/current/integrations/plugin-packs/procedures/network-cisco-wlc-snmp.md b/i18n/fr/docusaurus-plugin-content-docs-pp/current/integrations/plugin-packs/procedures/network-cisco-wlc-snmp.md index f156fcd68244..90703d27eff4 100644 --- a/i18n/fr/docusaurus-plugin-content-docs-pp/current/integrations/plugin-packs/procedures/network-cisco-wlc-snmp.md +++ b/i18n/fr/docusaurus-plugin-content-docs-pp/current/integrations/plugin-packs/procedures/network-cisco-wlc-snmp.md @@ -5,9 +5,9 @@ title: Cisco WLC SNMP import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; -## Dépendances du Connecteur de supervision +## Dépendances du connecteur de supervision -Les connecteurs de supervision suivants sont automatiquement installés lors de l'installation du connecteur **Cisco WLC** +Les connecteurs de supervision suivants sont automatiquement installés lors de l'installation du connecteur **Cisco WLC SNMP** depuis la page **Configuration > Connecteurs > Connecteurs de supervision** : * [Base Pack](./base-generic.md) @@ -15,7 +15,7 @@ depuis la page **Configuration > Connecteurs > Connecteurs de supervision** : ### Modèles -Le connecteur de supervision **Cisco WLC** apporte 2 modèles d'hôte : +Le connecteur de supervision **Cisco WLC SNMP** apporte 2 modèles d'hôte : * **Net-Cisco-Wlc-SNMP-custom** * **Net-Cisco-Wlc-SNMP-Access-Point-custom** @@ -26,12 +26,12 @@ Le connecteur apporte les modèles de service suivants -| Alias | Modèle de service | Description | Découverte | -|:-----------------|:-------------------------------------------|:---------------------------------------------------|:----------:| -| Ap-Status-Global | Net-Cisco-Wlc-Ap-Status-Global-SNMP-custom | Contrôle le statut de l'ensemble des relais | X | -| Cpu | Net-Cisco-Wlc-Cpu-SNMP-custom | Contrôle le taux d'utilisation du CPU | | -| Hardware-Global | Net-Cisco-Wlc-Hardware-Global-SNMP-custom | Contrôle l'ensemble du matériel | | -| Memory | Net-Cisco-Wlc-Memory-SNMP-custom | Contrôle du taux d'utilisation de la mémoire vive | | +| Alias | Modèle de service | Description | Découverte | +|:-----------------|:-------------------------------------------|:--------------------------------------------------------|:----------:| +| Ap-Status-Global | Net-Cisco-Wlc-Ap-Status-Global-SNMP-custom | Contrôle le statut de l'ensemble des relais (AP) | X | +| Cpu | Net-Cisco-Wlc-Cpu-SNMP-custom | Contrôle le taux d'utilisation du CPU | | +| Hardware-Global | Net-Cisco-Wlc-Hardware-Global-SNMP-custom | Contrôle l'ensemble du matériel (alimentations) | | +| Memory | Net-Cisco-Wlc-Memory-SNMP-custom | Contrôle du taux d'utilisation de la mémoire vive (RAM) | | > Les services listés ci-dessus sont créés automatiquement lorsque le modèle d'hôte **Net-Cisco-Wlc-SNMP-custom** est utilisé. @@ -40,26 +40,26 @@ Le connecteur apporte les modèles de service suivants -| Alias | Modèle de service | Description | -|:----------|:-------------------------------------------------|:-------------------------------------------------------------| -| Ap-Status | Net-Cisco-Wlc-Ap-Status-SNMP-Access-Point-custom | Contrôle le statut du point d'accès | -| Ap-Users | Net-Cisco-Wlc-Ap-Users-SNMP-Access-Point-custom | Contrôle le nombre d'utilisateurs du point d'accès | -| Ap-Users | Net-Cisco-Wlc-Ap-Users-SNMP-custom | Contrôle le nombre d'utilisateurs sur l'ensemble des relais | +| Alias | Modèle de service | Description | +|:----------|:-------------------------------------------------|:-----------------------------------------------------------------| +| Ap-Status | Net-Cisco-Wlc-Ap-Status-SNMP-Access-Point-custom | Contrôle le statut du point d'accès | +| Ap-Users | Net-Cisco-Wlc-Ap-Users-SNMP-Access-Point-custom | Contrôle le nombre d'utilisateurs du point d'accès | +| Ap-Users | Net-Cisco-Wlc-Ap-Users-SNMP-custom | Contrôle le nombre d'utilisateurs sur l'ensemble des relais (AP) | > Les services listés ci-dessus sont créés automatiquement lorsque le modèle d'hôte **Net-Cisco-Wlc-SNMP-Access-Point-custom** est utilisé. -| Alias | Modèle de service | Description | Découverte | -|:-------------------------------|:---------------------------------------------------------|:--------------------------------------------------------------------|:----------:| -| Ap-Channel-Interference-Global | Net-Cisco-Wlc-Ap-Channel-Interference-Global-SNMP-custom | Contrôle les interférences sur les canaux de l'ensemble des relais | | -| Ap-Channel-Noise-Global | Net-Cisco-Wlc-Ap-Channel-Noise-Global-SNMP-custom | Contrôle le bruit sur les canaux de l'ensemble des relais | | -| Ap-Users | Net-Cisco-Wlc-Ap-Users-SNMP-Access-Point-custom | Contrôle le nombre d'utilisateurs du point d'accès | | -| Ap-Users | Net-Cisco-Wlc-Ap-Users-SNMP-custom | Contrôle le nombre d'utilisateurs sur l'ensemble des relais | | -| Traffic-Generic-Id | Net-Cisco-Wlc-Traffic-Generic-Id-SNMP-custom | Contrôle le traffic réseau d'une interface réseau | | -| Traffic-Generic-Name | Net-Cisco-Wlc-Traffic-Generic-Name-SNMP-custom | Contrôle le traffic réseau d'une interface réseau | | -| Traffic-Global | Net-Cisco-Wlc-Traffic-Global-SNMP-custom | Contrôle le traffic réseau de plusieurs interfaces réseau | X | +| Alias | Modèle de service | Description | Découverte | +|:-------------------------------|:---------------------------------------------------------|:------------------------------------------------------------------------|:----------:| +| Ap-Channel-Interference-Global | Net-Cisco-Wlc-Ap-Channel-Interference-Global-SNMP-custom | Contrôle les interférences sur les canaux de l'ensemble des relais (AP) | | +| Ap-Channel-Noise-Global | Net-Cisco-Wlc-Ap-Channel-Noise-Global-SNMP-custom | Contrôle le bruit sur les canaux de l'ensemble des relais (AP) | | +| Ap-Users | Net-Cisco-Wlc-Ap-Users-SNMP-Access-Point-custom | Contrôle le nombre d'utilisateurs du point d'accès | | +| Ap-Users | Net-Cisco-Wlc-Ap-Users-SNMP-custom | Contrôle le nombre d'utilisateurs sur l'ensemble des relais (AP) | | +| Traffic-Generic-Id | Net-Cisco-Wlc-Traffic-Generic-Id-SNMP-custom | Contrôle le traffic réseau d'une interface réseau | | +| Traffic-Generic-Name | Net-Cisco-Wlc-Traffic-Generic-Name-SNMP-custom | Contrôle le traffic réseau d'une interface réseau | | +| Traffic-Global | Net-Cisco-Wlc-Traffic-Global-SNMP-custom | Contrôle le traffic réseau de plusieurs interfaces réseau | X | > Les services listés ci-dessus ne sont pas créés automatiquement lorsqu'un modèle d'hôte est appliqué. Pour les utiliser, [créez un service manuellement](/docs/monitoring/basic-objects/services) et appliquez le modèle de service souhaité. @@ -72,18 +72,18 @@ Le connecteur apporte les modèles de service suivants #### Découverte d'hôtes -| Nom de la règle | Description | -|:----------------|:--------------------------------------------------------------| -| Cisco WLC | Découvre les points d'accès du contrôleur LAN sans fil Cisco | +| Nom de la règle | Description | +|:----------------|:-------------------------------------------------------------| +| Cisco WLC | Découvre les points d'accès du contrôleur LAN sans fil Cisco | Rendez-vous sur la [documentation dédiée](/docs/monitoring/discovery/hosts-discovery) pour en savoir plus sur la découverte automatique d'hôtes. #### Découverte de services -| Nom de la règle | Description | -|:--------------------------------|:----------------------------------------------------------------------------| -| Net-Cisco-Wlc-SNMP-AP-Name | Découvre les points d'accès et supervise leur statut | -| Net-Cisco-Wlc-SNMP-Traffic-Name | Découvre les interfaces réseau et supervise leur statut et leurutilisation | +| Nom de la règle | Description | +|:--------------------------------|:--------------------------------------------------------------------------------------------------| +| Net-Cisco-Wlc-SNMP-AP-Name | Découvre les points d'accès et supervise leur statut | +| Net-Cisco-Wlc-SNMP-Traffic-Name | Découvre les interfaces réseau en utilisant leur nom et supervise leur statut et leur utilisation | Rendez-vous sur la [documentation dédiée](/docs/monitoring/discovery/services-discovery) pour en savoir plus sur la découverte automatique de services et sa [planification](/docs/monitoring/discovery/services-discovery/#règles-de-découverte). @@ -163,7 +163,7 @@ Voici le tableau des services pour ce connecteur, détaillant les métriques et | *ssid*#ssid.users.total.count | users | | *ap*#accesspoint.users.total.count | users | -> Concerne les modèles de service suivants : Ap-Users (Net-Cisco-Wlc-Ap-Users-SNMP-custom) et Ap-Users (Net-Cisco-Wlc-Ap-Users-SNMP-Access-Point-custom). +> Concerne les modèles de service suivants : Ap-Users, Ap-Users > Pour obtenir ce nouveau format de métrique, incluez la valeur **--use-new-perfdata** dans la macro de service **EXTRAOPTIONS**. @@ -177,9 +177,10 @@ Voici le tableau des services pour ce connecteur, détaillant les métriques et -| Metric name | Unité | -|:--------------------|:------| -| power supply status | N/A | +| Nom | Unité | +|:-------------------|:------| +| hardware.psu.count | count | +| psu status | N/A | @@ -201,8 +202,6 @@ Voici le tableau des services pour ce connecteur, détaillant les métriques et > Concerne les modèles de service suivants : Traffic-Generic-Id, Traffic-Generic-Name, Traffic-Global -> To obtain this new metric format, include **--use-new-perfdata** in the **EXTRAOPTIONS** service macro. - @@ -263,7 +262,7 @@ yum install centreon-pack-network-cisco-wlc-snmp -2. Quel que soit le type de la licence (*online* ou *offline*), installez le connecteur **Cisco WLC** +2. Quel que soit le type de la licence (*online* ou *offline*), installez le connecteur **Cisco WLC SNMP** depuis l'interface web et le menu **Configuration > Connecteurs > Connecteurs de supervision**. ### Plugin @@ -319,12 +318,14 @@ yum install centreon-plugin-Network-Cisco-Wlc-Snmp 2. Complétez les champs **Nom**, **Alias** & **IP Address/DNS** correspondant à votre ressource. 3. Appliquez le modèle d'hôte **Net-Cisco-Wlc-SNMP-custom**. -> Si vous utilisez SNMP en version 3, vous devez configurer les paramètres spécifiques associés via la macro **SNMPEXTRAOPTIONS**. -> Plus d'informations dans la section [Troubleshooting SNMP](../getting-started/how-to-guides/troubleshooting-plugins.md#mapping-des-options-snmpv3). - -| Macro | Description | Valeur par défaut | Obligatoire | -|:-----------------|:-----------------------------------------------------------------------------------------------------|:------------------|:-----------:| -| SNMPEXTRAOPTIONS | Any extra option you may want to add to every command (a --verbose flag for example). Toutes les options sont listées [ici](#options-disponibles). | | | +| Macro | Description | Valeur par défaut | Obligatoire | +|:------------------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------|:------------------|:-----------:| +| SNMP_V3_USERNAME | SNMP v3 only: User name (`securityName`) | | | +| SNMP_V3_AUTH_PROTOCOL | SNMP v3 only: Authentication protocol: MD5\|SHA. Since net-snmp 5.9.1: SHA224\|SHA256\|SHA384\|SHA512 | | | +| SNMP_V3_PRIV_PROTOCOL | 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 | | | +| SNMP_V3_AUTH_PASSPHRASE | SNMP v3 only: Pass phrase hashed using the authentication protocol defined in the --authprotocol option | | | +| SNMP_V3_PRIV_PASSPHRASE | SNMP v3 only: Privacy pass phrase (`privPassword`) to encrypt messages using the protocol defined in the --privprotocol option | | | +| SNMPEXTRAOPTIONS | Any extra option you may want to add to every command (a --verbose flag for example). Toutes les options sont listées [ici](#options-disponibles). | | | 4. [Déployez la configuration](/docs/monitoring/monitoring-servers/deploying-a-configuration). L'hôte apparaît dans la liste des hôtes supervisés, et dans la page **Statut des ressources**. La commande envoyée par le connecteur est indiquée dans le panneau de détails de l'hôte : celle-ci montre les valeurs des macros. @@ -335,16 +336,18 @@ yum install centreon-plugin-Network-Cisco-Wlc-Snmp 2. Complétez les champs **Nom**, **Alias** & **IP Address/DNS** correspondant à votre ressource. 3. Appliquez le modèle d'hôte **Net-Cisco-Wlc-SNMP-Access-Point-custom**. -> Si vous utilisez SNMP en version 3, vous devez configurer les paramètres spécifiques associés via la macro **SNMPEXTRAOPTIONS**. -> Plus d'informations dans la section [Troubleshooting SNMP](../getting-started/how-to-guides/troubleshooting-plugins.md#mapping-des-options-snmpv3). - -| Macro | Description | Valeur par défaut | Obligatoire | -|:--------------------|:-----------------------------------------------------------------------------------------------------|:------------------|:-----------:| -| WLCHOSTNAME | Name or address of the host to monitor (mandatory) | | | -| APNAME | Filter access point name (can be a regexp) | | | -| WLCSNMPCOMMUNITY | SNMP community (default value: public). It is recommended to use a read-only community | | | -| WLCSNMPVERSION | Version of the SNMP protocol. 1 for SNMP v1 (default), 2 for SNMP v2c, 3 for SNMP v3 | | | -| WLCSNMPEXTRAOPTIONS | Any extra option you may want to add to every command (a --verbose flag for example). Toutes les options sont listées [ici](#options-disponibles). | | | +| Macro | Description | Valeur par défaut | Obligatoire | +|:------------------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------|:------------------|:-----------:| +| WLCHOSTNAME | Name or address of the host to monitor (mandatory) | | | +| SNMP_V3_USERNAME | SNMP v3 only: User name (`securityName`) | | | +| SNMP_V3_AUTH_PROTOCOL | SNMP v3 only: Authentication protocol: MD5\|SHA. Since net-snmp 5.9.1: SHA224\|SHA256\|SHA384\|SHA512 | | | +| SNMP_V3_PRIV_PROTOCOL | 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 | | | +| APNAME | Filter access point name (can be a regexp) | | | +| SNMP_V3_AUTH_PASSPHRASE | SNMP v3 only: Pass phrase hashed using the authentication protocol defined in the --authprotocol option | | | +| SNMP_V3_PRIV_PASSPHRASE | SNMP v3 only: Privacy pass phrase (`privPassword`) to encrypt messages using the protocol defined in the --privprotocol option | | | +| WLCSNMPCOMMUNITY | SNMP community (default value: public). It is recommended to use a read-only community | | | +| WLCSNMPVERSION | Version of the SNMP protocol. 1 for SNMP v1 (default), 2 for SNMP v2c, 3 for SNMP v3 | | | +| WLCSNMPEXTRAOPTIONS | Any extra option you may want to add to every command (a --verbose flag for example). Toutes les options sont listées [ici](#options-disponibles). | | | 4. [Déployez la configuration](/docs/monitoring/monitoring-servers/deploying-a-configuration). L'hôte apparaît dans la liste des hôtes supervisés, et dans la page **Statut des ressources**. La commande envoyée par le connecteur est indiquée dans le panneau de détails de l'hôte : celle-ci montre les valeurs des macros. @@ -359,138 +362,138 @@ yum install centreon-plugin-Network-Cisco-Wlc-Snmp -| Macro | Description | Valeur par défaut | Obligatoire | -|:--------------------------|:---------------------------------------------------------------------------------------------------|:------------------|:-----------:| -| FILTER | Filter access point name (can be a regexp) | .* | | -| FILTERGROUP | Filter access point group (can be a regexp) | | | -| WARNINGINTERFERENCEPOWER | Threshold | | | -| CRITICALINTERFERENCEPOWER | Threshold | | | -| WARNINGINTERFERENCEUTIL | Threshold | | | -| CRITICALINTERFERENCEUTIL | Threshold | | | +| Macro | Description | Valeur par défaut | Obligatoire | +|:--------------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------|:------------------|:-----------:| +| FILTER | Filter access point name (can be a regexp) | .* | | +| FILTERGROUP | Filter access point group (can be a regexp) | | | +| WARNINGINTERFERENCEPOWER | Threshold | | | +| CRITICALINTERFERENCEPOWER | Threshold | | | +| WARNINGINTERFERENCEUTIL | Threshold | | | +| CRITICALINTERFERENCEUTIL | Threshold | | | | EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). Toutes les options sont listées [ici](#options-disponibles). | --verbose | | -| Macro | Description | Valeur par défaut | Obligatoire | -|:-------------------|:---------------------------------------------------------------------------------------------------|:------------------|:-----------:| -| FILTER | Filter access point name (can be a regexp) | .* | | -| FILTERGROUP | Filter access point group (can be a regexp) | | | -| WARNINGNOISEPOWER | Threshold | | | -| CRITICALNOISEPOWER | Threshold | | | +| Macro | Description | Valeur par défaut | Obligatoire | +|:-------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------|:------------------|:-----------:| +| FILTER | Filter access point name (can be a regexp) | .* | | +| FILTERGROUP | Filter access point group (can be a regexp) | | | +| WARNINGNOISEPOWER | Threshold | | | +| CRITICALNOISEPOWER | Threshold | | | | EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). Toutes les options sont listées [ici](#options-disponibles). | --verbose | | -| Macro | Description | Valeur par défaut | Obligatoire | -|:---------------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:----------------------------------------------------------------------|:-----------:| -| CRITICALSTATUS | Define the conditions to match for the status to be CRITICAL (default: '%\{admstatus\} eq "enable" and %\{opstatus\} !~ /associated\|downloading/'). You can use the following variables: %\{admstatus\}, %\{opstatus\}, %\{display\} | %\{admstatus\} eq "enable" and %\{opstatus\} !~ /associated\|downloading/ | | -| WARNINGSTATUS | Define the conditions to match for the status to be WARNING. You can use the following variables: %\{admstatus\}, %\{opstatus\}, %\{display\} | | | -| EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). Toutes les options sont listées [ici](#options-disponibles). | --verbose | | +| Macro | Description | Valeur par défaut | Obligatoire | +|:---------------|:-------------------------------------------------------------------------------------------------------------------------------------------------|:--------------------------------------------------------------------------|:-----------:| +| CRITICALSTATUS | Define the conditions to match for the status to be CRITICAL. You can use the following variables: %\{admstatus\}, %\{opstatus\}, %\{display\} | %\{admstatus\} eq "enable" and %\{opstatus\} !~ /associated\|downloading/ | | +| WARNINGSTATUS | Define the conditions to match for the status to be WARNING. You can use the following variables: %\{admstatus\}, %\{opstatus\}, %\{display\} | | | +| EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). Toutes les options sont listées [ici](#options-disponibles). | --verbose | | -| Macro | Description | Valeur par défaut | Obligatoire | -|:------------------------------------------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:----------------------------------------------------------------------|:-----------:| -| FILTER | Filter access point name (can be a regexp) | | | -| FILTERGROUP | Filter access point group (can be a regexp) | | | -| WARNINGRADIOINTERFACECHANNELSUTILIZATION | Threshold | | | -| CRITICALRADIOINTERFACECHANNELSUTILIZATION | Threshold | | | -| CRITICALRADIOSTATUS | Define the conditions to match for the status to be CRITICAL (default: '%\{admstatus\} eq "enable" and %\{opstatus\} eq "down"'). You can use the following variables: %\{admstatus\}, %\{opstatus\}, %\{display\} | %\{admstatus\} eq "enable" and %\{opstatus\} eq "down" | | -| WARNINGRADIOSTATUS | Define the conditions to match for the status to be WARNING. You can use the following variables: %\{admstatus\}, %\{opstatus\}, %\{display\} | | | -| CRITICALSTATUS | Define the conditions to match for the status to be CRITICAL (default: '%\{admstatus\} eq "enable" and %\{opstatus\} !~ /associated\|downloading/'). You can use the following variables: %\{admstatus\}, %\{opstatus\}, %\{display\} | %\{admstatus\} eq "enable" and %\{opstatus\} !~ /associated\|downloading/ | | -| WARNINGSTATUS | Define the conditions to match for the status to be WARNING. You can use the following variables: %\{admstatus\}, %\{opstatus\}, %\{display\} | | | -| WARNINGTOTAL | Threshold | | | -| CRITICALTOTAL | Threshold | | | -| WARNINGTOTALASSOCIATED | Threshold | | | -| CRITICALTOTALASSOCIATED | Threshold | | | -| WARNINGTOTALDISABLED | Threshold | | | -| CRITICALTOTALDISABLED | Threshold | | | -| WARNINGTOTALDISASSOCIATING | Threshold | | | -| CRITICALTOTALDISASSOCIATING | Threshold | | | -| WARNINGTOTALENABLED | Threshold | | | -| CRITICALTOTALENABLED | Threshold | | | -| EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). Toutes les options sont listées [ici](#options-disponibles). | --verbose | | +| Macro | Description | Valeur par défaut | Obligatoire | +|:------------------------------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------|:--------------------------------------------------------------------------|:-----------:| +| FILTER | Filter access point name (can be a regexp) | | | +| FILTERGROUP | Filter access point group (can be a regexp) | | | +| WARNINGRADIOINTERFACECHANNELSUTILIZATION | Threshold | | | +| CRITICALRADIOINTERFACECHANNELSUTILIZATION | Threshold | | | +| CRITICALRADIOSTATUS | Define the conditions to match for the status to be CRITICAL. You can use the following variables: %\{admstatus\}, %\{opstatus\}, %\{display\} | %\{admstatus\} eq "enable" and %\{opstatus\} eq "down" | | +| WARNINGRADIOSTATUS | Define the conditions to match for the status to be WARNING. You can use the following variables: %\{admstatus\}, %\{opstatus\}, %\{display\} | | | +| CRITICALSTATUS | Define the conditions to match for the status to be CRITICAL. You can use the following variables: %\{admstatus\}, %\{opstatus\}, %\{display\} | %\{admstatus\} eq "enable" and %\{opstatus\} !~ /associated\|downloading/ | | +| WARNINGSTATUS | Define the conditions to match for the status to be WARNING. You can use the following variables: %\{admstatus\}, %\{opstatus\}, %\{display\} | | | +| WARNINGTOTAL | Threshold | | | +| CRITICALTOTAL | Threshold | | | +| WARNINGTOTALASSOCIATED | Threshold | | | +| CRITICALTOTALASSOCIATED | Threshold | | | +| WARNINGTOTALDISABLED | Threshold | | | +| CRITICALTOTALDISABLED | Threshold | | | +| WARNINGTOTALDISASSOCIATING | Threshold | | | +| CRITICALTOTALDISASSOCIATING | Threshold | | | +| WARNINGTOTALENABLED | Threshold | | | +| CRITICALTOTALENABLED | Threshold | | | +| EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). Toutes les options sont listées [ici](#options-disponibles). | --verbose | | -| Macro | Description | Valeur par défaut | Obligatoire | -|:--------------|:---------------------------------------------------------------------------------------------------|:------------------|:-----------:| -| FILTERGROUP | Filter by access point group (can be a regexp) | | | -| WARNINGTOTAL | Threshold | | | -| CRITICALTOTAL | Threshold | | | +| Macro | Description | Valeur par défaut | Obligatoire | +|:--------------|:-------------------------------------------------------------------------------------------------------------------------------------------------|:------------------|:-----------:| +| FILTERGROUP | Filter by access point group (can be a regexp) | | | +| WARNINGTOTAL | Threshold | | | +| CRITICALTOTAL | Threshold | | | | EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). Toutes les options sont listées [ici](#options-disponibles). | --verbose | | -| Macro | Description | Valeur par défaut | Obligatoire | -|:-------------|:---------------------------------------------------------------------------------------------------|:------------------|:-----------:| -| WARNING | Warning threshold in percent | | | -| CRITICAL | Critical threshold in percent | | | +| Macro | Description | Valeur par défaut | Obligatoire | +|:-------------|:-------------------------------------------------------------------------------------------------------------------------------------------------|:------------------|:-----------:| +| WARNING | Warning threshold in percent | | | +| CRITICAL | Critical threshold in percent | | | | EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). Toutes les options sont listées [ici](#options-disponibles). | | | -| Macro | Description | Valeur par défaut | Obligatoire | -|:-------------|:---------------------------------------------------------------------------------------------------|:------------------|:-----------:| -| COMPONENT | Which component to check (default: '.*'). Can be: 'psu' | .* | | +| Macro | Description | Valeur par défaut | Obligatoire | +|:-------------|:-------------------------------------------------------------------------------------------------------------------------------------------------|:------------------|:-----------:| +| COMPONENT | Which component to check. Can be: 'psu' | .* | | | EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). Toutes les options sont listées [ici](#options-disponibles). | --verbose | | -| Macro | Description | Valeur par défaut | Obligatoire | -|:------------------|:---------------------------------------------------------------------------------------------------|:------------------|:-----------:| -| WARNING | Threshold | | | -| CRITICAL | Threshold | | | -| WARNINGUSAGEFREE | Threshold | | | -| CRITICALUSAGEFREE | Threshold | | | -| WARNINGUSAGEPRCT | Threshold | | | -| CRITICALUSAGEPRCT | Threshold | | | +| Macro | Description | Valeur par défaut | Obligatoire | +|:------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------|:------------------|:-----------:| +| WARNING | Threshold | | | +| CRITICAL | Threshold | | | +| WARNINGUSAGEFREE | Threshold | | | +| CRITICALUSAGEFREE | Threshold | | | +| WARNINGUSAGEPRCT | Threshold | | | +| CRITICALUSAGEPRCT | Threshold | | | | EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). Toutes les options sont listées [ici](#options-disponibles). | | | -| Macro | Description | Valeur par défaut | Obligatoire | -|:-------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------|:------------------|:-----------:| -| INTERFACEID | Define the interface filter on IDs (OID indexes, e.g.: 1,2,...). If empty, all interfaces will be monitored. To filter on interface names, see --name | | | -| WARNINGIN | Threshold | 80 | | -| CRITICALIN | Threshold | 90 | | -| WARNINGOUT | Threshold | 80 | | -| CRITICALOUT | Threshold | 90 | | -| EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). Toutes les options sont listées [ici](#options-disponibles). | | | +| Macro | Description | Valeur par défaut | Obligatoire | +|:-------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------|:------------------|:-----------:| +| INTERFACEID | Check only the interfaces with the specified IDs (OID indexes, e.g.: 1,2,...). If empty, all interfaces will be monitored. To filter on interface names, see --name | | | +| WARNINGIN | Thresholds | 80 | | +| CRITICALIN | Thresholds | 90 | | +| WARNINGOUT | Thresholds | 80 | | +| CRITICALOUT | Thresholds | 90 | | +| EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). Toutes les options sont listées [ici](#options-disponibles). | | | -| Macro | Description | Valeur par défaut | Obligatoire | -|:--------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------|:------------------|:-----------:| -| INTERFACENAME | Define the interface filter on IDs (OID indexes, e.g.: 1,2,...). If empty, all interfaces will be monitored. To filter on interface names, see --name | | | -| WARNINGIN | Threshold | 80 | | -| CRITICALIN | Threshold | 90 | | -| WARNINGOUT | Threshold | 80 | | -| CRITICALOUT | Threshold | 90 | | -| EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). Toutes les options sont listées [ici](#options-disponibles). | | | +| Macro | Description | Valeur par défaut | Obligatoire | +|:--------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------|:------------------|:-----------:| +| INTERFACENAME | Check only the interfaces with the specified IDs (OID indexes, e.g.: 1,2,...). If empty, all interfaces will be monitored. To filter on interface names, see --name | | | +| WARNINGIN | Thresholds | 80 | | +| CRITICALIN | Thresholds | 90 | | +| WARNINGOUT | Thresholds | 80 | | +| CRITICALOUT | Thresholds | 90 | | +| EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). Toutes les options sont listées [ici](#options-disponibles). | | | -| Macro | Description | Valeur par défaut | Obligatoire | -|:---------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:---------------------------------------------|:-----------:| -| FILTER | Define the interface filter on IDs (OID indexes, e.g.: 1,2,...). If empty, all interfaces will be monitored. To filter on interface names, see --name | .* | | -| WARNINGIN | Threshold | 80 | | -| CRITICALIN | Threshold | 90 | | -| WARNINGOUT | Threshold | 80 | | -| CRITICALOUT | Threshold | 90 | | -| CRITICALSTATUS | Define the conditions to match for the status to be CRITICAL (default: '%\{admstatus\} eq "up" and %\{opstatus\} ne "up"'). You can use the following variables: %\{admstatus\}, %\{opstatus\}, %\{duplexstatus\}, %\{display\} | %\{admstatus\} eq "up" and %\{opstatus\} ne "up" | | -| WARNINGSTATUS | Define the conditions to match for the status to be WARNING. You can use the following variables: %\{admstatus\}, %\{opstatus\}, %\{duplexstatus\}, %\{display\} | | | -| EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). Toutes les options sont listées [ici](#options-disponibles). | --verbose | | +| Macro | Description | Valeur par défaut | Obligatoire | +|:---------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------|:-------------------------------------------------|:-----------:| +| FILTER | Check only the interfaces with the specified IDs (OID indexes, e.g.: 1,2,...). If empty, all interfaces will be monitored. To filter on interface names, see --name | .* | | +| WARNINGIN | Thresholds | 80 | | +| CRITICALIN | Thresholds | 90 | | +| WARNINGOUT | Thresholds | 80 | | +| CRITICALOUT | Thresholds | 90 | | +| CRITICALSTATUS | Define the conditions to match for the status to be CRITICAL. You can use the following variables: %\{admstatus\}, %\{opstatus\}, %\{duplexstatus\}, %\{display\} | %\{admstatus\} eq "up" and %\{opstatus\} ne "up" | | +| WARNINGSTATUS | Define the conditions to match for the status to be WARNING. You can use the following variables: %\{admstatus\}, %\{opstatus\}, %\{duplexstatus\}, %\{display\} | | | +| EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). Toutes les options sont listées [ici](#options-disponibles). | --verbose | | @@ -508,29 +511,32 @@ telle que celle-ci (remplacez les valeurs d'exemple par les vôtres) : ```bash /usr/lib/centreon/plugins/centreon_cisco_wlc.pl \ --plugin=network::cisco::wlc::snmp::plugin \ - --mode=ap-status \ + --mode=interfaces \ --hostname=10.0.0.1 \ --snmp-version='2c' \ - --snmp-community='my-snmp-community' \ - --filter-name='ap-1200d-emb' \ - --use-new-perfdata \ - --add-radio-interfaces \ + --snmp-community='my-snmp-community' \ + --snmp-username='username' \ + --authpassphrase='' \ + --authprotocol='' \ + --privpassphrase='' \ + --privprotocol='' \ + --interface='.*' \ + --name \ + --add-status \ + --add-traffic \ + --warning-status='' \ + --critical-status='%\{admstatus\} eq "up" and %\{opstatus\} ne "up"' \ + --warning-in-traffic='80' \ + --critical-in-traffic='90' \ + --warning-out-traffic='80' \ + --critical-out-traffic='90' \ --verbose ``` La commande devrait retourner un message de sortie similaire à : ```bash -OK: Access points total: 2, associated: 2, disassociating: 0, enabled: 2, disabled: 0 - All access points are ok | 'accesspoints.total.count'=2;;;0; 'accesspoints.associated.count'=2;;;0; 'accesspoints.disassociating.count'=0;;;0; 'accesspoints.downloading.count'=0;;;0; 'accesspoints.enabled.count'=2;;;0; 'accesspoints.disabled.count'=0;;;0; 'ap-1200d-emb-2~0#accesspoint.radio.interface.channels.utilization.percentage'=54%;;;0;100 'ap-1200d-emb-4~0#accesspoint.radio.interface.channels.utilization.percentage'=36%;;;0;100 -Model: AIR-CT5508-K9 -checking access point 'ap-1200d-emb-2' - status: associated - radio interface '0' status: up, channels utilization: 54 % - radio interface '1' is disabled -checking access point 'ap-1200d-emb-4' - status: associated - radio interface '0' status: up, channels utilization: 36 % - radio interface '1' is disabled +OK: All interfaces are ok | 'interface_name1#interface.traffic.in.bitspersecond'=51920b/s;80;90;; 'interface_name2#interface.traffic.in.bitspersecond'=36127b/s;80;90;; 'interface_name1#interface.traffic.out.bitspersecond'=17785b/s;80;90;; 'interface_name2#interface.traffic.out.bitspersecond'=10288b/s;80;90;; ``` ### Diagnostic des erreurs communes @@ -563,17 +569,17 @@ Le plugin apporte les modes suivants : | ap-status [[code](https://github.com/centreon/centreon-plugins/blob/develop/src/centreon/common/airespace/snmp/mode/apstatus.pm)] | Net-Cisco-Wlc-Ap-Status-SNMP-Access-Point-custom
Net-Cisco-Wlc-Ap-Status-Global-SNMP-custom | | ap-users [[code](https://github.com/centreon/centreon-plugins/blob/develop/src/centreon/common/airespace/snmp/mode/apusers.pm)] | Net-Cisco-Wlc-Ap-Users-SNMP-Access-Point-custom
Net-Cisco-Wlc-Ap-Users-SNMP-custom | | cpu [[code](https://github.com/centreon/centreon-plugins/blob/develop/src/centreon/common/airespace/snmp/mode/cpu.pm)] | Net-Cisco-Wlc-Cpu-SNMP-custom | -| discovery [[code](https://github.com/centreon/centreon-plugins/blob/develop/src/centreon/common/airespace/snmp/mode/discovery.pm)] | Used for host discovery | +| discovery [[code](https://github.com/centreon/centreon-plugins/blob/develop/src/centreon/common/airespace/snmp/mode/discovery.pm)] | Utilisé pour la découverte d'hôtes | | hardware [[code](https://github.com/centreon/centreon-plugins/blob/develop/src/centreon/common/airespace/snmp/mode/hardware.pm)] | Net-Cisco-Wlc-Hardware-Global-SNMP-custom | | interfaces [[code](https://github.com/centreon/centreon-plugins/blob/develop/src/snmp_standard/mode/interfaces.pm)] | Net-Cisco-Wlc-Traffic-Generic-Id-SNMP-custom
Net-Cisco-Wlc-Traffic-Generic-Name-SNMP-custom
Net-Cisco-Wlc-Traffic-Global-SNMP-custom | -| list-aps [[code](https://github.com/centreon/centreon-plugins/blob/develop/src/centreon/common/airespace/snmp/mode/listaps.pm)] | Used for service discovery | -| list-groups [[code](https://github.com/centreon/centreon-plugins/blob/develop/src/centreon/common/airespace/snmp/mode/listgroups.pm)] | Not used in this Monitoring Connector | -| list-interfaces [[code](https://github.com/centreon/centreon-plugins/blob/develop/src/snmp_standard/mode/listinterfaces.pm)] | Used for service discovery | -| list-radius-acc-servers [[code](https://github.com/centreon/centreon-plugins/blob/develop/src/centreon/common/airespace/snmp/mode/listradiusaccservers.pm)] | Not used in this Monitoring Connector | -| list-radius-auth-servers [[code](https://github.com/centreon/centreon-plugins/blob/develop/src/centreon/common/airespace/snmp/mode/listradiusauthservers.pm)] | Not used in this Monitoring Connector | +| list-aps [[code](https://github.com/centreon/centreon-plugins/blob/develop/src/centreon/common/airespace/snmp/mode/listaps.pm)] | Utilisé pour la découverte de services | +| list-groups [[code](https://github.com/centreon/centreon-plugins/blob/develop/src/centreon/common/airespace/snmp/mode/listgroups.pm)] | Non utilisé dans ce connecteur de supervision | +| list-interfaces [[code](https://github.com/centreon/centreon-plugins/blob/develop/src/snmp_standard/mode/listinterfaces.pm)] | Utilisé pour la découverte de services | +| list-radius-acc-servers [[code](https://github.com/centreon/centreon-plugins/blob/develop/src/centreon/common/airespace/snmp/mode/listradiusaccservers.pm)] | Non utilisé dans ce connecteur de supervision | +| list-radius-auth-servers [[code](https://github.com/centreon/centreon-plugins/blob/develop/src/centreon/common/airespace/snmp/mode/listradiusauthservers.pm)] | Non utilisé dans ce connecteur de supervision | | memory [[code](https://github.com/centreon/centreon-plugins/blob/develop/src/centreon/common/airespace/snmp/mode/memory.pm)] | Net-Cisco-Wlc-Memory-SNMP-custom | -| radius-acc-servers [[code](https://github.com/centreon/centreon-plugins/blob/develop/src/centreon/common/airespace/snmp/mode/radiusaccservers.pm)] | Not used in this Monitoring Connector | -| radius-auth-servers [[code](https://github.com/centreon/centreon-plugins/blob/develop/src/centreon/common/airespace/snmp/mode/radiusauthservers.pm)] | Not used in this Monitoring Connector | +| radius-acc-servers [[code](https://github.com/centreon/centreon-plugins/blob/develop/src/centreon/common/airespace/snmp/mode/radiusaccservers.pm)] | Non utilisé dans ce connecteur de supervision | +| radius-auth-servers [[code](https://github.com/centreon/centreon-plugins/blob/develop/src/centreon/common/airespace/snmp/mode/radiusauthservers.pm)] | Non utilisé dans ce connecteur de supervision | ### Options disponibles @@ -581,65 +587,67 @@ Le plugin apporte les modes suivants : Les options génériques sont listées ci-dessous : -| 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 ok, 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\[,\[newuom\],\[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\[,\[newuom\],\[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\[,\[newuom\],\[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,namesofnewmetrics,calculation\[,\[newuom\],\[min\],\[max\]\] regex: regular expression namesofnewmetrics: 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 newuom (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~replacement~modifier Most commonly used modifiers are i (case insensitive) and g (replace all occurrences). Example: adding --change-short-output='OK\~Up\~gi' will replace all occurrences of 'OK', 'ok', 'Ok' or 'oK' with 'Up' | -| --change-short-output | Modify the short/long output that is returned by the plugin. Syntax: --change-short-output=pattern~replacement~modifier Most commonly used modifiers are i (case insensitive) and g (replace all occurrences). Example: adding --change-short-output='OK\~Up\~gi' will replace all occurrences of 'OK', 'ok', 'Ok' or 'oK' with 'Up' | -| --change-long-output | Modify the short/long output that is returned by the plugin. Syntax: --change-short-output=pattern~replacement~modifier Most commonly used modifiers are i (case insensitive) and g (replace all occurrences). Example: adding --change-short-output='OK\~Up\~gi' will replace all occurrences of 'OK', 'ok', 'Ok' or 'oK' with 'Up' | -| --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. | -| --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). E.g.: --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\. =cut | +| 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 get-next 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 ok, 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. | +| --show-password | By default, sensitive information in command lines is hidden in debug output and replaced with `***` (however, debug logs may still display sensitive information). Using the C option will display the passwords in plain text. | +| --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\[,\[\\],\[min\],\[max\]\] Common examples: onvert 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\[,\[\\],\[min\],\[max\]\] Common examples: onvert 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\[,\[\\],\[min\],\[max\]\] Common examples: onvert 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,\,calculation\[,\[\\],\[min\],\[max\]\] regex: regular expression \: 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 \ (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: um 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~replacement~modifier Most commonly used modifiers are i (case insensitive) and g (replace all occurrences). Example: adding --change-short-output='OK~Up~gi' will replace all occurrences of 'OK', 'ok', 'Ok' or 'oK' with 'Up' | +| --change-short-output | Modify the short/long output that is returned by the plugin. Syntax: --change-short-output=pattern~replacement~modifier Most commonly used modifiers are i (case insensitive) and g (replace all occurrences). Example: adding --change-short-output='OK~Up~gi' will replace all occurrences of 'OK', 'ok', 'Ok' or 'oK' with 'Up' | +| --change-long-output | Modify the short/long output that is returned by the plugin. Syntax: --change-short-output=pattern~replacement~modifier Most commonly used modifiers are i (case insensitive) and g (replace all occurrences). Example: adding --change-short-output='OK~Up~gi' will replace all occurrences of 'OK', 'ok', 'Ok' or 'oK' with 'Up' | +| --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'. \. | #### Options des modes @@ -648,148 +656,200 @@ Les options disponibles pour chaque modèle de services sont listées ci-dessous -| Option | Description | -|:-------------------------|:----------------------------------------------------------------------------------------------------| -| --filter-counters | Only display some counters (regexp can be used). Example: --filter-counters='interference-util' | -| --filter-name | Filter access point name (can be a regexp). | -| --filter-group | Filter access point group (can be a regexp). | -| --filter-channel | Filter channel (can be a regexp). Example: --filter-channel='slot0:channel3' | -| --warning-* --critical-* | Thresholds. Can be: 'interference-power', 'interference-util' (%). | +| Option | Description | +|:-------------------------|:------------------------------------------------------------------------------------------------| +| --filter-counters | Only display some counters (regexp can be used). Example: --filter-counters='interference-util' | +| --warning-xxx | Warning threshold. | +| --critical-xxx | Critical threshold. | +| --filter-name | Filter access point name (can be a regexp). | +| --filter-group | Filter access point group (can be a regexp). | +| --filter-channel | Filter channel (can be a regexp). Example: --filter-channel='slot0:channel3' | +| --warning-* --critical-* | Thresholds. Can be: 'interference-power', 'interference-util' (%). | -| Option | Description | -|:-------------------------|:------------------------------------------------------------------------------------------------------------------------------| -| --filter-counters | Only display some counters (regexp can be used). Example to check SSL connections only : --filter-counters='^xxxx\|yyyy$' | -| --filter-name | Filter access point name (can be a regexp). | -| --filter-group | Filter access point group (can be a regexp). | -| --filter-channel | Filter channel (can be a regexp). Example: --filter-channel='slot0:channel3' | -| --warning-* --critical-* | Thresholds. Can be: 'noise-power' (dBm). | +| Option | Description | +|:-------------------------|:--------------------------------------------------------------------------------------------------------------------------| +| --filter-counters | Only display some counters (regexp can be used). Example to check SSL connections only : --filter-counters='^xxxx\|yyyy$' | +| --warning-xxx | Warning threshold. | +| --critical-xxx | Critical threshold. | +| --filter-name | Filter access point name (can be a regexp). | +| --filter-group | Filter access point group (can be a regexp). | +| --filter-channel | Filter channel (can be a regexp). Example: --filter-channel='slot0:channel3' | +| --warning-* --critical-* | Thresholds. Can be: 'noise-power' (dBm). | -| Option | Description | -|:-------------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| --filter-counters | Only display some counters (regexp can be used). Example: --filter-counters='^total-disassociating\|total-associated$' | -| --filter-name | Filter access point name (can be a regexp). | -| --filter-group | Filter access point group (can be a regexp). | -| --add-radio-interfaces | Monitor radio interfaces channels utilization. | -| --warning-status | Define the conditions to match for the status to be WARNING. You can use the following variables: %\{admstatus\}, %\{opstatus\}, %\{display\} | -| --critical-status | Define the conditions to match for the status to be CRITICAL (default: '%\{admstatus\} eq "enable" and %\{opstatus\} !~ /associated\|downloading/'). You can use the following variables: %\{admstatus\}, %\{opstatus\}, %\{display\} | -| --warning-radio-status | Define the conditions to match for the status to be WARNING. You can use the following variables: %\{admstatus\}, %\{opstatus\}, %\{display\} | -| --critical-radio-status | Define the conditions to match for the status to be CRITICAL (default: '%\{admstatus\} eq "enable" and %\{opstatus\} eq "down"'). You can use the following variables: %\{admstatus\}, %\{opstatus\}, %\{display\} | -| --warning-* --critical-* | Thresholds. Can be: 'total', 'total-associated', 'total-disassociating', 'total-downloading', 'total-enabled', 'total-disabled', 'radio-interface-channels-utilization' (%). | +| Option | Description | +|:-------------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| --filter-counters | Only display some counters (regexp can be used). Example: --filter-counters='^total-disassociating\|total-associated$' | +| --warning-xxx | Warning threshold. | +| --critical-xxx | Critical threshold. | +| --filter-name | Filter access point name (can be a regexp). | +| --filter-group | Filter access point group (can be a regexp). | +| --add-radio-interfaces | Monitor radio interfaces channels utilization. | +| --warning-status | Define the conditions to match for the status to be WARNING. You can use the following variables: %\{admstatus\}, %\{opstatus\}, %\{display\} | +| --critical-status | Define the conditions to match for the status to be CRITICAL (default: '%\{admstatus\} eq "enable" and %\{opstatus\} !~ /associated\|downloading/'). You can use the following variables: %\{admstatus\}, %\{opstatus\}, %\{display\} | +| --warning-radio-status | Define the conditions to match for the status to be WARNING. You can use the following variables: %\{admstatus\}, %\{opstatus\}, %\{display\} | +| --critical-radio-status | Define the conditions to match for the status to be CRITICAL (default: '%\{admstatus\} eq "enable" and %\{opstatus\} eq "down"'). You can use the following variables: %\{admstatus\}, %\{opstatus\}, %\{display\} | +| --warning-* --critical-* | Thresholds. Can be: 'total', 'total-associated', 'total-disassociating', 'total-downloading', 'total-enabled', 'total-disabled', 'radio-interface-channels-utilization' (%). | -| Option | Description | -|:-------------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| --filter-counters | Only display some counters (regexp can be used). Example: --filter-counters='^total-disassociating\|total-associated$' | -| --filter-name | Filter access point name (can be a regexp). | -| --filter-group | Filter access point group (can be a regexp). | -| --add-radio-interfaces | Monitor radio interfaces channels utilization. | -| --warning-status | Define the conditions to match for the status to be WARNING. You can use the following variables: %\{admstatus\}, %\{opstatus\}, %\{display\} | -| --critical-status | Define the conditions to match for the status to be CRITICAL (default: '%\{admstatus\} eq "enable" and %\{opstatus\} !~ /associated\|downloading/'). You can use the following variables: %\{admstatus\}, %\{opstatus\}, %\{display\} | -| --warning-radio-status | Define the conditions to match for the status to be WARNING. You can use the following variables: %\{admstatus\}, %\{opstatus\}, %\{display\} | -| --critical-radio-status | Define the conditions to match for the status to be CRITICAL (default: '%\{admstatus\} eq "enable" and %\{opstatus\} eq "down"'). You can use the following variables: %\{admstatus\}, %\{opstatus\}, %\{display\} | -| --warning-* --critical-* | Thresholds. Can be: 'total', 'total-associated', 'total-disassociating', 'total-downloading', 'total-enabled', 'total-disabled', 'radio-interface-channels-utilization' (%). | +| Option | Description | +|:-------------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| --filter-counters | Only display some counters (regexp can be used). Example: --filter-counters='^total-disassociating\|total-associated$' | +| --warning-xxx | Warning threshold. | +| --critical-xxx | Critical threshold. | +| --filter-name | Filter access point name (can be a regexp). | +| --filter-group | Filter access point group (can be a regexp). | +| --add-radio-interfaces | Monitor radio interfaces channels utilization. | +| --warning-status | Define the conditions to match for the status to be WARNING. You can use the following variables: %\{admstatus\}, %\{opstatus\}, %\{display\} | +| --critical-status | Define the conditions to match for the status to be CRITICAL (default: '%\{admstatus\} eq "enable" and %\{opstatus\} !~ /associated\|downloading/'). You can use the following variables: %\{admstatus\}, %\{opstatus\}, %\{display\} | +| --warning-radio-status | Define the conditions to match for the status to be WARNING. You can use the following variables: %\{admstatus\}, %\{opstatus\}, %\{display\} | +| --critical-radio-status | Define the conditions to match for the status to be CRITICAL (default: '%\{admstatus\} eq "enable" and %\{opstatus\} eq "down"'). You can use the following variables: %\{admstatus\}, %\{opstatus\}, %\{display\} | +| --warning-* --critical-* | Thresholds. Can be: 'total', 'total-associated', 'total-disassociating', 'total-downloading', 'total-enabled', 'total-disabled', 'radio-interface-channels-utilization' (%). | -| Option | Description | -|:-------------------------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| --filter-counters | Only display some counters (regexp can be used). Example: --filter-counters='^total\|total-idle$' | -| --filter-ssid | Filter by SSID (can be a regexp). | -| --filter-ap | Filter by access point name (can be a regexp). | -| --filter-group | Filter by access point group (can be a regexp). | -| --ignore-ap-users | Unmonitor users by access points. | -| --warning-* --critical-* | Thresholds. Can be: 'total', 'total-idle', 'total-aaapending', 'total-authenticated', 'total-associated', 'total-powersave', 'total-disassociated', 'total-tobedeleted', 'total-probing', 'total-blacklisted', 'ssid', 'ap'. | +| Option | Description | +|:-------------------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| --filter-counters | Only display some counters (regexp can be used). Example: --filter-counters='^total\|total-idle$' | +| --warning-xxx | Warning threshold. | +| --critical-xxx | Critical threshold. | +| --filter-ssid | Filter by SSID (can be a regexp). | +| --filter-ap | Filter by access point name (can be a regexp). | +| --filter-group | Filter by access point group (can be a regexp). | +| --ignore-ap-users | Unmonitor users by access points. | +| --warning-* --critical-* | Thresholds. Can be: 'total', 'total-idle', 'total-aaapending', 'total-authenticated', 'total-associated', 'total-powersave', 'total-disassociated', 'total-tobedeleted', 'total-probing', 'total-blacklisted', 'ssid', 'ap'. | -| Option | Description | -|:---------------------------|:------------------------------------------------------------------------------------------------------------------------------| -| --filter-counters | Only display some counters (regexp can be used). Example to check SSL connections only : --filter-counters='^xxxx\|yyyy$' | -| --warning-cpu-utilization | Warning threshold in percent. | -| --critical-cpu-utilization | Critical threshold in percent. | +| Option | Description | +|:---------------------------|:--------------------------------------------------------------------------------------------------------------------------| +| --filter-counters | Only display some counters (regexp can be used). Example to check SSL connections only : --filter-counters='^xxxx\|yyyy$' | +| --warning-xxx | Warning threshold. | +| --critical-xxx | Critical threshold. | +| --warning-cpu-utilization | Warning threshold in percent. | +| --critical-cpu-utilization | Critical threshold in percent. | -| Option | Description | -|:---------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| --component | Which component to check (default: '.*'). Can be: 'psu'. | -| --filter | Exclude the items given as a comma-separated list (example: --filter=psu). You can also exclude items from specific instances: --filter=psu,1 | -| --absent-problem | Return an error if an entity is not 'present' (default is skipping) (comma separated list) Can be specific or global: --absent-problem=psu,1 | -| --no-component | Define the expected status if no components are found (default: critical). | -| --threshold-overload | Use this option to override the status returned by the plugin when the status label matches a regular expression (syntax: section,\[instance,\]status,regexp). Example: --threshold-overload='psu,WARNING,not operational' | -| --warning | Define the warning threshold for temperatures (syntax: type,instance,threshold) Example: --warning='temperature,.*,30' | -| --critical | Define the critical threshold for temperatures (syntax: type,instance,threshold) Example: --critical='temperature,.*,40' | -| --warning-count-* | Define the warning threshold for the number of components of one type (replace '*' with the component type). | -| --critical-count-* | Define the critical threshold for the number of components of one type (replace '*' with the component type). | +| Option | Description | +|:---------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| --component | Which component to check (default: '.*'). Can be: 'psu'. | +| --filter | Exclude the items given as a comma-separated list (example: --filter=psu). You can also exclude items from specific instances: --filter=psu,1 | +| --absent-problem | Return an error if an entity is not 'present' (default is skipping) (comma separated list) Can be specific or global: --absent-problem=psu,1 | +| --no-component | Define the expected status if no components are found (default: critical). | +| --threshold-overload | Use this option to override the status returned by the plugin when the status label matches a regular expression (syntax: section,\[instance,\]status,regexp). Example: --threshold-overload='psu,WARNING,not operational' | +| --warning | Define the warning threshold for temperatures (syntax: type,instance,threshold) Example: --warning='temperature,.*,30' | +| --critical | Define the critical threshold for temperatures (syntax: type,instance,threshold) Example: --critical='temperature,.*,40' | +| --warning-count-* | Define the warning threshold for the number of components of one type (replace '*' with the component type). | +| --critical-count-* | Define the critical threshold for the number of components of one type (replace '*' with the component type). | -| Option | Description | -|:-------------------------|:------------------------------------------------------------------------------------------------------------------------------| -| --filter-counters | Only display some counters (regexp can be used). Example to check SSL connections only : --filter-counters='^xxxx\|yyyy$' | -| --warning-* --critical-* | Thresholds. Can be: 'usage' (B), 'usage-free' (B), 'usage-prct' (%). | +| Option | Description | +|:-------------------------|:--------------------------------------------------------------------------------------------------------------------------| +| --filter-counters | Only display some counters (regexp can be used). Example to check SSL connections only : --filter-counters='^xxxx\|yyyy$' | +| --warning-xxx | Warning threshold. | +| --critical-xxx | Critical threshold. | +| --warning-* --critical-* | Thresholds. Can be: 'usage' (B), 'usage-free' (B), 'usage-prct' (%). | -| Option | Description | -|:------------------------------------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| --filter-counters | Only display some counters (regexp can be used). Example to check SSL connections only : --filter-counters='^xxxx\|yyyy$' | -| --memcached | Memcached server to use (only one server). | -| --redis-server | Redis server to use (only one server). Syntax: address\[:port\] | -| --redis-attribute | Set Redis Options (--redis-attribute="cnx\_timeout=5"). | -| --redis-db | Set Redis database index. | -| --failback-file | Failback on a local file if Redis connection fails. | -| --memexpiration | Time to keep data in seconds (default: 86400). | -| --statefile-dir | Define the cache directory (default: '/var/lib/centreon/centplugins'). | -| --statefile-suffix | Define a suffix to customize the statefile name (default: ''). | -| --statefile-concat-cwd | If used with the '--statefile-dir' option, the latter's value will be used as a sub-directory of the current working directory. Useful on Windows when the plugin is compiled, as the file system and permissions are different from Linux. | -| --statefile-format | Define the format used to store the cache. Available formats: 'dumper', 'storable', 'json' (default). | -| --statefile-key | Define the key to encrypt/decrypt the cache. | -| --statefile-cipher | Define the cipher algorithm to encrypt the cache (default: 'AES'). | -| --add-global | Check global port statistics (by default if no --add-* option is set). | -| --add-status | Check interface status. | -| --add-duplex-status | Check duplex status (with --warning-status and --critical-status). | -| --add-traffic | Check interface traffic. | -| --add-errors | Check interface errors. | -| --add-cast | Check interface cast. | -| --add-speed | Check interface speed. | -| --add-volume | Check interface data volume between two checks (not supposed to be graphed, useful for BI reporting). | -| --check-metrics | If the expression is true, metrics are checked (default: '%\{opstatus\} eq "up"'). | -| --warning-status | Define the conditions to match for the status to be WARNING. You can use the following variables: %\{admstatus\}, %\{opstatus\}, %\{duplexstatus\}, %\{display\} | -| --critical-status | Define the conditions to match for the status to be CRITICAL (default: '%\{admstatus\} eq "up" and %\{opstatus\} ne "up"'). You can use the following variables: %\{admstatus\}, %\{opstatus\}, %\{duplexstatus\}, %\{display\} | -| --warning-* --critical-* | Thresholds. Can be: 'total-port', 'total-admin-up', 'total-admin-down', 'total-oper-up', 'total-oper-down', 'in-traffic', 'out-traffic', 'in-error', 'in-discard', 'out-error', 'out-discard', 'in-ucast', 'in-bcast', 'in-mcast', 'out-ucast', 'out-bcast', 'out-mcast', 'speed' (b/s). | -| --units-traffic | Units of thresholds for the traffic (default: 'percent\_delta') ('percent\_delta', 'bps', 'counter'). | -| --units-errors | Units of thresholds for errors/discards (default: 'percent\_delta') ('percent\_delta', 'percent', 'delta', 'deltaps', 'counter'). | -| --units-cast | Units of thresholds for communication types (default: 'percent\_delta') ('percent\_delta', 'percent', 'delta', 'deltaps', 'counter'). | -| --nagvis-perfdata | Display traffic perfdata to be compatible with NagVis widget. | -| --interface | Define the interface filter on IDs (OID indexes, e.g.: 1,2,...). If empty, all interfaces will be monitored. To filter on interface names, see --name. | -| --name | With this option, the interfaces will be filtered by name (given in option --interface) instead of OID index. The name matching mode supports regular expressions. | -| --regex-id | With this option, interface IDs will be filtered using the --interface parameter as a regular expression instead of a list of IDs. | -| --speed | Set interface speed for incoming/outgoing traffic (in Mb). | -| --speed-in | Set interface speed for incoming traffic (in Mb). | -| --speed-out | Set interface speed for outgoing traffic (in Mb). | -| --map-speed-dsl | Get interface speed configuration for interfaces of type 'ADSL' and 'VDSL2'. Syntax: --map-speed-dsl=interface-src-name,interface-dsl-name E.g: --map-speed-dsl=Et0.835,Et0-vdsl2 | -| --force-counters64 | Force to use 64 bits counters only. Can be used to improve performance. | -| --force-counters32 | Force to use 32-bits counters (even with SNMP versions 2c and 3). To use when 64 bits counters are buggy. | -| --reload-cache-time | Time in minutes before reloading cache file (default: 180). | -| --oid-filter | Define the OID to be used to filter interfaces (default: ifName) (values: ifDesc, ifAlias, ifName, IpAddr). | -| --oid-display | Define the OID that will be used to name the interfaces (default: ifName) (values: ifDesc, ifAlias, ifName, IpAddr). | -| --oid-extra-display | Add an OID to display. | -| --display-transform-src --display-transform-dst | Modify the interface name displayed by using a regular expression. Example: adding --display-transform-src='eth' --display-transform-dst='ens' will replace all occurrences of 'eth' with 'ens' | -| --show-cache | Display cache interface data. | +| Option | Description | +|:------------------------------------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| --filter-counters | Only display some counters (regexp can be used). Example to check SSL connections only : --filter-counters='^xxxx\|yyyy$' | +| --warning-xxx | Warning threshold. | +| --critical-xxx | Critical threshold. | +| --memcached | Memcached server to use (only one server). | +| --redis-server | Redis server to use (only one server). Syntax: address\[:port\] | +| --redis-attribute | Set Redis Options (--redis-attribute="cnx\_timeout=5"). | +| --redis-db | Set Redis database index. | +| --failback-file | Fall back on a local file if Redis connection fails. | +| --memexpiration | Time to keep data in seconds (default: 86400). | +| --statefile-dir | Define the cache directory (default: '/var/lib/centreon/centplugins'). | +| --statefile-suffix | Define a suffix to customize the statefile name (default: ''). | +| --statefile-concat-cwd | If used with the '--statefile-dir' option, the latter's value will be used as a sub-directory of the current working directory. Useful on Windows when the plugin is compiled, as the file system and permissions are different from Linux. | +| --statefile-format | Define the format used to store the cache. Available formats: 'dumper', 'storable', 'json' (default). | +| --statefile-key | Define the key to encrypt/decrypt the cache. | +| --statefile-cipher | Define the cipher algorithm to encrypt the cache (default: 'AES'). | +| --add-global | Check global port statistics (by default if no --add-* option is set). | +| --add-status | Check interface status. | +| --add-duplex-status | Check duplex status (with --warning-status and --critical-status). | +| --add-traffic | Check interface traffic. | +| --add-errors | Check interface errors. | +| --add-cast | Check interface cast. | +| --add-speed | Check interface speed. | +| --add-volume | Check interface data volume between two checks (not supposed to be graphed, useful for BI reporting). | +| --check-metrics | If the expression is true, metrics are checked (default: '%\{opstatus\} eq "up"'). | +| --warning-status | Define the conditions to match for the status to be WARNING. You can use the following variables: %\{admstatus\}, %\{opstatus\}, %\{duplexstatus\}, %\{display\} | +| --critical-status | Define the conditions to match for the status to be CRITICAL (default: '%\{admstatus\} eq "up" and %\{opstatus\} ne "up"'). You can use the following variables: %\{admstatus\}, %\{opstatus\}, %\{duplexstatus\}, %\{display\} | +| --warning-total-port | Thresholds. | +| --critical-total-port | Thresholds. | +| --warning-total-admin-up | Thresholds. | +| --critical-total-admin-up | Thresholds. | +| --warning-total-admin-down | Thresholds. | +| --critical-total-admin-down | Thresholds. | +| --warning-total-oper-up | Thresholds. | +| --critical-total-oper-up | Thresholds. | +| --warning-total-oper-down | Thresholds. | +| --critical-total-oper-down | Thresholds. | +| --warning-in-traffic | Thresholds. | +| --critical-in-traffic | Thresholds. | +| --warning-out-traffic | Thresholds. | +| --critical-out-traffic | Thresholds. | +| --warning-in-error | Thresholds. | +| --critical-in-error | Thresholds. | +| --warning-in-discard | Thresholds. | +| --critical-in-discard | Thresholds. | +| --warning-out-error | Thresholds. | +| --critical-out-error | Thresholds. | +| --warning-out-discard | Thresholds. | +| --critical-out-discard | Thresholds. | +| --warning-in-ucast | Thresholds. | +| --critical-in-ucast | Thresholds. | +| --warning-in-bcast | Thresholds. | +| --critical-in-bcast | Thresholds. | +| --warning-in-mcast | Thresholds. | +| --critical-in-mcast | Thresholds. | +| --warning-out-ucast | Thresholds. | +| --critical-out-ucast | Thresholds. | +| --warning-out-bcast | Thresholds. | +| --critical-out-bcast | Thresholds. | +| --warning-out-mcast | Thresholds. | +| --critical-out-mcast | Thresholds. | +| --warning-speed | Thresholds in b/s. | +| --critical-speed | Thresholds in b/s. | +| --units-traffic | Units of thresholds for the traffic (default: 'percent\_delta') ('percent\_delta', 'bps', 'counter'). | +| --units-errors | Units of thresholds for errors/discards (default: 'percent\_delta') ('percent\_delta', 'delta', 'deltaps', 'counter'). | +| --units-cast | Units of thresholds for communication types (default: 'percent\_delta') ('percent\_delta', 'percent', 'delta', 'deltaps', 'counter'). | +| --nagvis-perfdata | Display traffic perfdata to be compatible with NagVis widget. | +| --interface | Check only the interfaces with the specified IDs (OID indexes, e.g.: 1,2,...). If empty, all interfaces will be monitored. To filter on interface names, see --name. | +| --name | With this option, the interfaces will be filtered by name (given in option --interface) instead of OID index. The name matching mode supports regular expressions. | +| --regex-id | With this option, interface IDs will be filtered using the --interface parameter as a regular expression instead of a list of IDs. | +| --speed | Set interface speed for incoming/outgoing traffic (in Mb). | +| --speed-in | Set interface speed for incoming traffic (in Mb). | +| --speed-out | Set interface speed for outgoing traffic (in Mb). | +| --map-speed-dsl | Get interface speed configuration for interfaces of type 'ADSL' and 'VDSL2'. Syntax: --map-speed-dsl=interface-src-name,interface-dsl-name E.g: --map-speed-dsl=Et0.835,Et0-vdsl2 | +| --force-counters64 | Force to use 64 bits counters only. Can be used to improve performance. | +| --force-counters32 | Force to use 32-bit counters (even with SNMP versions 2c and 3). To use when 64 bits counters are buggy. | +| --reload-cache-time | Time in minutes before reloading cache file (default: 180). | +| --oid-filter | Define the OID to be used to filter interfaces (default: ifName) (values: ifDesc, ifAlias, ifName, IpAddr). | +| --oid-display | Define the OID that will be used to name the interfaces (default: ifName) (values: ifDesc, ifAlias, ifName, IpAddr). | +| --oid-extra-display | Add an OID to display. | +| --display-transform-src --display-transform-dst | Modify the interface name displayed by using a regular expression. Example: adding --display-transform-src='eth' --display-transform-dst='ens' will replace all occurrences of 'eth' with 'ens' | +| --show-cache | Display cache interface data. | +| --no-cache-lock | Set to disable locking when accessing cache. | diff --git a/i18n/fr/docusaurus-plugin-content-docs-pp/current/integrations/plugin-packs/procedures/network-firewalls-cisco-asa-snmp.md b/i18n/fr/docusaurus-plugin-content-docs-pp/current/integrations/plugin-packs/procedures/network-firewalls-cisco-asa-snmp.md index f101228fed3d..75e29d54fdb6 100644 --- a/i18n/fr/docusaurus-plugin-content-docs-pp/current/integrations/plugin-packs/procedures/network-firewalls-cisco-asa-snmp.md +++ b/i18n/fr/docusaurus-plugin-content-docs-pp/current/integrations/plugin-packs/procedures/network-firewalls-cisco-asa-snmp.md @@ -37,16 +37,16 @@ Le connecteur apporte les modèles de service suivants -| Alias | Modèle de service | Description | Découverte | -|:---------------------------|:--------------------------------------------------------|:-----------------------------------------------------------------------------------|:----------:| -| Failover | Net-FW-Cisco-Asa-Failover-SNMP-custom | Contrôle l'état du failover | | -| Ipsec-Tunnel | Net-FW-Cisco-Asa-Ipsec-Tunnel-SNMP-custom | Contrôle les tunnels IPSec | | -| Packet-Errors-Generic-Id | Net-FW-Cisco-Asa-Packet-Errors-Generic-Id-SNMP-custom | Contrôle le pourcentage de paquets en erreur/écartés d'une interface réseau | | +| Alias | Modèle de service | Description | Découverte | +|:---------------------------|:--------------------------------------------------------|:------------------------------------------------------------------------------------|:----------:| +| Failover | Net-FW-Cisco-Asa-Failover-SNMP-custom | Contrôle l'état du failover | | +| Ipsec-Tunnel | Net-FW-Cisco-Asa-Ipsec-Tunnel-SNMP-custom | Contrôle les tunnels IPSec | | +| Packet-Errors-Generic-Id | Net-FW-Cisco-Asa-Packet-Errors-Generic-Id-SNMP-custom | Contrôle le pourcentage de paquets en erreur/écartés de plusieurs interfaces réseau | | | Packet-Errors-Generic-Name | Net-FW-Cisco-Asa-Packet-Errors-Generic-Name-SNMP-custom | Contrôle le pourcentage de paquets en erreur/écartés d'une interface réseau | | | Packet-Errors-Global | Net-FW-Cisco-Asa-Packet-Errors-Global-SNMP-custom | Contrôle le pourcentage de paquets en erreur/écartés de plusieurs interfaces réseau | X | -| Traffic-Generic-Id | Net-FW-Cisco-Asa-Traffic-Generic-Id-SNMP-custom | Contrôle le traffic réseau d'une interface réseau | | -| Traffic-Generic-Name | Net-FW-Cisco-Asa-Traffic-Generic-Name-SNMP-custom | Contrôle le traffic réseau d'une interface réseau | | -| Traffic-Global | Net-FW-Cisco-Asa-Traffic-Global-SNMP-custom | Contrôle le traffic réseau de plusieurs interfaces réseau | X | +| Traffic-Generic-Id | Net-FW-Cisco-Asa-Traffic-Generic-Id-SNMP-custom | Contrôle le traffic réseau d'une interface réseau | | +| Traffic-Generic-Name | Net-FW-Cisco-Asa-Traffic-Generic-Name-SNMP-custom | Contrôle le traffic réseau d'une interface réseau | | +| Traffic-Global | Net-FW-Cisco-Asa-Traffic-Global-SNMP-custom | Contrôle le traffic réseau de plusieurs interfaces réseau | X | > Les services listés ci-dessus ne sont pas créés automatiquement lorsqu'un modèle d'hôte est appliqué. Pour les utiliser, [créez un service manuellement](/docs/monitoring/basic-objects/services) et appliquez le modèle de service souhaité. @@ -295,12 +295,14 @@ yum install centreon-plugin-Network-Firewalls-Cisco-Asa-Snmp 2. Complétez les champs **Nom**, **Alias** & **IP Address/DNS** correspondant à votre ressource. 3. Appliquez le modèle d'hôte **Net-FW-Cisco-Asa-SNMP-custom**. -> Si vous utilisez SNMP en version 3, vous devez configurer les paramètres spécifiques associés via la macro **SNMPEXTRAOPTIONS**. -> Plus d'informations dans la section [Troubleshooting SNMP](../getting-started/how-to-guides/troubleshooting-plugins.md#mapping-des-options-snmpv3). - -| Macro | Description | Valeur par défaut | Obligatoire | -|:-----------------|:---------------------------------------------------------------------------------------------------------------------------------------------------|:------------------|:-----------:| -| SNMPEXTRAOPTIONS | Any extra option you may want to add to every command (a --verbose flag for example). Toutes les options sont listées [ici](#options-disponibles). | | | +| Macro | Description | Valeur par défaut | Obligatoire | +|:------------------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------|:------------------|:-----------:| +| SNMP_V3_USERNAME | SNMP v3 only: User name (`securityName`) | | | +| SNMP_V3_AUTH_PROTOCOL | SNMP v3 only: Authentication protocol: MD5\|SHA. Since net-snmp 5.9.1: SHA224\|SHA256\|SHA384\|SHA512 | | | +| SNMP_V3_PRIV_PROTOCOL | 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 | | | +| SNMP_V3_AUTH_PASSPHRASE | SNMP v3 only: Pass phrase hashed using the authentication protocol defined in the --authprotocol option | | | +| SNMP_V3_PRIV_PASSPHRASE | SNMP v3 only: Privacy pass phrase (`privPassword`) to encrypt messages using the protocol defined in the --privprotocol option | | | +| SNMPEXTRAOPTIONS | Any extra option you may want to add to every command (a --verbose flag for example). Toutes les options sont listées [ici](#options-disponibles). | | | 4. [Déployez la configuration](/docs/monitoring/monitoring-servers/deploying-a-configuration). L'hôte apparaît dans la liste des hôtes supervisés, et dans la page **Statut des ressources**. La commande envoyée par le connecteur est indiquée dans le panneau de détails de l'hôte : celle-ci montre les valeurs des macros. @@ -376,14 +378,14 @@ yum install centreon-plugin-Network-Firewalls-Cisco-Asa-Snmp | Macro | Description | Valeur par défaut | Obligatoire | |:-------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------|:------------------|:-----------:| | INTERFACEID | Check only the interfaces with the specified IDs (OID indexes, e.g.: 1,2,...). If empty, all interfaces will be monitored. To filter on interface names, see --name | | | -| WARNINGINDISCARD | Threshold | | | -| CRITICALINDISCARD | Threshold | | | -| WARNINGINERROR | Threshold | | | -| CRITICALINERROR | Threshold | | | -| WARNINGOUTDISCARD | Threshold | | | -| CRITICALOUTDISCARD | Threshold | | | -| WARNINGOUTERROR | Threshold | | | -| CRITICALOUTERROR | Threshold | | | +| WARNINGINDISCARD | Thresholds | | | +| CRITICALINDISCARD | Thresholds | | | +| WARNINGINERROR | Thresholds | | | +| CRITICALINERROR | Thresholds | | | +| WARNINGOUTDISCARD | Thresholds | | | +| CRITICALOUTDISCARD | Thresholds | | | +| WARNINGOUTERROR | Thresholds | | | +| CRITICALOUTERROR | Thresholds | | | | EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). Toutes les options sont listées [ici](#options-disponibles). | | | @@ -392,14 +394,14 @@ yum install centreon-plugin-Network-Firewalls-Cisco-Asa-Snmp | Macro | Description | Valeur par défaut | Obligatoire | |:-------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------|:------------------|:-----------:| | INTERFACENAME | Check only the interfaces with the specified IDs (OID indexes, e.g.: 1,2,...). If empty, all interfaces will be monitored. To filter on interface names, see --name | | | -| WARNINGINDISCARD | Threshold | | | -| CRITICALINDISCARD | Threshold | | | -| WARNINGINERROR | Threshold | | | -| CRITICALINERROR | Threshold | | | -| WARNINGOUTDISCARD | Threshold | | | -| CRITICALOUTDISCARD | Threshold | | | -| WARNINGOUTERROR | Threshold | | | -| CRITICALOUTERROR | Threshold | | | +| WARNINGINDISCARD | Thresholds | | | +| CRITICALINDISCARD | Thresholds | | | +| WARNINGINERROR | Thresholds | | | +| CRITICALINERROR | Thresholds | | | +| WARNINGOUTDISCARD | Thresholds | | | +| CRITICALOUTDISCARD | Thresholds | | | +| WARNINGOUTERROR | Thresholds | | | +| CRITICALOUTERROR | Thresholds | | | | EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). Toutes les options sont listées [ici](#options-disponibles). | | | @@ -408,14 +410,14 @@ yum install centreon-plugin-Network-Firewalls-Cisco-Asa-Snmp | Macro | Description | Valeur par défaut | Obligatoire | |:-------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------|:-------------------------------------------------|:-----------:| | FILTER | Check only the interfaces with the specified IDs (OID indexes, e.g.: 1,2,...). If empty, all interfaces will be monitored. To filter on interface names, see --name | .* | | -| WARNINGINDISCARD | Threshold | | | -| CRITICALINDISCARD | Threshold | | | -| WARNINGINERROR | Threshold | | | -| CRITICALINERROR | Threshold | | | -| WARNINGOUTDISCARD | Threshold | | | -| CRITICALOUTDISCARD | Threshold | | | -| WARNINGOUTERROR | Threshold | | | -| CRITICALOUTERROR | Threshold | | | +| WARNINGINDISCARD | Thresholds | | | +| CRITICALINDISCARD | Thresholds | | | +| WARNINGINERROR | Thresholds | | | +| CRITICALINERROR | Thresholds | | | +| WARNINGOUTDISCARD | Thresholds | | | +| CRITICALOUTDISCARD | Thresholds | | | +| WARNINGOUTERROR | Thresholds | | | +| CRITICALOUTERROR | Thresholds | | | | CRITICALSTATUS | Define the conditions to match for the status to be CRITICAL. You can use the following variables: %\{admstatus\}, %\{opstatus\}, %\{duplexstatus\}, %\{display\} | %\{admstatus\} eq "up" and %\{opstatus\} ne "up" | | | EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). Toutes les options sont listées [ici](#options-disponibles). | --verbose | | @@ -445,10 +447,10 @@ yum install centreon-plugin-Network-Firewalls-Cisco-Asa-Snmp | Macro | Description | Valeur par défaut | Obligatoire | |:-------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------|:------------------|:-----------:| | INTERFACEID | Check only the interfaces with the specified IDs (OID indexes, e.g.: 1,2,...). If empty, all interfaces will be monitored. To filter on interface names, see --name | | | -| WARNINGIN | Threshold | 80 | | -| CRITICALIN | Threshold | 90 | | -| WARNINGOUT | Threshold | 80 | | -| CRITICALOUT | Threshold | 90 | | +| WARNINGIN | Thresholds | 80 | | +| CRITICALIN | Thresholds | 90 | | +| WARNINGOUT | Thresholds | 80 | | +| CRITICALOUT | Thresholds | 90 | | | EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). Toutes les options sont listées [ici](#options-disponibles). | | | @@ -457,10 +459,10 @@ yum install centreon-plugin-Network-Firewalls-Cisco-Asa-Snmp | Macro | Description | Valeur par défaut | Obligatoire | |:--------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------|:------------------|:-----------:| | INTERFACENAME | Check only the interfaces with the specified IDs (OID indexes, e.g.: 1,2,...). If empty, all interfaces will be monitored. To filter on interface names, see --name | | | -| WARNINGIN | Threshold | 80 | | -| CRITICALIN | Threshold | 90 | | -| WARNINGOUT | Threshold | 80 | | -| CRITICALOUT | Threshold | 90 | | +| WARNINGIN | Thresholds | 80 | | +| CRITICALIN | Thresholds | 90 | | +| WARNINGOUT | Thresholds | 80 | | +| CRITICALOUT | Thresholds | 90 | | | EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). Toutes les options sont listées [ici](#options-disponibles). | | | @@ -469,10 +471,10 @@ yum install centreon-plugin-Network-Firewalls-Cisco-Asa-Snmp | Macro | Description | Valeur par défaut | Obligatoire | |:---------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------|:-------------------------------------------------|:-----------:| | FILTER | Check only the interfaces with the specified IDs (OID indexes, e.g.: 1,2,...). If empty, all interfaces will be monitored. To filter on interface names, see --name | .* | | -| WARNINGIN | Threshold | 80 | | -| CRITICALIN | Threshold | 90 | | -| WARNINGOUT | Threshold | 80 | | -| CRITICALOUT | Threshold | 90 | | +| WARNINGIN | Thresholds | 80 | | +| CRITICALIN | Thresholds | 90 | | +| WARNINGOUT | Thresholds | 80 | | +| CRITICALOUT | Thresholds | 90 | | | CRITICALSTATUS | Define the conditions to match for the status to be CRITICAL. You can use the following variables: %\{admstatus\}, %\{opstatus\}, %\{duplexstatus\}, %\{display\} | %\{admstatus\} eq "up" and %\{opstatus\} ne "up" | | | EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). Toutes les options sont listées [ici](#options-disponibles). | --verbose | | @@ -495,7 +497,12 @@ telle que celle-ci (remplacez les valeurs d'exemple par les vôtres) : --mode=interfaces \ --hostname=10.0.0.1 \ --snmp-version='2c' \ - --snmp-community='my-snmp-community' \ + --snmp-community='my-snmp-community' \ + --snmp-username='username' \ + --authpassphrase='' \ + --authprotocol='' \ + --privpassphrase='' \ + --privprotocol='' \ --interface='.*' \ --name \ --add-status \ @@ -571,24 +578,25 @@ Les options génériques sont listées ci-dessous : | --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-force-getnext | Use SNMP get-next 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). | +| --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. | +| --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 ok, warning, critical and unknown (default). | -| --snmp-tls-transport | Transport protocol for TLS communication (can be: 'dtlsudp', 'tlstcp'). | +| --snmp-errors-exit | Expected status in case of SNMP error or timeout. Possible values are ok, 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-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. | +| --show-password | By default, sensitive information in command lines is hidden in debug output and replaced with `***` (however, debug logs may still display sensitive information). Using the C option will display the passwords in plain text. | | --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%;;;; | @@ -596,9 +604,9 @@ Les options génériques sont listées ci-dessous : | --change-perfdata | Change or extend perfdata. Syntax: --extend-perfdata=searchlabel,newlabel,target\[,\[\\],\[min\],\[max\]\] Common examples: onvert 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\[,\[\\],\[min\],\[max\]\] Common examples: onvert 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,\,calculation\[,\[\\],\[min\],\[max\]\] regex: regular expression \: 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 \ (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: um 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~replacement~modifier Most commonly used modifiers are i (case insensitive) and g (replace all occurrences). Example: adding --change-short-output='OK\~Up\~gi' will replace all occurrences of 'OK', 'ok', 'Ok' or 'oK' with 'Up' | -| --change-short-output | Modify the short/long output that is returned by the plugin. Syntax: --change-short-output=pattern~replacement~modifier Most commonly used modifiers are i (case insensitive) and g (replace all occurrences). Example: adding --change-short-output='OK\~Up\~gi' will replace all occurrences of 'OK', 'ok', 'Ok' or 'oK' with 'Up' | -| --change-long-output | Modify the short/long output that is returned by the plugin. Syntax: --change-short-output=pattern~replacement~modifier Most commonly used modifiers are i (case insensitive) and g (replace all occurrences). Example: adding --change-short-output='OK\~Up\~gi' will replace all occurrences of 'OK', 'ok', 'Ok' or 'oK' with 'Up' | +| --change-short-output --change-long-output | Modify the short/long output that is returned by the plugin. Syntax: --change-short-output=pattern~replacement~modifier Most commonly used modifiers are i (case insensitive) and g (replace all occurrences). Example: adding --change-short-output='OK~Up~gi' will replace all occurrences of 'OK', 'ok', 'Ok' or 'oK' with 'Up' | +| --change-short-output | Modify the short/long output that is returned by the plugin. Syntax: --change-short-output=pattern~replacement~modifier Most commonly used modifiers are i (case insensitive) and g (replace all occurrences). Example: adding --change-short-output='OK~Up~gi' will replace all occurrences of 'OK', 'ok', 'Ok' or 'oK' with 'Up' | +| --change-long-output | Modify the short/long output that is returned by the plugin. Syntax: --change-short-output=pattern~replacement~modifier Most commonly used modifiers are i (case insensitive) and g (replace all occurrences). Example: adding --change-short-output='OK~Up~gi' will replace all occurrences of 'OK', 'ok', 'Ok' or 'oK' with 'Up' | | --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. | @@ -625,6 +633,8 @@ Les options disponibles pour chaque modèle de services sont listées ci-dessous | Option | Description | |:-------------------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | --filter-counters | Only display some counters (regexp can be used). Example to check SSL connections only : --filter-counters='^xxxx\|yyyy$' | +| --warning-xxx | Warning threshold. | +| --critical-xxx | Critical threshold. | | --check-order | Check CPU in standard cisco mib. If you have some issue (wrong CPU information in a specific mib), you can change the order (default: 'process,old\_sys,system\_ext'). | | --warning-* --critical-* | Thresholds. Can be: 'core-5s', 'core-1m', 'core-5m', 'average-5s', 'average-1m', 'average-5m'. | @@ -634,6 +644,8 @@ Les options disponibles pour chaque modèle de services sont listées ci-dessous | Option | Description | |:------------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | --filter-counters | Only display some counters (regexp can be used). Example: --filter-counters='^status$' | +| --warning-xxx | Warning threshold. | +| --critical-xxx | Critical threshold. | | --warning-status | Define the conditions to match for the status to be WARNING. You can use the following variables: %\{primaryStateLast\}, %\{secondaryStateLast\}, %\{primaryState\}, %\{secondaryState\} | | --critical-status | Define the conditions to match for the status to be CRITICAL. You can use the following variables: %\{primaryStateLast\}, %\{secondaryStateLast\}, %\{primaryState\}, %\{secondaryState\} | | --warning-* | Warning threshold. Can be: 'active-units'. | @@ -645,6 +657,8 @@ Les options disponibles pour chaque modèle de services sont listées ci-dessous | Option | Description | |:------------------|:-------------------------------------------------------------------------------------------------------------------| | --filter-counters | Only display some counters (regexp can be used). Example: --filter-counters='^(tunnels-total)$' | +| --warning-xxx | Warning threshold. | +| --critical-xxx | Critical threshold. | | --filter-name | Filter name (can be a regexp). Example (format localaddr\_remoteaddr): | | --filter-sa | Filter IPSec Security Associations (can be a regexp). Example (format localaddr:localmask\_remoteaddr:remotemask): | | --warning-* | Warning threshold. Can be: 'tunnels-total', 'traffic-in', 'traffic-out', 'drop-in', 'drop-out', 'sa-total'. | @@ -656,6 +670,8 @@ Les options disponibles pour chaque modèle de services sont listées ci-dessous | Option | Description | |:------------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | --filter-counters | Only display some counters (regexp can be used). Example to check SSL connections only : --filter-counters='^xxxx\|yyyy$' | +| --warning-xxx | Warning threshold. | +| --critical-xxx | Critical threshold. | | --warning-usage | Warning threshold in percent. | | --critical-usage | Critical threshold in percent. | | --filter-pool | Filter pool to check (can use regexp). | @@ -664,68 +680,106 @@ Les options disponibles pour chaque modèle de services sont listées ci-dessous -| Option | Description | -|:------------------------------------------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| --filter-counters | Only display some counters (regexp can be used). Example to check SSL connections only : --filter-counters='^xxxx\|yyyy$' | -| --memcached | Memcached server to use (only one server). | -| --redis-server | Redis server to use (only one server). Syntax: address\[:port\] | -| --redis-attribute | Set Redis Options (--redis-attribute="cnx\_timeout=5"). | -| --redis-db | Set Redis database index. | -| --failback-file | Fall back on a local file if Redis connection fails. | -| --memexpiration | Time to keep data in seconds (default: 86400). | -| --statefile-dir | Define the cache directory (default: '/var/lib/centreon/centplugins'). | -| --statefile-suffix | Define a suffix to customize the statefile name (default: ''). | -| --statefile-concat-cwd | If used with the '--statefile-dir' option, the latter's value will be used as a sub-directory of the current working directory. Useful on Windows when the plugin is compiled, as the file system and permissions are different from Linux. | -| --statefile-format | Define the format used to store the cache. Available formats: 'dumper', 'storable', 'json' (default). | -| --statefile-key | Define the key to encrypt/decrypt the cache. | -| --statefile-cipher | Define the cipher algorithm to encrypt the cache (default: 'AES'). | -| --add-global | Check global port statistics (by default if no --add-* option is set). | -| --add-status | Check interface status. | -| --add-duplex-status | Check duplex status (with --warning-status and --critical-status). | -| --add-traffic | Check interface traffic. | -| --add-errors | Check interface errors. | -| --add-cast | Check interface cast. | -| --add-speed | Check interface speed. | -| --add-volume | Check interface data volume between two checks (not supposed to be graphed, useful for BI reporting). | -| --check-metrics | If the expression is true, metrics are checked (default: '%\{opstatus\} eq "up"'). | -| --warning-status | Define the conditions to match for the status to be WARNING. You can use the following variables: %\{admstatus\}, %\{opstatus\}, %\{duplexstatus\}, %\{display\} | -| --critical-status | Define the conditions to match for the status to be CRITICAL (default: '%\{admstatus\} eq "up" and %\{opstatus\} ne "up"'). You can use the following variables: %\{admstatus\}, %\{opstatus\}, %\{duplexstatus\}, %\{display\} | -| --warning-* --critical-* | Thresholds. Can be: 'total-port', 'total-admin-up', 'total-admin-down', 'total-oper-up', 'total-oper-down', 'in-traffic', 'out-traffic', 'in-error', 'in-discard', 'out-error', 'out-discard', 'in-ucast', 'in-bcast', 'in-mcast', 'out-ucast', 'out-bcast', 'out-mcast', 'speed' (b/s). | -| --units-traffic | Units of thresholds for the traffic (default: 'percent\_delta') ('percent\_delta', 'bps', 'counter'). | -| --units-errors | Units of thresholds for errors/discards (default: 'percent\_delta') ('percent\_delta', 'percent', 'delta', 'deltaps', 'counter'). | -| --units-cast | Units of thresholds for communication types (default: 'percent\_delta') ('percent\_delta', 'percent', 'delta', 'deltaps', 'counter'). | -| --nagvis-perfdata | Display traffic perfdata to be compatible with NagVis widget. | -| --interface | Check only the interfaces with the specified IDs (OID indexes, e.g.: 1,2,...). If empty, all interfaces will be monitored. To filter on interface names, see --name. | -| --name | With this option, the interfaces will be filtered by name (given in option --interface) instead of OID index. The name matching mode supports regular expressions. | -| --regex-id | With this option, interface IDs will be filtered using the --interface parameter as a regular expression instead of a list of IDs. | -| --speed | Set interface speed for incoming/outgoing traffic (in Mb). | -| --speed-in | Set interface speed for incoming traffic (in Mb). | -| --speed-out | Set interface speed for outgoing traffic (in Mb). | -| --map-speed-dsl | Get interface speed configuration for interfaces of type 'ADSL' and 'VDSL2'. Syntax: --map-speed-dsl=interface-src-name,interface-dsl-name E.g: --map-speed-dsl=Et0.835,Et0-vdsl2 | -| --force-counters64 | Force to use 64 bits counters only. Can be used to improve performance. | -| --force-counters32 | Force to use 32-bit counters (even with SNMP versions 2c and 3). To use when 64 bits counters are buggy. | -| --reload-cache-time | Time in minutes before reloading cache file (default: 180). | -| --oid-filter | Define the OID to be used to filter interfaces (default: ifName) (values: ifDesc, ifAlias, ifName, IpAddr). | -| --oid-display | Define the OID that will be used to name the interfaces (default: ifName) (values: ifDesc, ifAlias, ifName, IpAddr). | -| --oid-extra-display | Add an OID to display. | -| --display-transform-src --display-transform-dst | Modify the interface name displayed by using a regular expression. Example: adding --display-transform-src='eth' --display-transform-dst='ens' will replace all occurrences of 'eth' with 'ens' | -| --show-cache | Display cache interface data. | +| Option | Description | +|:------------------------------------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| --filter-counters | Only display some counters (regexp can be used). Example to check SSL connections only : --filter-counters='^xxxx\|yyyy$' | +| --warning-xxx | Warning threshold. | +| --critical-xxx | Critical threshold. | +| --memcached | Memcached server to use (only one server). | +| --redis-server | Redis server to use (only one server). Syntax: address\[:port\] | +| --redis-attribute | Set Redis Options (--redis-attribute="cnx\_timeout=5"). | +| --redis-db | Set Redis database index. | +| --failback-file | Fall back on a local file if Redis connection fails. | +| --memexpiration | Time to keep data in seconds (default: 86400). | +| --statefile-dir | Define the cache directory (default: '/var/lib/centreon/centplugins'). | +| --statefile-suffix | Define a suffix to customize the statefile name (default: ''). | +| --statefile-concat-cwd | If used with the '--statefile-dir' option, the latter's value will be used as a sub-directory of the current working directory. Useful on Windows when the plugin is compiled, as the file system and permissions are different from Linux. | +| --statefile-format | Define the format used to store the cache. Available formats: 'dumper', 'storable', 'json' (default). | +| --statefile-key | Define the key to encrypt/decrypt the cache. | +| --statefile-cipher | Define the cipher algorithm to encrypt the cache (default: 'AES'). | +| --add-global | Check global port statistics (by default if no --add-* option is set). | +| --add-status | Check interface status. | +| --add-duplex-status | Check duplex status (with --warning-status and --critical-status). | +| --add-traffic | Check interface traffic. | +| --add-errors | Check interface errors. | +| --add-cast | Check interface cast. | +| --add-speed | Check interface speed. | +| --add-volume | Check interface data volume between two checks (not supposed to be graphed, useful for BI reporting). | +| --check-metrics | If the expression is true, metrics are checked (default: '%\{opstatus\} eq "up"'). | +| --warning-status | Define the conditions to match for the status to be WARNING. You can use the following variables: %\{admstatus\}, %\{opstatus\}, %\{duplexstatus\}, %\{display\} | +| --critical-status | Define the conditions to match for the status to be CRITICAL (default: '%\{admstatus\} eq "up" and %\{opstatus\} ne "up"'). You can use the following variables: %\{admstatus\}, %\{opstatus\}, %\{duplexstatus\}, %\{display\} | +| --warning-total-port | Thresholds. | +| --critical-total-port | Thresholds. | +| --warning-total-admin-up | Thresholds. | +| --critical-total-admin-up | Thresholds. | +| --warning-total-admin-down | Thresholds. | +| --critical-total-admin-down | Thresholds. | +| --warning-total-oper-up | Thresholds. | +| --critical-total-oper-up | Thresholds. | +| --warning-total-oper-down | Thresholds. | +| --critical-total-oper-down | Thresholds. | +| --warning-in-traffic | Thresholds. | +| --critical-in-traffic | Thresholds. | +| --warning-out-traffic | Thresholds. | +| --critical-out-traffic | Thresholds. | +| --warning-in-error | Thresholds. | +| --critical-in-error | Thresholds. | +| --warning-in-discard | Thresholds. | +| --critical-in-discard | Thresholds. | +| --warning-out-error | Thresholds. | +| --critical-out-error | Thresholds. | +| --warning-out-discard | Thresholds. | +| --critical-out-discard | Thresholds. | +| --warning-in-ucast | Thresholds. | +| --critical-in-ucast | Thresholds. | +| --warning-in-bcast | Thresholds. | +| --critical-in-bcast | Thresholds. | +| --warning-in-mcast | Thresholds. | +| --critical-in-mcast | Thresholds. | +| --warning-out-ucast | Thresholds. | +| --critical-out-ucast | Thresholds. | +| --warning-out-bcast | Thresholds. | +| --critical-out-bcast | Thresholds. | +| --warning-out-mcast | Thresholds. | +| --critical-out-mcast | Thresholds. | +| --warning-speed | Thresholds in b/s. | +| --critical-speed | Thresholds in b/s. | +| --units-traffic | Units of thresholds for the traffic (default: 'percent\_delta') ('percent\_delta', 'bps', 'counter'). | +| --units-errors | Units of thresholds for errors/discards (default: 'percent\_delta') ('percent\_delta', 'delta', 'deltaps', 'counter'). | +| --units-cast | Units of thresholds for communication types (default: 'percent\_delta') ('percent\_delta', 'percent', 'delta', 'deltaps', 'counter'). | +| --nagvis-perfdata | Display traffic perfdata to be compatible with NagVis widget. | +| --interface | Check only the interfaces with the specified IDs (OID indexes, e.g.: 1,2,...). If empty, all interfaces will be monitored. To filter on interface names, see --name. | +| --name | With this option, the interfaces will be filtered by name (given in option --interface) instead of OID index. The name matching mode supports regular expressions. | +| --regex-id | With this option, interface IDs will be filtered using the --interface parameter as a regular expression instead of a list of IDs. | +| --speed | Set interface speed for incoming/outgoing traffic (in Mb). | +| --speed-in | Set interface speed for incoming traffic (in Mb). | +| --speed-out | Set interface speed for outgoing traffic (in Mb). | +| --map-speed-dsl | Get interface speed configuration for interfaces of type 'ADSL' and 'VDSL2'. Syntax: --map-speed-dsl=interface-src-name,interface-dsl-name E.g: --map-speed-dsl=Et0.835,Et0-vdsl2 | +| --force-counters64 | Force to use 64 bits counters only. Can be used to improve performance. | +| --force-counters32 | Force to use 32-bit counters (even with SNMP versions 2c and 3). To use when 64 bits counters are buggy. | +| --reload-cache-time | Time in minutes before reloading cache file (default: 180). | +| --oid-filter | Define the OID to be used to filter interfaces (default: ifName) (values: ifDesc, ifAlias, ifName, IpAddr). | +| --oid-display | Define the OID that will be used to name the interfaces (default: ifName) (values: ifDesc, ifAlias, ifName, IpAddr). | +| --oid-extra-display | Add an OID to display. | +| --display-transform-src --display-transform-dst | Modify the interface name displayed by using a regular expression. Example: adding --display-transform-src='eth' --display-transform-dst='ens' will replace all occurrences of 'eth' with 'ens' | +| --show-cache | Display cache interface data. | +| --no-cache-lock | Set to disable locking when accessing cache. | -| Option | Description | -|:---------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| --component | Which component to check (default: '.*'). Can be: 'sensor'. | -| --filter | Exclude some parts (comma separated list) You can also exclude items from specific instances: --filter=sensor,celsius.* | -| --absent-problem | Return an error if a component is not 'present' (default is skipping). It can be set globally or for a specific instance: --absent-problem='component\_name' or --absent-problem='component\_name,instance\_value'. | -| --no-component | Define the expected status if no components are found (default: critical). | -| --threshold-overload | Use this option to override the status returned by the plugin when the status label matches a regular expression (syntax: section,\[instance,\]status,regexp). Example: --threshold-overload='sensor.celsius,OK,nonoperational' | -| --warning | Set warning threshold (syntax: type,regexp,threshold) Example: --warning='sensor.celsius,.*,30' | -| --critical | Set critical threshold (syntax: type,regexp,threshold) Example: --critical='sensor.celsius,.*,40' | -| --warning-count-* | Define the warning threshold for the number of components of one type (replace '*' with the component type). | -| --critical-count-* | Define the critical threshold for the number of components of one type (replace '*' with the component type). | -| --sensor-scale | Apply scaling value (some equipments are buggy. So we don't use scale by default) | +| Option | Description | +|:------------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| --component | Which component to check (default: '.*'). Can be: 'sensor'. | +| --filter | Exclude some parts (comma separated list) You can also exclude items from specific instances: --filter=sensor,celsius.* | +| --absent-problem | Return an error if a component is not 'present' (default is skipping). It can be set globally or for a specific instance: --absent-problem='component\_name' or --absent-problem='component\_name,instance\_value'. | +| --no-component | Define the expected status if no components are found (default: critical). | +| --threshold-overload | Use this option to override the status returned by the plugin when the status label matches a regular expression (syntax: section,\[instance,\]status,regexp). Example: --threshold-overload='sensor.celsius,OK,nonoperational' | +| --warning | Set warning threshold (syntax: type,regexp,threshold) Example: --warning='sensor.celsius,.*,30' | +| --critical | Set critical threshold (syntax: type,regexp,threshold) Example: --critical='sensor.celsius,.*,40' | +| --warning-count-sensor | Threshold. | +| --critical-count-sensor | Threshold. | +| --sensor-scale | Apply scaling value (some equipments are buggy. So we don't use scale by default). package snmp\_standard::mode::components::sensor; use strict; use warnings; my %map\_sensor\_status = (1 =\> 'ok', 2 =\> 'unavailable', 3 =\> 'nonoperational'); my %map\_sensor\_type = ( 1 =\> 'other', 2 =\> 'unknown', 3 =\> 'voltsAC', 4 =\> 'voltsDC', 5 =\> 'amperes', 6 =\> 'watts', 7 =\> 'hertz', 8 =\> 'celsius', 9 =\> 'percentRH', 10 =\> 'rpm', 11 =\> 'cmm', 12 =\> 'truthvalue', 13 =\> 'specialEnum', 14 =\> 'dBm', ); my %map\_sensor\_scale = ( 1 =\> -24, # yocto, 2 =\> -21, # zepto 3 =\> -18, # atto 4 =\> -15, # femto 5 =\> -12, # pico 6 =\> -9, # nano 7 =\> -6, # micro 8 =\> -3, # milli 9 =\> 0, #units 10 =\> 3, #kilo 11 =\> 6, #mega 12 =\> 9, #giga 13 =\> 12, #tera 14 =\> 18, #exa 15 =\> 15, #peta 16 =\> 21, #zetta 17 =\> 24, #yotta ); my %perfdata\_unit = ('other' =\> '', 'unknown' =\> '', 'voltsAC' =\> 'V', 'voltsDC' =\> 'V', 'amperes' =\> 'A', 'watts' =\> 'W', 'hertz' =\> 'Hz', 'celsius' =\> 'C', 'percentRH' =\> '%', 'rpm' =\> 'rpm', 'cmm' =\> '', 'truthvalue' =\> '', 'specialEnum' =\> '', 'dBm' =\> 'dBm', ); my $mapping = \{ entPhySensorType =\> \{ oid =\> '.1.3.6.1.2.1.99.1.1.1.1', map =\> \%map\_sensor\_type \}, entPhySensorScale =\> \{ oid =\> '.1.3.6.1.2.1.99.1.1.1.2', map =\> \%map\_sensor\_scale \}, entPhySensorPrecision =\> \{ oid =\> '.1.3.6.1.2.1.99.1.1.1.3' \}, entPhySensorValue =\> \{ oid =\> '.1.3.6.1.2.1.99.1.1.1.4' \}, entPhySensorOperStatus =\> \{ oid =\> '.1.3.6.1.2.1.99.1.1.1.5', map =\> \%map\_sensor\_status \}, \}; my $oid\_entPhySensorEntry = '.1.3.6.1.2.1.99.1.1.1'; sub load \{ my ($self) = @\_; push @\{$self-\>\{request\}\}, \{ oid =\> $oid\_entPhySensorEntry, end =\> $mapping-\>\{entPhySensorOperStatus\}-\>\{oid\} \}; \} sub check \{ my ($self) = @\_; $self-\>\{output\}-\>output\_add(long\_msg =\> "Checking sensors"); $self-\>\{components\}-\>\{sensor\} = \{name =\> 'sensors', total =\> 0, skip =\> 0\}; return if ($self-\>check\_filter(section =\> 'sensor')); my $oid\_entPhysicalName = '.1.3.6.1.2.1.47.1.1.1.1.7'; my $oid\_entPhysicalDescr = '.1.3.6.1.2.1.47.1.1.1.1.2'; foreach my $oid ($self-\>\{snmp\}-\>oid\_lex\_sort(keys %\{$self-\>\{results\}-\>\{$oid\_entPhysicalName\}\})) \{ next if ($oid !~ /^$oid\_entPhysicalName\.(.*)$/); my $instance = $1; my $result = $self-\>\{snmp\}-\>map\_instance(mapping =\> $mapping, results =\> $self-\>\{results\}-\>\{$oid\_entPhySensorEntry\}, instance =\> $instance); next if (!defined($result-\>\{entPhySensorOperStatus\})); next if ($self-\>check\_filter(section =\> 'sensor', instance =\> $result-\>\{entPhySensorType\} . '.' . $instance)); my $name = $self-\>\{results\}-\>\{$oid\_entPhysicalName\}-\>\{$oid\} ne '' ? $self-\>\{results\}-\>\{$oid\_entPhysicalName\}-\>\{$oid\} : $self-\>\{results\}-\>\{$oid\_entPhysicalDescr\}-\>\{$oid\_entPhysicalDescr . '.' . $instance\}; # It seems there is no scale if (!defined($self-\>\{option\_results\}-\>\{sensor\_scale\})) \{ $result-\>\{entPhySensorValue\} = defined($result-\>\{entPhySensorValue\}) ? $result-\>\{entPhySensorValue\} * (10 ** -($result-\>\{entPhySensorPrecision\})) : undef; \} else \{ $result-\>\{entPhySensorValue\} = defined($result-\>\{entPhySensorValue\}) ? $result-\>\{entPhySensorValue\} * (10 ** ($result-\>\{entPhySensorScale\}) * (10 ** -($result-\>\{entPhySensorPrecision\}))) : undef; \} $self-\>\{components\}-\>\{sensor\}-\>\{total\}++; $self-\>\{output\}-\>output\_add( long\_msg =\> sprintf( "sensor '%s' status is '%s' \[instance = %s, value = %s\]", $name, $result-\>\{entPhySensorOperStatus\}, $result-\>\{entPhySensorType\} . '.' . $instance, defined($result-\>\{entPhySensorValue\}) ? $result-\>\{entPhySensorValue\} : '-' ) ); my $exit = $self-\>get\_severity(label =\> 'sensor', section =\> 'sensor.' . $result-\>\{entPhySensorType\}, value =\> $result-\>\{entPhySensorOperStatus\}); if (!$self-\>\{output\}-\>is\_status(value =\> $exit, compare =\> 'ok', litteral =\> 1)) \{ $self-\>\{output\}-\>output\_add(severity =\> $exit, short\_msg =\> sprintf("Sensor '%s' status is '%s'", $name, $result-\>\{entPhySensorOperStatus\})); \} next if (!defined($result-\>\{entPhySensorValue\}) \|\| $result-\>\{entPhySensorValue\} !~ /\[0-9\]/); my $component = 'sensor.' . $result-\>\{entPhySensorType\}; my ($exit2, $warn, $crit, $checked) = $self-\>get\_severity\_numeric(section =\> $component, instance =\> $instance, value =\> $result-\>\{entPhySensorValue\}); if (!$self-\>\{output\}-\>is\_status(value =\> $exit2, compare =\> 'ok', litteral =\> 1)) \{ $self-\>\{output\}-\>output\_add( severity =\> $exit2, short\_msg =\> sprintf( "Sensor '%s/%s' is %s %s", $name, $instance, $result-\>\{entPhySensorValue\}, $perfdata\_unit\{$result-\>\{entPhySensorType\}\} ) ); \} $self-\>\{output\}-\>perfdata\_add( label =\> $component . '\_' . $name, unit =\> $perfdata\_unit\{$result-\>\{entPhySensorType\}\}, value =\> $result-\>\{entPhySensorValue\}, warning =\> $warn, critical =\> $crit ); \} \} 1; | @@ -733,58 +787,98 @@ Les options disponibles pour chaque modèle de services sont listées ci-dessous | Option | Description | |:------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | --filter-counters | Only display some counters (regexp can be used). Example to check SSL connections only : --filter-counters='^xxxx\|yyyy$' | +| --warning-xxx | Warning threshold. | +| --critical-xxx | Critical threshold. | | --warning-* | Warning threshold. Can be: 'connections-current', 'connections-1m', 'connections-5m', 'sessions-total', 'sessions-email-current', 'sessions-email-psec', 'sessions-ipsec-current', 'sessions-ipsec-psec', 'sessions-l2l-current', 'sessions-lb-psec' 'sessions-lb-current', 'sessions-lb-psec', 'sessions-svc-current', 'sessions-svc-psec', 'sessions-webvpn-current', 'sessions-webvpn-psec'. | | --critical-* | Critical threshold. Can be: 'connections-current', 'connections-1m', 'connections-5m', 'sessions-total', 'sessions-email-current', 'sessions-email-psec', 'sessions-ipsec-current', 'sessions-ipsec-psec', 'sessions-l2l-current', 'sessions-lb-psec' 'sessions-lb-current', 'sessions-lb-psec', 'sessions-svc-current', 'sessions-svc-psec', 'sessions-webvpn-current', 'sessions-webvpn-psec'. | -| Option | Description | -|:------------------------------------------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| --filter-counters | Only display some counters (regexp can be used). Example to check SSL connections only : --filter-counters='^xxxx\|yyyy$' | -| --memcached | Memcached server to use (only one server). | -| --redis-server | Redis server to use (only one server). Syntax: address\[:port\] | -| --redis-attribute | Set Redis Options (--redis-attribute="cnx\_timeout=5"). | -| --redis-db | Set Redis database index. | -| --failback-file | Fall back on a local file if Redis connection fails. | -| --memexpiration | Time to keep data in seconds (default: 86400). | -| --statefile-dir | Define the cache directory (default: '/var/lib/centreon/centplugins'). | -| --statefile-suffix | Define a suffix to customize the statefile name (default: ''). | -| --statefile-concat-cwd | If used with the '--statefile-dir' option, the latter's value will be used as a sub-directory of the current working directory. Useful on Windows when the plugin is compiled, as the file system and permissions are different from Linux. | -| --statefile-format | Define the format used to store the cache. Available formats: 'dumper', 'storable', 'json' (default). | -| --statefile-key | Define the key to encrypt/decrypt the cache. | -| --statefile-cipher | Define the cipher algorithm to encrypt the cache (default: 'AES'). | -| --add-global | Check global port statistics (by default if no --add-* option is set). | -| --add-status | Check interface status. | -| --add-duplex-status | Check duplex status (with --warning-status and --critical-status). | -| --add-traffic | Check interface traffic. | -| --add-errors | Check interface errors. | -| --add-cast | Check interface cast. | -| --add-speed | Check interface speed. | -| --add-volume | Check interface data volume between two checks (not supposed to be graphed, useful for BI reporting). | -| --check-metrics | If the expression is true, metrics are checked (default: '%\{opstatus\} eq "up"'). | -| --warning-status | Define the conditions to match for the status to be WARNING. You can use the following variables: %\{admstatus\}, %\{opstatus\}, %\{duplexstatus\}, %\{display\} | -| --critical-status | Define the conditions to match for the status to be CRITICAL (default: '%\{admstatus\} eq "up" and %\{opstatus\} ne "up"'). You can use the following variables: %\{admstatus\}, %\{opstatus\}, %\{duplexstatus\}, %\{display\} | -| --warning-* --critical-* | Thresholds. Can be: 'total-port', 'total-admin-up', 'total-admin-down', 'total-oper-up', 'total-oper-down', 'in-traffic', 'out-traffic', 'in-error', 'in-discard', 'out-error', 'out-discard', 'in-ucast', 'in-bcast', 'in-mcast', 'out-ucast', 'out-bcast', 'out-mcast', 'speed' (b/s). | -| --units-traffic | Units of thresholds for the traffic (default: 'percent\_delta') ('percent\_delta', 'bps', 'counter'). | -| --units-errors | Units of thresholds for errors/discards (default: 'percent\_delta') ('percent\_delta', 'percent', 'delta', 'deltaps', 'counter'). | -| --units-cast | Units of thresholds for communication types (default: 'percent\_delta') ('percent\_delta', 'percent', 'delta', 'deltaps', 'counter'). | -| --nagvis-perfdata | Display traffic perfdata to be compatible with NagVis widget. | -| --interface | Check only the interfaces with the specified IDs (OID indexes, e.g.: 1,2,...). If empty, all interfaces will be monitored. To filter on interface names, see --name. | -| --name | With this option, the interfaces will be filtered by name (given in option --interface) instead of OID index. The name matching mode supports regular expressions. | -| --regex-id | With this option, interface IDs will be filtered using the --interface parameter as a regular expression instead of a list of IDs. | -| --speed | Set interface speed for incoming/outgoing traffic (in Mb). | -| --speed-in | Set interface speed for incoming traffic (in Mb). | -| --speed-out | Set interface speed for outgoing traffic (in Mb). | -| --map-speed-dsl | Get interface speed configuration for interfaces of type 'ADSL' and 'VDSL2'. Syntax: --map-speed-dsl=interface-src-name,interface-dsl-name E.g: --map-speed-dsl=Et0.835,Et0-vdsl2 | -| --force-counters64 | Force to use 64 bits counters only. Can be used to improve performance. | -| --force-counters32 | Force to use 32-bit counters (even with SNMP versions 2c and 3). To use when 64 bits counters are buggy. | -| --reload-cache-time | Time in minutes before reloading cache file (default: 180). | -| --oid-filter | Define the OID to be used to filter interfaces (default: ifName) (values: ifDesc, ifAlias, ifName, IpAddr). | -| --oid-display | Define the OID that will be used to name the interfaces (default: ifName) (values: ifDesc, ifAlias, ifName, IpAddr). | -| --oid-extra-display | Add an OID to display. | -| --display-transform-src --display-transform-dst | Modify the interface name displayed by using a regular expression. Example: adding --display-transform-src='eth' --display-transform-dst='ens' will replace all occurrences of 'eth' with 'ens' | -| --show-cache | Display cache interface data. | +| Option | Description | +|:------------------------------------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| --filter-counters | Only display some counters (regexp can be used). Example to check SSL connections only : --filter-counters='^xxxx\|yyyy$' | +| --warning-xxx | Warning threshold. | +| --critical-xxx | Critical threshold. | +| --memcached | Memcached server to use (only one server). | +| --redis-server | Redis server to use (only one server). Syntax: address\[:port\] | +| --redis-attribute | Set Redis Options (--redis-attribute="cnx\_timeout=5"). | +| --redis-db | Set Redis database index. | +| --failback-file | Fall back on a local file if Redis connection fails. | +| --memexpiration | Time to keep data in seconds (default: 86400). | +| --statefile-dir | Define the cache directory (default: '/var/lib/centreon/centplugins'). | +| --statefile-suffix | Define a suffix to customize the statefile name (default: ''). | +| --statefile-concat-cwd | If used with the '--statefile-dir' option, the latter's value will be used as a sub-directory of the current working directory. Useful on Windows when the plugin is compiled, as the file system and permissions are different from Linux. | +| --statefile-format | Define the format used to store the cache. Available formats: 'dumper', 'storable', 'json' (default). | +| --statefile-key | Define the key to encrypt/decrypt the cache. | +| --statefile-cipher | Define the cipher algorithm to encrypt the cache (default: 'AES'). | +| --add-global | Check global port statistics (by default if no --add-* option is set). | +| --add-status | Check interface status. | +| --add-duplex-status | Check duplex status (with --warning-status and --critical-status). | +| --add-traffic | Check interface traffic. | +| --add-errors | Check interface errors. | +| --add-cast | Check interface cast. | +| --add-speed | Check interface speed. | +| --add-volume | Check interface data volume between two checks (not supposed to be graphed, useful for BI reporting). | +| --check-metrics | If the expression is true, metrics are checked (default: '%\{opstatus\} eq "up"'). | +| --warning-status | Define the conditions to match for the status to be WARNING. You can use the following variables: %\{admstatus\}, %\{opstatus\}, %\{duplexstatus\}, %\{display\} | +| --critical-status | Define the conditions to match for the status to be CRITICAL (default: '%\{admstatus\} eq "up" and %\{opstatus\} ne "up"'). You can use the following variables: %\{admstatus\}, %\{opstatus\}, %\{duplexstatus\}, %\{display\} | +| --warning-total-port | Thresholds. | +| --critical-total-port | Thresholds. | +| --warning-total-admin-up | Thresholds. | +| --critical-total-admin-up | Thresholds. | +| --warning-total-admin-down | Thresholds. | +| --critical-total-admin-down | Thresholds. | +| --warning-total-oper-up | Thresholds. | +| --critical-total-oper-up | Thresholds. | +| --warning-total-oper-down | Thresholds. | +| --critical-total-oper-down | Thresholds. | +| --warning-in-traffic | Thresholds. | +| --critical-in-traffic | Thresholds. | +| --warning-out-traffic | Thresholds. | +| --critical-out-traffic | Thresholds. | +| --warning-in-error | Thresholds. | +| --critical-in-error | Thresholds. | +| --warning-in-discard | Thresholds. | +| --critical-in-discard | Thresholds. | +| --warning-out-error | Thresholds. | +| --critical-out-error | Thresholds. | +| --warning-out-discard | Thresholds. | +| --critical-out-discard | Thresholds. | +| --warning-in-ucast | Thresholds. | +| --critical-in-ucast | Thresholds. | +| --warning-in-bcast | Thresholds. | +| --critical-in-bcast | Thresholds. | +| --warning-in-mcast | Thresholds. | +| --critical-in-mcast | Thresholds. | +| --warning-out-ucast | Thresholds. | +| --critical-out-ucast | Thresholds. | +| --warning-out-bcast | Thresholds. | +| --critical-out-bcast | Thresholds. | +| --warning-out-mcast | Thresholds. | +| --critical-out-mcast | Thresholds. | +| --warning-speed | Thresholds in b/s. | +| --critical-speed | Thresholds in b/s. | +| --units-traffic | Units of thresholds for the traffic (default: 'percent\_delta') ('percent\_delta', 'bps', 'counter'). | +| --units-errors | Units of thresholds for errors/discards (default: 'percent\_delta') ('percent\_delta', 'delta', 'deltaps', 'counter'). | +| --units-cast | Units of thresholds for communication types (default: 'percent\_delta') ('percent\_delta', 'percent', 'delta', 'deltaps', 'counter'). | +| --nagvis-perfdata | Display traffic perfdata to be compatible with NagVis widget. | +| --interface | Check only the interfaces with the specified IDs (OID indexes, e.g.: 1,2,...). If empty, all interfaces will be monitored. To filter on interface names, see --name. | +| --name | With this option, the interfaces will be filtered by name (given in option --interface) instead of OID index. The name matching mode supports regular expressions. | +| --regex-id | With this option, interface IDs will be filtered using the --interface parameter as a regular expression instead of a list of IDs. | +| --speed | Set interface speed for incoming/outgoing traffic (in Mb). | +| --speed-in | Set interface speed for incoming traffic (in Mb). | +| --speed-out | Set interface speed for outgoing traffic (in Mb). | +| --map-speed-dsl | Get interface speed configuration for interfaces of type 'ADSL' and 'VDSL2'. Syntax: --map-speed-dsl=interface-src-name,interface-dsl-name E.g: --map-speed-dsl=Et0.835,Et0-vdsl2 | +| --force-counters64 | Force to use 64 bits counters only. Can be used to improve performance. | +| --force-counters32 | Force to use 32-bit counters (even with SNMP versions 2c and 3). To use when 64 bits counters are buggy. | +| --reload-cache-time | Time in minutes before reloading cache file (default: 180). | +| --oid-filter | Define the OID to be used to filter interfaces (default: ifName) (values: ifDesc, ifAlias, ifName, IpAddr). | +| --oid-display | Define the OID that will be used to name the interfaces (default: ifName) (values: ifDesc, ifAlias, ifName, IpAddr). | +| --oid-extra-display | Add an OID to display. | +| --display-transform-src --display-transform-dst | Modify the interface name displayed by using a regular expression. Example: adding --display-transform-src='eth' --display-transform-dst='ens' will replace all occurrences of 'eth' with 'ens' | +| --show-cache | Display cache interface data. | +| --no-cache-lock | Set to disable locking when accessing cache. | diff --git a/i18n/fr/docusaurus-plugin-content-docs-pp/current/integrations/plugin-packs/procedures/network-firewalls-pfsense-snmp.md b/i18n/fr/docusaurus-plugin-content-docs-pp/current/integrations/plugin-packs/procedures/network-firewalls-pfsense-snmp.md index f2e7327a1d72..1d7c212d85ca 100644 --- a/i18n/fr/docusaurus-plugin-content-docs-pp/current/integrations/plugin-packs/procedures/network-firewalls-pfsense-snmp.md +++ b/i18n/fr/docusaurus-plugin-content-docs-pp/current/integrations/plugin-packs/procedures/network-firewalls-pfsense-snmp.md @@ -69,9 +69,9 @@ Rendez-vous sur la [documentation dédiée](/docs/monitoring/discovery/hosts-dis #### Découverte de services -| Nom de la règle | Description | -|:-----------------------------------------|:--------------------------------------------------------------------------------------------------| -| Net-FW-Pfsense-Pfinterfaces-SNMP-Traffic | Découvre les interfaces réseau en utilisant leur nom et supervise leur statut et leur utilisation | +| Nom de la règle | Description | +|:-----------------------------------------|:-------------------------------------------------------------------------------------------------| +| Net-FW-Pfsense-Pfinterfaces-SNMP-Traffic | Découvre les interfaces réseau en utilisant leur ID et supervise leur statut et leur utilisation | Rendez-vous sur la [documentation dédiée](/docs/monitoring/discovery/services-discovery) pour en savoir plus sur la découverte automatique de services et sa [planification](/docs/monitoring/discovery/services-discovery/#règles-de-découverte). @@ -260,10 +260,10 @@ Voici le tableau des services pour ce connecteur, détaillant les métriques et ### Configuration du parefeu pfSense -Afin de superviser le pare-feu pfSense, le SNMP v2 ou v3 doit -être configuré comme indiqué sur la documentation officielle fournie par -Netgate: -https://docs.netgate.com/pfsense/en/latest/services/snmp.html +L'agent SNMP doit être activé et configuré sur l'équipement. +Veuillez vous référer à la [documentation officielle](https://docs.netgate.com/pfsense/en/latest/services/snmp.html). +Il se peut que votre équipement nécessite qu'une liste d'adresses autorisées à l'interroger soit paramétrée. +Veillez à ce que les adresses des collecteurs Centreon y figurent bien. ### Flux réseaux @@ -274,6 +274,8 @@ Centreon vers la ressource supervisée. ### Pack +La procédure d'installation des connecteurs de supervision diffère légèrement [suivant que votre licence est offline ou online](../getting-started/how-to-guides/connectors-licenses.md). + 1. Si la plateforme est configurée avec une licence *online*, l'installation d'un paquet n'est pas requise pour voir apparaître le connecteur dans le menu **Configuration > Connecteurs > Connecteurs de supervision**. Au contraire, si la plateforme utilise une licence *offline*, installez le paquet @@ -364,12 +366,14 @@ yum install centreon-plugin-Network-Firewalls-Pfsense-Snmp 2. Complétez les champs **Nom**, **Alias** & **IP Address/DNS** correspondant à votre ressource. 3. Appliquez le modèle d'hôte **Net-FW-Pfsense-SNMP-custom**. -> Si vous utilisez SNMP en version 3, vous devez configurer les paramètres spécifiques associés via la macro **SNMPEXTRAOPTIONS**. -> Plus d'informations dans la section [Troubleshooting SNMP](../getting-started/how-to-guides/troubleshooting-plugins.md#mapping-des-options-snmpv3). - -| Macro | Description | Valeur par défaut | Obligatoire | -|:-----------------|:---------------------------------------------------------------------------------------------------------------------------------------------------|:------------------|:-----------:| -| SNMPEXTRAOPTIONS | Any extra option you may want to add to every command (a --verbose flag for example). Toutes les options sont listées [ici](#options-disponibles). | | | +| Macro | Description | Valeur par défaut | Obligatoire | +|:------------------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------|:------------------|:-----------:| +| SNMP_V3_USERNAME | SNMP v3 only: User name (`securityName`) | | | +| SNMP_V3_AUTH_PROTOCOL | SNMP v3 only: Authentication protocol: MD5\|SHA. Since net-snmp 5.9.1: SHA224\|SHA256\|SHA384\|SHA512 | | | +| SNMP_V3_PRIV_PROTOCOL | 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 | | | +| SNMP_V3_AUTH_PASSPHRASE | SNMP v3 only: Pass phrase hashed using the authentication protocol defined in the --authprotocol option | | | +| SNMP_V3_PRIV_PASSPHRASE | SNMP v3 only: Privacy pass phrase (`privPassword`) to encrypt messages using the protocol defined in the --privprotocol option | | | +| SNMPEXTRAOPTIONS | Any extra option you may want to add to every command (a --verbose flag for example). Toutes les options sont listées [ici](#options-disponibles). | | | 4. [Déployez la configuration](/docs/monitoring/monitoring-servers/deploying-a-configuration). L'hôte apparaît dans la liste des hôtes supervisés, et dans la page **Statut des ressources**. La commande envoyée par le connecteur est indiquée dans le panneau de détails de l'hôte : celle-ci montre les valeurs des macros. @@ -405,7 +409,7 @@ yum install centreon-plugin-Network-Firewalls-Pfsense-Snmp | Macro | Description | Valeur par défaut | Obligatoire | |:-------------|:-------------------------------------------------------------------------------------------------------------------------------------------------|:------------------|:-----------:| | WARNING | Warning threshold average CPU utilization | 80 | | -| CRITICAL | Critical threshold average CPU utilization | 90 | | +| CRITICAL | Critical threshold average CPU utilization | 90 | | | EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). Toutes les options sont listées [ici](#options-disponibles). | | | @@ -527,16 +531,21 @@ telle que celle-ci (remplacez les valeurs d'exemple par les vôtres) : --mode=packet-stats \ --hostname=10.0.0.1 \ --snmp-version='2c' \ - --snmp-community='my-snmp-community' \ - --filter-counters=badoffset \ - --warning-badoffset='' \ - --critical-badoffset='' + --snmp-community='my-snmp-community' \ + --snmp-username='username' \ + --authpassphrase='' \ + --authprotocol='' \ + --privpassphrase='' \ + --privprotocol='' \ + --filter-counters=short \ + --warning-short='' \ + --critical-short='' ``` La commande devrait retourner un message de sortie similaire à : ```bash -OK: Packets Matched Filter Rule : 6/s Bad Offset Packets : 97/s Fragmented Packets : 98/s Short Packets : 25/s Normalized Packets : 79/s Dropped Packets Due To Memory : 51/s | 'packets.matched.persecond'=6/s;;;0;'packets.badoffset.persecond'=97/s;;;0;'packets.fragmented.persecond'=98/s;;;0;'packets.short.persecond'=25/s;;;0;'packets.normalized.persecond'=79/s;;;0;'packets.memorydropped.persecond'=51/s;;;0; +OK: Packets Matched Filter Rule : 29919/s Bad Offset Packets : 62865/s Fragmented Packets : 40117/s Short Packets : 92041/s Normalized Packets : 36172/s Dropped Packets Due To Memory : 34119/s | 'packets.matched.persecond'=29919/s;;;0; 'packets.badoffset.persecond'=62865/s;;;0; 'packets.fragmented.persecond'=40117/s;;;0; 'packets.short.persecond'=92041/s;;;0; 'packets.normalized.persecond'=36172/s;;;0; 'packets.memorydropped.persecond'=34119/s;;;0; ``` ### Diagnostic des erreurs communes @@ -566,13 +575,13 @@ Le plugin apporte les modes suivants : |:-------------------------------------------------------------------------------------------------------------------------------------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | cpu [[code](https://github.com/centreon/centreon-plugins/blob/develop/src/snmp_standard/mode/cpu.pm)] | Net-FW-Pfsense-Cpu-SNMP-custom | | cpu-detailed [[code](https://github.com/centreon/centreon-plugins/blob/develop/src/snmp_standard/mode/cpudetailed.pm)] | Net-FW-Pfsense-Cpu-Detailed-SNMP-custom | -| list-pfinterfaces [[code](https://github.com/centreon/centreon-plugins/blob/develop/src/apps/pfsense/snmp/mode/listpfinterfaces.pm)] | Used for service discovery | +| list-pfinterfaces [[code](https://github.com/centreon/centreon-plugins/blob/develop/src/apps/pfsense/snmp/mode/listpfinterfaces.pm)] | Utilisé pour la découverte de services | | load [[code](https://github.com/centreon/centreon-plugins/blob/develop/src/snmp_standard/mode/loadaverage.pm)] | Net-FW-Pfsense-Load-SNMP-custom | | memory [[code](https://github.com/centreon/centreon-plugins/blob/develop/src/os/freebsd/snmp/mode/memory.pm)] | Net-FW-Pfsense-Memory-SNMP-custom | | packet-stats [[code](https://github.com/centreon/centreon-plugins/blob/develop/src/apps/pfsense/snmp/mode/packetstats.pm)] | Net-FW-Pfsense-Bad-Offset-Packets-SNMP-custom
Net-FW-Pfsense-Fragment-Packets-SNMP-custom
Net-FW-Pfsense-Match-Packets-SNMP-custom
Net-FW-Pfsense-Memory-Dropped-Packets-SNMP-custom
Net-FW-Pfsense-Normalize-Packets-SNMP-custom
Net-FW-Pfsense-Short-Packets-SNMP-custom | | pfinterfaces [[code](https://github.com/centreon/centreon-plugins/blob/develop/src/apps/pfsense/snmp/mode/pfinterfaces.pm)] | Net-FW-Pfsense-Blocked-Packets-Per-Interface-SNMP-custom | | runtime [[code](https://github.com/centreon/centreon-plugins/blob/develop/src/apps/pfsense/snmp/mode/runtime.pm)] | Net-FW-Pfsense-Runtime-SNMP-custom | -| state-table [[code](https://github.com/centreon/centreon-plugins/blob/develop/src/apps/pfsense/snmp/mode/statetable.pm)] | Not used in this Monitoring Connector | +| state-table [[code](https://github.com/centreon/centreon-plugins/blob/develop/src/apps/pfsense/snmp/mode/statetable.pm)] | Non utilisé dans ce connecteur de supervision | | swap [[code](https://github.com/centreon/centreon-plugins/blob/develop/src/snmp_standard/mode/swap.pm)] | Net-FW-Pfsense-Swap-SNMP-custom | | uptime [[code](https://github.com/centreon/centreon-plugins/blob/develop/src/snmp_standard/mode/uptime.pm)] | Net-FW-Pfsense-Uptime-SNMP-custom | @@ -582,66 +591,67 @@ Le plugin apporte les modes suivants : Les options génériques sont listées ci-dessous : -| 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 ok, 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\[,\[\\],\[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\[,\[\\],\[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\[,\[\\],\[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,\,calculation\[,\[\\],\[min\],\[max\]\] regex: regular expression \: 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 \ (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~replacement~modifier Most commonly used modifiers are i (case insensitive) and g (replace all occurrences). Example: adding --change-short-output='OK\~Up\~gi' will replace all occurrences of 'OK', 'ok', 'Ok' or 'oK' with 'Up' | -| --change-short-output | Modify the short/long output that is returned by the plugin. Syntax: --change-short-output=pattern~replacement~modifier Most commonly used modifiers are i (case insensitive) and g (replace all occurrences). Example: adding --change-short-output='OK\~Up\~gi' will replace all occurrences of 'OK', 'ok', 'Ok' or 'oK' with 'Up' | -| --change-long-output | Modify the short/long output that is returned by the plugin. Syntax: --change-short-output=pattern~replacement~modifier Most commonly used modifiers are i (case insensitive) and g (replace all occurrences). Example: adding --change-short-output='OK\~Up\~gi' will replace all occurrences of 'OK', 'ok', 'Ok' or 'oK' with 'Up' | -| --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\. =cut | +| 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 get-next 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 ok, 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. | +| --show-password | By default, sensitive information in command lines is hidden in debug output and replaced with `***` (however, debug logs may still display sensitive information). Using the C option will display the passwords in plain text. | +| --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\[,\[\\],\[min\],\[max\]\] Common examples: onvert 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\[,\[\\],\[min\],\[max\]\] Common examples: onvert 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\[,\[\\],\[min\],\[max\]\] Common examples: onvert 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,\,calculation\[,\[\\],\[min\],\[max\]\] regex: regular expression \: 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 \ (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: um 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~replacement~modifier Most commonly used modifiers are i (case insensitive) and g (replace all occurrences). Example: adding --change-short-output='OK~Up~gi' will replace all occurrences of 'OK', 'ok', 'Ok' or 'oK' with 'Up' | +| --change-short-output | Modify the short/long output that is returned by the plugin. Syntax: --change-short-output=pattern~replacement~modifier Most commonly used modifiers are i (case insensitive) and g (replace all occurrences). Example: adding --change-short-output='OK~Up~gi' will replace all occurrences of 'OK', 'ok', 'Ok' or 'oK' with 'Up' | +| --change-long-output | Modify the short/long output that is returned by the plugin. Syntax: --change-short-output=pattern~replacement~modifier Most commonly used modifiers are i (case insensitive) and g (replace all occurrences). Example: adding --change-short-output='OK~Up~gi' will replace all occurrences of 'OK', 'ok', 'Ok' or 'oK' with 'Up' | +| --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'. \. | #### Options des modes @@ -650,176 +660,198 @@ Les options disponibles pour chaque modèle de services sont listées ci-dessous -| Option | Description | -|:------------------|:----------------------------------------------------------------------------------------------------| -| --filter-counters | Only display some counters (regexp can be used). Example: --filter-counters='^match$' | -| --warning-* | Warning threshold. Can be: 'match', 'badoffset', 'fragment', 'short', 'normalize', 'memdrop'. | -| --critical-* | Critical threshold. Can be: 'match', 'badoffset', 'fragment', 'short', 'normalize', 'memdrop'. | +| Option | Description | +|:------------------|:-----------------------------------------------------------------------------------------------| +| --filter-counters | Only display some counters (regexp can be used). Example: --filter-counters='^match$' | +| --warning-xxx | Warning threshold. | +| --critical-xxx | Critical threshold. | +| --warning-* | Warning threshold. Can be: 'match', 'badoffset', 'fragment', 'short', 'normalize', 'memdrop'. | +| --critical-* | Critical threshold. Can be: 'match', 'badoffset', 'fragment', 'short', 'normalize', 'memdrop'. | -| Option | Description | -|:------------------|:------------------------------------------------------------------------------------------------------------------------------| -| --filter-counters | Only display some counters (regexp can be used). Example to check SSL connections only : --filter-counters='^xxxx\|yyyy$' | -| --warning-* | Warning threshold. Can be: 'traffic-in-pass', 'traffic-out-pass', 'traffic-in-block', 'traffic-out-block'. | -| --critical-* | Critical threshold. Can be: 'traffic-in-pass', 'traffic-out-pass', 'traffic-in-block', 'traffic-out-block'. | -| --filter-name | Filter by interface name (can be a regexp). | +| Option | Description | +|:------------------|:--------------------------------------------------------------------------------------------------------------------------| +| --filter-counters | Only display some counters (regexp can be used). Example to check SSL connections only : --filter-counters='^xxxx\|yyyy$' | +| --warning-xxx | Warning threshold. | +| --critical-xxx | Critical threshold. | +| --warning-* | Warning threshold. Can be: 'traffic-in-pass', 'traffic-out-pass', 'traffic-in-block', 'traffic-out-block'. | +| --critical-* | Critical threshold. Can be: 'traffic-in-pass', 'traffic-out-pass', 'traffic-in-block', 'traffic-out-block'. | +| --filter-name | Filter by interface name (can be a regexp). | -| Option | Description | -|:-------------------|:------------------------------------------------------------------------------------------------------------------------------| -| --filter-counters | Only display some counters (regexp can be used). Example to check SSL connections only : --filter-counters='^xxxx\|yyyy$' | -| --use-ucd | Use UCD MIB for CPU average. | -| --warning-average | Warning threshold average CPU utilization. | -| --critical-average | Critical threshold average CPU utilization. | -| --warning-core | Warning thresholds for each CPU core | -| --critical-core | Critical thresholds for each CPU core | +| Option | Description | +|:-------------------|:--------------------------------------------------------------------------------------------------------------------------| +| --filter-counters | Only display some counters (regexp can be used). Example to check SSL connections only : --filter-counters='^xxxx\|yyyy$' | +| --warning-xxx | Warning threshold. | +| --critical-xxx | Critical threshold. | +| --use-ucd | Use UCD MIB for CPU average. | +| --warning-average | Warning threshold average CPU utilization. | +| --critical-average | Critical threshold average CPU utilization. | +| --warning-core | Warning thresholds for each CPU core | +| --critical-core | Critical thresholds for each CPU core | -| Option | Description | -|:---------------------|:------------------------------------------------------------------------------------------------------------------------------| -| --filter-counters | Only display some counters (regexp can be used). Example to check SSL connections only : --filter-counters='^xxxx\|yyyy$' | -| --warning-guest | Threshold in percentage. | -| --critical-guest | Threshold in percentage. | -| --warning-guestnice | Threshold in percentage. | -| --critical-guestnice | Threshold in percentage. | -| --warning-idle | Threshold in percentage. | -| --critical-idle | Threshold in percentage. | -| --warning-interrupt | Threshold in percentage. | -| --critical-interrupt | Threshold in percentage. | -| --warning-kernel | Threshold in percentage. | -| --critical-kernel | Threshold in percentage. | -| --warning-nice | Threshold in percentage. | -| --critical-nice | Threshold in percentage. | -| --warning-softirq | Threshold in percentage. | -| --critical-softirq | Threshold in percentage. | -| --warning-steal | Threshold in percentage. | -| --critical-steal | Threshold in percentage. | -| --warning-system | Threshold in percentage. | -| --critical-system | Threshold in percentage. | -| --warning-user | Threshold in percentage. | -| --critical-user | Threshold in percentage. | -| --warning-wait | Threshold in percentage. | -| --critical-wait | Threshold in percentage. | +| Option | Description | +|:---------------------|:--------------------------------------------------------------------------------------------------------------------------| +| --filter-counters | Only display some counters (regexp can be used). Example to check SSL connections only : --filter-counters='^xxxx\|yyyy$' | +| --warning-xxx | Warning threshold. | +| --critical-xxx | Critical threshold. | +| --warning-guest | Threshold in percentage. | +| --critical-guest | Threshold in percentage. | +| --warning-guestnice | Threshold in percentage. | +| --critical-guestnice | Threshold in percentage. | +| --warning-idle | Threshold in percentage. | +| --critical-idle | Threshold in percentage. | +| --warning-interrupt | Threshold in percentage. | +| --critical-interrupt | Threshold in percentage. | +| --warning-kernel | Threshold in percentage. | +| --critical-kernel | Threshold in percentage. | +| --warning-nice | Threshold in percentage. | +| --critical-nice | Threshold in percentage. | +| --warning-softirq | Threshold in percentage. | +| --critical-softirq | Threshold in percentage. | +| --warning-steal | Threshold in percentage. | +| --critical-steal | Threshold in percentage. | +| --warning-system | Threshold in percentage. | +| --critical-system | Threshold in percentage. | +| --warning-user | Threshold in percentage. | +| --critical-user | Threshold in percentage. | +| --warning-wait | Threshold in percentage. | +| --critical-wait | Threshold in percentage. | -| Option | Description | -|:------------------|:----------------------------------------------------------------------------------------------------| -| --filter-counters | Only display some counters (regexp can be used). Example: --filter-counters='^match$' | -| --warning-* | Warning threshold. Can be: 'match', 'badoffset', 'fragment', 'short', 'normalize', 'memdrop'. | -| --critical-* | Critical threshold. Can be: 'match', 'badoffset', 'fragment', 'short', 'normalize', 'memdrop'. | +| Option | Description | +|:------------------|:-----------------------------------------------------------------------------------------------| +| --filter-counters | Only display some counters (regexp can be used). Example: --filter-counters='^match$' | +| --warning-xxx | Warning threshold. | +| --critical-xxx | Critical threshold. | +| --warning-* | Warning threshold. Can be: 'match', 'badoffset', 'fragment', 'short', 'normalize', 'memdrop'. | +| --critical-* | Critical threshold. Can be: 'match', 'badoffset', 'fragment', 'short', 'normalize', 'memdrop'. | -| Option | Description | -|:-----------|:------------------------------------------| -| --warning | Warning threshold (1min,5min,15min). | -| --critical | Critical threshold (1min,5min,15min). | -| --average | Load average for the number of CPUs. | +| Option | Description | +|:-----------|:--------------------------------------| +| --warning | Warning threshold (1min,5min,15min). | +| --critical | Critical threshold (1min,5min,15min). | +| --average | Load average for the number of CPUs. | -| Option | Description | -|:------------------|:----------------------------------------------------------------------------------------------------| -| --filter-counters | Only display some counters (regexp can be used). Example: --filter-counters='^match$' | -| --warning-* | Warning threshold. Can be: 'match', 'badoffset', 'fragment', 'short', 'normalize', 'memdrop'. | -| --critical-* | Critical threshold. Can be: 'match', 'badoffset', 'fragment', 'short', 'normalize', 'memdrop'. | +| Option | Description | +|:------------------|:-----------------------------------------------------------------------------------------------| +| --filter-counters | Only display some counters (regexp can be used). Example: --filter-counters='^match$' | +| --warning-xxx | Warning threshold. | +| --critical-xxx | Critical threshold. | +| --warning-* | Warning threshold. Can be: 'match', 'badoffset', 'fragment', 'short', 'normalize', 'memdrop'. | +| --critical-* | Critical threshold. Can be: 'match', 'badoffset', 'fragment', 'short', 'normalize', 'memdrop'. | -| Option | Description | -|:----------------|:--------------------------------------------------------| -| --warning | Warning threshold in percent. | -| --critical | Critical threshold in percent. | -| --swap | Check swap also. | -| --warning-swap | Warning threshold in percent. | -| --critical-swap | Critical threshold in percent. | -| --no-swap | Threshold if no active swap (default: 'critical'). | +| Option | Description | +|:----------------|:---------------------------------------------------| +| --warning | Warning threshold in percent. | +| --critical | Critical threshold in percent. | +| --swap | Check swap also. | +| --warning-swap | Warning threshold in percent. | +| --critical-swap | Critical threshold in percent. | +| --no-swap | Threshold if no active swap (default: 'critical'). | -| Option | Description | -|:------------------|:----------------------------------------------------------------------------------------------------| -| --filter-counters | Only display some counters (regexp can be used). Example: --filter-counters='^match$' | -| --warning-* | Warning threshold. Can be: 'match', 'badoffset', 'fragment', 'short', 'normalize', 'memdrop'. | -| --critical-* | Critical threshold. Can be: 'match', 'badoffset', 'fragment', 'short', 'normalize', 'memdrop'. | +| Option | Description | +|:------------------|:-----------------------------------------------------------------------------------------------| +| --filter-counters | Only display some counters (regexp can be used). Example: --filter-counters='^match$' | +| --warning-xxx | Warning threshold. | +| --critical-xxx | Critical threshold. | +| --warning-* | Warning threshold. Can be: 'match', 'badoffset', 'fragment', 'short', 'normalize', 'memdrop'. | +| --critical-* | Critical threshold. Can be: 'match', 'badoffset', 'fragment', 'short', 'normalize', 'memdrop'. | -| Option | Description | -|:------------------|:----------------------------------------------------------------------------------------------------| -| --filter-counters | Only display some counters (regexp can be used). Example: --filter-counters='^match$' | -| --warning-* | Warning threshold. Can be: 'match', 'badoffset', 'fragment', 'short', 'normalize', 'memdrop'. | -| --critical-* | Critical threshold. Can be: 'match', 'badoffset', 'fragment', 'short', 'normalize', 'memdrop'. | +| Option | Description | +|:------------------|:-----------------------------------------------------------------------------------------------| +| --filter-counters | Only display some counters (regexp can be used). Example: --filter-counters='^match$' | +| --warning-xxx | Warning threshold. | +| --critical-xxx | Critical threshold. | +| --warning-* | Warning threshold. Can be: 'match', 'badoffset', 'fragment', 'short', 'normalize', 'memdrop'. | +| --critical-* | Critical threshold. Can be: 'match', 'badoffset', 'fragment', 'short', 'normalize', 'memdrop'. | -| Option | Description | -|:-----------|:------------------------------------| -| --warning | Warning threshold in seconds. | -| --critical | Critical threshold in seconds. | +| Option | Description | +|:-----------|:-------------------------------| +| --warning | Warning threshold in seconds. | +| --critical | Critical threshold in seconds. | -| Option | Description | -|:------------------|:----------------------------------------------------------------------------------------------------| -| --filter-counters | Only display some counters (regexp can be used). Example: --filter-counters='^match$' | -| --warning-* | Warning threshold. Can be: 'match', 'badoffset', 'fragment', 'short', 'normalize', 'memdrop'. | -| --critical-* | Critical threshold. Can be: 'match', 'badoffset', 'fragment', 'short', 'normalize', 'memdrop'. | +| Option | Description | +|:------------------|:-----------------------------------------------------------------------------------------------| +| --filter-counters | Only display some counters (regexp can be used). Example: --filter-counters='^match$' | +| --warning-xxx | Warning threshold. | +| --critical-xxx | Critical threshold. | +| --warning-* | Warning threshold. Can be: 'match', 'badoffset', 'fragment', 'short', 'normalize', 'memdrop'. | +| --critical-* | Critical threshold. Can be: 'match', 'badoffset', 'fragment', 'short', 'normalize', 'memdrop'. | -| Option | Description | -|:----------------------|:------------------------------------------------------------------------------------------------------------------------------| -| --filter-counters | Only display some counters (regexp can be used). Example to check SSL connections only : --filter-counters='^xxxx\|yyyy$' | -| --no-swap | Threshold if no active swap (default: 'critical'). | -| --warning-usage | Threshold in bytes. | -| --critical-usage | Threshold in bytes. | -| --warning-usage-free | Threshold in bytes. | -| --critical-usage-free | Threshold in bytes. | -| --warning-usage-prct | Threshold in percentage. | -| --critical-usage-prct | Threshold in percentage. | +| Option | Description | +|:----------------------|:--------------------------------------------------------------------------------------------------------------------------| +| --filter-counters | Only display some counters (regexp can be used). Example to check SSL connections only : --filter-counters='^xxxx\|yyyy$' | +| --warning-xxx | Warning threshold. | +| --critical-xxx | Critical threshold. | +| --no-swap | Threshold if no active swap (default: 'critical'). | +| --warning-usage | Threshold in bytes. | +| --critical-usage | Threshold in bytes. | +| --warning-usage-free | Threshold in bytes. | +| --critical-usage-free | Threshold in bytes. | +| --warning-usage-prct | Threshold in percentage. | +| --critical-usage-prct | Threshold in percentage. | -| Option | Description | -|:-----------------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| --filter-counters | Only display some counters (regexp can be used). Example to check SSL connections only : --filter-counters='^xxxx\|yyyy$' | -| --memcached | Memcached server to use (only one server). | -| --redis-server | Redis server to use (only one server). Syntax: address\[:port\] | -| --redis-attribute | Set Redis Options (--redis-attribute="cnx\_timeout=5"). | -| --redis-db | Set Redis database index. | -| --failback-file | Fall back on a local file if Redis connection fails. | -| --memexpiration | Time to keep data in seconds (default: 86400). | -| --statefile-dir | Define the cache directory (default: '/var/lib/centreon/centplugins'). | -| --statefile-suffix | Define a suffix to customize the statefile name (default: ''). | -| --statefile-concat-cwd | If used with the '--statefile-dir' option, the latter's value will be used as a sub-directory of the current working directory. Useful on Windows when the plugin is compiled, as the file system and permissions are different from Linux. | -| --statefile-format | Define the format used to store the cache. Available formats: 'dumper', 'storable', 'json' (default). | -| --statefile-key | Define the key to encrypt/decrypt the cache. | -| --statefile-cipher | Define the cipher algorithm to encrypt the cache (default: 'AES'). | -| --warning-uptime | Warning threshold. | -| --critical-uptime | Critical threshold. | -| --add-sysdesc | Display system description. | -| --force-oid | Can choose your OID (numeric format only). | -| --check-overload | Uptime counter limit is 4294967296 and overflow. With that option, we manage the counter going back. But there is a few chance we can miss a reboot. | -| --reboot-window | To be used with check-overload option. Time in milliseconds (default: 5000) You increase the chance of not missing a reboot if you decrease that value. | -| --unit | Select the time unit for thresholds. May be 's' for seconds, 'm' for minutes, 'h' for hours, 'd' for days, 'w' for weeks. Default is seconds. | +| Option | Description | +|:-----------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| --filter-counters | Only display some counters (regexp can be used). Example to check SSL connections only : --filter-counters='^xxxx\|yyyy$' | +| --warning-xxx | Warning threshold. | +| --critical-xxx | Critical threshold. | +| --memcached | Memcached server to use (only one server). | +| --redis-server | Redis server to use (only one server). Syntax: address\[:port\] | +| --redis-attribute | Set Redis Options (--redis-attribute="cnx\_timeout=5"). | +| --redis-db | Set Redis database index. | +| --failback-file | Fall back on a local file if Redis connection fails. | +| --memexpiration | Time to keep data in seconds (default: 86400). | +| --statefile-dir | Define the cache directory (default: '/var/lib/centreon/centplugins'). | +| --statefile-suffix | Define a suffix to customize the statefile name (default: ''). | +| --statefile-concat-cwd | If used with the '--statefile-dir' option, the latter's value will be used as a sub-directory of the current working directory. Useful on Windows when the plugin is compiled, as the file system and permissions are different from Linux. | +| --statefile-format | Define the format used to store the cache. Available formats: 'dumper', 'storable', 'json' (default). | +| --statefile-key | Define the key to encrypt/decrypt the cache. | +| --statefile-cipher | Define the cipher algorithm to encrypt the cache (default: 'AES'). | +| --warning-uptime | Warning threshold. | +| --critical-uptime | Critical threshold. | +| --add-sysdesc | Display system description. | +| --force-oid | Can choose your OID (numeric format only). | +| --check-overload | Uptime counter limit is 4294967296 and overflow. With that option, we manage the counter going back. But there is a few chance we can miss a reboot. | +| --reboot-window | To be used with check-overload option. Time in milliseconds (default: 5000) You increase the chance of not missing a reboot if you decrease that value. | +| --unit | Select the time unit for thresholds. May be 's' for seconds, 'm' for minutes, 'h' for hours, 'd' for days, 'w' for weeks. Default is seconds. | diff --git a/i18n/fr/docusaurus-plugin-content-docs-pp/current/integrations/plugin-packs/procedures/network-fortinet-fortimanager-snmp.md b/i18n/fr/docusaurus-plugin-content-docs-pp/current/integrations/plugin-packs/procedures/network-fortinet-fortimanager-snmp.md index f3895eef54b9..5bc58612ee08 100644 --- a/i18n/fr/docusaurus-plugin-content-docs-pp/current/integrations/plugin-packs/procedures/network-fortinet-fortimanager-snmp.md +++ b/i18n/fr/docusaurus-plugin-content-docs-pp/current/integrations/plugin-packs/procedures/network-fortinet-fortimanager-snmp.md @@ -62,9 +62,9 @@ Voici le tableau des services pour ce connecteur, détaillant les métriques et -| Nom | Unité | -|:-----|:------| -| cpu | % | +| Nom | Unité | +|:----|:------| +| cpu | % | @@ -82,18 +82,18 @@ Voici le tableau des services pour ce connecteur, détaillant les métriques et -| Nom | Unité | -|:-----|:------| -| used | B | +| Nom | Unité | +|:------|:------| +| usage | B | > Pour obtenir ce nouveau format de métrique, incluez la valeur **--use-new-perfdata** dans la macro de service **EXTRAOPTIONS**. -| Nom | Unité | -|:-----|:------| -| used | B | +| Nom | Unité | +|:------|:------| +| usage | B | > Pour obtenir ce nouveau format de métrique, incluez la valeur **--use-new-perfdata** dans la macro de service **EXTRAOPTIONS**. @@ -104,7 +104,10 @@ Voici le tableau des services pour ce connecteur, détaillant les métriques et ### Configuration SNMP -Le service SNMP doit être activé et configuré sur l'équipement. Veuillez vous référer à la documentation officielle du constructeur/éditeur. +L'agent SNMP doit être activé et configuré sur l'équipement. +Veuillez vous référer à la documentation officielle. +Il se peut que votre équipement nécessite qu'une liste d'adresses autorisées à l'interroger soit paramétrée. +Veillez à ce que les adresses des collecteurs Centreon y figurent bien. ### Flux réseau @@ -207,12 +210,14 @@ yum install centreon-plugin-Network-Fortinet-Fortimanager-Snmp 2. Complétez les champs **Nom**, **Alias** & **IP Address/DNS** correspondant à votre ressource. 3. Appliquez le modèle d'hôte **Net-Fortinet-Fortimanager-SNMP-custom**. -> Si vous utilisez SNMP en version 3, vous devez configurer les paramètres spécifiques associés via la macro **SNMPEXTRAOPTIONS**. -> Plus d'informations dans la section [Troubleshooting SNMP](../getting-started/how-to-guides/troubleshooting-plugins.md#mapping-des-options-snmpv3). - -| Macro | Description | Valeur par défaut | Obligatoire | -|:-----------------|:---------------------------------------------------------------------------------------------------------------------------------------------------|:------------------|:-----------:| -| SNMPEXTRAOPTIONS | Any extra option you may want to add to every command (a --verbose flag for example). Toutes les options sont listées [ici](#options-disponibles). | | | +| Macro | Description | Valeur par défaut | Obligatoire | +|:------------------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------|:------------------|:-----------:| +| SNMP_V3_USERNAME | SNMP v3 only: User name (`securityName`) | | | +| SNMP_V3_AUTH_PROTOCOL | SNMP v3 only: Authentication protocol: MD5\|SHA. Since net-snmp 5.9.1: SHA224\|SHA256\|SHA384\|SHA512 | | | +| SNMP_V3_PRIV_PROTOCOL | 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 | | | +| SNMP_V3_AUTH_PASSPHRASE | SNMP v3 only: Pass phrase hashed using the authentication protocol defined in the --authprotocol option | | | +| SNMP_V3_PRIV_PASSPHRASE | SNMP v3 only: Privacy pass phrase (`privPassword`) to encrypt messages using the protocol defined in the --privprotocol option | | | +| SNMPEXTRAOPTIONS | Any extra option you may want to add to every command (a --verbose flag for example). Toutes les options sont listées [ici](#options-disponibles). | | | 4. [Déployez la configuration](/docs/monitoring/monitoring-servers/deploying-a-configuration). L'hôte apparaît dans la liste des hôtes supervisés, et dans la page **Statut des ressources**. La commande envoyée par le connecteur est indiquée dans le panneau de détails de l'hôte : celle-ci montre les valeurs des macros. @@ -233,20 +238,20 @@ yum install centreon-plugin-Network-Fortinet-Fortimanager-Snmp -| Macro | Description | Valeur par défaut | Obligatoire | -|:---------------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------|:---------------------|:-----------:| -| FILTERNAME | Filter by device name (can be a regexp) | | | -| WARNINGDEVICECONFIGSTATUS | Set warning threshold for device configuration status. You can use the following variables: %\{status\}, %\{name\} | | | -| CRITICALDEVICECONFIGSTATUS | Set critical threshold for device configuration status. You can use the following variables: %\{status\}, %\{name\} | | | -| CRITICALDEVICECONSTATUS | Set critical threshold for device connection status. You can use the following variables: %\{status\}, %\{name\} | %\{status\} =~ /down/i | | -| WARNINGDEVICECONSTATUS | Set warning threshold for device connection status. You can use the following variables: %\{status\}, %\{name\} | | | -| WARNINGDEVICEDBSTATUS | Set warning threshold for device DB status. You can use the following variables: %\{status\}, %\{name\} | | | -| CRITICALDEVICEDBSTATUS | Set critical threshold for device DB status. You can use the following variables: %\{status\}, %\{name\} | | | -| WARNINGDEVICEPOLICYSTATUS | Set warning threshold for device policy package status. You can use the following variables: %\{status\}, %\{package_name\} | | | -| CRITICALDEVICEPOLICYSTATUS | Set critical threshold for device policy package status. You can use the following variables: %\{status\}, %\{package_name\} | | | -| WARNINGDEVICESTATUS | Set warning threshold for device status. You can use the following variables: %\{status\}, %\{name\} | | | -| CRITICALDEVICESTATUS | Set critical threshold for device status You can use the following variables: %\{status\}, %\{name\} | | | -| EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). Toutes les options sont listées [ici](#options-disponibles). | --verbose | | +| Macro | Description | Valeur par défaut | Obligatoire | +|:---------------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------|:-----------------------|:-----------:| +| FILTERNAME | Filter by device name (can be a regexp) | | | +| WARNINGDEVICECONFIGSTATUS | Set warning threshold for device configuration status. You can use the following variables: %\{status\}, %\{name\} | | | +| CRITICALDEVICECONFIGSTATUS | Set critical threshold for device configuration status. You can use the following variables: %\{status\}, %\{name\} | | | +| CRITICALDEVICECONSTATUS | Set critical threshold for device connection status. You can use the following variables: %\{status\}, %\{name\} | %\{status\} =~ /down/i | | +| WARNINGDEVICECONSTATUS | Set warning threshold for device connection status. You can use the following variables: %\{status\}, %\{name\} | | | +| WARNINGDEVICEDBSTATUS | Set warning threshold for device DB status. You can use the following variables: %\{status\}, %\{name\} | | | +| CRITICALDEVICEDBSTATUS | Set critical threshold for device DB status. You can use the following variables: %\{status\}, %\{name\} | | | +| WARNINGDEVICEPOLICYSTATUS | Set warning threshold for device policy package status. You can use the following variables: %\{status\}, %\{package\_name\} | | | +| CRITICALDEVICEPOLICYSTATUS | Set critical threshold for device policy package status. You can use the following variables: %\{status\}, %\{package\_name\} | | | +| WARNINGDEVICESTATUS | Set warning threshold for device status. You can use the following variables: %\{status\}, %\{name\} | | | +| CRITICALDEVICESTATUS | Set critical threshold for device status You can use the following variables: %\{status\}, %\{name\} | | | +| EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). Toutes les options sont listées [ici](#options-disponibles). | --verbose | | @@ -285,7 +290,12 @@ telle que celle-ci (remplacez les valeurs d'exemple par les vôtres) : --mode=device-status \ --hostname=10.0.0.1 \ --snmp-version='2c' \ - --snmp-community='my-snmp-community' \ + --snmp-community='my-snmp-community' \ + --snmp-username='username' \ + --authpassphrase='' \ + --authprotocol='' \ + --privpassphrase='' \ + --privprotocol='' \ --filter-name='' \ --warning-device-status='' \ --critical-device-status='' \ @@ -303,12 +313,7 @@ telle que celle-ci (remplacez les valeurs d'exemple par les vôtres) : La commande devrait retourner un message de sortie similaire à : ```bash -OK: Device 'Device Ent Name' status: installed - connection status: up - db status: modified - configuration status: in-sync -checking device 'Device Ent Name' - status: installed - connection status: up - db status: modified - configuration status: in-sync +OK: policy packages are ok ``` ### Diagnostic des erreurs communes @@ -347,65 +352,67 @@ Le plugin apporte les modes suivants : Les options génériques sont listées ci-dessous : -| 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 ok, 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\[,\[newuom\],\[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\[,\[newuom\],\[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\[,\[newuom\],\[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,namesofnewmetrics,calculation\[,\[newuom\],\[min\],\[max\]\] regex: regular expression namesofnewmetrics: 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 newuom (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~replacement~modifier Most commonly used modifiers are i (case insensitive) and g (replace all occurrences). Example: adding --change-short-output='OK\~Up\~gi' will replace all occurrences of 'OK', 'ok', 'Ok' or 'oK' with 'Up' | -| --change-short-output | Modify the short/long output that is returned by the plugin. Syntax: --change-short-output=pattern~replacement~modifier Most commonly used modifiers are i (case insensitive) and g (replace all occurrences). Example: adding --change-short-output='OK\~Up\~gi' will replace all occurrences of 'OK', 'ok', 'Ok' or 'oK' with 'Up' | -| --change-long-output | Modify the short/long output that is returned by the plugin. Syntax: --change-short-output=pattern~replacement~modifier Most commonly used modifiers are i (case insensitive) and g (replace all occurrences). Example: adding --change-short-output='OK\~Up\~gi' will replace all occurrences of 'OK', 'ok', 'Ok' or 'oK' with 'Up' | -| --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. | -| --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). E.g.: --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\. =cut | +| 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 get-next 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 ok, 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. | +| --show-password | By default, sensitive information in command lines is hidden in debug output and replaced with `***` (however, debug logs may still display sensitive information). Using the C option will display the passwords in plain text. | +| --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\[,\[\\],\[min\],\[max\]\] Common examples: onvert 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\[,\[\\],\[min\],\[max\]\] Common examples: onvert 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\[,\[\\],\[min\],\[max\]\] Common examples: onvert 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,\,calculation\[,\[\\],\[min\],\[max\]\] regex: regular expression \: 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 \ (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: um 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~replacement~modifier Most commonly used modifiers are i (case insensitive) and g (replace all occurrences). Example: adding --change-short-output='OK~Up~gi' will replace all occurrences of 'OK', 'ok', 'Ok' or 'oK' with 'Up' | +| --change-short-output | Modify the short/long output that is returned by the plugin. Syntax: --change-short-output=pattern~replacement~modifier Most commonly used modifiers are i (case insensitive) and g (replace all occurrences). Example: adding --change-short-output='OK~Up~gi' will replace all occurrences of 'OK', 'ok', 'Ok' or 'oK' with 'Up' | +| --change-long-output | Modify the short/long output that is returned by the plugin. Syntax: --change-short-output=pattern~replacement~modifier Most commonly used modifiers are i (case insensitive) and g (replace all occurrences). Example: adding --change-short-output='OK~Up~gi' will replace all occurrences of 'OK', 'ok', 'Ok' or 'oK' with 'Up' | +| --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'. \. | #### Options des modes @@ -414,46 +421,52 @@ Les options disponibles pour chaque modèle de services sont listées ci-dessous -| Option | Description | -|:-----------|:-----------------------------| -| --warning | Warning threshold. | -| --critical | Critical threshold. | +| Option | Description | +|:-----------|:--------------------| +| --warning | Warning threshold. | +| --critical | Critical threshold. | -| Option | Description | -|:----------------------------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------| -| --filter-counters | Only display some counters (regexp can be used). Example to check SSL connections only : --filter-counters='^xxxx\|yyyy$' | -| --filter-name | Filter by device name (can be a regexp). | -| --warning-device-status | Set warning threshold for device status. You can use the following variables: %\{status\}, %\{name\} | -| --critical-device-status | Set critical threshold for device status You can use the following variables: %\{status\}, %\{name\} | -| --warning-device-con-status | Set warning threshold for device connection status. You can use the following variables: %\{status\}, %\{name\} | -| --critical-device-con-status | Set critical threshold for device connection status (default: '%\{status\} =~ /down/i'). You can use the following variables: %\{status\}, %\{name\} | -| --warning-device-db-status | Set warning threshold for device DB status. You can use the following variables: %\{status\}, %\{name\} | -| --critical-device-db-status | Set critical threshold for device DB status. You can use the following variables: %\{status\}, %\{name\} | -| --warning-device-config-status | Set warning threshold for device configuration status. You can use the following variables: %\{status\}, %\{name\} | -| --critical-device-config-status | Set critical threshold for device configuration status. You can use the following variables: %\{status\}, %\{name\} | -| --warning-device-policy-package-status | Set warning threshold for device policy package status. You can use the following variables: %\{status\}, %\{package_name\} | -| --critical-device-policy-package-status | Set critical threshold for device policy package status. You can use the following variables: %\{status\}, %\{package_name\} | +| Option | Description | +|:----------------------------------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------| +| --filter-counters | Only display some counters (regexp can be used). Example to check SSL connections only : --filter-counters='^xxxx\|yyyy$' | +| --warning-xxx | Warning threshold. | +| --critical-xxx | Critical threshold. | +| --filter-name | Filter by device name (can be a regexp). | +| --warning-device-status | Set warning threshold for device status. You can use the following variables: %\{status\}, %\{name\} | +| --critical-device-status | Set critical threshold for device status You can use the following variables: %\{status\}, %\{name\} | +| --warning-device-con-status | Set warning threshold for device connection status. You can use the following variables: %\{status\}, %\{name\} | +| --critical-device-con-status | Set critical threshold for device connection status (default: '%\{status\} =~ /down/i'). You can use the following variables: %\{status\}, %\{name\} | +| --warning-device-db-status | Set warning threshold for device DB status. You can use the following variables: %\{status\}, %\{name\} | +| --critical-device-db-status | Set critical threshold for device DB status. You can use the following variables: %\{status\}, %\{name\} | +| --warning-device-config-status | Set warning threshold for device configuration status. You can use the following variables: %\{status\}, %\{name\} | +| --critical-device-config-status | Set critical threshold for device configuration status. You can use the following variables: %\{status\}, %\{name\} | +| --warning-device-policy-package-status | Set warning threshold for device policy package status. You can use the following variables: %\{status\}, %\{package\_name\} | +| --critical-device-policy-package-status | Set critical threshold for device policy package status. You can use the following variables: %\{status\}, %\{package\_name\} | -| Option | Description | -|:------------------|:------------------------------------------------------------------------------------------------------------------------------| -| --filter-counters | Only display some counters (regexp can be used). Example to check SSL connections only : --filter-counters='^xxxx\|yyyy$' | -| --warning-usage | Warning threshold (in percent). | -| --critical-usage | Critical threshold (in percent). | +| Option | Description | +|:------------------|:--------------------------------------------------------------------------------------------------------------------------| +| --filter-counters | Only display some counters (regexp can be used). Example to check SSL connections only : --filter-counters='^xxxx\|yyyy$' | +| --warning-xxx | Warning threshold. | +| --critical-xxx | Critical threshold. | +| --warning-usage | Warning threshold (in percent). | +| --critical-usage | Critical threshold (in percent). | -| Option | Description | -|:------------------|:------------------------------------------------------------------------------------------------------------------------------| -| --filter-counters | Only display some counters (regexp can be used). Example to check SSL connections only : --filter-counters='^xxxx\|yyyy$' | -| --warning-usage | Warning threshold (in percent). | -| --critical-usage | Critical threshold (in percent). | +| Option | Description | +|:------------------|:--------------------------------------------------------------------------------------------------------------------------| +| --filter-counters | Only display some counters (regexp can be used). Example to check SSL connections only : --filter-counters='^xxxx\|yyyy$' | +| --warning-xxx | Warning threshold. | +| --critical-xxx | Critical threshold. | +| --warning-usage | Warning threshold (in percent). | +| --critical-usage | Critical threshold (in percent). | diff --git a/i18n/fr/docusaurus-plugin-content-docs-pp/current/integrations/plugin-packs/procedures/network-stormshield-snmp.md b/i18n/fr/docusaurus-plugin-content-docs-pp/current/integrations/plugin-packs/procedures/network-stormshield-snmp.md index 362bc767d8b8..a58f62257ba7 100644 --- a/i18n/fr/docusaurus-plugin-content-docs-pp/current/integrations/plugin-packs/procedures/network-stormshield-snmp.md +++ b/i18n/fr/docusaurus-plugin-content-docs-pp/current/integrations/plugin-packs/procedures/network-stormshield-snmp.md @@ -5,6 +5,12 @@ title: Stormshield SNMP import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; +## Dépendances du connecteur de supervision + +Les connecteurs de supervision suivants sont automatiquement installés lors de l'installation du connecteur **Stormshield SNMP** +depuis la page **Configuration > Connecteurs > Connecteurs de supervision** : +* [Base Pack](./base-generic.md) + ## Contenu du pack ### Modèles @@ -21,12 +27,12 @@ Le connecteur apporte les modèles de service suivants | Alias | Modèle de service | Description | |:----------------|:--------------------------------------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| Cpu-Detailed | Net-Stormshield-Cpu-Detailed-SNMP-custom | Contrôle du taux d'utilisation détaillé CPU de la machine. Ce contrôle pourra remonter la moyenne du taux d'utilisation des CPU ainsi que le taux par CPU pour les CPU multi-coeur. | -| Hardware | Net-Stormshield-Hardware-SNMP-custom | Contrôle le matériel. | -| Load | Net-Stormshield-Load-SNMP-custom | Contrôle de la charge serveur. | -| Memory | Net-Stormshield-Memory-SNMP-custom | Contrôle du taux d'utilisation de la mémoire vive. | -| Memory-Detailed | Net-Stormshield-Memory-Detailed-SNMP-custom | Contrôle du taux d'utilisation détaillé de la mémoire. | -| Swap | Net-Stormshield-Swap-SNMP-custom | Contrôle du taux d'utilisation de la mémoire virtuelle. | +| Cpu-Detailed | Net-Stormshield-Cpu-Detailed-SNMP-custom | Contrôle du taux d'utilisation détaillé CPU de la machine. Ce contrôle pourra remonter la moyenne du taux d'utilisation des CPU ainsi que le taux par CPU pour les CPU multi-coeur | +| Hardware | Net-Stormshield-Hardware-SNMP-custom | Contrôle le matériel | +| Load | Net-Stormshield-Load-SNMP-custom | Contrôle de la charge serveur | +| Memory | Net-Stormshield-Memory-SNMP-custom | Contrôle du taux d'utilisation de la mémoire vive (RAM) | +| Memory-Detailed | Net-Stormshield-Memory-Detailed-SNMP-custom | Contrôle du taux d'utilisation détaillé de la mémoire | +| Swap | Net-Stormshield-Swap-SNMP-custom | Contrôle du taux d'utilisation de la mémoire virtuelle (SWAP) | > Les services listés ci-dessus sont créés automatiquement lorsque le modèle d'hôte **Net-Stormshield-SNMP-custom** est utilisé. @@ -35,16 +41,16 @@ Le connecteur apporte les modèles de service suivants | Alias | Modèle de service | Description | Découverte | |:---------------------|:-------------------------------------------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:----------:| -| Connections | Net-Stormshield-Connections-SNMP-custom | Contrôle le nombre de connexions TCP/UDP. | | -| Cpu | Net-Stormshield-Cpu-SNMP-custom | Contrôle du taux d'utilisation du CPU de la machine. Ce contrôle pourra remonter la moyenne du taux d'utilisation des CPU ainsi que le taux par CPU pour les CPU multi-coeur. | | -| Disk-Global | Net-Stormshield-Disk-Global-SNMP-custom | Contrôle du taux d'espace libre disponible des disques. Pour chaque contrôle apparaîtra le point de montage des disques. | | -| Ha-Status | Net-Stormshield-Ha-Status-SNMP-custom | Contrôle le statut de la HA. | | -| Health | Net-Stormshield-Health-SNMP-custom | Contrôle l'état de santé. | | -| Qos | Net-Stormshield-Qos-SNMP-custom | Contrôle l'utilisation QoS. | | -| Traffic-Generic-Id | Net-Stormshield-Traffic-Generic-Id-SNMP-custom | Contrôle le traffic réseau d'une interface réseau. | | -| Traffic-Generic-Name | Net-Stormshield-Traffic-Generic-Name-SNMP-custom | Contrôle le traffic réseau d'une interface réseau. | | -| Traffic-Global | Net-Stormshield-Traffic-Global-SNMP-custom | Contrôle le traffic réseau de plusieurs interfaces réseau. | X | -| Vpn-Status | Net-Stormshield-Vpn-Status-SNMP-custom | Contrôle l'état des VPNs. | | +| Connections | Net-Stormshield-Connections-SNMP-custom | Contrôle le nombre de connexions TCP/UDP | | +| Cpu | Net-Stormshield-Cpu-SNMP-custom | Contrôle du taux d'utilisation du CPU de la machine. Ce contrôle pourra remonter la moyenne du taux d'utilisation des CPU ainsi que le taux par CPU pour les CPU multi-coeur | | +| Disk-Global | Net-Stormshield-Disk-Global-SNMP-custom | Contrôle du taux d'espace libre disponible des disques. Pour chaque contrôle apparaîtra le point de montage des disques (« | | +| Ha-Status | Net-Stormshield-Ha-Status-SNMP-custom | Contrôle le statut de la HA | | +| Health | Net-Stormshield-Health-SNMP-custom | Contrôle l'état de santé | | +| Qos | Net-Stormshield-Qos-SNMP-custom | Contrôle l'utilisation QoS | | +| Traffic-Generic-Id | Net-Stormshield-Traffic-Generic-Id-SNMP-custom | Contrôle le traffic réseau d'une interface réseau | | +| Traffic-Generic-Name | Net-Stormshield-Traffic-Generic-Name-SNMP-custom | Contrôle le traffic réseau d'une interface réseau | | +| Traffic-Global | Net-Stormshield-Traffic-Global-SNMP-custom | Contrôle le traffic réseau de plusieurs interfaces réseau | X | +| Vpn-Status | Net-Stormshield-Vpn-Status-SNMP-custom | Contrôle l'état des VPNs | | > Les services listés ci-dessus ne sont pas créés automatiquement lorsqu'un modèle d'hôte est appliqué. Pour les utiliser, [créez un service manuellement](/docs/monitoring/basic-objects/services) et appliquez le modèle de service souhaité. @@ -57,39 +63,39 @@ Le connecteur apporte les modèles de service suivants #### Découverte d'hôtes -| Nom de la règle | Description | -|:----------------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| SNMP Agents | Discover your resources through an SNMP subnet scan. You need to install the [Generic SNMP](./applications-protocol-snmp.md) connector to get the discovery rule and create a template mapper for the **Net-Stormshield-SNMP-custom** host template | +| Nom de la règle | Description | +|:----------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| SNMP Agents | Découvre les ressources via un scan réseau SNMP. Installez le connecteur [Generic SNMP](./applications-protocol-snmp.md) pour obtenir la règle de découverte et créez un modificateur pour le modèle d'hôte **Net-Stormshield-SNMP-custom**. | Rendez-vous sur la [documentation dédiée](/docs/monitoring/discovery/hosts-discovery) pour en savoir plus sur la découverte automatique d'hôtes. -#### Découverte de service +#### Découverte de services -| Nom de la règle | Description | -|:----------------------------------|:--------------------------------------------------------------| -| Net-Stormshield-SNMP-Traffic-Name | Discover network interfaces and monitor bandwidth utilization | +| Nom de la règle | Description | +|:----------------------------------|:--------------------------------------------------------------------------------------------------| +| Net-Stormshield-SNMP-Traffic-Name | Découvre les interfaces réseau en utilisant leur nom et supervise leur statut et leur utilisation | Rendez-vous sur la [documentation dédiée](/docs/monitoring/discovery/services-discovery) pour en savoir plus sur la découverte automatique de services et sa [planification](/docs/monitoring/discovery/services-discovery/#règles-de-découverte). ### Métriques & statuts collectés -Voici le tableau des services pour ce connecteur, détaillant les métriques rattachées à chaque service. +Voici le tableau des services pour ce connecteur, détaillant les métriques et statuts rattachés à chaque service. -| Métrique | Unité | -|:------------|:------| -| udp | con | -| tcp | con | +| Nom | Unité | +|:----|:------| +| udp | con | +| tcp | con | > Pour obtenir ce nouveau format de métrique, incluez la valeur **--use-new-perfdata** dans la macro de service **EXTRAOPTIONS**. -| Métrique | Unité | +| Nom | Unité | |:-------------------------------------------|:------| | cpu.utilization.percentage | % | | *cpu_core*#core.cpu.utilization.percentage | % | @@ -99,7 +105,7 @@ Voici le tableau des services pour ce connecteur, détaillant les métriques rat -| Métrique | Unité | +| Nom | Unité | |:-------------------------------------|:------| | cpu.user.utilization.percentage | % | | cpu.nice.utilization.percentage | % | @@ -118,7 +124,7 @@ Voici le tableau des services pour ce connecteur, détaillant les métriques rat -| Métrique | Unité | +| Nom | Unité | |:--------------------------------------|:------| | storage.partitions.count | count | | *disk_name*#storage.space.usage.bytes | B | @@ -129,10 +135,10 @@ Voici le tableau des services pour ce connecteur, détaillant les métriques rat -| Métrique | Unité | +| Nom | Unité | |:---------------|:------| -| dead_nodes | N/A | -| *nodes*#state | N/A | +| dead-nodes | N/A | +| state | N/A | | *nodes*#health | % | > Pour obtenir ce nouveau format de métrique, incluez la valeur **--use-new-perfdata** dans la macro de service **EXTRAOPTIONS**. @@ -140,24 +146,28 @@ Voici le tableau des services pour ce connecteur, détaillant les métriques rat -| Metric name | Unit | -|:-------------------|:-------| -| disk.status | N/A | -| fan.status | N/A | -| psu.status | N/A | -| temperature.value | Celsius| +| Nom | Unité | +|:---------------------------|:------| +| hardware.disk.count | count | +| disk status | N/A | +| hardware.fan.count | count | +| fan status | N/A | +| hardware.psu.count | count | +| psu status | N/A | +| hardware.temperature.count | count | +| temperature status | N/A | -| Métrique | Unité | -|:--------------------------------------|:------| -| *firewalls*~*services*#service-status | N/A | +| Nom | Unité | +|:---------------|:------| +| service-status | N/A | -| Métrique | Unité | +| Nom | Unité | |:-----------------------|:------| | load.1m.average.count | count | | load.5m.average.count | count | @@ -169,7 +179,7 @@ Voici le tableau des services pour ce connecteur, détaillant les métriques rat -| Métrique | Unité | +| Nom | Unité | |:--------------------|:------| | memory.cached.bytes | B | | memory.usage.bytes | B | @@ -178,7 +188,7 @@ Voici le tableau des services pour ce connecteur, détaillant les métriques rat -| Métrique | Unité | +| Nom | Unité | |:---------------------------------|:------| | memory.usage.percentage | % | | memory.protected_host.percentage | % | @@ -192,7 +202,7 @@ Voici le tableau des services pour ce connecteur, détaillant les métriques rat -| Métrique | Unité | +| Nom | Unité | |:-----------------------------------------|:------| | *qos*#qos.traffic.in.bitspersecond | b/s | | *qos*#qos.traffic.in.percentage | % | @@ -204,7 +214,7 @@ Voici le tableau des services pour ce connecteur, détaillant les métriques rat -| Métrique | Unité | +| Nom | Unité | |:----------------------|:------| | swap.usage.bytes | B | | swap.free.bytes | B | @@ -215,9 +225,9 @@ Voici le tableau des services pour ce connecteur, détaillant les métriques rat -| Métrique | Unité | +| Nom | Unité | |:-----------------------------------------------------|:------| -| *interface_name*#status | N/A | +| status | N/A | | *interface_name*#interface.traffic.in.bitspersecond | b/s | | *interface_name*#interface.traffic.out.bitspersecond | b/s | @@ -226,10 +236,10 @@ Voici le tableau des services pour ce connecteur, détaillant les métriques rat -| Métrique | Unité | +| Nom | Unité | |:------------------------------------|:------| | vpn.detected.count | count | -| *vpn*#status | N/A | +| status | N/A | | *vpn*#vpn.traffic.bitspersecond | b/s | | *vpn*#vpn.traffic.in.bitspersecond | b/s | | *vpn*#vpn.traffic.out.bitspersecond | b/s | @@ -241,7 +251,10 @@ Voici le tableau des services pour ce connecteur, détaillant les métriques rat ### Configuration SNMP -Le service SNMP doit être activé et configuré sur l'équipement. Veuillez vous référer à la documentation officielle du constructeur/éditeur. +L'agent SNMP doit être activé et configuré sur l'équipement. +Veuillez vous référer à la documentation officielle. +Il se peut que votre équipement nécessite qu'une liste d'adresses autorisées à l'interroger soit paramétrée. +Veillez à ce que les adresses des collecteurs Centreon y figurent bien. ### Flux réseau @@ -344,12 +357,14 @@ yum install centreon-plugin-Network-Stormshield-Snmp 2. Complétez les champs **Nom**, **Alias** & **IP Address/DNS** correspondant à votre ressource. 3. Appliquez le modèle d'hôte **Net-Stormshield-SNMP-custom**. -> Si vous utilisez SNMP en version 3, vous devez configurer les paramètres spécifiques associés via la macro **SNMPEXTRAOPTIONS**. -> Plus d'informations dans la section [Troubleshooting SNMP](../getting-started/how-to-guides/troubleshooting-plugins.md#mapping-des-options-snmpv3). - -| Macro | Description | Valeur par défaut | Obligatoire | -|:-----------------|:-----------------------------------------------------------------------------------------------------|:------------------|:-----------:| -| SNMPEXTRAOPTIONS | Any extra option you may want to add to every command (a --verbose flag for example). Toutes les options sont listées [ici](#options-disponibles). | | | +| Macro | Description | Valeur par défaut | Obligatoire | +|:------------------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------|:------------------|:-----------:| +| SNMP_V3_USERNAME | SNMP v3 only: User name (`securityName`) | | | +| SNMP_V3_AUTH_PROTOCOL | SNMP v3 only: Authentication protocol: MD5\|SHA. Since net-snmp 5.9.1: SHA224\|SHA256\|SHA384\|SHA512 | | | +| SNMP_V3_PRIV_PROTOCOL | 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 | | | +| SNMP_V3_AUTH_PASSPHRASE | SNMP v3 only: Pass phrase hashed using the authentication protocol defined in the --authprotocol option | | | +| SNMP_V3_PRIV_PASSPHRASE | SNMP v3 only: Privacy pass phrase (`privPassword`) to encrypt messages using the protocol defined in the --privprotocol option | | | +| SNMPEXTRAOPTIONS | Any extra option you may want to add to every command (a --verbose flag for example). Toutes les options sont listées [ici](#options-disponibles). | | | 4. [Déployez la configuration](/docs/monitoring/monitoring-servers/deploying-a-configuration). L'hôte apparaît dans la liste des hôtes supervisés, et dans la page **Statut des ressources**. La commande envoyée par le connecteur est indiquée dans le panneau de détails de l'hôte : celle-ci montre les valeurs des macros. @@ -361,203 +376,203 @@ yum install centreon-plugin-Network-Stormshield-Snmp -| Macro | Description | Valeur par défaut | Obligatoire | -|:-------------|:---------------------------------------------------------------------------------------------------|:------------------|:-----------:| -| WARNINGTCP | Warning threshold | | | -| CRITICALTCP | Critical threshold | | | -| WARNINGUDP | Warning threshold | | | -| CRITICALUDP | Critical threshold | | | +| Macro | Description | Valeur par défaut | Obligatoire | +|:-------------|:-------------------------------------------------------------------------------------------------------------------------------------------------|:------------------|:-----------:| +| WARNINGTCP | Threshold | | | +| CRITICALTCP | Threshold | | | +| WARNINGUDP | Threshold | | | +| CRITICALUDP | Threshold | | | | EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). Toutes les options sont listées [ici](#options-disponibles). | | | -| Macro | Description | Valeur par défaut | Obligatoire | -|:-------------|:---------------------------------------------------------------------------------------------------|:------------------|:-----------:| -| WARNING | Warning threshold for average CPU utilization | 80 | | -| CRITICAL | Critical threshold for average CPU utilization | 90 | | +| Macro | Description | Valeur par défaut | Obligatoire | +|:-------------|:-------------------------------------------------------------------------------------------------------------------------------------------------|:------------------|:-----------:| +| WARNING | Warning threshold average CPU utilization | 80 | | +| CRITICAL | Critical threshold average CPU utilization | 90 | | | EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). Toutes les options sont listées [ici](#options-disponibles). | | | -| Macro | Description | Valeur par défaut | Obligatoire | -|:-------------|:---------------------------------------------------------------------------------------------------|:------------------|:-----------:| -| WARNINGIDLE | Warning threshold in percent | 20: | | -| CRITICALIDLE | Critical threshold in percent | 10: | | +| Macro | Description | Valeur par défaut | Obligatoire | +|:-------------|:-------------------------------------------------------------------------------------------------------------------------------------------------|:------------------|:-----------:| +| WARNINGIDLE | Threshold in percentage | 20: | | +| CRITICALIDLE | Threshold in percentage | 10: | | | EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). Toutes les options sont listées [ici](#options-disponibles). | --verbose | | -| Macro | Description | Valeur par défaut | Obligatoire | -|:-------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:------------------|:-----------:| -| FILTER | Define the storage units to check (number expected). Example: 1, 2... (empty means 'check all storage units') | .* | | -| TRANSFORMSRC | Modify the storage name displayed by using a regular expression. Example: adding --display-transform-src='dev' --display-transform-dst='run' will replace all occurrences of 'dev' with 'run' | | | -| TRANSFORMDST | Modify the storage name displayed by using a regular expression. Example: adding --display-transform-src='dev' --display-transform-dst='run' will replace all occurrences of 'dev' with 'run' | | | -| WARNING | Warning threshold | 80 | | -| CRITICAL | Critical threshold | 90 | | -| EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). Toutes les options sont listées [ici](#options-disponibles). | --verbose | | +| Macro | Description | Valeur par défaut | Obligatoire | +|:-------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:------------------|:-----------:| +| FILTER | Set the storage (number expected) example: 1, 2,... (empty means 'check all storage') | .* | | +| TRANSFORMSRC | Modify the storage name displayed by using a regular expression. Example: adding --display-transform-src='dev' --display-transform-dst='run' will replace all occurrences of 'dev' with 'run' | | | +| TRANSFORMDST | Modify the storage name displayed by using a regular expression. Example: adding --display-transform-src='dev' --display-transform-dst='run' will replace all occurrences of 'dev' with 'run' | | | +| WARNING | Warning threshold | 80 | | +| CRITICAL | Critical threshold | 90 | | +| EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). Toutes les options sont listées [ici](#options-disponibles). | --verbose | | -| Macro | Description | Valeur par défaut | Obligatoire | -|:------------------|:------------------------------------------------------------------------------------------------------------------------------|:------------------|:-----------:| -| WARNINGDEADNODES | Warning threshold for dead nodes (absolute unless --percent is used) | | | -| CRITICALDEADNODES | Critical threshold for dead nodes (absolute unless --percent is used) | | | -| WARNINGHEALTH | Warning threshold for health level (example: --warning 90:) | | | -| CRITICALHEALTH | Critical threshold for health level (example --critical 80:) | | | -| WARNINGSTATE | Set warning threshold for state. You can use the following variables: %\{state\}, %\{role\} | | | -| CRITICALSTATE | Set critical threshold for state. (default: '%\{state\} =~ /offline/i'). You can use the following variables: %\{state\}, %\{role\} | | | -| EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). Toutes les options sont listées [ici](#options-disponibles). | --verbose | | +| Macro | Description | Valeur par défaut | Obligatoire | +|:------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------|:-------------------------|:-----------:| +| WARNINGDEADNODES | Warning threshold on deadnode (absolute unless --percent is used) | | | +| CRITICALDEADNODES | Critical threshold on deadnode (absolute unless --percent is used) | | | +| WARNINGHEALTH | Warning threshold on health level (example: --warning 90:) | | | +| CRITICALHEALTH | Critical threshold on health level (example --critical 80:) | | | +| WARNINGSTATE | Set warning threshold for state. You can use the following variables: %\{state\}, %\{role\} | | | +| CRITICALSTATE | Set critical threshold for state.. You can use the following variables: %\{state\}, %\{role\} | %\{state\} =~ /offline/i | | +| EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). Toutes les options sont listées [ici](#options-disponibles). | --verbose | | -| Macro | Description | Valeur par défaut | Obligatoire | -|:-------------|:---------------------------------------------------------------------------------------------------|:------------------|:-----------:| -| COMPONENT | Which component to check (default: '.*'). Can be: 'disk', 'fan', 'psu', 'temperature' | | | +| Macro | Description | Valeur par défaut | Obligatoire | +|:-------------|:-------------------------------------------------------------------------------------------------------------------------------------------------|:------------------|:-----------:| +| COMPONENT | Which component to check. Can be: 'disk', 'fan', 'psu', 'temperature' | .* | | | EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). Toutes les options sont listées [ici](#options-disponibles). | --verbose | | -| Macro | Description | Valeur par défaut | Obligatoire | -|:----------------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------|:----------------------|:-----------:| -| UNKNOWNSERVICESTATUS | Define the conditions to match for the status to be UNKNOWN. You can use the following variables: %\{health\}, %\{service\} | | | -| WARNINGSERVICESTATUS | Define the conditions to match for the status to be WARNING (default: '%\{health\} =~ /minor/i'). You can use the following variables: %\{health\}, %\{service\} | %\{health\} =~ /minor/i | | -| CRITICALSERVICESTATUS | Define the conditions to match for the status to be CRITICAL (default: '%\{health\} =~ /major/i'). You can use the following variables: %\{health\}, %\{service\} | %\{health\} =~ /major/i | | -| EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). Toutes les options sont listées [ici](#options-disponibles). | --verbose | | +| Macro | Description | Valeur par défaut | Obligatoire | +|:----------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------|:------------------------|:-----------:| +| UNKNOWNSERVICESTATUS | Define the conditions to match for the status to be UNKNOWN. You can use the following variables: %\{health\}, %\{service\} | | | +| WARNINGSERVICESTATUS | Define the conditions to match for the status to be WARNING. You can use the following variables: %\{health\}, %\{service\} | %\{health\} =~ /minor/i | | +| CRITICALSERVICESTATUS | Define the conditions to match for the status to be CRITICAL. You can use the following variables: %\{health\}, %\{service\} | %\{health\} =~ /major/i | | +| EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). Toutes les options sont listées [ici](#options-disponibles). | --verbose | | -| Macro | Description | Valeur par défaut | Obligatoire | -|:-------------|:---------------------------------------------------------------------------------------------------|:------------------|:-----------:| -| WARNING | Warning threshold (1min,5min,15min) | 4,3,2 | | -| CRITICAL | Critical threshold (1min,5min,15min) | 6,5,4 | | +| Macro | Description | Valeur par défaut | Obligatoire | +|:-------------|:-------------------------------------------------------------------------------------------------------------------------------------------------|:------------------|:-----------:| +| WARNING | Warning threshold (1min,5min,15min) | 4,3,2 | | +| CRITICAL | Critical threshold (1min,5min,15min) | 6,5,4 | | | EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). Toutes les options sont listées [ici](#options-disponibles). | | | -| Macro | Description | Valeur par défaut | Obligatoire | -|:-------------|:---------------------------------------------------------------------------------------------------|:------------------|:-----------:| -| WARNING | Warning threshold in percent | 80 | | -| CRITICAL | Critical threshold in percent | 90 | | +| Macro | Description | Valeur par défaut | Obligatoire | +|:-------------|:-------------------------------------------------------------------------------------------------------------------------------------------------|:------------------|:-----------:| +| WARNING | Warning threshold in percent | 80 | | +| CRITICAL | Critical threshold in percent | 90 | | | EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). Toutes les options sont listées [ici](#options-disponibles). | | | -| Macro | Description | Valeur par défaut | Obligatoire | -|:-------------------|:---------------------------------------------------------------------------------------------------|:------------------|:-----------:| -| WARNINGCONN | Thresholds | | | -| CRITICALCONN | Thresholds | | | -| WARNINGDTRACK | Thresholds | | | -| CRITICALDTRACK | Thresholds | | | -| WARNINGDYN | Thresholds | | | -| CRITICALDYN | Thresholds | | | -| WARNINGETHERSTATE | Thresholds | | | -| CRITICALETHERSTATE | Thresholds | | | -| WARNINGFRAG | Thresholds | | | -| CRITICALFRAG | Thresholds | | | -| WARNINGHOST | Thresholds | | | -| CRITICALHOST | Thresholds | | | -| WARNINGICMP | Thresholds | | | -| CRITICALICMP | Thresholds | | | -| WARNINGTOTAL | Thresholds | | | -| CRITICALTOTAL | Thresholds | | | +| Macro | Description | Valeur par défaut | Obligatoire | +|:-------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------|:------------------|:-----------:| +| WARNINGCONN | Threshold | | | +| CRITICALCONN | Threshold | | | +| WARNINGDTRACK | Threshold | | | +| CRITICALDTRACK | Threshold | | | +| WARNINGDYN | Threshold | | | +| CRITICALDYN | Threshold | | | +| WARNINGETHERSTATE | Threshold | | | +| CRITICALETHERSTATE | Threshold | | | +| WARNINGFRAG | Threshold | | | +| CRITICALFRAG | Threshold | | | +| WARNINGHOST | Threshold | | | +| CRITICALHOST | Threshold | | | +| WARNINGICMP | Threshold | | | +| CRITICALICMP | Threshold | | | +| WARNINGTOTAL | Threshold | | | +| CRITICALTOTAL | Threshold | | | | EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). Toutes les options sont listées [ici](#options-disponibles). | | | -| Macro | Description | Valeur par défaut | Obligatoire | -|:-----------------------|:---------------------------------------------------------------------------------------------------|:------------------|:-----------:| -| FILTERNAME | Filter by QoS name (can be a regexp) | | | -| SPEEDIN | Set interface speed for incoming traffic (in Mb) | | | -| SPEEDOUT | Set interface speed for outgoing traffic (in Mb) | | X | -| WARNINGTRAFFICIN | Thresholds | | | -| CRITICALTRAFFICIN | Thresholds | | | -| WARNINGTRAFFICINPEAK | Thresholds | | | -| CRITICALTRAFFICINPEAK | Thresholds | | | -| WARNINGTRAFFICINPRCT | Thresholds | | | -| CRITICALTRAFFICINPRCT | Thresholds | | | -| WARNINGTRAFFICOUT | Thresholds | | | -| CRITICALTRAFFICOUT | Thresholds | | | -| WARNINGTRAFFICOUTPEAK | Thresholds | | | -| CRITICALTRAFFICOUTPEAK | Thresholds | | | -| WARNINGTRAFFICOUTPRCT | Thresholds | | | -| CRITICALTRAFFICOUTPRCT | Thresholds | | | +| Macro | Description | Valeur par défaut | Obligatoire | +|:-----------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------|:------------------|:-----------:| +| FILTERNAME | Filter by QoS name (can be a regexp) | | | +| SPEEDIN | Set interface speed for incoming traffic (in Mb) | | | +| SPEEDOUT | Set interface speed for outgoing traffic (in Mb) | | | +| WARNINGTRAFFICIN | Threshold | | | +| CRITICALTRAFFICIN | Threshold | | | +| WARNINGTRAFFICINPEAK | Threshold | | | +| CRITICALTRAFFICINPEAK | Threshold | | | +| WARNINGTRAFFICINPRCT | Threshold | | | +| CRITICALTRAFFICINPRCT | Threshold | | | +| WARNINGTRAFFICOUT | Threshold | | | +| CRITICALTRAFFICOUT | Threshold | | | +| WARNINGTRAFFICOUTPEAK | Threshold | | | +| CRITICALTRAFFICOUTPEAK | Threshold | | | +| WARNINGTRAFFICOUTPRCT | Threshold | | | +| CRITICALTRAFFICOUTPRCT | Threshold | | | | EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). Toutes les options sont listées [ici](#options-disponibles). | --verbose | | -| Macro | Description | Valeur par défaut | Obligatoire | -|:-------------|:---------------------------------------------------------------------------------------------------|:------------------|:-----------:| -| WARNING | Thresholds | 10 | | -| CRITICAL | Thresholds | 30 | | +| Macro | Description | Valeur par défaut | Obligatoire | +|:-------------|:-------------------------------------------------------------------------------------------------------------------------------------------------|:------------------|:-----------:| +| WARNING | Threshold in percentage | 10 | | +| CRITICAL | Threshold in percentage | 30 | | | EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). Toutes les options sont listées [ici](#options-disponibles). | | | -| Macro | Description | Valeur par défaut | Obligatoire | -|:-------------|:---------------------------------------------------------------------------------------------------|:------------------|:-----------:| -| INTERFACEID | Define the interfaces to check (number expected). Example: 1,2... (empty means 'check all interfaces'). | | | -| WARNINGIN | Thresholds | 80 | | -| CRITICALIN | Thresholds | 90 | | -| WARNINGOUT | Thresholds | 80 | | -| CRITICALOUT | Thresholds | 90 | | -| EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). Toutes les options sont listées [ici](#options-disponibles). | | | +| Macro | Description | Valeur par défaut | Obligatoire | +|:-------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------|:------------------|:-----------:| +| INTERFACEID | Check only the interfaces with the specified IDs (OID indexes, e.g.: 1,2,...). If empty, all interfaces will be monitored. To filter on interface names, see --name | | | +| WARNINGIN | Thresholds | 80 | | +| CRITICALIN | Thresholds | 90 | | +| WARNINGOUT | Thresholds | 80 | | +| CRITICALOUT | Thresholds | 90 | | +| EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). Toutes les options sont listées [ici](#options-disponibles). | | | -| Macro | Description | Valeur par défaut | Obligatoire | -|:--------------|:---------------------------------------------------------------------------------------------------|:------------------|:-----------:| -| INTERFACENAME | Define the interfaces to check (number expected). Example: 1,2... (empty means 'check all interfaces'). | | | -| WARNINGIN | Thresholds | 80 | | -| CRITICALIN | Thresholds | 90 | | -| WARNINGOUT | Thresholds | 80 | | -| CRITICALOUT | Thresholds | 90 | | -| EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). Toutes les options sont listées [ici](#options-disponibles). | | | +| Macro | Description | Valeur par défaut | Obligatoire | +|:--------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------|:------------------|:-----------:| +| INTERFACENAME | Check only the interfaces with the specified IDs (OID indexes, e.g.: 1,2,...). If empty, all interfaces will be monitored. To filter on interface names, see --name | | | +| WARNINGIN | Thresholds | 80 | | +| CRITICALIN | Thresholds | 90 | | +| WARNINGOUT | Thresholds | 80 | | +| CRITICALOUT | Thresholds | 90 | | +| EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). Toutes les options sont listées [ici](#options-disponibles). | | | -| Macro | Description | Valeur par défaut | Obligatoire | -|:---------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:------------------|:-----------:| -| FILTER | Define the interfaces to check (number expected). Example: 1,2... (empty means 'check all interfaces'). | .* | | -| WARNINGIN | Thresholds | 80 | | -| CRITICALIN | Thresholds | 90 | | -| WARNINGOUT | Thresholds | 80 | | -| CRITICALOUT | Thresholds | 90 | | -| CRITICALSTATUS | Define the conditions to match for the status to be CRITICAL (default: '%\{admstatus\} eq "up" and %\{opstatus\} ne "up"'). You can use the following variables: %\{admstatus\}, %\{opstatus\}, %\{duplexstatus\}, %\{display\} | | | -| EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). Toutes les options sont listées [ici](#options-disponibles). | --verbose | | +| Macro | Description | Valeur par défaut | Obligatoire | +|:---------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------|:-------------------------------------------------|:-----------:| +| FILTER | Check only the interfaces with the specified IDs (OID indexes, e.g.: 1,2,...). If empty, all interfaces will be monitored. To filter on interface names, see --name | .* | | +| WARNINGIN | Thresholds | 80 | | +| CRITICALIN | Thresholds | 90 | | +| WARNINGOUT | Thresholds | 80 | | +| CRITICALOUT | Thresholds | 90 | | +| CRITICALSTATUS | Define the conditions to match for the status to be CRITICAL. You can use the following variables: %\{admstatus\}, %\{opstatus\}, %\{duplexstatus\}, %\{display\} | %\{admstatus\} eq "up" and %\{opstatus\} ne "up" | | +| EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). Toutes les options sont listées [ici](#options-disponibles). | --verbose | | -| Macro | Description | Valeur par défaut | Obligatoire | -|:--------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------|:-------------------|:-----------:| -| FILTERID | Filter by ID (regexp can be used) | | | -| FILTERSRCIP | Filter by source IP address (regexp can be used) | | | -| FILTERDSTIP | Filter by destination IP address (regexp can be used) | | | -| WARNINGSTATUS | Define the conditions to match for the status to be WARNING (default: '%\{state\} eq "dead"'). You can use the following variables: %\{state\}, %\{srcIp\}, %\{dstIp\} | %\{state\} eq "dead" | | -| CRITICALSTATUS | Define the conditions to match for the status to be CRITICAL. You can use the following variables: %\{state\}, %\{srcIp\}, %\{dstIp\} | | | -| WARNINGTRAFFIC | Thresholds | | | -| CRITICALTRAFFIC | Thresholds | | | -| WARNINGTRAFFICIN | Thresholds | | | -| CRITICALTRAFFICIN | Thresholds | | | -| WARNINGTRAFFICOUT | Thresholds | | | -| CRITICALTRAFFICOUT | Thresholds | | | -| WARNINGVPNDETECTED | Thresholds | | | -| CRITICALVPNDETECTED | Thresholds | | | -| EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). Toutes les options sont listées [ici](#options-disponibles). | --verbose | | +| Macro | Description | Valeur par défaut | Obligatoire | +|:--------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------|:---------------------|:-----------:| +| FILTERID | Filter by ID (regexp can be used) | | | +| FILTERSRCIP | Filter by src ip (regexp can be used) | | | +| FILTERDSTIP | Filter by dst ip (regexp can be used) | | | +| WARNINGSTATUS | Define the conditions to match for the status to be WARNING. You can use the following variables: %\{state\}, %\{srcIp\}, %\{dstIp\} | %\{state\} eq "dead" | | +| CRITICALSTATUS | Define the conditions to match for the status to be CRITICAL. You can use the following variables: %\{state\}, %\{srcIp\}, %\{dstIp\} | | | +| WARNINGTRAFFIC | Threshold | | | +| CRITICALTRAFFIC | Threshold | | | +| WARNINGTRAFFICIN | Threshold | | | +| CRITICALTRAFFICIN | Threshold | | | +| WARNINGTRAFFICOUT | Threshold | | | +| CRITICALTRAFFICOUT | Threshold | | | +| WARNINGVPNDETECTED | Threshold | | | +| CRITICALVPNDETECTED | Threshold | | | +| EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). Toutes les options sont listées [ici](#options-disponibles). | --verbose | | @@ -578,7 +593,12 @@ telle que celle-ci (remplacez les valeurs d'exemple par les vôtres) : --mode=vpn-status \ --hostname='10.0.0.1' \ --snmp-version='2c' \ - --snmp-community='my-snmp-community' \ + --snmp-community='my-snmp-community' \ + --snmp-username='username' \ + --authpassphrase='' \ + --authprotocol='' \ + --privpassphrase='' \ + --privprotocol='' \ --filter-id='' \ --filter-src-ip='' \ --filter-dst-ip='' \ @@ -598,7 +618,7 @@ telle que celle-ci (remplacez les valeurs d'exemple par les vôtres) : La commande devrait retourner un message de sortie similaire à : ```bash -OK: detected: 85 All vpn are ok | 'vpn.detected.count'=85;;;0;'*vpn*#vpn.traffic.bitspersecond'=b/s;;;;'*vpn*#vpn.traffic.in.bitspersecond'=b/s;;;;'*vpn*#vpn.traffic.out.bitspersecond'=b/s;;;; +OK: detected: 56562 All vpn are ok | 'vpn.detected.count'=56562;;;0; 'vpn1#vpn.traffic.bitspersecond'=69638b/s;;;; 'vpn2#vpn.traffic.bitspersecond'=95589b/s;;;; 'vpn1#vpn.traffic.in.bitspersecond'=1950b/s;;;; 'vpn2#vpn.traffic.in.bitspersecond'=4118b/s;;;; 'vpn1#vpn.traffic.out.bitspersecond'=71707b/s;;;; 'vpn2#vpn.traffic.out.bitspersecond'=15158b/s;;;; ``` ### Diagnostic des erreurs communes @@ -608,7 +628,7 @@ pour le diagnostic des erreurs communes des plugins Centreon. ### Modes disponibles -Dans la plupart des cas, un mode correspond à un modèle de service. Le mode est renseigné dans la commande d'exécution +Dans la plupart des cas, un mode correspond à un modèle de service. Le mode est renseigné dans la commande d'exécution du connecteur. Dans l'interface de Centreon, il n'est pas nécessaire de les spécifier explicitement, leur utilisation est implicite dès lors que vous utilisez un modèle de service. En revanche, vous devrez spécifier le mode correspondant à ce modèle si vous voulez tester la commande d'exécution du connecteur dans votre terminal. @@ -633,7 +653,7 @@ Le plugin apporte les modes suivants : | hardware [[code](https://github.com/centreon/centreon-plugins/blob/develop/src/network/stormshield/snmp/mode/hardware.pm)] | Net-Stormshield-Hardware-SNMP-custom | | health [[code](https://github.com/centreon/centreon-plugins/blob/develop/src/network/stormshield/snmp/mode/health.pm)] | Net-Stormshield-Health-SNMP-custom | | interfaces [[code](https://github.com/centreon/centreon-plugins/blob/develop/src/snmp_standard/mode/interfaces.pm)] | Net-Stormshield-Traffic-Generic-Id-SNMP-custom
Net-Stormshield-Traffic-Generic-Name-SNMP-custom
Net-Stormshield-Traffic-Global-SNMP-custom | -| list-interfaces [[code](https://github.com/centreon/centreon-plugins/blob/develop/src/snmp_standard/mode/listinterfaces.pm)] | Used for service discovery | +| list-interfaces [[code](https://github.com/centreon/centreon-plugins/blob/develop/src/snmp_standard/mode/listinterfaces.pm)] | Utilisé pour la découverte de services | | load [[code](https://github.com/centreon/centreon-plugins/blob/develop/src/snmp_standard/mode/loadaverage.pm)] | Net-Stormshield-Load-SNMP-custom | | memory [[code](https://github.com/centreon/centreon-plugins/blob/develop/src/os/freebsd/snmp/mode/memory.pm)] | Net-Stormshield-Memory-SNMP-custom | | memory-detailed [[code](https://github.com/centreon/centreon-plugins/blob/develop/src/network/stormshield/snmp/mode/memorydetailed.pm)] | Net-Stormshield-Memory-Detailed-SNMP-custom | @@ -648,61 +668,67 @@ Le plugin apporte les modes suivants : Les options génériques sont listées ci-dessous : -| 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. | -| --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 an "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\[,\[newuom\],\[min\],\[m ax\]\] Common examples: 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() | -| --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,namesofnewmetrics,calculation\[,\[ne wuom\],\[min\],\[max\]\] regex: regular expression namesofnewmetrics: 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 newuom (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: 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(traf fic\_(in\|out)\_$1)' | -| --change-short-output --change-long-output | Modify the short/long output that is returned by the plugin. Syntax: --change-short-output=pattern~replacement~modifier Most commonly used modifiers are i (case insensitive) and g (replace all occurrences). Example: adding --change-short-output='OK\~Up\~gi' will replace all occurrences of 'OK', 'ok', 'Ok' or 'oK' with 'Up' | -| --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. | -| --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). E.g.: --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'. | -| --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 ok, 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. | +| 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 get-next 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 ok, 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. | +| --show-password | By default, sensitive information in command lines is hidden in debug output and replaced with `***` (however, debug logs may still display sensitive information). Using the C option will display the passwords in plain text. | +| --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\[,\[\\],\[min\],\[max\]\] Common examples: onvert 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\[,\[\\],\[min\],\[max\]\] Common examples: onvert 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\[,\[\\],\[min\],\[max\]\] Common examples: onvert 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,\,calculation\[,\[\\],\[min\],\[max\]\] regex: regular expression \: 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 \ (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: um 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~replacement~modifier Most commonly used modifiers are i (case insensitive) and g (replace all occurrences). Example: adding --change-short-output='OK~Up~gi' will replace all occurrences of 'OK', 'ok', 'Ok' or 'oK' with 'Up' | +| --change-short-output | Modify the short/long output that is returned by the plugin. Syntax: --change-short-output=pattern~replacement~modifier Most commonly used modifiers are i (case insensitive) and g (replace all occurrences). Example: adding --change-short-output='OK~Up~gi' will replace all occurrences of 'OK', 'ok', 'Ok' or 'oK' with 'Up' | +| --change-long-output | Modify the short/long output that is returned by the plugin. Syntax: --change-short-output=pattern~replacement~modifier Most commonly used modifiers are i (case insensitive) and g (replace all occurrences). Example: adding --change-short-output='OK~Up~gi' will replace all occurrences of 'OK', 'ok', 'Ok' or 'oK' with 'Up' | +| --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'. \. | #### Options des modes @@ -711,258 +737,308 @@ Les options disponibles pour chaque modèle de services sont listées ci-dessous -| Option | Description | -|:-----------------------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| --memcached | Memcached server to use (only one server). | -| --redis-server | Redis server to use (only one server). Syntax: address\[:port\] | -| --redis-attribute | Set Redis Options (--redis-attribute="cnx\_timeout=5"). | -| --redis-db | Set Redis database index. | -| --failback-file | Failback on a local file if Redis connection fails. | -| --memexpiration | Time to keep data in seconds (default: 86400). | -| --statefile-dir | Define the cache directory (default: '/var/lib/centreon/centplugins'). | -| --statefile-suffix | Define a suffix to customize the statefile name (default: ''). | -| --statefile-concat-cwd | If used with the '--statefile-dir' option, the latter's value will be used as a sub-directory of the current working directory. Useful on Windows when the plugin is compiled, as the file system and permissions are different from Linux. | -| --statefile-format | Define the format used to store the cache. Available formats: 'dumper', 'storable', 'json' (default). | -| --statefile-key | Define the key to encrypt/decrypt the cache. | -| --statefile-cipher | Define the cipher algorithm to encrypt the cache (default: 'AES'). | -| --warning-* | Warning threshold. Can be: 'tcp', 'udp' | -| --critical-* | Critical threshold. Can be: 'tcp', 'udp' | +| Option | Description | +|:------------------|:--------------------------------------------------------------------------------------------------------------------------| +| --filter-counters | Only display some counters (regexp can be used). Example to check SSL connections only : --filter-counters='^xxxx\|yyyy$' | +| --warning-xxx | Warning threshold. | +| --critical-xxx | Critical threshold. | +| --warning-* | Warning threshold. Can be: 'tcp', 'udp' | +| --critical-* | Critical threshold. Can be: 'tcp', 'udp' | -| Option | Description | -|:-------------------|:----------------------------------------------| -| --use-ucd | Use UCD MIB for CPU average. | -| --warning-average | Warning threshold for average CPU utilization. | -| --critical-average | Critical threshold for average CPU utilization. | -| --warning-core | Warning threshold for each CPU core | -| --critical-core | Critical threshold for each CPU core | +| Option | Description | +|:-------------------|:--------------------------------------------------------------------------------------------------------------------------| +| --filter-counters | Only display some counters (regexp can be used). Example to check SSL connections only : --filter-counters='^xxxx\|yyyy$' | +| --warning-xxx | Warning threshold. | +| --critical-xxx | Critical threshold. | +| --use-ucd | Use UCD MIB for CPU average. | +| --warning-average | Warning threshold average CPU utilization. | +| --critical-average | Critical threshold average CPU utilization. | +| --warning-core | Warning thresholds for each CPU core | +| --critical-core | Critical thresholds for each CPU core | -| Option | Description | -|:-----------------------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| --memcached | Memcached server to use (only one server). | -| --redis-server | Redis server to use (only one server). Syntax: address\[:port\] | -| --redis-attribute | Set Redis Options (--redis-attribute="cnx\_timeout=5"). | -| --redis-db | Set Redis database index. | -| --failback-file | Failback on a local file if Redis connection fails. | -| --memexpiration | Time to keep data in seconds (default: 86400). | -| --statefile-dir | Define the cache directory (default: '/var/lib/centreon/centplugins'). | -| --statefile-suffix | Define a suffix to customize the statefile name (default: ''). | -| --statefile-concat-cwd | If used with the '--statefile-dir' option, the latter's value will be used as a sub-directory of the current working directory. Useful on Windows when the plugin is compiled, as the file system and permissions are different from Linux. | -| --statefile-format | Define the format used to store the cache. Available formats: 'dumper', 'storable', 'json' (default). | -| --statefile-key | Define the key to encrypt/decrypt the cache. | -| --statefile-cipher | Define the cipher algorithm to encrypt the cache (default: 'AES'). | -| --warning-* | Warning threshold in percent. Can be: 'user', 'nice', 'system', 'idle', 'wait', 'kernel', 'interrupt', 'softirq', 'steal', 'guest', 'guestnice'. | -| --critical-* | Critical threshold in percent. Can be: 'user', 'nice', 'system', 'idle', 'wait', 'kernel', 'interrupt', 'softirq', 'steal', 'guest', 'guestnice'. | +| Option | Description | +|:---------------------|:--------------------------------------------------------------------------------------------------------------------------| +| --filter-counters | Only display some counters (regexp can be used). Example to check SSL connections only : --filter-counters='^xxxx\|yyyy$' | +| --warning-xxx | Warning threshold. | +| --critical-xxx | Critical threshold. | +| --warning-guest | Threshold in percentage. | +| --critical-guest | Threshold in percentage. | +| --warning-guestnice | Threshold in percentage. | +| --critical-guestnice | Threshold in percentage. | +| --warning-idle | Threshold in percentage. | +| --critical-idle | Threshold in percentage. | +| --warning-interrupt | Threshold in percentage. | +| --critical-interrupt | Threshold in percentage. | +| --warning-kernel | Threshold in percentage. | +| --critical-kernel | Threshold in percentage. | +| --warning-nice | Threshold in percentage. | +| --critical-nice | Threshold in percentage. | +| --warning-softirq | Threshold in percentage. | +| --critical-softirq | Threshold in percentage. | +| --warning-steal | Threshold in percentage. | +| --critical-steal | Threshold in percentage. | +| --warning-system | Threshold in percentage. | +| --critical-system | Threshold in percentage. | +| --warning-user | Threshold in percentage. | +| --critical-user | Threshold in percentage. | +| --warning-wait | Threshold in percentage. | +| --critical-wait | Threshold in percentage. | -| Option | Description | -|:------------------------------------------------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| --memcached | Memcached server to use (only one server). | -| --redis-server | Redis server to use (only one server). Syntax: address\[:port\] | -| --redis-attribute | Set Redis Options (--redis-attribute="cnx\_timeout=5"). | -| --redis-db | Set Redis database index. | -| --failback-file | Failback on a local file if Redis connection fails. | -| --memexpiration | Time to keep data in seconds (default: 86400). | -| --statefile-dir | Define the cache directory (default: '/var/lib/centreon/centplugins'). | -| --statefile-suffix | Define a suffix to customize the statefile name (default: ''). | -| --statefile-concat-cwd | If used with the '--statefile-dir' option, the latter's value will be used as a sub-directory of the current working directory. Useful on Windows when the plugin is compiled, as the file system and permissions are different from Linux. | -| --statefile-format | Define the format used to store the cache. Available formats: 'dumper', 'storable', 'json' (default). | -| --statefile-key | Define the key to encrypt/decrypt the cache. | -| --statefile-cipher | Define the cipher algorithm to encrypt the cache (default: 'AES'). | -| --warning-usage | Warning threshold. | -| --critical-usage | Critical threshold. | -| --warning-access | Warning threshold. | -| --critical-access | Critical threshold. Check if storage is readOnly: --critical-access=readOnly | -| --add-access | Check storage access (readOnly, readWrite). | -| --units | Units of thresholds (default: '%') ('%', 'B'). | -| --free | Thresholds are on free space left. | -| --storage | Define the storage units to check (number expected). Example: 1, 2... (empty means 'check all storage units') | -| --name | Allows to use storage name with option --storage instead of storage OID index. | -| --regexp | Allows to use regexp to filter storage (with option --name). | -| --regexp-insensitive | Allows to use regexp non case-sensitive (with --regexp). | -| --path-best-match | Allows to select best path mount point (with --name). | -| --reload-cache-time | Time in minutes before reloading cache file (default: 180). | -| --oid-filter | Choose OID used to filter storage (default: hrStorageDescr) (values: hrStorageDescr, hrFSMountPoint). | -| --oid-display | Choose OID used to display storage (default: hrStorageDescr) (values: hrStorageDescr, hrFSMountPoint). | -| --display-transform-src --display-transform-dst | Modify the storage name displayed by using a regular expression. Example: adding --display-transform-src='dev' --display-transform-dst='run' will replace all occurrences of 'dev' with 'run' | -| --show-cache | Display cache storage data. | -| --space-reservation | Some filesystem has space reserved (like ext4 for root). The value is in percent of total (default: none) (results like 'df' command). | -| --filter-duplicate | Filter duplicate storages (in used size and total size). | -| --filter-storage-type | Filter storage types with a regexp (default: '^(hrStorageFixedDisk\|hrStorageNetworkDisk\|hrFSBerkeleyFFS)$'). | +| Option | Description | +|:------------------------------------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| --filter-counters | Only display some counters (regexp can be used). Example to check SSL connections only : --filter-counters='^xxxx\|yyyy$' | +| --warning-xxx | Warning threshold. | +| --critical-xxx | Critical threshold. | +| --memcached | Memcached server to use (only one server). | +| --redis-server | Redis server to use (only one server). Syntax: address\[:port\] | +| --redis-attribute | Set Redis Options (--redis-attribute="cnx\_timeout=5"). | +| --redis-db | Set Redis database index. | +| --failback-file | Fall back on a local file if Redis connection fails. | +| --memexpiration | Time to keep data in seconds (default: 86400). | +| --statefile-dir | Define the cache directory (default: '/var/lib/centreon/centplugins'). | +| --statefile-suffix | Define a suffix to customize the statefile name (default: ''). | +| --statefile-concat-cwd | If used with the '--statefile-dir' option, the latter's value will be used as a sub-directory of the current working directory. Useful on Windows when the plugin is compiled, as the file system and permissions are different from Linux. | +| --statefile-format | Define the format used to store the cache. Available formats: 'dumper', 'storable', 'json' (default). | +| --statefile-key | Define the key to encrypt/decrypt the cache. | +| --statefile-cipher | Define the cipher algorithm to encrypt the cache (default: 'AES'). | +| --warning-usage | Warning threshold. | +| --critical-usage | Critical threshold. | +| --warning-access | Warning threshold. | +| --critical-access | Critical threshold. Check if storage is readOnly: --critical-access=readOnly | +| --add-access | Check storage access (readOnly, readWrite). | +| --units | Units of thresholds (default: '%') ('%', 'B'). | +| --free | Thresholds are on free space left. | +| --storage | Set the storage (number expected) example: 1, 2,... (empty means 'check all storage'). | +| --name | Allows to use storage name with option --storage instead of storage oid index. | +| --regexp | Allows to use regexp to filter storage (with option --name). | +| --regexp-insensitive | Allows to use regexp non case-sensitive (with --regexp). | +| --path-best-match | Allows to select best path mount point (with --name). | +| --reload-cache-time | Time in minutes before reloading cache file (default: 180). | +| --oid-filter | Choose OID used to filter storage (default: hrStorageDescr) (values: hrStorageDescr, hrFSMountPoint). | +| --oid-display | Choose OID used to display storage (default: hrStorageDescr) (values: hrStorageDescr, hrFSMountPoint). | +| --display-transform-src --display-transform-dst | Modify the storage name displayed by using a regular expression. Example: adding --display-transform-src='dev' --display-transform-dst='run' will replace all occurrences of 'dev' with 'run' | +| --show-cache | Display cache storage data. | +| --space-reservation | Some filesystem has space reserved (like ext4 for root). The value is in percent of total (default: none) (results like 'df' command). | +| --filter-duplicate | Filter duplicate storages (in used size and total size). | +| --filter-storage-type | Filter storage types with a regexp (default: '^(hrStorageFixedDisk\|hrStorageNetworkDisk\|hrFSBerkeleyFFS)$'). | -| Option | Description | -|:----------------------|:---------------------------------------------------------------------------------------------------------------------------------| -| --filter-node | Filter name with regexp (based on serial). | -| --warning-health | Warning threshold on health level (example: --warning 90:). | -| --critical-health | Critical threshold on health level (example --critical 80:). | -| --warning-dead-nodes | Warning threshold on dead nodes (absolute unless --percent is used). | -| --critical-dead-nodes | Critical threshold on dead nodes (absolute unless --percent is used). | +| Option | Description | +|:----------------------|:-------------------------------------------------------------------------------------------------------------------------------------| +| --filter-counters | Only display some counters (regexp can be used). Example to check SSL connections only : --filter-counters='^xxxx\|yyyy$' | +| --warning-xxx | Warning threshold. | +| --critical-xxx | Critical threshold. | +| --filter-node | Filter name with regexp (based on serial). | +| --warning-health | Warning threshold on health level (example: --warning 90:). | +| --critical-health | Critical threshold on health level (example --critical 80:). | +| --warning-dead-nodes | Warning threshold on deadnode (absolute unless --percent is used). | +| --critical-dead-nodes | Critical threshold on deadnode (absolute unless --percent is used). | | --warning-state | Set warning threshold for state. You can use the following variables: %\{state\}, %\{role\}. | -| --critical-state | Set critical threshold for state. (default: '%\{state\} =~ /offline/i'). You can use the following variables: %\{state\}, %\{role\}. | -| --percent | Set this option if you want to warn on percent . | +| --critical-state | Set critical threshold for state. (default: '%\{state\} =~ /offline/i'). You can use the following variables: %\{state\}, %\{role\}. | +| --percent | Set this option if you want to warn on percent . | -| Option | Description | -|:---------------------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| --component | Which component to check (default: '.*'). Can be: 'disk', 'fan', 'psu', 'temperature'. | -| --filter | Exclude the items given as a comma-separated list (example: --filter=fan). You can also exclude items from specific instances: --filter=fan,1 | -| --no-component | Define the expected status if no components are found (default: critical). | -| --threshold-overload | Use this option to override the status returned by the plugin when the status label matches a regular expression (syntax: section,\[instance,\]status,regexp). Example: --threshold-overload='disk,WARNING,missing' | -| --warning | Set warning threshold for 'temperature', 'fan' (syntax: type,regexp,threshold) Example: --warning='temperature,.*,40' | -| --critical | Set critical threshold for 'temperature', 'fan' (syntax: type,regexp,threshold) Example: --critical='temperature,.*,50' | +| Option | Description | +|:---------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| --component | Which component to check (default: '.*'). Can be: 'disk', 'fan', 'psu', 'temperature'. | +| --filter | Exclude the items given as a comma-separated list (example: --filter=fan). You can also exclude items from specific instances: --filter=fan,1 | +| --absent-problem | Return an error if a component is not 'present' (default is skipping). It can be set globally or for a specific instance: --absent-problem='component\_name' or --absent-problem='component\_name,instance\_value'. | +| --no-component | Define the expected status if no components are found (default: critical). | +| --threshold-overload | Use this option to override the status returned by the plugin when the status label matches a regular expression (syntax: section,\[instance,\]status,regexp). Example: --threshold-overload='disk,WARNING,missing' | +| --warning | Set warning threshold for 'temperature', 'fan' (syntax: type,regexp,threshold) Example: --warning='temperature,.*,40' | +| --critical | Set critical threshold for 'temperature', 'fan' (syntax: type,regexp,threshold) Example: --critical='temperature,.*,50' | +| --warning-count-* | Define the warning threshold for the number of components of one type (replace '*' with the component type). | +| --critical-count-* | Define the critical threshold for the number of components of one type (replace '*' with the component type). | -| Option | Description | -|:--------------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------| -| --filter-serial | Filter by firewall serial (can be a regexp). | -| --unknown-service-status | Define the conditions to match for the status to be UNKNOWN. You can use the following variables: %\{health\}, %\{service\} | -| --warning-service-status | Define the conditions to match for the status to be WARNING (default: '%\{health\} =~ /minor/i'). You can use the following variables: %\{health\}, %\{service\} | -| --critical-service-status | Define the conditions to match for the status to be CRITICAL (default: '%\{health\} =~ /major/i'). You can use the following variables: %\{health\}, %\{service\} | +| Option | Description | +|:--------------------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| --filter-counters | Only display some counters (regexp can be used). Example to check SSL connections only : --filter-counters='^xxxx\|yyyy$' | +| --warning-xxx | Warning threshold. | +| --critical-xxx | Critical threshold. | +| --filter-serial | Filter by firewall serial (can be a regexp). | +| --unknown-service-status | Define the conditions to match for the status to be UNKNOWN. You can use the following variables: %\{health\}, %\{service\} | +| --warning-service-status | Define the conditions to match for the status to be WARNING (default: '%\{health\} =~ /minor/i'). You can use the following variables: %\{health\}, %\{service\} | +| --critical-service-status | Define the conditions to match for the status to be CRITICAL (default: '%\{health\} =~ /major/i'). You can use the following variables: %\{health\}, %\{service\} | -| Option | Description | -|:-----------|:----------------------------------------| -| --warning | Warning threshold (1min,5min,15min). | -| --critical | Critical threshold (1min,5min,15min). | -| --average | Load average for the number of CPUs. | +| Option | Description | +|:-----------|:--------------------------------------| +| --warning | Warning threshold (1min,5min,15min). | +| --critical | Critical threshold (1min,5min,15min). | +| --average | Load average for the number of CPUs. | -| Option | Description | -|:----------------|:------------------------------------------------------| -| --warning | Warning threshold in percent. | -| --critical | Critical threshold in percent. | -| --swap | Check swap also. | -| --warning-swap | Warning threshold in percent. | -| --critical-swap | Critical threshold in percent. | -| --no-swap | Status if no active swap (default: 'critical'). | +| Option | Description | +|:----------------|:---------------------------------------------------| +| --warning | Warning threshold in percent. | +| --critical | Critical threshold in percent. | +| --swap | Check swap also. | +| --warning-swap | Warning threshold in percent. | +| --critical-swap | Critical threshold in percent. | +| --no-swap | Threshold if no active swap (default: 'critical'). | -| Option | Description | -|:-------------------------|:-----------------------------------------------------------------------------------------------| -| --warning-* --critical-* | Thresholds. Can be: 'total', 'host', 'frag', 'conn', 'icmp', 'dtrack', 'dyn', 'etherstate'. | +| Option | Description | +|:-------------------------|:--------------------------------------------------------------------------------------------------------------------------| +| --filter-counters | Only display some counters (regexp can be used). Example to check SSL connections only : --filter-counters='^xxxx\|yyyy$' | +| --warning-xxx | Warning threshold. | +| --critical-xxx | Critical threshold. | +| --warning-* --critical-* | Thresholds. Can be: 'total', 'host', 'frag', 'conn', 'icmp', 'dtrack', 'dyn', 'etherstate'. | -| Option | Description | -|:-------------------------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| --memcached | Memcached server to use (only one server). | -| --redis-server | Redis server to use (only one server). Syntax: address\[:port\] | -| --redis-attribute | Set Redis Options (--redis-attribute="cnx\_timeout=5"). | -| --redis-db | Set Redis database index. | -| --failback-file | Failback on a local file if Redis connection fails. | -| --memexpiration | Time to keep data in seconds (default: 86400). | -| --statefile-dir | Define the cache directory (default: '/var/lib/centreon/centplugins'). | -| --statefile-suffix | Define a suffix to customize the statefile name (default: ''). | -| --statefile-concat-cwd | If used with the '--statefile-dir' option, the latter's value will be used as a sub-directory of the current working directory. Useful on Windows when the plugin is compiled, as the file system and permissions are different from Linux. | -| --statefile-format | Define the format used to store the cache. Available formats: 'dumper', 'storable', 'json' (default). | -| --statefile-key | Define the key to encrypt/decrypt the cache. | -| --statefile-cipher | Define the cipher algorithm to encrypt the cache (default: 'AES'). | -| --filter-name | Filter by QoS name (can be a regexp). | -| --speed-in | Set interface speed for incoming traffic (in Mb). | -| --speed-out | Set interface speed for outgoing traffic (in Mb). | -| --warning-* --critical-* | Thresholds. Can be: 'traffic-in', 'traffic-in-prct', 'traffic-in-peak', 'traffic-out', 'traffic-out-prct', 'traffic-out-peak'. | +| Option | Description | +|:-------------------------|:-------------------------------------------------------------------------------------------------------------------------------| +| --filter-counters | Only display some counters (regexp can be used). Example to check SSL connections only : --filter-counters='^xxxx\|yyyy$' | +| --warning-xxx | Warning threshold. | +| --critical-xxx | Critical threshold. | +| --filter-name | Filter by QoS name (can be a regexp). | +| --speed-in | Set interface speed for incoming traffic (in Mb). | +| --speed-out | Set interface speed for outgoing traffic (in Mb). | +| --warning-* --critical-* | Thresholds. Can be: 'traffic-in', 'traffic-in-prct', 'traffic-in-peak', 'traffic-out', 'traffic-out-prct', 'traffic-out-peak'. | -| Option | Description | -|:-------------------------|:------------------------------------------------------------------------| -| --no-swap | Status if no active swap (default: 'critical'). | -| --warning-* --critical-* | Thresholds. Can be: 'usage' (B), 'usage-free' (B), 'usage-prct' (%). | +| Option | Description | +|:----------------------|:--------------------------------------------------------------------------------------------------------------------------| +| --filter-counters | Only display some counters (regexp can be used). Example to check SSL connections only : --filter-counters='^xxxx\|yyyy$' | +| --warning-xxx | Warning threshold. | +| --critical-xxx | Critical threshold. | +| --no-swap | Threshold if no active swap (default: 'critical'). | +| --warning-usage | Threshold in bytes. | +| --critical-usage | Threshold in bytes. | +| --warning-usage-free | Threshold in bytes. | +| --critical-usage-free | Threshold in bytes. | +| --warning-usage-prct | Threshold in percentage. | +| --critical-usage-prct | Threshold in percentage. | -| Option | Description | -|:------------------------------------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| --memcached | Memcached server to use (only one server). | -| --redis-server | Redis server to use (only one server). Syntax: address\[:port\] | -| --redis-attribute | Set Redis Options (--redis-attribute="cnx\_timeout=5"). | -| --redis-db | Set Redis database index. | -| --failback-file | Failback on a local file if Redis connection fails. | -| --memexpiration | Time to keep data in seconds (default: 86400). | -| --statefile-dir | Define the cache directory (default: '/var/lib/centreon/centplugins'). | -| --statefile-suffix | Define a suffix to customize the statefile name (default: ''). | -| --statefile-concat-cwd | If used with the '--statefile-dir' option, the latter's value will be used as a sub-directory of the current working directory. Useful on Windows when the plugin is compiled, as the file system and permissions are different from Linux. | -| --statefile-format | Define the format used to store the cache. Available formats: 'dumper', 'storable', 'json' (default). | -| --statefile-key | Define the key to encrypt/decrypt the cache. | -| --statefile-cipher | Define the cipher algorithm to encrypt the cache (default: 'AES'). | -| --add-global | Check global port statistics (by default if no --add-* option is set). | -| --add-status | Check interface status. | -| --add-duplex-status | Check duplex status (with --warning-status and --critical-status). | -| --add-traffic | Check interface traffic. | -| --add-errors | Check interface errors. | -| --add-cast | Check interface cast. | -| --add-speed | Check interface speed. | -| --add-volume | Check interface data volume between two checks (not supposed to be graphed, useful for BI reporting). | -| --check-metrics | If the expression is true, metrics are checked (default: '%\{opstatus\} eq "up"'). | -| --warning-status | Define the conditions to match for the status to be WARNING. You can use the following variables: %\{admstatus\}, %\{opstatus\}, %\{duplexstatus\}, %\{display\} | -| --critical-status | Define the conditions to match for the status to be CRITICAL (default: '%\{admstatus\} eq "up" and %\{opstatus\} ne "up"'). You can use the following variables: %\{admstatus\}, %\{opstatus\}, %\{duplexstatus\}, %\{display\} | -| --warning-* --critical-* | Thresholds. Can be: 'total-port', 'total-admin-up', 'total-admin-down', 'total-oper-up', 'total-oper-down', 'in-traffic', 'out-traffic', 'in-error', 'in-discard', 'out-error', 'out-discard', 'in-ucast', 'in-bcast', 'in-mcast', 'out-ucast', 'out-bcast', 'out-mcast', 'speed' (b/s). | -| --units-traffic | Units of thresholds for the traffic (default: 'percent\_delta') ('percent\_delta', 'bps', 'counter'). | -| --units-errors | Units of thresholds for errors/discards (default: 'percent\_delta') ('percent\_delta', 'percent', 'delta', 'deltaps', 'counter'). | -| --units-cast | Units of thresholds for communication types (default: 'percent\_delta') ('percent\_delta', 'percent', 'delta', 'deltaps', 'counter'). | -| --nagvis-perfdata | Display traffic perfdata to be compatible with nagvis widget. | -| --interface | Define which interfaces to check (number expected). Example: 1,2... (empty means 'check all interfaces'). | -| --name | Allows you to define the interface (in option --interface) by name instead of OID index. The name matching mode supports regular expressions. | -| --speed | Set interface speed for incoming/outgoing traffic (in Mb). | -| --speed-in | Set interface speed for incoming traffic (in Mb). | -| --speed-out | Set interface speed for outgoing traffic (in Mb). | -| --map-speed-dsl | Get interface speed configuration for interface type 'adsl' and 'vdsl2'. Syntax: --map-speed-dsl=interface-src-name,interface-dsl-name E.g: --map-speed-dsl=Et0.835,Et0-vdsl2 | -| --force-counters64 | Force to use 64-bit counters only. Can be used to improve performance. | -| --force-counters32 | Force to use 32-bit counters (even in snmp v2c and v3). Should be used when 64-bit counters are buggy. | -| --reload-cache-time | Time in minutes before reloading cache file (default: 180). | -| --oid-filter | Define the OID to be used to filter interfaces (default: ifName) (values: ifDesc, ifAlias, ifName, IpAddr). | -| --oid-display | Define the OID that will be used to name the interfaces (default: ifName) (values: ifDesc, ifAlias, ifName, IpAddr). | -| --oid-extra-display | Add an OID to display. | -| --display-transform-src --display-transform-dst | Modify the interface name displayed by using a regular expression. Example: adding --display-transform-src='eth' --display-transform-dst='ens' will replace all occurrences of 'eth' with 'ens' | -| --show-cache | Display cache interface data. | +| Option | Description | +|:------------------------------------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| --filter-counters | Only display some counters (regexp can be used). Example to check SSL connections only : --filter-counters='^xxxx\|yyyy$' | +| --warning-xxx | Warning threshold. | +| --critical-xxx | Critical threshold. | +| --memcached | Memcached server to use (only one server). | +| --redis-server | Redis server to use (only one server). Syntax: address\[:port\] | +| --redis-attribute | Set Redis Options (--redis-attribute="cnx\_timeout=5"). | +| --redis-db | Set Redis database index. | +| --failback-file | Fall back on a local file if Redis connection fails. | +| --memexpiration | Time to keep data in seconds (default: 86400). | +| --statefile-dir | Define the cache directory (default: '/var/lib/centreon/centplugins'). | +| --statefile-suffix | Define a suffix to customize the statefile name (default: ''). | +| --statefile-concat-cwd | If used with the '--statefile-dir' option, the latter's value will be used as a sub-directory of the current working directory. Useful on Windows when the plugin is compiled, as the file system and permissions are different from Linux. | +| --statefile-format | Define the format used to store the cache. Available formats: 'dumper', 'storable', 'json' (default). | +| --statefile-key | Define the key to encrypt/decrypt the cache. | +| --statefile-cipher | Define the cipher algorithm to encrypt the cache (default: 'AES'). | +| --add-global | Check global port statistics (by default if no --add-* option is set). | +| --add-status | Check interface status. | +| --add-duplex-status | Check duplex status (with --warning-status and --critical-status). | +| --add-traffic | Check interface traffic. | +| --add-errors | Check interface errors. | +| --add-cast | Check interface cast. | +| --add-speed | Check interface speed. | +| --add-volume | Check interface data volume between two checks (not supposed to be graphed, useful for BI reporting). | +| --check-metrics | If the expression is true, metrics are checked (default: '%\{opstatus\} eq "up"'). | +| --warning-status | Define the conditions to match for the status to be WARNING. You can use the following variables: %\{admstatus\}, %\{opstatus\}, %\{duplexstatus\}, %\{display\} | +| --critical-status | Define the conditions to match for the status to be CRITICAL (default: '%\{admstatus\} eq "up" and %\{opstatus\} ne "up"'). You can use the following variables: %\{admstatus\}, %\{opstatus\}, %\{duplexstatus\}, %\{display\} | +| --warning-total-port | Thresholds. | +| --critical-total-port | Thresholds. | +| --warning-total-admin-up | Thresholds. | +| --critical-total-admin-up | Thresholds. | +| --warning-total-admin-down | Thresholds. | +| --critical-total-admin-down | Thresholds. | +| --warning-total-oper-up | Thresholds. | +| --critical-total-oper-up | Thresholds. | +| --warning-total-oper-down | Thresholds. | +| --critical-total-oper-down | Thresholds. | +| --warning-in-traffic | Thresholds. | +| --critical-in-traffic | Thresholds. | +| --warning-out-traffic | Thresholds. | +| --critical-out-traffic | Thresholds. | +| --warning-in-error | Thresholds. | +| --critical-in-error | Thresholds. | +| --warning-in-discard | Thresholds. | +| --critical-in-discard | Thresholds. | +| --warning-out-error | Thresholds. | +| --critical-out-error | Thresholds. | +| --warning-out-discard | Thresholds. | +| --critical-out-discard | Thresholds. | +| --warning-in-ucast | Thresholds. | +| --critical-in-ucast | Thresholds. | +| --warning-in-bcast | Thresholds. | +| --critical-in-bcast | Thresholds. | +| --warning-in-mcast | Thresholds. | +| --critical-in-mcast | Thresholds. | +| --warning-out-ucast | Thresholds. | +| --critical-out-ucast | Thresholds. | +| --warning-out-bcast | Thresholds. | +| --critical-out-bcast | Thresholds. | +| --warning-out-mcast | Thresholds. | +| --critical-out-mcast | Thresholds. | +| --warning-speed | Thresholds in b/s. | +| --critical-speed | Thresholds in b/s. | +| --units-traffic | Units of thresholds for the traffic (default: 'percent\_delta') ('percent\_delta', 'bps', 'counter'). | +| --units-errors | Units of thresholds for errors/discards (default: 'percent\_delta') ('percent\_delta', 'delta', 'deltaps', 'counter'). | +| --units-cast | Units of thresholds for communication types (default: 'percent\_delta') ('percent\_delta', 'percent', 'delta', 'deltaps', 'counter'). | +| --nagvis-perfdata | Display traffic perfdata to be compatible with NagVis widget. | +| --interface | Check only the interfaces with the specified IDs (OID indexes, e.g.: 1,2,...). If empty, all interfaces will be monitored. To filter on interface names, see --name. | +| --name | With this option, the interfaces will be filtered by name (given in option --interface) instead of OID index. The name matching mode supports regular expressions. | +| --regex-id | With this option, interface IDs will be filtered using the --interface parameter as a regular expression instead of a list of IDs. | +| --speed | Set interface speed for incoming/outgoing traffic (in Mb). | +| --speed-in | Set interface speed for incoming traffic (in Mb). | +| --speed-out | Set interface speed for outgoing traffic (in Mb). | +| --map-speed-dsl | Get interface speed configuration for interfaces of type 'ADSL' and 'VDSL2'. Syntax: --map-speed-dsl=interface-src-name,interface-dsl-name E.g: --map-speed-dsl=Et0.835,Et0-vdsl2 | +| --force-counters64 | Force to use 64 bits counters only. Can be used to improve performance. | +| --force-counters32 | Force to use 32-bit counters (even with SNMP versions 2c and 3). To use when 64 bits counters are buggy. | +| --reload-cache-time | Time in minutes before reloading cache file (default: 180). | +| --oid-filter | Define the OID to be used to filter interfaces (default: ifName) (values: ifDesc, ifAlias, ifName, IpAddr). | +| --oid-display | Define the OID that will be used to name the interfaces (default: ifName) (values: ifDesc, ifAlias, ifName, IpAddr). | +| --oid-extra-display | Add an OID to display. | +| --display-transform-src --display-transform-dst | Modify the interface name displayed by using a regular expression. Example: adding --display-transform-src='eth' --display-transform-dst='ens' will replace all occurrences of 'eth' with 'ens' | +| --show-cache | Display cache interface data. | +| --no-cache-lock | Set to disable locking when accessing cache. | -| Option | Description | -|:-------------------------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| --memcached | Memcached server to use (only one server). | -| --redis-server | Redis server to use (only one server). Syntax: address\[:port\] | -| --redis-attribute | Set Redis Options (--redis-attribute="cnx\_timeout=5"). | -| --redis-db | Set Redis database index. | -| --failback-file | Failback on a local file if Redis connection fails. | -| --memexpiration | Time to keep data in seconds (default: 86400). | -| --statefile-dir | Define the cache directory (default: '/var/lib/centreon/centplugins'). | -| --statefile-suffix | Define a suffix to customize the statefile name (default: ''). | -| --statefile-concat-cwd | If used with the '--statefile-dir' option, the latter's value will be used as a sub-directory of the current working directory. Useful on Windows when the plugin is compiled, as the file system and permissions are different from Linux. | -| --statefile-format | Define the format used to store the cache. Available formats: 'dumper', 'storable', 'json' (default). | -| --statefile-key | Define the key to encrypt/decrypt the cache. | -| --statefile-cipher | Define the cipher algorithm to encrypt the cache (default: 'AES'). | -| --filter-id | Filter by ID (regexp can be used). | -| --filter-src-ip | Filter by source IP address (regexp can be used). | -| --filter-dst-ip | Filter by destination IP address (regexp can be used). | -| --unknown-status | Define the conditions to match for the status to be UNKNOWN. You can use the following variables: %\{state\}, %\{srcIp\}, %\{dstIp\} | -| --warning-status | Define the conditions to match for the status to be WARNING (default: '%\{state\} eq "dead"'). You can use the following variables: %\{state\}, %\{srcIp\}, %\{dstIp\} | -| --critical-status | Define the conditions to match for the status to be CRITICAL. You can use the following variables: %\{state\}, %\{srcIp\}, %\{dstIp\} | -| --warning-* --critical-* | Thresholds. Can be: 'vpn-detected', 'traffic', 'traffic-in', 'traffic-out'. | +| Option | Description | +|:-------------------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| --filter-counters | Only display some counters (regexp can be used). Example to check SSL connections only : --filter-counters='^xxxx\|yyyy$' | +| --warning-xxx | Warning threshold. | +| --critical-xxx | Critical threshold. | +| --filter-id | Filter by ID (regexp can be used). | +| --filter-src-ip | Filter by src ip (regexp can be used). | +| --filter-dst-ip | Filter by dst ip (regexp can be used). | +| --unknown-status | Define the conditions to match for the status to be UNKNOWN. You can use the following variables: %\{state\}, %\{srcIp\}, %\{dstIp\} | +| --warning-status | Define the conditions to match for the status to be WARNING (default: '%\{state\} eq "dead"'). You can use the following variables: %\{state\}, %\{srcIp\}, %\{dstIp\} | +| --critical-status | Define the conditions to match for the status to be CRITICAL. You can use the following variables: %\{state\}, %\{srcIp\}, %\{dstIp\} | +| --warning-* --critical-* | Thresholds. Can be: 'vpn-detected', 'traffic', 'traffic-in', 'traffic-out'. | diff --git a/i18n/fr/docusaurus-plugin-content-docs-pp/current/integrations/plugin-packs/procedures/network-switchs-aruba-standard-snmp.md b/i18n/fr/docusaurus-plugin-content-docs-pp/current/integrations/plugin-packs/procedures/network-switchs-aruba-standard-snmp.md index b81d043dda07..c2b859aec4a8 100644 --- a/i18n/fr/docusaurus-plugin-content-docs-pp/current/integrations/plugin-packs/procedures/network-switchs-aruba-standard-snmp.md +++ b/i18n/fr/docusaurus-plugin-content-docs-pp/current/integrations/plugin-packs/procedures/network-switchs-aruba-standard-snmp.md @@ -50,17 +50,17 @@ Le connecteur apporte les modèles de service suivants -| Alias | Modèle de service | Description | Découverte | -|:---------------------------|:----------------------------------------------------------|:----------------------------------------------------------------------------|:----------:| -| Hardware-Fan | Net-Aruba-Standard-Hardware-Fan-SNMP-custom | Contrôle les ventilateurs de l'équipement | | -| Hardware-Module | Net-Aruba-Standard-Hardware-Module-SNMP-custom | Contrôle les modules de l'équipement | | -| Hardware-Psu | Net-Aruba-Standard-Hardware-Psu-SNMP-custom | Contrôle les alimentations de l'équipement | | -| Packet-Errors-Generic-Id | Net-Aruba-Standard-Packet-Errors-Generic-Id-SNMP-custom | Contrôle le pourcentage de paquets en erreur/écartés d'une interface réseau | | -| Packet-Errors-Generic-Name | Net-Aruba-Standard-Packet-Errors-Generic-Name-SNMP-custom | Contrôle le pourcentage de paquets en erreur/écartés d'une interface réseau | | -| Packet-Errors-Global | Net-Aruba-Standard-Packet-Errors-Global-SNMP-custom | Contrôle le pourcentage de paquets en erreur/écartés d'une interface réseau | X | -| Traffic-Generic-Id | Net-Aruba-Standard-Traffic-Generic-Id-SNMP-custom | Contrôle le trafic réseau d'une interface réseau | | -| Traffic-Generic-Name | Net-Aruba-Standard-Traffic-Generic-Name-SNMP-custom | Contrôle le trafic réseau d'une interface réseau | | -| Traffic-Global | Net-Aruba-Standard-Traffic-Global-SNMP-custom | Contrôle le trafic réseau d'une interface réseau | X | +| Alias | Modèle de service | Description | Découverte | +|:---------------------------|:----------------------------------------------------------|:------------------------------------------------------------------------------------|:----------:| +| Hardware-Fan | Net-Aruba-Standard-Hardware-Fan-SNMP-custom | Contrôle les ventilateurs de l'équipement | | +| Hardware-Module | Net-Aruba-Standard-Hardware-Module-SNMP-custom | Contrôle les modules de l'équipement | | +| Hardware-Psu | Net-Aruba-Standard-Hardware-Psu-SNMP-custom | Contrôle les alimentations de l'équipement | | +| Packet-Errors-Generic-Id | Net-Aruba-Standard-Packet-Errors-Generic-Id-SNMP-custom | Contrôle le pourcentage de paquets en erreur/écartés de plusieurs interfaces réseau | | +| Packet-Errors-Generic-Name | Net-Aruba-Standard-Packet-Errors-Generic-Name-SNMP-custom | Contrôle le pourcentage de paquets en erreur/écartés d'une interface réseau | | +| Packet-Errors-Global | Net-Aruba-Standard-Packet-Errors-Global-SNMP-custom | Contrôle le pourcentage de paquets en erreur/écartés de plusieurs interfaces réseau | X | +| Traffic-Generic-Id | Net-Aruba-Standard-Traffic-Generic-Id-SNMP-custom | Contrôle le traffic réseau d'une interface réseau | | +| Traffic-Generic-Name | Net-Aruba-Standard-Traffic-Generic-Name-SNMP-custom | Contrôle le traffic réseau d'une interface réseau | | +| Traffic-Global | Net-Aruba-Standard-Traffic-Global-SNMP-custom | Contrôle le traffic réseau d'une interface réseau | X | > Les services listés ci-dessus ne sont pas créés automatiquement lorsqu'un modèle d'hôte est appliqué. Pour les utiliser, [créez un service manuellement](/docs/monitoring/basic-objects/services) et appliquez le modèle de service souhaité. @@ -75,7 +75,7 @@ Le connecteur apporte les modèles de service suivants | Nom de la règle | Description | |:--------------------|:-----------------------------------------------------------| -| Aruba Access Points | Découvre les points d'accès Aruba Access au travers du Controller Aruba | +| Aruba Access Points | Discover Aruba Access Points throught the Aruba Controller | Rendez-vous sur la [documentation dédiée](/docs/monitoring/discovery/hosts-discovery) pour en savoir plus sur la découverte automatique d'hôtes. @@ -339,16 +339,18 @@ yum install centreon-plugin-Network-Switchs-Aruba-Standard-Snmp 2. Complétez les champs **Nom**, **Alias** & **IP Address/DNS** correspondant à votre ressource. 3. Appliquez le modèle d'hôte **Net-Aruba-Standard-Ap-SNMP-custom**. -> Si vous utilisez SNMP en version 3, vous devez configurer les paramètres spécifiques associés via la macro **SNMPEXTRAOPTIONS**. -> Plus d'informations dans la section [Troubleshooting SNMP](../getting-started/how-to-guides/troubleshooting-plugins.md#mapping-des-options-snmpv3). - -| Macro | Description | Valeur par défaut | Obligatoire | -|:------------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------|:------------------|:-----------:| -| ARUBACONTROLLERHOSTNAME | Name or address of the host to monitor (mandatory) | | | -| SNMPPORT | UDP port to send the SNMP request to | 161 | | -| APNAME | Threshold | | | -| SNMPTIMEOUT | Time to wait before sending the request again if no reply has been received, in seconds. See also --snmp-retries | 1 | | -| SNMPEXTRAOPTIONS | Any extra option you may want to add to every command (a --verbose flag for example). Toutes les options sont listées [ici](#options-disponibles). | | | +| Macro | Description | Valeur par défaut | Obligatoire | +|:------------------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------|:------------------|:-----------:| +| ARUBACONTROLLERHOSTNAME | Name or address of the host to monitor (mandatory) | | | +| SNMP_V3_USERNAME | SNMP v3 only: User name (`securityName`) | | | +| SNMP_V3_AUTH_PROTOCOL | SNMP v3 only: Authentication protocol: MD5\|SHA. Since net-snmp 5.9.1: SHA224\|SHA256\|SHA384\|SHA512 | | | +| SNMP_V3_PRIV_PROTOCOL | 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 | | | +| SNMPPORT | UDP port to send the SNMP request to | 161 | | +| APNAME | Threshold | | | +| SNMPTIMEOUT | Time to wait before sending the request again if no reply has been received, in seconds. See also --snmp-retries | 1 | | +| SNMP_V3_AUTH_PASSPHRASE | SNMP v3 only: Pass phrase hashed using the authentication protocol defined in the --authprotocol option | | | +| SNMP_V3_PRIV_PASSPHRASE | SNMP v3 only: Privacy pass phrase (`privPassword`) to encrypt messages using the protocol defined in the --privprotocol option | | | +| SNMPEXTRAOPTIONS | Any extra option you may want to add to every command (a --verbose flag for example). Toutes les options sont listées [ici](#options-disponibles). | | | 4. [Déployez la configuration](/docs/monitoring/monitoring-servers/deploying-a-configuration). L'hôte apparaît dans la liste des hôtes supervisés, et dans la page **Statut des ressources**. La commande envoyée par le connecteur est indiquée dans le panneau de détails de l'hôte : celle-ci montre les valeurs des macros. @@ -359,12 +361,14 @@ yum install centreon-plugin-Network-Switchs-Aruba-Standard-Snmp 2. Complétez les champs **Nom**, **Alias** & **IP Address/DNS** correspondant à votre ressource. 3. Appliquez le modèle d'hôte **Net-Aruba-Standard-Controller-SNMP-custom**. -> Si vous utilisez SNMP en version 3, vous devez configurer les paramètres spécifiques associés via la macro **SNMPEXTRAOPTIONS**. -> Plus d'informations dans la section [Troubleshooting SNMP](../getting-started/how-to-guides/troubleshooting-plugins.md#mapping-des-options-snmpv3). - -| Macro | Description | Valeur par défaut | Obligatoire | -|:-----------------|:---------------------------------------------------------------------------------------------------------------------------------------------------|:------------------|:-----------:| -| SNMPEXTRAOPTIONS | Any extra option you may want to add to every command (a --verbose flag for example). Toutes les options sont listées [ici](#options-disponibles). | | | +| Macro | Description | Valeur par défaut | Obligatoire | +|:------------------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------|:------------------|:-----------:| +| SNMP_V3_USERNAME | SNMP v3 only: User name (`securityName`) | | | +| SNMP_V3_AUTH_PROTOCOL | SNMP v3 only: Authentication protocol: MD5\|SHA. Since net-snmp 5.9.1: SHA224\|SHA256\|SHA384\|SHA512 | | | +| SNMP_V3_PRIV_PROTOCOL | 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 | | | +| SNMP_V3_AUTH_PASSPHRASE | SNMP v3 only: Pass phrase hashed using the authentication protocol defined in the --authprotocol option | | | +| SNMP_V3_PRIV_PASSPHRASE | SNMP v3 only: Privacy pass phrase (`privPassword`) to encrypt messages using the protocol defined in the --privprotocol option | | | +| SNMPEXTRAOPTIONS | Any extra option you may want to add to every command (a --verbose flag for example). Toutes les options sont listées [ici](#options-disponibles). | | | 4. [Déployez la configuration](/docs/monitoring/monitoring-servers/deploying-a-configuration). L'hôte apparaît dans la liste des hôtes supervisés, et dans la page **Statut des ressources**. La commande envoyée par le connecteur est indiquée dans le panneau de détails de l'hôte : celle-ci montre les valeurs des macros. @@ -484,14 +488,14 @@ yum install centreon-plugin-Network-Switchs-Aruba-Standard-Snmp | Macro | Description | Valeur par défaut | Obligatoire | |:-------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------|:------------------|:-----------:| | INTERFACEID | Check only the interfaces with the specified IDs (OID indexes, e.g.: 1,2,...). If empty, all interfaces will be monitored. To filter on interface names, see --name | | | -| WARNINGINDISCARD | Threshold | | | -| CRITICALINDISCARD | Threshold | | | -| WARNINGINERROR | Threshold | | | -| CRITICALINERROR | Threshold | | | -| WARNINGOUTDISCARD | Threshold | | | -| CRITICALOUTDISCARD | Threshold | | | -| WARNINGOUTERROR | Threshold | | | -| CRITICALOUTERROR | Threshold | | | +| WARNINGINDISCARD | Thresholds | | | +| CRITICALINDISCARD | Thresholds | | | +| WARNINGINERROR | Thresholds | | | +| CRITICALINERROR | Thresholds | | | +| WARNINGOUTDISCARD | Thresholds | | | +| CRITICALOUTDISCARD | Thresholds | | | +| WARNINGOUTERROR | Thresholds | | | +| CRITICALOUTERROR | Thresholds | | | | EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). Toutes les options sont listées [ici](#options-disponibles). | | | @@ -500,14 +504,14 @@ yum install centreon-plugin-Network-Switchs-Aruba-Standard-Snmp | Macro | Description | Valeur par défaut | Obligatoire | |:-------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------|:------------------|:-----------:| | INTERFACENAME | Check only the interfaces with the specified IDs (OID indexes, e.g.: 1,2,...). If empty, all interfaces will be monitored. To filter on interface names, see --name | | | -| WARNINGINDISCARD | Threshold | | | -| CRITICALINDISCARD | Threshold | | | -| WARNINGINERROR | Threshold | | | -| CRITICALINERROR | Threshold | | | -| WARNINGOUTDISCARD | Threshold | | | -| CRITICALOUTDISCARD | Threshold | | | -| WARNINGOUTERROR | Threshold | | | -| CRITICALOUTERROR | Threshold | | | +| WARNINGINDISCARD | Thresholds | | | +| CRITICALINDISCARD | Thresholds | | | +| WARNINGINERROR | Thresholds | | | +| CRITICALINERROR | Thresholds | | | +| WARNINGOUTDISCARD | Thresholds | | | +| CRITICALOUTDISCARD | Thresholds | | | +| WARNINGOUTERROR | Thresholds | | | +| CRITICALOUTERROR | Thresholds | | | | EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). Toutes les options sont listées [ici](#options-disponibles). | | | @@ -516,14 +520,14 @@ yum install centreon-plugin-Network-Switchs-Aruba-Standard-Snmp | Macro | Description | Valeur par défaut | Obligatoire | |:-------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------|:-------------------------------------------------|:-----------:| | FILTER | Check only the interfaces with the specified IDs (OID indexes, e.g.: 1,2,...). If empty, all interfaces will be monitored. To filter on interface names, see --name | | | -| WARNINGINDISCARD | Threshold | | | -| CRITICALINDISCARD | Threshold | | | -| WARNINGINERROR | Threshold | | | -| CRITICALINERROR | Threshold | | | -| WARNINGOUTDISCARD | Threshold | | | -| CRITICALOUTDISCARD | Threshold | | | -| WARNINGOUTERROR | Threshold | | | -| CRITICALOUTERROR | Threshold | | | +| WARNINGINDISCARD | Thresholds | | | +| CRITICALINDISCARD | Thresholds | | | +| WARNINGINERROR | Thresholds | | | +| CRITICALINERROR | Thresholds | | | +| WARNINGOUTDISCARD | Thresholds | | | +| CRITICALOUTDISCARD | Thresholds | | | +| WARNINGOUTERROR | Thresholds | | | +| CRITICALOUTERROR | Thresholds | | | | CRITICALSTATUS | Define the conditions to match for the status to be CRITICAL. You can use the following variables: %\{admstatus\}, %\{opstatus\}, %\{duplexstatus\}, %\{display\} | %\{admstatus\} eq "up" and %\{opstatus\} ne "up" | | | EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). Toutes les options sont listées [ici](#options-disponibles). | --verbose | | @@ -542,10 +546,10 @@ yum install centreon-plugin-Network-Switchs-Aruba-Standard-Snmp | Macro | Description | Valeur par défaut | Obligatoire | |:-------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------|:------------------|:-----------:| | FILTER | Check only the interfaces with the specified IDs (OID indexes, e.g.: 1,2,...). If empty, all interfaces will be monitored. To filter on interface names, see --name | | | -| WARNINGIN | Threshold | 80 | | -| CRITICALIN | Threshold | 90 | | -| WARNINGOUT | Threshold | 80 | | -| CRITICALOUT | Threshold | 90 | | +| WARNINGIN | Thresholds | 80 | | +| CRITICALIN | Thresholds | 90 | | +| WARNINGOUT | Thresholds | 80 | | +| CRITICALOUT | Thresholds | 90 | | | EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). Toutes les options sont listées [ici](#options-disponibles). | | | @@ -554,10 +558,10 @@ yum install centreon-plugin-Network-Switchs-Aruba-Standard-Snmp | Macro | Description | Valeur par défaut | Obligatoire | |:--------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------|:------------------|:-----------:| | INTERFACENAME | Check only the interfaces with the specified IDs (OID indexes, e.g.: 1,2,...). If empty, all interfaces will be monitored. To filter on interface names, see --name | | | -| WARNINGIN | Threshold | 80 | | -| CRITICALIN | Threshold | 90 | | -| WARNINGOUT | Threshold | 80 | | -| CRITICALOUT | Threshold | 90 | | +| WARNINGIN | Thresholds | 80 | | +| CRITICALIN | Thresholds | 90 | | +| WARNINGOUT | Thresholds | 80 | | +| CRITICALOUT | Thresholds | 90 | | | EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). Toutes les options sont listées [ici](#options-disponibles). | | | @@ -566,10 +570,10 @@ yum install centreon-plugin-Network-Switchs-Aruba-Standard-Snmp | Macro | Description | Valeur par défaut | Obligatoire | |:-------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------|:------------------|:-----------:| | FILTER | Check only the interfaces with the specified IDs (OID indexes, e.g.: 1,2,...). If empty, all interfaces will be monitored. To filter on interface names, see --name | .* | | -| WARNINGIN | Threshold | 80 | | -| CRITICALIN | Threshold | 90 | | -| WARNINGOUT | Threshold | 80 | | -| CRITICALOUT | Threshold | 90 | | +| WARNINGIN | Thresholds | 80 | | +| CRITICALIN | Thresholds | 90 | | +| WARNINGOUT | Thresholds | 80 | | +| CRITICALOUT | Thresholds | 90 | | | EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). Toutes les options sont listées [ici](#options-disponibles). | --verbose | | @@ -591,7 +595,12 @@ telle que celle-ci (remplacez les valeurs d'exemple par les vôtres) : --mode=interfaces \ --hostname=10.0.0.1 \ --snmp-version='2c' \ - --snmp-community='my-snmp-community' \ + --snmp-community='my-snmp-community' \ + --snmp-username='username' \ + --authpassphrase='' \ + --authprotocol='' \ + --privpassphrase='' \ + --privprotocol='' \ --interface='.*' \ --name \ --add-status \ @@ -671,24 +680,25 @@ Les options génériques sont listées ci-dessous : | --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-force-getnext | Use SNMP get-next 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). | +| --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. | +| --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 ok, warning, critical and unknown (default). | -| --snmp-tls-transport | Transport protocol for TLS communication (can be: 'dtlsudp', 'tlstcp'). | +| --snmp-errors-exit | Expected status in case of SNMP error or timeout. Possible values are ok, 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-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. | +| --show-password | By default, sensitive information in command lines is hidden in debug output and replaced with `***` (however, debug logs may still display sensitive information). Using the C option will display the passwords in plain text. | | --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%;;;; | @@ -696,9 +706,9 @@ Les options génériques sont listées ci-dessous : | --change-perfdata | Change or extend perfdata. Syntax: --extend-perfdata=searchlabel,newlabel,target\[,\[\\],\[min\],\[max\]\] Common examples: onvert 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\[,\[\\],\[min\],\[max\]\] Common examples: onvert 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,\,calculation\[,\[\\],\[min\],\[max\]\] regex: regular expression \: 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 \ (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: um 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~replacement~modifier Most commonly used modifiers are i (case insensitive) and g (replace all occurrences). Example: adding --change-short-output='OK\~Up\~gi' will replace all occurrences of 'OK', 'ok', 'Ok' or 'oK' with 'Up' | -| --change-short-output | Modify the short/long output that is returned by the plugin. Syntax: --change-short-output=pattern~replacement~modifier Most commonly used modifiers are i (case insensitive) and g (replace all occurrences). Example: adding --change-short-output='OK\~Up\~gi' will replace all occurrences of 'OK', 'ok', 'Ok' or 'oK' with 'Up' | -| --change-long-output | Modify the short/long output that is returned by the plugin. Syntax: --change-short-output=pattern~replacement~modifier Most commonly used modifiers are i (case insensitive) and g (replace all occurrences). Example: adding --change-short-output='OK\~Up\~gi' will replace all occurrences of 'OK', 'ok', 'Ok' or 'oK' with 'Up' | +| --change-short-output --change-long-output | Modify the short/long output that is returned by the plugin. Syntax: --change-short-output=pattern~replacement~modifier Most commonly used modifiers are i (case insensitive) and g (replace all occurrences). Example: adding --change-short-output='OK~Up~gi' will replace all occurrences of 'OK', 'ok', 'Ok' or 'oK' with 'Up' | +| --change-short-output | Modify the short/long output that is returned by the plugin. Syntax: --change-short-output=pattern~replacement~modifier Most commonly used modifiers are i (case insensitive) and g (replace all occurrences). Example: adding --change-short-output='OK~Up~gi' will replace all occurrences of 'OK', 'ok', 'Ok' or 'oK' with 'Up' | +| --change-long-output | Modify the short/long output that is returned by the plugin. Syntax: --change-short-output=pattern~replacement~modifier Most commonly used modifiers are i (case insensitive) and g (replace all occurrences). Example: adding --change-short-output='OK~Up~gi' will replace all occurrences of 'OK', 'ok', 'Ok' or 'oK' with 'Up' | | --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. | @@ -725,6 +735,8 @@ Les options disponibles pour chaque modèle de services sont listées ci-dessous | Option | Description | |:------------------|:--------------------------------------------------------------------------------------------------------------------------| | --filter-counters | Only display some counters (regexp can be used). Example to check SSL connections only : --filter-counters='^xxxx\|yyyy$' | +| --warning-xxx | Warning threshold. | +| --critical-xxx | Critical threshold. | | --warning-* | Warning threshold. Can be: 'stations-associated' (ESSID and BSSID), 'channel-noise', 'signal-noise-ratio' (BSSID). | | --critical-* | Critical threshold. Can be: 'stations-associated' (ESSID and BSSID), 'channel-noise', 'signal-noise-ratio' (BSSID). | | --filter-* | Filter by 'ap', 'essid', 'protocol', 'bssid' (regexp can be used). | @@ -735,6 +747,8 @@ Les options disponibles pour chaque modèle de services sont listées ci-dessous | Option | Description | |:-------------------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | --filter-counters | Only display some counters (regexp can be used). Example to check SSL connections only : --filter-counters='^xxxx\|yyyy$' | +| --warning-xxx | Warning threshold. | +| --critical-xxx | Critical threshold. | | --warning-* --critical-* | Thresholds. Can be: 'connected-current' (global), 'uptime', 'controller-bootstrap', 'reboot', 'status' (per AP). 'status' can use special variables like: %\{name\}, %\{status\}, %\{ip\}, %\{group\}, %\{location\} (default: '') | | --filter-* | Filter by 'ip', 'name', 'group' (regexp can be used). | @@ -744,6 +758,8 @@ Les options disponibles pour chaque modèle de services sont listées ci-dessous | Option | Description | |:------------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | --filter-counters | Only display some counters (regexp can be used). Example to check SSL connections only : --filter-counters='^xxxx\|yyyy$' | +| --warning-xxx | Warning threshold. | +| --critical-xxx | Critical threshold. | | --warning-* | Warning threshold. Can be: 'connected-current' (global), 'status' (per controller). 'status' can use special variables like: %\{name\}, %\{status\}, %\{ip\}, %\{role\}, %\{location\} (default: '') | | --critical-* | Critical threshold. Can be: 'connected-current' (global), 'status' (per controller). 'status' can use special variables like: %\{name\}, %\{status\}, %\{ip\}, %\{role\}, %\{location\} (default: '%\{status\} !~ /active/i') | | --filter-* | Filter by 'ip', 'name', 'location' (regexp can be used). | @@ -754,6 +770,8 @@ Les options disponibles pour chaque modèle de services sont listées ci-dessous | Option | Description | |:-----------------------|:--------------------------------------------------------------------------------------------------------------------------| | --filter-counters | Only display some counters (regexp can be used). Example to check SSL connections only : --filter-counters='^xxxx\|yyyy$' | +| --warning-xxx | Warning threshold. | +| --critical-xxx | Critical threshold. | | --warning-utilization | Warning threshold in percent. | | --critical-utilization | Critical threshold in percent. | @@ -803,6 +821,8 @@ Les options disponibles pour chaque modèle de services sont listées ci-dessous | Option | Description | |:------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | --filter-counters | Only display some counters (regexp can be used). Example to check SSL connections only : --filter-counters='^xxxx\|yyyy$' | +| --warning-xxx | Warning threshold. | +| --critical-xxx | Critical threshold. | | --warning-status | Warning threshold. Can use special variables like:%\{key\}, %\{service\}, %\{flag\}, %\{expires\} (default: '') | | --critical-status | Critical threshold. Can use special variables like: %\{key\}, %\{service\}, %\{flag\}, %\{expires\} (default: '%\{flag\} !~ /enabled/i \|\| (%\{expires\} ne "Never" && %\{expires\} \< 86400)') | @@ -812,58 +832,98 @@ Les options disponibles pour chaque modèle de services sont listées ci-dessous | Option | Description | |:------------------|:--------------------------------------------------------------------------------------------------------------------------| | --filter-counters | Only display some counters (regexp can be used). Example to check SSL connections only : --filter-counters='^xxxx\|yyyy$' | +| --warning-xxx | Warning threshold. | +| --critical-xxx | Critical threshold. | | --warning-usage | Warning threshold in percent. | | --critical-usage | Critical threshold in percent. | -| Option | Description | -|:------------------------------------------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| --filter-counters | Only display some counters (regexp can be used). Example to check SSL connections only : --filter-counters='^xxxx\|yyyy$' | -| --memcached | Memcached server to use (only one server). | -| --redis-server | Redis server to use (only one server). Syntax: address\[:port\] | -| --redis-attribute | Set Redis Options (--redis-attribute="cnx\_timeout=5"). | -| --redis-db | Set Redis database index. | -| --failback-file | Fall back on a local file if Redis connection fails. | -| --memexpiration | Time to keep data in seconds (default: 86400). | -| --statefile-dir | Define the cache directory (default: '/var/lib/centreon/centplugins'). | -| --statefile-suffix | Define a suffix to customize the statefile name (default: ''). | -| --statefile-concat-cwd | If used with the '--statefile-dir' option, the latter's value will be used as a sub-directory of the current working directory. Useful on Windows when the plugin is compiled, as the file system and permissions are different from Linux. | -| --statefile-format | Define the format used to store the cache. Available formats: 'dumper', 'storable', 'json' (default). | -| --statefile-key | Define the key to encrypt/decrypt the cache. | -| --statefile-cipher | Define the cipher algorithm to encrypt the cache (default: 'AES'). | -| --add-global | Check global port statistics (by default if no --add-* option is set). | -| --add-status | Check interface status. | -| --add-duplex-status | Check duplex status (with --warning-status and --critical-status). | -| --add-traffic | Check interface traffic. | -| --add-errors | Check interface errors. | -| --add-cast | Check interface cast. | -| --add-speed | Check interface speed. | -| --add-volume | Check interface data volume between two checks (not supposed to be graphed, useful for BI reporting). | -| --check-metrics | If the expression is true, metrics are checked (default: '%\{opstatus\} eq "up"'). | -| --warning-status | Define the conditions to match for the status to be WARNING. You can use the following variables: %\{admstatus\}, %\{opstatus\}, %\{duplexstatus\}, %\{display\} | -| --critical-status | Define the conditions to match for the status to be CRITICAL (default: '%\{admstatus\} eq "up" and %\{opstatus\} ne "up"'). You can use the following variables: %\{admstatus\}, %\{opstatus\}, %\{duplexstatus\}, %\{display\} | -| --warning-* --critical-* | Thresholds. Can be: 'total-port', 'total-admin-up', 'total-admin-down', 'total-oper-up', 'total-oper-down', 'in-traffic', 'out-traffic', 'in-error', 'in-discard', 'out-error', 'out-discard', 'in-ucast', 'in-bcast', 'in-mcast', 'out-ucast', 'out-bcast', 'out-mcast', 'speed' (b/s). | -| --units-traffic | Units of thresholds for the traffic (default: 'percent\_delta') ('percent\_delta', 'bps', 'counter'). | -| --units-errors | Units of thresholds for errors/discards (default: 'percent\_delta') ('percent\_delta', 'percent', 'delta', 'deltaps', 'counter'). | -| --units-cast | Units of thresholds for communication types (default: 'percent\_delta') ('percent\_delta', 'percent', 'delta', 'deltaps', 'counter'). | -| --nagvis-perfdata | Display traffic perfdata to be compatible with NagVis widget. | -| --interface | Check only the interfaces with the specified IDs (OID indexes, e.g.: 1,2,...). If empty, all interfaces will be monitored. To filter on interface names, see --name. | -| --name | With this option, the interfaces will be filtered by name (given in option --interface) instead of OID index. The name matching mode supports regular expressions. | -| --regex-id | With this option, interface IDs will be filtered using the --interface parameter as a regular expression instead of a list of IDs. | -| --speed | Set interface speed for incoming/outgoing traffic (in Mb). | -| --speed-in | Set interface speed for incoming traffic (in Mb). | -| --speed-out | Set interface speed for outgoing traffic (in Mb). | -| --map-speed-dsl | Get interface speed configuration for interfaces of type 'ADSL' and 'VDSL2'. Syntax: --map-speed-dsl=interface-src-name,interface-dsl-name E.g: --map-speed-dsl=Et0.835,Et0-vdsl2 | -| --force-counters64 | Force to use 64 bits counters only. Can be used to improve performance. | -| --force-counters32 | Force to use 32-bit counters (even with SNMP versions 2c and 3). To use when 64 bits counters are buggy. | -| --reload-cache-time | Time in minutes before reloading cache file (default: 180). | -| --oid-filter | Define the OID to be used to filter interfaces (default: ifName) (values: ifDesc, ifAlias, ifName, IpAddr). | -| --oid-display | Define the OID that will be used to name the interfaces (default: ifName) (values: ifDesc, ifAlias, ifName, IpAddr). | -| --oid-extra-display | Add an OID to display. | -| --display-transform-src --display-transform-dst | Modify the interface name displayed by using a regular expression. Example: adding --display-transform-src='eth' --display-transform-dst='ens' will replace all occurrences of 'eth' with 'ens' | -| --show-cache | Display cache interface data. | +| Option | Description | +|:------------------------------------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| --filter-counters | Only display some counters (regexp can be used). Example to check SSL connections only : --filter-counters='^xxxx\|yyyy$' | +| --warning-xxx | Warning threshold. | +| --critical-xxx | Critical threshold. | +| --memcached | Memcached server to use (only one server). | +| --redis-server | Redis server to use (only one server). Syntax: address\[:port\] | +| --redis-attribute | Set Redis Options (--redis-attribute="cnx\_timeout=5"). | +| --redis-db | Set Redis database index. | +| --failback-file | Fall back on a local file if Redis connection fails. | +| --memexpiration | Time to keep data in seconds (default: 86400). | +| --statefile-dir | Define the cache directory (default: '/var/lib/centreon/centplugins'). | +| --statefile-suffix | Define a suffix to customize the statefile name (default: ''). | +| --statefile-concat-cwd | If used with the '--statefile-dir' option, the latter's value will be used as a sub-directory of the current working directory. Useful on Windows when the plugin is compiled, as the file system and permissions are different from Linux. | +| --statefile-format | Define the format used to store the cache. Available formats: 'dumper', 'storable', 'json' (default). | +| --statefile-key | Define the key to encrypt/decrypt the cache. | +| --statefile-cipher | Define the cipher algorithm to encrypt the cache (default: 'AES'). | +| --add-global | Check global port statistics (by default if no --add-* option is set). | +| --add-status | Check interface status. | +| --add-duplex-status | Check duplex status (with --warning-status and --critical-status). | +| --add-traffic | Check interface traffic. | +| --add-errors | Check interface errors. | +| --add-cast | Check interface cast. | +| --add-speed | Check interface speed. | +| --add-volume | Check interface data volume between two checks (not supposed to be graphed, useful for BI reporting). | +| --check-metrics | If the expression is true, metrics are checked (default: '%\{opstatus\} eq "up"'). | +| --warning-status | Define the conditions to match for the status to be WARNING. You can use the following variables: %\{admstatus\}, %\{opstatus\}, %\{duplexstatus\}, %\{display\} | +| --critical-status | Define the conditions to match for the status to be CRITICAL (default: '%\{admstatus\} eq "up" and %\{opstatus\} ne "up"'). You can use the following variables: %\{admstatus\}, %\{opstatus\}, %\{duplexstatus\}, %\{display\} | +| --warning-total-port | Thresholds. | +| --critical-total-port | Thresholds. | +| --warning-total-admin-up | Thresholds. | +| --critical-total-admin-up | Thresholds. | +| --warning-total-admin-down | Thresholds. | +| --critical-total-admin-down | Thresholds. | +| --warning-total-oper-up | Thresholds. | +| --critical-total-oper-up | Thresholds. | +| --warning-total-oper-down | Thresholds. | +| --critical-total-oper-down | Thresholds. | +| --warning-in-traffic | Thresholds. | +| --critical-in-traffic | Thresholds. | +| --warning-out-traffic | Thresholds. | +| --critical-out-traffic | Thresholds. | +| --warning-in-error | Thresholds. | +| --critical-in-error | Thresholds. | +| --warning-in-discard | Thresholds. | +| --critical-in-discard | Thresholds. | +| --warning-out-error | Thresholds. | +| --critical-out-error | Thresholds. | +| --warning-out-discard | Thresholds. | +| --critical-out-discard | Thresholds. | +| --warning-in-ucast | Thresholds. | +| --critical-in-ucast | Thresholds. | +| --warning-in-bcast | Thresholds. | +| --critical-in-bcast | Thresholds. | +| --warning-in-mcast | Thresholds. | +| --critical-in-mcast | Thresholds. | +| --warning-out-ucast | Thresholds. | +| --critical-out-ucast | Thresholds. | +| --warning-out-bcast | Thresholds. | +| --critical-out-bcast | Thresholds. | +| --warning-out-mcast | Thresholds. | +| --critical-out-mcast | Thresholds. | +| --warning-speed | Thresholds in b/s. | +| --critical-speed | Thresholds in b/s. | +| --units-traffic | Units of thresholds for the traffic (default: 'percent\_delta') ('percent\_delta', 'bps', 'counter'). | +| --units-errors | Units of thresholds for errors/discards (default: 'percent\_delta') ('percent\_delta', 'delta', 'deltaps', 'counter'). | +| --units-cast | Units of thresholds for communication types (default: 'percent\_delta') ('percent\_delta', 'percent', 'delta', 'deltaps', 'counter'). | +| --nagvis-perfdata | Display traffic perfdata to be compatible with NagVis widget. | +| --interface | Check only the interfaces with the specified IDs (OID indexes, e.g.: 1,2,...). If empty, all interfaces will be monitored. To filter on interface names, see --name. | +| --name | With this option, the interfaces will be filtered by name (given in option --interface) instead of OID index. The name matching mode supports regular expressions. | +| --regex-id | With this option, interface IDs will be filtered using the --interface parameter as a regular expression instead of a list of IDs. | +| --speed | Set interface speed for incoming/outgoing traffic (in Mb). | +| --speed-in | Set interface speed for incoming traffic (in Mb). | +| --speed-out | Set interface speed for outgoing traffic (in Mb). | +| --map-speed-dsl | Get interface speed configuration for interfaces of type 'ADSL' and 'VDSL2'. Syntax: --map-speed-dsl=interface-src-name,interface-dsl-name E.g: --map-speed-dsl=Et0.835,Et0-vdsl2 | +| --force-counters64 | Force to use 64 bits counters only. Can be used to improve performance. | +| --force-counters32 | Force to use 32-bit counters (even with SNMP versions 2c and 3). To use when 64 bits counters are buggy. | +| --reload-cache-time | Time in minutes before reloading cache file (default: 180). | +| --oid-filter | Define the OID to be used to filter interfaces (default: ifName) (values: ifDesc, ifAlias, ifName, IpAddr). | +| --oid-display | Define the OID that will be used to name the interfaces (default: ifName) (values: ifDesc, ifAlias, ifName, IpAddr). | +| --oid-extra-display | Add an OID to display. | +| --display-transform-src --display-transform-dst | Modify the interface name displayed by using a regular expression. Example: adding --display-transform-src='eth' --display-transform-dst='ens' will replace all occurrences of 'eth' with 'ens' | +| --show-cache | Display cache interface data. | +| --no-cache-lock | Set to disable locking when accessing cache. | @@ -871,6 +931,8 @@ Les options disponibles pour chaque modèle de services sont listées ci-dessous | Option | Description | |:------------------|:--------------------------------------------------------------------------------------------------------------------------| | --filter-counters | Only display some counters (regexp can be used). Example to check SSL connections only : --filter-counters='^xxxx\|yyyy$' | +| --warning-xxx | Warning threshold. | +| --critical-xxx | Critical threshold. | | --warning-usage | Warning threshold in percent. | | --critical-usage | Critical threshold in percent. | | --filter-name | Filter storage device name (regexp can be used). | @@ -879,52 +941,90 @@ Les options disponibles pour chaque modèle de services sont listées ci-dessous -| Option | Description | -|:------------------------------------------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| --filter-counters | Only display some counters (regexp can be used). Example to check SSL connections only : --filter-counters='^xxxx\|yyyy$' | -| --memcached | Memcached server to use (only one server). | -| --redis-server | Redis server to use (only one server). Syntax: address\[:port\] | -| --redis-attribute | Set Redis Options (--redis-attribute="cnx\_timeout=5"). | -| --redis-db | Set Redis database index. | -| --failback-file | Fall back on a local file if Redis connection fails. | -| --memexpiration | Time to keep data in seconds (default: 86400). | -| --statefile-dir | Define the cache directory (default: '/var/lib/centreon/centplugins'). | -| --statefile-suffix | Define a suffix to customize the statefile name (default: ''). | -| --statefile-concat-cwd | If used with the '--statefile-dir' option, the latter's value will be used as a sub-directory of the current working directory. Useful on Windows when the plugin is compiled, as the file system and permissions are different from Linux. | -| --statefile-format | Define the format used to store the cache. Available formats: 'dumper', 'storable', 'json' (default). | -| --statefile-key | Define the key to encrypt/decrypt the cache. | -| --statefile-cipher | Define the cipher algorithm to encrypt the cache (default: 'AES'). | -| --add-global | Check global port statistics (by default if no --add-* option is set). | -| --add-status | Check interface status. | -| --add-duplex-status | Check duplex status (with --warning-status and --critical-status). | -| --add-traffic | Check interface traffic. | -| --add-errors | Check interface errors. | -| --add-cast | Check interface cast. | -| --add-speed | Check interface speed. | -| --add-volume | Check interface data volume between two checks (not supposed to be graphed, useful for BI reporting). | -| --check-metrics | If the expression is true, metrics are checked (default: '%\{opstatus\} eq "up"'). | -| --warning-status | Define the conditions to match for the status to be WARNING. You can use the following variables: %\{admstatus\}, %\{opstatus\}, %\{duplexstatus\}, %\{display\} | -| --critical-status | Define the conditions to match for the status to be CRITICAL (default: '%\{admstatus\} eq "up" and %\{opstatus\} ne "up"'). You can use the following variables: %\{admstatus\}, %\{opstatus\}, %\{duplexstatus\}, %\{display\} | -| --warning-* --critical-* | Thresholds. Can be: 'total-port', 'total-admin-up', 'total-admin-down', 'total-oper-up', 'total-oper-down', 'in-traffic', 'out-traffic', 'in-error', 'in-discard', 'out-error', 'out-discard', 'in-ucast', 'in-bcast', 'in-mcast', 'out-ucast', 'out-bcast', 'out-mcast', 'speed' (b/s). | -| --units-traffic | Units of thresholds for the traffic (default: 'percent\_delta') ('percent\_delta', 'bps', 'counter'). | -| --units-errors | Units of thresholds for errors/discards (default: 'percent\_delta') ('percent\_delta', 'percent', 'delta', 'deltaps', 'counter'). | -| --units-cast | Units of thresholds for communication types (default: 'percent\_delta') ('percent\_delta', 'percent', 'delta', 'deltaps', 'counter'). | -| --nagvis-perfdata | Display traffic perfdata to be compatible with NagVis widget. | -| --interface | Check only the interfaces with the specified IDs (OID indexes, e.g.: 1,2,...). If empty, all interfaces will be monitored. To filter on interface names, see --name. | -| --name | With this option, the interfaces will be filtered by name (given in option --interface) instead of OID index. The name matching mode supports regular expressions. | -| --regex-id | With this option, interface IDs will be filtered using the --interface parameter as a regular expression instead of a list of IDs. | -| --speed | Set interface speed for incoming/outgoing traffic (in Mb). | -| --speed-in | Set interface speed for incoming traffic (in Mb). | -| --speed-out | Set interface speed for outgoing traffic (in Mb). | -| --map-speed-dsl | Get interface speed configuration for interfaces of type 'ADSL' and 'VDSL2'. Syntax: --map-speed-dsl=interface-src-name,interface-dsl-name E.g: --map-speed-dsl=Et0.835,Et0-vdsl2 | -| --force-counters64 | Force to use 64 bits counters only. Can be used to improve performance. | -| --force-counters32 | Force to use 32-bit counters (even with SNMP versions 2c and 3). To use when 64 bits counters are buggy. | -| --reload-cache-time | Time in minutes before reloading cache file (default: 180). | -| --oid-filter | Define the OID to be used to filter interfaces (default: ifName) (values: ifDesc, ifAlias, ifName, IpAddr). | -| --oid-display | Define the OID that will be used to name the interfaces (default: ifName) (values: ifDesc, ifAlias, ifName, IpAddr). | -| --oid-extra-display | Add an OID to display. | -| --display-transform-src --display-transform-dst | Modify the interface name displayed by using a regular expression. Example: adding --display-transform-src='eth' --display-transform-dst='ens' will replace all occurrences of 'eth' with 'ens' | -| --show-cache | Display cache interface data. | +| Option | Description | +|:------------------------------------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| --filter-counters | Only display some counters (regexp can be used). Example to check SSL connections only : --filter-counters='^xxxx\|yyyy$' | +| --warning-xxx | Warning threshold. | +| --critical-xxx | Critical threshold. | +| --memcached | Memcached server to use (only one server). | +| --redis-server | Redis server to use (only one server). Syntax: address\[:port\] | +| --redis-attribute | Set Redis Options (--redis-attribute="cnx\_timeout=5"). | +| --redis-db | Set Redis database index. | +| --failback-file | Fall back on a local file if Redis connection fails. | +| --memexpiration | Time to keep data in seconds (default: 86400). | +| --statefile-dir | Define the cache directory (default: '/var/lib/centreon/centplugins'). | +| --statefile-suffix | Define a suffix to customize the statefile name (default: ''). | +| --statefile-concat-cwd | If used with the '--statefile-dir' option, the latter's value will be used as a sub-directory of the current working directory. Useful on Windows when the plugin is compiled, as the file system and permissions are different from Linux. | +| --statefile-format | Define the format used to store the cache. Available formats: 'dumper', 'storable', 'json' (default). | +| --statefile-key | Define the key to encrypt/decrypt the cache. | +| --statefile-cipher | Define the cipher algorithm to encrypt the cache (default: 'AES'). | +| --add-global | Check global port statistics (by default if no --add-* option is set). | +| --add-status | Check interface status. | +| --add-duplex-status | Check duplex status (with --warning-status and --critical-status). | +| --add-traffic | Check interface traffic. | +| --add-errors | Check interface errors. | +| --add-cast | Check interface cast. | +| --add-speed | Check interface speed. | +| --add-volume | Check interface data volume between two checks (not supposed to be graphed, useful for BI reporting). | +| --check-metrics | If the expression is true, metrics are checked (default: '%\{opstatus\} eq "up"'). | +| --warning-status | Define the conditions to match for the status to be WARNING. You can use the following variables: %\{admstatus\}, %\{opstatus\}, %\{duplexstatus\}, %\{display\} | +| --critical-status | Define the conditions to match for the status to be CRITICAL (default: '%\{admstatus\} eq "up" and %\{opstatus\} ne "up"'). You can use the following variables: %\{admstatus\}, %\{opstatus\}, %\{duplexstatus\}, %\{display\} | +| --warning-total-port | Thresholds. | +| --critical-total-port | Thresholds. | +| --warning-total-admin-up | Thresholds. | +| --critical-total-admin-up | Thresholds. | +| --warning-total-admin-down | Thresholds. | +| --critical-total-admin-down | Thresholds. | +| --warning-total-oper-up | Thresholds. | +| --critical-total-oper-up | Thresholds. | +| --warning-total-oper-down | Thresholds. | +| --critical-total-oper-down | Thresholds. | +| --warning-in-traffic | Thresholds. | +| --critical-in-traffic | Thresholds. | +| --warning-out-traffic | Thresholds. | +| --critical-out-traffic | Thresholds. | +| --warning-in-error | Thresholds. | +| --critical-in-error | Thresholds. | +| --warning-in-discard | Thresholds. | +| --critical-in-discard | Thresholds. | +| --warning-out-error | Thresholds. | +| --critical-out-error | Thresholds. | +| --warning-out-discard | Thresholds. | +| --critical-out-discard | Thresholds. | +| --warning-in-ucast | Thresholds. | +| --critical-in-ucast | Thresholds. | +| --warning-in-bcast | Thresholds. | +| --critical-in-bcast | Thresholds. | +| --warning-in-mcast | Thresholds. | +| --critical-in-mcast | Thresholds. | +| --warning-out-ucast | Thresholds. | +| --critical-out-ucast | Thresholds. | +| --warning-out-bcast | Thresholds. | +| --critical-out-bcast | Thresholds. | +| --warning-out-mcast | Thresholds. | +| --critical-out-mcast | Thresholds. | +| --warning-speed | Thresholds in b/s. | +| --critical-speed | Thresholds in b/s. | +| --units-traffic | Units of thresholds for the traffic (default: 'percent\_delta') ('percent\_delta', 'bps', 'counter'). | +| --units-errors | Units of thresholds for errors/discards (default: 'percent\_delta') ('percent\_delta', 'delta', 'deltaps', 'counter'). | +| --units-cast | Units of thresholds for communication types (default: 'percent\_delta') ('percent\_delta', 'percent', 'delta', 'deltaps', 'counter'). | +| --nagvis-perfdata | Display traffic perfdata to be compatible with NagVis widget. | +| --interface | Check only the interfaces with the specified IDs (OID indexes, e.g.: 1,2,...). If empty, all interfaces will be monitored. To filter on interface names, see --name. | +| --name | With this option, the interfaces will be filtered by name (given in option --interface) instead of OID index. The name matching mode supports regular expressions. | +| --regex-id | With this option, interface IDs will be filtered using the --interface parameter as a regular expression instead of a list of IDs. | +| --speed | Set interface speed for incoming/outgoing traffic (in Mb). | +| --speed-in | Set interface speed for incoming traffic (in Mb). | +| --speed-out | Set interface speed for outgoing traffic (in Mb). | +| --map-speed-dsl | Get interface speed configuration for interfaces of type 'ADSL' and 'VDSL2'. Syntax: --map-speed-dsl=interface-src-name,interface-dsl-name E.g: --map-speed-dsl=Et0.835,Et0-vdsl2 | +| --force-counters64 | Force to use 64 bits counters only. Can be used to improve performance. | +| --force-counters32 | Force to use 32-bit counters (even with SNMP versions 2c and 3). To use when 64 bits counters are buggy. | +| --reload-cache-time | Time in minutes before reloading cache file (default: 180). | +| --oid-filter | Define the OID to be used to filter interfaces (default: ifName) (values: ifDesc, ifAlias, ifName, IpAddr). | +| --oid-display | Define the OID that will be used to name the interfaces (default: ifName) (values: ifDesc, ifAlias, ifName, IpAddr). | +| --oid-extra-display | Add an OID to display. | +| --display-transform-src --display-transform-dst | Modify the interface name displayed by using a regular expression. Example: adding --display-transform-src='eth' --display-transform-dst='ens' will replace all occurrences of 'eth' with 'ens' | +| --show-cache | Display cache interface data. | +| --no-cache-lock | Set to disable locking when accessing cache. | diff --git a/i18n/fr/docusaurus-plugin-content-docs-pp/current/integrations/plugin-packs/procedures/network-switchs-brocade-snmp.md b/i18n/fr/docusaurus-plugin-content-docs-pp/current/integrations/plugin-packs/procedures/network-switchs-brocade-snmp.md index cf41ac9c5fa8..bfdc0c89ea4d 100644 --- a/i18n/fr/docusaurus-plugin-content-docs-pp/current/integrations/plugin-packs/procedures/network-switchs-brocade-snmp.md +++ b/i18n/fr/docusaurus-plugin-content-docs-pp/current/integrations/plugin-packs/procedures/network-switchs-brocade-snmp.md @@ -102,15 +102,7 @@ Voici le tableau des services pour ce connecteur, détaillant les métriques et -| Nom | Unité | -|:----------------------------------------------------------|:------| -| *interface_name*#status | N/A | -| *interface_name*#interface.packets.in.discard.percentage | % | -| *interface_name*#interface.packets.in.error.percentage | % | -| *interface_name*#interface.packets.out.discard.percentage | % | -| *interface_name*#interface.packets.out.error.percentage | % | - -> Concerne les modèles de service suivants : Packet-Errors-Generic-Name, Packet-Errors-Global +Coming soon @@ -120,18 +112,10 @@ Voici le tableau des services pour ce connecteur, détaillant les métriques et | *interface_name*#status | N/A | | *interface_name*#interface.traffic.in.bitspersecond | b/s | | *interface_name*#interface.traffic.out.bitspersecond | b/s | - -| Nom | Unité | -|:-----------------------------------------------------|:------| -| *interface_name*#status | N/A | -| *interface_name*#interface.traffic.in.bitspersecond | b/s | -| *interface_name*#interface.traffic.out.bitspersecond | b/s | - -> Concerne les modèles de service suivants : Traffic-Generic-Name, Traffic-Global - +Coming soon @@ -246,12 +230,14 @@ yum install centreon-plugin-Network-Switchs-Brocade-Snmp 2. Complétez les champs **Nom**, **Alias** & **IP Address/DNS** correspondant à votre ressource. 3. Appliquez le modèle d'hôte **Net-Brocade-SNMP-custom**. -> Si vous utilisez SNMP en version 3, vous devez configurer les paramètres spécifiques associés via la macro **SNMPEXTRAOPTIONS**. -> Plus d'informations dans la section [Troubleshooting SNMP](../getting-started/how-to-guides/troubleshooting-plugins.md#mapping-des-options-snmpv3). - -| Macro | Description | Valeur par défaut | Obligatoire | -|:-----------------|:---------------------------------------------------------------------------------------------------------------------------------------------------|:------------------|:-----------:| -| SNMPEXTRAOPTIONS | Any extra option you may want to add to every command (a --verbose flag for example). Toutes les options sont listées [ici](#options-disponibles). | | | +| Macro | Description | Valeur par défaut | Obligatoire | +|:------------------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------|:------------------|:-----------:| +| SNMP_V3_USERNAME | SNMP v3 only: User name (`securityName`) | | | +| SNMP_V3_AUTH_PROTOCOL | SNMP v3 only: Authentication protocol: MD5\|SHA. Since net-snmp 5.9.1: SHA224\|SHA256\|SHA384\|SHA512 | | | +| SNMP_V3_PRIV_PROTOCOL | 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 | | | +| SNMP_V3_AUTH_PASSPHRASE | SNMP v3 only: Pass phrase hashed using the authentication protocol defined in the --authprotocol option | | | +| SNMP_V3_PRIV_PASSPHRASE | SNMP v3 only: Privacy pass phrase (`privPassword`) to encrypt messages using the protocol defined in the --privprotocol option | | | +| SNMPEXTRAOPTIONS | Any extra option you may want to add to every command (a --verbose flag for example). Toutes les options sont listées [ici](#options-disponibles). | | | 4. [Déployez la configuration](/docs/monitoring/monitoring-servers/deploying-a-configuration). L'hôte apparaît dans la liste des hôtes supervisés, et dans la page **Statut des ressources**. La commande envoyée par le connecteur est indiquée dans le panneau de détails de l'hôte : celle-ci montre les valeurs des macros. @@ -374,13 +360,18 @@ telle que celle-ci (remplacez les valeurs d'exemple par les vôtres) : --mode=hardware \ --hostname=10.0.0.1 \ --snmp-version='2c' \ - --snmp-community='my-snmp-community' + --snmp-community='my-snmp-community' \ + --snmp-username='username' \ + --authpassphrase='' \ + --authprotocol='' \ + --privpassphrase='' \ + --privprotocol='' ``` La commande devrait retourner un message de sortie similaire à : ```bash -OK: All 3 components are ok [ 1/1 switch, 2/2 sensor,]. | 'hardware.switch.count'=1;;;; 'hardware.sensor.count'=2;;;; +OK: All 2 components are ok [1/1 switch, 1/1 sensor]. | 'hardware.switch.count'=1;;;; 'hardware.sensor.count'=1;;;; ``` ### Diagnostic des erreurs communes @@ -437,24 +428,25 @@ Les options génériques sont listées ci-dessous : | --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-force-getnext | Use SNMP get-next 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). | +| --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. | +| --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 ok, warning, critical and unknown (default). | -| --snmp-tls-transport | Transport protocol for TLS communication (can be: 'dtlsudp', 'tlstcp'). | +| --snmp-errors-exit | Expected status in case of SNMP error or timeout. Possible values are ok, 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-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. | +| --show-password | By default, sensitive information in command lines is hidden in debug output and replaced with `***` (however, debug logs may still display sensitive information). Using the C option will display the passwords in plain text. | | --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%;;;; | @@ -462,9 +454,9 @@ Les options génériques sont listées ci-dessous : | --change-perfdata | Change or extend perfdata. Syntax: --extend-perfdata=searchlabel,newlabel,target\[,\[\\],\[min\],\[max\]\] Common examples: onvert 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\[,\[\\],\[min\],\[max\]\] Common examples: onvert 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,\,calculation\[,\[\\],\[min\],\[max\]\] regex: regular expression \: 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 \ (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: um 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~replacement~modifier Most commonly used modifiers are i (case insensitive) and g (replace all occurrences). Example: adding --change-short-output='OK\~Up\~gi' will replace all occurrences of 'OK', 'ok', 'Ok' or 'oK' with 'Up' | -| --change-short-output | Modify the short/long output that is returned by the plugin. Syntax: --change-short-output=pattern~replacement~modifier Most commonly used modifiers are i (case insensitive) and g (replace all occurrences). Example: adding --change-short-output='OK\~Up\~gi' will replace all occurrences of 'OK', 'ok', 'Ok' or 'oK' with 'Up' | -| --change-long-output | Modify the short/long output that is returned by the plugin. Syntax: --change-short-output=pattern~replacement~modifier Most commonly used modifiers are i (case insensitive) and g (replace all occurrences). Example: adding --change-short-output='OK\~Up\~gi' will replace all occurrences of 'OK', 'ok', 'Ok' or 'oK' with 'Up' | +| --change-short-output --change-long-output | Modify the short/long output that is returned by the plugin. Syntax: --change-short-output=pattern~replacement~modifier Most commonly used modifiers are i (case insensitive) and g (replace all occurrences). Example: adding --change-short-output='OK~Up~gi' will replace all occurrences of 'OK', 'ok', 'Ok' or 'oK' with 'Up' | +| --change-short-output | Modify the short/long output that is returned by the plugin. Syntax: --change-short-output=pattern~replacement~modifier Most commonly used modifiers are i (case insensitive) and g (replace all occurrences). Example: adding --change-short-output='OK~Up~gi' will replace all occurrences of 'OK', 'ok', 'Ok' or 'oK' with 'Up' | +| --change-long-output | Modify the short/long output that is returned by the plugin. Syntax: --change-short-output=pattern~replacement~modifier Most commonly used modifiers are i (case insensitive) and g (replace all occurrences). Example: adding --change-short-output='OK~Up~gi' will replace all occurrences of 'OK', 'ok', 'Ok' or 'oK' with 'Up' | | --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. | @@ -530,7 +522,6 @@ Les options disponibles pour chaque modèle de services sont listées ci-dessous | --check-metrics | If the expression is true, metrics are checked (default: '%\{opstatus\} eq "up"'). | | --warning-status | Define the conditions to match for the status to be WARNING. You can use the following variables: %\{admstatus\}, %\{opstatus\}, %\{duplexstatus\}, %\{display\} | | --critical-status | Define the conditions to match for the status to be CRITICAL (default: '%\{admstatus\} eq "up" and %\{opstatus\} ne "up"'). You can use the following variables: %\{admstatus\}, %\{opstatus\}, %\{duplexstatus\}, %\{display\} | -| --warning-* --critical-* | Thresholds. Can be: 'total-port', 'total-admin-up', 'total-admin-down', 'total-oper-up', 'total-oper-down', 'in-traffic', 'out-traffic', 'in-crc', 'in-error', 'in-discard', 'out-error', 'out-discard', 'in-ucast', 'in-bcast', 'in-mcast', 'out-ucast', 'out-bcast', 'out-mcast', 'speed' (b/s), 'laser-temp', 'input-power', 'output-power'. | | --units-traffic | Units of thresholds for the traffic (default: 'percent\_delta') ('percent\_delta', 'bps', 'counter'). | | --units-errors | Units of thresholds for errors/discards (default: 'percent\_delta') ('percent\_delta', 'percent', 'delta', 'deltaps', 'counter'). | | --units-cast | Units of thresholds for communication types (default: 'percent\_delta') ('percent\_delta', 'percent', 'delta', 'deltaps', 'counter'). | @@ -550,7 +541,10 @@ Les options disponibles pour chaque modèle de services sont listées ci-dessous | --oid-extra-display | Add an OID to display. | | --display-transform-src --display-transform-dst | Modify the interface name displayed by using a regular expression. Example: adding --display-transform-src='eth' --display-transform-dst='ens' will replace all occurrences of 'eth' with 'ens' | | --show-cache | Display cache interface data. | +| --no-cache-lock | Set to disable locking when accessing cache. | | --filter-counters | Only display some counters (regexp can be used). Example to check SSL connections only : --filter-counters='^xxxx\|yyyy$' | +| --warning-xxx | Warning threshold. | +| --critical-xxx | Critical threshold. | | --memcached | Memcached server to use (only one server). | | --redis-server | Redis server to use (only one server). Syntax: address\[:port\] | | --redis-attribute | Set Redis Options (--redis-attribute="cnx\_timeout=5"). | @@ -564,6 +558,7 @@ Les options disponibles pour chaque modèle de services sont listées ci-dessous | --statefile-key | Define the key to encrypt/decrypt the cache. | | --statefile-cipher | Define the cipher algorithm to encrypt the cache (default: 'AES'). | | --add-optical | Check interface optical. | +| --warning-* --critical-* | Thresholds. Can be: 'total-port', 'total-admin-up', 'total-admin-down', 'total-oper-up', 'total-oper-down', 'in-traffic', 'out-traffic', 'in-crc', 'in-error', 'in-discard', 'out-error', 'out-discard', 'in-ucast', 'in-bcast', 'in-mcast', 'out-ucast', 'out-bcast', 'out-mcast', 'speed' (b/s), 'laser-temp', 'input-power', 'output-power'. | @@ -581,7 +576,6 @@ Les options disponibles pour chaque modèle de services sont listées ci-dessous | --check-metrics | If the expression is true, metrics are checked (default: '%\{opstatus\} eq "up"'). | | --warning-status | Define the conditions to match for the status to be WARNING. You can use the following variables: %\{admstatus\}, %\{opstatus\}, %\{duplexstatus\}, %\{display\} | | --critical-status | Define the conditions to match for the status to be CRITICAL (default: '%\{admstatus\} eq "up" and %\{opstatus\} ne "up"'). You can use the following variables: %\{admstatus\}, %\{opstatus\}, %\{duplexstatus\}, %\{display\} | -| --warning-* --critical-* | Thresholds. Can be: 'total-port', 'total-admin-up', 'total-admin-down', 'total-oper-up', 'total-oper-down', 'in-traffic', 'out-traffic', 'in-crc', 'in-error', 'in-discard', 'out-error', 'out-discard', 'in-ucast', 'in-bcast', 'in-mcast', 'out-ucast', 'out-bcast', 'out-mcast', 'speed' (b/s), 'laser-temp', 'input-power', 'output-power'. | | --units-traffic | Units of thresholds for the traffic (default: 'percent\_delta') ('percent\_delta', 'bps', 'counter'). | | --units-errors | Units of thresholds for errors/discards (default: 'percent\_delta') ('percent\_delta', 'percent', 'delta', 'deltaps', 'counter'). | | --units-cast | Units of thresholds for communication types (default: 'percent\_delta') ('percent\_delta', 'percent', 'delta', 'deltaps', 'counter'). | @@ -601,7 +595,9 @@ Les options disponibles pour chaque modèle de services sont listées ci-dessous | --oid-extra-display | Add an OID to display. | | --display-transform-src --display-transform-dst | Modify the interface name displayed by using a regular expression. Example: adding --display-transform-src='eth' --display-transform-dst='ens' will replace all occurrences of 'eth' with 'ens' | | --show-cache | Display cache interface data. | +| --no-cache-lock | Set to disable locking when accessing cache. | | --add-optical | Check interface optical. | +| --warning-* --critical-* | Thresholds. Can be: 'total-port', 'total-admin-up', 'total-admin-down', 'total-oper-up', 'total-oper-down', 'in-traffic', 'out-traffic', 'in-crc', 'in-error', 'in-discard', 'out-error', 'out-discard', 'in-ucast', 'in-bcast', 'in-mcast', 'out-ucast', 'out-bcast', 'out-mcast', 'speed' (b/s), 'laser-temp', 'input-power', 'output-power'. | @@ -619,7 +615,6 @@ Les options disponibles pour chaque modèle de services sont listées ci-dessous | --check-metrics | If the expression is true, metrics are checked (default: '%\{opstatus\} eq "up"'). | | --warning-status | Define the conditions to match for the status to be WARNING. You can use the following variables: %\{admstatus\}, %\{opstatus\}, %\{duplexstatus\}, %\{display\} | | --critical-status | Define the conditions to match for the status to be CRITICAL (default: '%\{admstatus\} eq "up" and %\{opstatus\} ne "up"'). You can use the following variables: %\{admstatus\}, %\{opstatus\}, %\{duplexstatus\}, %\{display\} | -| --warning-* --critical-* | Thresholds. Can be: 'total-port', 'total-admin-up', 'total-admin-down', 'total-oper-up', 'total-oper-down', 'in-traffic', 'out-traffic', 'in-crc', 'in-error', 'in-discard', 'out-error', 'out-discard', 'in-ucast', 'in-bcast', 'in-mcast', 'out-ucast', 'out-bcast', 'out-mcast', 'speed' (b/s), 'laser-temp', 'input-power', 'output-power'. | | --units-traffic | Units of thresholds for the traffic (default: 'percent\_delta') ('percent\_delta', 'bps', 'counter'). | | --units-errors | Units of thresholds for errors/discards (default: 'percent\_delta') ('percent\_delta', 'percent', 'delta', 'deltaps', 'counter'). | | --units-cast | Units of thresholds for communication types (default: 'percent\_delta') ('percent\_delta', 'percent', 'delta', 'deltaps', 'counter'). | @@ -639,7 +634,9 @@ Les options disponibles pour chaque modèle de services sont listées ci-dessous | --oid-extra-display | Add an OID to display. | | --display-transform-src --display-transform-dst | Modify the interface name displayed by using a regular expression. Example: adding --display-transform-src='eth' --display-transform-dst='ens' will replace all occurrences of 'eth' with 'ens' | | --show-cache | Display cache interface data. | +| --no-cache-lock | Set to disable locking when accessing cache. | | --add-optical | Check interface optical. | +| --warning-* --critical-* | Thresholds. Can be: 'total-port', 'total-admin-up', 'total-admin-down', 'total-oper-up', 'total-oper-down', 'in-traffic', 'out-traffic', 'in-crc', 'in-error', 'in-discard', 'out-error', 'out-discard', 'in-ucast', 'in-bcast', 'in-mcast', 'out-ucast', 'out-bcast', 'out-mcast', 'speed' (b/s), 'laser-temp', 'input-power', 'output-power'. | diff --git a/i18n/fr/docusaurus-plugin-content-docs-pp/current/integrations/plugin-packs/procedures/network-switchs-cisco-smallbusiness-standard-snmp.md b/i18n/fr/docusaurus-plugin-content-docs-pp/current/integrations/plugin-packs/procedures/network-switchs-cisco-smallbusiness-standard-snmp.md index 2e6869fafd40..79c4791d96b7 100644 --- a/i18n/fr/docusaurus-plugin-content-docs-pp/current/integrations/plugin-packs/procedures/network-switchs-cisco-smallbusiness-standard-snmp.md +++ b/i18n/fr/docusaurus-plugin-content-docs-pp/current/integrations/plugin-packs/procedures/network-switchs-cisco-smallbusiness-standard-snmp.md @@ -28,7 +28,7 @@ Le connecteur apporte les modèles de service suivants | Alias | Modèle de service | Description | |:------------|:----------------------------------------------|:--------------------------------------------------------------------------------------------------------------------------| | Cpu | Net-Cisco-Sb-Standard-Cpu-SNMP-custom | Contrôle du taux d'utilisation du CPU de la machine. Ce contrôle pourra remonter la moyenne du taux d'utilisation des CPU | -| Environment | Net-Cisco-Sb-Standard-Environment-SNMP-custom | Contrôle l'état du matériel (ventilateurs, alimentations) | +| Environment | Net-Cisco-Sb-Standard-Environment-SNMP-custom | Contrôle l'état du matériel (Ventilateurs, alimentations) | > Les services listés ci-dessus sont créés automatiquement lorsque le modèle d'hôte **Net-Cisco-Sb-Standard-SNMP-custom** est utilisé. @@ -42,9 +42,9 @@ Le connecteur apporte les modèles de service suivants | Packet-Errors-Global | Net-Cisco-Sb-Standard-Packet-Errors-Global-SNMP-custom | Contrôle le pourcentage de paquets en erreur/écartés de plusieurs interfaces réseau | X | | Spanning-Tree | Net-Cisco-Sb-Standard-SpanningTree-SNMP-custom | Contrôle l'état du protocole Spanning Tree sur les interfaces | | | Stack | Net-Cisco-Sb-Standard-Stack-SNMP-custom | Contrôle les membres du stack | | -| Traffic-Generic-Id | Net-Cisco-Sb-Standard-Traffic-Generic-Id-SNMP-custom | Contrôle le trafic réseau d'une interface réseau | | -| Traffic-Generic-Name | Net-Cisco-Sb-Standard-Traffic-Generic-Name-SNMP-custom | Contrôle le trafic réseau d'une interface réseau | | -| Traffic-Global | Net-Cisco-Sb-Standard-Traffic-Global-SNMP-custom | Contrôle le trafic réseau de plusieurs interfaces réseau | X | +| Traffic-Generic-Id | Net-Cisco-Sb-Standard-Traffic-Generic-Id-SNMP-custom | Contrôle le traffic réseau d'une interface réseau | | +| Traffic-Generic-Name | Net-Cisco-Sb-Standard-Traffic-Generic-Name-SNMP-custom | Contrôle le traffic réseau d'une interface réseau | | +| Traffic-Global | Net-Cisco-Sb-Standard-Traffic-Global-SNMP-custom | Contrôle le traffic réseau de plusieurs interfaces réseau | X | > Les services listés ci-dessus ne sont pas créés automatiquement lorsqu'un modèle d'hôte est appliqué. Pour les utiliser, [créez un service manuellement](/docs/monitoring/basic-objects/services) et appliquez le modèle de service souhaité. @@ -253,12 +253,14 @@ yum install centreon-plugin-Network-Switchs-Cisco-Smallbusiness-Standard-Snmp 2. Complétez les champs **Nom**, **Alias** & **IP Address/DNS** correspondant à votre ressource. 3. Appliquez le modèle d'hôte **Net-Cisco-Sb-Standard-SNMP-custom**. -> Si vous utilisez SNMP en version 3, vous devez configurer les paramètres spécifiques associés via la macro **SNMPEXTRAOPTIONS**. -> Plus d'informations dans la section [Troubleshooting SNMP](../getting-started/how-to-guides/troubleshooting-plugins.md#mapping-des-options-snmpv3). - -| Macro | Description | Valeur par défaut | Obligatoire | -|:-----------------|:---------------------------------------------------------------------------------------------------------------------------------------------------|:------------------|:-----------:| -| SNMPEXTRAOPTIONS | Any extra option you may want to add to every command (a --verbose flag for example). Toutes les options sont listées [ici](#options-disponibles). | | | +| Macro | Description | Valeur par défaut | Obligatoire | +|:------------------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------|:------------------|:-----------:| +| SNMP_V3_USERNAME | SNMP v3 only: User name (`securityName`) | | | +| SNMP_V3_AUTH_PROTOCOL | SNMP v3 only: Authentication protocol: MD5\|SHA. Since net-snmp 5.9.1: SHA224\|SHA256\|SHA384\|SHA512 | | | +| SNMP_V3_PRIV_PROTOCOL | 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 | | | +| SNMP_V3_AUTH_PASSPHRASE | SNMP v3 only: Pass phrase hashed using the authentication protocol defined in the --authprotocol option | | | +| SNMP_V3_PRIV_PASSPHRASE | SNMP v3 only: Privacy pass phrase (`privPassword`) to encrypt messages using the protocol defined in the --privprotocol option | | | +| SNMPEXTRAOPTIONS | Any extra option you may want to add to every command (a --verbose flag for example). Toutes les options sont listées [ici](#options-disponibles). | | | 4. [Déployez la configuration](/docs/monitoring/monitoring-servers/deploying-a-configuration). L'hôte apparaît dans la liste des hôtes supervisés, et dans la page **Statut des ressources**. La commande envoyée par le connecteur est indiquée dans le panneau de détails de l'hôte : celle-ci montre les valeurs des macros. @@ -290,14 +292,14 @@ yum install centreon-plugin-Network-Switchs-Cisco-Smallbusiness-Standard-Snmp | Macro | Description | Valeur par défaut | Obligatoire | |:-------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------|:------------------|:-----------:| | INTERFACEID | Check only the interfaces with the specified IDs (OID indexes, e.g.: 1,2,...). If empty, all interfaces will be monitored. To filter on interface names, see --name | | | -| WARNINGINDISCARD | Threshold | | | -| CRITICALINDISCARD | Threshold | | | -| WARNINGINERROR | Threshold | | | -| CRITICALINERROR | Threshold | | | -| WARNINGOUTDISCARD | Threshold | | | -| CRITICALOUTDISCARD | Threshold | | | -| WARNINGOUTERROR | Threshold | | | -| CRITICALOUTERROR | Threshold | | | +| WARNINGINDISCARD | Thresholds | | | +| CRITICALINDISCARD | Thresholds | | | +| WARNINGINERROR | Thresholds | | | +| CRITICALINERROR | Thresholds | | | +| WARNINGOUTDISCARD | Thresholds | | | +| CRITICALOUTDISCARD | Thresholds | | | +| WARNINGOUTERROR | Thresholds | | | +| CRITICALOUTERROR | Thresholds | | | | EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). Toutes les options sont listées [ici](#options-disponibles). | | | @@ -306,14 +308,14 @@ yum install centreon-plugin-Network-Switchs-Cisco-Smallbusiness-Standard-Snmp | Macro | Description | Valeur par défaut | Obligatoire | |:-------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------|:------------------|:-----------:| | INTERFACENAME | Check only the interfaces with the specified IDs (OID indexes, e.g.: 1,2,...). If empty, all interfaces will be monitored. To filter on interface names, see --name | | | -| WARNINGINDISCARD | Threshold | | | -| CRITICALINDISCARD | Threshold | | | -| WARNINGINERROR | Threshold | | | -| CRITICALINERROR | Threshold | | | -| WARNINGOUTDISCARD | Threshold | | | -| CRITICALOUTDISCARD | Threshold | | | -| WARNINGOUTERROR | Threshold | | | -| CRITICALOUTERROR | Threshold | | | +| WARNINGINDISCARD | Thresholds | | | +| CRITICALINDISCARD | Thresholds | | | +| WARNINGINERROR | Thresholds | | | +| CRITICALINERROR | Thresholds | | | +| WARNINGOUTDISCARD | Thresholds | | | +| CRITICALOUTDISCARD | Thresholds | | | +| WARNINGOUTERROR | Thresholds | | | +| CRITICALOUTERROR | Thresholds | | | | EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). Toutes les options sont listées [ici](#options-disponibles). | | | @@ -322,14 +324,14 @@ yum install centreon-plugin-Network-Switchs-Cisco-Smallbusiness-Standard-Snmp | Macro | Description | Valeur par défaut | Obligatoire | |:-------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------|:-------------------------------------------------|:-----------:| | FILTER | Check only the interfaces with the specified IDs (OID indexes, e.g.: 1,2,...). If empty, all interfaces will be monitored. To filter on interface names, see --name | .* | | -| WARNINGINDISCARD | Threshold | | | -| CRITICALINDISCARD | Threshold | | | -| WARNINGINERROR | Threshold | | | -| CRITICALINERROR | Threshold | | | -| WARNINGOUTDISCARD | Threshold | | | -| CRITICALOUTDISCARD | Threshold | | | -| WARNINGOUTERROR | Threshold | | | -| CRITICALOUTERROR | Threshold | | | +| WARNINGINDISCARD | Thresholds | | | +| CRITICALINDISCARD | Thresholds | | | +| WARNINGINERROR | Thresholds | | | +| CRITICALINERROR | Thresholds | | | +| WARNINGOUTDISCARD | Thresholds | | | +| CRITICALOUTDISCARD | Thresholds | | | +| WARNINGOUTERROR | Thresholds | | | +| CRITICALOUTERROR | Thresholds | | | | CRITICALSTATUS | Define the conditions to match for the status to be CRITICAL. You can use the following variables: %\{admstatus\}, %\{opstatus\}, %\{duplexstatus\}, %\{display\} | %\{admstatus\} eq "up" and %\{opstatus\} ne "up" | | | EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). Toutes les options sont listées [ici](#options-disponibles). | --verbose | | @@ -362,10 +364,10 @@ yum install centreon-plugin-Network-Switchs-Cisco-Smallbusiness-Standard-Snmp | Macro | Description | Valeur par défaut | Obligatoire | |:-------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------|:------------------|:-----------:| | INTERFACEID | Check only the interfaces with the specified IDs (OID indexes, e.g.: 1,2,...). If empty, all interfaces will be monitored. To filter on interface names, see --name | | | -| CRITICALIN | Threshold | 90 | | -| WARNINGIN | Threshold | 80 | | -| CRITICALOUT | Threshold | 90 | | -| WARNINGOUT | Threshold | 80 | | +| CRITICALIN | Thresholds | 90 | | +| WARNINGIN | Thresholds | 80 | | +| CRITICALOUT | Thresholds | 90 | | +| WARNINGOUT | Thresholds | 80 | | | EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). Toutes les options sont listées [ici](#options-disponibles). | | | @@ -374,10 +376,10 @@ yum install centreon-plugin-Network-Switchs-Cisco-Smallbusiness-Standard-Snmp | Macro | Description | Valeur par défaut | Obligatoire | |:--------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------|:------------------|:-----------:| | INTERFACENAME | Check only the interfaces with the specified IDs (OID indexes, e.g.: 1,2,...). If empty, all interfaces will be monitored. To filter on interface names, see --name | | | -| CRITICALIN | Threshold | 90 | | -| WARNINGIN | Threshold | 80 | | -| CRITICALOUT | Threshold | 90 | | -| WARNINGOUT | Threshold | 80 | | +| CRITICALIN | Thresholds | 90 | | +| WARNINGIN | Thresholds | 80 | | +| CRITICALOUT | Thresholds | 90 | | +| WARNINGOUT | Thresholds | 80 | | | EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). Toutes les options sont listées [ici](#options-disponibles). | | | @@ -386,10 +388,10 @@ yum install centreon-plugin-Network-Switchs-Cisco-Smallbusiness-Standard-Snmp | Macro | Description | Valeur par défaut | Obligatoire | |:---------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------|:-------------------------------------------------|:-----------:| | FILTER | Check only the interfaces with the specified IDs (OID indexes, e.g.: 1,2,...). If empty, all interfaces will be monitored. To filter on interface names, see --name | .* | | -| CRITICALIN | Threshold | 90 | | -| WARNINGIN | Threshold | 80 | | -| CRITICALOUT | Threshold | 90 | | -| WARNINGOUT | Threshold | 80 | | +| CRITICALIN | Thresholds | 90 | | +| WARNINGIN | Thresholds | 80 | | +| CRITICALOUT | Thresholds | 90 | | +| WARNINGOUT | Thresholds | 80 | | | CRITICALSTATUS | Define the conditions to match for the status to be CRITICAL. You can use the following variables: %\{admstatus\}, %\{opstatus\}, %\{duplexstatus\}, %\{display\} | %\{admstatus\} eq "up" and %\{opstatus\} ne "up" | | | EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). Toutes les options sont listées [ici](#options-disponibles). | --verbose | | @@ -412,7 +414,12 @@ telle que celle-ci (remplacez les valeurs d'exemple par les vôtres) : --mode=interfaces \ --hostname=10.0.0.1 \ --snmp-version='2c' \ - --snmp-community='my-snmp-community' \ + --snmp-community='my-snmp-community' \ + --snmp-username='username' \ + --authpassphrase='' \ + --authprotocol='' \ + --privpassphrase='' \ + --privprotocol='' \ --interface='.*' \ --name \ --add-status \ @@ -488,24 +495,25 @@ Les options génériques sont listées ci-dessous : | --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-force-getnext | Use SNMP get-next 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). | +| --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. | +| --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 ok, warning, critical and unknown (default). | -| --snmp-tls-transport | Transport protocol for TLS communication (can be: 'dtlsudp', 'tlstcp'). | +| --snmp-errors-exit | Expected status in case of SNMP error or timeout. Possible values are ok, 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-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. | +| --show-password | By default, sensitive information in command lines is hidden in debug output and replaced with `***` (however, debug logs may still display sensitive information). Using the C option will display the passwords in plain text. | | --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%;;;; | @@ -513,9 +521,9 @@ Les options génériques sont listées ci-dessous : | --change-perfdata | Change or extend perfdata. Syntax: --extend-perfdata=searchlabel,newlabel,target\[,\[\\],\[min\],\[max\]\] Common examples: onvert 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\[,\[\\],\[min\],\[max\]\] Common examples: onvert 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,\,calculation\[,\[\\],\[min\],\[max\]\] regex: regular expression \: 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 \ (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: um 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~replacement~modifier Most commonly used modifiers are i (case insensitive) and g (replace all occurrences). Example: adding --change-short-output='OK\~Up\~gi' will replace all occurrences of 'OK', 'ok', 'Ok' or 'oK' with 'Up' | -| --change-short-output | Modify the short/long output that is returned by the plugin. Syntax: --change-short-output=pattern~replacement~modifier Most commonly used modifiers are i (case insensitive) and g (replace all occurrences). Example: adding --change-short-output='OK\~Up\~gi' will replace all occurrences of 'OK', 'ok', 'Ok' or 'oK' with 'Up' | -| --change-long-output | Modify the short/long output that is returned by the plugin. Syntax: --change-short-output=pattern~replacement~modifier Most commonly used modifiers are i (case insensitive) and g (replace all occurrences). Example: adding --change-short-output='OK\~Up\~gi' will replace all occurrences of 'OK', 'ok', 'Ok' or 'oK' with 'Up' | +| --change-short-output --change-long-output | Modify the short/long output that is returned by the plugin. Syntax: --change-short-output=pattern~replacement~modifier Most commonly used modifiers are i (case insensitive) and g (replace all occurrences). Example: adding --change-short-output='OK~Up~gi' will replace all occurrences of 'OK', 'ok', 'Ok' or 'oK' with 'Up' | +| --change-short-output | Modify the short/long output that is returned by the plugin. Syntax: --change-short-output=pattern~replacement~modifier Most commonly used modifiers are i (case insensitive) and g (replace all occurrences). Example: adding --change-short-output='OK~Up~gi' will replace all occurrences of 'OK', 'ok', 'Ok' or 'oK' with 'Up' | +| --change-long-output | Modify the short/long output that is returned by the plugin. Syntax: --change-short-output=pattern~replacement~modifier Most commonly used modifiers are i (case insensitive) and g (replace all occurrences). Example: adding --change-short-output='OK~Up~gi' will replace all occurrences of 'OK', 'ok', 'Ok' or 'oK' with 'Up' | | --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. | @@ -562,52 +570,90 @@ Les options disponibles pour chaque modèle de services sont listées ci-dessous -| Option | Description | -|:------------------------------------------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| --filter-counters | Only display some counters (regexp can be used). Example to check SSL connections only : --filter-counters='^xxxx\|yyyy$' | -| --memcached | Memcached server to use (only one server). | -| --redis-server | Redis server to use (only one server). Syntax: address\[:port\] | -| --redis-attribute | Set Redis Options (--redis-attribute="cnx\_timeout=5"). | -| --redis-db | Set Redis database index. | -| --failback-file | Fall back on a local file if Redis connection fails. | -| --memexpiration | Time to keep data in seconds (default: 86400). | -| --statefile-dir | Define the cache directory (default: '/var/lib/centreon/centplugins'). | -| --statefile-suffix | Define a suffix to customize the statefile name (default: ''). | -| --statefile-concat-cwd | If used with the '--statefile-dir' option, the latter's value will be used as a sub-directory of the current working directory. Useful on Windows when the plugin is compiled, as the file system and permissions are different from Linux. | -| --statefile-format | Define the format used to store the cache. Available formats: 'dumper', 'storable', 'json' (default). | -| --statefile-key | Define the key to encrypt/decrypt the cache. | -| --statefile-cipher | Define the cipher algorithm to encrypt the cache (default: 'AES'). | -| --add-global | Check global port statistics (by default if no --add-* option is set). | -| --add-status | Check interface status. | -| --add-duplex-status | Check duplex status (with --warning-status and --critical-status). | -| --add-traffic | Check interface traffic. | -| --add-errors | Check interface errors. | -| --add-cast | Check interface cast. | -| --add-speed | Check interface speed. | -| --add-volume | Check interface data volume between two checks (not supposed to be graphed, useful for BI reporting). | -| --check-metrics | If the expression is true, metrics are checked (default: '%\{opstatus\} eq "up"'). | -| --warning-status | Define the conditions to match for the status to be WARNING. You can use the following variables: %\{admstatus\}, %\{opstatus\}, %\{duplexstatus\}, %\{display\} | -| --critical-status | Define the conditions to match for the status to be CRITICAL (default: '%\{admstatus\} eq "up" and %\{opstatus\} ne "up"'). You can use the following variables: %\{admstatus\}, %\{opstatus\}, %\{duplexstatus\}, %\{display\} | -| --warning-* --critical-* | Thresholds. Can be: 'total-port', 'total-admin-up', 'total-admin-down', 'total-oper-up', 'total-oper-down', 'in-traffic', 'out-traffic', 'in-error', 'in-discard', 'out-error', 'out-discard', 'in-ucast', 'in-bcast', 'in-mcast', 'out-ucast', 'out-bcast', 'out-mcast', 'speed' (b/s). | -| --units-traffic | Units of thresholds for the traffic (default: 'percent\_delta') ('percent\_delta', 'bps', 'counter'). | -| --units-errors | Units of thresholds for errors/discards (default: 'percent\_delta') ('percent\_delta', 'percent', 'delta', 'deltaps', 'counter'). | -| --units-cast | Units of thresholds for communication types (default: 'percent\_delta') ('percent\_delta', 'percent', 'delta', 'deltaps', 'counter'). | -| --nagvis-perfdata | Display traffic perfdata to be compatible with NagVis widget. | -| --interface | Check only the interfaces with the specified IDs (OID indexes, e.g.: 1,2,...). If empty, all interfaces will be monitored. To filter on interface names, see --name. | -| --name | With this option, the interfaces will be filtered by name (given in option --interface) instead of OID index. The name matching mode supports regular expressions. | -| --regex-id | With this option, interface IDs will be filtered using the --interface parameter as a regular expression instead of a list of IDs. | -| --speed | Set interface speed for incoming/outgoing traffic (in Mb). | -| --speed-in | Set interface speed for incoming traffic (in Mb). | -| --speed-out | Set interface speed for outgoing traffic (in Mb). | -| --map-speed-dsl | Get interface speed configuration for interfaces of type 'ADSL' and 'VDSL2'. Syntax: --map-speed-dsl=interface-src-name,interface-dsl-name E.g: --map-speed-dsl=Et0.835,Et0-vdsl2 | -| --force-counters64 | Force to use 64 bits counters only. Can be used to improve performance. | -| --force-counters32 | Force to use 32-bit counters (even with SNMP versions 2c and 3). To use when 64 bits counters are buggy. | -| --reload-cache-time | Time in minutes before reloading cache file (default: 180). | -| --oid-filter | Define the OID to be used to filter interfaces (default: ifName) (values: ifDesc, ifAlias, ifName, IpAddr). | -| --oid-display | Define the OID that will be used to name the interfaces (default: ifName) (values: ifDesc, ifAlias, ifName, IpAddr). | -| --oid-extra-display | Add an OID to display. | -| --display-transform-src --display-transform-dst | Modify the interface name displayed by using a regular expression. Example: adding --display-transform-src='eth' --display-transform-dst='ens' will replace all occurrences of 'eth' with 'ens' | -| --show-cache | Display cache interface data. | +| Option | Description | +|:------------------------------------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| --filter-counters | Only display some counters (regexp can be used). Example to check SSL connections only : --filter-counters='^xxxx\|yyyy$' | +| --warning-xxx | Warning threshold. | +| --critical-xxx | Critical threshold. | +| --memcached | Memcached server to use (only one server). | +| --redis-server | Redis server to use (only one server). Syntax: address\[:port\] | +| --redis-attribute | Set Redis Options (--redis-attribute="cnx\_timeout=5"). | +| --redis-db | Set Redis database index. | +| --failback-file | Fall back on a local file if Redis connection fails. | +| --memexpiration | Time to keep data in seconds (default: 86400). | +| --statefile-dir | Define the cache directory (default: '/var/lib/centreon/centplugins'). | +| --statefile-suffix | Define a suffix to customize the statefile name (default: ''). | +| --statefile-concat-cwd | If used with the '--statefile-dir' option, the latter's value will be used as a sub-directory of the current working directory. Useful on Windows when the plugin is compiled, as the file system and permissions are different from Linux. | +| --statefile-format | Define the format used to store the cache. Available formats: 'dumper', 'storable', 'json' (default). | +| --statefile-key | Define the key to encrypt/decrypt the cache. | +| --statefile-cipher | Define the cipher algorithm to encrypt the cache (default: 'AES'). | +| --add-global | Check global port statistics (by default if no --add-* option is set). | +| --add-status | Check interface status. | +| --add-duplex-status | Check duplex status (with --warning-status and --critical-status). | +| --add-traffic | Check interface traffic. | +| --add-errors | Check interface errors. | +| --add-cast | Check interface cast. | +| --add-speed | Check interface speed. | +| --add-volume | Check interface data volume between two checks (not supposed to be graphed, useful for BI reporting). | +| --check-metrics | If the expression is true, metrics are checked (default: '%\{opstatus\} eq "up"'). | +| --warning-status | Define the conditions to match for the status to be WARNING. You can use the following variables: %\{admstatus\}, %\{opstatus\}, %\{duplexstatus\}, %\{display\} | +| --critical-status | Define the conditions to match for the status to be CRITICAL (default: '%\{admstatus\} eq "up" and %\{opstatus\} ne "up"'). You can use the following variables: %\{admstatus\}, %\{opstatus\}, %\{duplexstatus\}, %\{display\} | +| --warning-total-port | Thresholds. | +| --critical-total-port | Thresholds. | +| --warning-total-admin-up | Thresholds. | +| --critical-total-admin-up | Thresholds. | +| --warning-total-admin-down | Thresholds. | +| --critical-total-admin-down | Thresholds. | +| --warning-total-oper-up | Thresholds. | +| --critical-total-oper-up | Thresholds. | +| --warning-total-oper-down | Thresholds. | +| --critical-total-oper-down | Thresholds. | +| --warning-in-traffic | Thresholds. | +| --critical-in-traffic | Thresholds. | +| --warning-out-traffic | Thresholds. | +| --critical-out-traffic | Thresholds. | +| --warning-in-error | Thresholds. | +| --critical-in-error | Thresholds. | +| --warning-in-discard | Thresholds. | +| --critical-in-discard | Thresholds. | +| --warning-out-error | Thresholds. | +| --critical-out-error | Thresholds. | +| --warning-out-discard | Thresholds. | +| --critical-out-discard | Thresholds. | +| --warning-in-ucast | Thresholds. | +| --critical-in-ucast | Thresholds. | +| --warning-in-bcast | Thresholds. | +| --critical-in-bcast | Thresholds. | +| --warning-in-mcast | Thresholds. | +| --critical-in-mcast | Thresholds. | +| --warning-out-ucast | Thresholds. | +| --critical-out-ucast | Thresholds. | +| --warning-out-bcast | Thresholds. | +| --critical-out-bcast | Thresholds. | +| --warning-out-mcast | Thresholds. | +| --critical-out-mcast | Thresholds. | +| --warning-speed | Thresholds in b/s. | +| --critical-speed | Thresholds in b/s. | +| --units-traffic | Units of thresholds for the traffic (default: 'percent\_delta') ('percent\_delta', 'bps', 'counter'). | +| --units-errors | Units of thresholds for errors/discards (default: 'percent\_delta') ('percent\_delta', 'delta', 'deltaps', 'counter'). | +| --units-cast | Units of thresholds for communication types (default: 'percent\_delta') ('percent\_delta', 'percent', 'delta', 'deltaps', 'counter'). | +| --nagvis-perfdata | Display traffic perfdata to be compatible with NagVis widget. | +| --interface | Check only the interfaces with the specified IDs (OID indexes, e.g.: 1,2,...). If empty, all interfaces will be monitored. To filter on interface names, see --name. | +| --name | With this option, the interfaces will be filtered by name (given in option --interface) instead of OID index. The name matching mode supports regular expressions. | +| --regex-id | With this option, interface IDs will be filtered using the --interface parameter as a regular expression instead of a list of IDs. | +| --speed | Set interface speed for incoming/outgoing traffic (in Mb). | +| --speed-in | Set interface speed for incoming traffic (in Mb). | +| --speed-out | Set interface speed for outgoing traffic (in Mb). | +| --map-speed-dsl | Get interface speed configuration for interfaces of type 'ADSL' and 'VDSL2'. Syntax: --map-speed-dsl=interface-src-name,interface-dsl-name E.g: --map-speed-dsl=Et0.835,Et0-vdsl2 | +| --force-counters64 | Force to use 64 bits counters only. Can be used to improve performance. | +| --force-counters32 | Force to use 32-bit counters (even with SNMP versions 2c and 3). To use when 64 bits counters are buggy. | +| --reload-cache-time | Time in minutes before reloading cache file (default: 180). | +| --oid-filter | Define the OID to be used to filter interfaces (default: ifName) (values: ifDesc, ifAlias, ifName, IpAddr). | +| --oid-display | Define the OID that will be used to name the interfaces (default: ifName) (values: ifDesc, ifAlias, ifName, IpAddr). | +| --oid-extra-display | Add an OID to display. | +| --display-transform-src --display-transform-dst | Modify the interface name displayed by using a regular expression. Example: adding --display-transform-src='eth' --display-transform-dst='ens' will replace all occurrences of 'eth' with 'ens' | +| --show-cache | Display cache interface data. | +| --no-cache-lock | Set to disable locking when accessing cache. | @@ -615,6 +661,8 @@ Les options disponibles pour chaque modèle de services sont listées ci-dessous | Option | Description | |:------------------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | --filter-counters | Only display some counters (regexp can be used). Example to check SSL connections only : --filter-counters='^xxxx\|yyyy$' | +| --warning-xxx | Warning threshold. | +| --critical-xxx | Critical threshold. | | --filter-port | Filter on port description (can be a regexp). | | --warning-status | Define the conditions to match for the status to be WARNING. You can use the following variables: %\{state\}, %\{op\_status\}, %\{admin\_status\}, %\{port\}, %\{index\}. | | --critical-status | Define the conditions to match for the status to be CRITICAL (default: '%\{op\_status\} =~ /up/ && %\{state\} =~ /blocking\|broken/'). You can use the following variables: %\{state\}, %\{op\_status\}, %\{admin\_status\}, %\{port\}, %\{index\}. | @@ -625,6 +673,8 @@ Les options disponibles pour chaque modèle de services sont listées ci-dessous | Option | Description | |:------------------------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------| | --filter-counters | Only display some counters (regexp can be used). Example to check SSL connections only : --filter-counters='^xxxx\|yyyy$' | +| --warning-xxx | Warning threshold. | +| --critical-xxx | Critical threshold. | | --warning-member-connection-status | Set warning threshold for member connection status. You can use the following variables: %\{connectionStatus\}, %\{connectionSide\}, %\{connectedMemberUnit\} | | --critical-member-connection-status | Set critical threshold for member connection status. You can use the following variables: %\{connectionStatus\}, %\{connectionSide\}, %\{connectedMemberUnit\} | | --warning-members-detected | Thresholds. | @@ -635,52 +685,90 @@ Les options disponibles pour chaque modèle de services sont listées ci-dessous -| Option | Description | -|:------------------------------------------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| --filter-counters | Only display some counters (regexp can be used). Example to check SSL connections only : --filter-counters='^xxxx\|yyyy$' | -| --memcached | Memcached server to use (only one server). | -| --redis-server | Redis server to use (only one server). Syntax: address\[:port\] | -| --redis-attribute | Set Redis Options (--redis-attribute="cnx\_timeout=5"). | -| --redis-db | Set Redis database index. | -| --failback-file | Fall back on a local file if Redis connection fails. | -| --memexpiration | Time to keep data in seconds (default: 86400). | -| --statefile-dir | Define the cache directory (default: '/var/lib/centreon/centplugins'). | -| --statefile-suffix | Define a suffix to customize the statefile name (default: ''). | -| --statefile-concat-cwd | If used with the '--statefile-dir' option, the latter's value will be used as a sub-directory of the current working directory. Useful on Windows when the plugin is compiled, as the file system and permissions are different from Linux. | -| --statefile-format | Define the format used to store the cache. Available formats: 'dumper', 'storable', 'json' (default). | -| --statefile-key | Define the key to encrypt/decrypt the cache. | -| --statefile-cipher | Define the cipher algorithm to encrypt the cache (default: 'AES'). | -| --add-global | Check global port statistics (by default if no --add-* option is set). | -| --add-status | Check interface status. | -| --add-duplex-status | Check duplex status (with --warning-status and --critical-status). | -| --add-traffic | Check interface traffic. | -| --add-errors | Check interface errors. | -| --add-cast | Check interface cast. | -| --add-speed | Check interface speed. | -| --add-volume | Check interface data volume between two checks (not supposed to be graphed, useful for BI reporting). | -| --check-metrics | If the expression is true, metrics are checked (default: '%\{opstatus\} eq "up"'). | -| --warning-status | Define the conditions to match for the status to be WARNING. You can use the following variables: %\{admstatus\}, %\{opstatus\}, %\{duplexstatus\}, %\{display\} | -| --critical-status | Define the conditions to match for the status to be CRITICAL (default: '%\{admstatus\} eq "up" and %\{opstatus\} ne "up"'). You can use the following variables: %\{admstatus\}, %\{opstatus\}, %\{duplexstatus\}, %\{display\} | -| --warning-* --critical-* | Thresholds. Can be: 'total-port', 'total-admin-up', 'total-admin-down', 'total-oper-up', 'total-oper-down', 'in-traffic', 'out-traffic', 'in-error', 'in-discard', 'out-error', 'out-discard', 'in-ucast', 'in-bcast', 'in-mcast', 'out-ucast', 'out-bcast', 'out-mcast', 'speed' (b/s). | -| --units-traffic | Units of thresholds for the traffic (default: 'percent\_delta') ('percent\_delta', 'bps', 'counter'). | -| --units-errors | Units of thresholds for errors/discards (default: 'percent\_delta') ('percent\_delta', 'percent', 'delta', 'deltaps', 'counter'). | -| --units-cast | Units of thresholds for communication types (default: 'percent\_delta') ('percent\_delta', 'percent', 'delta', 'deltaps', 'counter'). | -| --nagvis-perfdata | Display traffic perfdata to be compatible with NagVis widget. | -| --interface | Check only the interfaces with the specified IDs (OID indexes, e.g.: 1,2,...). If empty, all interfaces will be monitored. To filter on interface names, see --name. | -| --name | With this option, the interfaces will be filtered by name (given in option --interface) instead of OID index. The name matching mode supports regular expressions. | -| --regex-id | With this option, interface IDs will be filtered using the --interface parameter as a regular expression instead of a list of IDs. | -| --speed | Set interface speed for incoming/outgoing traffic (in Mb). | -| --speed-in | Set interface speed for incoming traffic (in Mb). | -| --speed-out | Set interface speed for outgoing traffic (in Mb). | -| --map-speed-dsl | Get interface speed configuration for interfaces of type 'ADSL' and 'VDSL2'. Syntax: --map-speed-dsl=interface-src-name,interface-dsl-name E.g: --map-speed-dsl=Et0.835,Et0-vdsl2 | -| --force-counters64 | Force to use 64 bits counters only. Can be used to improve performance. | -| --force-counters32 | Force to use 32-bit counters (even with SNMP versions 2c and 3). To use when 64 bits counters are buggy. | -| --reload-cache-time | Time in minutes before reloading cache file (default: 180). | -| --oid-filter | Define the OID to be used to filter interfaces (default: ifName) (values: ifDesc, ifAlias, ifName, IpAddr). | -| --oid-display | Define the OID that will be used to name the interfaces (default: ifName) (values: ifDesc, ifAlias, ifName, IpAddr). | -| --oid-extra-display | Add an OID to display. | -| --display-transform-src --display-transform-dst | Modify the interface name displayed by using a regular expression. Example: adding --display-transform-src='eth' --display-transform-dst='ens' will replace all occurrences of 'eth' with 'ens' | -| --show-cache | Display cache interface data. | +| Option | Description | +|:------------------------------------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| --filter-counters | Only display some counters (regexp can be used). Example to check SSL connections only : --filter-counters='^xxxx\|yyyy$' | +| --warning-xxx | Warning threshold. | +| --critical-xxx | Critical threshold. | +| --memcached | Memcached server to use (only one server). | +| --redis-server | Redis server to use (only one server). Syntax: address\[:port\] | +| --redis-attribute | Set Redis Options (--redis-attribute="cnx\_timeout=5"). | +| --redis-db | Set Redis database index. | +| --failback-file | Fall back on a local file if Redis connection fails. | +| --memexpiration | Time to keep data in seconds (default: 86400). | +| --statefile-dir | Define the cache directory (default: '/var/lib/centreon/centplugins'). | +| --statefile-suffix | Define a suffix to customize the statefile name (default: ''). | +| --statefile-concat-cwd | If used with the '--statefile-dir' option, the latter's value will be used as a sub-directory of the current working directory. Useful on Windows when the plugin is compiled, as the file system and permissions are different from Linux. | +| --statefile-format | Define the format used to store the cache. Available formats: 'dumper', 'storable', 'json' (default). | +| --statefile-key | Define the key to encrypt/decrypt the cache. | +| --statefile-cipher | Define the cipher algorithm to encrypt the cache (default: 'AES'). | +| --add-global | Check global port statistics (by default if no --add-* option is set). | +| --add-status | Check interface status. | +| --add-duplex-status | Check duplex status (with --warning-status and --critical-status). | +| --add-traffic | Check interface traffic. | +| --add-errors | Check interface errors. | +| --add-cast | Check interface cast. | +| --add-speed | Check interface speed. | +| --add-volume | Check interface data volume between two checks (not supposed to be graphed, useful for BI reporting). | +| --check-metrics | If the expression is true, metrics are checked (default: '%\{opstatus\} eq "up"'). | +| --warning-status | Define the conditions to match for the status to be WARNING. You can use the following variables: %\{admstatus\}, %\{opstatus\}, %\{duplexstatus\}, %\{display\} | +| --critical-status | Define the conditions to match for the status to be CRITICAL (default: '%\{admstatus\} eq "up" and %\{opstatus\} ne "up"'). You can use the following variables: %\{admstatus\}, %\{opstatus\}, %\{duplexstatus\}, %\{display\} | +| --warning-total-port | Thresholds. | +| --critical-total-port | Thresholds. | +| --warning-total-admin-up | Thresholds. | +| --critical-total-admin-up | Thresholds. | +| --warning-total-admin-down | Thresholds. | +| --critical-total-admin-down | Thresholds. | +| --warning-total-oper-up | Thresholds. | +| --critical-total-oper-up | Thresholds. | +| --warning-total-oper-down | Thresholds. | +| --critical-total-oper-down | Thresholds. | +| --warning-in-traffic | Thresholds. | +| --critical-in-traffic | Thresholds. | +| --warning-out-traffic | Thresholds. | +| --critical-out-traffic | Thresholds. | +| --warning-in-error | Thresholds. | +| --critical-in-error | Thresholds. | +| --warning-in-discard | Thresholds. | +| --critical-in-discard | Thresholds. | +| --warning-out-error | Thresholds. | +| --critical-out-error | Thresholds. | +| --warning-out-discard | Thresholds. | +| --critical-out-discard | Thresholds. | +| --warning-in-ucast | Thresholds. | +| --critical-in-ucast | Thresholds. | +| --warning-in-bcast | Thresholds. | +| --critical-in-bcast | Thresholds. | +| --warning-in-mcast | Thresholds. | +| --critical-in-mcast | Thresholds. | +| --warning-out-ucast | Thresholds. | +| --critical-out-ucast | Thresholds. | +| --warning-out-bcast | Thresholds. | +| --critical-out-bcast | Thresholds. | +| --warning-out-mcast | Thresholds. | +| --critical-out-mcast | Thresholds. | +| --warning-speed | Thresholds in b/s. | +| --critical-speed | Thresholds in b/s. | +| --units-traffic | Units of thresholds for the traffic (default: 'percent\_delta') ('percent\_delta', 'bps', 'counter'). | +| --units-errors | Units of thresholds for errors/discards (default: 'percent\_delta') ('percent\_delta', 'delta', 'deltaps', 'counter'). | +| --units-cast | Units of thresholds for communication types (default: 'percent\_delta') ('percent\_delta', 'percent', 'delta', 'deltaps', 'counter'). | +| --nagvis-perfdata | Display traffic perfdata to be compatible with NagVis widget. | +| --interface | Check only the interfaces with the specified IDs (OID indexes, e.g.: 1,2,...). If empty, all interfaces will be monitored. To filter on interface names, see --name. | +| --name | With this option, the interfaces will be filtered by name (given in option --interface) instead of OID index. The name matching mode supports regular expressions. | +| --regex-id | With this option, interface IDs will be filtered using the --interface parameter as a regular expression instead of a list of IDs. | +| --speed | Set interface speed for incoming/outgoing traffic (in Mb). | +| --speed-in | Set interface speed for incoming traffic (in Mb). | +| --speed-out | Set interface speed for outgoing traffic (in Mb). | +| --map-speed-dsl | Get interface speed configuration for interfaces of type 'ADSL' and 'VDSL2'. Syntax: --map-speed-dsl=interface-src-name,interface-dsl-name E.g: --map-speed-dsl=Et0.835,Et0-vdsl2 | +| --force-counters64 | Force to use 64 bits counters only. Can be used to improve performance. | +| --force-counters32 | Force to use 32-bit counters (even with SNMP versions 2c and 3). To use when 64 bits counters are buggy. | +| --reload-cache-time | Time in minutes before reloading cache file (default: 180). | +| --oid-filter | Define the OID to be used to filter interfaces (default: ifName) (values: ifDesc, ifAlias, ifName, IpAddr). | +| --oid-display | Define the OID that will be used to name the interfaces (default: ifName) (values: ifDesc, ifAlias, ifName, IpAddr). | +| --oid-extra-display | Add an OID to display. | +| --display-transform-src --display-transform-dst | Modify the interface name displayed by using a regular expression. Example: adding --display-transform-src='eth' --display-transform-dst='ens' will replace all occurrences of 'eth' with 'ens' | +| --show-cache | Display cache interface data. | +| --no-cache-lock | Set to disable locking when accessing cache. | diff --git a/i18n/fr/docusaurus-plugin-content-docs-pp/current/integrations/plugin-packs/procedures/network-ubiquiti-unifi-snmp.md b/i18n/fr/docusaurus-plugin-content-docs-pp/current/integrations/plugin-packs/procedures/network-ubiquiti-unifi-snmp.md index 2a3527c19285..57ecd5f85b67 100644 --- a/i18n/fr/docusaurus-plugin-content-docs-pp/current/integrations/plugin-packs/procedures/network-ubiquiti-unifi-snmp.md +++ b/i18n/fr/docusaurus-plugin-content-docs-pp/current/integrations/plugin-packs/procedures/network-ubiquiti-unifi-snmp.md @@ -5,6 +5,12 @@ title: Ubiquiti UniFi SNMP import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; +## Dépendances du connecteur de supervision + +Les connecteurs de supervision suivants sont automatiquement installés lors de l'installation du connecteur **Ubiquiti UniFi SNMP** +depuis la page **Configuration > Connecteurs > Connecteurs de supervision** : +* [Base Pack](./base-generic.md) + ## Contenu du pack ### Modèles @@ -21,12 +27,12 @@ Le connecteur apporte les modèles de service suivants | Alias | Modèle de service | Description | |:----------------------|:----------------------------------------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| Cpu | Net-Ubiquiti-Unifi-Cpu-SNMP-custom | Contrôle du taux d'utilisation détaillé CPU de l'équipement. Ce contrôle pourra remonter la moyenne du taux d'utilisation des CPU ainsi que le taux par CPU pour les CPU multi-coeur | +| Cpu | Net-Ubiquiti-Unifi-Cpu-SNMP-custom | Contrôle du taux d'utilisation détaillé CPU de l'equipement. Ce contrôle pourra remonter la moyenne du taux d'utilisation des CPU ainsi que le taux par CPU pour les CPU multi-coeur | | Load | Net-Ubiquiti-Unifi-Load-SNMP-custom | Contrôle de la charge serveur | -| Memory | Net-Ubiquiti-Unifi-Memory-SNMP-custom | Contrôle du taux d'utilisation de la mémoire vive | -| Swap | Net-Ubiquiti-Unifi-Swap-SNMP-custom | Contrôle du taux d'utilisation de la mémoire virtuelle | +| Memory | Net-Ubiquiti-Unifi-Memory-SNMP-custom | Contrôle du taux d'utilisation de la mémoire vive (RAM) | +| Swap | Net-Ubiquiti-Unifi-Swap-SNMP-custom | Contrôle du taux d'utilisation de la mémoire virtuelle (SWAP) | | Uptime | Net-Ubiquiti-Unifi-Uptime-SNMP-custom | Durée depuis laquelle le serveur tourne sans interruption | -| Virtual-Access-Points | Net-Ubiquiti-Unifi-Virtual-Access-Point-SNMP-custom | Contrôle les points d'accès virtuels | +| Virtual-Access-Points | Net-Ubiquiti-Unifi-Virtual-Access-Point-SNMP-custom | Contrôle les points d'accès virtuel | > Les services listés ci-dessus sont créés automatiquement lorsque le modèle d'hôte **Net-Ubiquiti-Unifi-SNMP-custom** est utilisé. @@ -36,7 +42,7 @@ Le connecteur apporte les modèles de service suivants | Alias | Modèle de service | Description | Découverte | |:-----------|:------------------------------------------|:-----------------------------------|:----------:| | Disks | Net-Ubiquiti-Unifi-Disks-SNMP-custom | Contrôle l'utilisation des disques | | -| Interfaces | Net-Ubiquiti-Unifi-Interfaces-SNMP-custom | Contrôle les interfaces | X | +| Interfaces | Net-Ubiquiti-Unifi-Interfaces-SNMP-custom | Contrôle les interfaces | X | > Les services listés ci-dessus ne sont pas créés automatiquement lorsqu'un modèle d'hôte est appliqué. Pour les utiliser, [créez un service manuellement](/docs/monitoring/basic-objects/services) et appliquez le modèle de service souhaité. @@ -49,29 +55,29 @@ Le connecteur apporte les modèles de service suivants #### Découverte d'hôtes -| Nom de la règle | Description | -|:----------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| SNMP Agents | Discover your resources through an SNMP subnet scan. You need to install the [Generic SNMP](./applications-protocol-snmp.md) connector to get the discovery rule and create a template mapper for the **Net-Ubiquiti-Unifi-SNMP-custom** host template | +| Nom de la règle | Description | +|:----------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| SNMP Agents | Découvre les ressources via un scan réseau SNMP. Installez le connecteur [Generic SNMP](./applications-protocol-snmp.md) pour obtenir la règle de découverte et créez un modificateur pour le modèle d'hôte **Net-Ubiquiti-Unifi-SNMP-custom**. | Rendez-vous sur la [documentation dédiée](/docs/monitoring/discovery/hosts-discovery) pour en savoir plus sur la découverte automatique d'hôtes. #### Découverte de services -| Nom de la règle | Description | -|:---------------------------------------|:------------------------------------------------------------------------| -| Net-Ubiquiti-Unifi-SNMP-Interface-Name | Découvre les interfaces réseau et supervise le statut et l'utilisation | +| Nom de la règle | Description | +|:---------------------------------------|:--------------------------------------------------------------------------------------------------| +| Net-Ubiquiti-Unifi-SNMP-Interface-Name | Découvre les interfaces réseau en utilisant leur nom et supervise leur statut et leur utilisation | Rendez-vous sur la [documentation dédiée](/docs/monitoring/discovery/services-discovery) pour en savoir plus sur la découverte automatique de services et sa [planification](/docs/monitoring/discovery/services-discovery/#règles-de-découverte). ### Métriques & statuts collectés -Voici le tableau des services pour ce connecteur, détaillant les métriques rattachées à chaque service. +Voici le tableau des services pour ce connecteur, détaillant les métriques et statuts rattachés à chaque service. -| Métrique | Unité | +| Nom | Unité | |:-------------------------------------|:------| | cpu.user.utilization.percentage | % | | cpu.nice.utilization.percentage | % | @@ -90,7 +96,7 @@ Voici le tableau des services pour ce connecteur, détaillant les métriques rat -| Métrique | Unité | +| Nom | Unité | |:--------------------------------------------|:------| | storage.partitions.count | count | | *disk_name*#storage.space.usage.bytes | B | @@ -103,16 +109,16 @@ Voici le tableau des services pour ce connecteur, détaillant les métriques rat -| Métrique | Unité | +| Nom | Unité | |:-----------------------------------------------------|:------| -| *interface_name*#status | N/A | +| status | N/A | | *interface_name*#interface.traffic.in.bitspersecond | b/s | | *interface_name*#interface.traffic.out.bitspersecond | b/s | -| Métrique | Unité | +| Nom | Unité | |:-----------------------|:------| | load.1m.average.count | count | | load.5m.average.count | count | @@ -124,7 +130,7 @@ Voici le tableau des services pour ce connecteur, détaillant les métriques rat -| Métrique | Unité | +| Nom | Unité | |:------------------------|:------| | memory.usage.bytes | B | | memory.free.bytes | B | @@ -141,7 +147,7 @@ Voici le tableau des services pour ce connecteur, détaillant les métriques rat -| Métrique | Unité | +| Nom | Unité | |:----------------------|:------| | swap.usage.bytes | B | | swap.free.bytes | B | @@ -152,7 +158,7 @@ Voici le tableau des services pour ce connecteur, détaillant les métriques rat -| Métrique | Unité | +| Nom | Unité | |:----------------------|:------| | system.uptime.seconds | s | @@ -161,11 +167,11 @@ Voici le tableau des services pour ce connecteur, détaillant les métriques rat -| Métrique | Unité | +| Nom | Unité | |:------------------------------------------------------|:------| | virtual_access_points.total.count | count | | virtual_access_points.clients.connected.count | count | -| *vaps*#status | N/A | +| status | N/A | | *vaps*#virtual_access_point.clients.connected.count | count | | *vaps*#virtual_access_point.traffic.in.bitspersecond | b/s | | *vaps*#virtual_access_point.traffic.out.bitspersecond | b/s | @@ -175,9 +181,16 @@ Voici le tableau des services pour ce connecteur, détaillant les métriques rat ## Prérequis -Afin de contrôler votre équipement Ubiquiti UniFi, le SNMP doit être configuré. +### Configuration SNMP + +L'agent SNMP doit être activé et configuré sur l'équipement. +Veuillez vous référer à la documentation officielle. +Il se peut que votre équipement nécessite qu'une liste d'adresses autorisées à l'interroger soit paramétrée. +Veillez à ce que les adresses des collecteurs Centreon y figurent bien. -Le flux SNMP UDP/161 doit être ouvert entre le Collecteur et l'équipement. +### Flux réseau + +La communication doit être possible sur le port UDP 161 depuis le collecteur Centreon vers la ressource supervisée. ## Installer le connecteur de supervision @@ -275,12 +288,14 @@ yum install centreon-plugin-Network-Ubiquiti-Unifi-Snmp 2. Complétez les champs **Nom**, **Alias** & **IP Address/DNS** correspondant à votre ressource. 3. Appliquez le modèle d'hôte **Net-Ubiquiti-Unifi-SNMP-custom**. -> Si vous utilisez SNMP en version 3, vous devez configurer les paramètres spécifiques associés via la macro **SNMPEXTRAOPTIONS**. -> Plus d'informations dans la section [Troubleshooting SNMP](../getting-started/how-to-guides/troubleshooting-plugins.md#mapping-des-options-snmpv3). - -| Macro | Description | Valeur par défaut | Obligatoire | -|:-----------------|:-----------------------------------------------------------------------------------------------------|:------------------|:-----------:| -| SNMPEXTRAOPTIONS | Any extra option you may want to add to every command (a --verbose flag for example). Toutes les options sont listées [ici](#options-disponibles). | | | +| Macro | Description | Valeur par défaut | Obligatoire | +|:------------------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------|:------------------|:-----------:| +| SNMP_V3_USERNAME | SNMP v3 only: User name (`securityName`) | | | +| SNMP_V3_AUTH_PROTOCOL | SNMP v3 only: Authentication protocol: MD5\|SHA. Since net-snmp 5.9.1: SHA224\|SHA256\|SHA384\|SHA512 | | | +| SNMP_V3_PRIV_PROTOCOL | 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 | | | +| SNMP_V3_AUTH_PASSPHRASE | SNMP v3 only: Pass phrase hashed using the authentication protocol defined in the --authprotocol option | | | +| SNMP_V3_PRIV_PASSPHRASE | SNMP v3 only: Privacy pass phrase (`privPassword`) to encrypt messages using the protocol defined in the --privprotocol option | | | +| SNMPEXTRAOPTIONS | Any extra option you may want to add to every command (a --verbose flag for example). Toutes les options sont listées [ici](#options-disponibles). | | | 4. [Déployez la configuration](/docs/monitoring/monitoring-servers/deploying-a-configuration). L'hôte apparaît dans la liste des hôtes supervisés, et dans la page **Statut des ressources**. La commande envoyée par le connecteur est indiquée dans le panneau de détails de l'hôte : celle-ci montre les valeurs des macros. @@ -292,132 +307,133 @@ yum install centreon-plugin-Network-Ubiquiti-Unifi-Snmp -| Macro | Description | Valeur par défaut | Obligatoire | -|:------------------|:---------------------------------------------------------------------------------------------------|:-----------------------------|:-----------:| -| WARNINGGUEST | Warning threshold in percent | | | -| CRITICALGUEST | Critical threshold in percent | | | -| WARNINGGUESTNICE | Warning threshold in percent | | | -| CRITICALGUESTNICE | Critical threshold in percent | | | -| WARNINGIDLE | Warning threshold in percent | | | -| CRITICALIDLE | Critical threshold in percent | | | -| WARNINGINTERRUPT | Warning threshold in percent | | | -| CRITICALINTERRUPT | Critical threshold in percent | | | -| WARNINGKERNEL | Warning threshold in percent | | | -| CRITICALKERNEL | Critical threshold in percent | | | -| WARNINGNICE | Warning threshold in percent | | | -| CRITICALNICE | Critical threshold in percent | | | -| WARNINGSOFTIRQ | Warning threshold in percent | | | -| CRITICALSOFTIRQ | Critical threshold in percent | | | -| CRITICALSTEAL | Critical threshold in percent | | | -| WARNINGSTREAL | Warning threshold in percent | | | -| WARNINGSYSTEM | Warning threshold in percent | | | -| CRITICALSYSTEM | Critical threshold in percent | | | -| WARNINGUSER | Warning threshold in percent | | | -| CRITICALUSER | Critical threshold in percent | | | -| WARNINGWAIT | Warning threshold in percent | | | -| CRITICALWAIT | Critical threshold in percent | | | +| Macro | Description | Valeur par défaut | Obligatoire | +|:------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------|:-----------------------------|:-----------:| +| WARNINGGUEST | Threshold in percentage | | | +| CRITICALGUEST | Threshold in percentage | | | +| WARNINGGUESTNICE | Threshold in percentage | | | +| CRITICALGUESTNICE | Threshold in percentage | | | +| WARNINGIDLE | Threshold in percentage | | | +| CRITICALIDLE | Threshold in percentage | | | +| WARNINGINTERRUPT | Threshold in percentage | | | +| CRITICALINTERRUPT | Threshold in percentage | | | +| WARNINGKERNEL | Threshold in percentage | | | +| CRITICALKERNEL | Threshold in percentage | | | +| WARNINGNICE | Threshold in percentage | | | +| CRITICALNICE | Threshold in percentage | | | +| WARNINGSOFTIRQ | Threshold in percentage | | | +| CRITICALSOFTIRQ | Threshold in percentage | | | +| CRITICALSTEAL | Threshold in percentage | | | +| WARNINGSTREAL | Threshold in percentage | | | +| WARNINGSYSTEM | Threshold in percentage | | | +| CRITICALSYSTEM | Threshold in percentage | | | +| WARNINGUSER | Threshold in percentage | | | +| CRITICALUSER | Threshold in percentage | | | +| WARNINGWAIT | Threshold in percentage | | | +| CRITICALWAIT | Threshold in percentage | | | | EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). Toutes les options sont listées [ici](#options-disponibles). | --verbose --use-new-perfdata | | -| Macro | Description | Valeur par défaut | Obligatoire | -|:------------------|:---------------------------------------------------------------------------------------------------|:-----------------------------|:-----------:| -| DISKPATH | Filter disks according to their path | | | -| DISKDEVICE | Filter disks according to their device name | | | -| WARNINGCOUNT | Thresholds ( | | | -| CRITICALCOUNT | Thresholds ( | | | -| WARNINGFREE | Thresholds ( | | | -| CRITICALFREE | Thresholds ( | | | -| WARNINGINODES | Thresholds ( | | | -| CRITICALINODES | Thresholds ( | | | -| WARNINGUSAGE | Thresholds ( | | | -| CRITICALUSAGE | Thresholds ( | | | -| WARNINGUSAGEPRCT | Thresholds ( | | | -| CRITICALUSAGEPRCT | Thresholds ( | | | +| Macro | Description | Valeur par défaut | Obligatoire | +|:------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------|:-----------------------------|:-----------:| +| DISKPATH | Filter disks according to their path | | | +| DISKDEVICE | Filter disks according to their device name | | | +| WARNINGCOUNT | Threshold | | | +| CRITICALCOUNT | Threshold | | | +| WARNINGFREE | Threshold | | | +| CRITICALFREE | Threshold | | | +| WARNINGINODES | Threshold | | | +| CRITICALINODES | Threshold | | | +| WARNINGUSAGE | Threshold | | | +| CRITICALUSAGE | Threshold | | | +| WARNINGUSAGEPRCT | Threshold | | | +| CRITICALUSAGEPRCT | Threshold | | | | EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). Toutes les options sont listées [ici](#options-disponibles). | --verbose --use-new-perfdata | | -| Macro | Description | Valeur par défaut | Obligatoire | -|:-------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:------------------------------------------------------|:-----------:| -| OIDFILTER | Define the OID to be used to filter interfaces (default: ifName) (values: ifDesc, ifAlias, ifName, IpAddr) | ifname | | -| OIDDISPLAY | Define the OID that will be used to name the interfaces (default: ifName) (values: ifDesc, ifAlias, ifName, IpAddr) | ifname | | -| INTERFACENAME | Set the interface (number expected) example: 1,2,... (empty means 'check all interfaces') | | | -| WARNINGINDISCARD | Thresholds | | | -| CRITICALINDISCARD | Thresholds | | | -| WARNINGINERROR | Thresholds | | | -| CRITICALINERROR | Thresholds | | | -| WARNINGINTRAFFIC | Thresholds | | | -| CRITICALINTRAFFIC | Thresholds | | | -| WARNINGOUTDISCARD | Thresholds | | | -| CRITICALOUTDISCARD | Thresholds | | | -| WARNINGOUTERROR | Thresholds | | | -| CRITICALOUTERROR | Thresholds | | | -| WARNINGOUTTRAFFIC | Thresholds | | | -| CRITICALOUTTRAFFIC | Thresholds | | | -| CRITICALSTATUS | Define the conditions to match for the status to be CRITICAL (default: '%\{admstatus\} eq "up" and %\{opstatus\} ne "up"'). You can use the following variables: %\{admstatus\}, %\{opstatus\}, %\{duplexstatus\}, %\{display\} | %\{admstatus\} eq "up" and %\{opstatus\} !~ /up\|dormant/ | | -| WARNINGSTATUS | Define the conditions to match for the status to be WARNING. You can use the following variables: %\{admstatus\}, %\{opstatus\}, %\{duplexstatus\}, %\{display\} | | | -| EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). Toutes les options sont listées [ici](#options-disponibles). | --verbose --use-new-perfdata | | +| Macro | Description | Valeur par défaut | Obligatoire | +|:-------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------|:----------------------------------------------------------|:-----------:| +| OIDFILTER | Define the OID to be used to filter interfaces (values: ifDesc, ifAlias, ifName, IpAddr) | ifname | | +| OIDDISPLAY | Define the OID that will be used to name the interfaces (values: ifDesc, ifAlias, ifName, IpAddr) | ifname | | +| INTERFACENAME | Check only the interfaces with the specified IDs (OID indexes, e.g.: 1,2,...). If empty, all interfaces will be monitored. To filter on interface names, see --name | | | +| WARNINGINDISCARD | Thresholds | | | +| CRITICALINDISCARD | Thresholds | | | +| WARNINGINERROR | Thresholds | | | +| CRITICALINERROR | Thresholds | | | +| WARNINGINTRAFFIC | Thresholds | | | +| CRITICALINTRAFFIC | Thresholds | | | +| WARNINGOUTDISCARD | Thresholds | | | +| CRITICALOUTDISCARD | Thresholds | | | +| WARNINGOUTERROR | Thresholds | | | +| CRITICALOUTERROR | Thresholds | | | +| WARNINGOUTTRAFFIC | Thresholds | | | +| CRITICALOUTTRAFFIC | Thresholds | | | +| CRITICALSTATUS | Define the conditions to match for the status to be CRITICAL. You can use the following variables: %\{admstatus\}, %\{opstatus\}, %\{duplexstatus\}, %\{display\} | %\{admstatus\} eq "up" and %\{opstatus\} !~ /up\|dormant/ | | +| WARNINGSTATUS | Define the conditions to match for the status to be WARNING. You can use the following variables: %\{admstatus\}, %\{opstatus\}, %\{duplexstatus\}, %\{display\} | | | +| EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). Toutes les options sont listées [ici](#options-disponibles). | --verbose --use-new-perfdata | | -| Macro | Description | Valeur par défaut | Obligatoire | -|:-------------|:---------------------------------------------------------------------------------------------------|:-------------------|:-----------:| -| WARNING | Warning threshold (1min,5min,15min) | | | -| CRITICAL | Critical threshold (1min,5min,15min) | | | +| Macro | Description | Valeur par défaut | Obligatoire | +|:-------------|:-------------------------------------------------------------------------------------------------------------------------------------------------|:-------------------|:-----------:| +| WARNING | Warning threshold (1min,5min,15min) | | | +| CRITICAL | Critical threshold (1min,5min,15min) | | | | EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). Toutes les options sont listées [ici](#options-disponibles). | --use-new-perfdata | | -| Macro | Description | Valeur par défaut | Obligatoire | -|:-------------|:---------------------------------------------------------------------------------------------------|:-------------------|:-----------:| -| WARNING | Thresholds | | | -| CRITICAL | Thresholds | | | +| Macro | Description | Valeur par défaut | Obligatoire | +|:-------------|:-------------------------------------------------------------------------------------------------------------------------------------------------|:-------------------|:-----------:| +| WARNING | Threshold in bytes | | | +| CRITICAL | Threshold in bytes | | | | EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). Toutes les options sont listées [ici](#options-disponibles). | --use-new-perfdata | | -| Macro | Description | Valeur par défaut | Obligatoire | -|:-------------|:---------------------------------------------------------------------------------------------------|:-------------------|:-----------:| -| WARNING | Thresholds | | | -| CRITICAL | Thresholds | | | +| Macro | Description | Valeur par défaut | Obligatoire | +|:-------------|:-------------------------------------------------------------------------------------------------------------------------------------------------|:-------------------|:-----------:| +| WARNING | Threshold in percentage | | | +| CRITICAL | Threshold in percentage | | | | EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). Toutes les options sont listées [ici](#options-disponibles). | --use-new-perfdata | | -| Macro | Description | Valeur par défaut | Obligatoire | -|:-------------|:---------------------------------------------------------------------------------------------------|:-------------------|:-----------:| -| WARNING | Warning threshold | | | -| CRITICAL | Critical threshold | | | -| EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). Toutes les options sont listées [ici](#options-disponibles). | --use-new-perfdata | | +| Macro | Description | Valeur par défaut | Obligatoire | +|:-------------|:-------------------------------------------------------------------------------------------------------------------------------------------------|:------------------------------------|:-----------:| +| UNIT | Select the time unit for thresholds. May be 's' for seconds, 'm' for minutes, 'h' for hours, 'd' for days, 'w' for weeks. Default is seconds | | | +| WARNING | Warning threshold | | | +| CRITICAL | Critical threshold | | | +| EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). Toutes les options sont listées [ici](#options-disponibles). | --use-new-perfdata --check-overload | | -| Macro | Description | Valeur par défaut | Obligatoire | -|:------------------------------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------|:--------------------|:-----------:| -| FILTERAPNAME | Filter virtual access points by name (can be a regexp) | | | -| FILTERAPSSID | Filter virtual access points by SSID (can be a regexp) | | | -| UNKNOWNSTATUS | Define the conditions to match for the status to be UNKNOWN. You can use the following variables: %\{name\}, %\{ssid\}, %\{status\} | | | -| WARNINGCLIENTSCONNECTED | Thresholds | | | -| CRITICALCLIENTSCONNECTED | Thresholds | | | -| CRITICALSTATUS | Define the conditions to match for the status to be CRITICAL (default: '%\{status\} eq "down"'). You can use the following variables: %\{name\}, %\{ssid\}, %\{status\} | %\{status\} eq "down" | | -| WARNINGSTATUS | Define the conditions to match for the status to be WARNING. You can use the following variables: %\{name\}, %\{ssid\}, %\{status\} | | | -| WARNINGTOTAL | Thresholds | | | -| CRITICALTOTAL | Thresholds | | | -| WARNINGTOTALCLIENTSCONNECTED | Thresholds | | | -| CRITICALTOTALCLIENTSCONNECTED | Thresholds | | | -| WARNINGTRAFFICIN | Thresholds | | | -| CRITICALTRAFFICIN | Thresholds | | | -| WARNINGTRAFFICOUT | Thresholds | | | -| CRITICALTRAFFICOUT | Thresholds | | | -| EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). Toutes les options sont listées [ici](#options-disponibles). | --verbose | | +| Macro | Description | Valeur par défaut | Obligatoire | +|:------------------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------|:----------------------|:-----------:| +| FILTERAPNAME | Filter virtual access points by name (can be a regexp) | | | +| FILTERAPSSID | Filter virtual access points by SSID (can be a regexp) | | | +| UNKNOWNSTATUS | Define the conditions to match for the status to be UNKNOWN. You can use the following variables: %\{name\}, %\{ssid\}, %\{status\} | | | +| WARNINGCLIENTSCONNECTED | Threshold | | | +| CRITICALCLIENTSCONNECTED | Threshold | | | +| CRITICALSTATUS | Define the conditions to match for the status to be CRITICAL. You can use the following variables: %\{name\}, %\{ssid\}, %\{status\} | %\{status\} eq "down" | | +| WARNINGSTATUS | Define the conditions to match for the status to be WARNING. You can use the following variables: %\{name\}, %\{ssid\}, %\{status\} | | | +| WARNINGTOTAL | Threshold | | | +| CRITICALTOTAL | Threshold | | | +| WARNINGTOTALCLIENTSCONNECTED | Threshold | | | +| CRITICALTOTALCLIENTSCONNECTED | Threshold | | | +| 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). Toutes les options sont listées [ici](#options-disponibles). | --verbose | | @@ -438,7 +454,12 @@ telle que celle-ci (remplacez les valeurs d'exemple par les vôtres) : --mode=virtual-access-points \ --hostname=10.0.0.1 \ --snmp-version='2c' \ - --snmp-community='my-snmp-community' \ + --snmp-community='my-snmp-community' \ + --snmp-username='username' \ + --authpassphrase='' \ + --authprotocol='' \ + --privpassphrase='' \ + --privprotocol='' \ --filter-name='' \ --filter-ssid='' \ --unknown-status='' \ @@ -460,7 +481,7 @@ telle que celle-ci (remplacez les valeurs d'exemple par les vôtres) : La commande devrait retourner un message de sortie similaire à : ```bash -OK: total: 23 clients connected: 50 All virtual access points are ok | 'virtual_access_points.total.count'=23;;;0;'virtual_access_points.clients.connected.count'=50;;;0;'*vaps*#virtual_access_point.clients.connected.count'=;;;0;'*vaps*#virtual_access_point.traffic.in.bitspersecond'=b/s;;;0;'*vaps*#virtual_access_point.traffic.out.bitspersecond'=b/s;;;0; +OK: total: 17585 clients connected: 98875 All virtual access points are ok | 'virtual_access_points.total.count'=17585;;;0; 'virtual_access_points.clients.connected.count'=98875;;;0; 'vaps1#virtual_access_point.clients.connected.count'=74864;;;0; 'vaps2#virtual_access_point.clients.connected.count'=3636;;;0; 'vaps1#virtual_access_point.traffic.in.bitspersecond'=56436b/s;;;0; 'vaps2#virtual_access_point.traffic.in.bitspersecond'=15056b/s;;;0; 'vaps1#virtual_access_point.traffic.out.bitspersecond'=82191b/s;;;0; 'vaps2#virtual_access_point.traffic.out.bitspersecond'=19910b/s;;;0; ``` ### Diagnostic des erreurs communes @@ -491,8 +512,8 @@ Le plugin apporte les modes suivants : | cpu [[code](https://github.com/centreon/centreon-plugins/blob/develop/src/snmp_standard/mode/cpudetailed.pm)] | Net-Ubiquiti-Unifi-Cpu-SNMP-custom | | disks [[code](https://github.com/centreon/centreon-plugins/blob/develop/src/snmp_standard/mode/diskusage.pm)] | Net-Ubiquiti-Unifi-Disks-SNMP-custom | | interfaces [[code](https://github.com/centreon/centreon-plugins/blob/develop/src/snmp_standard/mode/interfaces.pm)] | Net-Ubiquiti-Unifi-Interfaces-SNMP-custom | -| list-interfaces [[code](https://github.com/centreon/centreon-plugins/blob/develop/src/snmp_standard/mode/listinterfaces.pm)] | Used for service discovery | -| list-virtual-access-points [[code](https://github.com/centreon/centreon-plugins/blob/develop/src/network/ubiquiti/unifi/snmp/mode/listvirtualaccesspoints.pm)] | Not used in this Monitoring Connector | +| list-interfaces [[code](https://github.com/centreon/centreon-plugins/blob/develop/src/snmp_standard/mode/listinterfaces.pm)] | Utilisé pour la découverte de services | +| list-virtual-access-points [[code](https://github.com/centreon/centreon-plugins/blob/develop/src/network/ubiquiti/unifi/snmp/mode/listvirtualaccesspoints.pm)] | Non utilisé dans ce connecteur de supervision | | load [[code](https://github.com/centreon/centreon-plugins/blob/develop/src/snmp_standard/mode/loadaverage.pm)] | Net-Ubiquiti-Unifi-Load-SNMP-custom | | memory [[code](https://github.com/centreon/centreon-plugins/blob/develop/src/snmp_standard/mode/memory.pm)] | Net-Ubiquiti-Unifi-Memory-SNMP-custom | | swap [[code](https://github.com/centreon/centreon-plugins/blob/develop/src/snmp_standard/mode/swap.pm)] | Net-Ubiquiti-Unifi-Swap-SNMP-custom | @@ -505,61 +526,67 @@ Le plugin apporte les modes suivants : Les options génériques sont listées ci-dessous : -| 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. | -| --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\[,\[newuom\],\[min\],\[m ax\]\] Common examples: 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()' | -| --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,namesofnewmetrics,calculation\[,\[ne wuom\],\[min\],\[max\]\] regex: regular expression namesofnewmetrics: 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 newuom (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: 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(traf fic\_(in\|out)\_$1)' | -| --change-short-output --change-long-output | Modify the short/long output that is returned by the plugin. Syntax: --change-short-output=pattern~replacement~modifier Most commonly used modifiers are i (case insensitive) and g (replace all occurrences). Example: adding --change-short-output='OK\~Up\~gi' will replace all occurrences of 'OK', 'ok', 'Ok' or 'oK' with 'Up' | -| --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. | -| --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). E.g.: --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'. | -| --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 ok, 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. | +| 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 get-next 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 ok, 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. | +| --show-password | By default, sensitive information in command lines is hidden in debug output and replaced with `***` (however, debug logs may still display sensitive information). Using the C option will display the passwords in plain text. | +| --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\[,\[\\],\[min\],\[max\]\] Common examples: onvert 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\[,\[\\],\[min\],\[max\]\] Common examples: onvert 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\[,\[\\],\[min\],\[max\]\] Common examples: onvert 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,\,calculation\[,\[\\],\[min\],\[max\]\] regex: regular expression \: 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 \ (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: um 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~replacement~modifier Most commonly used modifiers are i (case insensitive) and g (replace all occurrences). Example: adding --change-short-output='OK~Up~gi' will replace all occurrences of 'OK', 'ok', 'Ok' or 'oK' with 'Up' | +| --change-short-output | Modify the short/long output that is returned by the plugin. Syntax: --change-short-output=pattern~replacement~modifier Most commonly used modifiers are i (case insensitive) and g (replace all occurrences). Example: adding --change-short-output='OK~Up~gi' will replace all occurrences of 'OK', 'ok', 'Ok' or 'oK' with 'Up' | +| --change-long-output | Modify the short/long output that is returned by the plugin. Syntax: --change-short-output=pattern~replacement~modifier Most commonly used modifiers are i (case insensitive) and g (replace all occurrences). Example: adding --change-short-output='OK~Up~gi' will replace all occurrences of 'OK', 'ok', 'Ok' or 'oK' with 'Up' | +| --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'. \. | #### Options des modes @@ -568,177 +595,252 @@ Les options disponibles pour chaque modèle de services sont listées ci-dessous -| Option | Description | -|:-----------------------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| --memcached | Memcached server to use (only one server). | -| --redis-server | Redis server to use (only one server). Syntax: address\[:port\] | -| --redis-attribute | Set Redis Options (--redis-attribute="cnx\_timeout=5"). | -| --redis-db | Set Redis database index. | -| --failback-file | Failback on a local file if Redis connection fails. | -| --memexpiration | Time to keep data in seconds (default: 86400). | -| --statefile-dir | Define the cache directory (default: '/var/lib/centreon/centplugins'). | -| --statefile-suffix | Define a suffix to customize the statefile name (default: ''). | -| --statefile-concat-cwd | If used with the '--statefile-dir' option, the latter's value will be used as a sub-directory of the current working directory. Useful on Windows when the plugin is compiled, as the file system and permissions are different from Linux. | -| --statefile-format | Define the format used to store the cache. Available formats: 'dumper', 'storable', 'json' (default). | -| --statefile-key | Define the key to encrypt/decrypt the cache. | -| --statefile-cipher | Define the cipher algorithm to encrypt the cache (default: 'AES'). | -| --warning-* | Warning threshold in percent. Can be: 'user', 'nice', 'system', 'idle', 'wait', 'kernel', 'interrupt', 'softirq', 'steal', 'guest', 'guestnice'. | -| --critical-* | Critical threshold in percent. Can be: 'user', 'nice', 'system', 'idle', 'wait', 'kernel', 'interrupt', 'softirq', 'steal', 'guest', 'guestnice'. | +| Option | Description | +|:---------------------|:--------------------------------------------------------------------------------------------------------------------------| +| --filter-counters | Only display some counters (regexp can be used). Example to check SSL connections only : --filter-counters='^xxxx\|yyyy$' | +| --warning-xxx | Warning threshold. | +| --critical-xxx | Critical threshold. | +| --warning-guest | Threshold in percentage. | +| --critical-guest | Threshold in percentage. | +| --warning-guestnice | Threshold in percentage. | +| --critical-guestnice | Threshold in percentage. | +| --warning-idle | Threshold in percentage. | +| --critical-idle | Threshold in percentage. | +| --warning-interrupt | Threshold in percentage. | +| --critical-interrupt | Threshold in percentage. | +| --warning-kernel | Threshold in percentage. | +| --critical-kernel | Threshold in percentage. | +| --warning-nice | Threshold in percentage. | +| --critical-nice | Threshold in percentage. | +| --warning-softirq | Threshold in percentage. | +| --critical-softirq | Threshold in percentage. | +| --warning-steal | Threshold in percentage. | +| --critical-steal | Threshold in percentage. | +| --warning-system | Threshold in percentage. | +| --critical-system | Threshold in percentage. | +| --warning-user | Threshold in percentage. | +| --critical-user | Threshold in percentage. | +| --warning-wait | Threshold in percentage. | +| --critical-wait | Threshold in percentage. | -| Option | Description | -|:------------------------------------------------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| --memcached | Memcached server to use (only one server). | -| --redis-server | Redis server to use (only one server). Syntax: address\[:port\] | -| --redis-attribute | Set Redis Options (--redis-attribute="cnx\_timeout=5"). | -| --redis-db | Set Redis database index. | -| --failback-file | Failback on a local file if Redis connection fails. | -| --memexpiration | Time to keep data in seconds (default: 86400). | -| --statefile-dir | Define the cache directory (default: '/var/lib/centreon/centplugins'). | -| --statefile-suffix | Define a suffix to customize the statefile name (default: ''). | -| --statefile-concat-cwd | If used with the '--statefile-dir' option, the latter's value will be used as a sub-directory of the current working directory. Useful on Windows when the plugin is compiled, as the file system and permissions are different from Linux. | -| --statefile-format | Define the format used to store the cache. Available formats: 'dumper', 'storable', 'json' (default). | -| --statefile-key | Define the key to encrypt/decrypt the cache. | -| --statefile-cipher | Define the cipher algorithm to encrypt the cache (default: 'AES'). | -| --filter-counters | Filter counters to be displayed (can be: 'usage', 'count', 'inodes'). | -| --disk-index | Choose disk according to the index. | -| --filter-disk-path | Filter disks according to their path. | -| --filter-disk-device | Filter disks according to their device name. | -| --reload-cache-time | Time in minutes before reloading cache file (default: 180). | -| --display-transform-src --display-transform-dst | Modify the disk name displayed by using a regular expression. Example: adding --display-transform-src='dev' --display-transform-dst='run' will replace all occurrences of 'dev' with 'run' | -| --show-cache | Display cache disk path data. | -| --space-reservation | Some filesystem has space reserved (like ext4 for root). The value is in percent of total (default: none) (results like 'df' command). | -| --force-use-mib-percent | Can be used if you have counters overload by big disks. | -| --force-counters32 | Force to use 32 bits counters. Should be used when 64 bits high/low components are not available. | -| --warning-* --critical-* | Thresholds (can be: 'usage', 'usage-free', 'usage-prct', 'inodes', 'count'). | +| Option | Description | +|:------------------------------------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| --filter-counters | Filter counters to be displayed (can be: 'usage', 'count', 'inodes'). | +| --warning-xxx | Warning threshold. | +| --critical-xxx | Critical threshold. | +| --memcached | Memcached server to use (only one server). | +| --redis-server | Redis server to use (only one server). Syntax: address\[:port\] | +| --redis-attribute | Set Redis Options (--redis-attribute="cnx\_timeout=5"). | +| --redis-db | Set Redis database index. | +| --failback-file | Fall back on a local file if Redis connection fails. | +| --memexpiration | Time to keep data in seconds (default: 86400). | +| --statefile-dir | Define the cache directory (default: '/var/lib/centreon/centplugins'). | +| --statefile-suffix | Define a suffix to customize the statefile name (default: ''). | +| --statefile-concat-cwd | If used with the '--statefile-dir' option, the latter's value will be used as a sub-directory of the current working directory. Useful on Windows when the plugin is compiled, as the file system and permissions are different from Linux. | +| --statefile-format | Define the format used to store the cache. Available formats: 'dumper', 'storable', 'json' (default). | +| --statefile-key | Define the key to encrypt/decrypt the cache. | +| --statefile-cipher | Define the cipher algorithm to encrypt the cache (default: 'AES'). | +| --disk-index | Choose disk according to the index. | +| --filter-disk-path | Filter disks according to their path. | +| --filter-disk-device | Filter disks according to their device name. | +| --reload-cache-time | Time in minutes before reloading cache file (default: 180). | +| --display-transform-src --display-transform-dst | Modify the disk name displayed by using a regular expression. Example: adding --display-transform-src='dev' --display-transform-dst='run' will replace all occurrences of 'dev' with 'run' | +| --show-cache | Display cache disk path data. | +| --space-reservation | Some filesystem has space reserved (like ext4 for root). The value is in percent of total (default: none) (results like 'df' command). | +| --force-use-mib-percent | Can be used if you have counters overload by big disks. | +| --force-counters32 | Force to use 32 bits counters. Should be used when 64 bits high/low components are not available. | +| --warning-* --critical-* | Thresholds (can be: 'usage', 'usage-free', 'usage-prct', 'inodes', 'count'). | -| Option | Description | -|:------------------------------------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| --memcached | Memcached server to use (only one server). | -| --redis-server | Redis server to use (only one server). Syntax: address\[:port\] | -| --redis-attribute | Set Redis Options (--redis-attribute="cnx\_timeout=5"). | -| --redis-db | Set Redis database index. | -| --failback-file | Failback on a local file if Redis connection fails. | -| --memexpiration | Time to keep data in seconds (default: 86400). | -| --statefile-dir | Define the cache directory (default: '/var/lib/centreon/centplugins'). | -| --statefile-suffix | Define a suffix to customize the statefile name (default: ''). | -| --statefile-concat-cwd | If used with the '--statefile-dir' option, the latter's value will be used as a sub-directory of the current working directory. Useful on Windows when the plugin is compiled, as the file system and permissions are different from Linux. | -| --statefile-format | Define the format used to store the cache. Available formats: 'dumper', 'storable', 'json' (default). | -| --statefile-key | Define the key to encrypt/decrypt the cache. | -| --statefile-cipher | Define the cipher algorithm to encrypt the cache (default: 'AES'). | -| --add-global | Check global port statistics (by default if no --add-* option is set). | -| --add-status | Check interface status. | -| --add-duplex-status | Check duplex status (with --warning-status and --critical-status). | -| --add-traffic | Check interface traffic. | -| --add-errors | Check interface errors. | -| --add-cast | Check interface cast. | -| --add-speed | Check interface speed. | -| --add-volume | Check interface data volume between two checks (not supposed to be graphed, useful for BI reporting). | -| --check-metrics | If the expression is true, metrics are checked (default: '%\{opstatus\} eq "up"'). | -| --warning-status | Define the conditions to match for the status to be WARNING. You can use the following variables: %\{admstatus\}, %\{opstatus\}, %\{duplexstatus\}, %\{display\} | -| --critical-status | Define the conditions to match for the status to be CRITICAL (default: '%\{admstatus\} eq "up" and %\{opstatus\} ne "up"'). You can use the following variables: %\{admstatus\}, %\{opstatus\}, %\{duplexstatus\}, %\{display\} | -| --warning-* --critical-* | Thresholds. Can be: 'total-port', 'total-admin-up', 'total-admin-down', 'total-oper-up', 'total-oper-down', 'in-traffic', 'out-traffic', 'in-error', 'in-discard', 'out-error', 'out-discard', 'in-ucast', 'in-bcast', 'in-mcast', 'out-ucast', 'out-bcast', 'out-mcast', 'speed' (b/s). | -| --units-traffic | Units of thresholds for the traffic (default: 'percent\_delta') ('percent\_delta', 'bps', 'counter'). | -| --units-errors | Units of thresholds for errors/discards (default: 'percent\_delta') ('percent\_delta', 'percent', 'delta', 'deltaps', 'counter'). | -| --units-cast | Units of thresholds for communication types (default: 'percent\_delta') ('percent\_delta', 'percent', 'delta', 'deltaps', 'counter'). | -| --nagvis-perfdata | Display traffic perfdata to be compatible with nagvis widget. | -| --interface | Set the interface (number expected) example: 1,2,... (empty means 'check all interfaces'). | -| --name | Allows you to define the interface (in option --interface) byname instead of OID index. The name matching mode supports regular expressions. | -| --speed | Set interface speed for incoming/outgoing traffic (in Mb). | -| --speed-in | Set interface speed for incoming traffic (in Mb). | -| --speed-out | Set interface speed for outgoing traffic (in Mb). | -| --map-speed-dsl | Get interface speed configuration for interface type 'adsl' and 'vdsl2'. Syntax: --map-speed-dsl=interface-src-name,interface-dsl-name E.g: --map-speed-dsl=Et0.835,Et0-vdsl2 | -| --force-counters64 | Force to use 64 bits counters only. Can be used to improve performance. | -| --force-counters32 | Force to use 32 bits counters (even in snmp v2c and v3). Should be used when 64 bits counters are buggy. | -| --reload-cache-time | Time in minutes before reloading cache file (default: 180). | -| --oid-filter | Define the OID to be used to filter interfaces (default: ifName) (values: ifDesc, ifAlias, ifName, IpAddr). | -| --oid-display | Define the OID that will be used to name the interfaces (default: ifName) (values: ifDesc, ifAlias, ifName, IpAddr). | -| --oid-extra-display | Add an OID to display. | -| --display-transform-src --display-transform-dst | Modify the interface name displayed by using a regular expression. Example: adding --display-transform-src='eth' --display-transform-dst='ens' will replace all occurrences of 'eth' with 'ens' | -| --show-cache | Display cache interface data. | +| Option | Description | +|:------------------------------------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| --filter-counters | Only display some counters (regexp can be used). Example to check SSL connections only : --filter-counters='^xxxx\|yyyy$' | +| --warning-xxx | Warning threshold. | +| --critical-xxx | Critical threshold. | +| --memcached | Memcached server to use (only one server). | +| --redis-server | Redis server to use (only one server). Syntax: address\[:port\] | +| --redis-attribute | Set Redis Options (--redis-attribute="cnx\_timeout=5"). | +| --redis-db | Set Redis database index. | +| --failback-file | Fall back on a local file if Redis connection fails. | +| --memexpiration | Time to keep data in seconds (default: 86400). | +| --statefile-dir | Define the cache directory (default: '/var/lib/centreon/centplugins'). | +| --statefile-suffix | Define a suffix to customize the statefile name (default: ''). | +| --statefile-concat-cwd | If used with the '--statefile-dir' option, the latter's value will be used as a sub-directory of the current working directory. Useful on Windows when the plugin is compiled, as the file system and permissions are different from Linux. | +| --statefile-format | Define the format used to store the cache. Available formats: 'dumper', 'storable', 'json' (default). | +| --statefile-key | Define the key to encrypt/decrypt the cache. | +| --statefile-cipher | Define the cipher algorithm to encrypt the cache (default: 'AES'). | +| --add-global | Check global port statistics (by default if no --add-* option is set). | +| --add-status | Check interface status. | +| --add-duplex-status | Check duplex status (with --warning-status and --critical-status). | +| --add-traffic | Check interface traffic. | +| --add-errors | Check interface errors. | +| --add-cast | Check interface cast. | +| --add-speed | Check interface speed. | +| --add-volume | Check interface data volume between two checks (not supposed to be graphed, useful for BI reporting). | +| --check-metrics | If the expression is true, metrics are checked (default: '%\{opstatus\} eq "up"'). | +| --warning-status | Define the conditions to match for the status to be WARNING. You can use the following variables: %\{admstatus\}, %\{opstatus\}, %\{duplexstatus\}, %\{display\} | +| --critical-status | Define the conditions to match for the status to be CRITICAL (default: '%\{admstatus\} eq "up" and %\{opstatus\} ne "up"'). You can use the following variables: %\{admstatus\}, %\{opstatus\}, %\{duplexstatus\}, %\{display\} | +| --warning-total-port | Thresholds. | +| --critical-total-port | Thresholds. | +| --warning-total-admin-up | Thresholds. | +| --critical-total-admin-up | Thresholds. | +| --warning-total-admin-down | Thresholds. | +| --critical-total-admin-down | Thresholds. | +| --warning-total-oper-up | Thresholds. | +| --critical-total-oper-up | Thresholds. | +| --warning-total-oper-down | Thresholds. | +| --critical-total-oper-down | Thresholds. | +| --warning-in-traffic | Thresholds. | +| --critical-in-traffic | Thresholds. | +| --warning-out-traffic | Thresholds. | +| --critical-out-traffic | Thresholds. | +| --warning-in-error | Thresholds. | +| --critical-in-error | Thresholds. | +| --warning-in-discard | Thresholds. | +| --critical-in-discard | Thresholds. | +| --warning-out-error | Thresholds. | +| --critical-out-error | Thresholds. | +| --warning-out-discard | Thresholds. | +| --critical-out-discard | Thresholds. | +| --warning-in-ucast | Thresholds. | +| --critical-in-ucast | Thresholds. | +| --warning-in-bcast | Thresholds. | +| --critical-in-bcast | Thresholds. | +| --warning-in-mcast | Thresholds. | +| --critical-in-mcast | Thresholds. | +| --warning-out-ucast | Thresholds. | +| --critical-out-ucast | Thresholds. | +| --warning-out-bcast | Thresholds. | +| --critical-out-bcast | Thresholds. | +| --warning-out-mcast | Thresholds. | +| --critical-out-mcast | Thresholds. | +| --warning-speed | Thresholds in b/s. | +| --critical-speed | Thresholds in b/s. | +| --units-traffic | Units of thresholds for the traffic (default: 'percent\_delta') ('percent\_delta', 'bps', 'counter'). | +| --units-errors | Units of thresholds for errors/discards (default: 'percent\_delta') ('percent\_delta', 'delta', 'deltaps', 'counter'). | +| --units-cast | Units of thresholds for communication types (default: 'percent\_delta') ('percent\_delta', 'percent', 'delta', 'deltaps', 'counter'). | +| --nagvis-perfdata | Display traffic perfdata to be compatible with NagVis widget. | +| --interface | Check only the interfaces with the specified IDs (OID indexes, e.g.: 1,2,...). If empty, all interfaces will be monitored. To filter on interface names, see --name. | +| --name | With this option, the interfaces will be filtered by name (given in option --interface) instead of OID index. The name matching mode supports regular expressions. | +| --regex-id | With this option, interface IDs will be filtered using the --interface parameter as a regular expression instead of a list of IDs. | +| --speed | Set interface speed for incoming/outgoing traffic (in Mb). | +| --speed-in | Set interface speed for incoming traffic (in Mb). | +| --speed-out | Set interface speed for outgoing traffic (in Mb). | +| --map-speed-dsl | Get interface speed configuration for interfaces of type 'ADSL' and 'VDSL2'. Syntax: --map-speed-dsl=interface-src-name,interface-dsl-name E.g: --map-speed-dsl=Et0.835,Et0-vdsl2 | +| --force-counters64 | Force to use 64 bits counters only. Can be used to improve performance. | +| --force-counters32 | Force to use 32-bit counters (even with SNMP versions 2c and 3). To use when 64 bits counters are buggy. | +| --reload-cache-time | Time in minutes before reloading cache file (default: 180). | +| --oid-filter | Define the OID to be used to filter interfaces (default: ifName) (values: ifDesc, ifAlias, ifName, IpAddr). | +| --oid-display | Define the OID that will be used to name the interfaces (default: ifName) (values: ifDesc, ifAlias, ifName, IpAddr). | +| --oid-extra-display | Add an OID to display. | +| --display-transform-src --display-transform-dst | Modify the interface name displayed by using a regular expression. Example: adding --display-transform-src='eth' --display-transform-dst='ens' will replace all occurrences of 'eth' with 'ens' | +| --show-cache | Display cache interface data. | +| --no-cache-lock | Set to disable locking when accessing cache. | -| Option | Description | -|:-----------|:----------------------------------------| -| --warning | Warning threshold (1min,5min,15min). | -| --critical | Critical threshold (1min,5min,15min). | -| --average | Load average for the number of CPUs. | +| Option | Description | +|:-----------|:--------------------------------------| +| --warning | Warning threshold (1min,5min,15min). | +| --critical | Critical threshold (1min,5min,15min). | +| --average | Load average for the number of CPUs. | -| Option | Description | -|:-------------------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| --units | Units of thresholds (default: '%') ('%', 'absolute')(deprecated. Please use new counters directly) | -| --free | Thresholds are on free space left (deprecated. Please use newcounters directly) | -| --swap | Check swap also. | -| --warning-* --critical-* | Thresholds. Can be: 'usage' (B), 'usage-free' (B), 'usage-prct' (%), 'swap' (B), 'swap-free' (B), 'swap-prct' (%), 'buffer' (B), 'cached' (B), 'shared' (B). | -| --patch-redhat | If using RedHat distribution with net-snmp \>= 5.7.2-43 and net-snmp \< 5.7.2-47. But you should update net-snmp!!!! This version: used = memTotalReal - memAvailReal // free = memAvailReal Others versions: used = memTotalReal - memAvailReal - memBuffer - memCached // free = total - used | +| Option | Description | +|:------------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| --filter-counters | Only display some counters (regexp can be used). Example to check SSL connections only : --filter-counters='^xxxx\|yyyy$' | +| --warning-xxx | Warning threshold. | +| --critical-xxx | Critical threshold. | +| --units | Units of thresholds (default: '%') ('%', 'absolute') (deprecated. Please use new counters directly) | +| --free | Thresholds are on free space left (deprecated. Please use new counters directly) | +| --swap | Check swap also. | +| --warning-buffer | Threshold in bytes. | +| --critical-buffer | Threshold in bytes. | +| --warning-cached | Threshold in bytes. | +| --critical-cached | Threshold in bytes. | +| --warning-shared | Threshold in bytes. | +| --critical-shared | Threshold in bytes. | +| --warning-swap | Threshold in bytes. | +| --critical-swap | Threshold in bytes. | +| --warning-swap-free | Threshold in bytes. | +| --critical-swap-free | Threshold in bytes. | +| --warning-swap-prct | Threshold in percentage. | +| --critical-swap-prct | Threshold in percentage. | +| --warning-usage | Threshold in bytes. | +| --critical-usage | Threshold in bytes. | +| --warning-usage-free | Threshold in bytes. | +| --critical-usage-free | Threshold in bytes. | +| --warning-usage-prct | Threshold in percentage. | +| --critical-usage-prct | Threshold in percentage. | +| --patch-redhat | If using Red Hat distribution with net-snmp \>= 5.7.2-43 and net-snmp \< 5.7.2-47. But you should update net-snmp!!!! This version: used = memTotalReal - memAvailReal // free = memAvailReal Others versions: used = memTotalReal - memAvailReal - memBuffer - memCached // free = total - used | +| --force-64bits-counters | Use this option to monitor a server/device that has more than 2 TB of RAM, the maximum size of a signed 32 bits integer. If you omit it you'll get the remainder of the Euclidean division of the actual value by 2 TB. NB: it cannot work with version 1 of SNMP protocol. 64 bits counters are supported starting version 2c. | -| Option | Description | -|:-------------------------|:------------------------------------------------------------------------| -| --no-swap | Threshold if no active swap (default: 'critical'). | -| --warning-* --critical-* | Thresholds. Can be: 'usage' (B), 'usage-free' (B), 'usage-prct' (%). | +| Option | Description | +|:----------------------|:--------------------------------------------------------------------------------------------------------------------------| +| --filter-counters | Only display some counters (regexp can be used). Example to check SSL connections only : --filter-counters='^xxxx\|yyyy$' | +| --warning-xxx | Warning threshold. | +| --critical-xxx | Critical threshold. | +| --no-swap | Threshold if no active swap (default: 'critical'). | +| --warning-usage | Threshold in bytes. | +| --critical-usage | Threshold in bytes. | +| --warning-usage-free | Threshold in bytes. | +| --critical-usage-free | Threshold in bytes. | +| --warning-usage-prct | Threshold in percentage. | +| --critical-usage-prct | Threshold in percentage. | -| Option | Description | -|:-----------------------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| --memcached | Memcached server to use (only one server). | -| --redis-server | Redis server to use (only one server). Syntax: address\[:port\] | -| --redis-attribute | Set Redis Options (--redis-attribute="cnx\_timeout=5"). | -| --redis-db | Set Redis database index. | -| --failback-file | Failback on a local file if Redis connection fails. | -| --memexpiration | Time to keep data in seconds (default: 86400). | -| --statefile-dir | Define the cache directory (default: '/var/lib/centreon/centplugins'). | -| --statefile-suffix | Define a suffix to customize the statefile name (default: ''). | -| --statefile-concat-cwd | If used with the '--statefile-dir' option, the latter's value will be used as a sub-directory of the current working directory. Useful on Windows when the plugin is compiled, as the file system and permissions are different from Linux. | -| --statefile-format | Define the format used to store the cache. Available formats: 'dumper', 'storable', 'json' (default). | -| --statefile-key | Define the key to encrypt/decrypt the cache. | -| --statefile-cipher | Define the cipher algorithm to encrypt the cache (default: 'AES'). | -| --warning-uptime | Warning threshold. | -| --critical-uptime | Critical threshold. | -| --add-sysdesc | Display system description. | -| --force-oid | Can choose your oid (numeric format only). | -| --check-overload | Uptime counter limit is 4294967296 and overflow. With that option, we manage the counter going back. But there is a few chance we can miss a reboot. | -| --reboot-window | To be used with check-overload option. Time in milliseconds (default: 5000) You increase the chance of not missing a reboot if you decrease that value. | -| --unit | Select the time unit for thresholds. May be 's' for seconds, 'm'for minutes, 'h' for hours, 'd' for days, 'w' for weeks. Default is seconds. | +| Option | Description | +|:-----------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| --filter-counters | Only display some counters (regexp can be used). Example to check SSL connections only : --filter-counters='^xxxx\|yyyy$' | +| --warning-xxx | Warning threshold. | +| --critical-xxx | Critical threshold. | +| --memcached | Memcached server to use (only one server). | +| --redis-server | Redis server to use (only one server). Syntax: address\[:port\] | +| --redis-attribute | Set Redis Options (--redis-attribute="cnx\_timeout=5"). | +| --redis-db | Set Redis database index. | +| --failback-file | Fall back on a local file if Redis connection fails. | +| --memexpiration | Time to keep data in seconds (default: 86400). | +| --statefile-dir | Define the cache directory (default: '/var/lib/centreon/centplugins'). | +| --statefile-suffix | Define a suffix to customize the statefile name (default: ''). | +| --statefile-concat-cwd | If used with the '--statefile-dir' option, the latter's value will be used as a sub-directory of the current working directory. Useful on Windows when the plugin is compiled, as the file system and permissions are different from Linux. | +| --statefile-format | Define the format used to store the cache. Available formats: 'dumper', 'storable', 'json' (default). | +| --statefile-key | Define the key to encrypt/decrypt the cache. | +| --statefile-cipher | Define the cipher algorithm to encrypt the cache (default: 'AES'). | +| --warning-uptime | Warning threshold. | +| --critical-uptime | Critical threshold. | +| --add-sysdesc | Display system description. | +| --force-oid | Can choose your OID (numeric format only). | +| --check-overload | Uptime counter limit is 4294967296 and overflow. With that option, we manage the counter going back. But there is a few chance we can miss a reboot. | +| --reboot-window | To be used with check-overload option. Time in milliseconds (default: 5000) You increase the chance of not missing a reboot if you decrease that value. | +| --unit | Select the time unit for thresholds. May be 's' for seconds, 'm' for minutes, 'h' for hours, 'd' for days, 'w' for weeks. Default is seconds. | -| Option | Description | -|:-------------------------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| --memcached | Memcached server to use (only one server). | -| --redis-server | Redis server to use (only one server). Syntax: address\[:port\] | -| --redis-attribute | Set Redis Options (--redis-attribute="cnx\_timeout=5"). | -| --redis-db | Set Redis database index. | -| --failback-file | Failback on a local file if Redis connection fails. | -| --memexpiration | Time to keep data in seconds (default: 86400). | -| --statefile-dir | Define the cache directory (default: '/var/lib/centreon/centplugins'). | -| --statefile-suffix | Define a suffix to customize the statefile name (default: ''). | -| --statefile-concat-cwd | If used with the '--statefile-dir' option, the latter's value will be used as a sub-directory of the current working directory. Useful on Windows when the plugin is compiled, as the file system and permissions are different from Linux. | -| --statefile-format | Define the format used to store the cache. Available formats: 'dumper', 'storable', 'json' (default). | -| --statefile-key | Define the key to encrypt/decrypt the cache. | -| --statefile-cipher | Define the cipher algorithm to encrypt the cache (default: 'AES'). | -| --filter-counters | Only display some counters (regexp can be used). Example: --filter-counters='status' | -| --filter-name | Filter virtual access points by name (can be a regexp). | -| --filter-ssid | Filter virtual access points by SSID (can be a regexp). | -| --unknown-status | Define the conditions to match for the status to be UNKNOWN. You can use the following variables: %\{name\}, %\{ssid\}, %\{status\} | -| --warning-status | Define the conditions to match for the status to be WARNING. You can use the following variables: %\{name\}, %\{ssid\}, %\{status\} | -| --critical-status | Define the conditions to match for the status to be CRITICAL (default: '%\{status\} eq "down"'). You can use the following variables: %\{name\}, %\{ssid\}, %\{status\} | -| --warning-* --critical-* | Thresholds. Can be: 'total', 'total-clients-connected', 'clients-connected', 'traffic-in', 'traffic-out'. | +| Option | Description | +|:-------------------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| --filter-counters | Only display some counters (regexp can be used). Example: --filter-counters='status' | +| --warning-xxx | Warning threshold. | +| --critical-xxx | Critical threshold. | +| --filter-name | Filter virtual access points by name (can be a regexp). | +| --filter-ssid | Filter virtual access points by SSID (can be a regexp). | +| --unknown-status | Define the conditions to match for the status to be UNKNOWN. You can use the following variables: %\{name\}, %\{ssid\}, %\{status\} | +| --warning-status | Define the conditions to match for the status to be WARNING. You can use the following variables: %\{name\}, %\{ssid\}, %\{status\} | +| --critical-status | Define the conditions to match for the status to be CRITICAL (default: '%\{status\} eq "down"'). You can use the following variables: %\{name\}, %\{ssid\}, %\{status\} | +| --warning-* --critical-* | Thresholds. Can be: 'total', 'total-clients-connected', 'clients-connected', 'traffic-in', 'traffic-out'. | diff --git a/pp/integrations/plugin-packs/procedures/applications-microsoft-dhcp-snmp.md b/pp/integrations/plugin-packs/procedures/applications-microsoft-dhcp-snmp.md index 121270478dfa..37539eea1638 100644 --- a/pp/integrations/plugin-packs/procedures/applications-microsoft-dhcp-snmp.md +++ b/pp/integrations/plugin-packs/procedures/applications-microsoft-dhcp-snmp.md @@ -5,10 +5,13 @@ title: Microsoft DHCP SNMP import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; -## Pack assets +## Connector dependencies + +The following monitoring connectors will be installed when you install the **Microsoft DHCP SNMP** connector through the +**Configuration > Connectors > Monitoring Connectors** menu: +* [Base Pack](./base-generic.md) -Please note that this connector is only compatible with Windows servers up to version 2012. -After which, OIDs can no longer be queried (for more information, see [here](https://learn.microsoft.com/en-us/archive/msdn-technet-forums/73c00321-496a-4898-ad5b-5ceb909610c7)). +## Pack assets ### Templates @@ -21,9 +24,9 @@ The connector brings the following service templates (sorted by the host templat -| Service Alias | Service Template | Service Description | Discovery | -|:--------------|:---------------------------------------|:--------------------|:----------:| -| Subnets | App-Microsoft-Dhcp-Subnets-SNMP-custom | Check subnets | X | +| Service Alias | Service Template | Service Description | Discovery | +|:--------------|:---------------------------------------|:--------------------|:---------:| +| Subnets | App-Microsoft-Dhcp-Subnets-SNMP-custom | Check subnets | X | > The services listed above are created automatically when the **App-Microsoft-Dhcp-SNMP-custom** host template is used. @@ -36,31 +39,31 @@ The connector brings the following service templates (sorted by the host templat #### Host discovery -| Rule name | Description | -|:----------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| SNMP Agents | Discover your resources through an SNMP subnet scan. You need to install the [Generic SNMP](./applications-protocol-snmp.md) connector to get the discovery rule and create a template mapper for the **App-Microsoft-Dhcp-SNMP-custom** host template | +| Rule name | Description | +|:------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| SNMP Agents | Discover your resources through an SNMP subnet scan. You need to install the [Generic SNMP](./applications-protocol-snmp.md) connector to get the discovery rule and create a template mapper for the **App-Microsoft-Dhcp-SNMP-custom** host template. | More information about discovering hosts automatically is available on the [dedicated page](/docs/monitoring/discovery/hosts-discovery). #### Service discovery -| Rule name | Description | -|:--------------------------------|:------------| -| App-Microsoft-Dhcp-SNMP-Subnets | Discovery of DHCP Subnets | +| Rule name | Description | +|:--------------------------------|:--------------------------| +| App-Microsoft-Dhcp-SNMP-Subnets | Discovery of DHCP Subnets | More information about discovering services automatically is available on the [dedicated page](/docs/monitoring/discovery/services-discovery) and in the [following chapter](/docs/monitoring/discovery/services-discovery/#discovery-rules). ### Collected metrics & status -Here is the list of services for this connector, detailing all metrics linked to each service. +Here is the list of services for this connector, detailing all metrics and statuses linked to each service. -| Metric name | Unit | +| Name | Unit | |:--------------------------------------------|:------| -| *subnets*#status | N/A | +| status | N/A | | *subnets*#subnet.addresses.usage.count | count | | *subnets*#subnet.addresses.free.count | count | | *subnets*#subnet.addresses.usage.percentage | % | @@ -73,7 +76,10 @@ Here is the list of services for this connector, detailing all metrics linked to ### SNMP Configuration -The SNMP service must be configured and activated on the host. Please refer to the official documentation from the constructor/editor. +The SNMP agent must be enabled and configured on the resource. +Please refer to the official documentation. +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 @@ -83,8 +89,7 @@ The target resource must be reachable from the Centreon poller on the UDP/161 SN ### Pack - The installation procedures for monitoring connectors are slightly different depending on [whether your license is offline or online](../getting-started/how-to-guides/connectors-licenses.md). - +The installation procedures for monitoring connectors are slightly different depending on [whether your license is offline or online](../getting-started/how-to-guides/connectors-licenses.md). 1. 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 @@ -178,12 +183,14 @@ yum install centreon-plugin-Applications-Microsoft-Dhcp-Snmp 2. Fill in the **Name**, **Alias** & **IP Address/DNS** fields according to your resource's settings. 3. Apply the **App-Microsoft-Dhcp-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](../getting-started/how-to-guides/troubleshooting-plugins.md#snmpv3-options-mapping) 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](#available-options). | | | +| Macro | Description | Default value | Mandatory | +|:------------------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------|:--------------|:---------:| +| SNMP_V3_USERNAME | SNMP v3 only: User name (`securityName`) | | | +| SNMP_V3_AUTH_PROTOCOL | SNMP v3 only: Authentication protocol: MD5\|SHA. Since net-snmp 5.9.1: SHA224\|SHA256\|SHA384\|SHA512 | | | +| SNMP_V3_PRIV_PROTOCOL | 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 | | | +| SNMP_V3_AUTH_PASSPHRASE | SNMP v3 only: Pass phrase hashed using the authentication protocol defined in the --authprotocol option | | | +| SNMP_V3_PRIV_PASSPHRASE | SNMP v3 only: Privacy pass phrase (`privPassword`) to encrypt messages using the protocol defined in the --privprotocol option | | | +| SNMPEXTRAOPTIONS | Any extra option you may want to add to every command (a --verbose flag for example). All options are listed [here](#available-options). | | | 4. [Deploy the configuration](/docs/monitoring/monitoring-servers/deploying-a-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. @@ -195,18 +202,18 @@ yum install centreon-plugin-Applications-Microsoft-Dhcp-Snmp -| Macro | Description | Default value | Mandatory | -|:---------------------------|:---------------------------------------------------------------------------------------------------|:------------------|:-----------:| -| FILTERSUBNETADDRESS | Filter subnets by address (can be a regexp) | | | -| WARNINGADDRESSESUSAGE | Thresholds | | | -| CRITICALADDRESSESUSAGE | Thresholds | | | -| WARNINGADDRESSESUSAGEFREE | Thresholds | | | -| CRITICALADDRESSESUSAGEFREE | Thresholds | | | -| WARNINGADDRESSESUSAGEPRCT | Thresholds | | | -| CRITICALADDRESSESUSAGEPRCT | Thresholds | | | -| WARNINGPENDINGOFFERS | Thresholds | | | -| CRITICALPENDINGOFFERS | Thresholds | | | -| EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). All options are listed [here](#available-options). | --verbose | | +| Macro | Description | Default value | Mandatory | +|:---------------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------|:--------------|:---------:| +| FILTERSUBNETADDRESS | Filter subnets by address (can be a regexp) | | | +| WARNINGADDRESSESUSAGE | Threshold | | | +| CRITICALADDRESSESUSAGE | Threshold | | | +| WARNINGADDRESSESUSAGEFREE | Threshold | | | +| CRITICALADDRESSESUSAGEFREE | Threshold | | | +| WARNINGADDRESSESUSAGEPRCT | Threshold | | | +| CRITICALADDRESSESUSAGEPRCT | Threshold | | | +| WARNINGPENDINGOFFERS | Threshold | | | +| CRITICALPENDINGOFFERS | Threshold | | | +| EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). All options are listed [here](#available-options). | --verbose | | @@ -216,7 +223,7 @@ yum install centreon-plugin-Applications-Microsoft-Dhcp-Snmp ## 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 +**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): ```bash @@ -225,7 +232,12 @@ is able to monitor a resource using a command like this one (replace the sample --mode=subnets \ --hostname='10.0.0.1' \ --snmp-version='2c' \ - --snmp-community='my-snmp-community' \ + --snmp-community='my-snmp-community' \ + --snmp-username='username' \ + --authpassphrase='' \ + --authprotocol='' \ + --privpassphrase='' \ + --privprotocol='' \ --filter-subnet-address='' \ --warning-addresses-usage='' \ --critical-addresses-usage='' \ @@ -253,7 +265,7 @@ for Centreon Plugins typical issues. 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 +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 @@ -281,67 +293,71 @@ All available options for each service template are listed below: -| 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. | -| --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\[,\[newuom\],\[min\],\[m ax\]\] Common examples: 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()' | -| --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,namesofnewmetrics,calculation\[,\[ne wuom\],\[min\],\[max\]\] regex: regular expression namesofnewmetrics: 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 newuom (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: 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(traf fic\_(in\|out)\_$1)' | -| --change-short-output --change-long-output | Modify the short/long output that is returned by the plugin. Syntax: --change-short-output=pattern~replacement~modifier Most commonly used modifiers are i (case insensitive) and g (replace all occurrences). Example: adding --change-short-output='OK\~Up\~gi' will replace all occurrences of 'OK', 'ok', 'Ok' or 'oK' with 'Up' | -| --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. | -| --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). E.g.: --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'. | -| --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 ok, 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. | -| --filter-counters | Only display some counters (regexp can be used). Example: --filter-counters='pending' | -| --filter-subnet-address | Filter subnets by address (can be a regexp). | -| --unknown-status | Define the conditions to match for the status to be UNKNOWN. You can use the following variables: %\{status\}, %\{name\} | -| --warning-status | Define the conditions to match for the status to be WARNING. You can use the following variables: %\{status\}, %\{name\} | -| --critical-status | Define the conditions to match for the status to be CRITICAL. You can use the following variables: %\{status\}, %\{name\} | -| --warning-* --critical-* | Thresholds. Can be: 'addresses-usage', 'addresses-usage-free', 'addresses-usage-prct', 'pending-offers'. | +| Option | Description | +|:-------------------------------------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| --filter-counters | Only display some counters (regexp can be used). Example: --filter-counters='pending' | +| --warning-xxx | Warning threshold. | +| --critical-xxx | Critical threshold. | +| --filter-subnet-address | Filter subnets by address (can be a regexp). | +| --unknown-status | Define the conditions to match for the status to be UNKNOWN. You can use the following variables: %\{status\}, %\{name\} | +| --warning-status | Define the conditions to match for the status to be WARNING. You can use the following variables: %\{status\}, %\{name\} | +| --critical-status | Define the conditions to match for the status to be CRITICAL. You can use the following variables: %\{status\}, %\{name\} | +| --warning-* --critical-* | Thresholds. Can be: 'addresses-usage', 'addresses-usage-free', 'addresses-usage-prct', 'pending-offers'. | +| --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 get-next 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 ok, 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. | +| --show-password | By default, sensitive information in command lines is hidden in debug output and replaced with `***` (however, debug logs may still display sensitive information). Using the C option will display the passwords in plain text. | +| --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\[,\[\\],\[min\],\[max\]\] Common examples: onvert 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,\,calculation\[,\[\\],\[min\],\[max\]\] regex: regular expression \: 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 \ (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: um 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~replacement~modifier Most commonly used modifiers are i (case insensitive) and g (replace all occurrences). Example: adding --change-short-output='OK~Up~gi' will replace all occurrences of 'OK', 'ok', 'Ok' or 'oK' with 'Up' | +| --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'. \. | diff --git a/pp/integrations/plugin-packs/procedures/hardware-pdu-apc-snmp.md b/pp/integrations/plugin-packs/procedures/hardware-pdu-apc-snmp.md index 5bc2d0e93ee2..4779321d6563 100644 --- a/pp/integrations/plugin-packs/procedures/hardware-pdu-apc-snmp.md +++ b/pp/integrations/plugin-packs/procedures/hardware-pdu-apc-snmp.md @@ -27,7 +27,7 @@ The connector brings the following service templates (sorted by the host templat | Service Alias | Service Template | Service Description | |:--------------|:--------------------------------|:-------------------------------| | Hardware | HW-Pdu-Apc-Hardware-SNMP-custom | Check hardware | -| Load | HW-Pdu-Apc-SNMP-Load-custom | Check load (current in amperes) | +| Load | HW-Pdu-Apc-SNMP-Load-custom | Check load (current in Amperes | | Outlet | HW-Pdu-Apc-SNMP-Outlet-custom | Check PDU outlets | > The services listed above are created automatically when the **HW-Pdu-Apc-SNMP-custom** host template is used. @@ -49,9 +49,9 @@ The connector brings the following service templates (sorted by the host templat #### Host discovery -| Rule name | Description | -|:----------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| SNMP Agents | Discover your resources through an SNMP subnet scan. You need to install the [Generic SNMP](./applications-protocol-snmp.md) connector to get the discovery rule and create a template mapper for the **HW-Pdu-Apc-SNMP-custom** host template. | +| Rule name | Description | +|:------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| SNMP Agents | Discover your resources through an SNMP subnet scan. You need to install the [Generic SNMP](./applications-protocol-snmp.md) connector to get the discovery rule and create a template mapper for the **HW-Pdu-Apc-SNMP-custom** host template. | More information about discovering hosts automatically is available on the [dedicated page](/docs/monitoring/discovery/hosts-discovery). @@ -62,16 +62,14 @@ Here is the list of services for this connector, detailing all metrics and statu -| Name | Unit | -|:------------------------------------|:------| -| hardware.psu.status | N/A | -| hardware.humidity.status | N/A | -| hardware.temperature.status | N/A | -| hardware.psu.count | count | -| hardware.humidity.count | count | -| hardware.temperature.count | count | -| hardware.sensor.humidity.percentage | % | -| hardware.sensor.temperature.celsius | C | +| Name | Unit | +|:---------------------------|:------| +| hardware.psu.count | count | +| psu status | N/A | +| hardware.humidity.count | count | +| humidity status | N/A | +| hardware.temperature.count | count | +| temperature status | N/A | @@ -91,16 +89,13 @@ Here is the list of services for this connector, detailing all metrics and statu | Name | Unité | |:--------------------|:------| | time.offset.seconds | s | - -| Name | Unit | -|:--------------------------------|:-----| -| status | N/A | -| status | N/A | -| *outlet1*#outlet.current.ampere | A | -| *outlet2*#outlet.current.ampere | A | +| Name | Unit | +|:-------------------------------|:-----| +| status | N/A | +| *outlet*#outlet.current.ampere | A | @@ -131,6 +126,8 @@ SNMP port. ### Pack +The installation procedures for monitoring connectors are slightly different depending on [whether your license is offline or online](../getting-started/how-to-guides/connectors-licenses.md). + 1. 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 > Connectors > Monitoring Connectors** menu. @@ -221,14 +218,16 @@ yum install centreon-plugin-Hardware-Pdu-Apc-Snmp 1. Log into Centreon and add a new host through **Configuration > Hosts**. 2. Fill in the **Name**, **Alias** & **IP Address/DNS** fields according to your resource's settings. -3. Apply the **HW-Pdu-Apc-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](../getting-started/how-to-guides/troubleshooting-plugins.md#snmpv3-options-mapping) section. +3. Apply the **HW-Pdu-Apc-SNMP-custom** template to the host. -| 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](#available-options). | | | +| Macro | Description | Default value | Mandatory | +|:------------------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------|:--------------|:---------:| +| SNMP_V3_USERNAME | SNMP v3 only: User name (`securityName`) | | | +| SNMP_V3_AUTH_PROTOCOL | SNMP v3 only: Authentication protocol: MD5\|SHA. Since net-snmp 5.9.1: SHA224\|SHA256\|SHA384\|SHA512 | | | +| SNMP_V3_PRIV_PROTOCOL | 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 | | | +| SNMP_V3_AUTH_PASSPHRASE | SNMP v3 only: Pass phrase hashed using the authentication protocol defined in the --authprotocol option | | | +| SNMP_V3_PRIV_PASSPHRASE | SNMP v3 only: Privacy pass phrase (`privPassword`) to encrypt messages using the protocol defined in the --privprotocol option | | | +| SNMPEXTRAOPTIONS | Any extra option you may want to add to every command (a --verbose flag for example). All options are listed [here](#available-options). | | | 4. [Deploy the configuration](/docs/monitoring/monitoring-servers/deploying-a-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. @@ -240,48 +239,48 @@ yum install centreon-plugin-Hardware-Pdu-Apc-Snmp -| Macro | Description | Default value | Mandatory | -|:-------------|:---------------------------------------------------------------------------------------------------------------------------------------|:--------------|:---------:| -| COMPONENT | Which component to check (default: '.*'). Can be: 'psu', 'humidity', 'temperature' | | | -| WARNING | Set warning threshold for temperatures (syntax: type,instance,threshold) Example: --warning='temperature,.*,30' | | | -| CRITICAL | Set critical threshold for temperatures (syntax: type,instance,threshold) Example: --critical='temperature,.*,40' | | | -| EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). All options are listed [here](#available-options). | --verbose | | +| Macro | Description | Default value | Mandatory | +|:-------------|:-------------------------------------------------------------------------------------------------------------------------------------------------|:--------------|:---------:| +| COMPONENT | Which component to check. Can be: 'psu', 'humidity', 'temperature' | .* | | +| WARNING | Set warning threshold for temperatures (syntax: type,instance,threshold) Example: --warning='temperature,.*,30' | | | +| CRITICAL | Set critical threshold for temperatures (syntax: type,instance,threshold) Example: --critical='temperature,.*,40' | | | +| EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). All options are listed [here](#available-options). | --verbose | | -| Macro | Description | Default value | Mandatory | -|:-------------|:---------------------------------------------------------------------------------------------------------------------------------------|:--------------|:---------:| -| EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). All options are listed [here](#available-options). | --verbose | | +| Macro | Description | Default value | Mandatory | +|:-------------|:-------------------------------------------------------------------------------------------------------------------------------------------------|:--------------|:---------:| +| EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). All options are listed [here](#available-options). | --verbose | | -| Macro | Description | Default value | Mandatory | -|:-------------|:---------------------------------------------------------------------------------------------------------------------------------------|:--------------|:---------:| -| NTPADDR | Set the ntp hostname (if not set, localtime is used) | | | -| NTPPORT | Set the ntp port (default: 123) | | | -| TIMEZONE | Set the timezone of distant server. For Windows, you need to set it. Can use format: 'Europe/London' or '+0100' | | | -| WARNING | Time warning threshold range (in seconds), in the format `-n:n` (e.g., `-5:5`). Returns WARNING when the offset is less than -n seconds or greater than n seconds. | -1:1 | | -| CRITICAL | Time critical threshold range (in seconds), in the format `-n:n` (e.g., `-5:5`). Returns CRITICAL when the offset is less than -n seconds or greater than n seconds. | -2:2 | | -| EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). All options are listed [here](#available-options). | | | +| Macro | Description | Default value | Mandatory | +|:-------------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------|:--------------|:---------:| +| NTPADDR | Set the NTP hostname (if not set, localtime is used) | | | +| NTPPORT | Set the NTP port | 123 | | +| TIMEZONE | Set the timezone of distant server. For Windows, you need to set it. Can use format: 'Europe/London' or '+0100' | | | +| WARNING | Time warning threshold range (in seconds), in the format -n:n (e.g., -5:5). Returns WARNING when the offset is less than -n seconds or greater than n seconds | -1:1 | | +| CRITICAL | Time critical threshold range (in seconds), in the format -n:n (e.g., -5:5). Returns CRITICAL when the offset is less than -n seconds or greater than n seconds | -2:2 | | +| EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). All options are listed [here](#available-options). | | | -| Macro | Description | Default value | Mandatory | -|:-------------|:---------------------------------------------------------------------------------------------------------------------------------------|:--------------|:---------:| -| EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). All options are listed [here](#available-options). | --verbose | | +| Macro | Description | Default value | Mandatory | +|:-------------|:-------------------------------------------------------------------------------------------------------------------------------------------------|:--------------|:---------:| +| EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). All options are listed [here](#available-options). | --verbose | | -| Macro | Description | Default value | Mandatory | -|:-------------|:---------------------------------------------------------------------------------------------------------------------------------------------|:-----------------|:---------:| -| UNIT | Select the time unit for thresholds. May be 's' for seconds, 'm' for minutes, 'h' for hours, 'd' for days, 'w' for weeks. Default is seconds | | | -| WARNING | Warning threshold | | | -| CRITICAL | Critical threshold | | | -| EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). All options are listed [here](#available-options). | --check-overload | | +| Macro | Description | Default value | Mandatory | +|:-------------|:-------------------------------------------------------------------------------------------------------------------------------------------------|:-----------------|:---------:| +| UNIT | Select the time unit for thresholds. May be 's' for seconds, 'm' for minutes, 'h' for hours, 'd' for days, 'w' for weeks. Default is seconds | | | +| WARNING | Warning threshold | | | +| CRITICAL | Critical threshold | | | +| EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). All options are listed [here](#available-options). | --check-overload | | @@ -300,14 +299,19 @@ is able to monitor a resource using a command like this one (replace the sample --mode=outlet \ --hostname=10.0.0.1 \ --snmp-version='2c' \ - --snmp-community='my-snmp-community' \ + --snmp-community='my-snmp-community' \ + --snmp-username='username' \ + --authpassphrase='' \ + --authprotocol='' \ + --privpassphrase='' \ + --privprotocol='' \ --verbose ``` The expected command output is shown below: ```bash -OK: All outlets are ok | 'outlet1#outlet.current.ampere'=60547A;;;0; 'outlet2#outlet.current.ampere'=35084A;;;0; +OK: All outlets are ok | 'outlet1#outlet.current.ampere'=8A;;;0; 'outlet2#outlet.current.ampere'=9A;;;0; ``` ### Troubleshooting @@ -347,66 +351,67 @@ The plugin brings the following modes: 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 ok, 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\[,\[\\],\[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\[,\[\\],\[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\[,\[\\],\[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,\,calculation\[,\[\\],\[min\],\[max\]\] regex: regular expression \: 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 \ (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~replacement~modifier Most commonly used modifiers are i (case insensitive) and g (replace all occurrences). Example: adding --change-short-output='OK\~Up\~gi' will replace all occurrences of 'OK', 'ok', 'Ok' or 'oK' with 'Up' | -| --change-short-output | Modify the short/long output that is returned by the plugin. Syntax: --change-short-output=pattern~replacement~modifier Most commonly used modifiers are i (case insensitive) and g (replace all occurrences). Example: adding --change-short-output='OK\~Up\~gi' will replace all occurrences of 'OK', 'ok', 'Ok' or 'oK' with 'Up' | -| --change-long-output | Modify the short/long output that is returned by the plugin. Syntax: --change-short-output=pattern~replacement~modifier Most commonly used modifiers are i (case insensitive) and g (replace all occurrences). Example: adding --change-short-output='OK\~Up\~gi' will replace all occurrences of 'OK', 'ok', 'Ok' or 'oK' with 'Up' | -| --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\. =cut | +| 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 get-next 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 ok, 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. | +| --show-password | By default, sensitive information in command lines is hidden in debug output and replaced with `***` (however, debug logs may still display sensitive information). Using the C option will display the passwords in plain text. | +| --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\[,\[\\],\[min\],\[max\]\] Common examples: onvert 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\[,\[\\],\[min\],\[max\]\] Common examples: onvert 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\[,\[\\],\[min\],\[max\]\] Common examples: onvert 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,\,calculation\[,\[\\],\[min\],\[max\]\] regex: regular expression \: 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 \ (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: um 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~replacement~modifier Most commonly used modifiers are i (case insensitive) and g (replace all occurrences). Example: adding --change-short-output='OK~Up~gi' will replace all occurrences of 'OK', 'ok', 'Ok' or 'oK' with 'Up' | +| --change-short-output | Modify the short/long output that is returned by the plugin. Syntax: --change-short-output=pattern~replacement~modifier Most commonly used modifiers are i (case insensitive) and g (replace all occurrences). Example: adding --change-short-output='OK~Up~gi' will replace all occurrences of 'OK', 'ok', 'Ok' or 'oK' with 'Up' | +| --change-long-output | Modify the short/long output that is returned by the plugin. Syntax: --change-short-output=pattern~replacement~modifier Most commonly used modifiers are i (case insensitive) and g (replace all occurrences). Example: adding --change-short-output='OK~Up~gi' will replace all occurrences of 'OK', 'ok', 'Ok' or 'oK' with 'Up' | +| --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'. \. | #### Modes options @@ -415,79 +420,87 @@ All available options for each service template are listed below: -| Option | Description | -|:---------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| --component | Which component to check (default: '.*'). Can be: 'psu', 'humidity', 'temperature'. | -| --filter | Exclude the items given as a comma-separated list (example: --filter=temperature --filter=humidity). You can also exclude items from specific instances: --filter=temperature,1 | -| --absent-problem | Return an error if an entity is not 'present' (default is skipping) (comma separated list) Can be specific or global: --absent-problem=psu | -| --no-component | Define the expected status if no components are found (default: critical). | -| --threshold-overload | Use this option to override the status returned by the plugin when the status label matches a regular expression (syntax: section,\[instance,\]status,regexp). Example: --threshold-overload='temperature,CRITICAL,^(?!(normal)$)' | -| --warning | Set warning threshold for temperatures (syntax: type,instance,threshold) Example: --warning='temperature,.*,30' | -| --critical | Set critical threshold for temperatures (syntax: type,instance,threshold) Example: --critical='temperature,.*,40' | +| Option | Description | +|:---------------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| --component | Which component to check (default: '.*'). Can be: 'psu', 'humidity', 'temperature'. | +| --filter | Exclude the items given as a comma-separated list (example: --filter=temperature --filter=humidity). You can also exclude items from specific instances: --filter=temperature,1 | +| --absent-problem | Return an error if an entity is not 'present' (default is skipping) (comma separated list) Can be specific or global: --absent-problem=psu | +| --no-component | Define the expected status if no components are found (default: critical). | +| --threshold-overload | Use this option to override the status returned by the plugin when the status label matches a regular expression (syntax: section,\[instance,\]status,regexp). Example: --threshold-overload='temperature,CRITICAL,^(?!(normal)$)' | +| --warning | Set warning threshold for temperatures (syntax: type,instance,threshold) Example: --warning='temperature,.*,30' | +| --critical | Set critical threshold for temperatures (syntax: type,instance,threshold) Example: --critical='temperature,.*,40' | -| Option | Description | -|:-------------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| --filter-counters | Only display some counters (regexp can be used). Example to check SSL connections only : --filter-counters='^xxxx\|yyyy$' | -| --unknown-bank-status | Define the conditions to match for the status to be WARNING. You can use the following variables: %\{type\}, %\{status\}, %\{display\} | -| --warning-bank-status | Define the conditions to match for the status to be WARNING (default: '%\{status\} =~ /low\|nearOverload/i'). You can use the following variables: %\{type\}, %\{status\}, %\{display\} | -| --critical-bank-status | Define the conditions to match for the status to be CRITICAL (default: '%\{status\} =~ /^overload/'). You can use the following variables: %\{type\}, %\{status\}, %\{display\} | -| --unknown-phase-status | Define the conditions to match for the status to be WARNING. You can use the following variables: %\{status\}, %\{display\} | -| --warning-phase-status | Define the conditions to match for the status to be WARNING (default: '%\{status\} =~ /low\|nearOverload/i'). You can use the following variables: %\{status\}, %\{display\} | -| --critical-phase-status | Define the conditions to match for the status to be CRITICAL (default: '%\{status\} =~ /^overload/i'). You can use the following variables: %\{status\}, %\{display\} | -| --warning-* --critical-* | Thresholds. Can be: 'current', 'power'. | +| Option | Description | +|:-------------------------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| --filter-counters | Only display some counters (regexp can be used). Example to check SSL connections only : --filter-counters='^xxxx\|yyyy$' | +| --warning-xxx | Warning threshold. | +| --critical-xxx | Critical threshold. | +| --unknown-bank-status | Define the conditions to match for the status to be WARNING. You can use the following variables: %\{type\}, %\{status\}, %\{display\} | +| --warning-bank-status | Define the conditions to match for the status to be WARNING (default: '%\{status\} =~ /low\|nearOverload/i'). You can use the following variables: %\{type\}, %\{status\}, %\{display\} | +| --critical-bank-status | Define the conditions to match for the status to be CRITICAL (default: '%\{status\} =~ /^overload/'). You can use the following variables: %\{type\}, %\{status\}, %\{display\} | +| --unknown-phase-status | Define the conditions to match for the status to be WARNING. You can use the following variables: %\{status\}, %\{display\} | +| --warning-phase-status | Define the conditions to match for the status to be WARNING (default: '%\{status\} =~ /low\|nearOverload/i'). You can use the following variables: %\{status\}, %\{display\} | +| --critical-phase-status | Define the conditions to match for the status to be CRITICAL (default: '%\{status\} =~ /^overload/i'). You can use the following variables: %\{status\}, %\{display\} | +| --warning-* --critical-* | Thresholds. Can be: 'current', 'power'. | -| Option | Description | -|:------------------|:------------------------------------------------------------------------------------------------------------------------------| -| --filter-counters | Only display some counters (regexp can be used). Example to check SSL connections only : --filter-counters='^xxxx\|yyyy$' | -| --oid | Override default OID. | -| --warning-offset | Time warning threshold range (in seconds), in the format `-n:n` (e.g., `-5:5`). Returns WARNING when the offset is less than -n seconds or greater than n seconds. | -| --critical-offset | Time critical threshold range (in seconds), in the format `-n:n` (e.g., `-5:5`). Returns CRITICAL when the offset is less than -n seconds or greater than n seconds. | -| --ntp-hostname | Set the ntp hostname (if not set, localtime is used). | -| --ntp-port | Set the ntp port (default: 123). | -| --timezone | Set the timezone of distant server. For Windows, you need to set it. Can use format: 'Europe/London' or '+0100'. | +| Option | Description | +|:------------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------| +| --filter-counters | Only display some counters (regexp can be used). Example to check SSL connections only : --filter-counters='^xxxx\|yyyy$' | +| --warning-xxx | Warning threshold. | +| --critical-xxx | Critical threshold. | +| --oid | Override default OID. | +| --warning-offset | Time warning threshold range (in seconds), in the format -n:n (e.g., -5:5). Returns WARNING when the offset is less than -n seconds or greater than n seconds. | +| --critical-offset | Time critical threshold range (in seconds), in the format -n:n (e.g., -5:5). Returns CRITICAL when the offset is less than -n seconds or greater than n seconds. | +| --ntp-hostname | Set the NTP hostname (if not set, localtime is used). | +| --ntp-port | Set the NTP port (default: 123). | +| --timezone | Set the timezone of distant server. For Windows, you need to set it. Can use format: 'Europe/London' or '+0100'. | -| Option | Description | -|:-------------------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| --filter-counters | Only display some counters (regexp can be used). Example to check SSL connections only : --filter-counters='^xxxx\|yyyy$' | -| --unknown-status | Define the conditions to match for the status to be UNKNOWN. You can use the following variables: %\{status\}, %\{display\} | -| --warning-status | Define the conditions to match for the status to be WARNING (default: ''). You can use the following variables: %\{status\}, %\{phase\}, %\{bank\}, %\{display\} | -| --critical-status | Define the conditions to match for the status to be CRITICAL (default: '%\{status\} =~ /off/'). You can use the following variables: %\{status\}, %\{phase\}, %\{bank\}, %\{display\} | -| --warning-* --critical-* | Thresholds. Can be: 'current'. | +| Option | Description | +|:-------------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| --filter-counters | Only display some counters (regexp can be used). Example to check SSL connections only : --filter-counters='^xxxx\|yyyy$' | +| --warning-xxx | Warning threshold. | +| --critical-xxx | Critical threshold. | +| --unknown-status | Define the conditions to match for the status to be UNKNOWN. You can use the following variables: %\{status\}, %\{display\} | +| --warning-status | Define the conditions to match for the status to be WARNING (default: ''). You can use the following variables: %\{status\}, %\{phase\}, %\{bank\}, %\{display\} | +| --critical-status | Define the conditions to match for the status to be CRITICAL (default: '%\{status\} =~ /off/'). You can use the following variables: %\{status\}, %\{phase\}, %\{bank\}, %\{display\} | +| --warning-* --critical-* | Thresholds. Can be: 'current'. | -| Option | Description | -|:-----------------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| --filter-counters | Only display some counters (regexp can be used). Example to check SSL connections only : --filter-counters='^xxxx\|yyyy$' | -| --memcached | Memcached server to use (only one server). | -| --redis-server | Redis server to use (only one server). Syntax: address\[:port\] | -| --redis-attribute | Set Redis Options (--redis-attribute="cnx\_timeout=5"). | -| --redis-db | Set Redis database index. | -| --failback-file | Fall back on a local file if Redis connection fails. | -| --memexpiration | Time to keep data in seconds (default: 86400). | -| --statefile-dir | Define the cache directory (default: '/var/lib/centreon/centplugins'). | -| --statefile-suffix | Define a suffix to customize the statefile name (default: ''). | -| --statefile-concat-cwd | If used with the '--statefile-dir' option, the latter's value will be used as a sub-directory of the current working directory. Useful on Windows when the plugin is compiled, as the file system and permissions are different from Linux. | -| --statefile-format | Define the format used to store the cache. Available formats: 'dumper', 'storable', 'json' (default). | -| --statefile-key | Define the key to encrypt/decrypt the cache. | -| --statefile-cipher | Define the cipher algorithm to encrypt the cache (default: 'AES'). | -| --warning-uptime | Warning threshold. | -| --critical-uptime | Critical threshold. | -| --add-sysdesc | Display system description. | -| --force-oid | Can choose your OID (numeric format only). | -| --check-overload | Uptime counter limit is 4294967296 and overflow. With that option, we manage the counter going back. But there is a few chance we can miss a reboot. | -| --reboot-window | To be used with check-overload option. Time in milliseconds (default: 5000) You increase the chance of not missing a reboot if you decrease that value. | -| --unit | Select the time unit for thresholds. May be 's' for seconds, 'm' for minutes, 'h' for hours, 'd' for days, 'w' for weeks. Default is seconds. | +| Option | Description | +|:-----------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| --filter-counters | Only display some counters (regexp can be used). Example to check SSL connections only : --filter-counters='^xxxx\|yyyy$' | +| --warning-xxx | Warning threshold. | +| --critical-xxx | Critical threshold. | +| --memcached | Memcached server to use (only one server). | +| --redis-server | Redis server to use (only one server). Syntax: address\[:port\] | +| --redis-attribute | Set Redis Options (--redis-attribute="cnx\_timeout=5"). | +| --redis-db | Set Redis database index. | +| --failback-file | Fall back on a local file if Redis connection fails. | +| --memexpiration | Time to keep data in seconds (default: 86400). | +| --statefile-dir | Define the cache directory (default: '/var/lib/centreon/centplugins'). | +| --statefile-suffix | Define a suffix to customize the statefile name (default: ''). | +| --statefile-concat-cwd | If used with the '--statefile-dir' option, the latter's value will be used as a sub-directory of the current working directory. Useful on Windows when the plugin is compiled, as the file system and permissions are different from Linux. | +| --statefile-format | Define the format used to store the cache. Available formats: 'dumper', 'storable', 'json' (default). | +| --statefile-key | Define the key to encrypt/decrypt the cache. | +| --statefile-cipher | Define the cipher algorithm to encrypt the cache (default: 'AES'). | +| --warning-uptime | Warning threshold. | +| --critical-uptime | Critical threshold. | +| --add-sysdesc | Display system description. | +| --force-oid | Can choose your OID (numeric format only). | +| --check-overload | Uptime counter limit is 4294967296 and overflow. With that option, we manage the counter going back. But there is a few chance we can miss a reboot. | +| --reboot-window | To be used with check-overload option. Time in milliseconds (default: 5000) You increase the chance of not missing a reboot if you decrease that value. | +| --unit | Select the time unit for thresholds. May be 's' for seconds, 'm' for minutes, 'h' for hours, 'd' for days, 'w' for weeks. Default is seconds. | diff --git a/pp/integrations/plugin-packs/procedures/hardware-servers-hp-snmp.md b/pp/integrations/plugin-packs/procedures/hardware-servers-hp-snmp.md index 6bea304a8db8..2562bff311ca 100644 --- a/pp/integrations/plugin-packs/procedures/hardware-servers-hp-snmp.md +++ b/pp/integrations/plugin-packs/procedures/hardware-servers-hp-snmp.md @@ -5,11 +5,17 @@ title: HP Proliant SNMP import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; +## Connector dependencies + +The following monitoring connectors will be installed when you install the **HP Proliant SNMP** connector through the +**Configuration > Connectors > Monitoring Connectors** menu: +* [Base Pack](./base-generic.md) + ## Pack assets ### Templates -The Monitoring Connector **HP Proliant** brings a host template: +The Monitoring Connector **HP Proliant SNMP** brings a host template: * **HW-Server-Hp-Server-SNMP-custom** @@ -18,9 +24,9 @@ The connector brings the following service templates (sorted by the host templat -| Service Alias | Service Template | Service Description | -|:----------------|:-----------------------------------------|:--------------------| -| Hardware-Global | HW-Hp-Server-Hardware-Global-SNMP-custom | Check all hardware | +| Service Alias | Service Template | Service Description | +|:----------------|:-----------------------------------------|:----------------------------------------------------------------------| +| Hardware-Global | HW-Hp-Server-Hardware-Global-SNMP-custom | Check all hardware ('cpu', 'fan', 'temperature', 'power supply', ...) | > The services listed above are created automatically when the **HW-Server-Hp-Server-SNMP-custom** host template is used. @@ -29,13 +35,13 @@ The connector brings the following service templates (sorted by the host templat | Service Alias | Service Template | Service Description | |:---------------------|:----------------------------------------------|:-------------------------------| -| Hardware-Cpu | HW-Hp-Server-Hardware-Cpu-SNMP-custom | Check CPU hardware | +| Hardware-Cpu | HW-Hp-Server-Hardware-Cpu-SNMP-custom | Check cpu hardware | | Hardware-Fan | HW-Hp-Server-Hardware-Fan-SNMP-custom | Check fan hardware | | Hardware-Network | HW-Hp-Server-Hardware-Network-SNMP-custom | Check network hardware | | Hardware-Pc | HW-Hp-Server-Hardware-Pc-SNMP-custom | Check power converter hardware | | Hardware-Psu | HW-Hp-Server-Hardware-Psu-SNMP-custom | Check power supply hardware | | Hardware-Storage | HW-Hp-Server-Hardware-Storage-SNMP-custom | Check storage hardware | -| Hardware-Temperature | HW-Hp-Server-Hardware-Temperature-SNMP-custom | Check hardware temperature | +| Hardware-Temperature | HW-Hp-Server-Hardware-Temperature-SNMP-custom | Check hardware temperatures | > The services listed above are not created automatically when a host template is applied. To use them, [create a service manually](/docs/monitoring/basic-objects/services), then apply the service template you want. @@ -46,75 +52,75 @@ The connector brings the following service templates (sorted by the host templat #### Host discovery -| Rule name | Description | -|:----------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| SNMP Agents | Discover your resources through an SNMP subnet scan. You need to install the [Generic SNMP](./applications-protocol-snmp.md) connector to get the discovery rule and create a template mapper for the **HW-Server-Hp-Server-SNMP-custom** host template | +| Rule name | Description | +|:------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| SNMP Agents | Discover your resources through an SNMP subnet scan. You need to install the [Generic SNMP](./applications-protocol-snmp.md) connector to get the discovery rule and create a template mapper for the **HW-Server-Hp-Server-SNMP-custom** host template. | More information about discovering hosts automatically is available on the [dedicated page](/docs/monitoring/discovery/hosts-discovery). ### Collected metrics & status -Here is the list of services for this connector, detailing all metrics linked to each service. +Here is the list of services for this connector, detailing all metrics and statuses linked to each service. -| Metric name | Description | Unit | -|:------------|:------------|:-----| -| status | CPU status | N/A | +| Name | Unit | +|:-------|:-----| +| status | N/A | -| Metric name | Description | Unit | -|:-----------------------|:------------|:------| -| status | Fan status | N/A | -| hardware.fan.speed.rpm | Fan speed | Rpm | +| Name | Unit | +|:-----------------------|:-----| +| status | N/A | +| hardware.fan.speed.rpm | Rpm | -| Metric name | Description | Unit | -|:------------|:-------------------------|:------| -| status | Components global status | N/A | +| Name | Unit | +|:-------|:-----| +| status | N/A | -| Metric name | Description | Unit | -|:------------|:------------|:-----| -| status | NIC status | N/A | +| Name | Unit | +|:-------|:-----| +| status | N/A | -| Metric name | Description | Unit | -|:------------|:-----------------------|:------| -| status | Power Converter status | N/A | +| Name | Unit | +|:-------|:-----| +| status | N/A | -| Metric name | Description | Unit | -|:----------------------------------|:--------------------------------|:------| -| status | Power supply status | N/A | -| hardware.powersupply.power.watt | Power supply watt capacity used | W | -| hardware.powersupply.voltage.volt | Power supply voltage | V | +| Name | Unit | +|:----------------------------------|:-----| +| status | N/A | +| hardware.powersupply.power.watt | W | +| hardware.powersupply.voltage.volt | V | -| Metric name | Description | Unit | -|:------------|:---------------|:------| -| status | Storage status | N/A | +| Name | Unit | +|:-------|:-----| +| status | N/A | -| Metric name | Description | Unit | -|:-----------------------------|:------------------------|:------| -| status | Temperature status | N/A | -| hardware.temperature.celsius | Temperature in celsius | C | +| Name | Unit | +|:-----------------------------|:-----| +| status | N/A | +| hardware.temperature.celsius | C | @@ -123,7 +129,10 @@ Here is the list of services for this connector, detailing all metrics linked to ### SNMP Configuration -The SNMP service must be configured and activated on the host. Please refer to the official documentation from the manufacturer/publisher. +The SNMP agent must be enabled and configured on the resource. +Please refer to the official documentation. +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 @@ -134,8 +143,7 @@ SNMP port. ### Pack - The installation procedures for monitoring connectors are slightly different depending on [whether your license is offline or online](../getting-started/how-to-guides/connectors-licenses.md). - +The installation procedures for monitoring connectors are slightly different depending on [whether your license is offline or online](../getting-started/how-to-guides/connectors-licenses.md). 1. 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 @@ -174,7 +182,7 @@ yum install centreon-pack-hardware-servers-hp-snmp -2. Whatever the license type (*online* or *offline*), install the **HP Proliant** connector through +2. Whatever the license type (*online* or *offline*), install the **HP Proliant SNMP** connector through the **Configuration > Connectors > Monitoring Connectors** menu. ### Plugin @@ -227,14 +235,16 @@ yum install centreon-plugin-Hardware-Servers-Hp-Snmp 1. Log into Centreon and add a new host through **Configuration > Hosts**. 2. Fill in the **Name**, **Alias** & **IP Address/DNS** fields according to your resource's settings. -3. Apply the **HW-Server-Hp-Server-SNMP-custom** template to the host. +3. Apply the **HW-Server-Hp-Server-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](../getting-started/how-to-guides/troubleshooting-plugins.md#snmpv3-options-mapping) 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](#available-options). | | | +| Macro | Description | Default value | Mandatory | +|:------------------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------|:--------------|:---------:| +| SNMP_V3_USERNAME | SNMP v3 only: User name (`securityName`) | | | +| SNMP_V3_AUTH_PROTOCOL | SNMP v3 only: Authentication protocol: MD5\|SHA. Since net-snmp 5.9.1: SHA224\|SHA256\|SHA384\|SHA512 | | | +| SNMP_V3_PRIV_PROTOCOL | 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 | | | +| SNMP_V3_AUTH_PASSPHRASE | SNMP v3 only: Pass phrase hashed using the authentication protocol defined in the --authprotocol option | | | +| SNMP_V3_PRIV_PASSPHRASE | SNMP v3 only: Privacy pass phrase (`privPassword`) to encrypt messages using the protocol defined in the --privprotocol option | | | +| SNMPEXTRAOPTIONS | Any extra option you may want to add to every command (a --verbose flag for example). All options are listed [here](#available-options). | | | 4. [Deploy the configuration](/docs/monitoring/monitoring-servers/deploying-a-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. @@ -246,66 +256,66 @@ yum install centreon-plugin-Hardware-Servers-Hp-Snmp -| Macro | Description | Default value | Mandatory | -|:-------------|:---------------------------------------------------------------------------------------------------------------------------------------|:------------------|:-----------:| -| COMPONENT | Which component to check | cpu | | -| EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). All options are listed [here](#available-options). | --verbose | | +| Macro | Description | Default value | Mandatory | +|:-------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------|:--------------|:---------:| +| COMPONENT | Which component to check. Can be: 'cpu', 'psu', 'pc', 'fan', 'temperature', 'lnic', 'pnic',... There are some magic words like: 'network', 'storage' | cpu | | +| EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). All options are listed [here](#available-options). | --verbose | | -| Macro | Description | Default value | Mandatory | -|:-------------|:---------------------------------------------------------------------------------------------------------------------------------------|:------------------|:-----------:| -| COMPONENT | Which component to check | fan | | -| EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). All options are listed [here](#available-options). | --verbose | | +| Macro | Description | Default value | Mandatory | +|:-------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------|:--------------|:---------:| +| COMPONENT | Which component to check. Can be: 'cpu', 'psu', 'pc', 'fan', 'temperature', 'lnic', 'pnic',... There are some magic words like: 'network', 'storage' | fan | | +| EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). All options are listed [here](#available-options). | --verbose | | -| Macro | Description | Default value | Mandatory | -|:-------------|:------------------------------------------------------------------------------------------------------------------------------------------------------|:------------------|:-----------:| -| COMPONENT | Which component to check. Can be: 'cpu', 'psu', 'pc', 'fan', 'temperature', 'lnic', 'pnic',... There are some magic words like: 'network', 'storage' | .* | | -| EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). All options are listed [here](#available-options). | --verbose | | +| Macro | Description | Default value | Mandatory | +|:-------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------|:--------------|:---------:| +| COMPONENT | Which component to check. Can be: 'cpu', 'psu', 'pc', 'fan', 'temperature', 'lnic', 'pnic',... There are some magic words like: 'network', 'storage' | .* | | +| EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). All options are listed [here](#available-options). | --verbose | | -| Macro | Description | Default value | Mandatory | -|:-------------|:---------------------------------------------------------------------------------------------------------------------------------------|:------------------|:-----------:| -| COMPONENT | Which component to check | network | | -| EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). All options are listed [here](#available-options). | --verbose | | +| Macro | Description | Default value | Mandatory | +|:-------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------|:--------------|:---------:| +| COMPONENT | Which component to check. Can be: 'cpu', 'psu', 'pc', 'fan', 'temperature', 'lnic', 'pnic',... There are some magic words like: 'network', 'storage' | network | | +| EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). All options are listed [here](#available-options). | --verbose | | -| Macro | Description | Default value | Mandatory | -|:-------------|:---------------------------------------------------------------------------------------------------------------------------------------|:------------------|:-----------:| -| COMPONENT | Which component to check | pc | | -| EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). All options are listed [here](#available-options). | --verbose | | +| Macro | Description | Default value | Mandatory | +|:-------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------|:--------------|:---------:| +| COMPONENT | Which component to check. Can be: 'cpu', 'psu', 'pc', 'fan', 'temperature', 'lnic', 'pnic',... There are some magic words like: 'network', 'storage' | pc | | +| EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). All options are listed [here](#available-options). | --verbose | | -| Macro | Description | Default value | Mandatory | -|:-------------|:---------------------------------------------------------------------------------------------------------------------------------------|:------------------|:-----------:| -| COMPONENT | Which component to check | psu | | -| EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). All options are listed [here](#available-options). | --verbose | | +| Macro | Description | Default value | Mandatory | +|:-------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------|:--------------|:---------:| +| COMPONENT | Which component to check. Can be: 'cpu', 'psu', 'pc', 'fan', 'temperature', 'lnic', 'pnic',... There are some magic words like: 'network', 'storage' | psu | | +| EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). All options are listed [here](#available-options). | --verbose | | -| Macro | Description | Default value | Mandatory | -|:-------------|:---------------------------------------------------------------------------------------------------------------------------------------|:------------------|:-----------:| -| COMPONENT | Which component to check | storage | | -| EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). All options are listed [here](#available-options). | --verbose | | +| Macro | Description | Default value | Mandatory | +|:-------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------|:--------------|:---------:| +| COMPONENT | Which component to check. Can be: 'cpu', 'psu', 'pc', 'fan', 'temperature', 'lnic', 'pnic',... There are some magic words like: 'network', 'storage' | storage | | +| EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). All options are listed [here](#available-options). | --verbose | | -| Macro | Description | Default value | Mandatory | -|:-------------|:---------------------------------------------------------------------------------------------------------------------------------------|:------------------|:-----------:| -| COMPONENT | Which component to check | temperature | | -| EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). All options are listed [here](#available-options). | --verbose | | +| Macro | Description | Default value | Mandatory | +|:-------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------|:--------------|:---------:| +| COMPONENT | Which component to check. Can be: 'cpu', 'psu', 'pc', 'fan', 'temperature', 'lnic', 'pnic',... There are some magic words like: 'network', 'storage' | temperature | | +| EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). All options are listed [here](#available-options). | --verbose | | @@ -324,8 +334,13 @@ is able to monitor a resource using a command like this one (replace the sample --mode=hardware \ --hostname=10.0.0.1 \ --snmp-version='2c' \ - --snmp-community='my-snmp-community' \ - --component='cpu' \ + --snmp-community='my-snmp-community' \ + --snmp-username='username' \ + --authpassphrase='' \ + --authprotocol='' \ + --privpassphrase='' \ + --privprotocol='' \ + --component='temperature' \ --verbose ``` @@ -333,7 +348,6 @@ The expected command output is shown below: ```bash OK: All 18 components are ok [1/1 cpus, 1/1 da accelerator boards, 1/1 da controllers, 3/3 da logical drives, 12/12 da physical drives]. | 'hardware.cpu.count'=1;;;; 'hardware.daacc.count'=1;;;; 'hardware.dactl.count'=1;;;; 'hardware.daldrive.count'=3;;;; 'hardware.dapdrive.count'=12;;;; - ``` ### Troubleshooting @@ -370,172 +384,74 @@ The plugin brings the following modes: 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. | -| --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\[,\[newuom\],\[min\],\[m ax\]\] Common examples: 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()' | -| --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,namesofnewmetrics,calculation\[,\[ne wuom\],\[min\],\[max\]\] regex: regular expression namesofnewmetrics: 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 newuom (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: 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(traf fic\_(in\|out)\_$1)' | -| --change-short-output --change-long-output | Modify the short/long output that is returned by the plugin. Syntax: --change-short-output=pattern~replacement~modifier Most commonly used modifiers are i (case insensitive) and g (replace all occurrences). Example: adding --change-short-output='OK\~Up\~gi' will replace all occurrences of 'OK', 'ok', 'Ok' or 'oK' with 'Up' | -| --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. | -| --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). E.g.: --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'. | -| --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 ok, 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. | - -#### Modes options - -All available options for each service template are listed below: - - - - -| Option | Description | -|:---------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| --component | Which component to check (default: '.*'). Can be: 'cpu', 'psu', 'pc', 'fan', 'temperature', 'lnic', 'pnic',... There are some magic words like: 'network', 'storage'. | -| --filter | Exclude the items given as a comma-separated list (example: --filter=fan --filter=temperature). You can also exclude items from specific instances: --filter=fan,1.2 --filter=lnic,1 | -| --absent-problem | Return an error if an entity is not 'present' (default is skipping Can be specific or global: --absent-problem=fan,1.2 | -| --no-component | Define the expected status if no components are found (default: critical). | -| --threshold-overload | Use this option to override the status returned by the plugin when the status label matches a regular expression (syntax: section,status,regexp). Example: --threshold-overload='temperature,CRITICAL,^(?!(ok)$)' | -| --warning | Set warning threshold for temperatures (syntax: type,regexp,threshold) Example: --warning='temperature,.*,30' | -| --critical | Set critical threshold for temperatures (syntax: type,regexp,threshold) Example: --critical='temperature,.*,40' | - - - - -| Option | Description | -|:---------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| --component | Which component to check (default: '.*'). Can be: 'cpu', 'psu', 'pc', 'fan', 'temperature', 'lnic', 'pnic',... There are some magic words like: 'network', 'storage'. | -| --filter | Exclude the items given as a comma-separated list (example: --filter=fan --filter=temperature). You can also exclude items from specific instances: --filter=fan,1.2 --filter=lnic,1 | -| --absent-problem | Return an error if an entity is not 'present' (default is skipping Can be specific or global: --absent-problem=fan,1.2 | -| --no-component | Define the expected status if no components are found (default: critical). | -| --threshold-overload | Use this option to override the status returned by the plugin when the status label matches a regular expression (syntax: section,status,regexp). Example: --threshold-overload='temperature,CRITICAL,^(?!(ok)$)' | -| --warning | Set warning threshold for temperatures (syntax: type,regexp,threshold) Example: --warning='temperature,.*,30' | -| --critical | Set critical threshold for temperatures (syntax: type,regexp,threshold) Example: --critical='temperature,.*,40' | - - - - -| Option | Description | -|:---------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| --component | Which component to check (default: '.*'). Can be: 'cpu', 'psu', 'pc', 'fan', 'temperature', 'lnic', 'pnic',... There are some magic words like: 'network', 'storage'. | -| --filter | Exclude the items given as a comma-separated list (example: --filter=fan --filter=temperature). You can also exclude items from specific instances: --filter=fan,1.2 --filter=lnic,1 | -| --absent-problem | Return an error if an entity is not 'present' (default is skipping Can be specific or global: --absent-problem=fan,1.2 | -| --no-component | Define the expected status if no components are found (default: critical). | -| --threshold-overload | Use this option to override the status returned by the plugin when the status label matches a regular expression (syntax: section,status,regexp). Example: --threshold-overload='temperature,CRITICAL,^(?!(ok)$)' | -| --warning | Set warning threshold for temperatures (syntax: type,regexp,threshold) Example: --warning='temperature,.*,30' | -| --critical | Set critical threshold for temperatures (syntax: type,regexp,threshold) Example: --critical='temperature,.*,40' | - - - - -| Option | Description | -|:---------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| --component | Which component to check (default: '.*'). Can be: 'cpu', 'psu', 'pc', 'fan', 'temperature', 'lnic', 'pnic',... There are some magic words like: 'network', 'storage'. | -| --filter | Exclude the items given as a comma-separated list (example: --filter=fan --filter=temperature). You can also exclude items from specific instances: --filter=fan,1.2 --filter=lnic,1 | -| --absent-problem | Return an error if an entity is not 'present' (default is skipping Can be specific or global: --absent-problem=fan,1.2 | -| --no-component | Define the expected status if no components are found (default: critical). | -| --threshold-overload | Use this option to override the status returned by the plugin when the status label matches a regular expression (syntax: section,status,regexp). Example: --threshold-overload='temperature,CRITICAL,^(?!(ok)$)' | -| --warning | Set warning threshold for temperatures (syntax: type,regexp,threshold) Example: --warning='temperature,.*,30' | -| --critical | Set critical threshold for temperatures (syntax: type,regexp,threshold) Example: --critical='temperature,.*,40' | - - - - -| Option | Description | -|:---------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| --component | Which component to check (default: '.*'). Can be: 'cpu', 'psu', 'pc', 'fan', 'temperature', 'lnic', 'pnic',... There are some magic words like: 'network', 'storage'. | -| --filter | Exclude the items given as a comma-separated list (example: --filter=fan --filter=temperature). You can also exclude items from specific instances: --filter=fan,1.2 --filter=lnic,1 | -| --absent-problem | Return an error if an entity is not 'present' (default is skipping Can be specific or global: --absent-problem=fan,1.2 | -| --no-component | Define the expected status if no components are found (default: critical). | -| --threshold-overload | Use this option to override the status returned by the plugin when the status label matches a regular expression (syntax: section,status,regexp). Example: --threshold-overload='temperature,CRITICAL,^(?!(ok)$)' | -| --warning | Set warning threshold for temperatures (syntax: type,regexp,threshold) Example: --warning='temperature,.*,30' | -| --critical | Set critical threshold for temperatures (syntax: type,regexp,threshold) Example: --critical='temperature,.*,40' | - - - - -| Option | Description | -|:---------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| --component | Which component to check (default: '.*'). Can be: 'cpu', 'psu', 'pc', 'fan', 'temperature', 'lnic', 'pnic',... There are some magic words like: 'network', 'storage'. | -| --filter | Exclude the items given as a comma-separated list (example: --filter=fan --filter=temperature). You can also exclude items from specific instances: --filter=fan,1.2 --filter=lnic,1 | -| --absent-problem | Return an error if an entity is not 'present' (default is skipping Can be specific or global: --absent-problem=fan,1.2 | -| --no-component | Define the expected status if no components are found (default: critical). | -| --threshold-overload | Use this option to override the status returned by the plugin when the status label matches a regular expression (syntax: section,status,regexp). Example: --threshold-overload='temperature,CRITICAL,^(?!(ok)$)' | -| --warning | Set warning threshold for temperatures (syntax: type,regexp,threshold) Example: --warning='temperature,.*,30' | -| --critical | Set critical threshold for temperatures (syntax: type,regexp,threshold) Example: --critical='temperature,.*,40' | - - - - -| Option | Description | -|:---------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| --component | Which component to check (default: '.*'). Can be: 'cpu', 'psu', 'pc', 'fan', 'temperature', 'lnic', 'pnic',... There are some magic words like: 'network', 'storage'. | -| --filter | Exclude the items given as a comma-separated list (example: --filter=fan --filter=temperature). You can also exclude items from specific instances: --filter=fan,1.2 --filter=lnic,1 | -| --absent-problem | Return an error if an entity is not 'present' (default is skipping Can be specific or global: --absent-problem=fan,1.2 | -| --no-component | Define the expected status if no components are found (default: critical). | -| --threshold-overload | Use this option to override the status returned by the plugin when the status label matches a regular expression (syntax: section,status,regexp). Example: --threshold-overload='temperature,CRITICAL,^(?!(ok)$)' | -| --warning | Set warning threshold for temperatures (syntax: type,regexp,threshold) Example: --warning='temperature,.*,30' | -| --critical | Set critical threshold for temperatures (syntax: type,regexp,threshold) Example: --critical='temperature,.*,40' | - - - - -| Option | Description | -|:---------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| --component | Which component to check (default: '.*'). Can be: 'cpu', 'psu', 'pc', 'fan', 'temperature', 'lnic', 'pnic',... There are some magic words like: 'network', 'storage'. | -| --filter | Exclude the items given as a comma-separated list (example: --filter=fan --filter=temperature). You can also exclude items from specific instances: --filter=fan,1.2 --filter=lnic,1 | -| --absent-problem | Return an error if an entity is not 'present' (default is skipping Can be specific or global: --absent-problem=fan,1.2 | -| --no-component | Define the expected status if no components are found (default: critical). | -| --threshold-overload | Use this option to override the status returned by the plugin when the status label matches a regular expression (syntax: section,status,regexp). Example: --threshold-overload='temperature,CRITICAL,^(?!(ok)$)' | -| --warning | Set warning threshold for temperatures (syntax: type,regexp,threshold) Example: --warning='temperature,.*,30' | -| --critical | Set critical threshold for temperatures (syntax: type,regexp,threshold) Example: --critical='temperature,.*,40' | - - - +| 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 get-next 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 ok, 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. | +| --show-password | By default, sensitive information in command lines is hidden in debug output and replaced with `***` (however, debug logs may still display sensitive information). Using the C option will display the passwords in plain text. | +| --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\[,\[\\],\[min\],\[max\]\] Common examples: onvert 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\[,\[\\],\[min\],\[max\]\] Common examples: onvert 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\[,\[\\],\[min\],\[max\]\] Common examples: onvert 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,\,calculation\[,\[\\],\[min\],\[max\]\] regex: regular expression \: 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 \ (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: um 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~replacement~modifier Most commonly used modifiers are i (case insensitive) and g (replace all occurrences). Example: adding --change-short-output='OK~Up~gi' will replace all occurrences of 'OK', 'ok', 'Ok' or 'oK' with 'Up' | +| --change-short-output | Modify the short/long output that is returned by the plugin. Syntax: --change-short-output=pattern~replacement~modifier Most commonly used modifiers are i (case insensitive) and g (replace all occurrences). Example: adding --change-short-output='OK~Up~gi' will replace all occurrences of 'OK', 'ok', 'Ok' or 'oK' with 'Up' | +| --change-long-output | Modify the short/long output that is returned by the plugin. Syntax: --change-short-output=pattern~replacement~modifier Most commonly used modifiers are i (case insensitive) and g (replace all occurrences). Example: adding --change-short-output='OK~Up~gi' will replace all occurrences of 'OK', 'ok', 'Ok' or 'oK' with 'Up' | +| --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'. \. | +| --component | Which component to check (default: '.*'). Can be: 'cpu', 'psu', 'pc', 'fan', 'temperature', 'lnic', 'pnic',... There are some magic words like: 'network', 'storage'. | +| --filter | Exclude the items given as a comma-separated list (example: --filter=fan --filter=temperature). You can also exclude items from specific instances: --filter=fan,1.2 --filter=lnic,1 | +| --absent-problem | Return an error if an entity is not 'present' (default is skipping Can be specific or global: --absent-problem=fan,1.2 | +| --no-component | Define the expected status if no components are found (default: critical). | +| --threshold-overload | Use this option to override the status returned by the plugin when the status label matches a regular expression (syntax: section,status,regexp). Example: --threshold-overload='temperature,CRITICAL,^(?!(ok)$)' | +| --warning | Set warning threshold for temperatures (syntax: type,regexp,threshold) Example: --warning='temperature,.*,30' | +| --critical | Set critical threshold for temperatures (syntax: type,regexp,threshold) Example: --critical='temperature,.*,40' | All available options for a given mode can be displayed by adding the `--help` parameter to the command: diff --git a/pp/integrations/plugin-packs/procedures/hardware-storage-qnap-snmp.md b/pp/integrations/plugin-packs/procedures/hardware-storage-qnap-snmp.md index 0378b0234d4d..77ba37ddb17c 100644 --- a/pp/integrations/plugin-packs/procedures/hardware-storage-qnap-snmp.md +++ b/pp/integrations/plugin-packs/procedures/hardware-storage-qnap-snmp.md @@ -7,19 +7,15 @@ import TabItem from '@theme/TabItem'; ## Connector dependencies -The following monitoring connectors will be installed when you install the **Qnap** connector through the +The following monitoring connectors will be installed when you install the **Qnap SNMP** connector through the **Configuration > Connectors > Monitoring Connectors** menu: * [Base Pack](./base-generic.md) ## Pack assets -### Supported equipment models - -* EKI using the QTS and QuTS hero operating system. - ### Templates -The Monitoring Connector **Qnap** brings a host template: +The Monitoring Connector **Qnap SNMP** brings a host template: * **HW-Storage-Qnap-SNMP-custom** @@ -31,7 +27,7 @@ The connector brings the following service templates (sorted by the host templat | Service Alias | Service Template | Service Description | |:----------------|:--------------------------------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------| | Cpu | HW-Storage-Qnap-Cpu-SNMP-custom | Check the rate of utilization of CPU for the machine. This check can give the average CPU utilization rate and the rate per CPU for multi-core CPU | -| Hardware-Global | HW-Storage-Qnap-Hardware-Global-SNMP-custom | Check hardware | +| Hardware-Global | HW-Storage-Qnap-Hardware-Global-SNMP-custom | Check hardware ('fan', 'temperature', 'disk') | | Memory | HW-Storage-Qnap-Memory-SNMP-custom | Check the memory usage | | Volumes | HW-Storage-Qnap-Volumes-SNMP-custom | Check volumes | @@ -40,13 +36,13 @@ The connector brings the following service templates (sorted by the host templat -| Service Alias | Service Template | Service Description | Discovery | -|:---------------------|:-------------------------------------------------|:---------------------------------------------------------------------------------------------|:----------:| -| Disk-Global | HW-Storage-Qnap-Disk-Global-SNMP-custom | Check the rate of free space on disks. For each check the mount point of disks will appear | X | -| Pools | HW-Storage-Qnap-Pools-SNMP-custom | Check pools | | -| Traffic-Generic-Id | HW-Storage-Qnap-Traffic-Generic-Id-SNMP-custom | Check traffic of a network interface | | -| Traffic-Generic-Name | HW-Storage-Qnap-Traffic-Generic-Name-SNMP-custom | Check traffic of a network interface | | -| Traffic-Global | HW-Storage-Qnap-Traffic-Global-SNMP-custom | Check traffic of multiple network interfaces | X | +| Service Alias | Service Template | Service Description | Discovery | +|:---------------------|:-------------------------------------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------|:---------:| +| Disk-Global | HW-Storage-Qnap-Disk-Global-SNMP-custom | Check the rate of free space on disks. For each checks the mount point of disks will appear (« label »). Thresholds can be in percentage or in free space remaining | X | +| Pools | HW-Storage-Qnap-Pools-SNMP-custom | Check pools | | +| Traffic-Generic-Id | HW-Storage-Qnap-Traffic-Generic-Id-SNMP-custom | Check traffic of an network interface | | +| Traffic-Generic-Name | HW-Storage-Qnap-Traffic-Generic-Name-SNMP-custom | Check traffic of an network interface | | +| Traffic-Global | HW-Storage-Qnap-Traffic-Global-SNMP-custom | Check traffic of multiple network interfaces | X | > The services listed above are not created automatically when a host template is applied. To use them, [create a service manually](/docs/monitoring/basic-objects/services), then apply the service template you want. @@ -59,9 +55,9 @@ The connector brings the following service templates (sorted by the host templat #### Host discovery -| Rule name | Description | -|:----------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| SNMP Agents | Discover your resources through an SNMP subnet scan. You need to install the [Generic SNMP](./applications-protocol-snmp.md) connector to get the discovery rule and create a template mapper for the **HW-Storage-Qnap-SNMP-custom** host template. | +| Rule name | Description | +|:------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| SNMP Agents | Discover your resources through an SNMP subnet scan. You need to install the [Generic SNMP](./applications-protocol-snmp.md) connector to get the discovery rule and create a template mapper for the **HW-Storage-Qnap-SNMP-custom** host template. | More information about discovering hosts automatically is available on the [dedicated page](/docs/monitoring/discovery/hosts-discovery). @@ -82,10 +78,10 @@ Here is the list of services for this connector, detailing all metrics and statu -| Name | Unit | -|:-------------------------------------------|:------| -| cpu.utilization.percentage | % | -| *cpu_core*#core.cpu.utilization.percentage | % | +| Name | Unit | +|:-------------------------------------------|:-----| +| cpu.utilization.percentage | % | +| *cpu_core*#core.cpu.utilization.percentage | % | > To obtain this new metric format, include **--use-new-perfdata** in the **EXTRAOPTIONS** service macro. @@ -103,53 +99,60 @@ Here is the list of services for this connector, detailing all metrics and statu -| Name | Unit | -|:-----------------------------------|:-----| -| hardware.temperature.celsius | C | -| hardware.disk.temperature.celsius | C | -| hardware.mdisk.temperature.celsius | C | -| hardware.fan.speed.rpm | rpm | -| hardware.powersupply.fan.speed.rpm | N/A | +| Name | Unit | +|:---------------------------|:------| +| hardware.disk.count | count | +| disk status | N/A | +| hardware.fan.count | count | +| fan status | N/A | +| hardware.mdisk.count | count | +| mdisk status | N/A | +| hardware.psu.count | count | +| psu status | N/A | +| hardware.raid.count | count | +| raid status | N/A | +| hardware.temperature.count | count | +| temperature status | N/A | -| Name | Unit | -|:------------------------|:------| -| memory.usage.bytes | B | -| memory.free.bytes | B | -| memory.usage.percentage | % | +| Name | Unit | +|:------------------------|:-----| +| memory.usage.bytes | B | +| memory.free.bytes | B | +| memory.usage.percentage | % | -| Name | Unit | -|:------------------------------------|:------| -| pool-status | N/A | -| *pools*~pool.space.usage.bytes | B | -| *pools*~pool.space.free.bytes | B | -| *pools*~pool.space.usage.percentage | % | +| Name | Unit | +|:------------------------------------|:-----| +| pool-status | N/A | +| *pools*~pool.space.usage.bytes | B | +| *pools*~pool.space.free.bytes | B | +| *pools*~pool.space.usage.percentage | % | -| Name | Unit | -|:-----------------------------------------------------|:------| -| status | N/A | -| *interface_name*#interface.traffic.in.bitspersecond | b/s | -| *interface_name*#interface.traffic.out.bitspersecond | b/s | +| Name | Unit | +|:-----------------------------------------------------|:-----| +| status | N/A | +| *interface_name*#interface.traffic.in.bitspersecond | b/s | +| *interface_name*#interface.traffic.out.bitspersecond | b/s | > Applies to the following service templates: Traffic-Generic-Id, Traffic-Generic-Name, Traffic-Global -| Name | Unit | -|:----------------------------------------|:------| -| volume-status | N/A | -| *volumes*~volume.space.usage.bytes | B | -| *volumes*~volume.space.free.bytes | B | -| *volumes*~volume.space.usage.percentage | % | +| Name | Unit | +|:----------------------------------------|:-----| +| volume-status | N/A | +| *volumes*~volume.space.usage.bytes | B | +| *volumes*~volume.space.free.bytes | B | +| *volumes*~volume.space.usage.percentage | % | @@ -172,8 +175,7 @@ SNMP port. ### Pack - The installation procedures for monitoring connectors are slightly different depending on [whether your license is offline or online](../getting-started/how-to-guides/connectors-licenses.md). - +The installation procedures for monitoring connectors are slightly different depending on [whether your license is offline or online](../getting-started/how-to-guides/connectors-licenses.md). 1. 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 @@ -212,7 +214,7 @@ yum install centreon-pack-hardware-storage-qnap-snmp -2. Whatever the license type (*online* or *offline*), install the **Qnap** connector through +2. Whatever the license type (*online* or *offline*), install the **Qnap SNMP** connector through the **Configuration > Connectors > Monitoring Connectors** menu. ### Plugin @@ -265,14 +267,16 @@ yum install centreon-plugin-Hardware-Storage-Qnap-Snmp 1. Log into Centreon and add a new host through **Configuration > Hosts**. 2. Fill in the **Name**, **Alias** & **IP Address/DNS** fields according to your resource's settings. -3. Apply the **HW-Storage-Qnap-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](../getting-started/how-to-guides/troubleshooting-plugins.md#snmpv3-options-mapping) section. +3. Apply the **HW-Storage-Qnap-SNMP-custom** template to the host. -| 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](#available-options). | | | +| Macro | Description | Default value | Mandatory | +|:------------------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------|:--------------|:---------:| +| SNMP_V3_USERNAME | SNMP v3 only: User name (`securityName`) | | | +| SNMP_V3_AUTH_PROTOCOL | SNMP v3 only: Authentication protocol: MD5\|SHA. Since net-snmp 5.9.1: SHA224\|SHA256\|SHA384\|SHA512 | | | +| SNMP_V3_PRIV_PROTOCOL | 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 | | | +| SNMP_V3_AUTH_PASSPHRASE | SNMP v3 only: Pass phrase hashed using the authentication protocol defined in the --authprotocol option | | | +| SNMP_V3_PRIV_PASSPHRASE | SNMP v3 only: Privacy pass phrase (`privPassword`) to encrypt messages using the protocol defined in the --privprotocol option | | | +| SNMPEXTRAOPTIONS | Any extra option you may want to add to every command (a --verbose flag for example). All options are listed [here](#available-options). | | | 4. [Deploy the configuration](/docs/monitoring/monitoring-servers/deploying-a-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. @@ -284,113 +288,113 @@ yum install centreon-plugin-Hardware-Storage-Qnap-Snmp -| Macro | Description | Default value | Mandatory | -|:-------------|:---------------------------------------------------------------------------------------------------------------------------------------|:------------------|:-----------:| -| WARNING | Warning threshold average CPU utilization | 80 | | -| CRITICAL | Critical threshold for average CPU utilization | 90 | | -| EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). All options are listed [here](#available-options). | | | +| Macro | Description | Default value | Mandatory | +|:-------------|:-------------------------------------------------------------------------------------------------------------------------------------------------|:--------------|:---------:| +| WARNING | Warning threshold average CPU utilization | 80 | | +| CRITICAL | Critical threshold average CPU utilization | 90 | | +| EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). All options are listed [here](#available-options). | | | -| Macro | Description | Default value | Mandatory | -|:-------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:------------------|:-----------:| -| FILTER | Set the storage (number expected) example: 1, 2,... (empty means 'check all storage') | .* | | -| TRANSFORMDST | Modify the storage name displayed by using a regular expression. Example: adding --display-transform-src='dev' --display-transform-dst='run' will replace all occurrences of 'dev' with 'run' | | | -| TRANSFORMSRC | Modify the storage name displayed by using a regular expression. Example: adding --display-transform-src='dev' --display-transform-dst='run' will replace all occurrences of 'dev' with 'run' | | | -| CRITICAL | Critical threshold | 90 | | -| WARNING | Warning threshold | 80 | | -| EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). All options are listed [here](#available-options). | --verbose | | +| Macro | Description | Default value | Mandatory | +|:-------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:--------------|:---------:| +| FILTER | Set the storage (number expected) example: 1, 2,... (empty means 'check all storage') | .* | | +| TRANSFORMDST | Modify the storage name displayed by using a regular expression. Example: adding --display-transform-src='dev' --display-transform-dst='run' will replace all occurrences of 'dev' with 'run' | | | +| TRANSFORMSRC | Modify the storage name displayed by using a regular expression. Example: adding --display-transform-src='dev' --display-transform-dst='run' will replace all occurrences of 'dev' with 'run' | | | +| CRITICAL | Critical threshold | 90 | | +| WARNING | Warning threshold | 80 | | +| EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). All options are listed [here](#available-options). | --verbose | | -| Macro | Description | Default value | Mandatory | -|:-------------|:---------------------------------------------------------------------------------------------------------------------------------------|:------------------|:-----------:| -| COMPONENT | Which component to check (default: '.*'). Can be: 'disk', 'fan', 'mdisk', 'psu', 'raid', 'temperature' | .* | | -| EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). All options are listed [here](#available-options). | --verbose | | +| Macro | Description | Default value | Mandatory | +|:-------------|:-------------------------------------------------------------------------------------------------------------------------------------------------|:--------------|:---------:| +| COMPONENT | Which component to check. Can be: 'disk', 'fan', 'mdisk', 'psu', 'raid', 'temperature' | .* | | +| EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). All options are listed [here](#available-options). | --verbose | | -| Macro | Description | Default value | Mandatory | -|:------------------------|:---------------------------------------------------------------------------------------------------------------------------------------|:------------------|:-----------:| -| WARNINGMEMORYUSAGE | Threshold | | | -| CRITICALMEMORYUSAGE | Threshold | | | -| WARNINGMEMORYUSAGEFREE | Threshold | | | -| CRITICALMEMORYUSAGEFREE | Threshold | | | -| WARNINGMEMORYUSAGEPRCT | Threshold | | | -| CRITICALMEMORYUSAGEPRCT | Threshold | | | -| EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). All options are listed [here](#available-options). | | | +| Macro | Description | Default value | Mandatory | +|:------------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------|:--------------|:---------:| +| WARNINGMEMORYUSAGE | Threshold | | | +| CRITICALMEMORYUSAGE | Threshold | | | +| WARNINGMEMORYUSAGEFREE | Threshold | | | +| CRITICALMEMORYUSAGEFREE | Threshold | | | +| WARNINGMEMORYUSAGEPRCT | Threshold | | | +| CRITICALMEMORYUSAGEPRCT | Threshold | | | +| EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). All options are listed [here](#available-options). | | | -| Macro | Description | Default value | Mandatory | -|:-----------------------|:---------------------------------------------------------------------------------------------------------------------------------------|:----------------------------------|:-----------:| -| FILTERNAME | Filter pools by name (can be a regexp) | | | -| WARNINGPOOLSTATUS | Define the conditions to match for the status to be WARNING. You can use the following variables: %\{status\}, %\{name\} | %\{status\} =~ /degraded\|warning/i | | -| CRITICALPOOLSTATUS | Define the conditions to match for the status to be CRITICAL. You can use the following variables: %\{status\}, %\{name\} | %\{status\} =~ /error\|critical/i | | -| WARNINGSPACEUSAGE | Threshold | | | -| CRITICALSPACEUSAGE | Threshold | | | -| WARNINGSPACEUSAGEFREE | Threshold | | | -| CRITICALSPACEUSAGEFREE | Threshold | | | -| WARNINGSPACEUSAGEPRCT | Threshold | | | -| CRITICALSPACEUSAGEPRCT | Threshold | | | -| EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). All options are listed [here](#available-options). | --verbose | | +| Macro | Description | Default value | Mandatory | +|:-----------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------|:------------------------------------|:---------:| +| FILTERNAME | Filter pools by name (can be a regexp) | | | +| WARNINGPOOLSTATUS | Define the conditions to match for the status to be WARNING. You can use the following variables: %\{status\}, %\{name\} | %\{status\} =~ /degraded\|warning/i | | +| CRITICALPOOLSTATUS | Define the conditions to match for the status to be CRITICAL. You can use the following variables: %\{status\}, %\{name\} | %\{status\} =~ /error\|critical/i | | +| WARNINGSPACEUSAGE | Threshold | | | +| CRITICALSPACEUSAGE | Threshold | | | +| WARNINGSPACEUSAGEFREE | Threshold | | | +| CRITICALSPACEUSAGEFREE | Threshold | | | +| WARNINGSPACEUSAGEPRCT | Threshold | | | +| CRITICALSPACEUSAGEPRCT | Threshold | | | +| EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). All options are listed [here](#available-options). | --verbose | | -| Macro | Description | Default value | Mandatory | -|:-------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------|:------------------|:-----------:| -| INTERFACEID | Define the interface filter on IDs (OID indexes, e.g.: 1,2,...). If empty, all interfaces will be monitored. To filter on interface names, see --name | | | -| CRITICALIN | Threshold | 90 | | -| WARNINGIN | Threshold | 80 | | -| CRITICALOUT | Threshold | 90 | | -| WARNINGOUT | Threshold | 80 | | -| EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). All options are listed [here](#available-options). | | | +| Macro | Description | Default value | Mandatory | +|:-------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------|:--------------|:---------:| +| INTERFACEID | Check only the interfaces with the specified IDs (OID indexes, e.g.: 1,2,...). If empty, all interfaces will be monitored. To filter on interface names, see --name | | | +| CRITICALIN | Thresholds | 90 | | +| WARNINGIN | Thresholds | 80 | | +| CRITICALOUT | Thresholds | 90 | | +| WARNINGOUT | Thresholds | 80 | | +| EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). All options are listed [here](#available-options). | | | -| Macro | Description | Default value | Mandatory | -|:--------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------|:------------------|:-----------:| -| INTERFACENAME | Define the interface filter on IDs (OID indexes, e.g.: 1,2,...). If empty, all interfaces will be monitored. To filter on interface names, see --name | | | -| CRITICALIN | Threshold | 90 | | -| WARNINGIN | Threshold | 80 | | -| CRITICALOUT | Threshold | 90 | | -| WARNINGOUT | Threshold | 80 | | -| EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). All options are listed [here](#available-options). | | | +| Macro | Description | Default value | Mandatory | +|:--------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------|:--------------|:---------:| +| INTERFACENAME | Check only the interfaces with the specified IDs (OID indexes, e.g.: 1,2,...). If empty, all interfaces will be monitored. To filter on interface names, see --name | | | +| CRITICALIN | Thresholds | 90 | | +| WARNINGIN | Thresholds | 80 | | +| CRITICALOUT | Thresholds | 90 | | +| WARNINGOUT | Thresholds | 80 | | +| EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). All options are listed [here](#available-options). | | | -| Macro | Description | Default value | Mandatory | -|:---------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:------------------|:-----------:| -| FILTER | Define the interface filter on IDs (OID indexes, e.g.: 1,2,...). If empty, all interfaces will be monitored. To filter on interface names, see --name | .* | | -| CRITICALIN | Threshold | 90 | | -| WARNINGIN | Threshold | 80 | | -| CRITICALOUT | Threshold | 90 | | -| WARNINGOUT | Threshold | 80 | | -| CRITICALSTATUS | Define the conditions to match for the status to be CRITICAL (default: '%\{admstatus\} eq "up" and %\{opstatus\} ne "up"'). You can use the following variables: %\{admstatus\}, %\{opstatus\}, %\{duplexstatus\}, %\{display\} | | | -| EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). All options are listed [here](#available-options). | --verbose | | +| Macro | Description | Default value | Mandatory | +|:---------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------|:-------------------------------------------------|:---------:| +| FILTER | Check only the interfaces with the specified IDs (OID indexes, e.g.: 1,2,...). If empty, all interfaces will be monitored. To filter on interface names, see --name | .* | | +| CRITICALIN | Thresholds | 90 | | +| WARNINGIN | Thresholds | 80 | | +| CRITICALOUT | Thresholds | 90 | | +| WARNINGOUT | Thresholds | 80 | | +| CRITICALSTATUS | Define the conditions to match for the status to be CRITICAL. You can use the following variables: %\{admstatus\}, %\{opstatus\}, %\{duplexstatus\}, %\{display\} | %\{admstatus\} eq "up" and %\{opstatus\} ne "up" | | +| EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). All options are listed [here](#available-options). | --verbose | | -| Macro | Description | Default value | Mandatory | -|:-----------------------|:---------------------------------------------------------------------------------------------------------------------------------------|:----------------------------------|:-----------:| -| FILTERNAME | Filter volumes by name (can be a regexp) | | | -| WARNINGSPACEUSAGE | Threshold | | | -| CRITICALSPACEUSAGE | Threshold | | | -| WARNINGSPACEUSAGEFREE | Threshold | | | -| CRITICALSPACEUSAGEFREE | Threshold | | | -| WARNINGSPACEUSAGEPRCT | Threshold | | | -| CRITICALSPACEUSAGEPRCT | Threshold | | | -| WARNINGVOLUMESTATUS | Define the conditions to match for the status to be WARNING. You can use the following variables: %\{status\}, %\{name\} | %\{status\} =~ /degraded\|warning/i | | -| CRITICALVOLUMESTATUS | Define the conditions to match for the status to be CRITICAL. You can use the following variables: %\{status\}, %\{name\} | %\{status\} =~ /critical/i | | -| EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). All options are listed [here](#available-options). | --verbose | | +| Macro | Description | Default value | Mandatory | +|:-----------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------|:------------------------------------|:---------:| +| FILTERNAME | Filter volumes by name (can be a regexp) | | | +| WARNINGSPACEUSAGE | Threshold | | | +| CRITICALSPACEUSAGE | Threshold | | | +| WARNINGSPACEUSAGEFREE | Threshold | | | +| CRITICALSPACEUSAGEFREE | Threshold | | | +| WARNINGSPACEUSAGEPRCT | Threshold | | | +| CRITICALSPACEUSAGEPRCT | Threshold | | | +| WARNINGVOLUMESTATUS | Define the conditions to match for the status to be WARNING. You can use the following variables: %\{status\}, %\{name\} | %\{status\} =~ /degraded\|warning/i | | +| CRITICALVOLUMESTATUS | Define the conditions to match for the status to be CRITICAL. You can use the following variables: %\{status\}, %\{name\} | %\{status\} =~ /critical/i | | +| EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). All options are listed [here](#available-options). | --verbose | | @@ -409,12 +413,17 @@ is able to monitor a resource using a command like this one (replace the sample --mode=interfaces \ --hostname=10.0.0.1 \ --snmp-version='2c' \ - --snmp-community='my-snmp-community' \ + --snmp-community='my-snmp-community' \ + --snmp-username='username' \ + --authpassphrase='' \ + --authprotocol='' \ + --privpassphrase='' \ + --privprotocol='' \ --interface='.*' \ --name \ --add-status \ --add-traffic \ - --critical-status='' \ + --critical-status='%\{admstatus\} eq "up" and %\{opstatus\} ne "up"' \ --warning-in-traffic='80' \ --critical-in-traffic='90' \ --warning-out-traffic='80' \ @@ -474,65 +483,67 @@ The plugin brings the following modes: 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 ok, 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\[,\[newuom\],\[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\[,\[newuom\],\[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\[,\[newuom\],\[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,namesofnewmetrics,calculation\[,\[newuom\],\[min\],\[max\]\] regex: regular expression namesofnewmetrics: 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 newuom (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~replacement~modifier Most commonly used modifiers are i (case insensitive) and g (replace all occurrences). Example: adding --change-short-output='OK\~Up\~gi' will replace all occurrences of 'OK', 'ok', 'Ok' or 'oK' with 'Up' | -| --change-short-output | Modify the short/long output that is returned by the plugin. Syntax: --change-short-output=pattern~replacement~modifier Most commonly used modifiers are i (case insensitive) and g (replace all occurrences). Example: adding --change-short-output='OK\~Up\~gi' will replace all occurrences of 'OK', 'ok', 'Ok' or 'oK' with 'Up' | -| --change-long-output | Modify the short/long output that is returned by the plugin. Syntax: --change-short-output=pattern~replacement~modifier Most commonly used modifiers are i (case insensitive) and g (replace all occurrences). Example: adding --change-short-output='OK\~Up\~gi' will replace all occurrences of 'OK', 'ok', 'Ok' or 'oK' with 'Up' | -| --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. | -| --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). E.g.: --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\. =cut | +| 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 get-next 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 ok, 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. | +| --show-password | By default, sensitive information in command lines is hidden in debug output and replaced with `***` (however, debug logs may still display sensitive information). Using the C option will display the passwords in plain text. | +| --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\[,\[\\],\[min\],\[max\]\] Common examples: onvert 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\[,\[\\],\[min\],\[max\]\] Common examples: onvert 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\[,\[\\],\[min\],\[max\]\] Common examples: onvert 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,\,calculation\[,\[\\],\[min\],\[max\]\] regex: regular expression \: 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 \ (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: um 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~replacement~modifier Most commonly used modifiers are i (case insensitive) and g (replace all occurrences). Example: adding --change-short-output='OK~Up~gi' will replace all occurrences of 'OK', 'ok', 'Ok' or 'oK' with 'Up' | +| --change-short-output | Modify the short/long output that is returned by the plugin. Syntax: --change-short-output=pattern~replacement~modifier Most commonly used modifiers are i (case insensitive) and g (replace all occurrences). Example: adding --change-short-output='OK~Up~gi' will replace all occurrences of 'OK', 'ok', 'Ok' or 'oK' with 'Up' | +| --change-long-output | Modify the short/long output that is returned by the plugin. Syntax: --change-short-output=pattern~replacement~modifier Most commonly used modifiers are i (case insensitive) and g (replace all occurrences). Example: adding --change-short-output='OK~Up~gi' will replace all occurrences of 'OK', 'ok', 'Ok' or 'oK' with 'Up' | +| --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'. \. | #### Modes options @@ -541,152 +552,200 @@ All available options for each service template are listed below: -| Option | Description | -|:-------------------|:------------------------------------------------------------------------------------------------------------------------------| -| --filter-counters | Only display some counters (regexp can be used). Example to check SSL connections only : --filter-counters='^xxxx\|yyyy$' | -| --use-ucd | Use UCD mib for CPU average. | -| --warning-average | Warning threshold average CPU utilization. | -| --critical-average | Critical threshold average CPU utilization. | -| --warning-core | Warning thresholds for each CPU core | -| --critical-core | Critical thresholds for each CPU core | +| Option | Description | +|:-------------------|:--------------------------------------------------------------------------------------------------------------------------| +| --filter-counters | Only display some counters (regexp can be used). Example to check SSL connections only : --filter-counters='^xxxx\|yyyy$' | +| --warning-xxx | Warning threshold. | +| --critical-xxx | Critical threshold. | +| --use-ucd | Use UCD MIB for CPU average. | +| --warning-average | Warning threshold average CPU utilization. | +| --critical-average | Critical threshold average CPU utilization. | +| --warning-core | Warning thresholds for each CPU core | +| --critical-core | Critical thresholds for each CPU core | -| Option | Description | -|:------------------------------------------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| --filter-counters | Only display some counters (regexp can be used). Example to check SSL connections only : --filter-counters='^xxxx\|yyyy$' | -| --memcached | Memcached server to use (only one server). | -| --redis-server | Redis server to use (only one server). Syntax: address\[:port\] | -| --redis-attribute | Set Redis Options (--redis-attribute="cnx\_timeout=5"). | -| --redis-db | Set Redis database index. | -| --failback-file | Fall back on a local file if Redis connection fails. | -| --memexpiration | Time to keep data in seconds (default: 86400). | -| --statefile-dir | Define the cache directory (default: '/var/lib/centreon/centplugins'). | -| --statefile-suffix | Define a suffix to customize the statefile name (default: ''). | -| --statefile-concat-cwd | If used with the '--statefile-dir' option, the latter's value will be used as a sub-directory of the current working directory. Useful on Windows when the plugin is compiled, as the file system and permissions are different from Linux. | -| --statefile-format | Define the format used to store the cache. Available formats: 'dumper', 'storable', 'json' (default). | -| --statefile-key | Define the key to encrypt/decrypt the cache. | -| --statefile-cipher | Define the cipher algorithm to encrypt the cache (default: 'AES'). | -| --warning-usage | Warning threshold. | -| --critical-usage | Critical threshold. | -| --warning-access | Warning threshold. | -| --critical-access | Critical threshold. Check if storage is readOnly: --critical-access=readOnly | -| --add-access | Check storage access (readOnly, readWrite). | -| --units | Units of thresholds (default: '%') ('%', 'B'). | -| --free | Thresholds are on free space left. | -| --storage | Set the storage (number expected) example: 1, 2,... (empty means 'check all storage'). | -| --name | Allows to use storage name with option --storage instead of storage oid index. | -| --regexp | Allows to use regexp to filter storage (with option --name). | -| --regexp-insensitive | Allows to use regexp non case-sensitive (with --regexp). | -| --path-best-match | Allows to select best path mount point (with --name). | -| --reload-cache-time | Time in minutes before reloading cache file (default: 180). | -| --oid-filter | Choose OID used to filter storage (default: hrStorageDescr) (values: hrStorageDescr, hrFSMountPoint). | -| --oid-display | Choose OID used to display storage (default: hrStorageDescr) (values: hrStorageDescr, hrFSMountPoint). | -| --display-transform-src --display-transform-dst | Modify the storage name displayed by using a regular expression. Example: adding --display-transform-src='dev' --display-transform-dst='run' will replace all occurrences of 'dev' with 'run' | -| --show-cache | Display cache storage data. | -| --space-reservation | Some filesystem has space reserved (like ext4 for root). The value is in percent of total (default: none) (results like 'df' command). | -| --filter-duplicate | Filter duplicate storages (in used size and total size). | -| --filter-storage-type | Filter storage types with a regexp (default: '^(hrStorageFixedDisk\|hrStorageNetworkDisk\|hrFSBerkeleyFFS)$'). | +| Option | Description | +|:------------------------------------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| --filter-counters | Only display some counters (regexp can be used). Example to check SSL connections only : --filter-counters='^xxxx\|yyyy$' | +| --warning-xxx | Warning threshold. | +| --critical-xxx | Critical threshold. | +| --memcached | Memcached server to use (only one server). | +| --redis-server | Redis server to use (only one server). Syntax: address\[:port\] | +| --redis-attribute | Set Redis Options (--redis-attribute="cnx\_timeout=5"). | +| --redis-db | Set Redis database index. | +| --failback-file | Fall back on a local file if Redis connection fails. | +| --memexpiration | Time to keep data in seconds (default: 86400). | +| --statefile-dir | Define the cache directory (default: '/var/lib/centreon/centplugins'). | +| --statefile-suffix | Define a suffix to customize the statefile name (default: ''). | +| --statefile-concat-cwd | If used with the '--statefile-dir' option, the latter's value will be used as a sub-directory of the current working directory. Useful on Windows when the plugin is compiled, as the file system and permissions are different from Linux. | +| --statefile-format | Define the format used to store the cache. Available formats: 'dumper', 'storable', 'json' (default). | +| --statefile-key | Define the key to encrypt/decrypt the cache. | +| --statefile-cipher | Define the cipher algorithm to encrypt the cache (default: 'AES'). | +| --warning-usage | Warning threshold. | +| --critical-usage | Critical threshold. | +| --warning-access | Warning threshold. | +| --critical-access | Critical threshold. Check if storage is readOnly: --critical-access=readOnly | +| --add-access | Check storage access (readOnly, readWrite). | +| --units | Units of thresholds (default: '%') ('%', 'B'). | +| --free | Thresholds are on free space left. | +| --storage | Set the storage (number expected) example: 1, 2,... (empty means 'check all storage'). | +| --name | Allows to use storage name with option --storage instead of storage oid index. | +| --regexp | Allows to use regexp to filter storage (with option --name). | +| --regexp-insensitive | Allows to use regexp non case-sensitive (with --regexp). | +| --path-best-match | Allows to select best path mount point (with --name). | +| --reload-cache-time | Time in minutes before reloading cache file (default: 180). | +| --oid-filter | Choose OID used to filter storage (default: hrStorageDescr) (values: hrStorageDescr, hrFSMountPoint). | +| --oid-display | Choose OID used to display storage (default: hrStorageDescr) (values: hrStorageDescr, hrFSMountPoint). | +| --display-transform-src --display-transform-dst | Modify the storage name displayed by using a regular expression. Example: adding --display-transform-src='dev' --display-transform-dst='run' will replace all occurrences of 'dev' with 'run' | +| --show-cache | Display cache storage data. | +| --space-reservation | Some filesystem has space reserved (like ext4 for root). The value is in percent of total (default: none) (results like 'df' command). | +| --filter-duplicate | Filter duplicate storages (in used size and total size). | +| --filter-storage-type | Filter storage types with a regexp (default: '^(hrStorageFixedDisk\|hrStorageNetworkDisk\|hrFSBerkeleyFFS)$'). | -| Option | Description | -|:---------------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| --component | Which component to check (default: '.*'). Can be: 'disk', 'fan', 'mdisk', 'psu', 'raid', 'temperature'. | -| --filter | Exclude the items given as a comma-separated list (example: --filter=disk). You can also exclude items from specific instances: --filter=disk,1 | -| --absent-problem | Return an error if an entity is not 'present' (default is skipping) (comma separated list) Can be specific or global: --absent-problem=disk | -| --no-component | Define the expected status if no components are found (default: critical). | -| --threshold-overload | Use this option to override the status returned by the plugin when the status label matches a regular expression (syntax: section,status,regexp). Example: --threshold-overload='disk,CRITICAL,^(?!(ready)$)' | -| --warning | Set warning threshold for temperatures (syntax: type,regexp,threshold) Example: --warning='temperature,cpu,30' --warning='fan,.*,1500' | -| --critical | Set critical threshold for temperatures (syntax: type,regexp,threshold) Example: --critical='temperature,system,40' --critical='disk,.*,40' | -| --warning-count-* | Define the warning threshold for the number of components of one type (replace '*' with the component type). | -| --critical-count-* | Define the critical threshold for the number of components of one type (replace '*' with the component type). | +| Option | Description | +|:---------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| --component | Which component to check (default: '.*'). Can be: 'disk', 'fan', 'mdisk', 'psu', 'raid', 'temperature'. | +| --filter | Exclude the items given as a comma-separated list (example: --filter=disk). You can also exclude items from specific instances: --filter=disk,1 | +| --absent-problem | Return an error if an entity is not 'present' (default is skipping) (comma separated list) Can be specific or global: --absent-problem=disk | +| --no-component | Define the expected status if no components are found (default: critical). | +| --threshold-overload | Use this option to override the status returned by the plugin when the status label matches a regular expression (syntax: section,status,regexp). Example: --threshold-overload='disk,CRITICAL,^(?!(ready)$)' | +| --warning | Set warning threshold for temperatures (syntax: type,regexp,threshold) Example: --warning='temperature,cpu,30' --warning='fan,.*,1500' | +| --critical | Set critical threshold for temperatures (syntax: type,regexp,threshold) Example: --critical='temperature,system,40' --critical='disk,.*,40' | +| --warning-count-* | Define the warning threshold for the number of components of one type (replace '*' with the component type). | +| --critical-count-* | Define the critical threshold for the number of components of one type (replace '*' with the component type). | -| Option | Description | -|:-------------------------|:------------------------------------------------------------------------------------------------------------------------------| -| --filter-counters | Only display some counters (regexp can be used). Example to check SSL connections only : --filter-counters='^xxxx\|yyyy$' | -| --force-counters-legacy | Force to use legacy counters. Should be used when EX/ES/QTS counters are buggy. | -| --warning-* --critical-* | Thresholds. Can be: 'memory-usage' (B), 'memory-usage-free' (B), 'memory-usage-prct' (%). | +| Option | Description | +|:-------------------------|:--------------------------------------------------------------------------------------------------------------------------| +| --filter-counters | Only display some counters (regexp can be used). Example to check SSL connections only : --filter-counters='^xxxx\|yyyy$' | +| --warning-xxx | Warning threshold. | +| --critical-xxx | Critical threshold. | +| --force-counters-legacy | Force to use legacy counters. Should be used when EX/ES/QTS counters are buggy. | +| --warning-* --critical-* | Thresholds. Can be: 'memory-usage' (B), 'memory-usage-free' (B), 'memory-usage-prct' (%). | -| Option | Description | -|:-------------------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| --filter-counters | Only display some counters (regexp can be used). Example to check SSL connections only : --filter-counters='^xxxx\|yyyy$' | -| --filter-name | Filter pools by name (can be a regexp). | -| --unknown-pool-status | Define the conditions to match for the status to be UNKNOWN. You can use the following variables: %\{status\}, %\{name\} | -| --warning-pool-status | Define the conditions to match for the status to be WARNING (default: '%\{status\} =~ /degraded\|warning/i'). You can use the following variables: %\{status\}, %\{name\} | -| --critical-pool-status | Define the conditions to match for the status to be CRITICAL (default: '%\{status\} =~ /error\|critical/i'). You can use the following variables: %\{status\}, %\{name\} | -| --warning-* --critical-* | Thresholds. Can be: 'space-usage-prct', 'space-usage', 'space-usage-free'. | +| Option | Description | +|:-------------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| --filter-counters | Only display some counters (regexp can be used). Example to check SSL connections only : --filter-counters='^xxxx\|yyyy$' | +| --warning-xxx | Warning threshold. | +| --critical-xxx | Critical threshold. | +| --filter-name | Filter pools by name (can be a regexp). | +| --unknown-pool-status | Define the conditions to match for the status to be UNKNOWN. You can use the following variables: %\{status\}, %\{name\} | +| --warning-pool-status | Define the conditions to match for the status to be WARNING (default: '%\{status\} =~ /degraded\|warning/i'). You can use the following variables: %\{status\}, %\{name\} | +| --critical-pool-status | Define the conditions to match for the status to be CRITICAL (default: '%\{status\} =~ /error\|critical/i'). You can use the following variables: %\{status\}, %\{name\} | +| --warning-* --critical-* | Thresholds. Can be: 'space-usage-prct', 'space-usage', 'space-usage-free'. | -| Option | Description | -|:------------------------------------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| --filter-counters | Only display some counters (regexp can be used). Example to check SSL connections only : --filter-counters='^xxxx\|yyyy$' | -| --memcached | Memcached server to use (only one server). | -| --redis-server | Redis server to use (only one server). Syntax: address\[:port\] | -| --redis-attribute | Set Redis Options (--redis-attribute="cnx\_timeout=5"). | -| --redis-db | Set Redis database index. | -| --failback-file | Fall back on a local file if Redis connection fails. | -| --memexpiration | Time to keep data in seconds (default: 86400). | -| --statefile-dir | Define the cache directory (default: '/var/lib/centreon/centplugins'). | -| --statefile-suffix | Define a suffix to customize the statefile name (default: ''). | -| --statefile-concat-cwd | If used with the '--statefile-dir' option, the latter's value will be used as a sub-directory of the current working directory. Useful on Windows when the plugin is compiled, as the file system and permissions are different from Linux. | -| --statefile-format | Define the format used to store the cache. Available formats: 'dumper', 'storable', 'json' (default). | -| --statefile-key | Define the key to encrypt/decrypt the cache. | -| --statefile-cipher | Define the cipher algorithm to encrypt the cache (default: 'AES'). | -| --add-global | Check global port statistics (by default if no --add-* option is set). | -| --add-status | Check interface status. | -| --add-duplex-status | Check duplex status (with --warning-status and --critical-status). | -| --add-traffic | Check interface traffic. | -| --add-errors | Check interface errors. | -| --add-cast | Check interface cast. | -| --add-speed | Check interface speed. | -| --add-volume | Check interface data volume between two checks (not supposed to be graphed, useful for BI reporting). | -| --check-metrics | If the expression is true, metrics are checked (default: '%\{opstatus\} eq "up"'). | -| --warning-status | Define the conditions to match for the status to be WARNING. You can use the following variables: %\{admstatus\}, %\{opstatus\}, %\{duplexstatus\}, %\{display\} | -| --critical-status | Define the conditions to match for the status to be CRITICAL (default: '%\{admstatus\} eq "up" and %\{opstatus\} ne "up"'). You can use the following variables: %\{admstatus\}, %\{opstatus\}, %\{duplexstatus\}, %\{display\} | -| --warning-* --critical-* | Thresholds. Can be: 'total-port', 'total-admin-up', 'total-admin-down', 'total-oper-up', 'total-oper-down', 'in-traffic', 'out-traffic', 'in-error', 'in-discard', 'out-error', 'out-discard', 'in-ucast', 'in-bcast', 'in-mcast', 'out-ucast', 'out-bcast', 'out-mcast', 'speed' (b/s). | -| --units-traffic | Units of thresholds for the traffic (default: 'percent\_delta') ('percent\_delta', 'bps', 'counter'). | -| --units-errors | Units of thresholds for errors/discards (default: 'percent\_delta') ('percent\_delta', 'percent', 'delta', 'deltaps', 'counter'). | -| --units-cast | Units of thresholds for communication types (default: 'percent\_delta') ('percent\_delta', 'percent', 'delta', 'deltaps', 'counter'). | -| --nagvis-perfdata | Display traffic perfdata to be compatible with NagVis widget. | -| --interface | Define the interface filter on IDs (OID indexes, e.g.: 1,2,...). If empty, all interfaces will be monitored. To filter on interface names, see --name. | -| --name | With this option, the interfaces will be filtered by name (given in option --interface) instead of OID index. The name matching mode supports regular expressions. | -| --regex-id | With this option, interface IDs will be filtered using the --interface parameter as a regular expression instead of a list of IDs. | -| --speed | Set interface speed for incoming/outgoing traffic (in Mb). | -| --speed-in | Set interface speed for incoming traffic (in Mb). | -| --speed-out | Set interface speed for outgoing traffic (in Mb). | -| --map-speed-dsl | Get interface speed configuration for interfaces of type 'ADSL' and 'VDSL2'. Syntax: --map-speed-dsl=interface-src-name,interface-dsl-name E.g: --map-speed-dsl=Et0.835,Et0-vdsl2 | -| --force-counters64 | Force to use 64 bits counters only. Can be used to improve performance. | -| --force-counters32 | Force to use 32-bits counters (even with SNMP versions 2c and 3). To use when 64 bits counters are buggy. | -| --reload-cache-time | Time in minutes before reloading cache file (default: 180). | -| --oid-filter | Define the OID to be used to filter interfaces (default: ifName) (values: ifDesc, ifAlias, ifName, IpAddr). | -| --oid-display | Define the OID that will be used to name the interfaces (default: ifName) (values: ifDesc, ifAlias, ifName, IpAddr). | -| --oid-extra-display | Add an OID to display. | -| --display-transform-src --display-transform-dst | Modify the interface name displayed by using a regular expression. Example: adding --display-transform-src='eth' --display-transform-dst='ens' will replace all occurrences of 'eth' with 'ens' | -| --show-cache | Display cache interface data. | +| Option | Description | +|:------------------------------------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| --filter-counters | Only display some counters (regexp can be used). Example to check SSL connections only : --filter-counters='^xxxx\|yyyy$' | +| --warning-xxx | Warning threshold. | +| --critical-xxx | Critical threshold. | +| --memcached | Memcached server to use (only one server). | +| --redis-server | Redis server to use (only one server). Syntax: address\[:port\] | +| --redis-attribute | Set Redis Options (--redis-attribute="cnx\_timeout=5"). | +| --redis-db | Set Redis database index. | +| --failback-file | Fall back on a local file if Redis connection fails. | +| --memexpiration | Time to keep data in seconds (default: 86400). | +| --statefile-dir | Define the cache directory (default: '/var/lib/centreon/centplugins'). | +| --statefile-suffix | Define a suffix to customize the statefile name (default: ''). | +| --statefile-concat-cwd | If used with the '--statefile-dir' option, the latter's value will be used as a sub-directory of the current working directory. Useful on Windows when the plugin is compiled, as the file system and permissions are different from Linux. | +| --statefile-format | Define the format used to store the cache. Available formats: 'dumper', 'storable', 'json' (default). | +| --statefile-key | Define the key to encrypt/decrypt the cache. | +| --statefile-cipher | Define the cipher algorithm to encrypt the cache (default: 'AES'). | +| --add-global | Check global port statistics (by default if no --add-* option is set). | +| --add-status | Check interface status. | +| --add-duplex-status | Check duplex status (with --warning-status and --critical-status). | +| --add-traffic | Check interface traffic. | +| --add-errors | Check interface errors. | +| --add-cast | Check interface cast. | +| --add-speed | Check interface speed. | +| --add-volume | Check interface data volume between two checks (not supposed to be graphed, useful for BI reporting). | +| --check-metrics | If the expression is true, metrics are checked (default: '%\{opstatus\} eq "up"'). | +| --warning-status | Define the conditions to match for the status to be WARNING. You can use the following variables: %\{admstatus\}, %\{opstatus\}, %\{duplexstatus\}, %\{display\} | +| --critical-status | Define the conditions to match for the status to be CRITICAL (default: '%\{admstatus\} eq "up" and %\{opstatus\} ne "up"'). You can use the following variables: %\{admstatus\}, %\{opstatus\}, %\{duplexstatus\}, %\{display\} | +| --warning-total-port | Thresholds. | +| --critical-total-port | Thresholds. | +| --warning-total-admin-up | Thresholds. | +| --critical-total-admin-up | Thresholds. | +| --warning-total-admin-down | Thresholds. | +| --critical-total-admin-down | Thresholds. | +| --warning-total-oper-up | Thresholds. | +| --critical-total-oper-up | Thresholds. | +| --warning-total-oper-down | Thresholds. | +| --critical-total-oper-down | Thresholds. | +| --warning-in-traffic | Thresholds. | +| --critical-in-traffic | Thresholds. | +| --warning-out-traffic | Thresholds. | +| --critical-out-traffic | Thresholds. | +| --warning-in-error | Thresholds. | +| --critical-in-error | Thresholds. | +| --warning-in-discard | Thresholds. | +| --critical-in-discard | Thresholds. | +| --warning-out-error | Thresholds. | +| --critical-out-error | Thresholds. | +| --warning-out-discard | Thresholds. | +| --critical-out-discard | Thresholds. | +| --warning-in-ucast | Thresholds. | +| --critical-in-ucast | Thresholds. | +| --warning-in-bcast | Thresholds. | +| --critical-in-bcast | Thresholds. | +| --warning-in-mcast | Thresholds. | +| --critical-in-mcast | Thresholds. | +| --warning-out-ucast | Thresholds. | +| --critical-out-ucast | Thresholds. | +| --warning-out-bcast | Thresholds. | +| --critical-out-bcast | Thresholds. | +| --warning-out-mcast | Thresholds. | +| --critical-out-mcast | Thresholds. | +| --warning-speed | Thresholds in b/s. | +| --critical-speed | Thresholds in b/s. | +| --units-traffic | Units of thresholds for the traffic (default: 'percent\_delta') ('percent\_delta', 'bps', 'counter'). | +| --units-errors | Units of thresholds for errors/discards (default: 'percent\_delta') ('percent\_delta', 'delta', 'deltaps', 'counter'). | +| --units-cast | Units of thresholds for communication types (default: 'percent\_delta') ('percent\_delta', 'percent', 'delta', 'deltaps', 'counter'). | +| --nagvis-perfdata | Display traffic perfdata to be compatible with NagVis widget. | +| --interface | Check only the interfaces with the specified IDs (OID indexes, e.g.: 1,2,...). If empty, all interfaces will be monitored. To filter on interface names, see --name. | +| --name | With this option, the interfaces will be filtered by name (given in option --interface) instead of OID index. The name matching mode supports regular expressions. | +| --regex-id | With this option, interface IDs will be filtered using the --interface parameter as a regular expression instead of a list of IDs. | +| --speed | Set interface speed for incoming/outgoing traffic (in Mb). | +| --speed-in | Set interface speed for incoming traffic (in Mb). | +| --speed-out | Set interface speed for outgoing traffic (in Mb). | +| --map-speed-dsl | Get interface speed configuration for interfaces of type 'ADSL' and 'VDSL2'. Syntax: --map-speed-dsl=interface-src-name,interface-dsl-name E.g: --map-speed-dsl=Et0.835,Et0-vdsl2 | +| --force-counters64 | Force to use 64 bits counters only. Can be used to improve performance. | +| --force-counters32 | Force to use 32-bit counters (even with SNMP versions 2c and 3). To use when 64 bits counters are buggy. | +| --reload-cache-time | Time in minutes before reloading cache file (default: 180). | +| --oid-filter | Define the OID to be used to filter interfaces (default: ifName) (values: ifDesc, ifAlias, ifName, IpAddr). | +| --oid-display | Define the OID that will be used to name the interfaces (default: ifName) (values: ifDesc, ifAlias, ifName, IpAddr). | +| --oid-extra-display | Add an OID to display. | +| --display-transform-src --display-transform-dst | Modify the interface name displayed by using a regular expression. Example: adding --display-transform-src='eth' --display-transform-dst='ens' will replace all occurrences of 'eth' with 'ens' | +| --show-cache | Display cache interface data. | +| --no-cache-lock | Set to disable locking when accessing cache. | -| Option | Description | -|:-------------------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| --filter-counters | Only display some counters (regexp can be used). Example to check SSL connections only : --filter-counters='^xxxx\|yyyy$' | -| --filter-name | Filter volumes by name (can be a regexp). | -| --force-counters-legacy | Force to use legacy counters. Should be used when EX/QTS counters are buggy. | -| --unknown-volume-status | Define the conditions to match for the status to be UNKNOWN. You can use the following variables: %\{status\}, %\{name\} | -| --warning-volume-status | Define the conditions to match for the status to be WARNING (default: '%\{status\} =~ /degraded\|warning/i'). You can use the following variables: %\{status\}, %\{name\} | -| --critical-volume-status | Define the conditions to match for the status to be CRITICAL (default: '%\{status\} =~ /critical/i'). You can use the following variables: %\{status\}, %\{name\} | -| --warning-* --critical-* | Thresholds. Can be: 'space-usage-prct', 'space-usage', 'space-usage-free'. | +| Option | Description | +|:-------------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| --filter-counters | Only display some counters (regexp can be used). Example to check SSL connections only : --filter-counters='^xxxx\|yyyy$' | +| --warning-xxx | Warning threshold. | +| --critical-xxx | Critical threshold. | +| --filter-name | Filter volumes by name (can be a regexp). | +| --force-counters-legacy | Force to use legacy counters. Should be used when EX/QTS counters are buggy. | +| --unknown-volume-status | Define the conditions to match for the status to be UNKNOWN. You can use the following variables: %\{status\}, %\{name\} | +| --warning-volume-status | Define the conditions to match for the status to be WARNING (default: '%\{status\} =~ /degraded\|warning/i'). You can use the following variables: %\{status\}, %\{name\} | +| --critical-volume-status | Define the conditions to match for the status to be CRITICAL (default: '%\{status\} =~ /critical/i'). You can use the following variables: %\{status\}, %\{name\} | +| --warning-* --critical-* | Thresholds. Can be: 'space-usage-prct', 'space-usage', 'space-usage-free'. | diff --git a/pp/integrations/plugin-packs/procedures/hardware-ups-apc-snmp.md b/pp/integrations/plugin-packs/procedures/hardware-ups-apc-snmp.md index d19c1de8a692..03dc1a4aac5c 100644 --- a/pp/integrations/plugin-packs/procedures/hardware-ups-apc-snmp.md +++ b/pp/integrations/plugin-packs/procedures/hardware-ups-apc-snmp.md @@ -5,10 +5,6 @@ title: APC UPS SNMP import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; -## Compatibility - -This connector is designed to monitor APC Uninterruptible Power Supplies (UPS), including models such as the Galaxy VS series. - ## Connector dependencies The following monitoring connectors will be installed when you install the **APC UPS SNMP** connector through the @@ -19,7 +15,7 @@ The following monitoring connectors will be installed when you install the **APC ### Templates -The Monitoring Connector **APC UPS** brings a host template: +The Monitoring Connector **APC UPS SNMP** brings a host template: * **HW-UPS-Apc-SNMP-custom** @@ -54,9 +50,9 @@ The connector brings the following service templates (sorted by the host templat #### Host discovery -| Rule name | Description | -|:----------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| SNMP Agents | Discover your resources through an SNMP subnet scan. You need to install the [Generic SNMP](./applications-protocol-snmp.md) connector to get the discovery rule and create a template mapper for the **HW-UPS-Apc-SNMP-custom** host template. | +| Rule name | Description | +|:------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| SNMP Agents | Discover your resources through an SNMP subnet scan. You need to install the [Generic SNMP](./applications-protocol-snmp.md) connector to get the discovery rule and create a template mapper for the **HW-UPS-Apc-SNMP-custom** host template. | More information about discovering hosts automatically is available on the [dedicated page](/docs/monitoring/discovery/hosts-discovery). @@ -67,68 +63,65 @@ Here is the list of services for this connector, detailing all metrics and statu -| Name | Unit | -|:---------------------------------|:------| -| status | N/A | -| battery.charge.remaining.percent | % | -| battery.charge.remaining.minutes | m | -| battery.timeon.minutes | m | -| battery.current.ampere | A | -| battery.voltage.volt | V | -| battery.temperature.celsius | C | -| battery.replace.lasttime.seconds | s | -| battery-pack-status | N/A | -| cartridge-status | N/A | +| Name | Unit | +|:---------------------------------|:-----| +| status | N/A | +| battery.charge.remaining.percent | % | +| battery.charge.remaining.minutes | m | +| battery.timeon.minutes | m | +| battery.current.ampere | A | +| battery.voltage.volt | V | +| battery.temperature.celsius | C | +| battery.replace.lasttime.seconds | s | +| battery-pack-status | N/A | +| cartridge-status | N/A | -| Name | Unit | -|:--------------------------------------------|:------| -| lines.input.voltage.volt | V | -| lines.input.frequence.hertz | Hz | -| status | N/A | -| *inputs*~line.input.frequence.hertz | Hz | -| *inputs*~*phases*#line.input.voltage.volt | V | -| *inputs*~*phases*#line.input.current.ampere | A | -| *inputs*~*phases*#line.input.power.watt | W | +| Name | Unit | +|:--------------------------------------------|:-----| +| lines.input.voltage.volt | V | +| lines.input.frequence.hertz | Hz | +| status | N/A | +| *inputs*~line.input.frequence.hertz | Hz | +| *inputs*~*phases*#line.input.voltage.volt | V | +| *inputs*~*phases*#line.input.current.ampere | A | +| *inputs*~*phases*#line.input.power.watt | W | -| Name | Unit | -|:-----------------------------|:------| -| status | N/A | -| lines.output.load.percentage | % | -| lines.output.current.ampere | A | -| lines.output.voltage.volt | V | -| lines.output.frequence.hertz | Hz | +| Name | Unit | +|:-----------------------------|:-----| +| status | N/A | +| lines.output.load.percentage | % | +| lines.output.current.ampere | A | +| lines.output.voltage.volt | V | +| lines.output.frequence.hertz | Hz | > To obtain this new metric format, include **--use-new-perfdata** in the **EXTRAOPTIONS** service macro. -| Name | Unit | -|:--------------------------------------|:------| -| sensor.universal.temperature.celsius | C | -| sensor.universal.humidity.percentage | % | -| sensor.integrated.humidity.percentage | % | +| Name | Unit | +|:------------------------|:------| +| hardware. sensor .count | count | +| sensor status | N/A | -| Metric name | Unit | -|:--------------------|:------| -| time.offset.seconds | s | - +| Metric name | Unit | +|:--------------------|:-----| +| time.offset.seconds | s | -| Metric name | Unit | -|:----------------------|:------| -| system.uptime.seconds | s | - +| Metric name | Unit | +|:----------------------|:-----| +| system.uptime.seconds | s | @@ -189,7 +182,7 @@ yum install centreon-pack-hardware-ups-apc-snmp -2. Whatever the license type (*online* or *offline*), install the **APC UPS** connector through +2. Whatever the license type (*online* or *offline*), install the **APC UPS SNMP** connector through the **Configuration > Connectors > Monitoring Connectors** menu. ### Plugin @@ -242,14 +235,16 @@ yum install centreon-plugin-Hardware-Ups-Apc-Snmp 1. Log into Centreon and add a new host through **Configuration > Hosts**. 2. Fill in the **Name**, **Alias** & **IP Address/DNS** fields according to your resource's settings. -3. Apply the **HW-UPS-Apc-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](../getting-started/how-to-guides/troubleshooting-plugins.md#snmpv3-options-mapping) section. +3. Apply the **HW-UPS-Apc-SNMP-custom** template to the host. -| 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](#available-options). | | | +| Macro | Description | Default value | Mandatory | +|:------------------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------|:--------------|:---------:| +| SNMP_V3_USERNAME | SNMP v3 only: User name (`securityName`) | | | +| SNMP_V3_AUTH_PROTOCOL | SNMP v3 only: Authentication protocol: MD5\|SHA. Since net-snmp 5.9.1: SHA224\|SHA256\|SHA384\|SHA512 | | | +| SNMP_V3_PRIV_PROTOCOL | 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 | | | +| SNMP_V3_AUTH_PASSPHRASE | SNMP v3 only: Pass phrase hashed using the authentication protocol defined in the --authprotocol option | | | +| SNMP_V3_PRIV_PASSPHRASE | SNMP v3 only: Privacy pass phrase (`privPassword`) to encrypt messages using the protocol defined in the --privprotocol option | | | +| SNMPEXTRAOPTIONS | Any extra option you may want to add to every command (a --verbose flag for example). All options are listed [here](#available-options). | | | 4. [Deploy the configuration](/docs/monitoring/monitoring-servers/deploying-a-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. @@ -261,90 +256,91 @@ yum install centreon-plugin-Hardware-Ups-Apc-Snmp -| Macro | Description | Default value | Mandatory | -|:----------------------|:---------------------------------------------------------------------------------------------------------------------------------------|:-----------------------------|:---------:| -| UNKNOWNSTATUS | Define the conditions to match for the status to be UNKNOWN. You can use the following variables: %\{status\}, %\{replace\} | %\{status\} =~ /unknown/i | | -| REPLACELASTTIMEFORMAT | Define the date format (default: C\<%m/%d/%Y\>) | | | -| WARNINGCURRENT | Warning threshold for battery current (in A) | | | -| CRITICALCURRENT | Critical threshold for battery current (in A) | | | -| WARNINGLOAD | Warning threshold for battery load (in %) | | | -| CRITICALLOAD | Critical threshold for battery load (in %) | | | -| WARNINGSTATUS | Define the conditions to match for the status to be WARNING. You can use the following variables: C\<%\{status\}\>, C\<%\{replace\}\> | %\{status\} =~ /batteryLow/i | | -| CRITICALSTATUS | Define the conditions to match for the status to be CRITICAL. You can use the following variables: C\<%\{status\}\>, C\<%\{replace\}\> | %\{replace\} =~ /yes/i | | -| WARNINGTEMPERATURE | Warning threshold for battery temperature (in C) | | | -| CRITICALTEMPERATURE | Critical threshold for battery temperature (in C) | | | -| WARNINGTIME | Warning threshold for battery remaining time (in minutes) | | | -| CRITICALTIME | Critical threshold for battery remaining time (in minutes) | | | -| WARNINGVOLTAGE | Warning threshold for battery voltage (in V) | | | -| CRITICALVOLTAGE | Critical threshold for battery voltage (in V) | | | -| EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). All options are listed [here](#available-options). | | | +| Macro | Description | Default value | Mandatory | +|:----------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------|:-----------------------------|:---------:| +| UNKNOWNSTATUS | Define the conditions to match for the status to be UNKNOWN. You can use the following variables: %\{status\}, %\{replace\} | %\{status\} =~ /unknown/i | | +| REPLACELASTTIMEFORMAT | Define the date format | `%m/%d/%Y` | | +| WARNINGCURRENT | Warning threshold for battery current (in A) | | | +| CRITICALCURRENT | Critical threshold for battery current (in A) | | | +| WARNINGLOAD | Warning threshold for battery load (in %) | | | +| CRITICALLOAD | Critical threshold for battery load (in %) | | | +| WARNINGSTATUS | Define the conditions to match for the status to be WARNING. You can use the following variables: `%\{status\}`, `%\{replace\}` | %\{status\} =~ /batteryLow/i | | +| CRITICALSTATUS | Define the conditions to match for the status to be CRITICAL. You can use the following variables: `%\{status\}`, `%\{replace\}` | %\{replace\} =~ /yes/i | | +| WARNINGTEMPERATURE | Warning threshold for battery temperature (in C) | | | +| CRITICALTEMPERATURE | Critical threshold for battery temperature (in C) | | | +| WARNINGTIME | Warning threshold for battery remaining time (in minutes) | | | +| CRITICALTIME | Critical threshold for battery remaining time (in minutes) | | | +| WARNINGVOLTAGE | Warning threshold for battery voltage (in V) | | | +| CRITICALVOLTAGE | Critical threshold for battery voltage (in V) | | | +| EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). All options are listed [here](#available-options). | | | -| Macro | Description | Default value | Mandatory | -|:-------------------------|:---------------------------------------------------------------------------------------------------------------------------------------|:--------------|:---------:| -| WARNINGFREQUENCE | Threshold | | | -| CRITICALFREQUENCE | Threshold | | | -| WARNINGLINEFREQUENCE | Threshold | | | -| CRITICALLINEFREQUENCE | Threshold | | | -| WARNINGLINEPHASECURRENT | Threshold | | | -| CRITICALLINEPHASECURRENT | Threshold | | | -| WARNINGLINEPHASEPOWER | Threshold | | | -| CRITICALLINEPHASEPOWER | Threshold | | | -| WARNINGLINEPHASEVOLTAGE | Threshold | | | -| CRITICALLINEPHASEVOLTAGE | Threshold | | | -| WARNINGSTATUS | Define the conditions to match for the status to be WARNING. You can use the following variables: %\{last\_cause\} | | | -| CRITICALSTATUS | Define the conditions to match for the status to be CRITICAL. You can use the following variables: %\{last\_cause\} | | | -| WARNINGVOLTAGE | Threshold | | | -| CRITICALVOLTAGE | Threshold | | | -| EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). All options are listed [here](#available-options). | | | +| Macro | Description | Default value | Mandatory | +|:-------------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------|:--------------|:---------:| +| WARNINGFREQUENCE | Threshold in Hertz | | | +| CRITICALFREQUENCE | Threshold in Hertz | | | +| WARNINGLINEFREQUENCE | Threshold | | | +| CRITICALLINEFREQUENCE | Threshold | | | +| WARNINGLINEPHASECURRENT | Threshold | | | +| CRITICALLINEPHASECURRENT | Threshold | | | +| WARNINGLINEPHASEPOWER | Threshold | | | +| CRITICALLINEPHASEPOWER | Threshold | | | +| WARNINGLINEPHASEVOLTAGE | Threshold | | | +| CRITICALLINEPHASEVOLTAGE | Threshold | | | +| WARNINGSTATUS | Define the conditions to match for the status to be WARNING. You can use the following variables: %\{last\_cause\} | | | +| CRITICALSTATUS | Define the conditions to match for the status to be CRITICAL. You can use the following variables: %\{last\_cause\} | | | +| WARNINGVOLTAGE | Threshold in Volts | | | +| CRITICALVOLTAGE | Threshold in Volts | | | +| EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). All options are listed [here](#available-options). | | | -| Macro | Description | Default value | Mandatory | -|:------------------|:---------------------------------------------------------------------------------------------------------------------------------------|:--------------------------|:-----------:| -| UNKNOWNSTATUS | Define the conditions to match for the status to be UNKNOWN. You can use the following variables: %\{status\} | %\{status\} =~ /unknown/i | | -| WARNINGCURRENT | Threshold | | | -| CRITICALCURRENT | Threshold | | | -| WARNINGFREQUENCE | Threshold | | | -| CRITICALFREQUENCE | Threshold | | | -| WARNINGLOAD | Threshold | 90 | | -| CRITICALLOAD | Threshold | 95 | | -| CRITICALSTATUS | Define the conditions to match for the status to be CRITICAL. You can use the following variables: %\{status\} | %\{status\} !~ /onLine\ | rebooting/i | | -| WARNINGSTATUS | Define the conditions to match for the status to be WARNING. You can use the following variables: %\{status\} | | | -| WARNINGVOLTAGE | Threshold | | | -| CRITICALVOLTAGE | Threshold | | | -| EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). All options are listed [here](#available-options). | | | +| Macro | Description | Default value | Mandatory | +|:------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------|:------------------------------------|:---------:| +| UNKNOWNSTATUS | Define the conditions to match for the status to be UNKNOWN. You can use the following variables: %\{status\} | %\{status\} =~ /unknown/i | | +| WARNINGCURRENT | Threshold in Amperes | | | +| CRITICALCURRENT | Threshold in Amperes | | | +| WARNINGFREQUENCE | Threshold in Hertz | | | +| CRITICALFREQUENCE | Threshold in Hertz | | | +| WARNINGLOAD | Threshold in percentage | 90 | | +| CRITICALLOAD | Threshold in percentage | 95 | | +| CRITICALSTATUS | Define the conditions to match for the status to be CRITICAL. You can use the following variables: %\{status\} | %\{status\} !~ /onLine\|rebooting/i | | +| WARNINGSTATUS | Define the conditions to match for the status to be WARNING. You can use the following variables: %\{status\} | | | +| WARNINGVOLTAGE | Threshold in Volts | | | +| CRITICALVOLTAGE | Threshold in Volts | | | +| EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). All options are listed [here](#available-options). | | | -| Macro | Description | Default value | Mandatory | -|:-------------|:---------------------------------------------------------------------------------------------------------------------------------------|:--------------|:---------:| -| EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). All options are listed [here](#available-options). | --verbose | | +| Macro | Description | Default value | Mandatory | +|:-------------|:-------------------------------------------------------------------------------------------------------------------------------------------------|:--------------|:---------:| +| EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). All options are listed [here](#available-options). | --verbose | | -| Macro | Description | Default value | Mandatory | -|:---------------|:---------------------------------------------------------------------------------------------------------------------------------------|:--------------|:---------:| -| NTPHOSTNAME | Set the ntp hostname (if not set, localtime is used) | | | -| NTPPORT | Set the ntp port (default: 123) | | | -| TIMEZONE | Set the timezone of distant server. For Windows, you need to set it. Can use format: 'Europe/London' | | | -| WARNINGOFFSET | Time warning threshold range (in seconds), in the format `-n:n` (e.g., `-5:5`). Returns WARNING when the offset is less than -n seconds or greater than n seconds. | | | -| CRITICALOFFSET | Time critical threshold range (in seconds), in the format `-n:n` (e.g., `-5:5`). Returns CRITICAL when the offset is less than -n seconds or greater than n seconds. | | | -| EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). All options are listed [here](#available-options). | | | +| Macro | Description | Default value | Mandatory | +|:---------------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------|:--------------|:---------:| +| NTPHOSTNAME | Set the NTP hostname (if not set, localtime is used) | | | +| NTPPORT | Set the NTP port | 123 | | +| TIMEZONE | Set the timezone of distant server. For Windows, you need to set it. Can use format: 'Europe/London' | | | +| WARNINGOFFSET | Time warning threshold range (in seconds), in the format -n:n (e.g., -5:5). Returns WARNING when the offset is less than -n seconds or greater than n seconds | | | +| CRITICALOFFSET | Time critical threshold range (in seconds), in the format -n:n (e.g., -5:5). Returns CRITICAL when the offset is less than -n seconds or greater than n seconds | | | +| EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). All options are listed [here](#available-options). | | | -| Macro | Description | Default value | Mandatory | -|:---------------|:---------------------------------------------------------------------------------------------------------------------------------------|:--------------|:---------:| -| WARNINGUPTIME | Warning threshold | | | -| CRITICALUPTIME | Critical threshold | | | -| EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). All options are listed [here](#available-options). | | | +| Macro | Description | Default value | Mandatory | +|:---------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:-----------------|:---------:| +| UNIT | Select the time unit for the performance data and thresholds. May be 's' for seconds, 'm' for minutes, 'h' for hours, 'd' for days, 'w' for weeks. Default is secondss. =back | | | +| WARNINGUPTIME | Warning threshold | | | +| CRITICALUPTIME | Critical threshold | | | +| EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). All options are listed [here](#available-options). | --check-overload | | @@ -360,27 +356,22 @@ is able to monitor a resource using a command like this one (replace the sample ```bash /usr/lib/centreon/plugins/centreon_ups_apc.pl \ --plugin=hardware::ups::apc::snmp::plugin \ - --mode=output-lines \ + --mode=sensors \ --hostname=10.0.0.1 \ --snmp-version='2c' \ - --snmp-community='my-snmp-community' \ - --warning-status='' \ - --critical-status='%\{status\} !~ /onLine|rebooting/i' \ - --unknown-status='%\{status\} =~ /unknown/i' \ - --warning-load='90' \ - --critical-load='95' \ - --warning-voltage='' \ - --critical-voltage='' \ - --warning-current='' \ - --critical-current='' \ - --warning-frequence='' \ - --critical-frequence='' + --snmp-community='my-snmp-community' \ + --snmp-username='username' \ + --authpassphrase='' \ + --authprotocol='' \ + --privpassphrase='' \ + --privprotocol='' \ + --verbose ``` The expected command output is shown below: ```bash -OK: load: 21 % current: 6 A voltage: 277 V frequence: 677 Hz | 'lines.output.load.percentage'=21%;0:90;0:95;0;100 'lines.output.current.ampere'=6A;;;0; 'lines.output.voltage.volt'=277V;;;; 'lines.output.frequence.hertz'=677Hz;;;; +OK: All 1 components are ok [1/1 sensor ]. | 'hardware. sensor .count'=1;;;; ``` ### Troubleshooting @@ -421,66 +412,67 @@ The plugin brings the following modes: 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 ok, 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\[,\[\\],\[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\[,\[\\],\[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\[,\[\\],\[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,\,calculation\[,\[\\],\[min\],\[max\]\] regex: regular expression \: 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 \ (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~replacement~modifier Most commonly used modifiers are i (case insensitive) and g (replace all occurrences). Example: adding --change-short-output='OK\~Up\~gi' will replace all occurrences of 'OK', 'ok', 'Ok' or 'oK' with 'Up' | -| --change-short-output | Modify the short/long output that is returned by the plugin. Syntax: --change-short-output=pattern~replacement~modifier Most commonly used modifiers are i (case insensitive) and g (replace all occurrences). Example: adding --change-short-output='OK\~Up\~gi' will replace all occurrences of 'OK', 'ok', 'Ok' or 'oK' with 'Up' | -| --change-long-output | Modify the short/long output that is returned by the plugin. Syntax: --change-short-output=pattern~replacement~modifier Most commonly used modifiers are i (case insensitive) and g (replace all occurrences). Example: adding --change-short-output='OK\~Up\~gi' will replace all occurrences of 'OK', 'ok', 'Ok' or 'oK' with 'Up' | -| --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\. =cut | +| 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 get-next 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 ok, 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. | +| --show-password | By default, sensitive information in command lines is hidden in debug output and replaced with `***` (however, debug logs may still display sensitive information). Using the C option will display the passwords in plain text. | +| --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\[,\[\\],\[min\],\[max\]\] Common examples: onvert 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\[,\[\\],\[min\],\[max\]\] Common examples: onvert 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\[,\[\\],\[min\],\[max\]\] Common examples: onvert 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,\,calculation\[,\[\\],\[min\],\[max\]\] regex: regular expression \: 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 \ (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: um 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~replacement~modifier Most commonly used modifiers are i (case insensitive) and g (replace all occurrences). Example: adding --change-short-output='OK~Up~gi' will replace all occurrences of 'OK', 'ok', 'Ok' or 'oK' with 'Up' | +| --change-short-output | Modify the short/long output that is returned by the plugin. Syntax: --change-short-output=pattern~replacement~modifier Most commonly used modifiers are i (case insensitive) and g (replace all occurrences). Example: adding --change-short-output='OK~Up~gi' will replace all occurrences of 'OK', 'ok', 'Ok' or 'oK' with 'Up' | +| --change-long-output | Modify the short/long output that is returned by the plugin. Syntax: --change-short-output=pattern~replacement~modifier Most commonly used modifiers are i (case insensitive) and g (replace all occurrences). Example: adding --change-short-output='OK~Up~gi' will replace all occurrences of 'OK', 'ok', 'Ok' or 'oK' with 'Up' | +| --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'. \. | #### Modes options @@ -489,108 +481,136 @@ All available options for each service template are listed below: -| Option | Description | -|:-------------------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| --filter-counters | Only display some counters (regexp can be used). Example: C\<--filter-counters='^status\|load$'\> | -| --replace-lasttime-format | Define the date format (default: C\<%m/%d/%Y\>). | -| --unknown-status | Define the conditions to match for the status to be UNKNOWN (default: C\<%\{status\} =~ /unknown/i\>). You can use the following variables: %\{status\}, %\{replace\} | -| --warning-status | Define the conditions to match for the status to be WARNING (default: C\<%\{status\} =~ /batteryLow/i\>). You can use the following variables: C\<%\{status\}\>, C\<%\{replace\}\> | -| --critical-status | Define the conditions to match for the status to be CRITICAL (default: C\<%\{replace\} =~ /yes/i\>). You can use the following variables: C\<%\{status\}\>, C\<%\{replace\}\> | -| --unknown-battery-pack-status | Define the conditions to match for the status to be UNKNOWN. You can use the following variables: C\<%\{status\}\> | -| --warning-battery-pack-status | Define the conditions to match for the status to be WARNING. You can use the following variables: C\<%\{status\}\> | -| --critical-battery-pack-status | Define the conditions to match for the status to be CRITICAL (default: C\<%\{status\} ne "OK"\>). You can use the following variables: C\<%\{status\}\> | -| --unknown-cartridge-status | Define the conditions to match for the status to be UNKNOWN. You can use the following variables: C\<%\{status\}\> | -| --warning-cartridge-status | Define the conditions to match for the status to be WARNING. You can use the following variables: C\<%\{status\}\> | -| --critical-cartridge-status | Define the conditions to match for the status to be CRITICAL (default: C\<%\{status\} ne "OK"\>). You can use the following variables: C\<%\{status\}\> | -| --warning-load | Warning threshold for battery load (in %). | -| --critical-load | Critical threshold for battery load (in %). | -| --warning-voltage | Warning threshold for battery voltage (in V). | -| --critical-voltage | Critical threshold for battery voltage (in V). | -| --warning-current | Warning threshold for battery current (in A). | -| --critical-current | Critical threshold for battery current (in A). | -| --warning-temperature | Warning threshold for battery temperature (in C). | -| --critical-temperature | Critical threshold for battery temperature (in C). | -| --warning-time | Warning threshold for battery remaining time (in minutes). | -| --critical-time | Critical threshold for battery remaining time (in minutes). | -| --warning-replace-lasttime | Warning threshold for battery last replace time (in seconds). | -| --critical-replace-lasttime | Critical threshold for battery last replace time (in seconds). | -| --warning-timeon | Warning threshold for time on battery (in minutes). | -| --critical-timeon | Critical threshold for time on battery (in minutes). | +| Option | Description | +|:-------------------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| --filter-counters | Only display some counters (regexp can be used). Example: `--filter-counters='^status\|load$'` | +| --warning-xxx | Warning threshold. | +| --critical-xxx | Critical threshold. | +| --replace-lasttime-format | Define the date format (default: `%m/%d/%Y`). | +| --unknown-status | Define the conditions to match for the status to be UNKNOWN (default: `%\{status\} =~ /unknown/i`). You can use the following variables: %\{status\}, %\{replace\} | +| --warning-status | Define the conditions to match for the status to be WARNING (default: `%\{status\} =~ /batteryLow/i`). You can use the following variables: `%\{status\}`, `%\{replace\}` | +| --critical-status | Define the conditions to match for the status to be CRITICAL (default: `%\{replace\} =~ /yes/i`). You can use the following variables: `%\{status\}`, `%\{replace\}` | +| --unknown-battery-pack-status | Define the conditions to match for the status to be UNKNOWN. You can use the following variables: `%\{status\}` | +| --warning-battery-pack-status | Define the conditions to match for the status to be WARNING. You can use the following variables: `%\{status\}` | +| --critical-battery-pack-status | Define the conditions to match for the status to be CRITICAL (default: `%\{status\} ne "OK"`). You can use the following variables: `%\{status\}` | +| --unknown-cartridge-status | Define the conditions to match for the status to be UNKNOWN. You can use the following variables: `%\{status\}` | +| --warning-cartridge-status | Define the conditions to match for the status to be WARNING. You can use the following variables: `%\{status\}` | +| --critical-cartridge-status | Define the conditions to match for the status to be CRITICAL (default: `%\{status\} ne "OK"`). You can use the following variables: `%\{status\}` | +| --warning-load | Warning threshold for battery load (in %). | +| --critical-load | Critical threshold for battery load (in %). | +| --warning-voltage | Warning threshold for battery voltage (in V). | +| --critical-voltage | Critical threshold for battery voltage (in V). | +| --warning-current | Warning threshold for battery current (in A). | +| --critical-current | Critical threshold for battery current (in A). | +| --warning-temperature | Warning threshold for battery temperature (in C). | +| --critical-temperature | Critical threshold for battery temperature (in C). | +| --warning-time | Warning threshold for battery remaining time (in minutes). | +| --critical-time | Critical threshold for battery remaining time (in minutes). | +| --warning-replace-lasttime | Warning threshold for battery last replace time (in seconds). | +| --critical-replace-lasttime | Critical threshold for battery last replace time (in seconds). | +| --warning-timeon | Warning threshold for time on battery (in minutes). | +| --critical-timeon | Critical threshold for time on battery (in minutes). | -| Option | Description | -|:-------------------------|:-----------------------------------------------------------------------------------------------------------------------------------| -| --filter-counters | Only display some counters (regexp can be used). Example: --filter-counters='^frequence\|voltage$' | -| --warning-status | Define the conditions to match for the status to be WARNING. You can use the following variables: %\{last\_cause\} | -| --critical-status | Define the conditions to match for the status to be CRITICAL. You can use the following variables: %\{last\_cause\} | -| --warning-* --critical-* | Thresholds. Can be: 'voltage', 'frequence', 'line-frequence', 'line-phase-voltage', 'line-phase-current', 'line-phase-power'. | +| Option | Description | +|:------------------------------|:--------------------------------------------------------------------------------------------------------------------| +| --filter-counters | Only display some counters (regexp can be used). Example: --filter-counters='^frequence\|voltage$' | +| --warning-xxx | Warning threshold. | +| --critical-xxx | Critical threshold. | +| --warning-status | Define the conditions to match for the status to be WARNING. You can use the following variables: %\{last\_cause\} | +| --critical-status | Define the conditions to match for the status to be CRITICAL. You can use the following variables: %\{last\_cause\} | +| --warning-frequence | Threshold in Hertz. | +| --critical-frequence | Threshold in Hertz. | +| --warning-line-frequence | Threshold. | +| --critical-line-frequence | Threshold. | +| --warning-line-phase-current | Threshold. | +| --critical-line-phase-current | Threshold. | +| --warning-line-phase-power | Threshold. | +| --critical-line-phase-power | Threshold. | +| --warning-line-phase-voltage | Threshold. | +| --critical-line-phase-voltage | Threshold. | +| --warning-voltage | Threshold in Volts. | +| --critical-voltage | Threshold in Volts. | -| Option | Description | -|:-------------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| --filter-counters | Only display some counters (regexp can be used). Example: --filter-counters='^status\|load$' | -| --unknown-status | Define the conditions to match for the status to be UNKNOWN (default: '%\{status\} =~ /unknown/i'). You can use the following variables: %\{status\} | -| --warning-status | Define the conditions to match for the status to be WARNING (default: ''). You can use the following variables: %\{status\} | -| --critical-status | Define the conditions to match for the status to be CRITICAL (default: '%\{status\} !~ /onLine\|rebooting/i'). You can use the following variables: %\{status\} | -| --warning-* --critical-* | Thresholds. Can be: 'load', 'voltage', 'current', 'frequence'. | +| Option | Description | +|:---------------------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------| +| --filter-counters | Only display some counters (regexp can be used). Example: --filter-counters='^status\|load$' | +| --warning-xxx | Warning threshold. | +| --critical-xxx | Critical threshold. | +| --unknown-status | Define the conditions to match for the status to be UNKNOWN (default: '%\{status\} =~ /unknown/i'). You can use the following variables: %\{status\} | +| --warning-status | Define the conditions to match for the status to be WARNING (default: ''). You can use the following variables: %\{status\} | +| --critical-status | Define the conditions to match for the status to be CRITICAL (default: '%\{status\} !~ /online\|rebooting/i'). You can use the following variables: %\{status\} | +| --warning-current | Threshold in Amperes. | +| --critical-current | Threshold in Amperes. | +| --warning-frequence | Threshold in Hertz. | +| --critical-frequence | Threshold in Hertz. | +| --warning-load | Threshold in percentage. | +| --critical-load | Threshold in percentage. | +| --warning-voltage | Threshold in Volts. | +| --critical-voltage | Threshold in Volts. | -| Option | Description | -|:---------------------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| --component | Define which component should be monitored based on their names. This option will be treated as a regular expression. All components are included by default ('.*'). | -| --filter | Exclude some parts (comma separated list) You can also exclude items from specific instances: --filter=sensor,1.1 | -| --absent-problem | Return an error if a component is not 'present' (default is skipping). It can be set globally or for a specific instance: --absent-problem='component\_name' or --absent-problem='component\_name,instance\_value'. | -| --no-component | Define the expected status if no components are found (default: critical). | -| --threshold-overload | Use this option to override the status returned by the plugin when the status label matches a regular expression (syntax: section,\[instance,\]status,regexp). Example: --threshold-overload='sensor,CRITICAL,sensorStatusNotApplicable' | -| --warning | Set warning threshold for 'temperature', 'humidity' (syntax: type,regexp,threshold) Example: --warning='temperature,.*,40' | -| --critical | Set critical threshold for 'temperature', 'humidity' (syntax: type,regexp,threshold) Example: --critical='temperature,.*,50' package hardware::ups::apc::snmp::mode::components::sensor; use strict; use warnings; my $map\_alarm\_status = \{ 1 =\> 'uioNormal', 2 =\> 'uioWarning', 3 =\> 'uioCritical', 4 =\> 'sensorStatusNotApplicable' \}; my $map\_iem\_status = \{ 1 =\> 'disconnected', 2 =\> 'connected' \}; my $map\_iem\_unit = \{ 1 =\> 'celsius', 2 =\> 'fahrenheit' \}; my $mapping = \{ uioSensorStatusSensorName =\> \{ oid =\> '.1.3.6.1.4.1.318.1.1.25.1.2.1.3' \}, uioSensorStatusTemperatureDegC =\> \{ oid =\> '.1.3.6.1.4.1.318.1.1.25.1.2.1.6' \}, uioSensorStatusHumidity =\> \{ oid =\> '.1.3.6.1.4.1.318.1.1.25.1.2.1.7' \}, uioSensorStatusAlarmStatus =\> \{ oid =\> '.1.3.6.1.4.1.318.1.1.25.1.2.1.9', map =\> $map\_alarm\_status \} \}; my $mapping\_iem = \{ iemStatusProbeName =\> \{ oid =\> '.1.3.6.1.4.1.318.1.1.10.2.3.2.1.2' \}, iemStatusProbeStatus =\> \{ oid =\> '.1.3.6.1.4.1.318.1.1.10.2.3.2.1.3', map =\> $map\_iem\_status \}, iemStatusProbeCurrentTemp =\> \{ oid =\> '.1.3.6.1.4.1.318.1.1.10.2.3.2.1.4' \}, iemStatusProbeTempUnits =\> \{ oid =\> '.1.3.6.1.4.1.318.1.1.10.2.3.2.1.5', map =\> $map\_iem\_unit \}, iemStatusProbeCurrentHumid =\> \{ oid =\> '.1.3.6.1.4.1.318.1.1.10.2.3.2.1.6' \} \}; my $oid\_uioSensorStatusEntry = '.1.3.6.1.4.1.318.1.1.25.1.2.1'; my $oid\_iemStatusProbesEntry = '.1.3.6.1.4.1.318.1.1.10.2.3.2.1'; sub load \{ my ($self) = @\_; push @\{$self-\>\{request\}\}, \{ oid =\> $oid\_uioSensorStatusEntry, start =\> $mapping-\>\{uioSensorStatusSensorName\}-\>\{oid\}, end =\> $mapping-\>\{uioSensorStatusAlarmStatus\}-\>\{oid\} \}, \{ oid =\> $oid\_iemStatusProbesEntry, start =\> $mapping\_iem-\>\{iemStatusProbeName\}-\>\{oid\}, end =\> $mapping\_iem-\>\{iemStatusProbeCurrentHumid\}-\>\{oid\} \}; \} sub check\_uoi \{ my ($self) = @\_; my ($exit, $warn, $crit, $checked); foreach my $oid ($self-\>\{snmp\}-\>oid\_lex\_sort(keys %\{$self-\>\{results\}-\>\{$oid\_uioSensorStatusEntry\}\})) \{ next if ($oid !~ /^$mapping-\>\{uioSensorStatusSensorName\}-\>\{oid\}\.(.*)$/); my $instance = $1; my $result = $self-\>\{snmp\}-\>map\_instance(mapping =\> $mapping, results =\> $self-\>\{results\}-\>\{$oid\_uioSensorStatusEntry\}, instance =\> $instance); $instance = 'universal-' . $1; next if ($self-\>check\_filter(section =\> 'sensor', instance =\> $instance)); $self-\>\{components\}-\>\{sensor\}-\>\{total\}++; $self-\>\{output\}-\>output\_add( long\_msg =\> sprintf( "universal sensor '%s' status is '%s' \[instance = %s\] \[temperature = %s C\] \[humidity = %s %%\]", $result-\>\{uioSensorStatusSensorName\}, $result-\>\{uioSensorStatusAlarmStatus\}, $instance, $result-\>\{uioSensorStatusTemperatureDegC\} != -1 ? $result-\>\{uioSensorStatusTemperatureDegC\} : '-', $result-\>\{uioSensorStatusHumidity\} != -1 ? $result-\>\{uioSensorStatusHumidity\} : '-' ) ); $exit = $self-\>get\_severity(section =\> 'sensor', value =\> $result-\>\{uioSensorStatusAlarmStatus\}); if (!$self-\>\{output\}-\>is\_status(value =\> $exit, compare =\> 'ok', litteral =\> 1)) \{ $self-\>\{output\}-\>output\_add( severity =\> $exit, short\_msg =\> sprintf("universal sensor '%s' status is '%s'", $result-\>\{uioSensorStatusSensorName\}, $result-\>\{uioSensorStatusAlarmStatus\}) ); \} if ($result-\>\{uioSensorStatusTemperatureDegC\} != -1) \{ ($exit, $warn, $crit, $checked) = $self-\>get\_severity\_numeric(section =\> 'temperature', instance =\> $instance, value =\> $result-\>\{uioSensorStatusTemperatureDegC\}); if (!$self-\>\{output\}-\>is\_status(value =\> $exit, compare =\> 'ok', litteral =\> 1)) \{ $self-\>\{output\}-\>output\_add( severity =\> $exit, short\_msg =\> sprintf( "universal sensor temperature '%s' is %s C", $result-\>\{uioSensorStatusSensorName\}, $result-\>\{uioSensorStatusTemperatureDegC\} ) ); \} $self-\>\{output\}-\>perfdata\_add( nlabel =\> 'sensor.universal.temperature.celsius', unit =\> 'C', instances =\> $result-\>\{uioSensorStatusSensorName\}, value =\> $result-\>\{uioSensorStatusTemperatureDegC\}, warning =\> $warn, critical =\> $crit ); \} next if ($result-\>\{uioSensorStatusHumidity\} == -1); ($exit, $warn, $crit, $checked) = $self-\>get\_severity\_numeric(section =\> 'humidity', instance =\> $instance, value =\> $result-\>\{uioSensorStatusHumidity\}); if (!$self-\>\{output\}-\>is\_status(value =\> $exit, compare =\> 'ok', litteral =\> 1)) \{ $self-\>\{output\}-\>output\_add( severity =\> $exit, short\_msg =\> sprintf( "universal sensor humidity '%s' is %s %%", $result-\>\{uioSensorStatusSensorName\}, $result-\>\{uioSensorStatusHumidity\} ) ); \} $self-\>\{output\}-\>perfdata\_add( nlabel =\> 'sensor.universal.humidity.percentage', unit =\> '%', instances =\> $result-\>\{uioSensorStatusSensorName\}, value =\> $result-\>\{uioSensorStatusHumidity\}, warning =\> $warn, critical =\> $crit, min =\> 0, max =\> 100 ); \} \} sub check\_iem \{ my ($self) = @\_; my ($exit, $warn, $crit, $checked); foreach my $oid ($self-\>\{snmp\}-\>oid\_lex\_sort(keys %\{$self-\>\{results\}-\>\{$oid\_iemStatusProbesEntry\}\})) \{ next if ($oid !~ /^$mapping\_iem-\>\{iemStatusProbeName\}-\>\{oid\}\.(.*)$/); my $instance = $1; my $result = $self-\>\{snmp\}-\>map\_instance(mapping =\> $mapping\_iem, results =\> $self-\>\{results\}-\>\{$oid\_iemStatusProbesEntry\}, instance =\> $instance); $instance = 'integrated-' . $1; next if ($self-\>check\_filter(section =\> 'sensor', instance =\> $instance)); $self-\>\{components\}-\>\{sensor\}-\>\{total\}++; $self-\>\{output\}-\>output\_add( long\_msg =\> sprintf( "integrated sensor '%s' status is '%s' \[instance = %s\] \[temperature = %s %s\] \[humidity = %s %%\]", $result-\>\{iemStatusProbeName\}, $result-\>\{iemStatusProbeStatus\}, $instance, $result-\>\{iemStatusProbeCurrentTemp\} != -1 ? $result-\>\{iemStatusProbeCurrentTemp\} : '-', $result-\>\{iemStatusProbeTempUnits\}, $result-\>\{iemStatusProbeCurrentHumid\} != -1 ? $result-\>\{iemStatusProbeCurrentHumid\} : '-' ) ); $exit = $self-\>get\_severity(section =\> 'sensor', value =\> $result-\>\{iemStatusProbeStatus\}); if (!$self-\>\{output\}-\>is\_status(value =\> $exit, compare =\> 'ok', litteral =\> 1)) \{ $self-\>\{output\}-\>output\_add( severity =\> $exit, short\_msg =\> sprintf("integrated sensor '%s' status is '%s'", $result-\>\{iemStatusProbeName\}, $result-\>\{iemStatusProbeStatus\}) ); \} next if ($result-\>\{iemStatusProbeStatus\} eq 'disconnected'); if ($result-\>\{iemStatusProbeCurrentTemp\} != -1) \{ ($exit, $warn, $crit, $checked) = $self-\>get\_severity\_numeric(section =\> 'temperature', instance =\> $instance, value =\> $result-\>\{iemStatusProbeCurrentTemp\}); if (!$self-\>\{output\}-\>is\_status(value =\> $exit, compare =\> 'ok', litteral =\> 1)) \{ $self-\>\{output\}-\>output\_add( severity =\> $exit, short\_msg =\> sprintf( "integrated sensor temperature '%s' is %s %s", $result-\>\{iemStatusProbeName\}, $result-\>\{iemStatusProbeCurrentTemp\}, $result-\>\{iemStatusProbeTempUnits\} ) ); \} $self-\>\{output\}-\>perfdata\_add( unit =\> $result-\>\{iemStatusProbeTempUnits\} eq 'celsius' ? 'C' : 'F', nlabel =\> 'sensor.integrated.temperature.' . $result-\>\{iemStatusProbeTempUnits\}, instances =\> $result-\>\{iemStatusProbeName\}, value =\> $result-\>\{iemStatusProbeCurrentTemp\}, warning =\> $warn, critical =\> $crit ); \} next if ($result-\>\{iemStatusProbeCurrentHumid\} == -1); ($exit, $warn, $crit, $checked) = $self-\>get\_severity\_numeric(section =\> 'humidity', instance =\> $instance, value =\> $result-\>\{iemStatusProbeCurrentHumid\}); if (!$self-\>\{output\}-\>is\_status(value =\> $exit, compare =\> 'ok', litteral =\> 1)) \{ $self-\>\{output\}-\>output\_add( severity =\> $exit, short\_msg =\> sprintf( "integrated sensor humidity '%s' is %s %%", $result-\>\{iemStatusProbeName\}, $result-\>\{iemStatusProbeCurrentHumid\} ) ); \} $self-\>\{output\}-\>perfdata\_add( nlabel =\> 'sensor.integrated.humidity.percentage', unit =\> '%', instances =\> $result-\>\{iemStatusProbeName\}, value =\> $result-\>\{iemStatusProbeCurrentHumid\}, warning =\> $warn, critical =\> $crit, min =\> 0, max =\> 100 ); \} \} sub check \{ my ($self) = @\_; $self-\>\{output\}-\>output\_add(long\_msg =\> 'checking sensors'); $self-\>\{components\}-\>\{sensor\} = \{name =\> 'sensors', total =\> 0, skip =\> 0\}; return if ($self-\>check\_filter(section =\> 'sensor')); check\_uoi($self); check\_iem($self); \} 1; | -| --warning-count-* | Define the warning threshold for the number of components of one type (replace '*' with the component type). | -| --critical-count-* | Define the critical threshold for the number of components of one type (replace '*' with the component type). | +| Option | Description | +|:---------------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| --component | Which component to check (default: '.*'). Can be: 'sensor'. | +| --filter | Exclude some parts (comma separated list) You can also exclude items from specific instances: --filter=sensor,1.1 | +| --absent-problem | Return an error if a component is not 'present' (default is skipping). It can be set globally or for a specific instance: --absent-problem='component\_name' or --absent-problem='component\_name,instance\_value'. | +| --no-component | Define the expected status if no components are found (default: critical). | +| --threshold-overload | Use this option to override the status returned by the plugin when the status label matches a regular expression (syntax: section,\[instance,\]status,regexp). Example: --threshold-overload='sensor,CRITICAL,sensorStatusNotApplicable' | +| --warning | Set warning threshold for 'temperature', 'humidity' (syntax: type,regexp,threshold) Example: --warning='temperature,.*,40' | +| --critical | Set critical threshold for 'temperature', 'humidity' (syntax: type,regexp,threshold) Example: --critical='temperature,.*,50' | +| --warning-count-* | Define the warning threshold for the number of components of one type (replace '*' with the component type). | +| --critical-count-* | Define the critical threshold for the number of components of one type (replace '*' with the component type). | -| Option | Description | -|:------------------|:--------------------------------------------------------------------------------------------------------------------------| -| --filter-counters | Only display some counters (regexp can be used). Example to check SSL connections only : --filter-counters='^xxxx\|yyyy$' | -| --oid | Override default OID. | -| --warning-offset | Time warning threshold range (in seconds), in the format `-n:n` (e.g., `-5:5`). Returns WARNING when the offset is less than -n seconds or greater than n seconds. | -| --critical-offset | Time critical threshold range (in seconds), in the format `-n:n` (e.g., `-5:5`). Returns CRITICAL when the offset is less than -n seconds or greater than n seconds. | -| --ntp-hostname | Set the ntp hostname (if not set, localtime is used). | -| --ntp-port | Set the ntp port (default: 123). | -| --timezone | Set the timezone of distant server. For Windows, you need to set it. Can use format: 'Europe/London'. | +| Option | Description | +|:------------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------| +| --filter-counters | Only display some counters (regexp can be used). Example to check SSL connections only : --filter-counters='^xxxx\|yyyy$' | +| --warning-xxx | Warning threshold. | +| --critical-xxx | Critical threshold. | +| --oid | Override default OID. | +| --warning-offset | Time warning threshold range (in seconds), in the format -n:n (e.g., -5:5). Returns WARNING when the offset is less than -n seconds or greater than n seconds. | +| --critical-offset | Time critical threshold range (in seconds), in the format -n:n (e.g., -5:5). Returns CRITICAL when the offset is less than -n seconds or greater than n seconds. | +| --ntp-hostname | Set the NTP hostname (if not set, localtime is used). | +| --ntp-port | Set the NTP port (default: 123). | +| --timezone | Set the timezone of distant server. For Windows, you need to set it. Can use format: 'Europe/London'. | -| Option | Description | -|:-----------------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| --filter-counters | Only display some counters (regexp can be used). Example to check SSL connections only : --filter-counters='^xxxx\|yyyy$' | -| --warning-uptime | Warning threshold. | -| --critical-uptime | Critical threshold. | -| --add-sysdesc | Display system description. | -| --force-oid | Can choose your oid (numeric format only). | -| --check-overload | Uptime counter limit is 4294967296 and overflow. With that option, we manage the counter going back. But there is a few chance we can miss a reboot. | -| --reboot-window | To be used with check-overload option. Time in milliseconds (default: 5000) You increase the chance of not missing a reboot if you decrease that value. | -| --unit | Select the time unit for the performance data and thresholds. May be 's' for seconds, 'm' for minutes, 'h' for hours, 'd' for days, 'w' for weeks. Default is secondss. =back | -| --memcached | Memcached server to use (only one server). | -| --redis-server | Redis server to use (only one server). Syntax: address\[:port\] | -| --redis-attribute | Set Redis Options (--redis-attribute="cnx\_timeout=5"). | -| --redis-db | Set Redis database index. | -| --failback-file | Fall back on a local file if Redis connection fails. | -| --memexpiration | Time to keep data in seconds (default: 86400). | -| --statefile-dir | Define the cache directory (default: '/var/lib/centreon/centplugins'). | -| --statefile-suffix | Define a suffix to customize the statefile name (default: ''). | -| --statefile-concat-cwd | If used with the '--statefile-dir' option, the latter's value will be used as a sub-directory of the current working directory. Useful on Windows when the plugin is compiled, as the file system and permissions are different from Linux. | -| --statefile-format | Define the format used to store the cache. Available formats: 'dumper', 'storable', 'json' (default). | -| --statefile-key | Define the key to encrypt/decrypt the cache. | -| --statefile-cipher | Define the cipher algorithm to encrypt the cache (default: 'AES'). | +| Option | Description | +|:-----------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| --filter-counters | Only display some counters (regexp can be used). Example to check SSL connections only : --filter-counters='^xxxx\|yyyy$' | +| --warning-xxx | Warning threshold. | +| --critical-xxx | Critical threshold. | +| --warning-uptime | Warning threshold. | +| --critical-uptime | Critical threshold. | +| --add-sysdesc | Display system description. | +| --force-oid | Can choose your oid (numeric format only). | +| --check-overload | Uptime counter limit is 4294967296 and overflow. With that option, we manage the counter going back. But there is a few chance we can miss a reboot. | +| --reboot-window | To be used with check-overload option. Time in milliseconds (default: 5000) You increase the chance of not missing a reboot if you decrease that value. | +| --unit | Select the time unit for the performance data and thresholds. May be 's' for seconds, 'm' for minutes, 'h' for hours, 'd' for days, 'w' for weeks. Default is secondss. =back | +| --memcached | Memcached server to use (only one server). | +| --redis-server | Redis server to use (only one server). Syntax: address\[:port\] | +| --redis-attribute | Set Redis Options (--redis-attribute="cnx\_timeout=5"). | +| --redis-db | Set Redis database index. | +| --failback-file | Fall back on a local file if Redis connection fails. | +| --memexpiration | Time to keep data in seconds (default: 86400). | +| --statefile-dir | Define the cache directory (default: '/var/lib/centreon/centplugins'). | +| --statefile-suffix | Define a suffix to customize the statefile name (default: ''). | +| --statefile-concat-cwd | If used with the '--statefile-dir' option, the latter's value will be used as a sub-directory of the current working directory. Useful on Windows when the plugin is compiled, as the file system and permissions are different from Linux. | +| --statefile-format | Define the format used to store the cache. Available formats: 'dumper', 'storable', 'json' (default). | +| --statefile-key | Define the key to encrypt/decrypt the cache. | +| --statefile-cipher | Define the cipher algorithm to encrypt the cache (default: 'AES'). | @@ -601,6 +621,6 @@ All available options for a given mode can be displayed by adding the ```bash /usr/lib/centreon/plugins/centreon_ups_apc.pl \ --plugin=hardware::ups::apc::snmp::plugin \ - --mode=output-lines \ + --mode=sensors \ --help ``` diff --git a/pp/integrations/plugin-packs/procedures/hardware-ups-powerware-snmp.md b/pp/integrations/plugin-packs/procedures/hardware-ups-powerware-snmp.md index e041a090472a..d32d02a8c9cf 100644 --- a/pp/integrations/plugin-packs/procedures/hardware-ups-powerware-snmp.md +++ b/pp/integrations/plugin-packs/procedures/hardware-ups-powerware-snmp.md @@ -37,8 +37,8 @@ The connector brings the following service templates (sorted by the host templat -| Service Alias | Service Template | Service Description | -|:--------------|:------------------------------------|:------------------------| +| Service Alias | Service Template | Service Description | +|:--------------|:------------------------------------|:----------------------------| | Alarms | HW-UPS-Powerware-Alarms-SNMP-custom | Check if alarms are present | > The services listed above are not created automatically when a host template is applied. To use them, [create a service manually](/docs/monitoring/basic-objects/services), then apply the service template you want. @@ -94,12 +94,9 @@ Here is the list of services for this connector, detailing all metrics and statu -| Name | Unit | -|:----------------------------------|:-----| -| lines.input.frequence.hertz | Hz | -| *iline*#line.input.current.ampere | A | -| *iline*#line.input.voltage.volt | V | -| *iline*#line.input.power.watt | W | +| Name | Unit | +|:----------------------------|:-----| +| lines.input.frequency.hertz | Hz | > To obtain this new metric format, include **--use-new-perfdata** in the **EXTRAOPTIONS** service macro. @@ -238,12 +235,14 @@ yum install centreon-plugin-Hardware-Ups-Powerware-Snmp 2. Fill in the **Name**, **Alias** & **IP Address/DNS** fields according to your resource's settings. 3. Apply the **HW-UPS-Powerware-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](../getting-started/how-to-guides/troubleshooting-plugins.md#snmpv3-options-mapping) 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](#available-options). | | | +| Macro | Description | Default value | Mandatory | +|:------------------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------|:--------------|:---------:| +| SNMP_V3_USERNAME | SNMP v3 only: User name (`securityName`) | | | +| SNMP_V3_AUTH_PROTOCOL | SNMP v3 only: Authentication protocol: MD5\|SHA. Since net-snmp 5.9.1: SHA224\|SHA256\|SHA384\|SHA512 | | | +| SNMP_V3_PRIV_PROTOCOL | 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 | | | +| SNMP_V3_AUTH_PASSPHRASE | SNMP v3 only: Pass phrase hashed using the authentication protocol defined in the --authprotocol option | | | +| SNMP_V3_PRIV_PASSPHRASE | SNMP v3 only: Privacy pass phrase (`privPassword`) to encrypt messages using the protocol defined in the --privprotocol option | | | +| SNMPEXTRAOPTIONS | Any extra option you may want to add to every command (a --verbose flag for example). All options are listed [here](#available-options). | | | 4. [Deploy the configuration](/docs/monitoring/monitoring-servers/deploying-a-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. @@ -295,17 +294,17 @@ yum install centreon-plugin-Hardware-Ups-Powerware-Snmp -| Macro | Description | Default value | Mandatory | -|:------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------|:--------------|:---------:| -| WARNINGCURRENT | Threshold | | | -| CRITICALCURRENT | Threshold | | | -| WARNINGFREQUENCE | Threshold | | | -| CRITICALFREQUENCE | Threshold | | | -| WARNINGPOWER | Threshold | | | -| CRITICALPOWER | Threshold | | | -| WARNINGVOLTAGE | Threshold | | | -| CRITICALVOLTAGE | Threshold | | | -| EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). All options are listed [here](#available-options). | | | +| Macro | Description | Default value | Mandatory | +|:------------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:--------------|:---------:| +| WARNINGCURRENT | Threshold in Amperes | | | +| CRITICALCURRENT | Threshold in Amperes | | | +| WARNINGFREQUENCE | Threshold in Hertz | | | +| CRITICALFREQUENCE | Threshold in Hertz | | | +| WARNINGPOWER | Threshold in Watts | | | +| CRITICALPOWER | Threshold in Watts | | | +| WARNINGVOLTAGE | Threshold in Volts | | | +| CRITICALVOLTAGE | Threshold in Volts. If --warning-voltage and --critical-voltage are not specified the connector uses the SNMP values `upsConfigLowVoltageTransferPoint` ( OID .1.3.6.1.2.1.33.1.9.9 ) and `upsConfigHighVoltageTransferPoint` ( OID .1.3.6.1.2.1.33.1.9.10 ) to set the CRITICAL threshold if these values are different from zero | | | +| EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). All options are listed [here](#available-options). | | | @@ -348,7 +347,12 @@ is able to monitor a resource using a command like this one (replace the sample --mode=output-lines \ --hostname=10.0.0.1 \ --snmp-version='2c' \ - --snmp-community='my-snmp-community' \ + --snmp-community='my-snmp-community' \ + --snmp-username='username' \ + --authpassphrase='' \ + --authprotocol='' \ + --privpassphrase='' \ + --privprotocol='' \ --warning-load='90' \ --critical-load='95' \ --warning-voltage='' \ @@ -422,24 +426,25 @@ All generic options are listed here: | --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-force-getnext | Use SNMP get-next 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). | +| --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. | +| --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 ok, warning, critical and unknown (default). | -| --snmp-tls-transport | Transport protocol for TLS communication (can be: 'dtlsudp', 'tlstcp'). | +| --snmp-errors-exit | Expected status in case of SNMP error or timeout. Possible values are ok, 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-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. | +| --show-password | By default, sensitive information in command lines is hidden in debug output and replaced with `***` (however, debug logs may still display sensitive information). Using the C option will display the passwords in plain text. | | --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%;;;; | @@ -447,9 +452,9 @@ All generic options are listed here: | --change-perfdata | Change or extend perfdata. Syntax: --extend-perfdata=searchlabel,newlabel,target\[,\[\\],\[min\],\[max\]\] Common examples: onvert 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\[,\[\\],\[min\],\[max\]\] Common examples: onvert 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,\,calculation\[,\[\\],\[min\],\[max\]\] regex: regular expression \: 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 \ (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: um 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~replacement~modifier Most commonly used modifiers are i (case insensitive) and g (replace all occurrences). Example: adding --change-short-output='OK\~Up\~gi' will replace all occurrences of 'OK', 'ok', 'Ok' or 'oK' with 'Up' | -| --change-short-output | Modify the short/long output that is returned by the plugin. Syntax: --change-short-output=pattern~replacement~modifier Most commonly used modifiers are i (case insensitive) and g (replace all occurrences). Example: adding --change-short-output='OK\~Up\~gi' will replace all occurrences of 'OK', 'ok', 'Ok' or 'oK' with 'Up' | -| --change-long-output | Modify the short/long output that is returned by the plugin. Syntax: --change-short-output=pattern~replacement~modifier Most commonly used modifiers are i (case insensitive) and g (replace all occurrences). Example: adding --change-short-output='OK\~Up\~gi' will replace all occurrences of 'OK', 'ok', 'Ok' or 'oK' with 'Up' | +| --change-short-output --change-long-output | Modify the short/long output that is returned by the plugin. Syntax: --change-short-output=pattern~replacement~modifier Most commonly used modifiers are i (case insensitive) and g (replace all occurrences). Example: adding --change-short-output='OK~Up~gi' will replace all occurrences of 'OK', 'ok', 'Ok' or 'oK' with 'Up' | +| --change-short-output | Modify the short/long output that is returned by the plugin. Syntax: --change-short-output=pattern~replacement~modifier Most commonly used modifiers are i (case insensitive) and g (replace all occurrences). Example: adding --change-short-output='OK~Up~gi' will replace all occurrences of 'OK', 'ok', 'Ok' or 'oK' with 'Up' | +| --change-long-output | Modify the short/long output that is returned by the plugin. Syntax: --change-short-output=pattern~replacement~modifier Most commonly used modifiers are i (case insensitive) and g (replace all occurrences). Example: adding --change-short-output='OK~Up~gi' will replace all occurrences of 'OK', 'ok', 'Ok' or 'oK' with 'Up' | | --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. | @@ -497,6 +502,8 @@ All available options for each service template are listed below: | Option | Description | |:-------------------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------| | --filter-counters | Only display some counters (regexp can be used). Example: --filter-counters='status\|current' | +| --warning-xxx | Warning threshold. | +| --critical-xxx | Critical threshold. | | --unknown-status | Define the conditions to match for the status to be UNKNOWN (default: '%\{status\} =~ /unknown/i'). You can use the following variables: %\{status\}. | | --warning-status | Define the conditions to match for the status to be WARNING (default: '%\{status\} =~ /batteryDischarging/i'). You can use the following variables: %\{status\}. | | --critical-status | Define the conditions to match for the status to be CRITICAL (default: ''). You can use the following variables: %\{status\}. | @@ -508,16 +515,27 @@ All available options for each service template are listed below: | Option | Description | |:-------------------------|:--------------------------------------------------------------------------------------------------------------------------| | --filter-counters | Only display some counters (regexp can be used). Example to check SSL connections only : --filter-counters='^xxxx\|yyyy$' | +| --warning-xxx | Warning threshold. | +| --critical-xxx | Critical threshold. | | --warning-* --critical-* | Thresholds. Can be: 'internal-temperature', 'internal-humidity', 'remote-temperature', 'remote-humidity'. | -| Option | Description | -|:-------------------------|:--------------------------------------------------------------------------------------------------------------------------| -| --filter-counters | Only display some counters (regexp can be used). Example to check SSL connections only : --filter-counters='^xxxx\|yyyy$' | -| --filter-iline | Filter input lines that match the regexp | -| --warning-* --critical-* | Thresholds. Can be: 'frequence', 'voltage', 'current', 'power'. | +| Option | Description | +|:---------------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| --filter-counters | Only display some counters (regexp can be used). Example to check SSL connections only : --filter-counters='^xxxx\|yyyy$' | +| --warning-xxx | Warning threshold. | +| --critical-xxx | Critical threshold. | +| --filter-iline | Filter input lines that match the regexp | +| --warning-current | Threshold in Amperes. | +| --critical-current | Threshold in Amperes. | +| --warning-frequency | Threshold in Hertz. | +| --critical-frequency | Threshold in Hertz. | +| --warning-power | Threshold in Watts. | +| --critical-power | Threshold in Watts. | +| --warning-voltage | Threshold in Volts. | +| --critical-voltage | Threshold in Volts. If --warning-voltage and --critical-voltage are not specified the connector uses the SNMP values `upsConfigLowVoltageTransferPoint` ( OID .1.3.6.1.2.1.33.1.9.9 ) and `upsConfigHighVoltageTransferPoint` ( OID .1.3.6.1.2.1.33.1.9.10 ) to set the CRITICAL threshold if these values are different from zero. | @@ -525,6 +543,8 @@ All available options for each service template are listed below: | Option | Description | |:------------------|:--------------------------------------------------------------------------------------------------------------------------| | --filter-counters | Only display some counters (regexp can be used). Example to check SSL connections only : --filter-counters='^xxxx\|yyyy$' | +| --warning-xxx | Warning threshold. | +| --critical-xxx | Critical threshold. | | --warning-* | Warning threshold. Can be: 'load', 'voltage', 'current', 'power'. Load is a rate for X phase. | | --critical-* | Critical threshold. Can be: 'load', 'voltage', 'current', 'power'. Load is a rate for X phase. | diff --git a/pp/integrations/plugin-packs/procedures/network-aruba-aoscx-snmp.md b/pp/integrations/plugin-packs/procedures/network-aruba-aoscx-snmp.md index d907c7503f9b..2394ab542e0b 100644 --- a/pp/integrations/plugin-packs/procedures/network-aruba-aoscx-snmp.md +++ b/pp/integrations/plugin-packs/procedures/network-aruba-aoscx-snmp.md @@ -13,8 +13,6 @@ The following monitoring connectors will be installed when you install the **Aru ## Pack assets -> Since HP acquired Aruba, some MIBs may have changed. If your Aruba device is no longer correcty monitored by the Aruba connector, use the [HP Procurve SNMP](network-switchs-hp-procurve-snmp.md) connector instead. - ### Templates The Monitoring Connector **ArubaOS-CX SNMP** brings a host template: @@ -28,7 +26,7 @@ The connector brings the following service templates (sorted by the host templat | Service Alias | Service Template | Service Description | |:--------------|:-------------------------------------|:-----------------------------------------------------| -| Cpu | Net-Aruba-Aoscx-Cpu-SNMP-custom | Check CPU | +| Cpu | Net-Aruba-Aoscx-Cpu-SNMP-custom | Check cpu | | Hardware | Net-Aruba-Aoscx-Hardware-SNMP-custom | Check hardware | | Memory | Net-Aruba-Aoscx-Memory-SNMP-custom | Check memory | | Uptime | Net-Aruba-Aoscx-Uptime-SNMP-custom | Time since the system has been working and available | @@ -40,11 +38,11 @@ The connector brings the following service templates (sorted by the host templat -| Service Alias | Service Template | Service Description | Discovery | -|:--------------|:-----------------------------------------|:-----------------------------------------------------------------------|:----------:| -| Interfaces | Net-Aruba-Aoscx-Interfaces-SNMP-custom | Check interfaces | X | -| Spanning-Tree | Net-Aruba-Aoscx-SpanningTree-SNMP-custom | Monitor the status of the Spanning Tree Protocol on network interfaces | X | -| Stack | Net-Aruba-Aoscx-Stack-SNMP-custom | Check stack members | | +| Service Alias | Service Template | Service Description | Discovery | +|:--------------|:-----------------------------------------|:-----------------------------------------------------------------------|:---------:| +| Interfaces | Net-Aruba-Aoscx-Interfaces-SNMP-custom | Check interfaces | X | +| Spanning-Tree | Net-Aruba-Aoscx-SpanningTree-SNMP-custom | Monitor the status of the Spanning Tree Protocol on network interfaces | X | +| Stack | Net-Aruba-Aoscx-Stack-SNMP-custom | Check stack members | | > The services listed above are not created automatically when a host template is applied. To use them, [create a service manually](/docs/monitoring/basic-objects/services), then apply the service template you want. @@ -57,9 +55,9 @@ The connector brings the following service templates (sorted by the host templat #### Host discovery -| Rule name | Description | -|:----------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| SNMP Agents | Discover your resources through an SNMP subnet scan. You need to install the [Generic SNMP](./applications-protocol-snmp.md) connector to get the discovery rule and create a template mapper for the **Net-Aruba-Aoscx-SNMP-custom** host template. | +| Rule name | Description | +|:------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| SNMP Agents | Discover your resources through an SNMP subnet scan. You need to install the [Generic SNMP](./applications-protocol-snmp.md) connector to get the discovery rule and create a template mapper for the **Net-Aruba-Aoscx-SNMP-custom** host template. | More information about discovering hosts automatically is available on the [dedicated page](/docs/monitoring/discovery/hosts-discovery). @@ -80,66 +78,67 @@ Here is the list of services for this connector, detailing all metrics and statu -| Name | Unit | -|:-------------------------------------|:------| -| *modules*#cpu.utilization.percentage | % | +| Name | Unit | +|:-------------------------------------|:-----| +| *modules*#cpu.utilization.percentage | % | -| Metric name | Unit | -|:-------------------------------------------|:-----| -| *fan_name*#hardware.fan.speed.rpm | rpm | -| fan tray status | N/A | -| psu status | N/A | -| *psu_name*#hardware.psu.power.watt | W | -| temperature status | N/A | -| *sensor_name*#hardware.temperature.celsius | C | +| Name | Unit | +|:---------------------------|:------| +| hardware.psu.count | count | +| psu status | N/A | +| hardware.temperature.count | count | +| temperature status | N/A | +| hardware.fan.count | count | +| fan status | N/A | +| hardware.fantray.count | count | +| fantray status | N/A | -| Name | Unit | -|:----------------------------------------------------------|:------| -| status | N/A | -| *interface_name*#interface.traffic.in.bitspersecond | b/s | -| *interface_name*#interface.traffic.out.bitspersecond | b/s | -| *interface_name*#interface.packets.in.discard.percentage | % | -| *interface_name*#interface.packets.in.error.percentage | % | -| *interface_name*#interface.packets.out.discard.percentage | % | -| *interface_name*#interface.packets.out.error.percentage | % | +| Name | Unit | +|:----------------------------------------------------------|:-----| +| status | N/A | +| *interface_name*#interface.traffic.in.bitspersecond | b/s | +| *interface_name*#interface.traffic.out.bitspersecond | b/s | +| *interface_name*#interface.packets.in.discard.percentage | % | +| *interface_name*#interface.packets.in.error.percentage | % | +| *interface_name*#interface.packets.out.discard.percentage | % | +| *interface_name*#interface.packets.out.error.percentage | % | -| Name | Unit | -|:----------------------------------|:------| -| *modules*#memory.usage.percentage | % | +| Name | Unit | +|:----------------------------------|:-----| +| *modules*#memory.usage.percentage | % | -| Name | Unit | -|:-------|:------| -| status | N/A | -| status | N/A | +| Name | Unit | +|:-------|:-----| +| status | N/A | > To obtain this new metric format, include **--use-new-perfdata** in the **EXTRAOPTIONS** service macro. -| Name | Unit | -|:--------------|:------| -| member-status | N/A | -| port-status | N/A | +| Name | Unit | +|:--------------|:-----| +| member-status | N/A | +| port-status | N/A | -| Name | Unit | -|:----------------------|:------| -| system.uptime.seconds | s | +| Name | Unit | +|:----------------------|:-----| +| system.uptime.seconds | s | > To obtain this new metric format, include **--use-new-perfdata** in the **EXTRAOPTIONS** service macro. @@ -188,6 +187,8 @@ port. ### Pack +The installation procedures for monitoring connectors are slightly different depending on [whether your license is offline or online](../getting-started/how-to-guides/connectors-licenses.md). + 1. 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 > Connectors > Monitoring Connectors** menu. @@ -278,14 +279,16 @@ yum install centreon-plugin-Network-Aruba-Aoscx-Snmp 1. Log into Centreon and add a new host through **Configuration > Hosts**. 2. Fill in the **Name**, **Alias** & **IP Address/DNS** fields according to your resource's settings. -3. Apply the **Net-Aruba-Aoscx-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](../getting-started/how-to-guides/troubleshooting-plugins.md#snmpv3-options-mapping) section. +3. Apply the **Net-Aruba-Aoscx-SNMP-custom** template to the host. -| 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](#available-options). | | | +| Macro | Description | Default value | Mandatory | +|:------------------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------|:--------------|:---------:| +| SNMP_V3_USERNAME | SNMP v3 only: User name (`securityName`) | | | +| SNMP_V3_AUTH_PROTOCOL | SNMP v3 only: Authentication protocol: MD5\|SHA. Since net-snmp 5.9.1: SHA224\|SHA256\|SHA384\|SHA512 | | | +| SNMP_V3_PRIV_PROTOCOL | 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 | | | +| SNMP_V3_AUTH_PASSPHRASE | SNMP v3 only: Pass phrase hashed using the authentication protocol defined in the --authprotocol option | | | +| SNMP_V3_PRIV_PASSPHRASE | SNMP v3 only: Privacy pass phrase (`privPassword`) to encrypt messages using the protocol defined in the --privprotocol option | | | +| SNMPEXTRAOPTIONS | Any extra option you may want to add to every command (a --verbose flag for example). All options are listed [here](#available-options). | | | 4. [Deploy the configuration](/docs/monitoring/monitoring-servers/deploying-a-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. @@ -297,122 +300,123 @@ yum install centreon-plugin-Network-Aruba-Aoscx-Snmp -| Macro | Description | Default value | Mandatory | -|:-----------------------|:---------------------------------------------------------------------------------------------------------------------------------------|:------------------|:-----------:| -| FILTERMODULENAME | Filter modules by name (can be a regexp) | | | -| WARNINGCPUUTILIZATION | Threshold | | | -| CRITICALCPUUTILIZATION | Threshold | | | -| EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). All options are listed [here](#available-options). | --verbose | | +| Macro | Description | Default value | Mandatory | +|:-----------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------|:--------------|:---------:| +| FILTERMODULENAME | Filter modules by name (can be a regexp) | | | +| WARNINGCPUUTILIZATION | Threshold | | | +| CRITICALCPUUTILIZATION | Threshold | | | +| EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). All options are listed [here](#available-options). | --verbose | | -| Macro | Description | Default value | Mandatory | -|:-------------|:---------------------------------------------------------------------------------------------------------------------------------------|:------------------|:-----------:| -| COMPONENT | Which component to check (default: '.*'). Can be: 'psu', 'temperature', 'fan', 'fantray' | | | -| EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). All options are listed [here](#available-options). | --verbose | | +| Macro | Description | Default value | Mandatory | +|:-------------|:-------------------------------------------------------------------------------------------------------------------------------------------------|:--------------|:---------:| +| COMPONENT | Which component to check. Can be: `psu`, `temperature`, `fan`, `fantray` | .* | | +| EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). All options are listed [here](#available-options). | --verbose | | -| Macro | Description | Default value | Mandatory | -|:-------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------|:----------------------------------------------------------|:-----------:| -| OIDFILTER | Define the OID to be used to filter interfaces (values: ifDesc, ifAlias, ifName, IpAddr) | ifname | | -| OIDDISPLAY | Define the OID that will be used to name the interfaces (values: ifDesc, ifAlias, ifName, IpAddr) | ifname | | -| INTERFACENAME | Check only the interfaces with the specified IDs (OID indexes, e.g.: 1,2,...). If empty, all interfaces will be monitored. To filter on interface names, see --name | | | -| WARNINGINDISCARD | Threshold | | | -| CRITICALINDISCARD | Threshold | | | -| WARNINGINERROR | Threshold | | | -| CRITICALINERROR | Threshold | | | -| WARNINGINTRAFFIC | Threshold | | | -| CRITICALINTRAFFIC | Threshold | | | -| WARNINGOUTDISCARD | Threshold | | | -| CRITICALOUTDISCARD | Threshold | | | -| WARNINGOUTERROR | Threshold | | | -| CRITICALOUTERROR | Threshold | | | -| WARNINGOUTTRAFFIC | Threshold | | | -| CRITICALOUTTRAFFIC | Threshold | | | -| CRITICALSTATUS | Define the conditions to match for the status to be CRITICAL. You can use the following variables: %\{admstatus\}, %\{opstatus\}, %\{duplexstatus\}, %\{display\} | %\{admstatus\} eq "up" and %\{opstatus\} !~ /up\|dormant/ | | -| WARNINGSTATUS | Define the conditions to match for the status to be WARNING. You can use the following variables: %\{admstatus\}, %\{opstatus\}, %\{duplexstatus\}, %\{display\} | | | -| EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). All options are listed [here](#available-options). | --verbose --no-skipped-counters | | +| Macro | Description | Default value | Mandatory | +|:-------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------|:----------------------------------------------------------|:---------:| +| OIDFILTER | Define the OID to be used to filter interfaces (values: ifDesc, ifAlias, ifName, IpAddr) | ifname | | +| OIDDISPLAY | Define the OID that will be used to name the interfaces (values: ifDesc, ifAlias, ifName, IpAddr) | ifname | | +| INTERFACENAME | Check only the interfaces with the specified IDs (OID indexes, e.g.: 1,2,...). If empty, all interfaces will be monitored. To filter on interface names, see --name | | | +| WARNINGINDISCARD | Thresholds | | | +| CRITICALINDISCARD | Thresholds | | | +| WARNINGINERROR | Thresholds | | | +| CRITICALINERROR | Thresholds | | | +| WARNINGINTRAFFIC | Thresholds | | | +| CRITICALINTRAFFIC | Thresholds | | | +| WARNINGOUTDISCARD | Thresholds | | | +| CRITICALOUTDISCARD | Thresholds | | | +| WARNINGOUTERROR | Thresholds | | | +| CRITICALOUTERROR | Thresholds | | | +| WARNINGOUTTRAFFIC | Thresholds | | | +| CRITICALOUTTRAFFIC | Thresholds | | | +| CRITICALSTATUS | Define the conditions to match for the status to be CRITICAL. You can use the following variables: %\{admstatus\}, %\{opstatus\}, %\{duplexstatus\}, %\{display\} | %\{admstatus\} eq "up" and %\{opstatus\} !~ /up\|dormant/ | | +| WARNINGSTATUS | Define the conditions to match for the status to be WARNING. You can use the following variables: %\{admstatus\}, %\{opstatus\}, %\{duplexstatus\}, %\{display\} | | | +| EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). All options are listed [here](#available-options). | --verbose --no-skipped-counters | | -| Macro | Description | Default value | Mandatory | -|:------------------------|:---------------------------------------------------------------------------------------------------------------------------------------|:------------------|:-----------:| -| FILTERMODULENAME | Filter modules by name (can be a regexp) | | | -| WARNINGMEMORYUSAGEPRCT | Threshold | | | -| CRITICALMEMORYUSAGEPRCT | Threshold | | | -| EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). All options are listed [here](#available-options). | --verbose | | +| Macro | Description | Default value | Mandatory | +|:------------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------|:--------------|:---------:| +| FILTERMODULENAME | Filter modules by name (can be a regexp) | | | +| WARNINGMEMORYUSAGEPRCT | Threshold | | | +| CRITICALMEMORYUSAGEPRCT | Threshold | | | +| EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). All options are listed [here](#available-options). | --verbose | | -| Macro | Description | Default value | Mandatory | -|:---------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:---------------------------------|:-----------:| -| FILTERPORT | Filter on port description (can be a regexp) | .* | | -| CRITICALSTATUS | Define the conditions to match for the status to be CRITICAL. You can use the following variables: %\{state\}, %\{op\_status\}, %\{admin\_status\}, %\{port\}, %\{index\} | %\{state\} =~ /blocking\|broken/ | | -| WARNINGSTATUS | Define the conditions to match for the status to be WARNING. You can use the following variables: %\{state\}, %\{op\_status\}, %\{admin\_status\}, %\{port\}, %\{index\} | | | -| EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). All options are listed [here](#available-options). | --verbose | | +| Macro | Description | Default value | Mandatory | +|:---------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:---------------------------------|:---------:| +| FILTERPORT | Filter on port description (can be a regexp) | .* | | +| CRITICALSTATUS | Define the conditions to match for the status to be CRITICAL. You can use the following variables: %\{state\}, %\{op\_status\}, %\{admin\_status\}, %\{port\}, %\{index\} | %\{state\} =~ /blocking\|broken/ | | +| WARNINGSTATUS | Define the conditions to match for the status to be WARNING. You can use the following variables: %\{state\}, %\{op\_status\}, %\{admin\_status\}, %\{port\}, %\{index\} | | | +| EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). All options are listed [here](#available-options). | --verbose | | -| Macro | Description | Default value | Mandatory | -|:---------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------|:----------------------------------------------------------|:-----------:| -| CRITICALMEMBERSTATUS | Define the conditions to match for the status to be CRITICAL. You can use the following variables: %\{role\}, %\{roleLast\}, %\{state\}, %\{stateLast\} | %\{role\} ne %\{roleLast\} | | -| WARNINGMEMBERSTATUS | Define the conditions to match for the status to be WARNING. You can use the following variables: %\{role\}, %\{roleLast\}, %\{state\}, %\{stateLast\} | | | -| CRITICALPORTSTATUS | Define the conditions to match for the status to be CRITICAL. You can use the following variables: %\{admin\_status\}, %\{oper\_status\}, %\{display\} | %\{admin\_status\} eq "up" and %\{oper\_status\} ne "up" | | -| WARNINGPORTSTATUS | Define the conditions to match for the status to be WARNING. You can use the following variables: %\{admin\_status\}, %\{oper\_status\}, %\{display\} | | | -| EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). All options are listed [here](#available-options). | --verbose | | +| Macro | Description | Default value | Mandatory | +|:---------------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:----------------------------------------------------------|:---------:| +| CRITICALMEMBERSTATUS | Define the conditions to match for the status to be CRITICAL (Default: '%\{role\} ne %\{roleLast\}'). You can use the following variables: %\{role\}, %\{roleLast\}, %\{state\}, %\{stateLast\} | %\{role\} ne %\{roleLast\} | | +| WARNINGMEMBERSTATUS | Define the conditions to match for the status to be WARNING (Default: ''). You can use the following variables: %\{role\}, %\{roleLast\}, %\{state\}, %\{stateLast\} | | | +| CRITICALPORTSTATUS | Define the conditions to match for the status to be CRITICAL (Default: '%\{admin\_status\} eq "up" and %\{oper\_status\} ne "up"'). You can use the following variables: %\{admin\_status\}, %\{oper\_status\}, %\{display\} | %\{admin\_status\} eq "up" and %\{oper\_status\} ne "up" | | +| WARNINGPORTSTATUS | Define the conditions to match for the status to be WARNING (Default: ''). You can use the following variables: %\{admin\_status\}, %\{oper\_status\}, %\{display\} | | | +| EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). All options are listed [here](#available-options). | --verbose | | -| Macro | Description | Default value | Mandatory | -|:-------------|:---------------------------------------------------------------------------------------------------------------------------------------|:------------------|:-----------:| -| WARNING | Warning threshold | | | -| CRITICAL | Critical threshold | | | -| EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). All options are listed [here](#available-options). | --check-overload | | +| Macro | Description | Default value | Mandatory | +|:-------------|:-------------------------------------------------------------------------------------------------------------------------------------------------|:-----------------|:---------:| +| UNIT | Select the time unit for thresholds. May be 's' for seconds, 'm' for minutes, 'h' for hours, 'd' for days, 'w' for weeks. Default is seconds | | | +| WARNING | Warning threshold | | | +| CRITICAL | Critical threshold | | | +| EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). All options are listed [here](#available-options). | --check-overload | | -| Macro | Description | Default value | Mandatory | -|:------------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------|:-----------------------------------------------------------------|:-----------:| -| WARNINGCPUUTILIZATION | Threshold | | | -| CRITICALCPUUTILIZATION | Threshold | | | -| CRITICALMEMBERSTATUS | Define the conditions to match for the status to be CRITICAL. You can use the following variables: %\{status\}, %\{role\}, %\{roleLast\}, %\{id\} | %\{role\} ne %\{roleLast\} \|\| %\{status\} !~ /ready\|booting/i | | -| WARNINGMEMBERSTATUS | Define the conditions to match for the status to be WARNING. You can use the following variables: %\{status\}, %\{role\}, %\{roleLast\}, %\{id\} | | | -| WARNINGMEMBERSTOTAL | Threshold | | | -| CRITICALMEMBERSTOTAL | Threshold | | | -| WARNINGMEMORYUSAGEPRCT | Threshold | | | -| CRITICALMEMORYUSAGEPRCT | Threshold | | | -| CRITICALSTATUS | Define the conditions to match for the status to be CRITICAL. You can use the following variables: %\{status\} | %\{status\} !~ /no\_split/i | | -| WARNINGSTATUS | Define the conditions to match for the status to be WARNING. You can use the following variables: %\{status\} | | | -| EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). All options are listed [here](#available-options). | --verbose | | +| Macro | Description | Default value | Mandatory | +|:------------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------|:-----------------------------------------------------------------|:---------:| +| WARNINGCPUUTILIZATION | Threshold | | | +| CRITICALCPUUTILIZATION | Threshold | | | +| CRITICALMEMBERSTATUS | Define the conditions to match for the status to be CRITICAL. You can use the following variables: %\{status\}, %\{role\}, %\{roleLast\}, %\{id\} | %\{role\} ne %\{roleLast\} \|\| %\{status\} !~ /ready\|booting/i | | +| WARNINGMEMBERSTATUS | Define the conditions to match for the status to be WARNING. You can use the following variables: %\{status\}, %\{role\}, %\{roleLast\}, %\{id\} | | | +| WARNINGMEMBERSTOTAL | Threshold | | | +| CRITICALMEMBERSTOTAL | Threshold | | | +| WARNINGMEMORYUSAGEPRCT | Threshold | | | +| CRITICALMEMORYUSAGEPRCT | Threshold | | | +| CRITICALSTATUS | Define the conditions to match for the status to be CRITICAL. You can use the following variables: %\{status\} | %\{status\} !~ /no\_split/i | | +| WARNINGSTATUS | Define the conditions to match for the status to be WARNING. You can use the following variables: %\{status\} | | | +| EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). All options are listed [here](#available-options). | --verbose | | -| Macro | Description | Default value | Mandatory | -|:----------------------------|:---------------------------------------------------------------------------------------------------------------------------------------|:---------------------------------------------------------|:-----------:| -| WARNINGDEVICESTATUS | Define the conditions to match for the status to be WARNING. You can use the following variables: %\{role\}, %\{config\_sync\} | | | -| CRITICALDEVICESTATUS | Define the conditions to match for the status to be CRITICAL. You can use the following variables: %\{role\}, %\{config\_sync\} | | | -| WARNINGISLPACKETSIN | Threshold | | | -| CRITICALISLPACKETSIN | Threshold | | | -| WARNINGISLPACKETSOUT | Threshold | | | -| CRITICALISLPACKETSOUT | Threshold | | | -| CRITICALISLSTATUS | Define the conditions to match for the status to be CRITICAL. You can use the following variables: %\{isl\_status\} | %\{isl\_status\} =~ /outSync/ | | -| WARNINGISLSTATUS | Define the conditions to match for the status to be WARNING. You can use the following variables: %\{isl\_status\} | | | -| WARNINGKEEPALIVEPACKETSIN | Threshold | | | -| CRITICALKEEPALIVEPACKETSIN | Threshold | | | -| WARNINGKEEPALIVEPACKETSOUT | Threshold | | | -| CRITICALKEEPALIVEPACKETSOUT | Threshold | | | -| CRITICALKEEPALIVESTATUS | Define the conditions to match for the status to be CRITICAL. You can use the following variables: %\{keepalive\_status\} | %\{keepalive\_status\} =~ /outofSyncEstablished\|failed/ | | -| WARNINGKEEPALIVESTATUS | Define the conditions to match for the status to be WARNING. You can use the following variables: %\{keepalive\_status\} | | | -| EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). All options are listed [here](#available-options). | --verbose | | +| Macro | Description | Default value | Mandatory | +|:----------------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------|:---------------------------------------------------------|:---------:| +| WARNINGDEVICESTATUS | Define the conditions to match for the status to be WARNING. You can use the following variables: %\{role\}, %\{config\_sync\} | | | +| CRITICALDEVICESTATUS | Define the conditions to match for the status to be CRITICAL. You can use the following variables: %\{role\}, %\{config\_sync\} | | | +| WARNINGISLPACKETSIN | Threshold | | | +| CRITICALISLPACKETSIN | Threshold | | | +| WARNINGISLPACKETSOUT | Threshold | | | +| CRITICALISLPACKETSOUT | Threshold | | | +| CRITICALISLSTATUS | Define the conditions to match for the status to be CRITICAL. You can use the following variables: %\{isl\_status\} | %\{isl\_status\} =~ /outSync/ | | +| WARNINGISLSTATUS | Define the conditions to match for the status to be WARNING. You can use the following variables: %\{isl\_status\} | | | +| WARNINGKEEPALIVEPACKETSIN | Threshold | | | +| CRITICALKEEPALIVEPACKETSIN | Threshold | | | +| WARNINGKEEPALIVEPACKETSOUT | Threshold | | | +| CRITICALKEEPALIVEPACKETSOUT | Threshold | | | +| CRITICALKEEPALIVESTATUS | Define the conditions to match for the status to be CRITICAL. You can use the following variables: %\{keepalive\_status\} | %\{keepalive\_status\} =~ /outofSyncEstablished\|failed/ | | +| WARNINGKEEPALIVESTATUS | Define the conditions to match for the status to be WARNING. You can use the following variables: %\{keepalive\_status\} | | | +| EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). All options are listed [here](#available-options). | --verbose | | @@ -427,36 +431,26 @@ is able to monitor a resource using a command like this one (replace the sample ```bash /usr/lib/centreon/plugins/centreon_aruba_aoscx_snmp.pl \ - --plugin=network::aruba::aoscx::snmp::plugin \ - --mode=vsf \ - --hostname=10.30.2.114 \ - --snmp-version='2c' \ - --snmp-community='aruba_ro' \ - --warning-cpu-utilization='90' \ - --critical-cpu-utilization='95' \ - --verbose + --plugin=network::aruba::aoscx::snmp::plugin \ + --mode=spanning-tree \ + --hostname=10.0.0.1 \ + --snmp-version='2c' \ + --snmp-community='my-snmp-community' \ + --snmp-username='username' \ + --authpassphrase='' \ + --authprotocol='' \ + --privpassphrase='' \ + --privprotocol='' \ + --filter-port='.*' \ + --warning-status='' \ + --critical-status='%\{state\} =~ /blocking|broken/' \ + --verbose ``` The expected command output is shown below: ```bash -OK: vsf operational status: no_split - All stack members are ok | '1#member.cpu.utilization.percentage'=16.00%;0:90;0:95;0;100 '1#member.memory.usage.percentage'=24.00%;;;0;100 '2#member.cpu.utilization.percentage'=4.00%;0:90;0:95;0;100 '2#member.memory.usage.percentage'=14.00%;;;0;100 '3#member.cpu.utilization.percentage'=4.00%;0:90;0:95;0;100 '3#member.memory.usage.percentage'=8.00%;;;0;100 '4#member.cpu.utilization.percentage'=4.00%;0:90;0:95;0;100 '4#member.memory.usage.percentage'=8.00%;;;0;100 -checking stack member '1' - role: master [status: ready] - cpu usage: 16.00% - memory used: 24.00 % -checking stack member '2' - role: standby [status: ready] - cpu usage: 4.00% - memory used: 14.00 % -checking stack member '3' - role: member [status: ready] - cpu usage: 4.00% - memory used: 8.00 % -checking stack member '4' - role: member [status: ready] - cpu usage: 4.00% - memory used: 8.00 % +OK: All spanning trees are ok ``` ### Troubleshooting @@ -502,66 +496,67 @@ The plugin brings the following modes: 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 ok, 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\[,\[\\],\[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\[,\[\\],\[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\[,\[\\],\[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,\,calculation\[,\[\\],\[min\],\[max\]\] regex: regular expression \: 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 \ (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~replacement~modifier Most commonly used modifiers are i (case insensitive) and g (replace all occurrences). Example: adding --change-short-output='OK\~Up\~gi' will replace all occurrences of 'OK', 'ok', 'Ok' or 'oK' with 'Up' | -| --change-short-output | Modify the short/long output that is returned by the plugin. Syntax: --change-short-output=pattern~replacement~modifier Most commonly used modifiers are i (case insensitive) and g (replace all occurrences). Example: adding --change-short-output='OK\~Up\~gi' will replace all occurrences of 'OK', 'ok', 'Ok' or 'oK' with 'Up' | -| --change-long-output | Modify the short/long output that is returned by the plugin. Syntax: --change-short-output=pattern~replacement~modifier Most commonly used modifiers are i (case insensitive) and g (replace all occurrences). Example: adding --change-short-output='OK\~Up\~gi' will replace all occurrences of 'OK', 'ok', 'Ok' or 'oK' with 'Up' | -| --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\. =cut | +| 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 get-next 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 ok, 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. | +| --show-password | By default, sensitive information in command lines is hidden in debug output and replaced with `***` (however, debug logs may still display sensitive information). Using the C option will display the passwords in plain text. | +| --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\[,\[\\],\[min\],\[max\]\] Common examples: onvert 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\[,\[\\],\[min\],\[max\]\] Common examples: onvert 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\[,\[\\],\[min\],\[max\]\] Common examples: onvert 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,\,calculation\[,\[\\],\[min\],\[max\]\] regex: regular expression \: 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 \ (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: um 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~replacement~modifier Most commonly used modifiers are i (case insensitive) and g (replace all occurrences). Example: adding --change-short-output='OK~Up~gi' will replace all occurrences of 'OK', 'ok', 'Ok' or 'oK' with 'Up' | +| --change-short-output | Modify the short/long output that is returned by the plugin. Syntax: --change-short-output=pattern~replacement~modifier Most commonly used modifiers are i (case insensitive) and g (replace all occurrences). Example: adding --change-short-output='OK~Up~gi' will replace all occurrences of 'OK', 'ok', 'Ok' or 'oK' with 'Up' | +| --change-long-output | Modify the short/long output that is returned by the plugin. Syntax: --change-short-output=pattern~replacement~modifier Most commonly used modifiers are i (case insensitive) and g (replace all occurrences). Example: adding --change-short-output='OK~Up~gi' will replace all occurrences of 'OK', 'ok', 'Ok' or 'oK' with 'Up' | +| --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'. \. | #### Modes options @@ -570,165 +565,217 @@ All available options for each service template are listed below: -| Option | Description | -|:-------------------------|:------------------------------------------------------------------------------------------------------------------------------| -| --filter-counters | Only display some counters (regexp can be used). Example to check SSL connections only : --filter-counters='^xxxx\|yyyy$' | -| --filter-module-name | Filter modules by name (can be a regexp). | -| --warning-* --critical-* | Thresholds. Can be: 'cpu-utilization' (%). | +| Option | Description | +|:-------------------------|:--------------------------------------------------------------------------------------------------------------------------| +| --filter-counters | Only display some counters (regexp can be used). Example to check SSL connections only : --filter-counters='^xxxx\|yyyy$' | +| --warning-xxx | Warning threshold. | +| --critical-xxx | Critical threshold. | +| --filter-module-name | Filter modules by name (can be a regexp). | +| --warning-* --critical-* | Thresholds. Can be: 'cpu-utilization' (%). | -| Option | Description | -|:---------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| --component | Which component to check (default: '.*'). Can be: 'psu', 'temperature', 'fan', 'fantray'. | -| --filter | Exclude the items given as a comma-separated list (example: --filter=psu). You can also exclude items from specific instances: --filter=fan,1.1 | -| --absent-problem | Return an error if a component is not 'present' (default is skipping). It can be set globally or for a specific instance: --absent-problem='component\_name' or --absent-problem='component\_name,instance\_value'. | -| --no-component | Define the expected status if no components are found (default: critical). | -| --threshold-overload | Use this option to override the status returned by the plugin when the status label matches a regular expression (syntax: section,status,regexp). Example: --threshold-overload='fan,WARNING,string' | -| --warning | Set warning threshold for 'temperature', 'fan.speed', 'psu.power' (syntax: section,\[instance,\]status,regexp) Example: --warning='temperature,.*,30' --warning='fan.speed,.*,1000' | -| --critical | Set critical threshold for 'temperature', 'fan.speed', 'psu.power' (syntax: section,\[instance,\]status,regexp) Example: --critical='temperature,.*,40' | -| --warning-count-* | Define the warning threshold for the number of components of one type (replace '*' with the component type). | -| --critical-count-* | Define the critical threshold for the number of components of one type (replace '*' with the component type). | +| Option | Description | +|:---------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| --component | Which component to check (default: '.*'). Can be: `psu`, `temperature`, `fan`, `fantray`. | +| --filter | Exclude the items given as a comma-separated list (example: --filter=psu). You can also exclude items from specific instances: --filter=fan,1.1 | +| --absent-problem | Return an error if a component is not 'present' (default is skipping). It can be set globally or for a specific instance: --absent-problem='component\_name' or --absent-problem='component\_name,instance\_value'. | +| --no-component | Define the expected status if no components are found (default: critical). | +| --threshold-overload | Use this option to override the status returned by the plugin when the status label matches a regular expression (syntax: section,status,regexp). Example: --threshold-overload='fan,WARNING,string' | +| --warning | Set warning threshold for 'temperature', 'fan.speed', 'psu.power' (syntax: section,\[instance,\]status,regexp) Example: --warning='temperature,.*,30' --warning='fan.speed,.*,1000' | +| --critical | Set critical threshold for 'temperature', 'fan.speed', 'psu.power' (syntax: section,\[instance,\]status,regexp) Example: --critical='temperature,.*,40' | +| --warning-count-* | Define the warning threshold for the number of components of one type (replace '*' with the component type). | +| --critical-count-* | Define the critical threshold for the number of components of one type (replace '*' with the component type). | -| Option | Description | -|:------------------------------------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| --filter-counters | Only display some counters (regexp can be used). Example to check SSL connections only : --filter-counters='^xxxx\|yyyy$' | -| --memcached | Memcached server to use (only one server). | -| --redis-server | Redis server to use (only one server). Syntax: address\[:port\] | -| --redis-attribute | Set Redis Options (--redis-attribute="cnx\_timeout=5"). | -| --redis-db | Set Redis database index. | -| --failback-file | Fall back on a local file if Redis connection fails. | -| --memexpiration | Time to keep data in seconds (default: 86400). | -| --statefile-dir | Define the cache directory (default: '/var/lib/centreon/centplugins'). | -| --statefile-suffix | Define a suffix to customize the statefile name (default: ''). | -| --statefile-concat-cwd | If used with the '--statefile-dir' option, the latter's value will be used as a sub-directory of the current working directory. Useful on Windows when the plugin is compiled, as the file system and permissions are different from Linux. | -| --statefile-format | Define the format used to store the cache. Available formats: 'dumper', 'storable', 'json' (default). | -| --statefile-key | Define the key to encrypt/decrypt the cache. | -| --statefile-cipher | Define the cipher algorithm to encrypt the cache (default: 'AES'). | -| --add-global | Check global port statistics (by default if no --add-* option is set). | -| --add-status | Check interface status. | -| --add-duplex-status | Check duplex status (with --warning-status and --critical-status). | -| --add-traffic | Check interface traffic. | -| --add-errors | Check interface errors. | -| --add-cast | Check interface cast. | -| --add-speed | Check interface speed. | -| --add-volume | Check interface data volume between two checks (not supposed to be graphed, useful for BI reporting). | -| --check-metrics | If the expression is true, metrics are checked (default: '%\{opstatus\} eq "up"'). | -| --warning-status | Define the conditions to match for the status to be WARNING. You can use the following variables: %\{admstatus\}, %\{opstatus\}, %\{duplexstatus\}, %\{display\} | -| --critical-status | Define the conditions to match for the status to be CRITICAL (default: '%\{admstatus\} eq "up" and %\{opstatus\} ne "up"'). You can use the following variables: %\{admstatus\}, %\{opstatus\}, %\{duplexstatus\}, %\{display\} | -| --warning-* --critical-* | Thresholds. Can be: 'total-port', 'total-admin-up', 'total-admin-down', 'total-oper-up', 'total-oper-down', 'in-traffic', 'out-traffic', 'in-error', 'in-discard', 'out-error', 'out-discard', 'in-ucast', 'in-bcast', 'in-mcast', 'out-ucast', 'out-bcast', 'out-mcast', 'speed' (b/s). | -| --units-traffic | Units of thresholds for the traffic (default: 'percent\_delta') ('percent\_delta', 'bps', 'counter'). | -| --units-errors | Units of thresholds for errors/discards (default: 'percent\_delta') ('percent\_delta', 'percent', 'delta', 'deltaps', 'counter'). | -| --units-cast | Units of thresholds for communication types (default: 'percent\_delta') ('percent\_delta', 'percent', 'delta', 'deltaps', 'counter'). | -| --nagvis-perfdata | Display traffic perfdata to be compatible with NagVis widget. | -| --interface | Check only the interfaces with the specified IDs (OID indexes, e.g.: 1,2,...). If empty, all interfaces will be monitored. To filter on interface names, see --name. | -| --name | With this option, the interfaces will be filtered by name (given in option --interface) instead of OID index. The name matching mode supports regular expressions. | -| --regex-id | With this option, interface IDs will be filtered using the --interface parameter as a regular expression instead of a list of IDs. | -| --speed | Set interface speed for incoming/outgoing traffic (in Mb). | -| --speed-in | Set interface speed for incoming traffic (in Mb). | -| --speed-out | Set interface speed for outgoing traffic (in Mb). | -| --map-speed-dsl | Get interface speed configuration for interfaces of type 'ADSL' and 'VDSL2'. Syntax: --map-speed-dsl=interface-src-name,interface-dsl-name E.g: --map-speed-dsl=Et0.835,Et0-vdsl2 | -| --force-counters64 | Force to use 64 bits counters only. Can be used to improve performance. | -| --force-counters32 | Force to use 32-bit counters (even with SNMP versions 2c and 3). To use when 64 bits counters are buggy. | -| --reload-cache-time | Time in minutes before reloading cache file (default: 180). | -| --oid-filter | Define the OID to be used to filter interfaces (default: ifName) (values: ifDesc, ifAlias, ifName, IpAddr). | -| --oid-display | Define the OID that will be used to name the interfaces (default: ifName) (values: ifDesc, ifAlias, ifName, IpAddr). | -| --oid-extra-display | Add an OID to display. | -| --display-transform-src --display-transform-dst | Modify the interface name displayed by using a regular expression. Example: adding --display-transform-src='eth' --display-transform-dst='ens' will replace all occurrences of 'eth' with 'ens' | -| --show-cache | Display cache interface data. | +| Option | Description | +|:------------------------------------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| --filter-counters | Only display some counters (regexp can be used). Example to check SSL connections only : --filter-counters='^xxxx\|yyyy$' | +| --warning-xxx | Warning threshold. | +| --critical-xxx | Critical threshold. | +| --memcached | Memcached server to use (only one server). | +| --redis-server | Redis server to use (only one server). Syntax: address\[:port\] | +| --redis-attribute | Set Redis Options (--redis-attribute="cnx\_timeout=5"). | +| --redis-db | Set Redis database index. | +| --failback-file | Fall back on a local file if Redis connection fails. | +| --memexpiration | Time to keep data in seconds (default: 86400). | +| --statefile-dir | Define the cache directory (default: '/var/lib/centreon/centplugins'). | +| --statefile-suffix | Define a suffix to customize the statefile name (default: ''). | +| --statefile-concat-cwd | If used with the '--statefile-dir' option, the latter's value will be used as a sub-directory of the current working directory. Useful on Windows when the plugin is compiled, as the file system and permissions are different from Linux. | +| --statefile-format | Define the format used to store the cache. Available formats: 'dumper', 'storable', 'json' (default). | +| --statefile-key | Define the key to encrypt/decrypt the cache. | +| --statefile-cipher | Define the cipher algorithm to encrypt the cache (default: 'AES'). | +| --add-global | Check global port statistics (by default if no --add-* option is set). | +| --add-status | Check interface status. | +| --add-duplex-status | Check duplex status (with --warning-status and --critical-status). | +| --add-traffic | Check interface traffic. | +| --add-errors | Check interface errors. | +| --add-cast | Check interface cast. | +| --add-speed | Check interface speed. | +| --add-volume | Check interface data volume between two checks (not supposed to be graphed, useful for BI reporting). | +| --check-metrics | If the expression is true, metrics are checked (default: '%\{opstatus\} eq "up"'). | +| --warning-status | Define the conditions to match for the status to be WARNING. You can use the following variables: %\{admstatus\}, %\{opstatus\}, %\{duplexstatus\}, %\{display\} | +| --critical-status | Define the conditions to match for the status to be CRITICAL (default: '%\{admstatus\} eq "up" and %\{opstatus\} ne "up"'). You can use the following variables: %\{admstatus\}, %\{opstatus\}, %\{duplexstatus\}, %\{display\} | +| --warning-total-port | Thresholds. | +| --critical-total-port | Thresholds. | +| --warning-total-admin-up | Thresholds. | +| --critical-total-admin-up | Thresholds. | +| --warning-total-admin-down | Thresholds. | +| --critical-total-admin-down | Thresholds. | +| --warning-total-oper-up | Thresholds. | +| --critical-total-oper-up | Thresholds. | +| --warning-total-oper-down | Thresholds. | +| --critical-total-oper-down | Thresholds. | +| --warning-in-traffic | Thresholds. | +| --critical-in-traffic | Thresholds. | +| --warning-out-traffic | Thresholds. | +| --critical-out-traffic | Thresholds. | +| --warning-in-error | Thresholds. | +| --critical-in-error | Thresholds. | +| --warning-in-discard | Thresholds. | +| --critical-in-discard | Thresholds. | +| --warning-out-error | Thresholds. | +| --critical-out-error | Thresholds. | +| --warning-out-discard | Thresholds. | +| --critical-out-discard | Thresholds. | +| --warning-in-ucast | Thresholds. | +| --critical-in-ucast | Thresholds. | +| --warning-in-bcast | Thresholds. | +| --critical-in-bcast | Thresholds. | +| --warning-in-mcast | Thresholds. | +| --critical-in-mcast | Thresholds. | +| --warning-out-ucast | Thresholds. | +| --critical-out-ucast | Thresholds. | +| --warning-out-bcast | Thresholds. | +| --critical-out-bcast | Thresholds. | +| --warning-out-mcast | Thresholds. | +| --critical-out-mcast | Thresholds. | +| --warning-speed | Thresholds in b/s. | +| --critical-speed | Thresholds in b/s. | +| --units-traffic | Units of thresholds for the traffic (default: 'percent\_delta') ('percent\_delta', 'bps', 'counter'). | +| --units-errors | Units of thresholds for errors/discards (default: 'percent\_delta') ('percent\_delta', 'delta', 'deltaps', 'counter'). | +| --units-cast | Units of thresholds for communication types (default: 'percent\_delta') ('percent\_delta', 'percent', 'delta', 'deltaps', 'counter'). | +| --nagvis-perfdata | Display traffic perfdata to be compatible with NagVis widget. | +| --interface | Check only the interfaces with the specified IDs (OID indexes, e.g.: 1,2,...). If empty, all interfaces will be monitored. To filter on interface names, see --name. | +| --name | With this option, the interfaces will be filtered by name (given in option --interface) instead of OID index. The name matching mode supports regular expressions. | +| --regex-id | With this option, interface IDs will be filtered using the --interface parameter as a regular expression instead of a list of IDs. | +| --speed | Set interface speed for incoming/outgoing traffic (in Mb). | +| --speed-in | Set interface speed for incoming traffic (in Mb). | +| --speed-out | Set interface speed for outgoing traffic (in Mb). | +| --map-speed-dsl | Get interface speed configuration for interfaces of type 'ADSL' and 'VDSL2'. Syntax: --map-speed-dsl=interface-src-name,interface-dsl-name E.g: --map-speed-dsl=Et0.835,Et0-vdsl2 | +| --force-counters64 | Force to use 64 bits counters only. Can be used to improve performance. | +| --force-counters32 | Force to use 32-bit counters (even with SNMP versions 2c and 3). To use when 64 bits counters are buggy. | +| --reload-cache-time | Time in minutes before reloading cache file (default: 180). | +| --oid-filter | Define the OID to be used to filter interfaces (default: ifName) (values: ifDesc, ifAlias, ifName, IpAddr). | +| --oid-display | Define the OID that will be used to name the interfaces (default: ifName) (values: ifDesc, ifAlias, ifName, IpAddr). | +| --oid-extra-display | Add an OID to display. | +| --display-transform-src --display-transform-dst | Modify the interface name displayed by using a regular expression. Example: adding --display-transform-src='eth' --display-transform-dst='ens' will replace all occurrences of 'eth' with 'ens' | +| --show-cache | Display cache interface data. | +| --no-cache-lock | Set to disable locking when accessing cache. | -| Option | Description | -|:-------------------------|:------------------------------------------------------------------------------------------------------------------------------| -| --filter-counters | Only display some counters (regexp can be used). Example to check SSL connections only : --filter-counters='^xxxx\|yyyy$' | -| --filter-module-name | Filter modules by name (can be a regexp). | -| --warning-* --critical-* | Thresholds. Can be: 'memory-usage-prct' (%). | +| Option | Description | +|:-------------------------|:--------------------------------------------------------------------------------------------------------------------------| +| --filter-counters | Only display some counters (regexp can be used). Example to check SSL connections only : --filter-counters='^xxxx\|yyyy$' | +| --warning-xxx | Warning threshold. | +| --critical-xxx | Critical threshold. | +| --filter-module-name | Filter modules by name (can be a regexp). | +| --warning-* --critical-* | Thresholds. Can be: 'memory-usage-prct' (%). | -| Option | Description | -|:------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| --filter-counters | Only display some counters (regexp can be used). Example to check SSL connections only : --filter-counters='^xxxx\|yyyy$' | -| --filter-port | Filter on port description (can be a regexp). | -| --warning-status | Define the conditions to match for the status to be WARNING. You can use the following variables: %\{state\}, %\{op\_status\}, %\{admin\_status\}, %\{port\}, %\{index\}. | -| --critical-status | Define the conditions to match for the status to be CRITICAL (default: '%\{op\_status\} =~ /up/ && %\{state\} =~ /blocking\|broken/'). You can use the following variables: %\{state\}, %\{op\_status\}, %\{admin\_status\}, %\{port\}, %\{index\}. | +| Option | Description | +|:------------------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| --filter-counters | Only display some counters (regexp can be used). Example to check SSL connections only : --filter-counters='^xxxx\|yyyy$' | +| --warning-xxx | Warning threshold. | +| --critical-xxx | Critical threshold. | +| --filter-port | Filter on port description (can be a regexp). | +| --warning-status | Define the conditions to match for the status to be WARNING. You can use the following variables: %\{state\}, %\{op\_status\}, %\{admin\_status\}, %\{port\}, %\{index\}. | +| --critical-status | Define the conditions to match for the status to be CRITICAL (default: '%\{op\_status\} =~ /up/ && %\{state\} =~ /blocking\|broken/'). You can use the following variables: %\{state\}, %\{op\_status\}, %\{admin\_status\}, %\{port\}, %\{index\}. | -| Option | Description | -|:-------------------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| --filter-counters | Only display some counters (regexp can be used). Example to check SSL connections only : --filter-counters='^xxxx\|yyyy$' | -| --unknown-member-status | Define the conditions to match for the status to be UNKNOWN (Default: ''). You can use the following variables: %\{role\}, %\{roleLast\}, %\{state\}, %\{stateLast\} | -| --warning-member-status | Define the conditions to match for the status to be WARNING (Default: ''). You can use the following variables: %\{role\}, %\{roleLast\}, %\{state\}, %\{stateLast\} | -| --critical-member-status | Define the conditions to match for the status to be CRITICAL (Default: '%\{role\} ne %\{roleLast\}'). You can use the following variables: %\{role\}, %\{roleLast\}, %\{state\}, %\{stateLast\} | -| --unknown-port-status | Define the conditions to match for the status to be UNKNOWN (Default: ''). You can use the following variables: %\{admin\_status\}, %\{oper\_status\}, %\{display\} | -| --warning-port-status | Define the conditions to match for the status to be WARNING (Default: ''). You can use the following variables: %\{admin\_status\}, %\{oper\_status\}, %\{display\} | -| --critical-port-status | Define the conditions to match for the status to be CRITICAL (Default: '%\{admin\_status\} eq "up" and %\{oper\_status\} ne "up"'). You can use the following variables: %\{admin\_status\}, %\{oper\_status\}, %\{display\} | +| Option | Description | +|:-------------------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| --filter-counters | Only display some counters (regexp can be used). Example to check SSL connections only : --filter-counters='^xxxx\|yyyy$' | +| --warning-xxx | Warning threshold. | +| --critical-xxx | Critical threshold. | +| --unknown-member-status | Define the conditions to match for the status to be UNKNOWN (Default: ''). You can use the following variables: %\{role\}, %\{roleLast\}, %\{state\}, %\{stateLast\} | +| --warning-member-status | Define the conditions to match for the status to be WARNING (Default: ''). You can use the following variables: %\{role\}, %\{roleLast\}, %\{state\}, %\{stateLast\} | +| --critical-member-status | Define the conditions to match for the status to be CRITICAL (Default: '%\{role\} ne %\{roleLast\}'). You can use the following variables: %\{role\}, %\{roleLast\}, %\{state\}, %\{stateLast\} | +| --unknown-port-status | Define the conditions to match for the status to be UNKNOWN (Default: ''). You can use the following variables: %\{admin\_status\}, %\{oper\_status\}, %\{display\} | +| --warning-port-status | Define the conditions to match for the status to be WARNING (Default: ''). You can use the following variables: %\{admin\_status\}, %\{oper\_status\}, %\{display\} | +| --critical-port-status | Define the conditions to match for the status to be CRITICAL (Default: '%\{admin\_status\} eq "up" and %\{oper\_status\} ne "up"'). You can use the following variables: %\{admin\_status\}, %\{oper\_status\}, %\{display\} | -| Option | Description | -|:-----------------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| --filter-counters | Only display some counters (regexp can be used). Example to check SSL connections only : --filter-counters='^xxxx\|yyyy$' | -| --memcached | Memcached server to use (only one server). | -| --redis-server | Redis server to use (only one server). Syntax: address\[:port\] | -| --redis-attribute | Set Redis Options (--redis-attribute="cnx\_timeout=5"). | -| --redis-db | Set Redis database index. | -| --failback-file | Fall back on a local file if Redis connection fails. | -| --memexpiration | Time to keep data in seconds (default: 86400). | -| --statefile-dir | Define the cache directory (default: '/var/lib/centreon/centplugins'). | -| --statefile-suffix | Define a suffix to customize the statefile name (default: ''). | -| --statefile-concat-cwd | If used with the '--statefile-dir' option, the latter's value will be used as a sub-directory of the current working directory. Useful on Windows when the plugin is compiled, as the file system and permissions are different from Linux. | -| --statefile-format | Define the format used to store the cache. Available formats: 'dumper', 'storable', 'json' (default). | -| --statefile-key | Define the key to encrypt/decrypt the cache. | -| --statefile-cipher | Define the cipher algorithm to encrypt the cache (default: 'AES'). | -| --warning-uptime | Warning threshold. | -| --critical-uptime | Critical threshold. | -| --add-sysdesc | Display system description. | -| --force-oid | Can choose your OID (numeric format only). | -| --check-overload | Uptime counter limit is 4294967296 and overflow. With that option, we manage the counter going back. But there is a few chance we can miss a reboot. | -| --reboot-window | To be used with check-overload option. Time in milliseconds (default: 5000) You increase the chance of not missing a reboot if you decrease that value. | -| --unit | Select the time unit for thresholds. May be 's' for seconds, 'm' for minutes, 'h' for hours, 'd' for days, 'w' for weeks. Default is seconds. | +| Option | Description | +|:-----------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| --filter-counters | Only display some counters (regexp can be used). Example to check SSL connections only : --filter-counters='^xxxx\|yyyy$' | +| --warning-xxx | Warning threshold. | +| --critical-xxx | Critical threshold. | +| --memcached | Memcached server to use (only one server). | +| --redis-server | Redis server to use (only one server). Syntax: address\[:port\] | +| --redis-attribute | Set Redis Options (--redis-attribute="cnx\_timeout=5"). | +| --redis-db | Set Redis database index. | +| --failback-file | Fall back on a local file if Redis connection fails. | +| --memexpiration | Time to keep data in seconds (default: 86400). | +| --statefile-dir | Define the cache directory (default: '/var/lib/centreon/centplugins'). | +| --statefile-suffix | Define a suffix to customize the statefile name (default: ''). | +| --statefile-concat-cwd | If used with the '--statefile-dir' option, the latter's value will be used as a sub-directory of the current working directory. Useful on Windows when the plugin is compiled, as the file system and permissions are different from Linux. | +| --statefile-format | Define the format used to store the cache. Available formats: 'dumper', 'storable', 'json' (default). | +| --statefile-key | Define the key to encrypt/decrypt the cache. | +| --statefile-cipher | Define the cipher algorithm to encrypt the cache (default: 'AES'). | +| --warning-uptime | Warning threshold. | +| --critical-uptime | Critical threshold. | +| --add-sysdesc | Display system description. | +| --force-oid | Can choose your OID (numeric format only). | +| --check-overload | Uptime counter limit is 4294967296 and overflow. With that option, we manage the counter going back. But there is a few chance we can miss a reboot. | +| --reboot-window | To be used with check-overload option. Time in milliseconds (default: 5000) You increase the chance of not missing a reboot if you decrease that value. | +| --unit | Select the time unit for thresholds. May be 's' for seconds, 'm' for minutes, 'h' for hours, 'd' for days, 'w' for weeks. Default is seconds. | -| Option | Description | -|:-------------------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| --filter-counters | Only display some counters (regexp can be used). Example to check SSL connections only : --filter-counters='^xxxx\|yyyy$' | -| --unknown-status | Define the conditions to match for the status to be UNKNOWN. You can use the following variables: %\{status\} | -| --warning-status | Define the conditions to match for the status to be WARNING. You can use the following variables: %\{status\} | -| --critical-status | Define the conditions to match for the status to be CRITICAL (default: '%\{status\} !~ /no\_split/i'). You can use the following variables: %\{status\} | -| --unknown-member-status | Define the conditions to match for the status to be UNKNOWN. You can use the following variables: %\{status\}, %\{role\}, %\{roleLast\}, %\{id\} | -| --warning-member-status | Define the conditions to match for the status to be WARNING. You can use the following variables: %\{status\}, %\{role\}, %\{roleLast\}, %\{id\} | -| --critical-member-status | Define the conditions to match for the status to be CRITICAL (default: '%\{role\} ne %\{roleLast\} \|\| %\{status\} !~ /ready\|booting/i'). You can use the following variables: %\{status\}, %\{role\}, %\{roleLast\}, %\{id\} | -| --warning-* --critical-* | Thresholds. Can be: 'members-total', 'memory-usage-prct', 'cpu-utilization'. | +| Option | Description | +|:-------------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| --filter-counters | Only display some counters (regexp can be used). Example to check SSL connections only : --filter-counters='^xxxx\|yyyy$' | +| --warning-xxx | Warning threshold. | +| --critical-xxx | Critical threshold. | +| --unknown-status | Define the conditions to match for the status to be UNKNOWN. You can use the following variables: %\{status\} | +| --warning-status | Define the conditions to match for the status to be WARNING. You can use the following variables: %\{status\} | +| --critical-status | Define the conditions to match for the status to be CRITICAL (default: '%\{status\} !~ /no\_split/i'). You can use the following variables: %\{status\} | +| --unknown-member-status | Define the conditions to match for the status to be UNKNOWN. You can use the following variables: %\{status\}, %\{role\}, %\{roleLast\}, %\{id\} | +| --warning-member-status | Define the conditions to match for the status to be WARNING. You can use the following variables: %\{status\}, %\{role\}, %\{roleLast\}, %\{id\} | +| --critical-member-status | Define the conditions to match for the status to be CRITICAL (default: '%\{role\} ne %\{roleLast\} \|\| %\{status\} !~ /ready\|booting/i'). You can use the following variables: %\{status\}, %\{role\}, %\{roleLast\}, %\{id\} | +| --warning-* --critical-* | Thresholds. Can be: 'members-total', 'memory-usage-prct', 'cpu-utilization'. | -| Option | Description | -|:----------------------------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| --filter-counters | Only display some counters (regexp can be used). Example to check SSL connections only : --filter-counters='^xxxx\|yyyy$' | -| --unknown-device-status | Define the conditions to match for the status to be UNKNOWN. You can use the following variables: %\{role\}, %\{config\_sync\} | -| --warning-device-status | Define the conditions to match for the status to be WARNING. You can use the following variables: %\{role\}, %\{config\_sync\} | -| --critical-device-status | Define the conditions to match for the status to be CRITICAL. You can use the following variables: %\{role\}, %\{config\_sync\} | -| --unknown-isl-status | Define the conditions to match for the status to be UNKNOWN. You can use the following variables: %\{isl\_status\} | -| --warning-isl-status | Define the conditions to match for the status to be WARNING. You can use the following variables: %\{isl\_status\} | -| --critical-isl-status | Define the conditions to match for the status to be CRITICAL (default: '%\{isl\_status\} =~ /outSync/'). You can use the following variables: %\{isl\_status\} | -| --unknown-keepalive-status | Define the conditions to match for the status to be UNKNOWN. You can use the following variables: %\{keepalive\_status\} | -| --warning-keepalive-status | Define the conditions to match for the status to be WARNING. You can use the following variables: %\{keepalive\_status\} | -| --critical-keepalive-status | Define the conditions to match for the status to be CRITICAL (default: '%\{keepalive\_status\} =~ /outofSyncEstablished\|failed/'). You can use the following variables: %\{keepalive\_status\} | -| --warning-* --critical-* | Thresholds. Can be: 'isl-packets-in', 'isl-packets-out', 'keepalive-packets-in', 'keepalive-packets-out'. | +| Option | Description | +|:----------------------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| --filter-counters | Only display some counters (regexp can be used). Example to check SSL connections only : --filter-counters='^xxxx\|yyyy$' | +| --warning-xxx | Warning threshold. | +| --critical-xxx | Critical threshold. | +| --unknown-device-status | Define the conditions to match for the status to be UNKNOWN. You can use the following variables: %\{role\}, %\{config\_sync\} | +| --warning-device-status | Define the conditions to match for the status to be WARNING. You can use the following variables: %\{role\}, %\{config\_sync\} | +| --critical-device-status | Define the conditions to match for the status to be CRITICAL. You can use the following variables: %\{role\}, %\{config\_sync\} | +| --unknown-isl-status | Define the conditions to match for the status to be UNKNOWN. You can use the following variables: %\{isl\_status\} | +| --warning-isl-status | Define the conditions to match for the status to be WARNING. You can use the following variables: %\{isl\_status\} | +| --critical-isl-status | Define the conditions to match for the status to be CRITICAL (default: '%\{isl\_status\} =~ /outSync/'). You can use the following variables: %\{isl\_status\} | +| --unknown-keepalive-status | Define the conditions to match for the status to be UNKNOWN. You can use the following variables: %\{keepalive\_status\} | +| --warning-keepalive-status | Define the conditions to match for the status to be WARNING. You can use the following variables: %\{keepalive\_status\} | +| --critical-keepalive-status | Define the conditions to match for the status to be CRITICAL (default: '%\{keepalive\_status\} =~ /outofSyncEstablished\|failed/'). You can use the following variables: %\{keepalive\_status\} | +| --warning-* --critical-* | Thresholds. Can be: 'isl-packets-in', 'isl-packets-out', 'keepalive-packets-in', 'keepalive-packets-out'. | diff --git a/pp/integrations/plugin-packs/procedures/network-aruba-instant-snmp.md b/pp/integrations/plugin-packs/procedures/network-aruba-instant-snmp.md index b041da932a3a..198fda34d8e8 100644 --- a/pp/integrations/plugin-packs/procedures/network-aruba-instant-snmp.md +++ b/pp/integrations/plugin-packs/procedures/network-aruba-instant-snmp.md @@ -5,9 +5,13 @@ title: Aruba Instant SNMP import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; -## Pack assets +## Connector dependencies + +The following monitoring connectors will be installed when you install the **Aruba Instant SNMP** connector through the +**Configuration > Connectors > Monitoring Connectors** menu: +* [Base Pack](./base-generic.md) -> Since HP acquired Aruba, some MIBs may have changed. If your Aruba device is no longer correcty monitored by the Aruba connector, use the [HP Procurve SNMP](network-switchs-hp-procurve-snmp.md) connector instead. +## Pack assets ### Templates @@ -22,8 +26,8 @@ The connector brings the following service templates (sorted by the host templat | Service Alias | Service Template | Service Description | |:--------------|:------------------------------------------|:--------------------------| -| Ap-Usage | Net-Aruba-Instant-Ap-Usage-SNMP-custom | Check access points usage. | -| Ssid-Status | Net-Aruba-Instant-Ssid-Status-SNMP-custom | Check SSID status. | +| Ap-Usage | Net-Aruba-Instant-Ap-Usage-SNMP-custom | Check access points usage | +| Ssid-Status | Net-Aruba-Instant-Ssid-Status-SNMP-custom | Check SSID status | > The services listed above are created automatically when the **Net-Aruba-Instant-SNMP-custom** host template is used. @@ -34,23 +38,23 @@ The connector brings the following service templates (sorted by the host templat #### Host discovery -| Rule name | Description | -|:----------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| SNMP Agents | Discover your resources through an SNMP subnet scan. You need to install the [Generic SNMP](./applications-protocol-snmp.md) connector to get the discovery rule and create a template mapper for the **Net-Aruba-Instant-SNMP-custom** host template. | +| Rule name | Description | +|:------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| SNMP Agents | Discover your resources through an SNMP subnet scan. You need to install the [Generic SNMP](./applications-protocol-snmp.md) connector to get the discovery rule and create a template mapper for the **Net-Aruba-Instant-SNMP-custom** host template. | More information about discovering hosts automatically is available on the [dedicated page](/docs/monitoring/discovery/hosts-discovery). ### Collected metrics & status -Here is the list of services for this connector, detailing all metrics linked to each service. +Here is the list of services for this connector, detailing all metrics and statuses linked to each service. -| Metric name | Unit | +| Name | Unit | |:--------------------------------|:------| | accesspoints.total.count | count | -| *ap*#status | N/A | +| status | N/A | | *ap*#clients.current.count | count | | *ap*#cpu.utilization.percentage | % | | *ap*#memory.usage.bytes | B | @@ -60,29 +64,31 @@ Here is the list of services for this connector, detailing all metrics linked to -| Metric name | Unit | -|:--------------|:------| -| *ssid*#status | N/A | +| Name | Unit | +|:-------|:-----| +| status | N/A | ## Prerequisites -### Device Configuration +### SNMP Configuration -The SNMP agent must be configured and running on the Aruba device. Please refer to the manufacturer documentation to achieve this. +The SNMP agent must be enabled and configured on the resource. +Please refer to the official documentation. +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 flows +### Network flow -The Centreon Poller must be able to reach the UDP/161 SNMP port of the Aruba device. +The target resource must be reachable from the Centreon poller on the UDP/161 SNMP port. ## Installing the monitoring connector ### Pack - The installation procedures for monitoring connectors are slightly different depending on [whether your license is offline or online](../getting-started/how-to-guides/connectors-licenses.md). - +The installation procedures for monitoring connectors are slightly different depending on [whether your license is offline or online](../getting-started/how-to-guides/connectors-licenses.md). 1. 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 @@ -122,7 +128,7 @@ yum install centreon-pack-network-aruba-instant-snmp 2. Whatever the license type (*online* or *offline*), install the **Aruba Instant SNMP** connector through -the **Configuration > Monitoring Connectors Manager** menu. +the **Configuration > Connectors > Monitoring Connectors** menu. ### Plugin @@ -173,15 +179,17 @@ yum install centreon-plugin-Network-Aruba-Instant-Snmp ### Using a host template provided by the connector 1. Log into Centreon and add a new host through **Configuration > Hosts**. -2. Fill the **Name**, **Alias** & **IP Address/DNS** fields according to your ressource settings. +2. Fill in the **Name**, **Alias** & **IP Address/DNS** fields according to your resource's settings. 3. Apply the **Net-Aruba-Instant-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](../getting-started/how-to-guides/troubleshooting-plugins.md#snmpv3-options-mapping) 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](#available-options). | | | +| Macro | Description | Default value | Mandatory | +|:------------------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------|:--------------|:---------:| +| SNMP_V3_USERNAME | SNMP v3 only: User name (`securityName`) | | | +| SNMP_V3_AUTH_PROTOCOL | SNMP v3 only: Authentication protocol: MD5\|SHA. Since net-snmp 5.9.1: SHA224\|SHA256\|SHA384\|SHA512 | | | +| SNMP_V3_PRIV_PROTOCOL | 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 | | | +| SNMP_V3_AUTH_PASSPHRASE | SNMP v3 only: Pass phrase hashed using the authentication protocol defined in the --authprotocol option | | | +| SNMP_V3_PRIV_PASSPHRASE | SNMP v3 only: Privacy pass phrase (`privPassword`) to encrypt messages using the protocol defined in the --privprotocol option | | | +| SNMPEXTRAOPTIONS | Any extra option you may want to add to every command (a --verbose flag for example). All options are listed [here](#available-options). | | | 4. [Deploy the configuration](/docs/monitoring/monitoring-servers/deploying-a-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. @@ -193,32 +201,32 @@ yum install centreon-plugin-Network-Aruba-Instant-Snmp -| Macro | Description | Default value | Mandatory | -|:---------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------|:-------------------|:-----------:| -| FILTERNAME | Filter access point name (can be a regexp) | | | -| WARNINGCLIENTS | Thresholds | | | -| CRITICALCLIENTS | Thresholds | | | -| WARNINGCPU | Thresholds | | | -| CRITICALCPU | Thresholds | | | -| WARNINGMEMUSAGE | Thresholds | | | -| CRITICALMEMUSAGE | Thresholds | | | -| WARNINGMEMUSAGEFREE | Thresholds | | | -| CRITICALMEMUSAGEFREE | Thresholds | | | -| WARNINGMEMUSAGEPRCT | Thresholds | | | -| CRITICALMEMUSAGEPRCT | Thresholds | | | -| CRITICALSTATUS | Define the conditions to match for the status to be CRITICAL (default: '%\{status\} !~ /up/i'). You can use the following variables: %\{status\}, %\{display\} | %\{status\} !~ /up/i | | -| WARNINGSTATUS | Define the conditions to match for the status to be WARNING (default: ''). You can use the following variables: %\{status\}, %\{display\} | | | -| EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). All options are listed [here](#available-options). | --verbose | | +| Macro | Description | Default value | Mandatory | +|:---------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------|:---------------------|:---------:| +| FILTERNAME | Filter access point name (can be a regexp) | | | +| WARNINGCLIENTS | Threshold | | | +| CRITICALCLIENTS | Threshold | | | +| WARNINGCPU | Threshold | | | +| CRITICALCPU | Threshold | | | +| WARNINGMEMUSAGE | Threshold | | | +| CRITICALMEMUSAGE | Threshold | | | +| WARNINGMEMUSAGEFREE | Threshold | | | +| CRITICALMEMUSAGEFREE | Threshold | | | +| WARNINGMEMUSAGEPRCT | Threshold | | | +| CRITICALMEMUSAGEPRCT | Threshold | | | +| CRITICALSTATUS | Define the conditions to match for the status to be CRITICAL. You can use the following variables: %\{status\}, %\{display\} | %\{status\} !~ /up/i | | +| WARNINGSTATUS | Define the conditions to match for the status to be WARNING. You can use the following variables: %\{status\}, %\{display\} | | | +| EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). All options are listed [here](#available-options). | --verbose | | -| Macro | Description | Default value | Mandatory | -|:---------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------|:-----------------------|:-----------:| -| FILTERNAME | Filter SSID name (can be a regexp) | | | -| CRITICALSTATUS | Define the conditions to match for the status to be CRITICAL (default: '%\{status\} !~ /enable/i'). You can use the following variables: %\{status\}, %\{display\} | %\{status\} !~ /enable/i | | -| WARNINGSTATUS | Define the conditions to match for the status to be WARNING (default: ''). You can use the following variables: %\{status\}, %\{display\} | | | -| EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). All options are listed [here](#available-options). | --verbose | | +| Macro | Description | Default value | Mandatory | +|:---------------|:-------------------------------------------------------------------------------------------------------------------------------------------------|:-------------------------|:---------:| +| FILTERNAME | Filter SSID name (can be a regexp) | | | +| CRITICALSTATUS | Define the conditions to match for the status to be CRITICAL. You can use the following variables: %\{status\}, %\{display\} | %\{status\} !~ /enable/i | | +| WARNINGSTATUS | Define the conditions to match for the status to be WARNING. You can use the following variables: %\{status\}, %\{display\} | | | +| EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). All options are listed [here](#available-options). | --verbose | | @@ -228,36 +236,31 @@ yum install centreon-plugin-Network-Aruba-Instant-Snmp ## 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 +**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): ```bash /usr/lib/centreon/plugins/centreon_aruba_instant_snmp.pl \ --plugin=network::aruba::instant::snmp::plugin \ - --mode=ap-usage \ + --mode=ssid-status \ --hostname=10.0.0.1 \ --snmp-version='2c' \ - --snmp-community='my-snmp-community' \ + --snmp-community='my-snmp-community' \ + --snmp-username='username' \ + --authpassphrase='' \ + --authprotocol='' \ + --privpassphrase='' \ + --privprotocol='' \ --filter-name='' \ --warning-status='' \ - --critical-status='%\{status\} !~ /up/i' \ - --warning-cpu='' \ - --critical-cpu='' \ - --warning-clients='' \ - --critical-clients='' \ - --warning-mem-usage='' \ - --critical-mem-usage='' \ - --warning-mem-usage-free='' \ - --critical-mem-usage-free='' \ - --warning-mem-usage-prct='' \ - --critical-mem-usage-prct='' \ + --critical-status='%\{status\} !~ /enable/i' \ --verbose ``` The expected command output is shown below: ```bash -OK: total access points: 88 All access points are ok | 'accesspoints.total.count'=88;;;0;'*ap*#clients.current.count'=;;;0;'*ap*#cpu.utilization.percentage'=%;;;0;100'*ap*#memory.usage.bytes'=B;;;0;total'*ap*#memory.free.bytes'=B;;;0;total'*ap*#memory.usage.percentage'=%;;;0;100 +OK: All SSIDs are ok ``` ### Troubleshooting @@ -269,7 +272,7 @@ for Centreon Plugins typical issues. 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 +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 @@ -294,61 +297,70 @@ The plugin brings the following modes: 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. | -| --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 an "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\[,\[newuom\],\[min\],\[m ax\]\] Common examples: 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() | -| --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,namesofnewmetrics,calculation\[,\[ne wuom\],\[min\],\[max\]\] regex: regular expression namesofnewmetrics: 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 newuom (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: 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(traf fic\_(in\|out)\_$1)' | -| --change-short-output --change-long-output | Modify the short/long output that is returned by the plugin. Syntax: --change-short-output=pattern~replacement~modifier Most commonly used modifiers are i (case insensitive) and g (replace all occurrences). Example: adding --change-short-output='OK\~Up\~gi' will replace all occurrences of 'OK', 'ok', 'Ok' or 'oK' with 'Up' | -| --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. | -| --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). E.g.: --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'. | -| --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 ok, 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. | +| 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 get-next 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 ok, 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. | +| --show-password | By default, sensitive information in command lines is hidden in debug output and replaced with `***` (however, debug logs may still display sensitive information). Using the C option will display the passwords in plain text. | +| --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\[,\[\\],\[min\],\[max\]\] Common examples: onvert 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\[,\[\\],\[min\],\[max\]\] Common examples: onvert 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\[,\[\\],\[min\],\[max\]\] Common examples: onvert 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,\,calculation\[,\[\\],\[min\],\[max\]\] regex: regular expression \: 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 \ (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: um 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~replacement~modifier Most commonly used modifiers are i (case insensitive) and g (replace all occurrences). Example: adding --change-short-output='OK~Up~gi' will replace all occurrences of 'OK', 'ok', 'Ok' or 'oK' with 'Up' | +| --change-short-output | Modify the short/long output that is returned by the plugin. Syntax: --change-short-output=pattern~replacement~modifier Most commonly used modifiers are i (case insensitive) and g (replace all occurrences). Example: adding --change-short-output='OK~Up~gi' will replace all occurrences of 'OK', 'ok', 'Ok' or 'oK' with 'Up' | +| --change-long-output | Modify the short/long output that is returned by the plugin. Syntax: --change-short-output=pattern~replacement~modifier Most commonly used modifiers are i (case insensitive) and g (replace all occurrences). Example: adding --change-short-output='OK~Up~gi' will replace all occurrences of 'OK', 'ok', 'Ok' or 'oK' with 'Up' | +| --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'. \. | +| --filter-counters | Only display some counters (regexp can be used). Example to check SSL connections only : --filter-counters='^xxxx\|yyyy$' | +| --warning-xxx | Warning threshold. | +| --critical-xxx | Critical threshold. | #### Modes options @@ -357,22 +369,22 @@ All available options for each service template are listed below: -| Option | Description | -|:-------------------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------| -| --filter-counters | Only display some counters (regexp can be used). Example: --filter-counters='^cpu$' | -| --filter-name | Filter access point name (can be a regexp). | +| Option | Description | +|:-------------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------| +| --filter-counters | Only display some counters (regexp can be used). Example: --filter-counters='^cpu$' | +| --filter-name | Filter access point name (can be a regexp). | | --warning-status | Define the conditions to match for the status to be WARNING (default: ''). You can use the following variables: %\{status\}, %\{display\} | -| --critical-status | Define the conditions to match for the status to be CRITICAL (default: '%\{status\} !~ /up/i'). You can use the following variables: %\{status\}, %\{display\} | -| --warning-* --critical-* | Thresholds. Can be: 'total-ap', 'cpu', 'clients', 'mem-usage' (B), 'mem-usage-free' (B), 'mem-usage-prct' (%). | +| --critical-status | Define the conditions to match for the status to be CRITICAL (default: '%\{status\} !~ /up/i'). You can use the following variables: %\{status\}, %\{display\} | +| --warning-* --critical-* | Thresholds. Can be: 'total-ap', 'cpu', 'clients', 'mem-usage' (B), 'mem-usage-free' (B), 'mem-usage-prct' (%). | -| Option | Description | -|:------------------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------| -| --filter-name | Filter SSID name (can be a regexp). | -| --warning-status | Define the conditions to match for the status to be WARNING (default: ''). You can use the following variables: %\{status\}, %\{display\} | -| --critical-status | Define the conditions to match for the status to be CRITICAL (default: '%\{status\} !~ /enable/i'). You can use the following variables: %\{status\}, %\{display\} | +| Option | Description | +|:------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| --filter-name | Filter SSID name (can be a regexp). | +| --warning-status | Define the conditions to match for the status to be WARNING (default: ''). You can use the following variables: %\{status\}, %\{display\} | +| --critical-status | Define the conditions to match for the status to be CRITICAL (default: '%\{status\} !~ /enable/i'). You can use the following variables: %\{status\}, %\{display\} | @@ -383,6 +395,6 @@ All available options for a given mode can be displayed by adding the ```bash /usr/lib/centreon/plugins/centreon_aruba_instant_snmp.pl \ --plugin=network::aruba::instant::snmp::plugin \ - --mode=ap-usage \ + --mode=ssid-status \ --help ``` diff --git a/pp/integrations/plugin-packs/procedures/network-cisco-meraki-snmp.md b/pp/integrations/plugin-packs/procedures/network-cisco-meraki-snmp.md index 7f97318767ad..617a88e15ef0 100644 --- a/pp/integrations/plugin-packs/procedures/network-cisco-meraki-snmp.md +++ b/pp/integrations/plugin-packs/procedures/network-cisco-meraki-snmp.md @@ -5,6 +5,12 @@ title: Cisco Meraki SNMP import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; +## Connector dependencies + +The following monitoring connectors will be installed when you install the **Cisco Meraki SNMP** connector through the +**Configuration > Connectors > Monitoring Connectors** menu: +* [Base Pack](./base-generic.md) + ## Pack assets ### Templates @@ -18,9 +24,9 @@ The connector brings the following service templates (sorted by the host templat -| Service Alias | Service Template | Service Description | Discovery | -|:--------------|:----------------------------------------------------------|:-------------------------|:----------:| -| Device-Usage | Net-Cisco-Meraki-Cloudcontroller-Device-Usage-SNMP-custom | Check access point usage | X | +| Service Alias | Service Template | Service Description | Discovery | +|:--------------|:----------------------------------------------------------|:-------------------------|:---------:| +| Device-Usage | Net-Cisco-Meraki-Cloudcontroller-Device-Usage-SNMP-custom | Check access point usage | X | > The services listed above are created automatically when the **Net-Cisco-Meraki-Cloudcontroller-SNMP-custom** host template is used. @@ -33,35 +39,35 @@ The connector brings the following service templates (sorted by the host templat #### Host discovery -| Rule name | Description | -|:----------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| SNMP Agents | Discover your resources through an SNMP subnet scan. You need to install the [Generic SNMP](./applications-protocol-snmp.md) connector to get the discovery rule and create a template mapper for the **Net-Cisco-Meraki-Cloudcontroller-SNMP-custom** host template | +| Rule name | Description | +|:------------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| SNMP Agents | Discover your resources through an SNMP subnet scan. You need to install the [Generic SNMP](./applications-protocol-snmp.md) connector to get the discovery rule and create a template mapper for the **Net-Cisco-Meraki-Cloudcontroller-SNMP-custom** host template. | More information about discovering hosts automatically is available on the [dedicated page](/docs/monitoring/discovery/hosts-discovery). #### Service discovery -| Rule name | Description | -|:---------------------------------------------------|:------------| -| Net-Cisco-Meraki-Cloudcontroller-SNMP-Device-Usage | Discover the devices to monitor their state and usage. | +| Rule name | Description | +|:---------------------------------------------------|:------------------------------------------------------| +| Net-Cisco-Meraki-Cloudcontroller-SNMP-Device-Usage | Discover the devices to monitor their state and usage | More information about discovering services automatically is available on the [dedicated page](/docs/monitoring/discovery/services-discovery) and in the [following chapter](/docs/monitoring/discovery/services-discovery/#discovery-rules). ### Collected metrics & status -Here is the list of services for this connector, detailing all metrics linked to each service. +Here is the list of services for this connector, detailing all metrics and statuses linked to each service. -| Metric name | Unit | -|:---------------------|:------| -| total-devices | N/A | -| *device*#status | N/A | -| *device*#clients | N/A | -| *interface*#traffic_ | b/s | -| *interface*#traffic_ | b/s | +| Name | Unit | +|:----------------|:-----| +| total-devices | N/A | +| status | N/A | +| clients | N/A | +| *interface*#in | b/s | +| *interface*#out | b/s | > To obtain this new metric format, include **--use-new-perfdata** in the **EXTRAOPTIONS** service macro. @@ -72,7 +78,10 @@ Here is the list of services for this connector, detailing all metrics linked to ### SNMP Configuration -The SNMP service must be configured and activated on the host. Please refer to the official documentation from the manufacturer/publisher. +The SNMP agent must be enabled and configured on the resource. +Please refer to the official documentation. +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 @@ -83,8 +92,7 @@ SNMP port. ### Pack - The installation procedures for monitoring connectors are slightly different depending on [whether your license is offline or online](../getting-started/how-to-guides/connectors-licenses.md). - +The installation procedures for monitoring connectors are slightly different depending on [whether your license is offline or online](../getting-started/how-to-guides/connectors-licenses.md). 1. 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 @@ -107,7 +115,7 @@ dnf install centreon-pack-network-cisco-meraki-snmp ``` - + ```bash apt install centreon-pack-network-cisco-meraki-snmp @@ -124,7 +132,7 @@ yum install centreon-pack-network-cisco-meraki-snmp 2. Whatever the license type (*online* or *offline*), install the **Cisco Meraki SNMP** connector through -the **Configuration > Monitoring Connectors Manager** menu. +the **Configuration > Connectors > Monitoring Connectors** menu. ### Plugin @@ -154,7 +162,7 @@ dnf install centreon-plugin-Network-Cisco-Meraki-Snmp ``` - + ```bash apt install centreon-plugin-network-cisco-meraki-snmp @@ -175,15 +183,17 @@ yum install centreon-plugin-Network-Cisco-Meraki-Snmp ### Using a host template provided by the connector 1. Log into Centreon and add a new host through **Configuration > Hosts**. -2. Fill the **Name**, **Alias** & **IP Address/DNS** fields according to your ressource settings. -3. Apply the **Net-Cisco-Meraki-Cloudcontroller-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](../getting-started/how-to-guides/troubleshooting-plugins.md#snmpv3-options-mapping) 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](#available-options). | | | +2. Fill in the **Name**, **Alias** & **IP Address/DNS** fields according to your resource's settings. +3. Apply the **Net-Cisco-Meraki-Cloudcontroller-SNMP-custom** template to the host. + +| Macro | Description | Default value | Mandatory | +|:------------------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------|:--------------|:---------:| +| SNMP_V3_USERNAME | SNMP v3 only: User name (`securityName`) | | | +| SNMP_V3_AUTH_PROTOCOL | SNMP v3 only: Authentication protocol: MD5\|SHA. Since net-snmp 5.9.1: SHA224\|SHA256\|SHA384\|SHA512 | | | +| SNMP_V3_PRIV_PROTOCOL | 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 | | | +| SNMP_V3_AUTH_PASSPHRASE | SNMP v3 only: Pass phrase hashed using the authentication protocol defined in the --authprotocol option | | | +| SNMP_V3_PRIV_PASSPHRASE | SNMP v3 only: Privacy pass phrase (`privPassword`) to encrypt messages using the protocol defined in the --privprotocol option | | | +| SNMPEXTRAOPTIONS | Any extra option you may want to add to every command (a --verbose flag for example). All options are listed [here](#available-options). | | | 4. [Deploy the configuration](/docs/monitoring/monitoring-servers/deploying-a-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. @@ -195,21 +205,21 @@ yum install centreon-plugin-Network-Cisco-Meraki-Snmp -| Macro | Description | Default value | Mandatory | -|:---------------------|:---------------------------------------------------------------------------------------------------|:------------------|:-----------:| -| FILTERPRODUCT | Filter device product code (can be a regexp) | | | -| FILTERNETWORK | Filter by network name (can be a regexp) | | | -| FILTERNAME | Filter device name (can be a regexp) | | | -| FILTERINTERFACE | Filter interface name (can be a regexp) | | | -| WARNINGCLIENTS | Warning threshold | | | -| CRITICALCLIENTS | Critical threshold | | | -| WARNINGIN | Warning threshold | | | -| CRITICALIN | Critical threshold | | | -| WARNINGOUT | Warning threshold | | | -| CRITICALOUT | Critical threshold | | | -| WARNINGTOTALDEVICES | Warning threshold | | | -| CRITICALTOTALDEVICES | Critical threshold | | | -| EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). All options are listed [here](#available-options). | --verbose | | +| Macro | Description | Default value | Mandatory | +|:---------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------|:--------------|:---------:| +| FILTERPRODUCT | Filter device product code (can be a regexp) | | | +| FILTERNETWORK | Filter by network name (can be a regexp) | | | +| FILTERNAME | Filter device name (can be a regexp) | | | +| FILTERINTERFACE | Filter interface name (can be a regexp) | | | +| WARNINGCLIENTS | Threshold | | | +| CRITICALCLIENTS | Threshold | | | +| WARNINGIN | Threshold | | | +| CRITICALIN | Threshold | | | +| WARNINGOUT | Threshold | | | +| CRITICALOUT | Threshold | | | +| WARNINGTOTALDEVICES | Threshold | | | +| CRITICALTOTALDEVICES | Threshold | | | +| EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). All options are listed [here](#available-options). | --verbose | | @@ -228,7 +238,12 @@ is able to monitor a resource using a command like this one (replace the sample --mode=device-usage \ --hostname=10.0.0.1 \ --snmp-version='2c' \ - --snmp-community='my-snmp-community' \ + --snmp-community='my-snmp-community' \ + --snmp-username='username' \ + --authpassphrase='' \ + --authprotocol='' \ + --privpassphrase='' \ + --privprotocol='' \ --filter-product='' \ --filter-network='' \ --filter-name='' \ @@ -247,7 +262,7 @@ is able to monitor a resource using a command like this one (replace the sample The expected command output is shown below: ```bash -OK: All devices are ok All device interfaces are ok | 'total-devices'=49;;;0;'*device*#clients'=;;;0;'*interface*#traffic_'=b/s;;;;'*interface*#traffic_'=b/s;;;; +OK: All devices are ok All device interfaces are ok | 'interface1#in'=52709b/s;;;; 'interface2#in'=51764b/s;;;; 'interface1#out'=48864b/s;;;; 'interface2#out'=26672b/s;;;; ``` ### Troubleshooting @@ -287,86 +302,90 @@ All available options for each service template are listed below: -| 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. | -| --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 an "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\[,\[newuom\],\[min\],\[m ax\]\] Common examples: 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() | -| --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,namesofnewmetrics,calculation\[,\[ne wuom\],\[min\],\[max\]\] regex: regular expression namesofnewmetrics: 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 newuom (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: 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(traf fic\_(in\|out)\_$1)' | -| --change-short-output --change-long-output | Modify the short/long output that is returned by the plugin. Syntax: --change-short-output=pattern~replacement~modifier Most commonly used modifiers are i (case insensitive) and g (replace all occurrences). Example: adding --change-short-output='OK\~Up\~gi' will replace all occurrences of 'OK', 'ok', 'Ok' or 'oK' with 'Up' | -| --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. | -| --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). E.g.: --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'. | -| --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 ok, 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. | -| --memcached | Memcached server to use (only one server). | -| --redis-server | Redis server to use (only one server). Syntax: address\[:port\] | -| --redis-attribute | Set Redis Options (--redis-attribute="cnx\_timeout=5"). | -| --redis-db | Set Redis database index. | -| --failback-file | Failback on a local file if Redis connection fails. | -| --memexpiration | Time to keep data in seconds (default: 86400). | -| --statefile-dir | Define the cache directory (default: '/var/lib/centreon/centplugins'). | -| --statefile-suffix | Define a suffix to customize the statefile name (default: ''). | -| --statefile-concat-cwd | If used with the '--statefile-dir' option, the latter's value will be used as a sub-directory of the current working directory. Useful on Windows when the plugin is compiled, as the file system and permissions are different from Linux. | -| --statefile-format | Define the format used to store the cache. Available formats: 'dumper', 'storable', 'json' (default). | -| --statefile-key | Define the key to encrypt/decrypt the cache. | -| --statefile-cipher | Define the cipher algorithm to encrypt the cache (default: 'AES'). | -| --filter-counters | Only display some counters (regexp can be used). Example: --filter-counters='^clients$' | -| --filter-name | Filter device name (can be a regexp). | -| --filter-product | Filter device product code (can be a regexp). | -| --filter-network | Filter by network name (can be a regexp). | -| --filter-interface | Filter interface name (can be a regexp). | -| --cache-expires-on | Use cache file to speed up mode execution (X seconds before refresh cache file). | -| --speed-in | Set interface speed for incoming traffic (in Mb). | -| --speed-out | Set interface speed for outgoing traffic (in Mb). | -| --units-traffic | Units of thresholds for the traffic (default: '%') ('%', 'b/s'). | -| --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 (default: '%\{status\} =~ /offline/'). You can use the following variables: %\{status\}, %\{display\} | -| --warning-* | Warning threshold. Can be: 'total-devices', 'clients', 'in', 'out'. | -| --critical-* | Critical threshold. Can be: 'total-devices', 'clients', 'in', 'out'. | +| Option | Description | +|:-------------------------------------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| --filter-counters | Only display some counters (regexp can be used). Example: --filter-counters='^clients$' | +| --warning-xxx | Warning threshold. | +| --critical-xxx | Critical threshold. | +| --memcached | Memcached server to use (only one server). | +| --redis-server | Redis server to use (only one server). Syntax: address\[:port\] | +| --redis-attribute | Set Redis Options (--redis-attribute="cnx\_timeout=5"). | +| --redis-db | Set Redis database index. | +| --failback-file | Fall back on a local file if Redis connection fails. | +| --memexpiration | Time to keep data in seconds (default: 86400). | +| --statefile-dir | Define the cache directory (default: '/var/lib/centreon/centplugins'). | +| --statefile-suffix | Define a suffix to customize the statefile name (default: ''). | +| --statefile-concat-cwd | If used with the '--statefile-dir' option, the latter's value will be used as a sub-directory of the current working directory. Useful on Windows when the plugin is compiled, as the file system and permissions are different from Linux. | +| --statefile-format | Define the format used to store the cache. Available formats: 'dumper', 'storable', 'json' (default). | +| --statefile-key | Define the key to encrypt/decrypt the cache. | +| --statefile-cipher | Define the cipher algorithm to encrypt the cache (default: 'AES'). | +| --filter-name | Filter device name (can be a regexp). | +| --filter-product | Filter device product code (can be a regexp). | +| --filter-network | Filter by network name (can be a regexp). | +| --filter-interface | Filter interface name (can be a regexp). | +| --cache-expires-on | Use cache file to speed up mode execution (X seconds before refresh cache file). | +| --speed-in | Set interface speed for incoming traffic (in Mb). | +| --speed-out | Set interface speed for outgoing traffic (in Mb). | +| --units-traffic | Units of thresholds for the traffic (default: '%') ('%', 'b/s'). | +| --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 (default: '%\{status\} =~ /offline/'). You can use the following variables: %\{status\}, %\{display\} | +| --warning-* | Warning threshold. Can be: 'total-devices', 'clients', 'in', 'out'. | +| --critical-* | Critical threshold. Can be: 'total-devices', 'clients', 'in', 'out'. | +| --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 get-next 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 ok, 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. | +| --show-password | By default, sensitive information in command lines is hidden in debug output and replaced with `***` (however, debug logs may still display sensitive information). Using the C option will display the passwords in plain text. | +| --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\[,\[\\],\[min\],\[max\]\] Common examples: onvert 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,\,calculation\[,\[\\],\[min\],\[max\]\] regex: regular expression \: 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 \ (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: um 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~replacement~modifier Most commonly used modifiers are i (case insensitive) and g (replace all occurrences). Example: adding --change-short-output='OK~Up~gi' will replace all occurrences of 'OK', 'ok', 'Ok' or 'oK' with 'Up' | +| --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'. \. | diff --git a/pp/integrations/plugin-packs/procedures/network-cisco-wlc-snmp.md b/pp/integrations/plugin-packs/procedures/network-cisco-wlc-snmp.md index f2c9bee626d7..7f0784a7a3b4 100644 --- a/pp/integrations/plugin-packs/procedures/network-cisco-wlc-snmp.md +++ b/pp/integrations/plugin-packs/procedures/network-cisco-wlc-snmp.md @@ -7,7 +7,7 @@ import TabItem from '@theme/TabItem'; ## Connector dependencies -The following monitoring connectors will be installed when you install the **Cisco WLC** connector through the +The following monitoring connectors will be installed when you install the **Cisco WLC SNMP** connector through the **Configuration > Connectors > Monitoring Connectors** menu: * [Base Pack](./base-generic.md) @@ -15,7 +15,7 @@ The following monitoring connectors will be installed when you install the **Cis ### Templates -The Monitoring Connector **Cisco WLC** brings 2 host templates: +The Monitoring Connector **Cisco WLC SNMP** brings 2 host templates: * **Net-Cisco-Wlc-SNMP-custom** * **Net-Cisco-Wlc-SNMP-Access-Point-custom** @@ -25,12 +25,12 @@ The connector brings the following service templates (sorted by the host templat -| Service Alias | Service Template | Service Description | Discovery | -|:-----------------|:-------------------------------------------|:---------------------------------------------|:----------:| -| Ap-Status-Global | Net-Cisco-Wlc-Ap-Status-Global-SNMP-custom | Check status of all access points | X | -| Cpu | Net-Cisco-Wlc-Cpu-SNMP-custom | Check CPU usage | | -| Hardware-Global | Net-Cisco-Wlc-Hardware-Global-SNMP-custom | Check all hardware | | -| Memory | Net-Cisco-Wlc-Memory-SNMP-custom | Check the rate of the utilization of memory | | +| Service Alias | Service Template | Service Description | Discovery | +|:-----------------|:-------------------------------------------|:--------------------------------------------------|:---------:| +| Ap-Status-Global | Net-Cisco-Wlc-Ap-Status-Global-SNMP-custom | Check status of all access points | X | +| Cpu | Net-Cisco-Wlc-Cpu-SNMP-custom | Check CPU usage | | +| Hardware-Global | Net-Cisco-Wlc-Hardware-Global-SNMP-custom | Check all hardware (power supplies) | | +| Memory | Net-Cisco-Wlc-Memory-SNMP-custom | Check the rate of the utilization of memory (RAM) | | > The services listed above are created automatically when the **Net-Cisco-Wlc-SNMP-custom** host template is used. @@ -50,15 +50,15 @@ The connector brings the following service templates (sorted by the host templat -| Service Alias | Service Template | Service Description | Discovery | -|:-------------------------------|:---------------------------------------------------------|:-------------------------------------------------|:----------:| -| Ap-Channel-Interference-Global | Net-Cisco-Wlc-Ap-Channel-Interference-Global-SNMP-custom | Check channel interferences of all access points | | -| Ap-Channel-Noise-Global | Net-Cisco-Wlc-Ap-Channel-Noise-Global-SNMP-custom | Check channel noises of all access points | | -| Ap-Users | Net-Cisco-Wlc-Ap-Users-SNMP-Access-Point-custom | Check access point total users | | -| Ap-Users | Net-Cisco-Wlc-Ap-Users-SNMP-custom | Check total users of all access points | | -| Traffic-Generic-Id | Net-Cisco-Wlc-Traffic-Generic-Id-SNMP-custom | Check traffic of an network interface | | -| Traffic-Generic-Name | Net-Cisco-Wlc-Traffic-Generic-Name-SNMP-custom | Check traffic of an network interface | | -| Traffic-Global | Net-Cisco-Wlc-Traffic-Global-SNMP-custom | Check traffic of multiple network interfaces | X | +| Service Alias | Service Template | Service Description | Discovery | +|:-------------------------------|:---------------------------------------------------------|:-------------------------------------------------|:---------:| +| Ap-Channel-Interference-Global | Net-Cisco-Wlc-Ap-Channel-Interference-Global-SNMP-custom | Check channel interferences of all access points | | +| Ap-Channel-Noise-Global | Net-Cisco-Wlc-Ap-Channel-Noise-Global-SNMP-custom | Check channel noises of all access points | | +| Ap-Users | Net-Cisco-Wlc-Ap-Users-SNMP-Access-Point-custom | Check access point total users | | +| Ap-Users | Net-Cisco-Wlc-Ap-Users-SNMP-custom | Check total users of all access points | | +| Traffic-Generic-Id | Net-Cisco-Wlc-Traffic-Generic-Id-SNMP-custom | Check traffic of an network interface | | +| Traffic-Generic-Name | Net-Cisco-Wlc-Traffic-Generic-Name-SNMP-custom | Check traffic of an network interface | | +| Traffic-Global | Net-Cisco-Wlc-Traffic-Global-SNMP-custom | Check traffic of multiple network interfaces | X | > The services listed above are not created automatically when a host template is applied. To use them, [create a service manually](/docs/monitoring/basic-objects/services), then apply the service template you want. @@ -71,9 +71,9 @@ The connector brings the following service templates (sorted by the host templat #### Host discovery -| Rule name | Description | -|:----------------|:----------------------------------------------------------| -| Cisco WLC | Discover Access Points from Cisco Wireless LAN Controller | +| Rule name | Description | +|:----------|:----------------------------------------------------------| +| Cisco WLC | Discover Access Points from Cisco Wireless LAN Controller | More information about discovering hosts automatically is available on the [dedicated page](/docs/monitoring/discovery/hosts-discovery). @@ -81,7 +81,7 @@ More information about discovering hosts automatically is available on the [dedi | Rule name | Description | |:--------------------------------|:--------------------------------------------------------------| -| Net-Cisco-Wlc-SNMP-AP-Name | Discover access points and moniteur status | +| Net-Cisco-Wlc-SNMP-AP-Name | Discover access points and moniteur status | | Net-Cisco-Wlc-SNMP-Traffic-Name | Discover network interfaces and monitor bandwidth utilization | More information about discovering services automatically is available on the [dedicated page](/docs/monitoring/discovery/services-discovery) @@ -104,9 +104,9 @@ Here is the list of services for this connector, detailing all metrics and statu -| Name | Unit | -|:--------------------------------------------|:------| -| *ap*~*channels*#accesspoint.noise.power.dbm | dBm | +| Name | Unit | +|:--------------------------------------------|:-----| +| *ap*~*channels*#accesspoint.noise.power.dbm | dBm | > To obtain this new metric format, include **--use-new-perfdata** in the **EXTRAOPTIONS** service macro. @@ -162,46 +162,45 @@ Here is the list of services for this connector, detailing all metrics and statu | *ssid*#ssid.users.total.count | users | | *ap*#accesspoint.users.total.count | users | -> Applies to the following service templates: Ap-Users (Net-Cisco-Wlc-Ap-Users-SNMP-custom) et Ap-Users (Net-Cisco-Wlc-Ap-Users-SNMP-Access-Point-custom). +> Applies to the following service templates: Ap-Users, Ap-Users > To obtain this new metric format, include **--use-new-perfdata** in the **EXTRAOPTIONS** service macro. -| Name | Unit | -|:---------------------------|:------| -| cpu.utilization.percentage | % | +| Name | Unit | +|:---------------------------|:-----| +| cpu.utilization.percentage | % | -| Metric name | Unit | -|:--------------------|:-----| -| power supply status | N/A | +| Name | Unit | +|:-------------------|:------| +| hardware.psu.count | count | +| psu status | N/A | -| Name | Unit | -|:------------------------|:------| -| memory.usage.bytes | B | -| memory.free.bytes | B | -| memory.usage.percentage | % | +| Name | Unit | +|:------------------------|:-----| +| memory.usage.bytes | B | +| memory.free.bytes | B | +| memory.usage.percentage | % | -| Name | Unit | -|:-----------------------------------------------------|:------| -| status | N/A | -| *interface_name*#interface.traffic.in.bitspersecond | b/s | -| *interface_name*#interface.traffic.out.bitspersecond | b/s | +| Name | Unit | +|:-----------------------------------------------------|:-----| +| status | N/A | +| *interface_name*#interface.traffic.in.bitspersecond | b/s | +| *interface_name*#interface.traffic.out.bitspersecond | b/s | > Applies to the following service templates: Traffic-Generic-Id, Traffic-Generic-Name, Traffic-Global -> To obtain this new metric format, include **--use-new-perfdata** in the **EXTRAOPTIONS** service macro. - @@ -223,8 +222,7 @@ SNMP port. ### Pack - The installation procedures for monitoring connectors are slightly different depending on [whether your license is offline or online](../getting-started/how-to-guides/connectors-licenses.md). - +The installation procedures for monitoring connectors are slightly different depending on [whether your license is offline or online](../getting-started/how-to-guides/connectors-licenses.md). 1. 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 @@ -263,7 +261,7 @@ yum install centreon-pack-network-cisco-wlc-snmp -2. Whatever the license type (*online* or *offline*), install the **Cisco WLC** connector through +2. Whatever the license type (*online* or *offline*), install the **Cisco WLC SNMP** connector through the **Configuration > Connectors > Monitoring Connectors** menu. ### Plugin @@ -319,14 +317,16 @@ yum install centreon-plugin-Network-Cisco-Wlc-Snmp 1. Log into Centreon and add a new host through **Configuration > Hosts**. 2. Fill in the **Name**, **Alias** & **IP Address/DNS** fields according to your resource's settings. -3. Apply the **Net-Cisco-Wlc-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](../getting-started/how-to-guides/troubleshooting-plugins.md#snmpv3-options-mapping) section. +3. Apply the **Net-Cisco-Wlc-SNMP-custom** template to the host. -| 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](#available-options). | | | +| Macro | Description | Default value | Mandatory | +|:------------------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------|:--------------|:---------:| +| SNMP_V3_USERNAME | SNMP v3 only: User name (`securityName`) | | | +| SNMP_V3_AUTH_PROTOCOL | SNMP v3 only: Authentication protocol: MD5\|SHA. Since net-snmp 5.9.1: SHA224\|SHA256\|SHA384\|SHA512 | | | +| SNMP_V3_PRIV_PROTOCOL | 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 | | | +| SNMP_V3_AUTH_PASSPHRASE | SNMP v3 only: Pass phrase hashed using the authentication protocol defined in the --authprotocol option | | | +| SNMP_V3_PRIV_PASSPHRASE | SNMP v3 only: Privacy pass phrase (`privPassword`) to encrypt messages using the protocol defined in the --privprotocol option | | | +| SNMPEXTRAOPTIONS | Any extra option you may want to add to every command (a --verbose flag for example). All options are listed [here](#available-options). | | | 4. [Deploy the configuration](/docs/monitoring/monitoring-servers/deploying-a-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. @@ -335,18 +335,20 @@ yum install centreon-plugin-Network-Cisco-Wlc-Snmp 1. Log into Centreon and add a new host through **Configuration > Hosts**. 2. Fill in the **Name**, **Alias** & **IP Address/DNS** fields according to your resource's settings. -3. Apply the **Net-Cisco-Wlc-SNMP-Access-Point-custom** template to the host. - -> When using SNMP v3, use the **SNMPEXTRAOPTIONS** macro to add specific authentication parameters. -> More information in the [Troubleshooting SNMP](../getting-started/how-to-guides/troubleshooting-plugins.md#snmpv3-options-mapping) section. - -| Macro | Description | Default value | Mandatory | -|:--------------------|:-----------------------------------------------------------------------------------------------------|:------------------|:-----------:| -| WLCHOSTNAME | Name or address of the host to monitor (mandatory) | | | -| APNAME | Filter access point name (can be a regexp) | | | -| WLCSNMPCOMMUNITY | SNMP community (default value: public). It is recommended to use a read-only community | | | -| WLCSNMPVERSION | Version of the SNMP protocol. 1 for SNMP v1 (default), 2 for SNMP v2c, 3 for SNMP v3 | | | -| WLCSNMPEXTRAOPTIONS | Any extra option you may want to add to every command (a --verbose flag for example). All options are listed [here](#available-options). | | | +3. Apply the **Net-Cisco-Wlc-SNMP-Access-Point-custom** template to the host. + +| Macro | Description | Default value | Mandatory | +|:------------------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------|:--------------|:---------:| +| WLCHOSTNAME | Name or address of the host to monitor (mandatory) | | | +| SNMP_V3_USERNAME | SNMP v3 only: User name (`securityName`) | | | +| SNMP_V3_AUTH_PROTOCOL | SNMP v3 only: Authentication protocol: MD5\|SHA. Since net-snmp 5.9.1: SHA224\|SHA256\|SHA384\|SHA512 | | | +| SNMP_V3_PRIV_PROTOCOL | 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 | | | +| APNAME | Filter access point name (can be a regexp) | | | +| SNMP_V3_AUTH_PASSPHRASE | SNMP v3 only: Pass phrase hashed using the authentication protocol defined in the --authprotocol option | | | +| SNMP_V3_PRIV_PASSPHRASE | SNMP v3 only: Privacy pass phrase (`privPassword`) to encrypt messages using the protocol defined in the --privprotocol option | | | +| WLCSNMPCOMMUNITY | SNMP community (default value: public). It is recommended to use a read-only community | | | +| WLCSNMPVERSION | Version of the SNMP protocol. 1 for SNMP v1 (default), 2 for SNMP v2c, 3 for SNMP v3 | | | +| WLCSNMPEXTRAOPTIONS | Any extra option you may want to add to every command (a --verbose flag for example). All options are listed [here](#available-options). | | | 4. [Deploy the configuration](/docs/monitoring/monitoring-servers/deploying-a-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. @@ -361,138 +363,138 @@ yum install centreon-plugin-Network-Cisco-Wlc-Snmp -| Macro | Description | Default value | Mandatory | -|:--------------------------|:---------------------------------------------------------------------------------------------------|:------------------|:-----------:| -| FILTER | Filter access point name (can be a regexp) | .* | | -| FILTERGROUP | Filter access point group (can be a regexp) | | | -| WARNINGINTERFERENCEPOWER | Threshold | | | -| CRITICALINTERFERENCEPOWER | Threshold | | | -| WARNINGINTERFERENCEUTIL | Threshold | | | -| CRITICALINTERFERENCEUTIL | Threshold | | | -| EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). All options are listed [here](#available-options). | --verbose | | +| Macro | Description | Default value | Mandatory | +|:--------------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------|:--------------|:---------:| +| FILTER | Filter access point name (can be a regexp) | .* | | +| FILTERGROUP | Filter access point group (can be a regexp) | | | +| WARNINGINTERFERENCEPOWER | Threshold | | | +| CRITICALINTERFERENCEPOWER | Threshold | | | +| WARNINGINTERFERENCEUTIL | Threshold | | | +| CRITICALINTERFERENCEUTIL | Threshold | | | +| EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). All options are listed [here](#available-options). | --verbose | | -| Macro | Description | Default value | Mandatory | -|:-------------------|:---------------------------------------------------------------------------------------------------|:------------------|:-----------:| -| FILTER | Filter access point name (can be a regexp) | .* | | -| FILTERGROUP | Filter access point group (can be a regexp) | | | -| WARNINGNOISEPOWER | Threshold | | | -| CRITICALNOISEPOWER | Threshold | | | -| EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). All options are listed [here](#available-options). | --verbose | | +| Macro | Description | Default value | Mandatory | +|:-------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------|:--------------|:---------:| +| FILTER | Filter access point name (can be a regexp) | .* | | +| FILTERGROUP | Filter access point group (can be a regexp) | | | +| WARNINGNOISEPOWER | Threshold | | | +| CRITICALNOISEPOWER | Threshold | | | +| EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). All options are listed [here](#available-options). | --verbose | | -| Macro | Description | Default value | Mandatory | -|:---------------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:----------------------------------------------------------------------|:-----------:| -| CRITICALSTATUS | Define the conditions to match for the status to be CRITICAL (default: '%\{admstatus\} eq "enable" and %\{opstatus\} !~ /associated\|downloading/'). You can use the following variables: %\{admstatus\}, %\{opstatus\}, %\{display\} | %\{admstatus\} eq "enable" and %\{opstatus\} !~ /associated\|downloading/ | | -| WARNINGSTATUS | Define the conditions to match for the status to be WARNING. You can use the following variables: %\{admstatus\}, %\{opstatus\}, %\{display\} | | | -| EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). All options are listed [here](#available-options). | --verbose | | +| Macro | Description | Default value | Mandatory | +|:---------------|:-------------------------------------------------------------------------------------------------------------------------------------------------|:--------------------------------------------------------------------------|:---------:| +| CRITICALSTATUS | Define the conditions to match for the status to be CRITICAL. You can use the following variables: %\{admstatus\}, %\{opstatus\}, %\{display\} | %\{admstatus\} eq "enable" and %\{opstatus\} !~ /associated\|downloading/ | | +| WARNINGSTATUS | Define the conditions to match for the status to be WARNING. You can use the following variables: %\{admstatus\}, %\{opstatus\}, %\{display\} | | | +| EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). All options are listed [here](#available-options). | --verbose | | -| Macro | Description | Default value | Mandatory | -|:------------------------------------------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:----------------------------------------------------------------------|:-----------:| -| FILTER | Filter access point name (can be a regexp) | | | -| FILTERGROUP | Filter access point group (can be a regexp) | | | -| WARNINGRADIOINTERFACECHANNELSUTILIZATION | Threshold | | | -| CRITICALRADIOINTERFACECHANNELSUTILIZATION | Threshold | | | -| CRITICALRADIOSTATUS | Define the conditions to match for the status to be CRITICAL (default: '%\{admstatus\} eq "enable" and %\{opstatus\} eq "down"'). You can use the following variables: %\{admstatus\}, %\{opstatus\}, %\{display\} | %\{admstatus\} eq "enable" and %\{opstatus\} eq "down" | | -| WARNINGRADIOSTATUS | Define the conditions to match for the status to be WARNING. You can use the following variables: %\{admstatus\}, %\{opstatus\}, %\{display\} | | | -| CRITICALSTATUS | Define the conditions to match for the status to be CRITICAL (default: '%\{admstatus\} eq "enable" and %\{opstatus\} !~ /associated\|downloading/'). You can use the following variables: %\{admstatus\}, %\{opstatus\}, %\{display\} | %\{admstatus\} eq "enable" and %\{opstatus\} !~ /associated\|downloading/ | | -| WARNINGSTATUS | Define the conditions to match for the status to be WARNING. You can use the following variables: %\{admstatus\}, %\{opstatus\}, %\{display\} | | | -| WARNINGTOTAL | Threshold | | | -| CRITICALTOTAL | Threshold | | | -| WARNINGTOTALASSOCIATED | Threshold | | | -| CRITICALTOTALASSOCIATED | Threshold | | | -| WARNINGTOTALDISABLED | Threshold | | | -| CRITICALTOTALDISABLED | Threshold | | | -| WARNINGTOTALDISASSOCIATING | Threshold | | | -| CRITICALTOTALDISASSOCIATING | Threshold | | | -| WARNINGTOTALENABLED | Threshold | | | -| CRITICALTOTALENABLED | Threshold | | | -| EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). All options are listed [here](#available-options). | --verbose | | +| Macro | Description | Default value | Mandatory | +|:------------------------------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------|:--------------------------------------------------------------------------|:---------:| +| FILTER | Filter access point name (can be a regexp) | | | +| FILTERGROUP | Filter access point group (can be a regexp) | | | +| WARNINGRADIOINTERFACECHANNELSUTILIZATION | Threshold | | | +| CRITICALRADIOINTERFACECHANNELSUTILIZATION | Threshold | | | +| CRITICALRADIOSTATUS | Define the conditions to match for the status to be CRITICAL. You can use the following variables: %\{admstatus\}, %\{opstatus\}, %\{display\} | %\{admstatus\} eq "enable" and %\{opstatus\} eq "down" | | +| WARNINGRADIOSTATUS | Define the conditions to match for the status to be WARNING. You can use the following variables: %\{admstatus\}, %\{opstatus\}, %\{display\} | | | +| CRITICALSTATUS | Define the conditions to match for the status to be CRITICAL. You can use the following variables: %\{admstatus\}, %\{opstatus\}, %\{display\} | %\{admstatus\} eq "enable" and %\{opstatus\} !~ /associated\|downloading/ | | +| WARNINGSTATUS | Define the conditions to match for the status to be WARNING. You can use the following variables: %\{admstatus\}, %\{opstatus\}, %\{display\} | | | +| WARNINGTOTAL | Threshold | | | +| CRITICALTOTAL | Threshold | | | +| WARNINGTOTALASSOCIATED | Threshold | | | +| CRITICALTOTALASSOCIATED | Threshold | | | +| WARNINGTOTALDISABLED | Threshold | | | +| CRITICALTOTALDISABLED | Threshold | | | +| WARNINGTOTALDISASSOCIATING | Threshold | | | +| CRITICALTOTALDISASSOCIATING | Threshold | | | +| WARNINGTOTALENABLED | Threshold | | | +| CRITICALTOTALENABLED | Threshold | | | +| EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). All options are listed [here](#available-options). | --verbose | | -| Macro | Description | Default value | Mandatory | -|:--------------|:---------------------------------------------------------------------------------------------------|:------------------|:-----------:| -| FILTERGROUP | Filter by access point group (can be a regexp) | | | -| WARNINGTOTAL | Threshold | | | -| CRITICALTOTAL | Threshold | | | -| EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). All options are listed [here](#available-options). | --verbose | | +| Macro | Description | Default value | Mandatory | +|:--------------|:-------------------------------------------------------------------------------------------------------------------------------------------------|:--------------|:---------:| +| FILTERGROUP | Filter by access point group (can be a regexp) | | | +| WARNINGTOTAL | Threshold | | | +| CRITICALTOTAL | Threshold | | | +| EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). All options are listed [here](#available-options). | --verbose | | -| Macro | Description | Default value | Mandatory | -|:-------------|:---------------------------------------------------------------------------------------------------|:------------------|:-----------:| -| WARNING | Warning threshold in percent | | | -| CRITICAL | Critical threshold in percent | | | -| EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). All options are listed [here](#available-options). | | | +| Macro | Description | Default value | Mandatory | +|:-------------|:-------------------------------------------------------------------------------------------------------------------------------------------------|:--------------|:---------:| +| WARNING | Warning threshold in percent | | | +| CRITICAL | Critical threshold in percent | | | +| EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). All options are listed [here](#available-options). | | | -| Macro | Description | Default value | Mandatory | -|:-------------|:---------------------------------------------------------------------------------------------------|:------------------|:-----------:| -| COMPONENT | Which component to check (default: '.*'). Can be: 'psu' | .* | | -| EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). All options are listed [here](#available-options). | --verbose | | +| Macro | Description | Default value | Mandatory | +|:-------------|:-------------------------------------------------------------------------------------------------------------------------------------------------|:--------------|:---------:| +| COMPONENT | Which component to check. Can be: 'psu' | .* | | +| EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). All options are listed [here](#available-options). | --verbose | | -| Macro | Description | Default value | Mandatory | -|:------------------|:---------------------------------------------------------------------------------------------------|:------------------|:-----------:| -| WARNING | Threshold | | | -| CRITICAL | Threshold | | | -| WARNINGUSAGEFREE | Threshold | | | -| CRITICALUSAGEFREE | Threshold | | | -| WARNINGUSAGEPRCT | Threshold | | | -| CRITICALUSAGEPRCT | Threshold | | | -| EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). All options are listed [here](#available-options). | | | +| Macro | Description | Default value | Mandatory | +|:------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------|:--------------|:---------:| +| WARNING | Threshold | | | +| CRITICAL | Threshold | | | +| WARNINGUSAGEFREE | Threshold | | | +| CRITICALUSAGEFREE | Threshold | | | +| WARNINGUSAGEPRCT | Threshold | | | +| CRITICALUSAGEPRCT | Threshold | | | +| EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). All options are listed [here](#available-options). | | | -| Macro | Description | Default value | Mandatory | -|:-------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------|:------------------|:-----------:| -| INTERFACEID | Define the interface filter on IDs (OID indexes, e.g.: 1,2,...). If empty, all interfaces will be monitored. To filter on interface names, see --name | | | -| WARNINGIN | Threshold | 80 | | -| CRITICALIN | Threshold | 90 | | -| WARNINGOUT | Threshold | 80 | | -| CRITICALOUT | Threshold | 90 | | -| EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). All options are listed [here](#available-options). | | | +| Macro | Description | Default value | Mandatory | +|:-------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------|:--------------|:---------:| +| INTERFACEID | Check only the interfaces with the specified IDs (OID indexes, e.g.: 1,2,...). If empty, all interfaces will be monitored. To filter on interface names, see --name | | | +| WARNINGIN | Thresholds | 80 | | +| CRITICALIN | Thresholds | 90 | | +| WARNINGOUT | Thresholds | 80 | | +| CRITICALOUT | Thresholds | 90 | | +| EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). All options are listed [here](#available-options). | | | -| Macro | Description | Default value | Mandatory | -|:--------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------|:------------------|:-----------:| -| INTERFACENAME | Define the interface filter on IDs (OID indexes, e.g.: 1,2,...). If empty, all interfaces will be monitored. To filter on interface names, see --name | | | -| WARNINGIN | Threshold | 80 | | -| CRITICALIN | Threshold | 90 | | -| WARNINGOUT | Threshold | 80 | | -| CRITICALOUT | Threshold | 90 | | -| EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). All options are listed [here](#available-options). | | | +| Macro | Description | Default value | Mandatory | +|:--------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------|:--------------|:---------:| +| INTERFACENAME | Check only the interfaces with the specified IDs (OID indexes, e.g.: 1,2,...). If empty, all interfaces will be monitored. To filter on interface names, see --name | | | +| WARNINGIN | Thresholds | 80 | | +| CRITICALIN | Thresholds | 90 | | +| WARNINGOUT | Thresholds | 80 | | +| CRITICALOUT | Thresholds | 90 | | +| EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). All options are listed [here](#available-options). | | | -| Macro | Description | Default value | Mandatory | -|:---------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:---------------------------------------------|:-----------:| -| FILTER | Define the interface filter on IDs (OID indexes, e.g.: 1,2,...). If empty, all interfaces will be monitored. To filter on interface names, see --name | .* | | -| WARNINGIN | Threshold | 80 | | -| CRITICALIN | Threshold | 90 | | -| WARNINGOUT | Threshold | 80 | | -| CRITICALOUT | Threshold | 90 | | -| CRITICALSTATUS | Define the conditions to match for the status to be CRITICAL (default: '%\{admstatus\} eq "up" and %\{opstatus\} ne "up"'). You can use the following variables: %\{admstatus\}, %\{opstatus\}, %\{duplexstatus\}, %\{display\} | %\{admstatus\} eq "up" and %\{opstatus\} ne "up" | | -| WARNINGSTATUS | Define the conditions to match for the status to be WARNING. You can use the following variables: %\{admstatus\}, %\{opstatus\}, %\{duplexstatus\}, %\{display\} | | | -| EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). All options are listed [here](#available-options). | --verbose | | +| Macro | Description | Default value | Mandatory | +|:---------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------|:-------------------------------------------------|:---------:| +| FILTER | Check only the interfaces with the specified IDs (OID indexes, e.g.: 1,2,...). If empty, all interfaces will be monitored. To filter on interface names, see --name | .* | | +| WARNINGIN | Thresholds | 80 | | +| CRITICALIN | Thresholds | 90 | | +| WARNINGOUT | Thresholds | 80 | | +| CRITICALOUT | Thresholds | 90 | | +| CRITICALSTATUS | Define the conditions to match for the status to be CRITICAL. You can use the following variables: %\{admstatus\}, %\{opstatus\}, %\{duplexstatus\}, %\{display\} | %\{admstatus\} eq "up" and %\{opstatus\} ne "up" | | +| WARNINGSTATUS | Define the conditions to match for the status to be WARNING. You can use the following variables: %\{admstatus\}, %\{opstatus\}, %\{duplexstatus\}, %\{display\} | | | +| EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). All options are listed [here](#available-options). | --verbose | | @@ -508,29 +510,32 @@ is able to monitor a resource using a command like this one (replace the sample ```bash /usr/lib/centreon/plugins/centreon_cisco_wlc.pl \ --plugin=network::cisco::wlc::snmp::plugin \ - --mode=ap-status \ + --mode=interfaces \ --hostname=10.0.0.1 \ --snmp-version='2c' \ - --snmp-community='my-snmp-community' \ - --filter-name='ap-1200d-emb' \ - --use-new-perfdata \ - --add-radio-interfaces \ + --snmp-community='my-snmp-community' \ + --snmp-username='username' \ + --authpassphrase='' \ + --authprotocol='' \ + --privpassphrase='' \ + --privprotocol='' \ + --interface='.*' \ + --name \ + --add-status \ + --add-traffic \ + --warning-status='' \ + --critical-status='%\{admstatus\} eq "up" and %\{opstatus\} ne "up"' \ + --warning-in-traffic='80' \ + --critical-in-traffic='90' \ + --warning-out-traffic='80' \ + --critical-out-traffic='90' \ --verbose ``` The expected command output is shown below: ```bash -OK: Access points total: 2, associated: 2, disassociating: 0, enabled: 2, disabled: 0 - All access points are ok | 'accesspoints.total.count'=2;;;0; 'accesspoints.associated.count'=2;;;0; 'accesspoints.disassociating.count'=0;;;0; 'accesspoints.downloading.count'=0;;;0; 'accesspoints.enabled.count'=2;;;0; 'accesspoints.disabled.count'=0;;;0; 'ap-1200d-emb-2~0#accesspoint.radio.interface.channels.utilization.percentage'=54%;;;0;100 'ap-1200d-emb-4~0#accesspoint.radio.interface.channels.utilization.percentage'=36%;;;0;100 -Model: AIR-CT5508-K9 -checking access point 'ap-1200d-emb-2' - status: associated - radio interface '0' status: up, channels utilization: 54 % - radio interface '1' is disabled -checking access point 'ap-1200d-emb-4' - status: associated - radio interface '0' status: up, channels utilization: 36 % - radio interface '1' is disabled +OK: All interfaces are ok | 'interface_name1#interface.traffic.in.bitspersecond'=51920b/s;80;90;; 'interface_name2#interface.traffic.in.bitspersecond'=36127b/s;80;90;; 'interface_name1#interface.traffic.out.bitspersecond'=17785b/s;80;90;; 'interface_name2#interface.traffic.out.bitspersecond'=10288b/s;80;90;; ``` ### Troubleshooting @@ -581,65 +586,67 @@ The plugin brings the following modes: 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 ok, 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\[,\[newuom\],\[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\[,\[newuom\],\[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\[,\[newuom\],\[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,namesofnewmetrics,calculation\[,\[newuom\],\[min\],\[max\]\] regex: regular expression namesofnewmetrics: 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 newuom (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~replacement~modifier Most commonly used modifiers are i (case insensitive) and g (replace all occurrences). Example: adding --change-short-output='OK\~Up\~gi' will replace all occurrences of 'OK', 'ok', 'Ok' or 'oK' with 'Up' | -| --change-short-output | Modify the short/long output that is returned by the plugin. Syntax: --change-short-output=pattern~replacement~modifier Most commonly used modifiers are i (case insensitive) and g (replace all occurrences). Example: adding --change-short-output='OK\~Up\~gi' will replace all occurrences of 'OK', 'ok', 'Ok' or 'oK' with 'Up' | -| --change-long-output | Modify the short/long output that is returned by the plugin. Syntax: --change-short-output=pattern~replacement~modifier Most commonly used modifiers are i (case insensitive) and g (replace all occurrences). Example: adding --change-short-output='OK\~Up\~gi' will replace all occurrences of 'OK', 'ok', 'Ok' or 'oK' with 'Up' | -| --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. | -| --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). E.g.: --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\. =cut | +| 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 get-next 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 ok, 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. | +| --show-password | By default, sensitive information in command lines is hidden in debug output and replaced with `***` (however, debug logs may still display sensitive information). Using the C option will display the passwords in plain text. | +| --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\[,\[\\],\[min\],\[max\]\] Common examples: onvert 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\[,\[\\],\[min\],\[max\]\] Common examples: onvert 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\[,\[\\],\[min\],\[max\]\] Common examples: onvert 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,\,calculation\[,\[\\],\[min\],\[max\]\] regex: regular expression \: 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 \ (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: um 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~replacement~modifier Most commonly used modifiers are i (case insensitive) and g (replace all occurrences). Example: adding --change-short-output='OK~Up~gi' will replace all occurrences of 'OK', 'ok', 'Ok' or 'oK' with 'Up' | +| --change-short-output | Modify the short/long output that is returned by the plugin. Syntax: --change-short-output=pattern~replacement~modifier Most commonly used modifiers are i (case insensitive) and g (replace all occurrences). Example: adding --change-short-output='OK~Up~gi' will replace all occurrences of 'OK', 'ok', 'Ok' or 'oK' with 'Up' | +| --change-long-output | Modify the short/long output that is returned by the plugin. Syntax: --change-short-output=pattern~replacement~modifier Most commonly used modifiers are i (case insensitive) and g (replace all occurrences). Example: adding --change-short-output='OK~Up~gi' will replace all occurrences of 'OK', 'ok', 'Ok' or 'oK' with 'Up' | +| --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'. \. | #### Modes options @@ -648,148 +655,200 @@ All available options for each service template are listed below: -| Option | Description | -|:-------------------------|:----------------------------------------------------------------------------------------------------| -| --filter-counters | Only display some counters (regexp can be used). Example: --filter-counters='interference-util' | -| --filter-name | Filter access point name (can be a regexp). | -| --filter-group | Filter access point group (can be a regexp). | -| --filter-channel | Filter channel (can be a regexp). Example: --filter-channel='slot0:channel3' | -| --warning-* --critical-* | Thresholds. Can be: 'interference-power', 'interference-util' (%). | +| Option | Description | +|:-------------------------|:------------------------------------------------------------------------------------------------| +| --filter-counters | Only display some counters (regexp can be used). Example: --filter-counters='interference-util' | +| --warning-xxx | Warning threshold. | +| --critical-xxx | Critical threshold. | +| --filter-name | Filter access point name (can be a regexp). | +| --filter-group | Filter access point group (can be a regexp). | +| --filter-channel | Filter channel (can be a regexp). Example: --filter-channel='slot0:channel3' | +| --warning-* --critical-* | Thresholds. Can be: 'interference-power', 'interference-util' (%). | -| Option | Description | -|:-------------------------|:------------------------------------------------------------------------------------------------------------------------------| -| --filter-counters | Only display some counters (regexp can be used). Example to check SSL connections only : --filter-counters='^xxxx\|yyyy$' | -| --filter-name | Filter access point name (can be a regexp). | -| --filter-group | Filter access point group (can be a regexp). | -| --filter-channel | Filter channel (can be a regexp). Example: --filter-channel='slot0:channel3' | -| --warning-* --critical-* | Thresholds. Can be: 'noise-power' (dBm). | +| Option | Description | +|:-------------------------|:--------------------------------------------------------------------------------------------------------------------------| +| --filter-counters | Only display some counters (regexp can be used). Example to check SSL connections only : --filter-counters='^xxxx\|yyyy$' | +| --warning-xxx | Warning threshold. | +| --critical-xxx | Critical threshold. | +| --filter-name | Filter access point name (can be a regexp). | +| --filter-group | Filter access point group (can be a regexp). | +| --filter-channel | Filter channel (can be a regexp). Example: --filter-channel='slot0:channel3' | +| --warning-* --critical-* | Thresholds. Can be: 'noise-power' (dBm). | -| Option | Description | -|:-------------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| --filter-counters | Only display some counters (regexp can be used). Example: --filter-counters='^total-disassociating\|total-associated$' | -| --filter-name | Filter access point name (can be a regexp). | -| --filter-group | Filter access point group (can be a regexp). | -| --add-radio-interfaces | Monitor radio interfaces channels utilization. | -| --warning-status | Define the conditions to match for the status to be WARNING. You can use the following variables: %\{admstatus\}, %\{opstatus\}, %\{display\} | -| --critical-status | Define the conditions to match for the status to be CRITICAL (default: '%\{admstatus\} eq "enable" and %\{opstatus\} !~ /associated\|downloading/'). You can use the following variables: %\{admstatus\}, %\{opstatus\}, %\{display\} | -| --warning-radio-status | Define the conditions to match for the status to be WARNING. You can use the following variables: %\{admstatus\}, %\{opstatus\}, %\{display\} | -| --critical-radio-status | Define the conditions to match for the status to be CRITICAL (default: '%\{admstatus\} eq "enable" and %\{opstatus\} eq "down"'). You can use the following variables: %\{admstatus\}, %\{opstatus\}, %\{display\} | -| --warning-* --critical-* | Thresholds. Can be: 'total', 'total-associated', 'total-disassociating', 'total-downloading', 'total-enabled', 'total-disabled', 'radio-interface-channels-utilization' (%). | +| Option | Description | +|:-------------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| --filter-counters | Only display some counters (regexp can be used). Example: --filter-counters='^total-disassociating\|total-associated$' | +| --warning-xxx | Warning threshold. | +| --critical-xxx | Critical threshold. | +| --filter-name | Filter access point name (can be a regexp). | +| --filter-group | Filter access point group (can be a regexp). | +| --add-radio-interfaces | Monitor radio interfaces channels utilization. | +| --warning-status | Define the conditions to match for the status to be WARNING. You can use the following variables: %\{admstatus\}, %\{opstatus\}, %\{display\} | +| --critical-status | Define the conditions to match for the status to be CRITICAL (default: '%\{admstatus\} eq "enable" and %\{opstatus\} !~ /associated\|downloading/'). You can use the following variables: %\{admstatus\}, %\{opstatus\}, %\{display\} | +| --warning-radio-status | Define the conditions to match for the status to be WARNING. You can use the following variables: %\{admstatus\}, %\{opstatus\}, %\{display\} | +| --critical-radio-status | Define the conditions to match for the status to be CRITICAL (default: '%\{admstatus\} eq "enable" and %\{opstatus\} eq "down"'). You can use the following variables: %\{admstatus\}, %\{opstatus\}, %\{display\} | +| --warning-* --critical-* | Thresholds. Can be: 'total', 'total-associated', 'total-disassociating', 'total-downloading', 'total-enabled', 'total-disabled', 'radio-interface-channels-utilization' (%). | -| Option | Description | -|:-------------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| --filter-counters | Only display some counters (regexp can be used). Example: --filter-counters='^total-disassociating\|total-associated$' | -| --filter-name | Filter access point name (can be a regexp). | -| --filter-group | Filter access point group (can be a regexp). | -| --add-radio-interfaces | Monitor radio interfaces channels utilization. | -| --warning-status | Define the conditions to match for the status to be WARNING. You can use the following variables: %\{admstatus\}, %\{opstatus\}, %\{display\} | -| --critical-status | Define the conditions to match for the status to be CRITICAL (default: '%\{admstatus\} eq "enable" and %\{opstatus\} !~ /associated\|downloading/'). You can use the following variables: %\{admstatus\}, %\{opstatus\}, %\{display\} | -| --warning-radio-status | Define the conditions to match for the status to be WARNING. You can use the following variables: %\{admstatus\}, %\{opstatus\}, %\{display\} | -| --critical-radio-status | Define the conditions to match for the status to be CRITICAL (default: '%\{admstatus\} eq "enable" and %\{opstatus\} eq "down"'). You can use the following variables: %\{admstatus\}, %\{opstatus\}, %\{display\} | -| --warning-* --critical-* | Thresholds. Can be: 'total', 'total-associated', 'total-disassociating', 'total-downloading', 'total-enabled', 'total-disabled', 'radio-interface-channels-utilization' (%). | +| Option | Description | +|:-------------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| --filter-counters | Only display some counters (regexp can be used). Example: --filter-counters='^total-disassociating\|total-associated$' | +| --warning-xxx | Warning threshold. | +| --critical-xxx | Critical threshold. | +| --filter-name | Filter access point name (can be a regexp). | +| --filter-group | Filter access point group (can be a regexp). | +| --add-radio-interfaces | Monitor radio interfaces channels utilization. | +| --warning-status | Define the conditions to match for the status to be WARNING. You can use the following variables: %\{admstatus\}, %\{opstatus\}, %\{display\} | +| --critical-status | Define the conditions to match for the status to be CRITICAL (default: '%\{admstatus\} eq "enable" and %\{opstatus\} !~ /associated\|downloading/'). You can use the following variables: %\{admstatus\}, %\{opstatus\}, %\{display\} | +| --warning-radio-status | Define the conditions to match for the status to be WARNING. You can use the following variables: %\{admstatus\}, %\{opstatus\}, %\{display\} | +| --critical-radio-status | Define the conditions to match for the status to be CRITICAL (default: '%\{admstatus\} eq "enable" and %\{opstatus\} eq "down"'). You can use the following variables: %\{admstatus\}, %\{opstatus\}, %\{display\} | +| --warning-* --critical-* | Thresholds. Can be: 'total', 'total-associated', 'total-disassociating', 'total-downloading', 'total-enabled', 'total-disabled', 'radio-interface-channels-utilization' (%). | -| Option | Description | -|:-------------------------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| --filter-counters | Only display some counters (regexp can be used). Example: --filter-counters='^total\|total-idle$' | -| --filter-ssid | Filter by SSID (can be a regexp). | -| --filter-ap | Filter by access point name (can be a regexp). | -| --filter-group | Filter by access point group (can be a regexp). | -| --ignore-ap-users | Unmonitor users by access points. | -| --warning-* --critical-* | Thresholds. Can be: 'total', 'total-idle', 'total-aaapending', 'total-authenticated', 'total-associated', 'total-powersave', 'total-disassociated', 'total-tobedeleted', 'total-probing', 'total-blacklisted', 'ssid', 'ap'. | +| Option | Description | +|:-------------------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| --filter-counters | Only display some counters (regexp can be used). Example: --filter-counters='^total\|total-idle$' | +| --warning-xxx | Warning threshold. | +| --critical-xxx | Critical threshold. | +| --filter-ssid | Filter by SSID (can be a regexp). | +| --filter-ap | Filter by access point name (can be a regexp). | +| --filter-group | Filter by access point group (can be a regexp). | +| --ignore-ap-users | Unmonitor users by access points. | +| --warning-* --critical-* | Thresholds. Can be: 'total', 'total-idle', 'total-aaapending', 'total-authenticated', 'total-associated', 'total-powersave', 'total-disassociated', 'total-tobedeleted', 'total-probing', 'total-blacklisted', 'ssid', 'ap'. | -| Option | Description | -|:---------------------------|:------------------------------------------------------------------------------------------------------------------------------| -| --filter-counters | Only display some counters (regexp can be used). Example to check SSL connections only : --filter-counters='^xxxx\|yyyy$' | -| --warning-cpu-utilization | Warning threshold in percent. | -| --critical-cpu-utilization | Critical threshold in percent. | +| Option | Description | +|:---------------------------|:--------------------------------------------------------------------------------------------------------------------------| +| --filter-counters | Only display some counters (regexp can be used). Example to check SSL connections only : --filter-counters='^xxxx\|yyyy$' | +| --warning-xxx | Warning threshold. | +| --critical-xxx | Critical threshold. | +| --warning-cpu-utilization | Warning threshold in percent. | +| --critical-cpu-utilization | Critical threshold in percent. | -| Option | Description | -|:---------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| --component | Which component to check (default: '.*'). Can be: 'psu'. | -| --filter | Exclude the items given as a comma-separated list (example: --filter=psu). You can also exclude items from specific instances: --filter=psu,1 | -| --absent-problem | Return an error if an entity is not 'present' (default is skipping) (comma separated list) Can be specific or global: --absent-problem=psu,1 | -| --no-component | Define the expected status if no components are found (default: critical). | -| --threshold-overload | Use this option to override the status returned by the plugin when the status label matches a regular expression (syntax: section,\[instance,\]status,regexp). Example: --threshold-overload='psu,WARNING,not operational' | -| --warning | Define the warning threshold for temperatures (syntax: type,instance,threshold) Example: --warning='temperature,.*,30' | -| --critical | Define the critical threshold for temperatures (syntax: type,instance,threshold) Example: --critical='temperature,.*,40' | -| --warning-count-* | Define the warning threshold for the number of components of one type (replace '*' with the component type). | -| --critical-count-* | Define the critical threshold for the number of components of one type (replace '*' with the component type). | +| Option | Description | +|:---------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| --component | Which component to check (default: '.*'). Can be: 'psu'. | +| --filter | Exclude the items given as a comma-separated list (example: --filter=psu). You can also exclude items from specific instances: --filter=psu,1 | +| --absent-problem | Return an error if an entity is not 'present' (default is skipping) (comma separated list) Can be specific or global: --absent-problem=psu,1 | +| --no-component | Define the expected status if no components are found (default: critical). | +| --threshold-overload | Use this option to override the status returned by the plugin when the status label matches a regular expression (syntax: section,\[instance,\]status,regexp). Example: --threshold-overload='psu,WARNING,not operational' | +| --warning | Define the warning threshold for temperatures (syntax: type,instance,threshold) Example: --warning='temperature,.*,30' | +| --critical | Define the critical threshold for temperatures (syntax: type,instance,threshold) Example: --critical='temperature,.*,40' | +| --warning-count-* | Define the warning threshold for the number of components of one type (replace '*' with the component type). | +| --critical-count-* | Define the critical threshold for the number of components of one type (replace '*' with the component type). | -| Option | Description | -|:-------------------------|:------------------------------------------------------------------------------------------------------------------------------| -| --filter-counters | Only display some counters (regexp can be used). Example to check SSL connections only : --filter-counters='^xxxx\|yyyy$' | -| --warning-* --critical-* | Thresholds. Can be: 'usage' (B), 'usage-free' (B), 'usage-prct' (%). | +| Option | Description | +|:-------------------------|:--------------------------------------------------------------------------------------------------------------------------| +| --filter-counters | Only display some counters (regexp can be used). Example to check SSL connections only : --filter-counters='^xxxx\|yyyy$' | +| --warning-xxx | Warning threshold. | +| --critical-xxx | Critical threshold. | +| --warning-* --critical-* | Thresholds. Can be: 'usage' (B), 'usage-free' (B), 'usage-prct' (%). | -| Option | Description | -|:------------------------------------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| --filter-counters | Only display some counters (regexp can be used). Example to check SSL connections only : --filter-counters='^xxxx\|yyyy$' | -| --memcached | Memcached server to use (only one server). | -| --redis-server | Redis server to use (only one server). Syntax: address\[:port\] | -| --redis-attribute | Set Redis Options (--redis-attribute="cnx\_timeout=5"). | -| --redis-db | Set Redis database index. | -| --failback-file | Failback on a local file if Redis connection fails. | -| --memexpiration | Time to keep data in seconds (default: 86400). | -| --statefile-dir | Define the cache directory (default: '/var/lib/centreon/centplugins'). | -| --statefile-suffix | Define a suffix to customize the statefile name (default: ''). | -| --statefile-concat-cwd | If used with the '--statefile-dir' option, the latter's value will be used as a sub-directory of the current working directory. Useful on Windows when the plugin is compiled, as the file system and permissions are different from Linux. | -| --statefile-format | Define the format used to store the cache. Available formats: 'dumper', 'storable', 'json' (default). | -| --statefile-key | Define the key to encrypt/decrypt the cache. | -| --statefile-cipher | Define the cipher algorithm to encrypt the cache (default: 'AES'). | -| --add-global | Check global port statistics (by default if no --add-* option is set). | -| --add-status | Check interface status. | -| --add-duplex-status | Check duplex status (with --warning-status and --critical-status). | -| --add-traffic | Check interface traffic. | -| --add-errors | Check interface errors. | -| --add-cast | Check interface cast. | -| --add-speed | Check interface speed. | -| --add-volume | Check interface data volume between two checks (not supposed to be graphed, useful for BI reporting). | -| --check-metrics | If the expression is true, metrics are checked (default: '%\{opstatus\} eq "up"'). | -| --warning-status | Define the conditions to match for the status to be WARNING. You can use the following variables: %\{admstatus\}, %\{opstatus\}, %\{duplexstatus\}, %\{display\} | -| --critical-status | Define the conditions to match for the status to be CRITICAL (default: '%\{admstatus\} eq "up" and %\{opstatus\} ne "up"'). You can use the following variables: %\{admstatus\}, %\{opstatus\}, %\{duplexstatus\}, %\{display\} | -| --warning-* --critical-* | Thresholds. Can be: 'total-port', 'total-admin-up', 'total-admin-down', 'total-oper-up', 'total-oper-down', 'in-traffic', 'out-traffic', 'in-error', 'in-discard', 'out-error', 'out-discard', 'in-ucast', 'in-bcast', 'in-mcast', 'out-ucast', 'out-bcast', 'out-mcast', 'speed' (b/s). | -| --units-traffic | Units of thresholds for the traffic (default: 'percent\_delta') ('percent\_delta', 'bps', 'counter'). | -| --units-errors | Units of thresholds for errors/discards (default: 'percent\_delta') ('percent\_delta', 'percent', 'delta', 'deltaps', 'counter'). | -| --units-cast | Units of thresholds for communication types (default: 'percent\_delta') ('percent\_delta', 'percent', 'delta', 'deltaps', 'counter'). | -| --nagvis-perfdata | Display traffic perfdata to be compatible with NagVis widget. | -| --interface | Define the interface filter on IDs (OID indexes, e.g.: 1,2,...). If empty, all interfaces will be monitored. To filter on interface names, see --name. | -| --name | With this option, the interfaces will be filtered by name (given in option --interface) instead of OID index. The name matching mode supports regular expressions. | -| --regex-id | With this option, interface IDs will be filtered using the --interface parameter as a regular expression instead of a list of IDs. | -| --speed | Set interface speed for incoming/outgoing traffic (in Mb). | -| --speed-in | Set interface speed for incoming traffic (in Mb). | -| --speed-out | Set interface speed for outgoing traffic (in Mb). | -| --map-speed-dsl | Get interface speed configuration for interfaces of type 'ADSL' and 'VDSL2'. Syntax: --map-speed-dsl=interface-src-name,interface-dsl-name E.g: --map-speed-dsl=Et0.835,Et0-vdsl2 | -| --force-counters64 | Force to use 64 bits counters only. Can be used to improve performance. | -| --force-counters32 | Force to use 32-bits counters (even with SNMP versions 2c and 3). To use when 64 bits counters are buggy. | -| --reload-cache-time | Time in minutes before reloading cache file (default: 180). | -| --oid-filter | Define the OID to be used to filter interfaces (default: ifName) (values: ifDesc, ifAlias, ifName, IpAddr). | -| --oid-display | Define the OID that will be used to name the interfaces (default: ifName) (values: ifDesc, ifAlias, ifName, IpAddr). | -| --oid-extra-display | Add an OID to display. | -| --display-transform-src --display-transform-dst | Modify the interface name displayed by using a regular expression. Example: adding --display-transform-src='eth' --display-transform-dst='ens' will replace all occurrences of 'eth' with 'ens' | -| --show-cache | Display cache interface data. | +| Option | Description | +|:------------------------------------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| --filter-counters | Only display some counters (regexp can be used). Example to check SSL connections only : --filter-counters='^xxxx\|yyyy$' | +| --warning-xxx | Warning threshold. | +| --critical-xxx | Critical threshold. | +| --memcached | Memcached server to use (only one server). | +| --redis-server | Redis server to use (only one server). Syntax: address\[:port\] | +| --redis-attribute | Set Redis Options (--redis-attribute="cnx\_timeout=5"). | +| --redis-db | Set Redis database index. | +| --failback-file | Fall back on a local file if Redis connection fails. | +| --memexpiration | Time to keep data in seconds (default: 86400). | +| --statefile-dir | Define the cache directory (default: '/var/lib/centreon/centplugins'). | +| --statefile-suffix | Define a suffix to customize the statefile name (default: ''). | +| --statefile-concat-cwd | If used with the '--statefile-dir' option, the latter's value will be used as a sub-directory of the current working directory. Useful on Windows when the plugin is compiled, as the file system and permissions are different from Linux. | +| --statefile-format | Define the format used to store the cache. Available formats: 'dumper', 'storable', 'json' (default). | +| --statefile-key | Define the key to encrypt/decrypt the cache. | +| --statefile-cipher | Define the cipher algorithm to encrypt the cache (default: 'AES'). | +| --add-global | Check global port statistics (by default if no --add-* option is set). | +| --add-status | Check interface status. | +| --add-duplex-status | Check duplex status (with --warning-status and --critical-status). | +| --add-traffic | Check interface traffic. | +| --add-errors | Check interface errors. | +| --add-cast | Check interface cast. | +| --add-speed | Check interface speed. | +| --add-volume | Check interface data volume between two checks (not supposed to be graphed, useful for BI reporting). | +| --check-metrics | If the expression is true, metrics are checked (default: '%\{opstatus\} eq "up"'). | +| --warning-status | Define the conditions to match for the status to be WARNING. You can use the following variables: %\{admstatus\}, %\{opstatus\}, %\{duplexstatus\}, %\{display\} | +| --critical-status | Define the conditions to match for the status to be CRITICAL (default: '%\{admstatus\} eq "up" and %\{opstatus\} ne "up"'). You can use the following variables: %\{admstatus\}, %\{opstatus\}, %\{duplexstatus\}, %\{display\} | +| --warning-total-port | Thresholds. | +| --critical-total-port | Thresholds. | +| --warning-total-admin-up | Thresholds. | +| --critical-total-admin-up | Thresholds. | +| --warning-total-admin-down | Thresholds. | +| --critical-total-admin-down | Thresholds. | +| --warning-total-oper-up | Thresholds. | +| --critical-total-oper-up | Thresholds. | +| --warning-total-oper-down | Thresholds. | +| --critical-total-oper-down | Thresholds. | +| --warning-in-traffic | Thresholds. | +| --critical-in-traffic | Thresholds. | +| --warning-out-traffic | Thresholds. | +| --critical-out-traffic | Thresholds. | +| --warning-in-error | Thresholds. | +| --critical-in-error | Thresholds. | +| --warning-in-discard | Thresholds. | +| --critical-in-discard | Thresholds. | +| --warning-out-error | Thresholds. | +| --critical-out-error | Thresholds. | +| --warning-out-discard | Thresholds. | +| --critical-out-discard | Thresholds. | +| --warning-in-ucast | Thresholds. | +| --critical-in-ucast | Thresholds. | +| --warning-in-bcast | Thresholds. | +| --critical-in-bcast | Thresholds. | +| --warning-in-mcast | Thresholds. | +| --critical-in-mcast | Thresholds. | +| --warning-out-ucast | Thresholds. | +| --critical-out-ucast | Thresholds. | +| --warning-out-bcast | Thresholds. | +| --critical-out-bcast | Thresholds. | +| --warning-out-mcast | Thresholds. | +| --critical-out-mcast | Thresholds. | +| --warning-speed | Thresholds in b/s. | +| --critical-speed | Thresholds in b/s. | +| --units-traffic | Units of thresholds for the traffic (default: 'percent\_delta') ('percent\_delta', 'bps', 'counter'). | +| --units-errors | Units of thresholds for errors/discards (default: 'percent\_delta') ('percent\_delta', 'delta', 'deltaps', 'counter'). | +| --units-cast | Units of thresholds for communication types (default: 'percent\_delta') ('percent\_delta', 'percent', 'delta', 'deltaps', 'counter'). | +| --nagvis-perfdata | Display traffic perfdata to be compatible with NagVis widget. | +| --interface | Check only the interfaces with the specified IDs (OID indexes, e.g.: 1,2,...). If empty, all interfaces will be monitored. To filter on interface names, see --name. | +| --name | With this option, the interfaces will be filtered by name (given in option --interface) instead of OID index. The name matching mode supports regular expressions. | +| --regex-id | With this option, interface IDs will be filtered using the --interface parameter as a regular expression instead of a list of IDs. | +| --speed | Set interface speed for incoming/outgoing traffic (in Mb). | +| --speed-in | Set interface speed for incoming traffic (in Mb). | +| --speed-out | Set interface speed for outgoing traffic (in Mb). | +| --map-speed-dsl | Get interface speed configuration for interfaces of type 'ADSL' and 'VDSL2'. Syntax: --map-speed-dsl=interface-src-name,interface-dsl-name E.g: --map-speed-dsl=Et0.835,Et0-vdsl2 | +| --force-counters64 | Force to use 64 bits counters only. Can be used to improve performance. | +| --force-counters32 | Force to use 32-bit counters (even with SNMP versions 2c and 3). To use when 64 bits counters are buggy. | +| --reload-cache-time | Time in minutes before reloading cache file (default: 180). | +| --oid-filter | Define the OID to be used to filter interfaces (default: ifName) (values: ifDesc, ifAlias, ifName, IpAddr). | +| --oid-display | Define the OID that will be used to name the interfaces (default: ifName) (values: ifDesc, ifAlias, ifName, IpAddr). | +| --oid-extra-display | Add an OID to display. | +| --display-transform-src --display-transform-dst | Modify the interface name displayed by using a regular expression. Example: adding --display-transform-src='eth' --display-transform-dst='ens' will replace all occurrences of 'eth' with 'ens' | +| --show-cache | Display cache interface data. | +| --no-cache-lock | Set to disable locking when accessing cache. | diff --git a/pp/integrations/plugin-packs/procedures/network-firewalls-cisco-asa-snmp.md b/pp/integrations/plugin-packs/procedures/network-firewalls-cisco-asa-snmp.md index 1b00097deee7..9935fafb8f47 100644 --- a/pp/integrations/plugin-packs/procedures/network-firewalls-cisco-asa-snmp.md +++ b/pp/integrations/plugin-packs/procedures/network-firewalls-cisco-asa-snmp.md @@ -24,28 +24,28 @@ The connector brings the following service templates (sorted by the host templat -| Service Alias | Service Template | Service Description | -|:--------------|:--------------------------------------|:--------------------------------------------------------------------------------------------------------------| -| Cpu | Net-FW-Cisco-Asa-Cpu-SNMP-custom | Check the rate of utilization of CPU for the machine. This check can give the average utilization rate of CPU | -| Memory | Net-FW-Cisco-Asa-Memory-SNMP-custom | Check machine memory usage | -| Sensors | Net-FW-Cisco-Asa-Sensors-SNMP-custom | Check sensors | -| Sessions | Net-FW-Cisco-Asa-Sessions-SNMP-custom | Check current/average connections | +| Service Alias | Service Template | Service Description | +|:--------------|:--------------------------------------|:----------------------------------------------------------------------------------------------------------------------| +| Cpu | Net-FW-Cisco-Asa-Cpu-SNMP-custom | Check the rate of utilization of the CPU for the machine. This check can give the average utilization rate of the CPU | +| Memory | Net-FW-Cisco-Asa-Memory-SNMP-custom | Check machine memory usage | +| Sensors | Net-FW-Cisco-Asa-Sensors-SNMP-custom | Check sensors | +| Sessions | Net-FW-Cisco-Asa-Sessions-SNMP-custom | Check current/average connections | > The services listed above are created automatically when the **Net-FW-Cisco-Asa-SNMP-custom** host template is used. -| Service Alias | Service Template | Service Description | Discovery | -|:---------------------------|:--------------------------------------------------------|:----------------------------------------------------------------|:---------:| -| Failover | Net-FW-Cisco-Asa-Failover-SNMP-custom | Check failover status | | -| Ipsec-Tunnel | Net-FW-Cisco-Asa-Ipsec-Tunnel-SNMP-custom | Check IPSec tunnels | | -| Packet-Errors-Generic-Id | Net-FW-Cisco-Asa-Packet-Errors-Generic-Id-SNMP-custom | Check packets on errors/discards of a network interface | | -| Packet-Errors-Generic-Name | Net-FW-Cisco-Asa-Packet-Errors-Generic-Name-SNMP-custom | Check packets on errors/discards of a network interface | | -| Packet-Errors-Global | Net-FW-Cisco-Asa-Packet-Errors-Global-SNMP-custom | Check packets on errors/discards of multiple network interfaces | X | -| Traffic-Generic-Id | Net-FW-Cisco-Asa-Traffic-Generic-Id-SNMP-custom | Check traffic of an network interface | | -| Traffic-Generic-Name | Net-FW-Cisco-Asa-Traffic-Generic-Name-SNMP-custom | Check traffic of an network interface | | -| Traffic-Global | Net-FW-Cisco-Asa-Traffic-Global-SNMP-custom | Check traffic of multiple network interfaces | X | +| Service Alias | Service Template | Service Description | Discovery | +|:---------------------------|:--------------------------------------------------------|:-----------------------------------------------------------------------------|:---------:| +| Failover | Net-FW-Cisco-Asa-Failover-SNMP-custom | Check failover status | | +| Ipsec-Tunnel | Net-FW-Cisco-Asa-Ipsec-Tunnel-SNMP-custom | Check IPSec tunnels | | +| Packet-Errors-Generic-Id | Net-FW-Cisco-Asa-Packet-Errors-Generic-Id-SNMP-custom | Check packets in error and discarded packets for multiple network interfaces | | +| Packet-Errors-Generic-Name | Net-FW-Cisco-Asa-Packet-Errors-Generic-Name-SNMP-custom | Check packets in error and discarded packets for a network interface | | +| Packet-Errors-Global | Net-FW-Cisco-Asa-Packet-Errors-Global-SNMP-custom | Check packets in error and discarded packets for multiple network interfaces | X | +| Traffic-Generic-Id | Net-FW-Cisco-Asa-Traffic-Generic-Id-SNMP-custom | Check traffic of an network interface | | +| Traffic-Generic-Name | Net-FW-Cisco-Asa-Traffic-Generic-Name-SNMP-custom | Check traffic of an network interface | | +| Traffic-Global | Net-FW-Cisco-Asa-Traffic-Global-SNMP-custom | Check traffic of multiple network interfaces | X | > The services listed above are not created automatically when a host template is applied. To use them, [create a service manually](/docs/monitoring/basic-objects/services), then apply the service template you want. @@ -296,12 +296,14 @@ yum install centreon-plugin-Network-Firewalls-Cisco-Asa-Snmp 2. Fill in the **Name**, **Alias** & **IP Address/DNS** fields according to your resource's settings. 3. Apply the **Net-FW-Cisco-Asa-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](../getting-started/how-to-guides/troubleshooting-plugins.md#snmpv3-options-mapping) 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](#available-options). | | | +| Macro | Description | Default value | Mandatory | +|:------------------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------|:--------------|:---------:| +| SNMP_V3_USERNAME | SNMP v3 only: User name (`securityName`) | | | +| SNMP_V3_AUTH_PROTOCOL | SNMP v3 only: Authentication protocol: MD5\|SHA. Since net-snmp 5.9.1: SHA224\|SHA256\|SHA384\|SHA512 | | | +| SNMP_V3_PRIV_PROTOCOL | 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 | | | +| SNMP_V3_AUTH_PASSPHRASE | SNMP v3 only: Pass phrase hashed using the authentication protocol defined in the --authprotocol option | | | +| SNMP_V3_PRIV_PASSPHRASE | SNMP v3 only: Privacy pass phrase (`privPassword`) to encrypt messages using the protocol defined in the --privprotocol option | | | +| SNMPEXTRAOPTIONS | Any extra option you may want to add to every command (a --verbose flag for example). All options are listed [here](#available-options). | | | 4. [Deploy the configuration](/docs/monitoring/monitoring-servers/deploying-a-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. @@ -377,14 +379,14 @@ yum install centreon-plugin-Network-Firewalls-Cisco-Asa-Snmp | Macro | Description | Default value | Mandatory | |:-------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------|:--------------|:---------:| | INTERFACEID | Check only the interfaces with the specified IDs (OID indexes, e.g.: 1,2,...). If empty, all interfaces will be monitored. To filter on interface names, see --name | | | -| WARNINGINDISCARD | Threshold | | | -| CRITICALINDISCARD | Threshold | | | -| WARNINGINERROR | Threshold | | | -| CRITICALINERROR | Threshold | | | -| WARNINGOUTDISCARD | Threshold | | | -| CRITICALOUTDISCARD | Threshold | | | -| WARNINGOUTERROR | Threshold | | | -| CRITICALOUTERROR | Threshold | | | +| WARNINGINDISCARD | Thresholds | | | +| CRITICALINDISCARD | Thresholds | | | +| WARNINGINERROR | Thresholds | | | +| CRITICALINERROR | Thresholds | | | +| WARNINGOUTDISCARD | Thresholds | | | +| CRITICALOUTDISCARD | Thresholds | | | +| WARNINGOUTERROR | Thresholds | | | +| CRITICALOUTERROR | Thresholds | | | | EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). All options are listed [here](#available-options). | | | @@ -393,14 +395,14 @@ yum install centreon-plugin-Network-Firewalls-Cisco-Asa-Snmp | Macro | Description | Default value | Mandatory | |:-------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------|:--------------|:---------:| | INTERFACENAME | Check only the interfaces with the specified IDs (OID indexes, e.g.: 1,2,...). If empty, all interfaces will be monitored. To filter on interface names, see --name | | | -| WARNINGINDISCARD | Threshold | | | -| CRITICALINDISCARD | Threshold | | | -| WARNINGINERROR | Threshold | | | -| CRITICALINERROR | Threshold | | | -| WARNINGOUTDISCARD | Threshold | | | -| CRITICALOUTDISCARD | Threshold | | | -| WARNINGOUTERROR | Threshold | | | -| CRITICALOUTERROR | Threshold | | | +| WARNINGINDISCARD | Thresholds | | | +| CRITICALINDISCARD | Thresholds | | | +| WARNINGINERROR | Thresholds | | | +| CRITICALINERROR | Thresholds | | | +| WARNINGOUTDISCARD | Thresholds | | | +| CRITICALOUTDISCARD | Thresholds | | | +| WARNINGOUTERROR | Thresholds | | | +| CRITICALOUTERROR | Thresholds | | | | EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). All options are listed [here](#available-options). | | | @@ -409,14 +411,14 @@ yum install centreon-plugin-Network-Firewalls-Cisco-Asa-Snmp | Macro | Description | Default value | Mandatory | |:-------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------|:-------------------------------------------------|:---------:| | FILTER | Check only the interfaces with the specified IDs (OID indexes, e.g.: 1,2,...). If empty, all interfaces will be monitored. To filter on interface names, see --name | .* | | -| WARNINGINDISCARD | Threshold | | | -| CRITICALINDISCARD | Threshold | | | -| WARNINGINERROR | Threshold | | | -| CRITICALINERROR | Threshold | | | -| WARNINGOUTDISCARD | Threshold | | | -| CRITICALOUTDISCARD | Threshold | | | -| WARNINGOUTERROR | Threshold | | | -| CRITICALOUTERROR | Threshold | | | +| WARNINGINDISCARD | Thresholds | | | +| CRITICALINDISCARD | Thresholds | | | +| WARNINGINERROR | Thresholds | | | +| CRITICALINERROR | Thresholds | | | +| WARNINGOUTDISCARD | Thresholds | | | +| CRITICALOUTDISCARD | Thresholds | | | +| WARNINGOUTERROR | Thresholds | | | +| CRITICALOUTERROR | Thresholds | | | | CRITICALSTATUS | Define the conditions to match for the status to be CRITICAL. You can use the following variables: %\{admstatus\}, %\{opstatus\}, %\{duplexstatus\}, %\{display\} | %\{admstatus\} eq "up" and %\{opstatus\} ne "up" | | | EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). All options are listed [here](#available-options). | --verbose | | @@ -446,10 +448,10 @@ yum install centreon-plugin-Network-Firewalls-Cisco-Asa-Snmp | Macro | Description | Default value | Mandatory | |:-------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------|:--------------|:---------:| | INTERFACEID | Check only the interfaces with the specified IDs (OID indexes, e.g.: 1,2,...). If empty, all interfaces will be monitored. To filter on interface names, see --name | | | -| WARNINGIN | Threshold | 80 | | -| CRITICALIN | Threshold | 90 | | -| WARNINGOUT | Threshold | 80 | | -| CRITICALOUT | Threshold | 90 | | +| WARNINGIN | Thresholds | 80 | | +| CRITICALIN | Thresholds | 90 | | +| WARNINGOUT | Thresholds | 80 | | +| CRITICALOUT | Thresholds | 90 | | | EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). All options are listed [here](#available-options). | | | @@ -458,10 +460,10 @@ yum install centreon-plugin-Network-Firewalls-Cisco-Asa-Snmp | Macro | Description | Default value | Mandatory | |:--------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------|:--------------|:---------:| | INTERFACENAME | Check only the interfaces with the specified IDs (OID indexes, e.g.: 1,2,...). If empty, all interfaces will be monitored. To filter on interface names, see --name | | | -| WARNINGIN | Threshold | 80 | | -| CRITICALIN | Threshold | 90 | | -| WARNINGOUT | Threshold | 80 | | -| CRITICALOUT | Threshold | 90 | | +| WARNINGIN | Thresholds | 80 | | +| CRITICALIN | Thresholds | 90 | | +| WARNINGOUT | Thresholds | 80 | | +| CRITICALOUT | Thresholds | 90 | | | EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). All options are listed [here](#available-options). | | | @@ -470,10 +472,10 @@ yum install centreon-plugin-Network-Firewalls-Cisco-Asa-Snmp | Macro | Description | Default value | Mandatory | |:---------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------|:-------------------------------------------------|:---------:| | FILTER | Check only the interfaces with the specified IDs (OID indexes, e.g.: 1,2,...). If empty, all interfaces will be monitored. To filter on interface names, see --name | .* | | -| WARNINGIN | Threshold | 80 | | -| CRITICALIN | Threshold | 90 | | -| WARNINGOUT | Threshold | 80 | | -| CRITICALOUT | Threshold | 90 | | +| WARNINGIN | Thresholds | 80 | | +| CRITICALIN | Thresholds | 90 | | +| WARNINGOUT | Thresholds | 80 | | +| CRITICALOUT | Thresholds | 90 | | | CRITICALSTATUS | Define the conditions to match for the status to be CRITICAL. You can use the following variables: %\{admstatus\}, %\{opstatus\}, %\{duplexstatus\}, %\{display\} | %\{admstatus\} eq "up" and %\{opstatus\} ne "up" | | | EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). All options are listed [here](#available-options). | --verbose | | @@ -494,7 +496,12 @@ is able to monitor a resource using a command like this one (replace the sample --mode=interfaces \ --hostname=10.0.0.1 \ --snmp-version='2c' \ - --snmp-community='my-snmp-community' \ + --snmp-community='my-snmp-community' \ + --snmp-username='username' \ + --authpassphrase='' \ + --authprotocol='' \ + --privpassphrase='' \ + --privprotocol='' \ --interface='.*' \ --name \ --add-status \ @@ -570,24 +577,25 @@ All generic options are listed here: | --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-force-getnext | Use SNMP get-next 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). | +| --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. | +| --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 ok, warning, critical and unknown (default). | -| --snmp-tls-transport | Transport protocol for TLS communication (can be: 'dtlsudp', 'tlstcp'). | +| --snmp-errors-exit | Expected status in case of SNMP error or timeout. Possible values are ok, 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-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. | +| --show-password | By default, sensitive information in command lines is hidden in debug output and replaced with `***` (however, debug logs may still display sensitive information). Using the C option will display the passwords in plain text. | | --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%;;;; | @@ -595,9 +603,9 @@ All generic options are listed here: | --change-perfdata | Change or extend perfdata. Syntax: --extend-perfdata=searchlabel,newlabel,target\[,\[\\],\[min\],\[max\]\] Common examples: onvert 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\[,\[\\],\[min\],\[max\]\] Common examples: onvert 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,\,calculation\[,\[\\],\[min\],\[max\]\] regex: regular expression \: 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 \ (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: um 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~replacement~modifier Most commonly used modifiers are i (case insensitive) and g (replace all occurrences). Example: adding --change-short-output='OK\~Up\~gi' will replace all occurrences of 'OK', 'ok', 'Ok' or 'oK' with 'Up' | -| --change-short-output | Modify the short/long output that is returned by the plugin. Syntax: --change-short-output=pattern~replacement~modifier Most commonly used modifiers are i (case insensitive) and g (replace all occurrences). Example: adding --change-short-output='OK\~Up\~gi' will replace all occurrences of 'OK', 'ok', 'Ok' or 'oK' with 'Up' | -| --change-long-output | Modify the short/long output that is returned by the plugin. Syntax: --change-short-output=pattern~replacement~modifier Most commonly used modifiers are i (case insensitive) and g (replace all occurrences). Example: adding --change-short-output='OK\~Up\~gi' will replace all occurrences of 'OK', 'ok', 'Ok' or 'oK' with 'Up' | +| --change-short-output --change-long-output | Modify the short/long output that is returned by the plugin. Syntax: --change-short-output=pattern~replacement~modifier Most commonly used modifiers are i (case insensitive) and g (replace all occurrences). Example: adding --change-short-output='OK~Up~gi' will replace all occurrences of 'OK', 'ok', 'Ok' or 'oK' with 'Up' | +| --change-short-output | Modify the short/long output that is returned by the plugin. Syntax: --change-short-output=pattern~replacement~modifier Most commonly used modifiers are i (case insensitive) and g (replace all occurrences). Example: adding --change-short-output='OK~Up~gi' will replace all occurrences of 'OK', 'ok', 'Ok' or 'oK' with 'Up' | +| --change-long-output | Modify the short/long output that is returned by the plugin. Syntax: --change-short-output=pattern~replacement~modifier Most commonly used modifiers are i (case insensitive) and g (replace all occurrences). Example: adding --change-short-output='OK~Up~gi' will replace all occurrences of 'OK', 'ok', 'Ok' or 'oK' with 'Up' | | --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. | @@ -624,6 +632,8 @@ All available options for each service template are listed below: | Option | Description | |:-------------------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | --filter-counters | Only display some counters (regexp can be used). Example to check SSL connections only : --filter-counters='^xxxx\|yyyy$' | +| --warning-xxx | Warning threshold. | +| --critical-xxx | Critical threshold. | | --check-order | Check CPU in standard cisco mib. If you have some issue (wrong CPU information in a specific mib), you can change the order (default: 'process,old\_sys,system\_ext'). | | --warning-* --critical-* | Thresholds. Can be: 'core-5s', 'core-1m', 'core-5m', 'average-5s', 'average-1m', 'average-5m'. | @@ -633,6 +643,8 @@ All available options for each service template are listed below: | Option | Description | |:------------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | --filter-counters | Only display some counters (regexp can be used). Example: --filter-counters='^status$' | +| --warning-xxx | Warning threshold. | +| --critical-xxx | Critical threshold. | | --warning-status | Define the conditions to match for the status to be WARNING. You can use the following variables: %\{primaryStateLast\}, %\{secondaryStateLast\}, %\{primaryState\}, %\{secondaryState\} | | --critical-status | Define the conditions to match for the status to be CRITICAL. You can use the following variables: %\{primaryStateLast\}, %\{secondaryStateLast\}, %\{primaryState\}, %\{secondaryState\} | | --warning-* | Warning threshold. Can be: 'active-units'. | @@ -644,6 +656,8 @@ All available options for each service template are listed below: | Option | Description | |:------------------|:-------------------------------------------------------------------------------------------------------------------| | --filter-counters | Only display some counters (regexp can be used). Example: --filter-counters='^(tunnels-total)$' | +| --warning-xxx | Warning threshold. | +| --critical-xxx | Critical threshold. | | --filter-name | Filter name (can be a regexp). Example (format localaddr\_remoteaddr): | | --filter-sa | Filter IPSec Security Associations (can be a regexp). Example (format localaddr:localmask\_remoteaddr:remotemask): | | --warning-* | Warning threshold. Can be: 'tunnels-total', 'traffic-in', 'traffic-out', 'drop-in', 'drop-out', 'sa-total'. | @@ -655,6 +669,8 @@ All available options for each service template are listed below: | Option | Description | |:------------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | --filter-counters | Only display some counters (regexp can be used). Example to check SSL connections only : --filter-counters='^xxxx\|yyyy$' | +| --warning-xxx | Warning threshold. | +| --critical-xxx | Critical threshold. | | --warning-usage | Warning threshold in percent. | | --critical-usage | Critical threshold in percent. | | --filter-pool | Filter pool to check (can use regexp). | @@ -663,68 +679,106 @@ All available options for each service template are listed below: -| Option | Description | -|:------------------------------------------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| --filter-counters | Only display some counters (regexp can be used). Example to check SSL connections only : --filter-counters='^xxxx\|yyyy$' | -| --memcached | Memcached server to use (only one server). | -| --redis-server | Redis server to use (only one server). Syntax: address\[:port\] | -| --redis-attribute | Set Redis Options (--redis-attribute="cnx\_timeout=5"). | -| --redis-db | Set Redis database index. | -| --failback-file | Fall back on a local file if Redis connection fails. | -| --memexpiration | Time to keep data in seconds (default: 86400). | -| --statefile-dir | Define the cache directory (default: '/var/lib/centreon/centplugins'). | -| --statefile-suffix | Define a suffix to customize the statefile name (default: ''). | -| --statefile-concat-cwd | If used with the '--statefile-dir' option, the latter's value will be used as a sub-directory of the current working directory. Useful on Windows when the plugin is compiled, as the file system and permissions are different from Linux. | -| --statefile-format | Define the format used to store the cache. Available formats: 'dumper', 'storable', 'json' (default). | -| --statefile-key | Define the key to encrypt/decrypt the cache. | -| --statefile-cipher | Define the cipher algorithm to encrypt the cache (default: 'AES'). | -| --add-global | Check global port statistics (by default if no --add-* option is set). | -| --add-status | Check interface status. | -| --add-duplex-status | Check duplex status (with --warning-status and --critical-status). | -| --add-traffic | Check interface traffic. | -| --add-errors | Check interface errors. | -| --add-cast | Check interface cast. | -| --add-speed | Check interface speed. | -| --add-volume | Check interface data volume between two checks (not supposed to be graphed, useful for BI reporting). | -| --check-metrics | If the expression is true, metrics are checked (default: '%\{opstatus\} eq "up"'). | -| --warning-status | Define the conditions to match for the status to be WARNING. You can use the following variables: %\{admstatus\}, %\{opstatus\}, %\{duplexstatus\}, %\{display\} | -| --critical-status | Define the conditions to match for the status to be CRITICAL (default: '%\{admstatus\} eq "up" and %\{opstatus\} ne "up"'). You can use the following variables: %\{admstatus\}, %\{opstatus\}, %\{duplexstatus\}, %\{display\} | -| --warning-* --critical-* | Thresholds. Can be: 'total-port', 'total-admin-up', 'total-admin-down', 'total-oper-up', 'total-oper-down', 'in-traffic', 'out-traffic', 'in-error', 'in-discard', 'out-error', 'out-discard', 'in-ucast', 'in-bcast', 'in-mcast', 'out-ucast', 'out-bcast', 'out-mcast', 'speed' (b/s). | -| --units-traffic | Units of thresholds for the traffic (default: 'percent\_delta') ('percent\_delta', 'bps', 'counter'). | -| --units-errors | Units of thresholds for errors/discards (default: 'percent\_delta') ('percent\_delta', 'percent', 'delta', 'deltaps', 'counter'). | -| --units-cast | Units of thresholds for communication types (default: 'percent\_delta') ('percent\_delta', 'percent', 'delta', 'deltaps', 'counter'). | -| --nagvis-perfdata | Display traffic perfdata to be compatible with NagVis widget. | -| --interface | Check only the interfaces with the specified IDs (OID indexes, e.g.: 1,2,...). If empty, all interfaces will be monitored. To filter on interface names, see --name. | -| --name | With this option, the interfaces will be filtered by name (given in option --interface) instead of OID index. The name matching mode supports regular expressions. | -| --regex-id | With this option, interface IDs will be filtered using the --interface parameter as a regular expression instead of a list of IDs. | -| --speed | Set interface speed for incoming/outgoing traffic (in Mb). | -| --speed-in | Set interface speed for incoming traffic (in Mb). | -| --speed-out | Set interface speed for outgoing traffic (in Mb). | -| --map-speed-dsl | Get interface speed configuration for interfaces of type 'ADSL' and 'VDSL2'. Syntax: --map-speed-dsl=interface-src-name,interface-dsl-name E.g: --map-speed-dsl=Et0.835,Et0-vdsl2 | -| --force-counters64 | Force to use 64 bits counters only. Can be used to improve performance. | -| --force-counters32 | Force to use 32-bit counters (even with SNMP versions 2c and 3). To use when 64 bits counters are buggy. | -| --reload-cache-time | Time in minutes before reloading cache file (default: 180). | -| --oid-filter | Define the OID to be used to filter interfaces (default: ifName) (values: ifDesc, ifAlias, ifName, IpAddr). | -| --oid-display | Define the OID that will be used to name the interfaces (default: ifName) (values: ifDesc, ifAlias, ifName, IpAddr). | -| --oid-extra-display | Add an OID to display. | -| --display-transform-src --display-transform-dst | Modify the interface name displayed by using a regular expression. Example: adding --display-transform-src='eth' --display-transform-dst='ens' will replace all occurrences of 'eth' with 'ens' | -| --show-cache | Display cache interface data. | +| Option | Description | +|:------------------------------------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| --filter-counters | Only display some counters (regexp can be used). Example to check SSL connections only : --filter-counters='^xxxx\|yyyy$' | +| --warning-xxx | Warning threshold. | +| --critical-xxx | Critical threshold. | +| --memcached | Memcached server to use (only one server). | +| --redis-server | Redis server to use (only one server). Syntax: address\[:port\] | +| --redis-attribute | Set Redis Options (--redis-attribute="cnx\_timeout=5"). | +| --redis-db | Set Redis database index. | +| --failback-file | Fall back on a local file if Redis connection fails. | +| --memexpiration | Time to keep data in seconds (default: 86400). | +| --statefile-dir | Define the cache directory (default: '/var/lib/centreon/centplugins'). | +| --statefile-suffix | Define a suffix to customize the statefile name (default: ''). | +| --statefile-concat-cwd | If used with the '--statefile-dir' option, the latter's value will be used as a sub-directory of the current working directory. Useful on Windows when the plugin is compiled, as the file system and permissions are different from Linux. | +| --statefile-format | Define the format used to store the cache. Available formats: 'dumper', 'storable', 'json' (default). | +| --statefile-key | Define the key to encrypt/decrypt the cache. | +| --statefile-cipher | Define the cipher algorithm to encrypt the cache (default: 'AES'). | +| --add-global | Check global port statistics (by default if no --add-* option is set). | +| --add-status | Check interface status. | +| --add-duplex-status | Check duplex status (with --warning-status and --critical-status). | +| --add-traffic | Check interface traffic. | +| --add-errors | Check interface errors. | +| --add-cast | Check interface cast. | +| --add-speed | Check interface speed. | +| --add-volume | Check interface data volume between two checks (not supposed to be graphed, useful for BI reporting). | +| --check-metrics | If the expression is true, metrics are checked (default: '%\{opstatus\} eq "up"'). | +| --warning-status | Define the conditions to match for the status to be WARNING. You can use the following variables: %\{admstatus\}, %\{opstatus\}, %\{duplexstatus\}, %\{display\} | +| --critical-status | Define the conditions to match for the status to be CRITICAL (default: '%\{admstatus\} eq "up" and %\{opstatus\} ne "up"'). You can use the following variables: %\{admstatus\}, %\{opstatus\}, %\{duplexstatus\}, %\{display\} | +| --warning-total-port | Thresholds. | +| --critical-total-port | Thresholds. | +| --warning-total-admin-up | Thresholds. | +| --critical-total-admin-up | Thresholds. | +| --warning-total-admin-down | Thresholds. | +| --critical-total-admin-down | Thresholds. | +| --warning-total-oper-up | Thresholds. | +| --critical-total-oper-up | Thresholds. | +| --warning-total-oper-down | Thresholds. | +| --critical-total-oper-down | Thresholds. | +| --warning-in-traffic | Thresholds. | +| --critical-in-traffic | Thresholds. | +| --warning-out-traffic | Thresholds. | +| --critical-out-traffic | Thresholds. | +| --warning-in-error | Thresholds. | +| --critical-in-error | Thresholds. | +| --warning-in-discard | Thresholds. | +| --critical-in-discard | Thresholds. | +| --warning-out-error | Thresholds. | +| --critical-out-error | Thresholds. | +| --warning-out-discard | Thresholds. | +| --critical-out-discard | Thresholds. | +| --warning-in-ucast | Thresholds. | +| --critical-in-ucast | Thresholds. | +| --warning-in-bcast | Thresholds. | +| --critical-in-bcast | Thresholds. | +| --warning-in-mcast | Thresholds. | +| --critical-in-mcast | Thresholds. | +| --warning-out-ucast | Thresholds. | +| --critical-out-ucast | Thresholds. | +| --warning-out-bcast | Thresholds. | +| --critical-out-bcast | Thresholds. | +| --warning-out-mcast | Thresholds. | +| --critical-out-mcast | Thresholds. | +| --warning-speed | Thresholds in b/s. | +| --critical-speed | Thresholds in b/s. | +| --units-traffic | Units of thresholds for the traffic (default: 'percent\_delta') ('percent\_delta', 'bps', 'counter'). | +| --units-errors | Units of thresholds for errors/discards (default: 'percent\_delta') ('percent\_delta', 'delta', 'deltaps', 'counter'). | +| --units-cast | Units of thresholds for communication types (default: 'percent\_delta') ('percent\_delta', 'percent', 'delta', 'deltaps', 'counter'). | +| --nagvis-perfdata | Display traffic perfdata to be compatible with NagVis widget. | +| --interface | Check only the interfaces with the specified IDs (OID indexes, e.g.: 1,2,...). If empty, all interfaces will be monitored. To filter on interface names, see --name. | +| --name | With this option, the interfaces will be filtered by name (given in option --interface) instead of OID index. The name matching mode supports regular expressions. | +| --regex-id | With this option, interface IDs will be filtered using the --interface parameter as a regular expression instead of a list of IDs. | +| --speed | Set interface speed for incoming/outgoing traffic (in Mb). | +| --speed-in | Set interface speed for incoming traffic (in Mb). | +| --speed-out | Set interface speed for outgoing traffic (in Mb). | +| --map-speed-dsl | Get interface speed configuration for interfaces of type 'ADSL' and 'VDSL2'. Syntax: --map-speed-dsl=interface-src-name,interface-dsl-name E.g: --map-speed-dsl=Et0.835,Et0-vdsl2 | +| --force-counters64 | Force to use 64 bits counters only. Can be used to improve performance. | +| --force-counters32 | Force to use 32-bit counters (even with SNMP versions 2c and 3). To use when 64 bits counters are buggy. | +| --reload-cache-time | Time in minutes before reloading cache file (default: 180). | +| --oid-filter | Define the OID to be used to filter interfaces (default: ifName) (values: ifDesc, ifAlias, ifName, IpAddr). | +| --oid-display | Define the OID that will be used to name the interfaces (default: ifName) (values: ifDesc, ifAlias, ifName, IpAddr). | +| --oid-extra-display | Add an OID to display. | +| --display-transform-src --display-transform-dst | Modify the interface name displayed by using a regular expression. Example: adding --display-transform-src='eth' --display-transform-dst='ens' will replace all occurrences of 'eth' with 'ens' | +| --show-cache | Display cache interface data. | +| --no-cache-lock | Set to disable locking when accessing cache. | -| Option | Description | -|:---------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| --component | Which component to check (default: '.*'). Can be: 'sensor'. | -| --filter | Exclude some parts (comma separated list) You can also exclude items from specific instances: --filter=sensor,celsius.* | -| --absent-problem | Return an error if a component is not 'present' (default is skipping). It can be set globally or for a specific instance: --absent-problem='component\_name' or --absent-problem='component\_name,instance\_value'. | -| --no-component | Define the expected status if no components are found (default: critical). | -| --threshold-overload | Use this option to override the status returned by the plugin when the status label matches a regular expression (syntax: section,\[instance,\]status,regexp). Example: --threshold-overload='sensor.celsius,OK,nonoperational' | -| --warning | Set warning threshold (syntax: type,regexp,threshold) Example: --warning='sensor.celsius,.*,30' | -| --critical | Set critical threshold (syntax: type,regexp,threshold) Example: --critical='sensor.celsius,.*,40' | -| --warning-count-* | Define the warning threshold for the number of components of one type (replace '*' with the component type). | -| --critical-count-* | Define the critical threshold for the number of components of one type (replace '*' with the component type). | -| --sensor-scale | Apply scaling value (some equipments are buggy. So we don't use scale by default). package snmp\_standard::mode::components::sensor; use strict; use warnings; my %map\_sensor\_status = (1 =\> 'ok', 2 =\> 'unavailable', 3 =\> 'nonoperational'); my %map\_sensor\_type = ( 1 =\> 'other', 2 =\> 'unknown', 3 =\> 'voltsAC', 4 =\> 'voltsDC', 5 =\> 'amperes', 6 =\> 'watts', 7 =\> 'hertz', 8 =\> 'celsius', 9 =\> 'percentRH', 10 =\> 'rpm', 11 =\> 'cmm', 12 =\> 'truthvalue', 13 =\> 'specialEnum', 14 =\> 'dBm', ); my %map\_sensor\_scale = ( 1 =\> -24, # yocto, 2 =\> -21, # zepto 3 =\> -18, # atto 4 =\> -15, # femto 5 =\> -12, # pico 6 =\> -9, # nano 7 =\> -6, # micro 8 =\> -3, # milli 9 =\> 0, #units 10 =\> 3, #kilo 11 =\> 6, #mega 12 =\> 9, #giga 13 =\> 12, #tera 14 =\> 18, #exa 15 =\> 15, #peta 16 =\> 21, #zetta 17 =\> 24, #yotta ); my %perfdata\_unit = ('other' =\> '', 'unknown' =\> '', 'voltsAC' =\> 'V', 'voltsDC' =\> 'V', 'amperes' =\> 'A', 'watts' =\> 'W', 'hertz' =\> 'Hz', 'celsius' =\> 'C', 'percentRH' =\> '%', 'rpm' =\> 'rpm', 'cmm' =\> '', 'truthvalue' =\> '', 'specialEnum' =\> '', 'dBm' =\> 'dBm', ); my $mapping = \{ entPhySensorType =\> \{ oid =\> '.1.3.6.1.2.1.99.1.1.1.1', map =\> \%map\_sensor\_type \}, entPhySensorScale =\> \{ oid =\> '.1.3.6.1.2.1.99.1.1.1.2', map =\> \%map\_sensor\_scale \}, entPhySensorPrecision =\> \{ oid =\> '.1.3.6.1.2.1.99.1.1.1.3' \}, entPhySensorValue =\> \{ oid =\> '.1.3.6.1.2.1.99.1.1.1.4' \}, entPhySensorOperStatus =\> \{ oid =\> '.1.3.6.1.2.1.99.1.1.1.5', map =\> \%map\_sensor\_status \}, \}; my $oid\_entPhySensorEntry = '.1.3.6.1.2.1.99.1.1.1'; sub load \{ my ($self) = @\_; push @\{$self-\>\{request\}\}, \{ oid =\> $oid\_entPhySensorEntry, end =\> $mapping-\>\{entPhySensorOperStatus\}-\>\{oid\} \}; \} sub check \{ my ($self) = @\_; $self-\>\{output\}-\>output\_add(long\_msg =\> "Checking sensors"); $self-\>\{components\}-\>\{sensor\} = \{name =\> 'sensors', total =\> 0, skip =\> 0\}; return if ($self-\>check\_filter(section =\> 'sensor')); my $oid\_entPhysicalName = '.1.3.6.1.2.1.47.1.1.1.1.7'; my $oid\_entPhysicalDescr = '.1.3.6.1.2.1.47.1.1.1.1.2'; foreach my $oid ($self-\>\{snmp\}-\>oid\_lex\_sort(keys %\{$self-\>\{results\}-\>\{$oid\_entPhysicalName\}\})) \{ next if ($oid !~ /^$oid\_entPhysicalName\.(.*)$/); my $instance = $1; my $result = $self-\>\{snmp\}-\>map\_instance(mapping =\> $mapping, results =\> $self-\>\{results\}-\>\{$oid\_entPhySensorEntry\}, instance =\> $instance); next if (!defined($result-\>\{entPhySensorOperStatus\})); next if ($self-\>check\_filter(section =\> 'sensor', instance =\> $result-\>\{entPhySensorType\} . '.' . $instance)); my $name = $self-\>\{results\}-\>\{$oid\_entPhysicalName\}-\>\{$oid\} ne '' ? $self-\>\{results\}-\>\{$oid\_entPhysicalName\}-\>\{$oid\} : $self-\>\{results\}-\>\{$oid\_entPhysicalDescr\}-\>\{$oid\_entPhysicalDescr . '.' . $instance\}; # It seems there is no scale if (!defined($self-\>\{option\_results\}-\>\{sensor\_scale\})) \{ $result-\>\{entPhySensorValue\} = defined($result-\>\{entPhySensorValue\}) ? $result-\>\{entPhySensorValue\} * (10 ** -($result-\>\{entPhySensorPrecision\})) : undef; \} else \{ $result-\>\{entPhySensorValue\} = defined($result-\>\{entPhySensorValue\}) ? $result-\>\{entPhySensorValue\} * (10 ** ($result-\>\{entPhySensorScale\}) * (10 ** -($result-\>\{entPhySensorPrecision\}))) : undef; \} $self-\>\{components\}-\>\{sensor\}-\>\{total\}++; $self-\>\{output\}-\>output\_add( long\_msg =\> sprintf( "sensor '%s' status is '%s' \[instance = %s, value = %s\]", $name, $result-\>\{entPhySensorOperStatus\}, $result-\>\{entPhySensorType\} . '.' . $instance, defined($result-\>\{entPhySensorValue\}) ? $result-\>\{entPhySensorValue\} : '-' ) ); my $exit = $self-\>get\_severity(label =\> 'sensor', section =\> 'sensor.' . $result-\>\{entPhySensorType\}, value =\> $result-\>\{entPhySensorOperStatus\}); if (!$self-\>\{output\}-\>is\_status(value =\> $exit, compare =\> 'ok', litteral =\> 1)) \{ $self-\>\{output\}-\>output\_add(severity =\> $exit, short\_msg =\> sprintf("Sensor '%s' status is '%s'", $name, $result-\>\{entPhySensorOperStatus\})); \} next if (!defined($result-\>\{entPhySensorValue\}) \|\| $result-\>\{entPhySensorValue\} !~ /\[0-9\]/); my $component = 'sensor.' . $result-\>\{entPhySensorType\}; my ($exit2, $warn, $crit, $checked) = $self-\>get\_severity\_numeric(section =\> $component, instance =\> $instance, value =\> $result-\>\{entPhySensorValue\}); if (!$self-\>\{output\}-\>is\_status(value =\> $exit2, compare =\> 'ok', litteral =\> 1)) \{ $self-\>\{output\}-\>output\_add( severity =\> $exit2, short\_msg =\> sprintf( "Sensor '%s/%s' is %s %s", $name, $instance, $result-\>\{entPhySensorValue\}, $perfdata\_unit\{$result-\>\{entPhySensorType\}\} ) ); \} $self-\>\{output\}-\>perfdata\_add( label =\> $component . '\_' . $name, unit =\> $perfdata\_unit\{$result-\>\{entPhySensorType\}\}, value =\> $result-\>\{entPhySensorValue\}, warning =\> $warn, critical =\> $crit ); \} \} 1; | +| Option | Description | +|:------------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| --component | Which component to check (default: '.*'). Can be: 'sensor'. | +| --filter | Exclude some parts (comma separated list) You can also exclude items from specific instances: --filter=sensor,celsius.* | +| --absent-problem | Return an error if a component is not 'present' (default is skipping). It can be set globally or for a specific instance: --absent-problem='component\_name' or --absent-problem='component\_name,instance\_value'. | +| --no-component | Define the expected status if no components are found (default: critical). | +| --threshold-overload | Use this option to override the status returned by the plugin when the status label matches a regular expression (syntax: section,\[instance,\]status,regexp). Example: --threshold-overload='sensor.celsius,OK,nonoperational' | +| --warning | Set warning threshold (syntax: type,regexp,threshold) Example: --warning='sensor.celsius,.*,30' | +| --critical | Set critical threshold (syntax: type,regexp,threshold) Example: --critical='sensor.celsius,.*,40' | +| --warning-count-sensor | Threshold. | +| --critical-count-sensor | Threshold. | +| --sensor-scale | Apply scaling value (some equipments are buggy. So we don't use scale by default). package snmp\_standard::mode::components::sensor; use strict; use warnings; my %map\_sensor\_status = (1 =\> 'ok', 2 =\> 'unavailable', 3 =\> 'nonoperational'); my %map\_sensor\_type = ( 1 =\> 'other', 2 =\> 'unknown', 3 =\> 'voltsAC', 4 =\> 'voltsDC', 5 =\> 'amperes', 6 =\> 'watts', 7 =\> 'hertz', 8 =\> 'celsius', 9 =\> 'percentRH', 10 =\> 'rpm', 11 =\> 'cmm', 12 =\> 'truthvalue', 13 =\> 'specialEnum', 14 =\> 'dBm', ); my %map\_sensor\_scale = ( 1 =\> -24, # yocto, 2 =\> -21, # zepto 3 =\> -18, # atto 4 =\> -15, # femto 5 =\> -12, # pico 6 =\> -9, # nano 7 =\> -6, # micro 8 =\> -3, # milli 9 =\> 0, #units 10 =\> 3, #kilo 11 =\> 6, #mega 12 =\> 9, #giga 13 =\> 12, #tera 14 =\> 18, #exa 15 =\> 15, #peta 16 =\> 21, #zetta 17 =\> 24, #yotta ); my %perfdata\_unit = ('other' =\> '', 'unknown' =\> '', 'voltsAC' =\> 'V', 'voltsDC' =\> 'V', 'amperes' =\> 'A', 'watts' =\> 'W', 'hertz' =\> 'Hz', 'celsius' =\> 'C', 'percentRH' =\> '%', 'rpm' =\> 'rpm', 'cmm' =\> '', 'truthvalue' =\> '', 'specialEnum' =\> '', 'dBm' =\> 'dBm', ); my $mapping = \{ entPhySensorType =\> \{ oid =\> '.1.3.6.1.2.1.99.1.1.1.1', map =\> \%map\_sensor\_type \}, entPhySensorScale =\> \{ oid =\> '.1.3.6.1.2.1.99.1.1.1.2', map =\> \%map\_sensor\_scale \}, entPhySensorPrecision =\> \{ oid =\> '.1.3.6.1.2.1.99.1.1.1.3' \}, entPhySensorValue =\> \{ oid =\> '.1.3.6.1.2.1.99.1.1.1.4' \}, entPhySensorOperStatus =\> \{ oid =\> '.1.3.6.1.2.1.99.1.1.1.5', map =\> \%map\_sensor\_status \}, \}; my $oid\_entPhySensorEntry = '.1.3.6.1.2.1.99.1.1.1'; sub load \{ my ($self) = @\_; push @\{$self-\>\{request\}\}, \{ oid =\> $oid\_entPhySensorEntry, end =\> $mapping-\>\{entPhySensorOperStatus\}-\>\{oid\} \}; \} sub check \{ my ($self) = @\_; $self-\>\{output\}-\>output\_add(long\_msg =\> "Checking sensors"); $self-\>\{components\}-\>\{sensor\} = \{name =\> 'sensors', total =\> 0, skip =\> 0\}; return if ($self-\>check\_filter(section =\> 'sensor')); my $oid\_entPhysicalName = '.1.3.6.1.2.1.47.1.1.1.1.7'; my $oid\_entPhysicalDescr = '.1.3.6.1.2.1.47.1.1.1.1.2'; foreach my $oid ($self-\>\{snmp\}-\>oid\_lex\_sort(keys %\{$self-\>\{results\}-\>\{$oid\_entPhysicalName\}\})) \{ next if ($oid !~ /^$oid\_entPhysicalName\.(.*)$/); my $instance = $1; my $result = $self-\>\{snmp\}-\>map\_instance(mapping =\> $mapping, results =\> $self-\>\{results\}-\>\{$oid\_entPhySensorEntry\}, instance =\> $instance); next if (!defined($result-\>\{entPhySensorOperStatus\})); next if ($self-\>check\_filter(section =\> 'sensor', instance =\> $result-\>\{entPhySensorType\} . '.' . $instance)); my $name = $self-\>\{results\}-\>\{$oid\_entPhysicalName\}-\>\{$oid\} ne '' ? $self-\>\{results\}-\>\{$oid\_entPhysicalName\}-\>\{$oid\} : $self-\>\{results\}-\>\{$oid\_entPhysicalDescr\}-\>\{$oid\_entPhysicalDescr . '.' . $instance\}; # It seems there is no scale if (!defined($self-\>\{option\_results\}-\>\{sensor\_scale\})) \{ $result-\>\{entPhySensorValue\} = defined($result-\>\{entPhySensorValue\}) ? $result-\>\{entPhySensorValue\} * (10 ** -($result-\>\{entPhySensorPrecision\})) : undef; \} else \{ $result-\>\{entPhySensorValue\} = defined($result-\>\{entPhySensorValue\}) ? $result-\>\{entPhySensorValue\} * (10 ** ($result-\>\{entPhySensorScale\}) * (10 ** -($result-\>\{entPhySensorPrecision\}))) : undef; \} $self-\>\{components\}-\>\{sensor\}-\>\{total\}++; $self-\>\{output\}-\>output\_add( long\_msg =\> sprintf( "sensor '%s' status is '%s' \[instance = %s, value = %s\]", $name, $result-\>\{entPhySensorOperStatus\}, $result-\>\{entPhySensorType\} . '.' . $instance, defined($result-\>\{entPhySensorValue\}) ? $result-\>\{entPhySensorValue\} : '-' ) ); my $exit = $self-\>get\_severity(label =\> 'sensor', section =\> 'sensor.' . $result-\>\{entPhySensorType\}, value =\> $result-\>\{entPhySensorOperStatus\}); if (!$self-\>\{output\}-\>is\_status(value =\> $exit, compare =\> 'ok', litteral =\> 1)) \{ $self-\>\{output\}-\>output\_add(severity =\> $exit, short\_msg =\> sprintf("Sensor '%s' status is '%s'", $name, $result-\>\{entPhySensorOperStatus\})); \} next if (!defined($result-\>\{entPhySensorValue\}) \|\| $result-\>\{entPhySensorValue\} !~ /\[0-9\]/); my $component = 'sensor.' . $result-\>\{entPhySensorType\}; my ($exit2, $warn, $crit, $checked) = $self-\>get\_severity\_numeric(section =\> $component, instance =\> $instance, value =\> $result-\>\{entPhySensorValue\}); if (!$self-\>\{output\}-\>is\_status(value =\> $exit2, compare =\> 'ok', litteral =\> 1)) \{ $self-\>\{output\}-\>output\_add( severity =\> $exit2, short\_msg =\> sprintf( "Sensor '%s/%s' is %s %s", $name, $instance, $result-\>\{entPhySensorValue\}, $perfdata\_unit\{$result-\>\{entPhySensorType\}\} ) ); \} $self-\>\{output\}-\>perfdata\_add( label =\> $component . '\_' . $name, unit =\> $perfdata\_unit\{$result-\>\{entPhySensorType\}\}, value =\> $result-\>\{entPhySensorValue\}, warning =\> $warn, critical =\> $crit ); \} \} 1; | @@ -732,58 +786,98 @@ All available options for each service template are listed below: | Option | Description | |:------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | --filter-counters | Only display some counters (regexp can be used). Example to check SSL connections only : --filter-counters='^xxxx\|yyyy$' | +| --warning-xxx | Warning threshold. | +| --critical-xxx | Critical threshold. | | --warning-* | Warning threshold. Can be: 'connections-current', 'connections-1m', 'connections-5m', 'sessions-total', 'sessions-email-current', 'sessions-email-psec', 'sessions-ipsec-current', 'sessions-ipsec-psec', 'sessions-l2l-current', 'sessions-lb-psec' 'sessions-lb-current', 'sessions-lb-psec', 'sessions-svc-current', 'sessions-svc-psec', 'sessions-webvpn-current', 'sessions-webvpn-psec'. | | --critical-* | Critical threshold. Can be: 'connections-current', 'connections-1m', 'connections-5m', 'sessions-total', 'sessions-email-current', 'sessions-email-psec', 'sessions-ipsec-current', 'sessions-ipsec-psec', 'sessions-l2l-current', 'sessions-lb-psec' 'sessions-lb-current', 'sessions-lb-psec', 'sessions-svc-current', 'sessions-svc-psec', 'sessions-webvpn-current', 'sessions-webvpn-psec'. | -| Option | Description | -|:------------------------------------------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| --filter-counters | Only display some counters (regexp can be used). Example to check SSL connections only : --filter-counters='^xxxx\|yyyy$' | -| --memcached | Memcached server to use (only one server). | -| --redis-server | Redis server to use (only one server). Syntax: address\[:port\] | -| --redis-attribute | Set Redis Options (--redis-attribute="cnx\_timeout=5"). | -| --redis-db | Set Redis database index. | -| --failback-file | Fall back on a local file if Redis connection fails. | -| --memexpiration | Time to keep data in seconds (default: 86400). | -| --statefile-dir | Define the cache directory (default: '/var/lib/centreon/centplugins'). | -| --statefile-suffix | Define a suffix to customize the statefile name (default: ''). | -| --statefile-concat-cwd | If used with the '--statefile-dir' option, the latter's value will be used as a sub-directory of the current working directory. Useful on Windows when the plugin is compiled, as the file system and permissions are different from Linux. | -| --statefile-format | Define the format used to store the cache. Available formats: 'dumper', 'storable', 'json' (default). | -| --statefile-key | Define the key to encrypt/decrypt the cache. | -| --statefile-cipher | Define the cipher algorithm to encrypt the cache (default: 'AES'). | -| --add-global | Check global port statistics (by default if no --add-* option is set). | -| --add-status | Check interface status. | -| --add-duplex-status | Check duplex status (with --warning-status and --critical-status). | -| --add-traffic | Check interface traffic. | -| --add-errors | Check interface errors. | -| --add-cast | Check interface cast. | -| --add-speed | Check interface speed. | -| --add-volume | Check interface data volume between two checks (not supposed to be graphed, useful for BI reporting). | -| --check-metrics | If the expression is true, metrics are checked (default: '%\{opstatus\} eq "up"'). | -| --warning-status | Define the conditions to match for the status to be WARNING. You can use the following variables: %\{admstatus\}, %\{opstatus\}, %\{duplexstatus\}, %\{display\} | -| --critical-status | Define the conditions to match for the status to be CRITICAL (default: '%\{admstatus\} eq "up" and %\{opstatus\} ne "up"'). You can use the following variables: %\{admstatus\}, %\{opstatus\}, %\{duplexstatus\}, %\{display\} | -| --warning-* --critical-* | Thresholds. Can be: 'total-port', 'total-admin-up', 'total-admin-down', 'total-oper-up', 'total-oper-down', 'in-traffic', 'out-traffic', 'in-error', 'in-discard', 'out-error', 'out-discard', 'in-ucast', 'in-bcast', 'in-mcast', 'out-ucast', 'out-bcast', 'out-mcast', 'speed' (b/s). | -| --units-traffic | Units of thresholds for the traffic (default: 'percent\_delta') ('percent\_delta', 'bps', 'counter'). | -| --units-errors | Units of thresholds for errors/discards (default: 'percent\_delta') ('percent\_delta', 'percent', 'delta', 'deltaps', 'counter'). | -| --units-cast | Units of thresholds for communication types (default: 'percent\_delta') ('percent\_delta', 'percent', 'delta', 'deltaps', 'counter'). | -| --nagvis-perfdata | Display traffic perfdata to be compatible with NagVis widget. | -| --interface | Check only the interfaces with the specified IDs (OID indexes, e.g.: 1,2,...). If empty, all interfaces will be monitored. To filter on interface names, see --name. | -| --name | With this option, the interfaces will be filtered by name (given in option --interface) instead of OID index. The name matching mode supports regular expressions. | -| --regex-id | With this option, interface IDs will be filtered using the --interface parameter as a regular expression instead of a list of IDs. | -| --speed | Set interface speed for incoming/outgoing traffic (in Mb). | -| --speed-in | Set interface speed for incoming traffic (in Mb). | -| --speed-out | Set interface speed for outgoing traffic (in Mb). | -| --map-speed-dsl | Get interface speed configuration for interfaces of type 'ADSL' and 'VDSL2'. Syntax: --map-speed-dsl=interface-src-name,interface-dsl-name E.g: --map-speed-dsl=Et0.835,Et0-vdsl2 | -| --force-counters64 | Force to use 64 bits counters only. Can be used to improve performance. | -| --force-counters32 | Force to use 32-bit counters (even with SNMP versions 2c and 3). To use when 64 bits counters are buggy. | -| --reload-cache-time | Time in minutes before reloading cache file (default: 180). | -| --oid-filter | Define the OID to be used to filter interfaces (default: ifName) (values: ifDesc, ifAlias, ifName, IpAddr). | -| --oid-display | Define the OID that will be used to name the interfaces (default: ifName) (values: ifDesc, ifAlias, ifName, IpAddr). | -| --oid-extra-display | Add an OID to display. | -| --display-transform-src --display-transform-dst | Modify the interface name displayed by using a regular expression. Example: adding --display-transform-src='eth' --display-transform-dst='ens' will replace all occurrences of 'eth' with 'ens' | -| --show-cache | Display cache interface data. | +| Option | Description | +|:------------------------------------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| --filter-counters | Only display some counters (regexp can be used). Example to check SSL connections only : --filter-counters='^xxxx\|yyyy$' | +| --warning-xxx | Warning threshold. | +| --critical-xxx | Critical threshold. | +| --memcached | Memcached server to use (only one server). | +| --redis-server | Redis server to use (only one server). Syntax: address\[:port\] | +| --redis-attribute | Set Redis Options (--redis-attribute="cnx\_timeout=5"). | +| --redis-db | Set Redis database index. | +| --failback-file | Fall back on a local file if Redis connection fails. | +| --memexpiration | Time to keep data in seconds (default: 86400). | +| --statefile-dir | Define the cache directory (default: '/var/lib/centreon/centplugins'). | +| --statefile-suffix | Define a suffix to customize the statefile name (default: ''). | +| --statefile-concat-cwd | If used with the '--statefile-dir' option, the latter's value will be used as a sub-directory of the current working directory. Useful on Windows when the plugin is compiled, as the file system and permissions are different from Linux. | +| --statefile-format | Define the format used to store the cache. Available formats: 'dumper', 'storable', 'json' (default). | +| --statefile-key | Define the key to encrypt/decrypt the cache. | +| --statefile-cipher | Define the cipher algorithm to encrypt the cache (default: 'AES'). | +| --add-global | Check global port statistics (by default if no --add-* option is set). | +| --add-status | Check interface status. | +| --add-duplex-status | Check duplex status (with --warning-status and --critical-status). | +| --add-traffic | Check interface traffic. | +| --add-errors | Check interface errors. | +| --add-cast | Check interface cast. | +| --add-speed | Check interface speed. | +| --add-volume | Check interface data volume between two checks (not supposed to be graphed, useful for BI reporting). | +| --check-metrics | If the expression is true, metrics are checked (default: '%\{opstatus\} eq "up"'). | +| --warning-status | Define the conditions to match for the status to be WARNING. You can use the following variables: %\{admstatus\}, %\{opstatus\}, %\{duplexstatus\}, %\{display\} | +| --critical-status | Define the conditions to match for the status to be CRITICAL (default: '%\{admstatus\} eq "up" and %\{opstatus\} ne "up"'). You can use the following variables: %\{admstatus\}, %\{opstatus\}, %\{duplexstatus\}, %\{display\} | +| --warning-total-port | Thresholds. | +| --critical-total-port | Thresholds. | +| --warning-total-admin-up | Thresholds. | +| --critical-total-admin-up | Thresholds. | +| --warning-total-admin-down | Thresholds. | +| --critical-total-admin-down | Thresholds. | +| --warning-total-oper-up | Thresholds. | +| --critical-total-oper-up | Thresholds. | +| --warning-total-oper-down | Thresholds. | +| --critical-total-oper-down | Thresholds. | +| --warning-in-traffic | Thresholds. | +| --critical-in-traffic | Thresholds. | +| --warning-out-traffic | Thresholds. | +| --critical-out-traffic | Thresholds. | +| --warning-in-error | Thresholds. | +| --critical-in-error | Thresholds. | +| --warning-in-discard | Thresholds. | +| --critical-in-discard | Thresholds. | +| --warning-out-error | Thresholds. | +| --critical-out-error | Thresholds. | +| --warning-out-discard | Thresholds. | +| --critical-out-discard | Thresholds. | +| --warning-in-ucast | Thresholds. | +| --critical-in-ucast | Thresholds. | +| --warning-in-bcast | Thresholds. | +| --critical-in-bcast | Thresholds. | +| --warning-in-mcast | Thresholds. | +| --critical-in-mcast | Thresholds. | +| --warning-out-ucast | Thresholds. | +| --critical-out-ucast | Thresholds. | +| --warning-out-bcast | Thresholds. | +| --critical-out-bcast | Thresholds. | +| --warning-out-mcast | Thresholds. | +| --critical-out-mcast | Thresholds. | +| --warning-speed | Thresholds in b/s. | +| --critical-speed | Thresholds in b/s. | +| --units-traffic | Units of thresholds for the traffic (default: 'percent\_delta') ('percent\_delta', 'bps', 'counter'). | +| --units-errors | Units of thresholds for errors/discards (default: 'percent\_delta') ('percent\_delta', 'delta', 'deltaps', 'counter'). | +| --units-cast | Units of thresholds for communication types (default: 'percent\_delta') ('percent\_delta', 'percent', 'delta', 'deltaps', 'counter'). | +| --nagvis-perfdata | Display traffic perfdata to be compatible with NagVis widget. | +| --interface | Check only the interfaces with the specified IDs (OID indexes, e.g.: 1,2,...). If empty, all interfaces will be monitored. To filter on interface names, see --name. | +| --name | With this option, the interfaces will be filtered by name (given in option --interface) instead of OID index. The name matching mode supports regular expressions. | +| --regex-id | With this option, interface IDs will be filtered using the --interface parameter as a regular expression instead of a list of IDs. | +| --speed | Set interface speed for incoming/outgoing traffic (in Mb). | +| --speed-in | Set interface speed for incoming traffic (in Mb). | +| --speed-out | Set interface speed for outgoing traffic (in Mb). | +| --map-speed-dsl | Get interface speed configuration for interfaces of type 'ADSL' and 'VDSL2'. Syntax: --map-speed-dsl=interface-src-name,interface-dsl-name E.g: --map-speed-dsl=Et0.835,Et0-vdsl2 | +| --force-counters64 | Force to use 64 bits counters only. Can be used to improve performance. | +| --force-counters32 | Force to use 32-bit counters (even with SNMP versions 2c and 3). To use when 64 bits counters are buggy. | +| --reload-cache-time | Time in minutes before reloading cache file (default: 180). | +| --oid-filter | Define the OID to be used to filter interfaces (default: ifName) (values: ifDesc, ifAlias, ifName, IpAddr). | +| --oid-display | Define the OID that will be used to name the interfaces (default: ifName) (values: ifDesc, ifAlias, ifName, IpAddr). | +| --oid-extra-display | Add an OID to display. | +| --display-transform-src --display-transform-dst | Modify the interface name displayed by using a regular expression. Example: adding --display-transform-src='eth' --display-transform-dst='ens' will replace all occurrences of 'eth' with 'ens' | +| --show-cache | Display cache interface data. | +| --no-cache-lock | Set to disable locking when accessing cache. | diff --git a/pp/integrations/plugin-packs/procedures/network-firewalls-pfsense-snmp.md b/pp/integrations/plugin-packs/procedures/network-firewalls-pfsense-snmp.md index 2a62031cea0e..e6ba166e2d9c 100644 --- a/pp/integrations/plugin-packs/procedures/network-firewalls-pfsense-snmp.md +++ b/pp/integrations/plugin-packs/procedures/network-firewalls-pfsense-snmp.md @@ -60,9 +60,9 @@ The connector brings the following service templates (sorted by the host templat #### Host discovery -| Rule name | Description | -|:----------------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| SNMP Agents | Discover your resources through an SNMP subnet scan. You need to install the [Generic SNMP](./applications-protocol-snmp.md) connector to get the discovery rule and create a template mapper for the **Net-FW-Pfsense-SNMP-custom** host template. | +| Rule name | Description | +|:------------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| SNMP Agents | Discover your resources through an SNMP subnet scan. You need to install the [Generic SNMP](./applications-protocol-snmp.md) connector to get the discovery rule and create a template mapper for the **Net-FW-Pfsense-SNMP-custom** host template. | More information about discovering hosts automatically is available on the [dedicated page](/docs/monitoring/discovery/hosts-discovery). @@ -82,69 +82,69 @@ Here is the list of services for this connector, detailing all metrics and statu -| Name | Unit | -|:--------------------------------|:------| -| packets.matched.persecond | /s | -| packets.badoffset.persecond | /s | -| packets.fragmented.persecond | /s | -| packets.short.persecond | /s | -| packets.normalized.persecond | /s | -| packets.memorydropped.persecond | /s | +| Name | Unit | +|:--------------------------------|:-----| +| packets.matched.persecond | /s | +| packets.badoffset.persecond | /s | +| packets.fragmented.persecond | /s | +| packets.short.persecond | /s | +| packets.normalized.persecond | /s | +| packets.memorydropped.persecond | /s | > To obtain this new metric format, include **--use-new-perfdata** in the **EXTRAOPTIONS** service macro. -| Name | Unit | -|:----------------------------------------------------|:------| -| *pfint*#pfinterface.pass.traffic.in.bitspersecond | b/s | -| *pfint*#pfinterface.pass.traffic.out.bitspersecond | b/s | -| *pfint*#pfinterface.block.traffic.in.bitspersecond | b/s | -| *pfint*#pfinterface.block.traffic.out.bitspersecond | b/s | +| Name | Unit | +|:----------------------------------------------------|:-----| +| *pfint*#pfinterface.pass.traffic.in.bitspersecond | b/s | +| *pfint*#pfinterface.pass.traffic.out.bitspersecond | b/s | +| *pfint*#pfinterface.block.traffic.in.bitspersecond | b/s | +| *pfint*#pfinterface.block.traffic.out.bitspersecond | b/s | > To obtain this new metric format, include **--use-new-perfdata** in the **EXTRAOPTIONS** service macro. -| Name | Unit | -|:-------------------------------------------|:------| -| cpu.utilization.percentage | % | -| *cpu_core*#core.cpu.utilization.percentage | % | +| Name | Unit | +|:-------------------------------------------|:-----| +| cpu.utilization.percentage | % | +| *cpu_core*#core.cpu.utilization.percentage | % | > To obtain this new metric format, include **--use-new-perfdata** in the **EXTRAOPTIONS** service macro. -| Name | Unit | -|:-------------------------------------|:------| -| cpu.user.utilization.percentage | % | -| cpu.nice.utilization.percentage | % | -| cpu.system.utilization.percentage | % | -| cpu.idle.utilization.percentage | % | -| cpu.wait.utilization.percentage | % | -| cpu.kernel.utilization.percentage | % | -| cpu.interrupt.utilization.percentage | % | -| cpu.softirq.utilization.percentage | % | -| cpu.steal.utilization.percentage | % | -| cpu.guest.utilization.percentage | % | -| cpu.guestnice.utilization.percentage | % | +| Name | Unit | +|:-------------------------------------|:-----| +| cpu.user.utilization.percentage | % | +| cpu.nice.utilization.percentage | % | +| cpu.system.utilization.percentage | % | +| cpu.idle.utilization.percentage | % | +| cpu.wait.utilization.percentage | % | +| cpu.kernel.utilization.percentage | % | +| cpu.interrupt.utilization.percentage | % | +| cpu.softirq.utilization.percentage | % | +| cpu.steal.utilization.percentage | % | +| cpu.guest.utilization.percentage | % | +| cpu.guestnice.utilization.percentage | % | > To obtain this new metric format, include **--use-new-perfdata** in the **EXTRAOPTIONS** service macro. -| Name | Unit | -|:--------------------------------|:------| -| packets.matched.persecond | /s | -| packets.badoffset.persecond | /s | -| packets.fragmented.persecond | /s | -| packets.short.persecond | /s | -| packets.normalized.persecond | /s | -| packets.memorydropped.persecond | /s | +| Name | Unit | +|:--------------------------------|:-----| +| packets.matched.persecond | /s | +| packets.badoffset.persecond | /s | +| packets.fragmented.persecond | /s | +| packets.short.persecond | /s | +| packets.normalized.persecond | /s | +| packets.memorydropped.persecond | /s | > To obtain this new metric format, include **--use-new-perfdata** in the **EXTRAOPTIONS** service macro. @@ -163,92 +163,92 @@ Here is the list of services for this connector, detailing all metrics and statu -| Name | Unit | -|:--------------------------------|:------| -| packets.matched.persecond | /s | -| packets.badoffset.persecond | /s | -| packets.fragmented.persecond | /s | -| packets.short.persecond | /s | -| packets.normalized.persecond | /s | -| packets.memorydropped.persecond | /s | +| Name | Unit | +|:--------------------------------|:-----| +| packets.matched.persecond | /s | +| packets.badoffset.persecond | /s | +| packets.fragmented.persecond | /s | +| packets.short.persecond | /s | +| packets.normalized.persecond | /s | +| packets.memorydropped.persecond | /s | > To obtain this new metric format, include **--use-new-perfdata** in the **EXTRAOPTIONS** service macro. -| Name | Unit | -|:--------------------|:------| -| memory.cached.bytes | B | -| memory.usage.bytes | B | -| swap.usage.bytes | B | +| Name | Unit | +|:--------------------|:-----| +| memory.cached.bytes | B | +| memory.usage.bytes | B | +| swap.usage.bytes | B | -| Name | Unit | -|:--------------------------------|:------| -| packets.matched.persecond | /s | -| packets.badoffset.persecond | /s | -| packets.fragmented.persecond | /s | -| packets.short.persecond | /s | -| packets.normalized.persecond | /s | -| packets.memorydropped.persecond | /s | +| Name | Unit | +|:--------------------------------|:-----| +| packets.matched.persecond | /s | +| packets.badoffset.persecond | /s | +| packets.fragmented.persecond | /s | +| packets.short.persecond | /s | +| packets.normalized.persecond | /s | +| packets.memorydropped.persecond | /s | > To obtain this new metric format, include **--use-new-perfdata** in the **EXTRAOPTIONS** service macro. -| Name | Unit | -|:--------------------------------|:------| -| packets.matched.persecond | /s | -| packets.badoffset.persecond | /s | -| packets.fragmented.persecond | /s | -| packets.short.persecond | /s | -| packets.normalized.persecond | /s | -| packets.memorydropped.persecond | /s | +| Name | Unit | +|:--------------------------------|:-----| +| packets.matched.persecond | /s | +| packets.badoffset.persecond | /s | +| packets.fragmented.persecond | /s | +| packets.short.persecond | /s | +| packets.normalized.persecond | /s | +| packets.memorydropped.persecond | /s | > To obtain this new metric format, include **--use-new-perfdata** in the **EXTRAOPTIONS** service macro. -| Name | Unit | -|:--------|:------| -| runtime | s | +| Name | Unit | +|:--------|:-----| +| runtime | s | -| Name | Unit | -|:--------------------------------|:------| -| packets.matched.persecond | /s | -| packets.badoffset.persecond | /s | -| packets.fragmented.persecond | /s | -| packets.short.persecond | /s | -| packets.normalized.persecond | /s | -| packets.memorydropped.persecond | /s | +| Name | Unit | +|:--------------------------------|:-----| +| packets.matched.persecond | /s | +| packets.badoffset.persecond | /s | +| packets.fragmented.persecond | /s | +| packets.short.persecond | /s | +| packets.normalized.persecond | /s | +| packets.memorydropped.persecond | /s | > To obtain this new metric format, include **--use-new-perfdata** in the **EXTRAOPTIONS** service macro. -| Name | Unit | -|:----------------------|:------| -| swap.usage.bytes | B | -| swap.free.bytes | B | -| swap.usage.percentage | % | +| Name | Unit | +|:----------------------|:-----| +| swap.usage.bytes | B | +| swap.free.bytes | B | +| swap.usage.percentage | % | > To obtain this new metric format, include **--use-new-perfdata** in the **EXTRAOPTIONS** service macro. -| Name | Unit | -|:----------------------|:------| -| system.uptime.seconds | s | +| Name | Unit | +|:----------------------|:-----| +| system.uptime.seconds | s | > To obtain this new metric format, include **--use-new-perfdata** in the **EXTRAOPTIONS** service macro. @@ -259,9 +259,10 @@ Here is the list of services for this connector, detailing all metrics and statu ### pfSense firewall configuration -To use this pack, the SNMP service must be properly configured on your -pfSense firewall. Netgate provides an official documentation -to achieve this: https://docs.netgate.com/pfsense/en/latest/services/snmp.html +The SNMP agent must be enabled and configured on the resource. +Please refer to the official [documentation](https://docs.netgate.com/pfsense/en/latest/services/snmp.html). +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 @@ -272,6 +273,8 @@ port. ### Pack +The installation procedures for monitoring connectors are slightly different depending on [whether your license is offline or online](../getting-started/how-to-guides/connectors-licenses.md). + 1. 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 > Connectors > Monitoring Connectors** menu. @@ -362,14 +365,16 @@ yum install centreon-plugin-Network-Firewalls-Pfsense-Snmp 1. Log into Centreon and add a new host through **Configuration > Hosts**. 2. Fill in the **Name**, **Alias** & **IP Address/DNS** fields according to your resource's settings. -3. Apply the **Net-FW-Pfsense-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](../getting-started/how-to-guides/troubleshooting-plugins.md#snmpv3-options-mapping) section. +3. Apply the **Net-FW-Pfsense-SNMP-custom** template to the host. -| 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](#available-options). | | | +| Macro | Description | Default value | Mandatory | +|:------------------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------|:--------------|:---------:| +| SNMP_V3_USERNAME | SNMP v3 only: User name (`securityName`) | | | +| SNMP_V3_AUTH_PROTOCOL | SNMP v3 only: Authentication protocol: MD5\|SHA. Since net-snmp 5.9.1: SHA224\|SHA256\|SHA384\|SHA512 | | | +| SNMP_V3_PRIV_PROTOCOL | 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 | | | +| SNMP_V3_AUTH_PASSPHRASE | SNMP v3 only: Pass phrase hashed using the authentication protocol defined in the --authprotocol option | | | +| SNMP_V3_PRIV_PASSPHRASE | SNMP v3 only: Privacy pass phrase (`privPassword`) to encrypt messages using the protocol defined in the --privprotocol option | | | +| SNMPEXTRAOPTIONS | Any extra option you may want to add to every command (a --verbose flag for example). All options are listed [here](#available-options). | | | 4. [Deploy the configuration](/docs/monitoring/monitoring-servers/deploying-a-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. @@ -381,132 +386,132 @@ yum install centreon-plugin-Network-Firewalls-Pfsense-Snmp -| Macro | Description | Default value | Mandatory | -|:-------------|:---------------------------------------------------------------------------------------------------------------------------------------|:--------------|:---------:| -| WARNING | Threshold | | | -| CRITICAL | Threshold | | | -| EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). All options are listed [here](#available-options). | | | +| Macro | Description | Default value | Mandatory | +|:-------------|:-------------------------------------------------------------------------------------------------------------------------------------------------|:--------------|:---------:| +| WARNING | Threshold | | | +| CRITICAL | Threshold | | | +| EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). All options are listed [here](#available-options). | | | -| Macro | Description | Default value | Mandatory | -|:-----------------|:---------------------------------------------------------------------------------------------------------------------------------------|:--------------|:---------:| -| FILTERNAME | Filter by interface name (can be a regexp) | em.* | | -| WARNINGBLOCKIN | Threshold | | | -| CRITICALBLOCKIN | Threshold | | | -| WARNINGBLOCKOUT | Threshold | | | -| CRITICALBLOCKOUT | Threshold | | | -| EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). All options are listed [here](#available-options). | | | +| Macro | Description | Default value | Mandatory | +|:-----------------|:-------------------------------------------------------------------------------------------------------------------------------------------------|:--------------|:---------:| +| FILTERNAME | Filter by interface name (can be a regexp) | em.* | | +| WARNINGBLOCKIN | Threshold | | | +| CRITICALBLOCKIN | Threshold | | | +| WARNINGBLOCKOUT | Threshold | | | +| CRITICALBLOCKOUT | Threshold | | | +| EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). All options are listed [here](#available-options). | | | -| Macro | Description | Default value | Mandatory | -|:-------------|:---------------------------------------------------------------------------------------------------------------------------------------|:--------------|:---------:| -| WARNING | Warning threshold average CPU utilization | 80 | | -| CRITICAL | Critical threshold average CPU utilization | 90 | | -| EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). All options are listed [here](#available-options). | | | +| Macro | Description | Default value | Mandatory | +|:-------------|:-------------------------------------------------------------------------------------------------------------------------------------------------|:--------------|:---------:| +| WARNING | Warning threshold average CPU utilization | 80 | | +| CRITICAL | Critical threshold average CPU utilization | 90 | | +| EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). All options are listed [here](#available-options). | | | -| Macro | Description | Default value | Mandatory | -|:-------------|:---------------------------------------------------------------------------------------------------------------------------------------|:--------------|:---------:| -| WARNINGIDLE | Threshold in percentage | 20: | | -| CRITICALIDLE | Threshold in percentage | 10: | | -| EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). All options are listed [here](#available-options). | --verbose | | +| Macro | Description | Default value | Mandatory | +|:-------------|:-------------------------------------------------------------------------------------------------------------------------------------------------|:--------------|:---------:| +| WARNINGIDLE | Threshold in percentage | 20: | | +| CRITICALIDLE | Threshold in percentage | 10: | | +| EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). All options are listed [here](#available-options). | --verbose | | -| Macro | Description | Default value | Mandatory | -|:-------------|:---------------------------------------------------------------------------------------------------------------------------------------|:--------------|:---------:| -| WARNING | Threshold | | | -| CRITICAL | Threshold | | | -| EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). All options are listed [here](#available-options). | | | +| Macro | Description | Default value | Mandatory | +|:-------------|:-------------------------------------------------------------------------------------------------------------------------------------------------|:--------------|:---------:| +| WARNING | Threshold | | | +| CRITICAL | Threshold | | | +| EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). All options are listed [here](#available-options). | | | -| Macro | Description | Default value | Mandatory | -|:-------------|:---------------------------------------------------------------------------------------------------------------------------------------|:--------------|:---------:| -| WARNING | Warning threshold (1min,5min,15min) | 4,3,2 | | -| CRITICAL | Critical threshold (1min,5min,15min) | 6,5,4 | | -| EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). All options are listed [here](#available-options). | | | +| Macro | Description | Default value | Mandatory | +|:-------------|:-------------------------------------------------------------------------------------------------------------------------------------------------|:--------------|:---------:| +| WARNING | Warning threshold (1min,5min,15min) | 4,3,2 | | +| CRITICAL | Critical threshold (1min,5min,15min) | 6,5,4 | | +| EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). All options are listed [here](#available-options). | | | -| Macro | Description | Default value | Mandatory | -|:-------------|:---------------------------------------------------------------------------------------------------------------------------------------|:--------------|:---------:| -| WARNING | Threshold | | | -| CRITICAL | Threshold | | | -| EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). All options are listed [here](#available-options). | | | +| Macro | Description | Default value | Mandatory | +|:-------------|:-------------------------------------------------------------------------------------------------------------------------------------------------|:--------------|:---------:| +| WARNING | Threshold | | | +| CRITICAL | Threshold | | | +| EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). All options are listed [here](#available-options). | | | -| Macro | Description | Default value | Mandatory | -|:-------------|:---------------------------------------------------------------------------------------------------------------------------------------|:--------------|:---------:| -| WARNING | Warning threshold in percent | 80 | | -| CRITICAL | Critical threshold in percent | 90 | | -| EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). All options are listed [here](#available-options). | | | +| Macro | Description | Default value | Mandatory | +|:-------------|:-------------------------------------------------------------------------------------------------------------------------------------------------|:--------------|:---------:| +| WARNING | Warning threshold in percent | 80 | | +| CRITICAL | Critical threshold in percent | 90 | | +| EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). All options are listed [here](#available-options). | | | -| Macro | Description | Default value | Mandatory | -|:-------------|:---------------------------------------------------------------------------------------------------------------------------------------|:--------------|:---------:| -| WARNING | Threshold | | | -| CRITICAL | Threshold | | | -| EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). All options are listed [here](#available-options). | | | +| Macro | Description | Default value | Mandatory | +|:-------------|:-------------------------------------------------------------------------------------------------------------------------------------------------|:--------------|:---------:| +| WARNING | Threshold | | | +| CRITICAL | Threshold | | | +| EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). All options are listed [here](#available-options). | | | -| Macro | Description | Default value | Mandatory | -|:-------------|:---------------------------------------------------------------------------------------------------------------------------------------|:--------------|:---------:| -| WARNING | Threshold | | | -| CRITICAL | Threshold | | | -| EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). All options are listed [here](#available-options). | | | +| Macro | Description | Default value | Mandatory | +|:-------------|:-------------------------------------------------------------------------------------------------------------------------------------------------|:--------------|:---------:| +| WARNING | Threshold | | | +| CRITICAL | Threshold | | | +| EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). All options are listed [here](#available-options). | | | -| Macro | Description | Default value | Mandatory | -|:-------------|:---------------------------------------------------------------------------------------------------------------------------------------|:--------------|:---------:| -| WARNING | Warning threshold in seconds | | | -| CRITICAL | Critical threshold in seconds | | | -| EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). All options are listed [here](#available-options). | | | +| Macro | Description | Default value | Mandatory | +|:-------------|:-------------------------------------------------------------------------------------------------------------------------------------------------|:--------------|:---------:| +| WARNING | Warning threshold in seconds | | | +| CRITICAL | Critical threshold in seconds | | | +| EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). All options are listed [here](#available-options). | | | -| Macro | Description | Default value | Mandatory | -|:-------------|:---------------------------------------------------------------------------------------------------------------------------------------|:--------------|:---------:| -| WARNING | Threshold | | | -| CRITICAL | Threshold | | | -| EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). All options are listed [here](#available-options). | | | +| Macro | Description | Default value | Mandatory | +|:-------------|:-------------------------------------------------------------------------------------------------------------------------------------------------|:--------------|:---------:| +| WARNING | Threshold | | | +| CRITICAL | Threshold | | | +| EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). All options are listed [here](#available-options). | | | -| Macro | Description | Default value | Mandatory | -|:-------------|:---------------------------------------------------------------------------------------------------------------------------------------|:--------------|:---------:| -| WARNING | Threshold in percentage | 10 | | -| CRITICAL | Threshold in percentage | 30 | | -| EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). All options are listed [here](#available-options). | | | +| Macro | Description | Default value | Mandatory | +|:-------------|:-------------------------------------------------------------------------------------------------------------------------------------------------|:--------------|:---------:| +| WARNING | Threshold in percentage | 10 | | +| CRITICAL | Threshold in percentage | 30 | | +| EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). All options are listed [here](#available-options). | | | -| Macro | Description | Default value | Mandatory | -|:-------------|:---------------------------------------------------------------------------------------------------------------------------------------------|:-----------------|:---------:| -| UNIT | Select the time unit for thresholds. May be 's' for seconds, 'm' for minutes, 'h' for hours, 'd' for days, 'w' for weeks. Default is seconds | | | -| WARNING | Warning threshold | | | -| CRITICAL | Critical threshold | | | -| EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). All options are listed [here](#available-options). | --check-overload | | +| Macro | Description | Default value | Mandatory | +|:-------------|:-------------------------------------------------------------------------------------------------------------------------------------------------|:-----------------|:---------:| +| UNIT | Select the time unit for thresholds. May be 's' for seconds, 'm' for minutes, 'h' for hours, 'd' for days, 'w' for weeks. Default is seconds | | | +| WARNING | Warning threshold | | | +| CRITICAL | Critical threshold | | | +| EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). All options are listed [here](#available-options). | --check-overload | | @@ -525,16 +530,21 @@ is able to monitor a resource using a command like this one (replace the sample --mode=packet-stats \ --hostname=10.0.0.1 \ --snmp-version='2c' \ - --snmp-community='my-snmp-community' \ - --filter-counters=badoffset \ - --warning-badoffset='' \ - --critical-badoffset='' + --snmp-community='my-snmp-community' \ + --snmp-username='username' \ + --authpassphrase='' \ + --authprotocol='' \ + --privpassphrase='' \ + --privprotocol='' \ + --filter-counters=short \ + --warning-short='' \ + --critical-short='' ``` The expected command output is shown below: ```bash -OK: Packets Matched Filter Rule : 6/s Bad Offset Packets : 97/s Fragmented Packets : 98/s Short Packets : 25/s Normalized Packets : 79/s Dropped Packets Due To Memory : 51/s | 'packets.matched.persecond'=6/s;;;0;'packets.badoffset.persecond'=97/s;;;0;'packets.fragmented.persecond'=98/s;;;0;'packets.short.persecond'=25/s;;;0;'packets.normalized.persecond'=79/s;;;0;'packets.memorydropped.persecond'=51/s;;;0; +OK: Packets Matched Filter Rule : 29919/s Bad Offset Packets : 62865/s Fragmented Packets : 40117/s Short Packets : 92041/s Normalized Packets : 36172/s Dropped Packets Due To Memory : 34119/s | 'packets.matched.persecond'=29919/s;;;0; 'packets.badoffset.persecond'=62865/s;;;0; 'packets.fragmented.persecond'=40117/s;;;0; 'packets.short.persecond'=92041/s;;;0; 'packets.normalized.persecond'=36172/s;;;0; 'packets.memorydropped.persecond'=34119/s;;;0; ``` ### Troubleshooting @@ -580,66 +590,67 @@ The plugin brings the following modes: 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 ok, 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\[,\[\\],\[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\[,\[\\],\[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\[,\[\\],\[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,\,calculation\[,\[\\],\[min\],\[max\]\] regex: regular expression \: 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 \ (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~replacement~modifier Most commonly used modifiers are i (case insensitive) and g (replace all occurrences). Example: adding --change-short-output='OK\~Up\~gi' will replace all occurrences of 'OK', 'ok', 'Ok' or 'oK' with 'Up' | -| --change-short-output | Modify the short/long output that is returned by the plugin. Syntax: --change-short-output=pattern~replacement~modifier Most commonly used modifiers are i (case insensitive) and g (replace all occurrences). Example: adding --change-short-output='OK\~Up\~gi' will replace all occurrences of 'OK', 'ok', 'Ok' or 'oK' with 'Up' | -| --change-long-output | Modify the short/long output that is returned by the plugin. Syntax: --change-short-output=pattern~replacement~modifier Most commonly used modifiers are i (case insensitive) and g (replace all occurrences). Example: adding --change-short-output='OK\~Up\~gi' will replace all occurrences of 'OK', 'ok', 'Ok' or 'oK' with 'Up' | -| --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\. =cut | +| 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 get-next 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 ok, 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. | +| --show-password | By default, sensitive information in command lines is hidden in debug output and replaced with `***` (however, debug logs may still display sensitive information). Using the C option will display the passwords in plain text. | +| --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\[,\[\\],\[min\],\[max\]\] Common examples: onvert 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\[,\[\\],\[min\],\[max\]\] Common examples: onvert 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\[,\[\\],\[min\],\[max\]\] Common examples: onvert 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,\,calculation\[,\[\\],\[min\],\[max\]\] regex: regular expression \: 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 \ (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: um 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~replacement~modifier Most commonly used modifiers are i (case insensitive) and g (replace all occurrences). Example: adding --change-short-output='OK~Up~gi' will replace all occurrences of 'OK', 'ok', 'Ok' or 'oK' with 'Up' | +| --change-short-output | Modify the short/long output that is returned by the plugin. Syntax: --change-short-output=pattern~replacement~modifier Most commonly used modifiers are i (case insensitive) and g (replace all occurrences). Example: adding --change-short-output='OK~Up~gi' will replace all occurrences of 'OK', 'ok', 'Ok' or 'oK' with 'Up' | +| --change-long-output | Modify the short/long output that is returned by the plugin. Syntax: --change-short-output=pattern~replacement~modifier Most commonly used modifiers are i (case insensitive) and g (replace all occurrences). Example: adding --change-short-output='OK~Up~gi' will replace all occurrences of 'OK', 'ok', 'Ok' or 'oK' with 'Up' | +| --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'. \. | #### Modes options @@ -648,176 +659,198 @@ All available options for each service template are listed below: -| Option | Description | -|:------------------|:----------------------------------------------------------------------------------------------------| -| --filter-counters | Only display some counters (regexp can be used). Example: --filter-counters='^match$' | -| --warning-* | Warning threshold. Can be: 'match', 'badoffset', 'fragment', 'short', 'normalize', 'memdrop'. | -| --critical-* | Critical threshold. Can be: 'match', 'badoffset', 'fragment', 'short', 'normalize', 'memdrop'. | +| Option | Description | +|:------------------|:-----------------------------------------------------------------------------------------------| +| --filter-counters | Only display some counters (regexp can be used). Example: --filter-counters='^match$' | +| --warning-xxx | Warning threshold. | +| --critical-xxx | Critical threshold. | +| --warning-* | Warning threshold. Can be: 'match', 'badoffset', 'fragment', 'short', 'normalize', 'memdrop'. | +| --critical-* | Critical threshold. Can be: 'match', 'badoffset', 'fragment', 'short', 'normalize', 'memdrop'. | -| Option | Description | -|:------------------|:------------------------------------------------------------------------------------------------------------------------------| -| --filter-counters | Only display some counters (regexp can be used). Example to check SSL connections only : --filter-counters='^xxxx\|yyyy$' | -| --warning-* | Warning threshold. Can be: 'traffic-in-pass', 'traffic-out-pass', 'traffic-in-block', 'traffic-out-block'. | -| --critical-* | Critical threshold. Can be: 'traffic-in-pass', 'traffic-out-pass', 'traffic-in-block', 'traffic-out-block'. | -| --filter-name | Filter by interface name (can be a regexp). | +| Option | Description | +|:------------------|:--------------------------------------------------------------------------------------------------------------------------| +| --filter-counters | Only display some counters (regexp can be used). Example to check SSL connections only : --filter-counters='^xxxx\|yyyy$' | +| --warning-xxx | Warning threshold. | +| --critical-xxx | Critical threshold. | +| --warning-* | Warning threshold. Can be: 'traffic-in-pass', 'traffic-out-pass', 'traffic-in-block', 'traffic-out-block'. | +| --critical-* | Critical threshold. Can be: 'traffic-in-pass', 'traffic-out-pass', 'traffic-in-block', 'traffic-out-block'. | +| --filter-name | Filter by interface name (can be a regexp). | -| Option | Description | -|:-------------------|:------------------------------------------------------------------------------------------------------------------------------| -| --filter-counters | Only display some counters (regexp can be used). Example to check SSL connections only : --filter-counters='^xxxx\|yyyy$' | -| --use-ucd | Use UCD MIB for CPU average. | -| --warning-average | Warning threshold average CPU utilization. | -| --critical-average | Critical threshold average CPU utilization. | -| --warning-core | Warning thresholds for each CPU core | -| --critical-core | Critical thresholds for each CPU core | +| Option | Description | +|:-------------------|:--------------------------------------------------------------------------------------------------------------------------| +| --filter-counters | Only display some counters (regexp can be used). Example to check SSL connections only : --filter-counters='^xxxx\|yyyy$' | +| --warning-xxx | Warning threshold. | +| --critical-xxx | Critical threshold. | +| --use-ucd | Use UCD MIB for CPU average. | +| --warning-average | Warning threshold average CPU utilization. | +| --critical-average | Critical threshold average CPU utilization. | +| --warning-core | Warning thresholds for each CPU core | +| --critical-core | Critical thresholds for each CPU core | -| Option | Description | -|:---------------------|:------------------------------------------------------------------------------------------------------------------------------| -| --filter-counters | Only display some counters (regexp can be used). Example to check SSL connections only : --filter-counters='^xxxx\|yyyy$' | -| --warning-guest | Threshold in percentage. | -| --critical-guest | Threshold in percentage. | -| --warning-guestnice | Threshold in percentage. | -| --critical-guestnice | Threshold in percentage. | -| --warning-idle | Threshold in percentage. | -| --critical-idle | Threshold in percentage. | -| --warning-interrupt | Threshold in percentage. | -| --critical-interrupt | Threshold in percentage. | -| --warning-kernel | Threshold in percentage. | -| --critical-kernel | Threshold in percentage. | -| --warning-nice | Threshold in percentage. | -| --critical-nice | Threshold in percentage. | -| --warning-softirq | Threshold in percentage. | -| --critical-softirq | Threshold in percentage. | -| --warning-steal | Threshold in percentage. | -| --critical-steal | Threshold in percentage. | -| --warning-system | Threshold in percentage. | -| --critical-system | Threshold in percentage. | -| --warning-user | Threshold in percentage. | -| --critical-user | Threshold in percentage. | -| --warning-wait | Threshold in percentage. | -| --critical-wait | Threshold in percentage. | +| Option | Description | +|:---------------------|:--------------------------------------------------------------------------------------------------------------------------| +| --filter-counters | Only display some counters (regexp can be used). Example to check SSL connections only : --filter-counters='^xxxx\|yyyy$' | +| --warning-xxx | Warning threshold. | +| --critical-xxx | Critical threshold. | +| --warning-guest | Threshold in percentage. | +| --critical-guest | Threshold in percentage. | +| --warning-guestnice | Threshold in percentage. | +| --critical-guestnice | Threshold in percentage. | +| --warning-idle | Threshold in percentage. | +| --critical-idle | Threshold in percentage. | +| --warning-interrupt | Threshold in percentage. | +| --critical-interrupt | Threshold in percentage. | +| --warning-kernel | Threshold in percentage. | +| --critical-kernel | Threshold in percentage. | +| --warning-nice | Threshold in percentage. | +| --critical-nice | Threshold in percentage. | +| --warning-softirq | Threshold in percentage. | +| --critical-softirq | Threshold in percentage. | +| --warning-steal | Threshold in percentage. | +| --critical-steal | Threshold in percentage. | +| --warning-system | Threshold in percentage. | +| --critical-system | Threshold in percentage. | +| --warning-user | Threshold in percentage. | +| --critical-user | Threshold in percentage. | +| --warning-wait | Threshold in percentage. | +| --critical-wait | Threshold in percentage. | -| Option | Description | -|:------------------|:----------------------------------------------------------------------------------------------------| -| --filter-counters | Only display some counters (regexp can be used). Example: --filter-counters='^match$' | -| --warning-* | Warning threshold. Can be: 'match', 'badoffset', 'fragment', 'short', 'normalize', 'memdrop'. | -| --critical-* | Critical threshold. Can be: 'match', 'badoffset', 'fragment', 'short', 'normalize', 'memdrop'. | +| Option | Description | +|:------------------|:-----------------------------------------------------------------------------------------------| +| --filter-counters | Only display some counters (regexp can be used). Example: --filter-counters='^match$' | +| --warning-xxx | Warning threshold. | +| --critical-xxx | Critical threshold. | +| --warning-* | Warning threshold. Can be: 'match', 'badoffset', 'fragment', 'short', 'normalize', 'memdrop'. | +| --critical-* | Critical threshold. Can be: 'match', 'badoffset', 'fragment', 'short', 'normalize', 'memdrop'. | -| Option | Description | -|:-----------|:------------------------------------------| -| --warning | Warning threshold (1min,5min,15min). | -| --critical | Critical threshold (1min,5min,15min). | -| --average | Load average for the number of CPUs. | +| Option | Description | +|:-----------|:--------------------------------------| +| --warning | Warning threshold (1min,5min,15min). | +| --critical | Critical threshold (1min,5min,15min). | +| --average | Load average for the number of CPUs. | -| Option | Description | -|:------------------|:----------------------------------------------------------------------------------------------------| -| --filter-counters | Only display some counters (regexp can be used). Example: --filter-counters='^match$' | -| --warning-* | Warning threshold. Can be: 'match', 'badoffset', 'fragment', 'short', 'normalize', 'memdrop'. | -| --critical-* | Critical threshold. Can be: 'match', 'badoffset', 'fragment', 'short', 'normalize', 'memdrop'. | +| Option | Description | +|:------------------|:-----------------------------------------------------------------------------------------------| +| --filter-counters | Only display some counters (regexp can be used). Example: --filter-counters='^match$' | +| --warning-xxx | Warning threshold. | +| --critical-xxx | Critical threshold. | +| --warning-* | Warning threshold. Can be: 'match', 'badoffset', 'fragment', 'short', 'normalize', 'memdrop'. | +| --critical-* | Critical threshold. Can be: 'match', 'badoffset', 'fragment', 'short', 'normalize', 'memdrop'. | -| Option | Description | -|:----------------|:--------------------------------------------------------| -| --warning | Warning threshold in percent. | -| --critical | Critical threshold in percent. | -| --swap | Check swap also. | -| --warning-swap | Warning threshold in percent. | -| --critical-swap | Critical threshold in percent. | -| --no-swap | Threshold if no active swap (default: 'critical'). | +| Option | Description | +|:----------------|:---------------------------------------------------| +| --warning | Warning threshold in percent. | +| --critical | Critical threshold in percent. | +| --swap | Check swap also. | +| --warning-swap | Warning threshold in percent. | +| --critical-swap | Critical threshold in percent. | +| --no-swap | Threshold if no active swap (default: 'critical'). | -| Option | Description | -|:------------------|:----------------------------------------------------------------------------------------------------| -| --filter-counters | Only display some counters (regexp can be used). Example: --filter-counters='^match$' | -| --warning-* | Warning threshold. Can be: 'match', 'badoffset', 'fragment', 'short', 'normalize', 'memdrop'. | -| --critical-* | Critical threshold. Can be: 'match', 'badoffset', 'fragment', 'short', 'normalize', 'memdrop'. | +| Option | Description | +|:------------------|:-----------------------------------------------------------------------------------------------| +| --filter-counters | Only display some counters (regexp can be used). Example: --filter-counters='^match$' | +| --warning-xxx | Warning threshold. | +| --critical-xxx | Critical threshold. | +| --warning-* | Warning threshold. Can be: 'match', 'badoffset', 'fragment', 'short', 'normalize', 'memdrop'. | +| --critical-* | Critical threshold. Can be: 'match', 'badoffset', 'fragment', 'short', 'normalize', 'memdrop'. | -| Option | Description | -|:------------------|:----------------------------------------------------------------------------------------------------| -| --filter-counters | Only display some counters (regexp can be used). Example: --filter-counters='^match$' | -| --warning-* | Warning threshold. Can be: 'match', 'badoffset', 'fragment', 'short', 'normalize', 'memdrop'. | -| --critical-* | Critical threshold. Can be: 'match', 'badoffset', 'fragment', 'short', 'normalize', 'memdrop'. | +| Option | Description | +|:------------------|:-----------------------------------------------------------------------------------------------| +| --filter-counters | Only display some counters (regexp can be used). Example: --filter-counters='^match$' | +| --warning-xxx | Warning threshold. | +| --critical-xxx | Critical threshold. | +| --warning-* | Warning threshold. Can be: 'match', 'badoffset', 'fragment', 'short', 'normalize', 'memdrop'. | +| --critical-* | Critical threshold. Can be: 'match', 'badoffset', 'fragment', 'short', 'normalize', 'memdrop'. | -| Option | Description | -|:-----------|:------------------------------------| -| --warning | Warning threshold in seconds. | -| --critical | Critical threshold in seconds. | +| Option | Description | +|:-----------|:-------------------------------| +| --warning | Warning threshold in seconds. | +| --critical | Critical threshold in seconds. | -| Option | Description | -|:------------------|:----------------------------------------------------------------------------------------------------| -| --filter-counters | Only display some counters (regexp can be used). Example: --filter-counters='^match$' | -| --warning-* | Warning threshold. Can be: 'match', 'badoffset', 'fragment', 'short', 'normalize', 'memdrop'. | -| --critical-* | Critical threshold. Can be: 'match', 'badoffset', 'fragment', 'short', 'normalize', 'memdrop'. | +| Option | Description | +|:------------------|:-----------------------------------------------------------------------------------------------| +| --filter-counters | Only display some counters (regexp can be used). Example: --filter-counters='^match$' | +| --warning-xxx | Warning threshold. | +| --critical-xxx | Critical threshold. | +| --warning-* | Warning threshold. Can be: 'match', 'badoffset', 'fragment', 'short', 'normalize', 'memdrop'. | +| --critical-* | Critical threshold. Can be: 'match', 'badoffset', 'fragment', 'short', 'normalize', 'memdrop'. | -| Option | Description | -|:----------------------|:------------------------------------------------------------------------------------------------------------------------------| -| --filter-counters | Only display some counters (regexp can be used). Example to check SSL connections only : --filter-counters='^xxxx\|yyyy$' | -| --no-swap | Threshold if no active swap (default: 'critical'). | -| --warning-usage | Threshold in bytes. | -| --critical-usage | Threshold in bytes. | -| --warning-usage-free | Threshold in bytes. | -| --critical-usage-free | Threshold in bytes. | -| --warning-usage-prct | Threshold in percentage. | -| --critical-usage-prct | Threshold in percentage. | +| Option | Description | +|:----------------------|:--------------------------------------------------------------------------------------------------------------------------| +| --filter-counters | Only display some counters (regexp can be used). Example to check SSL connections only : --filter-counters='^xxxx\|yyyy$' | +| --warning-xxx | Warning threshold. | +| --critical-xxx | Critical threshold. | +| --no-swap | Threshold if no active swap (default: 'critical'). | +| --warning-usage | Threshold in bytes. | +| --critical-usage | Threshold in bytes. | +| --warning-usage-free | Threshold in bytes. | +| --critical-usage-free | Threshold in bytes. | +| --warning-usage-prct | Threshold in percentage. | +| --critical-usage-prct | Threshold in percentage. | -| Option | Description | -|:-----------------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| --filter-counters | Only display some counters (regexp can be used). Example to check SSL connections only : --filter-counters='^xxxx\|yyyy$' | -| --memcached | Memcached server to use (only one server). | -| --redis-server | Redis server to use (only one server). Syntax: address\[:port\] | -| --redis-attribute | Set Redis Options (--redis-attribute="cnx\_timeout=5"). | -| --redis-db | Set Redis database index. | -| --failback-file | Fall back on a local file if Redis connection fails. | -| --memexpiration | Time to keep data in seconds (default: 86400). | -| --statefile-dir | Define the cache directory (default: '/var/lib/centreon/centplugins'). | -| --statefile-suffix | Define a suffix to customize the statefile name (default: ''). | -| --statefile-concat-cwd | If used with the '--statefile-dir' option, the latter's value will be used as a sub-directory of the current working directory. Useful on Windows when the plugin is compiled, as the file system and permissions are different from Linux. | -| --statefile-format | Define the format used to store the cache. Available formats: 'dumper', 'storable', 'json' (default). | -| --statefile-key | Define the key to encrypt/decrypt the cache. | -| --statefile-cipher | Define the cipher algorithm to encrypt the cache (default: 'AES'). | -| --warning-uptime | Warning threshold. | -| --critical-uptime | Critical threshold. | -| --add-sysdesc | Display system description. | -| --force-oid | Can choose your OID (numeric format only). | -| --check-overload | Uptime counter limit is 4294967296 and overflow. With that option, we manage the counter going back. But there is a few chance we can miss a reboot. | -| --reboot-window | To be used with check-overload option. Time in milliseconds (default: 5000) You increase the chance of not missing a reboot if you decrease that value. | -| --unit | Select the time unit for thresholds. May be 's' for seconds, 'm' for minutes, 'h' for hours, 'd' for days, 'w' for weeks. Default is seconds. | +| Option | Description | +|:-----------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| --filter-counters | Only display some counters (regexp can be used). Example to check SSL connections only : --filter-counters='^xxxx\|yyyy$' | +| --warning-xxx | Warning threshold. | +| --critical-xxx | Critical threshold. | +| --memcached | Memcached server to use (only one server). | +| --redis-server | Redis server to use (only one server). Syntax: address\[:port\] | +| --redis-attribute | Set Redis Options (--redis-attribute="cnx\_timeout=5"). | +| --redis-db | Set Redis database index. | +| --failback-file | Fall back on a local file if Redis connection fails. | +| --memexpiration | Time to keep data in seconds (default: 86400). | +| --statefile-dir | Define the cache directory (default: '/var/lib/centreon/centplugins'). | +| --statefile-suffix | Define a suffix to customize the statefile name (default: ''). | +| --statefile-concat-cwd | If used with the '--statefile-dir' option, the latter's value will be used as a sub-directory of the current working directory. Useful on Windows when the plugin is compiled, as the file system and permissions are different from Linux. | +| --statefile-format | Define the format used to store the cache. Available formats: 'dumper', 'storable', 'json' (default). | +| --statefile-key | Define the key to encrypt/decrypt the cache. | +| --statefile-cipher | Define the cipher algorithm to encrypt the cache (default: 'AES'). | +| --warning-uptime | Warning threshold. | +| --critical-uptime | Critical threshold. | +| --add-sysdesc | Display system description. | +| --force-oid | Can choose your OID (numeric format only). | +| --check-overload | Uptime counter limit is 4294967296 and overflow. With that option, we manage the counter going back. But there is a few chance we can miss a reboot. | +| --reboot-window | To be used with check-overload option. Time in milliseconds (default: 5000) You increase the chance of not missing a reboot if you decrease that value. | +| --unit | Select the time unit for thresholds. May be 's' for seconds, 'm' for minutes, 'h' for hours, 'd' for days, 'w' for weeks. Default is seconds. | diff --git a/pp/integrations/plugin-packs/procedures/network-fortinet-fortimanager-snmp.md b/pp/integrations/plugin-packs/procedures/network-fortinet-fortimanager-snmp.md index 602c5b7b05f5..1886cb8607ec 100644 --- a/pp/integrations/plugin-packs/procedures/network-fortinet-fortimanager-snmp.md +++ b/pp/integrations/plugin-packs/procedures/network-fortinet-fortimanager-snmp.md @@ -26,7 +26,7 @@ The connector brings the following service templates (sorted by the host templat | Service Alias | Service Template | Service Description | |:--------------|:---------------------------------------------|:-----------------------------------------------------| -| Cpu | Net-Fortinet-Fortimanager-Cpu-SNMP-custom | Check the rate of CPU utilization for the machine | +| Cpu | Net-Fortinet-Fortimanager-Cpu-SNMP-custom | Check the rate of utilization of CPU for the machine | | Disk | Net-Fortinet-Fortimanager-Disk-SNMP-custom | Check disk usage | | Memory | Net-Fortinet-Fortimanager-Memory-SNMP-custom | Check memory usage | @@ -48,9 +48,9 @@ The connector brings the following service templates (sorted by the host templat #### Host discovery -| Rule name | Description | -|:----------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| SNMP Agents | Discover your resources through an SNMP subnet scan. You need to install the [Generic SNMP](./applications-protocol-snmp.md) connector to get the discovery rule and create a template mapper for the **Net-Fortinet-Fortimanager-SNMP-custom** host template. | +| Rule name | Description | +|:------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| SNMP Agents | Discover your resources through an SNMP subnet scan. You need to install the [Generic SNMP](./applications-protocol-snmp.md) connector to get the discovery rule and create a template mapper for the **Net-Fortinet-Fortimanager-SNMP-custom** host template. | More information about discovering hosts automatically is available on the [dedicated page](/docs/monitoring/discovery/hosts-discovery). @@ -61,38 +61,38 @@ Here is the list of services for this connector, detailing all metrics and statu -| Name | Unit | -|:-----|:------| -| cpu | % | +| Name | Unit | +|:-----|:-----| +| cpu | % | -| Name | Unit | -|:-----------------------------|:------| -| device-status | N/A | -| device-con-status | N/A | -| device-db-status | N/A | -| device-config-status | N/A | -| device-policy-package-status | N/A | +| Name | Unit | +|:-----------------------------|:-----| +| device-status | N/A | +| device-con-status | N/A | +| device-db-status | N/A | +| device-config-status | N/A | +| device-policy-package-status | N/A | > To obtain this new metric format, include **--use-new-perfdata** in the **EXTRAOPTIONS** service macro. -| Name | Unit | -|:-----|:------| -| used | B | +| Name | Unit | +|:------|:-----| +| usage | B | > To obtain this new metric format, include **--use-new-perfdata** in the **EXTRAOPTIONS** service macro. -| Name | Unit | -|:-----|:------| -| used | B | +| Name | Unit | +|:------|:-----| +| usage | B | > To obtain this new metric format, include **--use-new-perfdata** in the **EXTRAOPTIONS** service macro. @@ -103,7 +103,10 @@ Here is the list of services for this connector, detailing all metrics and statu ### SNMP Configuration -The SNMP service must be configured and activated on the host. Please refer to the official documentation from the constructor/editor. +The SNMP agent must be enabled and configured on the resource. +Please refer to the official documentation. +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 @@ -114,8 +117,7 @@ SNMP port. ### Pack - The installation procedures for monitoring connectors are slightly different depending on [whether your license is offline or online](../getting-started/how-to-guides/connectors-licenses.md). - +The installation procedures for monitoring connectors are slightly different depending on [whether your license is offline or online](../getting-started/how-to-guides/connectors-licenses.md). 1. 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 @@ -207,14 +209,16 @@ yum install centreon-plugin-Network-Fortinet-Fortimanager-Snmp 1. Log into Centreon and add a new host through **Configuration > Hosts**. 2. Fill in the **Name**, **Alias** & **IP Address/DNS** fields according to your resource's settings. -3. Apply the **Net-Fortinet-Fortimanager-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](../getting-started/how-to-guides/troubleshooting-plugins.md#snmpv3-options-mapping) section. +3. Apply the **Net-Fortinet-Fortimanager-SNMP-custom** template to the host. -| 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](#available-options). | | | +| Macro | Description | Default value | Mandatory | +|:------------------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------|:--------------|:---------:| +| SNMP_V3_USERNAME | SNMP v3 only: User name (`securityName`) | | | +| SNMP_V3_AUTH_PROTOCOL | SNMP v3 only: Authentication protocol: MD5\|SHA. Since net-snmp 5.9.1: SHA224\|SHA256\|SHA384\|SHA512 | | | +| SNMP_V3_PRIV_PROTOCOL | 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 | | | +| SNMP_V3_AUTH_PASSPHRASE | SNMP v3 only: Pass phrase hashed using the authentication protocol defined in the --authprotocol option | | | +| SNMP_V3_PRIV_PASSPHRASE | SNMP v3 only: Privacy pass phrase (`privPassword`) to encrypt messages using the protocol defined in the --privprotocol option | | | +| SNMPEXTRAOPTIONS | Any extra option you may want to add to every command (a --verbose flag for example). All options are listed [here](#available-options). | | | 4. [Deploy the configuration](/docs/monitoring/monitoring-servers/deploying-a-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. @@ -226,47 +230,47 @@ yum install centreon-plugin-Network-Fortinet-Fortimanager-Snmp -| Macro | Description | Default value | Mandatory | -|:-------------|:---------------------------------------------------------------------------------------------------------------------------------------|:------------------|:-----------:| -| WARNING | Warning threshold | | | -| CRITICAL | Critical threshold | | | -| EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). All options are listed [here](#available-options). | | | +| Macro | Description | Default value | Mandatory | +|:-------------|:-------------------------------------------------------------------------------------------------------------------------------------------------|:--------------|:---------:| +| WARNING | Warning threshold | | | +| CRITICAL | Critical threshold | | | +| EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). All options are listed [here](#available-options). | | | -| Macro | Description | Default value | Mandatory | -|:---------------------------|:---------------------------------------------------------------------------------------------------------------------------------------|:---------------------|:-----------:| -| FILTERNAME | Filter by device name (can be a regexp) | | | -| WARNINGDEVICECONFIGSTATUS | Set warning threshold for device configuration status. You can use the following variables: %\{status\}, %\{name\} | | | -| CRITICALDEVICECONFIGSTATUS | Set critical threshold for device configuration status. You can use the following variables: %\{status\}, %\{name\} | | | -| CRITICALDEVICECONSTATUS | Set critical threshold for device connection status. You can use the following variables: %\{status\}, %\{name\} | %\{status\} =~ /down/i | | -| WARNINGDEVICECONSTATUS | Set warning threshold for device connection status. You can use the following variables: %\{status\}, %\{name\} | | | -| WARNINGDEVICEDBSTATUS | Set warning threshold for device DB status. You can use the following variables: %\{status\}, %\{name\} | | | -| CRITICALDEVICEDBSTATUS | Set critical threshold for device DB status. You can use the following variables: %\{status\}, %\{name\} | | | -| WARNINGDEVICEPOLICYSTATUS | Set warning threshold for device policy package status. You can use the following variables: %\{status\}, %\{package_name\} | | | -| CRITICALDEVICEPOLICYSTATUS | Set critical threshold for device policy package status. You can use the following variables: %\{status\}, %\{package_name\} | | | -| WARNINGDEVICESTATUS | Set warning threshold for device status. You can use the following variables: %\{status\}, %\{name\} | | | -| CRITICALDEVICESTATUS | Set critical threshold for device status You can use the following variables: %\{status\}, %\{name\} | | | -| EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). All options are listed [here](#available-options). | --verbose | | +| Macro | Description | Default value | Mandatory | +|:---------------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------|:-----------------------|:---------:| +| FILTERNAME | Filter by device name (can be a regexp) | | | +| WARNINGDEVICECONFIGSTATUS | Set warning threshold for device configuration status. You can use the following variables: %\{status\}, %\{name\} | | | +| CRITICALDEVICECONFIGSTATUS | Set critical threshold for device configuration status. You can use the following variables: %\{status\}, %\{name\} | | | +| CRITICALDEVICECONSTATUS | Set critical threshold for device connection status. You can use the following variables: %\{status\}, %\{name\} | %\{status\} =~ /down/i | | +| WARNINGDEVICECONSTATUS | Set warning threshold for device connection status. You can use the following variables: %\{status\}, %\{name\} | | | +| WARNINGDEVICEDBSTATUS | Set warning threshold for device DB status. You can use the following variables: %\{status\}, %\{name\} | | | +| CRITICALDEVICEDBSTATUS | Set critical threshold for device DB status. You can use the following variables: %\{status\}, %\{name\} | | | +| WARNINGDEVICEPOLICYSTATUS | Set warning threshold for device policy package status. You can use the following variables: %\{status\}, %\{package\_name\} | | | +| CRITICALDEVICEPOLICYSTATUS | Set critical threshold for device policy package status. You can use the following variables: %\{status\}, %\{package\_name\} | | | +| WARNINGDEVICESTATUS | Set warning threshold for device status. You can use the following variables: %\{status\}, %\{name\} | | | +| CRITICALDEVICESTATUS | Set critical threshold for device status You can use the following variables: %\{status\}, %\{name\} | | | +| EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). All options are listed [here](#available-options). | --verbose | | -| Macro | Description | Default value | Mandatory | -|:--------------|:---------------------------------------------------------------------------------------------------------------------------------------|:------------------|:-----------:| -| WARNINGUSAGE | Warning threshold (in percent) | | | -| CRITICALUSAGE | Critical threshold (in percent) | | | -| EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). All options are listed [here](#available-options). | | | +| Macro | Description | Default value | Mandatory | +|:--------------|:-------------------------------------------------------------------------------------------------------------------------------------------------|:--------------|:---------:| +| WARNINGUSAGE | Warning threshold (in percent) | | | +| CRITICALUSAGE | Critical threshold (in percent) | | | +| EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). All options are listed [here](#available-options). | | | -| Macro | Description | Default value | Mandatory | -|:--------------|:---------------------------------------------------------------------------------------------------------------------------------------|:------------------|:-----------:| -| WARNINGUSAGE | Warning threshold (in percent) | | | -| CRITICALUSAGE | Critical threshold (in percent) | | | -| EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). All options are listed [here](#available-options). | | | +| Macro | Description | Default value | Mandatory | +|:--------------|:-------------------------------------------------------------------------------------------------------------------------------------------------|:--------------|:---------:| +| WARNINGUSAGE | Warning threshold (in percent) | | | +| CRITICALUSAGE | Critical threshold (in percent) | | | +| EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). All options are listed [here](#available-options). | | | @@ -285,7 +289,12 @@ is able to monitor a resource using a command like this one (replace the sample --mode=device-status \ --hostname=10.0.0.1 \ --snmp-version='2c' \ - --snmp-community='my-snmp-community' \ + --snmp-community='my-snmp-community' \ + --snmp-username='username' \ + --authpassphrase='' \ + --authprotocol='' \ + --privpassphrase='' \ + --privprotocol='' \ --filter-name='' \ --warning-device-status='' \ --critical-device-status='' \ @@ -303,12 +312,7 @@ is able to monitor a resource using a command like this one (replace the sample The expected command output is shown below: ```bash -OK: Device 'Device Ent Name' status: installed - connection status: up - db status: modified - configuration status: in-sync -checking device 'Device Ent Name' - status: installed - connection status: up - db status: modified - configuration status: in-sync +OK: policy packages are ok ``` ### Troubleshooting @@ -347,65 +351,67 @@ The plugin brings the following modes: 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 ok, 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\[,\[newuom\],\[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\[,\[newuom\],\[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\[,\[newuom\],\[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,namesofnewmetrics,calculation\[,\[newuom\],\[min\],\[max\]\] regex: regular expression namesofnewmetrics: 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 newuom (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~replacement~modifier Most commonly used modifiers are i (case insensitive) and g (replace all occurrences). Example: adding --change-short-output='OK\~Up\~gi' will replace all occurrences of 'OK', 'ok', 'Ok' or 'oK' with 'Up' | -| --change-short-output | Modify the short/long output that is returned by the plugin. Syntax: --change-short-output=pattern~replacement~modifier Most commonly used modifiers are i (case insensitive) and g (replace all occurrences). Example: adding --change-short-output='OK\~Up\~gi' will replace all occurrences of 'OK', 'ok', 'Ok' or 'oK' with 'Up' | -| --change-long-output | Modify the short/long output that is returned by the plugin. Syntax: --change-short-output=pattern~replacement~modifier Most commonly used modifiers are i (case insensitive) and g (replace all occurrences). Example: adding --change-short-output='OK\~Up\~gi' will replace all occurrences of 'OK', 'ok', 'Ok' or 'oK' with 'Up' | -| --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. | -| --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). E.g.: --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\. =cut | +| 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 get-next 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 ok, 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. | +| --show-password | By default, sensitive information in command lines is hidden in debug output and replaced with `***` (however, debug logs may still display sensitive information). Using the C option will display the passwords in plain text. | +| --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\[,\[\\],\[min\],\[max\]\] Common examples: onvert 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\[,\[\\],\[min\],\[max\]\] Common examples: onvert 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\[,\[\\],\[min\],\[max\]\] Common examples: onvert 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,\,calculation\[,\[\\],\[min\],\[max\]\] regex: regular expression \: 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 \ (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: um 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~replacement~modifier Most commonly used modifiers are i (case insensitive) and g (replace all occurrences). Example: adding --change-short-output='OK~Up~gi' will replace all occurrences of 'OK', 'ok', 'Ok' or 'oK' with 'Up' | +| --change-short-output | Modify the short/long output that is returned by the plugin. Syntax: --change-short-output=pattern~replacement~modifier Most commonly used modifiers are i (case insensitive) and g (replace all occurrences). Example: adding --change-short-output='OK~Up~gi' will replace all occurrences of 'OK', 'ok', 'Ok' or 'oK' with 'Up' | +| --change-long-output | Modify the short/long output that is returned by the plugin. Syntax: --change-short-output=pattern~replacement~modifier Most commonly used modifiers are i (case insensitive) and g (replace all occurrences). Example: adding --change-short-output='OK~Up~gi' will replace all occurrences of 'OK', 'ok', 'Ok' or 'oK' with 'Up' | +| --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'. \. | #### Modes options @@ -414,46 +420,52 @@ All available options for each service template are listed below: -| Option | Description | -|:-----------|:-----------------------------| -| --warning | Warning threshold. | -| --critical | Critical threshold. | +| Option | Description | +|:-----------|:--------------------| +| --warning | Warning threshold. | +| --critical | Critical threshold. | -| Option | Description | -|:----------------------------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------| -| --filter-counters | Only display some counters (regexp can be used). Example to check SSL connections only : --filter-counters='^xxxx\|yyyy$' | -| --filter-name | Filter by device name (can be a regexp). | -| --warning-device-status | Set warning threshold for device status. You can use the following variables: %\{status\}, %\{name\} | -| --critical-device-status | Set critical threshold for device status You can use the following variables: %\{status\}, %\{name\} | -| --warning-device-con-status | Set warning threshold for device connection status. You can use the following variables: %\{status\}, %\{name\} | -| --critical-device-con-status | Set critical threshold for device connection status (default: '%\{status\} =~ /down/i'). You can use the following variables: %\{status\}, %\{name\} | -| --warning-device-db-status | Set warning threshold for device DB status. You can use the following variables: %\{status\}, %\{name\} | -| --critical-device-db-status | Set critical threshold for device DB status. You can use the following variables: %\{status\}, %\{name\} | -| --warning-device-config-status | Set warning threshold for device configuration status. You can use the following variables: %\{status\}, %\{name\} | -| --critical-device-config-status | Set critical threshold for device configuration status. You can use the following variables: %\{status\}, %\{name\} | -| --warning-device-policy-package-status | Set warning threshold for device policy package status. You can use the following variables: %\{status\}, %\{package_name\} | -| --critical-device-policy-package-status | Set critical threshold for device policy package status. You can use the following variables: %\{status\}, %\{package_name\} | +| Option | Description | +|:----------------------------------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------| +| --filter-counters | Only display some counters (regexp can be used). Example to check SSL connections only : --filter-counters='^xxxx\|yyyy$' | +| --warning-xxx | Warning threshold. | +| --critical-xxx | Critical threshold. | +| --filter-name | Filter by device name (can be a regexp). | +| --warning-device-status | Set warning threshold for device status. You can use the following variables: %\{status\}, %\{name\} | +| --critical-device-status | Set critical threshold for device status You can use the following variables: %\{status\}, %\{name\} | +| --warning-device-con-status | Set warning threshold for device connection status. You can use the following variables: %\{status\}, %\{name\} | +| --critical-device-con-status | Set critical threshold for device connection status (default: '%\{status\} =~ /down/i'). You can use the following variables: %\{status\}, %\{name\} | +| --warning-device-db-status | Set warning threshold for device DB status. You can use the following variables: %\{status\}, %\{name\} | +| --critical-device-db-status | Set critical threshold for device DB status. You can use the following variables: %\{status\}, %\{name\} | +| --warning-device-config-status | Set warning threshold for device configuration status. You can use the following variables: %\{status\}, %\{name\} | +| --critical-device-config-status | Set critical threshold for device configuration status. You can use the following variables: %\{status\}, %\{name\} | +| --warning-device-policy-package-status | Set warning threshold for device policy package status. You can use the following variables: %\{status\}, %\{package\_name\} | +| --critical-device-policy-package-status | Set critical threshold for device policy package status. You can use the following variables: %\{status\}, %\{package\_name\} | -| Option | Description | -|:------------------|:------------------------------------------------------------------------------------------------------------------------------| -| --filter-counters | Only display some counters (regexp can be used). Example to check SSL connections only : --filter-counters='^xxxx\|yyyy$' | -| --warning-usage | Warning threshold (in percent). | -| --critical-usage | Critical threshold (in percent). | +| Option | Description | +|:------------------|:--------------------------------------------------------------------------------------------------------------------------| +| --filter-counters | Only display some counters (regexp can be used). Example to check SSL connections only : --filter-counters='^xxxx\|yyyy$' | +| --warning-xxx | Warning threshold. | +| --critical-xxx | Critical threshold. | +| --warning-usage | Warning threshold (in percent). | +| --critical-usage | Critical threshold (in percent). | -| Option | Description | -|:------------------|:------------------------------------------------------------------------------------------------------------------------------| -| --filter-counters | Only display some counters (regexp can be used). Example to check SSL connections only : --filter-counters='^xxxx\|yyyy$' | -| --warning-usage | Warning threshold (in percent). | -| --critical-usage | Critical threshold (in percent). | +| Option | Description | +|:------------------|:--------------------------------------------------------------------------------------------------------------------------| +| --filter-counters | Only display some counters (regexp can be used). Example to check SSL connections only : --filter-counters='^xxxx\|yyyy$' | +| --warning-xxx | Warning threshold. | +| --critical-xxx | Critical threshold. | +| --warning-usage | Warning threshold (in percent). | +| --critical-usage | Critical threshold (in percent). | diff --git a/pp/integrations/plugin-packs/procedures/network-stormshield-snmp.md b/pp/integrations/plugin-packs/procedures/network-stormshield-snmp.md index 6a4f9f41bb0a..0dc38f81a6e1 100644 --- a/pp/integrations/plugin-packs/procedures/network-stormshield-snmp.md +++ b/pp/integrations/plugin-packs/procedures/network-stormshield-snmp.md @@ -5,6 +5,12 @@ title: Stormshield SNMP import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; +## Connector dependencies + +The following monitoring connectors will be installed when you install the **Stormshield SNMP** connector through the +**Configuration > Connectors > Monitoring Connectors** menu: +* [Base Pack](./base-generic.md) + ## Pack assets ### Templates @@ -20,30 +26,30 @@ The connector brings the following service templates (sorted by the host templat | Service Alias | Service Template | Service Description | |:----------------|:--------------------------------------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------| -| Cpu-Detailed | Net-Stormshield-Cpu-Detailed-SNMP-custom | Check the detailed rate of utilization of CPU for the machine. This check can give the average CPU utilization rate and the rate per CPU for multi-core CPU. | -| Hardware | Net-Stormshield-Hardware-SNMP-custom | Check hardware. | -| Load | Net-Stormshield-Load-SNMP-custom | Check the server load average. | -| Memory | Net-Stormshield-Memory-SNMP-custom | Check the rate of the utilization of memory. | -| Memory-Detailed | Net-Stormshield-Memory-Detailed-SNMP-custom | Check detailed memory usage. | -| Swap | Net-Stormshield-Swap-SNMP-custom | Check virtual memory usage. | +| Cpu-Detailed | Net-Stormshield-Cpu-Detailed-SNMP-custom | Check the detailed rate of utilization of CPU for the machine. This check can give the average CPU utilization rate and the rate per CPU for multi-core CPU | +| Hardware | Net-Stormshield-Hardware-SNMP-custom | Check hardware | +| Load | Net-Stormshield-Load-SNMP-custom | Check the server load average | +| Memory | Net-Stormshield-Memory-SNMP-custom | Check the rate of the utilization of memory (RAM) | +| Memory-Detailed | Net-Stormshield-Memory-Detailed-SNMP-custom | Check detailed memory usage | +| Swap | Net-Stormshield-Swap-SNMP-custom | Check virtual memory usage (SWAP) | > The services listed above are created automatically when the **Net-Stormshield-SNMP-custom** host template is used. -| Service Alias | Service Template | Service Description | Discovery | -|:---------------------|:-------------------------------------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------|:----------:| -| Connections | Net-Stormshield-Connections-SNMP-custom | Check connections setup. rate | | -| Cpu | Net-Stormshield-Cpu-SNMP-custom | Check the rate of utilization of CPU for the machine. This check can give the average CPU utilization rate and the rate per CPU for multi-core CPU. | | -| Disk-Global | Net-Stormshield-Disk-Global-SNMP-custom | Check the rate of free space on disks. For each checks the mount point of disks will appear. | | -| Ha-Status | Net-Stormshield-Ha-Status-SNMP-custom | Check HA status. | | -| Health | Net-Stormshield-Health-SNMP-custom | Check health. | | -| Qos | Net-Stormshield-Qos-SNMP-custom | Check QoS usage. | | -| Traffic-Generic-Id | Net-Stormshield-Traffic-Generic-Id-SNMP-custom | Check traffic of an network interface. | | -| Traffic-Generic-Name | Net-Stormshield-Traffic-Generic-Name-SNMP-custom | Check traffic of an network interface. | | -| Traffic-Global | Net-Stormshield-Traffic-Global-SNMP-custom | Check traffic of multiple network interfaces. | X | -| Vpn-Status | Net-Stormshield-Vpn-Status-SNMP-custom | Check VPN states. | | +| Service Alias | Service Template | Service Description | Discovery | +|:---------------------|:-------------------------------------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------|:---------:| +| Connections | Net-Stormshield-Connections-SNMP-custom | Check the number of TCP/UDP connections | | +| Cpu | Net-Stormshield-Cpu-SNMP-custom | Check the rate of utilization of CPU for the machine. This check can give the average CPU utilization rate and the rate per CPU for multi-core CPU | | +| Disk-Global | Net-Stormshield-Disk-Global-SNMP-custom | Check the rate of free space on disks. For each checks the mount point of disks will appear (« label »). Thresholds can be in percentage or in free space remaining | | +| Ha-Status | Net-Stormshield-Ha-Status-SNMP-custom | Check HA status | | +| Health | Net-Stormshield-Health-SNMP-custom | Check health | | +| Qos | Net-Stormshield-Qos-SNMP-custom | Check QoS usage | | +| Traffic-Generic-Id | Net-Stormshield-Traffic-Generic-Id-SNMP-custom | Check traffic of an network interface | | +| Traffic-Generic-Name | Net-Stormshield-Traffic-Generic-Name-SNMP-custom | Check traffic of an network interface | | +| Traffic-Global | Net-Stormshield-Traffic-Global-SNMP-custom | Check traffic of multiple network interfaces | X | +| Vpn-Status | Net-Stormshield-Vpn-Status-SNMP-custom | Check VPN states | | > The services listed above are not created automatically when a host template is applied. To use them, [create a service manually](/docs/monitoring/basic-objects/services), then apply the service template you want. @@ -56,9 +62,9 @@ The connector brings the following service templates (sorted by the host templat #### Host discovery -| Rule name | Description | -|:----------------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| SNMP Agents | Discover your resources through an SNMP subnet scan. You need to install the [Generic SNMP](./applications-protocol-snmp.md) connector to get the discovery rule and create a template mapper for the **Net-Stormshield-SNMP-custom** host template | +| Rule name | Description | +|:------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| SNMP Agents | Discover your resources through an SNMP subnet scan. You need to install the [Generic SNMP](./applications-protocol-snmp.md) connector to get the discovery rule and create a template mapper for the **Net-Stormshield-SNMP-custom** host template. | More information about discovering hosts automatically is available on the [dedicated page](/docs/monitoring/discovery/hosts-discovery). @@ -73,51 +79,51 @@ and in the [following chapter](/docs/monitoring/discovery/services-discovery/#di ### Collected metrics & status -Here is the list of services for this connector, detailing all metrics linked to each service. +Here is the list of services for this connector, detailing all metrics and statuses linked to each service. -| Metric name | Unit | -|:------------|:------| -| udp | con | -| tcp | con | +| Name | Unit | +|:-----|:-----| +| udp | con | +| tcp | con | > To obtain this new metric format, include **--use-new-perfdata** in the **EXTRAOPTIONS** service macro. -| Metric name | Unit | -|:-------------------------------------------|:------| -| cpu.utilization.percentage | % | -| *cpu_core*#core.cpu.utilization.percentage | % | +| Name | Unit | +|:-------------------------------------------|:-----| +| cpu.utilization.percentage | % | +| *cpu_core*#core.cpu.utilization.percentage | % | > To obtain this new metric format, include **--use-new-perfdata** in the **EXTRAOPTIONS** service macro. -| Metric name | Unit | -|:-------------------------------------|:------| -| cpu.user.utilization.percentage | % | -| cpu.nice.utilization.percentage | % | -| cpu.system.utilization.percentage | % | -| cpu.idle.utilization.percentage | % | -| cpu.wait.utilization.percentage | % | -| cpu.kernel.utilization.percentage | % | -| cpu.interrupt.utilization.percentage | % | -| cpu.softirq.utilization.percentage | % | -| cpu.steal.utilization.percentage | % | -| cpu.guest.utilization.percentage | % | -| cpu.guestnice.utilization.percentage | % | +| Name | Unit | +|:-------------------------------------|:-----| +| cpu.user.utilization.percentage | % | +| cpu.nice.utilization.percentage | % | +| cpu.system.utilization.percentage | % | +| cpu.idle.utilization.percentage | % | +| cpu.wait.utilization.percentage | % | +| cpu.kernel.utilization.percentage | % | +| cpu.interrupt.utilization.percentage | % | +| cpu.softirq.utilization.percentage | % | +| cpu.steal.utilization.percentage | % | +| cpu.guest.utilization.percentage | % | +| cpu.guestnice.utilization.percentage | % | > To obtain this new metric format, include **--use-new-perfdata** in the **EXTRAOPTIONS** service macro. -| Metric name | Unit | +| Name | Unit | |:--------------------------------------|:------| | storage.partitions.count | count | | *disk_name*#storage.space.usage.bytes | B | @@ -128,35 +134,39 @@ Here is the list of services for this connector, detailing all metrics linked to -| Metric name | Unit | -|:---------------|:------| -| dead_nodes | N/A | -| *nodes*#state | N/A | -| *nodes*#health | % | +| Name | Unit | +|:---------------|:-----| +| dead-nodes | N/A | +| state | N/A | +| *nodes*#health | % | > To obtain this new metric format, include **--use-new-perfdata** in the **EXTRAOPTIONS** service macro. -| Metric name | Unit | -|:-------------------|:-------| -| disk.status | N/A | -| fan.status | N/A | -| psu.status | N/A | -| temperature.value | Celsius| +| Name | Unit | +|:---------------------------|:------| +| hardware.disk.count | count | +| disk status | N/A | +| hardware.fan.count | count | +| fan status | N/A | +| hardware.psu.count | count | +| psu status | N/A | +| hardware.temperature.count | count | +| temperature status | N/A | -| Metric name | Unit | -|:--------------------------------------|:------| -| *firewalls*~*services*#service-status | N/A | +| Name | Unit | +|:---------------|:-----| +| service-status | N/A | -| Metric name | Unit | +| Name | Unit | |:-----------------------|:------| | load.1m.average.count | count | | load.5m.average.count | count | @@ -168,67 +178,67 @@ Here is the list of services for this connector, detailing all metrics linked to -| Metric name | Unit | -|:--------------------|:------| -| memory.cached.bytes | B | -| memory.usage.bytes | B | -| swap.usage.bytes | B | +| Name | Unit | +|:--------------------|:-----| +| memory.cached.bytes | B | +| memory.usage.bytes | B | +| swap.usage.bytes | B | -| Metric name | Unit | -|:---------------------------------|:------| -| memory.usage.percentage | % | -| memory.protected_host.percentage | % | -| memory.fragmented.percentage | % | -| memory.connections.percentage | % | -| memory.icmp.percentage | % | -| memory.data_tracking.percentage | % | -| memory.dynamic.percentage | % | -| memory.ether_state.percentage | % | +| Name | Unit | +|:---------------------------------|:-----| +| memory.usage.percentage | % | +| memory.protected_host.percentage | % | +| memory.fragmented.percentage | % | +| memory.connections.percentage | % | +| memory.icmp.percentage | % | +| memory.data_tracking.percentage | % | +| memory.dynamic.percentage | % | +| memory.ether_state.percentage | % | -| Metric name | Unit | -|:-----------------------------------------|:------| -| *qos*#qos.traffic.in.bitspersecond | b/s | -| *qos*#qos.traffic.in.percentage | % | -| *qos*#qos.traffic.in.peak.bitspersecond | b/s | -| *qos*#qos.traffic.out.bitspersecond | b/s | -| *qos*#qos.traffic.out.percentage | % | -| *qos*#qos.traffic.out.peak.bitspersecond | b/s | +| Name | Unit | +|:-----------------------------------------|:-----| +| *qos*#qos.traffic.in.bitspersecond | b/s | +| *qos*#qos.traffic.in.percentage | % | +| *qos*#qos.traffic.in.peak.bitspersecond | b/s | +| *qos*#qos.traffic.out.bitspersecond | b/s | +| *qos*#qos.traffic.out.percentage | % | +| *qos*#qos.traffic.out.peak.bitspersecond | b/s | -| Metric name | Unit | -|:----------------------|:------| -| swap.usage.bytes | B | -| swap.free.bytes | B | -| swap.usage.percentage | % | +| Name | Unit | +|:----------------------|:-----| +| swap.usage.bytes | B | +| swap.free.bytes | B | +| swap.usage.percentage | % | > To obtain this new metric format, include **--use-new-perfdata** in the **EXTRAOPTIONS** service macro. -| Metric name | Unit | -|:-----------------------------------------------------|:------| -| *interface_name*#status | N/A | -| *interface_name*#interface.traffic.in.bitspersecond | b/s | -| *interface_name*#interface.traffic.out.bitspersecond | b/s | +| Name | Unit | +|:-----------------------------------------------------|:-----| +| status | N/A | +| *interface_name*#interface.traffic.in.bitspersecond | b/s | +| *interface_name*#interface.traffic.out.bitspersecond | b/s | > Applies to the following service templates: Traffic-Generic-Id, Traffic-Generic-Name, Traffic-Global -| Metric name | Unit | +| Name | Unit | |:------------------------------------|:------| | vpn.detected.count | count | -| *vpn*#status | N/A | +| status | N/A | | *vpn*#vpn.traffic.bitspersecond | b/s | | *vpn*#vpn.traffic.in.bitspersecond | b/s | | *vpn*#vpn.traffic.out.bitspersecond | b/s | @@ -240,7 +250,10 @@ Here is the list of services for this connector, detailing all metrics linked to ### SNMP Configuration -The SNMP service must be configured and activated on the host. Please refer to the official documentation from the constructor/editor. +The SNMP agent must be enabled and configured on the resource. +Please refer to the official documentation. +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 @@ -251,8 +264,7 @@ SNMP port. ### Pack - The installation procedures for monitoring connectors are slightly different depending on [whether your license is offline or online](../getting-started/how-to-guides/connectors-licenses.md). - +The installation procedures for monitoring connectors are slightly different depending on [whether your license is offline or online](../getting-started/how-to-guides/connectors-licenses.md). 1. 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 @@ -292,7 +304,7 @@ yum install centreon-pack-network-stormshield-snmp 2. Whatever the license type (*online* or *offline*), install the **Stormshield SNMP** connector through -the **Configuration > Monitoring Connectors Manager** menu. +the **Configuration > Connectors > Monitoring Connectors** menu. ### Plugin @@ -343,15 +355,17 @@ yum install centreon-plugin-Network-Stormshield-Snmp ### Using a host template provided by the connector 1. Log into Centreon and add a new host through **Configuration > Hosts**. -2. Fill the **Name**, **Alias** & **IP Address/DNS** fields according to your ressource settings. +2. Fill in the **Name**, **Alias** & **IP Address/DNS** fields according to your resource's settings. 3. Apply the **Net-Stormshield-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](../getting-started/how-to-guides/troubleshooting-plugins.md#snmpv3-options-mapping) 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](#available-options). | | | +| Macro | Description | Default value | Mandatory | +|:------------------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------|:--------------|:---------:| +| SNMP_V3_USERNAME | SNMP v3 only: User name (`securityName`) | | | +| SNMP_V3_AUTH_PROTOCOL | SNMP v3 only: Authentication protocol: MD5\|SHA. Since net-snmp 5.9.1: SHA224\|SHA256\|SHA384\|SHA512 | | | +| SNMP_V3_PRIV_PROTOCOL | 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 | | | +| SNMP_V3_AUTH_PASSPHRASE | SNMP v3 only: Pass phrase hashed using the authentication protocol defined in the --authprotocol option | | | +| SNMP_V3_PRIV_PASSPHRASE | SNMP v3 only: Privacy pass phrase (`privPassword`) to encrypt messages using the protocol defined in the --privprotocol option | | | +| SNMPEXTRAOPTIONS | Any extra option you may want to add to every command (a --verbose flag for example). All options are listed [here](#available-options). | | | 4. [Deploy the configuration](/docs/monitoring/monitoring-servers/deploying-a-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. @@ -363,203 +377,203 @@ yum install centreon-plugin-Network-Stormshield-Snmp -| Macro | Description | Default value | Mandatory | -|:-------------|:---------------------------------------------------------------------------------------------------|:------------------|:-----------:| -| WARNINGTCP | Warning threshold | | | -| CRITICALTCP | Critical threshold | | | -| WARNINGUDP | Warning threshold | | | -| CRITICALUDP | Critical threshold | | | -| EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). All options are listed [here](#available-options). | | | +| Macro | Description | Default value | Mandatory | +|:-------------|:-------------------------------------------------------------------------------------------------------------------------------------------------|:--------------|:---------:| +| WARNINGTCP | Threshold | | | +| CRITICALTCP | Threshold | | | +| WARNINGUDP | Threshold | | | +| CRITICALUDP | Threshold | | | +| EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). All options are listed [here](#available-options). | | | -| Macro | Description | Default value | Mandatory | -|:-------------|:---------------------------------------------------------------------------------------------------|:------------------|:-----------:| -| WARNING | Warning threshold for average CPU utilization | 80 | | -| CRITICAL | Critical threshold for average CPU utilization | 90 | | -| EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). All options are listed [here](#available-options). | | | +| Macro | Description | Default value | Mandatory | +|:-------------|:-------------------------------------------------------------------------------------------------------------------------------------------------|:--------------|:---------:| +| WARNING | Warning threshold average CPU utilization | 80 | | +| CRITICAL | Critical threshold average CPU utilization | 90 | | +| EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). All options are listed [here](#available-options). | | | -| Macro | Description | Default value | Mandatory | -|:-------------|:---------------------------------------------------------------------------------------------------|:------------------|:-----------:| -| WARNINGIDLE | Warning threshold in percent | 20: | | -| CRITICALIDLE | Critical threshold in percent | 10: | | -| EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). All options are listed [here](#available-options). | --verbose | | +| Macro | Description | Default value | Mandatory | +|:-------------|:-------------------------------------------------------------------------------------------------------------------------------------------------|:--------------|:---------:| +| WARNINGIDLE | Threshold in percentage | 20: | | +| CRITICALIDLE | Threshold in percentage | 10: | | +| EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). All options are listed [here](#available-options). | --verbose | | -| Macro | Description | Default value | Mandatory | -|:-------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:------------------|:-----------:| -| FILTER | Define the storage units to check (number expected). Example: 1, 2... (empty means 'check all storage units') | .* | | -| TRANSFORMSRC | Modify the storage name displayed by using a regular expression. Example: adding --display-transform-src='dev' --display-transform-dst='run' will replace all occurrences of 'dev' with 'run' | | | -| TRANSFORMDST | Modify the storage name displayed by using a regular expression. Example: adding --display-transform-src='dev' --display-transform-dst='run' will replace all occurrences of 'dev' with 'run' | | | -| WARNING | Warning threshold | 80 | | -| CRITICAL | Critical threshold | 90 | | -| EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). All options are listed [here](#available-options). | --verbose | | +| Macro | Description | Default value | Mandatory | +|:-------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:--------------|:---------:| +| FILTER | Set the storage (number expected) example: 1, 2,... (empty means 'check all storage') | .* | | +| TRANSFORMSRC | Modify the storage name displayed by using a regular expression. Example: adding --display-transform-src='dev' --display-transform-dst='run' will replace all occurrences of 'dev' with 'run' | | | +| TRANSFORMDST | Modify the storage name displayed by using a regular expression. Example: adding --display-transform-src='dev' --display-transform-dst='run' will replace all occurrences of 'dev' with 'run' | | | +| WARNING | Warning threshold | 80 | | +| CRITICAL | Critical threshold | 90 | | +| EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). All options are listed [here](#available-options). | --verbose | | -| Macro | Description | Default value | Mandatory | -|:------------------|:------------------------------------------------------------------------------------------------------------------------------|:------------------|:-----------:| -| WARNINGDEADNODES | Warning threshold for dead nodes (absolute unless --percent is used) | | | -| CRITICALDEADNODES | Critical threshold for dead nodes (absolute unless --percent is used) | | | -| WARNINGHEALTH | Warning threshold for health level (example: --warning 90:) | | | -| CRITICALHEALTH | Critical threshold for health level (example --critical 80:) | | | -| WARNINGSTATE | Set warning threshold for state. You can use the following variables: %\{state\}, %\{role\} | | | -| CRITICALSTATE | Set critical threshold for state. (default: '%\{state\} =~ /offline/i'). You can use the following variables: %\{state\}, %\{role\} | | | -| EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). All options are listed [here](#available-options). | --verbose | | +| Macro | Description | Default value | Mandatory | +|:------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------|:-------------------------|:---------:| +| WARNINGDEADNODES | Warning threshold on deadnode (absolute unless --percent is used) | | | +| CRITICALDEADNODES | Critical threshold on deadnode (absolute unless --percent is used) | | | +| WARNINGHEALTH | Warning threshold on health level (example: --warning 90:) | | | +| CRITICALHEALTH | Critical threshold on health level (example --critical 80:) | | | +| WARNINGSTATE | Set warning threshold for state. You can use the following variables: %\{state\}, %\{role\} | | | +| CRITICALSTATE | Set critical threshold for state.. You can use the following variables: %\{state\}, %\{role\} | %\{state\} =~ /offline/i | | +| EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). All options are listed [here](#available-options). | --verbose | | -| Macro | Description | Default value | Mandatory | -|:-------------|:---------------------------------------------------------------------------------------------------|:------------------|:-----------:| -| COMPONENT | Which component to check (default: '.*'). Can be: 'disk', 'fan', 'psu', 'temperature' | | | -| EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). All options are listed [here](#available-options). | --verbose | | +| Macro | Description | Default value | Mandatory | +|:-------------|:-------------------------------------------------------------------------------------------------------------------------------------------------|:--------------|:---------:| +| COMPONENT | Which component to check. Can be: 'disk', 'fan', 'psu', 'temperature' | .* | | +| EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). All options are listed [here](#available-options). | --verbose | | -| Macro | Description | Default value | Mandatory | -|:----------------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------|:----------------------|:-----------:| -| UNKNOWNSERVICESTATUS | Define the conditions to match for the status to be UNKNOWN. You can use the following variables: %\{health\}, %\{service\} | | | -| WARNINGSERVICESTATUS | Define the conditions to match for the status to be WARNING (default: '%\{health\} =~ /minor/i'). You can use the following variables: %\{health\}, %\{service\} | %\{health\} =~ /minor/i | | -| CRITICALSERVICESTATUS | Define the conditions to match for the status to be CRITICAL (default: '%\{health\} =~ /major/i'). You can use the following variables: %\{health\}, %\{service\} | %\{health\} =~ /major/i | | -| EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). All options are listed [here](#available-options). | --verbose | | +| Macro | Description | Default value | Mandatory | +|:----------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------|:------------------------|:---------:| +| UNKNOWNSERVICESTATUS | Define the conditions to match for the status to be UNKNOWN. You can use the following variables: %\{health\}, %\{service\} | | | +| WARNINGSERVICESTATUS | Define the conditions to match for the status to be WARNING. You can use the following variables: %\{health\}, %\{service\} | %\{health\} =~ /minor/i | | +| CRITICALSERVICESTATUS | Define the conditions to match for the status to be CRITICAL. You can use the following variables: %\{health\}, %\{service\} | %\{health\} =~ /major/i | | +| EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). All options are listed [here](#available-options). | --verbose | | -| Macro | Description | Default value | Mandatory | -|:-------------|:---------------------------------------------------------------------------------------------------|:------------------|:-----------:| -| WARNING | Warning threshold (1min,5min,15min) | 4,3,2 | | -| CRITICAL | Critical threshold (1min,5min,15min) | 6,5,4 | | -| EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). All options are listed [here](#available-options). | | | +| Macro | Description | Default value | Mandatory | +|:-------------|:-------------------------------------------------------------------------------------------------------------------------------------------------|:--------------|:---------:| +| WARNING | Warning threshold (1min,5min,15min) | 4,3,2 | | +| CRITICAL | Critical threshold (1min,5min,15min) | 6,5,4 | | +| EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). All options are listed [here](#available-options). | | | -| Macro | Description | Default value | Mandatory | -|:-------------|:---------------------------------------------------------------------------------------------------|:------------------|:-----------:| -| WARNING | Warning threshold in percent | 80 | | -| CRITICAL | Critical threshold in percent | 90 | | -| EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). All options are listed [here](#available-options). | | | +| Macro | Description | Default value | Mandatory | +|:-------------|:-------------------------------------------------------------------------------------------------------------------------------------------------|:--------------|:---------:| +| WARNING | Warning threshold in percent | 80 | | +| CRITICAL | Critical threshold in percent | 90 | | +| EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). All options are listed [here](#available-options). | | | -| Macro | Description | Default value | Mandatory | -|:-------------------|:---------------------------------------------------------------------------------------------------|:------------------|:-----------:| -| WARNINGCONN | Thresholds | | | -| CRITICALCONN | Thresholds | | | -| WARNINGDTRACK | Thresholds | | | -| CRITICALDTRACK | Thresholds | | | -| WARNINGDYN | Thresholds | | | -| CRITICALDYN | Thresholds | | | -| WARNINGETHERSTATE | Thresholds | | | -| CRITICALETHERSTATE | Thresholds | | | -| WARNINGFRAG | Thresholds | | | -| CRITICALFRAG | Thresholds | | | -| WARNINGHOST | Thresholds | | | -| CRITICALHOST | Thresholds | | | -| WARNINGICMP | Thresholds | | | -| CRITICALICMP | Thresholds | | | -| WARNINGTOTAL | Thresholds | | | -| CRITICALTOTAL | Thresholds | | | -| EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). All options are listed [here](#available-options). | | | +| Macro | Description | Default value | Mandatory | +|:-------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------|:--------------|:---------:| +| WARNINGCONN | Threshold | | | +| CRITICALCONN | Threshold | | | +| WARNINGDTRACK | Threshold | | | +| CRITICALDTRACK | Threshold | | | +| WARNINGDYN | Threshold | | | +| CRITICALDYN | Threshold | | | +| WARNINGETHERSTATE | Threshold | | | +| CRITICALETHERSTATE | Threshold | | | +| WARNINGFRAG | Threshold | | | +| CRITICALFRAG | Threshold | | | +| WARNINGHOST | Threshold | | | +| CRITICALHOST | Threshold | | | +| WARNINGICMP | Threshold | | | +| CRITICALICMP | Threshold | | | +| WARNINGTOTAL | Threshold | | | +| CRITICALTOTAL | Threshold | | | +| EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). All options are listed [here](#available-options). | | | -| Macro | Description | Default value | Mandatory | -|:-----------------------|:---------------------------------------------------------------------------------------------------|:------------------|:-----------:| -| FILTERNAME | Filter by QoS name (can be a regexp) | | | -| SPEEDIN | Set interface speed for incoming traffic (in Mb) | | | -| SPEEDOUT | Set interface speed for outgoing traffic (in Mb) | | X | -| WARNINGTRAFFICIN | Thresholds | | | -| CRITICALTRAFFICIN | Thresholds | | | -| WARNINGTRAFFICINPEAK | Thresholds | | | -| CRITICALTRAFFICINPEAK | Thresholds | | | -| WARNINGTRAFFICINPRCT | Thresholds | | | -| CRITICALTRAFFICINPRCT | Thresholds | | | -| WARNINGTRAFFICOUT | Thresholds | | | -| CRITICALTRAFFICOUT | Thresholds | | | -| WARNINGTRAFFICOUTPEAK | Thresholds | | | -| CRITICALTRAFFICOUTPEAK | Thresholds | | | -| WARNINGTRAFFICOUTPRCT | Thresholds | | | -| CRITICALTRAFFICOUTPRCT | Thresholds | | | -| EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). All options are listed [here](#available-options). | --verbose | | +| Macro | Description | Default value | Mandatory | +|:-----------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------|:--------------|:---------:| +| FILTERNAME | Filter by QoS name (can be a regexp) | | | +| SPEEDIN | Set interface speed for incoming traffic (in Mb) | | | +| SPEEDOUT | Set interface speed for outgoing traffic (in Mb) | | | +| WARNINGTRAFFICIN | Threshold | | | +| CRITICALTRAFFICIN | Threshold | | | +| WARNINGTRAFFICINPEAK | Threshold | | | +| CRITICALTRAFFICINPEAK | Threshold | | | +| WARNINGTRAFFICINPRCT | Threshold | | | +| CRITICALTRAFFICINPRCT | Threshold | | | +| WARNINGTRAFFICOUT | Threshold | | | +| CRITICALTRAFFICOUT | Threshold | | | +| WARNINGTRAFFICOUTPEAK | Threshold | | | +| CRITICALTRAFFICOUTPEAK | Threshold | | | +| WARNINGTRAFFICOUTPRCT | Threshold | | | +| CRITICALTRAFFICOUTPRCT | Threshold | | | +| EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). All options are listed [here](#available-options). | --verbose | | -| Macro | Description | Default value | Mandatory | -|:-------------|:---------------------------------------------------------------------------------------------------|:------------------|:-----------:| -| WARNING | Thresholds | 10 | | -| CRITICAL | Thresholds | 30 | | -| EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). All options are listed [here](#available-options). | | | +| Macro | Description | Default value | Mandatory | +|:-------------|:-------------------------------------------------------------------------------------------------------------------------------------------------|:--------------|:---------:| +| WARNING | Threshold in percentage | 10 | | +| CRITICAL | Threshold in percentage | 30 | | +| EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). All options are listed [here](#available-options). | | | -| Macro | Description | Default value | Mandatory | -|:-------------|:---------------------------------------------------------------------------------------------------|:------------------|:-----------:| -| INTERFACEID | Define which interfaces to check (number expected). Example: 1,2... (empty means 'check all interfaces'). | | | -| WARNINGIN | Thresholds | 80 | | -| CRITICALIN | Thresholds | 90 | | -| WARNINGOUT | Thresholds | 80 | | -| CRITICALOUT | Thresholds | 90 | | -| EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). All options are listed [here](#available-options). | | | +| Macro | Description | Default value | Mandatory | +|:-------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------|:--------------|:---------:| +| INTERFACEID | Check only the interfaces with the specified IDs (OID indexes, e.g.: 1,2,...). If empty, all interfaces will be monitored. To filter on interface names, see --name | | | +| WARNINGIN | Thresholds | 80 | | +| CRITICALIN | Thresholds | 90 | | +| WARNINGOUT | Thresholds | 80 | | +| CRITICALOUT | Thresholds | 90 | | +| EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). All options are listed [here](#available-options). | | | -| Macro | Description | Default value | Mandatory | -|:--------------|:---------------------------------------------------------------------------------------------------|:------------------|:-----------:| -| INTERFACENAME | Define which interfaces to check (number expected). Example: 1,2... (empty means 'check all interfaces'). | | | -| WARNINGIN | Thresholds | 80 | | -| CRITICALIN | Thresholds | 90 | | -| WARNINGOUT | Thresholds | 80 | | -| CRITICALOUT | Thresholds | 90 | | -| EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). All options are listed [here](#available-options). | | | +| Macro | Description | Default value | Mandatory | +|:--------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------|:--------------|:---------:| +| INTERFACENAME | Check only the interfaces with the specified IDs (OID indexes, e.g.: 1,2,...). If empty, all interfaces will be monitored. To filter on interface names, see --name | | | +| WARNINGIN | Thresholds | 80 | | +| CRITICALIN | Thresholds | 90 | | +| WARNINGOUT | Thresholds | 80 | | +| CRITICALOUT | Thresholds | 90 | | +| EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). All options are listed [here](#available-options). | | | -| Macro | Description | Default value | Mandatory | -|:---------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:------------------|:-----------:| -| FILTER | Define which interfaces to check (number expected). Example: 1,2... (empty means 'check all interfaces'). | .* | | -| WARNINGIN | Thresholds | 80 | | -| CRITICALIN | Thresholds | 90 | | -| WARNINGOUT | Thresholds | 80 | | -| CRITICALOUT | Thresholds | 90 | | -| CRITICALSTATUS | Define the conditions to match for the status to be CRITICAL (default: '%\{admstatus\} eq "up" and %\{opstatus\} ne "up"'). You can use the following variables: %\{admstatus\}, %\{opstatus\}, %\{duplexstatus\}, %\{display\} | | | -| EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). All options are listed [here](#available-options). | --verbose | | +| Macro | Description | Default value | Mandatory | +|:---------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------|:-------------------------------------------------|:---------:| +| FILTER | Check only the interfaces with the specified IDs (OID indexes, e.g.: 1,2,...). If empty, all interfaces will be monitored. To filter on interface names, see --name | .* | | +| WARNINGIN | Thresholds | 80 | | +| CRITICALIN | Thresholds | 90 | | +| WARNINGOUT | Thresholds | 80 | | +| CRITICALOUT | Thresholds | 90 | | +| CRITICALSTATUS | Define the conditions to match for the status to be CRITICAL. You can use the following variables: %\{admstatus\}, %\{opstatus\}, %\{duplexstatus\}, %\{display\} | %\{admstatus\} eq "up" and %\{opstatus\} ne "up" | | +| EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). All options are listed [here](#available-options). | --verbose | | -| Macro | Description | Default value | Mandatory | -|:--------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------|:-------------------|:-----------:| -| FILTERID | Filter by ID (regexp can be used) | | | -| FILTERSRCIP | Filter by source IP address (regexp can be used) | | | -| FILTERDSTIP | Filter by destination IP address (regexp can be used) | | | -| WARNINGSTATUS | Define the conditions to match for the status to be WARNING (default: '%\{state\} eq "dead"'). You can use the following variables: %\{state\}, %\{srcIp\}, %\{dstIp\} | %\{state\} eq "dead" | | -| CRITICALSTATUS | Define the conditions to match for the status to be CRITICAL. You can use the following variables: %\{state\}, %\{srcIp\}, %\{dstIp\} | | | -| WARNINGTRAFFIC | Thresholds | | | -| CRITICALTRAFFIC | Thresholds | | | -| WARNINGTRAFFICIN | Thresholds | | | -| CRITICALTRAFFICIN | Thresholds | | | -| WARNINGTRAFFICOUT | Thresholds | | | -| CRITICALTRAFFICOUT | Thresholds | | | -| WARNINGVPNDETECTED | Thresholds | | | -| CRITICALVPNDETECTED | Thresholds | | | -| EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). All options are listed [here](#available-options). | --verbose | | +| Macro | Description | Default value | Mandatory | +|:--------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------|:---------------------|:---------:| +| FILTERID | Filter by ID (regexp can be used) | | | +| FILTERSRCIP | Filter by src ip (regexp can be used) | | | +| FILTERDSTIP | Filter by dst ip (regexp can be used) | | | +| WARNINGSTATUS | Define the conditions to match for the status to be WARNING. You can use the following variables: %\{state\}, %\{srcIp\}, %\{dstIp\} | %\{state\} eq "dead" | | +| CRITICALSTATUS | Define the conditions to match for the status to be CRITICAL. You can use the following variables: %\{state\}, %\{srcIp\}, %\{dstIp\} | | | +| WARNINGTRAFFIC | Threshold | | | +| CRITICALTRAFFIC | Threshold | | | +| WARNINGTRAFFICIN | Threshold | | | +| CRITICALTRAFFICIN | Threshold | | | +| WARNINGTRAFFICOUT | Threshold | | | +| CRITICALTRAFFICOUT | Threshold | | | +| WARNINGVPNDETECTED | Threshold | | | +| CRITICALVPNDETECTED | Threshold | | | +| EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). All options are listed [here](#available-options). | --verbose | | @@ -569,7 +583,7 @@ yum install centreon-plugin-Network-Stormshield-Snmp ## 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 +**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): ```bash @@ -578,7 +592,12 @@ is able to monitor a resource using a command like this one (replace the sample --mode=vpn-status \ --hostname='10.0.0.1' \ --snmp-version='2c' \ - --snmp-community='my-snmp-community' \ + --snmp-community='my-snmp-community' \ + --snmp-username='username' \ + --authpassphrase='' \ + --authprotocol='' \ + --privpassphrase='' \ + --privprotocol='' \ --filter-id='' \ --filter-src-ip='' \ --filter-dst-ip='' \ @@ -598,7 +617,7 @@ is able to monitor a resource using a command like this one (replace the sample The expected command output is shown below: ```bash -OK: detected: 85 All vpn are ok | 'vpn.detected.count'=85;;;0;'*vpn*#vpn.traffic.bitspersecond'=b/s;;;;'*vpn*#vpn.traffic.in.bitspersecond'=b/s;;;;'*vpn*#vpn.traffic.out.bitspersecond'=b/s;;;; +OK: detected: 56562 All vpn are ok | 'vpn.detected.count'=56562;;;0; 'vpn1#vpn.traffic.bitspersecond'=69638b/s;;;; 'vpn2#vpn.traffic.bitspersecond'=95589b/s;;;; 'vpn1#vpn.traffic.in.bitspersecond'=1950b/s;;;; 'vpn2#vpn.traffic.in.bitspersecond'=4118b/s;;;; 'vpn1#vpn.traffic.out.bitspersecond'=71707b/s;;;; 'vpn2#vpn.traffic.out.bitspersecond'=15158b/s;;;; ``` ### Troubleshooting @@ -610,7 +629,7 @@ for Centreon Plugins typical issues. 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 +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 @@ -648,61 +667,67 @@ The plugin brings the following modes: 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. | -| --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 an "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\[,\[newuom\],\[min\],\[m ax\]\] Common examples: 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() | -| --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,namesofnewmetrics,calculation\[,\[ne wuom\],\[min\],\[max\]\] regex: regular expression namesofnewmetrics: 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 newuom (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: 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(traf fic\_(in\|out)\_$1)' | -| --change-short-output --change-long-output | Modify the short/long output that is returned by the plugin. Syntax: --change-short-output=pattern~replacement~modifier Most commonly used modifiers are i (case insensitive) and g (replace all occurrences). Example: adding --change-short-output='OK\~Up\~gi' will replace all occurrences of 'OK', 'ok', 'Ok' or 'oK' with 'Up' | -| --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. | -| --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). E.g.: --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'. | -| --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 ok, 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. | +| 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 get-next 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 ok, 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. | +| --show-password | By default, sensitive information in command lines is hidden in debug output and replaced with `***` (however, debug logs may still display sensitive information). Using the C option will display the passwords in plain text. | +| --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\[,\[\\],\[min\],\[max\]\] Common examples: onvert 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\[,\[\\],\[min\],\[max\]\] Common examples: onvert 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\[,\[\\],\[min\],\[max\]\] Common examples: onvert 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,\,calculation\[,\[\\],\[min\],\[max\]\] regex: regular expression \: 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 \ (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: um 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~replacement~modifier Most commonly used modifiers are i (case insensitive) and g (replace all occurrences). Example: adding --change-short-output='OK~Up~gi' will replace all occurrences of 'OK', 'ok', 'Ok' or 'oK' with 'Up' | +| --change-short-output | Modify the short/long output that is returned by the plugin. Syntax: --change-short-output=pattern~replacement~modifier Most commonly used modifiers are i (case insensitive) and g (replace all occurrences). Example: adding --change-short-output='OK~Up~gi' will replace all occurrences of 'OK', 'ok', 'Ok' or 'oK' with 'Up' | +| --change-long-output | Modify the short/long output that is returned by the plugin. Syntax: --change-short-output=pattern~replacement~modifier Most commonly used modifiers are i (case insensitive) and g (replace all occurrences). Example: adding --change-short-output='OK~Up~gi' will replace all occurrences of 'OK', 'ok', 'Ok' or 'oK' with 'Up' | +| --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'. \. | #### Modes options @@ -711,258 +736,308 @@ All available options for each service template are listed below: -| Option | Description | -|:-----------------------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| --memcached | Memcached server to use (only one server). | -| --redis-server | Redis server to use (only one server). Syntax: address\[:port\] | -| --redis-attribute | Set Redis Options (--redis-attribute="cnx\_timeout=5"). | -| --redis-db | Set Redis database index. | -| --failback-file | Failback on a local file if Redis connection fails. | -| --memexpiration | Time to keep data in seconds (default: 86400). | -| --statefile-dir | Define the cache directory (default: '/var/lib/centreon/centplugins'). | -| --statefile-suffix | Define a suffix to customize the statefile name (default: ''). | -| --statefile-concat-cwd | If used with the '--statefile-dir' option, the latter's value will be used as a sub-directory of the current working directory. Useful on Windows when the plugin is compiled, as the file system and permissions are different from Linux. | -| --statefile-format | Define the format used to store the cache. Available formats: 'dumper', 'storable', 'json' (default). | -| --statefile-key | Define the key to encrypt/decrypt the cache. | -| --statefile-cipher | Define the cipher algorithm to encrypt the cache (default: 'AES'). | -| --warning-* | Warning threshold. Can be: 'tcp', 'udp' | -| --critical-* | Critical threshold. Can be: 'tcp', 'udp' | +| Option | Description | +|:------------------|:--------------------------------------------------------------------------------------------------------------------------| +| --filter-counters | Only display some counters (regexp can be used). Example to check SSL connections only : --filter-counters='^xxxx\|yyyy$' | +| --warning-xxx | Warning threshold. | +| --critical-xxx | Critical threshold. | +| --warning-* | Warning threshold. Can be: 'tcp', 'udp' | +| --critical-* | Critical threshold. Can be: 'tcp', 'udp' | -| Option | Description | -|:-------------------|:----------------------------------------------| -| --use-ucd | Use UCD MIB for CPU average. | -| --warning-average | Warning threshold for average CPU utilization. | -| --critical-average | Critical threshold for average CPU utilization. | -| --warning-core | Warning thresholds for each CPU core | -| --critical-core | Critical threshold for each CPU core | +| Option | Description | +|:-------------------|:--------------------------------------------------------------------------------------------------------------------------| +| --filter-counters | Only display some counters (regexp can be used). Example to check SSL connections only : --filter-counters='^xxxx\|yyyy$' | +| --warning-xxx | Warning threshold. | +| --critical-xxx | Critical threshold. | +| --use-ucd | Use UCD MIB for CPU average. | +| --warning-average | Warning threshold average CPU utilization. | +| --critical-average | Critical threshold average CPU utilization. | +| --warning-core | Warning thresholds for each CPU core | +| --critical-core | Critical thresholds for each CPU core | -| Option | Description | -|:-----------------------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| --memcached | Memcached server to use (only one server). | -| --redis-server | Redis server to use (only one server). Syntax: address\[:port\] | -| --redis-attribute | Set Redis Options (--redis-attribute="cnx\_timeout=5"). | -| --redis-db | Set Redis database index. | -| --failback-file | Failback on a local file if Redis connection fails. | -| --memexpiration | Time to keep data in seconds (default: 86400). | -| --statefile-dir | Define the cache directory (default: '/var/lib/centreon/centplugins'). | -| --statefile-suffix | Define a suffix to customize the statefile name (default: ''). | -| --statefile-concat-cwd | If used with the '--statefile-dir' option, the latter's value will be used as a sub-directory of the current working directory. Useful on Windows when the plugin is compiled, as the file system and permissions are different from Linux. | -| --statefile-format | Define the format used to store the cache. Available formats: 'dumper', 'storable', 'json' (default). | -| --statefile-key | Define the key to encrypt/decrypt the cache. | -| --statefile-cipher | Define the cipher algorithm to encrypt the cache (default: 'AES'). | -| --warning-* | Warning threshold in percent. Can be: 'user', 'nice', 'system', 'idle', 'wait', 'kernel', 'interrupt', 'softirq', 'steal', 'guest', 'guestnice'. | -| --critical-* | Critical threshold in percent. Can be: 'user', 'nice', 'system', 'idle', 'wait', 'kernel', 'interrupt', 'softirq', 'steal', 'guest', 'guestnice'. | +| Option | Description | +|:---------------------|:--------------------------------------------------------------------------------------------------------------------------| +| --filter-counters | Only display some counters (regexp can be used). Example to check SSL connections only : --filter-counters='^xxxx\|yyyy$' | +| --warning-xxx | Warning threshold. | +| --critical-xxx | Critical threshold. | +| --warning-guest | Threshold in percentage. | +| --critical-guest | Threshold in percentage. | +| --warning-guestnice | Threshold in percentage. | +| --critical-guestnice | Threshold in percentage. | +| --warning-idle | Threshold in percentage. | +| --critical-idle | Threshold in percentage. | +| --warning-interrupt | Threshold in percentage. | +| --critical-interrupt | Threshold in percentage. | +| --warning-kernel | Threshold in percentage. | +| --critical-kernel | Threshold in percentage. | +| --warning-nice | Threshold in percentage. | +| --critical-nice | Threshold in percentage. | +| --warning-softirq | Threshold in percentage. | +| --critical-softirq | Threshold in percentage. | +| --warning-steal | Threshold in percentage. | +| --critical-steal | Threshold in percentage. | +| --warning-system | Threshold in percentage. | +| --critical-system | Threshold in percentage. | +| --warning-user | Threshold in percentage. | +| --critical-user | Threshold in percentage. | +| --warning-wait | Threshold in percentage. | +| --critical-wait | Threshold in percentage. | -| Option | Description | -|:------------------------------------------------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| --memcached | Memcached server to use (only one server). | -| --redis-server | Redis server to use (only one server). Syntax: address\[:port\] | -| --redis-attribute | Set Redis Options (--redis-attribute="cnx\_timeout=5"). | -| --redis-db | Set Redis database index. | -| --failback-file | Failback on a local file if Redis connection fails. | -| --memexpiration | Time to keep data in seconds (default: 86400). | -| --statefile-dir | Define the cache directory (default: '/var/lib/centreon/centplugins'). | -| --statefile-suffix | Define a suffix to customize the statefile name (default: ''). | -| --statefile-concat-cwd | If used with the '--statefile-dir' option, the latter's value will be used as a sub-directory of the current working directory. Useful on Windows when the plugin is compiled, as the file system and permissions are different from Linux. | -| --statefile-format | Define the format used to store the cache. Available formats: 'dumper', 'storable', 'json' (default). | -| --statefile-key | Define the key to encrypt/decrypt the cache. | -| --statefile-cipher | Define the cipher algorithm to encrypt the cache (default: 'AES'). | -| --warning-usage | Warning threshold. | -| --critical-usage | Critical threshold. | -| --warning-access | Warning threshold. | -| --critical-access | Critical threshold. Check if storage is readOnly: --critical-access=readOnly | -| --add-access | Check storage access (readOnly, readWrite). | -| --units | Units of thresholds (default: '%') ('%', 'B'). | -| --free | Thresholds are on free space left. | -| --storage | Define the storage units to check (number expected). Example: 1, 2... (empty means 'check all storage units') | -| --name | Allows to use storage name with option --storage instead of storage OID index. | -| --regexp | Allows to use regexp to filter storage (with option --name). | -| --regexp-insensitive | Allows to use regexp non case-sensitive (with --regexp). | -| --path-best-match | Allows to select best path mount point (with --name). | -| --reload-cache-time | Time in minutes before reloading cache file (default: 180). | -| --oid-filter | Choose OID used to filter storage (default: hrStorageDescr) (values: hrStorageDescr, hrFSMountPoint). | -| --oid-display | Choose OID used to display storage (default: hrStorageDescr) (values: hrStorageDescr, hrFSMountPoint). | -| --display-transform-src --display-transform-dst | Modify the storage name displayed by using a regular expression. Example: adding --display-transform-src='dev' --display-transform-dst='run' will replace all occurrences of 'dev' with 'run' | -| --show-cache | Display cache storage data. | -| --space-reservation | Some filesystem has space reserved (like ext4 for root). The value is in percent of total (default: none) (results like 'df' command). | -| --filter-duplicate | Filter duplicate storages (in used size and total size). | -| --filter-storage-type | Filter storage types with a regexp (default: '^(hrStorageFixedDisk\|hrStorageNetworkDisk\|hrFSBerkeleyFFS)$'). | +| Option | Description | +|:------------------------------------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| --filter-counters | Only display some counters (regexp can be used). Example to check SSL connections only : --filter-counters='^xxxx\|yyyy$' | +| --warning-xxx | Warning threshold. | +| --critical-xxx | Critical threshold. | +| --memcached | Memcached server to use (only one server). | +| --redis-server | Redis server to use (only one server). Syntax: address\[:port\] | +| --redis-attribute | Set Redis Options (--redis-attribute="cnx\_timeout=5"). | +| --redis-db | Set Redis database index. | +| --failback-file | Fall back on a local file if Redis connection fails. | +| --memexpiration | Time to keep data in seconds (default: 86400). | +| --statefile-dir | Define the cache directory (default: '/var/lib/centreon/centplugins'). | +| --statefile-suffix | Define a suffix to customize the statefile name (default: ''). | +| --statefile-concat-cwd | If used with the '--statefile-dir' option, the latter's value will be used as a sub-directory of the current working directory. Useful on Windows when the plugin is compiled, as the file system and permissions are different from Linux. | +| --statefile-format | Define the format used to store the cache. Available formats: 'dumper', 'storable', 'json' (default). | +| --statefile-key | Define the key to encrypt/decrypt the cache. | +| --statefile-cipher | Define the cipher algorithm to encrypt the cache (default: 'AES'). | +| --warning-usage | Warning threshold. | +| --critical-usage | Critical threshold. | +| --warning-access | Warning threshold. | +| --critical-access | Critical threshold. Check if storage is readOnly: --critical-access=readOnly | +| --add-access | Check storage access (readOnly, readWrite). | +| --units | Units of thresholds (default: '%') ('%', 'B'). | +| --free | Thresholds are on free space left. | +| --storage | Set the storage (number expected) example: 1, 2,... (empty means 'check all storage'). | +| --name | Allows to use storage name with option --storage instead of storage oid index. | +| --regexp | Allows to use regexp to filter storage (with option --name). | +| --regexp-insensitive | Allows to use regexp non case-sensitive (with --regexp). | +| --path-best-match | Allows to select best path mount point (with --name). | +| --reload-cache-time | Time in minutes before reloading cache file (default: 180). | +| --oid-filter | Choose OID used to filter storage (default: hrStorageDescr) (values: hrStorageDescr, hrFSMountPoint). | +| --oid-display | Choose OID used to display storage (default: hrStorageDescr) (values: hrStorageDescr, hrFSMountPoint). | +| --display-transform-src --display-transform-dst | Modify the storage name displayed by using a regular expression. Example: adding --display-transform-src='dev' --display-transform-dst='run' will replace all occurrences of 'dev' with 'run' | +| --show-cache | Display cache storage data. | +| --space-reservation | Some filesystem has space reserved (like ext4 for root). The value is in percent of total (default: none) (results like 'df' command). | +| --filter-duplicate | Filter duplicate storages (in used size and total size). | +| --filter-storage-type | Filter storage types with a regexp (default: '^(hrStorageFixedDisk\|hrStorageNetworkDisk\|hrFSBerkeleyFFS)$'). | -| Option | Description | -|:----------------------|:---------------------------------------------------------------------------------------------------------------------------------| -| --filter-node | Filter name with regexp (based on serial). | -| --warning-health | Warning threshold on health level (example: --warning 90:). | -| --critical-health | Critical threshold on health level (example --critical 80:). | -| --warning-dead-nodes | Warning threshold on dead nodes (absolute unless --percent is used). | -| --critical-dead-nodes | Critical threshold on dead nodes (absolute unless --percent is used). | +| Option | Description | +|:----------------------|:-------------------------------------------------------------------------------------------------------------------------------------| +| --filter-counters | Only display some counters (regexp can be used). Example to check SSL connections only : --filter-counters='^xxxx\|yyyy$' | +| --warning-xxx | Warning threshold. | +| --critical-xxx | Critical threshold. | +| --filter-node | Filter name with regexp (based on serial). | +| --warning-health | Warning threshold on health level (example: --warning 90:). | +| --critical-health | Critical threshold on health level (example --critical 80:). | +| --warning-dead-nodes | Warning threshold on deadnode (absolute unless --percent is used). | +| --critical-dead-nodes | Critical threshold on deadnode (absolute unless --percent is used). | | --warning-state | Set warning threshold for state. You can use the following variables: %\{state\}, %\{role\}. | -| --critical-state | Set critical threshold for state. (default: '%\{state\} =~ /offline/i'). You can use the following variables: %\{state\}, %\{role\}. | -| --percent | Set this option if you want to warn on percent . | +| --critical-state | Set critical threshold for state. (default: '%\{state\} =~ /offline/i'). You can use the following variables: %\{state\}, %\{role\}. | +| --percent | Set this option if you want to warn on percent . | -| Option | Description | -|:---------------------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| --component | Which component to check (default: '.*'). Can be: 'disk', 'fan', 'psu', 'temperature'. | -| --filter | Exclude the items given as a comma-separated list (example: --filter=fan). You can also exclude items from specific instances: --filter=fan,1 | -| --no-component | Define the expected status if no components are found (default: critical). | -| --threshold-overload | Use this option to override the status returned by the plugin when the status label matches a regular expression (syntax: section,\[instance,\]status,regexp). Example: --threshold-overload='disk,WARNING,missing' | -| --warning | Set warning threshold for 'temperature', 'fan' (syntax: type,regexp,threshold) Example: --warning='temperature,.*,40' | -| --critical | Set critical threshold for 'temperature', 'fan' (syntax: type,regexp,threshold) Example: --critical='temperature,.*,50' | +| Option | Description | +|:---------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| --component | Which component to check (default: '.*'). Can be: 'disk', 'fan', 'psu', 'temperature'. | +| --filter | Exclude the items given as a comma-separated list (example: --filter=fan). You can also exclude items from specific instances: --filter=fan,1 | +| --absent-problem | Return an error if a component is not 'present' (default is skipping). It can be set globally or for a specific instance: --absent-problem='component\_name' or --absent-problem='component\_name,instance\_value'. | +| --no-component | Define the expected status if no components are found (default: critical). | +| --threshold-overload | Use this option to override the status returned by the plugin when the status label matches a regular expression (syntax: section,\[instance,\]status,regexp). Example: --threshold-overload='disk,WARNING,missing' | +| --warning | Set warning threshold for 'temperature', 'fan' (syntax: type,regexp,threshold) Example: --warning='temperature,.*,40' | +| --critical | Set critical threshold for 'temperature', 'fan' (syntax: type,regexp,threshold) Example: --critical='temperature,.*,50' | +| --warning-count-* | Define the warning threshold for the number of components of one type (replace '*' with the component type). | +| --critical-count-* | Define the critical threshold for the number of components of one type (replace '*' with the component type). | -| Option | Description | -|:--------------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------| -| --filter-serial | Filter by firewall serial (can be a regexp). | -| --unknown-service-status | Define the conditions to match for the status to be UNKNOWN. You can use the following variables: %\{health\}, %\{service\} | -| --warning-service-status | Define the conditions to match for the status to be WARNING (default: '%\{health\} =~ /minor/i'). You can use the following variables: %\{health\}, %\{service\} | -| --critical-service-status | Define the conditions to match for the status to be CRITICAL (default: '%\{health\} =~ /major/i'). You can use the following variables: %\{health\}, %\{service\} | +| Option | Description | +|:--------------------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| --filter-counters | Only display some counters (regexp can be used). Example to check SSL connections only : --filter-counters='^xxxx\|yyyy$' | +| --warning-xxx | Warning threshold. | +| --critical-xxx | Critical threshold. | +| --filter-serial | Filter by firewall serial (can be a regexp). | +| --unknown-service-status | Define the conditions to match for the status to be UNKNOWN. You can use the following variables: %\{health\}, %\{service\} | +| --warning-service-status | Define the conditions to match for the status to be WARNING (default: '%\{health\} =~ /minor/i'). You can use the following variables: %\{health\}, %\{service\} | +| --critical-service-status | Define the conditions to match for the status to be CRITICAL (default: '%\{health\} =~ /major/i'). You can use the following variables: %\{health\}, %\{service\} | -| Option | Description | -|:-----------|:----------------------------------------| -| --warning | Warning threshold (1min,5min,15min). | -| --critical | Critical threshold (1min,5min,15min). | -| --average | Load average for the number of CPUs. | +| Option | Description | +|:-----------|:--------------------------------------| +| --warning | Warning threshold (1min,5min,15min). | +| --critical | Critical threshold (1min,5min,15min). | +| --average | Load average for the number of CPUs. | -| Option | Description | -|:----------------|:------------------------------------------------------| -| --warning | Warning threshold in percent. | -| --critical | Critical threshold in percent. | -| --swap | Check swap also. | -| --warning-swap | Warning threshold in percent. | -| --critical-swap | Critical threshold in percent. | -| --no-swap | Status if no active swap (default: 'critical'). | +| Option | Description | +|:----------------|:---------------------------------------------------| +| --warning | Warning threshold in percent. | +| --critical | Critical threshold in percent. | +| --swap | Check swap also. | +| --warning-swap | Warning threshold in percent. | +| --critical-swap | Critical threshold in percent. | +| --no-swap | Threshold if no active swap (default: 'critical'). | -| Option | Description | -|:-------------------------|:-----------------------------------------------------------------------------------------------| -| --warning-* --critical-* | Thresholds. Can be: 'total', 'host', 'frag', 'conn', 'icmp', 'dtrack', 'dyn', 'etherstate'. | +| Option | Description | +|:-------------------------|:--------------------------------------------------------------------------------------------------------------------------| +| --filter-counters | Only display some counters (regexp can be used). Example to check SSL connections only : --filter-counters='^xxxx\|yyyy$' | +| --warning-xxx | Warning threshold. | +| --critical-xxx | Critical threshold. | +| --warning-* --critical-* | Thresholds. Can be: 'total', 'host', 'frag', 'conn', 'icmp', 'dtrack', 'dyn', 'etherstate'. | -| Option | Description | -|:-------------------------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| --memcached | Memcached server to use (only one server). | -| --redis-server | Redis server to use (only one server). Syntax: address\[:port\] | -| --redis-attribute | Set Redis Options (--redis-attribute="cnx\_timeout=5"). | -| --redis-db | Set Redis database index. | -| --failback-file | Failback on a local file if Redis connection fails. | -| --memexpiration | Time to keep data in seconds (default: 86400). | -| --statefile-dir | Define the cache directory (default: '/var/lib/centreon/centplugins'). | -| --statefile-suffix | Define a suffix to customize the statefile name (default: ''). | -| --statefile-concat-cwd | If used with the '--statefile-dir' option, the latter's value will be used as a sub-directory of the current working directory. Useful on Windows when the plugin is compiled, as the file system and permissions are different from Linux. | -| --statefile-format | Define the format used to store the cache. Available formats: 'dumper', 'storable', 'json' (default). | -| --statefile-key | Define the key to encrypt/decrypt the cache. | -| --statefile-cipher | Define the cipher algorithm to encrypt the cache (default: 'AES'). | -| --filter-name | Filter by QoS name (can be a regexp). | -| --speed-in | Set interface speed for incoming traffic (in Mb). | -| --speed-out | Set interface speed for outgoing traffic (in Mb). | -| --warning-* --critical-* | Thresholds. Can be: 'traffic-in', 'traffic-in-prct', 'traffic-in-peak', 'traffic-out', 'traffic-out-prct', 'traffic-out-peak'. | +| Option | Description | +|:-------------------------|:-------------------------------------------------------------------------------------------------------------------------------| +| --filter-counters | Only display some counters (regexp can be used). Example to check SSL connections only : --filter-counters='^xxxx\|yyyy$' | +| --warning-xxx | Warning threshold. | +| --critical-xxx | Critical threshold. | +| --filter-name | Filter by QoS name (can be a regexp). | +| --speed-in | Set interface speed for incoming traffic (in Mb). | +| --speed-out | Set interface speed for outgoing traffic (in Mb). | +| --warning-* --critical-* | Thresholds. Can be: 'traffic-in', 'traffic-in-prct', 'traffic-in-peak', 'traffic-out', 'traffic-out-prct', 'traffic-out-peak'. | -| Option | Description | -|:-------------------------|:------------------------------------------------------------------------| -| --no-swap | Status if no active swap (default: 'critical'). | -| --warning-* --critical-* | Thresholds. Can be: 'usage' (B), 'usage-free' (B), 'usage-prct' (%). | +| Option | Description | +|:----------------------|:--------------------------------------------------------------------------------------------------------------------------| +| --filter-counters | Only display some counters (regexp can be used). Example to check SSL connections only : --filter-counters='^xxxx\|yyyy$' | +| --warning-xxx | Warning threshold. | +| --critical-xxx | Critical threshold. | +| --no-swap | Threshold if no active swap (default: 'critical'). | +| --warning-usage | Threshold in bytes. | +| --critical-usage | Threshold in bytes. | +| --warning-usage-free | Threshold in bytes. | +| --critical-usage-free | Threshold in bytes. | +| --warning-usage-prct | Threshold in percentage. | +| --critical-usage-prct | Threshold in percentage. | -| Option | Description | -|:------------------------------------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| --memcached | Memcached server to use (only one server). | -| --redis-server | Redis server to use (only one server). Syntax: address\[:port\] | -| --redis-attribute | Set Redis Options (--redis-attribute="cnx\_timeout=5"). | -| --redis-db | Set Redis database index. | -| --failback-file | Failback on a local file if Redis connection fails. | -| --memexpiration | Time to keep data in seconds (default: 86400). | -| --statefile-dir | Define the cache directory (default: '/var/lib/centreon/centplugins'). | -| --statefile-suffix | Define a suffix to customize the statefile name (default: ''). | -| --statefile-concat-cwd | If used with the '--statefile-dir' option, the latter's value will be used as a sub-directory of the current working directory. Useful on Windows when the plugin is compiled, as the file system and permissions are different from Linux. | -| --statefile-format | Define the format used to store the cache. Available formats: 'dumper', 'storable', 'json' (default). | -| --statefile-key | Define the key to encrypt/decrypt the cache. | -| --statefile-cipher | Define the cipher algorithm to encrypt the cache (default: 'AES'). | -| --add-global | Check global port statistics (by default if no --add-* option is set). | -| --add-status | Check interface status. | -| --add-duplex-status | Check duplex status (with --warning-status and --critical-status). | -| --add-traffic | Check interface traffic. | -| --add-errors | Check interface errors. | -| --add-cast | Check interface cast. | -| --add-speed | Check interface speed. | -| --add-volume | Check interface data volume between two checks (not supposed to be graphed, useful for BI reporting). | -| --check-metrics | If the expression is true, metrics are checked (default: '%\{opstatus\} eq "up"'). | -| --warning-status | Define the conditions to match for the status to be WARNING. You can use the following variables: %\{admstatus\}, %\{opstatus\}, %\{duplexstatus\}, %\{display\} | -| --critical-status | Define the conditions to match for the status to be CRITICAL (default: '%\{admstatus\} eq "up" and %\{opstatus\} ne "up"'). You can use the following variables: %\{admstatus\}, %\{opstatus\}, %\{duplexstatus\}, %\{display\} | -| --warning-* --critical-* | Thresholds. Can be: 'total-port', 'total-admin-up', 'total-admin-down', 'total-oper-up', 'total-oper-down', 'in-traffic', 'out-traffic', 'in-error', 'in-discard', 'out-error', 'out-discard', 'in-ucast', 'in-bcast', 'in-mcast', 'out-ucast', 'out-bcast', 'out-mcast', 'speed' (b/s). | -| --units-traffic | Units of thresholds for the traffic (default: 'percent\_delta') ('percent\_delta', 'bps', 'counter'). | -| --units-errors | Units of thresholds for errors/discards (default: 'percent\_delta') ('percent\_delta', 'percent', 'delta', 'deltaps', 'counter'). | -| --units-cast | Units of thresholds for communication types (default: 'percent\_delta') ('percent\_delta', 'percent', 'delta', 'deltaps', 'counter'). | -| --nagvis-perfdata | Display traffic perfdata to be compatible with nagvis widget. | -| --interface | Define which interfaces to check (number expected). Example: 1,2... (empty means 'check all interfaces'). | -| --name | Allows you to define the interface (in option --interface) by name instead of OID index. The name matching mode supports regular expressions. | -| --speed | Set interface speed for incoming/outgoing traffic (in Mb). | -| --speed-in | Set interface speed for incoming traffic (in Mb). | -| --speed-out | Set interface speed for outgoing traffic (in Mb). | -| --map-speed-dsl | Get interface speed configuration for interface type 'adsl' and 'vdsl2'. Syntax: --map-speed-dsl=interface-src-name,interface-dsl-name E.g: --map-speed-dsl=Et0.835,Et0-vdsl2 | -| --force-counters64 | Force to use 64-bit counters only. Can be used to improve performance. | -| --force-counters32 | Force to use 32-bit counters (even in snmp v2c and v3). Should be used when 64-bit counters are buggy. | -| --reload-cache-time | Time in minutes before reloading cache file (default: 180). | -| --oid-filter | Define the OID to be used to filter interfaces (default: ifName) (values: ifDesc, ifAlias, ifName, IpAddr). | -| --oid-display | Define the OID that will be used to name the interfaces (default: ifName) (values: ifDesc, ifAlias, ifName, IpAddr). | -| --oid-extra-display | Add an OID to display. | -| --display-transform-src --display-transform-dst | Modify the interface name displayed by using a regular expression. Example: adding --display-transform-src='eth' --display-transform-dst='ens' will replace all occurrences of 'eth' with 'ens' | -| --show-cache | Display cache interface data. | +| Option | Description | +|:------------------------------------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| --filter-counters | Only display some counters (regexp can be used). Example to check SSL connections only : --filter-counters='^xxxx\|yyyy$' | +| --warning-xxx | Warning threshold. | +| --critical-xxx | Critical threshold. | +| --memcached | Memcached server to use (only one server). | +| --redis-server | Redis server to use (only one server). Syntax: address\[:port\] | +| --redis-attribute | Set Redis Options (--redis-attribute="cnx\_timeout=5"). | +| --redis-db | Set Redis database index. | +| --failback-file | Fall back on a local file if Redis connection fails. | +| --memexpiration | Time to keep data in seconds (default: 86400). | +| --statefile-dir | Define the cache directory (default: '/var/lib/centreon/centplugins'). | +| --statefile-suffix | Define a suffix to customize the statefile name (default: ''). | +| --statefile-concat-cwd | If used with the '--statefile-dir' option, the latter's value will be used as a sub-directory of the current working directory. Useful on Windows when the plugin is compiled, as the file system and permissions are different from Linux. | +| --statefile-format | Define the format used to store the cache. Available formats: 'dumper', 'storable', 'json' (default). | +| --statefile-key | Define the key to encrypt/decrypt the cache. | +| --statefile-cipher | Define the cipher algorithm to encrypt the cache (default: 'AES'). | +| --add-global | Check global port statistics (by default if no --add-* option is set). | +| --add-status | Check interface status. | +| --add-duplex-status | Check duplex status (with --warning-status and --critical-status). | +| --add-traffic | Check interface traffic. | +| --add-errors | Check interface errors. | +| --add-cast | Check interface cast. | +| --add-speed | Check interface speed. | +| --add-volume | Check interface data volume between two checks (not supposed to be graphed, useful for BI reporting). | +| --check-metrics | If the expression is true, metrics are checked (default: '%\{opstatus\} eq "up"'). | +| --warning-status | Define the conditions to match for the status to be WARNING. You can use the following variables: %\{admstatus\}, %\{opstatus\}, %\{duplexstatus\}, %\{display\} | +| --critical-status | Define the conditions to match for the status to be CRITICAL (default: '%\{admstatus\} eq "up" and %\{opstatus\} ne "up"'). You can use the following variables: %\{admstatus\}, %\{opstatus\}, %\{duplexstatus\}, %\{display\} | +| --warning-total-port | Thresholds. | +| --critical-total-port | Thresholds. | +| --warning-total-admin-up | Thresholds. | +| --critical-total-admin-up | Thresholds. | +| --warning-total-admin-down | Thresholds. | +| --critical-total-admin-down | Thresholds. | +| --warning-total-oper-up | Thresholds. | +| --critical-total-oper-up | Thresholds. | +| --warning-total-oper-down | Thresholds. | +| --critical-total-oper-down | Thresholds. | +| --warning-in-traffic | Thresholds. | +| --critical-in-traffic | Thresholds. | +| --warning-out-traffic | Thresholds. | +| --critical-out-traffic | Thresholds. | +| --warning-in-error | Thresholds. | +| --critical-in-error | Thresholds. | +| --warning-in-discard | Thresholds. | +| --critical-in-discard | Thresholds. | +| --warning-out-error | Thresholds. | +| --critical-out-error | Thresholds. | +| --warning-out-discard | Thresholds. | +| --critical-out-discard | Thresholds. | +| --warning-in-ucast | Thresholds. | +| --critical-in-ucast | Thresholds. | +| --warning-in-bcast | Thresholds. | +| --critical-in-bcast | Thresholds. | +| --warning-in-mcast | Thresholds. | +| --critical-in-mcast | Thresholds. | +| --warning-out-ucast | Thresholds. | +| --critical-out-ucast | Thresholds. | +| --warning-out-bcast | Thresholds. | +| --critical-out-bcast | Thresholds. | +| --warning-out-mcast | Thresholds. | +| --critical-out-mcast | Thresholds. | +| --warning-speed | Thresholds in b/s. | +| --critical-speed | Thresholds in b/s. | +| --units-traffic | Units of thresholds for the traffic (default: 'percent\_delta') ('percent\_delta', 'bps', 'counter'). | +| --units-errors | Units of thresholds for errors/discards (default: 'percent\_delta') ('percent\_delta', 'delta', 'deltaps', 'counter'). | +| --units-cast | Units of thresholds for communication types (default: 'percent\_delta') ('percent\_delta', 'percent', 'delta', 'deltaps', 'counter'). | +| --nagvis-perfdata | Display traffic perfdata to be compatible with NagVis widget. | +| --interface | Check only the interfaces with the specified IDs (OID indexes, e.g.: 1,2,...). If empty, all interfaces will be monitored. To filter on interface names, see --name. | +| --name | With this option, the interfaces will be filtered by name (given in option --interface) instead of OID index. The name matching mode supports regular expressions. | +| --regex-id | With this option, interface IDs will be filtered using the --interface parameter as a regular expression instead of a list of IDs. | +| --speed | Set interface speed for incoming/outgoing traffic (in Mb). | +| --speed-in | Set interface speed for incoming traffic (in Mb). | +| --speed-out | Set interface speed for outgoing traffic (in Mb). | +| --map-speed-dsl | Get interface speed configuration for interfaces of type 'ADSL' and 'VDSL2'. Syntax: --map-speed-dsl=interface-src-name,interface-dsl-name E.g: --map-speed-dsl=Et0.835,Et0-vdsl2 | +| --force-counters64 | Force to use 64 bits counters only. Can be used to improve performance. | +| --force-counters32 | Force to use 32-bit counters (even with SNMP versions 2c and 3). To use when 64 bits counters are buggy. | +| --reload-cache-time | Time in minutes before reloading cache file (default: 180). | +| --oid-filter | Define the OID to be used to filter interfaces (default: ifName) (values: ifDesc, ifAlias, ifName, IpAddr). | +| --oid-display | Define the OID that will be used to name the interfaces (default: ifName) (values: ifDesc, ifAlias, ifName, IpAddr). | +| --oid-extra-display | Add an OID to display. | +| --display-transform-src --display-transform-dst | Modify the interface name displayed by using a regular expression. Example: adding --display-transform-src='eth' --display-transform-dst='ens' will replace all occurrences of 'eth' with 'ens' | +| --show-cache | Display cache interface data. | +| --no-cache-lock | Set to disable locking when accessing cache. | -| Option | Description | -|:-------------------------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| --memcached | Memcached server to use (only one server). | -| --redis-server | Redis server to use (only one server). Syntax: address\[:port\] | -| --redis-attribute | Set Redis Options (--redis-attribute="cnx\_timeout=5"). | -| --redis-db | Set Redis database index. | -| --failback-file | Failback on a local file if Redis connection fails. | -| --memexpiration | Time to keep data in seconds (default: 86400). | -| --statefile-dir | Define the cache directory (default: '/var/lib/centreon/centplugins'). | -| --statefile-suffix | Define a suffix to customize the statefile name (default: ''). | -| --statefile-concat-cwd | If used with the '--statefile-dir' option, the latter's value will be used as a sub-directory of the current working directory. Useful on Windows when the plugin is compiled, as the file system and permissions are different from Linux. | -| --statefile-format | Define the format used to store the cache. Available formats: 'dumper', 'storable', 'json' (default). | -| --statefile-key | Define the key to encrypt/decrypt the cache. | -| --statefile-cipher | Define the cipher algorithm to encrypt the cache (default: 'AES'). | -| --filter-id | Filter by ID (regexp can be used). | -| --filter-src-ip | Filter by source IP address (regexp can be used). | -| --filter-dst-ip | Filter by destination IP address (regexp can be used). | -| --unknown-status | Define the conditions to match for the status to be UNKNOWN. You can use the following variables: %\{state\}, %\{srcIp\}, %\{dstIp\} | -| --warning-status | Define the conditions to match for the status to be WARNING (default: '%\{state\} eq "dead"'). You can use the following variables: %\{state\}, %\{srcIp\}, %\{dstIp\} | -| --critical-status | Define the conditions to match for the status to be CRITICAL. You can use the following variables: %\{state\}, %\{srcIp\}, %\{dstIp\} | -| --warning-* --critical-* | Thresholds. Can be: 'vpn-detected', 'traffic', 'traffic-in', 'traffic-out'. | +| Option | Description | +|:-------------------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| --filter-counters | Only display some counters (regexp can be used). Example to check SSL connections only : --filter-counters='^xxxx\|yyyy$' | +| --warning-xxx | Warning threshold. | +| --critical-xxx | Critical threshold. | +| --filter-id | Filter by ID (regexp can be used). | +| --filter-src-ip | Filter by src ip (regexp can be used). | +| --filter-dst-ip | Filter by dst ip (regexp can be used). | +| --unknown-status | Define the conditions to match for the status to be UNKNOWN. You can use the following variables: %\{state\}, %\{srcIp\}, %\{dstIp\} | +| --warning-status | Define the conditions to match for the status to be WARNING (default: '%\{state\} eq "dead"'). You can use the following variables: %\{state\}, %\{srcIp\}, %\{dstIp\} | +| --critical-status | Define the conditions to match for the status to be CRITICAL. You can use the following variables: %\{state\}, %\{srcIp\}, %\{dstIp\} | +| --warning-* --critical-* | Thresholds. Can be: 'vpn-detected', 'traffic', 'traffic-in', 'traffic-out'. | diff --git a/pp/integrations/plugin-packs/procedures/network-switchs-aruba-standard-snmp.md b/pp/integrations/plugin-packs/procedures/network-switchs-aruba-standard-snmp.md index 7ba2d5dbd190..a51112b72d34 100644 --- a/pp/integrations/plugin-packs/procedures/network-switchs-aruba-standard-snmp.md +++ b/pp/integrations/plugin-packs/procedures/network-switchs-aruba-standard-snmp.md @@ -49,17 +49,17 @@ The connector brings the following service templates (sorted by the host templat -| Service Alias | Service Template | Service Description | Discovery | -|:---------------------------|:----------------------------------------------------------|:--------------------------------------------------------|:---------:| -| Hardware-Fan | Net-Aruba-Standard-Hardware-Fan-SNMP-custom | Check fan status on hardware | | -| Hardware-Module | Net-Aruba-Standard-Hardware-Module-SNMP-custom | Check module status on hardware | | -| Hardware-Psu | Net-Aruba-Standard-Hardware-Psu-SNMP-custom | Check power supply status on hardware | | -| Packet-Errors-Generic-Id | Net-Aruba-Standard-Packet-Errors-Generic-Id-SNMP-custom | Check packets on errors/discards of a network interface | | -| Packet-Errors-Generic-Name | Net-Aruba-Standard-Packet-Errors-Generic-Name-SNMP-custom | Check packets on errors/discards of a network interface | | -| Packet-Errors-Global | Net-Aruba-Standard-Packet-Errors-Global-SNMP-custom | Check packets on errors/discards of a network interface | X | -| Traffic-Generic-Id | Net-Aruba-Standard-Traffic-Generic-Id-SNMP-custom | Check traffic of an network interface | | -| Traffic-Generic-Name | Net-Aruba-Standard-Traffic-Generic-Name-SNMP-custom | Check traffic of an network interface | | -| Traffic-Global | Net-Aruba-Standard-Traffic-Global-SNMP-custom | Check traffic of an network interface | X | +| Service Alias | Service Template | Service Description | Discovery | +|:---------------------------|:----------------------------------------------------------|:-----------------------------------------------------------------------------|:---------:| +| Hardware-Fan | Net-Aruba-Standard-Hardware-Fan-SNMP-custom | Check fan status on hardware | | +| Hardware-Module | Net-Aruba-Standard-Hardware-Module-SNMP-custom | Check module status on hardware | | +| Hardware-Psu | Net-Aruba-Standard-Hardware-Psu-SNMP-custom | Check power supply status on hardware | | +| Packet-Errors-Generic-Id | Net-Aruba-Standard-Packet-Errors-Generic-Id-SNMP-custom | Check packets in error and discarded packets for multiple network interfaces | | +| Packet-Errors-Generic-Name | Net-Aruba-Standard-Packet-Errors-Generic-Name-SNMP-custom | Check packets in error and discarded packets for a network interface | | +| Packet-Errors-Global | Net-Aruba-Standard-Packet-Errors-Global-SNMP-custom | Check packets in error and discarded packets for multiple network interfaces | X | +| Traffic-Generic-Id | Net-Aruba-Standard-Traffic-Generic-Id-SNMP-custom | Check traffic of an network interface | | +| Traffic-Generic-Name | Net-Aruba-Standard-Traffic-Generic-Name-SNMP-custom | Check traffic of an network interface | | +| Traffic-Global | Net-Aruba-Standard-Traffic-Global-SNMP-custom | Check traffic of an network interface | X | > The services listed above are not created automatically when a host template is applied. To use them, [create a service manually](/docs/monitoring/basic-objects/services), then apply the service template you want. @@ -340,16 +340,18 @@ yum install centreon-plugin-Network-Switchs-Aruba-Standard-Snmp 2. Fill in the **Name**, **Alias** & **IP Address/DNS** fields according to your resource's settings. 3. Apply the **Net-Aruba-Standard-Ap-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](../getting-started/how-to-guides/troubleshooting-plugins.md#snmpv3-options-mapping) section. - -| Macro | Description | Default value | Mandatory | -|:------------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------|:--------------|:---------:| -| ARUBACONTROLLERHOSTNAME | Name or address of the host to monitor (mandatory) | | | -| SNMPPORT | UDP port to send the SNMP request to | 161 | | -| APNAME | Threshold | | | -| SNMPTIMEOUT | Time to wait before sending the request again if no reply has been received, in seconds. See also --snmp-retries | 1 | | -| SNMPEXTRAOPTIONS | Any extra option you may want to add to every command (a --verbose flag for example). All options are listed [here](#available-options). | | | +| Macro | Description | Default value | Mandatory | +|:------------------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------|:--------------|:---------:| +| ARUBACONTROLLERHOSTNAME | Name or address of the host to monitor (mandatory) | | | +| SNMP_V3_USERNAME | SNMP v3 only: User name (`securityName`) | | | +| SNMP_V3_AUTH_PROTOCOL | SNMP v3 only: Authentication protocol: MD5\|SHA. Since net-snmp 5.9.1: SHA224\|SHA256\|SHA384\|SHA512 | | | +| SNMP_V3_PRIV_PROTOCOL | 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 | | | +| SNMPPORT | UDP port to send the SNMP request to | 161 | | +| APNAME | Threshold | | | +| SNMPTIMEOUT | Time to wait before sending the request again if no reply has been received, in seconds. See also --snmp-retries | 1 | | +| SNMP_V3_AUTH_PASSPHRASE | SNMP v3 only: Pass phrase hashed using the authentication protocol defined in the --authprotocol option | | | +| SNMP_V3_PRIV_PASSPHRASE | SNMP v3 only: Privacy pass phrase (`privPassword`) to encrypt messages using the protocol defined in the --privprotocol option | | | +| SNMPEXTRAOPTIONS | Any extra option you may want to add to every command (a --verbose flag for example). All options are listed [here](#available-options). | | | 4. [Deploy the configuration](/docs/monitoring/monitoring-servers/deploying-a-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. @@ -360,12 +362,14 @@ yum install centreon-plugin-Network-Switchs-Aruba-Standard-Snmp 2. Fill in the **Name**, **Alias** & **IP Address/DNS** fields according to your resource's settings. 3. Apply the **Net-Aruba-Standard-Controller-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](../getting-started/how-to-guides/troubleshooting-plugins.md#snmpv3-options-mapping) 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](#available-options). | | | +| Macro | Description | Default value | Mandatory | +|:------------------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------|:--------------|:---------:| +| SNMP_V3_USERNAME | SNMP v3 only: User name (`securityName`) | | | +| SNMP_V3_AUTH_PROTOCOL | SNMP v3 only: Authentication protocol: MD5\|SHA. Since net-snmp 5.9.1: SHA224\|SHA256\|SHA384\|SHA512 | | | +| SNMP_V3_PRIV_PROTOCOL | 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 | | | +| SNMP_V3_AUTH_PASSPHRASE | SNMP v3 only: Pass phrase hashed using the authentication protocol defined in the --authprotocol option | | | +| SNMP_V3_PRIV_PASSPHRASE | SNMP v3 only: Privacy pass phrase (`privPassword`) to encrypt messages using the protocol defined in the --privprotocol option | | | +| SNMPEXTRAOPTIONS | Any extra option you may want to add to every command (a --verbose flag for example). All options are listed [here](#available-options). | | | 4. [Deploy the configuration](/docs/monitoring/monitoring-servers/deploying-a-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. @@ -485,14 +489,14 @@ yum install centreon-plugin-Network-Switchs-Aruba-Standard-Snmp | Macro | Description | Default value | Mandatory | |:-------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------|:--------------|:---------:| | INTERFACEID | Check only the interfaces with the specified IDs (OID indexes, e.g.: 1,2,...). If empty, all interfaces will be monitored. To filter on interface names, see --name | | | -| WARNINGINDISCARD | Threshold | | | -| CRITICALINDISCARD | Threshold | | | -| WARNINGINERROR | Threshold | | | -| CRITICALINERROR | Threshold | | | -| WARNINGOUTDISCARD | Threshold | | | -| CRITICALOUTDISCARD | Threshold | | | -| WARNINGOUTERROR | Threshold | | | -| CRITICALOUTERROR | Threshold | | | +| WARNINGINDISCARD | Thresholds | | | +| CRITICALINDISCARD | Thresholds | | | +| WARNINGINERROR | Thresholds | | | +| CRITICALINERROR | Thresholds | | | +| WARNINGOUTDISCARD | Thresholds | | | +| CRITICALOUTDISCARD | Thresholds | | | +| WARNINGOUTERROR | Thresholds | | | +| CRITICALOUTERROR | Thresholds | | | | EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). All options are listed [here](#available-options). | | | @@ -501,14 +505,14 @@ yum install centreon-plugin-Network-Switchs-Aruba-Standard-Snmp | Macro | Description | Default value | Mandatory | |:-------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------|:--------------|:---------:| | INTERFACENAME | Check only the interfaces with the specified IDs (OID indexes, e.g.: 1,2,...). If empty, all interfaces will be monitored. To filter on interface names, see --name | | | -| WARNINGINDISCARD | Threshold | | | -| CRITICALINDISCARD | Threshold | | | -| WARNINGINERROR | Threshold | | | -| CRITICALINERROR | Threshold | | | -| WARNINGOUTDISCARD | Threshold | | | -| CRITICALOUTDISCARD | Threshold | | | -| WARNINGOUTERROR | Threshold | | | -| CRITICALOUTERROR | Threshold | | | +| WARNINGINDISCARD | Thresholds | | | +| CRITICALINDISCARD | Thresholds | | | +| WARNINGINERROR | Thresholds | | | +| CRITICALINERROR | Thresholds | | | +| WARNINGOUTDISCARD | Thresholds | | | +| CRITICALOUTDISCARD | Thresholds | | | +| WARNINGOUTERROR | Thresholds | | | +| CRITICALOUTERROR | Thresholds | | | | EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). All options are listed [here](#available-options). | | | @@ -517,14 +521,14 @@ yum install centreon-plugin-Network-Switchs-Aruba-Standard-Snmp | Macro | Description | Default value | Mandatory | |:-------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------|:-------------------------------------------------|:---------:| | FILTER | Check only the interfaces with the specified IDs (OID indexes, e.g.: 1,2,...). If empty, all interfaces will be monitored. To filter on interface names, see --name | | | -| WARNINGINDISCARD | Threshold | | | -| CRITICALINDISCARD | Threshold | | | -| WARNINGINERROR | Threshold | | | -| CRITICALINERROR | Threshold | | | -| WARNINGOUTDISCARD | Threshold | | | -| CRITICALOUTDISCARD | Threshold | | | -| WARNINGOUTERROR | Threshold | | | -| CRITICALOUTERROR | Threshold | | | +| WARNINGINDISCARD | Thresholds | | | +| CRITICALINDISCARD | Thresholds | | | +| WARNINGINERROR | Thresholds | | | +| CRITICALINERROR | Thresholds | | | +| WARNINGOUTDISCARD | Thresholds | | | +| CRITICALOUTDISCARD | Thresholds | | | +| WARNINGOUTERROR | Thresholds | | | +| CRITICALOUTERROR | Thresholds | | | | CRITICALSTATUS | Define the conditions to match for the status to be CRITICAL. You can use the following variables: %\{admstatus\}, %\{opstatus\}, %\{duplexstatus\}, %\{display\} | %\{admstatus\} eq "up" and %\{opstatus\} ne "up" | | | EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). All options are listed [here](#available-options). | --verbose | | @@ -543,10 +547,10 @@ yum install centreon-plugin-Network-Switchs-Aruba-Standard-Snmp | Macro | Description | Default value | Mandatory | |:-------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------|:--------------|:---------:| | FILTER | Check only the interfaces with the specified IDs (OID indexes, e.g.: 1,2,...). If empty, all interfaces will be monitored. To filter on interface names, see --name | | | -| WARNINGIN | Threshold | 80 | | -| CRITICALIN | Threshold | 90 | | -| WARNINGOUT | Threshold | 80 | | -| CRITICALOUT | Threshold | 90 | | +| WARNINGIN | Thresholds | 80 | | +| CRITICALIN | Thresholds | 90 | | +| WARNINGOUT | Thresholds | 80 | | +| CRITICALOUT | Thresholds | 90 | | | EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). All options are listed [here](#available-options). | | | @@ -555,10 +559,10 @@ yum install centreon-plugin-Network-Switchs-Aruba-Standard-Snmp | Macro | Description | Default value | Mandatory | |:--------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------|:--------------|:---------:| | INTERFACENAME | Check only the interfaces with the specified IDs (OID indexes, e.g.: 1,2,...). If empty, all interfaces will be monitored. To filter on interface names, see --name | | | -| WARNINGIN | Threshold | 80 | | -| CRITICALIN | Threshold | 90 | | -| WARNINGOUT | Threshold | 80 | | -| CRITICALOUT | Threshold | 90 | | +| WARNINGIN | Thresholds | 80 | | +| CRITICALIN | Thresholds | 90 | | +| WARNINGOUT | Thresholds | 80 | | +| CRITICALOUT | Thresholds | 90 | | | EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). All options are listed [here](#available-options). | | | @@ -567,10 +571,10 @@ yum install centreon-plugin-Network-Switchs-Aruba-Standard-Snmp | Macro | Description | Default value | Mandatory | |:-------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------|:--------------|:---------:| | FILTER | Check only the interfaces with the specified IDs (OID indexes, e.g.: 1,2,...). If empty, all interfaces will be monitored. To filter on interface names, see --name | .* | | -| WARNINGIN | Threshold | 80 | | -| CRITICALIN | Threshold | 90 | | -| WARNINGOUT | Threshold | 80 | | -| CRITICALOUT | Threshold | 90 | | +| WARNINGIN | Thresholds | 80 | | +| CRITICALIN | Thresholds | 90 | | +| WARNINGOUT | Thresholds | 80 | | +| CRITICALOUT | Thresholds | 90 | | | EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). All options are listed [here](#available-options). | --verbose | | @@ -590,7 +594,12 @@ is able to monitor a resource using a command like this one (replace the sample --mode=interfaces \ --hostname=10.0.0.1 \ --snmp-version='2c' \ - --snmp-community='my-snmp-community' \ + --snmp-community='my-snmp-community' \ + --snmp-username='username' \ + --authpassphrase='' \ + --authprotocol='' \ + --privpassphrase='' \ + --privprotocol='' \ --interface='.*' \ --name \ --add-status \ @@ -670,24 +679,25 @@ All generic options are listed here: | --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-force-getnext | Use SNMP get-next 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). | +| --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. | +| --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 ok, warning, critical and unknown (default). | -| --snmp-tls-transport | Transport protocol for TLS communication (can be: 'dtlsudp', 'tlstcp'). | +| --snmp-errors-exit | Expected status in case of SNMP error or timeout. Possible values are ok, 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-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. | +| --show-password | By default, sensitive information in command lines is hidden in debug output and replaced with `***` (however, debug logs may still display sensitive information). Using the C option will display the passwords in plain text. | | --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%;;;; | @@ -695,9 +705,9 @@ All generic options are listed here: | --change-perfdata | Change or extend perfdata. Syntax: --extend-perfdata=searchlabel,newlabel,target\[,\[\\],\[min\],\[max\]\] Common examples: onvert 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\[,\[\\],\[min\],\[max\]\] Common examples: onvert 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,\,calculation\[,\[\\],\[min\],\[max\]\] regex: regular expression \: 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 \ (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: um 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~replacement~modifier Most commonly used modifiers are i (case insensitive) and g (replace all occurrences). Example: adding --change-short-output='OK\~Up\~gi' will replace all occurrences of 'OK', 'ok', 'Ok' or 'oK' with 'Up' | -| --change-short-output | Modify the short/long output that is returned by the plugin. Syntax: --change-short-output=pattern~replacement~modifier Most commonly used modifiers are i (case insensitive) and g (replace all occurrences). Example: adding --change-short-output='OK\~Up\~gi' will replace all occurrences of 'OK', 'ok', 'Ok' or 'oK' with 'Up' | -| --change-long-output | Modify the short/long output that is returned by the plugin. Syntax: --change-short-output=pattern~replacement~modifier Most commonly used modifiers are i (case insensitive) and g (replace all occurrences). Example: adding --change-short-output='OK\~Up\~gi' will replace all occurrences of 'OK', 'ok', 'Ok' or 'oK' with 'Up' | +| --change-short-output --change-long-output | Modify the short/long output that is returned by the plugin. Syntax: --change-short-output=pattern~replacement~modifier Most commonly used modifiers are i (case insensitive) and g (replace all occurrences). Example: adding --change-short-output='OK~Up~gi' will replace all occurrences of 'OK', 'ok', 'Ok' or 'oK' with 'Up' | +| --change-short-output | Modify the short/long output that is returned by the plugin. Syntax: --change-short-output=pattern~replacement~modifier Most commonly used modifiers are i (case insensitive) and g (replace all occurrences). Example: adding --change-short-output='OK~Up~gi' will replace all occurrences of 'OK', 'ok', 'Ok' or 'oK' with 'Up' | +| --change-long-output | Modify the short/long output that is returned by the plugin. Syntax: --change-short-output=pattern~replacement~modifier Most commonly used modifiers are i (case insensitive) and g (replace all occurrences). Example: adding --change-short-output='OK~Up~gi' will replace all occurrences of 'OK', 'ok', 'Ok' or 'oK' with 'Up' | | --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. | @@ -724,6 +734,8 @@ All available options for each service template are listed below: | Option | Description | |:------------------|:--------------------------------------------------------------------------------------------------------------------------| | --filter-counters | Only display some counters (regexp can be used). Example to check SSL connections only : --filter-counters='^xxxx\|yyyy$' | +| --warning-xxx | Warning threshold. | +| --critical-xxx | Critical threshold. | | --warning-* | Warning threshold. Can be: 'stations-associated' (ESSID and BSSID), 'channel-noise', 'signal-noise-ratio' (BSSID). | | --critical-* | Critical threshold. Can be: 'stations-associated' (ESSID and BSSID), 'channel-noise', 'signal-noise-ratio' (BSSID). | | --filter-* | Filter by 'ap', 'essid', 'protocol', 'bssid' (regexp can be used). | @@ -734,6 +746,8 @@ All available options for each service template are listed below: | Option | Description | |:-------------------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | --filter-counters | Only display some counters (regexp can be used). Example to check SSL connections only : --filter-counters='^xxxx\|yyyy$' | +| --warning-xxx | Warning threshold. | +| --critical-xxx | Critical threshold. | | --warning-* --critical-* | Thresholds. Can be: 'connected-current' (global), 'uptime', 'controller-bootstrap', 'reboot', 'status' (per AP). 'status' can use special variables like: %\{name\}, %\{status\}, %\{ip\}, %\{group\}, %\{location\} (default: '') | | --filter-* | Filter by 'ip', 'name', 'group' (regexp can be used). | @@ -743,6 +757,8 @@ All available options for each service template are listed below: | Option | Description | |:------------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | --filter-counters | Only display some counters (regexp can be used). Example to check SSL connections only : --filter-counters='^xxxx\|yyyy$' | +| --warning-xxx | Warning threshold. | +| --critical-xxx | Critical threshold. | | --warning-* | Warning threshold. Can be: 'connected-current' (global), 'status' (per controller). 'status' can use special variables like: %\{name\}, %\{status\}, %\{ip\}, %\{role\}, %\{location\} (default: '') | | --critical-* | Critical threshold. Can be: 'connected-current' (global), 'status' (per controller). 'status' can use special variables like: %\{name\}, %\{status\}, %\{ip\}, %\{role\}, %\{location\} (default: '%\{status\} !~ /active/i') | | --filter-* | Filter by 'ip', 'name', 'location' (regexp can be used). | @@ -753,6 +769,8 @@ All available options for each service template are listed below: | Option | Description | |:-----------------------|:--------------------------------------------------------------------------------------------------------------------------| | --filter-counters | Only display some counters (regexp can be used). Example to check SSL connections only : --filter-counters='^xxxx\|yyyy$' | +| --warning-xxx | Warning threshold. | +| --critical-xxx | Critical threshold. | | --warning-utilization | Warning threshold in percent. | | --critical-utilization | Critical threshold in percent. | @@ -802,6 +820,8 @@ All available options for each service template are listed below: | Option | Description | |:------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | --filter-counters | Only display some counters (regexp can be used). Example to check SSL connections only : --filter-counters='^xxxx\|yyyy$' | +| --warning-xxx | Warning threshold. | +| --critical-xxx | Critical threshold. | | --warning-status | Warning threshold. Can use special variables like:%\{key\}, %\{service\}, %\{flag\}, %\{expires\} (default: '') | | --critical-status | Critical threshold. Can use special variables like: %\{key\}, %\{service\}, %\{flag\}, %\{expires\} (default: '%\{flag\} !~ /enabled/i \|\| (%\{expires\} ne "Never" && %\{expires\} \< 86400)') | @@ -811,58 +831,98 @@ All available options for each service template are listed below: | Option | Description | |:------------------|:--------------------------------------------------------------------------------------------------------------------------| | --filter-counters | Only display some counters (regexp can be used). Example to check SSL connections only : --filter-counters='^xxxx\|yyyy$' | +| --warning-xxx | Warning threshold. | +| --critical-xxx | Critical threshold. | | --warning-usage | Warning threshold in percent. | | --critical-usage | Critical threshold in percent. | -| Option | Description | -|:------------------------------------------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| --filter-counters | Only display some counters (regexp can be used). Example to check SSL connections only : --filter-counters='^xxxx\|yyyy$' | -| --memcached | Memcached server to use (only one server). | -| --redis-server | Redis server to use (only one server). Syntax: address\[:port\] | -| --redis-attribute | Set Redis Options (--redis-attribute="cnx\_timeout=5"). | -| --redis-db | Set Redis database index. | -| --failback-file | Fall back on a local file if Redis connection fails. | -| --memexpiration | Time to keep data in seconds (default: 86400). | -| --statefile-dir | Define the cache directory (default: '/var/lib/centreon/centplugins'). | -| --statefile-suffix | Define a suffix to customize the statefile name (default: ''). | -| --statefile-concat-cwd | If used with the '--statefile-dir' option, the latter's value will be used as a sub-directory of the current working directory. Useful on Windows when the plugin is compiled, as the file system and permissions are different from Linux. | -| --statefile-format | Define the format used to store the cache. Available formats: 'dumper', 'storable', 'json' (default). | -| --statefile-key | Define the key to encrypt/decrypt the cache. | -| --statefile-cipher | Define the cipher algorithm to encrypt the cache (default: 'AES'). | -| --add-global | Check global port statistics (by default if no --add-* option is set). | -| --add-status | Check interface status. | -| --add-duplex-status | Check duplex status (with --warning-status and --critical-status). | -| --add-traffic | Check interface traffic. | -| --add-errors | Check interface errors. | -| --add-cast | Check interface cast. | -| --add-speed | Check interface speed. | -| --add-volume | Check interface data volume between two checks (not supposed to be graphed, useful for BI reporting). | -| --check-metrics | If the expression is true, metrics are checked (default: '%\{opstatus\} eq "up"'). | -| --warning-status | Define the conditions to match for the status to be WARNING. You can use the following variables: %\{admstatus\}, %\{opstatus\}, %\{duplexstatus\}, %\{display\} | -| --critical-status | Define the conditions to match for the status to be CRITICAL (default: '%\{admstatus\} eq "up" and %\{opstatus\} ne "up"'). You can use the following variables: %\{admstatus\}, %\{opstatus\}, %\{duplexstatus\}, %\{display\} | -| --warning-* --critical-* | Thresholds. Can be: 'total-port', 'total-admin-up', 'total-admin-down', 'total-oper-up', 'total-oper-down', 'in-traffic', 'out-traffic', 'in-error', 'in-discard', 'out-error', 'out-discard', 'in-ucast', 'in-bcast', 'in-mcast', 'out-ucast', 'out-bcast', 'out-mcast', 'speed' (b/s). | -| --units-traffic | Units of thresholds for the traffic (default: 'percent\_delta') ('percent\_delta', 'bps', 'counter'). | -| --units-errors | Units of thresholds for errors/discards (default: 'percent\_delta') ('percent\_delta', 'percent', 'delta', 'deltaps', 'counter'). | -| --units-cast | Units of thresholds for communication types (default: 'percent\_delta') ('percent\_delta', 'percent', 'delta', 'deltaps', 'counter'). | -| --nagvis-perfdata | Display traffic perfdata to be compatible with NagVis widget. | -| --interface | Check only the interfaces with the specified IDs (OID indexes, e.g.: 1,2,...). If empty, all interfaces will be monitored. To filter on interface names, see --name. | -| --name | With this option, the interfaces will be filtered by name (given in option --interface) instead of OID index. The name matching mode supports regular expressions. | -| --regex-id | With this option, interface IDs will be filtered using the --interface parameter as a regular expression instead of a list of IDs. | -| --speed | Set interface speed for incoming/outgoing traffic (in Mb). | -| --speed-in | Set interface speed for incoming traffic (in Mb). | -| --speed-out | Set interface speed for outgoing traffic (in Mb). | -| --map-speed-dsl | Get interface speed configuration for interfaces of type 'ADSL' and 'VDSL2'. Syntax: --map-speed-dsl=interface-src-name,interface-dsl-name E.g: --map-speed-dsl=Et0.835,Et0-vdsl2 | -| --force-counters64 | Force to use 64 bits counters only. Can be used to improve performance. | -| --force-counters32 | Force to use 32-bit counters (even with SNMP versions 2c and 3). To use when 64 bits counters are buggy. | -| --reload-cache-time | Time in minutes before reloading cache file (default: 180). | -| --oid-filter | Define the OID to be used to filter interfaces (default: ifName) (values: ifDesc, ifAlias, ifName, IpAddr). | -| --oid-display | Define the OID that will be used to name the interfaces (default: ifName) (values: ifDesc, ifAlias, ifName, IpAddr). | -| --oid-extra-display | Add an OID to display. | -| --display-transform-src --display-transform-dst | Modify the interface name displayed by using a regular expression. Example: adding --display-transform-src='eth' --display-transform-dst='ens' will replace all occurrences of 'eth' with 'ens' | -| --show-cache | Display cache interface data. | +| Option | Description | +|:------------------------------------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| --filter-counters | Only display some counters (regexp can be used). Example to check SSL connections only : --filter-counters='^xxxx\|yyyy$' | +| --warning-xxx | Warning threshold. | +| --critical-xxx | Critical threshold. | +| --memcached | Memcached server to use (only one server). | +| --redis-server | Redis server to use (only one server). Syntax: address\[:port\] | +| --redis-attribute | Set Redis Options (--redis-attribute="cnx\_timeout=5"). | +| --redis-db | Set Redis database index. | +| --failback-file | Fall back on a local file if Redis connection fails. | +| --memexpiration | Time to keep data in seconds (default: 86400). | +| --statefile-dir | Define the cache directory (default: '/var/lib/centreon/centplugins'). | +| --statefile-suffix | Define a suffix to customize the statefile name (default: ''). | +| --statefile-concat-cwd | If used with the '--statefile-dir' option, the latter's value will be used as a sub-directory of the current working directory. Useful on Windows when the plugin is compiled, as the file system and permissions are different from Linux. | +| --statefile-format | Define the format used to store the cache. Available formats: 'dumper', 'storable', 'json' (default). | +| --statefile-key | Define the key to encrypt/decrypt the cache. | +| --statefile-cipher | Define the cipher algorithm to encrypt the cache (default: 'AES'). | +| --add-global | Check global port statistics (by default if no --add-* option is set). | +| --add-status | Check interface status. | +| --add-duplex-status | Check duplex status (with --warning-status and --critical-status). | +| --add-traffic | Check interface traffic. | +| --add-errors | Check interface errors. | +| --add-cast | Check interface cast. | +| --add-speed | Check interface speed. | +| --add-volume | Check interface data volume between two checks (not supposed to be graphed, useful for BI reporting). | +| --check-metrics | If the expression is true, metrics are checked (default: '%\{opstatus\} eq "up"'). | +| --warning-status | Define the conditions to match for the status to be WARNING. You can use the following variables: %\{admstatus\}, %\{opstatus\}, %\{duplexstatus\}, %\{display\} | +| --critical-status | Define the conditions to match for the status to be CRITICAL (default: '%\{admstatus\} eq "up" and %\{opstatus\} ne "up"'). You can use the following variables: %\{admstatus\}, %\{opstatus\}, %\{duplexstatus\}, %\{display\} | +| --warning-total-port | Thresholds. | +| --critical-total-port | Thresholds. | +| --warning-total-admin-up | Thresholds. | +| --critical-total-admin-up | Thresholds. | +| --warning-total-admin-down | Thresholds. | +| --critical-total-admin-down | Thresholds. | +| --warning-total-oper-up | Thresholds. | +| --critical-total-oper-up | Thresholds. | +| --warning-total-oper-down | Thresholds. | +| --critical-total-oper-down | Thresholds. | +| --warning-in-traffic | Thresholds. | +| --critical-in-traffic | Thresholds. | +| --warning-out-traffic | Thresholds. | +| --critical-out-traffic | Thresholds. | +| --warning-in-error | Thresholds. | +| --critical-in-error | Thresholds. | +| --warning-in-discard | Thresholds. | +| --critical-in-discard | Thresholds. | +| --warning-out-error | Thresholds. | +| --critical-out-error | Thresholds. | +| --warning-out-discard | Thresholds. | +| --critical-out-discard | Thresholds. | +| --warning-in-ucast | Thresholds. | +| --critical-in-ucast | Thresholds. | +| --warning-in-bcast | Thresholds. | +| --critical-in-bcast | Thresholds. | +| --warning-in-mcast | Thresholds. | +| --critical-in-mcast | Thresholds. | +| --warning-out-ucast | Thresholds. | +| --critical-out-ucast | Thresholds. | +| --warning-out-bcast | Thresholds. | +| --critical-out-bcast | Thresholds. | +| --warning-out-mcast | Thresholds. | +| --critical-out-mcast | Thresholds. | +| --warning-speed | Thresholds in b/s. | +| --critical-speed | Thresholds in b/s. | +| --units-traffic | Units of thresholds for the traffic (default: 'percent\_delta') ('percent\_delta', 'bps', 'counter'). | +| --units-errors | Units of thresholds for errors/discards (default: 'percent\_delta') ('percent\_delta', 'delta', 'deltaps', 'counter'). | +| --units-cast | Units of thresholds for communication types (default: 'percent\_delta') ('percent\_delta', 'percent', 'delta', 'deltaps', 'counter'). | +| --nagvis-perfdata | Display traffic perfdata to be compatible with NagVis widget. | +| --interface | Check only the interfaces with the specified IDs (OID indexes, e.g.: 1,2,...). If empty, all interfaces will be monitored. To filter on interface names, see --name. | +| --name | With this option, the interfaces will be filtered by name (given in option --interface) instead of OID index. The name matching mode supports regular expressions. | +| --regex-id | With this option, interface IDs will be filtered using the --interface parameter as a regular expression instead of a list of IDs. | +| --speed | Set interface speed for incoming/outgoing traffic (in Mb). | +| --speed-in | Set interface speed for incoming traffic (in Mb). | +| --speed-out | Set interface speed for outgoing traffic (in Mb). | +| --map-speed-dsl | Get interface speed configuration for interfaces of type 'ADSL' and 'VDSL2'. Syntax: --map-speed-dsl=interface-src-name,interface-dsl-name E.g: --map-speed-dsl=Et0.835,Et0-vdsl2 | +| --force-counters64 | Force to use 64 bits counters only. Can be used to improve performance. | +| --force-counters32 | Force to use 32-bit counters (even with SNMP versions 2c and 3). To use when 64 bits counters are buggy. | +| --reload-cache-time | Time in minutes before reloading cache file (default: 180). | +| --oid-filter | Define the OID to be used to filter interfaces (default: ifName) (values: ifDesc, ifAlias, ifName, IpAddr). | +| --oid-display | Define the OID that will be used to name the interfaces (default: ifName) (values: ifDesc, ifAlias, ifName, IpAddr). | +| --oid-extra-display | Add an OID to display. | +| --display-transform-src --display-transform-dst | Modify the interface name displayed by using a regular expression. Example: adding --display-transform-src='eth' --display-transform-dst='ens' will replace all occurrences of 'eth' with 'ens' | +| --show-cache | Display cache interface data. | +| --no-cache-lock | Set to disable locking when accessing cache. | @@ -870,6 +930,8 @@ All available options for each service template are listed below: | Option | Description | |:------------------|:--------------------------------------------------------------------------------------------------------------------------| | --filter-counters | Only display some counters (regexp can be used). Example to check SSL connections only : --filter-counters='^xxxx\|yyyy$' | +| --warning-xxx | Warning threshold. | +| --critical-xxx | Critical threshold. | | --warning-usage | Warning threshold in percent. | | --critical-usage | Critical threshold in percent. | | --filter-name | Filter storage device name (regexp can be used). | @@ -878,52 +940,90 @@ All available options for each service template are listed below: -| Option | Description | -|:------------------------------------------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| --filter-counters | Only display some counters (regexp can be used). Example to check SSL connections only : --filter-counters='^xxxx\|yyyy$' | -| --memcached | Memcached server to use (only one server). | -| --redis-server | Redis server to use (only one server). Syntax: address\[:port\] | -| --redis-attribute | Set Redis Options (--redis-attribute="cnx\_timeout=5"). | -| --redis-db | Set Redis database index. | -| --failback-file | Fall back on a local file if Redis connection fails. | -| --memexpiration | Time to keep data in seconds (default: 86400). | -| --statefile-dir | Define the cache directory (default: '/var/lib/centreon/centplugins'). | -| --statefile-suffix | Define a suffix to customize the statefile name (default: ''). | -| --statefile-concat-cwd | If used with the '--statefile-dir' option, the latter's value will be used as a sub-directory of the current working directory. Useful on Windows when the plugin is compiled, as the file system and permissions are different from Linux. | -| --statefile-format | Define the format used to store the cache. Available formats: 'dumper', 'storable', 'json' (default). | -| --statefile-key | Define the key to encrypt/decrypt the cache. | -| --statefile-cipher | Define the cipher algorithm to encrypt the cache (default: 'AES'). | -| --add-global | Check global port statistics (by default if no --add-* option is set). | -| --add-status | Check interface status. | -| --add-duplex-status | Check duplex status (with --warning-status and --critical-status). | -| --add-traffic | Check interface traffic. | -| --add-errors | Check interface errors. | -| --add-cast | Check interface cast. | -| --add-speed | Check interface speed. | -| --add-volume | Check interface data volume between two checks (not supposed to be graphed, useful for BI reporting). | -| --check-metrics | If the expression is true, metrics are checked (default: '%\{opstatus\} eq "up"'). | -| --warning-status | Define the conditions to match for the status to be WARNING. You can use the following variables: %\{admstatus\}, %\{opstatus\}, %\{duplexstatus\}, %\{display\} | -| --critical-status | Define the conditions to match for the status to be CRITICAL (default: '%\{admstatus\} eq "up" and %\{opstatus\} ne "up"'). You can use the following variables: %\{admstatus\}, %\{opstatus\}, %\{duplexstatus\}, %\{display\} | -| --warning-* --critical-* | Thresholds. Can be: 'total-port', 'total-admin-up', 'total-admin-down', 'total-oper-up', 'total-oper-down', 'in-traffic', 'out-traffic', 'in-error', 'in-discard', 'out-error', 'out-discard', 'in-ucast', 'in-bcast', 'in-mcast', 'out-ucast', 'out-bcast', 'out-mcast', 'speed' (b/s). | -| --units-traffic | Units of thresholds for the traffic (default: 'percent\_delta') ('percent\_delta', 'bps', 'counter'). | -| --units-errors | Units of thresholds for errors/discards (default: 'percent\_delta') ('percent\_delta', 'percent', 'delta', 'deltaps', 'counter'). | -| --units-cast | Units of thresholds for communication types (default: 'percent\_delta') ('percent\_delta', 'percent', 'delta', 'deltaps', 'counter'). | -| --nagvis-perfdata | Display traffic perfdata to be compatible with NagVis widget. | -| --interface | Check only the interfaces with the specified IDs (OID indexes, e.g.: 1,2,...). If empty, all interfaces will be monitored. To filter on interface names, see --name. | -| --name | With this option, the interfaces will be filtered by name (given in option --interface) instead of OID index. The name matching mode supports regular expressions. | -| --regex-id | With this option, interface IDs will be filtered using the --interface parameter as a regular expression instead of a list of IDs. | -| --speed | Set interface speed for incoming/outgoing traffic (in Mb). | -| --speed-in | Set interface speed for incoming traffic (in Mb). | -| --speed-out | Set interface speed for outgoing traffic (in Mb). | -| --map-speed-dsl | Get interface speed configuration for interfaces of type 'ADSL' and 'VDSL2'. Syntax: --map-speed-dsl=interface-src-name,interface-dsl-name E.g: --map-speed-dsl=Et0.835,Et0-vdsl2 | -| --force-counters64 | Force to use 64 bits counters only. Can be used to improve performance. | -| --force-counters32 | Force to use 32-bit counters (even with SNMP versions 2c and 3). To use when 64 bits counters are buggy. | -| --reload-cache-time | Time in minutes before reloading cache file (default: 180). | -| --oid-filter | Define the OID to be used to filter interfaces (default: ifName) (values: ifDesc, ifAlias, ifName, IpAddr). | -| --oid-display | Define the OID that will be used to name the interfaces (default: ifName) (values: ifDesc, ifAlias, ifName, IpAddr). | -| --oid-extra-display | Add an OID to display. | -| --display-transform-src --display-transform-dst | Modify the interface name displayed by using a regular expression. Example: adding --display-transform-src='eth' --display-transform-dst='ens' will replace all occurrences of 'eth' with 'ens' | -| --show-cache | Display cache interface data. | +| Option | Description | +|:------------------------------------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| --filter-counters | Only display some counters (regexp can be used). Example to check SSL connections only : --filter-counters='^xxxx\|yyyy$' | +| --warning-xxx | Warning threshold. | +| --critical-xxx | Critical threshold. | +| --memcached | Memcached server to use (only one server). | +| --redis-server | Redis server to use (only one server). Syntax: address\[:port\] | +| --redis-attribute | Set Redis Options (--redis-attribute="cnx\_timeout=5"). | +| --redis-db | Set Redis database index. | +| --failback-file | Fall back on a local file if Redis connection fails. | +| --memexpiration | Time to keep data in seconds (default: 86400). | +| --statefile-dir | Define the cache directory (default: '/var/lib/centreon/centplugins'). | +| --statefile-suffix | Define a suffix to customize the statefile name (default: ''). | +| --statefile-concat-cwd | If used with the '--statefile-dir' option, the latter's value will be used as a sub-directory of the current working directory. Useful on Windows when the plugin is compiled, as the file system and permissions are different from Linux. | +| --statefile-format | Define the format used to store the cache. Available formats: 'dumper', 'storable', 'json' (default). | +| --statefile-key | Define the key to encrypt/decrypt the cache. | +| --statefile-cipher | Define the cipher algorithm to encrypt the cache (default: 'AES'). | +| --add-global | Check global port statistics (by default if no --add-* option is set). | +| --add-status | Check interface status. | +| --add-duplex-status | Check duplex status (with --warning-status and --critical-status). | +| --add-traffic | Check interface traffic. | +| --add-errors | Check interface errors. | +| --add-cast | Check interface cast. | +| --add-speed | Check interface speed. | +| --add-volume | Check interface data volume between two checks (not supposed to be graphed, useful for BI reporting). | +| --check-metrics | If the expression is true, metrics are checked (default: '%\{opstatus\} eq "up"'). | +| --warning-status | Define the conditions to match for the status to be WARNING. You can use the following variables: %\{admstatus\}, %\{opstatus\}, %\{duplexstatus\}, %\{display\} | +| --critical-status | Define the conditions to match for the status to be CRITICAL (default: '%\{admstatus\} eq "up" and %\{opstatus\} ne "up"'). You can use the following variables: %\{admstatus\}, %\{opstatus\}, %\{duplexstatus\}, %\{display\} | +| --warning-total-port | Thresholds. | +| --critical-total-port | Thresholds. | +| --warning-total-admin-up | Thresholds. | +| --critical-total-admin-up | Thresholds. | +| --warning-total-admin-down | Thresholds. | +| --critical-total-admin-down | Thresholds. | +| --warning-total-oper-up | Thresholds. | +| --critical-total-oper-up | Thresholds. | +| --warning-total-oper-down | Thresholds. | +| --critical-total-oper-down | Thresholds. | +| --warning-in-traffic | Thresholds. | +| --critical-in-traffic | Thresholds. | +| --warning-out-traffic | Thresholds. | +| --critical-out-traffic | Thresholds. | +| --warning-in-error | Thresholds. | +| --critical-in-error | Thresholds. | +| --warning-in-discard | Thresholds. | +| --critical-in-discard | Thresholds. | +| --warning-out-error | Thresholds. | +| --critical-out-error | Thresholds. | +| --warning-out-discard | Thresholds. | +| --critical-out-discard | Thresholds. | +| --warning-in-ucast | Thresholds. | +| --critical-in-ucast | Thresholds. | +| --warning-in-bcast | Thresholds. | +| --critical-in-bcast | Thresholds. | +| --warning-in-mcast | Thresholds. | +| --critical-in-mcast | Thresholds. | +| --warning-out-ucast | Thresholds. | +| --critical-out-ucast | Thresholds. | +| --warning-out-bcast | Thresholds. | +| --critical-out-bcast | Thresholds. | +| --warning-out-mcast | Thresholds. | +| --critical-out-mcast | Thresholds. | +| --warning-speed | Thresholds in b/s. | +| --critical-speed | Thresholds in b/s. | +| --units-traffic | Units of thresholds for the traffic (default: 'percent\_delta') ('percent\_delta', 'bps', 'counter'). | +| --units-errors | Units of thresholds for errors/discards (default: 'percent\_delta') ('percent\_delta', 'delta', 'deltaps', 'counter'). | +| --units-cast | Units of thresholds for communication types (default: 'percent\_delta') ('percent\_delta', 'percent', 'delta', 'deltaps', 'counter'). | +| --nagvis-perfdata | Display traffic perfdata to be compatible with NagVis widget. | +| --interface | Check only the interfaces with the specified IDs (OID indexes, e.g.: 1,2,...). If empty, all interfaces will be monitored. To filter on interface names, see --name. | +| --name | With this option, the interfaces will be filtered by name (given in option --interface) instead of OID index. The name matching mode supports regular expressions. | +| --regex-id | With this option, interface IDs will be filtered using the --interface parameter as a regular expression instead of a list of IDs. | +| --speed | Set interface speed for incoming/outgoing traffic (in Mb). | +| --speed-in | Set interface speed for incoming traffic (in Mb). | +| --speed-out | Set interface speed for outgoing traffic (in Mb). | +| --map-speed-dsl | Get interface speed configuration for interfaces of type 'ADSL' and 'VDSL2'. Syntax: --map-speed-dsl=interface-src-name,interface-dsl-name E.g: --map-speed-dsl=Et0.835,Et0-vdsl2 | +| --force-counters64 | Force to use 64 bits counters only. Can be used to improve performance. | +| --force-counters32 | Force to use 32-bit counters (even with SNMP versions 2c and 3). To use when 64 bits counters are buggy. | +| --reload-cache-time | Time in minutes before reloading cache file (default: 180). | +| --oid-filter | Define the OID to be used to filter interfaces (default: ifName) (values: ifDesc, ifAlias, ifName, IpAddr). | +| --oid-display | Define the OID that will be used to name the interfaces (default: ifName) (values: ifDesc, ifAlias, ifName, IpAddr). | +| --oid-extra-display | Add an OID to display. | +| --display-transform-src --display-transform-dst | Modify the interface name displayed by using a regular expression. Example: adding --display-transform-src='eth' --display-transform-dst='ens' will replace all occurrences of 'eth' with 'ens' | +| --show-cache | Display cache interface data. | +| --no-cache-lock | Set to disable locking when accessing cache. | diff --git a/pp/integrations/plugin-packs/procedures/network-switchs-brocade-snmp.md b/pp/integrations/plugin-packs/procedures/network-switchs-brocade-snmp.md index 3d208b62daff..bd2a0208dea0 100644 --- a/pp/integrations/plugin-packs/procedures/network-switchs-brocade-snmp.md +++ b/pp/integrations/plugin-packs/procedures/network-switchs-brocade-snmp.md @@ -37,8 +37,8 @@ The connector brings the following service templates (sorted by the host templat | Service Alias | Service Template | Service Description | Discovery | |:---------------------------|:---------------------------------------------------|:----------------------------------------------------------------------------------------------------------------------------------------|:---------:| -| Packet-Errors-Generic-Name | Net-Brocade-Packet-Errors-Generic-Name-SNMP-custom | Check packets on errors/discards of a network interface | | -| Packet-Errors-Global | Net-Brocade-Packet-Errors-Global-SNMP-custom | Check packets on errors/discards of multiple network interfaces | X | +| Packet-Errors-Generic-Name | Net-Brocade-Packet-Errors-Generic-Name-SNMP-custom | Check packets in error and discarded packets for a network interface | | +| Packet-Errors-Global | Net-Brocade-Packet-Errors-Global-SNMP-custom | Check packets in error and discarded packets for multiple network interfaces | X | | Traffic-Generic-ID | Net-Brocade-Traffic-Generic-ID-SNMP-custom | Check the bandwidth of the interface. For each checks the name of the interface will appear ("label" shortcut describing the interface) | | | Traffic-Generic-Name | Net-brocade-Traffic-Generic-Name-SNMP-custom | Check the bandwidth of the interface. For each checks the name of the interface will appear ("label" shortcut describing the interface) | | | Traffic-Global | Net-Brocade-Traffic-Global-SNMP-custom | Check the bandwidth of interfaces. For each checks the name of the interface will appear ("label" shortcut describing the interface) | X | @@ -101,15 +101,7 @@ Here is the list of services for this connector, detailing all metrics and statu -| Name | Unit | -|:----------------------------------------------------------|:------| -| *interface_name*#status | N/A | -| *interface_name*#interface.packets.in.discard.percentage | % | -| *interface_name*#interface.packets.in.error.percentage | % | -| *interface_name*#interface.packets.out.discard.percentage | % | -| *interface_name*#interface.packets.out.error.percentage | % | - -> Applies to the following service templates: Packet-Errors-Generic-Name, Packet-Errors-Global +Coming soon @@ -122,13 +114,7 @@ Here is the list of services for this connector, detailing all metrics and statu -| Name | Unit | -|:-----------------------------------------------------|:------| -| *interface_name*#status | N/A | -| *interface_name*#interface.traffic.in.bitspersecond | b/s | -| *interface_name*#interface.traffic.out.bitspersecond | b/s | - -> Applies to the following service templates: Traffic-Generic-Name, Traffic-Global +Coming soon @@ -245,12 +231,14 @@ yum install centreon-plugin-Network-Switchs-Brocade-Snmp 2. Fill in the **Name**, **Alias** & **IP Address/DNS** fields according to your resource's settings. 3. Apply the **Net-Brocade-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](../getting-started/how-to-guides/troubleshooting-plugins.md#snmpv3-options-mapping) 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](#available-options). | | | +| Macro | Description | Default value | Mandatory | +|:------------------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------|:--------------|:---------:| +| SNMP_V3_USERNAME | SNMP v3 only: User name (`securityName`) | | | +| SNMP_V3_AUTH_PROTOCOL | SNMP v3 only: Authentication protocol: MD5\|SHA. Since net-snmp 5.9.1: SHA224\|SHA256\|SHA384\|SHA512 | | | +| SNMP_V3_PRIV_PROTOCOL | 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 | | | +| SNMP_V3_AUTH_PASSPHRASE | SNMP v3 only: Pass phrase hashed using the authentication protocol defined in the --authprotocol option | | | +| SNMP_V3_PRIV_PASSPHRASE | SNMP v3 only: Privacy pass phrase (`privPassword`) to encrypt messages using the protocol defined in the --privprotocol option | | | +| SNMPEXTRAOPTIONS | Any extra option you may want to add to every command (a --verbose flag for example). All options are listed [here](#available-options). | | | 4. [Deploy the configuration](/docs/monitoring/monitoring-servers/deploying-a-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. @@ -371,13 +359,18 @@ is able to monitor a resource using a command like this one (replace the sample --mode=hardware \ --hostname=10.0.0.1 \ --snmp-version='2c' \ - --snmp-community='my-snmp-community' + --snmp-community='my-snmp-community' \ + --snmp-username='username' \ + --authpassphrase='' \ + --authprotocol='' \ + --privpassphrase='' \ + --privprotocol='' ``` The expected command output is shown below: ```bash -OK: All 3 components are ok [ 1/1 switch, 2/2 sensor,]. | 'hardware.switch.count'=1;;;; 'hardware.sensor.count'=2;;;; +OK: All 2 components are ok [1/1 switch, 1/1 sensor]. | 'hardware.switch.count'=1;;;; 'hardware.sensor.count'=1;;;; ``` ### Troubleshooting @@ -434,24 +427,25 @@ All generic options are listed here: | --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-force-getnext | Use SNMP get-next 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). | +| --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. | +| --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 ok, warning, critical and unknown (default). | -| --snmp-tls-transport | Transport protocol for TLS communication (can be: 'dtlsudp', 'tlstcp'). | +| --snmp-errors-exit | Expected status in case of SNMP error or timeout. Possible values are ok, 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-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. | +| --show-password | By default, sensitive information in command lines is hidden in debug output and replaced with `***` (however, debug logs may still display sensitive information). Using the C option will display the passwords in plain text. | | --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%;;;; | @@ -459,9 +453,9 @@ All generic options are listed here: | --change-perfdata | Change or extend perfdata. Syntax: --extend-perfdata=searchlabel,newlabel,target\[,\[\\],\[min\],\[max\]\] Common examples: onvert 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\[,\[\\],\[min\],\[max\]\] Common examples: onvert 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,\,calculation\[,\[\\],\[min\],\[max\]\] regex: regular expression \: 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 \ (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: um 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~replacement~modifier Most commonly used modifiers are i (case insensitive) and g (replace all occurrences). Example: adding --change-short-output='OK\~Up\~gi' will replace all occurrences of 'OK', 'ok', 'Ok' or 'oK' with 'Up' | -| --change-short-output | Modify the short/long output that is returned by the plugin. Syntax: --change-short-output=pattern~replacement~modifier Most commonly used modifiers are i (case insensitive) and g (replace all occurrences). Example: adding --change-short-output='OK\~Up\~gi' will replace all occurrences of 'OK', 'ok', 'Ok' or 'oK' with 'Up' | -| --change-long-output | Modify the short/long output that is returned by the plugin. Syntax: --change-short-output=pattern~replacement~modifier Most commonly used modifiers are i (case insensitive) and g (replace all occurrences). Example: adding --change-short-output='OK\~Up\~gi' will replace all occurrences of 'OK', 'ok', 'Ok' or 'oK' with 'Up' | +| --change-short-output --change-long-output | Modify the short/long output that is returned by the plugin. Syntax: --change-short-output=pattern~replacement~modifier Most commonly used modifiers are i (case insensitive) and g (replace all occurrences). Example: adding --change-short-output='OK~Up~gi' will replace all occurrences of 'OK', 'ok', 'Ok' or 'oK' with 'Up' | +| --change-short-output | Modify the short/long output that is returned by the plugin. Syntax: --change-short-output=pattern~replacement~modifier Most commonly used modifiers are i (case insensitive) and g (replace all occurrences). Example: adding --change-short-output='OK~Up~gi' will replace all occurrences of 'OK', 'ok', 'Ok' or 'oK' with 'Up' | +| --change-long-output | Modify the short/long output that is returned by the plugin. Syntax: --change-short-output=pattern~replacement~modifier Most commonly used modifiers are i (case insensitive) and g (replace all occurrences). Example: adding --change-short-output='OK~Up~gi' will replace all occurrences of 'OK', 'ok', 'Ok' or 'oK' with 'Up' | | --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. | @@ -527,7 +521,6 @@ All available options for each service template are listed below: | --check-metrics | If the expression is true, metrics are checked (default: '%\{opstatus\} eq "up"'). | | --warning-status | Define the conditions to match for the status to be WARNING. You can use the following variables: %\{admstatus\}, %\{opstatus\}, %\{duplexstatus\}, %\{display\} | | --critical-status | Define the conditions to match for the status to be CRITICAL (default: '%\{admstatus\} eq "up" and %\{opstatus\} ne "up"'). You can use the following variables: %\{admstatus\}, %\{opstatus\}, %\{duplexstatus\}, %\{display\} | -| --warning-* --critical-* | Thresholds. Can be: 'total-port', 'total-admin-up', 'total-admin-down', 'total-oper-up', 'total-oper-down', 'in-traffic', 'out-traffic', 'in-crc', 'in-error', 'in-discard', 'out-error', 'out-discard', 'in-ucast', 'in-bcast', 'in-mcast', 'out-ucast', 'out-bcast', 'out-mcast', 'speed' (b/s), 'laser-temp', 'input-power', 'output-power'. | | --units-traffic | Units of thresholds for the traffic (default: 'percent\_delta') ('percent\_delta', 'bps', 'counter'). | | --units-errors | Units of thresholds for errors/discards (default: 'percent\_delta') ('percent\_delta', 'percent', 'delta', 'deltaps', 'counter'). | | --units-cast | Units of thresholds for communication types (default: 'percent\_delta') ('percent\_delta', 'percent', 'delta', 'deltaps', 'counter'). | @@ -547,7 +540,10 @@ All available options for each service template are listed below: | --oid-extra-display | Add an OID to display. | | --display-transform-src --display-transform-dst | Modify the interface name displayed by using a regular expression. Example: adding --display-transform-src='eth' --display-transform-dst='ens' will replace all occurrences of 'eth' with 'ens' | | --show-cache | Display cache interface data. | +| --no-cache-lock | Set to disable locking when accessing cache. | | --filter-counters | Only display some counters (regexp can be used). Example to check SSL connections only : --filter-counters='^xxxx\|yyyy$' | +| --warning-xxx | Warning threshold. | +| --critical-xxx | Critical threshold. | | --memcached | Memcached server to use (only one server). | | --redis-server | Redis server to use (only one server). Syntax: address\[:port\] | | --redis-attribute | Set Redis Options (--redis-attribute="cnx\_timeout=5"). | @@ -561,6 +557,7 @@ All available options for each service template are listed below: | --statefile-key | Define the key to encrypt/decrypt the cache. | | --statefile-cipher | Define the cipher algorithm to encrypt the cache (default: 'AES'). | | --add-optical | Check interface optical. | +| --warning-* --critical-* | Thresholds. Can be: 'total-port', 'total-admin-up', 'total-admin-down', 'total-oper-up', 'total-oper-down', 'in-traffic', 'out-traffic', 'in-crc', 'in-error', 'in-discard', 'out-error', 'out-discard', 'in-ucast', 'in-bcast', 'in-mcast', 'out-ucast', 'out-bcast', 'out-mcast', 'speed' (b/s), 'laser-temp', 'input-power', 'output-power'. | @@ -578,7 +575,6 @@ All available options for each service template are listed below: | --check-metrics | If the expression is true, metrics are checked (default: '%\{opstatus\} eq "up"'). | | --warning-status | Define the conditions to match for the status to be WARNING. You can use the following variables: %\{admstatus\}, %\{opstatus\}, %\{duplexstatus\}, %\{display\} | | --critical-status | Define the conditions to match for the status to be CRITICAL (default: '%\{admstatus\} eq "up" and %\{opstatus\} ne "up"'). You can use the following variables: %\{admstatus\}, %\{opstatus\}, %\{duplexstatus\}, %\{display\} | -| --warning-* --critical-* | Thresholds. Can be: 'total-port', 'total-admin-up', 'total-admin-down', 'total-oper-up', 'total-oper-down', 'in-traffic', 'out-traffic', 'in-crc', 'in-error', 'in-discard', 'out-error', 'out-discard', 'in-ucast', 'in-bcast', 'in-mcast', 'out-ucast', 'out-bcast', 'out-mcast', 'speed' (b/s), 'laser-temp', 'input-power', 'output-power'. | | --units-traffic | Units of thresholds for the traffic (default: 'percent\_delta') ('percent\_delta', 'bps', 'counter'). | | --units-errors | Units of thresholds for errors/discards (default: 'percent\_delta') ('percent\_delta', 'percent', 'delta', 'deltaps', 'counter'). | | --units-cast | Units of thresholds for communication types (default: 'percent\_delta') ('percent\_delta', 'percent', 'delta', 'deltaps', 'counter'). | @@ -598,7 +594,9 @@ All available options for each service template are listed below: | --oid-extra-display | Add an OID to display. | | --display-transform-src --display-transform-dst | Modify the interface name displayed by using a regular expression. Example: adding --display-transform-src='eth' --display-transform-dst='ens' will replace all occurrences of 'eth' with 'ens' | | --show-cache | Display cache interface data. | +| --no-cache-lock | Set to disable locking when accessing cache. | | --add-optical | Check interface optical. | +| --warning-* --critical-* | Thresholds. Can be: 'total-port', 'total-admin-up', 'total-admin-down', 'total-oper-up', 'total-oper-down', 'in-traffic', 'out-traffic', 'in-crc', 'in-error', 'in-discard', 'out-error', 'out-discard', 'in-ucast', 'in-bcast', 'in-mcast', 'out-ucast', 'out-bcast', 'out-mcast', 'speed' (b/s), 'laser-temp', 'input-power', 'output-power'. | @@ -616,7 +614,6 @@ All available options for each service template are listed below: | --check-metrics | If the expression is true, metrics are checked (default: '%\{opstatus\} eq "up"'). | | --warning-status | Define the conditions to match for the status to be WARNING. You can use the following variables: %\{admstatus\}, %\{opstatus\}, %\{duplexstatus\}, %\{display\} | | --critical-status | Define the conditions to match for the status to be CRITICAL (default: '%\{admstatus\} eq "up" and %\{opstatus\} ne "up"'). You can use the following variables: %\{admstatus\}, %\{opstatus\}, %\{duplexstatus\}, %\{display\} | -| --warning-* --critical-* | Thresholds. Can be: 'total-port', 'total-admin-up', 'total-admin-down', 'total-oper-up', 'total-oper-down', 'in-traffic', 'out-traffic', 'in-crc', 'in-error', 'in-discard', 'out-error', 'out-discard', 'in-ucast', 'in-bcast', 'in-mcast', 'out-ucast', 'out-bcast', 'out-mcast', 'speed' (b/s), 'laser-temp', 'input-power', 'output-power'. | | --units-traffic | Units of thresholds for the traffic (default: 'percent\_delta') ('percent\_delta', 'bps', 'counter'). | | --units-errors | Units of thresholds for errors/discards (default: 'percent\_delta') ('percent\_delta', 'percent', 'delta', 'deltaps', 'counter'). | | --units-cast | Units of thresholds for communication types (default: 'percent\_delta') ('percent\_delta', 'percent', 'delta', 'deltaps', 'counter'). | @@ -636,7 +633,9 @@ All available options for each service template are listed below: | --oid-extra-display | Add an OID to display. | | --display-transform-src --display-transform-dst | Modify the interface name displayed by using a regular expression. Example: adding --display-transform-src='eth' --display-transform-dst='ens' will replace all occurrences of 'eth' with 'ens' | | --show-cache | Display cache interface data. | +| --no-cache-lock | Set to disable locking when accessing cache. | | --add-optical | Check interface optical. | +| --warning-* --critical-* | Thresholds. Can be: 'total-port', 'total-admin-up', 'total-admin-down', 'total-oper-up', 'total-oper-down', 'in-traffic', 'out-traffic', 'in-crc', 'in-error', 'in-discard', 'out-error', 'out-discard', 'in-ucast', 'in-bcast', 'in-mcast', 'out-ucast', 'out-bcast', 'out-mcast', 'speed' (b/s), 'laser-temp', 'input-power', 'output-power'. | diff --git a/pp/integrations/plugin-packs/procedures/network-switchs-cisco-smallbusiness-standard-snmp.md b/pp/integrations/plugin-packs/procedures/network-switchs-cisco-smallbusiness-standard-snmp.md index b8f6144c8fa2..6d82a899d2be 100644 --- a/pp/integrations/plugin-packs/procedures/network-switchs-cisco-smallbusiness-standard-snmp.md +++ b/pp/integrations/plugin-packs/procedures/network-switchs-cisco-smallbusiness-standard-snmp.md @@ -254,12 +254,14 @@ yum install centreon-plugin-Network-Switchs-Cisco-Smallbusiness-Standard-Snmp 2. Fill in the **Name**, **Alias** & **IP Address/DNS** fields according to your resource's settings. 3. Apply the **Net-Cisco-Sb-Standard-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](../getting-started/how-to-guides/troubleshooting-plugins.md#snmpv3-options-mapping) 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](#available-options). | | | +| Macro | Description | Default value | Mandatory | +|:------------------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------|:--------------|:---------:| +| SNMP_V3_USERNAME | SNMP v3 only: User name (`securityName`) | | | +| SNMP_V3_AUTH_PROTOCOL | SNMP v3 only: Authentication protocol: MD5\|SHA. Since net-snmp 5.9.1: SHA224\|SHA256\|SHA384\|SHA512 | | | +| SNMP_V3_PRIV_PROTOCOL | 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 | | | +| SNMP_V3_AUTH_PASSPHRASE | SNMP v3 only: Pass phrase hashed using the authentication protocol defined in the --authprotocol option | | | +| SNMP_V3_PRIV_PASSPHRASE | SNMP v3 only: Privacy pass phrase (`privPassword`) to encrypt messages using the protocol defined in the --privprotocol option | | | +| SNMPEXTRAOPTIONS | Any extra option you may want to add to every command (a --verbose flag for example). All options are listed [here](#available-options). | | | 4. [Deploy the configuration](/docs/monitoring/monitoring-servers/deploying-a-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. @@ -291,14 +293,14 @@ yum install centreon-plugin-Network-Switchs-Cisco-Smallbusiness-Standard-Snmp | Macro | Description | Default value | Mandatory | |:-------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------|:--------------|:---------:| | INTERFACEID | Check only the interfaces with the specified IDs (OID indexes, e.g.: 1,2,...). If empty, all interfaces will be monitored. To filter on interface names, see --name | | | -| WARNINGINDISCARD | Threshold | | | -| CRITICALINDISCARD | Threshold | | | -| WARNINGINERROR | Threshold | | | -| CRITICALINERROR | Threshold | | | -| WARNINGOUTDISCARD | Threshold | | | -| CRITICALOUTDISCARD | Threshold | | | -| WARNINGOUTERROR | Threshold | | | -| CRITICALOUTERROR | Threshold | | | +| WARNINGINDISCARD | Thresholds | | | +| CRITICALINDISCARD | Thresholds | | | +| WARNINGINERROR | Thresholds | | | +| CRITICALINERROR | Thresholds | | | +| WARNINGOUTDISCARD | Thresholds | | | +| CRITICALOUTDISCARD | Thresholds | | | +| WARNINGOUTERROR | Thresholds | | | +| CRITICALOUTERROR | Thresholds | | | | EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). All options are listed [here](#available-options). | | | @@ -307,14 +309,14 @@ yum install centreon-plugin-Network-Switchs-Cisco-Smallbusiness-Standard-Snmp | Macro | Description | Default value | Mandatory | |:-------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------|:--------------|:---------:| | INTERFACENAME | Check only the interfaces with the specified IDs (OID indexes, e.g.: 1,2,...). If empty, all interfaces will be monitored. To filter on interface names, see --name | | | -| WARNINGINDISCARD | Threshold | | | -| CRITICALINDISCARD | Threshold | | | -| WARNINGINERROR | Threshold | | | -| CRITICALINERROR | Threshold | | | -| WARNINGOUTDISCARD | Threshold | | | -| CRITICALOUTDISCARD | Threshold | | | -| WARNINGOUTERROR | Threshold | | | -| CRITICALOUTERROR | Threshold | | | +| WARNINGINDISCARD | Thresholds | | | +| CRITICALINDISCARD | Thresholds | | | +| WARNINGINERROR | Thresholds | | | +| CRITICALINERROR | Thresholds | | | +| WARNINGOUTDISCARD | Thresholds | | | +| CRITICALOUTDISCARD | Thresholds | | | +| WARNINGOUTERROR | Thresholds | | | +| CRITICALOUTERROR | Thresholds | | | | EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). All options are listed [here](#available-options). | | | @@ -323,14 +325,14 @@ yum install centreon-plugin-Network-Switchs-Cisco-Smallbusiness-Standard-Snmp | Macro | Description | Default value | Mandatory | |:-------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------|:-------------------------------------------------|:---------:| | FILTER | Check only the interfaces with the specified IDs (OID indexes, e.g.: 1,2,...). If empty, all interfaces will be monitored. To filter on interface names, see --name | .* | | -| WARNINGINDISCARD | Threshold | | | -| CRITICALINDISCARD | Threshold | | | -| WARNINGINERROR | Threshold | | | -| CRITICALINERROR | Threshold | | | -| WARNINGOUTDISCARD | Threshold | | | -| CRITICALOUTDISCARD | Threshold | | | -| WARNINGOUTERROR | Threshold | | | -| CRITICALOUTERROR | Threshold | | | +| WARNINGINDISCARD | Thresholds | | | +| CRITICALINDISCARD | Thresholds | | | +| WARNINGINERROR | Thresholds | | | +| CRITICALINERROR | Thresholds | | | +| WARNINGOUTDISCARD | Thresholds | | | +| CRITICALOUTDISCARD | Thresholds | | | +| WARNINGOUTERROR | Thresholds | | | +| CRITICALOUTERROR | Thresholds | | | | CRITICALSTATUS | Define the conditions to match for the status to be CRITICAL. You can use the following variables: %\{admstatus\}, %\{opstatus\}, %\{duplexstatus\}, %\{display\} | %\{admstatus\} eq "up" and %\{opstatus\} ne "up" | | | EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). All options are listed [here](#available-options). | --verbose | | @@ -363,10 +365,10 @@ yum install centreon-plugin-Network-Switchs-Cisco-Smallbusiness-Standard-Snmp | Macro | Description | Default value | Mandatory | |:-------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------|:--------------|:---------:| | INTERFACEID | Check only the interfaces with the specified IDs (OID indexes, e.g.: 1,2,...). If empty, all interfaces will be monitored. To filter on interface names, see --name | | | -| CRITICALIN | Threshold | 90 | | -| WARNINGIN | Threshold | 80 | | -| CRITICALOUT | Threshold | 90 | | -| WARNINGOUT | Threshold | 80 | | +| CRITICALIN | Thresholds | 90 | | +| WARNINGIN | Thresholds | 80 | | +| CRITICALOUT | Thresholds | 90 | | +| WARNINGOUT | Thresholds | 80 | | | EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). All options are listed [here](#available-options). | | | @@ -375,10 +377,10 @@ yum install centreon-plugin-Network-Switchs-Cisco-Smallbusiness-Standard-Snmp | Macro | Description | Default value | Mandatory | |:--------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------|:--------------|:---------:| | INTERFACENAME | Check only the interfaces with the specified IDs (OID indexes, e.g.: 1,2,...). If empty, all interfaces will be monitored. To filter on interface names, see --name | | | -| CRITICALIN | Threshold | 90 | | -| WARNINGIN | Threshold | 80 | | -| CRITICALOUT | Threshold | 90 | | -| WARNINGOUT | Threshold | 80 | | +| CRITICALIN | Thresholds | 90 | | +| WARNINGIN | Thresholds | 80 | | +| CRITICALOUT | Thresholds | 90 | | +| WARNINGOUT | Thresholds | 80 | | | EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). All options are listed [here](#available-options). | | | @@ -387,10 +389,10 @@ yum install centreon-plugin-Network-Switchs-Cisco-Smallbusiness-Standard-Snmp | Macro | Description | Default value | Mandatory | |:---------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------|:-------------------------------------------------|:---------:| | FILTER | Check only the interfaces with the specified IDs (OID indexes, e.g.: 1,2,...). If empty, all interfaces will be monitored. To filter on interface names, see --name | .* | | -| CRITICALIN | Threshold | 90 | | -| WARNINGIN | Threshold | 80 | | -| CRITICALOUT | Threshold | 90 | | -| WARNINGOUT | Threshold | 80 | | +| CRITICALIN | Thresholds | 90 | | +| WARNINGIN | Thresholds | 80 | | +| CRITICALOUT | Thresholds | 90 | | +| WARNINGOUT | Thresholds | 80 | | | CRITICALSTATUS | Define the conditions to match for the status to be CRITICAL. You can use the following variables: %\{admstatus\}, %\{opstatus\}, %\{duplexstatus\}, %\{display\} | %\{admstatus\} eq "up" and %\{opstatus\} ne "up" | | | EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). All options are listed [here](#available-options). | --verbose | | @@ -411,7 +413,12 @@ is able to monitor a resource using a command like this one (replace the sample --mode=interfaces \ --hostname=10.0.0.1 \ --snmp-version='2c' \ - --snmp-community='my-snmp-community' \ + --snmp-community='my-snmp-community' \ + --snmp-username='username' \ + --authpassphrase='' \ + --authprotocol='' \ + --privpassphrase='' \ + --privprotocol='' \ --interface='.*' \ --name \ --add-status \ @@ -487,24 +494,25 @@ All generic options are listed here: | --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-force-getnext | Use SNMP get-next 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). | +| --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. | +| --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 ok, warning, critical and unknown (default). | -| --snmp-tls-transport | Transport protocol for TLS communication (can be: 'dtlsudp', 'tlstcp'). | +| --snmp-errors-exit | Expected status in case of SNMP error or timeout. Possible values are ok, 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-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. | +| --show-password | By default, sensitive information in command lines is hidden in debug output and replaced with `***` (however, debug logs may still display sensitive information). Using the C option will display the passwords in plain text. | | --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%;;;; | @@ -512,9 +520,9 @@ All generic options are listed here: | --change-perfdata | Change or extend perfdata. Syntax: --extend-perfdata=searchlabel,newlabel,target\[,\[\\],\[min\],\[max\]\] Common examples: onvert 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\[,\[\\],\[min\],\[max\]\] Common examples: onvert 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,\,calculation\[,\[\\],\[min\],\[max\]\] regex: regular expression \: 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 \ (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: um 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~replacement~modifier Most commonly used modifiers are i (case insensitive) and g (replace all occurrences). Example: adding --change-short-output='OK\~Up\~gi' will replace all occurrences of 'OK', 'ok', 'Ok' or 'oK' with 'Up' | -| --change-short-output | Modify the short/long output that is returned by the plugin. Syntax: --change-short-output=pattern~replacement~modifier Most commonly used modifiers are i (case insensitive) and g (replace all occurrences). Example: adding --change-short-output='OK\~Up\~gi' will replace all occurrences of 'OK', 'ok', 'Ok' or 'oK' with 'Up' | -| --change-long-output | Modify the short/long output that is returned by the plugin. Syntax: --change-short-output=pattern~replacement~modifier Most commonly used modifiers are i (case insensitive) and g (replace all occurrences). Example: adding --change-short-output='OK\~Up\~gi' will replace all occurrences of 'OK', 'ok', 'Ok' or 'oK' with 'Up' | +| --change-short-output --change-long-output | Modify the short/long output that is returned by the plugin. Syntax: --change-short-output=pattern~replacement~modifier Most commonly used modifiers are i (case insensitive) and g (replace all occurrences). Example: adding --change-short-output='OK~Up~gi' will replace all occurrences of 'OK', 'ok', 'Ok' or 'oK' with 'Up' | +| --change-short-output | Modify the short/long output that is returned by the plugin. Syntax: --change-short-output=pattern~replacement~modifier Most commonly used modifiers are i (case insensitive) and g (replace all occurrences). Example: adding --change-short-output='OK~Up~gi' will replace all occurrences of 'OK', 'ok', 'Ok' or 'oK' with 'Up' | +| --change-long-output | Modify the short/long output that is returned by the plugin. Syntax: --change-short-output=pattern~replacement~modifier Most commonly used modifiers are i (case insensitive) and g (replace all occurrences). Example: adding --change-short-output='OK~Up~gi' will replace all occurrences of 'OK', 'ok', 'Ok' or 'oK' with 'Up' | | --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. | @@ -561,52 +569,90 @@ All available options for each service template are listed below: -| Option | Description | -|:------------------------------------------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| --filter-counters | Only display some counters (regexp can be used). Example to check SSL connections only : --filter-counters='^xxxx\|yyyy$' | -| --memcached | Memcached server to use (only one server). | -| --redis-server | Redis server to use (only one server). Syntax: address\[:port\] | -| --redis-attribute | Set Redis Options (--redis-attribute="cnx\_timeout=5"). | -| --redis-db | Set Redis database index. | -| --failback-file | Fall back on a local file if Redis connection fails. | -| --memexpiration | Time to keep data in seconds (default: 86400). | -| --statefile-dir | Define the cache directory (default: '/var/lib/centreon/centplugins'). | -| --statefile-suffix | Define a suffix to customize the statefile name (default: ''). | -| --statefile-concat-cwd | If used with the '--statefile-dir' option, the latter's value will be used as a sub-directory of the current working directory. Useful on Windows when the plugin is compiled, as the file system and permissions are different from Linux. | -| --statefile-format | Define the format used to store the cache. Available formats: 'dumper', 'storable', 'json' (default). | -| --statefile-key | Define the key to encrypt/decrypt the cache. | -| --statefile-cipher | Define the cipher algorithm to encrypt the cache (default: 'AES'). | -| --add-global | Check global port statistics (by default if no --add-* option is set). | -| --add-status | Check interface status. | -| --add-duplex-status | Check duplex status (with --warning-status and --critical-status). | -| --add-traffic | Check interface traffic. | -| --add-errors | Check interface errors. | -| --add-cast | Check interface cast. | -| --add-speed | Check interface speed. | -| --add-volume | Check interface data volume between two checks (not supposed to be graphed, useful for BI reporting). | -| --check-metrics | If the expression is true, metrics are checked (default: '%\{opstatus\} eq "up"'). | -| --warning-status | Define the conditions to match for the status to be WARNING. You can use the following variables: %\{admstatus\}, %\{opstatus\}, %\{duplexstatus\}, %\{display\} | -| --critical-status | Define the conditions to match for the status to be CRITICAL (default: '%\{admstatus\} eq "up" and %\{opstatus\} ne "up"'). You can use the following variables: %\{admstatus\}, %\{opstatus\}, %\{duplexstatus\}, %\{display\} | -| --warning-* --critical-* | Thresholds. Can be: 'total-port', 'total-admin-up', 'total-admin-down', 'total-oper-up', 'total-oper-down', 'in-traffic', 'out-traffic', 'in-error', 'in-discard', 'out-error', 'out-discard', 'in-ucast', 'in-bcast', 'in-mcast', 'out-ucast', 'out-bcast', 'out-mcast', 'speed' (b/s). | -| --units-traffic | Units of thresholds for the traffic (default: 'percent\_delta') ('percent\_delta', 'bps', 'counter'). | -| --units-errors | Units of thresholds for errors/discards (default: 'percent\_delta') ('percent\_delta', 'percent', 'delta', 'deltaps', 'counter'). | -| --units-cast | Units of thresholds for communication types (default: 'percent\_delta') ('percent\_delta', 'percent', 'delta', 'deltaps', 'counter'). | -| --nagvis-perfdata | Display traffic perfdata to be compatible with NagVis widget. | -| --interface | Check only the interfaces with the specified IDs (OID indexes, e.g.: 1,2,...). If empty, all interfaces will be monitored. To filter on interface names, see --name. | -| --name | With this option, the interfaces will be filtered by name (given in option --interface) instead of OID index. The name matching mode supports regular expressions. | -| --regex-id | With this option, interface IDs will be filtered using the --interface parameter as a regular expression instead of a list of IDs. | -| --speed | Set interface speed for incoming/outgoing traffic (in Mb). | -| --speed-in | Set interface speed for incoming traffic (in Mb). | -| --speed-out | Set interface speed for outgoing traffic (in Mb). | -| --map-speed-dsl | Get interface speed configuration for interfaces of type 'ADSL' and 'VDSL2'. Syntax: --map-speed-dsl=interface-src-name,interface-dsl-name E.g: --map-speed-dsl=Et0.835,Et0-vdsl2 | -| --force-counters64 | Force to use 64 bits counters only. Can be used to improve performance. | -| --force-counters32 | Force to use 32-bit counters (even with SNMP versions 2c and 3). To use when 64 bits counters are buggy. | -| --reload-cache-time | Time in minutes before reloading cache file (default: 180). | -| --oid-filter | Define the OID to be used to filter interfaces (default: ifName) (values: ifDesc, ifAlias, ifName, IpAddr). | -| --oid-display | Define the OID that will be used to name the interfaces (default: ifName) (values: ifDesc, ifAlias, ifName, IpAddr). | -| --oid-extra-display | Add an OID to display. | -| --display-transform-src --display-transform-dst | Modify the interface name displayed by using a regular expression. Example: adding --display-transform-src='eth' --display-transform-dst='ens' will replace all occurrences of 'eth' with 'ens' | -| --show-cache | Display cache interface data. | +| Option | Description | +|:------------------------------------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| --filter-counters | Only display some counters (regexp can be used). Example to check SSL connections only : --filter-counters='^xxxx\|yyyy$' | +| --warning-xxx | Warning threshold. | +| --critical-xxx | Critical threshold. | +| --memcached | Memcached server to use (only one server). | +| --redis-server | Redis server to use (only one server). Syntax: address\[:port\] | +| --redis-attribute | Set Redis Options (--redis-attribute="cnx\_timeout=5"). | +| --redis-db | Set Redis database index. | +| --failback-file | Fall back on a local file if Redis connection fails. | +| --memexpiration | Time to keep data in seconds (default: 86400). | +| --statefile-dir | Define the cache directory (default: '/var/lib/centreon/centplugins'). | +| --statefile-suffix | Define a suffix to customize the statefile name (default: ''). | +| --statefile-concat-cwd | If used with the '--statefile-dir' option, the latter's value will be used as a sub-directory of the current working directory. Useful on Windows when the plugin is compiled, as the file system and permissions are different from Linux. | +| --statefile-format | Define the format used to store the cache. Available formats: 'dumper', 'storable', 'json' (default). | +| --statefile-key | Define the key to encrypt/decrypt the cache. | +| --statefile-cipher | Define the cipher algorithm to encrypt the cache (default: 'AES'). | +| --add-global | Check global port statistics (by default if no --add-* option is set). | +| --add-status | Check interface status. | +| --add-duplex-status | Check duplex status (with --warning-status and --critical-status). | +| --add-traffic | Check interface traffic. | +| --add-errors | Check interface errors. | +| --add-cast | Check interface cast. | +| --add-speed | Check interface speed. | +| --add-volume | Check interface data volume between two checks (not supposed to be graphed, useful for BI reporting). | +| --check-metrics | If the expression is true, metrics are checked (default: '%\{opstatus\} eq "up"'). | +| --warning-status | Define the conditions to match for the status to be WARNING. You can use the following variables: %\{admstatus\}, %\{opstatus\}, %\{duplexstatus\}, %\{display\} | +| --critical-status | Define the conditions to match for the status to be CRITICAL (default: '%\{admstatus\} eq "up" and %\{opstatus\} ne "up"'). You can use the following variables: %\{admstatus\}, %\{opstatus\}, %\{duplexstatus\}, %\{display\} | +| --warning-total-port | Thresholds. | +| --critical-total-port | Thresholds. | +| --warning-total-admin-up | Thresholds. | +| --critical-total-admin-up | Thresholds. | +| --warning-total-admin-down | Thresholds. | +| --critical-total-admin-down | Thresholds. | +| --warning-total-oper-up | Thresholds. | +| --critical-total-oper-up | Thresholds. | +| --warning-total-oper-down | Thresholds. | +| --critical-total-oper-down | Thresholds. | +| --warning-in-traffic | Thresholds. | +| --critical-in-traffic | Thresholds. | +| --warning-out-traffic | Thresholds. | +| --critical-out-traffic | Thresholds. | +| --warning-in-error | Thresholds. | +| --critical-in-error | Thresholds. | +| --warning-in-discard | Thresholds. | +| --critical-in-discard | Thresholds. | +| --warning-out-error | Thresholds. | +| --critical-out-error | Thresholds. | +| --warning-out-discard | Thresholds. | +| --critical-out-discard | Thresholds. | +| --warning-in-ucast | Thresholds. | +| --critical-in-ucast | Thresholds. | +| --warning-in-bcast | Thresholds. | +| --critical-in-bcast | Thresholds. | +| --warning-in-mcast | Thresholds. | +| --critical-in-mcast | Thresholds. | +| --warning-out-ucast | Thresholds. | +| --critical-out-ucast | Thresholds. | +| --warning-out-bcast | Thresholds. | +| --critical-out-bcast | Thresholds. | +| --warning-out-mcast | Thresholds. | +| --critical-out-mcast | Thresholds. | +| --warning-speed | Thresholds in b/s. | +| --critical-speed | Thresholds in b/s. | +| --units-traffic | Units of thresholds for the traffic (default: 'percent\_delta') ('percent\_delta', 'bps', 'counter'). | +| --units-errors | Units of thresholds for errors/discards (default: 'percent\_delta') ('percent\_delta', 'delta', 'deltaps', 'counter'). | +| --units-cast | Units of thresholds for communication types (default: 'percent\_delta') ('percent\_delta', 'percent', 'delta', 'deltaps', 'counter'). | +| --nagvis-perfdata | Display traffic perfdata to be compatible with NagVis widget. | +| --interface | Check only the interfaces with the specified IDs (OID indexes, e.g.: 1,2,...). If empty, all interfaces will be monitored. To filter on interface names, see --name. | +| --name | With this option, the interfaces will be filtered by name (given in option --interface) instead of OID index. The name matching mode supports regular expressions. | +| --regex-id | With this option, interface IDs will be filtered using the --interface parameter as a regular expression instead of a list of IDs. | +| --speed | Set interface speed for incoming/outgoing traffic (in Mb). | +| --speed-in | Set interface speed for incoming traffic (in Mb). | +| --speed-out | Set interface speed for outgoing traffic (in Mb). | +| --map-speed-dsl | Get interface speed configuration for interfaces of type 'ADSL' and 'VDSL2'. Syntax: --map-speed-dsl=interface-src-name,interface-dsl-name E.g: --map-speed-dsl=Et0.835,Et0-vdsl2 | +| --force-counters64 | Force to use 64 bits counters only. Can be used to improve performance. | +| --force-counters32 | Force to use 32-bit counters (even with SNMP versions 2c and 3). To use when 64 bits counters are buggy. | +| --reload-cache-time | Time in minutes before reloading cache file (default: 180). | +| --oid-filter | Define the OID to be used to filter interfaces (default: ifName) (values: ifDesc, ifAlias, ifName, IpAddr). | +| --oid-display | Define the OID that will be used to name the interfaces (default: ifName) (values: ifDesc, ifAlias, ifName, IpAddr). | +| --oid-extra-display | Add an OID to display. | +| --display-transform-src --display-transform-dst | Modify the interface name displayed by using a regular expression. Example: adding --display-transform-src='eth' --display-transform-dst='ens' will replace all occurrences of 'eth' with 'ens' | +| --show-cache | Display cache interface data. | +| --no-cache-lock | Set to disable locking when accessing cache. | @@ -614,6 +660,8 @@ All available options for each service template are listed below: | Option | Description | |:------------------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | --filter-counters | Only display some counters (regexp can be used). Example to check SSL connections only : --filter-counters='^xxxx\|yyyy$' | +| --warning-xxx | Warning threshold. | +| --critical-xxx | Critical threshold. | | --filter-port | Filter on port description (can be a regexp). | | --warning-status | Define the conditions to match for the status to be WARNING. You can use the following variables: %\{state\}, %\{op\_status\}, %\{admin\_status\}, %\{port\}, %\{index\}. | | --critical-status | Define the conditions to match for the status to be CRITICAL (default: '%\{op\_status\} =~ /up/ && %\{state\} =~ /blocking\|broken/'). You can use the following variables: %\{state\}, %\{op\_status\}, %\{admin\_status\}, %\{port\}, %\{index\}. | @@ -624,6 +672,8 @@ All available options for each service template are listed below: | Option | Description | |:------------------------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------| | --filter-counters | Only display some counters (regexp can be used). Example to check SSL connections only : --filter-counters='^xxxx\|yyyy$' | +| --warning-xxx | Warning threshold. | +| --critical-xxx | Critical threshold. | | --warning-member-connection-status | Set warning threshold for member connection status. You can use the following variables: %\{connectionStatus\}, %\{connectionSide\}, %\{connectedMemberUnit\} | | --critical-member-connection-status | Set critical threshold for member connection status. You can use the following variables: %\{connectionStatus\}, %\{connectionSide\}, %\{connectedMemberUnit\} | | --warning-members-detected | Thresholds. | @@ -634,52 +684,90 @@ All available options for each service template are listed below: -| Option | Description | -|:------------------------------------------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| --filter-counters | Only display some counters (regexp can be used). Example to check SSL connections only : --filter-counters='^xxxx\|yyyy$' | -| --memcached | Memcached server to use (only one server). | -| --redis-server | Redis server to use (only one server). Syntax: address\[:port\] | -| --redis-attribute | Set Redis Options (--redis-attribute="cnx\_timeout=5"). | -| --redis-db | Set Redis database index. | -| --failback-file | Fall back on a local file if Redis connection fails. | -| --memexpiration | Time to keep data in seconds (default: 86400). | -| --statefile-dir | Define the cache directory (default: '/var/lib/centreon/centplugins'). | -| --statefile-suffix | Define a suffix to customize the statefile name (default: ''). | -| --statefile-concat-cwd | If used with the '--statefile-dir' option, the latter's value will be used as a sub-directory of the current working directory. Useful on Windows when the plugin is compiled, as the file system and permissions are different from Linux. | -| --statefile-format | Define the format used to store the cache. Available formats: 'dumper', 'storable', 'json' (default). | -| --statefile-key | Define the key to encrypt/decrypt the cache. | -| --statefile-cipher | Define the cipher algorithm to encrypt the cache (default: 'AES'). | -| --add-global | Check global port statistics (by default if no --add-* option is set). | -| --add-status | Check interface status. | -| --add-duplex-status | Check duplex status (with --warning-status and --critical-status). | -| --add-traffic | Check interface traffic. | -| --add-errors | Check interface errors. | -| --add-cast | Check interface cast. | -| --add-speed | Check interface speed. | -| --add-volume | Check interface data volume between two checks (not supposed to be graphed, useful for BI reporting). | -| --check-metrics | If the expression is true, metrics are checked (default: '%\{opstatus\} eq "up"'). | -| --warning-status | Define the conditions to match for the status to be WARNING. You can use the following variables: %\{admstatus\}, %\{opstatus\}, %\{duplexstatus\}, %\{display\} | -| --critical-status | Define the conditions to match for the status to be CRITICAL (default: '%\{admstatus\} eq "up" and %\{opstatus\} ne "up"'). You can use the following variables: %\{admstatus\}, %\{opstatus\}, %\{duplexstatus\}, %\{display\} | -| --warning-* --critical-* | Thresholds. Can be: 'total-port', 'total-admin-up', 'total-admin-down', 'total-oper-up', 'total-oper-down', 'in-traffic', 'out-traffic', 'in-error', 'in-discard', 'out-error', 'out-discard', 'in-ucast', 'in-bcast', 'in-mcast', 'out-ucast', 'out-bcast', 'out-mcast', 'speed' (b/s). | -| --units-traffic | Units of thresholds for the traffic (default: 'percent\_delta') ('percent\_delta', 'bps', 'counter'). | -| --units-errors | Units of thresholds for errors/discards (default: 'percent\_delta') ('percent\_delta', 'percent', 'delta', 'deltaps', 'counter'). | -| --units-cast | Units of thresholds for communication types (default: 'percent\_delta') ('percent\_delta', 'percent', 'delta', 'deltaps', 'counter'). | -| --nagvis-perfdata | Display traffic perfdata to be compatible with NagVis widget. | -| --interface | Check only the interfaces with the specified IDs (OID indexes, e.g.: 1,2,...). If empty, all interfaces will be monitored. To filter on interface names, see --name. | -| --name | With this option, the interfaces will be filtered by name (given in option --interface) instead of OID index. The name matching mode supports regular expressions. | -| --regex-id | With this option, interface IDs will be filtered using the --interface parameter as a regular expression instead of a list of IDs. | -| --speed | Set interface speed for incoming/outgoing traffic (in Mb). | -| --speed-in | Set interface speed for incoming traffic (in Mb). | -| --speed-out | Set interface speed for outgoing traffic (in Mb). | -| --map-speed-dsl | Get interface speed configuration for interfaces of type 'ADSL' and 'VDSL2'. Syntax: --map-speed-dsl=interface-src-name,interface-dsl-name E.g: --map-speed-dsl=Et0.835,Et0-vdsl2 | -| --force-counters64 | Force to use 64 bits counters only. Can be used to improve performance. | -| --force-counters32 | Force to use 32-bit counters (even with SNMP versions 2c and 3). To use when 64 bits counters are buggy. | -| --reload-cache-time | Time in minutes before reloading cache file (default: 180). | -| --oid-filter | Define the OID to be used to filter interfaces (default: ifName) (values: ifDesc, ifAlias, ifName, IpAddr). | -| --oid-display | Define the OID that will be used to name the interfaces (default: ifName) (values: ifDesc, ifAlias, ifName, IpAddr). | -| --oid-extra-display | Add an OID to display. | -| --display-transform-src --display-transform-dst | Modify the interface name displayed by using a regular expression. Example: adding --display-transform-src='eth' --display-transform-dst='ens' will replace all occurrences of 'eth' with 'ens' | -| --show-cache | Display cache interface data. | +| Option | Description | +|:------------------------------------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| --filter-counters | Only display some counters (regexp can be used). Example to check SSL connections only : --filter-counters='^xxxx\|yyyy$' | +| --warning-xxx | Warning threshold. | +| --critical-xxx | Critical threshold. | +| --memcached | Memcached server to use (only one server). | +| --redis-server | Redis server to use (only one server). Syntax: address\[:port\] | +| --redis-attribute | Set Redis Options (--redis-attribute="cnx\_timeout=5"). | +| --redis-db | Set Redis database index. | +| --failback-file | Fall back on a local file if Redis connection fails. | +| --memexpiration | Time to keep data in seconds (default: 86400). | +| --statefile-dir | Define the cache directory (default: '/var/lib/centreon/centplugins'). | +| --statefile-suffix | Define a suffix to customize the statefile name (default: ''). | +| --statefile-concat-cwd | If used with the '--statefile-dir' option, the latter's value will be used as a sub-directory of the current working directory. Useful on Windows when the plugin is compiled, as the file system and permissions are different from Linux. | +| --statefile-format | Define the format used to store the cache. Available formats: 'dumper', 'storable', 'json' (default). | +| --statefile-key | Define the key to encrypt/decrypt the cache. | +| --statefile-cipher | Define the cipher algorithm to encrypt the cache (default: 'AES'). | +| --add-global | Check global port statistics (by default if no --add-* option is set). | +| --add-status | Check interface status. | +| --add-duplex-status | Check duplex status (with --warning-status and --critical-status). | +| --add-traffic | Check interface traffic. | +| --add-errors | Check interface errors. | +| --add-cast | Check interface cast. | +| --add-speed | Check interface speed. | +| --add-volume | Check interface data volume between two checks (not supposed to be graphed, useful for BI reporting). | +| --check-metrics | If the expression is true, metrics are checked (default: '%\{opstatus\} eq "up"'). | +| --warning-status | Define the conditions to match for the status to be WARNING. You can use the following variables: %\{admstatus\}, %\{opstatus\}, %\{duplexstatus\}, %\{display\} | +| --critical-status | Define the conditions to match for the status to be CRITICAL (default: '%\{admstatus\} eq "up" and %\{opstatus\} ne "up"'). You can use the following variables: %\{admstatus\}, %\{opstatus\}, %\{duplexstatus\}, %\{display\} | +| --warning-total-port | Thresholds. | +| --critical-total-port | Thresholds. | +| --warning-total-admin-up | Thresholds. | +| --critical-total-admin-up | Thresholds. | +| --warning-total-admin-down | Thresholds. | +| --critical-total-admin-down | Thresholds. | +| --warning-total-oper-up | Thresholds. | +| --critical-total-oper-up | Thresholds. | +| --warning-total-oper-down | Thresholds. | +| --critical-total-oper-down | Thresholds. | +| --warning-in-traffic | Thresholds. | +| --critical-in-traffic | Thresholds. | +| --warning-out-traffic | Thresholds. | +| --critical-out-traffic | Thresholds. | +| --warning-in-error | Thresholds. | +| --critical-in-error | Thresholds. | +| --warning-in-discard | Thresholds. | +| --critical-in-discard | Thresholds. | +| --warning-out-error | Thresholds. | +| --critical-out-error | Thresholds. | +| --warning-out-discard | Thresholds. | +| --critical-out-discard | Thresholds. | +| --warning-in-ucast | Thresholds. | +| --critical-in-ucast | Thresholds. | +| --warning-in-bcast | Thresholds. | +| --critical-in-bcast | Thresholds. | +| --warning-in-mcast | Thresholds. | +| --critical-in-mcast | Thresholds. | +| --warning-out-ucast | Thresholds. | +| --critical-out-ucast | Thresholds. | +| --warning-out-bcast | Thresholds. | +| --critical-out-bcast | Thresholds. | +| --warning-out-mcast | Thresholds. | +| --critical-out-mcast | Thresholds. | +| --warning-speed | Thresholds in b/s. | +| --critical-speed | Thresholds in b/s. | +| --units-traffic | Units of thresholds for the traffic (default: 'percent\_delta') ('percent\_delta', 'bps', 'counter'). | +| --units-errors | Units of thresholds for errors/discards (default: 'percent\_delta') ('percent\_delta', 'delta', 'deltaps', 'counter'). | +| --units-cast | Units of thresholds for communication types (default: 'percent\_delta') ('percent\_delta', 'percent', 'delta', 'deltaps', 'counter'). | +| --nagvis-perfdata | Display traffic perfdata to be compatible with NagVis widget. | +| --interface | Check only the interfaces with the specified IDs (OID indexes, e.g.: 1,2,...). If empty, all interfaces will be monitored. To filter on interface names, see --name. | +| --name | With this option, the interfaces will be filtered by name (given in option --interface) instead of OID index. The name matching mode supports regular expressions. | +| --regex-id | With this option, interface IDs will be filtered using the --interface parameter as a regular expression instead of a list of IDs. | +| --speed | Set interface speed for incoming/outgoing traffic (in Mb). | +| --speed-in | Set interface speed for incoming traffic (in Mb). | +| --speed-out | Set interface speed for outgoing traffic (in Mb). | +| --map-speed-dsl | Get interface speed configuration for interfaces of type 'ADSL' and 'VDSL2'. Syntax: --map-speed-dsl=interface-src-name,interface-dsl-name E.g: --map-speed-dsl=Et0.835,Et0-vdsl2 | +| --force-counters64 | Force to use 64 bits counters only. Can be used to improve performance. | +| --force-counters32 | Force to use 32-bit counters (even with SNMP versions 2c and 3). To use when 64 bits counters are buggy. | +| --reload-cache-time | Time in minutes before reloading cache file (default: 180). | +| --oid-filter | Define the OID to be used to filter interfaces (default: ifName) (values: ifDesc, ifAlias, ifName, IpAddr). | +| --oid-display | Define the OID that will be used to name the interfaces (default: ifName) (values: ifDesc, ifAlias, ifName, IpAddr). | +| --oid-extra-display | Add an OID to display. | +| --display-transform-src --display-transform-dst | Modify the interface name displayed by using a regular expression. Example: adding --display-transform-src='eth' --display-transform-dst='ens' will replace all occurrences of 'eth' with 'ens' | +| --show-cache | Display cache interface data. | +| --no-cache-lock | Set to disable locking when accessing cache. | diff --git a/pp/integrations/plugin-packs/procedures/network-ubiquiti-unifi-snmp.md b/pp/integrations/plugin-packs/procedures/network-ubiquiti-unifi-snmp.md index ab1fa4a8fea3..b6e4c1b6f7c9 100644 --- a/pp/integrations/plugin-packs/procedures/network-ubiquiti-unifi-snmp.md +++ b/pp/integrations/plugin-packs/procedures/network-ubiquiti-unifi-snmp.md @@ -5,6 +5,12 @@ title: Ubiquiti UniFi SNMP import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; +## Connector dependencies + +The following monitoring connectors will be installed when you install the **Ubiquiti UniFi SNMP** connector through the +**Configuration > Connectors > Monitoring Connectors** menu: +* [Base Pack](./base-generic.md) + ## Pack assets ### Templates @@ -20,22 +26,22 @@ The connector brings the following service templates (sorted by the host templat | Service Alias | Service Template | Service Description | |:----------------------|:----------------------------------------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------| -| Cpu | Net-Ubiquiti-Unifi-Cpu-SNMP-custom | Check the detailed rate of utilization of CPUs for the equipment. This check can give the average CPU utilization rate and the rate per CPU for multi-core CPUs | +| Cpu | Net-Ubiquiti-Unifi-Cpu-SNMP-custom | Check the detailed rate of utilization of CPU for the equipment. This check can give the average CPU utilization rate and the rate per CPU for multi-core CPU | | Load | Net-Ubiquiti-Unifi-Load-SNMP-custom | Check the server load average | -| Memory | Net-Ubiquiti-Unifi-Memory-SNMP-custom | Check the rate of the utilization of memory | -| Swap | Net-Ubiquiti-Unifi-Swap-SNMP-custom | Check virtual memory usage | +| Memory | Net-Ubiquiti-Unifi-Memory-SNMP-custom | Check the rate of the utilization of memory (RAM) | +| Swap | Net-Ubiquiti-Unifi-Swap-SNMP-custom | Check virtual memory usage (SWAP) | | Uptime | Net-Ubiquiti-Unifi-Uptime-SNMP-custom | Time since the server has been working and available | -| Virtual-Access-Points | Net-Ubiquiti-Unifi-Virtual-Access-Point-SNMP-custom | Check virtual access points | +| Virtual-Access-Points | Net-Ubiquiti-Unifi-Virtual-Access-Point-SNMP-custom | Check virtual access points | > The services listed above are created automatically when the **Net-Ubiquiti-Unifi-SNMP-custom** host template is used. -| Service Alias | Service Template | Service Description | Discovery | -|:--------------|:------------------------------------------|:--------------------|:----------:| -| Disks | Net-Ubiquiti-Unifi-Disks-SNMP-custom | Check disk usage | | -| Interfaces | Net-Ubiquiti-Unifi-Interfaces-SNMP-custom | Check interfaces | X | +| Service Alias | Service Template | Service Description | Discovery | +|:--------------|:------------------------------------------|:--------------------|:---------:| +| Disks | Net-Ubiquiti-Unifi-Disks-SNMP-custom | Check disk usages | | +| Interfaces | Net-Ubiquiti-Unifi-Interfaces-SNMP-custom | Check interfaces | X | > The services listed above are not created automatically when a host template is applied. To use them, [create a service manually](/docs/monitoring/basic-objects/services), then apply the service template you want. @@ -48,9 +54,9 @@ The connector brings the following service templates (sorted by the host templat #### Host discovery -| Rule name | Description | -|:----------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| SNMP Agents | Discover your resources through an SNMP subnet scan. You need to install the [Generic SNMP](./applications-protocol-snmp.md) connector to get the discovery rule and create a template mapper for the **Net-Ubiquiti-Unifi-SNMP-custom** host template | +| Rule name | Description | +|:------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| SNMP Agents | Discover your resources through an SNMP subnet scan. You need to install the [Generic SNMP](./applications-protocol-snmp.md) connector to get the discovery rule and create a template mapper for the **Net-Ubiquiti-Unifi-SNMP-custom** host template. | More information about discovering hosts automatically is available on the [dedicated page](/docs/monitoring/discovery/hosts-discovery). @@ -65,31 +71,31 @@ and in the [following chapter](/docs/monitoring/discovery/services-discovery/#di ### Collected metrics & status -Here is the list of services for this connector, detailing all metrics linked to each service. +Here is the list of services for this connector, detailing all metrics and statuses linked to each service. -| Metric name | Unit | -|:-------------------------------------|:------| -| cpu.user.utilization.percentage | % | -| cpu.nice.utilization.percentage | % | -| cpu.system.utilization.percentage | % | -| cpu.idle.utilization.percentage | % | -| cpu.wait.utilization.percentage | % | -| cpu.kernel.utilization.percentage | % | -| cpu.interrupt.utilization.percentage | % | -| cpu.softirq.utilization.percentage | % | -| cpu.steal.utilization.percentage | % | -| cpu.guest.utilization.percentage | % | -| cpu.guestnice.utilization.percentage | % | +| Name | Unit | +|:-------------------------------------|:-----| +| cpu.user.utilization.percentage | % | +| cpu.nice.utilization.percentage | % | +| cpu.system.utilization.percentage | % | +| cpu.idle.utilization.percentage | % | +| cpu.wait.utilization.percentage | % | +| cpu.kernel.utilization.percentage | % | +| cpu.interrupt.utilization.percentage | % | +| cpu.softirq.utilization.percentage | % | +| cpu.steal.utilization.percentage | % | +| cpu.guest.utilization.percentage | % | +| cpu.guestnice.utilization.percentage | % | > To obtain this new metric format, include **--use-new-perfdata** in the **EXTRAOPTIONS** service macro. -| Metric name | Unit | +| Name | Unit | |:--------------------------------------------|:------| | storage.partitions.count | count | | *disk_name*#storage.space.usage.bytes | B | @@ -102,16 +108,16 @@ Here is the list of services for this connector, detailing all metrics linked to -| Metric name | Unit | -|:-----------------------------------------------------|:------| -| *interface_name*#status | N/A | -| *interface_name*#interface.traffic.in.bitspersecond | b/s | -| *interface_name*#interface.traffic.out.bitspersecond | b/s | +| Name | Unit | +|:-----------------------------------------------------|:-----| +| status | N/A | +| *interface_name*#interface.traffic.in.bitspersecond | b/s | +| *interface_name*#interface.traffic.out.bitspersecond | b/s | -| Metric name | Unit | +| Name | Unit | |:-----------------------|:------| | load.1m.average.count | count | | load.5m.average.count | count | @@ -123,48 +129,48 @@ Here is the list of services for this connector, detailing all metrics linked to -| Metric name | Unit | -|:------------------------|:------| -| memory.usage.bytes | B | -| memory.free.bytes | B | -| memory.usage.percentage | % | -| memory.buffer.bytes | B | -| memory.cached.bytes | B | -| memory.shared.bytes | B | -| swap.usage.bytes | B | -| swap.free.bytes | B | -| swap.usage.percentage | % | +| Name | Unit | +|:------------------------|:-----| +| memory.usage.bytes | B | +| memory.free.bytes | B | +| memory.usage.percentage | % | +| memory.buffer.bytes | B | +| memory.cached.bytes | B | +| memory.shared.bytes | B | +| swap.usage.bytes | B | +| swap.free.bytes | B | +| swap.usage.percentage | % | > To obtain this new metric format, include **--use-new-perfdata** in the **EXTRAOPTIONS** service macro. -| Metric name | Unit | -|:----------------------|:------| -| swap.usage.bytes | B | -| swap.free.bytes | B | -| swap.usage.percentage | % | +| Name | Unit | +|:----------------------|:-----| +| swap.usage.bytes | B | +| swap.free.bytes | B | +| swap.usage.percentage | % | > To obtain this new metric format, include **--use-new-perfdata** in the **EXTRAOPTIONS** service macro. -| Metric name | Unit | -|:----------------------|:------| -| system.uptime.seconds | s | +| Name | Unit | +|:----------------------|:-----| +| system.uptime.seconds | s | > To obtain this new metric format, include **--use-new-perfdata** in the **EXTRAOPTIONS** service macro. -| Metric name | Unit | +| Name | Unit | |:------------------------------------------------------|:------| | virtual_access_points.total.count | count | | virtual_access_points.clients.connected.count | count | -| *vaps*#status | N/A | +| status | N/A | | *vaps*#virtual_access_point.clients.connected.count | count | | *vaps*#virtual_access_point.traffic.in.bitspersecond | b/s | | *vaps*#virtual_access_point.traffic.out.bitspersecond | b/s | @@ -174,15 +180,22 @@ Here is the list of services for this connector, detailing all metrics linked to ## Prerequisites -To monitor your Ubiquiti UniFi, the SNMP must be configured. -The Poller should be able to perform SNMP requests toward the Ubiquiti device over SNMP UDP/161 port. +### SNMP Configuration + +The SNMP agent must be enabled and configured on the resource. +Please refer to the official documentation. +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 - The installation procedures for monitoring connectors are slightly different depending on [whether your license is offline or online](../getting-started/how-to-guides/connectors-licenses.md). - +The installation procedures for monitoring connectors are slightly different depending on [whether your license is offline or online](../getting-started/how-to-guides/connectors-licenses.md). 1. 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 @@ -205,7 +218,7 @@ dnf install centreon-pack-network-ubiquiti-unifi-snmp ``` - + ```bash apt install centreon-pack-network-ubiquiti-unifi-snmp @@ -252,7 +265,7 @@ dnf install centreon-plugin-Network-Ubiquiti-Unifi-Snmp ``` - + ```bash apt install centreon-plugin-network-ubiquiti-unifi-snmp @@ -274,14 +287,16 @@ yum install centreon-plugin-Network-Ubiquiti-Unifi-Snmp 1. Log into Centreon and add a new host through **Configuration > Hosts**. 2. Fill in the **Name**, **Alias** & **IP Address/DNS** fields according to your resource's settings. -3. Apply the **Net-Ubiquiti-Unifi-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](../getting-started/how-to-guides/troubleshooting-plugins.md#snmpv3-options-mapping) section. +3. Apply the **Net-Ubiquiti-Unifi-SNMP-custom** template to the host. -| 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](#available-options). | | | +| Macro | Description | Default value | Mandatory | +|:------------------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------|:--------------|:---------:| +| SNMP_V3_USERNAME | SNMP v3 only: User name (`securityName`) | | | +| SNMP_V3_AUTH_PROTOCOL | SNMP v3 only: Authentication protocol: MD5\|SHA. Since net-snmp 5.9.1: SHA224\|SHA256\|SHA384\|SHA512 | | | +| SNMP_V3_PRIV_PROTOCOL | 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 | | | +| SNMP_V3_AUTH_PASSPHRASE | SNMP v3 only: Pass phrase hashed using the authentication protocol defined in the --authprotocol option | | | +| SNMP_V3_PRIV_PASSPHRASE | SNMP v3 only: Privacy pass phrase (`privPassword`) to encrypt messages using the protocol defined in the --privprotocol option | | | +| SNMPEXTRAOPTIONS | Any extra option you may want to add to every command (a --verbose flag for example). All options are listed [here](#available-options). | | | 4. [Deploy the configuration](/docs/monitoring/monitoring-servers/deploying-a-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. @@ -293,132 +308,133 @@ yum install centreon-plugin-Network-Ubiquiti-Unifi-Snmp -| Macro | Description | Default value | Mandatory | -|:------------------|:---------------------------------------------------------------------------------------------------|:-----------------------------|:-----------:| -| WARNINGGUEST | Warning threshold in percent | | | -| CRITICALGUEST | Critical threshold in percent | | | -| WARNINGGUESTNICE | Warning threshold in percent | | | -| CRITICALGUESTNICE | Critical threshold in percent | | | -| WARNINGIDLE | Warning threshold in percent | | | -| CRITICALIDLE | Critical threshold in percent | | | -| WARNINGINTERRUPT | Warning threshold in percent | | | -| CRITICALINTERRUPT | Critical threshold in percent | | | -| WARNINGKERNEL | Warning threshold in percent | | | -| CRITICALKERNEL | Critical threshold in percent | | | -| WARNINGNICE | Warning threshold in percent | | | -| CRITICALNICE | Critical threshold in percent | | | -| WARNINGSOFTIRQ | Warning threshold in percent | | | -| CRITICALSOFTIRQ | Critical threshold in percent | | | -| CRITICALSTEAL | Critical threshold in percent | | | -| WARNINGSTREAL | Warning threshold in percent | | | -| WARNINGSYSTEM | Warning threshold in percent | | | -| CRITICALSYSTEM | Critical threshold in percent | | | -| WARNINGUSER | Warning threshold in percent | | | -| CRITICALUSER | Critical threshold in percent | | | -| WARNINGWAIT | Warning threshold in percent | | | -| CRITICALWAIT | Critical threshold in percent | | | -| EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). All options are listed [here](#available-options). | --verbose --use-new-perfdata | | +| Macro | Description | Default value | Mandatory | +|:------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------|:-----------------------------|:---------:| +| WARNINGGUEST | Threshold in percentage | | | +| CRITICALGUEST | Threshold in percentage | | | +| WARNINGGUESTNICE | Threshold in percentage | | | +| CRITICALGUESTNICE | Threshold in percentage | | | +| WARNINGIDLE | Threshold in percentage | | | +| CRITICALIDLE | Threshold in percentage | | | +| WARNINGINTERRUPT | Threshold in percentage | | | +| CRITICALINTERRUPT | Threshold in percentage | | | +| WARNINGKERNEL | Threshold in percentage | | | +| CRITICALKERNEL | Threshold in percentage | | | +| WARNINGNICE | Threshold in percentage | | | +| CRITICALNICE | Threshold in percentage | | | +| WARNINGSOFTIRQ | Threshold in percentage | | | +| CRITICALSOFTIRQ | Threshold in percentage | | | +| CRITICALSTEAL | Threshold in percentage | | | +| WARNINGSTREAL | Threshold in percentage | | | +| WARNINGSYSTEM | Threshold in percentage | | | +| CRITICALSYSTEM | Threshold in percentage | | | +| WARNINGUSER | Threshold in percentage | | | +| CRITICALUSER | Threshold in percentage | | | +| WARNINGWAIT | Threshold in percentage | | | +| CRITICALWAIT | Threshold in percentage | | | +| EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). All options are listed [here](#available-options). | --verbose --use-new-perfdata | | -| Macro | Description | Default value | Mandatory | -|:------------------|:---------------------------------------------------------------------------------------------------|:-----------------------------|:-----------:| -| DISKPATH | Filter disks according to their path | | | -| DISKDEVICE | Filter disks according to their device name | | | -| WARNINGCOUNT | Thresholds ( | | | -| CRITICALCOUNT | Thresholds ( | | | -| WARNINGFREE | Thresholds ( | | | -| CRITICALFREE | Thresholds ( | | | -| WARNINGINODES | Thresholds ( | | | -| CRITICALINODES | Thresholds ( | | | -| WARNINGUSAGE | Thresholds ( | | | -| CRITICALUSAGE | Thresholds ( | | | -| WARNINGUSAGEPRCT | Thresholds ( | | | -| CRITICALUSAGEPRCT | Thresholds ( | | | -| EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). All options are listed [here](#available-options). | --verbose --use-new-perfdata | | +| Macro | Description | Default value | Mandatory | +|:------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------|:-----------------------------|:---------:| +| DISKPATH | Filter disks according to their path | | | +| DISKDEVICE | Filter disks according to their device name | | | +| WARNINGCOUNT | Threshold | | | +| CRITICALCOUNT | Threshold | | | +| WARNINGFREE | Threshold | | | +| CRITICALFREE | Threshold | | | +| WARNINGINODES | Threshold | | | +| CRITICALINODES | Threshold | | | +| WARNINGUSAGE | Threshold | | | +| CRITICALUSAGE | Threshold | | | +| WARNINGUSAGEPRCT | Threshold | | | +| CRITICALUSAGEPRCT | Threshold | | | +| EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). All options are listed [here](#available-options). | --verbose --use-new-perfdata | | -| Macro | Description | Default value | Mandatory | -|:-------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:------------------------------------------------------|:-----------:| -| OIDFILTER | Define the OID to be used to filter interfaces (default: ifName) (values: ifDesc, ifAlias, ifName, IpAddr) | ifname | | -| OIDDISPLAY | Define the OID that will be used to name the interfaces (default: ifName) (values: ifDesc, ifAlias, ifName, IpAddr) | ifname | | -| INTERFACENAME | Set the interface (number expected) example: 1,2,... (empty means 'check all interfaces') | | | -| WARNINGINDISCARD | Thresholds | | | -| CRITICALINDISCARD | Thresholds | | | -| WARNINGINERROR | Thresholds | | | -| CRITICALINERROR | Thresholds | | | -| WARNINGINTRAFFIC | Thresholds | | | -| CRITICALINTRAFFIC | Thresholds | | | -| WARNINGOUTDISCARD | Thresholds | | | -| CRITICALOUTDISCARD | Thresholds | | | -| WARNINGOUTERROR | Thresholds | | | -| CRITICALOUTERROR | Thresholds | | | -| WARNINGOUTTRAFFIC | Thresholds | | | -| CRITICALOUTTRAFFIC | Thresholds | | | -| CRITICALSTATUS | Define the conditions to match for the status to be CRITICAL (default: '%\{admstatus\} eq "up" and %\{opstatus\} ne "up"'). You can use the following variables: %\{admstatus\}, %\{opstatus\}, %\{duplexstatus\}, %\{display\} | %\{admstatus\} eq "up" and %\{opstatus\} !~ /up\|dormant/ | | -| WARNINGSTATUS | Define the conditions to match for the status to be WARNING. You can use the following variables: %\{admstatus\}, %\{opstatus\}, %\{duplexstatus\}, %\{display\} | | | -| EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). All options are listed [here](#available-options). | --verbose --use-new-perfdata | | +| Macro | Description | Default value | Mandatory | +|:-------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------|:----------------------------------------------------------|:---------:| +| OIDFILTER | Define the OID to be used to filter interfaces (values: ifDesc, ifAlias, ifName, IpAddr) | ifname | | +| OIDDISPLAY | Define the OID that will be used to name the interfaces (values: ifDesc, ifAlias, ifName, IpAddr) | ifname | | +| INTERFACENAME | Check only the interfaces with the specified IDs (OID indexes, e.g.: 1,2,...). If empty, all interfaces will be monitored. To filter on interface names, see --name | | | +| WARNINGINDISCARD | Thresholds | | | +| CRITICALINDISCARD | Thresholds | | | +| WARNINGINERROR | Thresholds | | | +| CRITICALINERROR | Thresholds | | | +| WARNINGINTRAFFIC | Thresholds | | | +| CRITICALINTRAFFIC | Thresholds | | | +| WARNINGOUTDISCARD | Thresholds | | | +| CRITICALOUTDISCARD | Thresholds | | | +| WARNINGOUTERROR | Thresholds | | | +| CRITICALOUTERROR | Thresholds | | | +| WARNINGOUTTRAFFIC | Thresholds | | | +| CRITICALOUTTRAFFIC | Thresholds | | | +| CRITICALSTATUS | Define the conditions to match for the status to be CRITICAL. You can use the following variables: %\{admstatus\}, %\{opstatus\}, %\{duplexstatus\}, %\{display\} | %\{admstatus\} eq "up" and %\{opstatus\} !~ /up\|dormant/ | | +| WARNINGSTATUS | Define the conditions to match for the status to be WARNING. You can use the following variables: %\{admstatus\}, %\{opstatus\}, %\{duplexstatus\}, %\{display\} | | | +| EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). All options are listed [here](#available-options). | --verbose --use-new-perfdata | | -| Macro | Description | Default value | Mandatory | -|:-------------|:---------------------------------------------------------------------------------------------------|:-------------------|:-----------:| -| WARNING | Warning threshold (1min,5min,15min) | | | -| CRITICAL | Critical threshold (1min,5min,15min) | | | -| EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). All options are listed [here](#available-options). | --use-new-perfdata | | +| Macro | Description | Default value | Mandatory | +|:-------------|:-------------------------------------------------------------------------------------------------------------------------------------------------|:-------------------|:---------:| +| WARNING | Warning threshold (1min,5min,15min) | | | +| CRITICAL | Critical threshold (1min,5min,15min) | | | +| EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). All options are listed [here](#available-options). | --use-new-perfdata | | -| Macro | Description | Default value | Mandatory | -|:-------------|:---------------------------------------------------------------------------------------------------|:-------------------|:-----------:| -| WARNING | Thresholds | | | -| CRITICAL | Thresholds | | | -| EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). All options are listed [here](#available-options). | --use-new-perfdata | | +| Macro | Description | Default value | Mandatory | +|:-------------|:-------------------------------------------------------------------------------------------------------------------------------------------------|:-------------------|:---------:| +| WARNING | Threshold in bytes | | | +| CRITICAL | Threshold in bytes | | | +| EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). All options are listed [here](#available-options). | --use-new-perfdata | | -| Macro | Description | Default value | Mandatory | -|:-------------|:---------------------------------------------------------------------------------------------------|:-------------------|:-----------:| -| WARNING | Thresholds | | | -| CRITICAL | Thresholds | | | -| EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). All options are listed [here](#available-options). | --use-new-perfdata | | +| Macro | Description | Default value | Mandatory | +|:-------------|:-------------------------------------------------------------------------------------------------------------------------------------------------|:-------------------|:---------:| +| WARNING | Threshold in percentage | | | +| CRITICAL | Threshold in percentage | | | +| EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). All options are listed [here](#available-options). | --use-new-perfdata | | -| Macro | Description | Default value | Mandatory | -|:-------------|:---------------------------------------------------------------------------------------------------|:-------------------|:-----------:| -| WARNING | Warning threshold | | | -| CRITICAL | Critical threshold | | | -| EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). All options are listed [here](#available-options). | --use-new-perfdata | | +| Macro | Description | Default value | Mandatory | +|:-------------|:-------------------------------------------------------------------------------------------------------------------------------------------------|:------------------------------------|:---------:| +| UNIT | Select the time unit for thresholds. May be 's' for seconds, 'm' for minutes, 'h' for hours, 'd' for days, 'w' for weeks. Default is seconds | | | +| WARNING | Warning threshold | | | +| CRITICAL | Critical threshold | | | +| EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). All options are listed [here](#available-options). | --use-new-perfdata --check-overload | | -| Macro | Description | Default value | Mandatory | -|:------------------------------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------|:--------------------|:-----------:| -| FILTERAPNAME | Filter virtual access points by name (can be a regexp) | | | -| FILTERAPSSID | Filter virtual access points by SSID (can be a regexp) | | | -| UNKNOWNSTATUS | Define the conditions to match for the status to be UNKNOWN. You can use the following variables: %\{name\}, %\{ssid\}, %\{status\} | | | -| WARNINGCLIENTSCONNECTED | Thresholds | | | -| CRITICALCLIENTSCONNECTED | Thresholds | | | -| CRITICALSTATUS | Define the conditions to match for the status to be CRITICAL (default: '%\{status\} eq "down"'). You can use the following variables: %\{name\}, %\{ssid\}, %\{status\} | %\{status\} eq "down" | | -| WARNINGSTATUS | Define the conditions to match for the status to be WARNING. You can use the following variables: %\{name\}, %\{ssid\}, %\{status\} | | | -| WARNINGTOTAL | Thresholds | | | -| CRITICALTOTAL | Thresholds | | | -| WARNINGTOTALCLIENTSCONNECTED | Thresholds | | | -| CRITICALTOTALCLIENTSCONNECTED | Thresholds | | | -| WARNINGTRAFFICIN | Thresholds | | | -| CRITICALTRAFFICIN | Thresholds | | | -| WARNINGTRAFFICOUT | Thresholds | | | -| CRITICALTRAFFICOUT | Thresholds | | | -| EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). All options are listed [here](#available-options). | --verbose | | +| Macro | Description | Default value | Mandatory | +|:------------------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------|:----------------------|:---------:| +| FILTERAPNAME | Filter virtual access points by name (can be a regexp) | | | +| FILTERAPSSID | Filter virtual access points by SSID (can be a regexp) | | | +| UNKNOWNSTATUS | Define the conditions to match for the status to be UNKNOWN. You can use the following variables: %\{name\}, %\{ssid\}, %\{status\} | | | +| WARNINGCLIENTSCONNECTED | Threshold | | | +| CRITICALCLIENTSCONNECTED | Threshold | | | +| CRITICALSTATUS | Define the conditions to match for the status to be CRITICAL. You can use the following variables: %\{name\}, %\{ssid\}, %\{status\} | %\{status\} eq "down" | | +| WARNINGSTATUS | Define the conditions to match for the status to be WARNING. You can use the following variables: %\{name\}, %\{ssid\}, %\{status\} | | | +| WARNINGTOTAL | Threshold | | | +| CRITICALTOTAL | Threshold | | | +| WARNINGTOTALCLIENTSCONNECTED | Threshold | | | +| CRITICALTOTALCLIENTSCONNECTED | Threshold | | | +| 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](#available-options). | --verbose | | @@ -437,7 +453,12 @@ is able to monitor a resource using a command like this one (replace the sample --mode=virtual-access-points \ --hostname=10.0.0.1 \ --snmp-version='2c' \ - --snmp-community='my-snmp-community' \ + --snmp-community='my-snmp-community' \ + --snmp-username='username' \ + --authpassphrase='' \ + --authprotocol='' \ + --privpassphrase='' \ + --privprotocol='' \ --filter-name='' \ --filter-ssid='' \ --unknown-status='' \ @@ -459,7 +480,7 @@ is able to monitor a resource using a command like this one (replace the sample The expected command output is shown below: ```bash -OK: total: 23 clients connected: 50 All virtual access points are ok | 'virtual_access_points.total.count'=23;;;0;'virtual_access_points.clients.connected.count'=50;;;0;'*vaps*#virtual_access_point.clients.connected.count'=;;;0;'*vaps*#virtual_access_point.traffic.in.bitspersecond'=b/s;;;0;'*vaps*#virtual_access_point.traffic.out.bitspersecond'=b/s;;;0; +OK: total: 17585 clients connected: 98875 All virtual access points are ok | 'virtual_access_points.total.count'=17585;;;0; 'virtual_access_points.clients.connected.count'=98875;;;0; 'vaps1#virtual_access_point.clients.connected.count'=74864;;;0; 'vaps2#virtual_access_point.clients.connected.count'=3636;;;0; 'vaps1#virtual_access_point.traffic.in.bitspersecond'=56436b/s;;;0; 'vaps2#virtual_access_point.traffic.in.bitspersecond'=15056b/s;;;0; 'vaps1#virtual_access_point.traffic.out.bitspersecond'=82191b/s;;;0; 'vaps2#virtual_access_point.traffic.out.bitspersecond'=19910b/s;;;0; ``` ### Troubleshooting @@ -504,61 +525,67 @@ The plugin brings the following modes: 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. | -| --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\[,\[newuom\],\[min\],\[m ax\]\] Common examples: 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()' | -| --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,namesofnewmetrics,calculation\[,\[ne wuom\],\[min\],\[max\]\] regex: regular expression namesofnewmetrics: 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 newuom (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: 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(traf fic\_(in\|out)\_$1)' | -| --change-short-output --change-long-output | Modify the short/long output that is returned by the plugin. Syntax: --change-short-output=pattern~replacement~modifier Most commonly used modifiers are i (case insensitive) and g (replace all occurrences). Example: adding --change-short-output='OK\~Up\~gi' will replace all occurrences of 'OK', 'ok', 'Ok' or 'oK' with 'Up' | -| --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. | -| --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). E.g.: --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'. | -| --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 ok, 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. | +| 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 get-next 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 ok, 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. | +| --show-password | By default, sensitive information in command lines is hidden in debug output and replaced with `***` (however, debug logs may still display sensitive information). Using the C option will display the passwords in plain text. | +| --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\[,\[\\],\[min\],\[max\]\] Common examples: onvert 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\[,\[\\],\[min\],\[max\]\] Common examples: onvert 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\[,\[\\],\[min\],\[max\]\] Common examples: onvert 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,\,calculation\[,\[\\],\[min\],\[max\]\] regex: regular expression \: 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 \ (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: um 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~replacement~modifier Most commonly used modifiers are i (case insensitive) and g (replace all occurrences). Example: adding --change-short-output='OK~Up~gi' will replace all occurrences of 'OK', 'ok', 'Ok' or 'oK' with 'Up' | +| --change-short-output | Modify the short/long output that is returned by the plugin. Syntax: --change-short-output=pattern~replacement~modifier Most commonly used modifiers are i (case insensitive) and g (replace all occurrences). Example: adding --change-short-output='OK~Up~gi' will replace all occurrences of 'OK', 'ok', 'Ok' or 'oK' with 'Up' | +| --change-long-output | Modify the short/long output that is returned by the plugin. Syntax: --change-short-output=pattern~replacement~modifier Most commonly used modifiers are i (case insensitive) and g (replace all occurrences). Example: adding --change-short-output='OK~Up~gi' will replace all occurrences of 'OK', 'ok', 'Ok' or 'oK' with 'Up' | +| --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'. \. | #### Modes options @@ -567,177 +594,252 @@ All available options for each service template are listed below: -| Option | Description | -|:-----------------------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| --memcached | Memcached server to use (only one server). | -| --redis-server | Redis server to use (only one server). Syntax: address\[:port\] | -| --redis-attribute | Set Redis Options (--redis-attribute="cnx\_timeout=5"). | -| --redis-db | Set Redis database index. | -| --failback-file | Failback on a local file if Redis connection fails. | -| --memexpiration | Time to keep data in seconds (default: 86400). | -| --statefile-dir | Define the cache directory (default: '/var/lib/centreon/centplugins'). | -| --statefile-suffix | Define a suffix to customize the statefile name (default: ''). | -| --statefile-concat-cwd | If used with the '--statefile-dir' option, the latter's value will be used as a sub-directory of the current working directory. Useful on Windows when the plugin is compiled, as the file system and permissions are different from Linux. | -| --statefile-format | Define the format used to store the cache. Available formats: 'dumper', 'storable', 'json' (default). | -| --statefile-key | Define the key to encrypt/decrypt the cache. | -| --statefile-cipher | Define the cipher algorithm to encrypt the cache (default: 'AES'). | -| --warning-* | Warning threshold in percent. Can be: 'user', 'nice', 'system', 'idle', 'wait', 'kernel', 'interrupt', 'softirq', 'steal', 'guest', 'guestnice'. | -| --critical-* | Critical threshold in percent. Can be: 'user', 'nice', 'system', 'idle', 'wait', 'kernel', 'interrupt', 'softirq', 'steal', 'guest', 'guestnice'. | +| Option | Description | +|:---------------------|:--------------------------------------------------------------------------------------------------------------------------| +| --filter-counters | Only display some counters (regexp can be used). Example to check SSL connections only : --filter-counters='^xxxx\|yyyy$' | +| --warning-xxx | Warning threshold. | +| --critical-xxx | Critical threshold. | +| --warning-guest | Threshold in percentage. | +| --critical-guest | Threshold in percentage. | +| --warning-guestnice | Threshold in percentage. | +| --critical-guestnice | Threshold in percentage. | +| --warning-idle | Threshold in percentage. | +| --critical-idle | Threshold in percentage. | +| --warning-interrupt | Threshold in percentage. | +| --critical-interrupt | Threshold in percentage. | +| --warning-kernel | Threshold in percentage. | +| --critical-kernel | Threshold in percentage. | +| --warning-nice | Threshold in percentage. | +| --critical-nice | Threshold in percentage. | +| --warning-softirq | Threshold in percentage. | +| --critical-softirq | Threshold in percentage. | +| --warning-steal | Threshold in percentage. | +| --critical-steal | Threshold in percentage. | +| --warning-system | Threshold in percentage. | +| --critical-system | Threshold in percentage. | +| --warning-user | Threshold in percentage. | +| --critical-user | Threshold in percentage. | +| --warning-wait | Threshold in percentage. | +| --critical-wait | Threshold in percentage. | -| Option | Description | -|:------------------------------------------------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| --memcached | Memcached server to use (only one server). | -| --redis-server | Redis server to use (only one server). Syntax: address\[:port\] | -| --redis-attribute | Set Redis Options (--redis-attribute="cnx\_timeout=5"). | -| --redis-db | Set Redis database index. | -| --failback-file | Failback on a local file if Redis connection fails. | -| --memexpiration | Time to keep data in seconds (default: 86400). | -| --statefile-dir | Define the cache directory (default: '/var/lib/centreon/centplugins'). | -| --statefile-suffix | Define a suffix to customize the statefile name (default: ''). | -| --statefile-concat-cwd | If used with the '--statefile-dir' option, the latter's value will be used as a sub-directory of the current working directory. Useful on Windows when the plugin is compiled, as the file system and permissions are different from Linux. | -| --statefile-format | Define the format used to store the cache. Available formats: 'dumper', 'storable', 'json' (default). | -| --statefile-key | Define the key to encrypt/decrypt the cache. | -| --statefile-cipher | Define the cipher algorithm to encrypt the cache (default: 'AES'). | -| --filter-counters | Filter counters to be displayed (can be: 'usage', 'count', 'inodes'). | -| --disk-index | Choose disk according to the index. | -| --filter-disk-path | Filter disks according to their path. | -| --filter-disk-device | Filter disks according to their device name. | -| --reload-cache-time | Time in minutes before reloading cache file (default: 180). | -| --display-transform-src --display-transform-dst | Modify the disk name displayed by using a regular expression. Example: adding --display-transform-src='dev' --display-transform-dst='run' will replace all occurrences of 'dev' with 'run' | -| --show-cache | Display cache disk path data. | -| --space-reservation | Some filesystem has space reserved (like ext4 for root). The value is in percent of total (default: none) (results like 'df' command). | -| --force-use-mib-percent | Can be used if you have counters overload by big disks. | -| --force-counters32 | Force to use 32 bits counters. Should be used when 64 bits high/low components are not available. | -| --warning-* --critical-* | Thresholds (can be: 'usage', 'usage-free', 'usage-prct', 'inodes', 'count'). | +| Option | Description | +|:------------------------------------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| --filter-counters | Filter counters to be displayed (can be: 'usage', 'count', 'inodes'). | +| --warning-xxx | Warning threshold. | +| --critical-xxx | Critical threshold. | +| --memcached | Memcached server to use (only one server). | +| --redis-server | Redis server to use (only one server). Syntax: address\[:port\] | +| --redis-attribute | Set Redis Options (--redis-attribute="cnx\_timeout=5"). | +| --redis-db | Set Redis database index. | +| --failback-file | Fall back on a local file if Redis connection fails. | +| --memexpiration | Time to keep data in seconds (default: 86400). | +| --statefile-dir | Define the cache directory (default: '/var/lib/centreon/centplugins'). | +| --statefile-suffix | Define a suffix to customize the statefile name (default: ''). | +| --statefile-concat-cwd | If used with the '--statefile-dir' option, the latter's value will be used as a sub-directory of the current working directory. Useful on Windows when the plugin is compiled, as the file system and permissions are different from Linux. | +| --statefile-format | Define the format used to store the cache. Available formats: 'dumper', 'storable', 'json' (default). | +| --statefile-key | Define the key to encrypt/decrypt the cache. | +| --statefile-cipher | Define the cipher algorithm to encrypt the cache (default: 'AES'). | +| --disk-index | Choose disk according to the index. | +| --filter-disk-path | Filter disks according to their path. | +| --filter-disk-device | Filter disks according to their device name. | +| --reload-cache-time | Time in minutes before reloading cache file (default: 180). | +| --display-transform-src --display-transform-dst | Modify the disk name displayed by using a regular expression. Example: adding --display-transform-src='dev' --display-transform-dst='run' will replace all occurrences of 'dev' with 'run' | +| --show-cache | Display cache disk path data. | +| --space-reservation | Some filesystem has space reserved (like ext4 for root). The value is in percent of total (default: none) (results like 'df' command). | +| --force-use-mib-percent | Can be used if you have counters overload by big disks. | +| --force-counters32 | Force to use 32 bits counters. Should be used when 64 bits high/low components are not available. | +| --warning-* --critical-* | Thresholds (can be: 'usage', 'usage-free', 'usage-prct', 'inodes', 'count'). | -| Option | Description | -|:------------------------------------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| --memcached | Memcached server to use (only one server). | -| --redis-server | Redis server to use (only one server). Syntax: address\[:port\] | -| --redis-attribute | Set Redis Options (--redis-attribute="cnx\_timeout=5"). | -| --redis-db | Set Redis database index. | -| --failback-file | Failback on a local file if Redis connection fails. | -| --memexpiration | Time to keep data in seconds (default: 86400). | -| --statefile-dir | Define the cache directory (default: '/var/lib/centreon/centplugins'). | -| --statefile-suffix | Define a suffix to customize the statefile name (default: ''). | -| --statefile-concat-cwd | If used with the '--statefile-dir' option, the latter's value will be used as a sub-directory of the current working directory. Useful on Windows when the plugin is compiled, as the file system and permissions are different from Linux. | -| --statefile-format | Define the format used to store the cache. Available formats: 'dumper', 'storable', 'json' (default). | -| --statefile-key | Define the key to encrypt/decrypt the cache. | -| --statefile-cipher | Define the cipher algorithm to encrypt the cache (default: 'AES'). | -| --add-global | Check global port statistics (by default if no --add-* option is set). | -| --add-status | Check interface status. | -| --add-duplex-status | Check duplex status (with --warning-status and --critical-status). | -| --add-traffic | Check interface traffic. | -| --add-errors | Check interface errors. | -| --add-cast | Check interface cast. | -| --add-speed | Check interface speed. | -| --add-volume | Check interface data volume between two checks (not supposed to be graphed, useful for BI reporting). | -| --check-metrics | If the expression is true, metrics are checked (default: '%\{opstatus\} eq "up"'). | -| --warning-status | Define the conditions to match for the status to be WARNING. You can use the following variables: %\{admstatus\}, %\{opstatus\}, %\{duplexstatus\}, %\{display\} | -| --critical-status | Define the conditions to match for the status to be CRITICAL (default: '%\{admstatus\} eq "up" and %\{opstatus\} ne "up"'). You can use the following variables: %\{admstatus\}, %\{opstatus\}, %\{duplexstatus\}, %\{display\} | -| --warning-* --critical-* | Thresholds. Can be: 'total-port', 'total-admin-up', 'total-admin-down', 'total-oper-up', 'total-oper-down', 'in-traffic', 'out-traffic', 'in-error', 'in-discard', 'out-error', 'out-discard', 'in-ucast', 'in-bcast', 'in-mcast', 'out-ucast', 'out-bcast', 'out-mcast', 'speed' (b/s). | -| --units-traffic | Units of thresholds for the traffic (default: 'percent\_delta') ('percent\_delta', 'bps', 'counter'). | -| --units-errors | Units of thresholds for errors/discards (default: 'percent\_delta') ('percent\_delta', 'percent', 'delta', 'deltaps', 'counter'). | -| --units-cast | Units of thresholds for communication types (default: 'percent\_delta') ('percent\_delta', 'percent', 'delta', 'deltaps', 'counter'). | -| --nagvis-perfdata | Display traffic perfdata to be compatible with nagvis widget. | -| --interface | Set the interface (number expected) example: 1,2,... (empty means 'check all interfaces'). | -| --name | Allows you to define the interface (in option --interface) byname instead of OID index. The name matching mode supports regular expressions. | -| --speed | Set interface speed for incoming/outgoing traffic (in Mb). | -| --speed-in | Set interface speed for incoming traffic (in Mb). | -| --speed-out | Set interface speed for outgoing traffic (in Mb). | -| --map-speed-dsl | Get interface speed configuration for interface type 'adsl' and 'vdsl2'. Syntax: --map-speed-dsl=interface-src-name,interface-dsl-name E.g: --map-speed-dsl=Et0.835,Et0-vdsl2 | -| --force-counters64 | Force to use 64 bits counters only. Can be used to improve performance. | -| --force-counters32 | Force to use 32 bits counters (even in snmp v2c and v3). Should be used when 64 bits counters are buggy. | -| --reload-cache-time | Time in minutes before reloading cache file (default: 180). | -| --oid-filter | Define the OID to be used to filter interfaces (default: ifName) (values: ifDesc, ifAlias, ifName, IpAddr). | -| --oid-display | Define the OID that will be used to name the interfaces (default: ifName) (values: ifDesc, ifAlias, ifName, IpAddr). | -| --oid-extra-display | Add an OID to display. | -| --display-transform-src --display-transform-dst | Modify the interface name displayed by using a regular expression. Example: adding --display-transform-src='eth' --display-transform-dst='ens' will replace all occurrences of 'eth' with 'ens' | -| --show-cache | Display cache interface data. | +| Option | Description | +|:------------------------------------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| --filter-counters | Only display some counters (regexp can be used). Example to check SSL connections only : --filter-counters='^xxxx\|yyyy$' | +| --warning-xxx | Warning threshold. | +| --critical-xxx | Critical threshold. | +| --memcached | Memcached server to use (only one server). | +| --redis-server | Redis server to use (only one server). Syntax: address\[:port\] | +| --redis-attribute | Set Redis Options (--redis-attribute="cnx\_timeout=5"). | +| --redis-db | Set Redis database index. | +| --failback-file | Fall back on a local file if Redis connection fails. | +| --memexpiration | Time to keep data in seconds (default: 86400). | +| --statefile-dir | Define the cache directory (default: '/var/lib/centreon/centplugins'). | +| --statefile-suffix | Define a suffix to customize the statefile name (default: ''). | +| --statefile-concat-cwd | If used with the '--statefile-dir' option, the latter's value will be used as a sub-directory of the current working directory. Useful on Windows when the plugin is compiled, as the file system and permissions are different from Linux. | +| --statefile-format | Define the format used to store the cache. Available formats: 'dumper', 'storable', 'json' (default). | +| --statefile-key | Define the key to encrypt/decrypt the cache. | +| --statefile-cipher | Define the cipher algorithm to encrypt the cache (default: 'AES'). | +| --add-global | Check global port statistics (by default if no --add-* option is set). | +| --add-status | Check interface status. | +| --add-duplex-status | Check duplex status (with --warning-status and --critical-status). | +| --add-traffic | Check interface traffic. | +| --add-errors | Check interface errors. | +| --add-cast | Check interface cast. | +| --add-speed | Check interface speed. | +| --add-volume | Check interface data volume between two checks (not supposed to be graphed, useful for BI reporting). | +| --check-metrics | If the expression is true, metrics are checked (default: '%\{opstatus\} eq "up"'). | +| --warning-status | Define the conditions to match for the status to be WARNING. You can use the following variables: %\{admstatus\}, %\{opstatus\}, %\{duplexstatus\}, %\{display\} | +| --critical-status | Define the conditions to match for the status to be CRITICAL (default: '%\{admstatus\} eq "up" and %\{opstatus\} ne "up"'). You can use the following variables: %\{admstatus\}, %\{opstatus\}, %\{duplexstatus\}, %\{display\} | +| --warning-total-port | Thresholds. | +| --critical-total-port | Thresholds. | +| --warning-total-admin-up | Thresholds. | +| --critical-total-admin-up | Thresholds. | +| --warning-total-admin-down | Thresholds. | +| --critical-total-admin-down | Thresholds. | +| --warning-total-oper-up | Thresholds. | +| --critical-total-oper-up | Thresholds. | +| --warning-total-oper-down | Thresholds. | +| --critical-total-oper-down | Thresholds. | +| --warning-in-traffic | Thresholds. | +| --critical-in-traffic | Thresholds. | +| --warning-out-traffic | Thresholds. | +| --critical-out-traffic | Thresholds. | +| --warning-in-error | Thresholds. | +| --critical-in-error | Thresholds. | +| --warning-in-discard | Thresholds. | +| --critical-in-discard | Thresholds. | +| --warning-out-error | Thresholds. | +| --critical-out-error | Thresholds. | +| --warning-out-discard | Thresholds. | +| --critical-out-discard | Thresholds. | +| --warning-in-ucast | Thresholds. | +| --critical-in-ucast | Thresholds. | +| --warning-in-bcast | Thresholds. | +| --critical-in-bcast | Thresholds. | +| --warning-in-mcast | Thresholds. | +| --critical-in-mcast | Thresholds. | +| --warning-out-ucast | Thresholds. | +| --critical-out-ucast | Thresholds. | +| --warning-out-bcast | Thresholds. | +| --critical-out-bcast | Thresholds. | +| --warning-out-mcast | Thresholds. | +| --critical-out-mcast | Thresholds. | +| --warning-speed | Thresholds in b/s. | +| --critical-speed | Thresholds in b/s. | +| --units-traffic | Units of thresholds for the traffic (default: 'percent\_delta') ('percent\_delta', 'bps', 'counter'). | +| --units-errors | Units of thresholds for errors/discards (default: 'percent\_delta') ('percent\_delta', 'delta', 'deltaps', 'counter'). | +| --units-cast | Units of thresholds for communication types (default: 'percent\_delta') ('percent\_delta', 'percent', 'delta', 'deltaps', 'counter'). | +| --nagvis-perfdata | Display traffic perfdata to be compatible with NagVis widget. | +| --interface | Check only the interfaces with the specified IDs (OID indexes, e.g.: 1,2,...). If empty, all interfaces will be monitored. To filter on interface names, see --name. | +| --name | With this option, the interfaces will be filtered by name (given in option --interface) instead of OID index. The name matching mode supports regular expressions. | +| --regex-id | With this option, interface IDs will be filtered using the --interface parameter as a regular expression instead of a list of IDs. | +| --speed | Set interface speed for incoming/outgoing traffic (in Mb). | +| --speed-in | Set interface speed for incoming traffic (in Mb). | +| --speed-out | Set interface speed for outgoing traffic (in Mb). | +| --map-speed-dsl | Get interface speed configuration for interfaces of type 'ADSL' and 'VDSL2'. Syntax: --map-speed-dsl=interface-src-name,interface-dsl-name E.g: --map-speed-dsl=Et0.835,Et0-vdsl2 | +| --force-counters64 | Force to use 64 bits counters only. Can be used to improve performance. | +| --force-counters32 | Force to use 32-bit counters (even with SNMP versions 2c and 3). To use when 64 bits counters are buggy. | +| --reload-cache-time | Time in minutes before reloading cache file (default: 180). | +| --oid-filter | Define the OID to be used to filter interfaces (default: ifName) (values: ifDesc, ifAlias, ifName, IpAddr). | +| --oid-display | Define the OID that will be used to name the interfaces (default: ifName) (values: ifDesc, ifAlias, ifName, IpAddr). | +| --oid-extra-display | Add an OID to display. | +| --display-transform-src --display-transform-dst | Modify the interface name displayed by using a regular expression. Example: adding --display-transform-src='eth' --display-transform-dst='ens' will replace all occurrences of 'eth' with 'ens' | +| --show-cache | Display cache interface data. | +| --no-cache-lock | Set to disable locking when accessing cache. | -| Option | Description | -|:-----------|:----------------------------------------| -| --warning | Warning threshold (1min,5min,15min). | -| --critical | Critical threshold (1min,5min,15min). | -| --average | Load average for the number of CPUs. | +| Option | Description | +|:-----------|:--------------------------------------| +| --warning | Warning threshold (1min,5min,15min). | +| --critical | Critical threshold (1min,5min,15min). | +| --average | Load average for the number of CPUs. | -| Option | Description | -|:-------------------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| --units | Units of thresholds (default: '%') ('%', 'absolute')(deprecated. Please use new counters directly) | -| --free | Thresholds are on free space left (deprecated. Please use newcounters directly) | -| --swap | Check swap also. | -| --warning-* --critical-* | Thresholds. Can be: 'usage' (B), 'usage-free' (B), 'usage-prct' (%), 'swap' (B), 'swap-free' (B), 'swap-prct' (%), 'buffer' (B), 'cached' (B), 'shared' (B). | -| --patch-redhat | If using RedHat distribution with net-snmp \>= 5.7.2-43 and net-snmp \< 5.7.2-47. But you should update net-snmp!!!! This version: used = memTotalReal - memAvailReal // free = memAvailReal Others versions: used = memTotalReal - memAvailReal - memBuffer - memCached // free = total - used | +| Option | Description | +|:------------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| --filter-counters | Only display some counters (regexp can be used). Example to check SSL connections only : --filter-counters='^xxxx\|yyyy$' | +| --warning-xxx | Warning threshold. | +| --critical-xxx | Critical threshold. | +| --units | Units of thresholds (default: '%') ('%', 'absolute') (deprecated. Please use new counters directly) | +| --free | Thresholds are on free space left (deprecated. Please use new counters directly) | +| --swap | Check swap also. | +| --warning-buffer | Threshold in bytes. | +| --critical-buffer | Threshold in bytes. | +| --warning-cached | Threshold in bytes. | +| --critical-cached | Threshold in bytes. | +| --warning-shared | Threshold in bytes. | +| --critical-shared | Threshold in bytes. | +| --warning-swap | Threshold in bytes. | +| --critical-swap | Threshold in bytes. | +| --warning-swap-free | Threshold in bytes. | +| --critical-swap-free | Threshold in bytes. | +| --warning-swap-prct | Threshold in percentage. | +| --critical-swap-prct | Threshold in percentage. | +| --warning-usage | Threshold in bytes. | +| --critical-usage | Threshold in bytes. | +| --warning-usage-free | Threshold in bytes. | +| --critical-usage-free | Threshold in bytes. | +| --warning-usage-prct | Threshold in percentage. | +| --critical-usage-prct | Threshold in percentage. | +| --patch-redhat | If using Red Hat distribution with net-snmp \>= 5.7.2-43 and net-snmp \< 5.7.2-47. But you should update net-snmp!!!! This version: used = memTotalReal - memAvailReal // free = memAvailReal Others versions: used = memTotalReal - memAvailReal - memBuffer - memCached // free = total - used | +| --force-64bits-counters | Use this option to monitor a server/device that has more than 2 TB of RAM, the maximum size of a signed 32 bits integer. If you omit it you'll get the remainder of the Euclidean division of the actual value by 2 TB. NB: it cannot work with version 1 of SNMP protocol. 64 bits counters are supported starting version 2c. | -| Option | Description | -|:-------------------------|:------------------------------------------------------------------------| -| --no-swap | Threshold if no active swap (default: 'critical'). | -| --warning-* --critical-* | Thresholds. Can be: 'usage' (B), 'usage-free' (B), 'usage-prct' (%). | +| Option | Description | +|:----------------------|:--------------------------------------------------------------------------------------------------------------------------| +| --filter-counters | Only display some counters (regexp can be used). Example to check SSL connections only : --filter-counters='^xxxx\|yyyy$' | +| --warning-xxx | Warning threshold. | +| --critical-xxx | Critical threshold. | +| --no-swap | Threshold if no active swap (default: 'critical'). | +| --warning-usage | Threshold in bytes. | +| --critical-usage | Threshold in bytes. | +| --warning-usage-free | Threshold in bytes. | +| --critical-usage-free | Threshold in bytes. | +| --warning-usage-prct | Threshold in percentage. | +| --critical-usage-prct | Threshold in percentage. | -| Option | Description | -|:-----------------------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| --memcached | Memcached server to use (only one server). | -| --redis-server | Redis server to use (only one server). Syntax: address\[:port\] | -| --redis-attribute | Set Redis Options (--redis-attribute="cnx\_timeout=5"). | -| --redis-db | Set Redis database index. | -| --failback-file | Failback on a local file if Redis connection fails. | -| --memexpiration | Time to keep data in seconds (default: 86400). | -| --statefile-dir | Define the cache directory (default: '/var/lib/centreon/centplugins'). | -| --statefile-suffix | Define a suffix to customize the statefile name (default: ''). | -| --statefile-concat-cwd | If used with the '--statefile-dir' option, the latter's value will be used as a sub-directory of the current working directory. Useful on Windows when the plugin is compiled, as the file system and permissions are different from Linux. | -| --statefile-format | Define the format used to store the cache. Available formats: 'dumper', 'storable', 'json' (default). | -| --statefile-key | Define the key to encrypt/decrypt the cache. | -| --statefile-cipher | Define the cipher algorithm to encrypt the cache (default: 'AES'). | -| --warning-uptime | Warning threshold. | -| --critical-uptime | Critical threshold. | -| --add-sysdesc | Display system description. | -| --force-oid | Can choose your oid (numeric format only). | -| --check-overload | Uptime counter limit is 4294967296 and overflow. With that option, we manage the counter going back. But there is a few chance we can miss a reboot. | -| --reboot-window | To be used with check-overload option. Time in milliseconds (default: 5000) You increase the chance of not missing a reboot if you decrease that value. | -| --unit | Select the time unit for thresholds. May be 's' for seconds, 'm'for minutes, 'h' for hours, 'd' for days, 'w' for weeks. Default is seconds. | +| Option | Description | +|:-----------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| --filter-counters | Only display some counters (regexp can be used). Example to check SSL connections only : --filter-counters='^xxxx\|yyyy$' | +| --warning-xxx | Warning threshold. | +| --critical-xxx | Critical threshold. | +| --memcached | Memcached server to use (only one server). | +| --redis-server | Redis server to use (only one server). Syntax: address\[:port\] | +| --redis-attribute | Set Redis Options (--redis-attribute="cnx\_timeout=5"). | +| --redis-db | Set Redis database index. | +| --failback-file | Fall back on a local file if Redis connection fails. | +| --memexpiration | Time to keep data in seconds (default: 86400). | +| --statefile-dir | Define the cache directory (default: '/var/lib/centreon/centplugins'). | +| --statefile-suffix | Define a suffix to customize the statefile name (default: ''). | +| --statefile-concat-cwd | If used with the '--statefile-dir' option, the latter's value will be used as a sub-directory of the current working directory. Useful on Windows when the plugin is compiled, as the file system and permissions are different from Linux. | +| --statefile-format | Define the format used to store the cache. Available formats: 'dumper', 'storable', 'json' (default). | +| --statefile-key | Define the key to encrypt/decrypt the cache. | +| --statefile-cipher | Define the cipher algorithm to encrypt the cache (default: 'AES'). | +| --warning-uptime | Warning threshold. | +| --critical-uptime | Critical threshold. | +| --add-sysdesc | Display system description. | +| --force-oid | Can choose your OID (numeric format only). | +| --check-overload | Uptime counter limit is 4294967296 and overflow. With that option, we manage the counter going back. But there is a few chance we can miss a reboot. | +| --reboot-window | To be used with check-overload option. Time in milliseconds (default: 5000) You increase the chance of not missing a reboot if you decrease that value. | +| --unit | Select the time unit for thresholds. May be 's' for seconds, 'm' for minutes, 'h' for hours, 'd' for days, 'w' for weeks. Default is seconds. | -| Option | Description | -|:-------------------------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| --memcached | Memcached server to use (only one server). | -| --redis-server | Redis server to use (only one server). Syntax: address\[:port\] | -| --redis-attribute | Set Redis Options (--redis-attribute="cnx\_timeout=5"). | -| --redis-db | Set Redis database index. | -| --failback-file | Failback on a local file if Redis connection fails. | -| --memexpiration | Time to keep data in seconds (default: 86400). | -| --statefile-dir | Define the cache directory (default: '/var/lib/centreon/centplugins'). | -| --statefile-suffix | Define a suffix to customize the statefile name (default: ''). | -| --statefile-concat-cwd | If used with the '--statefile-dir' option, the latter's value will be used as a sub-directory of the current working directory. Useful on Windows when the plugin is compiled, as the file system and permissions are different from Linux. | -| --statefile-format | Define the format used to store the cache. Available formats: 'dumper', 'storable', 'json' (default). | -| --statefile-key | Define the key to encrypt/decrypt the cache. | -| --statefile-cipher | Define the cipher algorithm to encrypt the cache (default: 'AES'). | -| --filter-counters | Only display some counters (regexp can be used). Example: --filter-counters='status' | -| --filter-name | Filter virtual access points by name (can be a regexp). | -| --filter-ssid | Filter virtual access points by SSID (can be a regexp). | -| --unknown-status | Define the conditions to match for the status to be UNKNOWN. You can use the following variables: %\{name\}, %\{ssid\}, %\{status\} | -| --warning-status | Define the conditions to match for the status to be WARNING. You can use the following variables: %\{name\}, %\{ssid\}, %\{status\} | -| --critical-status | Define the conditions to match for the status to be CRITICAL (default: '%\{status\} eq "down"'). You can use the following variables: %\{name\}, %\{ssid\}, %\{status\} | -| --warning-* --critical-* | Thresholds. Can be: 'total', 'total-clients-connected', 'clients-connected', 'traffic-in', 'traffic-out'. | +| Option | Description | +|:-------------------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| --filter-counters | Only display some counters (regexp can be used). Example: --filter-counters='status' | +| --warning-xxx | Warning threshold. | +| --critical-xxx | Critical threshold. | +| --filter-name | Filter virtual access points by name (can be a regexp). | +| --filter-ssid | Filter virtual access points by SSID (can be a regexp). | +| --unknown-status | Define the conditions to match for the status to be UNKNOWN. You can use the following variables: %\{name\}, %\{ssid\}, %\{status\} | +| --warning-status | Define the conditions to match for the status to be WARNING. You can use the following variables: %\{name\}, %\{ssid\}, %\{status\} | +| --critical-status | Define the conditions to match for the status to be CRITICAL (default: '%\{status\} eq "down"'). You can use the following variables: %\{name\}, %\{ssid\}, %\{status\} | +| --warning-* --critical-* | Thresholds. Can be: 'total', 'total-clients-connected', 'clients-connected', 'traffic-in', 'traffic-out'. | From 90c376ae3f7e5f26a310289bf93f4abff63293bf Mon Sep 17 00:00:00 2001 From: Lucie Tirand <123162035+lucie-tirand@users.noreply.github.com> Date: Thu, 16 Jul 2026 15:17:25 +0200 Subject: [PATCH 3/6] Apply suggestions from code review Co-authored-by: Lucie Tirand <123162035+lucie-tirand@users.noreply.github.com> --- .../plugin-packs/procedures/hardware-pdu-apc-snmp.md | 4 +++- .../procedures/hardware-storage-qnap-snmp.md | 9 +++++++-- .../plugin-packs/procedures/hardware-pdu-apc-snmp.md | 4 +++- .../procedures/hardware-storage-qnap-snmp.md | 5 +++++ 4 files changed, 18 insertions(+), 4 deletions(-) diff --git a/i18n/fr/docusaurus-plugin-content-docs-pp/current/integrations/plugin-packs/procedures/hardware-pdu-apc-snmp.md b/i18n/fr/docusaurus-plugin-content-docs-pp/current/integrations/plugin-packs/procedures/hardware-pdu-apc-snmp.md index c374320e074a..36abfbaeb7a9 100644 --- a/i18n/fr/docusaurus-plugin-content-docs-pp/current/integrations/plugin-packs/procedures/hardware-pdu-apc-snmp.md +++ b/i18n/fr/docusaurus-plugin-content-docs-pp/current/integrations/plugin-packs/procedures/hardware-pdu-apc-snmp.md @@ -28,7 +28,7 @@ Le connecteur apporte les modèles de service suivants | Alias | Modèle de service | Description | |:---------|:--------------------------------|:----------------------------------------| | Hardware | HW-Pdu-Apc-Hardware-SNMP-custom | Contrôle le matériel | -| Load | HW-Pdu-Apc-SNMP-Load-custom | Contrôle la charge (courant en Amperes) | +| Load | HW-Pdu-Apc-SNMP-Load-custom | Contrôle la charge (courant en ampères) | | Outlet | HW-Pdu-Apc-SNMP-Outlet-custom | Contrôle les sorties PDU | > Les services listés ci-dessus sont créés automatiquement lorsque le modèle d'hôte **HW-Pdu-Apc-SNMP-custom** est utilisé. @@ -71,6 +71,8 @@ Voici le tableau des services pour ce connecteur, détaillant les métriques et | humidity status | N/A | | hardware.temperature.count | count | | temperature status | N/A | +| hardware.sensor.humidity.percentage | % | +| hardware.sensor.temperature.celsius | C | diff --git a/i18n/fr/docusaurus-plugin-content-docs-pp/current/integrations/plugin-packs/procedures/hardware-storage-qnap-snmp.md b/i18n/fr/docusaurus-plugin-content-docs-pp/current/integrations/plugin-packs/procedures/hardware-storage-qnap-snmp.md index 8d1185660014..7d6d9ae00f04 100644 --- a/i18n/fr/docusaurus-plugin-content-docs-pp/current/integrations/plugin-packs/procedures/hardware-storage-qnap-snmp.md +++ b/i18n/fr/docusaurus-plugin-content-docs-pp/current/integrations/plugin-packs/procedures/hardware-storage-qnap-snmp.md @@ -66,8 +66,8 @@ Rendez-vous sur la [documentation dédiée](/docs/monitoring/discovery/hosts-dis | Nom de la règle | Description | |:----------------------------------|:-------------------------------------------------------------------------------------------------------| -| HW-Storage-Qnap-SNMP-Disk-Name | Découvre les partitions du disque en utilisant son nom et supervise l'espace occupé | -| HW-Storage-Qnap-SNMP-Traffic-Name | Utilise le nom du disque pour découvrir les partitions du disque et supervise l'occupation de l'espace | +| HW-Storage-Qnap-SNMP-Disk-Name | Découvre les partitions du disque et supervise l'occupation de son espace | +| HW-Storage-Qnap-SNMP-Traffic-Name | Découvre les interfaces réseau et en supervise le statut et l'utilisation | Rendez-vous sur la [documentation dédiée](/docs/monitoring/discovery/services-discovery) pour en savoir plus sur la découverte automatique de services et sa [planification](/docs/monitoring/discovery/services-discovery/#règles-de-découverte). @@ -114,6 +114,11 @@ Voici le tableau des services pour ce connecteur, détaillant les métriques et | raid status | N/A | | hardware.temperature.count | count | | temperature status | N/A | +| hardware.temperature.celsius | C | +| hardware.disk.temperature.celsius | C | +| hardware.mdisk.temperature.celsius | C | +| hardware.fan.speed.rpm | rpm | +| hardware.powersupply.fan.speed.rpm | N/A | diff --git a/pp/integrations/plugin-packs/procedures/hardware-pdu-apc-snmp.md b/pp/integrations/plugin-packs/procedures/hardware-pdu-apc-snmp.md index 4779321d6563..3bfbc94a672c 100644 --- a/pp/integrations/plugin-packs/procedures/hardware-pdu-apc-snmp.md +++ b/pp/integrations/plugin-packs/procedures/hardware-pdu-apc-snmp.md @@ -27,7 +27,7 @@ The connector brings the following service templates (sorted by the host templat | Service Alias | Service Template | Service Description | |:--------------|:--------------------------------|:-------------------------------| | Hardware | HW-Pdu-Apc-Hardware-SNMP-custom | Check hardware | -| Load | HW-Pdu-Apc-SNMP-Load-custom | Check load (current in Amperes | +| Load | HW-Pdu-Apc-SNMP-Load-custom | Check load (current in amperes | | Outlet | HW-Pdu-Apc-SNMP-Outlet-custom | Check PDU outlets | > The services listed above are created automatically when the **HW-Pdu-Apc-SNMP-custom** host template is used. @@ -70,6 +70,8 @@ Here is the list of services for this connector, detailing all metrics and statu | humidity status | N/A | | hardware.temperature.count | count | | temperature status | N/A | +| hardware.sensor.humidity.percentage | % | +| hardware.sensor.temperature.celsius | C | diff --git a/pp/integrations/plugin-packs/procedures/hardware-storage-qnap-snmp.md b/pp/integrations/plugin-packs/procedures/hardware-storage-qnap-snmp.md index 77ba37ddb17c..e75d5f99dc74 100644 --- a/pp/integrations/plugin-packs/procedures/hardware-storage-qnap-snmp.md +++ b/pp/integrations/plugin-packs/procedures/hardware-storage-qnap-snmp.md @@ -113,6 +113,11 @@ Here is the list of services for this connector, detailing all metrics and statu | raid status | N/A | | hardware.temperature.count | count | | temperature status | N/A | +| hardware.temperature.celsius | C | +| hardware.disk.temperature.celsius | C | +| hardware.mdisk.temperature.celsius | C | +| hardware.fan.speed.rpm | rpm | +| hardware.powersupply.fan.speed.rpm | N/A | From 4a81d104429ee6713cc166f576e704902846348c Mon Sep 17 00:00:00 2001 From: Lucie Tirand <123162035+lucie-tirand@users.noreply.github.com> Date: Tue, 21 Jul 2026 14:40:23 +0200 Subject: [PATCH 4/6] Apply suggestions from code review Co-authored-by: cg-tw <83637804+cg-tw@users.noreply.github.com> Co-authored-by: Lucie Tirand <123162035+lucie-tirand@users.noreply.github.com> --- .../procedures/hardware-storage-qnap-snmp.md | 6 +++--- .../procedures/hardware-ups-apc-snmp.md | 4 ++++ .../procedures/network-aruba-aoscx-snmp.md | 3 +++ .../procedures/network-cisco-wlc-snmp.md | 6 +++--- .../procedures/network-stormshield-snmp.md | 8 ++++---- .../network-switchs-aruba-standard-snmp.md | 8 ++++---- .../procedures/network-switchs-brocade-snmp.md | 18 ++++++++++++++++-- ...witchs-cisco-smallbusiness-standard-snmp.md | 8 ++++---- .../procedures/network-ubiquiti-unifi-snmp.md | 4 ++-- 9 files changed, 43 insertions(+), 22 deletions(-) diff --git a/i18n/fr/docusaurus-plugin-content-docs-pp/current/integrations/plugin-packs/procedures/hardware-storage-qnap-snmp.md b/i18n/fr/docusaurus-plugin-content-docs-pp/current/integrations/plugin-packs/procedures/hardware-storage-qnap-snmp.md index 7d6d9ae00f04..f91263751c16 100644 --- a/i18n/fr/docusaurus-plugin-content-docs-pp/current/integrations/plugin-packs/procedures/hardware-storage-qnap-snmp.md +++ b/i18n/fr/docusaurus-plugin-content-docs-pp/current/integrations/plugin-packs/procedures/hardware-storage-qnap-snmp.md @@ -41,9 +41,9 @@ Le connecteur apporte les modèles de service suivants |:---------------------|:-------------------------------------------------|:--------------------------------------------------------------------------------------------------------------------------|:----------:| | Disk-Global | HW-Storage-Qnap-Disk-Global-SNMP-custom | Contrôle du taux d'espace libre disponible des disques. Pour chaque contrôle apparaîtra le point de montage des disques | X | | Pools | HW-Storage-Qnap-Pools-SNMP-custom | Contrôle les pools | | -| Traffic-Generic-Id | HW-Storage-Qnap-Traffic-Generic-Id-SNMP-custom | Contrôle le traffic réseau d'une interface réseau | | -| Traffic-Generic-Name | HW-Storage-Qnap-Traffic-Generic-Name-SNMP-custom | Contrôle le traffic réseau d'une interface réseau | | -| Traffic-Global | HW-Storage-Qnap-Traffic-Global-SNMP-custom | Contrôle le traffic réseau de plusieurs interfaces réseau | X | +| Traffic-Generic-Id | HW-Storage-Qnap-Traffic-Generic-Id-SNMP-custom | Contrôle le trafic réseau d'une interface réseau | | +| Traffic-Generic-Name | HW-Storage-Qnap-Traffic-Generic-Name-SNMP-custom | Contrôle le trafic réseau d'une interface réseau | | +| Traffic-Global | HW-Storage-Qnap-Traffic-Global-SNMP-custom | Contrôle le trafic réseau de plusieurs interfaces réseau | X | > Les services listés ci-dessus ne sont pas créés automatiquement lorsqu'un modèle d'hôte est appliqué. Pour les utiliser, [créez un service manuellement](/docs/monitoring/basic-objects/services) et appliquez le modèle de service souhaité. diff --git a/i18n/fr/docusaurus-plugin-content-docs-pp/current/integrations/plugin-packs/procedures/hardware-ups-apc-snmp.md b/i18n/fr/docusaurus-plugin-content-docs-pp/current/integrations/plugin-packs/procedures/hardware-ups-apc-snmp.md index 485906914a7e..3ccbe0e97350 100644 --- a/i18n/fr/docusaurus-plugin-content-docs-pp/current/integrations/plugin-packs/procedures/hardware-ups-apc-snmp.md +++ b/i18n/fr/docusaurus-plugin-content-docs-pp/current/integrations/plugin-packs/procedures/hardware-ups-apc-snmp.md @@ -5,6 +5,10 @@ title: APC UPS SNMP import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; +## Compatibilité + +Ce connecteur est conçu pour superviser les onduleurs APC UPS, y compris les modèles de la série Galaxy VS.Collapse commentCommen + ## Dépendances du connecteur de supervision Les connecteurs de supervision suivants sont automatiquement installés lors de l'installation du connecteur **APC UPS SNMP** diff --git a/i18n/fr/docusaurus-plugin-content-docs-pp/current/integrations/plugin-packs/procedures/network-aruba-aoscx-snmp.md b/i18n/fr/docusaurus-plugin-content-docs-pp/current/integrations/plugin-packs/procedures/network-aruba-aoscx-snmp.md index d0c9bbde0889..6cc273de792d 100644 --- a/i18n/fr/docusaurus-plugin-content-docs-pp/current/integrations/plugin-packs/procedures/network-aruba-aoscx-snmp.md +++ b/i18n/fr/docusaurus-plugin-content-docs-pp/current/integrations/plugin-packs/procedures/network-aruba-aoscx-snmp.md @@ -13,6 +13,9 @@ depuis la page **Configuration > Connecteurs > Connecteurs de supervision** : ## Contenu du pack +> Depuis le rachat d'Aruba par HP, certaines MIB peuvent avoir changé. Si votre équipement Aruba n'est plus supervisé correctement par le connecteur Aruba, utilisez le connecteur [HP Procurve SNMP](network-switchs-hp-procurve-snmp.md). + + ### Modèles Le connecteur de supervision **ArubaOS-CX SNMP** apporte un modèle d'hôte : diff --git a/i18n/fr/docusaurus-plugin-content-docs-pp/current/integrations/plugin-packs/procedures/network-cisco-wlc-snmp.md b/i18n/fr/docusaurus-plugin-content-docs-pp/current/integrations/plugin-packs/procedures/network-cisco-wlc-snmp.md index 90703d27eff4..e7ea8c7ddbfa 100644 --- a/i18n/fr/docusaurus-plugin-content-docs-pp/current/integrations/plugin-packs/procedures/network-cisco-wlc-snmp.md +++ b/i18n/fr/docusaurus-plugin-content-docs-pp/current/integrations/plugin-packs/procedures/network-cisco-wlc-snmp.md @@ -57,9 +57,9 @@ Le connecteur apporte les modèles de service suivants | Ap-Channel-Noise-Global | Net-Cisco-Wlc-Ap-Channel-Noise-Global-SNMP-custom | Contrôle le bruit sur les canaux de l'ensemble des relais (AP) | | | Ap-Users | Net-Cisco-Wlc-Ap-Users-SNMP-Access-Point-custom | Contrôle le nombre d'utilisateurs du point d'accès | | | Ap-Users | Net-Cisco-Wlc-Ap-Users-SNMP-custom | Contrôle le nombre d'utilisateurs sur l'ensemble des relais (AP) | | -| Traffic-Generic-Id | Net-Cisco-Wlc-Traffic-Generic-Id-SNMP-custom | Contrôle le traffic réseau d'une interface réseau | | -| Traffic-Generic-Name | Net-Cisco-Wlc-Traffic-Generic-Name-SNMP-custom | Contrôle le traffic réseau d'une interface réseau | | -| Traffic-Global | Net-Cisco-Wlc-Traffic-Global-SNMP-custom | Contrôle le traffic réseau de plusieurs interfaces réseau | X | +| Traffic-Generic-Id | Net-Cisco-Wlc-Traffic-Generic-Id-SNMP-custom | Contrôle le trafic réseau d'une interface réseau | | +| Traffic-Generic-Name | Net-Cisco-Wlc-Traffic-Generic-Name-SNMP-custom | Contrôle le trafic réseau d'une interface réseau | | +| Traffic-Global | Net-Cisco-Wlc-Traffic-Global-SNMP-custom | Contrôle le trafic réseau de plusieurs interfaces réseau | X | > Les services listés ci-dessus ne sont pas créés automatiquement lorsqu'un modèle d'hôte est appliqué. Pour les utiliser, [créez un service manuellement](/docs/monitoring/basic-objects/services) et appliquez le modèle de service souhaité. diff --git a/i18n/fr/docusaurus-plugin-content-docs-pp/current/integrations/plugin-packs/procedures/network-stormshield-snmp.md b/i18n/fr/docusaurus-plugin-content-docs-pp/current/integrations/plugin-packs/procedures/network-stormshield-snmp.md index a58f62257ba7..40758cacb0d6 100644 --- a/i18n/fr/docusaurus-plugin-content-docs-pp/current/integrations/plugin-packs/procedures/network-stormshield-snmp.md +++ b/i18n/fr/docusaurus-plugin-content-docs-pp/current/integrations/plugin-packs/procedures/network-stormshield-snmp.md @@ -43,13 +43,13 @@ Le connecteur apporte les modèles de service suivants |:---------------------|:-------------------------------------------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:----------:| | Connections | Net-Stormshield-Connections-SNMP-custom | Contrôle le nombre de connexions TCP/UDP | | | Cpu | Net-Stormshield-Cpu-SNMP-custom | Contrôle du taux d'utilisation du CPU de la machine. Ce contrôle pourra remonter la moyenne du taux d'utilisation des CPU ainsi que le taux par CPU pour les CPU multi-coeur | | -| Disk-Global | Net-Stormshield-Disk-Global-SNMP-custom | Contrôle du taux d'espace libre disponible des disques. Pour chaque contrôle apparaîtra le point de montage des disques (« | | +| Disk-Global | Net-Stormshield-Disk-Global-SNMP-custom | Contrôle du taux d'espace libre disponible des disques. Pour chaque contrôle apparaîtra le point de montage des disques | | | Ha-Status | Net-Stormshield-Ha-Status-SNMP-custom | Contrôle le statut de la HA | | | Health | Net-Stormshield-Health-SNMP-custom | Contrôle l'état de santé | | | Qos | Net-Stormshield-Qos-SNMP-custom | Contrôle l'utilisation QoS | | -| Traffic-Generic-Id | Net-Stormshield-Traffic-Generic-Id-SNMP-custom | Contrôle le traffic réseau d'une interface réseau | | -| Traffic-Generic-Name | Net-Stormshield-Traffic-Generic-Name-SNMP-custom | Contrôle le traffic réseau d'une interface réseau | | -| Traffic-Global | Net-Stormshield-Traffic-Global-SNMP-custom | Contrôle le traffic réseau de plusieurs interfaces réseau | X | +| Traffic-Generic-Id | Net-Stormshield-Traffic-Generic-Id-SNMP-custom | Contrôle le trafic réseau d'une interface réseau | | +| Traffic-Generic-Name | Net-Stormshield-Traffic-Generic-Name-SNMP-custom | Contrôle le trafic réseau d'une interface réseau | | +| Traffic-Global | Net-Stormshield-Traffic-Global-SNMP-custom | Contrôle le trafic réseau de plusieurs interfaces réseau | X | | Vpn-Status | Net-Stormshield-Vpn-Status-SNMP-custom | Contrôle l'état des VPNs | | > Les services listés ci-dessus ne sont pas créés automatiquement lorsqu'un modèle d'hôte est appliqué. Pour les utiliser, [créez un service manuellement](/docs/monitoring/basic-objects/services) et appliquez le modèle de service souhaité. diff --git a/i18n/fr/docusaurus-plugin-content-docs-pp/current/integrations/plugin-packs/procedures/network-switchs-aruba-standard-snmp.md b/i18n/fr/docusaurus-plugin-content-docs-pp/current/integrations/plugin-packs/procedures/network-switchs-aruba-standard-snmp.md index c2b859aec4a8..b713092ead70 100644 --- a/i18n/fr/docusaurus-plugin-content-docs-pp/current/integrations/plugin-packs/procedures/network-switchs-aruba-standard-snmp.md +++ b/i18n/fr/docusaurus-plugin-content-docs-pp/current/integrations/plugin-packs/procedures/network-switchs-aruba-standard-snmp.md @@ -58,9 +58,9 @@ Le connecteur apporte les modèles de service suivants | Packet-Errors-Generic-Id | Net-Aruba-Standard-Packet-Errors-Generic-Id-SNMP-custom | Contrôle le pourcentage de paquets en erreur/écartés de plusieurs interfaces réseau | | | Packet-Errors-Generic-Name | Net-Aruba-Standard-Packet-Errors-Generic-Name-SNMP-custom | Contrôle le pourcentage de paquets en erreur/écartés d'une interface réseau | | | Packet-Errors-Global | Net-Aruba-Standard-Packet-Errors-Global-SNMP-custom | Contrôle le pourcentage de paquets en erreur/écartés de plusieurs interfaces réseau | X | -| Traffic-Generic-Id | Net-Aruba-Standard-Traffic-Generic-Id-SNMP-custom | Contrôle le traffic réseau d'une interface réseau | | -| Traffic-Generic-Name | Net-Aruba-Standard-Traffic-Generic-Name-SNMP-custom | Contrôle le traffic réseau d'une interface réseau | | -| Traffic-Global | Net-Aruba-Standard-Traffic-Global-SNMP-custom | Contrôle le traffic réseau d'une interface réseau | X | +| Traffic-Generic-Id | Net-Aruba-Standard-Traffic-Generic-Id-SNMP-custom | Contrôle le trafic réseau d'une interface réseau | | +| Traffic-Generic-Name | Net-Aruba-Standard-Traffic-Generic-Name-SNMP-custom | Contrôle le trafic réseau d'une interface réseau | | +| Traffic-Global | Net-Aruba-Standard-Traffic-Global-SNMP-custom | Contrôle le trafic réseau d'une interface réseau | X | > Les services listés ci-dessus ne sont pas créés automatiquement lorsqu'un modèle d'hôte est appliqué. Pour les utiliser, [créez un service manuellement](/docs/monitoring/basic-objects/services) et appliquez le modèle de service souhaité. @@ -75,7 +75,7 @@ Le connecteur apporte les modèles de service suivants | Nom de la règle | Description | |:--------------------|:-----------------------------------------------------------| -| Aruba Access Points | Discover Aruba Access Points throught the Aruba Controller | +| Aruba Access Points | Découvre les points d'accès Aruba Access au travers du Controller Aruba | Rendez-vous sur la [documentation dédiée](/docs/monitoring/discovery/hosts-discovery) pour en savoir plus sur la découverte automatique d'hôtes. diff --git a/i18n/fr/docusaurus-plugin-content-docs-pp/current/integrations/plugin-packs/procedures/network-switchs-brocade-snmp.md b/i18n/fr/docusaurus-plugin-content-docs-pp/current/integrations/plugin-packs/procedures/network-switchs-brocade-snmp.md index bfdc0c89ea4d..5450c8e6ebdd 100644 --- a/i18n/fr/docusaurus-plugin-content-docs-pp/current/integrations/plugin-packs/procedures/network-switchs-brocade-snmp.md +++ b/i18n/fr/docusaurus-plugin-content-docs-pp/current/integrations/plugin-packs/procedures/network-switchs-brocade-snmp.md @@ -102,7 +102,15 @@ Voici le tableau des services pour ce connecteur, détaillant les métriques et -Coming soon +| Nom | Unité | +|:----------------------------------------------------------|:------| +| *interface_name*#status | N/A | +| *interface_name*#interface.packets.in.discard.percentage | % | +| *interface_name*#interface.packets.in.error.percentage | % | +| *interface_name*#interface.packets.out.discard.percentage | % | +| *interface_name*#interface.packets.out.error.percentage | % | + +> Concerne les modèles de service suivants : Packet-Errors-Generic-Name, Packet-Errors-Global @@ -115,7 +123,13 @@ Coming soon -Coming soon +|:-----------------------------------------------------|:------| +| *interface_name*#status | N/A | +| *interface_name*#interface.traffic.in.bitspersecond | b/s | +| *interface_name*#interface.traffic.out.bitspersecond | b/s | + +> Concerne les modèles de service suivants : Traffic-Generic-Name, Traffic-Global + diff --git a/i18n/fr/docusaurus-plugin-content-docs-pp/current/integrations/plugin-packs/procedures/network-switchs-cisco-smallbusiness-standard-snmp.md b/i18n/fr/docusaurus-plugin-content-docs-pp/current/integrations/plugin-packs/procedures/network-switchs-cisco-smallbusiness-standard-snmp.md index 79c4791d96b7..13fcaa0f9eae 100644 --- a/i18n/fr/docusaurus-plugin-content-docs-pp/current/integrations/plugin-packs/procedures/network-switchs-cisco-smallbusiness-standard-snmp.md +++ b/i18n/fr/docusaurus-plugin-content-docs-pp/current/integrations/plugin-packs/procedures/network-switchs-cisco-smallbusiness-standard-snmp.md @@ -28,7 +28,7 @@ Le connecteur apporte les modèles de service suivants | Alias | Modèle de service | Description | |:------------|:----------------------------------------------|:--------------------------------------------------------------------------------------------------------------------------| | Cpu | Net-Cisco-Sb-Standard-Cpu-SNMP-custom | Contrôle du taux d'utilisation du CPU de la machine. Ce contrôle pourra remonter la moyenne du taux d'utilisation des CPU | -| Environment | Net-Cisco-Sb-Standard-Environment-SNMP-custom | Contrôle l'état du matériel (Ventilateurs, alimentations) | +| Environment | Net-Cisco-Sb-Standard-Environment-SNMP-custom | Contrôle l'état du matériel (ventilateurs, alimentations) | > Les services listés ci-dessus sont créés automatiquement lorsque le modèle d'hôte **Net-Cisco-Sb-Standard-SNMP-custom** est utilisé. @@ -42,9 +42,9 @@ Le connecteur apporte les modèles de service suivants | Packet-Errors-Global | Net-Cisco-Sb-Standard-Packet-Errors-Global-SNMP-custom | Contrôle le pourcentage de paquets en erreur/écartés de plusieurs interfaces réseau | X | | Spanning-Tree | Net-Cisco-Sb-Standard-SpanningTree-SNMP-custom | Contrôle l'état du protocole Spanning Tree sur les interfaces | | | Stack | Net-Cisco-Sb-Standard-Stack-SNMP-custom | Contrôle les membres du stack | | -| Traffic-Generic-Id | Net-Cisco-Sb-Standard-Traffic-Generic-Id-SNMP-custom | Contrôle le traffic réseau d'une interface réseau | | -| Traffic-Generic-Name | Net-Cisco-Sb-Standard-Traffic-Generic-Name-SNMP-custom | Contrôle le traffic réseau d'une interface réseau | | -| Traffic-Global | Net-Cisco-Sb-Standard-Traffic-Global-SNMP-custom | Contrôle le traffic réseau de plusieurs interfaces réseau | X | +| Traffic-Generic-Id | Net-Cisco-Sb-Standard-Traffic-Generic-Id-SNMP-custom | Contrôle le trafic réseau d'une interface réseau | | +| Traffic-Generic-Name | Net-Cisco-Sb-Standard-Traffic-Generic-Name-SNMP-custom | Contrôle le trafic réseau d'une interface réseau | | +| Traffic-Global | Net-Cisco-Sb-Standard-Traffic-Global-SNMP-custom | Contrôle le trafic réseau de plusieurs interfaces réseau | X | > Les services listés ci-dessus ne sont pas créés automatiquement lorsqu'un modèle d'hôte est appliqué. Pour les utiliser, [créez un service manuellement](/docs/monitoring/basic-objects/services) et appliquez le modèle de service souhaité. diff --git a/i18n/fr/docusaurus-plugin-content-docs-pp/current/integrations/plugin-packs/procedures/network-ubiquiti-unifi-snmp.md b/i18n/fr/docusaurus-plugin-content-docs-pp/current/integrations/plugin-packs/procedures/network-ubiquiti-unifi-snmp.md index 57ecd5f85b67..5c4eff430bed 100644 --- a/i18n/fr/docusaurus-plugin-content-docs-pp/current/integrations/plugin-packs/procedures/network-ubiquiti-unifi-snmp.md +++ b/i18n/fr/docusaurus-plugin-content-docs-pp/current/integrations/plugin-packs/procedures/network-ubiquiti-unifi-snmp.md @@ -27,12 +27,12 @@ Le connecteur apporte les modèles de service suivants | Alias | Modèle de service | Description | |:----------------------|:----------------------------------------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| Cpu | Net-Ubiquiti-Unifi-Cpu-SNMP-custom | Contrôle du taux d'utilisation détaillé CPU de l'equipement. Ce contrôle pourra remonter la moyenne du taux d'utilisation des CPU ainsi que le taux par CPU pour les CPU multi-coeur | +| Cpu | Net-Ubiquiti-Unifi-Cpu-SNMP-custom | Contrôle du taux d'utilisation détaillé CPU de l'équipement. Ce contrôle pourra remonter la moyenne du taux d'utilisation des CPU ainsi que le taux par CPU pour les CPU multi-coeur | | Load | Net-Ubiquiti-Unifi-Load-SNMP-custom | Contrôle de la charge serveur | | Memory | Net-Ubiquiti-Unifi-Memory-SNMP-custom | Contrôle du taux d'utilisation de la mémoire vive (RAM) | | Swap | Net-Ubiquiti-Unifi-Swap-SNMP-custom | Contrôle du taux d'utilisation de la mémoire virtuelle (SWAP) | | Uptime | Net-Ubiquiti-Unifi-Uptime-SNMP-custom | Durée depuis laquelle le serveur tourne sans interruption | -| Virtual-Access-Points | Net-Ubiquiti-Unifi-Virtual-Access-Point-SNMP-custom | Contrôle les points d'accès virtuel | +| Virtual-Access-Points | Net-Ubiquiti-Unifi-Virtual-Access-Point-SNMP-custom | Contrôle les points d'accès virtuels | > Les services listés ci-dessus sont créés automatiquement lorsque le modèle d'hôte **Net-Ubiquiti-Unifi-SNMP-custom** est utilisé. From 9866c59e28471c61b3ecbc956f1d8d704cbcffb7 Mon Sep 17 00:00:00 2001 From: Lucie Tirand <123162035+lucie-tirand@users.noreply.github.com> Date: Tue, 21 Jul 2026 14:49:36 +0200 Subject: [PATCH 5/6] Apply suggestions from code review Co-authored-by: cg-tw <83637804+cg-tw@users.noreply.github.com> Co-authored-by: Lucie Tirand <123162035+lucie-tirand@users.noreply.github.com> --- .../procedures/hardware-servers-hp-snmp.md | 4 ++-- .../procedures/hardware-storage-qnap-snmp.md | 6 +++--- .../procedures/hardware-ups-apc-snmp.md | 4 ++++ .../procedures/network-aruba-aoscx-snmp.md | 2 +- .../procedures/network-cisco-wlc-snmp.md | 4 ++-- .../procedures/network-stormshield-snmp.md | 6 +++--- .../procedures/network-switchs-brocade-snmp.md | 18 ++++++++++++++++-- .../procedures/network-ubiquiti-unifi-snmp.md | 2 +- 8 files changed, 32 insertions(+), 14 deletions(-) diff --git a/pp/integrations/plugin-packs/procedures/hardware-servers-hp-snmp.md b/pp/integrations/plugin-packs/procedures/hardware-servers-hp-snmp.md index 2562bff311ca..be9515f9534a 100644 --- a/pp/integrations/plugin-packs/procedures/hardware-servers-hp-snmp.md +++ b/pp/integrations/plugin-packs/procedures/hardware-servers-hp-snmp.md @@ -35,13 +35,13 @@ The connector brings the following service templates (sorted by the host templat | Service Alias | Service Template | Service Description | |:---------------------|:----------------------------------------------|:-------------------------------| -| Hardware-Cpu | HW-Hp-Server-Hardware-Cpu-SNMP-custom | Check cpu hardware | +| Hardware-Cpu | HW-Hp-Server-Hardware-Cpu-SNMP-custom | Check CPU hardware | | Hardware-Fan | HW-Hp-Server-Hardware-Fan-SNMP-custom | Check fan hardware | | Hardware-Network | HW-Hp-Server-Hardware-Network-SNMP-custom | Check network hardware | | Hardware-Pc | HW-Hp-Server-Hardware-Pc-SNMP-custom | Check power converter hardware | | Hardware-Psu | HW-Hp-Server-Hardware-Psu-SNMP-custom | Check power supply hardware | | Hardware-Storage | HW-Hp-Server-Hardware-Storage-SNMP-custom | Check storage hardware | -| Hardware-Temperature | HW-Hp-Server-Hardware-Temperature-SNMP-custom | Check hardware temperatures | +| Hardware-Temperature | HW-Hp-Server-Hardware-Temperature-SNMP-custom | Check hardware temperature | > The services listed above are not created automatically when a host template is applied. To use them, [create a service manually](/docs/monitoring/basic-objects/services), then apply the service template you want. diff --git a/pp/integrations/plugin-packs/procedures/hardware-storage-qnap-snmp.md b/pp/integrations/plugin-packs/procedures/hardware-storage-qnap-snmp.md index e75d5f99dc74..a04ae80efc6a 100644 --- a/pp/integrations/plugin-packs/procedures/hardware-storage-qnap-snmp.md +++ b/pp/integrations/plugin-packs/procedures/hardware-storage-qnap-snmp.md @@ -38,10 +38,10 @@ The connector brings the following service templates (sorted by the host templat | Service Alias | Service Template | Service Description | Discovery | |:---------------------|:-------------------------------------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------|:---------:| -| Disk-Global | HW-Storage-Qnap-Disk-Global-SNMP-custom | Check the rate of free space on disks. For each checks the mount point of disks will appear (« label »). Thresholds can be in percentage or in free space remaining | X | +| Disk-Global | HW-Storage-Qnap-Disk-Global-SNMP-custom | Check the rate of free space on disks. For each check the mount point of disks will appear (« label »). Thresholds can be in percentage or in free space remaining | X | | Pools | HW-Storage-Qnap-Pools-SNMP-custom | Check pools | | -| Traffic-Generic-Id | HW-Storage-Qnap-Traffic-Generic-Id-SNMP-custom | Check traffic of an network interface | | -| Traffic-Generic-Name | HW-Storage-Qnap-Traffic-Generic-Name-SNMP-custom | Check traffic of an network interface | | +| Traffic-Generic-Id | HW-Storage-Qnap-Traffic-Generic-Id-SNMP-custom | Check traffic of a network interface | | +| Traffic-Generic-Name | HW-Storage-Qnap-Traffic-Generic-Name-SNMP-custom | Check traffic of a network interface | | | Traffic-Global | HW-Storage-Qnap-Traffic-Global-SNMP-custom | Check traffic of multiple network interfaces | X | > The services listed above are not created automatically when a host template is applied. To use them, [create a service manually](/docs/monitoring/basic-objects/services), then apply the service template you want. diff --git a/pp/integrations/plugin-packs/procedures/hardware-ups-apc-snmp.md b/pp/integrations/plugin-packs/procedures/hardware-ups-apc-snmp.md index 03dc1a4aac5c..60b43289bb4e 100644 --- a/pp/integrations/plugin-packs/procedures/hardware-ups-apc-snmp.md +++ b/pp/integrations/plugin-packs/procedures/hardware-ups-apc-snmp.md @@ -5,6 +5,10 @@ title: APC UPS SNMP import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; +## Compatibility + +This connector is designed to monitor APC Uninterruptible Power Supplies (UPS), including models such as the Galaxy VS series. + ## Connector dependencies The following monitoring connectors will be installed when you install the **APC UPS SNMP** connector through the diff --git a/pp/integrations/plugin-packs/procedures/network-aruba-aoscx-snmp.md b/pp/integrations/plugin-packs/procedures/network-aruba-aoscx-snmp.md index 2394ab542e0b..72717d3bff28 100644 --- a/pp/integrations/plugin-packs/procedures/network-aruba-aoscx-snmp.md +++ b/pp/integrations/plugin-packs/procedures/network-aruba-aoscx-snmp.md @@ -26,7 +26,7 @@ The connector brings the following service templates (sorted by the host templat | Service Alias | Service Template | Service Description | |:--------------|:-------------------------------------|:-----------------------------------------------------| -| Cpu | Net-Aruba-Aoscx-Cpu-SNMP-custom | Check cpu | +| Cpu | Net-Aruba-Aoscx-Cpu-SNMP-custom | Check CPU | | Hardware | Net-Aruba-Aoscx-Hardware-SNMP-custom | Check hardware | | Memory | Net-Aruba-Aoscx-Memory-SNMP-custom | Check memory | | Uptime | Net-Aruba-Aoscx-Uptime-SNMP-custom | Time since the system has been working and available | diff --git a/pp/integrations/plugin-packs/procedures/network-cisco-wlc-snmp.md b/pp/integrations/plugin-packs/procedures/network-cisco-wlc-snmp.md index 7f0784a7a3b4..3b9557c3ed61 100644 --- a/pp/integrations/plugin-packs/procedures/network-cisco-wlc-snmp.md +++ b/pp/integrations/plugin-packs/procedures/network-cisco-wlc-snmp.md @@ -56,8 +56,8 @@ The connector brings the following service templates (sorted by the host templat | Ap-Channel-Noise-Global | Net-Cisco-Wlc-Ap-Channel-Noise-Global-SNMP-custom | Check channel noises of all access points | | | Ap-Users | Net-Cisco-Wlc-Ap-Users-SNMP-Access-Point-custom | Check access point total users | | | Ap-Users | Net-Cisco-Wlc-Ap-Users-SNMP-custom | Check total users of all access points | | -| Traffic-Generic-Id | Net-Cisco-Wlc-Traffic-Generic-Id-SNMP-custom | Check traffic of an network interface | | -| Traffic-Generic-Name | Net-Cisco-Wlc-Traffic-Generic-Name-SNMP-custom | Check traffic of an network interface | | +| Traffic-Generic-Id | Net-Cisco-Wlc-Traffic-Generic-Id-SNMP-custom | Check traffic of a network interface | | +| Traffic-Generic-Name | Net-Cisco-Wlc-Traffic-Generic-Name-SNMP-custom | Check traffic of a network interface | | | Traffic-Global | Net-Cisco-Wlc-Traffic-Global-SNMP-custom | Check traffic of multiple network interfaces | X | > The services listed above are not created automatically when a host template is applied. To use them, [create a service manually](/docs/monitoring/basic-objects/services), then apply the service template you want. diff --git a/pp/integrations/plugin-packs/procedures/network-stormshield-snmp.md b/pp/integrations/plugin-packs/procedures/network-stormshield-snmp.md index 0dc38f81a6e1..212112d9b2d2 100644 --- a/pp/integrations/plugin-packs/procedures/network-stormshield-snmp.md +++ b/pp/integrations/plugin-packs/procedures/network-stormshield-snmp.md @@ -42,7 +42,7 @@ The connector brings the following service templates (sorted by the host templat |:---------------------|:-------------------------------------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------|:---------:| | Connections | Net-Stormshield-Connections-SNMP-custom | Check the number of TCP/UDP connections | | | Cpu | Net-Stormshield-Cpu-SNMP-custom | Check the rate of utilization of CPU for the machine. This check can give the average CPU utilization rate and the rate per CPU for multi-core CPU | | -| Disk-Global | Net-Stormshield-Disk-Global-SNMP-custom | Check the rate of free space on disks. For each checks the mount point of disks will appear (« label »). Thresholds can be in percentage or in free space remaining | | +| Disk-Global | Net-Stormshield-Disk-Global-SNMP-custom | Check the rate of free space on disks. For each check the mount point of disks will appear (« label »). Thresholds can be in percentage or in free space remaining | | | Ha-Status | Net-Stormshield-Ha-Status-SNMP-custom | Check HA status | | | Health | Net-Stormshield-Health-SNMP-custom | Check health | | | Qos | Net-Stormshield-Qos-SNMP-custom | Check QoS usage | | @@ -561,8 +561,8 @@ yum install centreon-plugin-Network-Stormshield-Snmp | Macro | Description | Default value | Mandatory | |:--------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------|:---------------------|:---------:| | FILTERID | Filter by ID (regexp can be used) | | | -| FILTERSRCIP | Filter by src ip (regexp can be used) | | | -| FILTERDSTIP | Filter by dst ip (regexp can be used) | | | +| FILTERSRCIP |Filter by source IP address (regexp can be used) | | | +| FILTERDSTIP | Filter by destination IP address (regexp can be used) | | | | WARNINGSTATUS | Define the conditions to match for the status to be WARNING. You can use the following variables: %\{state\}, %\{srcIp\}, %\{dstIp\} | %\{state\} eq "dead" | | | CRITICALSTATUS | Define the conditions to match for the status to be CRITICAL. You can use the following variables: %\{state\}, %\{srcIp\}, %\{dstIp\} | | | | WARNINGTRAFFIC | Threshold | | | diff --git a/pp/integrations/plugin-packs/procedures/network-switchs-brocade-snmp.md b/pp/integrations/plugin-packs/procedures/network-switchs-brocade-snmp.md index bd2a0208dea0..9ebfbfe3a52d 100644 --- a/pp/integrations/plugin-packs/procedures/network-switchs-brocade-snmp.md +++ b/pp/integrations/plugin-packs/procedures/network-switchs-brocade-snmp.md @@ -101,7 +101,15 @@ Here is the list of services for this connector, detailing all metrics and statu -Coming soon +| Name | Unit | +|:----------------------------------------------------------|:------| +| *interface_name*#status | N/A | +| *interface_name*#interface.packets.in.discard.percentage | % | +| *interface_name*#interface.packets.in.error.percentage | % | +| *interface_name*#interface.packets.out.discard.percentage | % | +| *interface_name*#interface.packets.out.error.percentage | % | + +> Applies to the following service templates: Packet-Errors-Generic-Name, Packet-Errors-Global @@ -114,7 +122,13 @@ Coming soon -Coming soon +| Name | Unit | +|:-----------------------------------------------------|:------| +| *interface_name*#status | N/A | +| *interface_name*#interface.traffic.in.bitspersecond | b/s | +| *interface_name*#interface.traffic.out.bitspersecond | b/s | + +> Applies to the following service templates: Traffic-Generic-Name, Traffic-Global diff --git a/pp/integrations/plugin-packs/procedures/network-ubiquiti-unifi-snmp.md b/pp/integrations/plugin-packs/procedures/network-ubiquiti-unifi-snmp.md index b6e4c1b6f7c9..7acdc8c88efd 100644 --- a/pp/integrations/plugin-packs/procedures/network-ubiquiti-unifi-snmp.md +++ b/pp/integrations/plugin-packs/procedures/network-ubiquiti-unifi-snmp.md @@ -40,7 +40,7 @@ The connector brings the following service templates (sorted by the host templat | Service Alias | Service Template | Service Description | Discovery | |:--------------|:------------------------------------------|:--------------------|:---------:| -| Disks | Net-Ubiquiti-Unifi-Disks-SNMP-custom | Check disk usages | | +| Disks | Net-Ubiquiti-Unifi-Disks-SNMP-custom | Check disk usage | | | Interfaces | Net-Ubiquiti-Unifi-Interfaces-SNMP-custom | Check interfaces | X | > The services listed above are not created automatically when a host template is applied. To use them, [create a service manually](/docs/monitoring/basic-objects/services), then apply the service template you want. From 01688d2ea992e6014751bd1369c1b7518b17f32c Mon Sep 17 00:00:00 2001 From: Lucie Tirand <123162035+lucie-tirand@users.noreply.github.com> Date: Tue, 21 Jul 2026 14:54:11 +0200 Subject: [PATCH 6/6] Apply suggestions from code review Co-authored-by: Lucie Tirand <123162035+lucie-tirand@users.noreply.github.com> --- .../procedures/hardware-servers-hp-snmp.md | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/i18n/fr/docusaurus-plugin-content-docs-pp/current/integrations/plugin-packs/procedures/hardware-servers-hp-snmp.md b/i18n/fr/docusaurus-plugin-content-docs-pp/current/integrations/plugin-packs/procedures/hardware-servers-hp-snmp.md index 5fee5cb7663e..a784435fc48c 100644 --- a/i18n/fr/docusaurus-plugin-content-docs-pp/current/integrations/plugin-packs/procedures/hardware-servers-hp-snmp.md +++ b/i18n/fr/docusaurus-plugin-content-docs-pp/current/integrations/plugin-packs/procedures/hardware-servers-hp-snmp.md @@ -257,7 +257,7 @@ yum install centreon-plugin-Hardware-Servers-Hp-Snmp | Macro | Description | Valeur par défaut | Obligatoire | |:-------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------|:------------------|:-----------:| -| COMPONENT | Which component to check. Can be: 'cpu', 'psu', 'pc', 'fan', 'temperature', 'lnic', 'pnic',... There are some magic words like: 'network', 'storage' | cpu | | +| COMPONENT | Which component to check | cpu | | | EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). Toutes les options sont listées [ici](#options-disponibles). | --verbose | | @@ -265,7 +265,7 @@ yum install centreon-plugin-Hardware-Servers-Hp-Snmp | Macro | Description | Valeur par défaut | Obligatoire | |:-------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------|:------------------|:-----------:| -| COMPONENT | Which component to check. Can be: 'cpu', 'psu', 'pc', 'fan', 'temperature', 'lnic', 'pnic',... There are some magic words like: 'network', 'storage' | fan | | +| COMPONENT | Which component to check | fan | | | EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). Toutes les options sont listées [ici](#options-disponibles). | --verbose | | @@ -281,7 +281,7 @@ yum install centreon-plugin-Hardware-Servers-Hp-Snmp | Macro | Description | Valeur par défaut | Obligatoire | |:-------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------|:------------------|:-----------:| -| COMPONENT | Which component to check. Can be: 'cpu', 'psu', 'pc', 'fan', 'temperature', 'lnic', 'pnic',... There are some magic words like: 'network', 'storage' | network | | +| COMPONENT | Which component to check | network | | | EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). Toutes les options sont listées [ici](#options-disponibles). | --verbose | | @@ -289,7 +289,7 @@ yum install centreon-plugin-Hardware-Servers-Hp-Snmp | Macro | Description | Valeur par défaut | Obligatoire | |:-------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------|:------------------|:-----------:| -| COMPONENT | Which component to check. Can be: 'cpu', 'psu', 'pc', 'fan', 'temperature', 'lnic', 'pnic',... There are some magic words like: 'network', 'storage' | pc | | +| COMPONENT | Which component to check | pc | | | EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). Toutes les options sont listées [ici](#options-disponibles). | --verbose | | @@ -297,7 +297,7 @@ yum install centreon-plugin-Hardware-Servers-Hp-Snmp | Macro | Description | Valeur par défaut | Obligatoire | |:-------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------|:------------------|:-----------:| -| COMPONENT | Which component to check. Can be: 'cpu', 'psu', 'pc', 'fan', 'temperature', 'lnic', 'pnic',... There are some magic words like: 'network', 'storage' | psu | | +| COMPONENT | Which component to check | psu | | | EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). Toutes les options sont listées [ici](#options-disponibles). | --verbose | | @@ -305,7 +305,7 @@ yum install centreon-plugin-Hardware-Servers-Hp-Snmp | Macro | Description | Valeur par défaut | Obligatoire | |:-------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------|:------------------|:-----------:| -| COMPONENT | Which component to check. Can be: 'cpu', 'psu', 'pc', 'fan', 'temperature', 'lnic', 'pnic',... There are some magic words like: 'network', 'storage' | storage | | +| COMPONENT | Which component to check | storage | | | EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). Toutes les options sont listées [ici](#options-disponibles). | --verbose | | @@ -313,7 +313,7 @@ yum install centreon-plugin-Hardware-Servers-Hp-Snmp | Macro | Description | Valeur par défaut | Obligatoire | |:-------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------|:------------------|:-----------:| -| COMPONENT | Which component to check. Can be: 'cpu', 'psu', 'pc', 'fan', 'temperature', 'lnic', 'pnic',... There are some magic words like: 'network', 'storage' | temperature | | +| COMPONENT | Which component to check | temperature | | | EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). Toutes les options sont listées [ici](#options-disponibles). | --verbose | |