Ansible Academy · Lesson

AnsibleModule & Argument Spec

Define and validate module inputs.

Meet AnsibleModule

The AnsibleModule class is your toolkit. It parses the arguments Ansible sends, validates them, and gives you helpers to return results.

from ansible.module_utils.basic import AnsibleModule

You describe every input your module accepts in an argument_spec dictionary. Ansible reads it to validate what users pass in.

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