docs/docsite/rst/reference_appendices/module_utils.rst
.. _ansible.module_utils: .. _module_utils:
Ansible Reference: Module Utilities
This page documents utilities intended to be helpful when writing Ansible modules in Python.
To use this functionality, include from ansible.module_utils.basic import AnsibleModule in your module.
.. autoclass:: ansible.module_utils.basic.AnsibleModule :members: :noindex:
To use this functionality, include import ansible.module_utils.basic in your module.
.. automodule:: ansible.module_utils.basic :members:
Classes and functions for validating parameters against an argument spec.
.. autoclass:: ansible.module_utils.common.arg_spec.ArgumentSpecValidator :members:
.. autoclass:: ansible.module_utils.common.arg_spec.ValidationResult :members: :member-order: bysource :private-members: _no_log_values # This only works in sphinx >= 3.2. Otherwise it shows all private members with doc strings.
.. automodule:: ansible.module_utils.common.parameters :members:
.. py:data:: DEFAULT_TYPE_VALIDATORS
:class:`dict` of type names, such as ``'str'``, and the default function
used to check that type, :func:`~ansible.module_utils.common.validation.check_type_str` in this case.
Standalone functions for validating various parameter types.
.. automodule:: ansible.module_utils.common.validation :members:
.. automodule:: ansible.module_utils.errors :members: :member-order: bysource