Class: Ansible::Ruby::Modules::Timezone

Inherits:
Base show all
Defined in:
lib/ansible/ruby/modules/generated/system/timezone.rb

Overview

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. It is recommended to restart C(crond) after changing the timezone, otherwise the jobs may run at the wrong time. Several different tools are used depending on the OS/Distribution involved. For Linux it can use C(timedatectl) or edit C(/etc/sysconfig/clock) or C(/etc/timezone) and C(hwclock). On SmartOS, C(sm-set-timezone), for macOS, C(systemsetup), for BSD, C(/etc/localtime) is modified. As of version 2.3 support was added for SmartOS and BSDs. As of version 2.4 support was added for macOS. Windows, AIX and HPUX are not supported, please let us know if you find any other OS/distro in which this fails.

Instance Method Summary collapse

Methods inherited from Base

#ansible_name, #to_h

Methods inherited from Ansible::Ruby::Models::Base

attr_option, attr_options, attribute, fix_inclusion, #initialize, remove_existing_validations, #to_h, validates

Constructor Details

This class inherits a constructor from Ansible::Ruby::Models::Base

Instance Method Details

#hwclock ⇒ :UTC, ...

Returns Whether the hardware clock is in UTC or in local timezone. Default is to keep current setting. Note that this option is recommended not to change and may fail to configure, especially on virtual environments such as AWS. B(At least one of name and hwclock are required.) I(Only used on Linux.).

Returns:

  • (:UTC, :local, nil) —

    Whether the hardware clock is in UTC or in local timezone. Default is to keep current setting. Note that this option is recommended not to change and may fail to configure, especially on virtual environments such as AWS. B(At least one of name and hwclock are required.) I(Only used on Linux.)



21
 
# File 'lib/ansible/ruby/modules/generated/system/timezone.rb', line 21

attribute :hwclock

#name ⇒ String?

Returns Name of the timezone for the system clock. Default is to keep current setting. B(At least one of name and hwclock are required.).

Returns:

  • (String, nil) —

    Name of the timezone for the system clock. Default is to keep current setting. B(At least one of name and hwclock are required.)



17
 
# File 'lib/ansible/ruby/modules/generated/system/timezone.rb', line 17

attribute :name