Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 20 additions & 11 deletions cloud/monitoring/basic-objects/commands.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,27 +11,36 @@ Check commands are used by the monitoring engine to check the status of a host o

Most commands are provided by the Monitoring Connectors you have installed and are ready to use. However, if these commands do not meet your needs (e.g. they have too many or too few arguments) you can create new ones (custom commands). You need to create one command per plugin and per [mode](../../resources/glossary.md#mode). Custom commands are an advanced feature.

Commands can be configured in the following menu: **Configuration > Commands > Checks**.
Commands can be configured in the following menu: **Configuration > Commands > Commands**.

> By default, only custom commands (i.e. user-created commands) are displayed. All commands provided by Monitoring Connectors are read-only ("locked") and hidden. Check the "Locked elements" box to show these commands.

## Creating a custom check command

1. Go to **Configuration > Commands > Checks**.
1. Go to **Configuration > Commands > Commands**.
2. Click **Add**.
3. Fill in the following fields:

* **Command Name**: defines the name of the command. This name will appear in the list of commands in the host and service template creation forms.
* **Command Line**: the actual command that will be executed when a check is made. The syntax is that of Nagios. You need to specify:
* **Name**: This name will appear in the list of commands in the host and service template creation forms.
* **Command type**: in Centreon Cloud, only **Check** and **Miscellaneous** are available. **Miscellaneous** commands are used with [event handlers](../event-handler.md).
* **Command Line**: the actual command that will be executed when a check is made. The syntax is that of Nagios. Use the lists on the left to insert variables quickly and/or type your own contents. You need to specify:

* the application or script executed by the command (path and filename). For Centreon or Nagios plugins, use a variable so that Centreon can find the path to the plugins folder on any OS (the variable is defined on the **Configuration > Pollers > Resources** page). If you are using your own plugins, specify the path where you have stored the plugins.
* the [mode](../../resources/glossary.md#mode) of the plugin to use.
* any parameter you want to pass to the plugin in this mode. For Centreon plugins, refer to the documentation of the plugin in the [Monitoring Connectors](/pp/integrations/plugin-packs/getting-started/introduction) section.
* You can use [macros](macros.md) (host macros or service macros) to make your command more generic, but it is not compulsory. The macros's name will appear in the configuration form for the host or service so that you can give it a specific value for each host or service you use it with.
* A macro that represents the path to the script executed by the command (with no filename). For Centreon or Nagios plugins, use a variable so that Centreon can find the path to the plugins folder on any OS (the variable is defined on the **Configuration > Pollers > Global macros** page). If you are using your own plugins, specify the path where you have stored the plugins. Default values appear in **Poller global macros**, but you can also type the path to your own plugin you have stored somewhere else.

* **Describe macros**: add a description to custom macros. This description will be visible when using the command in a host or service configuration form.
* **Connectors**: use the **[Perl Connector](#perl-connector)** or the **[SSH Connector](#ssh-connector)** to reduce the consumption of resources of the plugin. The Perl connector can be used with all commands except **check_icmp** and **check_nrpe**.
* **Graph template**: link the command to a graph template.
Examples:

* $CENTREONPLUGINS$ if the plugin you are using is in the same place as Centreon plugins (like centreon_linux_snmp.pl)
* $USER1$ if the plugin you are using is in the same place as Nagios plugins (like check_icmp)
* /custom/path/ if the plugin you are using is in a custom location
* create the global macro $MYPLUGINS$  if the path is /custom/path/ on one poller and /alt/path/ on another one. This way you may use the same command for the same plugin found in various places depending on the poller.

* The name of the plugin you want to use (stored in the path specified in the poller global macro). **Installed plugins** allows you to select Nagios plugins. Examples: `centreon_linux_snmp.pl`, `check_icmp`...
* Any option you want to pass to the plugin in this [mode](../../resources/glossary.md#mode). For Centreon plugins, refer to the documentation of the plugin in the [Monitoring Connectors](/pp/integrations/plugin-packs/getting-started/introduction) section. Examples: `--community=public`, `--warning=1`, `--verbose`...
* Instead of hardcoding an option value, you can use [macros](macros.md) (host macros or service macros) to make your command more generic, but it is not compulsory. The macros's name will appear in the configuration form for the host or service so that you can give it a specific value for each host or service you use it with. You can use [**Standard macros**](./macros.md#standard-macros), or create you own [custom macros](./macros.md#custom-macros). Exampls: `--hostname='$HOSTADDRESS$'`, `--warning='$_SERVICEWARNING$'`, `--community='$_HOSTSNMPCOMMUNITY$'`...

* **Enable shell syntax**: check this box if your command uses shell functions (pipes, redirects, wildcards...). Note that commands requiring the shell slow down the monitoring server.

* **Optimization connectors**: use the **[Perl Connector](#perl-connector)** or the **[SSH Connector](#ssh-connector)** to reduce the consumption of resources of the plugin. The Perl connector can be used with all commands provided by Centreon that use Perl plugins (.pl). It is not compatible with commands that use **check_icmp** and **check_nrpe**.

4. Click **Save**. The command now appears in the **Check command** list in the host or service template configuration pages.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,27 +11,35 @@ Les commandes de contrôle sont utilisées par le moteur de supervision pour con

Le plupart des commandes sont fournies par les connecteurs de supervision installés, et sont prêtes à l'emploi. Cependant si ces commandes ne répondent pas à vos besoins (par exemple, si elles ont trop ou pas assez d'arguments), vous pouvez en créer de nouvelles (commandes personnalisées). Vous devez créer une commande par plugin et par [mode](../../resources/glossary.md#mode). Les commandes personnalisées sont une fonctionnalité avancée.

Les commandes peuvent être configurées à la page **Configuration > Commands > Checks**.
Les commandes peuvent être configurées à la page **Configuration > Commandes > Commandes**.

> Par défaut, seules les commandes personnalisées (c'est-à-dire créées par l'utilisateur) sont affichées. Toutes les commandes fournies par les connecteurs de supervision sont en lecture seule ("verrouillées") et sont masquées. Cochez la case "éléments verrouillés" pour afficher ces commandes.

## Créer une commande personnalisée

1. Allez à la page **Configuration > Commandes > Contrôles**.
2. Cliquez sur le bouton **Ajouter**.
1. Allez à la page **Configuration > Commandes > Commandes**.
2. Cliquez sur **Ajouter**.
3. Remplissez les champs suivants :

* **Nom de commande** : nom de la commande tel qu'il apparaîtra dans la liste des commandes dans les forumlaires de création de modèles d'hôtes ou de services.
* **Ligne de commande** : la commande qui sera exécutée quand un contrôle sera effectué. La syntaxe est celle de Nagios. Spécifiez :
* **Nom** : nom de la commande tel qu'il apparaîtra dans la liste des commandes dans les formulaires de création de modèles d'hôtes ou de services.
* **Type de commande** : dans Centreon Cloud, seules les options **Contrôle** et **Divers** sont disponibles. Les commandes **Divers** s'utilisent avec les [gestionnaires d'événements](../event-handler.md).
* **Ligne de commande** : la commande qui sera exécutée quand un contrôle sera effectué. La syntaxe est celle de Nagios. Utilisez les listes à gauche pour insérer rapidement des variables et/ou saisissez votre propre contenu. Spécifiez :

* l'application ou le script exécuté par la commande (chemin et nom de fichier). Pour des plugins Centreon ou Nagios, utilisez une variable afin que Centreon trouve le chemin du répertoire des pugins quel que soit l'OS (la variable est définie à la page **Configuration > Collecteurs > Ressources** page). Si vous utilisez vos propres plugins, spécifiez le chemin du répertoire où vous avez placé les plugins.
* le [mode](../../resources/glossary.md#mode) du plugin à utiliser.
* tout paramètre que vous voulez passer au plugin dans ce mode. Pour les plugins Centreon, reportez-vous à la documentation du plugin dans la section [Connecteurs de supervision](/pp/integrations/plugin-packs/getting-started/introduction).
* Vous pouvez utiliser des [macros](macros.md) (macros d'hôtes ou de services) afin de rendre votre commande plus générique, mais ce n'est pas obligatoire. Le nom de la macro apparaîtra dans le formulaire de configuration de l'hôte ou du service afin que vous puissiez lui attribuer une valeur spécifique pour chaque hôte ou service avec lequel vous l'utiliserez.
* Une macro représentant le chemin de l'application ou du script exécuté par la commande (sans le nom de fichier). Pour des plugins Centreon ou Nagios, utilisez une variable afin que Centreon trouve le chemin du répertoire des pugins quel que soit l'OS (la variable est définie à la page **Configuration > Collecteurs > Macros globales**). Si vous utilisez vos propres plugins, spécifiez le chemin du répertoire où vous avez placé les plugins. Les valeurs par défaut apparaissent dans **Macros globales des collecteurs**, mais vous pouvez également saisir le chemin d'accès à votre propre plugin que vous avez enregistré ailleurs.

* **Description des macros** : saisissez une description pour les macros personnalisées. Cette description sera visible lorsque vous utiliserez la commande dans le formulaire de configuration d'hôte ou de service.
* **Connecteurs**: utilisez le **[connecteur Perl](#connecteur-perl)** ou le **[connecteur SSH](#connecteur-ssh)** afin de réduire la comsommation de ressources du plugin. Le connecteur Perl peut être utilisé avec toutes les commandes, sauf **check_icmp** et **check_nrpe**.
* **Modèle de graphique** : liez la commande à un modèle de graphique.
Exemples :
* $CENTREONPLUGINS$ si le plugin que vous utilisez se trouve au même emplacement que les plugins Centreon (comme centreon_linux_snmp.pl)
* $USER1$ si le plugin que vous utilisez se trouve au même emplacement que les plugins Nagios (comme check_icmp)
* /custom/path/ si le plugin que vous utilisez se trouve dans un emplacement personnalisé
* créez la macro globale $MYPLUGINS$ si le chemin est /custom/path/ sur un poller et /alt/path/ sur un autre. De cette façon, vous pouvez utiliser la même commande pour le même plugin situé à différents emplacements selon le poller.

* Le nom du plugin que vous souhaitez utiliser (stocké dans le chemin spécifié dans la macro globale des collecteurs). **Plugins installés** vous permet de sélectionner des plugins Nagios. Exemples : `centreon_linux_snmp.pl`, `check_icmp`...
* Toute option que vous souhaitez passer au plugin dans ce [mode](../../resources/glossary.md#mode). Pour les plugins Centreon, reportez-vous à la documentation du plugin dans la section [Connecteurs de surveillance](/pp/integrations/plugin-packs/getting-started/introduction). Exemples : `--community=public`, `--warning=1`, `--verbose`...
* Au lieu de coder en dur la valeur d'une option, vous pouvez utiliser des [macros](macros.md) (macros d'hôte ou macros de service) pour rendre votre commande plus générique, mais ce n'est pas obligatoire. Le nom de la macro apparaîtra dans le formulaire de configuration de l'hôte ou du service, ce qui vous permettra de lui attribuer une valeur spécifique pour chaque hôte ou service avec lequel vous l'utilisez. Vous pouvez utiliser les [**macros standard**](./macros.md#standard-macros) ou créer vos propres [macros personnalisées](./macros.md#custom-macros). Exampls: `--hostname='$HOSTADDRESS$'`, `--warning='$_SERVICEWARNING$'`, `--community='$_HOSTSNMPCOMMUNITY$'`...

* **Activer la syntaxe du shell** : cochez cette case si votre commande utilise des fonctions du shell (pipes, redirections, caractères génériques...). Notez que les commandes nécessitant le shell ralentissent le serveur de supervision.

* **Connecteurs**: utilisez le **[connecteur Perl](#connecteur-perl)** ou le **[connecteur SSH](#connecteur-ssh)** afin de réduire la consommation de ressources du plugin. Le connecteur Perl peut être utilisé avec toutes les commandes fournies par Centreon qui utilisent des plugins Perl (.pl). Il n'est pas compatible avec les commandes qui utilisent **check_icmp** et **check_nrpe**.

4. Cliquez sur **Sauvegarder**. La commande apparaît maintenant dans la liste **Commande de vérification** dans les formulaires de configuration de modèles d'hôtes ou de services.

Expand Down
Loading