XYMONCLIENT.CFG(5)

πŸ’– XYMONCLIENT.CFG β€” xymonclient.cfg πŸ’–

okay bestie, gather round, because this is the file that tells your Xymon client who it is and where it's going πŸ¦‹ it's a page from the File Formats Manual, and honestly? it's giving backstage pass. let's get into it.


✨ NAME ✨

xymonclient.cfg β€” the Xymon client environment variables, aka the group chat settings file for your whole client setup πŸ’…


🌸 DESCRIPTION 🌸

so. Xymon programs don't just use the normal set of environment variables β€” they've got their own extra little stash too πŸ‘‘ and for the Xymon client, all those environment definitions live in the file ~xymon/client/etc/xymonclient.cfg.

every single line in this file looks like:

NAME=VALUE

and that one line defines one environment variable called NAME with the value VALUE. simple. iconic. no cap. ✨


πŸŽ€ SETTINGS πŸŽ€

these are the big ones, the main character variables fr fr:

  • XYMSRV β€” the IP-address used to contact the Xymon server. Default: chosen back when the Xymon client was compiled. so like, it was decided for you at build time, periodt πŸ’€
  • XYMSERVERS β€” a whole list of IP-addresses of Xymon servers πŸ’– your data gets sent to all of the servers listed here. important caveat tho: this setting is only used if XYMSRV=0.0.0.0. iykyk.
  • XYMONDPORT β€” the port number used to contact the Xymon server. Default: 1984.
  • XYMONHOME β€” the Xymon client top-level directory. Default: the $XYMONCLIENTHOME setting inherited from the "runclient.sh" script which starts the Xymon client 🫢
  • XYMONCLIENTLOGS β€” the directory for the Xymon clients' own log files. Default: $XYMONHOME/logs πŸ“
  • XYMONTMP β€” the directory used for temporary files. Default: $XYMONHOME/tmp/ πŸ—‚οΈ
  • XYMON β€” full path to the xymon(1) client program. Default: $XYMONHOME/bin/xymon.

⭐ Commands ⭐

lots of extension scripts expect a whole series of environment variables to point at various system utilities 🌈 and these get included in the file when the client is built. so they're just... there. preloaded. slay.


🧚 INHERITED SETTINGS 🧚

some environment variables are inherited from the "runclient.sh" script which launches the Xymon client β€” like, they're not really defined here, they're handed down, and the file just knows about them:

  • MACHINEDOTS β€” the hostname of the local system. Default: taken from "uname -n".
  • MACHINE β€” the hostname of the local system, but with the dots replaced by commas πŸ¦‹ For compatibility with Big Brother extension scripts.
  • SERVEROSTYPE β€” the operating system of the local system, in lowercase. Default: taken from "uname -s".
  • XYMONCLIENTHOME β€” the top-level directory for the Xymon client. Default: the location of the "runclient.sh" script.

πŸ’œ SEE ALSO πŸ’œ


and that's the whole vibe check bestie, you ate that πŸ“πŸ’…

Xymon β€” Version 4.3.30: 4 Sep 2019 β€” mwah, kisses, go configure something beautiful πŸ’–βœ¨πŸŽ€

πŸ“¦ where this page comes from