File manager - Edit - /opt/saltstack/salt/lib/python3.10/site-packages/salt/modules/__pycache__/state.cpython-310.pyc
Back
o ;j!b � @ sF d Z ddlZddlZddlZddlZddlZddlZddlZddlm Z ddl Z ddl Z ddl Z ddlZ ddlZ ddlZ ddlZ ddlZ ddlZ ddlZ ddlZ ddlZ ddlZ ddlZ ddlZ ddlZ ddlZ ddl Z ddl Z ddl Z ddl m Z m!Z! ddl"m#Z# ddl$m%a& dgZ'dddddddddddddd � Z(d d iZ)e�*e+�Z,d Z-d d� Z.dd� Z/dxdd�Z0dxdd�Z1dydd�Z2dd� Z3dd� Z4dxdd �Z5dxd d �Z6dxd d �Z7dzd!d"�Z8dxd#d$�Z9 d{d&d'�Z%d|d)d*�Z:d+d,� Z;d-d.� Z<d/d0� Z=d1d2� Z>d3d4� Z?d5d6� Z@dxd7d8�ZAdxd9d:�ZBdzd;d<�ZCdxd=d>�ZDdxd?d@�ZEdxdAd �ZFdBdC� ZGdxdDdE�ZHdxdFdG�ZIdxdHdI�ZJd}dKdL�ZKd~dMd�ZL ddNdO�ZMdzdPdQ�ZNdxdRdS�ZOdxdTdU�ZPdxdVdW�ZQdxdXdY�ZRd~dZd[�ZSdzd\d]�ZTdzd^d_�ZUdzd`da�ZVdzdbdc�ZWdxddde�ZXdzdfdg�ZYdhdi� ZZdxdjdk�Z[dldm� Z\dndo� Z]dpdq� Z^drds� Z_ ud�dvdw�Z`dS )�aB Control the state system on the minion. State Caching ------------- When a highstate is called, the minion automatically caches a copy of the last high data. If you then run a highstate with cache=True it will use that cached highdata and won't hit the fileserver except for ``salt://`` links in the states themselves. � N)� OrderedDict)�CommandExecutionError�SaltInvocationError)�_format_cached_grains)� orchestrate�*� highstate) �sls�sls_id�pkg�top�singler �template� template_str�apply_�test�request� check_request� run_requestr Zapply�statec C s t jj�tt� �atS )z Set the virtualname )�salt�utils� functoolsZnamespaced_function� _orchestrate�globals�__virtualname__� r r �F/opt/saltstack/salt/lib/python3.10/site-packages/salt/modules/state.py� __virtual__G s r c C s dd� | � � D �}|S )z7 Filter out the result: True + no changes data c S s& i | ]\}}|d r|d r||�qS )�result�changesr )�.0�tag�valuer r r � <dictcomp>V s ���z#_filter_running.<locals>.<dictcomp>)�items)Zrunnings�retr r r �_filter_runningR s �r' c C sP t jjjtd< t| t�rt jjjtd< dS td | |d�s&t jjj td< dS dS )zJ Set the return code based on the data back from the state system �retcodeN�state.check_result�r ) r �defaults� exitcodes�EX_OK� __context__� isinstance�list�EX_STATE_COMPILER_ERROR� __utils__�EX_STATE_FAILURE)r& r r r r � _set_retcode^ s �r4 c C s | � d�rdS |p t� d�S )ae Check pillar for errors. If a pillar is passed, it will be checked. Otherwise, the in-memory pillar will checked instead. Passing kwargs['force'] = True short cuts the check and always returns None, indicating no errors. :param kwargs: dictionary of options :param pillar: pillar :return: None or a list of error messages �forceN�_errors)�get� __pillar__)�kwargs�pillarr r r �_get_pillar_errorsm s r; c C s� | du r t jj�t�} t jj�t�� t| �}W d � n1 s!w Y |r.t|�|k rT|rRt � d� t jj�t�� t| �}W d � n1 sKw Y |s0dS dS )zF Wait for all previously started state jobs to finish running N� TF) r r �jid�gen_jid�__opts__r �acquire_queue_lock�_prior_running_states�len�time�sleep)r= � max_queue�statesr r r �_wait| s � ��rG c C sl d}z#| d s t �d�r#td t �dd�dd|� �|d �}W |S W |S W |S ty5 t�d |� Y |S w ) z' Create a snapper pre snapshot Nr �snapper_states�snapper.create_snapshot�snapper_states_config�rootZpre�Salt State run for jid )�config� snapshot_type� description� __pub_jid�1Failed to create snapper pre snapshot for jid: %s�r? r7 �__salt__� Exception�log�error)�optsr= � snapper_prer r r � _snapper_pre� s$ �� � ��rY c C st z)| d s!t �d�r$|r'td t �dd�d|d|� �|d� W d S W d S W d S W d S ty9 t�d |� Y d S w ) z) Create the post states snapshot r rH rI rJ rK ZpostrL )rM rN Z pre_numberrO rP rQ NrR )rW r= Zpre_numr r r � _snapper_post� s �� �rZ c C s� t j�td d�}t j�|| �}t j�|�s'zt �|� W n ty& Y nw i }|dur5||vr5i ||< t j�|�r_tjj � |d��}tjj � |� � �}W d � ||fS 1 sZw Y ||fS )z6 Return the pause information for a given jid �cachedir� state_pauseN�rb)�os�path�joinr? �exists�makedirs�OSErrorr r �files�fopen�msgpack�loads�read)r= �state_id� pause_dir� pause_path�data�fp_r r r � _get_pause� s& � ��rn c C s� i }t d d�}tj�td d�}tj�|�s|S | du r#t�|�}nt| t�r0t j j � | �}nt | �g}|D ]6}d}|D ] }|d |krGd}q=|scztj�||�}t�|� W n tya Y nw q7t|�\} }| ||< q7|S ) z� Get a report on all of the currently paused state runs and pause run settings. Optionally send in a jid if you only desire to see a single pause data set. �saltutil.is_running�state.*r[ r\ NFr= T)rS r^ r_ r` r? ra �listdirr/ r0 r r rl Z stringify�str�removerc rn ) r= r& �activerj ZjidsZscan_jidZ is_activeZ active_datark rl r r r � get_pauses� s6 � � ru c C sx t | �} |du r d}t| |�\}}d|| d< tjj�|d��}|�tjj�|�� W d � dS 1 s5w Y dS )a� Set up a state run to die before executing the given state id, this instructs a running state to safely exit at a given state id. This needs to pass in the jid of the running state. If a state_id is not passed then the jid referenced will be safely exited at the beginning of the next state run. The given state id is the id got a given state execution, so given a state that looks like this: .. code-block:: yaml vim: pkg.installed: [] The state_id to pass to `soft_kill` is `vim` CLI Examples: .. code-block:: bash salt '*' state.soft_kill 20171130110407769519 salt '*' state.soft_kill 20171130110407769519 vim N�__all__T�kill�wb) rr rn r r rd re �writerf �dumps�r= ri rl rk rm r r r � soft_kill� s "�r| c C s� t | �} |du r d}t| |�\}}|rt|�|| d< tjj�|d��}|�tjj� |�� W d � dS 1 s9w Y dS )a� Set up a state id pause, this instructs a running state to pause at a given state id. This needs to pass in the jid of the running state and can optionally pass in a duration in seconds. If a state_id is not passed then the jid referenced will be paused at the beginning of the next state run. The given state id is the id got a given state execution, so given a state that looks like this: .. code-block:: yaml vim: pkg.installed: [] The state_id to pass to `pause` is `vim` CLI Examples: .. code-block:: bash salt '*' state.pause 20171130110407769519 salt '*' state.pause 20171130110407769519 vim salt '*' state.pause 20171130110407769519 vim 20 Nrv �durationrx ) rr rn �intr r rd re ry rf rz )r= ri r} rl rk rm r r r �pause s "�r c C s� t | �} |du r d}t| |�\}}||v r|�|� |dkr i }tjj�|d��}|�tjj� |�� W d � dS 1 s>w Y dS )a Remove a pause from a jid, allowing it to continue. If the state_id is not specified then the a general pause will be resumed. The given state_id is the id got a given state execution, so given a state that looks like this: .. code-block:: yaml vim: pkg.installed: [] The state_id to pass to `rm_pause` is `vim` CLI Examples: .. code-block:: bash salt '*' state.resume 20171130110407769519 salt '*' state.resume 20171130110407769519 vim Nrv rx ) rr rn �popr r rd re ry rf rz r{ r r r �resume3 s "�r� �basec C s t | |||||d�S )a .. versionadded:: 2016.11.0 Execute the orchestrate runner from a masterless minion. .. seealso:: More Orchestrate documentation * :ref:`Full Orchestrate Tutorial <orchestrate-runner>` * Docs for the salt state module :py:mod:`salt.states.saltmod` CLI Examples: .. code-block:: bash salt-call --local state.orchestrate webserver salt-call --local state.orchestrate webserver saltenv=dev test=True salt-call --local state.orchestrate webserver saltenv=dev pillarenv=aws ��mods�saltenvr �excluder: � pillarenv)r r� r r r r U s �r Fc C s� g }| r|S t d d�}t�d�}|D ];}|dur4zt|�d��t|�kr'W qW n ttfy3 Y nw d�|d |d tjj � |d �|d �}|� |� q|S )a Return a list of strings that contain state return data if a state function is already running. This function is used to prevent multiple state calls from being run at the same time. CLI Example: .. code-block:: bash salt '*' state.running ro rp r= NzHThe function "{}" is running as PID {} and was started at {} with jid {}�fun�pid) rS r? r7 r~ � ValueError� TypeError�formatr r r= Z jid_to_time�append)� concurrentr& rt Z current_jidrl �errr r r �runningt s0 ���� r� c C s t jj�t�S )z& Acquire the state queue lock )r r r r@ r? r r r r �_acquire_queue_lock� s r� c C s� | du rdS t jj�t�}tj�|t| ��}tj� |�s-zt� |� W n t y, Y nw t � �2 t jj �|d��}|�tt�� �� W d � n1 sMw Y W d � dS W d � dS 1 sew Y dS )zI Set a flag to indicate that the state run is checking the queue Nzw+)r r r �state_queue_dirr? r^ r_ r` rr ra rb rc r� rd re ry �getpid)r= � queue_dir� queue_pathrm r r r �_set_queue_flag� s" � ��"�r� c C s� | du rdS t jj�t�}tj�|t| ��}t � �0 tj� |�r1zt� |� W n t y0 Y nw W d � dS W d � dS W d � dS 1 sLw Y dS )z Clear the queue flag N) r r r r� r? r^ r_ r` rr r� ra rs rc )r= r� r� r r r �_clear_queue_flag� s" ����"�r� c C s t d d�}tjj�t| |�S )z� Return a list of dicts of prior calls to state functions. This function is used to queue state calls so only one is run at a time. ro rp )rS r r r Zcheck_prior_running_statesr? )r= rt r r r rA � s rA c C s� | du r t d dd�} | du �r|�d�}|du r t�d�}tjj�t��� t|�}|r�tjj�t�}t j � |�sJzt � |� W n t yI Y nw |}|du rWtjj�t�}dd � |�� D �}d |v rg|d = |�d �|�d g �|�d �||�dd�|�dd�|d�}dtt�� d �� d|� d�}t j �||�} z;| d } tjj�| d��} tj�|| � W d � n1 s�w Y tjj�| | � dddi dd�W W d � S t y� t�d| � dd i d � Y W d � S w W d � dS 1 s�w Y dS d} t | t ��s-t | t��r-|�d�}t |� z t || d �} W t |� nt |� w | �sEt!|�d d�d �} | �rEtj"j#j$t%d!< | S dS )"zy Utility function to queue the state run if requested and to check for conflicts in currently running states N� config.optionZ state_queueFTrP r= c S s i | ] \}}|� d �s||�qS )Z__pub_)� startswith)r! �k�vr r r r$ s z _check_queue.<locals>.<dictcomp>�queueZ __pub_funZ __pub_argZ __pub_tgtZ __pub_ret� Z __pub_userrK )r� �argZtgtr= r& �user�kwargZqueued_i@B �_z.pz.tmp�w+bzJob queued for execution)r �commentZqueuedr Z __no_return__z Failed to write queue file %sz/Failed to queue job: unable to write queue file)r r� r )rE r� )r� r( )&rS r7 r? r r r r@ rA r� r^ r_ ra rb rc r= r> r% r~ rC r` rd re �payload�dumpZ atomicfileZ atomic_renamerU rV r/ �boolr� rG r� r� r+ r, r1 r. )r� r9 r= rF r� Z queued_jidr� r� �fnr_ Ztmp_pathrm Z queue_ret�conflictr r r � _check_queue� s� � � ��� > ��> �Z�Z� r� c C s, t �dd �dkr| d t d krt�� S d S )NZ__cliz salt-callr� )r? r7 r8 r# )rW r r r �_get_initial_pillar@ s ���r� c K s� t ||�}|dur |S z tjjttd�}W n ty$ tj�t�}Y nw |�| �}|r5tjj j t d< |S |� | �}t |t�rFtjj j t d< td |�rStjj jt d< |S )a Execute a single low data call This function is mostly intended for testing the state system and is not likely to be needed in everyday usage. CLI Example: .. code-block:: bash salt '*' state.low '{"state": "pkg", "fun": "installed", "name": "vi"}' N)�proxyr( r) )r� r r �Stater? � __proxy__� NameError� verify_datar+ r, r1 r. �callr/ r0 r2 r3 )rl r� r9 r� �st_r� r& r r r �lowI s$ � r� c K sh d}| du r,t jjjdd| i|��rd}|S td ddd�du r$d}|S t�dd�}|S | du r2d}|S )z8 Determine the correct value for the test flag. TNr z config.get)Z omit_optsFr )r r �argsZ test_moderS r? r7 )r r9 r& r r r �_get_test_valuei s � ��r� c K s� t ||�}|dur |S tjjjtfi |��}t|fi |��|d< |�d�}|�d�}|du r;|dur;t|t �s;t d��ztjj |||t t �t t �t|�d�}W n tyd tjj |||t|�d�}Y nw |�| �} t| | d� | S ) a, Execute the compound calls stored in a single set of high data This function is mostly intended for testing the state system and is not likely to be needed in everyday usage. CLI Example: .. code-block:: bash salt '*' state.high '{"vim": {"pkg": ["installed"]}}' Nr r: � pillar_enc�NPillar data must be formatted as a dictionary, unless pillar_enc is specified.)r� r� �context�initial_pillar�r� r� r* )r� r r r � get_sls_optsr? r� r7 r/ �dictr r� r� r. r� r� � call_highr4 ) rl r r� r9 r� rW �pillar_overrider� r� r& r r r �highz sD �� � �� r� c K s\ d|v r |� d� t||�}|dur|S tjjjtfi |��}ztjj|tt �tt �t |�d�}W n t yG tjj|tt �t |�d�}Y nw |�Z t ||jd d�}|rctjjjt d< td|d ��| �d �sm| � d �} |j| |�d d �d dd d�\}}|r�tjjjt d< |W d � S |j�|�}t||d� |W d � S 1 s�w Y dS )aL Execute the information stored in a template file on the minion. This function does not ask a master for a SLS file to render but instead directly processes the file at the provided path on the minion. CLI Example: .. code-block:: bash salt '*' state.template '<Path to template on the minion>' �envN)r� r� r� )r� r� r: �r: r( �Pillar failed to render��infoz.slsr� r� T)�localr* )r� r� r r r r� r? � HighStater� r. r� r� r� r; rW r+ r, �EX_PILLAR_FAILUREr �endswithZ render_stater7 r1 r� r4 ) �temr� r9 r� rW r� �errorsZ high_stater& r r r r � sH � �� �� $�r c K s� t ||�}|dur |S tjjjtfi |��}z tjj|tt|�d�}W n t y6 tjj|t|�d�}Y nw |� | �}t |� |S )z� Execute the information stored in a string from an sls template CLI Example: .. code-block:: bash salt '*' state.template_str '<Template String>' N�r� r� �r� ) r� r r r r� r? r� r� r� r� Zcall_template_strr4 )r� r� r9 r� rW r� r& r r r r � s � � r c K s" | r t | fi |��S tdi |��S )a .. versionadded:: 2015.5.0 This function will call :mod:`state.highstate <salt.modules.state.highstate>` or :mod:`state.sls <salt.modules.state.sls>` based on the arguments passed to this function. It exists as a more intuitive way of applying states. .. rubric:: APPLYING ALL STATES CONFIGURED IN TOP.SLS (A.K.A. :ref:`HIGHSTATE <running-highstate>`) To apply all configured states, simply run ``state.apply`` with no SLS targets, like so: .. code-block:: bash salt '*' state.apply The following additional arguments are also accepted when applying all states configured in top.sls: test Run states in test-only (dry-run) mode mock The mock option allows for the state run to execute without actually calling any states. This then returns a mocked return which will show the requisite ordering as well as fully validate the state run. .. versionadded:: 2015.8.4 pillar Custom Pillar values, passed as a dictionary of key-value pairs .. code-block:: bash salt '*' state.apply stuff pillar='{"foo": "bar"}' .. note:: Values passed this way will override Pillar values set via ``pillar_roots`` or an external Pillar source. exclude Exclude specific states from execution. Accepts a list of sls names, a comma-separated string of sls names, or a list of dictionaries containing ``sls`` or ``id`` keys. Glob-patterns may be used to match multiple states. .. code-block:: bash salt '*' state.apply exclude=bar,baz salt '*' state.apply exclude=foo* salt '*' state.apply exclude="[{'id': 'id_to_exclude'}, {'sls': 'sls_to_exclude'}]" queue : False Instead of failing immediately when another state run is in progress, a value of ``True`` will queue the new state run to begin running once the other has finished. The queue is implemented as a disk-based FIFO queue, minimizing memory usage regardless of queue depth. Jobs in the state queue are processed by a background thread and will bypass ``process_count_max`` limits when they are ready to execute, ensuring they are not starved by other workloads. .. versionchanged:: 3006.0 This parameter can also be set via the ``state_queue`` configuration option. Additionally, it can now be set to an integer representing the maximum queue size which can be attained before the state runs will fail to be queued. This can prevent runaway conditions where new threads are started until system performance is hampered. localconfig Optionally, instead of using the minion config, load minion opts from the file specified by this argument, and then merge them with the options from the minion config. This functionality allows for specific states to be run with their own custom minion configuration, including different pillars, file_roots, etc. .. code-block:: bash salt '*' state.apply localconfig=/path/to/minion.yml state_events The state_events option sends progress events as each function in a state run completes execution. .. versionadded:: 3006.0 .. rubric:: APPLYING INDIVIDUAL SLS FILES (A.K.A. :py:func:`STATE.SLS <salt.modules.state.sls>`) To apply individual SLS files, pass them as a comma-separated list: .. code-block:: bash # Run the states configured in salt://stuff.sls (or salt://stuff/init.sls) salt '*' state.apply stuff # Run the states configured in salt://stuff.sls (or salt://stuff/init.sls) # and salt://pkgs.sls (or salt://pkgs/init.sls). salt '*' state.apply stuff,pkgs # Run the states configured in a more deeply nested directory such as salt://my/organized/stuff.sls (or salt://my/organized/stuff/init.sls) salt '*' state.apply my.organized.stuff The following additional arguments are also accepted when applying individual SLS files: test Run states in test-only (dry-run) mode mock The mock option allows for the state run to execute without actually calling any states. This then returns a mocked return which will show the requisite ordering as well as fully validate the state run. .. versionadded:: 2015.8.4 pillar Custom Pillar values, passed as a dictionary of key-value pairs .. code-block:: bash salt '*' state.apply stuff pillar='{"foo": "bar"}' .. note:: Values passed this way will override Pillar values set via ``pillar_roots`` or an external Pillar source. queue : False Instead of failing immediately when another state run is in progress, a value of ``True`` will queue the new state run to begin running once the other has finished. The queue is implemented as a disk-based FIFO queue, minimizing memory usage regardless of queue depth. Jobs in the state queue are processed by a background thread and will bypass ``process_count_max`` limits when they are ready to execute, ensuring they are not starved by other workloads. .. versionchanged:: 3006.0 This parameter can also be set via the ``state_queue`` configuration option. Additionally, it can now be set to an integer representing the maximum queue size which can be attained before the state runs will fail to be queued. This can prevent runaway conditions where new threads are started until system performance is hampered. concurrent : False Execute state runs concurrently instead of serially .. warning:: This flag is potentially dangerous. It is designed for use when multiple state runs can safely be run at the same time. Do *not* use this flag for performance optimization. saltenv Specify a salt fileserver environment to be used when applying states .. versionchanged:: 0.17.0 Argument name changed from ``env`` to ``saltenv`` .. versionchanged:: 2014.7.0 If no saltenv is specified, the minion config will be checked for an ``environment`` parameter and if found, it will be used. If none is found, ``base`` will be used. In prior releases, the minion config was not checked and ``base`` would always be assumed when the saltenv was not explicitly set. pillarenv Specify a Pillar environment to be used when applying states. This can also be set in the minion config file using the :conf_minion:`pillarenv` option. When neither the :conf_minion:`pillarenv` minion config option nor this CLI argument is used, all Pillar environments will be merged together. localconfig Optionally, instead of using the minion config, load minion opts from the file specified by this argument, and then merge them with the options from the minion config. This functionality allows for specific states to be run with their own custom minion configuration, including different pillars, file_roots, etc. .. code-block:: bash salt '*' state.apply stuff localconfig=/path/to/minion.yml sync_mods If specified, the desired custom module types will be synced prior to running the SLS files: .. code-block:: bash salt '*' state.apply stuff sync_mods=states,modules salt '*' state.apply stuff sync_mods=all .. note:: This option is ignored when no SLS files are specified, as a :ref:`highstate <running-highstate>` automatically syncs all custom module types. .. versionadded:: 2017.7.8,2018.3.3,2019.2.0 state_events The state_events option sends progress events as each function in a state run completes execution. .. versionadded:: 3006.0 Nr )r r )r� r9 r r r r � s Qc O s d|d< t | i |��}|S )z� .. versionadded:: 3001 Alias for `state.apply` with the kwarg `test` forced to `True`. This is a nicety to avoid the need to type out `test=True` and the possibility of a typo causing changes you do not intend. Tr )r )r� r9 r& r r r r � s r c K s d|d< t | fi |��}tj�td d�}t� }|�|�dd�|| |d�i� tj j � d��R z1tj j � � r@td d |� d �� tj j �|d ��}tj�||� W d � n1 sZw Y W n tyo t�d|� Y n w W d � |S W d � |S 1 s�w Y |S )aJ .. versionadded:: 2015.5.0 Request that the local admin execute a state run via `salt-call state.run_request`. All arguments match those of state.apply. CLI Example: .. code-block:: bash salt '*' state.request salt '*' state.request stuff salt '*' state.request stuff,pkgs Tr r[ � req_state.p�name�default)Ztest_runr� r9 �? �cmd.run� attrib -R "�"r� N�8Unable to write state request file %s. Check permission.)r r^ r_ r` r? r �updater7 r r rd � set_umask�platform� is_windowsrS re r� r� rc rU rV )r� r9 r& � notify_path�reqrm r r r r � sB ��� �� ��� � � � � r c C sn t j�td d�}t j�|�r5tjj�|d��}tj � |�}W d � n1 s(w Y | r3|| S |S i S )z� .. versionadded:: 2015.5.0 Return the state request information, if any CLI Example: .. code-block:: bash salt '*' state.check_request r[ r� r] N) r^ r_ r` r? �isfiler r rd re r� �load)r� r� rm r� r r r r s �r c C s0 t j�td d�}t j�|�sdS | s&zt �|� W dS ty% Y dS w t� }| |v r3|�| � ndS t j j � d��R z1t j j �� rNtd d|� d�� t j j �|d ��}t j�||� W d � n1 shw Y W n ty} t�d |� Y n w W d � dS W d � dS 1 s�w Y dS ) z� .. versionadded:: 2015.5.0 Clear out the state execution request without executing it CLI Example: .. code-block:: bash salt '*' state.clear_request r[ r� TFr� r� r� r� r� Nr� )r^ r_ r` r? r� rs rc r r� r r rd r� r� r� rS re r� r� rU rV )r� r� r� rm r r r � clear_request$ sJ �� �� ��� � � � � r� r� c K s� t � }| |vr i S || }d|vsd|vri S || d �|� d|d v r-|d �d� |rUt|d fi |d ��}zt�tj�td d�� W |S t yT Y |S w i S )z� .. versionadded:: 2015.5.0 Execute the pending state request CLI Example: .. code-block:: bash salt '*' state.run_request r� r9 r r[ r� ) r r� r� r r^ rs r_ r` r? rc )r� r9 r� Zn_reqr& r r r r M s& ��r c K s� t dg�rt�d� dddd�}|S t||�}|dur |S t�dd�}tjjj tfi |��}t | fi |��|d< d|v rA|� d� d |v rK|d |d < d |v rU|d |d < |�d �}|�d �} | du rp|durpt |t �sptd ��|durx||d< z tjj|||�d�| t t�t t�|�dd�t|�d�} W n ty� tjj|||�d�| |�dd�t|�d�} Y nw | �� t|| jd �} | r�tjjjtd< dg| W d � S | �� |�d�} t||�dd��} z$| j|�dg �|�dd�|�dd�|�dd�|�d �| d �}W | � � n| � � w t |t ��r*t d d d �d!k�s&|�d!��r*t |�}t || j d"� t!||�dd�| � |td< |W d � S 1 �sLw Y dS )#a� Retrieve the state data from the salt master for this minion and execute it test Run states in test-only (dry-run) mode pillar Custom Pillar values, passed as a dictionary of key-value pairs .. code-block:: bash salt '*' state.highstate stuff pillar='{"foo": "bar"}' .. note:: Values passed this way will override Pillar values set via ``pillar_roots`` or an external Pillar source. .. versionchanged:: 2016.3.0 GPG-encrypted CLI Pillar data is now supported via the GPG renderer. See :ref:`here <encrypted-cli-pillar-data>` for details. pillar_enc Specify which renderer to use to decrypt encrypted data located within the ``pillar`` value. Currently, only ``gpg`` is supported. .. versionadded:: 2016.3.0 exclude Exclude specific states from execution. Accepts a list of sls names, a comma-separated string of sls names, or a list of dictionaries containing ``sls`` or ``id`` keys. Glob-patterns may be used to match multiple states. .. code-block:: bash salt '*' state.highstate exclude=bar,baz salt '*' state.highstate exclude=foo* salt '*' state.highstate exclude="[{'id': 'id_to_exclude'}, {'sls': 'sls_to_exclude'}]" saltenv Specify a salt fileserver environment to be used when applying states .. versionchanged:: 0.17.0 Argument name changed from ``env`` to ``saltenv``. .. versionchanged:: 2014.7.0 If no saltenv is specified, the minion config will be checked for a ``saltenv`` parameter and if found, it will be used. If none is found, ``base`` will be used. In prior releases, the minion config was not checked and ``base`` would always be assumed when the saltenv was not explicitly set. pillarenv Specify a Pillar environment to be used when applying states. This can also be set in the minion config file using the :conf_minion:`pillarenv` option. When neither the :conf_minion:`pillarenv` minion config option nor this CLI argument is used, all Pillar environments will be merged together. queue : False Instead of failing immediately when another state run is in progress, a value of ``True`` will queue the new state run to begin running once the other has finished. The queue is implemented as a disk-based FIFO queue, minimizing memory usage regardless of queue depth. Jobs in the state queue are processed by a background thread and will bypass ``process_count_max`` limits when they are ready to execute, ensuring they are not starved by other workloads. .. versionchanged:: 3006.0 This parameter can also be set via the ``state_queue`` configuration option. Additionally, it can now be set to an integer representing the maximum queue size which can be attained before the state runs will fail to be queued. This can prevent runaway conditions where new threads are started until system performance is hampered. concurrent : False Execute state runs concurrently instead of serially .. warning:: This flag is potentially dangerous. It is designed for use when multiple state runs can safely be run at the same time. Do *not* use this flag for performance optimization. localconfig Optionally, instead of using the minion config, load minion opts from the file specified by this argument, and then merge them with the options from the minion config. This functionality allows for specific states to be run with their own custom minion configuration, including different pillars, file_roots, etc. mock The mock option allows for the state run to execute without actually calling any states. This then returns a mocked return which will show the requisite ordering as well as fully validate the state run. .. versionadded:: 2015.8.4 state_events The state_events option sends progress events as each function in a state run completes execution. .. versionadded:: 3006.0 CLI Examples: .. code-block:: bash salt '*' state.highstate salt '*' state.highstate whitelist=sls1_to_run,sls2_to_run salt '*' state.highstate exclude=sls_to_exclude salt '*' state.highstate exclude="[{'id': 'id_to_exclude'}, {'sls': 'sls_to_exclude'}]" salt '*' state.highstate pillar="{foo: 'Foo!', bar: 'Bar!'}" r zHSalt highstate run is disabled. To re-enable, run state.enable highstate�FalseZDisabled)r� r r� Nr r� r� r� r: r� r� � state_eventsrP �mockF�r� r� r� �mockedr� �r� r� r� r( �4Pillar failed to render with the following messages:�orchestration_jid� called localyr� �cache� cache_namer5 � whitelist)r� r� r� r5 r� r� r� � state_datar� �terser* )"� _disabledrU �debugr� r? r7 r r r r� r� r� r/ r� r r� r� r. r� r� r; rW r+ r, r� � push_activerY �call_highstate� pop_activerS r' r4 �building_highstaterZ )r r� r� r9 r& r� � orig_testrW r� r� r� r� r� rX r r r r l s� v�� �� � �� � � �&�c K s� |� dd�}d|v r|�d� t||�}|dur|S t| t�r$t| �} nt| g�} | r@| D ] } t�d| | � q-tj j j t d< | S t � dd�} tjjjt fi |��} t|fi |��| d< | d du red | d< |� d �} |� d �}|du r�| dur�t| t�s�td ��tj�t d d�|� dd���}|du r�dg}|dur�tjj�|�}ng }d|v r�|dgkr�dg}|D ] }ztd|� � | d d� W q� ty� t� d|� Y q�w |dur�|| d< z tjj | | |� d�|tt �tt �|� dd�t | �d�}W n t �y tjj | | |� d�||� dd�t | �d�}Y nw |�� t!||j"d d�}|�r:tj j j#t d< d g| W d � S |� d �}tjj$�%d ��I |� d ��r�tj�&|��r�tjj$�'|d ��#}tj(�)|�}|j�*||�W d � W d � W d � S 1 �s�w Y W d � n 1 �s�w Y t| t+��r�tjj,�-t.| ��} tjj�| �} |�/� zT|�0| d | i�\}}|�r�tj j j t d< |W |�1� W d � S |�r�tjj�|�}d!|v �r�|d! �2|� n||d!< t3| |� dd"��}|j�*||�}W |�1� n|�1� w W d � n 1 �sw Y td# d$d%�d&k�s,|� d&��r0t4|�}tj�t d d'�}tjj$�%d ��� z4tjj5�6� �rTtd( d)d*|gdd+� tjj$�'|d,��}tj(�7||� W d � n 1 �sow Y W n t8�y� t�9d-|� Y nw t:||� | t d< z/tjj$�'|d,�� }z tj(�7||� W n t;�y� Y nw W d � n 1 �s�w Y W n t8�y� t�9d.|� Y nw W d � n 1 �s�w Y t<| |� dd"�|� |S )/as Execute the states in one or more SLS files test Run states in test-only (dry-run) mode pillar Custom Pillar values, passed as a dictionary of key-value pairs .. code-block:: bash salt '*' state.sls stuff pillar='{"foo": "bar"}' .. note:: Values passed this way will override existing Pillar values set via ``pillar_roots`` or an external Pillar source. Pillar values that are not included in the kwarg will not be overwritten. .. versionchanged:: 2016.3.0 GPG-encrypted CLI Pillar data is now supported via the GPG renderer. See :ref:`here <encrypted-cli-pillar-data>` for details. pillar_enc Specify which renderer to use to decrypt encrypted data located within the ``pillar`` value. Currently, only ``gpg`` is supported. .. versionadded:: 2016.3.0 exclude Exclude specific states from execution. Accepts a list of sls names, a comma-separated string of sls names, or a list of dictionaries containing ``sls`` or ``id`` keys. Glob-patterns may be used to match multiple states. .. code-block:: bash salt '*' state.sls foo,bar,baz exclude=bar,baz salt '*' state.sls foo,bar,baz exclude=ba* salt '*' state.sls foo,bar,baz exclude="[{'id': 'id_to_exclude'}, {'sls': 'sls_to_exclude'}]" queue : False Instead of failing immediately when another state run is in progress, a value of ``True`` will queue the new state run to begin running once the other has finished. The queue is implemented as a disk-based FIFO queue, minimizing memory usage regardless of queue depth. Jobs in the state queue are processed by a background thread and will bypass ``process_count_max`` limits when they are ready to execute, ensuring they are not starved by other workloads. .. versionchanged:: 3006.0 This parameter can also be set via the ``state_queue`` configuration option. Additionally, it can now be set to an integer representing the maximum queue size which can be attained before the state runs will fail to be queued. This can prevent runaway conditions where new threads are started until system performance is hampered. concurrent : False Execute state runs concurrently instead of serially .. warning:: This flag is potentially dangerous. It is designed for use when multiple state runs can safely be run at the same time. Do *not* use this flag for performance optimization. saltenv Specify a salt fileserver environment to be used when applying states .. versionchanged:: 0.17.0 Argument name changed from ``env`` to ``saltenv``. .. versionchanged:: 2014.7.0 If no saltenv is specified, the minion config will be checked for an ``environment`` parameter and if found, it will be used. If none is found, ``base`` will be used. In prior releases, the minion config was not checked and ``base`` would always be assumed when the saltenv was not explicitly set. pillarenv Specify a Pillar environment to be used when applying states. This can also be set in the minion config file using the :conf_minion:`pillarenv` option. When neither the :conf_minion:`pillarenv` minion config option nor this CLI argument is used, all Pillar environments will be merged together. localconfig Optionally, instead of using the minion config, load minion opts from the file specified by this argument, and then merge them with the options from the minion config. This functionality allows for specific states to be run with their own custom minion configuration, including different pillars, file_roots, etc. mock The mock option allows for the state run to execute without actually calling any states. This then returns a mocked return which will show the requisite ordering as well as fully validate the state run. .. versionadded:: 2015.8.4 sync_mods If specified, the desired custom module types will be synced prior to running the SLS files: .. code-block:: bash salt '*' state.sls stuff sync_mods=states,modules salt '*' state.sls stuff sync_mods=all .. versionadded:: 2017.7.8,2018.3.3,2019.2.0 state_events The state_events option sends progress events as each function in a state run completes execution. .. versionadded:: 3006.0 CLI Example: .. code-block:: bash # Run the states configured in salt://example.sls (or salt://example/init.sls) salt '*' state.apply example # Run the states configured in salt://core.sls (or salt://core/init.sls) # and salt://edit/vim.sls (or salt://edit/vim/init.sls) salt '*' state.sls core,edit.vim # Run the states configured in a more deeply nested directory such as salt://my/nested/state.sls (or salt://my/nested/state/init.sls) salt '*' state.sls my.nested.state salt '*' state.sls core exclude="[{'id': 'id_to_exclude'}, {'sls': 'sls_to_exclude'}]" salt '*' state.sls myslsfile pillar="{foo: 'Foo!', bar: 'Bar!'}" r� Fr� Nz<Salt state %s is disabled. To re-enable, run state.enable %sr( r r� r� r: r� r� r[ z {}.cache.pr� r T�allzsaltutil.sync_)r� z)Invalid custom module type '%s', ignoringr� rP r� r� r� r� r� r� r� r� r] Z __exclude__r� r� r� r� r� zsls.pr� Zattribz-R)Z python_shellr� z7Unable to write to SLS cache file %s. Check permission.zDUnable to write to highstate cache file %s. Do you have permissions?)=r7 r� r� r/ r0 r� rU r� r r+ r, r1 r. r? r r r� r� r� r r^ r_ r` r� r� � split_inputrS �KeyError�warningr� r� r� r� r; rW r� rd r� r� re r� r� r� r~ � stringutils� to_unicoderr r� �render_highstater� �extendrY r' r� r� r� rc rV r4 r� rZ )r� r r� r� Z sync_modsr� r9 r� r� �disabledr r� rW r� r� Zcfn� module_typer� r� r� rm �high_rX r& Z cache_filer r r r K s, � ��� � � �� � ��� � � � � & ���� �� ����� � r c K s t ||�}|dur |S t�dd�}tjjjtfi |��}t|fi |��|d< |�d�}|�d�}|du rA|durAt|t �sAt d��ztjj |||t t �t t �t|�d�} W n tym tjj |||t t �t|�d�} Y nw | �� t|| jd d�} | r�tjjjt d < d g| W d � S | �� tjj�| �| jd < i } |�d �} d |v r�|d | jd< z$t||�dd��} | j|�dg �|�dd�|�dd�| d�} W | �� n| �� w t| | j d� t ||�dd�| � |td< | W d � S 1 s�w Y dS )ag Execute a specific top file instead of the default. This is useful to apply configurations from a different environment (for example, dev or prod), without modifying the default top file. queue : False Instead of failing immediately when another state run is in progress, a value of ``True`` will queue the new state run to begin running once the other has finished. The queue is implemented as a disk-based FIFO queue, minimizing memory usage regardless of queue depth. Jobs in the state queue are processed by a background thread and will bypass ``process_count_max`` limits when they are ready to execute, ensuring they are not starved by other workloads. .. versionchanged:: 3006.0 This parameter can also be set via the ``state_queue`` configuration option. Additionally, it can now be set to an integer representing the maximum queue size which can be attained before the state runs will fail to be queued. This can prevent runaway conditions where new threads are started until system performance is hampered. saltenv Specify a salt fileserver environment to be used when applying states pillarenv Specify a Pillar environment to be used when applying states. This can also be set in the minion config file using the :conf_minion:`pillarenv` option. When neither the :conf_minion:`pillarenv` minion config option nor this CLI argument is used, all Pillar environments will be merged together. .. versionadded:: 2017.7.0 CLI Example: .. code-block:: bash salt '*' state.top reverse_top.sls salt '*' state.top prod_top.sls exclude=sls_to_exclude salt '*' state.top dev_top.sls exclude="[{'id': 'id_to_exclude'}, {'sls': 'sls_to_exclude'}]" Nr r: r� r� )r� r� r� r� )r� r� r� r� r( r� Z state_topr� r� Zstate_top_saltenvrP r� r� r� r� r )r� r� r� r� r* ) r� r? r7 r r r r� r� r/ r� r r� r. r� r� r� r; rW r+ r, r� r� �url�createrY r� r� r4 r� rZ )Ztopfnr r� r9 r� r� rW r� r� r� r� r& r� rX r r r r � sv + �� � �� � �$�r c K s8 t | |�}|dur |S |�d�}|�d�}|du r&|dur&t|t�s&td��tjjjt fi |��}ztjj |||t t |�d�}W n t yU tjj |||t |�d�}Y nw |�: t||jd d�}|rqtjjjtd< td |d ��|�� z |�� }W |�� n|�� w t|� |W d � S 1 s�w Y dS ) z� Retrieve the highstate data from the salt master and display it Custom Pillar data can be passed with the ``pillar`` kwarg. CLI Example: .. code-block:: bash salt '*' state.show_highstate Nr: r� r� �r� r� r� r� r� r( r� r� )r� r7 r/ r� r r r r r� r? r� r� r� r� r; rW r+ r, r� r. r r� Zcompile_highstater� r4 ) r� r9 r� r� r� rW r� r� r& r r r �show_highstate� sR �� � �� $�r c K s� t | |�}|dur J �tjjjtfi |��}z tjj|tt|�d�}W n t y6 tjj|t|�d�}Y nw |�6 t ||j d d�}|rRtj j jtd< td|d ��|�� z |�� }W |�� n|�� w |W d � S 1 srw Y dS ) z� List out the low data that will be applied to this minion CLI Example: .. code-block:: bash salt '*' state.show_lowstate NFr� r� r: r� r( r� r� )r� r r r r� r? r� r� r� r� r; rW r+ r, r� r. r r� �compile_low_chunksr� )r� r9 r� rW r� r� r& r r r � show_lowstate* s, � � $�r c K s� t | |�}|dur |S |�d�}|�d�}|du r&|dur&t|t�s&td��tjjt||d��"}|� � z |� � }W |� � n|� � w t |� |W d � S 1 sTw Y dS )z� Retrieve the highstate data from the salt master to analyse used and unused states Custom Pillar data can be passed with the ``pillar`` kwarg. CLI Example: .. code-block:: bash salt '*' state.show_state_usage Nr: r� r� )r� ) r� r7 r/ r� r r r r� r? r� Zcompile_state_usager� r4 )r� r9 r� r: r� r� r& r r r �show_state_usageO s" � $�r c K sZ t | |�}|dur |S tjjjtfi |��}z tjj|tt|�d�}W n t y6 tjj|t|�d�}Y nw |�j t ||j d d�}|rRtj j jtd< td|d��|�� t� }z7|�� }t|t�sgt|��|D ]!}t|t�s�t|� | W |�� W d � S d ||d < qiW |�� n|�� w t|�� �W d � S 1 s�w Y dS ) z� Returns the list of states that will be applied on highstate. CLI Example: .. code-block:: bash salt '*' state.show_states .. versionadded:: 2019.2.0 Nr� r� r: r� r( r� r� TZ__sls__)r� r r r r� r? r� r� r� r� r; rW r+ r, r� r. r r� r r r/ r0 rT r� r4 r� �keys) r� r9 r� rW r� r� rF r �sr r r � show_statesq sB � � �� $�r c K sb t ||�}|dur |S t�dd�}tjjjtfi |��}t|fi |��|d< |d du r0d|d< |�d�} |�d�} | du rK| durKt| t �sKt d��|durS||d< ztjj || | t t |�d �} W n tyw tjj || | t |�d �} Y nw | �� t|| jd d �} | r�tjjjtd < d g| W d � S tjj�|�} | �� z| �|d | i�\}} W | �� n| �� w | | j�|�7 } | j�|�\}}|r�| � |� | r�tjjj td < | W d � S | j� |�}i }|D ]}|�dd�| k�r|� | j� |i |�� q�t!|t"d� |td< |�s t d�#| ||d ���|W d � S 1 �s*w Y dS )ad Call a single ID from the named module(s) and handle all requisites The state ID comes *before* the module ID(s) on the command line. id ID to call mods Comma-delimited list of modules to search for given id and its requisites .. versionadded:: 2014.7.0 saltenv : base Specify a salt fileserver environment to be used when applying states pillarenv Specify a Pillar environment to be used when applying states. This can also be set in the minion config file using the :conf_minion:`pillarenv` option. When neither the :conf_minion:`pillarenv` minion config option nor this CLI argument is used, all Pillar environments will be merged together. pillar Custom Pillar values, passed as a dictionary of key-value pairs .. code-block:: bash salt '*' state.sls_id my_state my_module pillar='{"foo": "bar"}' .. note:: Values passed this way will override existing Pillar values set via ``pillar_roots`` or an external Pillar source. Pillar values that are not included in the kwarg will not be overwritten. .. versionadded:: 2018.3.0 CLI Example: .. code-block:: bash salt '*' state.sls_id my_state my_module salt '*' state.sls_id my_state my_module,a_common_module Nr r� r� r: r� r� r� r� r� r� r( r� �__id__r� r* z<No matches for ID '{}' found in SLS '{}' within saltenv '{}')$r� r? r7 r r r r� r� r/ r� r r� r� r� r� r; rW r+ r, r� r. r� r� r� r� r� � verify_highZ requisite_inr� r1 �compile_high_datar� Z call_chunkr4 r r� )Zid_r� r r� r� r9 r� r� rW r� r� r� r� Z split_modsr� Z req_in_errors�chunksr& �chunkr r r r � s� . �� � ��� � � ��&�r c K s� d|v r |� d� t||�}|dur|S t�dd�}tjjjtfi |��}t|fi |��|d< |d du r9d|d< |�d�}|�d�}|du rT|durTt |t �sTt d��ztjj ||t t|�d �} W n tyv tjj ||t|�d �} Y nw | �h t|| jd d �} | r�tjjjtd < td | d��tjj�| �} | �� z| �|d | i�\} } W | �� n| �� w | | j� | �7 } | r�tjjj td < | W d � S | j� | �} |td< | W d � S 1 s�w Y dS )a Display the low data from a specific sls. The default environment is ``base``, use ``saltenv`` to specify a different environment. saltenv Specify a salt fileserver environment to be used when applying states pillar Custom Pillar values, passed as a dictionary of key-value pairs .. code-block:: bash salt '*' state.show_low_sls stuff pillar='{"foo": "bar"}' .. note:: Values passed this way will override Pillar values set via ``pillar_roots`` or an external Pillar source. pillarenv Specify a Pillar environment to be used when applying states. This can also be set in the minion config file using the :conf_minion:`pillarenv` option. When neither the :conf_minion:`pillarenv` minion config option nor this CLI argument is used, all Pillar environments will be merged together. CLI Example: .. code-block:: bash salt '*' state.show_low_sls foo salt '*' state.show_low_sls foo saltenv=dev r� Nr r� r� r: r� r� r� r� r� r( r� r� ) r� r� r? r7 r r r r� r� r/ r� r r� r� r� r� r; rW r+ r, r� r. r r� r� r� r� r� r r1 r ) r� r r� r9 r� r� rW r� r� r� r� r� r& r r r � show_low_sls% sd ! �� � �� � $�r c K s� d|v r |� d� t||�}|dur|S t�dd�}tjjjtfi |��}t|fi |��|d< |d du r9d|d< |�d�}|�d�}|du rT|durTt |t �sTt d��ztjj |||t t|�d �} W n tyx tjj |||t|�d �} Y nw | �b t|| jd d �} | r�tjjjtd < td | d��tjj�| �} | �� z| �|d | i�\} } W | �� n| �� w | | j� | �7 } |td< | r�tjjj td < | W d � S | W d � S 1 s�w Y dS )a~ Display the state data from a specific sls or list of sls files on the master. The default environment is ``base``, use ``saltenv`` to specify a different environment. This function does not support topfiles. For ``top.sls`` please use ``show_top`` instead. Custom Pillar data can be passed with the ``pillar`` kwarg. saltenv Specify a salt fileserver environment to be used when applying states pillarenv Specify a Pillar environment to be used when applying states. This can also be set in the minion config file using the :conf_minion:`pillarenv` option. When neither the :conf_minion:`pillarenv` minion config option nor this CLI argument is used, all Pillar environments will be merged together. CLI Example: .. code-block:: bash salt '*' state.show_sls core,edit.vim saltenv=dev r� Nr r� r� r: r� r� r� r� r� r( r� r� ) r� r� r? r7 r r r r� r� r/ r� r r� r� r� r� r; rW r+ r, r� r. r r� r� r� r� r� r r1 ) r� r r� r9 r� r� rW r� r� r� r� r� r r r �show_sls� sj �� � �� �$�r c K s t t| f||d�|��t�S )aT Tests for the existence the of a specific SLS or list of SLS files on the master. Similar to :py:func:`state.show_sls <salt.modules.state.show_sls>`, rather than returning state details, returns True or False. The default environment is ``base``, use ``saltenv`` to specify a different environment. .. versionadded:: 2019.2.0 saltenv Specify a salt fileserver environment from which to look for the SLS files specified in the ``mods`` argument CLI Example: .. code-block:: bash salt '*' state.sls_exists core,edit.vim saltenv=dev �r r� )r/ r r� )r� r r� r9 r r r � sls_exists� s r c K s@ t jj�| �} t| �} dd� t|f||d�|��D �}| �|�S )aR Tests for the existence of a specific ID or list of IDs within the specified SLS file(s). Similar to :py:func:`state.sls_exists <salt.modules.state.sls_exists>`, returns True or False. The default environment is base``, use ``saltenv`` to specify a different environment. .. versionadded:: 2019.2.0 saltenv Specify a salt fileserver environment from which to look for the SLS files specified in the ``mods`` argument CLI Example: .. code-block:: bash salt '*' state.id_exists create_myfile,update_template filestate saltenv=dev c S s h | ]}|d �qS )r r )r! �xr r r � <setcomp> s �z id_exists.<locals>.<setcomp>r )r r r� r� �setr �issubset)Zidsr� r r� r9 Zsls_idsr r r � id_exists� s � r c K s$ d|v r |� d� t| |�}|dur|S tjjjtfi |��}z tjj|tt |�d�}W n t y? tjj|t |�d�}Y nw |�F t ||j d d�}|r[tj jjtd< td|d ��g }|�� }||�|�7 }|rztj jjtd< |W d � S |�|�}|W d � S 1 s�w Y dS ) z� Return the top data that the minion will use for a highstate CLI Example: .. code-block:: bash salt '*' state.show_top r� Nr� r� r: r� r( r� r� )r� r� r r r r� r? r� r� r� r� r; rW r+ r, r� r. r Zget_topZ verify_topsr1 Z top_matches)r� r9 r� rW r� r� Ztop_�matchesr r r �show_top s8 � � � $�r c K s� t ||�}|dur |S | �d�}t|�dk r tjjjtd< dS |�|d |d ||d�� t � d d�}tj j j t fi |��}t|fi |��|d < |� d �} |� d �} | du rc| durct| t�sctd ��ztj j|| | tt|�d �} W n ty� tj j|| | t|�d�} Y nw | �|�} | r�tjjjtd< | S | �|� t||� dd��} d�|�| �|�i}t|� t ||� dd�| � |t d < |S )a� Execute a single state function with the named kwargs, returns False if insufficient data is sent to the command By default, the values of the kwargs will be parsed as YAML. So, you can specify lists values, or lists of single entry key-value maps, as you would in a YAML salt file. Alternatively, JSON format of keyword values is also supported. CLI Example: .. code-block:: bash salt '*' state.single pkg.installed name=vim N�.� r( zInvalid function passedr r< )r r� r r� r r: r� r� r� r� rP r� z/{0[state]}_|-{0[__id__]}_|-{0[name]}_|-{0[fun]}) r� �splitrB r r+ r, r1 r. r� r? r7 r r r� r� r/ r� r r� r� r� r� r� Z _mod_initrY r� r� r4 rZ )r� r� r r� r9 r� �compsr� rW r� r� r� r� rX r& r r r r > sd �� � �� ��r c C sZ g } t �td �D ]!}|�d�r*t j�td |�}t j�|�s q t �|� | �|� q | S )aK Clear out cached state files, forcing even cache runs to refresh the cache on the next state execution. Remember that the state cache is completely disabled by default, this execution only applies if cache=True is used in states CLI Example: .. code-block:: bash salt '*' state.clear_cache r[ z.cache.p) r^ rq r? r� r_ r` r� rs r� )r& �fn_r_ r r r � clear_cache� s �r c K s� t jjjtfi |��}tj�| �si S t jj� | |�|ks i S t � � }t � | d�}|�� }|D ]*} t jj�| j��tjdtj� �f�rGi S dtj� �t jj�| j�v rYi S q/|�|� |�� tj�|d�} t jj�| d��} t jj�| �} W d � n1 s�w Y | D ] } t| t�s�| S q�tj�|d�}tj�|�r�t jj�|d��} t jj�| �}W d � n1 s�w Y nd}tj�|d�}tj�|�r�t jj�|d��} t t jj�| ��}W d � n1 s�w Y tj�|�r�||d< d |d < i |d < t |fi |��|d < t� |�}|D ]}tj�||�}tj� |��s)�q|g|d |< �qt jj ||d �}t!||�"dd��}|�#| �}|�$| |�}zt%�&|� W n t'�y_ Y nw t(|� t)||�"dd�|� |S )a' Execute a packaged state run, the packaged state run will exist in a tarball available locally. This packaged state can be generated using salt-ssh. CLI Example: .. code-block:: bash salt '*' state.pkg /tmp/salt_state.tgz 760a9353810e36f6d81416366fc426dc md5 zr:gzz..z lowstate.json�rNz pillar.jsonzroster_grains.jsonZgrainsr� Z fileclientZ file_rootsr )r� rP r� )*r r r r� r? r^ r_ r� Z hashutilsZget_hash�tempfileZmkdtemp�tarfile�open� getmembersr� r� r� �sep� extractall�closer` rd re �jsonr� r/ r� r r� rq �isdirr� rY r7 Z call_chunksZ call_listen�shutil�rmtreerc r4 rZ )Zpkg_pathZpkg_sumZ hash_typer r9 ZpoptsrK Zs_pkg�members�memberZ lowstate_jsonrm Zlowstater Z pillar_jsonr� Zroster_grains_jsonZ roster_grainsZenvsr �fullr� rX r& r r r r � sz � � � � �� � �r c C s� ddd�}t jj�| �} g }td d�}t|t�sg }d}| D ] }||v r/|�d|� d�� q |�d|� d �� |�|� d}q |rItd d|� d �|�|d < td � |S )ak Disable state runs. CLI Example: .. code-block:: bash salt '*' state.disable highstate salt '*' state.disable highstate,test.succeed_without_changes .. note:: To disable a state file from running provide the same name that would be passed in a state.sls call. salt '*' state.disable bind.config Tr� ��res�msg� grains.get�state_runs_disabledF�Info: z state already disabled.z state disabled.� grains.setval� r. �saltutil.refresh_modules) r r r� r� rS r/ r0 r� r` �rF r& r. �_disabled_state_runsZ_changed�_stater r r �disable� s$ r8 c C s� ddd�}t jj�| �} t�d| � g }td d�}t|t�s!g }d}| D ]&}t�d|� ||vr;|� d |� d �� q%|� d |� d �� |� |� d}q%|rUtd d|� d � |�|d< td � |S )ak Enable state function or sls run CLI Example: .. code-block:: bash salt '*' state.enable highstate salt '*' state.enable test.succeed_without_changes .. note:: To enable a state file from running provide the same name that would be passed in a state.sls call. salt '*' state.disable bind.config Tr� r, z states %sr/ r0 Fz _state %sr1 z state already enabled.z state enabled.r2 r3 r. r4 ) r r r� r� rU r� rS r/ r0 r� rs r` r5 r r r �enable s( r9 c C s t d d�S )z� List the states which are currently disabled CLI Example: .. code-block:: bash salt '*' state.list_disabled r/ r0 )rS r r r r � list_disabledO s r: c C s� g }t d d�}t|t�sg }| D ]>}|D ]9}d|v r?|�d�d }|�d�s+|d n|}|�|�r>d�||�}|�|� qq||krNd�|�}|�|� qqq|S )zU Return messages for disabled states that match state functions in funs. r/ r0 z.*r r zXThe state file "{0}" is currently disabled by "{1}", to re-enable, run state.enable {1}.zOThe state file "{0}" is currently disabled, to re-enable, run state.enable {0}.)rS r/ r0 r r� r� r� r� )Zfunsr& r6 r r7 Z target_stater� r r r r� \ sB �� �� � �� �� r� ����minionc C s t jjj||p td tdd��j} |jddd�}|du r qt jj�|d | �rg|sSt jj�d�t jj� |d �t jj j t jj � |d �||sHdnd d ��� tj�� |d kra|d 8 }t�d |� |d krfn n t�d|d � qqW d � dS 1 s|w Y dS )a* Watch Salt's event bus and block until the given tag is matched .. versionadded:: 2016.3.0 .. versionchanged:: 2019.2.0 ``tagmatch`` can now be either a glob or regular expression. This is useful for utilizing Salt's event bus from shell scripts or for taking simple actions directly from the CLI. Enable debug logging to see ignored events. :param tagmatch: the event is written to stdout for each tag that matches this glob or regular expression. :param count: this number is decremented for each event that matches the ``tagmatch`` parameter; pass ``-1`` to listen forever. :param quiet: do not print to stdout; just block :param sock_dir: path to the Salt master's event socket file. :param pretty: Output the JSON all on a single line if ``False`` (useful for shell tools); pretty-print the JSON output if ``True``. :param node: Watch the minion-side or master-side event bus. CLI Example: .. code-block:: bash salt-call --local state.event pretty=True �sock_dirT)rW �listen)r+ Zauto_reconnectNr" z{} {}rl � )� sort_keys�indentr r< zRemaining event matches: %szSkipping event tag: %s)r r �eventZ get_eventr? r� Z expr_matchZ print_clir� Zto_strr% rz rl �decode�sys�stdout�flushrU r� )Ztagmatch�count�quietr= Zpretty�nodeZseventr& r r r rB � sF � ��� ��"�rB )N)r )NN)r� NNNN)F)r� )NNN)NNNNN)r r; FNFr< )a�__doc__�loggingr^ r' rD r r rC � collectionsr Z salt.configr Zsalt.defaults.exitcodesZ salt.payloadZ salt.stateZsalt.utils.argsZsalt.utils.atomicfileZsalt.utils.dataZsalt.utils.eventZsalt.utils.filesZsalt.utils.functoolsZsalt.utils.hashutilsZsalt.utils.jidZsalt.utils.jsonZsalt.utils.msgpackZsalt.utils.platformZsalt.utils.processZsalt.utils.stateZsalt.utils.stringutilsZsalt.utils.urlZsalt.utils.versionsZsalt.exceptionsr r Z salt.loaderr Zsalt.runners.stater r Z__proxyenabled__Z __outputter__Z__func_alias__� getLogger�__name__rU r r r' r4 r; rG rY rZ rn ru r| r r� r� r� r� r� rA r� r� r� r� r� r r r r r r r� r r r r r r r r r r r r r r r r r r8 r9 r: r� rB r r r r �<module> s� � $ " ## � , l 5 5 V + ) b � 8 n ; % " 2 ` ^ *L J02 *�
| ver. 1.4 |
Github
|
.
| PHP 8.2.30 | Generation time: 0 |
proxy
|
phpinfo
|
Settings