diff --git a/i18n/fr/docusaurus-plugin-content-docs-pp/current/integrations/plugin-packs/procedures/cloud-aws-fsx.md b/i18n/fr/docusaurus-plugin-content-docs-pp/current/integrations/plugin-packs/procedures/cloud-aws-fsx.md index 7e04ac3a15a4..52a510b4a01c 100644 --- a/i18n/fr/docusaurus-plugin-content-docs-pp/current/integrations/plugin-packs/procedures/cloud-aws-fsx.md +++ b/i18n/fr/docusaurus-plugin-content-docs-pp/current/integrations/plugin-packs/procedures/cloud-aws-fsx.md @@ -5,6 +5,12 @@ title: Amazon FSx 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 **Amazon FSx** +depuis la page **Configuration > Connecteurs > Connecteurs de supervision** : +* [Base Pack](./base-generic.md) + ## Contenu du pack ### Modèles @@ -21,8 +27,8 @@ Le connecteur apporte les modèles de service suivants | Alias | Modèle de service | Description | |:--------------|:-----------------------------------|:-----------------------------------------------------------| -| Fsx-DataUsage | Cloud-Aws-Fsx-Datausage-Api-custom | Contrôle les métriques liées au système de fichiers FSx | -| Fsx-Freespace | Cloud-Aws-Fsx-Freespace-Api-custom | Contrôle l'espace disponible sur un système de fichiers FSx | +| Fsx-DataUsage | Cloud-Aws-Fsx-Datausage-Api-custom | Contrôle les métriques liées au système de fichier FSx | +| Fsx-Freespace | Cloud-Aws-Fsx-Freespace-Api-custom | Contrôle l'espace disponible sur un système de fichier FSx | > Les services listés ci-dessus sont créés automatiquement lorsque le modèle d'hôte **Cloud-Aws-Fsx-custom** est utilisé. @@ -35,31 +41,36 @@ Le connecteur apporte les modèles de service suivants | Nom de la règle | Description | |:----------------|:------------------------| -| Amazon AWS FSX | Discover Amazon AWS FSX instances | +| Amazon AWS FSX | Discover Amazon AWS FSX | 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é | -|:------------------------|:------| -| fsx.data.read.bytes | B | -| fsx.data.write.bytes | B | -| fsx.data.io.read.count | count | -| fsx.data.io.write.count | count | -| fsx.metadata.ops.bytes | B | +| Nom | Unité | +|:--------------------------------|:--------| +| fsx.data.read.bytes | B | +| fsx.data.read.bytespersecond | B/s | +| fsx.data.write.bytes | B | +| fsx.data.write.bytespersecond | B/s | +| fsx.data.io.read.count | count | +| fsx.data.io.read.persecond | count/s | +| fsx.data.io.write.count | count | +| fsx.data.io.write.persecond | count/s | +| fsx.metadata.ops.bytes | B | +| fsx.metadata.ops.bytespersecond | B/s | -| Métrique | Unité | -|:---------------------|:------| -| fsx.storage.free.byt | B | +| Nom | Unité | +|:-----------------------|:------| +| fsx.storage.free.bytes | B | @@ -69,13 +80,10 @@ Voici le tableau des services pour ce connecteur, détaillant les métriques rat ### Privilèges AWS Configurez un compte de service (via une combinaison d'access et secret key) et affectez-lui les privilèges suivants : +* cloudwatch:getMetricStatistics +* fsx:DescribeFileSystems -| AWS Privilege | Description | -| :----------------------------- | :--------------------------------------------------- | -| fsx:DescribeFileSystems | Display FSx instances & details | -| cloudwatch:getMetricStatistics | Get metrics from the AWS/FSx namespace on Cloudwatch | - -### Dépendances du Plugin +### Dépendances du plugin Afin de récupérer les informations nécessaires via les APIs AWS, il est possible d'utiliser soit le binaire *awscli* fourni par Amazon, soit le SDK Perl *paws*. Le SDK est recommandé car plus performant. @@ -197,17 +205,16 @@ yum install centreon-plugin-Cloud-Aws-Fsx-Api 3. Appliquez le modèle d'hôte **Cloud-Aws-Fsx-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, notamment la macro permettant de définir le [custom mode](#custom-modes-disponibles), c'est-à-dire la méthode de connexion à la ressource. -| Macro | Description | Valeur par défaut | Obligatoire | -|:----------------|:---------------------------------------------------------------------------------------------------------------------------|:------------------|:-----------:| -| AWSACCESSKEY | Set AWS access key | | | -| AWSASSUMEROLE | Set arn of the role to be assumed | | | -| AWSCUSTOMMODE | When a plugin offers several ways (CLI, library, etc.) to get information the desired one must be defined with this option | awscli | | -| AWSFILESYSTEMID | Set the instance name (Required) (can be defined multipletimes) | | X | -| AWSREGION | Set the region name (Required) | | X | -| AWSSECRETKEY | Set AWS secret key | | | -| FILESYSTEMID | | | | -| PROXYURL | Proxy URL if any | | | -| EXTRAOPTIONS | Any extra option you may want to add to every command (E.g. a --verbose flag). Toutes les options sont listées [ici](#options-disponibles) | | | +| Macro | Description | Valeur par défaut | Obligatoire | +|:----------------|:---------------------------------------------------------------------------------------------------------------------------------------------------|:------------------|:-----------:| +| AWSACCESSKEY | Set AWS access key | | | +| AWSASSUMEROLE | Set Amazon Resource Name of the role to be assumed | | | +| AWSCUSTOMMODE | When a plugin offers several ways (CLI, library, etc.) to get information the desired one must be defined with this option | awscli | | +| AWSFILESYSTEMID | Set the instance name (can be defined multiple times) | | X | +| AWSREGION | Set the region name | | X | +| AWSSECRETKEY | Set AWS secret key | | | +| PROXYURL | Proxy URL if any | | | +| EXTRAOPTIONS | 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). | | | 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. @@ -219,34 +226,36 @@ yum install centreon-plugin-Cloud-Aws-Fsx-Api -| Macro | Description | Valeur par défaut | Obligatoire | -|:-------------------------|:-------------------------------------------------------------------------------------------------------------------------------|:------------------|:-----------:| -| STATISTIC | Set the metric calculation method (Only Sum is relevant) | sum | | -| TIMEFRAME | Set timeframe in seconds | 900 | | -| PERIOD | Set period in seconds | 60 | | -| FILTERMETRIC | Filter on a specific metric. Can be: DataReadBytes, DataWriteBytes, DataReadOperations, DataWriteOperations, MetaDataOperations | | | -| WARNINGDATAREADBYTES | Thresholds | | | -| CRITICALDATAREADBYTES | Thresholds | | | -| WARNINGDATAREADOPS | Thresholds | | | -| CRITICALDATAREADOPS | Thresholds | | | -| WARNINGDATAWRITEOPS | Thresholds | | | -| CRITICALDATAWRITEOPS | Thresholds | | | -| WARNINGMETADATAOPSBYTES | Thresholds | | | -| CRITICALMETADATAOPSBYTES | Thresholds | | | -| 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) | --verbose | | +| Macro | Description | Valeur par défaut | Obligatoire | +|:-------------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------|:------------------|:-----------:| +| STATISTIC | Set the metric calculation method (Only Sum is relevant) | sum | | +| TIMEFRAME | Set timeframe in seconds | 900 | | +| PERIOD | Set period in seconds | 60 | | +| FILTERMETRIC | Filter on a specific metric. Can be: DataReadBytes, DataWriteBytes, DataReadOperations, DataWriteOperations, MetaDataOperations | | | +| WARNINGDATAREADBYTES | Threshold | | | +| CRITICALDATAREADBYTES | Threshold | | | +| WARNINGDATAREADOPS | Threshold | | | +| CRITICALDATAREADOPS | Threshold | | | +| WARNINGDATAWRITEBYTES | Threshold | | | +| CRITICALDATAWRITEBYTES | Threshold | | | +| WARNINGDATAWRITEOPS | Threshold | | | +| CRITICALDATAWRITEOPS | Threshold | | | +| WARNINGMETADATAOPSBYTES | Threshold | | | +| CRITICALMETADATAOPSBYTES | 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 | -|:-------------------------|:----------------------------------------------------------------------------------------------------|:------------------|:-----------:| -| STATISTIC | Set the metric calculation method (Default: Average). Can be 'minimum', 'average' | average | | -| TIMEFRAME | Set timeframe in seconds (e.g. '3600' to check last 60 minutes) | 900 | | -| PERIOD | Set period in seconds. | 60 | | -| FILTERMETRIC | Name of the metrics to filter on. | | | -| WARNINGSTORAGEFREEBYTES | Warning threshold for remaining available bytes | | | -| CRITICALSTORAGEFREEBYTES | Warning threshold for remaining available bytes | | | -| 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) | --verbose | | +| Macro | Description | Valeur par défaut | Obligatoire | +|:-------------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------|:------------------|:-----------:| +| STATISTIC | Set the metric calculation method Can be 'minimum', 'average' | average | | +| TIMEFRAME | Set timeframe in seconds | 900 | | +| PERIOD | Set period in seconds | 60 | | +| FILTERMETRIC | Name of the metrics to filter | | | +| WARNINGSTORAGEFREEBYTES | Warning threshold for remaining available bytes | | | +| CRITICALSTORAGEFREEBYTES | Critical threshold for remaining available 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). | --verbose | | @@ -321,7 +330,7 @@ Le plugin apporte les modes suivants : | Mode | Modèle de service associé | |:------------------------------------------------------------------------------------------------------------------|:-----------------------------------| | datausage [[code](https://github.com/centreon/centreon-plugins/blob/develop/src/cloud/aws/fsx/mode/datausage.pm)] | Cloud-Aws-Fsx-Datausage-Api-custom | -| discovery [[code](https://github.com/centreon/centreon-plugins/blob/develop/src/cloud/aws/fsx/mode/discovery.pm)] | Used for host discovery | +| discovery [[code](https://github.com/centreon/centreon-plugins/blob/develop/src/cloud/aws/fsx/mode/discovery.pm)] | Utilisé pour la découverte d'hôtes | | freespace [[code](https://github.com/centreon/centreon-plugins/blob/develop/src/cloud/aws/fsx/mode/freespace.pm)] | Cloud-Aws-Fsx-Freespace-Api-custom | ### Custom modes disponibles @@ -338,8 +347,8 @@ Tous les custom modes disponibles peuvent être affichés en ajoutant le paramè Le plugin apporte les custom modes suivants : -* awscli * paws +* awscli ### Options disponibles @@ -347,84 +356,87 @@ Le plugin apporte les custom 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. | -| --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. Eg: 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). Eg: 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). Eg: 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). Eg: 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. Eg: 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. Eg: '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'. | +| 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\[,\[\\],\[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 custom modes Les options spécifiques aux **custom modes** sont listées ci-dessous : - - -| Option | Description | -|:--------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| --aws-secret-key | Set AWS secret key. | -| --aws-access-key | Set AWS access key. | -| --aws-session-token | Set AWS session token. | -| --aws-role-arn | Set arn of the role to be assumed. | -| --aws-profile | Set AWS profile. | -| --endpoint-url | Override AWS service endpoint URL if necessary. | -| --region | Set the region name (Required). | -| --period | Set period in seconds. | -| --timeframe | Set timeframe in seconds. | -| --statistic | Set cloudwatch statistics (Can be: 'minimum', 'maximum', 'average', 'sum'). | -| --zeroed | Set metrics value to 0 if none. Useful when CloudWatch does not return value when not defined. | -| --timeout | Set timeout in seconds (Default: 50). | -| --sudo | Use 'sudo' to execute the command. | -| --command | Command to get information (Default: 'aws'). Can be changed if you have output in a file. | -| --command-path | Command path (Default: none). | -| --command-options | Command options (Default: none). Only use for testing purpose, when you want to set ALL parameters of a command by yourself. | -| --proxyurl | Proxy URL if any | -| --skip-ssl-check | Avoid certificate issuer verification. Useful when AWS resources are hosted by a third-party. Note that it strips all stderr from the command result. Will be enhanced someday. Debug will only display CLI instead of evreything. | - - -| Option | Description | -|:--------------------|:-------------------------------------------------------------------------------------------------| -| --aws-secret-key | Set AWS secret key. | -| --aws-access-key | Set AWS access key. | -| --aws-session-token | Set AWS session token. | -| --aws-role-arn | Set arn of the role to be assumed. | -| --region | Set the region name (Required). | -| --period | Set period in seconds. | -| --timeframe | Set timeframe in seconds. | -| --statistic | Set cloudwatch statistics (Can be: 'minimum', 'maximum', 'average', 'sum'). | -| --zeroed | Set metrics value to 0 if none. Useful when CloudWatch does not return value when not defined. | -| --proxyurl | Proxy URL if any | +| Option | Description | +|:--------------------|:-----------------------------------------------------------------------------------------------| +| --aws-secret-key | Set AWS secret key. | +| --aws-access-key | Set AWS access key. | +| --aws-session-token | Set AWS session token. | +| --aws-role-arn | Set arn of the role to be assumed. | +| --region | Set the region name . | +| --period | Set period in seconds. | +| --timeframe | Set timeframe in seconds. | +| --statistic | Set cloudwatch statistics (can be: 'minimum', 'maximum', 'average', 'sum'). | +| --zeroed | Set metrics value to 0 if none. Useful when CloudWatch does not return value when not defined. | +| --proxyurl | Proxy URL if any | + + +| Option | Description | +|:--------------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| --aws-secret-key | Set AWS secret key. | +| --aws-access-key | Set AWS access key. | +| --aws-session-token | Set AWS session token. | +| --aws-role-arn | Set Amazon Resource Name of the role to be assumed. | +| --aws-profile | Set AWS profile. | +| --endpoint-url | Override AWS service endpoint URL if necessary. | +| --region | Set the region name . | +| --period | Set period in seconds. | +| --timeframe | Set timeframe in seconds. | +| --statistic | Set CloudWatch statistics (can be: 'minimum', 'maximum', 'average', 'sum'). | +| --zeroed | Set metrics value to 0 if none. Useful when CloudWatch does not return value when not defined. | +| --timeout | Set timeout in seconds (default: 50). | +| --sudo | Use 'sudo' to execute the command. | +| --command | Command to get information (default: 'aws'). Can be changed if you have output in a file. | +| --command-path | Command path (default: none). | +| --command-options | Command options (default: none). Only use for testing purpose, when you want to set ALL parameters of a command by yourself. | +| --proxyurl | Proxy URL if any | +| --skip-ssl-check | Avoid certificate issuer verification. Useful when AWS resources are hosted by a third party. Note that it strips all stderr from the command result. Debug will only display CLI instead of everything. | @@ -435,21 +447,24 @@ Les options disponibles pour chaque modèle de services sont listées ci-dessous -| Option | Description | -|:--------------------|:----------------------------------------------------------------------------------------------------------------------------------------| -| --name | Set the instance name (required) (can be defined multiple times). | -| --filter-metric | Filter on a specific metric. Can be: DataReadBytes, DataWriteBytes, DataReadOperations, DataWriteOperations, MetaDataOperations | -| --warning-$metric$ | Thresholds warning ($metric$ can be: 'data-write-ops', 'data-write-ops', 'data-read-ops', 'data-read-bytes', 'metadata-ops-bytes'). | -| --critical-$metric$ | Thresholds critical ($metric$ can be: 'data-write-ops', 'data-write-ops', 'data-read-ops', 'data-read-bytes', 'metadata-ops-bytes'). | +| Option | Description | +|:--------------------|:-------------------------------------------------------------------------------------------------------------------------------------| +| --filter-counters | Only display some counters (regexp can be used). Example to check SSL connections only : --filter-counters='^xxxx\|yyyy$' | +| --name | Set the instance name (can be defined multiple times). | +| --filter-metric | Filter on a specific metric. Can be: DataReadBytes, DataWriteBytes, DataReadOperations, DataWriteOperations, MetaDataOperations | +| --statistic | Set the metric calculation method (Only Sum is relevant). | +| --warning-$metric$ | Warning threshold ($metric$ can be: 'data-write-ops', 'data-write-ops', 'data-read-ops', 'data-read-bytes', 'metadata-ops-bytes'). | +| --critical-$metric$ | Critical threshold ($metric$ can be: 'data-write-ops', 'data-write-ops', 'data-read-ops', 'data-read-bytes', 'metadata-ops-bytes'). | -| Option | Description | -|:------------------------------|:-------------------------------------------------------------------| -| --name | Set the instance name (required) (can be defined multiple times). | -| --warning-storage-free-bytes | Warning threshold for remaining available bytes. | -| --critical-storage-free-bytes | Warning threshold for remaining available bytes. | +| Option | Description | +|:------------------------------|:---------------------------------------------------------------------------------| +| --name | Set the instance name (can be defined multiple times). | +| --statistic | Set the metric calculation method (default: Average) Can be 'minimum', 'average' | +| --warning-storage-free-bytes | Warning threshold for remaining available bytes. | +| --critical-storage-free-bytes | Critical threshold for remaining available bytes. | @@ -460,7 +475,6 @@ affichée en ajoutant le paramètre `--help` à la commande : ```bash /usr/lib/centreon/plugins/centreon_aws_fsx_api.pl \ --plugin=cloud::aws::fsx::plugin \ - --mode=datausage \ - --custommode='paws' \ + --mode=freespace \ --help ``` diff --git a/pp/integrations/plugin-packs/procedures/cloud-aws-fsx.md b/pp/integrations/plugin-packs/procedures/cloud-aws-fsx.md index fc4e8418c5f3..dab88c288c5c 100644 --- a/pp/integrations/plugin-packs/procedures/cloud-aws-fsx.md +++ b/pp/integrations/plugin-packs/procedures/cloud-aws-fsx.md @@ -5,6 +5,12 @@ title: Amazon FSx import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; +## Connector dependencies + +The following monitoring connectors will be installed when you install the **Amazon FSx** connector through the +**Configuration > Connectors > Monitoring Connectors** menu: +* [Base Pack](./base-generic.md) + ## Pack assets ### Templates @@ -20,7 +26,7 @@ The connector brings the following service templates (sorted by the host templat | Service Alias | Service Template | Service Description | |:--------------|:-----------------------------------|:-----------------------------------------------| -| Fsx-DataUsage | Cloud-Aws-Fsx-Datausage-Api-custom | Check FSx filesystem related I/O metrics. | +| Fsx-DataUsage | Cloud-Aws-Fsx-Datausage-Api-custom | Check FSx filesystem related I/O metrics | | Fsx-Freespace | Cloud-Aws-Fsx-Freespace-Api-custom | Check free space available on a FSx filesystem | > The services listed above are created automatically when the **Cloud-Aws-Fsx-custom** host template is used. @@ -32,33 +38,38 @@ The connector brings the following service templates (sorted by the host templat #### Host discovery -| Rule name | Description | -|:----------------|:------------------------| -| Amazon AWS FSX | Discover Amazon AWS FSX | +| Rule name | Description | +|:---------------|:------------------------| +| Amazon AWS FSX | Discover Amazon AWS FSX | 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 | -|:------------------------|:------| -| fsx.data.read.bytes | B | -| fsx.data.write.bytes | B | -| fsx.data.io.read.count | count | -| fsx.data.io.write.count | count | -| fsx.metadata.ops.bytes | B | +| Name | Unit | +|:--------------------------------|:--------| +| fsx.data.read.bytes | B | +| fsx.data.read.bytespersecond | B/s | +| fsx.data.write.bytes | B | +| fsx.data.write.bytespersecond | B/s | +| fsx.data.io.read.count | count | +| fsx.data.io.read.persecond | count/s | +| fsx.data.io.write.count | count | +| fsx.data.io.write.persecond | count/s | +| fsx.metadata.ops.bytes | B | +| fsx.metadata.ops.bytespersecond | B/s | -| Metric Name | Unit | -|:---------------------|:------| -| fsx.storage.free.byt | B | +| Name | Unit | +|:-----------------------|:-----| +| fsx.storage.free.bytes | B | @@ -68,11 +79,8 @@ Here is the list of services for this connector, detailing all metrics linked to ### AWS Configuration Configure a service account (access/secret key combo) for which the following privileges have to be granted: - -| AWS Privilege | Description | -| :----------------------------- | :--------------------------------------------------- | -| fsx:DescribeFileSystems | Display FSx instances & details | -| cloudwatch:getMetricStatistics | Get metrics from the AWS/FSx namespace on Cloudwatch | +* cloudwatch:getMetricStatistics +* fsx:DescribeFileSystems ### Plugin dependencies @@ -103,8 +111,7 @@ sudo ./aws/install ### 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 @@ -195,21 +202,20 @@ yum install centreon-plugin-Cloud-Aws-Fsx-Api ### 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 **Cloud-Aws-Fsx-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, in particular the macro for defining the [custom mode](#available-custom-modes), i.e. the connection method to the resource. -| Macro | Description | Default value | Mandatory | -|:----------------|:---------------------------------------------------------------------------------------------------------------------------|:------------------|:-----------:| -| AWSACCESSKEY | Set AWS access key | | | -| AWSASSUMEROLE | Set arn of the role to be assumed | | | -| AWSCUSTOMMODE | When a plugin offers several ways (CLI, library, etc.) to get information the desired one must be defined with this option | awscli | | -| AWSFILESYSTEMID | Set the instance name (Required) (can be defined multipletimes) | | X | -| AWSREGION | Set the region name (Required) | | X | -| AWSSECRETKEY | Set AWS secret key | | | -| FILESYSTEMID | | | | -| PROXYURL | Proxy URL if any | | | -| EXTRAOPTIONS | Any extra option you may want to add to every command (E.g. a --verbose flag). All options are listed [here](#available-options) | | | +| Macro | Description | Default value | Mandatory | +|:----------------|:---------------------------------------------------------------------------------------------------------------------------------------------------|:--------------|:---------:| +| AWSACCESSKEY | Set AWS access key | | | +| AWSASSUMEROLE | Set Amazon Resource Name of the role to be assumed | | | +| AWSCUSTOMMODE | When a plugin offers several ways (CLI, library, etc.) to get information the desired one must be defined with this option | awscli | | +| AWSFILESYSTEMID | Set the instance name (can be defined multiple times) | | X | +| AWSREGION | Set the region name | | X | +| AWSSECRETKEY | Set AWS secret key | | | +| PROXYURL | Proxy URL if any | | | +| EXTRAOPTIONS | Any extra option you may want to add to every command (a --verbose flag for example). All options are listed [here](#available-options). | | | 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. @@ -221,34 +227,36 @@ yum install centreon-plugin-Cloud-Aws-Fsx-Api -| Macro | Description | Default value | Mandatory | -|:-------------------------|:-------------------------------------------------------------------------------------------------------------------------------|:------------------|:-----------:| -| STATISTIC | Set the metric calculation method (Only Sum is relevant) | sum | | -| TIMEFRAME | Set timeframe in seconds | 900 | | -| PERIOD | Set period in seconds | 60 | | -| FILTERMETRIC | Filter on a specific metric. Can be: DataReadBytes, DataWriteBytes, DataReadOperations, DataWriteOperations, MetaDataOperations | | | -| WARNINGDATAREADBYTES | Thresholds | | | -| CRITICALDATAREADBYTES | Thresholds | | | -| WARNINGDATAREADOPS | Thresholds | | | -| CRITICALDATAREADOPS | Thresholds | | | -| WARNINGDATAWRITEOPS | Thresholds | | | -| CRITICALDATAWRITEOPS | Thresholds | | | -| WARNINGMETADATAOPSBYTES | Thresholds | | | -| CRITICALMETADATAOPSBYTES | Thresholds | | | -| EXTRAOPTIONS | Any extra option you may want to add to the command (E.g. a --verbose flag). All options are listed [here](#available-options) | --verbose | | +| Macro | Description | Default value | Mandatory | +|:-------------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------|:--------------|:---------:| +| STATISTIC | Set the metric calculation method (Only Sum is relevant) | sum | | +| TIMEFRAME | Set timeframe in seconds | 900 | | +| PERIOD | Set period in seconds | 60 | | +| FILTERMETRIC | Filter on a specific metric. Can be: DataReadBytes, DataWriteBytes, DataReadOperations, DataWriteOperations, MetaDataOperations | | | +| WARNINGDATAREADBYTES | Threshold | | | +| CRITICALDATAREADBYTES | Threshold | | | +| WARNINGDATAREADOPS | Threshold | | | +| CRITICALDATAREADOPS | Threshold | | | +| WARNINGDATAWRITEBYTES | Threshold | | | +| CRITICALDATAWRITEBYTES | Threshold | | | +| WARNINGDATAWRITEOPS | Threshold | | | +| CRITICALDATAWRITEOPS | Threshold | | | +| WARNINGMETADATAOPSBYTES | Threshold | | | +| CRITICALMETADATAOPSBYTES | 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 | -|:-------------------------|:----------------------------------------------------------------------------------------------------|:------------------|:-----------:| -| STATISTIC | Set the metric calculation method (Default: Average). Can be 'minimum', 'average' | average | | -| TIMEFRAME | Set timeframe in seconds (e.g. '3600' to check last 60 minutes) | 900 | | -| PERIOD | Set period in seconds. | 60 | | -| FILTERMETRIC | Name of the metrics to filter on. | | | -| WARNINGSTORAGEFREEBYTES | Warning threshold for remaining available bytes | | | -| CRITICALSTORAGEFREEBYTES | Warning threshold for remaining available bytes | | | -| EXTRAOPTIONS | Any extra option you may want to add to the command (E.g. a --verbose flag). All options are listed [here](#available-options) | --verbose | | +| Macro | Description | Default value | Mandatory | +|:-------------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------|:--------------|:---------:| +| STATISTIC | Set the metric calculation method Can be 'minimum', 'average' | average | | +| TIMEFRAME | Set timeframe in seconds | 900 | | +| PERIOD | Set period in seconds | 60 | | +| FILTERMETRIC | Name of the metrics to filter | | | +| WARNINGSTORAGEFREEBYTES | Warning threshold for remaining available bytes | | | +| CRITICALSTORAGEFREEBYTES | Critical threshold for remaining available 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). | --verbose | | @@ -338,8 +346,8 @@ the command: The plugin brings the following custom modes: -* awscli * paws +* awscli ### Available options @@ -347,84 +355,87 @@ The plugin brings the following custom 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. | -| --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). Eg: 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). Eg: 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). Eg: 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. Eg: 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. Eg: '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'. | +| 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\[,\[\\],\[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'. \. | #### Custom modes options All **custom modes** specific options are listed here: - - -| Option | Description | -|:--------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| --aws-secret-key | Set AWS secret key. | -| --aws-access-key | Set AWS access key. | -| --aws-session-token | Set AWS session token. | -| --aws-role-arn | Set arn of the role to be assumed. | -| --aws-profile | Set AWS profile. | -| --endpoint-url | Override AWS service endpoint URL if necessary. | -| --region | Set the region name (Required). | -| --period | Set period in seconds. | -| --timeframe | Set timeframe in seconds. | -| --statistic | Set cloudwatch statistics (Can be: 'minimum', 'maximum', 'average', 'sum'). | -| --zeroed | Set metrics value to 0 if none. Useful when CloudWatch does not return value when not defined. | -| --timeout | Set timeout in seconds (Default: 50). | -| --sudo | Use 'sudo' to execute the command. | -| --command | Command to get information (Default: 'aws'). Can be changed if you have output in a file. | -| --command-path | Command path (Default: none). | -| --command-options | Command options (Default: none). Only use for testing purpose, when you want to set ALL parameters of a command by yourself. | -| --proxyurl | Proxy URL if any | -| --skip-ssl-check | Avoid certificate issuer verification. Useful when AWS resources are hosted by a third party. Note that it strips all stderr from the command result. Will be enhanced someday. Debug will only display CLI instead of evreything. | - - -| Option | Description | -|:--------------------|:-------------------------------------------------------------------------------------------------| -| --aws-secret-key | Set AWS secret key. | -| --aws-access-key | Set AWS access key. | -| --aws-session-token | Set AWS session token. | -| --aws-role-arn | Set arn of the role to be assumed. | -| --region | Set the region name (required). | -| --period | Set period in seconds. | -| --timeframe | Set timeframe in seconds. | -| --statistic | Set cloudwatch statistics (Can be: 'minimum', 'maximum', 'average', 'sum'). | -| --zeroed | Set metrics value to 0 if none. Useful when CloudWatch does not return value when not defined. | -| --proxyurl | Proxy URL if any | +| Option | Description | +|:--------------------|:-----------------------------------------------------------------------------------------------| +| --aws-secret-key | Set AWS secret key. | +| --aws-access-key | Set AWS access key. | +| --aws-session-token | Set AWS session token. | +| --aws-role-arn | Set arn of the role to be assumed. | +| --region | Set the region name . | +| --period | Set period in seconds. | +| --timeframe | Set timeframe in seconds. | +| --statistic | Set cloudwatch statistics (can be: 'minimum', 'maximum', 'average', 'sum'). | +| --zeroed | Set metrics value to 0 if none. Useful when CloudWatch does not return value when not defined. | +| --proxyurl | Proxy URL if any | + + +| Option | Description | +|:--------------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| --aws-secret-key | Set AWS secret key. | +| --aws-access-key | Set AWS access key. | +| --aws-session-token | Set AWS session token. | +| --aws-role-arn | Set Amazon Resource Name of the role to be assumed. | +| --aws-profile | Set AWS profile. | +| --endpoint-url | Override AWS service endpoint URL if necessary. | +| --region | Set the region name . | +| --period | Set period in seconds. | +| --timeframe | Set timeframe in seconds. | +| --statistic | Set CloudWatch statistics (can be: 'minimum', 'maximum', 'average', 'sum'). | +| --zeroed | Set metrics value to 0 if none. Useful when CloudWatch does not return value when not defined. | +| --timeout | Set timeout in seconds (default: 50). | +| --sudo | Use 'sudo' to execute the command. | +| --command | Command to get information (default: 'aws'). Can be changed if you have output in a file. | +| --command-path | Command path (default: none). | +| --command-options | Command options (default: none). Only use for testing purpose, when you want to set ALL parameters of a command by yourself. | +| --proxyurl | Proxy URL if any | +| --skip-ssl-check | Avoid certificate issuer verification. Useful when AWS resources are hosted by a third party. Note that it strips all stderr from the command result. Debug will only display CLI instead of everything. | @@ -435,21 +446,24 @@ All available options for each service template are listed below: -| Option | Description | -|:--------------------|:----------------------------------------------------------------------------------------------------------------------------------------| -| --name | Set the instance name (required) (can be defined multiple times). | -| --filter-metric | Filter on a specific metric. Can be: DataReadBytes, DataWriteBytes, DataReadOperations, DataWriteOperations, MetaDataOperations | -| --warning-$metric$ | Warning threshold ($metric$ can be: 'data-write-ops', 'data-write-ops', 'data-read-ops', 'data-read-bytes', 'metadata-ops-bytes'). | -| --critical-$metric$ | Critical threshold ($metric$ can be: 'data-write-ops', 'data-write-ops', 'data-read-ops', 'data-read-bytes', 'metadata-ops-bytes'). | +| Option | Description | +|:--------------------|:-------------------------------------------------------------------------------------------------------------------------------------| +| --filter-counters | Only display some counters (regexp can be used). Example to check SSL connections only : --filter-counters='^xxxx\|yyyy$' | +| --name | Set the instance name (can be defined multiple times). | +| --filter-metric | Filter on a specific metric. Can be: DataReadBytes, DataWriteBytes, DataReadOperations, DataWriteOperations, MetaDataOperations | +| --statistic | Set the metric calculation method (Only Sum is relevant). | +| --warning-$metric$ | Warning threshold ($metric$ can be: 'data-write-ops', 'data-write-ops', 'data-read-ops', 'data-read-bytes', 'metadata-ops-bytes'). | +| --critical-$metric$ | Critical threshold ($metric$ can be: 'data-write-ops', 'data-write-ops', 'data-read-ops', 'data-read-bytes', 'metadata-ops-bytes'). | -| Option | Description | -|:------------------------------|:-------------------------------------------------------------------| -| --name | Set the instance name (required) (can be defined multiple times). | -| --warning-storage-free-bytes | Warning threshold for remaining available bytes. | -| --critical-storage-free-bytes | Warning threshold for remaining available bytes. | +| Option | Description | +|:------------------------------|:---------------------------------------------------------------------------------| +| --name | Set the instance name (can be defined multiple times). | +| --statistic | Set the metric calculation method (default: Average) Can be 'minimum', 'average' | +| --warning-storage-free-bytes | Warning threshold for remaining available bytes. | +| --critical-storage-free-bytes | Critical threshold for remaining available bytes. | @@ -460,7 +474,6 @@ All available options for a given mode can be displayed by adding the ```bash /usr/lib/centreon/plugins/centreon_aws_fsx_api.pl \ --plugin=cloud::aws::fsx::plugin \ - --mode=datausage \ - --custommode='paws' \ + --mode=freespace \ --help ```