Control the state system on the minion.
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.
New in version 2015.5.0.
Apply states! This function will call highstate or state.sls based on the arguments passed in, state.apply is intended to be the main gateway for all state executions.
CLI Example:
salt '*' state.apply
salt '*' state.apply test
salt '*' state.apply test,pkgs
New in version 2015.5.0.
Return the state request information, if any
CLI Example:
salt '*' state.check_request
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:
salt '*' state.clear_cache
New in version 2015.5.0.
Clear out the state execution request without executing it
CLI Example:
salt '*' state.clear_request
Disable state runs.
CLI Example:
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
Enable state function or sls run
CLI Example:
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
Execute the compound calls stored in a single set of high data This function is mostly intended for testing the state system
CLI Example:
salt '*' state.high '{"vim": {"pkg": ["installed"]}}'
Retrieve the state data from the salt master for this minion and execute it
Notify states to execute in test-only (dry-run) mode.
Sets the test variable in the minion opts for the duration of the state run.
Instead of failing immediately when another state run is in progress, queue the new state run to begin running once the other has finished.
This option starts a new thread for each queued state run so use this option sparingly.
CLI Example:
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!'}"
List the states which are currently disabled
CLI Example:
salt '*' state.list_disabled
Execute a single low data call This function is mostly intended for testing the state system
CLI Example:
salt '*' state.low '{"state": "pkg", "fun": "installed", "name": "vi"}'
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:
salt '*' state.pkg /tmp/state_pkg.tgz
New in version 2015.5.0.
Request that the local admin execute a state run via salt-call state.run_request All arguments match state.apply
CLI Example:
salt '*' state.request
salt '*' state.request test
salt '*' state.request test,pkgs
New in version 2015.5.0.
Execute the pending state request
CLI Example:
salt '*' state.run_request
Return a dict of 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:
salt '*' state.running
Retrieve the highstate data from the salt master and display it
Custom Pillar data can be passed with the pillar kwarg.
CLI Example:
salt '*' state.show_highstate
Display the low data from a specific sls. The default environment is base, use saltenv (env in Salt 0.17.x and older) to specify a different environment.
CLI Example:
salt '*' state.show_low_sls foo
List out the low data that will be applied to this minion
CLI Example:
salt '*' state.show_lowstate
Display the state data from a specific sls or list of sls files on the master. The default environment is base, use saltenv (env in Salt 0.17.x and older) 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.
CLI Example:
salt '*' state.show_sls core,edit.vim dev
Return the top data that the minion will use for a highstate
CLI Example:
salt '*' state.show_top
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:
salt '*' state.single pkg.installed name=vim
Execute a set list of state files from an environment.
Notify states to execute in test-only (dry-run) mode.
Sets the test variable in the minion opts for the duration of the state run.
Instead of failing immediately when another state run is in progress, queue the new state run to begin running once the other has finished.
This option starts a new thread for each queued state run so use this option sparingly.
Specify a file_roots environment.
Changed in version 0.17.0: Argument name changed from env to saltenv.
Changed in version 2014.7: Defaults to None. If no saltenv is specified, the minion config will be checked for a saltenv and if found, it will be used. If none is found, base will be used.
CLI Example:
salt '*' state.sls core,edit.vim dev
salt '*' state.sls core exclude="[{'id': 'id_to_exclude'}, {'sls': 'sls_to_exclude'}]"
salt '*' state.sls myslsfile pillar="{foo: 'Foo!', bar: 'Bar!'}"
Call a single ID from the named module(s) and handle all requisites
New in version 2014.7.0.
CLI Example:
salt '*' state.sls_id apache http
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:
salt '*' state.template '<Path to template on the minion>'
Execute the information stored in a string from an sls template
CLI Example:
salt '*' state.template_str '<Template String>'
Execute a specific top file instead of the default
CLI Example:
salt '*' state.top reverse_top.sls
salt '*' state.top reverse_top.sls exclude=sls_to_exclude
salt '*' state.top reverse_top.sls exclude="[{'id': 'id_to_exclude'}, {'sls': 'sls_to_exclude'}]"
Docs for previous releases are available on readthedocs.org.
Latest Salt release: 2015.5.2