File manager - Edit - /opt/saltstack/salt/lib/python3.10/site-packages/salt/modules/__pycache__/cmdmod.cpython-310.pyc
Back
o ;j|� � @ 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.Zddl/m0Z1 ddl2m3Z4 dZ5n ddl6Z6e6j7Z1dZ5d gZ8d Z9e�:e;�Z<ej=j>�?� d Z@d d � ZAdd� ZBdd� ZCdd� ZDdd� ZEd[dd�ZFd\dd�ZGdd � ZHd d � ZId d � ZJd!d"� ZKdde jLe jLdd#ddde@dddddddddddddddddddddd$f d%d&�ZMdddde@dddddddddddddfd'd(�ZNddde@ddddddddddddddfd)d*�ZOdddde@dddddddd#ddddddddddddddddf d+d,�ZPdddde@ddddddd#dddddddddddddfd-d �Z?dddde@dddddddd#ddddddddddddfd.d/�ZQdddde@dddddddd#ddddddddddddfd0d1�ZRdddde@dddddddd#ddddddddddddddfd2d3�ZSdddde@ddddddd#ddddddddddfd4d5�ZTdddde@ddddddddddddddddfd6d7�ZUddddde@dddddd#dddddddddddfd8d9�ZVddddde@ddd:dddddd#ddddddfd;d<�ZWd=d>� ZXd?d@� ZYdAdB� ZZd]dCdD�Z[d]dEdF�Z\d^dHdI�Z]dddde@dddddddddJdddddddddddfdKdL�Z^dMdN� Z_dOdP� Z`d_dQdR�Za S # d`dTdS�Zb S # dadUdV�ZcdWdX� Zdddde@dddddddd#dddddddddfdYdZ�ZedS )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__O 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_cmdS 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>d s z_check_cb.<locals>.<lambda>)�hasattr�log�error)Zcb_r r r � _check_cbZ 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 )zX Set python_shell default based on the shell parameter and __opts__['cmd_safe'] NTZcmd_safeF)�__opts__�get� NameError)� python_shell� __pub_jidr r r �_python_shell_defaultg 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_pidsx 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� | ddddg}t jdd�}|d d d kr |�d � |�|� n |r*|�d |g� n|�d � t|t�r9d �|�}|�|� t�|� |S )z� Prep cmd when shell is powershell.exe or pwsh.exe. If we were called by script(), then run it via the -File parameter, Otherwise, run the command via the -Command parameter. �-NonInteractivez -NoProfilez-ExecutionPolicyZBypass� )�limit���� �script�-File�-EncodedCommandz-Commandre ) � traceback� extract_stackr+ �extendr r rZ r �debug)� win_shellr � encoded_cmd�new_cmd�stackr r r �_prep_powershell_cmd s$ � r| rw i� c! D sB d|!v r |s |!d }|dkrt | �du rt�d| � t|�}t|�}d}"�du r2dt� v r2t�d��|du r@dt� v r@t�d�}|sltj � d � �sKd n���}t� |tj �r\tj �|�skd }tjj�� rktj �tj�}nt|�}|rvd }d}d}#tjj�� s�| r�tj �| �r�t� | tj�s�d | � d�}$t|$��n |r�td��| r�t| t�s�t| �} tjj� � }%| |%kr�d }#t | |||||�\} }i � d|!v r�t | �s�td| � d���tjj�� �rl�r�t s�d}$t|$��| �rjtjj � | �}&|&s�td|&� ���|&�!� �t"�fdd�dD ���r t#|&| | �} n_t"�fdd�dD ���rct| t$t%f�}'t&���o:|' �o:| �p:t| t��o:d| v �p:d| v }(| �sA��rbtjj'j(|&| |(t&���oO| d �} | �sbt| t��rbd | v �rbd } n td |&� ���d}&t)| �} d d� | �*� D �D ] })t�+d |)� d | |)< �qy|du�r�d!� t| t$��s�d"nd t,| �t| t$��s�d"nd ��r�d#�� d$�nd | �r�d%| � d$�nd ||�r�d&nd �}$t�-||$�� ��r'tjj�.� �r't| t$t%f��r�d'�/t0t1| ��} d(t1|�� d)| � d*�} z �fd+d,�t2�3� D �d- j4}*t5�6d.|*��r d/j |*t1| �d0�} W n t7t8f�y Y nw d1t1��� d2t1| �� �} d���rItjj�� �sIzt2�9�� W n t:�yH td3�� d4���w | �rtjj�� �rYd5}$t;|$��t<d6g��sed7}$t|$��zt=�>| � W n t:�y| td8�� d4���w d }"��s�| �rAtjj�� �sA�z�d-dl?}+d9t|+�@� � d: },|,�AtB�}-d;� |,�}.|"�r�d6g}/��r�|/�Cd<�g� | �r�|/�Cd=| g� | �r�| tDk�r�|/�Cd>d?| d@g� nK|/�CdAd?g� nC|/�Cd?g� n<tEdB dCv �r�dDdE�d@g}/n.tEdF dGv �r�dDdE�d@g}/n tEdF dHv �r dDdE�d@g}/n| �rdDd>| dE�d@g}/ndDdE�d@g}/tjjF�G� �s@tEdB dCv �r8|/�C| � d2tHjI� �g� nN|/�CtHjIg� nFtJjKdIddJ��6}0tEdB dCv �r]|/�CdK� | tHjI|0jL�g� n |/�CtHjI� dL|0jL� �g� |0�M|.� tN�O|0jL�� W d � n 1 �s�w Y dM|/� �}$t�P||$�� tQjR|/tQjStQjStQjSdN��TtjjU�V|.��\}1}2tjjF�G� �r�t�W|0jL� |1�X|-�}3|3d-k�r�t�+dO�|2|1� dP}1n|3dQk�r�tdRtY|2�tY|1�dS�dT��|1�Z|-�dU }1t[t$t\t]|1�ZdV��gdQ � ��}4dWdX� |4�*� D �}4|4�^| � |4�dY��k�r �|4dY< tj � dZ�� ��}5|4�d[�|5k�r"|5|4d[< |4} W n t_�y@ }6 zt�`d\�� td]� �|6���d}6~6ww |d u �r�tjj�� �s�| �ad^d_� | �ad`d_� | �adad_� | �adbd_� | �adcd_� | �addd_� | �aded_� | �adfd_� | �adgd_� | �adhd_� | �adid_� | �adjd_� | �adkd_� | �r�| }7ntjj�� �r�d-dlb}8|8jc�d� }7ntjc�d� }7|7�^| � |�r�dl�/||7dm f�|7dm< dn| v�r�|7�ednd� | du �r�d} || |7|du�r�t|�n||||||do� }9dp|!v �r�|!dp |9dp< |du�r+t|��fdq�}:|:d k�rdr}$t|$��zt|:ds�}:W n t_�y* tdt|� d"���w d}:��s6| �s6|�rCtg�htjjijj�|:| �|9du< tjj�� �sk|9dv d u �rU| |9dw< tjj�k� �rgtHjldxk �rgd|9dy< nd |9dy< tj �m|��rytj �|��s�tdz|� d{���| d u�r�| du�r�tjj�� �s�t| t$��s�tjjn�o| �} | du �r�d-g} nzd|d,� tjjn�p| �D �} W n t_�y� t;d}��w | du �r�g } ntjjn�p| �} | du �r�g } ntjjn�p| �} |�s���r tjj�� �r |#�r�tjj�q| � tr| �||�� |#�r tjj�q|%� �nQz�|#�rtjj�q| � z tjjsjt| fi |9��};W n( tu�yK }6 zd~dX� |9�*� D �}<d� |du�r>| nd�|<|6�}$t|$��d}6~6ww z|;�v� W n9 tw�y� }6 z,t|6�� d�< d � d�< d� d�< |;jxjy� d�< dU� d�< � W Y d}6~6W |#�r�tjj�q|%� S S d}6~6ww W |#�r�tjj�q|%� n |#�r�tjj�q|%� w w |dk�r�|du�r�t�Pd�| |� z tjjUjz|;j{|d��}=W n- t|�y� d }=Y n" t}�y� tjjUjz|;j{|d�d��}=|dk�r�t�+d�t,| �� Y nw z tjjUjz|;j~|d��}>W n- t|�y d }>Y n" t}�y( tjjUjz|;j~|d�d��}>|dk�r&t�+d�t,| �� Y nw | �r3d�|>v �r3d }>|�rH|=du�r?|=�� }=|>du�rH|>�� }>|;jxjy� d�< |;jxj�� d�< |=� d�< |>� d�< � d� | v �rgd-� d�< t"� fd�d,�| D �� fd�d,�| D � ��r�d-� d�< �n)d }?|�r�d�|� d��}?|du�r�d�| � d�|?� �}$t�P||$�� d�\}}t���� }@|�r�|@| }And�}Az�tjj�j�| d d d ||9�dud�|7|||d d d�� };|;jy� d�< d }d }|;j��r�z^zEt���d�� z|;��� \}B}CW n tu�y� d�\}B}CY nw |B�r�||B7 }|C�r||C7 }|�r t���� |Ak�r d�� ||�� d�< d� d�< W W n}W n t��y4 d�|� �� d�< dU� d�< Y W nfw W n$ tjj�j��yZ }6 ztj+d�|6t�j�d�� dUd�d��� W Y d}6~6nDd}6~6ww |� d�< |;��� �s�|� d�< |;j�� d�< � d� | v �rxd-� d�< t"� fd�d,�| D �� fd�d,�| D � ��r�d-� d�< |;jy� d�< |;j��s�W |;j�d d d�� n|;j�d d d�� w z|�r�d-td�< n� d� td�< W n t��y� Y nw |du� r |�s� d� d-k�r�|t�d� k �r�t�d� }d�� t,| �� d� �}$t�+||$�� � d� � rt�|d�|� d� �� � d� � rt�|d�|� d� �� � d� � r t�|d�� d� � � 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 windowsr$ zThe shell command "z" is not permittedz missing salt/utils/win_runas.pyzshell binary not found: c 3 � � | ]}� � |�V qd S r ��endswith�rg �word��win_shell_lowerr r � <genexpr>� s � � �z_run.<locals>.<genexpr>)�powershell.exezpwsh.exec 3 r� r r� r� r� r r r� � � � )�cmd.exe�&�|)Zquote_c_payloadZmsvc_quote_bare_path_stringrs zunsupported shell type: c s s � | ] \}}|d u r|V qd S r r )rg r �yr r r r� � s � 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.re 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 integersc S s i | ] \}}|d vr||�qS ))r_ r� r r� r r r r� 2 s z<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 � � c r� �r� r �rg Zstder� r r rh � 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_OK�isdirr7 r? �platform� is_windows�abspath�sepr �isfile�X_OKr r r, Zwin_chcpZget_codepage_idrS rk � HAS_WIN_RUNAS�whichrW �anyr| r r �bool�winZ prepend_cmdr` �itemsr r rT Z is_darwinrZ �map� _cmd_quote�pwd�getpwall�pw_shell�re�searchrX � IndexError�getpwnamrY r � which_bin�grp�getgrnam�uuidZuuid4�encodeZ__salt_system_encoding__rv � DEFAULT_SHELLrP ZpkgZ check_bundled�sysr� �tempfileZNamedTemporaryFile�namerC �shutil�chownrw � 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�args� 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 )Dr 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� ry �success_retcodes�success_stdout�success_stderrZwindows_codepagerK Zuse_sudoZchange_windows_codepage�msgZprevious_windows_codepagerx Zwin_cmd_is_argvZwin_cmd_needs_cswitchZ bad_env_keyZ user_shellr� �markerZmarker_bZpy_codeZenv_cmd�fpZ env_bytesZenv_encoded_errZ marker_countZ env_runasZ runas_home�excZrun_envr Z new_kwargsZ_umask�procZ safe_kwargs�out�errZformatted_timeout�nowZ will_timeoutZcstdoutZcstderrr )rd r r� r �_run$ s '� � � � � � � �� �� �� ���� � � � ��� � �� � � � ���� � �� � �� �� � ���� ���� ���� �� ��� �� ��� ��� � ����� �� �� �� + �� � r3 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� )r3 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^ �������� � � � � �����������r5 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% )r3 )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 �������� � � � � ���������r6 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 )%am& 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 MacOS 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. The password for the account specified by ``runas``. Required only when the salt-minion is **not** running as SYSTEM or as an elevated Administrator. When Salt has sufficient privileges it can obtain a logon token for the target user through Windows impersonation APIs without needing their credentials. This parameter is 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' ry r( r) r* Nr� r r r� r� z output: %s)r% r! r� r4 r� r3 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' ry Z raise_errr" r( r) r* rK r� rd Zlvlr+ r r r r Y s� �������� � � � � ��������������� � ���r c K s� |� dd�}|du r 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|�d|�d|�d |�|��S ) a� 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. .. warning:: For versions 2018.3.3 and above on MacOS 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. The password for the account specified by ``runas``. Required only when the salt-minion is **not** running as SYSTEM or as an elevated Administrator. When Salt has sufficient privileges it can obtain a logon token for the target user through Windows impersonation APIs without needing their credentials. This parameter is 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# TNrQ r� r r r r_ r! r" rL r r# r r r r7 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 r7 r� r$ r% r5 r& r� r' r" r( r) r* rK r# r r r r � sx d�������� � � � � ���������������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. .. warning:: For versions 2018.3.3 and above on MacOS 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. The password for the account specified by ``runas``. Required only when the salt-minion is **not** running as SYSTEM or as an elevated Administrator. When Salt has sufficient privileges it can obtain a logon token for the target user through Windows impersonation APIs without needing their credentials. This parameter is 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! r3 � r rQ r� r r r r# r_ r! rL r r# r r r r7 r� r$ r% r5 r& r' r" r( r) r* rK rd r r r � run_stdout� �n L�������� � � � � ������������� r; 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. .. warning:: For versions 2018.3.3 and above on MacOS 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. The password for the account specified by ``runas``. Required only when the salt-minion is **not** running as SYSTEM or as an elevated Administrator. When Salt has sufficient privileges it can obtain a logon token for the target user through Windows impersonation APIs without needing their credentials. This parameter is 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� r9 r: r r r � run_stderr� r< r= 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 ) aH" 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. .. warning:: For versions 2018.3.3 and above on MacOS 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. The password for the account specified by ``runas``. Required only when the salt-minion is **not** running as SYSTEM or as an elevated Administrator. When Salt has sufficient privileges it can obtain a logon token for the target user through Windows impersonation APIs without needing their credentials. This parameter is 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. The password for the account specified by ``runas``. Required only when the salt-minion is **not** running as SYSTEM or as an elevated Administrator. When Salt has sufficient privileges it can obtain a logon token for the target user through Windows impersonation APIs without needing their credentials. This parameter is 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' ry r( r) r* r� )r% r! r� r4 r� r3 ) r rQ r� r r r r# r_ r! rL r r# r r r r7 r� r$ r% r5 r& r8 r' ry r" r( r) r* rK r� rd r r r �run_all� s| {�������� � � � � ��������������� r> 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 )a� 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. .. warning:: For versions 2018.3.3 and above on MacOS 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. The password for the account specified by ``runas``. Required only when the salt-minion is **not** running as SYSTEM or as an elevated Administrator. When Salt has sufficient privileges it can obtain a logon token for the target user through Windows impersonation APIs without needing their credentials. This parameter is 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! r3 r� r4 )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` �������� � � � � �����������r? c $ K sv |du rzt �dd�}W n ty d}Y nw t||�dd��}dd� }d|v r.|�d� d }tjj�� r\|r\t d |�sDt � d |� |du r\t j t d d �}d}tjjj||dd� tj�tjj�| �d �\}} tjj�� r~|s~dddd�} | �| �}tjjj|| d�} | r�d|v s�d|v r�|�dt �d��} t| |�d��|d< t d | | | |fi |��} | s�|| � |r�||� dddddd�S n@t d | |�} | s�|| � |r�||� dddddd�S zt�| | � W n t�y || � |r�||� dddddd� Y S w tjj�� �s t�| d � t� | t d |�d � |�r#d }t |t ��r0tjj � |�}|�r8| g|�n| g}!i }"zFt!|!fi d |�d |�d!| �d"| �d#| �d$|�d%|�d&|�d'|�d(|�d)| �d*|�d+|�d|�d,|�d-|�d.|�d/|�d0|�d1|�|��}"W n t"t#f�y� }# zt j$d2|!|#t%j&d3� W Y d}#~#nd}#~#ww || � |�r�||� |�r�d |"d4< |"d5< |"S )6ad 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. .. note:: For Windows 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. The password for the account specified by ``runas``. Required only when the salt-minion is **not** running as SYSTEM or as an elevated Administrator. When Salt has sufficient privileges it can obtain a logon token for the target user through Windows impersonation APIs without needing their credentials. This parameter is 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_tempfile� � ���z!script.<locals>._cleanup_tempfile�__env__Fz user.infoz�cmd.script: user.info did not return information for runas user '%s'; continuing and letting the underlying runas implementation validate the account.Zcachedir)�dirTZ full_control)Zobj_nameZ principalZ permissionsr r � powershell)z.batz.cmd�.ps1)rG �suffixr8 r9 zcp.get_templater� )r� r� r� r� Z cache_errorz cp.cache_filei@ �file.user_to_uidr� rQ r� r r r r r r r# r_ r# r� r$ r& r� r' r( r) r* z)cmd.script: Unable to run script '%s': %sr� r� r� )'r r! r" r% r r7 r? r� r� rN r r� r� ZmkdtempZwin_daclZset_permissionsr' r( �splitext�urlZ split_envr@ rA rO r� �copyfile�FileNotFoundError�chmodr� r r r r r3 r r r r r )$�sourcer rQ r� r r r r# r_ rL r# r r r r7 r� r$ r5 r& r� r' r( r) r* rK rD Zwin_cwd�_�extZ extension_mapr( r8 Zfn_rz rd r. r r r rq � s S � �� � �� � �� �������� � � � � �������� ����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 )aI 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. :param str password: Windows only. The password for the account specified by ``runas``. Required only when the salt-minion is **not** running as SYSTEM or as an elevated Administrator. When Salt has sufficient privileges it can obtain a logon token for the target user through Windows impersonation APIs without needing their credentials. This parameter is 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' rF rQ 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 )rQ 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 2 �������� � � � � �����������rT 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( r� r r r r r� � � r� c C rU )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� rV 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)r� r r r r �has_exec s rW 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 r[ 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"}' rH rI )rJ zw+tF)�binaryNrr c S r@ )NrA z4cmd.exec_code_all: Unable to clean tempfile '%s': %sr� rB rC r r r rD U rE z(exec_code_all.<locals>._cleanup_tempfiler rK r� )rQ r# )rW r* r7 r? r@ rA rB rC rD r< r r r+ r r! r� r� r' r� rN r> ) rY rZ rQ r rK rH ZcodefilerI r rD r rd r r r rX 1 s, � rX 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 r] j s � �r] 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. :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 D 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 r> r! �ranger4 r� r r )&r2 r rQ r� r r r r# Zbindsr_ r! rL r r# r r r r7 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� 2 �������� � � � � ����� � ������ � �rf 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 rg rh c S ri r rj rf r r r rh � rk zshells.<locals>.<listcomp>Nrl zFile '%s' was not found)r' r( rm r7 r? r@ rB rn ro r r* r+ r/ r r )Z shells_fnrd rq rr rs r r r rp � s. � � � ��rp 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.]+)rt ru )z (HOME=.*)rt r� Zdeclare)z ^zsh (\d\S*)�zshru )z ^tcsh (\d\S*)�tcshru )zVersion ([\d.]+)r� z/C�ver)zPSVersion\s+(\d\S*)rH 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*)�phpr| ) rt zbash-test-errorz bash-test-envrv rw r rH ry rz r{ r} � installedFrH �HKEY_LOCAL_MACHINEz Software\Microsoft\PowerShell)�hive�key)r� zBUnable to locate 'powershell' Reason: Cannot be found in registry.)r r~ z Software\Microsoft\PowerShell\ZInstall)r� r� �vnameZvtypeZ REG_DWORDZvdatar� z1Software\Microsoft\PowerShell\{}\PowerShellEngineNr� r( r� 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.]*)T�.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 r� rW r� r r r r r' r( r� r rw r r r� r� r4 r/ rZ r r r� r� r� � IGNORECASEr �match�lenr+ rH 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_info� s� ,� � ���� ����-�� � ���� ���� � � r� rH 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} 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 )+ay 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. :param str password: Windows only. The password for the account specified by ``runas``. Required only when the salt-minion is **not** running as SYSTEM or as an elevated Administrator. When Salt has sufficient privileges it can obtain a logon token for the target user through Windows impersonation APIs without needing their credentials. This parameter is 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" �rH Zpwsh�FMust specify a valid powershell binary. Must be 'powershell' or 'pwsh'r# Fre rH r� �2.0r� z | ConvertTo-JSON Nz-Depth ztry { z } catch { Write-Error $_ }� Encoding PowerShell command '%s'�($ProgressPreference='SilentlyContinue'; � utf-16-leTrQ r� r r r_ r! rL r r# r r r7 r� r$ r% r5 r& r' ry r( r) r* z'Error converting PowerShell JSON return)�exc_info)r r r r rZ r� r7 r? �versions� version_cmpr rw r� �base64�standard_b64encoderD r< r; �_prep_powershell_json�json�loads� Exceptionr ) r rQ r� r r r_ r! rL r r# r r r7 r� r$ r% r5 r& r' �depth� encode_cmdr( r) r* rK r# r� � cmd_utf16ry �responser r r rH � s� W� �������� � � � � ������������ �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. :param str password: Windows only. The password for the account specified by ``runas``. Required only when the salt-minion is **not** running as SYSTEM or as an elevated Administrator. When Salt has sufficient privileges it can obtain a logon token for the target user through Windows impersonation APIs without needing their credentials. This parameter is 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# Fre rH r� r� r� z | ConvertTo-JSONNz -Depth r� r� r� TrQ r� r r r_ r! rL r r# r r rU r� r$ r% r5 r& r' ry 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 rw r� r� r� rD r< r> 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# r� r� ry r� Z stdoutputr= �err_msgr r r �powershell_all� 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 r� r )r* rf ��textr r r� R r� z(_prep_powershell_json.<locals>.<genexpr>r� )r� )r� Z starts_withr r� r r� G 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 )"aJ .. 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. .. warning:: For versions 2018.3.3 and above on MacOS 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. The password for the account specified by ``runas``. Required only when the salt-minion is **not** running as SYSTEM or as an elevated Administrator. When Salt has sufficient privileges it can obtain a logon token for the target user through Windows impersonation APIs without needing their credentials. This parameter is 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� r9 )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_bgW sz U�������� � � � � ��������������� � r� )NNNr� )NN)r~ )F)NNNrH NFNTNNrw FNTFNFNNFNNN)NNNrH NFNTNNrw FNTFNFNNFFNNN)f�__doc__r� ri r r& r r' r� r� r� r� r� r rt 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.platform.winZsalt.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� r3 r5 r6 r r; r= r> r� r? rq rT r� r� rW r[ rX r] rf r� rp r� rH r� r� r� r r r r �<module> s� � 5 " � S �4 �9 � O � � o � o � $ � _ �; � u � Q 9 � " X � ( � �
| ver. 1.4 |
Github
|
.
| PHP 8.2.30 | Generation time: 0 |
proxy
|
phpinfo
|
Settings