Current File : //lib/python2.7/site-packages/salt/modules/win_system.pyo
�
���^c @@ sN d Z d d l m Z m Z m Z d d l Z d d l Z d d l Z d d l Z d d l m Z d d l
Z d d l Z d d l
Z d d l Z d d l m Z d d l m Z yV d d l Z d d l Z d d l Z d d l Z d d l Z d d l m Z e Z Wn e k
r!e Z n Xe j e � Z d Z d � Z! e d
� Z" d � Z# d � Z$ d
e d � Z% d � Z& d
e d � Z' d
e e e d � Z( d d
e e e e d � Z* d � Z+ d � Z, d � Z- d � Z. d � Z/ d � Z0 d d � Z1 e j2 j3 j4 e1 d � Z5 d � Z6 d � Z7 e j2 j3 j4 e7 d � Z8 d � Z9 d � Z: d d d e e d � Z; d d d e d! � Z< d d d d" e e d# � Z= d$ � Z> d% � Z? d& � Z@ d' � ZA d d d d d d d( � ZB d) � ZC d* � ZD d+ � ZE d, � ZF d- � ZG d. � ZH d/ � ZI d0 � ZJ d1 � ZK d2 ZL d3 ZM d4 � ZN d5 � ZO d6 � ZP d S(7 u�
Module for managing windows systems.
:depends:
- pywintypes
- win32api
- win32con
- win32net
- wmi
Support for reboot, shutdown, etc
i ( t absolute_importt unicode_literalst print_functionN( t datetime( t CommandExecutionError( t six( t windllu systemc C@ s0 t j j j � s t d f St s, t d f St S( u:
Only works on Windows Systems with Win32 Modules
u# Module win_system: Requires Windowsu( Module win_system: Missing win32 modules( t saltt utilst platformt
is_windowst Falset HAS_WIN32NET_MODSt __virtualname__( ( ( s; /usr/lib/python2.7/site-packages/salt/modules/win_system.pyt __virtual__2 s
c C@ s | r
| S| d S( u$
convert timeout to seconds
i< ( ( t timeoutt
in_seconds( ( s; /usr/lib/python2.7/site-packages/salt/modules/win_system.pyt _convert_minutes_seconds? s c C@ s2 | j d � d } t j | d � } | j d � S( u,
convert string to date time object
u .i u %Y%m%d%H%M%Su %Y-%m-%d %H:%M:%S( t splitR t strptimet strftime( t dt_stringt dt_obj( ( s; /usr/lib/python2.7/site-packages/salt/modules/win_system.pyt _convert_date_time_stringF s c C@ s6 | d k s t | t j � r" | St j | d � Sd S( u�
Converts from current users character encoding to unicode.
When instr has a value of None, the return value of the function
will also be None.
u utf8N( t Nonet
isinstanceR t text_type( t instr( ( s; /usr/lib/python2.7/site-packages/salt/modules/win_system.pyt _to_unicodeO s i c C@ s t d | d | � S( u�
Halt a running system.
Args:
timeout (int):
Number of seconds before halting the system. Default is 5 seconds.
in_seconds (bool):
Whether to treat timeout as seconds or minutes.
.. versionadded:: 2015.8.0
Returns:
bool: ``True`` if successful, otherwise ``False``
CLI Example:
.. code-block:: bash
salt '*' system.halt 5 True
R R ( t shutdown( R R ( ( s; /usr/lib/python2.7/site-packages/salt/modules/win_system.pyt halt[ s c C@ s d S( u�
Change the system runlevel on sysV compatible systems. Not applicable to
Windows
CLI Example:
.. code-block:: bash
salt '*' system.init 3
u( Not implemented on Windows at this time.( ( t runlevel( ( s; /usr/lib/python2.7/site-packages/salt/modules/win_system.pyt initu s c C@ s t d | d | � S( u�
Power off a running system.
Args:
timeout (int):
Number of seconds before powering off the system. Default is 5
seconds.
in_seconds (bool):
Whether to treat timeout as seconds or minutes.
.. versionadded:: 2015.8.0
Returns:
bool: ``True`` if successful, otherwise ``False``
CLI Example:
.. code-block:: bash
salt '*' system.poweroff 5
R R ( R ( R R ( ( s; /usr/lib/python2.7/site-packages/salt/modules/win_system.pyt poweroff� s c C@ sN t d | d t d | d | � } | rJ t | | � } t j | d � n | S( u�
Reboot a running system.
Args:
timeout (int):
The number of minutes/seconds before rebooting the system. Use of
minutes or seconds depends on the value of ``in_seconds``. Default
is 5 minutes.
in_seconds (bool):
``True`` will cause the ``timeout`` parameter to be in seconds.
``False`` will be in minutes. Default is ``False``.
.. versionadded:: 2015.8.0
wait_for_reboot (bool)
``True`` will sleep for timeout + 30 seconds after reboot has been
initiated. This is useful for use in a highstate. For example, you
may have states that you want to apply only after the reboot.
Default is ``False``.
.. versionadded:: 2015.8.0
only_on_pending_reboot (bool):
If this is set to ``True``, then the reboot will only proceed
if the system reports a pending reboot. Setting this parameter to
``True`` could be useful when calling this function from a final
housekeeping state intended to be executed at the end of a state run
(using *order: last*). Default is ``False``.
Returns:
bool: ``True`` if successful (a reboot will occur), otherwise ``False``
CLI Example:
.. code-block:: bash
salt '*' system.reboot 5
salt '*' system.reboot 5 True
Invoking this function from a final housekeeping state:
.. code-block:: yaml
final_housekeeping:
module.run:
- name: system.reboot
- only_on_pending_reboot: True
- order: last
R t rebootR t only_on_pending_rebooti ( R t TrueR t timet sleep( R R t wait_for_rebootR# t rett seconds( ( s; /usr/lib/python2.7/site-packages/salt/modules/win_system.pyR" � s 5 c C@ s� t j r t | � } n t | | � } | r; t � r; t S| rf t | t j � rf | j d � } n y! t j
d | | | | � t SWnf t j
k
r� } | j \ } } } t j
d � t j
d | � t j
d | � t j
d | � t SXd S( u�
Shutdown a running system.
Args:
message (str):
The message to display to the user before shutting down.
timeout (int):
The length of time (in seconds) that the shutdown dialog box should
be displayed. While this dialog box is displayed, the shutdown can
be aborted using the ``system.shutdown_abort`` function.
If timeout is not zero, InitiateSystemShutdown displays a dialog box
on the specified computer. The dialog box displays the name of the
user who called the function, the message specified by the lpMessage
parameter, and prompts the user to log off. The dialog box beeps
when it is created and remains on top of other windows (system
modal). The dialog box can be moved but not closed. A timer counts
down the remaining time before the shutdown occurs.
If timeout is zero, the computer shuts down immediately without
displaying the dialog box and cannot be stopped by
``system.shutdown_abort``.
Default is 5 minutes
in_seconds (bool):
``True`` will cause the ``timeout`` parameter to be in seconds.
``False`` will be in minutes. Default is ``False``.
.. versionadded:: 2015.8.0
force_close (bool):
``True`` will force close all open applications. ``False`` will
display a dialog box instructing the user to close open
applications. Default is ``True``.
reboot (bool):
``True`` restarts the computer immediately after shutdown. ``False``
powers down the system. Default is ``False``.
only_on_pending_reboot (bool): If this is set to True, then the shutdown
will only proceed if the system reports a pending reboot. To
optionally shutdown in a highstate, consider using the shutdown
state instead of this module.
only_on_pending_reboot (bool):
If ``True`` the shutdown will only proceed if there is a reboot
pending. ``False`` will shutdown the system. Default is ``False``.
Returns:
bool:
``True`` if successful (a shutdown or reboot will occur), otherwise
``False``
CLI Example:
.. code-block:: bash
salt '*' system.shutdown "System will shutdown in 5 minutes"
u utf-8u 127.0.0.1u Failed to shutdown the systemu nbr: %su ctx: %su msg: %sN( R t PY2R R t get_pending_rebootR R t string_typest decodet win32apit InitiateSystemShutdownR$ t
pywintypest errort argst log( t messageR t force_closeR" R R# t exct numbert context( ( s; /usr/lib/python2.7/site-packages/salt/modules/win_system.pyR � s$ @
c C@ s
t d d � S( u�
Shutdown a running system with no timeout or warning.
Returns:
bool: ``True`` if successful, otherwise ``False``
CLI Example:
.. code-block:: bash
salt '*' system.shutdown_hard
R i ( R ( ( ( s; /usr/lib/python2.7/site-packages/salt/modules/win_system.pyt
shutdown_hard; s
c C@ s� y t j d � t SWnf t j k
r} } | j \ } } } t j d � t j d | � t j d | � t j d | � t SXd S( uB
Abort a shutdown. Only available while the dialog box is being
displayed to the user. Once the shutdown has initiated, it cannot be
aborted.
Returns:
bool: ``True`` if successful, otherwise ``False``
CLI Example:
.. code-block:: bash
salt 'minion-id' system.shutdown_abort
u 127.0.0.1u Failed to abort system shutdownu nbr: %su ctx: %su msg: %sN( R. t AbortSystemShutdownR$ R0 R1 R2 R3 R ( R6 R7 R8 R4 ( ( s; /usr/lib/python2.7/site-packages/salt/modules/win_system.pyt shutdown_abortK s
c C@ s
t j j � S( u�
Lock the workstation.
Returns:
bool: ``True`` if successful, otherwise ``False``
CLI Example:
.. code-block:: bash
salt 'minion-id' system.lock
( R t user32t LockWorkStation( ( ( s; /usr/lib/python2.7/site-packages/salt/modules/win_system.pyt lockf s
c C@ s{ t j r t | � } n t j j t j | � rw i i t � d 6d 6} t � } | d t f k rs | | d d <n | St S( u�
Set the Windows computer name
Args:
name (str):
The new name to give the computer. Requires a reboot to take effect.
Returns:
dict:
Returns a dictionary containing the old and new names if successful.
``False`` if not.
CLI Example:
.. code-block:: bash
salt 'minion-id' system.set_computer_name 'DavesComputer'
u Currentu
Computer Nameu PendingN( R R* R R t kernel32t SetComputerNameExWt win32cont ComputerNamePhysicalDnsHostnamet get_computer_namet get_pending_computer_nameR R ( t nameR( t pending( ( s; /usr/lib/python2.7/site-packages/salt/modules/win_system.pyt set_computer_namev s c C@ sA t � } t d d d d � d } | r= | | k r9 | Sd St S( ub
Get a pending computer name. If the computer name has been changed, and the
change is pending a system reboot, this function will return the pending
computer name. Otherwise, ``None`` will be returned. If there was an error
retrieving the pending computer name, ``False`` will be returned, and an
error message will be logged to the minion log.
Returns:
str:
Returns the pending name if pending restart. Returns ``None`` if not
pending restart.
CLI Example:
.. code-block:: bash
salt 'minion-id' system.get_pending_computer_name
u reg.read_valueu HKLMu2 SYSTEM\CurrentControlSet\Services\Tcpip\Parametersu NV Hostnameu vdataN( RC t __salt__R R ( t currentRF ( ( s; /usr/lib/python2.7/site-packages/salt/modules/win_system.pyRD � s
c C@ s t j t j � } | r | St S( u�
Get the Windows computer name
Returns:
str: Returns the computer name if found. Otherwise returns ``False``.
CLI Example:
.. code-block:: bash
salt 'minion-id' system.get_computer_name
( R. t GetComputerNameExRA RB R ( RE ( ( s; /usr/lib/python2.7/site-packages/salt/modules/win_system.pyRC � s
c C@ s� t j r t | � } n t j d d � } | d k r: t S| | d <y t j d d | � Wnf t j k
r� } | j \ } } } t
j d � t
j d | � t
j d | � t
j d | � t SXi t � d 6S( u=
Set the Windows computer description
Args:
desc (str):
The computer description
Returns:
str: Description if successful, otherwise ``False``
CLI Example:
.. code-block:: bash
salt 'minion-id' system.set_computer_desc 'This computer belongs to Dave!'
ie u commentu Failed to update systemu nbr: %su ctx: %su msg: %su Computer DescriptionN( R R* R t win32nett NetServerGetInfoR R t NetServerSetInfoR1 R2 R3 t get_computer_desc( t desct system_infoR6 R7 R8 R4 ( ( s; /usr/lib/python2.7/site-packages/salt/modules/win_system.pyt set_computer_desc� s
u set_computer_descriptionc C@ s| d � } i d d 6d d 6d d 6} t j j j � � t j � } Wd QX| j � d } i t � d
6| j d 6| j d 6| j
d
6| j d 6| j d 6| j
d 6| j d 6| j d 6| j d 6| | j d 6| j d 6| j d 6| j d 6| j d 6| j d 6} i d d 6d d 6d d 6d d 6d d 6d d! 6} i d" d 6d# d 6d$ d 6d% d 6d& d! 6d' d( 6} i d) d 6d* d 6d+ d 6d, d 6d- d 6d. d! 6d/ d( 6d0 d1 6d2 d3 6} | j � d } | j i | j d4 6� | j � d } t j � dY k r| | j } n( | j i d8 d3 6d2 d9 6� | | j } | j i | j d: 6| j d; 6| | j d< 6| j d= 6| j! d> 6| | j" d? 6| j d@ 6| j# dA 6| j$ dB 6| j% dC 6| dD 6| j& dE 6| j' dF 6| j( dG 6| | j) � dH 6| j) dI 6| | j* dJ 6| j+ dK 6� | j, � }
d | dL <d | dM <d | dN <d | dO <|
d j | dP <t- j. |
d j/ � dQ | dR <xu |
D]m } | dL c d 7<| dM c | j0 7<| dN c | j1 7<y | dO c | j2 7<Wqct3 t4 f k
r�qcXqcW| dO d k r�| j5 dO t6 � n | j7 � d } | j i | j8 dS 6| j dT 6| j dU 6| j9 dV 6| j dW 6| j dX 6� t: | d � | d <t: | d
� | d
<| S(Z u�
Get system information.
.. note::
Not all system info is available across all versions of Windows. If it
is not available on an older version, it will be skipped
Returns:
dict: Dictionary containing information about the system to include
name, description, version, etc...
CLI Example:
.. code-block:: bash
salt 'minion-id' system.get_system_info
c S@ s� t | � } | d k r% d j | � S| d k rB d j | d
� S| d k r_ d j | d � S| d k r| d j | d � Sd
j | d � Sd S( Ni i
u {0:.3f}Bi u {0:.3f}KBi u {0:.3f}MBi( u {0:.3f}GBu {0:.3f}TBi i i i @i I i @I ( t floatt format( t val( ( s; /usr/lib/python2.7/site-packages/salt/modules/win_system.pyt byte_calc s
u Work Stationi u Domain Controlleri u Serveri Ni u nameu descriptionu install_dateu last_bootu os_manufactureru os_nameu usersu organizationu os_architectureu primaryu os_typeu registered_useru system_directoryu system_driveu
os_versionu windows_directoryu Standalone Workstationu Member Workstationu Standalone Serveru
Member Serveru Backup Domain Controlleri u Primary Domain Controlleri u Otheru Unknownu Safeu Warningu Criticalu Non-recoverablei u Unspecifiedu Desktopu Mobileu Workstationu Enterprise Serveru SOHO Serveru Appliance PCu Performance Serveri u Maximumi u chassis_sku_numberu Vistau 7u 8u Slatei u bootup_stateu captionu chassis_bootup_stateu dns_hostnameu domainu domain_roleu hardware_manufactureru hardware_modelu network_server_mode_enabledu part_of_domainu pc_system_typeu power_stateu statusu system_typeu total_physical_memoryu total_physical_memory_rawu
thermal_stateu workgroupu
processorsu processors_logicalu processor_coresu processor_cores_enabledu processor_manufactureru MHzu processor_max_clock_speedu hardware_serialu bios_manufactureru bios_versionu bios_detailsu bios_captionu bios_description( u Vistau 7u 8(; R R t winapit Comt wmit WMIt Win32_OperatingSystemRC t Descriptiont InstallDatet LastBootUpTimet Manufacturert Captiont
NumberOfUserst Organizationt OSArchitecturet Primaryt ProductTypet RegisteredUsert SystemDirectoryt SystemDrivet Versiont WindowsDirectoryt Win32_ComputerSystemProductt updatet SKUNumbert Win32_ComputerSystemR t releaset PCSystemTypet BootupStatet ChassisBootupStatet DNSHostnamet Domaint
DomainRolet Modelt NetworkServerModeEnabledt PartOfDomaint
PowerStatet Statust
SystemTypet TotalPhysicalMemoryt ThermalStatet Workgroupt Win32_ProcessorR R t
MaxClockSpeedt NumberOfLogicalProcessorst
NumberOfCorest NumberOfEnabledCoret AttributeErrort TypeErrort popR t
Win32_BIOSt SerialNumbert BIOSVersionR ( RU t os_typet connt systemR( t domain_rolet warning_statest pc_system_typest productt pc_system_typet
processors( ( s; /usr/lib/python2.7/site-packages/salt/modules/win_system.pyt get_system_info� s�
c C@ s! t � d } | d k r t S| S( u�
Get the Windows computer description
Returns:
str: Returns the computer description if found. Otherwise returns
``False``.
CLI Example:
.. code-block:: bash
salt 'minion-id' system.get_computer_desc
u descriptionN( R� R R ( RO ( ( s; /usr/lib/python2.7/site-packages/salt/modules/win_system.pyRN � s
u get_computer_descriptionc C@ s d } t d d | � } | S( u�
Get the hostname of the windows minion
.. versionadded:: 2016.3.0
Returns:
str: Returns the hostname of the windows minion
CLI Example:
.. code-block:: bash
salt 'minion-id' system.get_hostname
u hostnameu cmd.runt cmd( RH ( R� R( ( ( s; /usr/lib/python2.7/site-packages/salt/modules/win_system.pyt get_hostname� s c C@ s8 t � } d j | | � } t d d | � } d | k S( uj
Set the hostname of the windows minion, requires a restart before this will
be updated.
.. versionadded:: 2016.3.0
Args:
hostname (str): The hostname to set
Returns:
bool: ``True`` if successful, otherwise ``False``
CLI Example:
.. code-block:: bash
salt 'minion-id' system.set_hostname newhostname
u; wmic computersystem where name='{0}' call rename name='{1}'u cmd.runR� u
successful( R� RS RH ( t hostnamet
curr_hostnameR� R( ( ( s; /usr/lib/python2.7/site-packages/salt/modules/win_system.pyt set_hostname� s c C@ sg t j r< t | � } t | � } t | � } t | � } n t � } d | k rq | d | k rq d j | � Sn | r� d | k r� d | k r� d j | | � } n | r� | d k r� d St | t j � r� | j d � } d j | � } n t
d | d | d
| d | d | � } | sHi | d 6t d
6} | rDt � | d
<n | St
t j | � j � � � d S( uO
Join a computer to an Active Directory domain. Requires a reboot.
Args:
domain (str):
The domain to which the computer should be joined, e.g.
``example.com``
username (str):
Username of an account which is authorized to join computers to the
specified domain. Needs to be either fully qualified like
``user@domain.tld`` or simply ``user``
password (str):
Password of the specified user
account_ou (str):
The DN of the OU below which the account for this computer should be
created when joining the domain, e.g.
``ou=computers,ou=departm_432,dc=my-company,dc=com``
account_exists (bool):
If set to ``True`` the computer will only join the domain if the
account already exists. If set to ``False`` the computer account
will be created if it does not exist, otherwise it will use the
existing account. Default is ``False``
restart (bool):
``True`` will restart the computer after a successful join. Default
is ``False``
.. versionadded:: 2015.8.2/2015.5.7
Returns:
dict: Returns a dictionary if successful, otherwise ``False``
CLI Example:
.. code-block:: bash
salt 'minion-id' system.join_domain domain='domain.tld' \
username='joinuser' password='joinpassword' \
account_ou='ou=clients,ou=org,dc=domain,dc=tld' \
account_exists=False, restart=True
u Domainu Already joined to {0}u \u @u {0}@{1}u. Must specify a password if you pass a usernameu t domaint usernamet passwordt
account_out account_existsu RestartN( R R* R t get_domain_workgroupRS R R R, R t joint _join_domainR R" R R. t
FormatMessaget rstrip( R� R� R� R� R� t restartt statust errR( ( ( s; /usr/lib/python2.7/site-packages/salt/modules/win_system.pyt join_domain� s2 4
c C@ s� d } d } d } d } d } | | O} | | O} | | O} | sO | | O} n t j j j � � t j � }
Wd QX|
j � d } | j d | d | d | d
| d | � d S( uD
Helper function to join the domain.
Args:
domain (str): The domain to which the computer should be joined, e.g.
``example.com``
username (str): Username of an account which is authorized to join
computers to the specified domain. Need to be either fully qualified
like ``user@domain.tld`` or simply ``user``
password (str): Password of the specified user
account_ou (str): The DN of the OU below which the account for this
computer should be created when joining the domain, e.g.
``ou=computers,ou=departm_432,dc=my-company,dc=com``
account_exists (bool): If set to ``True`` the computer will only join
the domain if the account already exists. If set to ``False`` the
computer account will be created if it does not exist, otherwise it
will use the existing account. Default is False.
Returns:
int:
:param domain:
:param username:
:param password:
:param account_ou:
:param account_exists:
:return:
i i i i i Nt Namet Passwordt UserNamet AccountOUt FJoinOptions( R R RV RW RX RY Rm t JoinDomainOrWorkgroup( R� R� R� R� R� t NETSETUP_JOIN_DOMAINt NETSETUP_ACCOUNT_CREATEt NETSETUP_DOMAIN_JOIN_IF_JOINEDt NETSETUP_JOIN_WITH_NEW_NAMEt join_optionsR� t comp( ( s; /usr/lib/python2.7/site-packages/salt/modules/win_system.pyR� s %
u WORKGROUPc
C@ s� t j r0 t | � } t | � } t | � } n t � } d | k re | d | k re d j | � Sn | r� d | k r� d | k r� | r� d j | | � } q� d Sn | r� | d
k r� d Sd } d } | r� | | O} n t j j j � � t
j � } Wd
QX| j � d }
|
j
d | d | d
| � } | d s�|
j d | � } | d s�i | d 6t d 6} | r}t � | d <n | St j t j | d � j � � t j d | � t Sn8 t j t j | d � j � � t j d | d � t Sd
S( u�
Unjoin a computer from an Active Directory Domain. Requires a restart.
Args:
username (str):
Username of an account which is authorized to manage computer
accounts on the domain. Needs to be a fully qualified name like
``user@domain.tld`` or ``domain.tld\user``. If the domain is not
specified, the passed domain will be used. If the computer account
doesn't need to be disabled after the computer is unjoined, this can
be ``None``.
password (str):
The password of the specified user
domain (str):
The domain from which to unjoin the computer. Can be ``None``
workgroup (str):
The workgroup to join the computer to. Default is ``WORKGROUP``
.. versionadded:: 2015.8.2/2015.5.7
disable (bool):
``True`` to disable the computer account in Active Directory.
Default is ``False``
restart (bool):
``True`` will restart the computer after successful unjoin. Default
is ``False``
.. versionadded:: 2015.8.2/2015.5.7
Returns:
dict: Returns a dictionary if successful, otherwise ``False``
CLI Example:
.. code-block:: bash
salt 'minion-id' system.unjoin_domain restart=True
salt 'minion-id' system.unjoin_domain username='unjoinuser' \
password='unjoinpassword' disable=True \
restart=True
u Workgroupu Already joined to {0}u \u @u {0}@{1}u/ Must specify domain if not supplied in usernameu. Must specify a password if you pass a usernamei i NR� R� t FUnjoinOptionsR� u Restartu! Failed to join the computer to %su! Failed to unjoin computer from %su Domain( R R* R R� RS R R R RV RW RX RY Rm t UnjoinDomainOrWorkgroupR� R R" R3 R1 R. R� R� (
R� R� R� t workgroupt disableR� R� t NETSETUP_ACCT_DELETEt unjoin_optionsR� R� R� R( ( ( s; /usr/lib/python2.7/site-packages/salt/modules/win_system.pyt
unjoin_domain\ sL 7
c C@ se t j j j � � t j � } Wd QXx9 | j � D]+ } | j rO i | j d 6Si | j d 6Sq2 Wd S( u
Get the domain or workgroup the computer belongs to.
.. versionadded:: 2015.5.7
.. versionadded:: 2015.8.2
Returns:
str: The name of the domain or workgroup
CLI Example:
.. code-block:: bash
salt 'minion-id' system.get_domain_workgroup
Nu Domainu Workgroup( R R RV RW RX RY Rm Rw Rs ( R� t computer( ( s; /usr/lib/python2.7/site-packages/salt/modules/win_system.pyR� � s c C@ sF d } x9 | D]1 } y t j | | � } PWq
t k
r= q
Xq
W| S( u$
A helper function that attempts to parse the input time_str as a date.
Args:
time_str (str): A string representing the time
fmts (list): A list of date format strings
Returns:
datetime: Returns a datetime object if parsed properly, otherwise None
N( R R R t
ValueError( t time_strt fmtst resultt fmt( ( s; /usr/lib/python2.7/site-packages/salt/modules/win_system.pyt _try_parse_datetime� s
c C@ s� t j � } d } t | d � } | d k r7 d } n4 | d k rL d } n | d k rk | d } d } n d j | | d | d | � S( u�
Get the system time.
Returns:
str: Returns the system time in HH:MM:SS AM/PM format.
CLI Example:
.. code-block:: bash
salt 'minion-id' system.get_system_time
u AMi i u PMi u {0:02d}:{1:02d}:{2:02d} {3}i i ( R. t GetLocalTimet intRS ( t nowt meridiant hours( ( s; /usr/lib/python2.7/site-packages/salt/modules/win_system.pyt get_system_time� s
c C@ sS d d d d g } t | | � } | d k r1 t St d | j d | j d | j � S( u�
Set the system time.
Args:
newtime (str):
The time to set. Can be any of the following formats:
- HH:MM:SS AM/PM
- HH:MM AM/PM
- HH:MM:SS (24 hour)
- HH:MM (24 hour)
Returns:
bool: ``True`` if successful, otherwise ``False``
CLI Example:
.. code-block:: bash
salt 'minion-id' system.set_system_time 12:01
u %I:%M:%S %pu %I:%M %pu %H:%M:%Su %H:%MR� t minutesR) N( R� R R t set_system_date_timet hourt minutet second( t newtimeR� R ( ( s; /usr/lib/python2.7/site-packages/salt/modules/win_system.pyt set_system_time s c C@ s y t j � } Wnf t j k
rx } | j \ } } }
t j d � t j d | � t j d | � t j d |
� t SX| d k r� | d } n | d k r� | d } n | d k r� | d } n | d k r� | d } n | d k r� | d } n | d k r| d
} n y� d t j f d � � Y} | � } t | � | _
t | � | _ t | � | _ t | � | _
t | � | _ t | � | _ t j | � }
t j j j |
� } | d k r�t St j d
� t t j | � j � � � Wn, t k
r} t j d
� t | � � n Xd S( u
Set the system date and time. Each argument is an element of the date, but
not required. If an element is not passed, the current system value for that
element will be used. For example, if you don't pass the year, the current
system year will be used. (Used by set_system_date and set_system_time)
Args:
years (int): Years digit, ie: 2015
months (int): Months digit: 1 - 12
days (int): Days digit: 1 - 31
hours (int): Hours digit: 0 - 23
minutes (int): Minutes digit: 0 - 59
seconds (int): Seconds digit: 0 - 59
Returns:
bool: ``True`` if successful, otherwise ``False``
CLI Example:
.. code-block:: bash
salt '*' system.set_system_date_ time 2015 5 12 11 37 53
u Failed to get local timeu nbr: %su ctx: %su msg: %si i i i i i t
SYSTEMTIMEc B@ sn e Z d e j f d e j f d e j f d e j f d e j f d e j f d e j f d e j f g Z RS( u wYearu wMonthu
wDayOfWeeku wDayu wHouru wMinuteu wSecondu
wMilliseconds( t __name__t
__module__t ctypest c_int16t _fields_( ( ( s; /usr/lib/python2.7/site-packages/salt/modules/win_system.pyR� m s u Failed to set local timeN( R. R� R1 R2 R3 R R R� t StructureR� t wYeart wMontht wDayt wHourt wMinutet wSecondt pointerR R? t SetLocalTimeR$ R R� R� t OSError( t yearst monthst daysR� R� R) t date_timeR6 R7 R8 R4 R� t system_timet system_time_ptrt succeededR� ( ( s; /usr/lib/python2.7/site-packages/salt/modules/win_system.pyR� 5 sP
c C@ s+ t j � } d j | d | d | d � S( u�
Get the Windows system date
Returns:
str: Returns the system date
CLI Example:
.. code-block:: bash
salt '*' system.get_system_date
u {0:02d}/{1:02d}/{2:04d}i i i ( R. R� RS ( R� ( ( s; /usr/lib/python2.7/site-packages/salt/modules/win_system.pyt get_system_date� s
c C@ sY d d d d d d g } t | | � } | d
k r7 t St d | j d | j d | j � S( u�
Set the Windows system date. Use <mm-dd-yy> format for the date.
Args:
newdate (str):
The date to set. Can be any of the following formats
- YYYY-MM-DD
- MM-DD-YYYY
- MM-DD-YY
- MM/DD/YYYY
- MM/DD/YY
- YYYY/MM/DD
Returns:
bool: ``True`` if successful, otherwise ``False``
CLI Example:
.. code-block:: bash
salt '*' system.set_system_date '03-28-13'
u %Y-%m-%du %m-%d-%Yu %m-%d-%yu %m/%d/%Yu %m/%d/%yu %Y/%m/%dR� R� R� N( R� R R R� t yeart montht day( t newdateR� R ( ( s; /usr/lib/python2.7/site-packages/salt/modules/win_system.pyt set_system_date� s c C@ s t d d � S( u�
Start the Windows time service
Returns:
bool: ``True`` if successful, otherwise ``False``
CLI Example:
.. code-block:: bash
salt '*' system.start_time_service
u
service.startu w32time( RH ( ( ( s; /usr/lib/python2.7/site-packages/salt/modules/win_system.pyt start_time_service� s
c C@ s t d d � S( u�
Stop the Windows time service
Returns:
bool: ``True`` if successful, otherwise ``False``
CLI Example:
.. code-block:: bash
salt '*' system.stop_time_service
u service.stopu w32time( RH ( ( ( s; /usr/lib/python2.7/site-packages/salt/modules/win_system.pyt stop_time_service� s
c C@ sA d } t d d | � r- t j d | � t St j d | � t S( ue
Determine whether there are pending Component Based Servicing tasks that
require a reboot.
.. versionadded:: 2016.11.0
Returns:
bool: ``True`` if there are pending Component Based Servicing tasks,
otherwise ``False``
CLI Example:
.. code-block:: bash
salt '*' system.get_pending_component_servicing
uQ SOFTWARE\Microsoft\Windows\CurrentVersion\Component Based Servicing\RebootPendingu reg.key_existsu HKLMu Key exists: %su Key does not exist: %s( t __utils__R3 t debugR$ R ( t key( ( s; /usr/lib/python2.7/site-packages/salt/modules/win_system.pyt get_pending_component_servicing� s c C@ s� d } d j | � } d j | � } t d d | � rK t j d | � t St j d | � t d d | � r� t j d | � t St j d | � t S( uF
Determine whether there is a pending domain join action that requires a
reboot.
.. versionadded:: 2016.11.0
Returns:
bool: ``True`` if there is a pending domain join action, otherwise
``False``
CLI Example:
.. code-block:: bash
salt '*' system.get_pending_domain_join
u* SYSTEM\CurrentControlSet\Services\Netlogonu {0}\AvoidSpnSetu {0}\JoinDomainu reg.key_existsu HKLMu Key exists: %su Key does not exist: %s( RS R� R3 R� R$ R ( t base_keyt avoid_keyt join_key( ( s; /usr/lib/python2.7/site-packages/salt/modules/win_system.pyt get_pending_domain_join� s c C@ s� d } d } xo | D]g } t d d | | � } | d rj t j d | � | d rz | d d k rz t Sq t j d
| � q Wt S( uK
Determine whether there are pending file rename operations that require a
reboot.
.. versionadded:: 2016.11.0
Returns:
bool: ``True`` if there are pending file rename operations, otherwise
``False``
CLI Example:
.. code-block:: bash
salt '*' system.get_pending_file_rename
u PendingFileRenameOperationsu PendingFileRenameOperations2u0 SYSTEM\CurrentControlSet\Control\Session Manageru reg.read_valueu HKLMu successu
Found key: %su vdatau (value not set)u Unable to access key: %s( u PendingFileRenameOperationsu PendingFileRenameOperations2( RH R3 R� R$ R ( t vnamesR� t vnamet reg_ret( ( s; /usr/lib/python2.7/site-packages/salt/modules/win_system.pyt get_pending_file_rename$ s
c C@ s� d } d } t d d | | � } | d rq t j d | � y t | d � d k rY t SWq� t k
rm q� Xn t j d | � t S(
uI
Determine whether there are pending Server Manager tasks that require a
reboot.
.. versionadded:: 2016.11.0
Returns:
bool: ``True`` if there are pending Server Manager tasks, otherwise
``False``
CLI Example:
.. code-block:: bash
salt '*' system.get_pending_servermanager
u CurrentRebootAttemptsu SOFTWARE\Microsoft\ServerManageru reg.read_valueu HKLMu successu
Found key: %su vdatai u Unable to access key: %s( RH R3 R� R� R$ R� R ( R� R� R� ( ( s; /usr/lib/python2.7/site-packages/salt/modules/win_system.pyt get_pending_servermanagerH s
c C@ sA d } t d d | � r- t j d | � t St j d | � t S( u
Determine whether there are pending updates that require a reboot.
.. versionadded:: 2016.11.0
Returns:
bool: ``True`` if there are pending updates, otherwise ``False``
CLI Example:
.. code-block:: bash
salt '*' system.get_pending_update
uR SOFTWARE\Microsoft\Windows\CurrentVersion\WindowsUpdate\Auto Update\RebootRequiredu reg.key_existsu HKLMu Key exists: %su Key does not exist: %s( R� R3 R� R$ R ( R� ( ( s; /usr/lib/python2.7/site-packages/salt/modules/win_system.pyt get_pending_updateo s u; SYSTEM\CurrentControlSet\Services\salt-minion\Volatile-Datau Reboot requiredc
C@ s/ t d d d d t d t d t d d d d
� S( ul
This function is used to remember that an event indicating that a reboot is
required was witnessed. This function relies on the salt-minion's ability to
create the following volatile registry key in the *HKLM* hive:
*SYSTEM\\CurrentControlSet\\Services\\salt-minion\\Volatile-Data*
Because this registry key is volatile, it will not persist beyond the
current boot session. Also, in the scope of this key, the name *'Reboot
required'* will be assigned the value of *1*.
For the time being, this function is being used whenever an install
completes with exit code 3010 and can be extended where appropriate in the
future.
.. versionadded:: 2016.11.0
Returns:
bool: ``True`` if successful, otherwise ``False``
CLI Example:
.. code-block:: bash
salt '*' system.set_reboot_required_witnessed
u
reg.set_valuet hiveu HKLMR� t volatileR� t vdatai t vtypeu REG_DWORD( RH t MINION_VOLATILE_KEYR$ t REBOOT_REQUIRED_NAME( ( ( s; /usr/lib/python2.7/site-packages/salt/modules/win_system.pyt set_reboot_required_witnessed� s c C@ s- t d d d d t d t � } | d d k S( u@
Determine if at any time during the current boot session the salt minion
witnessed an event indicating that a reboot is required.
This function will return ``True`` if an install completed with exit
code 3010 during the current boot session and can be extended where
appropriate in the future.
.. versionadded:: 2016.11.0
Returns:
bool: ``True`` if the ``Requires reboot`` registry flag is set to ``1``,
otherwise ``False``
CLI Example:
.. code-block:: bash
salt '*' system.get_reboot_required_witnessed
u reg.read_valueR� u HKLMR� R� u vdatai ( RH R� R� ( t
value_dict( ( s; /usr/lib/python2.7/site-packages/salt/modules/win_system.pyt get_reboot_required_witnessed� s c C@ s= t t t t t t t f } x | D] } | � r" t Sq" Wt S( u
Determine whether there is a reboot pending.
.. versionadded:: 2016.11.0
Returns:
bool: ``True`` if the system is pending reboot, otherwise ``False``
CLI Example:
.. code-block:: bash
salt '*' system.get_pending_reboot
( R� R� R� R� R RD R� R$ R ( t checkst check( ( s; /usr/lib/python2.7/site-packages/salt/modules/win_system.pyR+ � s
(Q t __doc__t
__future__R R R R� t loggingR% R R t salt.utils.functoolsR t salt.utils.localest salt.utils.platformt salt.utils.winapit salt.exceptionsR t salt.extR RX RK R. RA R0 R R$ R t ImportErrorR t getLoggerR� R3 R
R R R R R R R! R" R R R9 R; R> RG RD RC RQ R t functoolst alias_functiont set_computer_descriptionR� RN t get_computer_descriptionR� R� R� R� R� R� R� R� R� R� R� R� R� R� R� R� R� R� R� R� R� R R R+ ( ( ( s; /usr/lib/python2.7/site-packages/salt/modules/win_system.pyt <module>
s�
> V " - � S 9 g # Q % & $ ' #
Mini Shell