object

object_xml

The object_xml command returns a xml document containing information about an object. To access the object the operator must be a member of the operator group assigned to the object.

Syntax

http://localhost:8080/extract.xsi?cmd=object_xml&user=Admin&id=2

cmd	object_xml
user	KNM operator username
id	ID number of the object

Returned data

A xml document.

XML fields

KNM_OBJECT	Root of tree
NAME	Real name
DESC	Description of the object
IP_ADDRESS	IP address or host name of object
MAC_ADDRESS	MAC address of object (if available)
ACTIVE	YES if object is enabled, NO if disabled
MAINTENANCE	"Available" if operator is scheduled and on duty, "n/a" if not on duty or not scheduled
NETWORK_NAME	Name of the network
NETWORK_DESC	Description of the network
NETWORK_CONTACT_NAME	Name of network administrator
NETWORK_CONTACT_ADDRESS1	Contact address of network administrator, line one
NETWORK_CONTACT_ADDRESS2	Contact address of network administrator, line two
NETWORK_CONTACT_PHONE	Network administrator phone number, fixed line
NETWORK_CONTACT_MOBILE	Network administrator phone number, mobile
NETWORK_CONTACT_FAX	Network administrator Fax number
NETWORK_CONTACT_EMAIL	Network administrator email
NETWORK_CONTACT_ADD	Additional information about this network

KNM_AGENT	Child to KNM_OBJECT
NAME	Monitor name
TEST_INTERVAL	Interval between tests, in seconds
ALARM_DELAY	Interval between tests when monitor is in alarm state, in seconds
ALARM_GENERATION	How many consecutive tests that have to fail before an monitor is considered to be in alarm state
LAST_TEST	Time of the most recent test
LAST_OK_TEST	Time of the most recent ok test
LAST_FAILED_TEST	Time of the most recent failed test
TEST_DONE	Number of tests done since last reboot
ACTIVE	YES if monitor is enabled, or NO if disabled
TYPE	Type of monitor
STATUS	State of monitor, can be OK, FAILED or ALARM
STATUS_STRING	The most recent status string
UPTIME	Time that the monitor have been in OK state or ALARM state, when in ALARM state the string is prefixed with a '*' sign
UPTIME_PERCENT*	Uptime for the last calculated period, in percent
DOWNTIME_PERCENT*	Downtime for the last calculated period, in percent
UNKNOWNTIME_PERCENT*	Unknown state for the last calculated period, in percent
PERIOD_FROM*	Start of period
PERIOD_TO*	End of period

* This feature must be enabled with the scheduled event Refresh uptime statistics

KNM_ALARM_MESSAGE	Child to KNM_AGENT, shows the last 5 status strings
MESSAGE	Status text
TIME	Time of the entry
STATUS	OK, FAILED or ALARM

KNM_GRAPH_LINK	Child to KNM_AGENT, contains information about the realtime charts displayed in the monitor information page
LINK	A data extraction link to the chart
DESC	Description of the chart
UNIT	Unit of the Y axis of the chart
PERIOD	Time period of the chart

STATUS_EX	Extended status for SNMP, SSH2 Script, ODBC and WinPerf monitors
STATUS	State of monitor can be OK, FAILED or ALARM
UNIT	User defined unit
COMPARE_VALUE	User defined value that value returned from test is compared with, to evaluate the result of the test.
COMPARE_OPERATION	Operation to compare returned value from test and the user defined compare value. Can be: EQUAL NOT EQUAL GREATER LESS EQUAL OR GREATER EQUAL OR LESS
LAST_VALUE	Last value returned from test.

Example

<KNM_OBJECT>

	<NAME>DOMAINSERVER</NAME>

	<DESC></DESC>

	<IP_ADDRESS>192.168.1.1</IP_ADDRESS>

	<MAC_ADDRESS>00-00-5A-A8-07-D8</MAC_ADDRESS>

	<ACTIVE>YES</ACTIVE>

	<MAINTENANCE>NO</MAINTENANCE>

	<NETWORK_NAME>Office</NETWORK_NAME>

	<NETWORK_DESC>The default network</NETWORK_DESC>

	<NETWORK_CONTACT_NAME></NETWORK_CONTACT_NAME>

	<NETWORK_CONTACT_ADDRESS1></NETWORK_ADDRESS1>

	<NETWORK_CONTACT_ADDRESS2></NETWORK_ADDRESS2>

	<NETWORK_CONTACT_PHONE></NETWORK_PHONE>

	<NETWORK_CONTACT_MOBIL></NETWORK_CONTACT_MOBIL>

	<NETWORK_CONTACT_FAX></NETWORK_FAX>

	<NETWORK_CONTACT_EMAIL></NETWORK_CONTACT_EMAIL>

	<NETWORK_CONTACT_ADD></NETWORK_CONTACT_ADD>

	<KNM_AGENT>

		<NAME>Bandwidth test</NAME>

		<TEST_INTERVAL>10</TEST_INTERVAL>

		<ALARM_DELAY>600</ALARM_DELAY>

		<ALARM_GENERATION>5</ALARM_GENERATION>

		<LAST_TEST>2004-06-10 13:38:55</LAST_TEST>

		<LAST_OK_TEST>2004-06-10 13:38:40</LAST_OK_TEST>

		<TEST_DONE>0</TEST_DONE>

		<ACTIVE>NO</ACTIVE>

		<TYPE>Bandwidth test</TYPE>

		<STATUS>OK</STATUS>

		<STATUS_STRING></STATUS_STRING>

		<UPTIME>23t 4m 45s</UPTIME>

	</KNM_AGENT>

</KNM_OBJECT>

Topic 8726: Send Feedback. Download a PDF of this online book from the first topic in the table of contents. Print this topic.