CDIST-TYPE__CONSUL_WATCH_EVENT(7)

💅 cdist-type__consul_watch_event(7)

okay bestie, welcome to the cdist-type__consul_watch_event page — yes it's a section 7 manual page from the cdist fam, and yes it's lowkey iconic. sit down, grab a strawberry 🍓, and let's get into it.

---

✨ NAME ✨

cdist-type__consul_watch_event — the type that manages consul event watches. that's the whole job. she's focused, she's employed, she's slaying 💅

---

🌸 DESCRIPTION 🌸

so basically: this type generates and deploys watch definitions of type 'event' for a consul agent. that's it, that's the mission. 🎀

and if you want the actual parameter documentation (like, the receipts, the lore, the full syllabus)? it lives over at http://www.consul.io/docs/agent/watches.html. go read it, i'll wait 🦋

---

👑 REQUIRED PARAMETERS 👑

these are non-negotiable, bestie. no skipping.

• handler — the handler to invoke when the data view updates. that's it. that's the requirement. you literally cannot do this without it. periodt.

---

✨ OPTIONAL PARAMETERS ✨

the little extras, the accessories to the outfit, the garnish 🧚

• datacenter — can be provided to override the agent's default datacenter. so like, if you wanna be somewhere else datacenter-wise, say the word.
• name — restrict the watch to only events with the given name. a lil filter moment. narrowing the vibe check down to exactly what you want 🌈
• state — if this watch is 'present' or 'absent'. Defaults to 'present'. so if you want it gone, you gotta say you want it gone 🙈
• token — can be provided to override the agent's default ACL token. handing over a different token, no questions asked 💜

---

🫶 EXAMPLES 🫶

here's how the girlies actually use it. copy these exactly, no cap.

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

and if you're feeling fancy and want to name your event:

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

look at that. beautiful. ate and left no crumbs 🔥

---

💖 SEE ALSO 💖

• cdist-type__consul_agent(7) — her sister, her bestie, her roommate
• consul documentation at: http://www.consul.io/docs/agent/watches.html — the source material, the blueprint, the original text

---

🌟 AUTHORS 🌟

Steven Armstrong <steven-cdist--@--armstrong.cc> — the legend, the icon, the moment 👑

---

📜 COPYING 📜

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. so like, share it, remix it, just keep the license bestie 🫶

---

⭐ COPYRIGHT ⭐

ungleich GmbH 2021

---

fr fr, that's the whole page. every flag, every default, every link, all of it. nothing skipped, nothing invented. iykyk 💅

and that's a wrap on version 7.0.0, dated Jul 31, 2022 — thanks for reading the whole thing, you're literally the main character for that 🎀✨🦋