Current File : //usr/lib/python2.7/site-packages/salt/modules/mac_system.pyo
�
���^c @@ s� d Z d d l m Z m Z m Z y d d l m Z Wn! e k
rY d d l m Z n Xd d l
Z
d d l Z d d l
m Z m Z d Z d � Z d � Z d � Z d d
� Z d d � Z d d � Z d d
� Z d d � Z d � Z d � Z d � Z d � Z d � Z d � Z d � Z d � Z! d � Z" d � Z# d � Z$ d � Z% d � Z& d � Z' d � Z( d � Z) d d � Z* d S(! u�
System module for sleeping, restarting, and shutting down the system on Mac OS X
.. versionadded:: 2016.3.0
.. warning::
Using this module will enable ``atrun`` on the system if it is disabled.
i ( t absolute_importt unicode_literalst print_function( t quoteN( t SaltInvocationErrort CommandExecutionErroru systemc C@ s[ t j j j � s t d f St j � d k r8 t d f St � sW t � sW t d f Sn t S( u+
Only for MacOS with atrun enabled
uN The mac_system module could not be loaded: module only works on MacOS systems.u rootu7 The mac_system module is not useful for non-root users.u) atrun could not be enabled on this system(
t saltt utilst platformt is_darwint Falset getpasst getusert _atrun_enabledt
_enable_atrunt __virtualname__( ( ( s; /usr/lib/python2.7/site-packages/salt/modules/mac_system.pyt __virtual__ s
c C@ s+ y t d d � SWn t k
r& t SXd S( uD
Check to see if atrun is running and enabled on the system
u service.listu com.apple.atrunN( t __salt__R R
( ( ( s; /usr/lib/python2.7/site-packages/salt/modules/mac_system.pyR
- s
c C@ sB d } y t d | � t d | � Wn t k
r: t SXt � S( u+
Enable and start the atrun daemon
u com.apple.atrunu service.enableu
service.start( R R R
R
( t name( ( s; /usr/lib/python2.7/site-packages/salt/modules/mac_system.pyR 7 s
c C@ s< | r! d j | t | � � } n t t d | d t �� S( u�
Helper function to execute the command
:param str cmd: the command to run
:param str at_time: If passed, the cmd will be scheduled.
Returns: bool
u echo '{0}' | at {1}u cmd.retcodet python_shell( t formatt
_cmd_quotet boolR t True( t cmdt at_time( ( s; /usr/lib/python2.7/site-packages/salt/modules/mac_system.pyt _execute_commandD s
c C@ s d } t | | � S( u'
Halt a running system
:param str at_time: Any valid `at` expression. For example, some valid at
expressions could be:
- noon
- midnight
- fri
- 9:00 AM
- 2:30 PM tomorrow
- now + 10 minutes
.. note::
If you pass a time only, with no 'AM/PM' designation, you have to
double quote the parameter on the command line. For example: '"14:00"'
CLI Example:
.. code-block:: bash
salt '*' system.halt
salt '*' system.halt 'now + 10 minutes'
u shutdown -h now( R ( R R ( ( s; /usr/lib/python2.7/site-packages/salt/modules/mac_system.pyt haltS s c C@ s d } t | | � S( ua
Sleep the system. If a user is active on the system it will likely fail to
sleep.
:param str at_time: Any valid `at` expression. For example, some valid at
expressions could be:
- noon
- midnight
- fri
- 9:00 AM
- 2:30 PM tomorrow
- now + 10 minutes
.. note::
If you pass a time only, with no 'AM/PM' designation, you have to
double quote the parameter on the command line. For example: '"14:00"'
CLI Example:
.. code-block:: bash
salt '*' system.sleep
salt '*' system.sleep '10:00 PM'
u shutdown -s now( R ( R R ( ( s; /usr/lib/python2.7/site-packages/salt/modules/mac_system.pyt sleepp s c C@ s d } t | | � S( u&
Restart the system
:param str at_time: Any valid `at` expression. For example, some valid at
expressions could be:
- noon
- midnight
- fri
- 9:00 AM
- 2:30 PM tomorrow
- now + 10 minutes
.. note::
If you pass a time only, with no 'AM/PM' designation, you have to
double quote the parameter on the command line. For example: '"14:00"'
CLI Example:
.. code-block:: bash
salt '*' system.restart
salt '*' system.restart '12:00 PM fri'
u shutdown -r now( R ( R R ( ( s; /usr/lib/python2.7/site-packages/salt/modules/mac_system.pyt restart� s c C@ s
t | � S( u)
Shutdown the system
:param str at_time: Any valid `at` expression. For example, some valid at
expressions could be:
- noon
- midnight
- fri
- 9:00 AM
- 2:30 PM tomorrow
- now + 10 minutes
.. note::
If you pass a time only, with no 'AM/PM' designation, you have to
double quote the parameter on the command line. For example: '"14:00"'
CLI Example:
.. code-block:: bash
salt '*' system.shutdown
salt '*' system.shutdown 'now + 1 hour'
( R ( R ( ( s; /usr/lib/python2.7/site-packages/salt/modules/mac_system.pyt shutdown� s c C@ s4 t d d � } t d t d | � � } | d k S( u�
Displays whether remote login (SSH) is on or off.
:return: True if remote login is on, False if off
:rtype: bool
CLI Example:
.. code-block:: bash
salt '*' system.get_remote_login
u mac_utils.execute_return_resultu systemsetup -getremoteloginu mac_utils.validate_enabledu mac_utils.parse_returnu on( t __utils__( t rett enabled( ( s; /usr/lib/python2.7/site-packages/salt/modules/mac_system.pyt get_remote_login� s
c C@ sD t d | � } d j | � } t d | � t d | t d t �S( u�
Set the remote login (SSH) to either on or off.
:param bool enable: True to enable, False to disable. "On" and "Off" are
also acceptable values. Additionally you can pass 1 and 0 to represent
True and False respectively
:return: True if successful, False if not
:rtype: bool
CLI Example:
.. code-block:: bash
salt '*' system.set_remote_login True
u mac_utils.validate_enabledu" systemsetup -f -setremotelogin {0}u mac_utils.execute_return_successu mac_utils.confirm_updatedt
normalize_ret( R R R" R ( t enablet stateR ( ( s; /usr/lib/python2.7/site-packages/salt/modules/mac_system.pyt set_remote_login� s
c C@ s4 t d d � } t d t d | � � } | d k S( u�
Displays whether remote apple events are on or off.
:return: True if remote apple events are on, False if off
:rtype: bool
CLI Example:
.. code-block:: bash
salt '*' system.get_remote_events
u mac_utils.execute_return_resultu! systemsetup -getremoteappleeventsu mac_utils.validate_enabledu mac_utils.parse_returnu on( R ( R R! ( ( s; /usr/lib/python2.7/site-packages/salt/modules/mac_system.pyt get_remote_events� s
c C@ sD t d | � } d j | � } t d | � t d | t d t �S( u�
Set whether the server responds to events sent by other computers (such as
AppleScripts)
:param bool enable: True to enable, False to disable. "On" and "Off" are
also acceptable values. Additionally you can pass 1 and 0 to represent
True and False respectively
:return: True if successful, False if not
:rtype: bool
CLI Example:
.. code-block:: bash
salt '*' system.set_remote_events On
u mac_utils.validate_enabledu% systemsetup -setremoteappleevents {0}u mac_utils.execute_return_successu mac_utils.confirm_updatedR# ( R R R' R ( R$ R% R ( ( s; /usr/lib/python2.7/site-packages/salt/modules/mac_system.pyt set_remote_events s c C@ s t d d � } t d | � S( u�
Gets the computer name
:return: The computer name
:rtype: str
CLI Example:
.. code-block:: bash
salt '*' system.get_computer_name
u mac_utils.execute_return_resultu scutil --get ComputerNameu mac_utils.parse_return( R ( R ( ( s; /usr/lib/python2.7/site-packages/salt/modules/mac_system.pyt get_computer_name, s
c C@ s. d j | � } t d | � t d | t � S( u�
Set the computer name
:param str name: The new computer name
:return: True if successful, False if not
:rtype: bool
CLI Example:
.. code-block:: bash
salt '*' system.set_computer_name "Mike's Mac"
u scutil --set ComputerName "{0}"u mac_utils.execute_return_successu mac_utils.confirm_updated( R R R) ( R R ( ( s; /usr/lib/python2.7/site-packages/salt/modules/mac_system.pyt set_computer_name? s
c C@ s t d d � } t d | � S( u�
Gets the local subnet name
:return: The local subnet name
:rtype: str
CLI Example:
.. code-block:: bash
salt '*' system.get_subnet_name
u mac_utils.execute_return_resultu systemsetup -getlocalsubnetnameu mac_utils.parse_return( R ( R ( ( s; /usr/lib/python2.7/site-packages/salt/modules/mac_system.pyt get_subnet_nameW s
c C@ s. d j | � } t d | � t d | t � S( u�
Set the local subnet name
:param str name: The new local subnet name
.. note::
Spaces are changed to dashes. Other special characters are removed.
:return: True if successful, False if not
:rtype: bool
CLI Example:
.. code-block:: bash
The following will be set as 'Mikes-Mac'
salt '*' system.set_subnet_name "Mike's Mac"
u% systemsetup -setlocalsubnetname "{0}"u mac_utils.execute_return_successu mac_utils.confirm_updated( R R R+ ( R R ( ( s; /usr/lib/python2.7/site-packages/salt/modules/mac_system.pyt set_subnet_namej s
c C@ s t d d � } t d | � S( u�
Displays the current startup disk
:return: The current startup disk
:rtype: str
CLI Example:
.. code-block:: bash
salt '*' system.get_startup_disk
u mac_utils.execute_return_resultu systemsetup -getstartupdisku mac_utils.parse_return( R ( R ( ( s; /usr/lib/python2.7/site-packages/salt/modules/mac_system.pyt get_startup_disk� s
c C@ s t d d � } | j � S( u�
List all valid startup disks on the system.
:return: A list of valid startup disks
:rtype: list
CLI Example:
.. code-block:: bash
salt '*' system.list_startup_disks
u mac_utils.execute_return_resultu systemsetup -liststartupdisks( R t
splitlines( R ( ( s; /usr/lib/python2.7/site-packages/salt/modules/mac_system.pyt list_startup_disks� s
c C@ s[ | t � k r- d j | � } t | � � n d j | � } t d | � t d | t � S( us
Set the current startup disk to the indicated path. Use
``system.list_startup_disks`` to find valid startup disks on the system.
:param str path: The valid startup disk path
:return: True if successful, False if not
:rtype: bool
CLI Example:
.. code-block:: bash
salt '*' system.set_startup_disk /System/Library/CoreServices
un Invalid value passed for path.
Must be a valid startup disk as found in system.list_startup_disks.
Passed: {0}u systemsetup -setstartupdisk {0}u mac_utils.execute_return_resultu mac_utils.confirm_updated( R/ R R R R- ( t patht msgR ( ( s; /usr/lib/python2.7/site-packages/salt/modules/mac_system.pyt set_startup_disk� s c C@ s t d d � } t d | � S( uC
Get the number of seconds after which the computer will start up after a
power failure.
:return: A string value representing the number of seconds the system will
delay restart after power loss
:rtype: str
CLI Example:
.. code-block:: bash
salt '*' system.get_restart_delay
u mac_utils.execute_return_resultu/ systemsetup -getwaitforstartupafterpowerfailureu mac_utils.parse_return( R ( R ( ( s; /usr/lib/python2.7/site-packages/salt/modules/mac_system.pyt get_restart_delay� s c C@ s\ | d d k r. d j | � } t | � � n d j | � } t d | � t d | t � S( u�
Set the number of seconds after which the computer will start up after a
power failure.
.. warning::
This command fails with the following error:
``Error, IOServiceOpen returned 0x10000003``
The setting is not updated. This is an apple bug. It seems like it may
only work on certain versions of Mac Server X. This article explains the
issue in more detail, though it is quite old.
http://lists.apple.com/archives/macos-x-server/2006/Jul/msg00967.html
:param int seconds: The number of seconds. Must be a multiple of 30
:return: True if successful, False if not
:rtype: bool
CLI Example:
.. code-block:: bash
salt '*' system.set_restart_delay 180
i i uG Invalid value passed for seconds.
Must be a multiple of 30.
Passed: {0}u3 systemsetup -setwaitforstartupafterpowerfailure {0}u mac_utils.execute_return_successu mac_utils.confirm_updated( R R R R3 ( t secondsR1 R ( ( s; /usr/lib/python2.7/site-packages/salt/modules/mac_system.pyt set_restart_delay� s c C@ s4 t d d � } t d t d | � � } | d k S( u!
Get whether or not the keyboard should be disabled when the X Serve enclosure
lock is engaged.
:return: True if disable keyboard on lock is on, False if off
:rtype: bool
CLI Example:
..code-block:: bash
salt '*' system.get_disable_keyboard_on_lock
u mac_utils.execute_return_resultu9 systemsetup -getdisablekeyboardwhenenclosurelockisengagedu mac_utils.validate_enabledu mac_utils.parse_returnu on( R ( R R! ( ( s; /usr/lib/python2.7/site-packages/salt/modules/mac_system.pyt get_disable_keyboard_on_lock s
c C@ sD t d | � } d j | � } t d | � t d | t d t �S( u�
Get whether or not the keyboard should be disabled when the X Serve
enclosure lock is engaged.
:param bool enable: True to enable, False to disable. "On" and "Off" are
also acceptable values. Additionally you can pass 1 and 0 to represent
True and False respectively
:return: True if successful, False if not
:rtype: bool
CLI Example:
.. code-block:: bash
salt '*' system.set_disable_keyboard_on_lock False
u mac_utils.validate_enabledu= systemsetup -setdisablekeyboardwhenenclosurelockisengaged {0}u mac_utils.execute_return_successu mac_utils.confirm_updatedR# ( R R R6 R ( R$ R% R ( ( s; /usr/lib/python2.7/site-packages/salt/modules/mac_system.pyt set_disable_keyboard_on_lock# s c C@ sT t d d � } t d | � } d | k r0 d Sd | k r@ d Sd | k rP d Sd S( u�
Get the kernel architecture setting from ``com.apple.Boot.plist``
:return: A string value representing the boot architecture setting
:rtype: str
CLI Example:
.. code-block:: bash
salt '*' system.get_boot_arch
u mac_utils.execute_return_resultu- systemsetup -getkernelbootarchitecturesettingu mac_utils.parse_returnu defaultu i386u x86_64u unknown( R ( R t arch( ( s; /usr/lib/python2.7/site-packages/salt/modules/mac_system.pyt
get_boot_archB s
u defaultc C@ sX | d k r* d j | � } t | � � n d j | � } t d | � t d | t � S( u�
Set the kernel to boot in 32 or 64 bit mode on next boot.
.. note::
When this function fails with the error ``changes to kernel
architecture failed to save!``, then the boot arch is not updated.
This is either an Apple bug, not available on the test system, or a
result of system files being locked down in macOS (SIP Protection).
:param str arch: A string representing the desired architecture. If no
value is passed, default is assumed. Valid values include:
- i386
- x86_64
- default
:return: True if successful, False if not
:rtype: bool
CLI Example:
.. code-block:: bash
salt '*' system.set_boot_arch i386
u i386u x86_64u defaultuL Invalid value passed for arch.
Must be i386, x86_64, or default.
Passed: {0}u* systemsetup -setkernelbootarchitecture {0}u mac_utils.execute_return_successu mac_utils.confirm_updated( u i386u x86_64u default( R R R R9 ( R8 R1 R ( ( s; /usr/lib/python2.7/site-packages/salt/modules/mac_system.pyt
set_boot_arch^ s (+ t __doc__t
__future__R R R t shlexR R t ImportErrort pipesR t salt.utils.platformR t salt.exceptionsR R R R R
R t NoneR R R R R R" R& R' R( R) R* R+ R, R- R/ R2 R3 R5 R6 R7 R9 R: ( ( ( s; /usr/lib/python2.7/site-packages/salt/modules/mac_system.pyt <module> sD
+
Mini Shell