# salt.modules.saltutil

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

salt.modules.saltutil.clear_cache()

  Forcibly removes all caches on a minion.

  Added in version 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:

      salt '*' saltutil.clear_cache

salt.modules.saltutil.clear_job_cache(hours=24)

  Forcibly removes job cache folders and files on a minion.

  Added in version 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:

      salt '*' saltutil.clear_job_cache hours=12

salt.modules.saltutil.cmd(tgt, fun, arg=(), timeout=None, tgt_type='glob', ret='', kwarg=None, ssh=False, **kwargs)

  Changed in version 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:

      salt '*' saltutil.cmd

salt.modules.saltutil.cmd_iter(tgt, fun, arg=(), timeout=None, tgt_type='glob', ret='', kwarg=None, ssh=False, **kwargs)

  Changed in version 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:

      salt '*' saltutil.cmd_iter

salt.modules.saltutil.find_cached_job(jid)

  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:

      salt '*' saltutil.find_cached_job <job id>

salt.modules.saltutil.find_job(jid)

  Return the data for a specific job id that is currently running.

  jid

    The job id to search for and return data.

  CLI Example:

      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:

      # 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:

      # salt my-minion saltutil.find_job 20160503150049487736
      my-minion:
          ----------

salt.modules.saltutil.is_running(fun)

  If the named function is running return the data associated with it/them. The argument can be a glob

  CLI Example:

      salt '*' saltutil.is_running state.highstate

salt.modules.saltutil.kill_all_jobs()

  Sends a kill signal (SIGKILL 9) to all currently running jobs

  CLI Example:

      salt '*' saltutil.kill_all_jobs

salt.modules.saltutil.kill_job(jid)

  Sends a kill signal (SIGKILL 9) to the named salt job's process

  CLI Example:

      salt '*' saltutil.kill_job <job id>

salt.modules.saltutil.list_extmods()

  Added in version 2017.7.0.

  List Salt modules which have been synced externally

  CLI Examples:

      salt '*' saltutil.list_extmods

salt.modules.saltutil.mmodule(saltenv, fun, *args, **kwargs)

  Loads minion modules from an environment so that they can be used in pillars for that environment

  CLI Example:

      salt '*' saltutil.mmodule base test.ping

salt.modules.saltutil.pillar_refresh(wait=False, timeout=30, clean_cache=True)

  This function is an alias of `refresh_pillar`.

  Signal the minion to refresh the in-memory pillar data. See In-Memory Pillar Data vs. On-Demand Pillar Data.

  Parameters:

    - wait (bool, optional) -- Wait for pillar refresh to complete, defaults to False.

    - timeout (int, optional) -- How long to wait in seconds, only used when wait is True, defaults to 30.

    - clean_cache (bool, optional .. versionadded:: 3005) -- Clean the pillar cache, only used when pillar_cache is True. Defaults to True

  Returns:

    Boolean status, True when the pillar_refresh event was fired successfully.

  CLI Example:

      salt '*' saltutil.refresh_pillar
      salt '*' saltutil.refresh_pillar wait=True timeout=60

salt.modules.saltutil.refresh_beacons()

  Signal the minion to refresh the beacons.

  CLI Example:

      salt '*' saltutil.refresh_beacons

salt.modules.saltutil.refresh_grains(**kwargs)

  Added in version 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_pillarTrue

    Set to `False` to keep pillar data from being refreshed.

  clean_pillar_cacheFalse

    Set to `True` to refresh pillar cache.

  CLI Examples:

      salt '*' saltutil.refresh_grains

salt.modules.saltutil.refresh_matchers()

  Signal the minion to refresh its matchers.

  CLI Example:

      salt '*' saltutil.refresh_matchers

salt.modules.saltutil.refresh_modules(**kwargs)

  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:

      salt '*' saltutil.refresh_modules

