Docs4dev
Docs
ansible / latest / collections / community / general / locale_gen_module.html

community.general.locale_gen – Creates or removes locales

Note

This plugin is part of the community.general collection (version 3.8.1).

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 Choices/Defaults Comments
name
string / required
Name and encoding of the locale, such as "en_GB.UTF-8".
state
string
    Choices:
  • absent
  • present ←
Whether the locale shall be present.

Examples

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

Authors

  • Augustus Kling (@AugustusKling)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/community/general/locale_gen_module.html