informatiquecdc.win_authorized_key

win_authorized_key - SSHの認証鍵を追加または削除します

概要

Windowsベースのシステム上で特定のユーザーアカウントのSSH認証鍵を追加または削除するためのAnsibleモジュールです。

要件

このモジュールを実行するホストに必要な要件は次のとおりです。

Win32 OpenSSH

パラメーター

パラメーター	選択肢/デフォルト	コメント
user 文字列 / 必須		認証鍵ファイルが変更されるリモートホストのユーザー名
key 文字列 / 必須		SSH公開鍵（文字列またはURL: https://github.com/username.keys）
path 文字列	デフォルト: (ホームディレクトリ)+/.ssh/authorized_keys	認証鍵ファイルの別のパス
manage_dir 真偽値	選択肢: いいえはい ←	このモジュールが認証鍵ファイルのディレクトリを管理するかどうか。設定すると、モジュールはディレクトリを作成し、既存のディレクトリの所有者や権限を設定します。 `path`で別のディレクトリを使用する場合は、manage_dir=`no`に設定してください。SSHアクセスを失う可能性があるためです。
state 文字列	選択肢: 存在する ← 存在しない	指定された鍵がファイルに存在するかどうか
key_options 文字列		認証鍵ファイルの鍵の前に追加されるSSH鍵オプションの文字列
exclusive 真偽値	選択肢: いいえ ← はい	認証鍵ファイルから他の非指定の鍵をすべて削除するかどうか。新しい行で区切ることで、1つの_key_文字列値で複数の鍵を指定できます。
validate_certs 真偽値	選択肢: いいえはい ←	鍵のソースとしてhttps URLを使用している場合にのみ適用されます。 `no`に設定すると、SSL証明書が検証されません。自己署名証明書を使っている場合、サイトの検証を避けるために`no`に設定するべきです。
comment 文字列		公開鍵のコメントを変更します。GitHubやGitLabから取得した場合などに、コメントを書き換えるのが便利です。指定しなければ、既存のコメントが保持されます。
follow 真偽値	選択肢: いいえ ← はい	パスのシンボリックリンクを追跡するか、置き換えるか

例

---
roles:
  - win_authorized_key

tasks:

  - name: ファイルから取得した認証鍵を設定
    win_authorized_key:
      user: charlie
      state: present
      key: "{{ lookup('file', 'c:/users/charlie/.ssh/id_rsa.pub') }}"

  - name: URLから取得した認証鍵を設定
    win_authorized_key:
      user: charlie
      state: present
      key: https://github.com/charlie.keys

  - name: 別の場所に認証鍵を設定
    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: 複数の認証鍵を設定
    win_authorized_key:
      user: deploy
      state: present
      key: '{{ item }}'
    with_file:
      - public_keys/doe-jane
      - public_keys/doe-john

  - name: 鍵オプションを指定した認証鍵を設定
    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: TLS/SSL証明書を検証せずに認証鍵を設定
    win_authorized_key:
      user: charlie
      state: present
      key: https://github.com/user.keys
      validate_certs: False

  - name: すでに設定されている認証鍵をすべて削除し、認証鍵を設定
    win_authorized_key:
      user: administrator
      key: '{{ item }}'
      state: present
      exclusive: True
    with_file:
      - public_keys/doe-jane

戻り値

一般的な戻り値はこちらで文書化されていますが、このモジュールに特有のフィールドは次のとおりです。

キー	戻り値	説明
exclusive 真偽値	success	鍵が排他的に強制されたかどうか。サンプル: False
key 文字列	success	モジュールが実行していた鍵。サンプル: https://github.com/user.keys
key_option 文字列	success	鍵に関連する鍵オプション。
keyfile 文字列	success	認証鍵ファイルのパス。サンプル: C:/users/charlie/.ssh/authorized_keys
manage_dir 真偽値	success	このモジュールが認証鍵ファイルのディレクトリを管理したかどうか。サンプル: True
path 文字列	success	認証鍵ファイルへの別のパス。
state 文字列	success	指定された鍵（指定された鍵オプション）がファイルに含まれるべきかどうか。サンプル: present
unique 真偽値	success	鍵がユニークであるかどうか。サンプル: False
user 文字列	success	認証鍵ファイルが変更されるリモートホストのユーザー名。サンプル: user
validate_certs 真偽値	success	鍵のソースとしてhttps URLを使用している場合にのみ有効。`no`に設定すると、SSL証明書が検証されません。サンプル: True