ansible
一連のホストに対して単一のタスク「Playbook」を定義して実行
概要
usage: ansible [-h] [--version] [-v] [-b] [--become-method BECOME_METHOD]
[--become-user BECOME_USER]
[-K | --become-password-file BECOME_PASSWORD_FILE]
[-i INVENTORY] [--list-hosts] [-l SUBSET] [-P POLL_INTERVAL]
[-B SECONDS] [-o] [-t TREE] [--private-key PRIVATE_KEY_FILE]
[-u REMOTE_USER] [-c CONNECTION] [-T TIMEOUT]
[--ssh-common-args SSH_COMMON_ARGS]
[--sftp-extra-args SFTP_EXTRA_ARGS]
[--scp-extra-args SCP_EXTRA_ARGS]
[--ssh-extra-args SSH_EXTRA_ARGS]
[-k | --connection-password-file CONNECTION_PASSWORD_FILE] [-C]
[--syntax-check] [-D] [-e EXTRA_VARS] [--vault-id VAULT_IDS]
[--ask-vault-password | --vault-password-file VAULT_PASSWORD_FILES]
[-f FORKS] [-M MODULE_PATH] [--playbook-dir BASEDIR]
[--task-timeout TASK_TIMEOUT] [-a MODULE_ARGS] [-m MODULE_NAME]
pattern
共通オプション
- --ask-vault-password, --ask-vault-pass
Vault のパスワード入力を尋ねます。
- --become-method <BECOME_METHOD>
使用する特権昇格方法 (デフォルトは sudo)。有効な選択を一覧表示するには ansible-doc -t become -l を使用します。
- --become-password-file <BECOME_PASSWORD_FILE>, --become-pass-file <BECOME_PASSWORD_FILE>
become パスワードファイル
- --become-user <BECOME_USER>
このユーザーとして操作を実行します (デフォルトは root)。
- --connection-password-file <CONNECTION_PASSWORD_FILE>, --conn-pass-file <CONNECTION_PASSWORD_FILE>
接続のパスワードファイル
- --list-hosts
一致するホストの一覧を出力します。他には何も実行しません。
- --playbook-dir <BASEDIR>
このツールは Playbook を使用しないため、代替の Playbook ディレクトリーとして使用します。これにより、roles/ group_vars/ などの多くの機能の相対パスが設定されます。
- --private-key <PRIVATE_KEY_FILE>, --key-file <PRIVATE_KEY_FILE>
このファイルを使用して接続を認証します。
- --scp-extra-args <SCP_EXTRA_ARGS>
scp のみに渡す追加の引数を指定します (例: -l)。
- --sftp-extra-args <SFTP_EXTRA_ARGS>
sftp のみに渡す追加の引数を指定します (例: -f、-l)。
- --ssh-common-args <SSH_COMMON_ARGS>
sftp/scp/ssh に渡す一般的な引数を指定します (例: ProxyCommand)。
- --ssh-extra-args <SSH_EXTRA_ARGS>
ssh のみに渡す追加の引数を指定します (例: -R)。
- --syntax-check
Playbook で構文チェックを実行しますが、Playbook は実行しません。
- --task-timeout <TASK_TIMEOUT>
タスクのタイムアウト制限を秒単位で設定します。正の整数である必要があります。
- --vault-id
使用する Vault アイデンティティー
- --vault-password-file, --vault-pass-file
Vault パスワードファイル
- --version
プログラムバージョン番号、設定ファイルの場所、設定したモジュール検索パス、モジュールの場所、実行可能な場所、および終了を表示します。
- -B <SECONDS>, --background <SECONDS>
非同期的に実行し、X 秒後に失敗します (デフォルトは N/A)。
- -C, --check
変更を加えないでください。代わりに、発生する可能性のある変更のいくつかを予測してみてください。
- -D, --diff
(小規模な) ファイルおよびテンプレートの変更時に、これらのファイルの相違点を表示します。--check と適切に連携します。
- -K, --ask-become-pass
権限昇格のパスワードを要求します。
- -M, --module-path
モジュールライブラリーへのコロン区切りパス (デフォルトは ~/.ansible/plugins/modules:/usr/share/ansible/plugins/modules) を先頭に追加します。
- -P <POLL_INTERVAL>, --poll <POLL_INTERVAL>
-B (デフォルトは 15) を使用する場合はポーリング間隔を設定します。
- -T <TIMEOUT>, --timeout <TIMEOUT>
接続タイムアウトを秒単位で上書きします (デフォルトは 10)。
- -a <MODULE_ARGS>, --args <MODULE_ARGS>
スペースで区切られた k=v 形式のアクションのオプション: -a 'opt1=val1 opt2=val2'
- -b, --become
become で操作の実行 (パスワード入力を意味するものではありません)
- -c <CONNECTION>, --connection <CONNECTION>
使用する接続タイプ (デフォルトは smart)
- -e, --extra-vars
ファイル名の前に @ を付ける場合は、追加の変数を key=value または YAML/JSON に設定します。
- -f <FORKS>, --forks <FORKS>
使用する並列プロセス数を指定します (デフォルトは 5)。
- -h, --help
ヘルプメッセージを表示して終了します。
- -i, --inventory, --inventory-file
インベントリーホストパスまたはコンマ区切りホスト一覧を指定します。--inventory-file は非推奨になりました。
- -k, --ask-pass
接続のパスワードを要求します。
- -l <SUBSET>, --limit <SUBSET>
選択したホストを追加パターンにさらに制限します。
- -m <MODULE_NAME>, --module-name <MODULE_NAME>
実行する動作の名前 (default=command)
- -o, --one-line
出力を要約します。
- -t <TREE>, --tree <TREE>
このディレクトリーにログを記録します。
- -u <REMOTE_USER>, --user <REMOTE_USER>
このユーザーとして接続します (デフォルトは None)。
- -v, --verbose
詳細モード (-vvv の場合はより詳細になり、-vvvv の場合は接続のデバッグを有効にします)
環境
以下の環境変数を指定できます。
ANSIBLE_CONFIG -- デフォルトの Ansible 設定ファイルを上書きします。
ansible.cfg のほとんどのオプションで、さらに多くのものが利用できます。