From: Martin Schwenke Date: Mon, 23 Jul 2018 04:07:08 +0000 (+1000) Subject: ctdb-docs: Update documentation for "ctdb event" command X-Git-Tag: ldb-1.5.0~96 X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=e3ce1a2dfc4cbba4bf22381b91e9a14c8f240f5d;p=thirdparty%2Fsamba.git ctdb-docs: Update documentation for "ctdb event" command BUG: https://bugzilla.samba.org/show_bug.cgi?id=13551 Signed-off-by: Martin Schwenke Reviewed-by: Amitay Isaacs Autobuild-User(master): Amitay Isaacs Autobuild-Date(master): Sat Jul 28 20:03:52 CEST 2018 on sn-devel-144 --- diff --git a/ctdb/doc/ctdb.1.xml b/ctdb/doc/ctdb.1.xml index 90e532cb689..5c3ce410c0c 100644 --- a/ctdb/doc/ctdb.1.xml +++ b/ctdb/doc/ctdb.1.xml @@ -609,43 +609,36 @@ Interface[2]: Name:eth5 Link:up References:2 (active) status of various events. + + The commands below require a component to be specified. In + the current version the only valid component is + legacy. + + - run EVENT TIMEOUT ARGUMENTS + run TIMEOUT COMPONENT EVENT ARGUMENTS This command can be used to manually run specified EVENT - with optional ARGUMENTS. The event will be allowed to run - a maximum of TIMEOUT seconds. If TIMEOUT is 0, then there - is no time limit for running the event. + in COMPONENT with optional ARGUMENTS. The event will be + allowed to run a maximum of TIMEOUT seconds. If TIMEOUT + is 0, then there is no time limit for running the event. - status EVENT lastrun|lastpass|lastfail + status COMPONENT EVENT This command displays the last execution status of the - specified EVENT. If no event is specified, then the status - of last executed monitor event will be displayed. - - - To see the last successful execution of the event, lastpass - can be specified. Similarly lastfail can be specified - to see the last unsuccessful execution of the event. - The optional lastrun can be specified to query the last - execution of the event. + specified EVENT in COMPONENT. The command will terminate with the exit status corresponding to the overall status of event that is - displayed. If lastpass is specified, then the command will - always terminate with 0. If lastfail is specified then the - command will always terminate with non-zero exit status. - If lastrun is specified, then the command will terminate - with 0 or not depending on if the last execution of the - event was successful or not. + displayed. The output is the list of event scripts executed. @@ -673,59 +666,67 @@ Interface[2]: Name:eth5 Link:up References:2 (active) 60.nfs OK 0.376 Sat Dec 17 19:39:12 2016 70.iscsi OK 0.009 Sat Dec 17 19:39:12 2016 91.lvs OK 0.007 Sat Dec 17 19:39:12 2016 -99.timeout OK 0.007 Sat Dec 17 19:39:12 2016 - script list + script list COMPONENT - List the available event scripts. + List the available event scripts in COMPONENT. Enabled + scripts are flagged with a '*'. + + + Generally, event scripts are provided by CTDB. However, + local or 3rd party event scripts may also be available. + These are shown in a separate section after those + provided by CTDB. Example output: -00.ctdb -01.reclock -05.system -06.nfs -10.interface -11.natgw -11.routing -13.per_ip_routing -20.multipathd -31.clamd -40.vsftpd -41.httpd -49.winbind -50.samba -60.nfs -70.iscsi -91.lvs -99.timeout +* 00.ctdb +* 01.reclock +* 05.system +* 06.nfs +* 10.interface + 11.natgw + 11.routing + 13.per_ip_routing + 20.multipathd + 31.clamd + 40.vsftpd + 41.httpd +* 49.winbind +* 50.samba +* 60.nfs + 70.iscsi + 91.lvs + +* 02.local - script enable SCRIPT + script enable COMPONENT SCRIPT - Enable the specified event SCRIPT. Only enabled scripts will be - executed when running any event. + Enable the specified event SCRIPT in COMPONENT. Only + enabled scripts will be executed when running any event. - script disable SCRIPT + script disable COMPONENT SCRIPT - Disable the specified event SCRIPT. This will prevent the script - from executing when running any event. + Disable the specified event SCRIPT in COMPONENT. This + will prevent the script from executing when running any + event.