forked from ungleich-public/cdist
55 lines
1.2 KiB
ReStructuredText
55 lines
1.2 KiB
ReStructuredText
cdist-type__consul_watch_nodes(7)
|
|
=================================
|
|
|
|
NAME
|
|
----
|
|
cdist-type__consul_watch_nodes - Manages consul nodes watches
|
|
|
|
Steven Armstrong <steven-cdist--@--armstrong.cc>
|
|
|
|
|
|
DESCRIPTION
|
|
-----------
|
|
Generate and deploy watch definitions of type 'nodes' 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
|
|
|
|
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_nodes some-id \
|
|
--handler /usr/bin/my-key-handler.sh
|
|
|
|
|
|
SEE ALSO
|
|
--------
|
|
- `cdist-type(7) <cdist-type.html>`_
|
|
- `cdist-type__consul_agent(7) <cdist-type__consul_agent.html>`_
|
|
- http://www.consul.io/docs/agent/watches.html
|
|
|
|
|
|
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).
|