`ansible-console`

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

译注：REPL console，其中 REPL 指 read, evaluate, print, loop，读取-求值-打印-循环，故 REPL console 指的是交互式控制台。

简介

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]
                    [--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（基于 dominis 的 ansible-shell），运行针对所选仓库的临时任务，该 shell 具有内置的制表符补全功能。

他支持多种命令，并可在运行时修改配置：

cd [pattern]：改变主机/组别（咱们可以运用主机模式，比如 app*.dc*:!app01*）；
list：列出当前路径下的可用主机；
list groups：列出当前路径下所包含的组别；
become：打开 become 命令行开关；
!：强制从 ansible 模组进入 shell 模组（!yum update -y）；
verbosity [num]：设置详细级别；
forks [num]：设置进程分叉数目；
become_user [user]：设置 become_user；
remote_user [user]：设置 remote_user；
become_method [method]：设置权限升级方式；
check [bool]：打开检查模式；
diff [bool]：打开 diff 模式；
timeout [integer]：设置任务超时（秒，0 关闭超时）；
help [command/module]：显示命令或模组的帮助信息；
exit：退出 ansible-console。

常用选项

--become-method <BECOME_METHOD>，权限提升方式（default=sudo），使用 ansible-doc -t become -l 列出有效选项；
--become-password-file <BECOME_PASSWORD_FILE>, --become-pass-file <BECOME_PASSWORD_FILE>，become 的口令文件；
--become-user <BECOME_USER>，以该用户身份运行操作（default=root）；
--connection-password-file <CONNECTION_PASSWORD_FILE>, --conn-pass-file <CONNECTION_PASSWORD_FILE>，连接的口令文件；
--list-hosts，输出匹配主机的列表；不执行任何其他操作；
--playbook-dir <BASEDIR>，由于该工具不使用 playbook，因此可将其用作替代的 playbook 目录。这将为许多功能设置相对路径，包括 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，一次运行一步：每项运行前要进行确认；
--task-timeout <TASK_TIMEOUT>，设置任务超时限制（秒），必须为正整数；
--vault-id，要使用的保险库标识。该参数可指定多次；
--vault-password-file, --vault-pass-file，保险库口令文件；
--version，显示程序的版本号、配置文件位置、所配置的模组搜索路径、模组位置、可执行文件位置并退出；
-C, --check，不做任何改变，而是尝试预测可能发生的一些变化；
-D, --diff，更改（小）文件和模板时，显示这些文件的差异；与 --check 一起使用效果极佳；
-J, --ask-vault-password, --ask-vault-pass，询问保险库口令；
-K, --ask-become-pass，询问权限提升口令；
-M, --module-path，添加以冒号分隔的路径，作为模组库（default={{ ANSIBLE_HOME ~ "/plugins/modules:/usr/share/ansible/plugins/modules" }}）。此参数可指定多次；
-b, --become，以 become 运行操作（并不意味着密码提示符）；
-c <CONNECTION>, --connection <CONNECTION>，要使用的连接类型（default=ssh）；
-e, --extra-vars，以 key=value 方式，或文件名前添加了 @ 的 YAML/JSON 方式，设置一些额外变量。此参数可指定多次；
-f <FORKS>, --forks <FORKS>，指定要使用的并行进程数（default=5）；
-h, --help，打印此帮助消息并退出；
-i, --inventory，指定仓库主机路径，或逗号分隔的主机列表。--inventory-file 选项已被弃用。该参数可指定多次；
-k, --ask-pass，询问连接口令；
-l <SUBSET>, --limit <SUBSET>，将选定主机进一步限制为额外模式；
-u <REMOTE_USER>, --user <REMOTE_USER>，以该用户身份连接（default=None）；
-v, --verbose，会导致 Ansible 打印更多调试信息。添加多个 -v 会增加调试信息的冗余度，内置插件目前最多会评估到 -vvvvv。开始时的合理级别是 -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 - 用户配置文件，会覆盖存在的默认配置。

（End）

又一本 Ansible 教程

ansible-console

简介

描述

常用选项

命令行参数

环境

文件

`ansible-console`