Ansible 故障排除：缺少模块参数

在 Ansible 中，拼写错误或遗漏参数名称会导致“缺少模块参数”的致命错误。这种错误有时很难排查，尤其是当参数名称拼写错误时。通过实际演示，我们可以展示如何找到并解决这种问题。

错误示例

以下是一个会导致“缺少模块参数”错误的 Ansible Playbook 示例：

---
- name: service module demo
  hosts: all
  become: true
  tasks:
    - name: sshd restart
      ansible.builtin.service:
        nme: sshd
        state: restarted
        enabled: true

错误信息

运行上述 Playbook 时，可能会遇到以下错误：

$ ansible-playbook -i demo/inventory troubleshooting/missingparam_error.yml
PLAY [service module demo] **************************************************

TASK [Gathering Facts] **************************************************
ok: [demo.example.com]

TASK [sshd restart] **************************************************
fatal: [demo.example.com]: FAILED! => {"changed": false, "msg": "missing required arguments: name"}

PLAY RECAP *******************************************************************
demo.example.com           : ok=1    changed=0    unreachable=0    failed=1    skipped=0    rescued=0    ignored=0

问题原因

  1. 拼写错误：nme 是一个拼写错误，正确的参数名称是 name。
  2. 缺少必要的参数：ansible.builtin.service 模块需要 name 参数来指定服务名称，但实际代码中使用了错误的参数名称。

修复方法

  1. 修正拼写错误：将 nme 改为正确的参数名称 name。
  2. 验证参数名称：确保所有参数名称正确无误，必要时参考 Ansible 模块的官方文档。

修复后的 Playbook 如下所示：

---
- name: service module demo
  hosts: all
  become: true
  tasks:
    - name: sshd restart
      ansible.builtin.service:
        name: sshd
        state: restarted
        enabled: true

修复步骤

  1. 修正拼写错误：将 nme 改为 name。
  2. 重新运行 Playbook：验证修复是否有效。

验证修复

修复问题后，重新运行 Playbook：

$ ansible-playbook -i demo/inventory troubleshooting/missingparam_fix.yml
PLAY [service module demo] **************************************************

TASK [Gathering Facts] **************************************************
ok: [demo.example.com]

TASK [sshd restart] **************************************************
changed: [demo.example.com]

PLAY RECAP *******************************************************************
demo.example.com           : ok=2    changed=1    unreachable=0    failed=0    skipped=0    rescued=0    ignored=0

总结

Ansible 中的“缺少模块参数”错误通常是由于以下原因导致的：

  1. 拼写错误：参数名称拼写错误。
  2. 遗漏参数：缺少模块所需的必要参数。

通过以下步骤可以有效解决这种错误：

  1. 修正拼写错误：确保所有参数名称正确无误。
  2. 验证参数名称：参考 Ansible 模块的官方文档，确保使用正确的参数名称。
  3. 重新运行 Playbook：验证修复是否有效。

如果问题仍未解决，可以参考 Ansible 的 官方文档或社区支持获取更多帮助。