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

Members

find_job

salt.modules.saltutil.find_job(jid)

Return the data for a specific job id

CLI Example:

salt '*' saltutil.find_job <job id>

kill_job

salt.modules.saltutil.kill_job(jid)

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

CLI Example:

salt '*' saltutil.kill_job <job id>

refresh_pillar

salt.modules.saltutil.refresh_pillar()

Queue the minion to refresh the pillar data.

CLI Example:

salt '*' saltutil.refresh_pillar

running

salt.modules.saltutil.running()

Return the data on all running processes salt on the minion

CLI Example:

salt '*' saltutil.running

signal_job

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

sync_all

salt.modules.saltutil.sync_all(env='base')

Sync down all of the dynamic modules from the file server for a specific environment

CLI Example:

salt '*' saltutil.sync_all

sync_grains

salt.modules.saltutil.sync_grains(env='base')

Sync the grains from the _grains directory on the salt master file server. This function is environment aware, pass the desired environment to grab the contents of the _grains directory, base is the default environment.

CLI Example:

salt '*' saltutil.sync_grains

sync_modules

salt.modules.saltutil.sync_modules(env='base')

Sync the modules from the _modules directory on the salt master file server. This function is environment aware, pass the desired environment to grab the contents of the _modules directory, base is the default environment.

CLI Example:

salt '*' saltutil.sync_modules

sync_renderers

salt.modules.saltutil.sync_renderers(env='base')

Sync the renderers from the _renderers directory on the salt master file server. This function is environment aware, pass the desired environment to grab the contents of the _renderers directory, base is the default environment.

CLI Example:

salt '*' saltutil.sync_renderers

sync_returners

salt.modules.saltutil.sync_returners(env='base')

Sync the returners from the _returners directory on the salt master file server. This function is environment aware, pass the desired environment to grab the contents of the _returners directory, base is the default environment.

CLI Example:

salt '*' saltutil.sync_returners

sync_states

salt.modules.saltutil.sync_states(env='base')

Sync the states from the _states directory on the salt master file server. This function is environment aware, pass the desired environment to grab the contents of the _states directory, base is the default environment.

CLI Example:

salt '*' saltutil.sync_states

term_job

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>