File: //opt/saltstack/salt/lib/python3.10/site-packages/salt/modules/__pycache__/win_task.cpython-310.pyc
o
�N�gh> � @ s� d Z ddlZddlZddlmZ ddlZddlZddlmZm Z zddl
Z
ddl Z ddl Z
dZW n ey; dZY nw e�e�ZdZdZdZd Zd
ZdZd Zd Zd
Zd Z d Z dZ d Z dZ dZ!dZ"dZ#d Z$d Z%d
Z&dZ'd Z(d Z)d
Z*dZ+dZ,d Z-dZ.d Z/dZ0d Z1d Z2d
Z3dZ4dZ5d Z6d Z7d
Z8dZ9dZ:d Z;d
Z<dZ=dZ>dZ?i dd�dd�dd�dd�dd �d d �d d �d!d"�d#d$�d%d&�d'd(�d)d*�d+d,�d-d.�d/d0�d1d2d3g�d4d5d6g�d7d8d9d:d;��Z@eeed<�ZAe5e6e7e8e9e:e;e<e=e>e?d=� ZBe0d>e1d?e2d@e3dAe4dBiZCe#e$e%e&dC�ZDi ddD�d dE�d dF�dGdH�dIdJ�dKdL�dMdN�dOdP�dQdR�dSdT�dUdV�dWdX�dYdZ�d[d\�d]d^�d_d`�ZEdadb� ZFdcdd� ZGdedf� ZHdgdh� ZIdidj� ZJdkdl� ZKdmdn� ZLd�dpdq�ZMd�drds�ZNd�dtdu�ZOd�dvdw�ZP d�dydz�ZQ d�d{d|�ZRd�d}d~�ZS o
d�dd��ZTd�d�d��ZUd�d�d��ZVd�d�d��ZWd�d�d��ZXd�d�d��ZYd�d�d��ZZd�d�d��Z[d�d�d��Z\d�d�d��Z] o d�d�d��Z^d�d�d��Z_dS )�z�
Windows Task Scheduler Module
.. versionadded:: 2016.3.0
A module for working with the Windows Task Scheduler.
You can add and edit existing tasks.
You can add and clear triggers and actions.
You can list all tasks, folders, triggers, and actions.
� N)�datetime)�ArgumentValueError�CommandExecutionErrorTF�task� � � � � � � � � � � � � ImmediatelyZPT0MZ Indefinitely� z Do not waitz
15 secondsZPT15Sz
30 secondsZPT30Sz1 minuteZPT1Mz 5 minutesZPT5Mz
10 minutesZPT10Mz
15 minutesZPT15Mz
30 minutesZPT30Mz1 hourZPT1Hz2 hoursZPT2Hz4 hoursZPT4Hz8 hoursZPT8Hz12 hoursZPT12Hz1 dayZP1DZPT24Hz3 daysZP3DZPT72HZP30DZP90DZP180DZP365D)z30 daysz90 daysz180 daysz365 days)�ExecuteZEmail�Message) �EventZOnceZDailyZWeeklyZMonthlyZ
MonthlyDayZOnIdleZOnTaskCreationZOnBootZOnLogonZOnSessionChangeZUnknownZDisabledZQueuedZReadyZRunning)ZParallel�QueuezNo New Instancez
Stop Existingz$The operation completed successfullyz$Incorrect or unknown function calledzFile not found�
z The environment is incorrecti z/Task is ready to run at its next scheduled timei zTask is currently runningi zTask is disabledi zTask has not yet runi z.There are no more runs scheduled for this taski z Task was terminated by the user� z Credentials became corruptedl z+An instance of this task is already runningl � z5The operator or administrator has refused the requestl � z7The service is not available (Run only when logged in?)l : z0The application terminated as a result of CTRL+Cl ~ � zUnknown software exceptionc C s$ t jj�� rtst�dt� tS dS )z'
Only works on Windows systems
z"Could not load dependencies for %s)Fz5Module win_task: module only works on Windows systems)�salt�utils�platformZ
is_windows�HAS_DEPENDENCIES�log�warning�__virtualname__� r! r! �I/opt/saltstack/salt/lib/python3.10/site-packages/salt/modules/win_task.py� __virtual__� s
r# c C s | dk r| d } | S )z?
Convert negative result and error codes from win32com
r l r! )�coder! r! r" �_signed_to_unsigned_int32� s r% c C s> g d�}|D ]}z t �| |� |W S ty Y qw dS )z�
Copied from win_system.py (_get_date_time_format)
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
)
z %I:%M:%S %pz%I:%M %p�%H:%M:%Sz%H:%M�%Y-%m-%dz%m-%d-%yz%m-%d-%Yz%m/%d/%yz%m/%d/%Yz%Y/%m/%dF)r �strptime�
ValueError)Z dt_stringZ
valid_formatsZ dt_formatr! r! r" �_get_date_time_format� s
�r* c C s z| � W S t y Y dS w )a&
Function for dealing with PyTime values with invalid dates. ie: 12/30/1899
which is the windows task scheduler value for Never
:param obj date: A PyTime object
:return: A string value representing the date or the word "Never" for
invalid date strings
:rtype: str
ZNever)r) )�dater! r! r" �_get_date_value� s
�r, c C s^ d}t | �� �D ]\}}t|t�r||v r|} n
q||kr"|} nq|dk r)dS t| �| S )a
Lookup the key in a dictionary by its value. Will return the first match.
:param dict dictionary: The dictionary to search
:param str value: The value to search for.
:return: Returns the first key to match the value
:rtype: str
���r z
invalid value)� enumerate�values�
isinstance�list)�
dictionary�valueZ value_index�idxZ
dict_valuer! r! r" �_reverse_lookup� s
�� r5 c C s | | }t |t�r
|d S |S )a
Lookup the first value given a key. Returns the first value if the key
refers to a list or the value itself.
:param dict dictionary: The dictionary to search
:param str key: The key to get
:return: Returns the first value available for the key
:rtype: str
r )r0 r1 )r2 �keyr3 r! r! r" �
_lookup_first s
r7 c C s� z
|� | |t|||� W dS tjyW } z=|j\}}} }
t| d �} dddddd�} z| | }
W n tyA d t| �� �}
Y nw t� d
|
� d |
� �W Y d }~S d }~ww )
a
Internal function to save the task definition.
:param str name: The name of the task.
:param str task_folder: The object representing the folder in which to save
the task
:param str task_definition: The object representing the task to be saved
:param str user_name: The user_account under which to run the task
:param str password: The password that corresponds to the user account
:param int logon_type: The logon type for the task.
:return: True if successful, False if not
:rtype: bool
Tr zAThe filename, directory name, or volume label syntax is incorrectz)The system cannot find the file specified�%Required element or attribute missing�+Value incorrectly formatted or out of range�
Access denied)l { l � � � �Unknown Failure: zFailed to modify task: %szFailed to modify task: N)
ZRegisterTaskDefinition�TASK_CREATE_OR_UPDATE� pythoncom� com_error�argsr% �KeyError�hexr �debug)�name� task_folder�task_definition� user_name�password�
logon_type�error�hr�msg�exc�arg�
error_code�fc� failure_coder! r! r" �_save_task_definition! s8 � � � ��rT �\c C s� t jj�� �C tj�d�}|�� z|�| �}W n t j
y. d| � �}t � |� t
|��w |�d�}g }|D ]}|�|j� q8W d � |S 1 sLw Y |S )av
List all tasks located in a specific location in the task scheduler.
Args:
location (str):
A string value representing the folder from which you want to list
tasks. Default is ``\`` which is the root for the task scheduler
(``C:\Windows\System32\tasks``).
Returns:
list: Returns a list of tasks
CLI Example:
.. code-block:: bash
# List all tasks in the default location
salt 'minion-id' task.list_tasks
# List all tasks in the Microsoft\XblGameSave Directory
salt 'minion-id' task.list_tasks Microsoft\XblGameSave
�Schedule.ServicezUnable to load location: r N)r r �winapi�Com�win32com�client�Dispatch�Connect� GetFolder�
pywintypesrA r rL r ZGetTasks�append�Name)�location� task_servicerG rN Ztasks�retr r! r! r" �
list_tasksY s&
�
�
��rd c C st t jj�� �* tj�d�}|�� |�| �}|� d�}g }|D ]}|�
|j � q W d � |S 1 s3w Y |S )ak
List all folders located in a specific location in the task scheduler.
Args:
location (str):
A string value representing the folder from which you want to list
tasks. Default is ``\`` which is the root for the task scheduler
(``C:\Windows\System32\tasks``).
Returns:
list: Returns a list of folders.
CLI Example:
.. code-block:: bash
# List all folders in the default location
salt 'minion-id' task.list_folders
# List all folders in the Microsoft directory
salt 'minion-id' task.list_folders Microsoft
rV r N) r r rW rX rY rZ r[ r\ r] Z
GetFoldersr_ r` )ra rb rG Zfoldersrc Zfolderr! r! r" � list_folders� s
�
� � re c C �| t jj�� �. tj�d�}|�� |�|�}|� | �j
}|j }g }|D ]}|� |j
� q#W d � |S 1 s7w Y |S )a
List all triggers that pertain to a task in the specified location.
Args:
name (str):
The name of the task for which list triggers.
location (str):
A string value representing the location of the task from which to
list triggers. Default is ``\`` which is the root for the task
scheduler (``C:\Windows\System32\tasks``).
Returns:
list: Returns a list of triggers.
CLI Example:
.. code-block:: bash
# List all triggers for a task in the default location
salt 'minion-id' task.list_triggers <task_name>
# List all triggers for the XblGameSaveTask in the Microsoft\XblGameSave
# location
salt '*' task.list_triggers XblGameSaveTask Microsoft\XblGameSave
rV N)r r rW rX rY rZ r[ r\ r] �GetTask�
Definition�Triggersr_ �Id)rF ra rb rG rH �triggersrc �triggerr! r! r" �
list_triggers� �
�
�
�
rm c C rf )a
List all actions that pertain to a task in the specified location.
Args:
name (str):
The name of the task for which list actions.
location (str):
A string value representing the location of the task from which to
list actions. Default is ``\`` which is the root for the task
scheduler (``C:\Windows\System32\tasks``).
Returns:
list: Returns a list of actions.
CLI Example:
.. code-block:: bash
# List all actions for a task in the default location
salt 'minion-id' task.list_actions <task_name>
# List all actions for the XblGameSaveTask in the Microsoft\XblGameSave
# location
salt 'minion-id' task.list_actions XblGameSaveTask Microsoft\XblGameSave
rV N)r r rW rX rY rZ r[ r\ r] rg rh �Actionsr_ rj )rF ra rb rG rH �actionsrc �actionr! r! r" � list_actions� rn rr �Systemc K s� | t |�v r
|s
| � d�S tjj�� �G tj�d�}|�� |� d�}t
d|||d�|�� t dd|i|�� t dd|i|�� |�
|�}t| |||jj||jjd� W d � n1 s]w Y | t |�v S ) aE
Create a new task in the designated location. This function has many keyword
arguments that are not listed here. For additional arguments see:
- :py:func:`edit_task`
- :py:func:`add_action`
- :py:func:`add_trigger`
Args:
name (str):
The name of the task. This will be displayed in the task scheduler.
location (str):
A string value representing the location in which to create the
task. Default is ``\`` which is the root for the task scheduler
(``C:\Windows\System32\tasks``).
user_name (str):
The user account under which to run the task. To specify the
'System' account, use 'System'. The password will be ignored.
password (str):
The password to use for authentication. This should set the task to
run whether the user is logged in or not, but is currently not
working.
force (bool):
If the task exists, overwrite the existing task.
Returns:
bool: ``True`` if successful, otherwise ``False``
CLI Example:
.. code-block:: bash
salt 'minion-id' task.create_task <task_name> user_name=System force=True action_type=Execute cmd='del /Q /S C:\\Temp' trigger_type=Once start_date=2016-12-1 start_time='"01:00"'
� already existsrV r )rH rI rJ rH �rF rG rH rI rJ rK Nr! )rd r r rW rX rY rZ r[ r\ ZNewTask� edit_task�
add_action� add_triggerr] rT � Principal�UserID� LogonType) rF ra rI rJ �force�kwargsrb rH rG r! r! r" � create_task s4 +
��
� � #r~ c C s� | t |�v r | � d�S |s|std��tjj�� �� tj�d�}|� � |r(|}|�
|�}|rD|� � dkr<t }d}d}n |rAt
}nt}nd}t}z |�| |t|||� W n� tjy� } z|| j\}
} } }
t| d �}i dd �d
d �d d
�dd�dd�dd�dd�dd�dd�dd�d d �d d �d d!�d"d#�d$d%�d&d'�d(d)�d*d+d,��}z-z|| }W n ty� d-t|�� �}Y n w W t�d.|� t|��W t�d.|� t|��t�d.|� w d} ~ ww W d � n1 s�w Y | t |�v S )/a�
Create a task based on XML. Source can be a file or a string of XML.
Args:
name (str):
The name of the task. This will be displayed in the task scheduler.
location (str):
A string value representing the location in which to create the
task. Default is ``\`` which is the root for the task scheduler
(``C:\Windows\System32\tasks``).
xml_text (str):
A string of xml representing the task to be created. This will be
overridden by ``xml_path`` if passed.
xml_path (str):
The path to an XML file on the local system containing the xml that
defines the task. This will override ``xml_text``
user_name (str):
The user account under which to run the task. To specify the
'System' account, use 'System'. The password will be ignored.
password (str):
The password to use for authentication. This should set the task to
run whether the user is logged in or not, but is currently not
working.
Returns:
bool: ``True`` if successful, otherwise ``False``
str: A string with the error message if there is an error
Raises:
ArgumentValueError: If arguments are invalid
CommandExecutionError
CLI Example:
.. code-block:: bash
salt '*' task.create_task_from_xml <task_name> xml_path=C:\task.xml
rt z(Must specify either xml_text or xml_pathrV �system�SYSTEMNr r; r8 r< r9 r= r: l z A task's trigger is not foundl
zIOne or more of the properties required to run this task have not been setl z<The Task Scheduler service is not installed on this computerl
z#The task object could not be openedl zCThe object is either an invalid task object or is not a task objectr zdNo account information could be found in the Task Scheduler security database for the task indicatedl z6Unable to establish existence of the account specifiedl z\Corruption was detected in the Task Scheduler security database; the database has been resetl z8The task object version is either unsupported or invalidl zeThe task has been configured with an unsupported combination of account settings and run time optionsl z)The Task Scheduler Service is not runningl z(The task XML contains an unexpected nodel zJThe task XML contains an element or attribute from an unexpected namespacel zThe task XML is malformedzoThe task is registered, but may fail to start. Batch logon privilege needs to be enabled for the task principalz5The task XML contains too many nodes of the same type)i l r> zFailed to create task: %s)rd r r r rW rX rY rZ r[ r\ r] �lower�TASK_LOGON_SERVICE_ACCOUNT�TASK_LOGON_PASSWORD� TASK_LOGON_INTERACTIVE_TOKEN�TASK_LOGON_NONEZ RegisterTask� TASK_CREATEr@ rA rB r% rC rD r rE r )rF ra Zxml_textZxml_pathrI rJ rb rG rK rL rM rN rO rP rQ rR rS r! r! r" �create_task_from_xml_ s� 0
� ����� � �
������ � �!�%�'�, �� � ���� � Yr� c C sv | t |�v r | � d�S tjj�� � tj�d�}|�� |� |�}|�
| � W d � n1 s0w Y | t |�v S )a@
Create a folder in which to create tasks.
Args:
name (str):
The name of the folder. This will be displayed in the task
scheduler.
location (str):
A string value representing the location in which to create the
folder. Default is ``\`` which is the root for the task scheduler
(``C:\Windows\System32\tasks``).
Returns:
bool: ``True`` if successful, otherwise ``False``
CLI Example:
.. code-block:: bash
salt 'minion-id' task.create_folder <folder_name>
rt rV N) re r r rW rX rY rZ r[ r\ r] Z CreateFolder�rF ra rb rG r! r! r" �
create_folder� s
� r� c K s t jj�� ��� d}|�dd�r|�d�} n5d}| s# W d � dS | t|�v r?tj�d�} | � � | �
|�} | � | �j } n | � d�W d � S |rUd| j
_d | j
_|dur]|| j
_|r�|�� d
krlt} d }d}n || j_|rut} nt} || j_|| j_| | j_t| j_nd}d}|dur�|| j _ |dur�|| j _ |dur�|| j _ | j j r�|
dur�|
| j j _!| dur�| | j j _"|dur�|t#v r�t$t#|�| j j _%n W d � d S | dur�| t#v r�t$t#| �| j j _&n W d � d
S | dur�| | j _'|
dur�|
| j _(|du�r|| j _)|du�r|| j _*| j j*�r%|�r || j j+_|�r%|| j j+_,|du�r.|| j _-|du�r7|| j _.|du�r\|du �rFd| j _/n|t#v �rSt$t#|�| j _/n W d � dS | j j/�r||du�r||t0dd�v �rs|| j _1n W d � dS |du�r�|du �r�d| j _2n|t#v �r�t$t#|�| j _2n W d � dS |du�r�|| j _3|du�r�|du �r�d| j _4n|t#v �r�t$t#|�| j _4n W d � dS |du�r�t5| | j _6|�r�t7| | | ||| jjd�W d � S W d � dS 1 �s�w Y dS )a�
Edit the parameters of a task. Triggers and Actions cannot be edited yet.
Args:
name (str):
The name of the task. This will be displayed in the task scheduler.
location (str):
A string value representing the location in which to create the
task. Default is ``\`` which is the root for the task scheduler
(``C:\Windows\System32\tasks``).
user_name (str):
The user account under which to run the task. To specify the
'System' account, use 'System'. The password will be ignored.
password (str):
The password to use for authentication. This should set the task to
run whether the user is logged in or not, but is currently not
working.
.. note::
The combination of user_name and password determine how the
task runs. For example, if a username is passed without at
password the task will only run when the user is logged in. If a
password is passed as well the task will run whether the user is
logged on or not. If you pass 'System' as the username the task
will run as the system account (the password parameter is
ignored).
description (str):
A string representing the text that will be displayed in the
description field in the task scheduler.
enabled (bool):
A boolean value representing whether or not the task is enabled.
hidden (bool):
A boolean value representing whether or not the task is hidden.
run_if_idle (bool):
Boolean value that indicates that the Task Scheduler will run the
task only if the computer is in an idle state.
idle_duration (str):
A value that indicates the amount of time that the computer must be
in an idle state before the task is run. Valid values are:
- 1 minute
- 5 minutes
- 10 minutes
- 15 minutes
- 30 minutes
- 1 hour
idle_wait_timeout (str):
A value that indicates the amount of time that the Task Scheduler
will wait for an idle condition to occur. Valid values are:
- Do not wait
- 1 minute
- 5 minutes
- 10 minutes
- 15 minutes
- 30 minutes
- 1 hour
- 2 hours
idle_stop_on_end (bool):
Boolean value that indicates that the Task Scheduler will terminate
the task if the idle condition ends before the task is completed.
idle_restart (bool):
Boolean value that indicates whether the task is restarted when the
computer cycles into an idle condition more than once.
ac_only (bool):
Boolean value that indicates that the Task Scheduler will launch the
task only while on AC power.
stop_if_on_batteries (bool):
Boolean value that indicates that the task will be stopped if the
computer begins to run on battery power.
wake_to_run (bool):
Boolean value that indicates that the Task Scheduler will wake the
computer when it is time to run the task.
run_if_network (bool):
Boolean value that indicates that the Task Scheduler will run the
task only when a network is available.
network_id (guid):
GUID value that identifies a network profile.
network_name (str):
Sets the name of a network profile. The name is used for display
purposes.
allow_demand_start (bool):
Boolean value that indicates that the task can be started by using
either the Run command or the Context menu.
start_when_available (bool):
Boolean value that indicates that the Task Scheduler can start the
task at any time after its scheduled time has passed.
restart_every (str):
A value that specifies the interval between task restart attempts.
Valid values are:
- False (to disable)
- 1 minute
- 5 minutes
- 10 minutes
- 15 minutes
- 30 minutes
- 1 hour
- 2 hours
restart_count (int):
The number of times the Task Scheduler will attempt to restart the
task. Valid values are integers 1 - 999.
execution_time_limit (bool, str):
The amount of time allowed to complete the task. Valid values are:
- False (to disable)
- 1 hour
- 2 hours
- 4 hours
- 8 hours
- 12 hours
- 1 day
- 3 days
force_stop (bool):
Boolean value that indicates that the task may be terminated by
using TerminateProcess.
delete_after (bool, str):
The amount of time that the Task Scheduler will wait before deleting
the task after it expires. Requires a trigger with an expiration
date. Valid values are:
- False (to disable)
- Immediately
- 30 days
- 90 days
- 180 days
- 365 days
multiple_instances (str):
Sets the policy that defines how the Task Scheduler deals with
multiple instances of the task. Valid values are:
- Parallel
- Queue
- No New Instance
- Stop Existing
Returns:
bool: ``True`` if successful, otherwise ``False``
CLI Example:
.. code-block:: bash
salt '*' task.edit_task <task_name> description='This task is awesome'
FrH TN�$Required parameter "name" not passedrV �
not foundz Salt MinionzSalt Minion Daemonr r� z!Invalid value for "idle_duration"z%Invalid value for "idle_wait_timeout"r z!Invalid value for "restart_every"r i� z1"restart_count" must be a value between 1 and 999�PT0Sz(Invalid value for "execution_time_limit"z Invalid value for "delete_after"ru )8r r rW rX �getrd rY rZ r[ r\ r] rg rh ZRegistrationInfoZAuthorZSourceZ Descriptionr� r� ry rj r� r� rz Z DisplayNamer{ �TASK_RUNLEVEL_HIGHESTZRunLevel�Settings�EnabledZHidden�
RunOnlyIfIdle� IdleSettings�
StopOnIdleEnd�
RestartOnIdle�durationr7 � IdleDuration� WaitTimeout�DisallowStartIfOnBatteries�StopIfGoingOnBatteries� WakeToRun�RunOnlyIfNetworkAvailable�NetworkSettingsr` �AllowDemandStart�StartWhenAvailable�RestartInterval�range� RestartCount�ExecutionTimeLimit�AllowHardTerminate�DeleteExpiredTaskAfter� instances�MultipleInstancesrT ) rF ra rI rJ � description�enabledZhidden� run_if_idle�
idle_duration�idle_wait_timeout�idle_stop_on_end� idle_restart�ac_only�stop_if_on_batteries� wake_to_run�run_if_network�
network_id� network_name�allow_demand_start�start_when_availableZ
restart_every�
restart_count�execution_time_limit�
force_stop� delete_after�multiple_instancesr} �save_definitionrH rb rG rK r! r! r" rv s O �
�
��U ��^
��
~
��
� ��
� ��
� �� �$�rv c C �| | t |�vr
| � d|� �S tjj�� � tj�d�}|�� |� |�}|�
| d� W d � n1 s3w Y | t |�vS )a�
Delete a task from the task scheduler.
Args:
name (str):
The name of the task to delete.
location (str):
A string value representing the location of the task. Default is
``\`` which is the root for the task scheduler
(``C:\Windows\System32\tasks``).
Returns:
bool: ``True`` if successful, otherwise ``False``
CLI Example:
.. code-block:: bash
salt 'minion-id' task.delete_task <task_name>
� not found in rV r N) rd r r rW rX rY rZ r[ r\ r] Z
DeleteTaskr� r! r! r" � delete_task� s
�
r� c C r� )a
Delete a folder from the task scheduler.
Args:
name (str):
The name of the folder to delete.
location (str):
A string value representing the location of the folder. Default is
``\`` which is the root for the task scheduler
(``C:\Windows\System32\tasks``).
Returns:
bool: ``True`` if successful, otherwise ``False``
CLI Example:
.. code-block:: bash
salt 'minion-id' task.delete_folder <folder_name>
r� rV r N) re r r rW rX rY rZ r[ r\ r] Z DeleteFolderr� r! r! r" �
delete_folder� s
� r� c C � | t |�vr
| � d|� �S tjj�� �5 tj�d�}|�� |� |�}|�
| �}z|� d� W W d � dS t j
yG Y W d � dS w 1 sKw Y dS )a�
Run a scheduled task manually.
Args:
name (str):
The name of the task to run.
location (str):
A string value representing the location of the task. Default is
``\`` which is the root for the task scheduler
(``C:\Windows\System32\tasks``).
Returns:
bool: ``True`` if successful, otherwise ``False``
CLI Example:
.. code-block:: bash
salt 'minion-id' task.run <task_name>
r� rV r NTF)rd r r rW rX rY rZ r[ r\ r] rg �Runr@ rA �rF ra rb rG r r! r! r" �run� �
� � �r� c C s2 | t |�vr
| � d|� �S tjj�� �| tj�d�}|�� |� |�}|�
| �}|j t kr6 W d � dS z|�
d� t�d� d}W n tjyU Y W d � dS w |r�d}z|�d �}|jro|D ] }|j| krnd}qeW n tjy| d}Y nw |sXW d � dS W d � dS 1 s�w Y dS )
a�
Run a scheduled task and return when the task finishes
Args:
name (str):
The name of the task to run.
location (str):
A string value representing the location of the task. Default is
``\`` which is the root for the task scheduler
(``C:\Windows\System32\tasks``).
Returns:
bool: ``True`` if successful, otherwise ``False``
CLI Example:
.. code-block:: bash
salt 'minion-id' task.run_wait <task_name>
r� rV NzTask already runningr r TFr )rd r r rW rX rY rZ r[ r\ r] rg �State�TASK_STATE_RUNNINGr� �time�sleepr@ rA ZGetRunningTasksZCountr` )rF ra rb rG r ZrunningZ
running_tasks�itemr! r! r" �run_wait sL
�
�
���
� �
� � r� c C r� )a�
Stop a scheduled task.
Args:
name (str):
The name of the task to stop.
location (str):
A string value representing the location of the task. Default is
``\`` which is the root for the task scheduler
(``C:\Windows\System32\tasks``).
Returns:
bool: ``True`` if successful, otherwise ``False``
CLI Example:
.. code-block:: bash
salt 'minion-id' task.list_stop <task_name>
r� rV r NTF)rd r r rW rX rY rZ r[ r\ r] rg ZStopr@ rA r� r! r! r" �stopP r� r� c C s| | t |�vr
| � d|� �S tjj�� �! tj�d�}|�� |� |�}|�
| �}t |j W d � S 1 s7w Y dS )a�
Determine the status of a task. Is it Running, Queued, Ready, etc.
Args:
name (str):
The name of the task for which to return the status
location (str):
A string value representing the location of the task. Default is
``\`` which is the root for the task scheduler
(``C:\Windows\System32\tasks``).
Returns:
str: The current status of the task. Will be one of the following:
- Unknown
- Disabled
- Queued
- Ready
- Running
CLI Example:
.. code-block:: bash
salt 'minion-id' task.list_status <task_name>
r� rV N)
rd r r rW rX rY rZ r[ r\ r] rg �statesr� r� r! r! r" �status{ s
$�r� c C s� | t |�vr
| � d|� �S tjj�� ��� tj�d�}|�� |� |�}|�
| �}t |j �}zt
| }W n tyD dt|�� �}Y nw |jt|j�||jt|j�t|j d�}|jj}|j|jd�} |jdkrnd| d< n|jd krxd
| d< nt t |j�| d< |j dks�|j d kr�d| d < nt t |j �| d < t t |j �| d < |j!dkr�d| d
< nt t |j!�| d
< | d
r�|j"| d< |j#| d< |j$| d< |j%|j&|j'|j(d�}
|
d r�|j)} | j*|
d< | j+|
d< | j,|
d< | j-|
d< |
d r�|j.} | j/|
d< | j0|
d< g }
|jj1D ]+}dt t2|j3�i}|j4�r|j4|d< |j5�r |j5|d < |j6�r&|j6|d < |
�7|� �qg }|jj8D ]�}d t t9|j3�i}|j �rIt t |j �|d < |j:�r^|j:�;d d �\}}||d!< ||d"< |j<�rs|j<�;d d �\}}||d#< ||d$< |j|d%< t=|d&��r�|j>�r�t t |j>�|d'< nd|d'< t=|d(��r�|j?�r�t t |j?�|d)< nd|d)< t=|d*��r�t t |j@jA�|d+< t t |j@jB�|d,< |j@jC|d-< |�7|� �q3| |d.< |
|d/< |
|d0< ||d1< |}W d2 � |S 1 �s�w Y |S )3a
Get the details about a task in the task scheduler.
Args:
name (str):
The name of the task for which to return the status
location (str):
A string value representing the location of the task. Default is
``\`` which is the root for the task scheduler
(``C:\Windows\System32\tasks``).
Returns:
dict: A dictionary containing the task configuration
CLI Example:
.. code-block:: bash
salt 'minion-id' task.info <task_name>
r� rV zUnknown Task Result: )r� Zlast_runZlast_run_resultZ missed_runsZnext_runr� )r� r� r Fr� r� r r� r� Zrestart_intervalr� r� r� )r� r� r� r� r� r� r� r� r� r� r� r� � action_type�cmd� argumentsZ working_dir� trigger_type�Tr �
start_date�
start_time�end_date�end_timer� � RandomDelay� random_delay�Delay�delay�
Repetition�repeat_duration�repeat_interval�repeat_stop_at_duration_end�settings�
conditionsrp rk N)Drd r r rW rX rY rZ r[ r\ r] rg r% ZLastTaskResult�resultsrC rD r� r, Z LastRunTimeZNumberOfMissedRunsZ NextRunTimer� r� rh r� r� r� r� r5 r� r� r� r� r� r� r� r� r� r� r� r� r� r� r� r� r� r� rj r` ro � action_typesZType�Path� Arguments�WorkingDirectoryr_ ri �
trigger_types�
StartBoundary�split� EndBoundary�hasattrr� r� r� �Duration�Interval�StopAtDurationEnd)rF ra rb rG r Zlast_task_result_codeZlast_task_resultZ
propertiesZdef_setr� r� Zidle_setZnet_setrp Z actionObjrq rk Z
triggerObjrl r� r� r� r� rc r! r! r" �info� s�
�� �
�
��
�
�
�
� ��� �
� �� r� r c K s t jj�� ��o d}|�dd�r|�d�}n5d}| s# W d � dS | t|�v r?tj�d�}|� � |�
|�}|� | �j }n | � d�W d � S |j
�t| �}t| tkr�d|_|�d d�ri|�d �|_n W d � d
S |�d d �|_|�d
d �|_n�t| tk�r d|_|�dd�r�|�d�|_n W d � dS |�dd�r�|�d�|_n W d � dS |�dd�s�|�dd�r�|�d�r�|�d�|_|�d�r�|�d�|_n W d � dS |�d�r�|�d�|_|�d�r�|�d�|_|�d��r|�d�|_ |�d��r|�d�|_ |�d��r |�d�|_ n8t| t k�rVd|_|�d d��r6|�d �|_ n W d � d S |�d d��rM|�d �|_!n W d � d S |�rnt"| |||j#j$d|j#j%d �W d � S W d � dS 1 �szw Y dS )!a�
Add an action to a task.
Args:
name (str):
The name of the task to which to add the action.
location (str):
A string value representing the location of the task. Default is
``\`` which is the root for the task scheduler
(``C:\Windows\System32\tasks``).
action_type (str):
The type of action to add. There are three action types. Each one
requires its own set of Keyword Arguments (kwargs). Valid values
are:
- Execute
- Email
- Message
Required arguments for each action_type:
**Execute**
Execute a command or an executable
cmd (str):
(required) The command or executable to run.
arguments (str):
(optional) Arguments to be passed to the command or executable.
To launch a script the first command will need to be the
interpreter for the script. For example, to run a vbscript you
would pass ``cscript.exe`` in the ``cmd`` parameter and pass the
script in the ``arguments`` parameter as follows:
- ``cmd='cscript.exe' arguments='c:\scripts\myscript.vbs'``
Batch files do not need an interpreter and may be passed to the
cmd parameter directly.
start_in (str):
(optional) The current working directory for the command.
**Email**
Send and email. Requires ``server``, ``from``, and ``to`` or ``cc``.
from (str): The sender
reply_to (str): Who to reply to
to (str): The recipient
cc (str): The CC recipient
bcc (str): The BCC recipient
subject (str): The subject of the email
body (str): The Message Body of the email
server (str): The server used to send the email
attachments (list):
A list of attachments. These will be the paths to the files to
attach. ie: ``attachments="['C:\attachment1.txt',
'C:\attachment2.txt']"``
**Message**
Display a dialog box. The task must be set to "Run only when user is
logged on" in order for the dialog box to display. Both parameters are
required.
title (str):
The dialog box title.
message (str):
The dialog box message body
Returns:
dict: A dictionary containing the task configuration
CLI Example:
.. code-block:: bash
salt 'minion-id' task.add_action <task_name> cmd='del /Q /S C:\\Temp'
FrH TNr� rV r� Z Execute_ID1r� z"Required parameter "cmd" not foundr� r Zstart_inZ Email_ID1Zserverz%Required parameter "server" not found�fromz#Required parameter "from" not found�toZccz)Required parameter "to" or "cc" not foundZreply_toZbcc�subject�body� attachmentsZ Message_ID1�titlez$Required parameter "title" not found�messagez&Required parameter "message" not foundru )&r r rW rX r� rd rY rZ r[ r\ r] rg rh ro �Creater� �TASK_ACTION_EXECrj r� r� r� �TASK_ACTION_SEND_EMAILZServerZFromZToZCcZReplyToZBccZSubjectZBodyZ Attachments�TASK_ACTION_SHOW_MESSAGEZTitleZ MessageBodyrT ry rz r{ ) rF ra r� r} r� rH rb rG Z task_actionr! r! r" rw Q s� ] �
� �# � /�4
��
=
��P�V��V$�rw c C � | t |�vr
| � d|� �S tjj�� �2 tj�d�}|�� |� |�}|�
| �j }|j }|�
� t| |||jjd|jjd�W d � S 1 sHw Y dS )as
Remove all actions from the task.
:param str name: The name of the task from which to clear all actions.
:param str location: A string value representing the location of the task.
Default is ``\`` which is the root for the task scheduler
(``C:\Windows\System32\tasks``).
:return: True if successful, False if unsuccessful
:rtype: bool
r� rV Nru )rd r r rW rX rY rZ r[ r\ r] rg rh ro �ClearrT ry rz r{ )rF ra rb rG rH rp r! r! r" �_clear_actions s$
�$�r� c & K s� |sdS ddddddd�}i dd�dd�dd�dd�d d
�d d �dd
�dd�dd�dd�dd�dd�dd�dd�dd �d
d �d d �d d!d"d#d$d%d&d'd(d)d*d+d,d-d.d/��}ddddd
d d
d0�}ddddd1�}ddddd
d d
dddddd2� }|r�t |�}|r�t�||�}nd3S t�� }|r�t |�}|r�t�||�}nd4S t�d5d6�}d7�|�d8�|�d6��}d9}|r�t |�}|r�t�||�}nd:S |r�t |�}|r�t�||�}nd;S t�d5d6�}d9}|r�|r�d7�|�d8�|�d6��}tjj� � ��z d<}|�
d=d<�r�|�
d=�}n7d>}| �s W d9 � d?S | t |�v �r)t j
�d@�} | �� | �|�} | �| �j}n | � dA�W d9 � S |j�t| �} || _|
�rItt|
�| _|�rRtt|�| _| �rjtt| �| j_ |
�rftt|
�| j_ | | j_ | �rstt| �| _ |�ry|| _ || _!t| t"k�r�|�
dBd<��r�dC| _#|�
dB�| _$�n� W d9 � dDS t| t%k�r�dE| _#�n�t| t&k�r�dF| _#|�
dGd�| _'�n�t| t(k�r�dH| _#|�
dId�| _)|�
dJd<��r�dK} |�
dJ�D ] } | || O } �q�| | _*�n^ W d9 � dLS t| t+k�r^dM| _#|�
dNd<��rdK}!|�
dN�D ] }"|!||" O }!�q |!| _,n W d9 � dOS |�
dPd<��s1|�
dQd<��rT|�
dPd<��rLdK} |�
dP�D ] }#| ||# O } �q?| | _-|�
dQd<�| _.n� W d9 � dRS t| t/k�r�dS| _#|�
dNd<��r�dK}!|�
dN�D ] }"|!||" O }!�qv|!| _,n W d9 � dOS |�
dTd<��s�|�
dUd<��r�|�
dTd<��r�dK}$|�
dT�D ] }%|$||% O }$�q�|$| _0|�
dUd<�| _1n
W d9 � dVS |�
dJd<��r�dK} |�
dJ�D ] } | || O } �q�| | _*ne W d9 � dLS t| t2k�r�dW| _#nQt| t3k�rdX| _#nFt| t4k�rdY| _#n;t| t5k�rdZ| _#n0t| t6k�rId[| _#|�
d\d<��r0|�
d\�| _7|�
d]d<��r@||�
d]� | _8n W d9 � d^S |�rat9| | ||j:j;d9|j:j<d_�W d9 � S W d9 � d9S 1 �smw Y d9S )`a�&
Add a trigger to a Windows Scheduled task
.. note::
Arguments are parsed by the YAML loader and are subject to
yaml's idiosyncrasies. Therefore, time values in some
formats (``%H:%M:%S`` and ``%H:%M``) should to be quoted.
See `YAML IDIOSYNCRASIES`_ for more details.
.. _`YAML IDIOSYNCRASIES`: https://docs.saltproject.io/en/latest/topics/troubleshooting/yaml_idiosyncrasies.html#time-expressions
Args:
name (str):
The name of the task to which to add the trigger.
location (str):
A string value representing the location of the task. Default is
``\`` which is the root for the task scheduler
(``C:\Windows\System32\tasks``).
trigger_type (str):
The type of trigger to create. This is defined when the trigger is
created and cannot be changed later. Options are as follows:
- Event
- Once
- Daily
- Weekly
- Monthly
- MonthlyDay
- OnIdle
- OnTaskCreation
- OnBoot
- OnLogon
- OnSessionChange
trigger_enabled (bool):
Boolean value that indicates whether the trigger is enabled.
start_date (str):
The date when the trigger is activated. If no value is passed, the
current date will be used. Can be one of the following formats:
- %Y-%m-%d
- %m-%d-%y
- %m-%d-%Y
- %m/%d/%y
- %m/%d/%Y
- %Y/%m/%d
start_time (str):
The time when the trigger is activated. If no value is passed,
midnight will be used. Can be one of the following formats:
- %I:%M:%S %p
- %I:%M %p
- %H:%M:%S
- %H:%M
end_date (str):
The date when the trigger is deactivated. The trigger cannot start
the task after it is deactivated. Can be one of the following
formats:
- %Y-%m-%d
- %m-%d-%y
- %m-%d-%Y
- %m/%d/%y
- %m/%d/%Y
- %Y/%m/%d
end_time (str):
The time when the trigger is deactivated. If this is not passed
with ``end_date`` it will be set to midnight. Can be one of the
following formats:
- %I:%M:%S %p
- %I:%M %p
- %H:%M:%S
- %H:%M
random_delay (str):
The delay time that is randomly added to the start time of the
trigger. Valid values are:
- 30 seconds
- 1 minute
- 30 minutes
- 1 hour
- 8 hours
- 1 day
.. note::
This parameter applies to the following trigger types
- Once
- Daily
- Weekly
- Monthly
- MonthlyDay
repeat_interval (str):
The amount of time between each restart of the task. Valid values
are:
- 5 minutes
- 10 minutes
- 15 minutes
- 30 minutes
- 1 hour
repeat_duration (str):
How long the pattern is repeated. Valid values are:
- Indefinitely
- 15 minutes
- 30 minutes
- 1 hour
- 12 hours
- 1 day
repeat_stop_at_duration_end (bool):
Boolean value that indicates if a running instance of the task is
stopped at the end of the repetition pattern duration.
execution_time_limit (str):
The maximum amount of time that the task launched by the trigger is
allowed to run. Valid values are:
- 30 minutes
- 1 hour
- 2 hours
- 4 hours
- 8 hours
- 12 hours
- 1 day
- 3 days (default)
delay (str):
The time the trigger waits after its activation to start the task.
Valid values are:
- 15 seconds
- 30 seconds
- 1 minute
- 30 minutes
- 1 hour
- 8 hours
- 1 day
.. note::
This parameter applies to the following trigger types:
- OnLogon
- OnBoot
- Event
- OnTaskCreation
- OnSessionChange
**kwargs**
There are optional keyword arguments determined by the type of trigger
being defined. They are as follows:
*Event*
The trigger will be fired by an event.
subscription (str):
An event definition in xml format that fires the trigger. The
easiest way to get this would is to create an event in Windows
Task Scheduler and then copy the xml text.
*Once*
No special parameters required.
*Daily*
The task will run daily.
days_interval (int):
The interval between days in the schedule. An interval of 1
produces a daily schedule. An interval of 2 produces an
every-other day schedule. If no interval is specified, 1 is
used. Valid entries are 1 - 999.
*Weekly*
The task will run weekly.
weeks_interval (int):
The interval between weeks in the schedule. An interval of 1
produces a weekly schedule. An interval of 2 produces an
every-other week schedule. If no interval is specified, 1 is
used. Valid entries are 1 - 52.
days_of_week (list):
Sets the days of the week on which the task runs. Should be a
list. ie: ``['Monday','Wednesday','Friday']``. Valid entries are
the names of the days of the week.
*Monthly*
The task will run monthly.
months_of_year (list):
Sets the months of the year during which the task runs. Should
be a list. ie: ``['January','July']``. Valid entries are the
full names of all the months.
days_of_month (list):
Sets the days of the month during which the task runs. Should be
a list. ie: ``[1, 15, 'Last']``. Options are all days of the
month 1 - 31 and the word 'Last' to indicate the last day of the
month.
last_day_of_month (bool):
Boolean value that indicates that the task runs on the last day
of the month regardless of the actual date of that day.
.. note::
You can set the task to run on the last day of the month by
either including the word 'Last' in the list of days, or
setting the parameter 'last_day_of_month' equal to ``True``.
*MonthlyDay*
The task will run monthly on the specified day.
months_of_year (list):
Sets the months of the year during which the task runs. Should
be a list. ie: ``['January','July']``. Valid entries are the
full names of all the months.
weeks_of_month (list):
Sets the weeks of the month during which the task runs. Should
be a list. ie: ``['First','Third']``. Valid options are:
- First
- Second
- Third
- Fourth
last_week_of_month (bool):
Boolean value that indicates that the task runs on the last week
of the month.
days_of_week (list):
Sets the days of the week during which the task runs. Should be
a list. ie: ``['Monday','Wednesday','Friday']``. Valid entries
are the names of the days of the week.
*OnIdle*
No special parameters required.
*OnTaskCreation*
No special parameters required.
*OnBoot*
No special parameters required.
*OnLogon*
No special parameters required.
*OnSessionChange*
The task will be triggered by a session change.
session_user_name (str):
Sets the user for the Terminal Server session. When a session
state change is detected for this user, a task is started. To
detect session status change for any user, do not pass this
parameter.
state_change (str):
Sets the kind of Terminal Server session change that would
trigger a task launch. Valid options are:
- ConsoleConnect: When you connect to a user session (switch
users)
- ConsoleDisconnect: When you disconnect a user session
(switch users)
- RemoteConnect: When a user connects via Remote Desktop
- RemoteDisconnect: When a user disconnects via Remote
Desktop
- SessionLock: When the workstation is locked
- SessionUnlock: When the workstation is unlocked
Returns:
bool: ``True`` if successful, otherwise ``False``
CLI Example:
.. code-block:: bash
salt 'minion-id' task.add_trigger <task_name> trigger_type=Once trigger_enabled=True start_date=2016/12/1 start_time='"12:01"'
z/Required parameter "trigger_type" not specifiedr r
r r r r
)ZConsoleConnectZConsoleDisconnectZ
RemoteConnectZRemoteDisconnectZ SessionLockZ
SessionUnlockr r r r �@ � r � r i r i � i �
i � i � i @ i � � i i i i i i i @ i � i i i i i i i @l )� � � � � � � � � � � � � � ZLast)ZSundayZMondayZTuesdayZ WednesdayZThursdayZFridayZSaturday)ZFirstZSecondZThirdZFourth) �January�FebruaryZMarchZApril�MayZJuneZJulyZAugustZ SeptemberZOctoberZNovemberZDecemberzInvalid start_datezInvalid start_timez00:00:00r& z{}T{}r' NzInvalid end_datezInvalid end_timeFrH Tr� rV r� Z subscriptionZ Event_ID1z,Required parameter "subscription" not passedZOnce_ID1Z Daily_ID1Z
days_intervalZ
Weekly_ID1Zweeks_intervalZ days_of_weekr z,Required parameter "days_of_week" not passedZ Monthly_ID1Zmonths_of_yearz.Required parameter "months_of_year" not passedZ
days_of_monthZlast_day_of_monthzJMonthly trigger requires "days_of_month" or "last_day_of_month" parametersZMonthly_DOW_ID1Zweeks_of_monthZlast_week_of_monthzPMonthly DOW trigger requires "weeks_of_month" or "last_week_of_month" parametersZ
OnIdle_ID1ZOnTaskCreation_ID1Z
OnBoot_ID1Z OnLogon_ID1ZOnSessionStateChange_ID1Zsession_user_nameZ state_changez,Required parameter "state_change" not passedru )=r* r r( �now�format�strftimer r rW rX r� rd rY rZ r[ r\ r] rg rh ri r� r� r� r7 r� r� r� r� r� r� r� r� r� r� �TASK_TRIGGER_EVENTrj Z Subscription�TASK_TRIGGER_TIME�TASK_TRIGGER_DAILYZ DaysInterval�TASK_TRIGGER_WEEKLYZ
WeeksIntervalZ
DaysOfWeek�TASK_TRIGGER_MONTHLYZ MonthsOfYearZ DaysOfMonthZRunOnLastDayOfMonth�TASK_TRIGGER_MONTHLYDOWZ WeeksOfMonthZRunOnLastWeekOfMonth�TASK_TRIGGER_IDLE�TASK_TRIGGER_REGISTRATION�TASK_TRIGGER_BOOT�TASK_TRIGGER_LOGON�!TASK_TRIGGER_SESSION_STATE_CHANGEZUserIdZ StateChangerT ry rz r{ )&rF ra r� Ztrigger_enabledr� r� r� r� r� r� r� r� r� r� r} Z
state_changes�daysZweekdays�weeks�monthsZ date_formatZdt_obj� time_formatZtm_objZstart_boundaryZ end_boundaryr� rH rb rG rl Z bits_days�weekdayZ bits_months�month�dayZ
bits_weeks�weekr! r! r" rx > s� F� �������� �
� � �
������$�
� � � �
� �;
�P�Z���j�t��� ��
�� '� �� ' �$�rx c C r� )a
Remove all triggers from the task.
Args:
name (str):
The name of the task from which to clear all triggers.
location (str):
A string value representing the location of the task. Default is
``\`` which is the root for the task scheduler
(``C:\Windows\System32\tasks``).
Returns:
bool: ``True`` if successful, otherwise ``False``
CLI Example:
.. code-block:: bash
salt 'minion-id' task.clear_trigger <task_name>
r� rV Nru )rd r r rW rX rY rZ r[ r\ r] rg rh ri r� rT ry rz r{ )rF ra rb rG rH rk r! r! r" �clear_triggers� s$
�$�r, )rU )rU rs NF)rU NNrs N)NrU NNNNNNNNNNNNNNNNNNNr NNNN)NrU r )NrU NTNNNNNNNFNN)`�__doc__�loggingr� r Zsalt.utils.platformr Zsalt.utils.winapiZsalt.exceptionsr r r@ r^ Zwin32com.clientrY r � ImportError� getLogger�__name__r r r� ZTASK_ACTION_COM_HANDLERr� r� ZTASK_COMPATIBILITY_ATZTASK_COMPATIBILITY_V1ZTASK_COMPATIBILITY_V2ZTASK_COMPATIBILITY_V3ZTASK_VALIDATE_ONLYr� Z TASK_UPDATEr? Z TASK_DISABLEZTASK_DONT_ADD_PRINCIPAL_ACEZ!TASK_IGNORE_REGISTRATION_TRIGGERSZTASK_INSTANCES_PARALLELZTASK_INSTANCES_QUEUEZTASK_INSTANCES_IGNORE_NEWZ TASK_INSTANCES_STOP_EXISTINGr� r� ZTASK_LOGON_S4Ur� ZTASK_LOGON_GROUPr� Z(TASK_LOGON_INTERACTIVE_TOKEN_OR_PASSWORDZTASK_RUNLEVEL_LUAr� ZTASK_STATE_UNKNOWNZTASK_STATE_DISABLEDZTASK_STATE_QUEUEDZTASK_STATE_READYr� r r r r r r r r r! r" r# r� r� r� r� r� r� r# r% r* r, r5 r7 rT rd re rm rr r~ r� r� rv r� r� r� r� r� r� r� rw r� rx r, r! r! r! r" �<module> s�
�
�������� �
� � �
��������� ��������� �
� � �
���� !
8
.
(
-.
�W
�
+
�
{
(
*
+
=
+
-
*
@/
� s