ansible.errors package

exception ansible.errors.AnsibleError(message='', obj=None, show_content=True, suppress_extended_error=False)

Bases: exceptions.Exception

This is the base class for all errors raised from Ansible code, and can be instantiated with two optional parameters beyond the error message to control whether detailed information is displayed when the error occurred while parsing a data file of some kind.

Usage:

raise AnsibleError(‘some message here’, obj=obj, show_content=True)

Where “obj” is some subclass of ansible.parsing.yaml.objects.AnsibleBaseYAMLObject, which should be returned by the DataLoader() class.

exception ansible.errors.AnsibleOptionsError(message='', obj=None, show_content=True, suppress_extended_error=False)

Bases: ansible.errors.AnsibleError

bad or incomplete options passed

exception ansible.errors.AnsibleParserError(message='', obj=None, show_content=True, suppress_extended_error=False)

Bases: ansible.errors.AnsibleError

something was detected early that is wrong about a playbook or data file

exception ansible.errors.AnsibleInternalError(message='', obj=None, show_content=True, suppress_extended_error=False)

Bases: ansible.errors.AnsibleError

internal safeguards tripped, something happened in the code that should never happen

exception ansible.errors.AnsibleRuntimeError(message='', obj=None, show_content=True, suppress_extended_error=False)

Bases: ansible.errors.AnsibleError

ansible had a problem while running a playbook

exception ansible.errors.AnsibleModuleError(message='', obj=None, show_content=True, suppress_extended_error=False)

Bases: ansible.errors.AnsibleRuntimeError

a module failed somehow

exception ansible.errors.AnsibleConnectionFailure(message='', obj=None, show_content=True, suppress_extended_error=False)

Bases: ansible.errors.AnsibleRuntimeError

the transport / connection_plugin had a fatal error

exception ansible.errors.AnsibleFilterError(message='', obj=None, show_content=True, suppress_extended_error=False)

Bases: ansible.errors.AnsibleRuntimeError

a templating failure

exception ansible.errors.AnsibleLookupError(message='', obj=None, show_content=True, suppress_extended_error=False)

Bases: ansible.errors.AnsibleRuntimeError

a lookup failure

exception ansible.errors.AnsibleCallbackError(message='', obj=None, show_content=True, suppress_extended_error=False)

Bases: ansible.errors.AnsibleRuntimeError

a callback failure

exception ansible.errors.AnsibleUndefinedVariable(message='', obj=None, show_content=True, suppress_extended_error=False)

Bases: ansible.errors.AnsibleRuntimeError

a templating failure

exception ansible.errors.AnsibleFileNotFound(message='', obj=None, show_content=True, suppress_extended_error=False)

Bases: ansible.errors.AnsibleRuntimeError

a file missing failure

Submodules

ansible.errors.yaml_strings module