ansible-playbook
ターゲットのホストで定義したタスクを実行して Ansible Playbook を実行します。
概要
usage: ansible-playbook [-h] [--version] [-v] [-k]
[--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] [--force-handlers]
[--flush-cache] [-b] [--become-method BECOME_METHOD]
[--become-user BECOME_USER] [-K] [-t TAGS]
[--skip-tags SKIP_TAGS] [-C] [--syntax-check] [-D]
[-i INVENTORY] [--list-hosts] [-l SUBSET]
[-e EXTRA_VARS] [--vault-id VAULT_IDS]
[--ask-vault-password | --vault-password-file VAULT_PASSWORD_FILES]
[-f FORKS] [-M MODULE_PATH] [--list-tasks]
[--list-tags] [--step] [--start-at-task START_AT_TASK]
playbook [playbook ...]
説明
設定およびマルチノードのデプロイメントシステムである Ansible Playbook を実行するツール。詳細はプロジェクトのホームページ (https://docs.ansible.com)) を参照してください。
共通オプション
- --ask-vault-password, --ask-vault-pass
Vault のパスワード入力を尋ねます。
- --become-method <BECOME_METHOD>
使用する特権昇格方法 (デフォルトは sudo)。有効な選択を一覧表示するには ansible-doc -t become -l を使用します。
- --become-user <BECOME_USER>
このユーザーとして操作を実行します (デフォルトは root)。
- --flush-cache
インベントリー内のすべてのホストのファクトキャッシュを消去します。
- --force-handlers
タスクが失敗してもハンドラーを実行する
- --list-hosts
一致するホストの一覧を出力します。他には何も実行しません。
- --list-tags
利用可能なタグをすべて表示する
- --list-tasks
実行するタスクをすべて表示する
- --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)。
- --skip-tags
タグがこれらの値と一致しないプレイとタスクのみを実行する
- --ssh-common-args <SSH_COMMON_ARGS>
sftp/scp/ssh に渡す一般的な引数を指定します (例: ProxyCommand)。
- --ssh-extra-args <SSH_EXTRA_ARGS>
ssh のみに渡す追加の引数を指定します (例: -R)。
- --start-at-task <START_AT_TASK>
この名前に一致するタスクで Playbook を開始する
- --step
one-step-at-a-time: 実行前に各タスクを確認する
- --syntax-check
Playbook で構文チェックを実行しますが、Playbook は実行しません。
- --vault-id
使用する Vault アイデンティティー
- --vault-password-file, --vault-pass-file
Vault パスワードファイル
- --version
プログラムバージョン番号、設定ファイルの場所、設定したモジュール検索パス、モジュールの場所、実行可能な場所、および終了を表示します。
- -C, --check
変更を加えないでください。代わりに、発生する可能性のある変更のいくつかを予測してみてください。
- -D, --diff
(小規模な) ファイルおよびテンプレートの変更時に、これらのファイルの相違点を表示します。--check と適切に連携します。
- -K, --ask-become-pass
権限昇格のパスワードを要求します。
- -M, --module-path
モジュールライブラリーへのコロン区切りパス (デフォルトは ~/.ansible/plugins/modules:/usr/share/ansible/plugins/modules) を先頭に追加します。
- -T <TIMEOUT>, --timeout <TIMEOUT>
接続タイムアウトを秒単位で上書きします (デフォルトは 10)。
- -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>
選択したホストを追加パターンにさらに制限します。
- -t, --tags
それらの値でタグ付けされたプレイとタスクのみを実行する
- -u <REMOTE_USER>, --user <REMOTE_USER>
このユーザーとして接続 します (デフォルトは None)。
- -v, --verbose
詳細モード (-vvv の場合はより詳細になる。-vvvv の場合は接続のデバッグを有効にする)
環境
以下の環境変数を指定できます。
ANSIBLE_CONFIG -- デフォルトの Ansible 設定ファイルを上書きします
ansible.cfg のほとんどのオプションで、さらに多くのものが利用できます。