ansible-doc

插件文档工具，plugin documentation tool。

简介

usage: ansible-doc [-h] [--version] [-v] [-M MODULE_PATH]
                [--playbook-dir BASEDIR]
                [-t {become,cache,callback,cliconf,connection,httpapi,inventory,lookup,netconf,shell,vars,module,strategy,test,filter,role,keyword}]
                [-j] [-r ROLES_PATH]
                [-e ENTRY_POINT | -s | -F | -l | --metadata-dump]
                [--no-fail-on-errors]
                [plugin ...]

描述

显示安装在 Ansible 库中的模组信息。他会显示一个插件的简短列表，及这些插件的简短描述，提供这些插件 DOCUMENTATION 字符串的打印输出，还能创建可被粘贴到某个 playbook 的一个简短 “片段”。

常用选项

• --metadata-dump，仅供内部使用 转储所有条目的 JSON 元数据，而忽略其他选项；
• --no-fail-on-errors，仅供内部使用 仅用于 --metadata-dump. 不因出错而运行失败。而是在 JSON 中报告错误信息；
• --playbook-dir <BASEDIR>，由于该工具不使用 playbook，因此可将其用作替代的 playbook 目录。这将为许多功能设置相对路径，包括 roles/、group_vars/ 等；
• --version，显示程序的版本号、配置文件位置、所配置的模组搜索路径、模组位置、可执行文件位置并退出；
• -F, --list_files，显示插件名称及各自的源文件，不带摘要（表示 -list）。提供的参数将用于筛选，可以是命名空间，或完整的集合名称；
• -M, --module-path，添加以冒号分隔的路径，作为模组库（default={{ ANSIBLE_HOME ~ "/plugins/modules:/usr/share/ansible/plugins/modules" }}）。此参数可指定多次；
• -e <ENTRY_POINT>, --entry-point <ENTRY_POINT>，选取角色，roles，的入口点。
• -h, --help，打印此帮助消息并退出；
• -j, --json，修改输出为 JSON 格式；
• -l, --list，列出可用的插件。提供的参数将用于筛选，可以是命名空间，或完整集合名称；
• -r, --roles-path，包含角色的目录路径。此参数可指定多次；
• -s, --snippet，显示这些插件类型：inventory、lookup、module，的 playbook 代码片段；
• -t <TYPE>, --type <TYPE>，选择插件类型（默认为 module）。可用的插件类型有：('become', 'cache', 'callback', 'cliconf', 'connection', 'httpapi', 'inventory', 'lookup', 'netconf', 'shell', 'vars', 'module'、'strategy'、'test'、'filter'、'role'、'keyword')；
• -v, --verbose，会导致 Ansible 打印更多调试信息。添加多个 -v 会增加调试信息的冗余度，内置插件目前最多会评估到 -vvvvv。 开始时的合理级别是 -vvv，连接的调试则可能需要 -vvvv。可以多次指定此参数；

环境

可以指定以下环境变量。

• ANSIBLE_LIBRARY - 覆盖默认的 ansible 模组库路径；
• ANSIBLE_CONFIG - 覆盖默认的 ansible 配置文件。

ansible.cfg 中的大多数选项，都有更多可用选项。

文件

• /etc/ansible/ansible.cfg - 若存在，就会用到的配置文件；
• ~/.ansible.cfg - 用户配置文件，会覆盖存在的默认配置。

（End）

（End）