ansible-playbook
运行 Ansible playbook，在目标主机上执行定义的任务。
概要
usage: ansible-playbook [-h] [--version] [-v] [--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]
[--force-handlers] [--flush-cache] [-b]
[--become-method BECOME_METHOD]
[--become-user BECOME_USER]
[-K | --become-password-file BECOME_PASSWORD_FILE]
[-t TAGS] [--skip-tags SKIP_TAGS] [-C] [-D]
[-i INVENTORY] [--list-hosts] [-l SUBSET]
[-e EXTRA_VARS] [--vault-id VAULT_IDS]
[-J | --vault-password-file VAULT_PASSWORD_FILES]
[-f FORKS] [-M MODULE_PATH] [--syntax-check]
[--list-tasks] [--list-tags] [--step]
[--start-at-task START_AT_TASK]
playbook [playbook ...]
描述
用于运行 *Ansible playbook* 的工具，Ansible playbook 是一种配置和多节点部署系统。有关更多信息，请参阅项目主页 (https://docs.ansible.org.cn)。
常用选项
- --become-method <BECOME_METHOD>
要使用的提权方法（默认为 sudo），使用 ansible-doc -t become -l 列出有效选项。
- --become-password-file <BECOME_PASSWORD_FILE>, --become-pass-file <BECOME_PASSWORD_FILE>
提权密码文件
- --become-user <BECOME_USER>
以该用户身份运行操作（默认为 root）
- --connection-password-file <CONNECTION_PASSWORD_FILE>, --conn-pass-file <CONNECTION_PASSWORD_FILE>
连接密码文件
- --flush-cache
清除清单中每个主机的 fact 缓存
- --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
一步一步执行：在运行每个任务之前进行确认
- --syntax-check
对 playbook 执行语法检查，但不执行它
- --vault-id
要使用的 vault 身份。此参数可以多次指定。
- --vault-password-file, --vault-pass-file
vault 密码文件
- --version
显示程序的版本号、配置文件位置、已配置的模块搜索路径、模块位置、可执行文件位置并退出
- -C, --check
不进行任何更改；而是尝试预测可能发生的某些更改
- -D, --diff
更改（小）文件和模板时，显示这些文件的差异；与 –check 配合使用效果很好
- -J, --ask-vault-password, --ask-vault-pass
询问 vault 密码
- -K, --ask-become-pass
询问提权密码
- -M, --module-path
将冒号分隔的路径(s)添加到模块库的前面（默认为 {{ ANSIBLE_HOME ~ “/plugins/modules:/usr/share/ansible/plugins/modules” }}）。此参数可以多次指定。
- -T <TIMEOUT>, --timeout <TIMEOUT>
覆盖以秒为单位的连接超时（默认取决于连接）
- -b, --become
使用 become 运行操作（不表示提示输入密码）
- -c <CONNECTION>, --connection <CONNECTION>
使用的连接类型（默认值为 ssh）
- -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
使 Ansible 打印更多调试信息。添加多个 -v 将增加详细程度，内置插件当前最多评估到 -vvvvvv。一个合理的开始级别是 -vvv，连接调试可能需要 -vvvv。此参数可以多次指定。
环境变量
可以指定以下环境变量。
ANSIBLE_INVENTORY – 覆盖默认的 Ansible 清单文件
ANSIBLE_LIBRARY – 覆盖默认的 Ansible 模块库路径
ANSIBLE_CONFIG – 覆盖默认的 Ansible 配置文件
在 ansible.cfg 中还有更多可用于大多数选项的环境变量。
文件
/etc/ansible/hosts – 默认清单文件
/etc/ansible/ansible.cfg – 配置文件，如果存在则使用
~/.ansible.cfg – 用户配置文件，如果存在则覆盖默认配置
许可证
Ansible 在 GPLv3+ 许可证的条款下发布。
另请参阅
ansible(1), ansible-config(1), ansible-console(1), ansible-doc(1), ansible-galaxy(1), ansible-inventory(1), ansible-pull(1), ansible-vault(1)