Sommaire

Lister des démons

Concept

Cet outil est utilisé pour lister les démons configurés sur le serveur Shinken.

Il ne listera pas l'ensemble des démons de l'architecture Shinken ( potentiellement distribuée avec d'autres serveurs ), mais uniquement les démons présents en local sur le serveur.

Utilisation

La commande suivante permet de lister les démons en local :

shinken-daemons-list

Options

OptionValeur par défautDescription

--version

---Version de Shinken.

--help, -h

---Aide de la commande.

Exemple de résultats

$ shinken-daemons-list
-- arbiter          - [id:0] arbiter-master         : ENABLED   | configuration in: /etc/shinken/shinken.cfg
-- broker           - [id:0] broker-master          : ENABLED   | configuration in: /etc/shinken/daemons/brokerd.ini
-- poller           - [id:0] poller-master          : ENABLED   | configuration in: /etc/shinken/daemons/pollerd.ini
   poller           - [id:1] Poller-2               : ENABLED   | configuration in: /etc/shinken/daemons/pollerd-1.ini
-- reactionner      - [id:0] reactionner-master     : ENABLED   | configuration in: /etc/shinken/daemons/reactionnerd.ini
-- receiver         - [id:0] receiver-master        : ENABLED   | configuration in: /etc/shinken/daemons/receiverd.ini
-- scheduler        - [id:0] scheduler-master       : ENABLED   | configuration in: /etc/shinken/daemons/schedulerd.ini
-- synchronizer     - [id:0] synchronizer-master    : ENABLED   | configuration in: /etc/shinken/synchronizer.cfg

Activer un ou plusieurs démons Shinken

Concept

Cet outil est utilisé pour activer un démon Shinken sur le serveur Shinken.

En plus d'activé le démon en local sur le serveur Shinken, il faudra modifier la configuration sur l'Arbiter pour qu'il envoie une configuration au démon local.

Utilisation

La commande suivante permet d'activer des démons en local :

shinken-daemons-enable [poller synchronizer scheduler reactionner receiver broker]

Options

Option générale

OptionValeur par défautDescription

--version

---Version de Shinken.

--help, -h 

---Aide de la commande.



Options pour l'activation

OptionValeur par défautDescription

--force

---Ignore l'état précédent des démons avant d'effectuer le changement.

--id ARG

---

Active spécifiquement d'un démon en fonction de son ID.

  • Si l'option est non renseignée, toutes les instances du type de démon sont activées.

Options de connexion à la base MongoDB

Les paramètres de connexion à la base MongoDB sont requis uniquement lors de l’activation d’un Synchronizer, afin de permettre l’exécution des actions automatiques. Elles garantissent la compatibilité entre la version du Synchroniser, les données en base et la configuration.

La commande dispose d'options de connexion à la base MongoDB qui peuvent être utilisés dans les cas suivants :

  • La base de données MongoDB ne se trouve pas sur la machine qui exécute la commande.
  • L'authentification par mot de passe à la base MongoDB est activée.
  • Le port de MongoDB n'est pas celui par défaut ( défaut : 27017 ).


La combinaison des options de connexion à MongoDB peut rapidement devenir complexe ; voici des paramètres adaptés aux cas les plus courants.

Options génériques

 [root@serveur01 ~] shinken-commande --mongo-host 127.0.0.1 --mongo-port 27017 --mongo-database shinken
OptionValeur par défautDescription
--mongo-host ARG

localhost

Nom ou IP du serveur MongoDB.

--mongo-port ARG

27017

Port de la base MongoDB.

--mongo-database ARG

shinken  ( ou synchronizer si la commande concerne la base du Synchronizer )

Nom de la base de données à utiliser dans MongoDB.

À n'utiliser que si la configuration du module ou du démon a changé la base utilisée par défaut.

Options de connexion SSH 

 [root@serveur01 ~] shinken-command --mongo-host serveur02 --mongo-port 27017 --mongo-use-ssh --mongo-ssh-key /var/lib/shinken/.ssh/id_rsa --mongo-ssh-user shinken 
OptionValeur par défautDescription
--mongo-use-ssh

---

Active la connexion SSH au serveur MongoDB.

--mongo-ssh-key ARG

 /var/lib/shinken/.ssh/id_rsa

Clé privée SSH pour la connexion au serveur MongoDB.

À utiliser en complément de l'option --mongo-use-ssh.

--mongo-ssh-user ARG

shinken

Utilisateur à utiliser pour la connexion SSH.

À utiliser en complément de l'option --mongo-use-ssh.

Options d'authentification

 [root@serveur01 ~] shinken-command  --mongo-host 127.0.0.1  --mongo-port 27017  --mongo-username shinken --mongo-password shinken 
OptionValeur par défautDescription
--mongo-username ARG

---

Utilisateur pour l'authentification avec mot de passe.

--mongo-password ARG

---

Mot de passe de l'utilisateur pour l'authentification avec mot de passe.

À utiliser en complément de l'option --mongo-username.

Si l'option --mongo-password est utilisée, le mot de passe risque d'être visible dans l'historique des commandes ( via la commande history ).

Pour éviter d'exposer le mot de passe, il est possible d'utiliser cette commande uniquement avec l'option --mongo-username. Un prompt interactif apparaîtra alors pour demander le mot de passe.

Pour automatiser les commandes dans un script, il est possible de rediriger le contenu d'un fichier contenant le mot de passe ( par exemple : --mongo-password $(cat my_file_with_password) ).


Options SSL/TLS

[root@serveur01 ~] shinken-command  --mongo-host serveur02  --mongo-port 27017  --mongo-ssl-ca-file /etc/shinken/certs/mongo/ca.pem --mongo-ssl-pem-key-file  /etc/shinken/certs/mongo/client.pem  
OptionValeur par défautDescription
--mongo-ssl


 

---

Active SSL/TLS pour les communications avec la base MongoDB.

--mongo-ssl-ca-file ARG

---

Chemin vers le fichier de l’autorité de certification ( CA ) utilisé pour vérifier le certificat SSL de MongoDB.

À utiliser en complément de l'option  --mongo-ssl.

--mongo-ssl-pem-key-file ARG

---

Chemin vers le fichier contenant le certificat SSL du client.

À utiliser en complément de l'option --mongo-ssl.

--mongo-ssl-pem-key-password ARG

---

Mot de passe du certificat SSL du client.

À utiliser en complément de l'option  --mongo-ssl.

--mongo-ssl-crl-file ARG

---

Chemin vers le fichier CRL ( liste de révocation ) des certificats SSL à rejeter.

À utiliser en complément de l'option  --mongo-ssl.

--mongo-ssl-allow-invalid-hostnames

---

Accepter le certificat SSL de MongoDB même si le nom d’hôte du certificat ne correspond pas à celui du serveur.

À utiliser en complément de l'option  --mongo-ssl.


--mongo-ssl-allow-invalid-certificates

---

Accepter le certificat SSL de MongoDB même s’il est invalide, par exemple expiré.

À utiliser en complément de l'option  --mongo-ssl.


Exemple de résultats

Activation des démons Reactionner et Poller sur le serveur (toutes les instances) :

$ shinken-daemons-enable reactionner poller
 [id:0] reactionner-master  : ENABLED
 [id:1] Poller-2            : ENABLED
 [id:0] poller-master       : ENABLED

 Activation du démon Poller ayant l'id 1 sur le serveur :

$ shinken-daemons-enable poller --id=1
 [id:1] Poller-2            : ENABLED

Désactiver un ou plusieurs démons Shinken

Concept

Cet outil est utilisé pour désactiver un démon Shinken sur le serveur Shinken.

En plus de désactiver le démon en local sur le serveur Shinken, il faudra modifier la configuration sur l'Arbiter pour qu'il n'envoie plus de configuration au démon local.

Utilisation

La commande suivante permet de désactiver des démons en local :

shinken-daemons-disable [poller synchronizer scheduler reactionner receiver broker]

Options

Option générale

OptionValeur par défautDescription

--version

---Version de Shinken.

--help, -h 

---Aide de la commande.

Option pour la désactivation

OptionValeur par défautDescription

--force

---Ignore l'état précédent des démons avant d'effectuer le changement.

--id ARG

---

Active spécifiquement d'un démon en fonction de son ID.

  • Si l'option est non renseignée, toutes les instances du type de démon sont activées.

Exemple de résultats

Désactivation des démons Reactionner et Poller sur le serveur ( toutes les instances ) :

$ shinken-daemons-disable reactionner poller
 [id:0] reactionner-master  : DISABLED
 [id:1] Poller-2            : DISABLED
 [id:0] poller-master       : DISABLED

 Désactivation du démon Poller ayant l'id 1 sur le serveur :

$ shinken-daemons-disable poller --id=1
 [id:1] Poller-2            : DISABLED