informatiquecdc.win_authorized_key

win_authorized_key - Ajoute ou supprime une clé SSH autorisée

Synopsis

Module Ansible pour ajouter ou supprimer des clés SSH autorisées pour des comptes d'utilisateurs spécifiques sur des systèmes basés sur Windows.

Exigences

Les exigences ci-dessous sont nécessaires sur l'hôte exécutant ce module.

Win32 OpenSSH

Paramètres

Paramètre	Choix/Valeurs par défaut	Commentaires
user chaîne / requis		Le nom d'utilisateur sur l'hôte distant dont le fichier authorized_keys sera modifié
key chaîne / requis		La ou les clés publiques SSH, sous forme de chaîne ou (depuis 1.9) d'URL https://github.com/username.keys
path chaîne	Par défaut : (homedir)+/.ssh/authorized_keys	Chemin alternatif vers le fichier authorized_keys
manage_dir booléen	Choix: non oui ←	Indique si ce module doit gérer le répertoire du fichier de clé autorisée. Si activé, le module créera le répertoire et définira le propriétaire et les permissions d'un répertoire existant. Assurez-vous de définir manage_dir=`non` si vous utilisez un répertoire alternatif pour authorized_keys, comme défini avec `path`, car cela pourrait vous empêcher d'accéder à SSH. Voir l'exemple ci-dessous.
state chaîne	Choix: présent ← absent	Indique si la clé donnée (avec les options de clé données) doit ou ne doit pas être dans le fichier
key_options chaîne		Une chaîne d'options de clé SSH à préfixer à la clé dans le fichier authorized_keys
exclusive booléen	Choix: non ← oui	Indique s'il faut supprimer toutes les autres clés non spécifiées du fichier authorized_keys. Plusieurs clés peuvent être spécifiées dans une seule valeur de chaîne key en les séparant par des sauts de ligne. Cette option n'est pas consciente de la boucle, donc si vous utilisez `with_`, elle sera exclusive par itération de la boucle. Si vous voulez plusieurs clés dans le fichier, vous devez les passer toutes à `key` en un seul lot comme mentionné ci-dessus.
validate_certs booléen	Choix: non oui ←	Ceci ne s'applique que si vous utilisez une URL https comme source des clés. Si mis à `non`, les certificats SSL ne seront pas validés. Cela ne doit être réglé sur `non` que pour les sites contrôlés personnellement utilisant des certificats auto-signés, car cela évite de vérifier le site source.
comment chaîne		Changez le commentaire sur la clé publique. Réécrire le commentaire est utile dans des cas tels que l'extraction depuis GitHub ou GitLab. Si aucun commentaire n'est spécifié, le commentaire existant sera conservé.
follow booléen	Choix: non ← oui	Suivre le chemin de symbole au lieu de le remplacer

Exemples

---
roles:
  - win_authorized_key

tasks:

  - name: Définir une clé autorisée prise depuis un fichier
    win_authorized_key:
      user: charlie
      state: present
      key: "{{ lookup('file', 'c:/users/charlie/.ssh/id_rsa.pub') }}"

  - name: Définir des clés autorisées prises depuis une URL
    win_authorized_key:
      user: charlie
      state: present
      key: https://github.com/charlie.keys

  - name: Définir une clé autorisée à un emplacement alternatif
    win_authorized_key:
      user: charlie
      state: present
      key: "{{ lookup('file', 'c:/users/charlie/.ssh/id_rsa.pub') }}"
      path: c:/ProgramData/ssh/administrators_authorized_key
      manage_dir: False

  - name: Configurer plusieurs clés autorisées
    win_authorized_key:
      user: deploy
      state: present
      key: '{{ item }}'
    with_file:
      - public_keys/doe-jane
      - public_keys/doe-john

  - name: Définir une clé autorisée en définissant des options de clé
    win_authorized_key:
      user: charlie
      state: present
      key: "{{ lookup('file', 'c:/users/charlie/.ssh/id_rsa.pub') }}"
      key_options: 'no-port-forwarding,from="10.0.1.1"'

  - name: Définir une clé autorisée sans valider les certificats TLS/SSL
    win_authorized_key:
      user: charlie
      state: present
      key: https://github.com/user.keys
      validate_certs: False

  - name: Définir une clé autorisée, en supprimant toutes les clés déjà autorisées
    win_authorized_key:
      user: administrator
      key: '{{ item }}'
      state: present
      exclusive: True
    with_file:
      - public_keys/doe-jane

Valeurs de retour

Les valeurs de retour courantes sont documentées ici, les champs suivants sont uniques à ce module :

Clé	Renvoyée	Description
exclusive booléen	succès	Si la clé a été forcée à être exclusive ou non. Exemple : False
key chaîne	succès	La clé contre laquelle le module a été exécuté. Exemple : https://github.com/user.keys
key_option chaîne	succès	Options de clé liées à la clé.
keyfile chaîne	succès	Chemin vers le fichier de clé autorisée. Exemple : C:/users/charlie/.ssh/authorized_keys
manage_dir booléen	succès	Indique si ce module a géré le répertoire du fichier de clé autorisée. Exemple : True
path chaîne	succès	Chemin alternatif vers le fichier authorized_keys.
state chaîne	succès	Indique si la clé donnée (avec les options de clé données) doit ou ne doit pas être dans le fichier. Exemple : présent
unique booléen	succès	Indique si la clé est unique. Exemple : False
user chaîne	succès	Le nom d'utilisateur sur l'hôte distant dont le fichier authorized_keys sera modifié. Exemple : user
validate_certs booléen	succès	Cela ne s'applique que si vous utilisez une URL https comme source des clés. Si mis à `non`, les certificats SSL ne seront pas validés. Exemple : True