device

device_xml

The device_xml command returns an xml document containing information about a device. To access the device the user must be a member of the user group assigned to the device.

Syntax

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

cmd	device_xml
user	KNM user username
id	ID number of the device

Returned data

An xml document.

XML fields

DEVICE	Root of tree
NAME	Real name
DESC	Description of the device
IP_ADDRESS	IP address or host name of device
MAC_ADDRESS	MAC address of device (if available)
ACTIVE	YES if device is enabled, NO if disabled
MAINTENANCE	"Available" if user is scheduled and on duty, "n/a" if not on duty or not scheduled
MONITOR	Child to DEVICE
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
INM_ALARM_MESSAGE	Child to MONITOR, shows the last 5 status strings
MESSAGE	Status text
TIME	Time of the entry
STATUS	OK, FAILED or ALARM
INM_GRAPH_LINK	Child to MONITOR, 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

<DEVICE>

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

	<MONITOR>

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

	</MONITOR>

</DEVICE>