SoftLayer User Customer Notification Hardware

From SoftLayer Development Network Wiki

Jump to: navigation, search

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

Contents

Overview

This service represents the link between a monitored hardware instance, and a user account.

When a monitoring service on that hardware instance fails and the monitor is set to "notify users," any users linked to that hardware instance using this service will be notified of the failure.

Endpoints

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

Methods

createObject

Create a user hardware notification entry

  • returns
SoftLayer_User_Customer_Notification_Hardware
  • parameters
SoftLayer_User_Customer_Notification_Hardware templateObject
SoftLayer_User_Customer_Notification_Hardware templateObject



createObjects

Create multiple user hardware notification entries at once

  • returns
SoftLayer_Dns_DomainArray
  • parameters
SoftLayer_User_Customer_Notification_HardwareArray templateObjects



deleteObjects

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

  • returns
boolean
  • parameters
SoftLayer_User_Customer_Notification_HardwareArray templateObjects



findByHardwareId

Return all hardware notifications associated with the passed hardware ID

  • returns
SoftLayer_User_Customer_Notification_HardwareArray
  • parameters
integer hardwareId



getHardware

Retrieve the hardware object that will be monitored.

  • returns
SoftLayer_Hardware
  • parameters
None



getObject

Retrieve a SoftLayer_User_Customer_Notification_Hardware record.

  • returns
SoftLayer_User_Customer_Notification_Hardware
  • parameters
None



getUser

Retrieve the user that will be notified when the associated hardware object fails a monitoring instance.

  • returns
SoftLayer_User_Customer
  • parameters
None
Personal tools