XYMON-XMH(5)

📦 version 4.3.30, in debian bookworm, debian trixie, ubuntu jammy, ubuntu noble, ubuntu questing, ubuntu resolute, ubuntu stonking

okay so bestie — welcome to Xymon-XMH-variables, straight outta the File Formats Manual. this is your group chat with the xymond daemon, fr fr. 💖

🌸 NAME 🌸

Xymon-XMH-variables — configuration items available online. that's the whole vibe. 👑

✨ DESCRIPTION ✨

okay so first thing: the hosts.cfg(5) file is THE most important config file for literally every single Xymon program. no cap. it holds the full list of all the systems Xymon monitors, plus the set of tests and other config items stored for each host. it's the main character of config files, periodt. 💅

so the file is plain text, which is great, and you can search it with stuff like xymongrep(1) — but ngl, picking specific fields out of it is kind of a nightmare because of quoting and other text-parsing drama. 😭 so Xymon lets you ask for this info directly from the xymond daemon using the "xymondboard" command. that way the info can come back together with the current status of a host and/or test. and how do you do that? you add a "fields" definition to the "xymondboard" command. iconic. ✨

🎀 XMH items 🎀

except where it says otherwise below, every item returns the text of a particular setting from the hosts.cfg file — or an empty string if that setting hasn't been set for the host you're querying. no setting, no tea, empty string, moving on. 🫶

  • XMH_ALLPAGEPATHS — list of all the pages where the host is found, using the filename hierarchy page path. 🦋
  • XMH_BROWSER — value of the "browser" tag.
  • XMH_CLASS — the host class (if a Xymon client reported it), or the value of the CLASS tag.
  • XMH_CLIENTALIAS — value of the CLIENT tag.
  • XMH_COMMENT — value of the COMMENT tag.
  • XMH_COMPACT — value of the COMPACT tag.
  • XMH_DEPENDS — value of the DEPENDS tag.
  • XMH_DESCRIPTION — value of the DESCR tag.
  • XMH_DGNAME — the text string from the hosts.cfg "group" definition (that's group, group-only, group-except) where the host is defined. 📂
  • XMH_DISPLAYNAME — value of the NAME tag.
  • XMH_DOCURL — value of the DOC tag.
  • XMH_DOWNTIME — value of the DOWNTIME tag.
  • XMH_PULLDATA — value of the PULLDATA tag (including IP:PORT, if there is any). 🍓
  • XMH_FLAG_DIALUP — value of the "dialup" tag.
  • XMH_FLAG_HIDEHTTP — value of the HIDEHTTP tag.
  • XMH_FLAG_LDAPFAILYELLOW — value of the "ldapyellowfail" tag.
  • XMH_FLAG_MULTIHOMED — value of the MULTIHOMED tag.
  • XMH_FLAG_NOBB2 — value of the "nobb2" tag. > ⚠️ deprecated bestie — use NONONGREEN instead.
  • XMH_FLAG_NOCLEAR — value of the NOCLEAR tag.
  • XMH_FLAG_NOCLIENT — value of the "noclient" tag.
  • XMH_FLAG_NOCONN — value of the "noconn" tag.
  • XMH_FLAG_NODISP — value of the "nodisp" tag.
  • XMH_FLAG_NOINFO — value of the "noinfo" tag.
  • XMH_FLAG_NONONGREEN — value of the "nonongreen" tag.
  • XMH_FLAG_NOPING — value of the "noping" tag.
  • XMH_FLAG_NOSSLCERT — value of the "nosslcert" tag.
  • XMH_FLAG_NOTRACE — value of the "notrace" tag.
  • XMH_FLAG_NOTRENDS — value of the "notrends" tag.
  • XMH_FLAG_PREFER — value of the "prefer" tag.
  • XMH_FLAG_TESTIP — value of the "testip" tag.
  • XMH_FLAG_TRACE — value of the "trace" tag.
  • XMH_GROUPID — the number of the group where the host is listed — first group is 0. and if a host shows up on multiple pages, this is the number of the group for the first page where the host is found. 🔢
  • XMH_HOLIDAYS — value of the "holidays" tag.
  • XMH_HOSTNAME — the name of the host. yes, the whole point. 💀
  • XMH_HTTPHEADERS — value of the "httphdr" tag.
  • XMH_IP — the IP-address of the host (as specified in hosts.cfg).
  • XMH_LDAPLOGIN — value of the "ldaplogin" tag.
  • XMH_NET — value of the NET tag.
  • XMH_NK — value of the NK tag. > ⚠️ deprecated, just so you know.
  • XMH_NKTIME — value of the NKTIME tag. > ⚠️ also deprecated. both of these are giving "old era" ngl.
  • XMH_NOCOLUMNS — value of the NOCOLUMNS tag.
  • XMH_NOPROP — value of the NOPROP tag.
  • XMH_NOPROPACK — value of the NOPROPACK tag.
  • XMH_NOPROPPURPLE — value of the NOPROPPURPLE tag.
  • XMH_NOPROPRED — value of the NOPROPRED tag.
  • XMH_NOPROPYELLOW — value of the NOPROPYELLOW tag.
  • XMH_NOTAFTER — value of the NOTAFTER tag.
  • XMH_NOTBEFORE — value of the NOTBEFORE tag.
  • XMH_OS — the host operating system (if a Xymon client reported it), or the value of the OS tag. 🌈
  • XMH_PAGEINDEX — the index of the host on the page where it's shown — the first host has index 0. 🔢
  • XMH_PAGENAME — name of the page where the host is shown (peep XMH_PAGEPATH too, they're a duo). 🫶
  • XMH_PAGEPATH — file path to the page where the host is shown.
  • XMH_PAGEPATHTITLE — title of the full path to the page where the host is shown.
  • XMH_PAGETITLE — title of the page where the host is shown.
  • XMH_RAW — literally all the configuration settings for the host. settings are separated by a pipe-sign (|). 🔥
  • XMH_REPORTTIME — value of the REPORTTIME tag.
  • XMH_SSLDAYS — value of the "ssldays" tag.
  • XMH_SSLMINBITS — value of the "sslbits" tag.
  • XMH_TRENDS — value of the TRENDS tag.
  • XMH_WARNPCT — value of the WARNPCT tag.
  • XMH_WARNSTOPS — value of the WARNSTOPS tag.
  • XMH_WML — value of the WML tag.

🌈 SEE ALSO 🌈

and that's the whole page bestie, you ate it. 💅 this whole thing ships under the Xymon name, Version 4.3.30, dated 4 Sep 2019 — and the manual itself is XYMON-XMH(5). go forth and query your hosts, mwah. 💖✨🎀

📦 where this page comes from