salt.modules.saltutil.refresh_pillar(wait=False, timeout=30, clean_cache=True)

  Signal the minion to refresh the in-memory pillar data. See In-Memory Pillar Data vs. On-Demand Pillar Data.

  Parameters:

    - wait (bool, optional) -- Wait for pillar refresh to complete, defaults to False.

    - timeout (int, optional) -- How long to wait in seconds, only used when wait is True, defaults to 30.

    - clean_cache (bool, optional .. versionadded:: 3005) -- Clean the pillar cache, only used when pillar_cache is True. Defaults to True

  Returns:

    Boolean status, True when the pillar_refresh event was fired successfully.

  CLI Example:

      salt '*' saltutil.refresh_pillar
      salt '*' saltutil.refresh_pillar wait=True timeout=60

salt.modules.saltutil.regen_keys()

  Used to regenerate the minion keys.

  CLI Example:

      salt '*' saltutil.regen_keys

salt.modules.saltutil.revoke_auth(preserve_minion_cache=False)

  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:

      salt '*' saltutil.revoke_auth

salt.modules.saltutil.runner(name, arg=None, kwarg=None, full_return=False, saltenv='base', jid=None, **kwargs)

  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.

  Added in version 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.

      salt master_minion saltutil.runner jobs.list_jobs
      salt master_minion saltutil.runner test.arg arg="['baz']" kwarg="{'foo': 'bar'}"

salt.modules.saltutil.running()

  Return the data on all running salt processes on the minion

  CLI Example:

      salt '*' saltutil.running

salt.modules.saltutil.signal_job(jid, sig)

  Sends a signal to the named salt job's process

  CLI Example:

      salt '*' saltutil.signal_job <job id> 15

salt.modules.saltutil.sync_all(saltenv=None, refresh=True, extmod_whitelist=None, extmod_blacklist=None, clean_pillar_cache=False)

  Changed in version 3007.0: On masterless minions, master top modules are now synced as well. When `refresh` is set to `True`, this module's cache containing the environments from which extension modules are synced when `saltenv` is not specified will be refreshed.

  Changed in version 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.

  refreshTrue

    Also refresh the execution modules and recompile pillar data available to the minion. If this is a masterless minion, also refresh the environments from which extension modules are synced after syncing master tops. 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 `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:

      load_my_custom_module:
        module.run:
          - name: saltutil.sync_all
          - refresh: True

  See here for a more detailed explanation of why this is necessary.

  extmod_whitelistNone

    dictionary of modules to sync based on type

  extmod_blacklistNone

    dictionary of modules to blacklist based on type

  clean_pillar_cacheFalse

    Set to `True` to refresh pillar cache.

  CLI Examples:

      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']}

salt.modules.saltutil.sync_beacons(saltenv=None, refresh=True, extmod_whitelist=None, extmod_blacklist=None)

  Added in version 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 top files will be checked for beacons to sync. If no top files are found, then the `base` environment will be synced.

  refreshTrue

    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_whitelistNone

    comma-separated list of modules to sync

  extmod_blacklistNone

    comma-separated list of modules to blacklist based on type

  CLI Example:

      salt '*' saltutil.sync_beacons
      salt '*' saltutil.sync_beacons saltenv=dev
      salt '*' saltutil.sync_beacons saltenv=base,dev

salt.modules.saltutil.sync_clouds(saltenv=None, refresh=True, extmod_whitelist=None, extmod_blacklist=None)

  Added in version 2017.7.0.

  Sync cloud modules from `salt://_cloud` to the minion

  saltenvbase

    The fileserver environment from which to sync. To sync from more than one environment, pass a comma-separated list.

  refreshTrue

    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_whitelistNone

    comma-separated list of modules to sync

  extmod_blacklistNone

    comma-separated list of modules to blacklist based on type

  CLI Examples:

      salt '*' saltutil.sync_clouds
      salt '*' saltutil.sync_clouds saltenv=dev
      salt '*' saltutil.sync_clouds saltenv=base,dev

salt.modules.saltutil.sync_engines(saltenv=None, refresh=False, extmod_whitelist=None, extmod_blacklist=None)

  Added in version 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 top files will be checked for engines to sync. If no top files are found, then the `base` environment will be synced.

  refreshTrue

    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_whitelistNone

    comma-separated list of modules to sync

  extmod_blacklistNone

    comma-separated list of modules to blacklist based on type

  CLI Examples:

      salt '*' saltutil.sync_engines
      salt '*' saltutil.sync_engines saltenv=base,dev

