W3cubDocs

/Ansible

community.windows.win_timezone – Sets Windows machine timezone

Note

This plugin is part of the community.windows collection (version 1.7.0).

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.windows.

To use it in a playbook, specify: community.windows.win_timezone.

Synopsis
Parameters
Notes
See Also
Examples
Return Values

Synopsis

Sets machine time to the specified timezone.

Parameters

Parameter	Choices/Defaults	Comments
timezone string / required		Timezone to set to. Example: Central Standard Time To disable Daylight Saving time, add the suffix `_dstoff` on timezones that support this.

Notes

Note

The module will check if the provided timezone is supported on the machine.
A list of possible timezones is available from tzutil.exe /l and from https://msdn.microsoft.com/en-us/library/ms912391.aspx
If running on Server 2008 the hotfix https://support.microsoft.com/en-us/help/2556308/tzutil-command-line-tool-is-added-to-windows-vista-and-to-windows-server-2008 needs to be installed to be able to run this module.

Examples

- name: Set timezone to 'Romance Standard Time' (GMT+01:00)
  community.windows.win_timezone:
    timezone: Romance Standard Time

- name: Set timezone to 'GMT Standard Time' (GMT)
  community.windows.win_timezone:
    timezone: GMT Standard Time

- name: Set timezone to 'Central Standard Time' (GMT-06:00)
  community.windows.win_timezone:
    timezone: Central Standard Time

- name: Set timezime to Pacific Standard time and disable Daylight Saving time adjustments
  community.windows.win_timezone:
    timezone: Pacific Standard Time_dstoff

Return Values

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

Key	Returned	Description
previous_timezone string	success	The previous timezone if it was changed, otherwise the existing timezone. Sample: Central Standard Time
timezone string	success	The current timezone (possibly changed). Sample: Central Standard Time

Authors

Phil Schwartz (@schwartzmx)

© 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/windows/win_timezone_module.html