informatiquecdc.win_authorized_key

win_authorized_key - Fügt einen SSH-authorisierten Schlüssel hinzu oder entfernt ihn

Zusammenfassung

Ansible-Modul zum Hinzufügen oder Entfernen von SSH-authorisierten Schlüsseln für bestimmte Benutzerkonten auf Windows-basierten Systemen.

Anforderungen

Die folgenden Anforderungen sind auf dem Host erforderlich, der dieses Modul ausführt.

Win32 OpenSSH

Parameter

Parameter	Optionen/Standardwerte	Kommentare
user string / erforderlich		Der Benutzername auf dem entfernten Host, dessen authorized_keys-Datei geändert wird
key string / erforderlich		Der SSH-Öffentliche Schlüssel(e), als String oder (seit 1.9) URL https://github.com/benutzername.keys
path string	Standard: (homedir)+/.ssh/authorized_keys	Alternativer Pfad zur authorized_keys-Datei
manage_dir boolean	Optionen: nein ja ←	Ob dieses Modul das Verzeichnis der autorisierten Schlüsseldatei verwalten soll. Wenn gesetzt, wird das Modul das Verzeichnis erstellen sowie den Besitzer und die Berechtigungen eines vorhandenen Verzeichnisses festlegen. Setzen Sie manage_dir=`nein`, wenn Sie ein alternatives Verzeichnis für authorized_keys verwenden, wie mit `path` festgelegt, da Sie sich sonst vom SSH-Zugriff aussperren könnten. Siehe das Beispiel unten.
state string	Optionen: vorhanden ← fehlt	Ob der angegebene Schlüssel (mit den angegebenen Schlüsseloptionen) in der Datei sein sollte oder nicht
key_options string		Eine Zeichenfolge von SSH-Schlüsseloptionen, die dem Schlüssel in der authorized_keys-Datei vorangestellt werden sollen
exclusive boolean	Optionen: nein ← ja	Ob alle anderen nicht spezifizierten Schlüssel aus der authorized_keys-Datei entfernt werden sollen. Mehrere Schlüssel können in einem einzelnen key Stringwert angegeben werden, indem sie durch Zeilenumbrüche getrennt werden. Diese Option ist nicht schleifenbewusst, sodass, wenn Sie `mit_` verwenden, sie pro Iteration der Schleife exklusiv sein wird. Wenn Sie mehrere Schlüssel in der Datei haben möchten, müssen Sie sie alle in einem einzigen Batch an `key` übergeben, wie oben erwähnt.
validate_certs boolean	Optionen: nein ja ←	Dies gilt nur, wenn eine HTTPS-URL als Quelle der Schlüssel verwendet wird. Wenn auf `nein` gesetzt, werden die SSL-Zertifikate nicht validiert. Dies sollte nur auf persönlich kontrollierten Webseiten mit selbstsignierten Zertifikaten auf `nein` gesetzt werden, da es die Überprüfung der Quellseite vermeidet.
comment string		Ändern Sie den Kommentar zum öffentlichen Schlüssel. Das Umschreiben des Kommentars ist nützlich in Fällen wie dem Abrufen von GitHub oder GitLab. Wenn kein Kommentar angegeben ist, bleibt der vorhandene Kommentar erhalten.
follow boolean	Optionen: nein ← ja	Dem Pfad-Symlink folgen, anstatt ihn zu ersetzen

Beispiele

---
 Rollen:
   - win_authorized_key

 Aufgaben:

   - name: Autorisierten Schlüssel aus Datei setzen
     win_authorized_key:
       user: charlie
       state: vorhanden
       key: "{{ lookup('file', 'c:/users/charlie/.ssh/id_rsa.pub') }}"

   - name: Autorisierte Schlüssel aus URL setzen
     win_authorized_key:
       user: charlie
       state: vorhanden
       key: https://github.com/charlie.keys

   - name: Autorisierten Schlüssel an alternativem Ort setzen
     win_authorized_key:
       user: charlie
       state: vorhanden
       key: "{{ lookup('file', 'c:/users/charlie/.ssh/id_rsa.pub') }}"
       path: c:/ProgramData/ssh/administrators_authorized_key
       manage_dir: False

   - name: Mehrere autorisierte Schlüssel einrichten
     win_authorized_key:
       user: deploy
       state: vorhanden
       key: '{{ item }}'
     mit_datei:
       - public_keys/doe-jane
       - public_keys/doe-john

   - name: Autorisierten Schlüssel mit definierten Schlüsseloptionen setzen
     win_authorized_key:
       user: charlie
       state: vorhanden
       key: "{{ lookup('file', 'c:/users/charlie/.ssh/id_rsa.pub') }}"
       key_options: 'no-port-forwarding,from="10.0.1.1"'

   - name: Autorisierten Schlüssel setzen, ohne die TLS/SSL-Zertifikate zu validieren
     win_authorized_key:
       user: charlie
       state: vorhanden
       key: https://github.com/user.keys
       validate_certs: False

   - name: Autorisierten Schlüssel setzen, alle bereits festgelegten autorisierten Schlüssel entfernen
     win_authorized_key:
       user: administrator
       key: '{{ item }}'
       state: vorhanden
       exclusive: True
     mit_datei:
       - public_keys/doe-jane

Rückgabewerte

Die üblichen Rückgabewerte sind hier dokumentiert, die folgenden Felder sind einzigartig für dieses Modul:

Schlüssel	Zurückgegeben	Beschreibung
exclusive boolean	Erfolg	Ob der Schlüssel als exklusiv gesetzt wurde oder nicht. Beispiel: False
key string	Erfolg	Der Schlüssel, gegen den das Modul ausgeführt wurde. Beispiel: https://github.com/user.keys
key_option string	Erfolg	Schlüsseloptionen, die mit dem Schlüssel verbunden sind.
keyfile string	Erfolg	Pfad zur autorisierten Schlüsseldatei. Beispiel: C:/users/charlie/.ssh/authorized_keys
manage_dir boolean	Erfolg	Ob dieses Modul das Verzeichnis der autorisierten Schlüsseldatei verwaltet hat. Beispiel: True
path string	Erfolg	Alternativer Pfad zur authorized_keys-Datei.
state string	Erfolg	Ob der angegebene Schlüssel (mit den angegebenen Schlüsseloptionen) in der Datei sein sollte oder nicht. Beispiel: vorhanden
unique boolean	Erfolg	Ob der Schlüssel eindeutig ist. Beispiel: False
user string	Erfolg	Der Benutzername auf dem entfernten Host, dessen authorized_keys-Datei geändert wird. Beispiel: user
validate_certs boolean	Erfolg	Dies gilt nur, wenn eine HTTPS-URL als Quelle der Schlüssel verwendet wird. Wenn auf `nein` gesetzt, werden die SSL-Zertifikate nicht validiert. Beispiel: True