saltstack/salt
1
0
Fork 0
mirror of https://github.com/saltstack/salt.git synced 2025-04-17 10:10:20 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 2

Add documentation on the state_event option

Browse source 
Adds additional documentation on the state_events option to the
Salt Master Events doc
This commit is contained in:
Barney Sowood 2023-01-31 12:40:35 +00:00
parent eb432b2df0
commit 95cc18e6a4
1 changed files with 7 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

9
doc/topics/event/master_events.rst
View file

@ -90,8 +90,13 @@ Job events
.. salt:event:: salt/job/<JID>/prog/<MID>/<RUN NUM>
Fired each time a each function in a state run completes execution. Must be
enabled using the :conf_master:`state_events` option.
Fired each time a each function in a state run completes execution.
Can be enabled for all state runs in the Salt master config with the
:conf_master:`state_events` option. To enable for an individual state
run, pass ``state_events=True`` to the :py:mod:`state <salt.modules.state>`
function being used.
:var data: The data returned from the state module function.
:var id: The minion ID.