File: //opt/saltstack/salt/lib/python3.10/site-packages/salt/modules/__pycache__/cmdmod.cpython-310.pyc
o
�N�g � � @ s� d Z ddlZddlZddlZddlZddlZddlZddlZddlZddl Z ddl
Z
ddl Z ddl Z ddl
Z
ddlZddlZddlZddlZddlZddlZddlZddlZddlZddlZddlZddlZddlZddl Zddl Zddl Zddl Zddl Zddl!Zddl"m#Z# ddl$m%Z%m&Z&m'Z' z
ddl(Z(ddl)Z)W n e*y� Y nw ej+j,�-� r�ddl.m/Z0 ddl1m2Z3 dZ4n ddl5Z5e5j6Z0dZ4d gZ7d
Z8e�9e:�Z;ej<j=�>� d Z?d d
� Z@dd� ZAdd� ZBdd� ZCdd� ZDd[dd�ZEd\dd�ZFdd � ZGd d � ZHd d � ZId!d"� ZJdde jKe jKdd#ddde?dddddddddddddddddddddd$f d%d&�ZLdddde?dddddddddddddfd'd(�ZMddde?ddddddddddddddfd)d*�ZNdddde?dddddddd#ddddddddddddddddf d+d,�ZOdddde?ddddddd#dddddddddddddfd-d �Z>dddde?dddddddd#ddddddddddddfd.d/�ZPdddde?dddddddd#ddddddddddddfd0d1�ZQdddde?dddddddd#ddddddddddddddfd2d3�ZRdddde?ddddddd#ddddddddddfd4d5�ZSdddde?ddddddddddddddddfd6d7�ZTddddde?dddddd#dddddddddddfd8d9�ZUddddde?ddd:dddddd#ddddddfd;d<�ZVd=d>� ZWd?d@� ZXdAdB� ZYd]dCdD�ZZd]dEdF�Z[d^dHdI�Z\dddde?dddddddddJdddddddddddfdKdL�Z]dMdN� Z^dOdP� Z_d_dQdR�Z` S # d`dTdS�Za S # dadUdV�ZbdWdX� Zcddde?dddddddd#dddddddddfdYdZ�ZddS )bz�
A module for shelling out.
Keep in mind that this module is insecure, in that it can give whomever has
access to the master root execution access to all salt minions.
� N)�
LOG_LEVELS)�CommandExecutionError�SaltInvocationError�TimedProcTimeoutError)�escape_argument��runasTF�*�cmd�shellc C s t S �N)�__virtualname__� r r �G/opt/saltstack/salt/lib/python3.10/site-packages/salt/modules/cmdmod.py� __virtual__N s r c C s. t | ttf�r
| d �� S t| ��� d �� S )Nr )�
isinstance�tuple�list�strip�str�split�r
r r r �_log_cmdR s r c C s( | durt | d�r | S t�d� dd� S )zh
If the callback is None or is not callable, return a lambda that returns
the value passed.
N�__call__z&log_callback is not callable, ignoringc S s | S r r )�xr r r �<lambda>c s z_check_cb.<locals>.<lambda>)�hasattr�log�error)Zcb_r r r � _check_cbY s
r c C sR z |r
| du r
W dS t �dd�du r| du r W dS W | S W | S ty( Y | S w )zU
Set python_shell default based on remote execution and __opts__['cmd_safe']
NTZcmd_safeF)�__opts__�get� NameError)� python_shell� __pub_jidr r r �_python_shell_defaultf s �� ��r% c C sb g }t � d�D ]'}z tj�|�}|�| �r$|�ttj�tj�|���� W q t y. Y qw |S )Nz/proc/[0-9]*/root)
�glob�os�path�realpath�
startswith�append�int�basename�dirname�OSError)�chroot�pids�root�linkr r r � _chroot_pidsw s
� �r4 c s� |du rzt �dd�}W n ty d}Y nw �s | |fS �tjjjvr,td�� ���i � t� d< |dus:|durH|p?t d }t ||�� d< nt
� d< t � d< t � d < |� d< � �fd
d �}|| �} ||�}| |fS ) zb
If template is a valid template engine, process the cmd and cwd through
that engine.
N�saltenv�basez7Attempted to render file paths with unavailable engine �salt� pillarenv�pillar�grains�optsc s� t jj�� }t jj�|d��}|�t jj�| �� W d � n1 s#w Y t jjj � |fddi� ��}t jj�
|� |d sKt d� |d ���|d S )Nzw+�to_strT�resultz$Failed to execute cmd with error: {}�data)
r7 �utils�files�mkstemp�fopen�write� stringutilsr< � templates�TEMPLATE_REGISTRYZsafe_rmr �format)�contentsZ tmp_path_fn�fp_r> ��kwargs�templater r �_render� s" � ��� �z _render_cmd.<locals>._render) r r! r" r7 r? rE rF r �__salt__�_gather_pillarZ
__pillar__�
__grains__)r
�cwdrL r5 r8 �pillar_overriderM r rJ r � _render_cmd� s2 �� rS �infoc
C s\ z| � � } | dkr W dS t| W S ttfy- t�d| d�ttdd��� td Y S w )zB
Retrieve the level code for use in logging.Logger.log().
�quietNzKInvalid output_loglevel '%s'. Valid levels are: %s. Falling back to 'info'.z, T)�reverserT )�lowerr �AttributeError�KeyErrorr r �join�sorted)�levelr r r �_check_loglevel� s
� �r] c C s2 | si } t | t�rtjj�| �} t | t�si } | S r )r r r7 r? r> Zrepack_dictlist�dict)�envr r r �
_parse_env� s
r` c C sH t jjtt�� td td || d�}|�� }|r"t|t�r"|� |� |S )zC
Whenever a state run starts, gather the pillar data fresh
�idr5 )rR r8 )
r7 r9 Z
get_pillarr rP �valueZcompile_pillarr r^ �update)r8 rR r9 �retr r r rO � s �
rO c C s� t | t�rd�dd� | D ��} d}d}td d�r-td dg �}|D ]
}t�| |�r,d}q"td dg �rKtd dg �}|D ] }t�| |�rId} nq=nd}|oP|S ) z6
Check to see if the given command can be run
� c S s" g | ]
}t |t�s
t|�n|�qS r )r r ��.0r r r r �
<listcomp>� s " z _check_avail.<locals>.<listcomp>TFz
config.getZcmd_blacklist_globZcmd_whitelist_glob)r r rZ rN �fnmatch)r
ZbretZwretZblist�compr r r � _check_avail� s(
� ��rk c C s t jj�| �} | std| � ���| ddddg}tjdd�}|d d d
kr@|�d � t|t �r4d �
|�}|�d
|� � � d�� n?|rK|� d|� g� n4t|t �rUd �
|�}g d�}|D ]}|�
� �|�
� �rr|� d |� � � g� n
q[|� d d
|� � � �g� t�|� |S )z�
Prep cmd when shell is powershell. If we were called by script(), then fake
out the Windows shell to run a Powershell script. Otherwise, just run a
Powershell command.
z PowerShell binary not found: �-NonInteractivez
-NoProfilez-ExecutionPolicyZBypass� )�limit���� �scriptz-Commandre z& z; exit $LASTEXITCODEz-EncodedCommand)�$�&�.Z
Configuration�try)r7 r? r( �whichr � traceback�
extract_stackr+ r r rZ r �extendrW r* r �debug)Z win_shellr
� encoded_cmdZnew_cmd�stack�keywords�keywordr r r �_prep_powershell_cmd s.
�
r rz i� c! @ s d|!v r
|s
|!d }|dkrt ��du rt�d�� t|�}t|�}d}"�du r2dt� v r2t�d��|du r@dt� v r@t�d�}|sftj �
d � �sKd
n���}t� |tj
�sed }tjj�� retj �tj�}nt|�}|rpd }d}d}#tjj�� s�tj ���r�t� �tj�s�d
�� d�}$t|$��n |r�td��| r�t| t�s�t| �} tjj�� }%| |%kr�d }#t �fdd�dD ��r�t �| | �} t | |||||�\} }i � d|!v r�t | �s�td| � d���t | �} dd� | �!� D �D ] }&t�"d|&� d
| |&< q�|du�r5d� t| t#��sdnd
t$| �t| t#��sdnd
��rd�� d�nd
| �r$d | � d�nd
||�r+d nd
�}$t�%||$�� ��rUtjj�� �rUt&�sHd }$t|$��t| t#t'f��rUd �(| �} ��r�tjj�)� �r�t| t#t'f��rod �(t*t+| ��} d t+|�� d!| � d"�} z �fd#d$�t,�-� D �d% j.}'t/�0d&|'��r�d'j |'t+| �d(�} W n t1t2f�y� Y nw d)t+��� d*t+| �� �} d���r�tjj�� �s�zt,�3�� W n t4�y� td+�� d,���w | �r
tjj�� �r�d-}$t5|$��t6d.g��s�d/}$t|$��zt7�8| � W n t4�y
td0�� d,���w d }"��s| �r�tjj�� �s��z�d%dl9}(d1t|(�:� � d2 })|)�;t<�}*d3� |)�}+|"�red.g},��rD|,�=d4�g� | �rN|,�=d5| g� �t>k�r]|,�=d6d7�d8g� n:|,�=d9d7g� n2t?d: d;v �rsd<d=�d8g},n$t?d> d?v �r�d<d=�d8g},nt?d> d@v �r�d<d=�d8g},nd<d6�d=�d8g},tjj@�A� �s�t?d: d;v �r�|,�=�� d*tBjC� �g� nN|,�=tBjCg� nFtDjEdAddB��6}-t?d: d;v �r�|,�=dC� �tBjC|-jF�g� n
|,�=tBjC� dD|-jF� �g� |-�G|+� tH�I|-jF�� W d � n 1 �s�w Y dE|,� �}$t�J||$�� tKjL|,tKjMtKjMtKjMdF��NtjjO�P|+��\}.}/tjj@�A� �r/t�Q|-jF� |.�R|*�}0|0d%k�rDt�"dG�|/|.� dH}.n|0dIk�rVtdJtS|/�tS|.�dK�dL��|.�T|*�dM }.tUt#tVtW|.�TdN��gdI � ��}1dOdP� |1�!� D �}1|1�X| � |1�dQ��k�r��|1dQ< tj �
dR�� ��}2|1�dS�|2k�r�|2|1dS< |1} W n tY�y� }3 zt�ZdT�� tdU� �|3���d}3~3ww |d u �rtjj�� �s| �[dVdW� | �[dXdW� | �[dYdW� | �[dZdW� | �[d[dW� | �[d\dW� | �[d]dW� | �[d^dW� | �[d_dW� | �[d`dW� | �[dadW� | �[dbdW� | �[dcdW� |
�r| }4ntjj�� �r,d%dl\}5|5j]�^� }4ntj]�^� }4|4�X| � |�rDdd�(||4de f�|4de< df| v�rO|4�_dfd� | du �rVd} || |4|du�rbt|�n||||||dg� }6dh|!v �rv|!dh |6dh< |du�r�t|��`di�}7|7d
k�r�dj}$t|$��zt|7dk�}7W n tY�y� tdl|� d���w d}7��s�| �s�|�r�ta�btjjcjd�|7| �|6dm< tjj�� �s�|6dn d u �rψ|6do< tjj�e� �r�tBjfdpk �r�d|6dq< nd |6dq< tj �g|��r�tj �h|��s�tdr|� ds���| d u�rtjj�� �st| t#��stjji�j| �} | du �r d%g} nzdtd$� tjji�k| �D �} W n tY�y7 t5du��w | du �r@g } ntjji�k| �} | du �rOg } ntjji�k| �} |�s��r�tjj�� �r�|#�rmtjj�l| � tm| �||�� |#�r~tjj�l|%� �nHz�|#�r�tjj�l| � z
tjjnjo| fi |6��}8W n tp�y� }3 zdv� |du�r�| ndw|6|3�}$t|$��d}3~3ww z|8�q� W n9 tr�y� }3 z,t|3�� dx< d
� dy< d� dz< |8jsjt� d{< dM� dz< � W Y d}3~3W |#�r�tjj�l|%� S S d}3~3ww W |#�rtjj�l|%� n |#�rtjj�l|%� w w |dk�r!|du�r!t�Jd|| |� z tjjOju|8jv|d}�}9W n- tw�y9 d
}9Y n" tx�yZ tjjOju|8jv|d~d�}9|dk�rXt�"d�t$| �� Y nw z tjjOju|8jy|d}�}:W n- tw�ys d
}:Y n" tx�y� tjjOju|8jy|d~d�}:|dk�r�t�"d�t$| �� Y nw | �r�d�|:v �r�d
}:|�r�|9du�r�|9�z� }9|:du�r�|:�z� }:|8jsjt� d{< |8jsj{� dz< |9� dx< |:� dy< � dz | v �r�d%� dz< t � fd�d$�| D �� fd�d$�| D � ��r�d%� dz< �n)d
};|�r�d�|� d��};|du�r
d�| � d�|;� �}$t�J||$�� d�\}}t|�|� }<|�r |<| }=nd�}=z�tjj}j~| d d d ||6�dmd�|4|||d d d�� }8|8jt� d{< d
}d
}|8j�rz^zEt|��d�� z|8��� \}>}?W n tp�ya d�\}>}?Y nw |>�ri||>7 }|?�rp||?7 }|�r�t|�|� |=k�r�d�� ||�� dy< d� dz< W W n}W n t��y� d�|� �� dy< dM� dz< Y W nfw W n$ tjj}j��y� }3 ztj"d�|3t�j�d�� dMd�d��� W Y d}3~3nDd}3~3ww |� dx< |8��� �s�|� dy< |8j�� dz< � dz | v �r�d%� dz< t � fd�d$�| D �� fd�d$�| D � ��r�d%� dz< |8jt� d{< |8j�sDW |8j�d d d�� n|8j�d d d�� w z|�r d%tdz< n� dz tdz< W n
t��y1 Y nw |du�r�|�s]� dz d%k�r]|t�d� k �rLt�d� }d�� t$| �� dz �}$t�"||$�� � dx �rmt�|d�|� dx �� � dy �r}t�|d�|� dy �� � dz �r�t�|d�� dz � � S )�z@
Do the DRY thing and only call subprocess.Popen() once
r9 rU Fz}Attempt to run a shell command with what may be an invalid shell! Check to ensure that the shell <%s> is valid for this user.N� __context__r Zrunas_passwordz~{}� �/Tz
The shell z is not availablezVT not available on windowsc 3 s � | ] }|� � � �� v V qd S r )rW r )rg �word)r r r � <genexpr>� � � z_run.<locals>.<genexpr>��
powershellZpwshr$ zThe shell command "z" is not permittedc s s � | ] \}}|d u r|V qd S r r )rg r �yr r r r� � r� zREnvironment variable '%s' passed without a value. Setting value to an empty stringz0Executing command {}{}{} {}{}in directory '{}'{}�'z as user 'z' z
in group 'z@. Executing command in the background, no output will be logged.z missing salt/utils/win_runas.pyre zcd -- z && { z
}c s g | ] }|j � kr|�qS r )�pw_namerf r r r rh � s z_run.<locals>.<listcomp>r zbash$z{shell} -l -c {cmd})r r
zsu -l � -c zUser 'z' is not availablez+group is not currently available on WindowsZsudoz*group argument requires sudo but not foundzGroup 'z<<<z>>>z�import sys, os, itertools; sys.stdout.write('{0}'); sys.stdout.write('\0'.join(itertools.chain(*os.environ.items()))); sys.stdout.write('{0}');z-uz-gz-sz--�-cz-ir' )ZFreeBSDZsu�-Z os_family)�Solaris)ZAIX�w)�deletez{} -c {} python {}z python z
env command: )�stderr�stdout�stdinzEEnvironment could not be retrieved for user '%s': stderr=%r stdout=%r� rp z0Environment could not be retrieved for user '{}')r� r� �rT � � c S s* i | ]\}}t jj�|�t jj�|��qS r )r7 r? rD r< )rg �k�vr r r �
<dictcomp>` s ��z_run.<locals>.<dictcomp>ZUSER�~�HOMEz/Error raised retrieving environment for user %sz4Environment could not be retrieved for user '{}': {}�LC_CTYPE�C�
LC_NUMERIC�LC_TIME�
LC_COLLATE� LC_MONETARY� LC_MESSAGESZLC_PAPERZLC_NAMEZ
LC_ADDRESSZ LC_TELEPHONEZLC_MEASUREMENTZLC_IDENTIFICATION�LANGUAGE�:�PATHZ
NOTIFY_SOCKET) rQ r r_ r� r� r� �with_communicate�timeout�bgZstdin_raw_newlines�0zZero umask is not allowed.� zInvalid umask: '�
preexec_fnr �
executable)rm � � close_fdszSpecified cwd 'z'' either not absolute or does not existc S � g | ]}t |��qS r )r, �rg �ir r r rh � s �z+success_retcodes must be a list of integersz<Unable to run command '{}' with the context '{}', reason: {}ZREDACTEDr� r� �retcode�pidz1Decoding output from command %s using %s encoding)�encoding�replace)r� �errorszTFailed to decode stdout from command %s, non-decodable characters have been replacedzTFailed to decode stderr from command %s, non-decodable characters have been replaced�CLIXMLc � g | ]}|� d v �qS �r� r �rg Zstdo�rd r r rh T � c r� �r� r �rg Zstder� r r rh U r� z (timeout: zs)zRunning z in VT)r� r� ���) r Z
log_stdoutZ
log_stderrrQ r� r_ Zlog_stdin_levelZlog_stdout_levelZlog_stderr_levelZ
stream_stdoutZ
stream_stderrg �?zSALT: Timeout after {}s
{}zSALT: User break
zVT: %s�Zexc_info_on_loglevel�2)r� r� c r� r� r r� r� r r rh � r� c r� r� r r� r� r r rh � r� )� terminate�killr �(Command '{}' failed with return code: {}z
stdout: %sz
stderr: %sz retcode: %s)��_is_valid_shellr �warningr] r �globalsr� r! r' r( �
expanduserrG �access�R_OKr7 r? �platform�
is_windows�abspath�sepr �isfile�X_OKr r r, Zwin_chcpZget_codepage_id�anyr rS rk r` �itemsr r r rT �
HAS_WIN_RUNASr rZ Z is_darwin�map�
_cmd_quote�pwd�getpwall�pw_shell�re�searchrX �
IndexError�getpwnamrY r � which_bin�grp�getgrnam�uuidZuuid4�encodeZ__salt_system_encoding__ry �
DEFAULT_SHELLrP ZpkgZ
check_bundled�sysr� �tempfileZNamedTemporaryFile�namerC �shutil�chownrz �
subprocess�Popen�PIPE� communicaterD �to_bytes�remove�count�reprr r^ �zip�iterrc �
ValueError� exception�
setdefault�nt�environ�copy�pop�lstrip� functools�partial�userZchugid_and_umaskZ
is_freebsd� version_info�isabs�isdir�argsZ shlex_splitZ split_inputZset_codepage_id� win_runas�timed_subprocess� TimedProcr/ �runr �processr� �
to_unicoder� � TypeError�UnicodeDecodeErrorr� �rstrip�
returncode�timeZvtZTerminalZhas_unread_data�sleep�recv�KeyboardInterruptZTerminalException�logging�DEBUGZisaliveZ
exitstatus�closer" r )@r
rQ r� r� r� �output_encoding�output_loglevel� log_callbackr �groupr r# r_ � clean_env� prepend_pathr
rL �umaskr� r� �reset_system_locale�ignore_retcoder5 r8 rR �use_vt�passwordr� r{ �success_retcodes�success_stdout�success_stderrZwindows_codepagerK Zuse_sudoZchange_windows_codepage�msgZprevious_windows_codepageZ bad_env_keyZ
user_shellr� ZmarkerZmarker_bZpy_codeZenv_cmd�fpZ env_bytesZenv_encoded_errZ marker_countZ env_runasZ
runas_home�excZrun_envr� Z
new_kwargsZ_umask�proc�out�errZformatted_timeout�nowZ will_timeoutZcstdoutZcstderrr )rd r r r �_run8 s� '�
� �
�
��
���� �
�
�
���
�
��
�
� �
����
�
��
�
��
��
���� ����
����
��
���
��
���
���
�
�����
��
��
�� +
��
�
r( c C s� t | fi d|�d|�d|�dtj�d|�dd�dd �d
|�d |�d |�d
|�d| �d|
�d| �d| �d|
�d|�d|�d|�d|�d|��d S )z@
Helper for running commands quietly for minion startup
r rQ r� r� r r rU r Nr r# r_ rL r r� r r5 r8 rR r r r r r� )r( r� �STDOUT)r
rQ r� r r r r# r_ rL r r� r r5 r8 rR r r r r r r r �
_run_quiet� s^ �������� �
� � �
�����������r* c C s� t | fi d|�d|�d|�d|�d|�d|�d|�dd �d
d �d |�d
|�d| �d|
�d| �d| �d|
�d|�d|�d|�d|��S )aj
Helper for running commands quietly for minion startup.
Returns a dict of return data.
output_loglevel argument is ignored. This is here for when we alias
cmd.run_all directly to _run_all_quiet in certain chicken-and-egg
situations where modules need to work both before and after
the __salt__ dictionary is populated (cf dracr.py)
r rQ r� r r# r_ r r rU r NrL r r� r r5 r8 rR r r r r )r( )r
rQ r� r r r# r_ rL r r� r r5 r8 rR r r r r r r r r �_run_all_quiet� sV �������� �
� � �
���������r+ c # K sx t || �dd��}|rtjntj} t| fi d|�d|�d|�d|�d|�d|�d | �d
|�d |�d |�d
| �d|
�d| �d| �d|
�d|�d|�d|�d|�d|�d|�d|�d|�d|�d|�d | �d | �| ��} t|�}t|
�}!|!d ur�|s�| d d kr�|!td! k r�td! }!d"� t
| �| d �}"t � ||"�� |r�t
||s�| d# ���d���t � |!d$|| d# �� |s�| d# S dS )%aG%
Execute the passed command and return the output as a string
:param str cmd: The command to run. ex: ``ls -lart /home``
:param str cwd: The directory from which to execute the command. Defaults
to the home directory of the user specified by ``runas`` (or the user
under which Salt is running if ``runas`` is not specified).
:param str stdin: A string of standard input can be specified for the
command to be run using the ``stdin`` parameter. This can be useful in
cases where sensitive information must be read from standard input.
:param str runas: Specify an alternate user to run the command. The default
behavior is to run as the user under which Salt is running.
.. warning::
For versions 2018.3.3 and above on macosx while using runas,
on linux while using run, to pass special characters to the
command you need to escape the characters on the shell.
Example:
.. code-block:: bash
cmd.run 'echo '\''h=\"baz\"'\''' runas=macuser
:param str group: Group to run command as. Not currently supported
on Windows.
:param str password: Windows only. Required when specifying ``runas``. This
parameter will be ignored on non-Windows platforms.
.. versionadded:: 2016.3.0
:param str shell: Specify an alternate shell. Defaults to the system's
default shell.
:param bool python_shell: If ``False``, let python handle the positional
arguments. Set to ``True`` to use shell features, such as pipes or
redirection.
:param bool bg: If ``True``, run command in background and do not await or
deliver its results
.. versionadded:: 2016.3.0
:param dict env: Environment variables to be set prior to execution.
.. note::
When passing environment variables on the CLI, they should be
passed as the string representation of a dictionary.
.. code-block:: bash
salt myminion cmd.run 'some command' env='{"FOO": "bar"}'
.. note::
When using environment variables on Window's, case-sensitivity
matters, i.e. Window's uses `Path` as opposed to `PATH` for other
systems.
:param bool clean_env: Attempt to clean out all other shell environment
variables and set only those provided in the 'env' argument to this
function.
:param str prepend_path: $PATH segment to prepend (trailing ':' not
necessary) to $PATH
.. versionadded:: 2018.3.0
:param str template: If this setting is applied then the named templating
engine will be used to render the downloaded file. Currently jinja,
mako, and wempy are supported.
:param bool rstrip: Strip all whitespace off the end of output before it is
returned.
:param str umask: The umask (in octal) to use when running the command.
:param str output_encoding: Control the encoding used to decode the
command's output.
.. note::
This should not need to be used in most cases. By default, Salt
will try to use the encoding detected from the system locale, and
will fall back to UTF-8 if this fails. This should only need to be
used in cases where the output of the command is encoded in
something other than the system locale or UTF-8.
To see the encoding Salt has detected from the system locale, check
the `locale` line in the output of :py:func:`test.versions_report
<salt.modules.test.versions_report>`.
.. versionadded:: 2018.3.0
:param str output_loglevel: Control the loglevel at which the output from
the command is logged to the minion log.
.. note::
The command being run will still be logged at the ``debug``
loglevel regardless, unless ``quiet`` is used for this value.
:param bool ignore_retcode: If the exit code of the command is nonzero,
this is treated as an error condition, and the output from the command
will be logged to the minion log. However, there are some cases where
programs use the return code for signaling and a nonzero exit code
doesn't necessarily mean failure. Pass this argument as ``True`` to
skip logging the output if the command has a nonzero exit code.
:param bool hide_output: If ``True``, suppress stdout and stderr in the
return data.
.. note::
This is separate from ``output_loglevel``, which only handles how
Salt logs to the minion log.
.. versionadded:: 2018.3.0
:param int timeout: A timeout in seconds for the executed process to return.
:param bool use_vt: Use VT utils (saltstack) to stream the command output
more interactively to the console and the logs. This is experimental.
:param bool redirect_stderr: If set to ``True``, then stderr will be
redirected to stdout. This is helpful for cases where obtaining both
the retcode and output is desired. Default is ``True``
.. versionadded:: 3006.9
:param bool encoded_cmd: Specify if the supplied command is encoded.
Only applies to shell 'powershell' and 'pwsh'.
.. versionadded:: 2018.3.0
Older versions of powershell seem to return raw xml data in the return.
To avoid raw xml data in the return, prepend your command with the
following before encoding:
`$ProgressPreference='SilentlyContinue'; <your command>`
The following powershell code block will encode the `Write-Output`
command so that it will not have the raw xml data in the return:
.. code-block:: powershell
# target string
$Command = '$ProgressPreference="SilentlyContinue"; Write-Output "hello"'
# Convert to Base64 encoded string
$Encoded = [convert]::ToBase64String([System.Text.encoding]::Unicode.GetBytes($command))
Write-Output $Encoded
:param bool raise_err: If ``True`` and the command has a nonzero exit code,
a CommandExecutionError exception will be raised.
.. warning::
This function does not process commands through a shell
unless the python_shell flag is set to True. This means that any
shell-specific functionality such as 'echo' or the use of pipes,
redirection or &&, should either be migrated to cmd.shell or
have the python_shell=True flag set here.
The use of python_shell=True means that the shell will accept _any_ input
including potentially malicious commands such as 'good_command;rm -rf /'.
Be absolutely certain that you have sanitized your input prior to using
python_shell=True
:param list success_retcodes: This parameter will allow a list of
non-zero return codes that should be considered a success. If the
return code returned from the run matches any in the provided list,
the return code will be overridden with zero.
.. versionadded:: 2019.2.0
:param list success_stdout: This parameter will allow a list of
strings that when found in standard out should be considered a success.
If stdout returned from the run matches any in the provided list,
the return code will be overridden with zero.
.. versionadded:: 3004
:param list success_stderr: This parameter will allow a list of
strings that when found in standard error should be considered a success.
If stderr returned from the run matches any in the provided list,
the return code will be overridden with zero.
.. versionadded:: 3004
:param bool stdin_raw_newlines: False
If ``True``, Salt will not automatically convert the characters ``\\n``
present in the ``stdin`` value to newlines.
.. versionadded:: 2019.2.0
:param int windows_codepage: 65001
Only applies to Windows: the minion uses `C:\Windows\System32\chcp.com` to
verify or set the code page before the command `cmd` is executed.
Code page 65001 corresponds with UTF-8 and allows international localization of Windows.
.. versionadded:: 3002
CLI Example:
.. code-block:: bash
salt '*' cmd.run "ls -l | awk '/foo/{print \\$2}'"
The template arg can be set to 'jinja' or another supported template
engine to render the command arguments before execution.
For example:
.. code-block:: bash
salt '*' cmd.run template=jinja "ls -l /tmp/{{grains.id}} | awk '/foo/{print \\$2}'"
Specify an alternate shell with the shell parameter:
.. code-block:: bash
salt '*' cmd.run "Get-ChildItem C:\\ " shell='powershell'
A string of standard input can be specified for the command to be run using
the ``stdin`` parameter. This can be useful in cases where sensitive
information must be read from standard input.
.. code-block:: bash
salt '*' cmd.run "grep f" stdin='one\\ntwo\\nthree\\nfour\\nfive\\n'
If an equal sign (``=``) appears in an argument to a Salt command it is
interpreted as a keyword argument in the format ``key=val``. That
processing can be bypassed in order to pass an equal sign through to the
remote shell command by manually specifying the kwarg:
.. code-block:: bash
salt '*' cmd.run cmd='sed -e s/=/:/g'
r$ r� r r r r# rQ r� r� r_ r r rL r
r r r r r� r r r5 r r� r r{ r r r Nr� r r r� r� z
output: %s)r% r! r� r) r� r( r r] r rG r r r r )#r
rQ r� r r r r# r_ r rL r
r r r r � hide_outputr� r r r5 r �redirect_stderrr� r r{ Z raise_errr r r r rK r� rd Zlvlr! r r r r ( s� �������� �
� � �
��������������� � ���r c K s� d|v r
|� d�}nd}t| fi d|�d|�d|�d|�d|�d|�d |�d
|�d |�d | �d
|
�d| �d| �d|
�d|�d|�d|�d|�d|�d|�d|�d|�d|�d|�d|�d|�|��S ) aV
Execute the passed command and return the output as a string.
.. versionadded:: 2015.5.0
:param str cmd: The command to run. ex: ``ls -lart /home``
:param str cwd: The directory from which to execute the command. Defaults
to the home directory of the user specified by ``runas`` (or the user
under which Salt is running if ``runas`` is not specified).
:param str stdin: A string of standard input can be specified for the
command to be run using the ``stdin`` parameter. This can be useful in
cases where sensitive information must be read from standard input.
:param str runas: Specify an alternate user to run the command. The default
behavior is to run as the user under which Salt is running. If running
on a Windows minion you must also use the ``password`` argument, and
the target user account must be in the Administrators group.
.. warning::
For versions 2018.3.3 and above on macosx while using runas,
to pass special characters to the command you need to escape
the characters on the shell.
Example:
.. code-block:: bash
cmd.shell 'echo '\''h=\"baz\"'\''' runas=macuser
:param str group: Group to run command as. Not currently supported
on Windows.
:param str password: Windows only. Required when specifying ``runas``. This
parameter will be ignored on non-Windows platforms.
.. versionadded:: 2016.3.0
:param int shell: Shell to execute under. Defaults to the system default
shell.
:param bool bg: If True, run command in background and do not await or
deliver its results
:param dict env: Environment variables to be set prior to execution.
.. note::
When passing environment variables on the CLI, they should be
passed as the string representation of a dictionary.
.. code-block:: bash
salt myminion cmd.shell 'some command' env='{"FOO": "bar"}'
.. note::
When using environment variables on Window's, case-sensitivity
matters, i.e. Window's uses `Path` as opposed to `PATH` for other
systems.
:param bool clean_env: Attempt to clean out all other shell environment
variables and set only those provided in the 'env' argument to this
function.
:param str prepend_path: $PATH segment to prepend (trailing ':' not necessary)
to $PATH
.. versionadded:: 2018.3.0
:param str template: If this setting is applied then the named templating
engine will be used to render the downloaded file. Currently jinja,
mako, and wempy are supported.
:param bool rstrip: Strip all whitespace off the end of output before it is
returned.
:param str umask: The umask (in octal) to use when running the command.
:param str output_encoding: Control the encoding used to decode the
command's output.
.. note::
This should not need to be used in most cases. By default, Salt
will try to use the encoding detected from the system locale, and
will fall back to UTF-8 if this fails. This should only need to be
used in cases where the output of the command is encoded in
something other than the system locale or UTF-8.
To see the encoding Salt has detected from the system locale, check
the `locale` line in the output of :py:func:`test.versions_report
<salt.modules.test.versions_report>`.
.. versionadded:: 2018.3.0
:param str output_loglevel: Control the loglevel at which the output from
the command is logged to the minion log.
.. note::
The command being run will still be logged at the ``debug``
loglevel regardless, unless ``quiet`` is used for this value.
:param bool ignore_retcode: If the exit code of the command is nonzero,
this is treated as an error condition, and the output from the command
will be logged to the minion log. However, there are some cases where
programs use the return code for signaling and a nonzero exit code
doesn't necessarily mean failure. Pass this argument as ``True`` to
skip logging the output if the command has a nonzero exit code.
:param bool hide_output: If ``True``, suppress stdout and stderr in the
return data.
.. note::
This is separate from ``output_loglevel``, which only handles how
Salt logs to the minion log.
.. versionadded:: 2018.3.0
:param int timeout: A timeout in seconds for the executed process to
return.
:param bool use_vt: Use VT utils (saltstack) to stream the command output
more interactively to the console and the logs. This is experimental.
.. warning::
This passes the cmd argument directly to the shell without any further
processing! Be absolutely sure that you have properly sanitized the
command passed to this function and do not use untrusted inputs.
:param list success_retcodes: This parameter will allow a list of
non-zero return codes that should be considered a success. If the
return code returned from the run matches any in the provided list,
the return code will be overridden with zero.
.. versionadded:: 2019.2.0
:param list success_stdout: This parameter will allow a list of
strings that when found in standard out should be considered a success.
If stdout returned from the run matches any in the provided list,
the return code will be overridden with zero.
.. versionadded:: 3004
:param list success_stderr: This parameter will allow a list of
strings that when found in standard error should be considered a success.
If stderr returned from the run matches any in the provided list,
the return code will be overridden with zero.
.. versionadded:: 3004
:param bool stdin_raw_newlines: False
If ``True``, Salt will not automatically convert the characters ``\n``
present in the ``stdin`` value to newlines.
.. versionadded:: 2019.2.0
CLI Example:
.. code-block:: bash
salt '*' cmd.shell "ls -l | awk '/foo/{print \$2}'"
The template arg can be set to 'jinja' or another supported template
engine to render the command arguments before execution.
For example:
.. code-block:: bash
salt '*' cmd.shell template=jinja "ls -l /tmp/{{grains.id}} | awk '/foo/{print \$2}'"
Specify an alternate shell with the shell parameter:
.. code-block:: bash
salt '*' cmd.shell "Get-ChildItem C:\ " shell='powershell'
A string of standard input can be specified for the command to be run using
the ``stdin`` parameter. This can be useful in cases where sensitive
information must be read from standard input.
.. code-block:: bash
salt '*' cmd.shell "grep f" stdin='one\ntwo\nthree\nfour\nfive\n'
If an equal sign (``=``) appears in an argument to a Salt command it is
interpreted as a keyword argument in the format ``key=val``. That
processing can be bypassed in order to pass an equal sign through to the
remote shell command by manually specifying the kwarg:
.. code-block:: bash
salt '*' cmd.shell cmd='sed -e s/=/:/g'
r# TrQ r� r r r r_ r r rL r
r r r r r, r� r r r5 r r� r r r r )r� r ) r
rQ r� r r r r_ r rL r
r r r r r, r� r r r5 r r� r r r r r rK r# r r r r o sx ` �������� �
� � �
���������������c K s� t ||�dd��}t| fi d|�d|�d|�d|�d|�d|�d |�d
|�d |�d | �d
|
�d| �d| �d|
�d|�d|�d|�d|�d|�d|�d|�d|�d|�d|�|��}|s_|d S dS ) a�
Execute a command, and only return the standard out
:param str cmd: The command to run. ex: ``ls -lart /home``
:param str cwd: The directory from which to execute the command. Defaults
to the home directory of the user specified by ``runas`` (or the user
under which Salt is running if ``runas`` is not specified).
:param str stdin: A string of standard input can be specified for the
command to be run using the ``stdin`` parameter. This can be useful in
cases where sensitive information must be read from standard input.
:param str runas: Specify an alternate user to run the command. The default
behavior is to run as the user under which Salt is running. If running
on a Windows minion you must also use the ``password`` argument, and
the target user account must be in the Administrators group.
.. warning::
For versions 2018.3.3 and above on macosx while using runas,
to pass special characters to the command you need to escape
the characters on the shell.
Example:
.. code-block:: bash
cmd.run_stdout 'echo '\''h=\"baz\"'\''' runas=macuser
:param str password: Windows only. Required when specifying ``runas``. This
parameter will be ignored on non-Windows platforms.
.. versionadded:: 2016.3.0
:param str group: Group to run command as. Not currently supported
on Windows.
:param str shell: Specify an alternate shell. Defaults to the system's
default shell.
:param bool python_shell: If False, let python handle the positional
arguments. Set to True to use shell features, such as pipes or
redirection.
:param dict env: Environment variables to be set prior to execution.
.. note::
When passing environment variables on the CLI, they should be
passed as the string representation of a dictionary.
.. code-block:: bash
salt myminion cmd.run_stdout 'some command' env='{"FOO": "bar"}'
.. note::
When using environment variables on Window's, case-sensitivity
matters, i.e. Window's uses `Path` as opposed to `PATH` for other
systems.
:param bool clean_env: Attempt to clean out all other shell environment
variables and set only those provided in the 'env' argument to this
function.
:param str prepend_path: $PATH segment to prepend (trailing ':' not necessary)
to $PATH
.. versionadded:: 2018.3.0
:param str template: If this setting is applied then the named templating
engine will be used to render the downloaded file. Currently jinja,
mako, and wempy are supported.
:param bool rstrip: Strip all whitespace off the end of output before it is
returned.
:param str umask: The umask (in octal) to use when running the command.
:param str output_encoding: Control the encoding used to decode the
command's output.
.. note::
This should not need to be used in most cases. By default, Salt
will try to use the encoding detected from the system locale, and
will fall back to UTF-8 if this fails. This should only need to be
used in cases where the output of the command is encoded in
something other than the system locale or UTF-8.
To see the encoding Salt has detected from the system locale, check
the `locale` line in the output of :py:func:`test.versions_report
<salt.modules.test.versions_report>`.
.. versionadded:: 2018.3.0
:param str output_loglevel: Control the loglevel at which the output from
the command is logged to the minion log.
.. note::
The command being run will still be logged at the ``debug``
loglevel regardless, unless ``quiet`` is used for this value.
:param bool ignore_retcode: If the exit code of the command is nonzero,
this is treated as an error condition, and the output from the command
will be logged to the minion log. However, there are some cases where
programs use the return code for signaling and a nonzero exit code
doesn't necessarily mean failure. Pass this argument as ``True`` to
skip logging the output if the command has a nonzero exit code.
:param bool hide_output: If ``True``, suppress stdout and stderr in the
return data.
.. note::
This is separate from ``output_loglevel``, which only handles how
Salt logs to the minion log.
.. versionadded:: 2018.3.0
:param int timeout: A timeout in seconds for the executed process to
return.
:param bool use_vt: Use VT utils (saltstack) to stream the command output
more interactively to the console and the logs. This is experimental.
:param list success_retcodes: This parameter will allow a list of
non-zero return codes that should be considered a success. If the
return code returned from the run matches any in the provided list,
the return code will be overridden with zero.
.. versionadded:: 2019.2.0
:param list success_stdout: This parameter will allow a list of
strings that when found in standard out should be considered a success.
If stdout returned from the run matches any in the provided list,
the return code will be overridden with zero.
.. versionadded:: 3004
:param list success_stderr: This parameter will allow a list of
strings that when found in standard error should be considered a success.
If stderr returned from the run matches any in the provided list,
the return code will be overridden with zero.
.. versionadded:: 3004
:param bool stdin_raw_newlines: False
If ``True``, Salt will not automatically convert the characters ``\n``
present in the ``stdin`` value to newlines.
.. versionadded:: 2019.2.0
CLI Example:
.. code-block:: bash
salt '*' cmd.run_stdout "ls -l | awk '/foo/{print \$2}'"
The template arg can be set to 'jinja' or another supported template
engine to render the command arguments before execution.
For example:
.. code-block:: bash
salt '*' cmd.run_stdout template=jinja "ls -l /tmp/{{grains.id}} | awk '/foo/{print \$2}'"
A string of standard input can be specified for the command to be run using
the ``stdin`` parameter. This can be useful in cases where sensitive
information must be read from standard input.
.. code-block:: bash
salt '*' cmd.run_stdout "grep f" stdin='one\ntwo\nthree\nfour\nfive\n'
r$ r� r r rQ r� r r# r_ r r rL r
r r r r r� r r r5 r r r r r r� �r% r! r( � r
rQ r� r r r r# r_ r rL r
r r r r r, r� r r r5 r r r r r r rK rd r r r �
run_stdoutr �n J�������� �
� � �
������������� r0 c K s� t ||�dd��}t| fi d|�d|�d|�d|�d|�d|�d |�d
|�d |�d | �d
|
�d| �d| �d|
�d|�d|�d|�d|�d|�d|�d|�d|�d|�d|�|��}|s_|d S dS ) a�
Execute a command and only return the standard error
:param str cmd: The command to run. ex: ``ls -lart /home``
:param str cwd: The directory from which to execute the command. Defaults
to the home directory of the user specified by ``runas`` (or the user
under which Salt is running if ``runas`` is not specified).
:param str stdin: A string of standard input can be specified for the
command to be run using the ``stdin`` parameter. This can be useful in
cases where sensitive information must be read from standard input.
:param str runas: Specify an alternate user to run the command. The default
behavior is to run as the user under which Salt is running. If running
on a Windows minion you must also use the ``password`` argument, and
the target user account must be in the Administrators group.
.. warning::
For versions 2018.3.3 and above on macosx while using runas,
to pass special characters to the command you need to escape
the characters on the shell.
Example:
.. code-block:: bash
cmd.run_stderr 'echo '\''h=\"baz\"'\''' runas=macuser
:param str password: Windows only. Required when specifying ``runas``. This
parameter will be ignored on non-Windows platforms.
.. versionadded:: 2016.3.0
:param str group: Group to run command as. Not currently supported
on Windows.
:param str shell: Specify an alternate shell. Defaults to the system's
default shell.
:param bool python_shell: If False, let python handle the positional
arguments. Set to True to use shell features, such as pipes or
redirection.
:param dict env: Environment variables to be set prior to execution.
.. note::
When passing environment variables on the CLI, they should be
passed as the string representation of a dictionary.
.. code-block:: bash
salt myminion cmd.run_stderr 'some command' env='{"FOO": "bar"}'
.. note::
When using environment variables on Window's, case-sensitivity
matters, i.e. Window's uses `Path` as opposed to `PATH` for other
systems.
:param bool clean_env: Attempt to clean out all other shell environment
variables and set only those provided in the 'env' argument to this
function.
:param str prepend_path: $PATH segment to prepend (trailing ':' not
necessary) to $PATH
.. versionadded:: 2018.3.0
:param str template: If this setting is applied then the named templating
engine will be used to render the downloaded file. Currently jinja,
mako, and wempy are supported.
:param bool rstrip: Strip all whitespace off the end of output before it is
returned.
:param str umask: The umask (in octal) to use when running the command.
:param str output_encoding: Control the encoding used to decode the
command's output.
.. note::
This should not need to be used in most cases. By default, Salt
will try to use the encoding detected from the system locale, and
will fall back to UTF-8 if this fails. This should only need to be
used in cases where the output of the command is encoded in
something other than the system locale or UTF-8.
To see the encoding Salt has detected from the system locale, check
the `locale` line in the output of :py:func:`test.versions_report
<salt.modules.test.versions_report>`.
.. versionadded:: 2018.3.0
:param str output_loglevel: Control the loglevel at which the output from
the command is logged to the minion log.
.. note::
The command being run will still be logged at the ``debug``
loglevel regardless, unless ``quiet`` is used for this value.
:param bool ignore_retcode: If the exit code of the command is nonzero,
this is treated as an error condition, and the output from the command
will be logged to the minion log. However, there are some cases where
programs use the return code for signaling and a nonzero exit code
doesn't necessarily mean failure. Pass this argument as ``True`` to
skip logging the output if the command has a nonzero exit code.
:param bool hide_output: If ``True``, suppress stdout and stderr in the
return data.
.. note::
This is separate from ``output_loglevel``, which only handles how
Salt logs to the minion log.
.. versionadded:: 2018.3.0
:param int timeout: A timeout in seconds for the executed process to
return.
:param bool use_vt: Use VT utils (saltstack) to stream the command output
more interactively to the console and the logs. This is experimental.
:param list success_retcodes: This parameter will allow a list of
non-zero return codes that should be considered a success. If the
return code returned from the run matches any in the provided list,
the return code will be overridden with zero.
.. versionadded:: 2019.2.0
:param list success_stdout: This parameter will allow a list of
strings that when found in standard out should be considered a success.
If stdout returned from the run matches any in the provided list,
the return code will be overridden with zero.
.. versionadded:: 3004
:param list success_stderr: This parameter will allow a list of
strings that when found in standard error should be considered a success.
If stderr returned from the run matches any in the provided list,
the return code will be overridden with zero.
.. versionadded:: 3004
:param bool stdin_raw_newlines: False
If ``True``, Salt will not automatically convert the characters ``\n``
present in the ``stdin`` value to newlines.
.. versionadded:: 2019.2.0
CLI Example:
.. code-block:: bash
salt '*' cmd.run_stderr "ls -l | awk '/foo/{print \$2}'"
The template arg can be set to 'jinja' or another supported template
engine to render the command arguments before execution.
For example:
.. code-block:: bash
salt '*' cmd.run_stderr template=jinja "ls -l /tmp/{{grains.id}} | awk '/foo/{print \$2}'"
A string of standard input can be specified for the command to be run using
the ``stdin`` parameter. This can be useful in cases where sensitive
information must be read from standard input.
.. code-block:: bash
salt '*' cmd.run_stderr "grep f" stdin='one\ntwo\nthree\nfour\nfive\n'
r$ r� r r rQ r� r r# r_ r r rL r
r r r r r� r r r r5 r r r r r� r. r/ r r r �
run_stderr\ r1 r2 c K s� t || �dd��}|rtjntj} t| fi d|�d|�d|�d|�d| �d|�d |�d
|�d |�d |�d
| �d|
�d| �d| �d|
�d|�d|�d|�d|�d|�d|�d|�d|�d|�d|�d |�| ��} |rqd | d < | d< | S ) a�
Execute the passed command and return a dict of return data
:param str cmd: The command to run. ex: ``ls -lart /home``
:param str cwd: The directory from which to execute the command. Defaults
to the home directory of the user specified by ``runas`` (or the user
under which Salt is running if ``runas`` is not specified).
:param str stdin: A string of standard input can be specified for the
command to be run using the ``stdin`` parameter. This can be useful in
cases where sensitive information must be read from standard input.
:param str runas: Specify an alternate user to run the command. The default
behavior is to run as the user under which Salt is running. If running
on a Windows minion you must also use the ``password`` argument, and
the target user account must be in the Administrators group.
.. warning::
For versions 2018.3.3 and above on macosx while using runas,
to pass special characters to the command you need to escape
the characters on the shell.
Example:
.. code-block:: bash
cmd.run_all 'echo '\''h=\"baz\"'\''' runas=macuser
:param str password: Windows only. Required when specifying ``runas``. This
parameter will be ignored on non-Windows platforms.
.. versionadded:: 2016.3.0
:param str group: Group to run command as. Not currently supported
on Windows.
:param str shell: Specify an alternate shell. Defaults to the system's
default shell.
:param bool python_shell: If False, let python handle the positional
arguments. Set to True to use shell features, such as pipes or
redirection.
:param dict env: Environment variables to be set prior to execution.
.. note::
When passing environment variables on the CLI, they should be
passed as the string representation of a dictionary.
.. code-block:: bash
salt myminion cmd.run_all 'some command' env='{"FOO": "bar"}'
.. note::
When using environment variables on Window's, case-sensitivity
matters, i.e. Window's uses `Path` as opposed to `PATH` for other
systems.
:param bool clean_env: Attempt to clean out all other shell environment
variables and set only those provided in the 'env' argument to this
function.
:param str prepend_path: $PATH segment to prepend (trailing ':' not
necessary) to $PATH
.. versionadded:: 2018.3.0
:param str template: If this setting is applied then the named templating
engine will be used to render the downloaded file. Currently jinja,
mako, and wempy are supported.
:param bool rstrip: Strip all whitespace off the end of output before it is
returned.
:param str umask: The umask (in octal) to use when running the command.
:param str output_encoding: Control the encoding used to decode the
command's output.
.. note::
This should not need to be used in most cases. By default, Salt
will try to use the encoding detected from the system locale, and
will fall back to UTF-8 if this fails. This should only need to be
used in cases where the output of the command is encoded in
something other than the system locale or UTF-8.
To see the encoding Salt has detected from the system locale, check
the `locale` line in the output of :py:func:`test.versions_report
<salt.modules.test.versions_report>`.
.. versionadded:: 2018.3.0
:param str output_loglevel: Control the loglevel at which the output from
the command is logged to the minion log.
.. note::
The command being run will still be logged at the ``debug``
loglevel regardless, unless ``quiet`` is used for this value.
:param bool ignore_retcode: If the exit code of the command is nonzero,
this is treated as an error condition, and the output from the command
will be logged to the minion log. However, there are some cases where
programs use the return code for signaling and a nonzero exit code
doesn't necessarily mean failure. Pass this argument as ``True`` to
skip logging the output if the command has a nonzero exit code.
:param bool hide_output: If ``True``, suppress stdout and stderr in the
return data.
.. note::
This is separate from ``output_loglevel``, which only handles how
Salt logs to the minion log.
.. versionadded:: 2018.3.0
:param int timeout: A timeout in seconds for the executed process to
return.
:param bool use_vt: Use VT utils (saltstack) to stream the command output
more interactively to the console and the logs. This is experimental.
:param bool encoded_cmd: Specify if the supplied command is encoded.
Only applies to shell 'powershell' and 'pwsh'.
.. versionadded:: 2018.3.0
Older versions of powershell seem to return raw xml data in the return.
To avoid raw xml data in the return, prepend your command with the
following before encoding:
`$ProgressPreference='SilentlyContinue'; <your command>`
The following powershell code block will encode the `Write-Output`
command so that it will not have the raw xml data in the return:
.. code-block:: powershell
# target string
$Command = '$ProgressPreference="SilentlyContinue"; Write-Output "hello"'
# Convert to Base64 encoded string
$Encoded = [convert]::ToBase64String([System.Text.encoding]::Unicode.GetBytes($command))
Write-Output $Encoded
:param bool redirect_stderr: If set to ``True``, then stderr will be
redirected to stdout. This is helpful for cases where obtaining both
the retcode and output is desired, but it is not desired to have the
output separated into both stdout and stderr.
.. versionadded:: 2015.8.2
:param str password: Windows only. Required when specifying ``runas``. This
parameter will be ignored on non-Windows platforms.
.. versionadded:: 2016.3.0
:param bool bg: If ``True``, run command in background and do not await or
deliver its results
.. versionadded:: 2016.3.6
:param list success_retcodes: This parameter will allow a list of
non-zero return codes that should be considered a success. If the
return code returned from the run matches any in the provided list,
the return code will be overridden with zero.
.. versionadded:: 2019.2.0
:param list success_stdout: This parameter will allow a list of
strings that when found in standard out should be considered a success.
If stdout returned from the run matches any in the provided list,
the return code will be overridden with zero.
.. versionadded:: 3004
:param list success_stderr: This parameter will allow a list of
strings that when found in standard error should be considered a success.
If stderr returned from the run matches any in the provided list,
the return code will be overridden with zero.
.. versionadded:: 3004
:param bool stdin_raw_newlines: False
If ``True``, Salt will not automatically convert the characters ``\n``
present in the ``stdin`` value to newlines.
.. versionadded:: 2019.2.0
CLI Example:
.. code-block:: bash
salt '*' cmd.run_all "ls -l | awk '/foo/{print \$2}'"
The template arg can be set to 'jinja' or another supported template
engine to render the command arguments before execution.
For example:
.. code-block:: bash
salt '*' cmd.run_all template=jinja "ls -l /tmp/{{grains.id}} | awk '/foo/{print \$2}'"
A string of standard input can be specified for the command to be run using
the ``stdin`` parameter. This can be useful in cases where sensitive
information must be read from standard input.
.. code-block:: bash
salt '*' cmd.run_all "grep f" stdin='one\ntwo\nthree\nfour\nfive\n'
r$ r� r r rQ r� r� r r# r_ r r rL r
r r r r r� r r r5 r r r{ r r r r� )r% r! r� r) r� r( ) r
rQ r� r r r r# r_ r rL r
r r r r r, r� r r r5 r r- r r{ r r r r rK r� rd r r r �run_allF s| u�������� �
� � �
��������������� r3 c K s� t ||�dd��}t| fi d|�d|�d|�d|�dtj�d|�d |�d
|�d |�d | �d
|
�d| �d| �d|
�d|�d|�d|�d|�d|�d|�d|�d|�d|�|��}|d S )a8
Execute a shell command and return the command's return code.
:param str cmd: The command to run. ex: ``ls -lart /home``
:param str cwd: The directory from which to execute the command. Defaults
to the home directory of the user specified by ``runas`` (or the user
under which Salt is running if ``runas`` is not specified).
:param str stdin: A string of standard input can be specified for the
command to be run using the ``stdin`` parameter. This can be useful in
cases where sensitive information must be read from standard input.
:param str runas: Specify an alternate user to run the command. The default
behavior is to run as the user under which Salt is running. If running
on a Windows minion you must also use the ``password`` argument, and
the target user account must be in the Administrators group.
.. warning::
For versions 2018.3.3 and above on macosx while using runas,
to pass special characters to the command you need to escape
the characters on the shell.
Example:
.. code-block:: bash
cmd.retcode 'echo '\''h=\"baz\"'\''' runas=macuser
:param str password: Windows only. Required when specifying ``runas``. This
parameter will be ignored on non-Windows platforms.
.. versionadded:: 2016.3.0
:param str group: Group to run command as. Not currently supported
on Windows.
:param str shell: Specify an alternate shell. Defaults to the system's
default shell.
:param bool python_shell: If False, let python handle the positional
arguments. Set to True to use shell features, such as pipes or
redirection.
:param dict env: Environment variables to be set prior to execution.
.. note::
When passing environment variables on the CLI, they should be
passed as the string representation of a dictionary.
.. code-block:: bash
salt myminion cmd.retcode 'some command' env='{"FOO": "bar"}'
.. note::
When using environment variables on Window's, case-sensitivity
matters, i.e. Window's uses `Path` as opposed to `PATH` for other
systems.
:param bool clean_env: Attempt to clean out all other shell environment
variables and set only those provided in the 'env' argument to this
function.
:param str template: If this setting is applied then the named templating
engine will be used to render the downloaded file. Currently jinja,
mako, and wempy are supported.
:param bool rstrip: Strip all whitespace off the end of output before it is
returned.
:param str umask: The umask (in octal) to use when running the command.
:param str output_encoding: Control the encoding used to decode the
command's output.
.. note::
This should not need to be used in most cases. By default, Salt
will try to use the encoding detected from the system locale, and
will fall back to UTF-8 if this fails. This should only need to be
used in cases where the output of the command is encoded in
something other than the system locale or UTF-8.
To see the encoding Salt has detected from the system locale, check
the `locale` line in the output of :py:func:`test.versions_report
<salt.modules.test.versions_report>`.
.. versionadded:: 2018.3.0
:param str output_loglevel: Control the loglevel at which the output from
the command is logged to the minion log.
.. note::
The command being run will still be logged at the ``debug``
loglevel regardless, unless ``quiet`` is used for this value.
:param bool ignore_retcode: If the exit code of the command is nonzero,
this is treated as an error condition, and the output from the command
will be logged to the minion log. However, there are some cases where
programs use the return code for signaling and a nonzero exit code
doesn't necessarily mean failure. Pass this argument as ``True`` to
skip logging the output if the command has a nonzero exit code.
:param int timeout: A timeout in seconds for the executed process to return.
:param bool use_vt: Use VT utils (saltstack) to stream the command output
more interactively to the console and the logs. This is experimental.
:rtype: int
:rtype: None
:returns: Return Code as an int or None if there was an exception.
:param list success_retcodes: This parameter will allow a list of
non-zero return codes that should be considered a success. If the
return code returned from the run matches any in the provided list,
the return code will be overridden with zero.
.. versionadded:: 2019.2.0
:param list success_stdout: This parameter will allow a list of
strings that when found in standard out should be considered a success.
If stdout returned from the run matches any in the provided list,
the return code will be overridden with zero.
.. versionadded:: 3004
:param list success_stderr: This parameter will allow a list of
strings that when found in standard error should be considered a success.
If stderr returned from the run matches any in the provided list,
the return code will be overridden with zero.
.. versionadded:: 3004
:param bool stdin_raw_newlines: False
If ``True``, Salt will not automatically convert the characters ``\n``
present in the ``stdin`` value to newlines.
.. versionadded:: 2019.2.0
CLI Example:
.. code-block:: bash
salt '*' cmd.retcode "file /bin/bash"
The template arg can be set to 'jinja' or another supported template
engine to render the command arguments before execution.
For example:
.. code-block:: bash
salt '*' cmd.retcode template=jinja "file {{grains.pythonpath[0]}}/python"
A string of standard input can be specified for the command to be run using
the ``stdin`` parameter. This can be useful in cases where sensitive
information must be read from standard input.
.. code-block:: bash
salt '*' cmd.retcode "grep f" stdin='one\ntwo\nthree\nfour\nfive\n'
r$ r� r r rQ r� r� r r# r_ r rL r r r r r� r r r5 r r r r r r� )r% r! r( r� r) )r
rQ r� r r r r# r_ r rL r r r r r� r r r5 r r r r r rK rd r r r r� ` sj <�������� �
� � �
������������r� c K s� t | fi d|�d|�d|�d|�d|�d|�d|�d|�d | �d
|
�d | �d d
�d| �d|
�d|�d|�d|�d|�d|�d|�d|�d|�|��S )zm
Helper for running commands quietly for minion startup. Returns same as
the retcode() function.
rQ r� r r r r# r_ r rL r r r rU r r� r r r5 r r r r r )r� )r
rQ r� r r r r# r_ r rL r r r r� r r r5 r r r r r rK r r r �_retcode_quiet;
s` �������� �
� � �
�����������r4 c K s� |du rzt �dd�}W n ty d}Y nw t||�dd��}dd� }d|v r.|�d� d }tjj�� rP|rP|du rPt j
t d
d �}d }tjj j ||d
d� tjj
j|tj�tjj�| �d �d d�}| r�d|v spd|v r�|�dt �d��} t| |�d��|d< td | || |fi |��} | s�||� |r�||� ddddd d�S n!td | |�} | s�||� |r�||� ddddd d�S t�| |� tjj�� s�t�|d� t�|td |�d� tjj�� r�|�� dvr�t|d d�} n|} nt|�} t |�r| d t |� n| fi d |�d |�d | �d | �d!|
�d"|�d#|�d$|�d%|�d&|�d'|
�d(|�d)|�d|�d*|�d+|�d,|�d-|�d.|�d/|�|��} ||� |�rQ||� |�r\d | d0< | d1< | S )2a�
Download a script from a remote location and execute the script locally.
The script can be located on the salt master file server or on an HTTP/FTP
server.
The script will be executed directly, so it can be written in any available
programming language.
:param str source: The location of the script to download. If the file is
located on the master in the directory named spam, and is called eggs,
the source string is salt://spam/eggs
:param str args: String of command line args to pass to the script. Only
used if no args are specified as part of the `name` argument. To pass a
string containing spaces in YAML, you will need to doubly-quote it.
Additionally, if you need to pass falsey values (e.g., "0", "", "False"),
you should doubly-quote them to ensure they are correctly interpreted:
.. code-block:: bash
salt myminion cmd.script salt://foo.sh "arg1 'arg two' arg3"
salt myminion cmd.script salt://foo.sh "''0''"
salt myminion cmd.script salt://foo.sh "''False''"
:param str cwd: The directory from which to execute the command. Defaults
to the directory returned from Python's tempfile.mkstemp.
:param str stdin: A string of standard input can be specified for the
command to be run using the ``stdin`` parameter. This can be useful in
cases where sensitive information must be read from standard input.
:param str runas: Specify an alternate user to run the command. The default
behavior is to run as the user under which Salt is running. If running
on a Windows minion you must also use the ``password`` argument, and
the target user account must be in the Administrators group.
.. note::
For Window's users, specifically Server users, it may be necessary
to specify your runas user using the User Logon Name instead of the
legacy logon name. Traditionally, logons would be in the following
format.
``Domain/user``
In the event this causes issues when executing scripts, use the UPN
format which looks like the following.
``user@domain.local``
More information <https://github.com/saltstack/salt/issues/55080>
:param str password: Windows only. Required when specifying ``runas``. This
parameter will be ignored on non-Windows platforms.
.. versionadded:: 2016.3.0
:param str group: Group to run script as. Not currently supported
on Windows.
:param str shell: Specify an alternate shell. Defaults to the system's
default shell.
:param bool python_shell: If False, let python handle the positional
arguments. Set to True to use shell features, such as pipes or
redirection.
:param bool bg: If True, run script in background and do not await or
deliver its results
:param dict env: Environment variables to be set prior to execution.
.. note::
When passing environment variables on the CLI, they should be
passed as the string representation of a dictionary.
.. code-block:: bash
salt myminion cmd.script 'some command' env='{"FOO": "bar"}'
.. note::
When using environment variables on Window's, case-sensitivity
matters, i.e. Window's uses `Path` as opposed to `PATH` for other
systems.
:param str template: If this setting is applied then the named templating
engine will be used to render the downloaded file. Currently jinja,
mako, and wempy are supported.
:param str umask: The umask (in octal) to use when running the command.
:param str output_encoding: Control the encoding used to decode the
command's output.
.. note::
This should not need to be used in most cases. By default, Salt
will try to use the encoding detected from the system locale, and
will fall back to UTF-8 if this fails. This should only need to be
used in cases where the output of the command is encoded in
something other than the system locale or UTF-8.
To see the encoding Salt has detected from the system locale, check
the `locale` line in the output of :py:func:`test.versions_report
<salt.modules.test.versions_report>`.
.. versionadded:: 2018.3.0
:param str output_loglevel: Control the loglevel at which the output from
the command is logged to the minion log.
.. note::
The command being run will still be logged at the ``debug``
loglevel regardless, unless ``quiet`` is used for this value.
:param bool ignore_retcode: If the exit code of the command is nonzero,
this is treated as an error condition, and the output from the command
will be logged to the minion log. However, there are some cases where
programs use the return code for signaling and a nonzero exit code
doesn't necessarily mean failure. Pass this argument as ``True`` to
skip logging the output if the command has a nonzero exit code.
:param bool hide_output: If ``True``, suppress stdout and stderr in the
return data.
.. note::
This is separate from ``output_loglevel``, which only handles how
Salt logs to the minion log.
.. versionadded:: 2018.3.0
:param int timeout: If the command has not terminated after timeout
seconds, send the subprocess sigterm, and if sigterm is ignored, follow
up with sigkill
:param bool use_vt: Use VT utils (saltstack) to stream the command output
more interactively to the console and the logs. This is experimental.
:param list success_retcodes: This parameter will allow a list of
non-zero return codes that should be considered a success. If the
return code returned from the run matches any in the provided list,
the return code will be overridden with zero.
.. versionadded:: 2019.2.0
:param list success_stdout: This parameter will allow a list of
strings that when found in standard out should be considered a success.
If stdout returned from the run matches any in the provided list,
the return code will be overridden with zero.
.. versionadded:: 3004
:param list success_stderr: This parameter will allow a list of
strings that when found in standard error should be considered a success.
If stderr returned from the run matches any in the provided list,
the return code will be overridden with zero.
.. versionadded:: 3004
:param bool stdin_raw_newlines: False
If ``True``, Salt will not automatically convert the characters ``\n``
present in the ``stdin`` value to newlines.
.. versionadded:: 2019.2.0
:return: The return value of the script execution, including stdout, stderr,
and the exit code. If the script returns a falsey string value, it should be
doubly-quoted to ensure it is correctly interpreted by Salt.
CLI Example:
.. code-block:: bash
salt '*' cmd.script salt://scripts/runme.sh
salt '*' cmd.script salt://scripts/runme.sh 'arg1 arg2 "arg 3"'
salt '*' cmd.script salt://scripts/windows_task.ps1 args=' -Input c:\tmp\infile.txt' shell='powershell'
.. code-block:: bash
salt '*' cmd.script salt://scripts/runme.sh stdin='one\ntwo\nthree\nfour\nfive\n'
Nr5 r6 r$ r� c
S �R z t d | � W d S ttfy( } ztjd| |tjd� W Y d }~d S d }~ww )N� file.removez-cmd.script: Unable to clean tempfile '%s': %sr� �rN r r r r r r �r( r# r r r �_cleanup_tempfileK � ���z!script.<locals>._cleanup_tempfile�__env__FZcachedir)�dirTZ full_control)Zobj_nameZ principalZ permissionsr r� )r< �suffixr8 r9 zcp.get_template)r� r� r� r� Z cache_errorz
cp.cache_filei@ �file.user_to_uidr� r� )�escapere rQ r� r r r r r r r# r_ r r� r r r� r r r r r� r� ) r r! r" r% r� r7 r? r� r� r� ZmkdtempZwin_daclZset_permissionsr@ rA r' r( �splitext�urlZ split_envrO rN r� �copyfile�chmodr� rW r� r( r ) �sourcer rQ r� r r r r# r_ rL r r r r r, r� r r5 r r� r r r r rK r9 Zwin_cwdr( r8 Zfn_Zcmd_pathrd r r r rq t
s� Q �
� ���
� �������� �
� � �
���������rq Zjinjac K s� d|v r |� d� tdi d| �d|�d|�d|�d|�d|�d|�d |�d
|�d | �d |
�d
| �d| �d|
�d|�d|�d|�d|�d|�d|�d|�d|�|��d S )a�
Download a script from a remote location and execute the script locally.
The script can be located on the salt master file server or on an HTTP/FTP
server.
The script will be executed directly, so it can be written in any available
programming language.
The script can also be formatted as a template, the default is jinja.
Only evaluate the script return code and do not block for terminal output
:param str source: The location of the script to download. If the file is
located on the master in the directory named spam, and is called eggs,
the source string is salt://spam/eggs
:param str args: String of command line args to pass to the script. Only
used if no args are specified as part of the `name` argument. To pass a
string containing spaces in YAML, you will need to doubly-quote it:
"arg1 'arg two' arg3"
:param str cwd: The directory from which to execute the command. Defaults
to the home directory of the user specified by ``runas`` (or the user
under which Salt is running if ``runas`` is not specified).
:param str stdin: A string of standard input can be specified for the
command to be run using the ``stdin`` parameter. This can be useful in
cases where sensitive information must be read from standard input.
:param str runas: Specify an alternate user to run the command. The default
behavior is to run as the user under which Salt is running. If running
on a Windows minion you must also use the ``password`` argument, and
the target user account must be in the Administrators group.
:param str password: Windows only. Required when specifying ``runas``. This
parameter will be ignored on non-Windows platforms.
.. versionadded:: 2016.3.0
:param str group: Group to run script as. Not currently supported
on Windows.
:param str shell: Specify an alternate shell. Defaults to the system's
default shell.
:param bool python_shell: If False, let python handle the positional
arguments. Set to True to use shell features, such as pipes or
redirection.
:param dict env: Environment variables to be set prior to execution.
.. note::
When passing environment variables on the CLI, they should be
passed as the string representation of a dictionary.
.. code-block:: bash
salt myminion cmd.script_retcode 'some command' env='{"FOO": "bar"}'
.. note::
When using environment variables on Window's, case-sensitivity
matters, i.e. Window's uses `Path` as opposed to `PATH` for other
systems.
:param str template: If this setting is applied then the named templating
engine will be used to render the downloaded file. Currently jinja,
mako, and wempy are supported.
:param str umask: The umask (in octal) to use when running the command.
:param str output_encoding: Control the encoding used to decode the
command's output.
.. note::
This should not need to be used in most cases. By default, Salt
will try to use the encoding detected from the system locale, and
will fall back to UTF-8 if this fails. This should only need to be
used in cases where the output of the command is encoded in
something other than the system locale or UTF-8.
To see the encoding Salt has detected from the system locale, check
the `locale` line in the output of :py:func:`test.versions_report
<salt.modules.test.versions_report>`.
.. versionadded:: 2018.3.0
:param str output_loglevel: Control the loglevel at which the output from
the command is logged to the minion log.
.. note::
The command being run will still be logged at the ``debug``
loglevel regardless, unless ``quiet`` is used for this value.
:param bool ignore_retcode: If the exit code of the command is nonzero,
this is treated as an error condition, and the output from the command
will be logged to the minion log. However, there are some cases where
programs use the return code for signaling and a nonzero exit code
doesn't necessarily mean failure. Pass this argument as ``True`` to
skip logging the output if the command has a nonzero exit code.
:param int timeout: If the command has not terminated after timeout
seconds, send the subprocess sigterm, and if sigterm is ignored, follow
up with sigkill
:param bool use_vt: Use VT utils (saltstack) to stream the command output
more interactively to the console and the logs. This is experimental.
:param list success_retcodes: This parameter will allow a list of
non-zero return codes that should be considered a success. If the
return code returned from the run matches any in the provided list,
the return code will be overridden with zero.
.. versionadded:: 2019.2.0
:param list success_stdout: This parameter will allow a list of
strings that when found in standard out should be considered a success.
If stdout returned from the run matches any in the provided list,
the return code will be overridden with zero.
.. versionadded:: 3004
:param list success_stderr: This parameter will allow a list of
strings that when found in standard error should be considered a success.
If stderr returned from the run matches any in the provided list,
the return code will be overridden with zero.
.. versionadded:: 3004
:param bool stdin_raw_newlines: False
If ``True``, Salt will not automatically convert the characters ``\n``
present in the ``stdin`` value to newlines.
.. versionadded:: 2019.2.0
CLI Example:
.. code-block:: bash
salt '*' cmd.script_retcode salt://scripts/runme.sh
salt '*' cmd.script_retcode salt://scripts/runme.sh 'arg1 arg2 "arg 3"'
salt '*' cmd.script_retcode salt://scripts/windows_task.ps1 args=' -Input c:\tmp\infile.txt' shell='powershell'
A string of standard input can be specified for the command to be run using
the ``stdin`` parameter. This can be useful in cases where sensitive
information must be read from standard input.
.. code-block:: bash
salt '*' cmd.script_retcode salt://scripts/runme.sh stdin='one\ntwo\nthree\nfour\nfive\n'
r; rD r rQ r� r r r r# r_ rL r r� r r5 r r r r r r r r r� Nr )r� rq )rD r rQ r� r r r r# r_ rL r r� r r5 r r r r r r r r rK r r r �script_retcode� sf 0
�������� �
� � �
�����������rE c C � t jj�| �S )z�
Returns the path of an executable available on the minion, None otherwise
CLI Example:
.. code-block:: bash
salt '*' cmd.which cat
)r7 r? r( rv r r r r rv � �
rv c C rF )z�
Returns the first command found in a list of commands
CLI Example:
.. code-block:: bash
salt '*' cmd.which_bin '[pip2, pip, pip-python]'
)r7 r? r( r� )Zcmdsr r r r� � rG r� c C s t | �duS )z�
Returns true if the executable is available on the minion, false otherwise
CLI Example:
.. code-block:: bash
salt '*' cmd.has_exec cat
N)rv r r r r �has_exec� s
rH c K s t | |||fi |��d S )a
Pass in two strings, the first naming the executable language, aka -
python2, python3, ruby, perl, lua, etc. the second string containing
the code you wish to execute. The stdout will be returned.
All parameters from :mod:`cmd.run_all <salt.modules.cmdmod.run_all>` except python_shell can be used.
CLI Example:
.. code-block:: bash
salt '*' cmd.exec_code ruby 'puts "cheese"'
salt '*' cmd.exec_code ruby 'puts "cheese"' args='["arg1", "arg2"]' env='{"FOO": "bar"}'
r� )�
exec_code_all)�lang�coderQ r rK r r r � exec_code� s rL c K s | � � �d�}|rtjjjdd�}ntjj�� }tjjj|ddd��}|�tjj� |�� W d � n1 s7w Y |rD| d|g}n| |g}t
|t �rS|� |� n t
|t
�r\||7 }d d
� } |�d �}
|
durztjj�� szt�|td |
�d
� t|f|dd�|��} | |� | S )a5
Pass in two strings, the first naming the executable language, aka -
python2, python3, ruby, perl, lua, etc. the second string containing
the code you wish to execute. All cmd artifacts (stdout, stderr, retcode, pid)
will be returned.
All parameters from :mod:`cmd.run_all <salt.modules.cmdmod.run_all>` except python_shell can be used.
CLI Example:
.. code-block:: bash
salt '*' cmd.exec_code_all ruby 'puts "cheese"'
salt '*' cmd.exec_code_all ruby 'puts "cheese"' args='["arg1", "arg2"]' env='{"FOO": "bar"}'
r� z.ps1)r= zw+tF)�binaryNz-Filec
S r5 )Nr6 z4cmd.exec_code_all: Unable to clean tempfile '%s': %sr� r7 r8 r r r r9 � r: z(exec_code_all.<locals>._cleanup_tempfiler r> r� )rQ r# )rW r* r7 r? r@ rA rB rC rD r< r r r+ r r! r� r� r' r� rN r3 ) rJ rK rQ r rK r� ZcodefilerI r
r9 r rd r r r rI � s, �
rI r� c C s� | � d�r d| � �}n| � d�rd�| �dd��}nddiS z*tjj�|d��}|�tjj� |�� W d � n1 s<w Y d
d |� �iW S t
yY dd |� d
�i Y S w )z�
Echo a string to a specific tty
CLI Example:
.. code-block:: bash
salt '*' cmd.tty tty0 'This is a test'
salt '*' cmd.tty pts3 'This is a test'
�ttyz/dev/Zptsz/dev/{}zpts/�Errorz'The specified device is not a valid TTY�wbNZSuccessz#Message was successfully echoed to z Echoing to z returned error) r* rG r� r7 r? r@ rB rC rD r� r/ )ZdeviceZechoZteletypeZ
tty_devicer r r rN � s
� �rN rU c & K s� t d tj�| d�ddd� t d tj�| d�ddd� t d tj�| d�ddd� |r.|ng }|D ]} tj�| tjj�} tj�| | �} t d | | dd � q2d
} tj�tj�| d ��r]d } t|tt f�rnd
�dd� |D ��}|r{d�
||rw|nd�} nd} d| � d
| � d
| � dt |�� �}t �
dt�} | |fi d|�d|�d|�d|�d| �d|
�d| �d | �d |
�d |�d |�d |�d!|�d"|�d#|�d$|�d%|�d%��d&|�d&��d'|�d(|�d)|�d*|�d+|��}!td,�D ] }"t| �}#|#s� n|#D ]}$|"d-k r�d.nd/}%t�|$|%� q�q�t| ��rt�d0� |D ]} tj�| tjj�} tj�| | �} t d1 | � �qt d1 tj�| d�� t d1 tj�| d�� t d1 tj�| d�� |�rXd |!d2< |!d3< |!S )4a�
.. versionadded:: 2014.7.0
This function runs :mod:`cmd.run_all <salt.modules.cmdmod.run_all>` wrapped
within a chroot, with dev and proc mounted in the chroot
:param str root: Path to the root of the jail to use.
:param str stdin: A string of standard input can be specified for
the command to be run using the ``stdin`` parameter. This can
be useful in cases where sensitive information must be read
from standard input.:
:param str runas: User to run script as.
:param str group: Group to run script as.
:param str shell: Shell to execute under. Defaults to the system
default shell.
:param str cmd: The command to run. ex: ``ls -lart /home``
:param str cwd: The directory from which to execute the command. Defaults
to the home directory of the user specified by ``runas`` (or the user
under which Salt is running if ``runas`` is not specified).
:parar str stdin: A string of standard input can be specified for the
command to be run using the ``stdin`` parameter. This can be useful in
cases where sensitive information must be read from standard input.
:param str runas: Specify an alternate user to run the command. The default
behavior is to run as the user under which Salt is running. If running
on a Windows minion you must also use the ``password`` argument, and
the target user account must be in the Administrators group.
:param str shell: Specify an alternate shell. Defaults to the system's
default shell.
:param bool python_shell: If False, let python handle the positional
arguments. Set to True to use shell features, such as pipes or
redirection.
:param list binds: List of directories that will be exported inside
the chroot with the bind option.
.. versionadded:: 3000
:param dict env: Environment variables to be set prior to execution.
.. note::
When passing environment variables on the CLI, they should be
passed as the string representation of a dictionary.
.. code-block:: bash
salt myminion cmd.run_chroot 'some command' env='{"FOO": "bar"}'
.. note::
When using environment variables on Window's, case-sensitivity
matters, i.e. Window's uses `Path` as opposed to `PATH` for other
systems.
:param dict clean_env: Attempt to clean out all other shell environment
variables and set only those provided in the 'env' argument to this
function.
:param str template: If this setting is applied then the named templating
engine will be used to render the downloaded file. Currently jinja,
mako, and wempy are supported.
:param bool rstrip: Strip all whitespace off the end of output
before it is returned.
:param str umask: The umask (in octal) to use when running the
command.
:param str output_encoding: Control the encoding used to decode the
command's output.
.. note::
This should not need to be used in most cases. By default, Salt
will try to use the encoding detected from the system locale, and
will fall back to UTF-8 if this fails. This should only need to be
used in cases where the output of the command is encoded in
something other than the system locale or UTF-8.
To see the encoding Salt has detected from the system locale, check
the `locale` line in the output of :py:func:`test.versions_report
<salt.modules.test.versions_report>`.
.. versionadded:: 2018.3.0
:param str output_loglevel: Control the loglevel at which the output from
the command is logged to the minion log.
.. note::
The command being run will still be logged at the ``debug``
loglevel regardless, unless ``quiet`` is used for this value.
:param bool ignore_retcode: If the exit code of the command is nonzero,
this is treated as an error condition, and the output from the command
will be logged to the minion log. However, there are some cases where
programs use the return code for signaling and a nonzero exit code
doesn't necessarily mean failure. Pass this argument as ``True`` to
skip logging the output if the command has a nonzero exit code.
:param bool hide_output: If ``True``, suppress stdout and stderr in the
return data.
.. note::
This is separate from ``output_loglevel``, which only handles how
Salt logs to the minion log.
.. versionadded:: 2018.3.0
:param int timeout:
A timeout in seconds for the executed process to return.
:param bool use_vt:
Use VT utils (saltstack) to stream the command output more
interactively to the console and the logs. This is experimental.
:param success_retcodes: This parameter will allow a list of
non-zero return codes that should be considered a success. If the
return code returned from the run matches any in the provided list,
the return code will be overridden with zero.
.. versionadded:: 2019.2.0
:param list success_stdout: This parameter will allow a list of
strings that when found in standard out should be considered a success.
If stdout returned from the run matches any in the provided list,
the return code will be overridden with zero.
.. versionadded:: 3004
:param list success_stderr: This parameter will allow a list of
strings that when found in standard error should be considered a success.
If stderr returned from the run matches any in the provided list,
the return code will be overridden with zero.
.. versionadded:: 3004
CLI Example:
.. code-block:: bash
salt '*' cmd.run_chroot /var/lib/lxc/container_name/rootfs 'sh /tmp/bootstrap.sh'
z mount.mount�devZdevtmpfs)Zfstyper$ r� Zsysfsz default,bind)r; z/bin/shzbin/bashz /bin/bashre c S r� r )r r� r r r rh �
s z run_chroot.<locals>.<listcomp>z--userspec {}:{}r� zchroot r� zcmd.run_chroot.funcrQ r� r r# r_ r rL r
r r r r r� r r r5 r8 r9 r r r r r� � rm � r� zOProcesses running in chroot could not be killed, filesystem will remain mountedz mount.umountr� r� )rN r' r( rZ �relpathr� r� r r r rG r� r� r� r3 r! �ranger4 r� r r )&r2 r
rQ r� r r r r# Zbindsr_ r rL r
r r r r r, r� r r r5 r r� r r r rK Z
bind_exportedZbind_exported_toZsh_ZuserspecZrun_funcrd r� r1 r� �sigr r r �
run_chroot
s� 4 �������� �
� � �
�����
�
������ �
�rW c C s� t jj�� rdS d}g }tj�|�rRz5t jj�|d��}dd� |� � �
� D �}W d � n1 s1w Y |D ]
}|� d�r@q8|� |� q8W n t
yQ Y dS w dS | |v rZdS dS ) ze
Attempts to search for valid shells on a system and
see if a given shell is in the list
T� /etc/shells�rc S � g | ] }t jj�|��qS r �r7 r? rD r rf r r r rh " � ��z#_is_valid_shell.<locals>.<listcomp>N�#F)r7 r? r� r� r' r( �existsr@ rB �read�
splitlinesr* r+ r/ )r �shellsZavailable_shells�shell_fp�lines�liner r r r� s.
� �
� �r� c C s� d} g }t j�| �rXz=tjj�| d��}dd� |�� �� D �}W d � n1 s)w Y |D ]}|� � }|�
d�r<q0|s?q0|� |� q0W |S t yW t
�d| � Y |S w |S )z�
Lists the valid shells on this system via the /etc/shells file
.. versionadded:: 2015.5.0
CLI Example:
.. code-block:: bash
salt '*' cmd.shells
rX rY c S rZ r r[ rf r r r rh G r\ zshells.<locals>.<listcomp>Nr] zFile '%s' was not found)r' r( r^ r7 r? r@ rB r_ r` r r* r+ r/ r r )Z shells_fnrd rb rc rd r r r ra 6 s.
� �
�
��ra c C s g d�g d�g d�g d�g d�g d�g d�g d�g d �g d
�g d �d � }d
di}t jj�� r�| dkr�t jjjddd�}|jtd� |sHddd�S |D ]�}t jjjdd|� �dd�}|� d�dkr�|� d�d kr�t jjj
dd � |�d�}i }d |d
< t d �|d < |D ]c}|d! �
� d"kr�q�|d! �
� d#kr�|d |d$< |d |d%< q�|d! �
� d&kr�|d |d'< |d' d( �
� d)kr�|d' d d � |d'< q�|d! �
� d*kr�|d �d+d,��d-�|d.< q�|d ||d! �
� < q�qJn�| |vr�d/� | �d d�S || } | �d(�}
t jj�� �r d(d l} | j} ntj} d0| v�r*t jj�� �s*tj�d1�| d0< t�d2| d0 � zt jjj| d tjtj d3| d4�}
W n t �yZ } zd5� d+� | �|�dd�W Y d }~S d }~ww z|
� � W n t �y } zd6� d+� | ��dd�W Y d }~S d }~ww t | d( �|d < t!j"|
|
j#t!j$d7�}|�r�|�%d �|d%< d%|v �r�t!�&d8|d% �}|�r�d9|d
< |�%d ��d:�d d;� }t'|�d k�r�|�(d<� d:� |d d;� �|d=< nd |d
< | dk�r�|d
�r�|�r�t jj)�*� |d>< d=|v�rd?� | �|d@< |
j#|dA< t�+|d@ � |S )Ba�
.. versionadded:: 2016.11.0
Provides information about a shell or script languages which often use
``#!``. The values returned are dependent on the shell or scripting
languages all return the ``installed``, ``path``, ``version``,
``version_raw``
Args:
shell (str): Name of the shell. Support shells/script languages include
bash, cmd, perl, php, powershell, python, ruby and zsh
list_modules (bool): True to list modules available to the shell.
Currently only lists powershell modules.
Returns:
dict: A dictionary of information about the shell
.. code-block:: python
{'version': '<2 or 3 numeric components dot-separated>',
'version_raw': '<full version string>',
'path': '<full path to binary>',
'installed': <True, False or None>,
'<attribute>': '<attribute value>'}
.. note::
- ``installed`` is always returned, if ``None`` or ``False`` also
returns error and may also return ``stdout`` for diagnostics.
- ``version`` is for use in determine if a shell/script language has a
particular feature set, not for package management.
- The shell must be within the executable search path.
CLI Example:
.. code-block:: bash
salt '*' cmd.shell_info bash
salt '*' cmd.shell_info powershell
:codeauthor: Damon Atkins <https://github.com/damon-atkins>
)zversion (\d\S*)�bash� --version)zversioZ ([-\w.]+)re rf )z (HOME=.*)re r� Zdeclare)z ^zsh (\d\S*)�zshrf )z
^tcsh (\d\S*)�tcshrf )zVersion ([\d.]+)zcmd.exez/C�ver)zPSVersion\s+(\d\S*)r� rl z$PSVersionTable)z^(\d\S*)�perlz-ezprintf "%vd
", $^V;)z^Python (\d\S*)�pythonz-V)z
^ruby (\d\S*)�ruby�-v)z ^PHP (\d\S*)�phprm ) re zbash-test-errorz
bash-test-envrg rh r
r� rj rk rl rn � installedFr� �HKEY_LOCAL_MACHINEz Software\Microsoft\PowerShell)�hive�key)rr zBUnable to locate 'powershell' Reason: Cannot be found in registry.)r ro z Software\Microsoft\PowerShell\ZInstall)rq rr �vnameZvtypeZ REG_DWORDZvdatar� z1Software\Microsoft\PowerShell\{}\PowerShellEngineNzpowershell.exer( rs z (default)Zpowershellversion� psversionZ version_rawZruntimeversionZ
crlversionr r� Zpscompatibleversionre r� �,Zpscompatibleversionsz7Salt does not know how to get the version number for {}r� r� zHOME environment set to %s�
)r� r� r� r� r_ z%Unable to run command '{}' Reason: {}z-Unable to run command '{}' Reason: Timed out.)�flagsz
(\d[\d.]*)Trt rm r� �version�moduleszIThe version regex pattern for shell {}, could not find the version stringr r� ),r7 r? r� r� Zwin_regZ list_keys�sortr, Z
read_valuer! Z list_valuesrG rv rW r� r r� r� r� r' r( r� r rz r r r� r� r) r/ rZ r r r� r� r� �
IGNORECASEr �match�lenr+ r� Z get_modulesr )r Z list_modulesZ regex_shellsrd Zpw_keysZreg_verZ install_data�detailsZ attributeZ
shell_data�patternr� Znewenvr$ r# Zpattern_resultZversion_resultsZver_listr r r �
shell_infoX s� ,� � ���� ����-��
�
���� ����
�
�
r� r� c K s� |dvrt d��d|v r|�d�}nd}t| t�r d�| �} td�d }tjj� |d�d kr>| d
7 } |d ur>| d |� d�7 } d
| d } |ret
� d| � d| � �} | � d�}t
�|�} tjj�| �} d} nd| � d�} d} t| fi d|�d|�d|�d|�d|�d|�d|�d |�d | �d |
�d | �d | �d!|
�d"|�d#|�d$|�d%|�d|�d&|�d'| �d(|�d)|�d*|�|��} t| �} ztjj�| �W S ty� t
jd+dd,� i Y S w )-a�
Execute the passed PowerShell command and return the output as a dictionary.
Other ``cmd.*`` functions (besides ``cmd.powershell_all``)
return the raw text output of the command. This
function appends ``| ConvertTo-JSON`` to the command and then parses the
JSON into a Python dictionary. If you want the raw textual result of your
PowerShell command you should use ``cmd.run`` with the ``shell=powershell``
option.
For example:
.. code-block:: bash
salt '*' cmd.run '$PSVersionTable.CLRVersion' shell=powershell
salt '*' cmd.run 'Get-NetTCPConnection' shell=powershell
.. versionadded:: 2016.3.0
.. warning::
This passes the cmd argument directly to PowerShell
without any further processing! Be absolutely sure that you
have properly sanitized the command passed to this function
and do not use untrusted inputs.
In addition to the normal ``cmd.run`` parameters, this command offers the
``depth`` parameter to change the Windows default depth for the
``ConvertTo-JSON`` powershell command. The Windows default is 2. If you need
more depth, set that here.
.. note::
For some commands, setting the depth to a value greater than 4 greatly
increases the time it takes for the command to return and in many cases
returns useless data.
:param str cmd: The powershell command to run.
:param str cwd: The directory from which to execute the command. Defaults
to the home directory of the user specified by ``runas`` (or the user
under which Salt is running if ``runas`` is not specified).
:param str stdin: A string of standard input can be specified for the
command to be run using the ``stdin`` parameter. This can be useful in cases
where sensitive information must be read from standard input.
:param str runas: Specify an alternate user to run the command. The default
behavior is to run as the user under which Salt is running. If running
on a Windows minion you must also use the ``password`` argument, and
the target user account must be in the Administrators group.
:param str password: Windows only. Required when specifying ``runas``. This
parameter will be ignored on non-Windows platforms.
.. versionadded:: 2016.3.0
:param str shell: Specify an alternate shell. Defaults to "powershell". Can
also use "pwsh" for powershell core if present on the system
:param bool python_shell: If False, let python handle the positional
arguments. Set to True to use shell features, such as pipes or
redirection.
:param dict env: Environment variables to be set prior to execution.
.. note::
When passing environment variables on the CLI, they should be
passed as the string representation of a dictionary.
.. code-block:: bash
salt myminion cmd.powershell 'some command' env='{"FOO": "bar"}'
.. note::
When using environment variables on Window's, case-sensitivity
matters, i.e. Window's uses `Path` as opposed to `PATH` for other
systems.
:param bool clean_env: Attempt to clean out all other shell environment
variables and set only those provided in the 'env' argument to this
function.
:param str template: If this setting is applied then the named templating
engine will be used to render the downloaded file. Currently jinja,
mako, and wempy are supported.
:param bool rstrip: Strip all whitespace off the end of output before it is
returned.
:param str umask: The umask (in octal) to use when running the command.
:param str output_encoding: Control the encoding used to decode the
command's output.
.. note::
This should not need to be used in most cases. By default, Salt
will try to use the encoding detected from the system locale, and
will fall back to UTF-8 if this fails. This should only need to be
used in cases where the output of the command is encoded in
something other than the system locale or UTF-8.
To see the encoding Salt has detected from the system locale, check
the `locale` line in the output of :py:func:`test.versions_report
<salt.modules.test.versions_report>`.
.. versionadded:: 2018.3.0
:param str output_loglevel: Control the loglevel at which the output from
the command is logged to the minion log.
.. note::
The command being run will still be logged at the ``debug``
loglevel regardless, unless ``quiet`` is used for this value.
:param bool ignore_retcode: If the exit code of the command is nonzero,
this is treated as an error condition, and the output from the command
will be logged to the minion log. However, there are some cases where
programs use the return code for signaling and a nonzero exit code
doesn't necessarily mean failure. Pass this argument as ``True`` to
skip logging the output if the command has a nonzero exit code.
:param bool hide_output: If ``True``, suppress stdout and stderr in the
return data.
.. note::
This is separate from ``output_loglevel``, which only handles how
Salt logs to the minion log.
.. versionadded:: 2018.3.0
:param int timeout: A timeout in seconds for the executed process to return.
:param bool use_vt: Use VT utils (saltstack) to stream the command output
more interactively to the console and the logs. This is experimental.
:param bool reset_system_locale: Resets the system locale
:param str saltenv: The salt environment to use. Default is 'base'
:param int depth: The number of levels of contained objects to be included.
Default is 2. Values greater than 4 seem to greatly increase the time
it takes for the command to complete for some commands. eg: ``dir``
.. versionadded:: 2016.3.4
:param bool encode_cmd: Encode the command before executing. Use in cases
where characters may be dropped or incorrectly converted when executed.
Default is False.
:param list success_retcodes: This parameter will allow a list of
non-zero return codes that should be considered a success. If the
return code returned from the run matches any in the provided list,
the return code will be overridden with zero.
.. versionadded:: 2019.2.0
:param list success_stdout: This parameter will allow a list of
strings that when found in standard out should be considered a success.
If stdout returned from the run matches any in the provided list,
the return code will be overridden with zero.
.. versionadded:: 3004
:param list success_stderr: This parameter will allow a list of
strings that when found in standard error should be considered a success.
If stderr returned from the run matches any in the provided list,
the return code will be overridden with zero.
.. versionadded:: 3004
:param bool stdin_raw_newlines: False
If ``True``, Salt will not automatically convert the characters ``\n``
present in the ``stdin`` value to newlines.
.. versionadded:: 2019.2.0
:returns:
:dict: A dictionary of data returned by the powershell command.
CLI Example:
.. code-block:: powershell
salt '*' cmd.powershell "$PSVersionTable.CLRVersion"
r� �FMust specify a valid powershell binary. Must be 'powershell' or 'pwsh'r# Tre r� rt �2.0r� z | ConvertTo-JSON Nz-Depth ztry { z } catch { "{}" }� Encoding PowerShell command '%s'�($ProgressPreference='SilentlyContinue'; � utf-16-lez{ z }FrQ r� r r r_ r rL r
r r r r, r� r r r5 r r r{ r r r z'Error converting PowerShell JSON return)�exc_info)r r� r r rZ r� r7 r? �versions� version_cmpr rz r� �base64�standard_b64encoderD r< r0 �_prep_powershell_json�json�loads� Exceptionr ) r
rQ r� r r r_ r rL r
r r r r, r� r r r5 r r �depth�
encode_cmdr r r rK r# rt � cmd_utf16r{ �responser r r r� - s� U�
�������� �
� � �
������������ �c " K s |dvrt d��d|v r|�d�}nd}t| t�r d�| �} td�d }tjj� |d�d kr=| d
7 } |d ur=| d |� �7 } |r^t
� d
| � d| � �} | � d�} t
�| �} tjj�| �} d} nd} t| fi d|�d|�d|�d|�d|�d|�d|�d|�d| �d|
�d| �d | �d |
�d |�d |�d |�d!|�d|�d"|�d#| �d$|�d%|�d&|�|��} | d' } | s�| �d'� |r�g | d(< | S t| �} z tjj�| �} W n ty� d)}!| | d*< t |!| d+��w | �d'� t| �tur�|r�| g| d(< n | | d(< n| | d(< d,| d- v �rd.| d-< | S )/a*-
Execute the passed PowerShell command and return a dictionary with a result
field representing the output of the command, as well as other fields
showing us what the PowerShell invocation wrote to ``stderr``, the process
id, and the exit code of the invocation.
This function appends ``| ConvertTo-JSON`` to the command before actually
invoking powershell.
An unquoted empty string is not valid JSON, but it's very normal for the
Powershell output to be exactly that. Therefore, we do not attempt to parse
empty Powershell output (which would result in an exception). Instead we
treat this as a special case and one of two things will happen:
- If the value of the ``force_list`` parameter is ``True``, then the
``result`` field of the return dictionary will be an empty list.
- If the value of the ``force_list`` parameter is ``False``, then the
return dictionary **will not have a result key added to it**. We aren't
setting ``result`` to ``None`` in this case, because ``None`` is the
Python representation of "null" in JSON. (We likewise can't use ``False``
for the equivalent reason.)
If Powershell's output is not an empty string and Python cannot parse its
content, then a ``CommandExecutionError`` exception will be raised.
If Powershell's output is not an empty string, Python is able to parse its
content, and the type of the resulting Python object is other than ``list``
then one of two things will happen:
- If the value of the ``force_list`` parameter is ``True``, then the
``result`` field will be a singleton list with the Python object as its
sole member.
- If the value of the ``force_list`` parameter is ``False``, then the value
of ``result`` will be the unmodified Python object.
If Powershell's output is not an empty string, Python is able to parse its
content, and the type of the resulting Python object is ``list``, then the
value of ``result`` will be the unmodified Python object. The
``force_list`` parameter has no effect in this case.
.. note::
An example of why the ``force_list`` parameter is useful is as
follows: The Powershell command ``dir x | Convert-ToJson`` results in
- no output when x is an empty directory.
- a dictionary object when x contains just one item.
- a list of dictionary objects when x contains multiple items.
By setting ``force_list`` to ``True`` we will always end up with a
list of dictionary items, representing files, no matter how many files
x contains. Conversely, if ``force_list`` is ``False``, we will end
up with no ``result`` key in our return dictionary when x is an empty
directory, and a dictionary object when x contains just one file.
If you want a similar function but with a raw textual result instead of a
Python dictionary, you should use ``cmd.run_all`` in combination with
``shell=powershell``.
The remaining fields in the return dictionary are described in more detail
in the ``Returns`` section.
Example:
.. code-block:: bash
salt '*' cmd.run_all '$PSVersionTable.CLRVersion' shell=powershell
salt '*' cmd.run_all 'Get-NetTCPConnection' shell=powershell
.. versionadded:: 2018.3.0
.. warning::
This passes the cmd argument directly to PowerShell without any further
processing! Be absolutely sure that you have properly sanitized the
command passed to this function and do not use untrusted inputs.
In addition to the normal ``cmd.run`` parameters, this command offers the
``depth`` parameter to change the Windows default depth for the
``ConvertTo-JSON`` powershell command. The Windows default is 2. If you need
more depth, set that here.
.. note::
For some commands, setting the depth to a value greater than 4 greatly
increases the time it takes for the command to return and in many cases
returns useless data.
:param str cmd: The powershell command to run.
:param str cwd: The directory from which to execute the command. Defaults
to the home directory of the user specified by ``runas`` (or the user
under which Salt is running if ``runas`` is not specified).
:param str stdin: A string of standard input can be specified for the
command to be run using the ``stdin`` parameter. This can be useful in
cases where sensitive information must be read from standard input.
:param str runas: Specify an alternate user to run the command. The default
behavior is to run as the user under which Salt is running. If running
on a Windows minion you must also use the ``password`` argument, and
the target user account must be in the Administrators group.
:param str password: Windows only. Required when specifying ``runas``. This
parameter will be ignored on non-Windows platforms.
:param str shell: Specify an alternate shell. Defaults to "powershell". Can
also use "pwsh" for powershell core if present on the system
:param bool python_shell: If False, let python handle the positional
arguments. Set to True to use shell features, such as pipes or
redirection.
:param dict env: Environment variables to be set prior to execution.
.. note::
When passing environment variables on the CLI, they should be
passed as the string representation of a dictionary.
.. code-block:: bash
salt myminion cmd.powershell_all 'some command' env='{"FOO": "bar"}'
.. note::
When using environment variables on Window's, case-sensitivity
matters, i.e. Window's uses `Path` as opposed to `PATH` for other
systems.
:param bool clean_env: Attempt to clean out all other shell environment
variables and set only those provided in the 'env' argument to this
function.
:param str template: If this setting is applied then the named templating
engine will be used to render the downloaded file. Currently jinja,
mako, and wempy are supported.
:param bool rstrip: Strip all whitespace off the end of output before it is
returned.
:param str umask: The umask (in octal) to use when running the command.
:param str output_encoding: Control the encoding used to decode the
command's output.
.. note::
This should not need to be used in most cases. By default, Salt
will try to use the encoding detected from the system locale, and
will fall back to UTF-8 if this fails. This should only need to be
used in cases where the output of the command is encoded in
something other than the system locale or UTF-8.
To see the encoding Salt has detected from the system locale, check
the `locale` line in the output of :py:func:`test.versions_report
<salt.modules.test.versions_report>`.
.. versionadded:: 2018.3.0
:param str output_loglevel: Control the loglevel at which the output from
the command is logged to the minion log.
.. note::
The command being run will still be logged at the ``debug``
loglevel regardless, unless ``quiet`` is used for this value.
:param bool ignore_retcode: If the exit code of the command is nonzero,
this is treated as an error condition, and the output from the command
will be logged to the minion log. However, there are some cases where
programs use the return code for signaling and a nonzero exit code
doesn't necessarily mean failure. Pass this argument as ``True`` to
skip logging the output if the command has a nonzero exit code.
:param int timeout: A timeout in seconds for the executed process to
return.
:param bool use_vt: Use VT utils (saltstack) to stream the command output
more interactively to the console and the logs. This is experimental.
:param bool reset_system_locale: Resets the system locale
:param bool ignore_retcode: If the exit code of the command is nonzero,
this is treated as an error condition, and the output from the command
will be logged to the minion log. However, there are some cases where
programs use the return code for signaling and a nonzero exit code
doesn't necessarily mean failure. Pass this argument as ``True`` to
skip logging the output if the command has a nonzero exit code.
:param str saltenv: The salt environment to use. Default is 'base'
:param int depth: The number of levels of contained objects to be included.
Default is 2. Values greater than 4 seem to greatly increase the time
it takes for the command to complete for some commands. eg: ``dir``
:param bool encode_cmd: Encode the command before executing. Use in cases
where characters may be dropped or incorrectly converted when executed.
Default is False.
:param bool force_list: The purpose of this parameter is described in the
preamble of this function's documentation. Default value is False.
:param list success_retcodes: This parameter will allow a list of
non-zero return codes that should be considered a success. If the
return code returned from the run matches any in the provided list,
the return code will be overridden with zero.
.. versionadded:: 2019.2.0
:param list success_stdout: This parameter will allow a list of
strings that when found in standard out should be considered a success.
If stdout returned from the run matches any in the provided list,
the return code will be overridden with zero.
.. versionadded:: 3004
:param list success_stderr: This parameter will allow a list of
strings that when found in standard error should be considered a success.
If stderr returned from the run matches any in the provided list,
the return code will be overridden with zero.
.. versionadded:: 3004
:param bool stdin_raw_newlines: False
If ``True``, Salt will not automatically convert the characters ``\n``
present in the ``stdin`` value to newlines.
.. versionadded:: 2019.2.0
:return: A dictionary with the following entries:
result
For a complete description of this field, please refer to this
function's preamble. **This key will not be added to the dictionary
when force_list is False and Powershell's output is the empty
string.**
stderr
What the PowerShell invocation wrote to ``stderr``.
pid
The process id of the PowerShell invocation
retcode
This is the exit code of the invocation of PowerShell.
If the final execution status (in PowerShell) of our command
(with ``| ConvertTo-JSON`` appended) is ``False`` this should be non-0.
Likewise if PowerShell exited with ``$LASTEXITCODE`` set to some
non-0 value, then ``retcode`` will end up with this value.
:rtype: dict
CLI Example:
.. code-block:: bash
salt '*' cmd.powershell_all "$PSVersionTable.CLRVersion"
CLI Example:
.. code-block:: bash
salt '*' cmd.powershell_all "dir mydirectory" force_list=True
r� r� r# Tre r� rt r� r� z | ConvertTo-JSONNz -Depth r� r� r� FrQ r� r r r_ r rL r
r r r rU r� r r r5 r r r{ r r r r� r= z6cmd.powershell_all cannot parse the Powershell output.r
)�messagerT r� r� r� )r r� r r rZ r� r7 r? r� r� r rz r� r� r� rD r< r3 r� r� r� r� �type)"r
rQ r� r r r_ r rL r
r r r rU r� r r r5 r r r� r� Z
force_listr r r rK r# rt r� r{ r� Z stdoutputr= �err_msgr r r �powershell_allP s� �
�������� �
� � �
������������
�
r� c s> � dkrd� � S g d�}t � fdd�|D ��s d� � d�� � S )zc
Try to fix the output from OutputTo-JSON in powershell commands to make it
valid JSON
r� z"")�"�{�[c 3 s � | ]}� � |�V qd S r )r* rf ��textr r r� � s � z(_prep_powershell_json.<locals>.<genexpr>r� )r� )r� Z starts_withr r� r r� � s � r� c K s� t ||�dd��}t| fi dd�dd�dd�d| �d| �d d�d
d �d d
�dd
�d|�d|�d|�d|�d|�d|�d|�d|�d|�d| �d|
�d|
�d|�d |�d |�d |�d |�d |�|��}d!|d! iS )"a�
.. versionadded:: 2016.3.0
Execute the passed command in the background and return its PID
.. note::
If the init system is systemd and the backgrounded task should run even
if the salt-minion process is restarted, prepend ``systemd-run
--scope`` to the command. This will reparent the process in its own
scope separate from salt-minion, and will not be affected by restarting
the minion service.
:param str cmd: The command to run. ex: ``ls -lart /home``
:param str cwd: The directory from which to execute the command. Defaults
to the home directory of the user specified by ``runas`` (or the user
under which Salt is running if ``runas`` is not specified).
:param str group: Group to run command as. Not currently supported
on Windows.
:param str shell: Shell to execute under. Defaults to the system default
shell.
:param str output_encoding: Control the encoding used to decode the
command's output.
.. note::
This should not need to be used in most cases. By default, Salt
will try to use the encoding detected from the system locale, and
will fall back to UTF-8 if this fails. This should only need to be
used in cases where the output of the command is encoded in
something other than the system locale or UTF-8.
To see the encoding Salt has detected from the system locale, check
the `locale` line in the output of :py:func:`test.versions_report
<salt.modules.test.versions_report>`.
.. versionadded:: 2018.3.0
:param str output_loglevel: Control the loglevel at which the output from
the command is logged to the minion log.
.. note::
The command being run will still be logged at the ``debug``
loglevel regardless, unless ``quiet`` is used for this value.
:param bool ignore_retcode: If the exit code of the command is nonzero,
this is treated as an error condition, and the output from the command
will be logged to the minion log. However, there are some cases where
programs use the return code for signaling and a nonzero exit code
doesn't necessarily mean failure. Pass this argument as ``True`` to
skip logging the output if the command has a nonzero exit code.
:param str runas: Specify an alternate user to run the command. The default
behavior is to run as the user under which Salt is running. If running
on a Windows minion you must also use the ``password`` argument, and
the target user account must be in the Administrators group.
.. warning::
For versions 2018.3.3 and above on macosx while using runas,
to pass special characters to the command you need to escape
the characters on the shell.
Example:
.. code-block:: bash
cmd.run_bg 'echo '\''h=\"baz\"'\''' runas=macuser
:param str password: Windows only. Required when specifying ``runas``. This
parameter will be ignored on non-Windows platforms.
.. versionadded:: 2016.3.0
:param str shell: Specify an alternate shell. Defaults to the system's
default shell.
:param bool python_shell: If False, let python handle the positional
arguments. Set to True to use shell features, such as pipes or
redirection.
:param dict env: Environment variables to be set prior to execution.
.. note::
When passing environment variables on the CLI, they should be
passed as the string representation of a dictionary.
.. code-block:: bash
salt myminion cmd.run_bg 'some command' env='{"FOO": "bar"}'
.. note::
When using environment variables on Window's, case-sensitivity
matters, i.e. Window's uses `Path` as opposed to `PATH` for other
systems.
:param bool clean_env: Attempt to clean out all other shell environment
variables and set only those provided in the 'env' argument to this
function.
:param str prepend_path: $PATH segment to prepend (trailing ':' not
necessary) to $PATH
.. versionadded:: 2018.3.0
:param str template: If this setting is applied then the named templating
engine will be used to render the downloaded file. Currently jinja,
mako, and wempy are supported.
:param str umask: The umask (in octal) to use when running the command.
:param int timeout: A timeout in seconds for the executed process to return.
.. warning::
This function does not process commands through a shell unless the
``python_shell`` argument is set to ``True``. This means that any
shell-specific functionality such as 'echo' or the use of pipes,
redirection or &&, should either be migrated to cmd.shell or have the
python_shell=True flag set here.
The use of ``python_shell=True`` means that the shell will accept _any_
input including potentially malicious commands such as 'good_command;rm
-rf /'. Be absolutely certain that you have sanitized your input prior
to using ``python_shell=True``.
:param list success_retcodes: This parameter will allow a list of
non-zero return codes that should be considered a success. If the
return code returned from the run matches any in the provided list,
the return code will be overridden with zero.
.. versionadded:: 2019.2.0
:param list success_stdout: This parameter will allow a list of
strings that when found in standard out should be considered a success.
If stdout returned from the run matches any in the provided list,
the return code will be overridden with zero.
.. versionadded:: 3004
:param list success_stderr: This parameter will allow a list of
strings that when found in standard error should be considered a success.
If stderr returned from the run matches any in the provided list,
the return code will be overridden with zero.
.. versionadded:: 3004
:param bool stdin_raw_newlines: False
If ``True``, Salt will not automatically convert the characters ``\\n``
present in the ``stdin`` value to newlines.
.. versionadded:: 2019.2.0
CLI Example:
.. code-block:: bash
salt '*' cmd.run_bg "fstrim-all"
The template arg can be set to 'jinja' or another supported template
engine to render the command arguments before execution.
For example:
.. code-block:: bash
salt '*' cmd.run_bg template=jinja "ls -l /tmp/{{grains.id}} | awk '/foo/{print \\$2}'"
Specify an alternate shell with the shell parameter:
.. code-block:: bash
salt '*' cmd.run_bg "Get-ChildItem C:\\ " shell='powershell'
If an equal sign (``=``) appears in an argument to a Salt command it is
interpreted as a keyword argument in the format ``key=val``. That
processing can be bypassed in order to pass an equal sign through to the
remote shell command by manually specifying the kwarg:
.. code-block:: bash
salt '*' cmd.run_bg cmd='ls -lR / | sed -e s/=/:/g > /tmp/dontwait'
r$ r� r� Nr� r� r r r r� Tr� Fr
r r r r# rQ r_ r r rL r r r� r r5 r r r r r� r. )r
rQ r r r r# r_ r rL r r� r r r r r r5 r r r r r rK �resr r r �run_bg� sz T�������� �
� � �
��������������� � r� )NNNr� )NN)r� )F)NNNr� NFNTNNrz FNTFNFNNFNNN)NNNr� NFNTNNrz FNTFNFNNFFNNN)e�__doc__r� ri r� r& r r' r� r� r� r� r� r rw Zsalt.grains.extrar7 Zsalt.utils.argsZsalt.utils.dataZsalt.utils.filesZsalt.utils.jsonZsalt.utils.pathZsalt.utils.pkgZsalt.utils.platformZsalt.utils.powershellZsalt.utils.stringutilsZsalt.utils.templatesZsalt.utils.timed_subprocessZsalt.utils.urlZsalt.utils.userZsalt.utils.versionsZ
salt.utils.vtZsalt.utils.win_chcpZsalt.utils.win_daclZsalt.utils.win_regZ
salt._loggingr Zsalt.exceptionsr r r r� r� � ImportErrorr? r� r� Zsalt.utils.win_functionsr r� Zsalt.utils.win_runasr r r� Zshlex�quoteZ__proxyenabled__r
� getLogger�__name__r r: �extrar r� r r r r% r4 rS r] r` rO rk r r� r( r* r+ r r0 r2 r3 r� r4 rq rE rv r� rH rL rI rN rW r� ra r� r� r� r� r� r r r r �<module> s� �
5
7
�
�4
�9
� K
�
� m
� m
�
� ^
�;
� E
� O
9
�
" X
� '
� �