From 32b7f85f6c1c1bacc631fd7db7b28b8a3da0b58c Mon Sep 17 00:00:00 2001 From: Brian Coca Date: Mon, 16 Jan 2017 11:05:36 -0500 Subject: [PATCH] clarified docs on timezone module --- lib/ansible/modules/system/timezone.py | 18 +++++++----------- 1 file changed, 7 insertions(+), 11 deletions(-) diff --git a/lib/ansible/modules/system/timezone.py b/lib/ansible/modules/system/timezone.py index c6f0173e72..02e0f7e1dd 100644 --- a/lib/ansible/modules/system/timezone.py +++ b/lib/ansible/modules/system/timezone.py @@ -37,17 +37,11 @@ DOCUMENTATION = ''' module: timezone short_description: Configure timezone setting description: - - This module configures the timezone setting, both of the system clock - and of the hardware clock. I(Currently only Linux, FreeBSD, NetBSD, - OpenBSD and SmartOS instances are supported.) - It is recommended to restart C(crond) after changing the timezone, - otherwise the jobs may run at the wrong time. - 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. + - 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. + - It is recommended to restart C(crond) after changing the timezone, otherwise the jobs may run at the wrong time. + - 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. + - "On *BSD, C(/etc/localtime) is modified." version_added: "2.2" options: name: @@ -66,6 +60,8 @@ options: I(Only used on Linux.) required: false aliases: ['rtc'] +notes: + - On SmartOS the C(sm-set-timezone) utility (part of the smtools package) is required to set the zone timezone author: - "Shinichi TAMURA (@tmshn)" - "Jasper Lievisse Adriaanse (@jasperla)"