使用AnsibleModule()创建自定义Ansible模块的步骤解析

创建自定义 Ansible 模块可以帮助我们使用 Ansible 实现更多自动化任务。下面是使用 AnsibleModule() 创建自定义 Ansible 模块的步骤解析，并附带一个示例。

步骤1：导入所需的模块

from ansible.module_utils.basic import AnsibleModule

步骤2：定义模块参数

使用 Argspec 类定义模块所需的参数，包括参数名称、参数类型、默认值等。

module_args = dict(
    name=dict(type='str', required=True),
    state=dict(type='str', required=False, default='present'),
    age=dict(type='int', required=False),
)

步骤3：编写模块代码

def main():

    # 创建 Ansible 模块对象
    module = AnsibleModule(
        argument_spec=module_args,
        supports_check_mode=True,
    )

    # 获取传入的参数
    name = module.params['name']
    state = module.params['state']
    age = module.params['age']

    # 检查模块参数状态
    if state == 'present':
        # 实现相应的逻辑
        result = dict(
            changed=True,
            message=f'{name} is created',
        )
        # 如果模块处于 check_mode，则返回结果，不执行任何修改操作
        module.exit_json(**result)

    elif state == 'absent':
        # 实现相应的逻辑
        result = dict(
            changed=True,
            message=f'{name} is deleted',
        )
        module.exit_json(**result)

    else:
        # 处理不支持的状态
        module.fail_json(msg='Unsupported state')

步骤4：执行模块代码

if __name__ == '__main__':
    main()

步骤5：测试模块

可以使用 ansible-playbook 命令测试自定义模块的执行情况，以下是一个测试的示例 playbook。

- name: Test Custom Ansible Module
  hosts: localhost
  tasks:
    - name: Create
      custom_module:
        name: test
        state: present
      register: result

    - debug:
        var: result

    - name: Delete
      custom_module:
        name: test
        state: absent

将上述代码保存为 test_module.yml 文件，然后运行下面的命令进行测试：

ansible-playbook test_module.yml

在执行过程中，该自定义模块将输出适当的结果，并根据参数 state 执行相应的操作。

这是一个简单的示例，你可以根据自己的需求扩展模块的功能，并定义更多的参数。通过使用 AnsibleModule()，可以方便地创建自定义的 Ansible 模块，实现更多的自动化任务。