Current File : //lib/python2.7/site-packages/salt/modules/saltutil.pyo
�
���^c @@ sb d Z d d l m Z m Z m Z d d l Z d d l Z d d l Z d d l Z d d l Z d d l
Z
d d l Z d d l Z y& d d l
Z
d d l
m Z e Z Wn e k
r� e Z n Xd d l m Z d d l m Z y
e j Z Wn e k
r e j Z n Xd d l Z d d l Z d d l Z d d l Z d d l Z d d l Z d d l! Z d d l" Z d d l# Z d d l$ Z d d l% Z d d l& Z d d l' Z d d l( Z d d l) Z d d l* Z d d l+ Z d d l, Z e Z- y d d l. Z Wn e k
re Z- n Xd d l/ m0 Z0 m1 Z1 m2 Z2 m3 Z3 d g Z4 e j5 e6 � Z7 d � Z8 d d d d
� Z: d d � Z; d e d d d � Z< d d d d
� Z= d e d d d � Z> d e d d d � Z? d � Z@ d e d d d � ZA d e d d d � ZB d e d d d � ZC d e d d d � ZD d e d d d � ZE d e d d d � ZF d e d d d � ZG d e d d d � ZH e jI jJ jK eH d � ZL d e d d d � ZM d e d d d � ZN d e d d d � ZO d � ZP d e d d d � ZQ d e d d d � ZR d e d d d � ZS d! � ZT d" � ZU e d# d$ � ZV e jI jJ jK eV d% � ZW d& � ZX d' � ZY d( � ZZ d) � Z[ d* d+ � Z\ d, � Z] d- � Z^ d. � Z_ d/ � Z` d0 � Za d1 � Zb d2 � Zc d3 � Zd e d4 � Ze e d5 � Zf d6 � Zg dA d d7 d8 d e d9 � Zh dB d d7 d8 d e d: � Zi d d e d; d d< � Zj d= � Zk d> el f d? � � YZm d@ � Zn d S(C u�
The Saltutil module is used to manage the state of the salt minion itself. It
is used to manage minion modules as well as automate updates to the salt
minion.
:depends: - esky Python module for update functionality
i ( t absolute_importt print_functiont unicode_literalsN( t EskyVersionError( t six( t URLError( t SaltReqTimeoutErrort SaltRenderErrort CommandExecutionErrort SaltInvocationErroru *c C@ s� y t d SWn� t k
r� yX t j j t d t �} | j � } | rm t | j | � j
� � pg d } n d } Wn( t k
r� } t d j
| � � � n X| t d <| SXd S( u0
Get all environments from the top file
u saltutil._top_file_envst initial_pillaru baseu! Unable to render top file(s): {0}N( t __context__t KeyErrort saltt statet HighStatet __opts__t
__pillar__t get_topt listt top_matchest keysR R t format( t st_t topt envst exc( ( s9 /usr/lib/python2.7/site-packages/salt/modules/saltutil.pyt _get_top_file_envsK s
$
c C@ s9 | d k r t � } n t | t j � r< | j d � } n t j j j t
| d | d | d | �\ } } | r� t j j
t
d d � } t j j j | d � � Wd QXn | d k r5t
j d
� r5t j j t j j
t
d d � � r5y$ t j t j j
t
d d � � Wq5t k
r1t j d � q5Xn | S(
u;
Sync the given directory in the given environment
u ,t saltenvt extmod_whitelistt extmod_blacklistu cachediru module_refreshu aNu grainsu grains_cacheu grains.cache.pu Could not remove grains cache!( t NoneR t
isinstanceR t string_typest splitR
t utilst extmodst syncR t ost patht joint filest fopent gett isfilet removet OSErrort logt error( t formR R R t rett touchedt mod_file( ( s9 /usr/lib/python2.7/site-packages/salt/modules/saltutil.pyt _syncb s$ ! %$
c C@ s� i } t s d | d <| St t d t � s: d | d <| St d d � sX d | d <| St j t j t d � } t d } | s� y | j
� } Wq� t k
r� } d j | � | d <| SXn | s� d
| d <| Sy | j
| � Wn* t k
r} d j | | � | d <| SXy | j | � Wn* t k
rM} d j | | � | d <| SXy | j � Wn& t k
r�} d
j | � | d <n Xi } x& t d D] } t d | � | | <q�Wd j | | � | d <| | d <| S( u�
Update the salt minion from the URL defined in opts['update_url']
SaltStack, Inc provides the latest builds here:
update_url: https://repo.saltstack.com/windows/
Be aware that as of 2014-8-11 there's a bug in esky such that only the
latest version available in the update_url can be downloaded and installed.
This feature requires the minion to be running a bdist_esky build.
The version number is optional and will default to the most recent version
available at opts['update_url'].
Returns details about the transaction upon completion.
CLI Examples:
.. code-block:: bash
salt '*' saltutil.update
salt '*' saltutil.update 0.10.3
u Esky not available as importu _erroru frozenu# Minion is not running an Esky buildu
config.optionu
update_urlu* "update_url" not configured on this minionu saltversionu+ Could not connect to update_url. Error: {0}u No updates availableu' Unable to fetch version {0}. Error: {1}u) Unable to install version {0}. Error: {1}u Unable to cleanup. Error: {0}u update_restart_servicesu service.restartu Updated from {0} to {1}u commentu restarted( t HAS_ESKYt getattrt syst Falset __salt__t eskyt Eskyt
executableR t
__grains__t find_updateR R t
fetch_versionR t install_versiont cleanupt Exception( t versionR2 t appt
oldversionR t restartedt service( ( s9 /usr/lib/python2.7/site-packages/salt/modules/saltutil.pyt update{ sR
c C@ s) t d | | | � } | r% t � n | S( u
.. versionadded:: 2015.5.1
Sync beacons from ``salt://_beacons`` to the minion
saltenv
The fileserver environment from which to sync. To sync from more than
one environment, pass a comma-separated list.
If not passed, then all environments configured in the :ref:`top files
<states-top>` will be checked for beacons to sync. If no top files are
found, then the ``base`` environment will be synced.
refresh : True
If ``True``, refresh the available beacons on the minion. This refresh
will be performed even if no new beacons are synced. Set to ``False``
to prevent this refresh.
extmod_whitelist : None
comma-seperated list of modules to sync
extmod_blacklist : None
comma-seperated list of modules to blacklist based on type
CLI Example:
.. code-block:: bash
salt '*' saltutil.sync_beacons
salt '*' saltutil.sync_beacons saltenv=dev
salt '*' saltutil.sync_beacons saltenv=base,dev
u beacons( R5 t refresh_beacons( R t refreshR R R2 ( ( s9 /usr/lib/python2.7/site-packages/salt/modules/saltutil.pyt sync_beacons� s !
c C@ s t d | | | � } | S( u�
.. versionadded:: 2015.5.8,2015.8.3
Sync sdb modules from ``salt://_sdb`` to the minion
saltenv
The fileserver environment from which to sync. To sync from more than
one environment, pass a comma-separated list.
If not passed, then all environments configured in the :ref:`top files
<states-top>` will be checked for sdb modules to sync. If no top files
are found, then the ``base`` environment will be synced.
refresh : False
This argument has no affect and is included for consistency with the
other sync functions.
extmod_whitelist : None
comma-seperated list of modules to sync
extmod_blacklist : None
comma-seperated list of modules to blacklist based on type
CLI Example:
.. code-block:: bash
salt '*' saltutil.sync_sdb
salt '*' saltutil.sync_sdb saltenv=dev
salt '*' saltutil.sync_sdb saltenv=base,dev
u sdb( R5 ( R R R R2 ( ( s9 /usr/lib/python2.7/site-packages/salt/modules/saltutil.pyt sync_sdb� s c C@ s) t d | | | � } | r% t � n | S( uY
.. versionadded:: 0.10.0
Sync execution modules from ``salt://_modules`` to the minion
saltenv
The fileserver environment from which to sync. To sync from more than
one environment, pass a comma-separated list.
If not passed, then all environments configured in the :ref:`top files
<states-top>` will be checked for execution modules to sync. If no top
files are found, then the ``base`` environment will be synced.
refresh : True
If ``True``, refresh the available execution modules on the minion.
This refresh will be performed even if no new execution modules are
synced. Set to ``False`` to prevent this refresh.
.. important::
If this function is executed using a :py:func:`module.run
<salt.states.module.run>` state, the SLS file will not have access to
newly synced execution modules unless a ``refresh`` argument is
added to the state, like so:
.. code-block:: yaml
load_my_custom_module:
module.run:
- name: saltutil.sync_modules
- refresh: True
See :ref:`here <reloading-modules>` for a more detailed explanation of
why this is necessary.
extmod_whitelist : None
comma-seperated list of modules to sync
extmod_blacklist : None
comma-seperated list of modules to blacklist based on type
CLI Example:
.. code-block:: bash
salt '*' saltutil.sync_modules
salt '*' saltutil.sync_modules saltenv=dev
salt '*' saltutil.sync_modules saltenv=base,dev
u modules( R5 t refresh_modules( R RK R R R2 ( ( s9 /usr/lib/python2.7/site-packages/salt/modules/saltutil.pyt sync_modules s 2
c C@ s) t d | | | � } | r% t � n | S( u
.. versionadded:: 0.10.0
Sync state modules from ``salt://_states`` to the minion
saltenv
The fileserver environment from which to sync. To sync from more than
one environment, pass a comma-separated list.
If not passed, then all environments configured in the :ref:`top files
<states-top>` will be checked for state modules to sync. If no top
files are found, then the ``base`` environment will be synced.
refresh : True
If ``True``, refresh the available states on the minion. This refresh
will be performed even if no new state modules are synced. Set to
``False`` to prevent this refresh.
extmod_whitelist : None
comma-seperated list of modules to sync
extmod_blacklist : None
comma-seperated list of modules to blacklist based on type
CLI Examples:
.. code-block:: bash
salt '*' saltutil.sync_states
salt '*' saltutil.sync_states saltenv=dev
salt '*' saltutil.sync_states saltenv=base,dev
u states( R5 RN ( R RK R R R2 ( ( s9 /usr/lib/python2.7/site-packages/salt/modules/saltutil.pyt sync_states@ s !
c K@ s^ t j j j | � } | j d t � } | rC t j j j | � n t � | rZ t � n t S( u�
.. versionadded:: 2016.3.6,2016.11.4,2017.7.0
Refresh the minion's grains without syncing custom grains modules from
``salt://_grains``.
.. note::
The available execution modules will be reloaded as part of this
proceess, as grains can affect which modules are available.
refresh_pillar : True
Set to ``False`` to keep pillar data from being refreshed.
CLI Examples:
.. code-block:: bash
salt '*' saltutil.refresh_grains
u refresh_pillar( R
R# t argst clean_kwargst popt Truet invalid_kwargsRN t refresh_pillar( t kwargst _refresh_pillar( ( s9 /usr/lib/python2.7/site-packages/salt/modules/saltutil.pyt refresh_grainsg s
c C@ s0 t d | | | � } | r, t � t � n | S( uE
.. versionadded:: 0.10.0
Sync grains modules from ``salt://_grains`` to the minion
saltenv
The fileserver environment from which to sync. To sync from more than
one environment, pass a comma-separated list.
If not passed, then all environments configured in the :ref:`top files
<states-top>` will be checked for grains modules to sync. If no top
files are found, then the ``base`` environment will be synced.
refresh : True
If ``True``, refresh the available execution modules and recompile
pillar data for the minion. This refresh will be performed even if no
new grains modules are synced. Set to ``False`` to prevent this
refresh.
extmod_whitelist : None
comma-seperated list of modules to sync
extmod_blacklist : None
comma-seperated list of modules to blacklist based on type
CLI Examples:
.. code-block:: bash
salt '*' saltutil.sync_grains
salt '*' saltutil.sync_grains saltenv=dev
salt '*' saltutil.sync_grains saltenv=base,dev
u grains( R5 RN RV ( R RK R R R2 ( ( s9 /usr/lib/python2.7/site-packages/salt/modules/saltutil.pyt sync_grains� s
"
c C@ s) t d | | | � } | r% t � n | S( uQ
.. versionadded:: 0.10.0
Sync renderers from ``salt://_renderers`` to the minion
saltenv
The fileserver environment from which to sync. To sync from more than
one environment, pass a comma-separated list.
If not passed, then all environments configured in the :ref:`top files
<states-top>` will be checked for renderers to sync. If no top files
are found, then the ``base`` environment will be synced.
refresh : True
If ``True``, refresh the available execution modules on the minion.
This refresh will be performed even if no new renderers are synced.
Set to ``False`` to prevent this refresh. Set to ``False`` to prevent
this refresh.
extmod_whitelist : None
comma-seperated list of modules to sync
extmod_blacklist : None
comma-seperated list of modules to blacklist based on type
CLI Examples:
.. code-block:: bash
salt '*' saltutil.sync_renderers
salt '*' saltutil.sync_renderers saltenv=dev
salt '*' saltutil.sync_renderers saltenv=base,dev
u renderers( R5 RN ( R RK R R R2 ( ( s9 /usr/lib/python2.7/site-packages/salt/modules/saltutil.pyt sync_renderers� s "
c C@ s) t d | | | � } | r% t � n | S( u�
.. versionadded:: 0.10.0
Sync returners from ``salt://_returners`` to the minion
saltenv
The fileserver environment from which to sync. To sync from more than
one environment, pass a comma-separated list.
If not passed, then all environments configured in the :ref:`top files
<states-top>` will be checked for returners to sync. If no top files
are found, then the ``base`` environment will be synced.
refresh : True
If ``True``, refresh the available execution modules on the minion.
This refresh will be performed even if no new returners are synced. Set
to ``False`` to prevent this refresh.
extmod_whitelist : None
comma-seperated list of modules to sync
extmod_blacklist : None
comma-seperated list of modules to blacklist based on type
CLI Examples:
.. code-block:: bash
salt '*' saltutil.sync_returners
salt '*' saltutil.sync_returners saltenv=dev
u returners( R5 RN ( R RK R R R2 ( ( s9 /usr/lib/python2.7/site-packages/salt/modules/saltutil.pyt sync_returners� s
c C@ s) t d | | | � } | r% t � n | S( u2
.. versionadded:: 2015.8.2
Sync proxy modules from ``salt://_proxy`` to the minion
saltenv
The fileserver environment from which to sync. To sync from more than
one environment, pass a comma-separated list.
If not passed, then all environments configured in the :ref:`top files
<states-top>` will be checked for proxy modules to sync. If no top
files are found, then the ``base`` environment will be synced.
refresh : True
If ``True``, refresh the available execution modules on the minion.
This refresh will be performed even if no new proxy modules are synced.
Set to ``False`` to prevent this refresh.
extmod_whitelist : None
comma-seperated list of modules to sync
extmod_blacklist : None
comma-seperated list of modules to blacklist based on type
CLI Examples:
.. code-block:: bash
salt '*' saltutil.sync_proxymodules
salt '*' saltutil.sync_proxymodules saltenv=dev
salt '*' saltutil.sync_proxymodules saltenv=base,dev
u proxy( R5 RN ( R RK R R R2 ( ( s9 /usr/lib/python2.7/site-packages/salt/modules/saltutil.pyt sync_proxymodules� s !
c C@ s) t d | | | � } | r% t � n | S( u�
.. versionadded:: 2019.2.0
Sync engine modules from ``salt://_matchers`` to the minion
saltenv
The fileserver environment from which to sync. To sync from more than
one environment, pass a comma-separated list.
If not passed, then all environments configured in the :ref:`top files
<states-top>` will be checked for engines to sync. If no top files are
found, then the ``base`` environment will be synced.
refresh : True
If ``True``, refresh the available execution modules on the minion.
This refresh will be performed even if no new matcher modules are synced.
Set to ``False`` to prevent this refresh.
extmod_whitelist : None
comma-separated list of modules to sync
extmod_blacklist : None
comma-separated list of modules to blacklist based on type
CLI Examples:
.. code-block:: bash
salt '*' saltutil.sync_matchers
salt '*' saltutil.sync_matchers saltenv=base,dev
u matchers( R5 RN ( R RK R R R2 ( ( s9 /usr/lib/python2.7/site-packages/salt/modules/saltutil.pyt
sync_matchers& s
c C@ s) t d | | | � } | r% t � n | S( u�
.. versionadded:: 2016.3.0
Sync engine modules from ``salt://_engines`` to the minion
saltenv
The fileserver environment from which to sync. To sync from more than
one environment, pass a comma-separated list.
If not passed, then all environments configured in the :ref:`top files
<states-top>` will be checked for engines to sync. If no top files are
found, then the ``base`` environment will be synced.
refresh : True
If ``True``, refresh the available execution modules on the minion.
This refresh will be performed even if no new engine modules are synced.
Set to ``False`` to prevent this refresh.
extmod_whitelist : None
comma-seperated list of modules to sync
extmod_blacklist : None
comma-seperated list of modules to blacklist based on type
CLI Examples:
.. code-block:: bash
salt '*' saltutil.sync_engines
salt '*' saltutil.sync_engines saltenv=base,dev
u engines( R5 RN ( R RK R R R2 ( ( s9 /usr/lib/python2.7/site-packages/salt/modules/saltutil.pyt sync_enginesL s
c C@ s) t d | | | � } | r% t � n | S( u�
.. versionadded:: 2018.3.0
Sync Thorium modules from ``salt://_thorium`` to the minion
saltenv
The fileserver environment from which to sync. To sync from more than
one environment, pass a comma-separated list.
If not passed, then all environments configured in the :ref:`top files
<states-top>` will be checked for engines to sync. If no top files are
found, then the ``base`` environment will be synced.
refresh: ``True``
If ``True``, refresh the available execution modules on the minion.
This refresh will be performed even if no new Thorium modules are synced.
Set to ``False`` to prevent this refresh.
extmod_whitelist
comma-seperated list of modules to sync
extmod_blacklist
comma-seperated list of modules to blacklist based on type
CLI Examples:
.. code-block:: bash
salt '*' saltutil.sync_thorium
salt '*' saltutil.sync_thorium saltenv=base,dev
u thorium( R5 RN ( R RK R R R2 ( ( s9 /usr/lib/python2.7/site-packages/salt/modules/saltutil.pyt sync_thoriumr s
c C@ s) t d | | | � } | r% t � n | S( u�
Sync outputters from ``salt://_output`` to the minion
saltenv
The fileserver environment from which to sync. To sync from more than
one environment, pass a comma-separated list.
If not passed, then all environments configured in the :ref:`top files
<states-top>` will be checked for outputters to sync. If no top files
are found, then the ``base`` environment will be synced.
refresh : True
If ``True``, refresh the available execution modules on the minion.
This refresh will be performed even if no new outputters are synced.
Set to ``False`` to prevent this refresh.
extmod_whitelist : None
comma-seperated list of modules to sync
extmod_blacklist : None
comma-seperated list of modules to blacklist based on type
CLI Examples:
.. code-block:: bash
salt '*' saltutil.sync_output
salt '*' saltutil.sync_output saltenv=dev
salt '*' saltutil.sync_output saltenv=base,dev
u output( R5 RN ( R RK R R R2 ( ( s9 /usr/lib/python2.7/site-packages/salt/modules/saltutil.pyt sync_output� s
u sync_outputtersc C@ s) t d | | | � } | r% t � n | S( uG
.. versionadded:: 2017.7.0
Sync cloud modules from ``salt://_cloud`` to the minion
saltenv : base
The fileserver environment from which to sync. To sync from more than
one environment, pass a comma-separated list.
refresh : True
If ``True``, refresh the available execution modules on the minion.
This refresh will be performed even if no new utility modules are
synced. Set to ``False`` to prevent this refresh.
extmod_whitelist : None
comma-seperated list of modules to sync
extmod_blacklist : None
comma-seperated list of modules to blacklist based on type
CLI Examples:
.. code-block:: bash
salt '*' saltutil.sync_clouds
salt '*' saltutil.sync_clouds saltenv=dev
salt '*' saltutil.sync_clouds saltenv=base,dev
u clouds( R5 RN ( R RK R R R2 ( ( s9 /usr/lib/python2.7/site-packages/salt/modules/saltutil.pyt sync_clouds� s
c C@ s) t d | | | � } | r% t � n | S( u#
.. versionadded:: 2014.7.0
Sync utility modules from ``salt://_utils`` to the minion
saltenv
The fileserver environment from which to sync. To sync from more than
one environment, pass a comma-separated list.
If not passed, then all environments configured in the :ref:`top files
<states-top>` will be checked for utility modules to sync. If no top
files are found, then the ``base`` environment will be synced.
refresh : True
If ``True``, refresh the available execution modules on the minion.
This refresh will be performed even if no new utility modules are
synced. Set to ``False`` to prevent this refresh.
extmod_whitelist : None
comma-seperated list of modules to sync
extmod_blacklist : None
comma-seperated list of modules to blacklist based on type
CLI Examples:
.. code-block:: bash
salt '*' saltutil.sync_utils
salt '*' saltutil.sync_utils saltenv=dev
salt '*' saltutil.sync_utils saltenv=base,dev
u utils( R5 RN ( R RK R R R2 ( ( s9 /usr/lib/python2.7/site-packages/salt/modules/saltutil.pyt
sync_utils� s !
c C@ s) t d | | | � } | r% t � n | S( u=
.. versionadded:: 2019.2.0
Sync serializers from ``salt://_serializers`` to the minion
saltenv
The fileserver environment from which to sync. To sync from more than
one environment, pass a comma-separated list.
If not passed, then all environments configured in the :ref:`top files
<states-top>` will be checked for serializer modules to sync. If no top
files are found, then the ``base`` environment will be synced.
refresh : True
If ``True``, refresh the available execution modules on the minion.
This refresh will be performed even if no new serializer modules are
synced. Set to ``False`` to prevent this refresh.
extmod_whitelist : None
comma-seperated list of modules to sync
extmod_blacklist : None
comma-seperated list of modules to blacklist based on type
CLI Examples:
.. code-block:: bash
salt '*' saltutil.sync_serializers
salt '*' saltutil.sync_serializers saltenv=dev
salt '*' saltutil.sync_serializers saltenv=base,dev
u serializers( R5 RN ( R RK R R R2 ( ( s9 /usr/lib/python2.7/site-packages/salt/modules/saltutil.pyt sync_serializers
s !
c C@ s� i } t j j t d d � } t j | � } x� | D]� } t � | | <xd t j j j t j j | | � � D]> \ } } } x, | D]$ } | | j | j
d � d � q� Wqm Wt | | � | | <q5 W| S( u�
.. versionadded:: 2017.7.0
List Salt modules which have been synced externally
CLI Examples:
.. code-block:: bash
salt '*' saltutil.list_extmods
u cachediru extmodsu .i ( R& R' R( R t listdirt setR
R# t os_walkt addR" R ( R2 t ext_dirt mod_typest mod_typet _R) t fh_( ( s9 /usr/lib/python2.7/site-packages/salt/modules/saltutil.pyt list_extmods1 s
4
&c C@ s) t d | | | � } | r% t � n | S( u6
.. versionadded:: 2015.8.0
Sync log handlers from ``salt://_log_handlers`` to the minion
saltenv
The fileserver environment from which to sync. To sync from more than
one environment, pass a comma-separated list.
If not passed, then all environments configured in the :ref:`top files
<states-top>` will be checked for log handlers to sync. If no top files
are found, then the ``base`` environment will be synced.
refresh : True
If ``True``, refresh the available execution modules on the minion.
This refresh will be performed even if no new log handlers are synced.
Set to ``False`` to prevent this refresh.
extmod_whitelist : None
comma-seperated list of modules to sync
extmod_blacklist : None
comma-seperated list of modules to blacklist based on type
CLI Examples:
.. code-block:: bash
salt '*' saltutil.sync_log_handlers
salt '*' saltutil.sync_log_handlers saltenv=dev
salt '*' saltutil.sync_log_handlers saltenv=base,dev
u log_handlers( R5 RN ( R RK R R R2 ( ( s9 /usr/lib/python2.7/site-packages/salt/modules/saltutil.pyt sync_log_handlersI s !
c C@ sO t d d k r t d � � n t d | | | � } | rK t � t � n | S( u
.. versionadded:: 2015.8.11,2016.3.2
Sync pillar modules from the ``salt://_pillar`` directory on the Salt
fileserver. This function is environment-aware, pass the desired
environment to grab the contents of the ``_pillar`` directory from that
environment. The default environment, if none is specified, is ``base``.
refresh : True
Also refresh the execution modules available to the minion, and refresh
pillar data.
extmod_whitelist : None
comma-seperated list of modules to sync
extmod_blacklist : None
comma-seperated list of modules to blacklist based on type
.. note::
This function will raise an error if executed on a traditional (i.e.
not masterless) minion
CLI Examples:
.. code-block:: bash
salt '*' saltutil.sync_pillar
salt '*' saltutil.sync_pillar saltenv=dev
u file_clientu localu7 Pillar modules can only be synced to masterless minionsu pillar( R R R5 RN RV ( R RK R R R2 ( ( s9 /usr/lib/python2.7/site-packages/salt/modules/saltutil.pyt sync_pillarp s
c C@ s� t j d � i } t | t | | � | d <t | t | | � | d <t | t | | � | d <t | t | | � | d <t | | | � | d <t | t | | � | d <t | t | | � | d <t
| t | | � | d <t | t | | � | d
<t | t | | � | d <t
| t | | � | d <t | t | | � | d
<t | t | | � | d <t | t | | � | d <t | t | | � | d <t | t | | � | d <t d d k r�t | t | | � | d <n | r�t � t � n | S( uL
.. versionchanged:: 2015.8.11,2016.3.2
On masterless minions, pillar modules are now synced, and refreshed
when ``refresh`` is set to ``True``.
Sync down all of the dynamic modules from the file server for a specific
environment. This function synchronizes custom modules, states, beacons,
grains, returners, output modules, renderers, and utils.
refresh : True
Also refresh the execution modules and recompile pillar data available
to the minion. This refresh will be performed even if no new dynamic
modules are synced. Set to ``False`` to prevent this refresh.
.. important::
If this function is executed using a :py:func:`module.run
<salt.states.module.run>` state, the SLS file will not have access to
newly synced execution modules unless a ``refresh`` argument is
added to the state, like so:
.. code-block:: yaml
load_my_custom_module:
module.run:
- name: saltutil.sync_all
- refresh: True
See :ref:`here <reloading-modules>` for a more detailed explanation of
why this is necessary.
extmod_whitelist : None
dictionary of modules to sync based on type
extmod_blacklist : None
dictionary of modules to blacklist based on type
CLI Examples:
.. code-block:: bash
salt '*' saltutil.sync_all
salt '*' saltutil.sync_all saltenv=dev
salt '*' saltutil.sync_all saltenv=base,dev
salt '*' saltutil.sync_all extmod_whitelist={'modules': ['custom_module']}
u Syncing allu cloudsu beaconsu modulesu statesu sdbu grainsu renderersu returnersu outputu utilsu log_handlersu proxymodulesu enginesu thoriumu serializersu matchersu file_clientu localu pillar( R/ t debugRb R9 RL RO RP RM RZ R[ R\ Ra Rc Ro R] R_ R` Rd R^ R Rp RN RV ( R RK R R R2 ( ( s9 /usr/lib/python2.7/site-packages/salt/modules/saltutil.pyt sync_all� s0 /
c C@ sB y t d i d � } Wn$ t k
r= t j d � t } n X| S( u�
Signal the minion to refresh the beacons.
CLI Example:
.. code-block:: bash
salt '*' saltutil.refresh_beacons
u
event.fireu beacons_refreshu2 Event module not available. Module refresh failed.( R: R R/ R0 R9 ( R2 ( ( s9 /usr/lib/python2.7/site-packages/salt/modules/saltutil.pyRJ � s
c C@ sB y t d i d � } Wn$ t k
r= t j d � t } n X| S( u�
Signal the minion to refresh its matchers.
CLI Example:
.. code-block:: bash
salt '*' saltutil.refresh_matchers
u
event.fireu matchers_refreshu3 Event module not available. Matcher refresh failed.( R: R R/ R0 R9 ( R2 ( ( s9 /usr/lib/python2.7/site-packages/salt/modules/saltutil.pyt refresh_matchers� s
i c C@ s� y t d i d � } Wn$ t k
r= t j d � t } n X| r� t j j j d d t d t
�} | j d d d | � } | s� | d
t k r� t j d | � q� n | S( u
Signal the minion to refresh the pillar data.
:param wait: Wait for pillar refresh to complete, defaults to False.
:type wait: bool, optional
:param timeout: How long to wait in seconds, only used when wait is True, defaults to 30.
:type timeout: int, optional
:return: Boolean status, True when the pillar_refresh event was fired successfully.
CLI Example:
.. code-block:: bash
salt '*' saltutil.refresh_pillar
u
event.fireu pillar_refreshu2 Event module not available. Module refresh failed.u miniont optst listent tagu+ /salt/minion/minion_pillar_refresh_completet waitu completeu1 Pillar refresh did not complete within timeout %s( R: R R/ R0 R9 R
R# t eventt get_eventR RT t warn( Rw t timeoutR2 t eventert event_ret( ( s9 /usr/lib/python2.7/site-packages/salt/modules/saltutil.pyRV s
! u pillar_refreshc K@ s� t | j d t � � } y~ | r7 t d i d � } n^ t j j j d d t d t �} t d i t d 6d � } t j
d � | j d d
d d � Wn$ t k
r� t j d
� t
} n X| S( u#
Signal the minion to refresh the module and grain data
The default is to refresh module asynchronously. To block
until the module refresh is complete, set the 'async' flag
to False.
CLI Example:
.. code-block:: bash
salt '*' saltutil.refresh_modules
u asyncu
event.fireu module_refreshu minionRt Ru u notifyu6 refresh_modules waiting for module refresh to completeRv u /salt/minion/minion_mod_completeRw i u2 Event module not available. Module refresh failed.( t boolR+ RT R: R
R# Rx Ry R R/ t traceR R0 R9 ( RW t asynchronousR2 R| ( ( s9 /usr/lib/python2.7/site-packages/salt/modules/saltutil.pyRN ( s !
c C@ sR t � } g } x< | D]4 } t j | j d d � | � r | j | � q q W| S( u�
If the named function is running return the data associated with it/them.
The argument can be a glob
CLI Example:
.. code-block:: bash
salt '*' saltutil.is_running state.highstate
u funu ( t runningt fnmatchR+ t append( t funt runR2 t data( ( s9 /usr/lib/python2.7/site-packages/salt/modules/saltutil.pyt
is_runningH s
c C@ s t j j j t � S( u�
Return the data on all running salt processes on the minion
CLI Example:
.. code-block:: bash
salt '*' saltutil.running
( R
R# t minionR� R ( ( ( s9 /usr/lib/python2.7/site-packages/salt/modules/saltutil.pyR� [ s
c C@ s� x� t j j j t d d t �D]g \ } } } xU | D]M } y t j t j j | | � � Wq6 t
k
r� } t j d | � t SXq6 Wq Wt
S( u6
Forcibly removes all caches on a minion.
.. versionadded:: 2014.7.0
WARNING: The safest way to clear a minion cache is by first stopping
the minion and then deleting the cache files before restarting it.
CLI Example:
.. code-block:: bash
salt '*' saltutil.clear_cache
u cachedirt followlinksu@ Attempt to clear cache with saltutil.clear_cache FAILED with: %s( R
R# R) t safe_walkR R9 R& R- R' R( R. R/ R0 RT ( t roott dirsR) t nameR ( ( s9 /usr/lib/python2.7/site-packages/salt/modules/saltutil.pyt clear_cacheh s /
i c C@ s� t j � | d } x� t j j j t j j t d d � d t �D]� \ } } } x| | D]t } yG t j j | | � } t j j
| � } | | k r� t j | � n WqY t
k
r� } t j d | � t SXqY WqC Wt S( uT
Forcibly removes job cache folders and files on a minion.
.. versionadded:: 2018.3.0
WARNING: The safest way to clear a minion cache is by first stopping
the minion and then deleting the cache files before restarting it.
CLI Example:
.. code-block:: bash
salt '*' saltutil.clear_job_cache hours=12
i u cachediru minion_jobsR� uD Attempt to clear cache with saltutil.clear_job_cache FAILED with: %s( t timeR
R# R) R� R& R' R( R R9 t getmtimet shutilt rmtreeR. R/ R0 RT ( t hourst thresholdR� R� R) R� t directoryt mtimeR ( ( s9 /usr/lib/python2.7/site-packages/salt/modules/saltutil.pyt clear_job_cache� s (
c C@ s, x% t � D] } | d | k r
| Sq
Wi S( um
Return the data for a specific job id that is currently running.
jid
The job id to search for and return data.
CLI Example:
.. code-block:: bash
salt '*' saltutil.find_job <job id>
Note that the find_job function only returns job information when the job is still running. If
the job is currently running, the output looks something like this:
.. code-block:: bash
# salt my-minion saltutil.find_job 20160503150049487736
my-minion:
----------
arg:
- 30
fun:
test.sleep
jid:
20160503150049487736
pid:
9601
ret:
tgt:
my-minion
tgt_type:
glob
user:
root
If the job has already completed, the job cannot be found and therefore the function returns
an empty dictionary, which looks like this on the CLI:
.. code-block:: bash
# salt my-minion saltutil.find_job 20160503150049487736
my-minion:
----------
u jid( R� ( t jidR� ( ( s9 /usr/lib/python2.7/site-packages/salt/modules/saltutil.pyt find_job� s .c C@ s t j j t � } t j j t d d � } t j j | t j | � � } t j j | � s~ t j
d � sn d Sd j | � Sn t j j | d � } t j j
j | d � � } | j � } Wd QX| ry | j | � } Wn t k
r� qXt | t � r| Sn d S( u�
Return the data for a specific cached job id. Note this only works if
cache_jobs has previously been set to True on the minion.
CLI Example:
.. code-block:: bash
salt '*' saltutil.find_cached_job <job id>
u cachediru minion_jobsu
cache_jobsuV Local jobs cache directory not found; you may need to enable cache_jobs on this minionu( Local jobs cache directory {0} not foundu return.pu rbN( R
t payloadt SerialR R& R' R( R t text_typet isdirR+ R R# R) R* t readt loadst NameErrorR t dictR ( R� t serialt proc_dirt job_dirR' t fp_t bufR� ( ( s9 /usr/lib/python2.7/site-packages/salt/modules/saltutil.pyt find_cached_job� s$
c C@ sv t t k r t j d � n xSt � D]H} | d | k r& y� t r� x@ t j j j d | d � j d t
� D] } | j | � qn Wn t j
t | d � | � t t k r� d | k r� x+ | d D] } t j
t | � | � q� Wn d j t | � | | d � SWqnt k
rjt j j t d d t j | � � } t j j | � r]t j | � n d
j | � SXq& q& Wd S( u�
Sends a signal to the named salt job's process
CLI Example:
.. code-block:: bash
salt '*' saltutil.signal_job <job id> 15
u| saltutil.signal job called, but psutil is not installed. Install psutil to ensure more reliable and accurate PID management.u jidt pidu pidt recursiveu
child_pidsu% Signal {0} sent to job {1} at pid {2}u cachediru procu9 Job {0} was not running and job data has been cleaned upu ( t
HAS_PSUTILR9 R/ t warningR� R
R# t
psutil_compatt Processt childrenRT t send_signalR& t killt intR R. R' R( R R R� R, R- ( R� t sigR� t procR� R' ( ( s9 /usr/lib/python2.7/site-packages/salt/modules/saltutil.pyt
signal_job� s.
/
%c C@ s t | t j � S( u�
Sends a termination signal (SIGTERM 15) to the named salt job's process
CLI Example:
.. code-block:: bash
salt '*' saltutil.term_job <job id>
( R� t signalt SIGTERM( R� ( ( s9 /usr/lib/python2.7/site-packages/salt/modules/saltutil.pyt term_job s
c C@ s; g } x. t � D]# } | j t | d t j � � q W| S( u�
Sends a termination signal (SIGTERM 15) to all currently running jobs
CLI Example:
.. code-block:: bash
salt '*' saltutil.term_all_jobs
u jid( R� R� R� R� R� ( R2 R� ( ( s9 /usr/lib/python2.7/site-packages/salt/modules/saltutil.pyt
term_all_jobs- s
!c C@ s
t | t � S( u�
Sends a kill signal (SIGKILL 9) to the named salt job's process
CLI Example:
.. code-block:: bash
salt '*' saltutil.kill_job <job id>
( R� t salt_SIGKILL( R� ( ( s9 /usr/lib/python2.7/site-packages/salt/modules/saltutil.pyt kill_job= s c C@ s8 g } x+ t � D] } | j t | d t � � q W| S( u�
Sends a kill signal (SIGKILL 9) to all currently running jobs
CLI Example:
.. code-block:: bash
salt '*' saltutil.kill_all_jobs
u jid( R� R� R� R� ( R2 R� ( ( s9 /usr/lib/python2.7/site-packages/salt/modules/saltutil.pyt
kill_all_jobsL s c C@ s� x\ t j t d � D]G } t j j t d | � } y t j | � Wq t j k
rZ q Xq Wt j j j
j t � } | j � d S( u
Used to regenerate the minion keys.
CLI Example:
.. code-block:: bash
salt '*' saltutil.regen_keys
u pki_dirN(
R& Re R R' R( R- R0 R
t transportt clientt
ReqChannelt factoryt close( t fn_R' t channel( ( s9 /usr/lib/python2.7/site-packages/salt/modules/saltutil.pyt
regen_keys^ s
c C@ s� t � } t } d t k r@ x3 t d D] } | j | � q& Wn | j t d � x� | D]� } t j j j j t d | �} | j j
d � } i d d 6t d d 6| d 6| d 6} z/ y | j | � Wn t k
r� t
} n XWd
| j � XqX W| S( u�
The minion sends a request to the master to revoke its own key.
Note that the minion session will be revoked and the minion may
not be able to return the result of this command back to the master.
If the 'preserve_minion_cache' flag is set to True, the master
cache for this minion will not be removed.
CLI Example:
.. code-block:: bash
salt '*' saltutil.revoke_auth
u master_uri_listu
master_urit
master_uriR
u revoke_authu cmdu idu toku preserve_minion_cacheN( R RT R R� R
R� R� R� R� t autht gen_tokent sendR R9 R� ( t preserve_minion_cachet mastersR2 R� t masterR� t tokt load( ( s9 /usr/lib/python2.7/site-packages/salt/modules/saltutil.pyt revoke_autht s(
c C@ s7 | r! t j j j j | � } n t j j | � } | S( N( R
R� t ssht SSHClientt get_local_client( t cfgfileR� R� ( ( s9 /usr/lib/python2.7/site-packages/salt/modules/saltutil.pyt _get_ssh_or_api_client� s c K@ sh i } d }
d | k rf | j } i | d 6| d 6| d 6| d 6| d 6| d 6| d d 6} | d =n� d | k r� | j } i | d 6| d 6| d 6| d 6| d 6t d
6| d 6| d d 6} | d =n@ | j } i | d 6| d 6| d 6| d 6| d 6| d 6| d 6} | j | � xM | | � D]? }
| j |
� |
d
7}
| d k r!t | � |
k r!Pq!q!W| S( Ni u batchu tgtu funu argu tgt_typeu retu kwargu subsetu cliu subu timeouti u list( t cmd_batcht
cmd_subsetRT t cmd_iterRI t len( R� t tgtR� t argR{ t tgt_typeR2 t kwargRW t fcn_rett seent _cmdt
cmd_kwargst ret_comp( ( s9 /usr/lib/python2.7/site-packages/salt/modules/saltutil.pyt _exec� s2
#
u globu c K@ s6 t d } t | | � }
t |
| | | | | | | | � } d j | d � } | r� | j d j t j j d � � r� t j j | � r� t | | � }
t |
| | | | | | | | � } n d | k r2| i }
} xV |
j � D]E \ } } i t
| t � r| j d d � n d d 6| d 6| | <q� Wn | S(
u%
.. versionchanged:: 2017.7.0
The ``expr_form`` argument has been renamed to ``tgt_type``, earlier
releases must use ``expr_form``.
Assuming this minion is a master, execute a salt command
CLI Example:
.. code-block:: bash
salt '*' saltutil.cmd
u conf_fileu {0}masteri����u {0}{1}u minionu batchu outu highstateu ret(
R R� R� R t endswithR& R' t sept existst itemsR R� R+ ( R� R� R� R{ R� R2 R� R� RW R� R� R� t master_cfgfilet old_rett keyt value( ( s9 /usr/lib/python2.7/site-packages/salt/modules/saltutil.pyt cmd� s$
!!$
(c
k@ ss | r% t j j j j t d � } n t j j t d � } x1 | j | | | | | | | | � D] } | Vq` Wd S( u*
.. versionchanged:: 2017.7.0
The ``expr_form`` argument has been renamed to ``tgt_type``, earlier
releases must use ``expr_form``.
Assuming this minion is a master, execute a salt command
CLI Example:
.. code-block:: bash
salt '*' saltutil.cmd_iter
u conf_fileN( R
R� R� R� R R� R� (
R� R� R� R{ R� R2 R� R� RW R� ( ( s9 /usr/lib/python2.7/site-packages/salt/modules/saltutil.pyR� � s
u basec
K@ s� | d k r g } n | d k r* i } n | j d | � } | j d | � } t j j j | � } | ry | j | � n d t k r� t j j
t j j t d � d � } t j j
| � } t j j | � } n t j j t � } | | j k r-t j j j | j | � }
d |
j k r-| | d <q-n | d k rF| | d
<n | r�t j j j t | i d d 6| d
6| d 6| d 6d d �n | j | d | d | d t d | �S( u[
Execute a runner function. This function must be run on the master,
either by targeting a minion running on a master or by using
salt-call on a master.
.. versionadded:: 2014.7.0
name
The name of the function to run
kwargs
Any keyword arguments to pass to the runner function
CLI Example:
In this example, assume that `master_minion` is a minion running
on a master.
.. code-block:: bash
salt master_minion saltutil.runner jobs.list_jobs
salt master_minion saltutil.runner test.arg arg="['baz']" kwarg="{'foo': 'bar'}"
u __orchestration_jid__u __env__u master_job_cacheu conf_fileu masteru saltenvu state.orchestrateu
state.orchu state.slsu orchestration_jidu runneru typeu nameu argsu kwargst prefixu runR� R� t print_eventt full_returnN( u state.orchestrateu
state.orchu state.sls( R RS R
R# RQ RR RI R R& R' R( t dirnamet configt
master_configt runnert RunnerClientt functionst get_function_argspecRx t fire_argsR� R9 ( R� R� R� R� R R� RW R� t master_optst rclientt aspec( ( s9 /usr/lib/python2.7/site-packages/salt/modules/saltutil.pyR� s@
"
c O@ s� | j d d � } | j d d � } t d d k r� t j j t j j t d � d � } t j j | � } t j
j | � } n t j
j t � } i } i } xC t j
| � D]2 \ }
} |
j d � r� | | |
<q� | | |
<q� Wy� | | j k r1t j j j | j | � } d | j k r1| | d <q1n | rnt j j j t | i d
d 6| d 6| d
6d d �n | j | d | d | d | d t d t �}
Wn t k
r�t d � � n X|
S( u�
Execute a wheel module and function. This function must be run against a
minion that is local to the master.
.. versionadded:: 2014.7.0
name
The name of the function to run
args
Any positional arguments to pass to the wheel function. A common example
of this would be the ``match`` arg needed for key functions.
.. versionadded:: v2015.8.11
kwargs
Any keyword arguments to pass to the wheel function
CLI Example:
.. code-block:: bash
salt my-local-minion saltutil.wheel key.accept jerry
salt my-local-minion saltutil.wheel minions.connected
.. note::
Since this function must be run against a minion that is running locally
on the master in order to get accurate returns, if this function is run
against minions that are not local to the master, "empty" returns are
expected. The remote minion does not have access to wheel functions and
their return data.
u __orchestration_jid__u __env__u baseu __roleu minionu conf_fileu masteru __u saltenvu wheelu typeu nameu argsR� u runR� t pub_dataR� R� R� uL This command can only be executed on a minion that is located on the master.N( RS R R R& R' R( R� R
R� t
client_configt wheelt WheelClientR t iteritemst
startswithR� R# RQ R� Rx R� R� R9 RT R R ( R� RQ RW R� R R� R� t wheel_clientR� t valid_kwargsR� t valR� R2 ( ( s9 /usr/lib/python2.7/site-packages/salt/modules/saltutil.pyR� _ sH #
t _MMinionc B@ s e Z e d � Z RS( c C@ s� d t � k r i a n | t k s* | r� t j t � } | d =t j t � } t j j | � } | a | | j d <| j d | } g | D] } | d ^ q� | j d <| j
� | t | <n t | S( Nu _mminionsu
file_rootsu grainsu /_modulesu module_dirs( t globalst _mminionst copyt deepcopyR R> R
R� t MasterMinionRt t gen_modules( t clsR t
reload_envRt t grainst mt env_rootst fp( ( s9 /usr/lib/python2.7/site-packages/salt/modules/saltutil.pyt __new__� s
$
( t __name__t
__module__R9 R ( ( ( s9 /usr/lib/python2.7/site-packages/salt/modules/saltutil.pyR � s c O@ s t | � } | j | | | � S( u�
Loads minion modules from an environment so that they can be used in pillars
for that environment
CLI Example:
.. code-block:: bash
salt '*' saltutil.mmodule base test.ping
( R R� ( R R� RQ RW t mminion( ( s9 /usr/lib/python2.7/site-packages/salt/modules/saltutil.pyt mmodule� s ( ( (o t __doc__t
__future__R R R R R� t loggingR& R� R8 R� R� R; R RT R6 t ImportErrorR9 t salt.extR t salt.ext.six.moves.urllib.errorR t SIGKILLR� t AttributeErrorR� R
t salt.configt salt.clientt salt.client.ssh.clientt salt.payloadt salt.runnert
salt.statet salt.utils.argst salt.utils.eventt salt.utils.extmodst salt.utils.filest salt.utils.functoolst salt.utils.miniont salt.utils.patht salt.utils.processt salt.utils.urlt
salt.wheelt salt.transport.clientR� t salt.utils.psutil_compatt salt.exceptionsR R R R t __proxyenabled__t getLoggerR R/ R R R5 RI RL RM RO RP RY RZ R[ R\ R] R^ R_ R` Ra R# t functoolst alias_functiont sync_outputtersRb Rc Rd Rn Ro Rp Rr RJ Rs RV t pillar_refreshRN R� R� R� R� R� R� R� R� R� R� R� R� R� R� R� R� R� R� R� t objectR R ( ( ( s9 /usr/lib/python2.7/site-packages/salt/modules/saltutil.pyt <module> s�
" B'$8' !)(&'&&&%#'' ')I
4 $ &
' % - A Y
Mini Shell