Documentation

win_region - Set the region and format settings

New in version 2.3.

Synopsis

  • Set the location settings of a Windows Server.
  • Set the format settings of a Windows Server.
  • Set the unicode language settings of a Windows Server.
  • Copy across these settings to the default profile.

Options

parameter required default choices comments
copy_settings
no
  • true
  • false
This will copy the current format and location values to new user profiles and the welcome screen. This will only run if location, format or unicode_language has resulted in a change. If this process runs then it will always result in a change.
format
no
The language format to set for the current user, see https://msdn.microsoft.com/en-us/library/system.globalization.cultureinfo.aspx for a list of culture names to use. This needs to be set if location or unicode_language is not set.
location
no
The location to set for the current user, see https://msdn.microsoft.com/en-us/library/dd374073.aspx for a list of GeoIDs you can use and what location it relates to. This needs to be set if format or unicode_language is not set.
unicode_language
no
The unicode language format to set for all users, see https://msdn.microsoft.com/en-us/library/system.globalization.cultureinfo.aspx for a list of culture names to use. This needs to be set if location or format is not set. After setting this value a reboot is required for it to take effect.

Examples

# Set the region format to English United States
- win_region:
    format: en-US

# Set the region format to English Australia and copy settings to new profiles
- win_region:
    format: en-AU
    copy_settings: True

# Set the unicode language to English Great Britain
- win_region:
    unicode_language: en-GB
  register: result

- action: win_reboot
  when: result.restart_required

# Set the location to United States
- win_region:
    location: 244

# Set format, location and unicode to English Australia and copy settings
- win_region:
    location: 12
    format: en-AU
    unicode_language: en-AU
  register: result

- action: win_reboot
  when: result.restart_required

Return Values

Common return values are documented here Return Values, the following are the fields unique to this module:

name description returned type sample
changed Whether anything was changed always boolean True
restart_required Whether a reboot is required for the change to take effect success boolean True


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, Helping Testing PRs and Developing Modules.