community.windows.win_region (2.2.0) — module

Install collection

Install with ansible-galaxy collection install community.windows:==2.2.0

Add to requirements.yml

  collections:
    - name: community.windows
      version: 2.2.0

Description

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.

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Set the region format to English United States
  community.windows.win_region:
    format: en-US

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Set the region format to English Australia and copy settings to new profiles
  community.windows.win_region:
    format: en-AU
    copy_settings: yes

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Set the location to United States
  community.windows.win_region:
    location: 244

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

# Reboot when region settings change
- name: Set the unicode language to English Great Britain, reboot if required
  community.windows.win_region:
    unicode_language: en-GB
  register: result

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- ansible.windows.win_reboot:
  when: result.restart_required

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

# Reboot when format, location or unicode has changed
- name: Set format, location and unicode to English Australia and copy settings, reboot if required
  community.windows.win_region:
    location: 12
    format: en-AU
    unicode_language: en-AU
  register: result

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- ansible.windows.win_reboot:
  when: result.restart_required

Inputs

    
format:
    description:
    - The language format to set for the current user, see U(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 C(location) or C(unicode_language) is not set.
    type: str

location:
    description:
    - The location to set for the current user, see U(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 C(format) or C(unicode_language) is not set.
    type: str

copy_settings:
    default: false
    description:
    - This will copy the current format and location values to new user profiles and the
      welcome screen. This will only run if C(location), C(format) or C(unicode_language)
      has resulted in a change. If this process runs then it will always result in a change.
    type: bool

unicode_language:
    description:
    - The unicode language format to set for all users, see U(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 C(location) or C(format) is not set. After setting this
      value a reboot is required for it to take effect.
    type: str

Outputs

restart_required:
  description: Whether a reboot is required for the change to take effect.
  returned: success
  sample: true
  type: bool

See also

• community.windows.win_timezone