Page History

Principe

Les commandes sont des éléments de configuration permettant de décrire l'utilisation d'un plugin .

Elle précise ou trouver le plugin, comment l'utiliser avec les bons arguments et comment remplacer ces arguments par des données

Par exemple, check_ping est un plugin utiliser pour pinguer un hôte et collecter ses données de connexion

Overview

Commands are configuration elements used to describe plugins usage.

It tells Shinken Enterprise where to find plugins, how to use it, what arguments are necessary, and how to substitute arguments by Data.

For example, check_ping is a plugin used to ping a host, and get informations about network connectivity with host :

check_ping -H <host_address> -w <wrta>,<wpl>% -c <crta>,<cpl>%

Plugin help tells that to use the command, we need to pass, as argument the following L'aide du plugin nous précise quels arguments passer pour utiliser la commande ::

• -H : host addressadresse de l'hôte
• -w : wrta,wpl (Warning Round Trip Average, Warning Packet Loss)
• -c : crta, cpl (Critical Round Trip Average, Critical Packet Loss)

The corresponding commands should be La commande correspondante devrait alors être :

check_ping -H $HOSTADDRESS$ -w $ARG1$ -c $ARG2$

In this wayDe cette façon, Shinken Enterprise will able to replace arguments by the corresponding value, depending of HOSTADDRESS and arguments given to command.pourra remplacer les arguments par les valeurs correspondantes en fonction de HOSTADDRESS (adresse de l'hôte) et des arguments fournis dans la commande

 Accessing Commands configuration

 Accéder à la configuration des commandes

L'accès se fait par l'onglet "Commandes" dans le menu principal

En accédant à la page de configuration, une liste apparaît précisant tous les objets commandes .

En haut de la table,un barre d'outils permet de :

• Activer, désactiver, supprimer ou dupliquer la commande sélectionnée
• Filtrer la liste par nom

When accessing the Commands Configuration Page, a Command Table is displayed, listing all Commands objects.

On the top of the table, A tool bar let Administrators the ability to :

• Enable, Disable, Delete or Duplicate selected Commands
• Filter list by Name

Cette table contient les informations suivantes:

• un boîte de choix pour sélectionne rune ou plusieurs commandes
• Différences
• Nom

This table contains the following informations :

• A check box to select one or more commands
• Differences
• Name
• Poller Tag
• Reactionner Tag
• Pack
• StatutStatus
  

This page also provides, on the left, an action Menu, used to :

Cette page propose également à gauche un menu action permettant de :

• Ajouter une nouvelle commande
• Montrer les commandes détectées par les modules de découverte automatique
• Accepter les différences sur les éléments sélectionnés
• Add a new Command
• Show Commands detected by Automatic Modules
• Accept differences on selected elements

Create a new Command

Créer une nouvelle commande

Pour créer une nouvelle commande,,utiliser le bouton To create a new Command, use the button "Add new [Command]" located in the Action Menusitué dans le menu d'action

Command creation form will be displayed.

This form is composed of tabs, corresponding to categories of properties :

• Generic

• Advanced

The left menu give to Administrators the ability to :

• Validate the new Command
• Cancel the action
• Delete the Command

Le formulaire de création apparaît

Ce formulaire est composé d'onglet correspondant à des catégories de propriétés :

• Générique

• Avancé

Le menu de gauche permet de :

• Valider la nouvelle commande
• Supprimer l'action
• Supprimer le commande

Generic

Générique

Les propriétés génériques contiennent les propriétés minimum réclamées pour créer une commande :

• Nom
  

  • nom de la commande

  • ce champs est obligatoire

• Commande
  • configuration du plugin
  • champs texte définissant la syntaxe du plugin

Generic properties contains the minimum properties requiered to create a Command :

• Name
  

  • the name of the Command

  • this field is requiered

• Command
  • the plugin configuration
  • the value is a text field, defining the plugin syntax (see example in Overview)

Advanced

Avancé

Les propriétés avancées permettent de définir :

• Supervisé depuis
  • précise le the poller tag depuis lequel la commande est lancée
• Type de Module
  • précise le module que la commande doit exécuter dans le poller

Advanced properties are used to define Advanced features like :

• Monitored from
  • the poller tag that the command should run on
• Module Type
  • the poller module the command should run in the poller daemon

Modify a command

Modifier une commande

Pour modifier les propriétés d'une commande, accéder à la page "Commande" depuis le menu principale puis cliquer sur le nom de la commande que vous souhaitez modifier

To modify properties of a command, first go on the Commands page, from the Main menu,

then click on the command name you want to modify.

The form displayed is the same as the form used to create a new Command.

All fields are filled with Command properties.

Le formulaire est le même que celui de la création.

Une fois les changements réalisés, il faut sauvegarder. Le bouton supprimer permet de revenir à l'état prcéédent sans prise en compte ds modificationsOnce changes have been made, configuration of the Command must be saved by clicking the Validate button available on the left menu. Cancel button revert all changes to previous configuration.

Delete a command

From the Form page

First go to the Commands page, from the Main menu, then click on the command name you want to delete.

Once in the page displaying the form, click on the Delete button available on the left menu.

A confirmation popup will be displayed.

Supprimer une commande

Depuis le formulaire

Allez sur la page commande, puis cliquer sur le nom de la commande à supprimer .

Cliquer ensuite sur le bouton "supprimer", une fenêtre de confirmation va alors apparaître.

Depuis la page principale

Allez dans la page commande du menu principal, puis cliquer sur la boîte de choix placée dans la 1ère colonne à gauche.

Utilisez le menu Action et sélectionner Supprimer, puis cliquer sur le bouton Lancer.

Une fenêtre de confirmation apparaître.

Passer par le menu principal permet d'en supprimer plusieurs d'un coup

From the Main page

First go to the Commands page, from the Main menu, then click on the check box placed on the first column of the table.

Use the Action menu on the top to select Delete, and click to the Launch Button.

A confirmation popup will be displayed.

Using the Main page gives Administrators ability to Delete many Commands at once.

Duplicate a command

To duplicate a command, first go on the Main page listing all commands,

then select a comand by clicking on the check box placed on the first column.

Once selected, the command can be duplicated by selecting Duplicate in the select Action of the tool bar.

Duplication is executed by clicking the Launch button.

Dupliquer une commande

Allez dans la page commande du menu principal, puis cliquer sur la boîte de choix placée dans la 1ère colonne à gauche.

Utilisez le menu Action et sélectionner Dupliquer, puis cliquer sur le bouton Lancer.

Toutes les propriétées et données sont conservées lors de l aduplication.

Using the Main page gives Administrators ability to Duplicate many Commands at once.

All properties are kept when duplicating operation, as well as data.