ansible-console

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

概要 

usage: ansible-console [-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]
                    [--flush-cache] [--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] [-D] [--vault-id VAULT_IDS]
                    [-J | --vault-password-file VAULT_PASSWORD_FILES]
                    [-f FORKS] [-M MODULE_PATH] [--playbook-dir BASEDIR]
                    [-e EXTRA_VARS] [--task-timeout TASK_TIMEOUT] [--step]
                    [pattern]

描述 

一个REPL，允许在一个带有内置制表符自动完成的友好shell中，针对选择的清单运行ad-hoc任务（基于dominis的ansible-shell）。

它支持多个命令，并且您可以在运行时修改其配置。

cd [pattern]：更改主机/组（您可以使用主机模式，例如：app*.dc*:!app01*）
list：列出当前路径中可用的主机。
list groups：列出当前路径中包含的组。
become：切换become标志。
!：强制使用shell模块而不是ansible模块（!yum update -y）
verbosity [num]：设置详细程度级别。
forks [num]：设置并发进程数。
become_user [user]：设置become用户。
remote_user [user]：设置远程用户。
become_method [method]：设置权限提升方法。
check [bool]：切换检查模式。
diff [bool]：切换差异模式。
timeout [integer]：设置任务超时时间（秒）（设置为0则禁用）。
help [command/module]：显示命令或模块的文档。
exit：退出ansible-console。

常用选项 

--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>: 连接密码文件

--flush-cache: 清除清单中每个主机的fact缓存。

--list-hosts: 输出匹配主机列表；不执行其他任何操作。

--playbook-dir <BASEDIR>: 由于此工具不使用playbook，因此将其用作替代playbook目录。这为许多功能设置了相对路径，包括角色/组变量/等等。

--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: 一步一步执行：在运行每个任务之前进行确认。

--task-timeout <TASK_TIMEOUT>: 设置任务超时限制（秒），必须是正整数。

--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: 在模块库路径前添加以冒号分隔的路径 (默认值={{ ANSIBLE_HOME ~ “/plugins/modules:/usr/share/ansible/plugins/modules” }})。此参数可以多次指定。

-T <TIMEOUT>, --timeout <TIMEOUT>: 覆盖连接超时时间（秒）（默认值取决于连接类型）

-b, --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>: 进一步将选定的主机限制到附加模式

-u <REMOTE_USER>, --user <REMOTE_USER>: 以该用户身份连接 (默认值=无)

-v, --verbose: 使 Ansible 打印更多调试信息。添加多个 -v 将增加详细程度，内置插件当前最多评估到 -vvvvvv。一个合理的起始级别是 -vvv，连接调试可能需要 -vvvv。此参数可以多次指定。

参数 

host-pattern: 清单中的组名称，用于选择清单中主机的类似 shell 的通配符，或者两者以逗号分隔的任意组合。

环境变量 

可以指定以下环境变量。

ANSIBLE_INVENTORY – 覆盖默认的 Ansible 清单文件

ANSIBLE_LIBRARY – 覆盖默认的 Ansible 模块库路径

ANSIBLE_CONFIG – 覆盖默认的 Ansible 配置文件

ansible.cfg 中还有更多选项可用。

文件 

/etc/ansible/hosts – 默认清单文件

/etc/ansible/ansible.cfg – 配置文件，如果存在则使用

~/.ansible.cfg – 用户配置文件，如果存在则覆盖默认配置

作者 

Ansible 最初由 Michael DeHaan 编写。

请参阅 AUTHORS 文件以获取完整的贡献者列表。

许可证 

Ansible 按照 GPLv3+ 许可证的条款发布。

另见 

ansible(1), ansible-config(1), ansible-doc(1), ansible-galaxy(1), ansible-inventory(1), ansible-playbook(1), ansible-pull(1), ansible-vault(1)