Ansible自定义模块报错：不支持param3参数，求排查方案

嘿，我来帮你梳理下这个问题的排查方向——你明明在模块里定义了param3，但Ansible却不认，这种情况大概率是模块加载或配置的细节出了问题，咱们一步步来：

1. 先确认Ansible加载的是不是你修改的模块版本 #

这是最常见的坑！Ansible查找模块有优先级顺序，很可能你修改的custom_module.py根本没被加载，而是用了旧版本的模块：

• 先核对模块文件名和剧本里用的模块名：Ansible模块名就是文件名（不带.py后缀）。比如你的模块文件是custom_module.py，那剧本里应该写custom_module:，而不是ansiblecustommodulename:！如果这里对不上，Ansible会去加载系统里或其他路径下的同名旧模块，自然找不到你加的param3。
• 用ansible-doc ansiblecustommodulename命令查看模块文档（自定义模块能查到就说明已加载），看看文档里有没有param3这个参数。如果没有，说明加载的是旧模块。
• 执行剧本时加-vvv（ verbose模式），看输出里的模块路径，确认是不是你修改的那个文件。

2. 检查模块代码的语法和导入是否正确 #

有时候模块代码的小错误，会导致argument_spec没被正确解析：

• 直接用Ansible使用的Python版本运行模块文件：python custom_module.py，看看有没有语法报错。比如少了逗号、括号不匹配，都会导致模块加载失败。
• 确认开头的导入语句正确：from ansible.module_utils.basic import AnsibleModule，如果导入错了，AnsibleModule的参数定义根本不会生效。

3. 修正参数定义的不规范写法 #

你写的'param1': {'required': None}不太规范，required应该是布尔值（True/False），虽然Ansible可能兼容，但这种写法可能导致参数解析异常。建议改成：

'param1': {'required': False},

同时检查argument_spec的大括号、逗号有没有写错，比如最后一个键值对后面的逗号（Python允许，但某些旧版本可能有问题）。

4. 清除Ansible缓存 #

Ansible会缓存模块的元数据，有时候你修改了模块，缓存的旧数据还在生效：

• 删除~/.ansible/cache目录下的缓存文件
• 或者执行剧本时加上--no-cache参数，强制不使用缓存

5. 手动验证模块的参数接收情况 #

虽然你用p task_vars看到了param3的值，但可以在模块里加个调试输出，看看模块实际接收到的参数是什么：

def main():
    module = AnsibleModule(
        argument_spec={
            'param1': {'required': False},
            'param2': {'default': None},
            'param3': {'default': None},
            'action': {'required': True, 'choices': [ 'service.scale', ]}
        }
    )
    print(module.params)  # 加这行调试代码
    # 其他业务逻辑代码

然后手动运行模块测试：python custom_module.py '{"action": "service.scale", "param1": "ec2", "param2": "default", "param3": "3"}'，看看输出里有没有param3，如果没有，说明模块本身的参数定义有问题。

结合你的情况，模块文件名和剧本中使用的模块名不一致是最可能的根因。比如你模块文件叫custom_module.py，但剧本里写了ansiblecustommodulename:，这时候Ansible加载的是其他地方的旧模块，自然识别不了你加的param3。

内容的提问来源于stack exchange，提问作者lsambo