cdist/cdist/conf/type/__consul_watch_event/man.rst

cdist-type__consul_watch_event(7)
=================================

NAME
----
cdist-type__consul_watch_event - Manages consul event watches


DESCRIPTION
-----------
Generate and deploy watch definitions of type 'event' for a consul agent.
See http://www.consul.io/docs/agent/watches.html for parameter documentation.


REQUIRED PARAMETERS
-------------------
handler
   the handler to invoke when the data view updates


OPTIONAL PARAMETERS
-------------------
datacenter
   can be provided to override the agent's default datacenter

name
   restrict the watch to only events with the given name

state
   if this watch is 'present' or 'absent'. Defaults to 'present'.

token
   can be provided to override the agent's default ACL token


EXAMPLES
--------

.. code-block:: sh

    __consul_watch_event some-id \
       --handler /usr/bin/my-handler.sh

    __consul_watch_event some-id \
       --name web-deploy \
       --handler /usr/bin/my-handler.sh


SEE ALSO
--------
`cdist-type__consul_agent(7) <cdist-type__consul_agent.html>`_

Full documentation at: <:cdist_docs:`index`>,
especially cdist type chapter: <:cdist_docs:`cdist-type`>.
consul documentation at:
<http://www.consul.io/docs/agent/watches.html>.


AUTHORS
-------
Steven Armstrong <steven-cdist--@--armstrong.cc>


COPYING
-------
Copyright \(C) 2015 Steven Armstrong. Free use of this software is
granted under the terms of the GNU General Public License version 3 (GPLv3).