salt.modules.saltutil.sync_executors(saltenv=None, refresh=True, extmod_whitelist=None, extmod_blacklist=None)

  Added in version 3000.

  Sync executors from `salt://_executors` 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 top files will be checked for log handlers to sync. If no top files are found, then the `base` environment will be synced.

  refreshTrue

    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_whitelistNone

    comma-seperated list of modules to sync

  extmod_blacklistNone

    comma-seperated list of modules to blacklist based on type

  CLI Examples:

      salt '*' saltutil.sync_executors
      salt '*' saltutil.sync_executors saltenv=dev
      salt '*' saltutil.sync_executors saltenv=base,dev

salt.modules.saltutil.sync_grains(saltenv=None, refresh=True, extmod_whitelist=None, extmod_blacklist=None, clean_pillar_cache=False)

  Added in version 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 top files will be checked for grains modules to sync. If no top files are found, then the `base` environment will be synced.

  refreshTrue

    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_whitelistNone

    comma-separated list of modules to sync

  extmod_blacklistNone

    comma-separated list of modules to blacklist based on type

  clean_pillar_cacheFalse

    Set to `True` to refresh pillar cache.

  CLI Examples:

      salt '*' saltutil.sync_grains
      salt '*' saltutil.sync_grains saltenv=dev
      salt '*' saltutil.sync_grains saltenv=base,dev

salt.modules.saltutil.sync_log_handlers(saltenv=None, refresh=True, extmod_whitelist=None, extmod_blacklist=None)

  Added in version 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 top files will be checked for log handlers to sync. If no top files are found, then the `base` environment will be synced.

  refreshTrue

    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_whitelistNone

    comma-separated list of modules to sync

  extmod_blacklistNone

    comma-separated list of modules to blacklist based on type

  CLI Examples:

      salt '*' saltutil.sync_log_handlers
      salt '*' saltutil.sync_log_handlers saltenv=dev
      salt '*' saltutil.sync_log_handlers saltenv=base,dev

salt.modules.saltutil.sync_matchers(saltenv=None, refresh=False, extmod_whitelist=None, extmod_blacklist=None)

  Added in version 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 top files will be checked for engines to sync. If no top files are found, then the `base` environment will be synced.

  refreshTrue

    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_whitelistNone

    comma-separated list of modules to sync

  extmod_blacklistNone

    comma-separated list of modules to blacklist based on type

  CLI Examples:

      salt '*' saltutil.sync_matchers
      salt '*' saltutil.sync_matchers saltenv=base,dev

salt.modules.saltutil.sync_modules(saltenv=None, refresh=True, extmod_whitelist=None, extmod_blacklist=None)

  Added in version 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 top files will be checked for execution modules to sync. If no top files are found, then the `base` environment will be synced.

  refreshTrue

    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 `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:

      load_my_custom_module:
        module.run:
          - name: saltutil.sync_modules
          - refresh: True

  See here for a more detailed explanation of why this is necessary.

  extmod_whitelistNone

    comma-separated list of modules to sync

  extmod_blacklistNone

    comma-separated list of modules to blacklist based on type

  CLI Example:

      salt '*' saltutil.sync_modules
      salt '*' saltutil.sync_modules saltenv=dev
      salt '*' saltutil.sync_modules saltenv=base,dev

salt.modules.saltutil.sync_output(saltenv=None, refresh=True, extmod_whitelist=None, extmod_blacklist=None)

  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 top files will be checked for outputters to sync. If no top files are found, then the `base` environment will be synced.

  refreshTrue

    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_whitelistNone

    comma-separated list of modules to sync

  extmod_blacklistNone

    comma-separated list of modules to blacklist based on type

  CLI Examples:

      salt '*' saltutil.sync_output
      salt '*' saltutil.sync_output saltenv=dev
      salt '*' saltutil.sync_output saltenv=base,dev

salt.modules.saltutil.sync_outputters(saltenv=None, refresh=True, extmod_whitelist=None, extmod_blacklist=None)

  This function is an alias of `sync_output`.

  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 top files will be checked for outputters to sync. If no top files are found, then the `base` environment will be synced.

  refreshTrue

    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_whitelistNone

    comma-separated list of modules to sync

  extmod_blacklistNone

    comma-separated list of modules to blacklist based on type

  CLI Examples:

      salt '*' saltutil.sync_output
      salt '*' saltutil.sync_output saltenv=dev
      salt '*' saltutil.sync_output saltenv=base,dev

salt.modules.saltutil.sync_pillar(saltenv=None, refresh=True, extmod_whitelist=None, extmod_blacklist=None, clean_pillar_cache=False)

  Added in version 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`.

  refreshTrue

    Also refresh the execution modules available to the minion, and refresh pillar data.

  extmod_whitelistNone

    comma-separated list of modules to sync

  extmod_blacklistNone

    comma-separated list of modules to blacklist based on type

  clean_pillar_cacheFalse

    Set to `True` to refresh pillar cache.

  Note

  This function will raise an error if executed on a traditional (i.e. not masterless) minion

  CLI Examples:

      salt '*' saltutil.sync_pillar
      salt '*' saltutil.sync_pillar saltenv=dev

