salt.modules.state

Control the state system on the minion

Members

high

salt.modules.state.high(data)

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

highstate

salt.modules.state.highstate(test=None, **kwargs)

Retrive the state data from the salt master for this minion and execute it

CLI Example:

salt '*' state.highstate

low

salt.modules.state.low(data)

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

show_highstate

salt.modules.state.show_highstate()

Retrieve the highstate data from the salt master and display it

CLI Example:

salt '*' state.show_highstate

show_lowstate

salt.modules.state.show_lowstate()

List out the low data that will be applied to this minion

CLI Example:

salt '*' state.show_lowstate

show_masterstate

salt.modules.state.show_masterstate()

Display the data gathered from the master compiled state

CLI Example:

salt '*' state.show_masterstate

show_sls

salt.modules.state.show_sls(mods, env='base', test=None, **kwargs)

Display the state data from a specific sls or list of sls files on the master

CLI Example:

salt '*' state.sls core,edit.vim dev

single

salt.modules.state.single(fun=None, test=None, **kwargs)

Execute a single state function with the named kwargs, returns False if insufficient data is sent to the command

CLI Example:

salt '*' state.single pkg.installed name=vim

sls

salt.modules.state.sls(mods, env='base', test=None, **kwargs)

Execute a set list of state modules from an environment, default environment is base

CLI Example:

salt '*' state.sls core,edit.vim dev

template

salt.modules.state.template(tem)

Execute the information stored in a template file on the minion

CLI Example:

salt '*' state.template '<Path to template on the minion>'

template_str

salt.modules.state.template_str(tem)

Execute the information stored in a template file on the minion

CLI Example:

salt '*' state.template_str '<Template String>'

top

salt.modules.state.top(topfn)

Execute a specific top file instead of the default

CLI Example:

salt '*' state.top reverse_top.sls

Parent topic

Table Of Contents

Previous topic

salt.modules.ssh

Next topic

salt.modules.status