Syntaxe de la commande `ansible`

Comprendre la structure fondamentale de la commande `ansible`

La commande ansible est votre principal outil pour exécuter des tâches Ad-Hoc. Elle permet d'envoyer une instruction unique, via un module Ansible, à un ensemble de noeuds gérés définis dans votre inventaire. Sa syntaxe, bien que paraissant dense au premier abord, est logique et flexible, offrant un contrôle précis sur vos actions d'automatisation ponctuelles. Maîtriser cette syntaxe est essentiel pour interagir efficacement avec votre infrastructure sans avoir à rédiger systématiquement des playbooks complets.

La forme la plus générale de la commande est la suivante :

ansible  [options]

Cette structure de base sera complétée par diverses options qui spécifient quel module utiliser, quels arguments lui passer, comment se connecter aux hôtes, et comment gérer les privilèges. Chaque composant joue un rôle crucial dans la définition exacte de l'action à entreprendre et des cibles concernées.

Avant de plonger dans les détails de chaque option, il est important de se rappeler que les commandes Ad-Hoc sont conçues pour des opérations simples et directes. Pour des logiques plus complexes, des dépendances entre tâches ou des scénarios de déploiement élaborés, les playbooks Ansible sont l'outil privilégié. Néanmoins, la puissance et la rapidité des commandes Ad-Hoc en font un allié indispensable pour l'administration quotidienne et le dépannage.

Le pattern d'hôte : cibler précisément vos noeuds gérés

Le premier argument après la commande ansible est le . Ce pattern indique à Ansible sur quels hôtes de votre inventaire la commande doit être exécutée. Sans ce pattern, Ansible ne saurait où diriger ses actions. Plusieurs types de patterns peuvent être utilisés :

• Nom d'hôte individuel : Cible un seul hôte spécifique. Par exemple, server1.example.com.
• Nom de groupe : Cible tous les hôtes appartenant à un groupe défini dans votre inventaire. Par exemple, webservers.
• Le mot-clé all : Cible tous les hôtes listés dans votre inventaire. C'est un moyen simple d'agir sur l'ensemble de votre parc.
• Motifs avec jokers (wildcards) : Vous pouvez utiliser des caractères jokers pour correspondre à plusieurs hôtes. Par exemple, web*.example.com ciblera web01.example.com, web02.example.com, etc. Le joker * correspond à n'importe quelle séquence de caractères, et ? à un seul caractère.
• Combinaisons de groupes : Vous pouvez utiliser des opérateurs pour combiner des groupes :
  • groupe1:groupe2 (ET logique) : Cible les hôtes qui sont dans groupe1 ET dans groupe2.
  • groupe1:!groupe2 (NON logique) : Cible les hôtes qui sont dans groupe1 mais PAS dans groupe2.
• Expressions régulières : Pour des ciblages plus avancés, vous pouvez utiliser des expressions régulières en les préfixant par un tilde (~). Par exemple, ~^(web|db).*.prod$.

Par exemple :

# Cible l'hôte 'db01'
ansible db01 -m ping

# Cible tous les hôtes du groupe 'staging_servers'
ansible staging_servers -m ping

# Cible tous les hôtes de l'inventaire
ansible all -m ping

# Cible les serveurs web en production (hôtes dans 'webservers' ET 'production')
ansible 'webservers:&production' -m ping

# Cible les serveurs applicatifs SAUF ceux marqués comme 'legacy'
ansible 'appservers:!legacy' -m ping

Le choix du bon pattern est crucial pour s'assurer que votre commande Ad-Hoc s'exécute uniquement sur les machines prévues, évitant ainsi des actions indésirables sur des systèmes sensibles.

Options essentielles : module, arguments, et inventaire

Après avoir défini le pattern d'hôte, vous spécifiez l'action à réaliser et comment l'exécuter à l'aide d'options. Voici les plus fondamentales :

• -m ou --module-name : Cette option est au coeur de la commande Ad-Hoc. Elle indique quel module Ansible utiliser. Les modules sont les unités de travail d'Ansible, chacun étant conçu pour une tâche spécifique (gérer des fichiers, des paquets, des services, etc.). Si cette option est omise, Ansible utilise par défaut le module command.
• -a "" ou --args "" : Cette option fournit les arguments nécessaires au module spécifié avec -m. La nature et le format de ces arguments dépendent entièrement du module utilisé. Les arguments sont souvent passés sous forme clé=valeur, séparés par des espaces si plusieurs arguments sont nécessaires. Les guillemets autour des arguments sont importants, surtout s'ils contiennent des espaces ou des caractères spéciaux.
• -i ou --inventory : Par défaut, Ansible cherche un fichier d'inventaire à des emplacements standards (comme /etc/ansible/hosts) ou selon la configuration (variable d'environnement ANSIBLE_INVENTORY, fichier ansible.cfg). Cette option permet de spécifier explicitement un fichier d'inventaire ou un répertoire contenant des fichiers d'inventaire pour cette commande particulière. C'est très utile lorsque vous travaillez sur plusieurs projets ou environnements avec des inventaires distincts.

Exemples concrets :

