summaryrefslogtreecommitdiffstats
path: root/doc/client/tools/actions.txt
diff options
context:
space:
mode:
Diffstat (limited to 'doc/client/tools/actions.txt')
-rw-r--r--doc/client/tools/actions.txt23
1 files changed, 16 insertions, 7 deletions
diff --git a/doc/client/tools/actions.txt b/doc/client/tools/actions.txt
index e5fdb1f39..52d07eb4f 100644
--- a/doc/client/tools/actions.txt
+++ b/doc/client/tools/actions.txt
@@ -28,18 +28,17 @@ so they can be centrally observed. Actions look like:
Note that the status attribute tells the bcfg2 client to ignore
return status, causing failures to still not be centrally reported. If
central reporting of action failure is desired, set this attribute to
-'check'. Also note that Action entries included in Base will not be
-executed.
+'check'.
-Actions may be completely defined inside of a bundle with the use of
-:ref:`server-configurationentries`, much like Packages, Services or Paths.
-The Rules plugin can also bind these entries. For example to include the
-above action in a bundle, first the Action entry must be included in the
+Actions may be completely defined inside of a bundle with the use of
+:ref:`server-configurationentries`, much like Packages, Services or Paths.
+The Rules plugin can also bind these entries. For example to include the
+above action in a bundle, first the Action entry must be included in the
bundle:
.. code-block:: xml
- <Bundle name='bundle_name'>
+ <Bundle>
...
<Action name='action_name'/>
</Bundle>
@@ -56,6 +55,16 @@ Then a corresponding entry must be included in the Rules directory, like:
This allows different clients to get different actions as a part of the
same bundle based on group membership.
+It is also possible to do this in one step in the bundle itself with a
+``BoundAction`` tag, e.g.:
+
+.. code-block:: xml
+
+ <Bundle>
+ <BoundAction timing='post' when='modified' name='action_name'
+ command='/path/to/command arg1 arg2' status='ignore'/>
+ </Rules>
+
Example Action (add APT keys)
=============================