运行Ansible PlayBooks,在目标主机上执行定义的任务。
语法
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-pass | --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 PlayBooks的工具,它是配置和多节点部署系统。有关更多信息,请参阅项目主页(https://docs.ansible.com)。
常用选项
--ask-vault-pass
要求vault密码
--become-method
<BECOME_METHOD>
使用权限升级方法(默认=%(default)s),请使用Ansible-Doc -T become -L以列出有效的选择。
--become-user
<BECOME_USER>
以此用户身份运行操作(默认=root)
--flush-cache
清除库存中每个主机的事实缓存
--force-handlers
即使任务发生故障,依然运行处理程序
--list-hosts
输出匹配主机列表;不执行任何其他操作
--list-tags
列出所有可用的tag
--list-tasks
列出所有即将被执行的task
--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
只运行play和task的标记与这些值不匹配
--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
对剧本执行语法检查,但不执行它
--vault-id
设置使用的vault标识
--vault-password-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>
指定要使用的并行进程数 (default=5)
-h
,
--help
显示此帮助消息并退出
-i
,
--inventory
,
--inventory-file
指定库存主机路径或逗号分隔的主机列表。 –inventory-file 已弃用
-k
,
--ask-pass
要求连接密码
-l
<SUBSET>
,
--limit
<SUBSET>
进一步将选定的主机限制为其他模式
-t
,
--tags
只运行标记这些值的播放和任务
-u
<REMOTE_USER>
,
--user
<REMOTE_USER>
以此用户连接 (default=None)
-v
,
--verbose
详细模式 (-vvv 更详细, -vvvv 启用连接调试)
环境
可以指定以下环境变量。
ANSIBLE_CONFIG
– 覆盖默认的 ansible 配置文件
ansible.cfg 中的大多数选项还有更多可用选项
文件
/etc/ansible/ansible.cfg
– 配置文件,如果存在则使用
~/.ansible.cfg
– 用户配置文件,如果存在则覆盖默认配置
作者
Ansible 最初由 Michael DeHaan 编写。
有关贡献者的完整列表,请参阅 AUTHORS 文件。
License
Ansible 是根据 GPLv3+ 许可条款发布的。