SoftLayer Network Monitor Version1 Query Host

From SoftLayer Development Network Wiki

Jump to: navigation, search

This page refers to the SoftLayer_Network_Monitor_Version1_Query_Host service. For information on the SoftLayer_Network_Monitor_Version1_Query_Host data type please see SoftLayer_Network_Monitor_Version1_Query_Host (type).

Contents

Overview

The Query_Host service is the core of the monitoring system. Each instance of this service represents a monitoring instance. Each monitoring instance 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.

The monitoring services are scheduled jobs, and cannot be initiated by the user. Simply creating the object is enough, the monitor will begin working in 5-10 minutes. Deleting a monitor will immediately remove it from the monitoring queue. Modifications will take effect in 5-10 minutes.

If the user wishes to be notified, or have other users on the account notified when a monitoring instance fails, a response type that includes "notify users" must be included on the query host object, and a SoftLayer_User_Customer_Notification_Hardware instance must be saved linking the desired users to the hardware being monitored. In order for users to be notified, a SoftLayer_User_Customer_Notification_Hardware object MUST exist linking them to a hardware object, and a monitoring instance on that hardware object must be set to "notify users"

Endpoints

SOAP WSDL http://api.service.softlayer.com/soap/v3/SoftLayer_Network_Monitor_Version1_Query_Host?wsdl
XML-RPC http://api.service.softlayer.com/xmlrpc/v3/SoftLayer_Network_Monitor_Version1_Query_Host

Methods

createObject

Create a monitoring entry

  • returns
SoftLayer_Core_Orm
  • parameters
SoftLayer_Network_Monitor_Version1_Query_Host templateObject


createObjects

Create multiple monitoring entries at once

  • returns
SoftLayer_Dns_DomainArray
  • parameters
SoftLayer_Network_Monitor_Version1_Query_HostArray templateObjects


deleteObject

Delete a Query_Host object by passing in a version of it

  • returns
bool
  • parameters
None


deleteObjects

Delete a group of Query_Host objects by passing in a collection of them

  • returns
bool
  • parameters
SoftLayer_Network_Monitor_Version1_Query_HostArray templateObjects


editObject

Edit the object by passing in a modified instance of the object

  • returns
bool
  • parameters
SoftLayer_Network_Monitor_Version1_Query_Host templateObject


editObjects

Edit a group of Query_Host objects by passing in a collection of them.

  • returns
bool
  • parameters
SoftLayer_Network_Monitor_Version1_Query_HostArray templateObjects


findByHardwareId

Return all monitoring instances associated with the passed hardware ID

  • returns
SoftLayer_Network_Monitor_Version1_Query_HostArray
  • parameters
int hardwareId


getHardware

Retrieve the hardware that is being monitored by this monitoring instance

  • returns
SoftLayer_Hardware
  • parameters
None


getObject

Retrieve a SoftLayer_Network_Monitor_Version1_Query_Host record.

  • returns
SoftLayer_Network_Monitor_Version1_Query_Host
  • parameters
None


getQueryType

Retrieve the type of monitoring query that is executed when this hardware is monitored.

  • returns
SoftLayer_Network_Monitor_Version1_Query_Type
  • parameters
None


getResponseAction

Retrieve the action taken when a monitor fails.

  • returns
SoftLayer_Network_Monitor_Version1_Query_ResponseType
  • parameters
None
Retrieved from "http://sldn.softlayer.com/wiki/index.php/SoftLayer_Network_Monitor_Version1_Query_Host"
Personal tools