用于执行 Ansible 任务的 REPL 控制台。

语法

usage: ansible-console [-h] [--version] [-v] [-b]
                    [--become-method BECOME_METHOD]
                    [--become-user BECOME_USER] [-K] [-i INVENTORY]
                    [--list-hosts] [-l SUBSET] [-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] [-C] [--syntax-check]
                    [-D] [--vault-id VAULT_IDS]
                    [--ask-vault-pass | --vault-password-file VAULT_PASSWORD_FILES]
                    [-f FORKS] [-M MODULE_PATH] [--playbook-dir BASEDIR]
                    [--step]
                    [pattern]

说明

一个 REPL，允许针对选定的清单运行临时任务（基于 dominis 的 ansible-shell）。

常见选项

--ask-vault-pass

要求vault密码

--become-method <BECOME_METHOD>

要使用的权限提升方法 (default=%(default)s)，使用 ansible-doc -t become -l 列出有效的选择。

--become-user <BECOME_USER>

以此用户身份运行操作（默认=root）

--list-hosts

输出匹配主机列表；不执行任何其他操作

--playbook-dir <BASEDIR>

由于此工具不使用剧本，因此使用它作为替代剧本目录。这为许多功能设置了相对路径，包括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)

--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)

-f <FORKS>, --forks <FORKS>

指定要使用的并行进程数 (default=5)

-h, --help

显示此帮助消息并退出

-i, --inventory, --inventory-file

指定库存主机路径或逗号分隔的主机列表。 –inventory-file 已弃用

-k, --ask-pass

要求连接密码

-l <SUBSET>, --limit <SUBSET>

进一步将选定的主机限制为其他模式

-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+ 许可条款发布的。