ansible-collections/community.general
1
0
Fork 0
mirror of https://github.com/ansible-collections/community.general.git synced 2025-04-25 03:41:25 -07:00
Code Issues Projects Releases Packages Wiki Activity Actions 9

clarified docs on timezone module

Browse source
This commit is contained in:
Brian Coca 2017-01-16 11:05:36 -05:00
parent c129fd7c81
commit 32b7f85f6c
1 changed files with 7 additions and 11 deletions
Download patch file Download diff file Expand all files Collapse all files

18
lib/ansible/modules/system/timezone.py
View file

@ -37,17 +37,11 @@ DOCUMENTATION = '''
module: timezone module: timezone
short_description: Configure timezone setting short_description: Configure timezone setting
description: description:
- This module configures the timezone setting, both of the system clock - This module configures the timezone setting, both of the system clock and of the hardware clock. If you want to set up the NTP, use M(service) module. As of version 2.3 support was added for SmartOS and BSDs.
and of the hardware clock. I(Currently only Linux, FreeBSD, NetBSD, - It is recommended to restart C(crond) after changing the timezone, otherwise the jobs may run at the wrong time.
OpenBSD and SmartOS instances are supported.) - On Linux it uses the C(timedatectl) command if available. Otherwise, it edits C(/etc/sysconfig/clock) or C(/etc/timezone) for the system clock, and uses the C(hwclock) command for the hardware clock.
It is recommended to restart C(crond) after changing the timezone, - On SmartOS the C(sm-set-timezone) utility is used to set the zone timezone.
otherwise the jobs may run at the wrong time. - "On *BSD, C(/etc/localtime) is modified."
On Linux it uses the C(timedatectl) command if available. Otherwise,
it edits C(/etc/sysconfig/clock) or C(/etc/timezone) for the system clock,
and uses the C(hwclock) command for the hardware clock.
On SmartOS the C(sm-set-timezone) utility is used to set the zone timezone,
and on *BSD, C(/etc/localtime) is modified.
If you want to set up the NTP, use M(service) module.
version_added: "2.2" version_added: "2.2"
options: options:
name: name:
@ -66,6 +60,8 @@ options:
I(Only used on Linux.) I(Only used on Linux.)
required: false required: false
aliases: ['rtc'] aliases: ['rtc']
notes:
- On SmartOS the C(sm-set-timezone) utility (part of the smtools package) is required to set the zone timezone
author: author:
- "Shinichi TAMURA (@tmshn)" - "Shinichi TAMURA (@tmshn)"
- "Jasper Lievisse Adriaanse (@jasperla)" - "Jasper Lievisse Adriaanse (@jasperla)"