removeActiveAlarmSubscriber


SoftLayer_Monitoring_Agent::removeActiveAlarmSubscriber

Removes the selected user from receiving the alarms for this monitoring agent.

Overview

Use of this method will allow removing active subscribers from the monitoring agent. The agent subscribers can be managed within the portal from the “Alarm Subscribers” tab of the monitoring agent configuration.


Parameters

Name Type Description
userRecordId integer A valid numeric SoftLayer_User_Customer::id for a user on your account to be removed

Required Headers

  • authenticate
  • SoftLayer_Monitoring_AgentInitParameters

Return Values

  • boolean

Associated Methods

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.