salt.modules.saltutil.sync_proxymodules(saltenv=None, refresh=False, extmod_whitelist=None, extmod_blacklist=None)

  Added in version 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 top files will be checked for proxy modules to sync. If no top files are found, then the `base` environment will be synced.

  refreshTrue

    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_whitelistNone

    comma-separated list of modules to sync

  extmod_blacklistNone

    comma-separated list of modules to blacklist based on type

  CLI Examples:

      salt '*' saltutil.sync_proxymodules
      salt '*' saltutil.sync_proxymodules saltenv=dev
      salt '*' saltutil.sync_proxymodules saltenv=base,dev

salt.modules.saltutil.sync_renderers(saltenv=None, refresh=True, extmod_whitelist=None, extmod_blacklist=None)

  Added in version 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 top files will be checked for renderers to sync. If no top files are found, then the `base` environment will be synced.

  refreshTrue

    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.

  extmod_whitelistNone

    comma-separated list of modules to sync

  extmod_blacklistNone

    comma-separated list of modules to blacklist based on type

  CLI Examples:

      salt '*' saltutil.sync_renderers
      salt '*' saltutil.sync_renderers saltenv=dev
      salt '*' saltutil.sync_renderers saltenv=base,dev

salt.modules.saltutil.sync_returners(saltenv=None, refresh=True, extmod_whitelist=None, extmod_blacklist=None)

  Added in version 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 top files will be checked for returners to sync. If no top files are found, then the `base` environment will be synced.

  refreshTrue

    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_whitelistNone

    comma-separated list of modules to sync

  extmod_blacklistNone

    comma-separated list of modules to blacklist based on type

  CLI Examples:

      salt '*' saltutil.sync_returners
      salt '*' saltutil.sync_returners saltenv=dev

salt.modules.saltutil.sync_sdb(saltenv=None, extmod_whitelist=None, extmod_blacklist=None)

  Added in version 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 top files will be checked for sdb modules to sync. If no top files are found, then the `base` environment will be synced.

  extmod_whitelistNone

    comma-separated list of modules to sync

  extmod_blacklistNone

    comma-separated list of modules to blacklist based on type

  CLI Example:

      salt '*' saltutil.sync_sdb
      salt '*' saltutil.sync_sdb saltenv=dev
      salt '*' saltutil.sync_sdb saltenv=base,dev

salt.modules.saltutil.sync_serializers(saltenv=None, refresh=True, extmod_whitelist=None, extmod_blacklist=None)

  Added in version 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 top files will be checked for serializer modules to sync. If no top files are found, then the `base` environment will be synced.

  refreshTrue

    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_whitelistNone

    comma-seperated list of modules to sync

  extmod_blacklistNone

    comma-seperated list of modules to blacklist based on type

  CLI Examples:

      salt '*' saltutil.sync_serializers
      salt '*' saltutil.sync_serializers saltenv=dev
      salt '*' saltutil.sync_serializers saltenv=base,dev

