voxel.devices.monitors.list

List all monitors associated with a device, including settings and monitor_id for sending to devices.monitors.enable/disable.

Parameters

device_id (required)
Numeric Voxel device id, available from voxel.devices.list
monitor_id (optional)
Monitor id, available from voxel.devices.monitors.list

Example Response

<rsp stat="ok">
<monitors>
	<monitor id="0000" device_id="0000" state="down" type="mysql_status">
		<ip_address>1.1.1.1</ip_address>
		<staff_notification_level>emergency</staff_notification_level>
		<notification_email>alerts@test.com,dba@test.com</notification_email>
		<notification_delay units="seconds">300</notification_delay>
		<notification_interval units="seconds">0</notification_interval>

		<settings>
			<setting name="is_slave">1</setting>
			<setting name="max_slave_delay" unit="seconds">600</setting>
			<setting name="min_slave_processing_rate" 
				unit="writes/s">30</setting>
			<setting name="max_available_connections_used" 
				unit="percent">50</setting>
		</settings>
	</monitor>
	<monitor id="0000" device_id="0000" state="up" type="ping">
		<ip_address>1.1.1.1<ip_/address>
		<staff_notification_level>emergency</staff_notification_level>
		<notification_delay units="seconds">600</notification_delay>
		<notification_interval units="seconds">0</notification_interval>

		<settings>
			<setting name="max_packet_loss" unit="percent">75</setting>
		</settings>
	</monitor>
	<monitor id="0000" device_id="0000" state="up" type="http">
		<ip_address>1.1.1.1</ip_address>
		<staff_notification_level>emergency</staff_notification_level>
		<notification_delay units="seconds">300</notification_delay>
		<notification_interval units="seconds">3600</notification_interval>
		
		<settings>
			<settings name="ssl">1</settings>
			<settings name="http_request_method">GET</settings>
			<settings name="test_url">/test.php</settings>
			<settings name="hostname">myvirtualhost.com</settings>
			<settings name="username">web_user</settings>
			<settings name="password">htaccess_pw</settings>
			<settings name="response_regex">(?i)test success\s*</settings>
		</settings>
	</monitor>
	<monitor id="0000" device_id="0000" state="warn" type="custom">
		<ip_address>1.1.1.1</ip_address>
		<port>77777</port>
		<staff_notification_level>emergency></staff_notification_level>
		<notification_delay units="seconds">300</notification_delay>
		<notification_interval units="seconds">0</notification_interval>

		<actions>
			<action id="0" type="sendline">hello myapplication</action>
			<action id="1" type="matchregex">^hello client</action>
			<action id="2" type="send">99999\r\n\r\n</action>
			<action id="3" type="matchexact">8888\b</action>
		</actions>
		<settings>
			<setting name="ssl">0</setting>
		</settings>
	</monitor>
	<monitor id="0000" device_id="0000" state="up" type="snmp">
		<ip_address>1.1.1.1</ip_address>
		<staff_notification_level>none</staff>
		<notification_email>user@test.com</notification_email>
		<notification_delay units="seconds">300</notification_delay>
		<notification_interval units="seconds">3600</notification_interval>
		
		<snmp_oids community="readonlycommunity" timeout="2.5">
			<snmp_oid id="0" regex="(?i)ok">.2.3.4.5.6.7.8.9</snmp_oid>
			<snmp_oid id="1" min="10" max="100">.4.5.6.7.8.9.0M/snmp_oid>
		</snmp_oids>
	</monitor>
	<monitor id="0000" device_id="0000" state="disabled" type="server_metrics">
		<ip_address>1.1.1.1</ip_address>
		<staff_notification_level>emergency</staff_notification_level>
		<notification_delay units="seconds">300</notification_delay>
		<notification_interval units="seconds">0</notification_interval>

		<settings>
			<setting name="min_ram_used" unit="MB"/>
			<setting name="max_ram_used" unit="MB"/>
			<setting name="min_vmem_used" unit="MB"/>
			<setting name="max_vmem_used" unit="MB"/>
			<setting name="max_disk_space_used" unit="percent"/>
			<setting name="min_cpu_used" unit="percent"/>
			<setting name="max_cpu_used" unit="percent"/>
			<setting name="min_cpu_io_wait_used" unit="percent"/>
			<setting name="max_cpu_io_wait_used" unit="percent"/>
			<setting name="min_disk_io_usage" unit="bytes/s"/>
			<setting name="max_disk_io_usage" unit="bytes/s"/>
			<setting name="min_disk_io_operations" unit="ops/s"/>
			<setting name="max_disk_io_operations" unit="ops/s"/>
			<setting name="max_system_load">12</setting>
		</settings>
	</monitor>
	
</monitors>
</rsp>

Notes

If you pass in an existing monitor_id, only the information for that monitor will be returned.

Method Specific Error Codes

100: Unknown device
The device_id passed in can't be matched to a valid device.