community.general.locale_gen module – Creates or removes locales
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
.
To use it in a playbook, specify: community.general.locale_gen
.
Synopsis
Manages locales by editing /etc/locale.gen and invoking locale-gen.
Aliases: system.locale_gen
Parameters
Parameter |
Comments |
---|---|
Name and encoding of the locale, such as “en_GB.UTF-8”. |
|
Whether the locale shall be present. 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 module does not support RHEL-based systems.
Examples
- name: Ensure a locale exists
community.general.locale_gen:
name: de_CH.UTF-8
state: present