salt.modules.saltutil.sync_states(saltenv=None, refresh=True, extmod_whitelist=None, extmod_blacklist=None)

  Added in version 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 top files will be checked for state modules to sync. If no top files are found, then the `base` environment will be synced.

  refreshTrue

    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_whitelistNone

    comma-separated list of modules to sync

  extmod_blacklistNone

    comma-separated list of modules to blacklist based on type

  CLI Examples:

      salt '*' saltutil.sync_states
      salt '*' saltutil.sync_states saltenv=dev
      salt '*' saltutil.sync_states saltenv=base,dev

salt.modules.saltutil.sync_thorium(saltenv=None, refresh=False, extmod_whitelist=None, extmod_blacklist=None)

  Added in version 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 top files 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-separated list of modules to sync

  extmod_blacklist

    comma-separated list of modules to blacklist based on type

  CLI Examples:

      salt '*' saltutil.sync_thorium
      salt '*' saltutil.sync_thorium saltenv=base,dev

salt.modules.saltutil.sync_tops(saltenv=None, refresh=True, extmod_whitelist=None, extmod_blacklist=None)

  Added in version 3007.0.

  Sync master tops from `salt://_tops` 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 top files will be checked for master tops to sync. If no top files are found, then the `base` environment will be synced.

  refreshTrue

    Refresh this module's cache containing the environments from which extension modules are synced when `saltenv` is not specified. This refresh will be performed even if no new master tops are synced. Set to `False` to prevent this refresh.

  extmod_whitelistNone

    comma-separated list of modules to sync

  extmod_blacklistNone

    comma-separated 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:

      salt '*' saltutil.sync_tops
      salt '*' saltutil.sync_tops saltenv=dev

salt.modules.saltutil.sync_utils(saltenv=None, refresh=True, extmod_whitelist=None, extmod_blacklist=None)

  Added in version 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 top files will be checked for utility modules to sync. If no top files are found, then the `base` environment will be synced.

  refreshTrue

    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_whitelistNone

    comma-separated list of modules to sync

  extmod_blacklistNone

    comma-separated list of modules to blacklist based on type

  CLI Examples:

      salt '*' saltutil.sync_utils
      salt '*' saltutil.sync_utils saltenv=dev
      salt '*' saltutil.sync_utils saltenv=base,dev

salt.modules.saltutil.sync_wrapper(saltenv=None, refresh=True, extmod_whitelist=None, extmod_blacklist=None)

  Added in version 3007.0.

  Sync salt-ssh wrapper modules from `salt://_wrapper` 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 top files will be checked for wrappers to sync. If no top files are found, then the `base` environment will be synced.

  refreshTrue

    If `True`, refresh the available wrapper modules on the minion. This refresh will be performed even if no wrappers are synced. Set to `False` to prevent this refresh.

  extmod_whitelistNone

    comma-seperated list of modules to sync

  extmod_blacklistNone

    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:

      salt '*' saltutil.sync_wrapper
      salt '*' saltutil.sync_wrapper saltenv=dev
      salt '*' saltutil.sync_wrapper saltenv=base,dev

salt.modules.saltutil.term_all_jobs()

  Sends a termination signal (SIGTERM 15) to all currently running jobs

  CLI Example:

      salt '*' saltutil.term_all_jobs

salt.modules.saltutil.term_job(jid)

  Sends a termination signal (SIGTERM 15) to the named salt job's process

  CLI Example:

      salt '*' saltutil.term_job <job id>

salt.modules.saltutil.update(version=None)

  Update the salt minion from the URL defined in opts['update_url'] Broadcom, Inc provides the latest builds here: update_url: https://packages.broadcom.com/artifactory/saltproject-generic/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:

      salt '*' saltutil.update
      salt '*' saltutil.update 0.10.3

salt.modules.saltutil.wheel(name, *args, **kwargs)

  Execute a wheel module and function. This function must be run against a minion that is local to the master.

  Added in version 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.

    Added in version 2015.8.11.

  kwargs

    Any keyword arguments to pass to the wheel function

  CLI Example:

      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.