diff --git a/i18n/fr/docusaurus-plugin-content-docs-pp/current/integrations/plugin-packs/procedures/hardware-storage-emc-xtremio-restapi.md b/i18n/fr/docusaurus-plugin-content-docs-pp/current/integrations/plugin-packs/procedures/hardware-storage-emc-xtremio-restapi.md index f53fe5ff97ed..afd41571ec7a 100644 --- a/i18n/fr/docusaurus-plugin-content-docs-pp/current/integrations/plugin-packs/procedures/hardware-storage-emc-xtremio-restapi.md +++ b/i18n/fr/docusaurus-plugin-content-docs-pp/current/integrations/plugin-packs/procedures/hardware-storage-emc-xtremio-restapi.md @@ -2,34 +2,451 @@ id: hardware-storage-emc-xtremio-restapi title: EMC Xtremio --- +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; -## Prerequisites +## Dépendances du Connecteur de supervision -### Centreon Plugin +Les connecteurs de supervision suivants sont automatiquement installés lors de l'installation du connecteur **EMC Xtremio** +depuis la page **Configuration > Gestionnaire de connecteurs de supervision** : +* [Base Pack](./base-generic.md) -Install this plugin on each needed poller: +## Contenu du pack -``` shell +### Modèles + +Le connecteur de supervision **EMC Xtremio** apporte un modèle d'hôte : + +* **HW-Storage-EMC-Xtremio-Restatpi-custom** + +Le connecteur apporte les modèles de service suivants +(classés selon le modèle d'hôte auquel ils sont rattachés) : + + + + +| Alias | Modèle de service | Description | +|:---------------|:-----------------------------------------------------|:----------------------------------------------------------| +| Cluster-Health | HW-Storage-EMC-Xtremio-Cluster-Health-Restapi-custom | Contrôle l'état des 'clusters' | +| SSDs-Endurance | HW-Storage-EMC-Xtremio-SSDs-Endurance-Restapi-custom | Contrôle la durée de vie restante des SSDs en pourcentage | +| SSDs-Iops | HW-Storage-EMC-Xtremio-SSDs-Iops-Restapi-custom | Contrôle le nombre d'IOPS sur les SSDs | +| XenVS-CPU | HW-Storage-EMC-Xtremio-XenVS-CPU-Restapi-custom | Contrôle l'utilisation CPU des XenVS de l'Xtremio | +| XenVS-State | HW-Storage-EMC-Xtremio-XenVS-State-Restapi-custom | Contrôle l'état des XenVS de l'Xtremio | + +> Les services listés ci-dessus sont créés automatiquement lorsque le modèle d'hôte **HW-Storage-EMC-Xtremio-Restatpi-custom** est utilisé. + + + + +### Métriques & statuts collectés + +Voici le tableau des services pour ce connecteur, détaillant les métriques et statuts rattachés à chaque service. + + + + +| Nom | Unité | +|:--------------|:------| +| consistency-state | N/A | +| shared-memory-efficiency-level | N/A | +| free-ud-ssd-space-level | N/A | +| vaai-tp-limit-crossing | N/A | +| shared-memory-in-use-ratio-level | N/A | +| sys-health-state | N/A | + + + + +| Nom | Unité | +|:--------------|:------| +| ssd-endurence | % | + + + + +| Nom | Unité | +|:--------------|:------| +| total | iops | +| total-read | iops | +| total-write | iops | +| *ssd1*#global | iops | +| *ssd2*#global | iops | +| *ssd1*#read | iops | +| *ssd2*#read | iops | +| *ssd1*#write | iops | +| *ssd2*#write | iops | + +> Pour obtenir ce nouveau format de métrique, incluez la valeur **--use-new-perfdata** dans la macro de service **EXTRAOPTIONS**. + + + + +| Nom | Unité | +|:--------------|:------| +| cpu-usage | % | + + + + +| Nom | Unité | +|:--------------|:------| +| xenv-status | N/A | + + + + +## Prérequis + +Un identifiant et un mot de passe API sont nécessaires pour superviser EMC Xtremio via l'API REST. + +## Installer le connecteur de supervision + +### Pack + +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 > Gestionnaire de connecteurs de supervision**. +Au contraire, si la plateforme utilise une licence *offline*, installez le paquet +sur le **serveur central** via la commande correspondant au gestionnaire de paquets +associé à sa distribution : + + + + +```bash +dnf install centreon-pack-hardware-storage-emc-xtremio-restapi +``` + + + + +```bash +dnf install centreon-pack-hardware-storage-emc-xtremio-restapi +``` + + + + +```bash +apt install centreon-pack-hardware-storage-emc-xtremio-restapi +``` + + + + +```bash +yum install centreon-pack-hardware-storage-emc-xtremio-restapi +``` + + + + +2. Quel que soit le type de la licence (*online* ou *offline*), installez le connecteur **EMC Xtremio** +depuis l'interface web et le menu **Configuration > Gestionnaire de connecteurs de supervision**. + +### Plugin + +À partir de Centreon 22.04, il est possible de demander le déploiement automatique +du plugin lors de l'utilisation d'un connecteur. Si cette fonctionnalité est activée, et +que vous ne souhaitez pas découvrir des éléments pour la première fois, alors cette +étape n'est pas requise. + +> Plus d'informations dans la section [Installer le plugin](/docs/monitoring/pluginpacks/#installer-le-plugin). + +Utilisez les commandes ci-dessous en fonction du gestionnaire de paquets de votre système d'exploitation : + + + + +```bash +dnf install centreon-plugin-Hardware-Storage-Emc-Xtremio-Restapi +``` + + + + +```bash +dnf install centreon-plugin-Hardware-Storage-Emc-Xtremio-Restapi +``` + + + + +```bash +apt install centreon-plugin-hardware-storage-emc-xtremio-restapi +``` + + + + +```bash yum install centreon-plugin-Hardware-Storage-Emc-Xtremio-Restapi ``` -### Rest API + + + +## Utiliser le connecteur de supervision + +### Utiliser un modèle d'hôte issu du connecteur + +1. Ajoutez un hôte à Centreon depuis la page **Configuration > Hôtes**. +2. Complétez les champs **Nom**, **Alias** & **IP Address/DNS** correspondant à votre ressource. +3. Appliquez le modèle d'hôte **HW-Storage-EMC-Xtremio-Restatpi-custom**. Une liste de macros apparaît. Les macros vous permettent de définir comment le connecteur se connectera à la ressource, ainsi que de personnaliser le comportement du connecteur. +4. Renseignez les macros désirées. Attention, certaines macros sont obligatoires. + +| Macro | Description | Valeur par défaut | Obligatoire | +|:----------------|:-----------------|:------------------|:-----------:| +| XTREMIOUSERNAME | Xtremio username | | | +| XTREMIOPASSWORD | Xtremio password | | | +| APIEXTRAOPTS | | | | + +5. [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. + +### Utiliser un modèle de service issu du connecteur + +1. Si vous avez utilisé un modèle d'hôte et coché la case **Créer aussi les services liés aux modèles**, les services associés au modèle ont été créés automatiquement, avec les modèles de services correspondants. Sinon, [créez les services désirés manuellement](/docs/monitoring/basic-objects/services) et appliquez-leur un modèle de service. +2. Renseignez les macros désirées (par exemple, ajustez les seuils d'alerte). Les macros indiquées ci-dessous comme requises (**Obligatoire**) doivent être renseignées. + + + + +| Macro | Description | Valeur par défaut | Obligatoire | +|:-------------|:---------------------------------------------------------------------------------------------------|:------------------|:-----------:| +| 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 some parts (comma separated list) You can also exclude items from specific instances: --filter=ssds,SSD-NAME-NUMBER | ssds,(?!.*) | | +| CRITICAL | Critical trigger for SSD endurance | | | +| WARNING | Warning trigger for SSD endurance | | | +| 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 the SSD names to monitor with a regular expression. Example: --filter-name '.*' for all SSDs | | | +| CRITICALGLOBAL | Threshold | | | +| WARNINGGLOBAL | Threshold | | | +| CRITICALREAD | Threshold | | | +| WARNINGREAD | Threshold | | | +| CRITICALWRITE | Threshold | | | +| WARNINGWRITE | 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 | +|:-------------|:---------------------------------------------------------------------------------------------------|:------------------|:-----------:| +| CRITICAL | Value to trigger a critical alarm on CPU usage | | | +| WARNING | Value to trigger a warning alarm on CPU usage | | | +| 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 some parts (comma separated list) You can also exclude items from specific instances: --filter=device,cluster-1\_xxxx | device,(?!(.*)) | | +| 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 | | + + + + +3. [Déployez la configuration](/docs/monitoring/monitoring-servers/deploying-a-configuration). Le service apparaît dans la liste des services 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 du service : celle-ci montre les valeurs des macros. + +## Comment puis-je tester le plugin et que signifient les options des commandes ? + +Une fois le plugin installé, vous pouvez tester celui-ci directement en ligne +de commande depuis votre collecteur Centreon en vous connectant avec +l'utilisateur **centreon-engine** (`su - centreon-engine`). Vous pouvez tester +que le connecteur arrive bien à superviser une ressource en utilisant une commande +telle que celle-ci (remplacez les valeurs d'exemple par les vôtres) : + +```bash +/usr/lib/centreon/plugins/centreon_emc_xtremio.pl \ + --plugin storage::emc::xtremio::restapi::plugin \ + --custommode xtremioapi \ + --mode ssds-iops \ + --hostname 10.0.0.1 \ + --xtremio-username 'xxxxx' \ + --xtremio-password 'xxxxx' \ + --filter-name '' \ + --warning-read \ + --critical-read \ + --warning-write \ + --critical-write \ + --warning-global \ + --critical-global \ + --verbose +``` + +La commande devrait retourner un message de sortie similaire à : + +```bash +OK: Total : 84736 iops Total read : 66476 iops Total write : 60811 iops All SSDs usages are ok | 'total'=84736iops;;;0; 'total-read'=66476iops;;;0; 'total-write'=60811iops;;;0; 'ssd1#global'=61190iops;;;0; 'ssd2#global'=61560iops;;;0; 'ssd1#read'=24501iops;;;0; 'ssd2#read'=68513iops;;;0; 'ssd1#write'=95000iops;;;0; 'ssd2#write'=87186iops;;;0; +``` + +### Diagnostic des erreurs communes + +Rendez-vous sur la [documentation dédiée](../getting-started/how-to-guides/troubleshooting-plugins.md#http-and-api-checks) +des plugins basés sur HTTP/API. + +### 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 +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. + +Tous les modes disponibles peuvent être affichés en ajoutant le paramètre +`--list-mode` à la commande : + +```bash +/usr/lib/centreon/plugins/centreon_emc_xtremio.pl \ + --plugin storage::emc::xtremio::restapi::plugin \ + --list-mode +``` + +Le plugin apporte les modes suivants : + +| Mode | Modèle de service associé | +|:---------------------------------------------------------------------------------------------------------------------------------------------------|:-----------------------------------------------------| +| cluster-health [[code](https://github.com/centreon/centreon-plugins/blob/develop/src/storage/emc/xtremio/restapi/mode/clusterhealth.pm)] | HW-Storage-EMC-Xtremio-Cluster-Health-Restapi-custom | +| dpg [[code](https://github.com/centreon/centreon-plugins/blob/develop/src/storage/emc/xtremio/restapi/mode/dpg.pm)] | Not used in this Monitoring Connector | +| ssds-endurance [[code](https://github.com/centreon/centreon-plugins/blob/develop/src/storage/emc/xtremio/restapi/mode/ssdendurance.pm)] | HW-Storage-EMC-Xtremio-SSDs-Endurance-Restapi-custom | +| ssds-iops [[code](https://github.com/centreon/centreon-plugins/blob/develop/src/storage/emc/xtremio/restapi/mode/ssdiops.pm)] | HW-Storage-EMC-Xtremio-SSDs-Iops-Restapi-custom | +| storage-controllers [[code](https://github.com/centreon/centreon-plugins/blob/develop/src/storage/emc/xtremio/restapi/mode/storagecontrollers.pm)] | Not used in this Monitoring Connector | +| xenvs-cpu [[code](https://github.com/centreon/centreon-plugins/blob/develop/src/storage/emc/xtremio/restapi/mode/xenvscpu.pm)] | HW-Storage-EMC-Xtremio-XenVS-CPU-Restapi-custom | +| xenvs-state [[code](https://github.com/centreon/centreon-plugins/blob/develop/src/storage/emc/xtremio/restapi/mode/xenvsstate.pm)] | HW-Storage-EMC-Xtremio-XenVS-State-Restapi-custom | + +### Options disponibles -The plugin need an account to connect on Rest API. +#### Options génériques -## Centreon Configuration +Les options génériques sont listées ci-dessous : -### Create a host using the appropriate template +| 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. | +| --custommode | When a plugin offers several ways (CLI, library, etc.) to get information the desired one must be defined with this option. | +| --list-custommode | List all available custom modes. | +| --multiple | Multiple custom mode objects. This may be required by some specific modes (advanced). | +| --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\],\[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 | +| --http-peer-addr | Set the address you want to connect to. Useful if hostname is only a vhost, to avoid IP resolution. | +| --proxyurl | Proxy URL. Example: http://my.proxy:3128 | +| --proxypac | Proxy pac file (can be a URL or a local file). | +| --insecure | Accept insecure SSL connections. | +| --http-backend | Perl library to use for HTTP transactions. Possible values are: lwp (default) and curl. | +| --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'). | +| --hostname | Xtremio hostname. | +| --xtremio-username | Xtremio username. | +| --xtremio-password | Xtremio password. | +| --timeout | Set HTTP timeout | +| --reload-cache-time | Time in seconds before reloading cache file (default: 180). The cache is used when XMS manages multiple clusters. | -Go to *Configuration \> Hosts* and click *Add*. Then, fill the form as shown by -the following table: +#### Options des modes -| Field | Value | -| :---------------------- | :------------------------------------ | -| Host name | *Name of the host* | -| Alias | *Host description* | -| IP | *Host IP Address* | -| Monitored from | *Monitoring Poller to use* | -| Host Multiple Templates | HW-Storage-EMC-Xtremio-Restapi-custom | +Les options disponibles pour chaque modèle de services sont listées ci-dessous : -Click on the *Save* button. + + + +| Option | Description | +|:---------------------|:-------------------------------------------------------------------------------------------------------------------------------| +| --filter | Filter some parts (comma separated list) You can also exclude items from specific instances: --filter=cluster,CLUSTER-NAME | +| --threshold-overload | Overload a specific threshold. Example: --threshold-overload="consistency-state,Xtremio,CRITICAL,healthy" | + + + + +| Option | Description | +|:-----------|:-------------------------------------------------------------------------------------------------------------------------------| +| --filter | Filter some parts (comma separated list) You can also exclude items from specific instances: --filter=ssds,SSD-NAME-NUMBER | +| --warning | Warning trigger for SSD endurance | +| --critical | Critical trigger for SSD endurance | + + + + +| Option | Description | +|:-------------------------|:------------------------------------------------------------------------------------------------------------------------------| +| --filter-counters | Only display some counters (regexp can be used). Example to check SSL connections only : --filter-counters='^xxxx\|yyyy$' | +| --warning-* --critical-* | Warning threshold (number of iops) Can be: 'total', 'total-read', 'total-write', 'global', 'read', 'write'. | +| --filter-name | Filter the SSD names to monitor with a regular expression. Example: --filter-name '.*' for all SSDs. | + + + + +| Option | Description | +|:-----------|:--------------------------------------------------------------------------------------------------------------------------------| +| --filter | Filter some parts (comma separated list) You can also exclude items from specific instances: --filter=cpu,XENVS-NAME-NUMBER | +| --warning | Value to trigger a warning alarm on CPU usage | +| --critical | Value to trigger a critical alarm on CPU usage | + + + + +| Option | Description | +|:---------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| --filter | Filter some parts (comma separated list) You can also exclude items from specific instances: --filter=device,cluster-1\_xxxx | +| --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='xenvs\_state,CRITICAL,^(?!(ok)$)' | + + + + +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 : + +```bash +/usr/lib/centreon/plugins/centreon_emc_xtremio.pl \ + --plugin storage::emc::xtremio::restapi::plugin \ + --custommode xtremioapi \ + --help +``` diff --git a/pp/integrations/plugin-packs/procedures/hardware-storage-emc-xtremio-restapi.md b/pp/integrations/plugin-packs/procedures/hardware-storage-emc-xtremio-restapi.md index f53fe5ff97ed..d9f93763e0de 100644 --- a/pp/integrations/plugin-packs/procedures/hardware-storage-emc-xtremio-restapi.md +++ b/pp/integrations/plugin-packs/procedures/hardware-storage-emc-xtremio-restapi.md @@ -2,34 +2,450 @@ id: hardware-storage-emc-xtremio-restapi title: EMC Xtremio --- +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +## Connector dependencies + +The following monitoring connectors will be installed when you install the **EMC Xtremio** connector through the +**Configuration > Monitoring Connector Manager** menu: +* [Base Pack](./base-generic.md) + +## Pack assets + +### Templates + +The Monitoring Connector **EMC Xtremio** brings a host template: + +* **HW-Storage-EMC-Xtremio-Restatpi-custom** + +The connector brings the following service templates (sorted by the host template they are attached to): + + + + +| Service Alias | Service Template | Service Description | +|:---------------|:-----------------------------------------------------|:--------------------------------------| +| Cluster-Health | HW-Storage-EMC-Xtremio-Cluster-Health-Restapi-custom | Check cluster state | +| SSDs-Endurance | HW-Storage-EMC-Xtremio-SSDs-Endurance-Restapi-custom | Check SSDs life remaining in percent | +| SSDs-Iops | HW-Storage-EMC-Xtremio-SSDs-Iops-Restapi-custom | Check Iops on SSDs disks | +| XenVS-CPU | HW-Storage-EMC-Xtremio-XenVS-CPU-Restapi-custom | Check XenVS CPU usage | +| XenVS-State | HW-Storage-EMC-Xtremio-XenVS-State-Restapi-custom | Check XenVS State | + +> The services listed above are created automatically when the **HW-Storage-EMC-Xtremio-Restatpi-custom** host template is used. + + + + +### Collected metrics & status + +Here is the list of services for this connector, detailing all metrics and statuses linked to each service. + + + + +| Name | Unit | +|:--------------|:------| +| consistency-state | N/A | +| shared-memory-efficiency-level | N/A | +| free-ud-ssd-space-level | N/A | +| vaai-tp-limit-crossing | N/A | +| shared-memory-in-use-ratio-level | N/A | +| sys-health-state | N/A | + + + + +| Name | Unit | +|:--------------|:------| +| ssd-endurence | % | + + + + +| Name | Unit | +|:--------------|:------| +| total | iops | +| total-read | iops | +| total-write | iops | +| *ssd1*#global | iops | +| *ssd2*#global | iops | +| *ssd1*#read | iops | +| *ssd2*#read | iops | +| *ssd1*#write | iops | +| *ssd2*#write | iops | + +> To obtain this new metric format, include **--use-new-perfdata** in the **EXTRAOPTIONS** service macro. + + + + +| Name | Unit | +|:--------------|:------| +| cpu-usage | % | + + + + +| Name | Unit | +|:--------------|:------| +| xenv-status | N/A | + + + ## Prerequisites -### Centreon Plugin +An API username and password are required to monitor EMC Xtremio via the REST API. + +## Installing the monitoring connector + +### Pack + +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 > Monitoring Connector Manager** menu. +If the platform uses an *offline* license, install the package on the **central server** +with the command corresponding to the operating system's package manager: + + + + +```bash +dnf install centreon-pack-hardware-storage-emc-xtremio-restapi +``` + + + + +```bash +dnf install centreon-pack-hardware-storage-emc-xtremio-restapi +``` + + + + +```bash +apt install centreon-pack-hardware-storage-emc-xtremio-restapi +``` + + + + +```bash +yum install centreon-pack-hardware-storage-emc-xtremio-restapi +``` + + + + +2. Whatever the license type (*online* or *offline*), install the **EMC Xtremio** connector through +the **Configuration > Monitoring Connector Manager** menu. + +### Plugin + +Since Centreon 22.04, you can benefit from the 'Automatic plugin installation' feature. +When this feature is enabled, you can skip the installation part below. + +You still have to manually install the plugin on the poller(s) when: +- Automatic plugin installation is turned off +- You want to run a discovery job from a poller that doesn't monitor any resource of this kind yet + +> More information in the [Installing the plugin](/docs/monitoring/pluginpacks/#installing-the-plugin) section. + +Use the commands below according to your operating system's package manager: + + + + +```bash +dnf install centreon-plugin-Hardware-Storage-Emc-Xtremio-Restapi +``` + + + + +```bash +dnf install centreon-plugin-Hardware-Storage-Emc-Xtremio-Restapi +``` -Install this plugin on each needed poller: + + -``` shell +```bash +apt install centreon-plugin-hardware-storage-emc-xtremio-restapi +``` + + + + +```bash yum install centreon-plugin-Hardware-Storage-Emc-Xtremio-Restapi ``` -### Rest API + + + +## Using the monitoring connector + +### Using a host template provided by the connector + +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-EMC-Xtremio-Restatpi-custom** template to the host. A list of macros appears. Macros allow you to define how the connector will connect to the resource, and to customize the connector's behavior. +4. Fill in the macros you want. Some macros are mandatory. + +| Macro | Description | Default value | Mandatory | +|:----------------|:-----------------|:------------------|:-----------:| +| XTREMIOUSERNAME | Xtremio username | | | +| XTREMIOPASSWORD | Xtremio password | | | +| APIEXTRAOPTS | | | | + +5. [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. + +### Using a service template provided by the connector + +1. If you have used a host template and checked **Create Services linked to the Template too**, the services linked to the template have been created automatically, using the corresponding service templates. Otherwise, [create manually the services you want](/docs/monitoring/basic-objects/services) and apply a service template to them. +2. Fill in the macros you want (e.g. to change the thresholds for the alerts). Some macros are mandatory (see the table below). + + + + +| 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 | +|:-------------|:---------------------------------------------------------------------------------------------------------------------------|:------------------|:-----------:| +| FILTER | Filter some parts (comma separated list) You can also exclude items from specific instances: --filter=ssds,SSD-NAME-NUMBER | ssds,(?!.*) | | +| CRITICAL | Critical trigger for SSD endurance | | | +| WARNING | Warning trigger for SSD endurance | | | +| 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 the SSD names to monitor with a regular expression. Example: --filter-name '.*' for all SSDs | | | +| CRITICALGLOBAL | Threshold | | | +| WARNINGGLOBAL | Threshold | | | +| CRITICALREAD | Threshold | | | +| WARNINGREAD | Threshold | | | +| CRITICALWRITE | Threshold | | | +| WARNINGWRITE | 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 | +|:-------------|:---------------------------------------------------------------------------------------------------|:------------------|:-----------:| +| CRITICAL | Value to trigger a critical alarm on CPU usage | | | +| WARNING | Value to trigger a warning alarm on CPU usage | | | +| 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 some parts (comma separated list) You can also exclude items from specific instances: --filter=device,cluster-1\_xxxx | device,(?!(.*)) | | +| 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 | | + + + + +3. [Deploy the configuration](/docs/monitoring/monitoring-servers/deploying-a-configuration). The service appears in the list of services, and on the **Resources Status** page. The command that is sent by the connector is displayed in the details panel of the service: it shows the values of the macros. + +## How to check in the CLI that the configuration is OK and what are the main options for? + +Once the plugin is installed, log into your Centreon poller's CLI using the +**centreon-engine** user account (`su - centreon-engine`). Test that the connector +is able to monitor a resource using a command like this one (replace the sample values by yours): + +```bash +/usr/lib/centreon/plugins/centreon_emc_xtremio.pl \ + --plugin storage::emc::xtremio::restapi::plugin \ + --custommode xtremioapi \ + --mode ssds-iops \ + --hostname 10.0.0.1 \ + --xtremio-username 'xxxxx' \ + --xtremio-password 'xxxxx' \ + --filter-name '' \ + --warning-read \ + --critical-read \ + --warning-write \ + --critical-write \ + --warning-global \ + --critical-global \ + --verbose +``` + +The expected command output is shown below: + +```bash +OK: Total : 84736 iops Total read : 66476 iops Total write : 60811 iops All SSDs usages are ok | 'total'=84736iops;;;0; 'total-read'=66476iops;;;0; 'total-write'=60811iops;;;0; 'ssd1#global'=61190iops;;;0; 'ssd2#global'=61560iops;;;0; 'ssd1#read'=24501iops;;;0; 'ssd2#read'=68513iops;;;0; 'ssd1#write'=95000iops;;;0; 'ssd2#write'=87186iops;;;0; +``` + +### Troubleshooting + +Please find the troubleshooting documentation for the API-based plugins in +this [chapter](../getting-started/how-to-guides/troubleshooting-plugins.md#http-and-api-checks). + +### Available modes + +In most cases, a mode corresponds to a service template. The mode appears in the execution command for the connector. +In the Centreon interface, you don't need to specify a mode explicitly: its use is implied when you apply a service template. +However, you will need to specify the correct mode for the template if you want to test the execution command for the +connector in your terminal. + +All available modes can be displayed by adding the `--list-mode` parameter to +the command: + +```bash +/usr/lib/centreon/plugins/centreon_emc_xtremio.pl \ + --plugin storage::emc::xtremio::restapi::plugin \ + --list-mode +``` + +The plugin brings the following modes: + +| Mode | Linked service template | +|:---------------------------------------------------------------------------------------------------------------------------------------------------|:-----------------------------------------------------| +| cluster-health [[code](https://github.com/centreon/centreon-plugins/blob/develop/src/storage/emc/xtremio/restapi/mode/clusterhealth.pm)] | HW-Storage-EMC-Xtremio-Cluster-Health-Restapi-custom | +| dpg [[code](https://github.com/centreon/centreon-plugins/blob/develop/src/storage/emc/xtremio/restapi/mode/dpg.pm)] | Not used in this Monitoring Connector | +| ssds-endurance [[code](https://github.com/centreon/centreon-plugins/blob/develop/src/storage/emc/xtremio/restapi/mode/ssdendurance.pm)] | HW-Storage-EMC-Xtremio-SSDs-Endurance-Restapi-custom | +| ssds-iops [[code](https://github.com/centreon/centreon-plugins/blob/develop/src/storage/emc/xtremio/restapi/mode/ssdiops.pm)] | HW-Storage-EMC-Xtremio-SSDs-Iops-Restapi-custom | +| storage-controllers [[code](https://github.com/centreon/centreon-plugins/blob/develop/src/storage/emc/xtremio/restapi/mode/storagecontrollers.pm)] | Not used in this Monitoring Connector | +| xenvs-cpu [[code](https://github.com/centreon/centreon-plugins/blob/develop/src/storage/emc/xtremio/restapi/mode/xenvscpu.pm)] | HW-Storage-EMC-Xtremio-XenVS-CPU-Restapi-custom | +| xenvs-state [[code](https://github.com/centreon/centreon-plugins/blob/develop/src/storage/emc/xtremio/restapi/mode/xenvsstate.pm)] | HW-Storage-EMC-Xtremio-XenVS-State-Restapi-custom | + +### Available options -The plugin need an account to connect on Rest API. +#### Generic options -## Centreon Configuration +All generic options are listed here: -### Create a host using the appropriate template +| 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. | +| --custommode | When a plugin offers several ways (CLI, library, etc.) to get information the desired one must be defined with this option. | +| --list-custommode | List all available custom modes. | +| --multiple | Multiple custom mode objects. This may be required by some specific modes (advanced). | +| --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\],\[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 | +| --http-peer-addr | Set the address you want to connect to. Useful if hostname is only a vhost, to avoid IP resolution. | +| --proxyurl | Proxy URL. Example: http://my.proxy:3128 | +| --proxypac | Proxy pac file (can be a URL or a local file). | +| --insecure | Accept insecure SSL connections. | +| --http-backend | Perl library to use for HTTP transactions. Possible values are: lwp (default) and curl. | +| --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'). | +| --hostname | Xtremio hostname. | +| --xtremio-username | Xtremio username. | +| --xtremio-password | Xtremio password. | +| --timeout | Set HTTP timeout | +| --reload-cache-time | Time in seconds before reloading cache file (default: 180). The cache is used when XMS manages multiple clusters. | -Go to *Configuration \> Hosts* and click *Add*. Then, fill the form as shown by -the following table: +#### Modes options -| Field | Value | -| :---------------------- | :------------------------------------ | -| Host name | *Name of the host* | -| Alias | *Host description* | -| IP | *Host IP Address* | -| Monitored from | *Monitoring Poller to use* | -| Host Multiple Templates | HW-Storage-EMC-Xtremio-Restapi-custom | +All available options for each service template are listed below: -Click on the *Save* button. + + + +| Option | Description | +|:---------------------|:-------------------------------------------------------------------------------------------------------------------------------| +| --filter | Filter some parts (comma separated list) You can also exclude items from specific instances: --filter=cluster,CLUSTER-NAME | +| --threshold-overload | Overload a specific threshold. Example: --threshold-overload="consistency-state,Xtremio,CRITICAL,healthy" | + + + + +| Option | Description | +|:-----------|:-------------------------------------------------------------------------------------------------------------------------------| +| --filter | Filter some parts (comma separated list) You can also exclude items from specific instances: --filter=ssds,SSD-NAME-NUMBER | +| --warning | Warning trigger for SSD endurance | +| --critical | Critical trigger for SSD endurance | + + + + +| Option | Description | +|:-------------------------|:------------------------------------------------------------------------------------------------------------------------------| +| --filter-counters | Only display some counters (regexp can be used). Example to check SSL connections only : --filter-counters='^xxxx\|yyyy$' | +| --warning-* --critical-* | Warning threshold (number of iops) Can be: 'total', 'total-read', 'total-write', 'global', 'read', 'write'. | +| --filter-name | Filter the SSD names to monitor with a regular expression. Example: --filter-name '.*' for all SSDs. | + + + + +| Option | Description | +|:-----------|:--------------------------------------------------------------------------------------------------------------------------------| +| --filter | Filter some parts (comma separated list) You can also exclude items from specific instances: --filter=cpu,XENVS-NAME-NUMBER | +| --warning | Value to trigger a warning alarm on CPU usage | +| --critical | Value to trigger a critical alarm on CPU usage | + + + + +| Option | Description | +|:---------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| --filter | Filter some parts (comma separated list) You can also exclude items from specific instances: --filter=device,cluster-1\_xxxx | +| --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='xenvs\_state,CRITICAL,^(?!(ok)$)' | + + + + +All available options for a given mode can be displayed by adding the +`--help` parameter to the command: + +```bash +/usr/lib/centreon/plugins/centreon_emc_xtremio.pl \ + --plugin storage::emc::xtremio::restapi::plugin \ + --custommode xtremioapi \ + --help +```