SoftLayer Network Monitor Version1 Query Host (type)
From SoftLayer Development Network Wiki
This page refers to the SoftLayer_Network_Monitor_Version1_Query_Host data type. For information on the SoftLayer_Network_Monitor_Version1_Query_Host service please see SoftLayer_Network_Monitor_Version1_Query_Host.
Contents |
Overview
The Monitoring_Query_Host type represents a monitoring instance. It consists of a hardware ID to monitor, an IP address attached to that hardware ID, a method of monitoring, and what to do in the instance that the monitor ever fails.
User Access
Users wishing to access the SoftLayer_Network_Monitor_Version1_Query_Host type must have the Monitoring permission assigned to their account.
| Warning! Even though our API is object based, XML-RPC can only return data as array values. The SOAP implementation treats data as object properties. |
Local Properties
arg1Value
The argument to be used for this monitor, if necessary. The lowest monitoring levels (like ping) ignore this setting, but higher levels like HTTP custom use it.
- Type: string
- Length: 100 characters
hardwareId
The ID of the hardware being monitored
- Type: integer
- Length: 10 digits
id
The unique identifier for this object
- Type: integer
ipAddress
The IP address to be monitored. Must be attached to the hardware on this object
- Type: string
- Length: 100 characters
queryTypeId
The ID of the query type to use.
- Type: integer
- Length: 2 digits
responseActionId
The ID of the response action to take when the monitor fails
- Type: integer
- Length: 8 digits
status
The status of this monitoring instance. Anything other than "ON" means that the monitor has been disabled
- Type: string
- Length: 10 characters
waitCycles
The number of 5-minute cycles to wait before the "responseAction" is taken. If set to 0, the response action will be taken immediately
- Type: integer
- Length: 2 digits
Relational Properties
hardware
The hardware that is being monitored by this monitoring instance
hardware can be queried by object mask.
hardware must be a unique value.
- Type: SoftLayer_Hardware
lastResult
The most recent result for this particular monitoring instance.
lastResult can be queried by object mask.
lastResult must be a unique value.
queryType
The type of monitoring query that is executed when this hardware is monitored.
queryType can be queried by object mask.
queryType must be a unique value.
responseAction
The action taken when a monitor fails.
responseAction can be queried by object mask.
responseAction must be a unique value.
subnet
The subnet object that holds the IP address associated with this query host.
subnet can be queried by object mask.
subnet must be a unique value.
- Type: SoftLayer_Network_Subnet
