community.general.locale_gen module – Creates or removes locales

Note

This module is part of the community.general collection (version 5.8.3).

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.

Parameters

Parameter

Comments

name

string / required

Name and encoding of the locale, such as “en_GB.UTF-8”.

state

string

Whether the locale shall be present.

Choices:

  • "absent"

  • "present" ← (default)

Examples

- name: Ensure a locale exists
  community.general.locale_gen:
    name: de_CH.UTF-8
    state: present

Authors

  • Augustus Kling (@AugustusKling)