ansible/docs/docsite/rst/api/index.rst

2 KiB

orphan

Ansible API Documentation

The Ansible API is under construction. These stub references for attributes, classes, functions, methods, and modules will be documented in future. The module utilities <ansible.module_utils> included in ansible.module_utils.basic and AnsibleModule are documented under Reference & Appendices.

Attributes

The parameters accepted by the module.

Deprecated in favor of ansibleModule._selinux_special_fs.

(formerly ansible.module_utils.basic.SELINUX_SPECIAL_FS)

Classes

The basic utilities for AnsibleModule.

The main class for an Ansible module.

Functions

Load parameters.

Methods

Logs the output of Ansible.

Debugs Ansible.

Retrieves the path for executables.

Runs a command within an Ansible module.

Exits and returns a failure.

Exits and returns output.

Modules