.\" Man page generated from reStructuredText.
.
.TH "CDIST-TYPE__CONSUL_WATCH_EVENT" "7" "Jun 23, 2019" "5.1.2" "cdist"
.
.nr rst2man-indent-level 0
.
.de1 rstReportMargin
\\$1 \\n[an-margin]
level \\n[rst2man-indent-level]
level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
-
\\n[rst2man-indent0]
\\n[rst2man-indent1]
\\n[rst2man-indent2]
..
.de1 INDENT
.\" .rstReportMargin pre:
. RS \\$1
. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
. nr rst2man-indent-level +1
.\" .rstReportMargin post:
..
.de UNINDENT
. RE
.\" indent \\n[an-margin]
.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
.nr rst2man-indent-level -1
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
.SH NAME
.sp
cdist\-type__consul_watch_event \- Manages consul event watches
.SH DESCRIPTION
.sp
Generate and deploy watch definitions of type \(aqevent\(aq for a consul agent.
See \fI\%http://www.consul.io/docs/agent/watches.html\fP for parameter documentation.
.SH REQUIRED PARAMETERS
.INDENT 0.0
.TP
.B handler
the handler to invoke when the data view updates
.UNINDENT
.SH OPTIONAL PARAMETERS
.INDENT 0.0
.TP
.B datacenter
can be provided to override the agent\(aqs default datacenter
.TP
.B name
restrict the watch to only events with the given name
.TP
.B state
if this watch is \(aqpresent\(aq or \(aqabsent\(aq. Defaults to \(aqpresent\(aq.
.TP
.B token
can be provided to override the agent\(aqs default ACL token
.UNINDENT
.SH EXAMPLES
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
__consul_watch_event some\-id \e
   \-\-handler /usr/bin/my\-handler.sh

__consul_watch_event some\-id \e
   \-\-name web\-deploy \e
   \-\-handler /usr/bin/my\-handler.sh
.ft P
.fi
.UNINDENT
.UNINDENT
.SH SEE ALSO
.sp
\fBcdist\-type__consul_agent\fP(7)
.sp
consul documentation at: <\fI\%http://www.consul.io/docs/agent/watches.html\fP>.
.SH AUTHORS
.sp
Steven Armstrong <\fI\%steven\-cdist\-\-@\-\-armstrong.cc\fP>
.SH COPYING
.sp
Copyright (C) 2015 Steven Armstrong. You can redistribute it
and/or modify it under the terms of the GNU General Public License as
published by the Free Software Foundation, either version 3 of the
License, or (at your option) any later version.
.SH COPYRIGHT
ungleich GmbH 2019
.\" Generated by docutils manpage writer.
.