bionic (5) xymon-xmh.5.gz

Provided by: xymon_4.3.28-3build1_amd64 bug

NAME

       Xymon-XMH-variables - Configuration items available online

DESCRIPTION

       The  hosts.cfg(5) file is the most important configuration file for all of the Xymon programs.  This file
       contains the full list of all the systems monitored by Xymon,  including  the  set  of  tests  and  other
       configuration items stored for each host.

       Although the file is in text format and can be searched using tools like xymongrep(1) it can be difficult
       to pick out specific fields from the configuration due to quoting and  other  text  parsing  issues.   So
       Xymon allows for querying this information directly from the xymond daemon via the "xymondboard" command.
       So the information can be provided together with the current status of a host and/or test. This  is  done
       by adding a "fields" definition to the "xymondboard" command.

XMH items

       Except  where specified below, all items return the text of a particular setting from the hosts.cfg file,
       or an empty string if the setting has not been set for the host that is queried.

       XMH_ALLPAGEPATHS
              List of all 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 reported by a Xymon client), 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 (group, group-only, group-except)  in  which
              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 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, 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" atg.

       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
              Number of the group where the host is listed - first group is 0.  If a host is present 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.

       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).

       XMH_NKTIME
              Value of the NKTIME tag (deprecated).

       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 reported by a Xymon client), or the value of the OS tag.

       XMH_PAGEINDEX
              Index of the host on the page where it is shown, first host has index 0.

       XMH_PAGENAME
              Name of the page where the host is shown (see also XMH_PAGEPATH).

       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
              All 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

       xymon(1), hosts.cfg(5), xymongrep(1)