Sommaire

Concept

Cette commande shinken-protected-fields-keyfile-restore permet de restaurer sur l'installation Shinken-Entreprise, le hash de la clé obtenue via la commande shinken-protected-fields-keyfile-export ( voir la page shinken-protected-fields-keyfile-export )

Options

Options génériques

OptionValeur par défautDescription
-h, --help 
--Affiche l'aide de la commande

Option pour la restauration de clé

OptionValeur par défautDescription
-f ARG
--

Déprécié : Au lieu d'importer la clef dans Shinken, cela crée un fichier avec la clef

Cette option sera supprimée de cette commande dans une future version, car elle porte à confusion. Cela s'apparente plus à un "dump" de la clef qu'à un "restore".

<hash>
--La hash de la clé précédemment exportée

Options de connexion à la base MongoDB

Cette commande récupère les paramètres de connexion à la base MongoDB depuis la configuration.
  • Il est nécessaire d'utiliser les options de la ligne de commande que si les fichiers de configuration ne correspond pas à la base MongoDB sur laquelle, la commande doit être exécutée (
migration de base, test sur une préprod ... ).

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.


Utilisations

La restauration de la clé peut se faire de trois façons différentes :

Restauration de la clé avec la saisie dans la commande

Si la clé n'est pas donnée dans les paramètres de la commande, elle sera demandée pendant l’exécution de la commande.


Restauration de la clé avec le paramètre de la commande

La clé peut être passée en paramètre de la commande en écrivant la clé juste après le nom de la commande. 

Cela permet d’exécuter directement la commande sans faire l'étape de saisie de la clé.

Restauration de la clé dans un fichier

À partir de l'export d'une clé, il est possible de l'exporter dans un fichier.

  • L'option "-f " permet de spécifier le chemin du fichier dans lequel la clé va être restaurée.
  • Puis, il faut fournir la clé.
    Pour cela, il y a deux possibilités :
    • La fournir en paramètre de la commande.
    • Ou la saisir quand la commande la demande.


Information

Après l’exécution de la commande, il sera demandé de redémarrer le Synchronizer pour que la clé soit prise en compte.