# Utiliser le module 'copy' pour copier un fichier local vers les serveurs web
ansible webservers -i ./my_inventory.ini -m copy -a "src=/local/path/index.html dest=/var/www/html/index.html"

# Utiliser le module 'service' pour s'assurer que nginx est démarré sur 'server1'
ansible server1 -i ./my_inventory.ini -m service -a "name=nginx state=started"

# Le module 'command' est implicite si -m n'est pas fourni
ansible all -i ./my_inventory.ini -a "uptime"

Consulter la documentation d'un module (avec ansible-doc ) est indispensable pour connaître les arguments qu'il accepte et leur syntaxe.

Options de connexion et de privilèges : `ansible_user`, `become`

Souvent, les actions que vous souhaitez effectuer sur les noeuds distants nécessitent des permissions spécifiques ou un utilisateur de connexion particulier. Ansible offre plusieurs options pour gérer cela :

• -u ou --user : Spécifie le nom d'utilisateur à utiliser pour la connexion SSH aux noeuds gérés. Cela surcharge la variable ansible_user si elle est définie dans l'inventaire pour un hôte ou un groupe, ou l'utilisateur courant du noeud de contrôle si rien d'autre n'est spécifié.
• -k ou --ask-pass : Si vous utilisez une authentification par mot de passe pour SSH (ce qui est moins sécurisé et moins recommandé que les clés SSH), cette option demandera interactivement le mot de passe de connexion SSH.
• -b ou --become : Active la montée en privilèges. Ansible tentera d'exécuter la tâche en tant qu'un autre utilisateur, typiquement root, en utilisant la méthode de montée en privilèges configurée (par défaut, sudo).
• --become-user : Utilisé avec -b, spécifie l'utilisateur cible pour la montée en privilèges. Par défaut, c'est root. Par exemple, --become-user apache.
• --become-method : Spécifie la méthode de montée en privilèges à utiliser (sudo, su, pbrun, enable, etc.). La valeur par défaut est généralement sudo.
• -K ou --ask-become-pass : Si la méthode de montée en privilèges requiert un mot de passe (par exemple, le mot de passe sudo de l'utilisateur de connexion), cette option le demandera interactivement.

Exemples d'utilisation :

# Installer 'nginx' sur 'web01' en tant que root (via sudo)
ansible web01 -m apt -a "name=nginx state=present" -b -K

# Exécuter 'whoami' en tant qu'utilisateur 'appadmin' après connexion en 'sshuser'
ansible appserver1 -u sshuser -m command -a "whoami" -b --become-user appadmin -K

Il est préférable de configurer les variables ansible_user, ansible_become, ansible_become_user, et ansible_become_method dans l'inventaire ou dans le fichier de configuration ansible.cfg pour éviter de les spécifier constamment en ligne de commande et pour une meilleure gestion des secrets (par exemple, en utilisant Ansible Vault pour ansible_become_pass).

Autres options utiles : verbosité, mode `check`, et forks

Plusieurs autres options peuvent affiner le comportement de vos commandes Ad-Hoc :

• -v, -vv, -vvv, -vvvv : Augmente le niveau de verbosité de la sortie d'Ansible. -v affiche des informations de base sur la réussite/échec. -vvv fournit des détails de connexion SSH et l'exécution des modules. -vvvv active le débogage de la connexion. Très utile pour diagnostiquer les problèmes.
• -C ou --check : Active le mode "dry run" (exécution à blanc). Ansible simulera l'exécution de la tâche sans apporter de modifications réelles aux noeuds gérés. Il rapportera les changements qu'il *aurait* faits. C'est un excellent moyen de tester vos commandes avant de les appliquer réellement.
• -D ou --diff : Lorsque le mode check est activé (-C), et si le module le supporte (comme les modules manipulant des fichiers), cette option affiche les différences entre l'état actuel et l'état désiré, un peu comme la sortie de la commande diff. Très utile avec les modules template ou copy.
• -f ou --forks : Spécifie le nombre de processus parallèles qu'Ansible utilisera pour se connecter aux noeuds gérés. La valeur par défaut est généralement de 5. Augmenter ce nombre peut accélérer l'exécution sur un grand nombre d'hôtes, mais consommera plus de ressources sur le noeud de contrôle.
• -T ou --timeout : Définit le timeout de connexion SSH en secondes. Utile si certains hôtes sont lents à répondre.
• --list-hosts : N'exécute aucune tâche, mais affiche la liste des hôtes qui seraient ciblés par le pattern fourni. Pratique pour vérifier la portée de votre commande avant de l'exécuter.

Exemples :

# Vérifier quels changements le module 'file' apporterait sans les appliquer
ansible fileservers -m file -a "path=/tmp/myfile state=touch" -C --diff

# Lister les hôtes du groupe 'databases' sans exécuter de tâche
ansible databases --list-hosts

# Exécuter 'uptime' sur tous les serveurs avec 20 forks et une sortie très verbeuse
ansible all -a "uptime" -f 20 -vvv

La maîtrise de ces différentes options vous permettra d'exploiter pleinement la flexibilité et la puissance de la commande ansible pour vos besoins d'administration Ad-Hoc, rendant vos interactions avec votre infrastructure plus rapides, plus précises et plus sûres.