ansible-doc
插件文档工具
概要
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
将冒号分隔的路径预先添加到模块库（默认值为{{ ANSIBLE_HOME ~ “/plugins/modules:/usr/share/ansible/plugins/modules” }}）。此参数可以多次指定。
- -e <ENTRY_POINT>, --entry-point <ENTRY_POINT>
选择角色的入口点。
- -h, --help
显示此帮助消息并退出
- -j, --json
将输出更改为 JSON 格式。
- -l, --list
列出可用的插件。提供的参数将用于过滤，可以是命名空间或完整集合名称。
- -r, --roles-path
包含角色的目录的路径。此参数可以多次指定。
- -s, --snippet
显示这些插件类型的 playbook 代码片段：清单、查找、模块
- -t <TYPE>, --type <TYPE>
选择插件类型（默认为“模块”）。可用的插件类型为：（‘become’，‘cache’，‘callback’，‘cliconf’，‘connection’，‘httpapi’，‘inventory’，‘lookup’，‘netconf’，‘shell’，‘vars’，‘module’，‘strategy’，‘test’，‘filter’，‘role’，‘keyword’）
- -v, --verbose
导致 Ansible 打印更多调试消息。添加多个 -v 将增加详细程度，内置插件当前评估最多 -vvvvvv。一个合理的起始级别是 -vvv，连接调试可能需要 -vvvv。此参数可以多次指定。
环境
可以指定以下环境变量。
ANSIBLE_LIBRARY – 覆盖默认的 Ansible 模块库路径
ANSIBLE_CONFIG – 覆盖默认的 Ansible 配置文件
ansible.cfg 中的大多数选项都提供了更多可用选项。
文件
/etc/ansible/ansible.cfg – 配置文件，如果存在则使用
~/.ansible.cfg – 用户配置文件，如果存在则覆盖默认配置
许可证
Ansible 在 GPLv3+ 许可证的条款下发布。
参见
ansible(1), ansible-config(1), ansible-console(1), ansible-galaxy(1), ansible-inventory(1), ansible-playbook(1), ansible-pull(1), ansible-vault(1)