Documentation

locale_gen - Creates or removes locales.

New in version 1.6.

Synopsis

  • Manages locales by editing /etc/locale.gen and invoking locale-gen.

Options

parameter required default choices comments
name
yes
Name and encoding of the locale, such as "en_GB.UTF-8".
state
no present
  • present
  • absent
Whether the locale shall be present.

Examples

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

Status

This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

Support

This module is community maintained without core committer oversight.

For more information on what this means please read Module Support

For help in developing on modules, should you be so inclined, please read Community Information & Contributing, Testing Ansible and Developing Modules.