salt.modules.state

### Navigation

- index
- modules |
- next |
- previous |
- « SaltStack.org |
- Documentation home
- Full list of builtin execution modules »

# salt.modules.state

Control the state system on the minion

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

`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

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

`salt.modules.state.` `running`()

  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

`salt.modules.state.` `show_highstate`()

  Retrieve the highstate data from the salt master and display it

  CLI Example:

      salt '*' state.show_highstate

`salt.modules.state.` `show_lowstate`()

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

  CLI Example:

      salt '*' state.show_lowstate

`salt.modules.state.` `show_masterstate`()

  Display the data gathered from the master compiled state

  CLI Example:

      salt '*' state.show_masterstate

`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.show_sls core,edit.vim dev

`salt.modules.state.` `single`(fun, name, test=None, kwval_as='yaml', **kwargs)

  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

`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

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

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

`salt.modules.state.` `top`(topfn)

  Execute a specific top file instead of the default

  CLI Example:

      salt '*' state.top reverse_top.sls

## Comments

comments powered by Disqus

### Navigation

- index
- modules |
- next |
- previous |
- « SaltStack.org |
- Documentation home
- Full list of builtin execution modules »