网站优化培训学校,专做老酒的网站,赣州网站建设开发,高清有线电视沈阳目录
常用参数
基本用法
查看指定模块的文档
列出所有可用模块
搜索模块
显示模块参数的简单列表
显示详细的说明和示例
详细示例
查看 file 模块的文档
简略查看 copy 模块的参数 ansible-doc 是 Ansible 中的一个非常有用的命令行工具#xff0c;它可以帮助你查找…目录
常用参数
基本用法
查看指定模块的文档
列出所有可用模块
搜索模块
显示模块参数的简单列表
显示详细的说明和示例
详细示例
查看 file 模块的文档
简略查看 copy 模块的参数 ansible-doc 是 Ansible 中的一个非常有用的命令行工具它可以帮助你查找和显示Ansible模块的文档信息。通过这个命令你能快速了解每个模块的功能、参数和使用示例。
常用参数 -l, --list: 描述列出所有可用的模块。示例ansible-doc -l -s, --snippet: 描述以 YAML 格式显示模块的示例代码片段。示例ansible-doc -s copy -t, --type: 描述仅显示指定类型的插件如 module, become, cache, callback 等。示例ansible-doc -t module -l -j, --json: 描述以 JSON 格式输出模块文档。示例ansible-doc -j copy -M, --module-path: 描述指定模块库的路径可指定多个路径用冒号分隔。示例ansible-doc -M /path/to/library -v, --verbose: 描述详细模式显示更多调试信息。示例ansible-doc -v copy -h, --help: 描述显示帮助信息并退出。示例ansible-doc -h 基本用法 查看指定模块的文档
ansible-doc module_name例如查看shell模块的文档
ansible-doc shell列出所有可用模块
ansible-doc -l此命令会列出所有可用的模块供你使用。 搜索模块
可以通过关键词搜索模块
ansible-doc -s keyword例如搜索和文件相关的模块
ansible-doc -s file显示模块参数的简单列表
ansible-doc -s module_name例如查看copy模块的参数
ansible-doc -s copy显示详细的说明和示例 除了上述的基础用法还可以查看每个模块的详细说明和示例这是通过默认显示的只需不带任何参数即可
ansible-doc module_name详细示例 查看 file 模块的文档
ansible-doc file会看到类似以下的输出 FILE (/usr/lib/python3.8/site-packages/ansible/modules/files/file.py)The file module manages file and directory properties. Tests andlogs output similarly to how ls would list a file, meaning itis one of the most commonly used modules.Options ( is mandatory):- attributes(added in 2.6)Change the attributes of a file, i.e. i, a, e. See man chattr.This requires the root user in most environments.aliases: attr- pathPath to the file being managed. This is required when adding, updating, or deleting a file or directory.type: str | required- stateIf the path exists, this will change the state of the file. States can be file, link, absent or directory.If set to absent, the file or directory or all children/specifical contents will be removed.If set to directory, an empty directory will be created.... (更多输出)简略查看 copy 模块的参数
ansible-doc -s copy会看到类似以下的输出
COPY (/usr/lib/python3.8/site-packages/ansible/modules/files/copy.py)The copy module copies a file from the local or remote machine toa location on the remote machine. If you need variable interpolationin copied files, use the template module. Consider using the unarchivemodule instead if you need to unpack the archive after downloading.OPTIONS ( is mandatory):
- backupThis boolean option controls the creation of a backup file with the timestamp before overwriting the file.type: booldefault: no- contentWhen used instead of src, sets the contents of a file directly to the specified value. This is for simple values primarily.... (更多输出)
