Document new 'exec' parameter.

MFC after:	2 weeks
Obtained from:	Wheel Systems Sp. z o.o. http://www.wheelsystems.com
This commit is contained in:
pjd 2010-08-27 15:20:31 +00:00
parent 74741a8c60
commit 4b6cfc055c

View File

@ -1,4 +1,5 @@
.\" Copyright (c) 2010 The FreeBSD Foundation
.\" Copyright (c) 2010 Pawel Jakub Dawidek <pjd@FreeBSD.org>
.\" All rights reserved.
.\"
.\" This software was developed by Pawel Jakub Dawidek under sponsorship from
@ -27,7 +28,7 @@
.\"
.\" $FreeBSD$
.\"
.Dd August 5, 2010
.Dd August 27, 2010
.Dt HAST.CONF 5
.Os
.Sh NAME
@ -59,6 +60,7 @@ control <addr>
listen <addr>
replication <mode>
timeout <seconds>
exec <path>
on <node> {
# Node section
@ -78,6 +80,7 @@ resource <name> {
name <name>
local <path>
timeout <seconds>
exec <path>
on <node> {
# Resource-node section
@ -203,6 +206,41 @@ replication mode is currently not implemented.
Connection timeout in seconds.
The default value is
.Va 5 .
.It Ic exec Aq path
.Pp
Execute the given program on various HAST events.
Below is the list of currently implemented events and arguments the given
program is executed with:
.Bl -tag -width ".Ic xxxx"
.It Ic "<path> syncstart <resource>"
.Pp
Executed on primary node when synchronization process of secondary node is
started.
.Pp
.It Ic "<path> syncdone <resource>"
.Pp
Executed on primary node when synchronization process of secondary node is
completed successfully.
.Pp
.It Ic "<path> syncintr <resource>"
.Pp
Executed on primary node when synchronization process of secondary node is
interrupted, most likely due to secondary node outage or connection failure
between the nodes.
.Pp
.El
The
.Aq path
argument should contain full path to executable program.
If the given program exits with code different than
.Va 0 ,
.Nm hastd
will log it as an error.
.Pp
The
.Aq resource
argument is resource name from the configuration file.
.Pp
.It Ic name Aq name
.Pp
GEOM provider name that will appear as