All Superinterfaces:

Maskable, ResultLimitable, Service

Enclosing class:

Agent
```
@ApiService("SoftLayer_Monitoring_Agent")
public static interface Agent.Service
extends Service
```
A monitoring agent is a program that resides on a server and does the work of getting details of a system or application and reporting of the metric data and triggers alarms for predefined events.

See Also:

SoftLayer_Monitoring_Agent

Method Summary

Modifier and Type	Method	Description
`Boolean`	`activate()`	This method activates a SoftLayer_Monitoring_Agent.
`Transaction`	`addConfigurationProfile(List<Value> configurationValues)`	This method is used to apply changes to a monitoring agent's configuration for SoftLayer_Configuration_Template_Section with the property sectionType that has a keyName of 'TEMPLATE_SECTION'.
`Transaction`	`applyConfigurationValues(List<Value> configurationValues)`	This method creates a transaction used to apply changes to a monitoring agent's configuration for an array of SoftLayer_Configuration_Template_Section that have the property sectionType with a name of 'Fixed section'.
`Agent.ServiceAsync`	`asAsync()`	Get an async version of this service
`Boolean`	`deactivate()`	This method will deactivate the monitoring agent, preventing it from generating any further alarms.
`Boolean`	`deleteConfigurationProfile(Long sectionId, Long profileId)`	This method will remove a SoftLayer_Configuration_Template_Section_Profile from a SoftLayer_Configuration_Template_Section by passing in the sectionId of the profile object and identifier of the profile.
`Transaction`	`deployMonitoringAgent(Long configurationTemplateId)`	Initialize a monitoring agent and deploy it with the SoftLayer_Configuration_Template with the same identifier as the $configurationTemplateId parameter.
`List<Subscriber>`	`getActiveAlarmSubscribers()`	This method retrieves an array of SoftLayer_Notification_User_Subscriber objects belonging to the SoftLayer_Monitoring_Agent which are able to receive alarm notifications.
`Status`	`getAgentStatus()`	The current status of the corresponding agent
`List<Template>`	`getAvailableConfigurationTemplates()`	This method returns an array of available SoftLayer_Configuration_Template objects for this monitoring agent.
`List<Value>`	`getAvailableConfigurationValues(Long configurationDefinitionId, List<Value> configValues)`	Returns an array of available configuration values that are specific to a server or a Virtual that this monitoring agent is running on.
`List<Profile>`	`getConfigurationProfiles()`	All custom configuration profiles associated with the corresponding agent
`Template`	`getConfigurationTemplate()`	A template of an agent's current configuration which contains information about the structure of the configuration values.
`List<Value>`	`getConfigurationValues()`	The values associated with the corresponding Agent configuration.
`List<Customer>`	`getEligibleAlarmSubscibers()`	This method returns an array of SoftLayer_User_Customer objects, representing those who are allowed to be used as alarm subscribers.
`Outputs`	`getGraph(List<Value> configurationValues, GregorianCalendar beginDate, GregorianCalendar endDate)`	This method returns a SoftLayer_Container_Bandwidth_GraphOutputs object containing a base64 PNG string graph of the provided configuration values for the given begin and end dates.
`List<Data>`	`getGraphData(List<Type> metricDataTypes, GregorianCalendar startDate, GregorianCalendar endDate)`	This method returns the metric data for each of the configuration values provided during the given time range.
`Hardware`	`getHardware()`	SoftLayer hardware related to the agent.
`Agent`	`getObject()`	This method retrieves a monitoring agent whose identifier corresponds to the value provided in the initialization parameter passed to the SoftLayer_Monitoring_Agent service.
`Item`	`getProductItem()`	Contains general information relating to a single SoftLayer product.
`Description`	`getSoftwareDescription()`	A description for a specific installation of a Software Component
`String`	`getStatusName()`	Monitoring agent status name.
`Guest`	`getVirtualGuest()`	Softlayer_Virtual_Guest object related to the monitoring agent, which this virtual guest object and hardware is on the server of the running agent.
`Boolean`	`removeActiveAlarmSubscriber(Long userRecordId)`	Use of this method will allow removing active subscribers from the monitoring agent.
`Boolean`	`removeAllAlarmSubscribers()`	Use of this method will allow removing all subscribers from the monitoring agent.
`Boolean`	`restartMonitoringAgent()`	This method restarts a monitoring agent and sets the agent's status to 'ACTIVE'.
`Boolean`	`setActiveAlarmSubscriber(Long userRecordId)`	This method assigns a user to receive the alerts generated by this SoftLayer_Monitoring_Agent.
`void`	`setMask(Agent.Mask mask)`
`Agent.Mask`	`withMask()`	Use the existing mask on this service or create it if not present
`Agent.Mask`	`withNewMask()`	Overwrite the existing mask on this service with a new one and return it

