0Pricing
Ansible Academy · 课时

AnsibleModule 与参数规范

定义并验证模块输入

AnsibleModule 与参数规范 是 CoddyKit 上的免费 Ansible Academy 课时。 这是第 2 节课，共 4 节。 你可以在下方免费阅读本课时的完整内容 — 然后在浏览器中使用内置代码编辑器和全天候 AI 导师进行实践。 这是 Ansible Academy 学习路径的一部分，你的进度在网页和 CoddyKit 应用中同步。 Ansible Academy 课程共包含 4 节课。

认识 AnsibleModule

AnsibleModule 类就是您的工具箱。它会解析 Ansible 发送的参数、验证这些参数，并为您提供返回结果的辅助方法。

from ansible.module_utils.basic import AnsibleModule

argument_spec 映射

您需要在 argument_spec 字典中描述模块接受的每个输入。Ansible 会读取它，以验证用户传入的内容。

argument_spec=dict(
  name=dict(type='str', required=True)
)

为每个参数指定类型

设置 type，例如 str、int、bool、list 或 dict。Ansible 会在您的代码运行之前转换类型，并拒绝无效输入。

count=dict(type='int', default=1)

标记必填参数

添加 required=True 后，如果用户忘记该参数，Ansible 会显示清晰的错误并失败。您无需再进行防御性检查。

path=dict(type='str', required=True)

提供合理的默认值

使用 default 让可选参数自动获得一个值。用户只需设置他们想要更改的内容。

state=dict(type='str', default='present')

限制为有效选项

choices 列表会将参数限制为允许的值。其他任何值都会在开始时被拒绝，并显示有帮助的消息。

state=dict(choices=['present', 'absent'])

构建模块对象

将您的规范传入 AnsibleModule 以创建对象。从这里开始，所有输入都会安全地存储在 module.params 中。

module = AnsibleModule(argument_spec=argument_spec)

读取已验证的输入

通过 module.params 这个普通字典访问参数。这些值已经完成类型转换并通过验证，因此直接使用即可。

name = module.params['name']

参数之间的规则

是否需要两个参数同时出现，或者两个参数绝不能同时出现？将 required_together 或 mutually_exclusive 这样的规则传给 AnsibleModule，由它负责强制执行。

mutually_exclusive=[['src', 'content']]

使用 no_log 隐藏机密

使用 no_log=True 标记敏感输入，这样密码就不会出现在 Ansible 日志或详细输出中。

password=dict(type='str', no_log=True)

让规范完成工作

一个设计良好的 argument_spec 可以替代大量手动验证。只需描述一次输入，Ansible 就会自动处理类型、错误和文档，无需额外工作。

快速检查

请想一想，用户输入是如何传递到您的模块代码中的。

回顾

在 argument_spec 中定义输入的类型、默认值、是否必需以及可选值，构建 AnsibleModule，然后从 module.params 中读取经过整理的值。✅

常见问题解答

「AnsibleModule 与参数规范」课时是免费的吗？

是的 — 「AnsibleModule 与参数规范」的完整文本可在网页上免费阅读。要进行交互式练习（内置代码编辑器和全天候 AI 导师）并解锁 Ansible Academy 课程的其余内容，请升级到 CoddyKit PRO。 Ansible Academy 课程共包含 4 节课。

「AnsibleModule 与参数规范」这节课中我会学到什么？

定义并验证模块输入 你通过在浏览器中直接运行的动手代码来练习 Ansible Academy，全天候 AI 导师会在你学习这节课的过程中回答你的问题。

学习 Ansible Academy 需要有经验吗？

无需任何先前经验。CoddyKit 上的 Ansible Academy 课程适合初学者到高级学习者，你可以从这里开始或从头开始，按照自己的节奏学习。 这是第 2 节课，共 4 节。

「AnsibleModule 与参数规范」课时需要多长时间？

大多数 CoddyKit 课程大约需要 5–10 分钟。每节课都很精短且互动，所以你能稳步进步，并在网页和应用中从离开的地方继续。

我能在这节 Ansible Academy 课中编写并运行代码吗？

能。每节 Ansible Academy 课都包含内置代码编辑器，你可以在浏览器中直接编写并运行真实代码，并获得即时 AI 反馈 — 无需本地设置。

此课程中的所有课时

  1. 何时构建自定义模块
  2. AnsibleModule 与参数规范
  3. 返回 JSON 并遵循 changed 约定
  4. 在您的模块中支持 Check Mode
← 返回 Ansible Academy