From 80919d86af2112301457d5ff4297d8b207c39174 Mon Sep 17 00:00:00 2001 From: lucie-tirand Date: Fri, 24 Oct 2025 14:15:01 +0200 Subject: [PATCH] enh(applications-controlm-restapi): refresh doc page CTOR-1500 --- .../applications-controlm-restapi.md | 328 ++++++++++++++---- .../applications-controlm-restapi.md | 321 +++++++++++++---- 2 files changed, 518 insertions(+), 131 deletions(-) diff --git a/i18n/fr/docusaurus-plugin-content-docs-pp/current/integrations/plugin-packs/procedures/applications-controlm-restapi.md b/i18n/fr/docusaurus-plugin-content-docs-pp/current/integrations/plugin-packs/procedures/applications-controlm-restapi.md index 2521b9198bc3..7eef6e0481fa 100644 --- a/i18n/fr/docusaurus-plugin-content-docs-pp/current/integrations/plugin-packs/procedures/applications-controlm-restapi.md +++ b/i18n/fr/docusaurus-plugin-content-docs-pp/current/integrations/plugin-packs/procedures/applications-controlm-restapi.md @@ -5,42 +5,69 @@ title: Control-M Rest API import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; -## Contenu du Pack +## Dépendances du connecteur de supervision + +Les connecteurs de supervision suivants sont automatiquement installés lors de l'installation du connecteur **Control-M Rest API** +depuis la page **Configuration > Gestionnaire de connecteurs de supervision** : +* [Base Pack](./base-generic.md) + +## Contenu du pack ### Modèles -Le Pack Centreon **Control-M Rest API** apporte un modèle d'hôte : +Le connecteur de supervision **Control-M Rest API** apporte un modèle d'hôte : + +* **App-Controlm-Restapi-custom** + +Le connecteur apporte le modèle de service suivant +(classé selon le modèle d'hôte auquel il est rattaché) : + + + + +> Ce modèle d'hôte n'a pas de service automatiquement déployé. -* App-Controlm-Restapi-custom + + -Il apporte le modèle de service suivant : +| Alias | Modèle de service | Description | Découverte | +|:------|:---------------------------------|:------------------|:----------:| +| Jobs | App-Controlm-Restapi-Jobs-custom | Contrôle les jobs | X | -| Alias | Modèle de service | Description | Défaut | Découverte | -|:------|:--------------------------|:------------------|:-------|:-----------| -| Jobs | App-Controlm-Restapi-Jobs | Contrôle les jobs | | X | +> Les services listés ci-dessus ne sont pas créés automatiquement lorsqu'un modèle d'hôte est appliqué. Pour les utiliser, [créez un service manuellement](/docs/monitoring/basic-objects/services) et appliquez le modèle de service souhaité. + +> Si la case **Découverte** est cochée, cela signifie qu'une règle de découverte de service existe pour ce service. + + + ### Règles de découverte -| Nom de la règle | Description | -|:------------------------------|:-----------------------------------------| -| App-Controlm-Restapi-Job-Name | Découvre les jobs et supervise le statut | +#### Découverte de services + +| Nom de la règle | Description | +|:------------------------------|:-----------------------------------| +| App-Controlm-Restapi-Job-Name | Découvre les jobs et les supervise | Rendez-vous sur la [documentation dédiée](/docs/monitoring/discovery/services-discovery) pour en savoir plus sur la découverte automatique de services et sa [planification](/docs/monitoring/discovery/services-discovery/#règles-de-découverte). ### Métriques & statuts collectés +Voici le tableau des services pour ce connecteur, détaillant les métriques et statuts rattachés à chaque service. + -| Métrique | Unité | -|:---------------------------------------------|:------| -| jobs.executing.count | | -| jobs.failed.count | | -| jobs.succeeded.count | | -| jobs.waiting.count | | -| job status | | -| *application_name~job_name*#job.failed.count | | +| Nom | Unité | +|:------------------------|:------| +| jobs.succeeded.count | count | +| jobs.failed.count | count | +| jobs.executing.count | count | +| jobs.waiting.count | count | +| status | N/A | +| long | N/A | +| *jobs*#job.failed.count | count | @@ -49,15 +76,12 @@ pour en savoir plus sur la découverte automatique de services et sa [planificat Pour la supervision, un utilisateur avec des droits de lecture sur l'[Automation API](https://docs.bmc.com/docs/automation-api/918/) Control-M est nécessaire. -## Installation +## Installer le connecteur de supervision ### Pack -La procédure d'installation des connecteurs de supervision diffère légèrement [suivant que votre licence est offline ou online](../getting-started/how-to-guides/connectors-licenses.md). de supervision - -Si la plateforme est configurée avec une licence *online*, l'installation d'un paquet -n'est pas requise pour voir apparaître le pack dans le menu **Configuration > Connecteurs > Connecteurs de supervision**. - +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 : @@ -70,10 +94,10 @@ dnf install centreon-pack-applications-controlm-restapi ``` - + ```bash -yum install centreon-pack-applications-controlm-restapi +dnf install centreon-pack-applications-controlm-restapi ``` @@ -83,16 +107,23 @@ yum install centreon-pack-applications-controlm-restapi apt install centreon-pack-applications-controlm-restapi ``` + + + +```bash +yum install centreon-pack-applications-controlm-restapi +``` + -Quel que soit le type de la licence (*online* ou *offline*), installez le Pack **Control-M Rest API** -depuis l'interface web et le menu **Configuration > Connecteurs > Connecteurs de supervision**. +2. Quel que soit le type de la licence (*online* ou *offline*), installez le connecteur **Control-M Rest API** +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 pack. Si cette fonctionnalité est activée, et +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. @@ -108,10 +139,10 @@ dnf install centreon-plugin-Applications-Controlm-Restapi ``` - + ```bash -yum install centreon-plugin-Applications-Controlm-Restapi +dnf install centreon-plugin-Applications-Controlm-Restapi ``` @@ -121,43 +152,109 @@ yum install centreon-plugin-Applications-Controlm-Restapi apt install centreon-plugin-applications-controlm-restapi ``` + + + +```bash +yum install centreon-plugin-Applications-Controlm-Restapi +``` + -## Configuration +## Utiliser le connecteur de supervision + +### Utiliser un modèle d'hôte issu du connecteur -### Hôte +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 **App-Controlm-Restapi-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. -* Ajoutez un hôte à Centreon depuis la page **Configuration > Hôtes**. -* Complétez les champs **Nom**, **Alias** & **IP Address/DNS** correspondant à votre serveur **Control-M**. -* Appliquez le modèle d'hôte **App-Controlm-Restapi-custom**. -* Une fois le modèle appliqué, les macros ci-dessous indiquées comme requises (**Obligatoire**) doivent être renseignées. +| Macro | Description | Valeur par défaut | Obligatoire | +|:------------------------|:--------------------------------------------------------------------------------------------------------------------------------------------|:------------------|:-----------:| +| CONTROLMAPIUSERNAME | API username | | X | +| CONTROLMAPIPASSWORD | API password | | X | +| CONTROLMAPIPROTOCOL | Specify https if needed | https | | +| CONTROLMAPIPORT | Port used | 8443 | | +| CONTROLMAPIEXTRAOPTIONS | 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). | --insecure | | -| Obligatoire | Macro | Description | -|:------------|:------------------------|:-------------------| -| X | CONTROLMAPIUSERNAME | | -| X | CONTROLMAPIPASSWORD | | -| | CONTROLMAPIPORT | (Default: '8443') | -| | CONTROLMAPIPROTOCOL | (Default: 'https') | -| | CONTROLMAPIEXTRAOPTIONS | --insecure | +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 | +|:----------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------|:-------------------------------|:-----------:| +| JOBNAME | Check exact job name (no regexp) | | | +| FILTERNAME | Filter jobs by job name (can be a regexp) | | | +| FILTERAPPLICATION | Filter jobs by application name (cannot be a regexp) | | | +| FILTERFOLDER | Filter jobs by folder name (cannot be a regexp) | | | +| FILTERTYPE | Filter jobs by type (cannot be a regexp) | | | +| WARNINGJOBFAILED | Threshold | | | +| CRITICALJOBFAILED | Threshold | | | +| WARNINGJOBSEXECUTING | Threshold | | | +| CRITICALJOBSEXECUTING | Threshold | | | +| WARNINGJOBSFAILED | Threshold | | | +| CRITICALJOBSFAILED | Threshold | | | +| WARNINGJOBSSUCCEEDED | Threshold | | | +| CRITICALJOBSSUCCEEDED | Threshold | | | +| WARNINGJOBSWAITING | Threshold | | | +| CRITICALJOBSWAITING | Threshold | | | +| WARNINGLONG | Set warning threshold for long jobs. You can use the following variables: %\{name\}, %\{status\}, %\{elapsed\}, %\{application\}, %\{folder\}, %\{type\} | | | +| CRITICALLONG | Set critical threshold for long jobs. You can use the following variables: %\{name\}, %\{status\}, %\{elapsed\}, %\{application\}, %\{folder\}, %\{type\} | | | +| CRITICALSTATUS | Define the conditions to match for the status to be CRITICAL. You can use the following variables: %\{name\}, %\{status\}, %\{application\}, %\{folder\}, %\{type\} | %\{status\} =~ /ended not ok/i | | +| WARNINGSTATUS | Define the conditions to match for the status to be WARNING. You can use the following variables: %\{name\}, %\{status\}, %\{application\}, %\{folder\}, %\{type\} | | | +| 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`) : +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_controlm_restapi.pl \ - --plugin=apps::controlm::restapi::plugin \ - --mode=jobs \ - --hostname='10.0.0.1' \ - --port='8443' \ - --proto='https' \ - --api-username='myuser' \ - --api-password='mypass' \ - --filter-name='P2TLNBUS20|P2TLNBUS203' \ - --verbose + --plugin=apps::controlm::restapi::plugin \ + --mode=jobs \ + --hostname='10.0.0.1' \ + --port='8443' \ + --proto='https' \ + --api-username='XXXX' \ + --api-password='XXXX' \ + --job-name='' \ + --filter-name='' \ + --filter-application='' \ + --filter-folder='' \ + --filter-type='' \ + --warning-status='' \ + --critical-status='%\{status\} =~ /ended not ok/i' \ + --warning-long='' \ + --critical-long='' \ + --warning-job-failed='' \ + --critical-job-failed='' \ + --warning-jobs-succeeded='' \ + --critical-jobs-succeeded='' \ + --warning-jobs-failed='' \ + --critical-jobs-failed='' \ + --warning-jobs-executing='' \ + --critical-jobs-executing='' \ + --warning-jobs-waiting='' \ + --critical-jobs-waiting='' \ + --verbose + --insecure ``` La commande devrait retourner un message de sortie similaire à : @@ -171,26 +268,123 @@ job 'TALEND/P2TLNBUS203' status: ended ok job 'TALEND/P2TLNBUS204' status: ended ok ``` -La liste de toutes les options complémentaires et leur signification peut être -affichée en ajoutant le paramètre `--help` à la commande : +### Diagnostic des erreurs communes -```bash -/usr/lib/centreon/plugins/centreon_controlm_restapi.pl \ - --plugin=apps::controlm::restapi::plugin \ - --mode=jobs \ - --help -``` +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_controlm_restapi.pl \ - --plugin=apps::controlm::restapi::plugin \ - --list-mode + --plugin=apps::controlm::restapi::plugin \ + --list-mode ``` -### Diagnostic des erreurs communes +Le plugin apporte les modes suivants : -Rendez-vous sur la [documentation dédiée](../getting-started/how-to-guides/troubleshooting-plugins.md#contrôles-http-et-api) -des plugins basés sur HTTP/API. +| Mode | Modèle de service associé | +|:-------------------------------------------------------------------------------------------------------------------------|:---------------------------------| +| jobs [[code](https://github.com/centreon/centreon-plugins/blob/develop/src/apps/controlm/restapi/mode/jobs.pm)] | App-Controlm-Restapi-Jobs-custom | +| list-jobs [[code](https://github.com/centreon/centreon-plugins/blob/develop/src/apps/controlm/restapi/mode/listjobs.pm)] | Used for service discovery | + +### Options disponibles + +#### Options des modes + +Les options disponibles pour chaque modèle de services sont listées ci-dessous : + + + + +| Option | Description | +|:-------------------------------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| --filter-counters | Only display some counters (regexp can be used). Example: --filter-counters='failed' | +| --filter-folder | Filter jobs by folder name (cannot be a regexp). | +| --filter-application | Filter jobs by application name (cannot be a regexp). | +| --filter-type | Filter jobs by type (cannot be a regexp). | +| --filter-name | Filter jobs by job name (can be a regexp). | +| --job-name | Check exact job name (no regexp). | +| --display-extra-attrs | Display extra job attributes (example: --display-extra-attrs=', number of runs: %(numberOfRuns)'). | +| --timezone | Set date timezone. Can use format: 'Europe/London' or '+0100'. | +| --warning-status | Define the conditions to match for the status to be WARNING. You can use the following variables: %\{name\}, %\{status\}, %\{application\}, %\{folder\}, %\{type\} | +| --critical-status | Define the conditions to match for the status to be CRITICAL (default: '%\{status\} =~ /ended not ok/i'). You can use the following variables: %\{name\}, %\{status\}, %\{application\}, %\{folder\}, %\{type\} | +| --warning-long | Set warning threshold for long jobs. You can use the following variables: %\{name\}, %\{status\}, %\{elapsed\}, %\{application\}, %\{folder\}, %\{type\} | +| --critical-long | Set critical threshold for long jobs. You can use the following variables: %\{name\}, %\{status\}, %\{elapsed\}, %\{application\}, %\{folder\}, %\{type\} | +| --warning-* --critical-* | Thresholds. Can be: 'jobs-succeeded', 'jobs-failed', 'jobs-executing', 'jobs-waiting', 'job-failed'. | +| --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: =over 4 Convert storage free perfdata into used: --change-perfdata='free,used,invert()' Convert storage free perfdata into used: --change-perfdata='used,free,invert()' Scale traffic values automatically: --change-perfdata='traffic,,scale(auto)' Scale traffic values in Mbps: --change-perfdata='traffic\_in,,scale(Mbps),mbps' Change traffic values in percent: --change-perfdata='traffic\_in,,percent()' =back | +| --extend-perfdata-group | Add new aggregated metrics (min, max, average or sum) for groups of metrics defined by a regex match on the metrics' names. Syntax: --extend-perfdata-group=regex,\,calculation\[,\[\\],\[min\],\[max\]\] regex: regular expression \: how the new metrics' names are composed (can use $1, $2... for groups defined by () in regex). calculation: how the values of the new metrics should be calculated \ (optional): unit of measure for the new metrics min (optional): lowest value the metrics can reach max (optional): highest value the metrics can reach Common examples: =over 4 Sum wrong packets from all interfaces (with interface need --units-errors=absolute): --extend-perfdata-group=',packets\_wrong,sum(packets\_(discard\|error)\_(in\|out))' Sum traffic by interface: --extend-perfdata-group='traffic\_in\_(.*),traffic\_$1,sum(traffic\_(in\|out)\_$1)' =back | +| --change-short-output --change-long-output | Modify the short/long output that is returned by the plugin. Syntax: --change-short-output=pattern~replacement~modifier Most commonly used modifiers are i (case insensitive) and g (replace all occurrences). Example: adding --change-short-output='OK~Up~gi' will replace all occurrences of 'OK', 'ok', 'Ok' or 'oK' with 'Up' | +| --change-exit | Replace an exit code with one of your choice. Example: adding --change-exit=unknown=critical will result in a CRITICAL state instead of an UNKNOWN state. | +| --change-output-adv | Replace short output and exit code based on a "if" condition using the following variables: short\_output, exit\_code. Variables must be written either %\{variable\} or %(variable). Example: adding --change-output-adv='%(short\_ouput) =~ /UNKNOWN: No daemon/,OK: No daemon,OK' will change the following specific UNKNOWN result to an OK result. | +| --range-perfdata | Rewrite the ranges displayed in the perfdata. Accepted values: 0: nothing is changed. 1: if the lower value of the range is equal to 0, it is removed. 2: remove the thresholds from the perfdata. | +| --filter-uom | Mask the units when they don't match the given regular expression. | +| --opt-exit | Replace the exit code in case of an execution error (i.e. wrong option provided, SSH connection refused, timeout, etc). Default: unknown. | +| --output-ignore-perfdata | Remove all the metrics from the service. The service will still have a status and an output. | +| --output-ignore-label | Remove the status label ("OK:", "WARNING:", "UNKNOWN:", CRITICAL:") from the beginning of the output. Example: 'OK: Ram Total:...' will become 'Ram Total:...' | +| --output-xml | Return the output in XML format (to send to an XML API). | +| --output-json | Return the output in JSON format (to send to a JSON API). | +| --output-openmetrics | Return the output in OpenMetrics format (to send to a tool expecting this format). | +| --output-file | Write output in file (can be combined with JSON, XML and OpenMetrics options). Example: --output-file=/tmp/output.txt will write the output in /tmp/output.txt. | +| --disco-format | Applies only to modes beginning with 'list-'. Returns the list of available macros to configure a service discovery rule (formatted in XML). | +| --disco-show | Applies only to modes beginning with 'list-'. Returns the list of discovered objects (formatted in XML) for service discovery. | +| --float-precision | Define the float precision for thresholds (default: 8). | +| --source-encoding | Define the character encoding of the response sent by the monitored resource Default: 'UTF-8'. =head1 DESCRIPTION B\. =cut | +| --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 | Set hostname. | +| --port | Port used (default: 8443) | +| --proto | Specify https if needed (default: 'https') | +| --api-username | API username. | +| --api-password | API password. | +| --timeout | Set timeout in seconds (default: 30). | + + + + +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_controlm_restapi.pl \ + --plugin=apps::controlm::restapi::plugin \ + --mode=jobs \ + --help +``` diff --git a/pp/integrations/plugin-packs/procedures/applications-controlm-restapi.md b/pp/integrations/plugin-packs/procedures/applications-controlm-restapi.md index 87bba1eac21c..c84962fd9b5d 100644 --- a/pp/integrations/plugin-packs/procedures/applications-controlm-restapi.md +++ b/pp/integrations/plugin-packs/procedures/applications-controlm-restapi.md @@ -5,23 +5,46 @@ title: Control-M Rest API import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; -## Pack Assets +## Connector dependencies + +The following monitoring connectors will be installed when you install the **Control-M Rest API** connector through the +**Configuration > Monitoring Connector Manager** menu: +* [Base Pack](./base-generic.md) + +## Pack assets ### Templates -The Centreon Pack **Control-M Rest API** brings a host template: +The Monitoring Connector **Control-M Rest API** brings a host template: + +* **App-Controlm-Restapi-custom** + +The connector brings the following service templates (sorted by the host template they are attached to): + + + + +> This host template doesn't provide automatic deployed services. -* App-Controlm-Restapi-custom + + -It brings the following service template: +| Service Alias | Service Template | Service Description | Discovery | +|:--------------|:---------------------------------|:--------------------|:---------:| +| Jobs | App-Controlm-Restapi-Jobs-custom | Check jobs | X | -| Service Alias | Service Template | Service Description | Default | Discovery | -|:--------------|:--------------------------|:--------------------|:--------|:----------| -| Jobs | App-Controlm-Restapi-Jobs | Check jobs | | X | +> The services listed above are not created automatically when a host template is applied. To use them, [create a service manually](/docs/monitoring/basic-objects/services), then apply the service template you want. + +> If **Discovery** is checked, it means a service discovery rule exists for this service template. + + + ### Discovery rules -| Rule Name | Description | +#### Service discovery + +| Rule name | Description | |:------------------------------|:---------------------------------| | App-Controlm-Restapi-Job-Name | Discover jobs and monitor status | @@ -30,17 +53,20 @@ and in the [following chapter](/docs/monitoring/discovery/services-discovery/#di ### Collected metrics & status +Here is the list of services for this connector, detailing all metrics and statuses linked to each service. + -| Metric Name | Unit | -|:---------------------------------------------|:------| -| jobs.executing.count | | -| jobs.failed.count | | -| jobs.succeeded.count | | -| jobs.waiting.count | | -| job status | | -| *application_name~job_name*#job.failed.count | | +| Name | Unit | +|:------------------------|:------| +| jobs.succeeded.count | count | +| jobs.failed.count | count | +| jobs.executing.count | count | +| jobs.waiting.count | count | +| status | N/A | +| long | N/A | +| *jobs*#job.failed.count | count | @@ -49,13 +75,13 @@ and in the [following chapter](/docs/monitoring/discovery/services-discovery/#di To monitor, a user with read privileges on the Control-M [Automation API](https://docs.bmc.com/docs/automation-api/918/) is required. -## Setup +## Installing the monitoring connector -### Monitoring Pack +### Pack -If the platform uses an *online* license, you can skip the package installation -instruction below as it is not required to have the pack displayed within the -**Configuration > Connectors > Monitoring Connectors** menu. +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: @@ -67,10 +93,10 @@ dnf install centreon-pack-applications-controlm-restapi ``` - + ```bash -yum install centreon-pack-applications-controlm-restapi +dnf install centreon-pack-applications-controlm-restapi ``` @@ -80,11 +106,18 @@ yum install centreon-pack-applications-controlm-restapi apt install centreon-pack-applications-controlm-restapi ``` + + + +```bash +yum install centreon-pack-applications-controlm-restapi +``` + -Whatever the license type (*online* or *offline*), install the **Control-M Rest API** Pack through -the **Configuration > Connectors > Monitoring Connectors** menu. +2. Whatever the license type (*online* or *offline*), install the **Control-M Rest API** connector through +the **Configuration > Monitoring Connector Manager** menu. ### Plugin @@ -107,10 +140,10 @@ dnf install centreon-plugin-Applications-Controlm-Restapi ``` - + ```bash -yum install centreon-plugin-Applications-Controlm-Restapi +dnf install centreon-plugin-Applications-Controlm-Restapi ``` @@ -120,43 +153,106 @@ yum install centreon-plugin-Applications-Controlm-Restapi apt install centreon-plugin-applications-controlm-restapi ``` + + + +```bash +yum install centreon-plugin-Applications-Controlm-Restapi +``` + -## Configuration +## Using the monitoring connector -### Host +### Using a host template provided by the connector -* Log into Centreon and add a new host through **Configuration > Hosts**. -* Fill the **Name**, **Alias** & **IP Address/DNS** fields according to your **Control-M** server settings. -* Apply the **App-Controlm-Restapi-custom** template to the host. -* Once the template is applied, fill in the corresponding macros. Some macros are mandatory. +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 **App-Controlm-Restapi-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. -| Mandatory | Macro | Description | -|:------------|:------------------------|:-------------------| -| X | CONTROLMAPIUSERNAME | | -| X | CONTROLMAPIPASSWORD | | -| | CONTROLMAPIPORT | (Default: '8443') | -| | CONTROLMAPIPROTOCOL | (Default: 'https') | -| | CONTROLMAPIEXTRAOPTIONS | --insecure | +| Macro | Description | Default value | Mandatory | +|:------------------------|:----------------------------------------------------------------------------------------------------------------------------------|:--------------|:---------:| +| CONTROLMAPIUSERNAME | API username | | X | +| CONTROLMAPIPASSWORD | API password | | X | +| CONTROLMAPIPROTOCOL | Specify https if needed | https | | +| CONTROLMAPIPORT | Port used | 8443 | | +| CONTROLMAPIEXTRAOPTIONS | Any extra option you may want to add to every command (E.g. a --verbose flag). All options are listed [here](#available-options). | --insecure | | + +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 | +|:----------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------|:-------------------------------|:---------:| +| JOBNAME | Check exact job name (no regexp) | | | +| FILTERNAME | Filter jobs by job name (can be a regexp) | | | +| FILTERAPPLICATION | Filter jobs by application name (cannot be a regexp) | | | +| FILTERFOLDER | Filter jobs by folder name (cannot be a regexp) | | | +| FILTERTYPE | Filter jobs by type (cannot be a regexp) | | | +| WARNINGJOBFAILED | Threshold | | | +| CRITICALJOBFAILED | Threshold | | | +| WARNINGJOBSEXECUTING | Threshold | | | +| CRITICALJOBSEXECUTING | Threshold | | | +| WARNINGJOBSFAILED | Threshold | | | +| CRITICALJOBSFAILED | Threshold | | | +| WARNINGJOBSSUCCEEDED | Threshold | | | +| CRITICALJOBSSUCCEEDED | Threshold | | | +| WARNINGJOBSWAITING | Threshold | | | +| CRITICALJOBSWAITING | Threshold | | | +| WARNINGLONG | Set warning threshold for long jobs. You can use the following variables: %\{name\}, %\{status\}, %\{elapsed\}, %\{application\}, %\{folder\}, %\{type\} | | | +| CRITICALLONG | Set critical threshold for long jobs. You can use the following variables: %\{name\}, %\{status\}, %\{elapsed\}, %\{application\}, %\{folder\}, %\{type\} | | | +| CRITICALSTATUS | Define the conditions to match for the status to be CRITICAL. You can use the following variables: %\{name\}, %\{status\}, %\{application\}, %\{folder\}, %\{type\} | %\{status\} =~ /ended not ok/i | | +| WARNINGSTATUS | Define the conditions to match for the status to be WARNING. You can use the following variables: %\{name\}, %\{status\}, %\{application\}, %\{folder\}, %\{type\} | | | +| 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`) and test the plugin by -running the following command: +**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_controlm_restapi.pl \ - --plugin=apps::controlm::restapi::plugin \ - --mode=jobs \ - --hostname='10.0.0.1' \ - --port='8443' \ - --proto='https' \ - --api-username='myuser' \ - --api-password='mypass' \ - --filter-name='P2TLNBUS20|P2TLNBUS203' \ - --verbose + --plugin=apps::controlm::restapi::plugin \ + --mode=jobs \ + --hostname='10.0.0.1' \ + --port='8443' \ + --proto='https' \ + --api-username='XXXX' \ + --api-password='XXXX' \ + --job-name='' \ + --filter-name='' \ + --filter-application='' \ + --filter-folder='' \ + --filter-type='' \ + --warning-status='' \ + --critical-status='%\{status\} =~ /ended not ok/i' \ + --warning-long='' \ + --critical-long='' \ + --warning-job-failed='' \ + --critical-job-failed='' \ + --warning-jobs-succeeded='' \ + --critical-jobs-succeeded='' \ + --warning-jobs-failed='' \ + --critical-jobs-failed='' \ + --warning-jobs-executing='' \ + --critical-jobs-executing='' \ + --warning-jobs-waiting='' \ + --critical-jobs-waiting='' \ + --verbose ``` The expected command output is shown below: @@ -170,26 +266,123 @@ job 'TALEND/P2TLNBUS203' status: ended ok job 'TALEND/P2TLNBUS204' status: ended ok ``` -All available options for a given mode can be displayed by adding the -`--help` parameter to the command: +### Troubleshooting -```bash -/usr/lib/centreon/plugins/centreon_controlm_restapi.pl \ - --plugin=apps::controlm::restapi::plugin \ - --mode=jobs \ - --help -``` +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_controlm_restapi.pl \ - --plugin=apps::controlm::restapi::plugin \ - --list-mode + --plugin=apps::controlm::restapi::plugin \ + --list-mode ``` -### Troubleshooting +The plugin brings the following modes: -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). +| Mode | Linked service template | +|:-------------------------------------------------------------------------------------------------------------------------|:---------------------------------| +| jobs [[code](https://github.com/centreon/centreon-plugins/blob/develop/src/apps/controlm/restapi/mode/jobs.pm)] | App-Controlm-Restapi-Jobs-custom | +| list-jobs [[code](https://github.com/centreon/centreon-plugins/blob/develop/src/apps/controlm/restapi/mode/listjobs.pm)] | Used for service discovery | + +### Available options + +#### Modes options + +All available options for each service template are listed below: + + + + +| Option | Description | +|:-------------------------------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| --filter-counters | Only display some counters (regexp can be used). Example: --filter-counters='failed' | +| --filter-folder | Filter jobs by folder name (cannot be a regexp). | +| --filter-application | Filter jobs by application name (cannot be a regexp). | +| --filter-type | Filter jobs by type (cannot be a regexp). | +| --filter-name | Filter jobs by job name (can be a regexp). | +| --job-name | Check exact job name (no regexp). | +| --display-extra-attrs | Display extra job attributes (example: --display-extra-attrs=', number of runs: %(numberOfRuns)'). | +| --timezone | Set date timezone. Can use format: 'Europe/London' or '+0100'. | +| --warning-status | Define the conditions to match for the status to be WARNING. You can use the following variables: %\{name\}, %\{status\}, %\{application\}, %\{folder\}, %\{type\} | +| --critical-status | Define the conditions to match for the status to be CRITICAL (default: '%\{status\} =~ /ended not ok/i'). You can use the following variables: %\{name\}, %\{status\}, %\{application\}, %\{folder\}, %\{type\} | +| --warning-long | Set warning threshold for long jobs. You can use the following variables: %\{name\}, %\{status\}, %\{elapsed\}, %\{application\}, %\{folder\}, %\{type\} | +| --critical-long | Set critical threshold for long jobs. You can use the following variables: %\{name\}, %\{status\}, %\{elapsed\}, %\{application\}, %\{folder\}, %\{type\} | +| --warning-* --critical-* | Thresholds. Can be: 'jobs-succeeded', 'jobs-failed', 'jobs-executing', 'jobs-waiting', 'job-failed'. | +| --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: =over 4 Convert storage free perfdata into used: --change-perfdata='free,used,invert()' Convert storage free perfdata into used: --change-perfdata='used,free,invert()' Scale traffic values automatically: --change-perfdata='traffic,,scale(auto)' Scale traffic values in Mbps: --change-perfdata='traffic\_in,,scale(Mbps),mbps' Change traffic values in percent: --change-perfdata='traffic\_in,,percent()' =back | +| --extend-perfdata-group | Add new aggregated metrics (min, max, average or sum) for groups of metrics defined by a regex match on the metrics' names. Syntax: --extend-perfdata-group=regex,\,calculation\[,\[\\],\[min\],\[max\]\] regex: regular expression \: how the new metrics' names are composed (can use $1, $2... for groups defined by () in regex). calculation: how the values of the new metrics should be calculated \ (optional): unit of measure for the new metrics min (optional): lowest value the metrics can reach max (optional): highest value the metrics can reach Common examples: =over 4 Sum wrong packets from all interfaces (with interface need --units-errors=absolute): --extend-perfdata-group=',packets\_wrong,sum(packets\_(discard\|error)\_(in\|out))' Sum traffic by interface: --extend-perfdata-group='traffic\_in\_(.*),traffic\_$1,sum(traffic\_(in\|out)\_$1)' =back | +| --change-short-output --change-long-output | Modify the short/long output that is returned by the plugin. Syntax: --change-short-output=pattern~replacement~modifier Most commonly used modifiers are i (case insensitive) and g (replace all occurrences). Example: adding --change-short-output='OK~Up~gi' will replace all occurrences of 'OK', 'ok', 'Ok' or 'oK' with 'Up' | +| --change-exit | Replace an exit code with one of your choice. Example: adding --change-exit=unknown=critical will result in a CRITICAL state instead of an UNKNOWN state. | +| --change-output-adv | Replace short output and exit code based on a "if" condition using the following variables: short\_output, exit\_code. Variables must be written either %\{variable\} or %(variable). Example: adding --change-output-adv='%(short\_ouput) =~ /UNKNOWN: No daemon/,OK: No daemon,OK' will change the following specific UNKNOWN result to an OK result. | +| --range-perfdata | Rewrite the ranges displayed in the perfdata. Accepted values: 0: nothing is changed. 1: if the lower value of the range is equal to 0, it is removed. 2: remove the thresholds from the perfdata. | +| --filter-uom | Mask the units when they don't match the given regular expression. | +| --opt-exit | Replace the exit code in case of an execution error (i.e. wrong option provided, SSH connection refused, timeout, etc). Default: unknown. | +| --output-ignore-perfdata | Remove all the metrics from the service. The service will still have a status and an output. | +| --output-ignore-label | Remove the status label ("OK:", "WARNING:", "UNKNOWN:", CRITICAL:") from the beginning of the output. Example: 'OK: Ram Total:...' will become 'Ram Total:...' | +| --output-xml | Return the output in XML format (to send to an XML API). | +| --output-json | Return the output in JSON format (to send to a JSON API). | +| --output-openmetrics | Return the output in OpenMetrics format (to send to a tool expecting this format). | +| --output-file | Write output in file (can be combined with JSON, XML and OpenMetrics options). Example: --output-file=/tmp/output.txt will write the output in /tmp/output.txt. | +| --disco-format | Applies only to modes beginning with 'list-'. Returns the list of available macros to configure a service discovery rule (formatted in XML). | +| --disco-show | Applies only to modes beginning with 'list-'. Returns the list of discovered objects (formatted in XML) for service discovery. | +| --float-precision | Define the float precision for thresholds (default: 8). | +| --source-encoding | Define the character encoding of the response sent by the monitored resource Default: 'UTF-8'. =head1 DESCRIPTION B\. =cut | +| --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 | Set hostname. | +| --port | Port used (default: 8443) | +| --proto | Specify https if needed (default: 'https') | +| --api-username | API username. | +| --api-password | API password. | +| --timeout | Set timeout in seconds (default: 30). | + + + + +All available options for a given mode can be displayed by adding the +`--help` parameter to the command: + +```bash +/usr/lib/centreon/plugins/centreon_controlm_restapi.pl \ + --plugin=apps::controlm::restapi::plugin \ + --mode=jobs \ + --help +```