vici: Document the ike/child-updown events
authorTobias Brunner <tobias@strongswan.org>
Fri, 29 May 2015 16:43:15 +0000 (18:43 +0200)
committerTobias Brunner <tobias@strongswan.org>
Mon, 17 Aug 2015 09:12:17 +0000 (11:12 +0200)
src/libcharon/plugins/vici/README.md

index db7ce4e..1421ab4 100644 (file)
@@ -738,6 +738,29 @@ information during an active_list-authorities_ command.
                }
        }
 
+### ike-updown ###
+
+The _ike-updown_ event is issued when an IKE_SA is established or terminated.
+
+       {
+               up = <yes or no>
+               <IKE_SA config name> = {
+                       <same data as in the list-sas event, but without child-sas section>
+               }
+       }
+
+### child-updown ###
+
+The _child-updown_ event is issued when a CHILD_SA is established or terminated.
+
+       {
+               up = <yes or no>
+               <IKE_SA config name> = {
+                       <same data as in the list-sas event, but with only the affected
+                        CHILD_SA in the child-sas section>
+               }
+       }
+
 # libvici C client library #
 
 libvici is the reference implementation of a C client library implementing