deployMonitoringAgent


SoftLayer_Monitoring_Agent::deployMonitoringAgent

Initialize a monitoring agent and deploy it with the specified configuration template.

Overview

Initialize a monitoring agent and deploy it with the SoftLayer_Configuration_Template with the same identifier as the $configurationTemplateId parameter. If the configuration template ID is not provided, the current configuration template will be used. When executing this method, the existing configuration values will be lost. If no configuration template identifier is provided, the current configuration template will be used. “‘Warning”’ Reporting data may be lost as a result of executing this method.


Parameters

Name Type Description
configurationTemplateId integer The numeric identifier for the SoftLayer_Configuration_Template to use when

Required Headers

  • authenticate
  • SoftLayer_Monitoring_AgentInitParameters

Optional Headers

  • SoftLayer_Monitoring_AgentObjectMask
  • SoftLayer_ObjectMask

Return Values

Associated Methods

Error Handling

  • SoftLayer_Exception

Throws ‘Please wait until “{$this->name}” is activated.’ the SoftLayer_Monitoring_Agent_Status::statusCode if this SoftLayer_Monitoring_Agent is ‘PENDING_ACTIVATION’.

  • SoftLayer_Exception

Throws ‘Invalid configuration template id of {$configurationTemplateId}’ if an available SoftLayer_Configuration_Template is not found matching the identifier passed in the $configurationTemplateId.