使用 ansible-doc 阅读文档
从 CLI 了解模块选项
使用 ansible-doc 阅读文档 是 CoddyKit 上的免费 DevOps Bootcamp 课时。 这是第 4 节课，共 4 节。 你可以在下方免费阅读本课时的完整内容 — 然后在浏览器中使用内置代码编辑器和全天候 AI 导师进行实践。 这是 DevOps Bootcamp 学习路径的一部分，你的进度在网页和 CoddyKit 应用中同步。 DevOps Bootcamp 课程共包含 4 节课。
文档就在终端中
ansible-doc 命令会直接在 shell 中显示完整的模块文档，因此您无需离开终端即可查阅信息。
查询一个模块
传入模块名称即可阅读其文档：包括每个选项、选项类型以及是否为必需项。这是学习模块最快的方法。
ansible-doc ansible.builtin.copy阅读选项部分
输出会列出每个选项的说明、默认值和可选值。这能准确告诉您模块接受哪些键。
直接跳转到示例
添加 -s，即可打印一段可以直接复制的模块参数片段。它是创建新任务的理想起点。
ansible-doc -s ansible.builtin.systemd列出所有模块
使用 -l 运行命令，即可列出所有已安装模块及其单行摘要。通过 grep 过滤结果，就能找到所需内容。
ansible-doc -l按关键词搜索
不确定名称吗？请列出模块并按主题筛选。搜索 service 可以快速找到相关的模块。
ansible-doc -l | grep service文档与您的版本匹配
由于 ansible-doc 读取本地安装的模块，文档始终与您的确切版本匹配，不必担心在线页面过时。
查看返回值
文档还会说明模块返回的内容，例如 changed 或 stdout。当您注册结果以便稍后使用时，这些信息会很有帮助。
也可浏览插件
使用 -t 可以阅读其他插件类型的文档，而不仅是模块。例如，您可以用同样的方式查询查找插件或过滤器插件。
ansible-doc -t lookup file查找模块元数据
文档标题会显示模块所属的集合及其简短用途，因此您可以在编写任务前了解它的完全限定名称。
养成习惯
在猜测参数之前，先检查 ansible-doc。十秒钟的查询可以避免一次失败的运行和一条令人困惑的错误消息。
快速检查
您想要的是模块参数的快速复制粘贴片段，而不是完整手册。
回顾
ansible-doc 会将与版本匹配的文档带到您的终端：查询模块，使用 -s 获取片段，使用 -l 列出并搜索模块。📚
常见问题解答
「使用 ansible-doc 阅读文档」课时是免费的吗？
是的 — 「使用 ansible-doc 阅读文档」的完整文本可在网页上免费阅读。要进行交互式练习（内置代码编辑器和全天候 AI 导师）并解锁 DevOps Bootcamp 课程的其余内容，请升级到 CoddyKit PRO。 DevOps Bootcamp 课程共包含 4 节课。
「使用 ansible-doc 阅读文档」这节课中我会学到什么？
从 CLI 了解模块选项 你通过在浏览器中直接运行的动手代码来练习 DevOps Bootcamp，全天候 AI 导师会在你学习这节课的过程中回答你的问题。
学习 DevOps Bootcamp 需要有经验吗？
无需任何先前经验。CoddyKit 上的 DevOps Bootcamp 课程适合初学者到高级学习者，你可以从这里开始或从头开始，按照自己的节奏学习。 这是第 4 节课，共 4 节。
「使用 ansible-doc 阅读文档」课时需要多长时间？
大多数 CoddyKit 课程大约需要 5–10 分钟。每节课都很精短且互动，所以你能稳步进步，并在网页和应用中从离开的地方继续。
我能在这节 DevOps Bootcamp 课中编写并运行代码吗？
能。每节 DevOps Bootcamp 课都包含内置代码编辑器，你可以在浏览器中直接编写并运行真实代码，并获得即时 AI 反馈 — 无需本地设置。
此课程中的所有课时
- 模块究竟是什么
- 使用 package 模块安装包
- 使用 systemd 管理服务
- 使用 ansible-doc 阅读文档