mirror of
https://github.com/valitydev/salt.git
synced 2024-11-09 01:36:48 +00:00
Merge pull request #30408 from twangboy/mac_timezone
Mac timezone module
This commit is contained in:
Mike Place
commit
3f280991a3
400
salt/modules/mac_timezone.py
Normal file
400
salt/modules/mac_timezone.py
Normal file
@ -0,0 +1,400 @@
|
||||
# -*- coding: utf-8 -*-
|
||||
'''
|
||||
Module for editing date/time settings on Mac OS X
|
||||
|
||||
.. versionadded:: 2016.3.0
|
||||
'''
|
||||
from __future__ import absolute_import
|
||||
|
||||
# Import python libs
|
||||
from datetime import datetime
|
||||
|
||||
# Import salt libs
|
||||
import salt.utils
|
||||
from salt.exceptions import CommandExecutionError
|
||||
|
||||
__virtualname__ = 'timezone'
|
||||
|
||||
|
||||
def __virtual__():
|
||||
'''
|
||||
Only for Mac OS X
|
||||
'''
|
||||
if not salt.utils.is_darwin():
|
||||
return (False, 'The mac_timezone module could not be loaded: '
|
||||
'module only works on Mac OS X systems.')
|
||||
|
||||
return __virtualname__
|
||||
|
||||
|
||||
def _get_date_time_format(dt_string):
|
||||
'''
|
||||
Function that detects the date/time format for the string passed.
|
||||
|
||||
:param str dt_string:
|
||||
A date/time string
|
||||
|
||||
:return: The format of the passed dt_string
|
||||
:rtype: str
|
||||
'''
|
||||
valid_formats = [
|
||||
'%H:%M',
|
||||
'%H:%M:%S',
|
||||
'%m:%d:%y',
|
||||
'%m:%d:%Y',
|
||||
'%m/%d/%y',
|
||||
'%m/%d/%Y'
|
||||
]
|
||||
for dt_format in valid_formats:
|
||||
try:
|
||||
datetime.strptime(dt_string, dt_format)
|
||||
return dt_format
|
||||
except ValueError:
|
||||
continue
|
||||
msg = 'Invalid Date/Time Format: {0}'.format(dt_string)
|
||||
raise CommandExecutionError(msg)
|
||||
|
||||
|
||||
def _execute_return_success(cmd):
|
||||
'''
|
||||
Helper function to execute the command
|
||||
Returns: bool
|
||||
'''
|
||||
ret = __salt__['cmd.run_all'](cmd)
|
||||
|
||||
if ret['retcode'] != 0:
|
||||
msg = 'Command failed: {0}'.format(ret['stderr'])
|
||||
raise CommandExecutionError(msg)
|
||||
|
||||
return True
|
||||
|
||||
|
||||
def _execute_return_result(cmd):
|
||||
ret = __salt__['cmd.run_all'](cmd)
|
||||
|
||||
if ret['retcode'] != 0:
|
||||
msg = 'Command failed: {0}'.format(ret['stderr'])
|
||||
raise CommandExecutionError(msg)
|
||||
|
||||
return ret['stdout']
|
||||
|
||||
|
||||
def _parse_return(data):
|
||||
'''
|
||||
Parse a return in the format:
|
||||
``Time Zone: America/Denver``
|
||||
to return only:
|
||||
``America/Denver``
|
||||
|
||||
Returns: The value portion of a return
|
||||
'''
|
||||
|
||||
if ': ' in data:
|
||||
return data.split(': ')[1]
|
||||
if ':\n' in data:
|
||||
return data.split(':\n')[1]
|
||||
else:
|
||||
return data
|
||||
|
||||
|
||||
def get_date():
|
||||
'''
|
||||
Displays the current date
|
||||
|
||||
Returns: the system date
|
||||
|
||||
CLI Example:
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
salt '*' timezone.get_date
|
||||
'''
|
||||
ret = _execute_return_result('systemsetup -getdate')
|
||||
return _parse_return(ret)
|
||||
|
||||
|
||||
def set_date(date):
|
||||
'''
|
||||
Set the current month, day, and year
|
||||
|
||||
:param str date: The date to set. Valid date formats are:
|
||||
- %m:%d:%y
|
||||
- %m:%d:%Y
|
||||
- %m/%d/%y
|
||||
- %m/%d/%Y
|
||||
|
||||
:return: True if successful, False if not
|
||||
:rtype: bool
|
||||
|
||||
CLI Example:
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
salt '*' timezone.set_date 1/13/2016
|
||||
'''
|
||||
date_format = _get_date_time_format(date)
|
||||
dt_obj = datetime.strptime(date, date_format)
|
||||
|
||||
cmd = 'systemsetup -setdate {0}'.format(dt_obj.strftime('%m:%d:%Y'))
|
||||
_execute_return_success(cmd)
|
||||
|
||||
new_date = get_date()
|
||||
date_format = _get_date_time_format(new_date)
|
||||
new_dt_obj = datetime.strptime(new_date, date_format)
|
||||
|
||||
return dt_obj.strftime('%m:%d:%Y') == new_dt_obj.strftime('%m:%d:%Y')
|
||||
|
||||
|
||||
def get_time():
|
||||
'''
|
||||
Get the current system time.
|
||||
|
||||
:return: The current time in 24 hour format
|
||||
:rtype: str
|
||||
|
||||
CLI Example:
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
salt '*' timezone.get_time
|
||||
'''
|
||||
ret = _execute_return_result('systemsetup -gettime')
|
||||
return _parse_return(ret)
|
||||
|
||||
|
||||
def set_time(time):
|
||||
'''
|
||||
Sets the current time. Must be in 24 hour format.
|
||||
|
||||
:param str time: The time to set in 24 hour format.
|
||||
The value must be double quoted.
|
||||
|
||||
:return: True if successful, False if not
|
||||
:rtype: bool
|
||||
|
||||
CLI Example:
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
salt '*' timezone.set_time '"17:34"'
|
||||
'''
|
||||
# time must be double quoted '"17:46"'
|
||||
time_format = _get_date_time_format(time)
|
||||
dt_obj = datetime.strptime(time, time_format)
|
||||
|
||||
cmd = 'systemsetup -settime {0}'.format(dt_obj.strftime('%H:%M:%S'))
|
||||
_execute_return_success(cmd)
|
||||
|
||||
new_time = get_time()
|
||||
time_format = _get_date_time_format(new_time)
|
||||
new_dt_obj = datetime.strptime(new_time, time_format)
|
||||
|
||||
return dt_obj.strftime('%H:%M:%S') == new_dt_obj.strftime('%H:%M:%S')
|
||||
|
||||
|
||||
def get_zone():
|
||||
'''
|
||||
Displays the current time zone
|
||||
|
||||
:return: The current time zone
|
||||
:rtype: str
|
||||
|
||||
CLI Example:
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
salt '*' timezone.get_zone
|
||||
'''
|
||||
ret = _execute_return_result('systemsetup -gettimezone')
|
||||
return _parse_return(ret)
|
||||
|
||||
|
||||
def get_zonecode():
|
||||
'''
|
||||
Displays the current time zone abbreviated code
|
||||
|
||||
:return: The current time zone code
|
||||
:rtype: str
|
||||
|
||||
CLI Example:
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
salt '*' timezone.get_zonecode
|
||||
'''
|
||||
return _execute_return_result('date +%Z')
|
||||
|
||||
|
||||
def get_offset():
|
||||
'''
|
||||
Displays the current time zone offset
|
||||
|
||||
:return: The current time zone offset
|
||||
:rtype: str
|
||||
|
||||
CLI Example:
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
salt '*' timezone.get_offset
|
||||
'''
|
||||
return _execute_return_result('date +%z')
|
||||
|
||||
|
||||
def list_zones():
|
||||
'''
|
||||
Displays a list of available time zones. Use this list when setting a
|
||||
time zone using ``timezone.set_zone``
|
||||
|
||||
:return: a string containing a list of time zones
|
||||
:rtype: str
|
||||
|
||||
CLI Example:
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
salt '*' timezone.list_zones
|
||||
'''
|
||||
ret = _execute_return_result('systemsetup -listtimezones')
|
||||
return _parse_return(ret)
|
||||
|
||||
|
||||
def set_zone(time_zone):
|
||||
'''
|
||||
Set the local time zone. Use ``timezone.list_zones`` to list valid time_zone
|
||||
arguments
|
||||
|
||||
:param str time_zone: The time zone to apply
|
||||
|
||||
:return: True if successful, False if not
|
||||
:rtype: bool
|
||||
|
||||
CLI Example:
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
salt '*' timezone.set_zone America/Denver
|
||||
'''
|
||||
if time_zone not in list_zones():
|
||||
return (False, 'Not a valid timezone. '
|
||||
'Use list_time_zones to find a valid time zone.')
|
||||
|
||||
_execute_return_success('systemsetup -settimezone {0}'.format(time_zone))
|
||||
|
||||
return time_zone in get_zone()
|
||||
|
||||
|
||||
def zone_compare(time_zone):
|
||||
'''
|
||||
Compares the given timezone name with the system timezone name.
|
||||
|
||||
:return: True if they are the same, False if not
|
||||
:rtype: bool
|
||||
|
||||
CLI Example:
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
salt '*' timezone.zone_compare America/Boise
|
||||
'''
|
||||
current = get_zone()
|
||||
|
||||
if current != time_zone:
|
||||
return False
|
||||
|
||||
return True
|
||||
|
||||
|
||||
def get_using_network_time():
|
||||
'''
|
||||
Display whether network time is on or off
|
||||
|
||||
:return: True if network time is on, False if off
|
||||
:rtype: bool
|
||||
|
||||
CLI Example:
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
salt '*' timezone.get_using_network_time
|
||||
'''
|
||||
ret = _execute_return_result('systemsetup -getusingnetworktime')
|
||||
|
||||
if _parse_return(ret) == 'On':
|
||||
return True
|
||||
else:
|
||||
return False
|
||||
|
||||
|
||||
def set_using_network_time(enable):
|
||||
'''
|
||||
Set whether network time is on or off.
|
||||
|
||||
:param enable: True to enable, False to disable. Can also use 'on' or 'off'
|
||||
:type: str bool
|
||||
|
||||
:return: True if successful, False if not
|
||||
:rtype: bool
|
||||
|
||||
CLI Example:
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
salt '*' timezone.set_using_network_time True
|
||||
'''
|
||||
if enable not in ['On', 'on', 'Off', 'off', True, False]:
|
||||
msg = 'Must pass a boolean value. Passed: {0}'.format(enable)
|
||||
raise CommandExecutionError(msg)
|
||||
|
||||
if enable in ['On', 'on', True]:
|
||||
enable = 'on'
|
||||
expect = True
|
||||
else:
|
||||
enable = 'off'
|
||||
expect = False
|
||||
cmd = 'systemsetup -setusingnetworktime {0}'.format(enable)
|
||||
|
||||
_execute_return_success(cmd)
|
||||
|
||||
return expect == get_using_network_time()
|
||||
|
||||
|
||||
def get_time_server():
|
||||
'''
|
||||
Display the currently set network time server.
|
||||
|
||||
:return: the network time server
|
||||
:rtype: str
|
||||
|
||||
CLI Example:
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
salt '*' timezone.get_time_server
|
||||
'''
|
||||
ret = _execute_return_result('systemsetup -getnetworktimeserver')
|
||||
return _parse_return(ret)
|
||||
|
||||
|
||||
def set_time_server(time_server='time.apple.com'):
|
||||
'''
|
||||
Designates a network time server. Enter the IP address or DNS name for the
|
||||
network time server.
|
||||
|
||||
:param time_server: IP or DNS name of the network time server. If nothing is
|
||||
passed the time server will be set to the OS X default of 'time.apple.com'
|
||||
:type: str
|
||||
|
||||
:return: True if successful, False if not
|
||||
:rtype: bool
|
||||
|
||||
CLI Example:
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
salt '*' timezone.set_time_server time.acme.com
|
||||
'''
|
||||
cmd = 'systemsetup -setnetworktimeserver {0}'.format(time_server)
|
||||
_execute_return_success(cmd)
|
||||
|
||||
return time_server in get_time_server()
|
||||
@ -18,14 +18,24 @@ from salt.exceptions import SaltInvocationError, CommandExecutionError
|
||||
|
||||
log = logging.getLogger(__name__)
|
||||
|
||||
__virtualname__ = 'timezone'
|
||||
|
||||
|
||||
def __virtual__():
|
||||
'''
|
||||
Only work on POSIX-like systems
|
||||
'''
|
||||
if salt.utils.is_windows():
|
||||
return (False, 'The timezone execution module failed to load: not available on Windows systems.')
|
||||
return True
|
||||
return (False, 'The timezone execution module failed to load: '
|
||||
'win_timezone.py should replace this module on Windows.'
|
||||
'There was a problem loading win_timezone.py.')
|
||||
|
||||
if salt.utils.is_darwin():
|
||||
return (False, 'The timezone execution module failed to load: '
|
||||
'mac_timezone.py should replace this module on OS X.'
|
||||
'There was a problem loading mac_timezone.py.')
|
||||
|
||||
return __virtualname__
|
||||
|
||||
|
||||
def _timedatectl():
|
||||
|
||||
Loading…
Reference in New Issue
Block a user