Methods inherited from interface com.softlayer.api.Maskable
clearMask, setMask, setMask

Methods inherited from interface com.softlayer.api.ResultLimitable
getLastResponseTotalItemCount, getResultLimit, setResultLimit

- Method Detail
  - asAsync
```
Agent.ServiceAsync asAsync()
```
    Description copied from interface: Service
    
    Get an async version of this service
    
    Specified by:
    
    asAsync in interface Service
  - withNewMask
```
Agent.Mask withNewMask()
```
    Description copied from interface: Maskable
    
    Overwrite the existing mask on this service with a new one and return it
    
    Specified by:
    
    withNewMask in interface Maskable
  - withMask
```
Agent.Mask withMask()
```
    Description copied from interface: Maskable
    
    Use the existing mask on this service or create it if not present
    
    Specified by:
    
    withMask in interface Maskable
  - setMask
```
void setMask(Agent.Mask mask)
```
  - activate
```
@ApiMethod(instanceRequired=true)
Boolean activate()
```
    This method activates a SoftLayer_Monitoring_Agent.
    
    See Also:
    
    SoftLayer_Monitoring_Agent::activate
  - addConfigurationProfile
```
@ApiMethod(instanceRequired=true)
Transaction addConfigurationProfile(List<Value> configurationValues)
```
    This method is used to apply changes to a monitoring agent's configuration for SoftLayer_Configuration_Template_Section with the property sectionType that has a keyName of 'TEMPLATE_SECTION'. Configuration values that are passed in can be new or updated objects but must have a definitionId and profileId defined for both. Existing SoftLayer_Monitoring_Agent_Configuration_Value values can be retrieved as a property of the SoftLayer_Configuration_Template_Section_Definition's from the monitoring agent's configurationTemplate property. New values will follow the structure of SoftLayer_Monitoring_Agent_Configuration_Value. It returns a SoftLayer_Provisioning_Version1_Transaction object to track the progress of the update being applied. Some configuration sections act as a template which helps to create additional monitoring configurations. For instance, Core Resource monitoring agent lets you create monitoring configurations for different disk volumes or disk path.
    
    See Also:
    
    SoftLayer_Monitoring_Agent::addConfigurationProfile
  - applyConfigurationValues
```
@ApiMethod(instanceRequired=true)
Transaction applyConfigurationValues(List<Value> configurationValues)
```
    This method creates a transaction used to apply changes to a monitoring agent's configuration for an array of SoftLayer_Configuration_Template_Section that have the property sectionType with a name of 'Fixed section'. Configuration values that are passed in can be new or updated objects but must have a configurationDefinitionId defined for both. Existing SoftLayer_Monitoring_Agent_Configuration_Value values can be retrieved as a property of the SoftLayer_Configuration_Template_Section_Definition from the monitoring agent's configurationTemplate property. New values will follow the structure of SoftLayer_Monitoring_Agent_Configuration_Value. This method returns a SoftLayer_Provisioning_Version1_Transaction object to track the progress of the update being applied.
    
    See Also:
    
    SoftLayer_Monitoring_Agent::applyConfigurationValues
  - deactivate
```
@ApiMethod(instanceRequired=true)
Boolean deactivate()
```
    This method will deactivate the monitoring agent, preventing it from generating any further alarms.
    
    See Also:
    
    SoftLayer_Monitoring_Agent::deactivate
  - deleteConfigurationProfile
