Monitoring
SoftLayer_Monitoring_Agent::setActiveAlarmSubscriber

Overview

This method assigns a user to receive the alerts generated by this SoftLayer_Monitoring_Agent.

Parameters

userRecordId

integer

A valid SoftLayer_User_Customer::id for a user on your account.

Headers

n/a
authenticate, SoftLayer_Monitoring_AgentInitParameters

Return Values

boolean

Associated Methods

SoftLayer_Monitoring_Agent::getEligibleAlarmSubscibers
SoftLayer_Monitoring_Agent::removeActiveAlarmSubscriber
SoftLayer_Monitoring_Agent::removeAllAlarmSubscribers
SoftLayer_Monitoring_Agent::getActiveAlarmSubscribers

Error Handling

  • SoftLayer_Exception_Public: Throws 'You do not have permission to set this user as an alarm messages recipient.' if no SoftLayer_User_Customer is found, using the provided $userRecordId, associated with the active user's account.