This state is intended for use from the Salt Master. It provides access to sending commands down to minions as well as access to executing master-side modules. These state functions wrap Salt's Python API.
salt.states.saltmod.
function
(name, tgt, ssh=False, tgt_type=None, expr_form=None, ret='', expect_minions=False, fail_minions=None, fail_function=None, arg=None, kwarg=None, timeout=None)¶Execute a single module function on a remote minion via salt or salt-ssh
salt.states.saltmod.
runner
(name, **kwargs)¶Execute a runner module on the master
New in version 2014.7.
salt.states.saltmod.
state
(name, tgt, ssh=False, tgt_type=None, expr_form=None, ret='', highstate=None, sls=None, top=None, env=None, test=False, pillar=None, expect_minions=False, fail_minions=None, allow_fail=0, concurrent=False, timeout=None)¶Invoke a state run on a given target
test=true
through to the state functionpillar
kwarg through to the state functionAllow multiple state runs to occur at once.
WARNING: This flag is potentially dangerous. It is designed for use when multiple state runs can safely be run at the same Do not use this flag for performance optimization.
Examples:
Run a list of sls files via state.sls
on target
minions:
webservers:
salt.state:
- tgt: 'web*'
- sls:
- apache
- django
- core
- saltenv: prod
Run a full state.highstate
on target
mininons.
databases:
salt.state:
- tgt: role:database
- tgt_type: grain
- highstate: True
salt.states.saltmod.
wait_for_event
(name, id_list, event_id='id', timeout=300)¶Watch Salt's event bus and block until a condition is met
New in version 2014.7.
event_id
, if found it is removed from id_list
. When id_list
is empty this function returns success.id
for the minion
ID, another common value is name
for use with orchestrating
salt-cloud events.The following example blocks until all the listed minions complete a restart and reconnect to the Salt master:
reboot_all_minions:
salt.function:
- name: system.reboot
- tgt: '*'
wait_for_reboots:
salt.wait_for_event:
- name: salt/minion/*/start
- id_list:
- jerry
- stuart
- dave
- phil
- kevin
- mike
- require:
- salt: reboot_all_minions
salt.states.saltmod.
wheel
(name, **kwargs)¶Execute a wheel module on the master
New in version 2014.7.
accept_minion_key:
salt.wheel:
- name: key.accept
- match: frank