apache2_module – Enables/disables a module of the Apache2 webserver
Synopsis
- Enables or disables a specified module of the Apache2 webserver.
Requirements
The below requirements are needed on the host that executes this module.
- a2enmod
- a2dismod
Parameters
Parameter | Choices/Defaults | Comments |
---|---|---|
force boolean added in 2.1 |
| Force disabling of default modules and override Debian warnings. |
identifier - added in 2.5 | Identifier of the module as listed by apache2ctl -M . This is optional and usually determined automatically by the common convention of appending _module to name as well as custom exception for popular modules. | |
ignore_configcheck boolean added in 2.3 |
| Ignore configuration checks about inconsistent module configuration. Especially for mpm_* modules. |
name - / required | Name of the module to enable/disable as given to a2enmod/a2dismod . | |
state - |
| Desired state of the module. |
Examples
# enables the Apache2 module "wsgi" - apache2_module: state: present name: wsgi # disables the Apache2 module "wsgi" - apache2_module: state: absent name: wsgi # disable default modules for Debian - apache2_module: state: absent name: autoindex force: True # disable mpm_worker and ignore warnings about missing mpm module - apache2_module: state: absent name: mpm_worker ignore_configcheck: True # enable dump_io module, which is identified as dumpio_module inside apache2 - apache2_module: state: present name: dump_io identifier: dumpio_module
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key | Returned | Description |
---|---|---|
rc integer | failed | return code of underlying command |
result string | always | message about action taken |
stderr string | failed | stderr of underlying command |
stdout string | failed | stdout of underlying command |
warnings list | when needed | list of warning messages |
Status
- This module is not guaranteed to have a backwards compatible interface. [preview]
- This module is maintained by the Ansible Community. [community]
Authors
- Christian Berendt (@berendt)
- Ralf Hertel (@n0trax)
- Robin Roth (@robinro)
Hint
If you notice any issues in this documentation you can edit this document to improve it.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.8/modules/apache2_module_module.html