```
@ApiMethod(instanceRequired=true)
Boolean deleteConfigurationProfile(Long sectionId,
                                   Long profileId)
```
    This method will remove a SoftLayer_Configuration_Template_Section_Profile from a SoftLayer_Configuration_Template_Section by passing in the sectionId of the profile object and identifier of the profile. This will execute the action immediately on the server and the SoftLayer_Configuration_Template_Section returning a boolean true if successful.
    
    See Also:
    
    SoftLayer_Monitoring_Agent::deleteConfigurationProfile
  - deployMonitoringAgent
```
@ApiMethod(instanceRequired=true)
Transaction deployMonitoringAgent(Long configurationTemplateId)
```
    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.
    
    See Also:
    
    SoftLayer_Monitoring_Agent::deployMonitoringAgent
  - getActiveAlarmSubscribers
```
@ApiMethod(instanceRequired=true)
List<Subscriber> getActiveAlarmSubscribers()
```
    This method retrieves an array of SoftLayer_Notification_User_Subscriber objects belonging to the SoftLayer_Monitoring_Agent which are able to receive alarm notifications.
    
    See Also:
    
    SoftLayer_Monitoring_Agent::getActiveAlarmSubscribers
  - getAvailableConfigurationTemplates
```
@ApiMethod(instanceRequired=true)
List<Template> getAvailableConfigurationTemplates()
```
    This method returns an array of available SoftLayer_Configuration_Template objects for this monitoring agent.
    
    See Also:
    
    SoftLayer_Monitoring_Agent::getAvailableConfigurationTemplates
  - getAvailableConfigurationValues
```
@ApiMethod(instanceRequired=true)
List<Value> getAvailableConfigurationValues(Long configurationDefinitionId,
                                            List<Value> configValues)
```
    Returns an array of available configuration values that are specific to a server or a Virtual that this monitoring agent is running on. For example, invoking this method against "Network Traffic Monitoring Agent" will return all available network adapters on your system.
    
    See Also:
    
    SoftLayer_Monitoring_Agent::getAvailableConfigurationValues
  - getEligibleAlarmSubscibers
```
@ApiMethod(instanceRequired=true)
List<Customer> getEligibleAlarmSubscibers()
```
    This method returns an array of SoftLayer_User_Customer objects, representing those who are allowed to be used as alarm subscribers.
    
    See Also:
    
    SoftLayer_Monitoring_Agent::getEligibleAlarmSubscibers
  - getGraph
```
@ApiMethod(instanceRequired=true)
Outputs getGraph(List<Value> configurationValues,
                 GregorianCalendar beginDate,
                 GregorianCalendar endDate)
```
    This method returns a SoftLayer_Container_Bandwidth_GraphOutputs object containing a base64 PNG string graph of the provided configuration values for the given begin and end dates.
    
    See Also:
    
    SoftLayer_Monitoring_Agent::getGraph
  - getGraphData
```
@ApiMethod(instanceRequired=true)
List<Data> getGraphData(List<Type> metricDataTypes,
                        GregorianCalendar startDate,
                        GregorianCalendar endDate)
```
    This method returns the metric data for each of the configuration values provided during the given time range.
    
    See Also:
    
    SoftLayer_Monitoring_Agent::getGraphData
  - getObject
```
@ApiMethod(instanceRequired=true)
Agent getObject()
```
    This method retrieves a monitoring agent whose identifier corresponds to the value provided in the initialization parameter passed to the SoftLayer_Monitoring_Agent service.
    
    See Also:
    
    SoftLayer_Monitoring_Agent::getObject
  - removeActiveAlarmSubscriber
```
@ApiMethod(instanceRequired=true)
Boolean removeActiveAlarmSubscriber(Long userRecordId)
```
    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.
    
    See Also:
    
    SoftLayer_Monitoring_Agent::removeActiveAlarmSubscriber
  - removeAllAlarmSubscribers
