community.general.apache2_module module – Enables/disables a module of the Apache2 webserver
Note
This module is part of the community.general collection (version 8.6.4).
You might already have this collection installed if you are using the ansible
package.
It is not included in ansible-core
.
To check whether it is installed, run ansible-galaxy collection list
.
To install it, use: ansible-galaxy collection install community.general
.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: community.general.apache2_module
.
Synopsis
Enables or disables a specified module of the Apache2 webserver.
Aliases: web_infrastructure.apache2_module
Requirements
The below requirements are needed on the host that executes this module.
a2enmod
a2dismod
Parameters
Parameter |
Comments |
---|---|
Force disabling of default modules and override Debian warnings. Choices:
|
|
Identifier of the module as listed by |
|
Ignore configuration checks about inconsistent module configuration. Especially for mpm_* modules. Choices:
|
|
Name of the module to enable/disable as given to |
|
Desired state of the module. Choices:
|
|
Control the behavior of the warning process for MPM modules. Choices:
|
Attributes
Attribute |
Support |
Description |
---|---|---|
Support: full |
Can run in |
|
Support: none |
Will return details on what has changed (or possibly needs changing in |
Notes
Note
This does not work on RedHat-based distributions. It does work on Debian- and SuSE-based distributions. Whether it works on others depend on whether the
a2enmod
anda2dismod
tools are available or not.
Examples
- name: Enable the Apache2 module wsgi
community.general.apache2_module:
state: present
name: wsgi
- name: Disables the Apache2 module wsgi
community.general.apache2_module:
state: absent
name: wsgi
- name: Disable default modules for Debian
community.general.apache2_module:
state: absent
name: autoindex
force: true
- name: Disable mpm_worker and ignore warnings about missing mpm module
community.general.apache2_module:
state: absent
name: mpm_worker
ignore_configcheck: true
- name: Disable mpm_event, enable mpm_prefork and ignore warnings about missing mpm module
community.general.apache2_module:
name: "{{ item.module }}"
state: "{{ item.state }}"
warn_mpm_absent: false
ignore_configcheck: true
loop:
- module: mpm_event
state: absent
- module: mpm_prefork
state: present
- name: Enable dump_io module, which is identified as dumpio_module inside apache2
community.general.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 |
Description |
---|---|
return code of underlying command Returned: failed |
|
message about action taken Returned: always |
|
stderr of underlying command Returned: failed |
|
stdout of underlying command Returned: failed |
|
list of warning messages Returned: when needed |