1.  
  2. 主页
  3.  / 
  4. Ansible 教程
  5.  / 
  6. Ansible 相关工具
  7.  / 
  8. ansible-doc

ansible-doc

ansible-doc,这个命令主要作用是显示模块的帮助信息,有点类似Linux里的man命令。

命令格式

usage: ansible-doc [-h] [--version] [-v] [-M MODULE_PATH]
                   [--playbook-dir BASEDIR]
                   [-t {become,cache,callback,cliconf,connection,httpapi,inventory,lookup,netconf,shell,module,strategy,vars}]
                   [-j] [-F | -l | -s | --metadata-dump]
                   [plugin [plugin ...]]

参数详解

--metadata-dump    # 对于内部测试,仅转储所有插件的json元数据
--playbook-dir <BASEDIR>    # 因为这个工具不使用playbook,所以用它来替代playbook目录,它为许多功能设置了相对路径,包括角色/group_vars/等
--version    # 显示程序的版本号,配置文件位置,配置的模块搜索路径,模块位置,可执行文件位置
-F, --list_files    # 显示没有摘要的插件名称及其源文件
-M MODULE_PATH, --module-path    # 为模块库添加以冒号分隔的路径(默认=~/.ansible/plugins/modules:/usr/share/ansible/plugins/modules)
-j, --json    # 将输出改为json格式
-l, --list    # 列出可用的插件
-s, --snippet    # 显示指定插件的剧本片段,也可以称之为模块简化的帮助信息
-t <TYPE>, --type <TYPE>    # 选择哪种插件类型(默认为“模块”)。可用的插件类型包括:('become','cache','callback','cliconf','connection','httpapi','inventory','lookup','netconf','shell','vars, '模块','策略')
-v, --verbose    # 输出更详细的帮助信息,verbose模式(-vvvv表示更多,-vvvv表示启用连接调试)
-h, --help    # 显示帮助信息

演示

[root@lanyulei-1 ~]# ansible-doc -s ping
- name: Try to connect to host, verify a usable python and return `pong' on success
  ping:
      data:                  # Data to return for the `ping' return value. If this parameter is set to `crash', the module will cause an exception.

这篇文章对您有用吗?

我们要如何帮助您?

发表评论

您的电子邮箱地址不会被公开。