```
@ApiMethod(instanceRequired=true)
Boolean removeAllAlarmSubscribers()
```
    Use of this method will allow removing all subscribers from the monitoring agent. The agent subscribers can be managed within the portal from the "Alarm Subscribers" tab of the monitoring agent configuration.
    
    See Also:
    
    SoftLayer_Monitoring_Agent::removeAllAlarmSubscribers
  - restartMonitoringAgent
```
@ApiMethod(instanceRequired=true)
Boolean restartMonitoringAgent()
```
    This method restarts a monitoring agent and sets the agent's status to 'ACTIVE'.
    
    See Also:
    
    SoftLayer_Monitoring_Agent::restartMonitoringAgent
  - setActiveAlarmSubscriber
```
@ApiMethod(instanceRequired=true)
Boolean setActiveAlarmSubscriber(Long userRecordId)
```
    This method assigns a user to receive the alerts generated by this SoftLayer_Monitoring_Agent.
    
    See Also:
    
    SoftLayer_Monitoring_Agent::setActiveAlarmSubscriber
  - getAgentStatus
```
@ApiMethod(instanceRequired=true)
Status getAgentStatus()
```
    The current status of the corresponding agent
    
    See Also:
    
    SoftLayer_Monitoring_Agent::getAgentStatus
  - getConfigurationProfiles
```
@ApiMethod(instanceRequired=true)
List<Profile> getConfigurationProfiles()
```
    All custom configuration profiles associated with the corresponding agent
    
    See Also:
    
    SoftLayer_Monitoring_Agent::getConfigurationProfiles
  - getConfigurationTemplate
```
@ApiMethod(instanceRequired=true)
Template getConfigurationTemplate()
```
    A template of an agent's current configuration which contains information about the structure of the configuration values.
    
    See Also:
    
    SoftLayer_Monitoring_Agent::getConfigurationTemplate
  - getConfigurationValues
```
@ApiMethod(instanceRequired=true)
List<Value> getConfigurationValues()
```
    The values associated with the corresponding Agent configuration.
    
    See Also:
    
    SoftLayer_Monitoring_Agent::getConfigurationValues
  - getHardware
```
@ApiMethod(instanceRequired=true)
Hardware getHardware()
```
    SoftLayer hardware related to the agent.
    
    See Also:
    
    SoftLayer_Monitoring_Agent::getHardware
  - getProductItem
```
@ApiMethod(instanceRequired=true)
Item getProductItem()
```
    Contains general information relating to a single SoftLayer product.
    
    See Also:
    
    SoftLayer_Monitoring_Agent::getProductItem
  - getSoftwareDescription
```
@ApiMethod(instanceRequired=true)
Description getSoftwareDescription()
```
    A description for a specific installation of a Software Component
    
    See Also:
    
    SoftLayer_Monitoring_Agent::getSoftwareDescription
  - getStatusName
```
@ApiMethod(instanceRequired=true)
String getStatusName()
```
    Monitoring agent status name.
    
    See Also:
    
    SoftLayer_Monitoring_Agent::getStatusName
  - getVirtualGuest
```
@ApiMethod(instanceRequired=true)
Guest getVirtualGuest()
```
    Softlayer_Virtual_Guest object related to the monitoring agent, which this virtual guest object and hardware is on the server of the running agent.
    
    See Also:
    
    SoftLayer_Monitoring_Agent::getVirtualGuest

Interface Agent.Service

Method Summary

Methods inherited from interface com.softlayer.api.Maskable

Methods inherited from interface com.softlayer.api.ResultLimitable

Method Detail

asAsync

withNewMask

withMask

setMask

activate

addConfigurationProfile

applyConfigurationValues

deactivate

deleteConfigurationProfile

deployMonitoringAgent

getActiveAlarmSubscribers

getAvailableConfigurationTemplates

getAvailableConfigurationValues

getEligibleAlarmSubscibers

getGraph

getGraphData

getObject

removeActiveAlarmSubscriber

removeAllAlarmSubscribers

restartMonitoringAgent

setActiveAlarmSubscriber

getAgentStatus

getConfigurationProfiles

getConfigurationTemplate

getConfigurationValues

getHardware

getProductItem

getSoftwareDescription

getStatusName

getVirtualGuest