Package com.softlayer.api.service.monitoring

Interface Robot.Service

All Superinterfaces:

Maskable, ResultLimitable, Service

Enclosing class:

Robot

@ApiService("SoftLayer_Monitoring_Robot")
public static interface Robot.Service
extends Service

A monitoring robot is a set of essential agents that lets SoftLayer monitoring management system to communicate with a server, a Cloud Computing Instance or a Bare Metal Instance.

A monitoring robot must be installed in order for any monitoring agent to report monitoring data to a SoftLayer monitoring hub system.

TCP ports from 48000 to 48020 should be open on your server or cloud instance for advanced monitoring robots and agents.

See Also:

SoftLayer_Monitoring_Robot

Method Summary

Modifier and Type	Method	Description
Robot.ServiceAsync	asAsync()	Get an async version of this service
Boolean	checkConnection()	Checks if a monitoring robot can communicate with SoftLayer monitoring management system via the private network.
Transaction	deployMonitoringAgents(Group configurationTemplateGroup)
Account	getAccount()	The account associated with the corresponding robot.
List<Group>	getAvailableConfigurationGroups()	Returns available configuration template groups for this monitoring agent.
List<Agent>	getMonitoringAgents()	The program (monitoring agent) that gets details of a system or application and reporting of the metric data and triggers alarms for predefined events.
Robot	getObject()
Status	getRobotStatus()	The current status of the robot.
Component	getSoftwareComponent()	The SoftLayer_Software_Component that corresponds to the robot installation on the server.
Boolean	resetStatus()	If our monitoring management system is not able to connect to your monitoring robot, it sets the robot status to "Limited Connectivity".
void	setMask(Robot.Mask mask)
Robot.Mask	withMask()	Use the existing mask on this service or create it if not present
Robot.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

Robot.ServiceAsync asAsync()

Description copied from interface: Service

Get an async version of this service

Specified by:

asAsync in interface Service

withNewMask

Robot.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

Robot.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(Robot.Mask mask)

checkConnection

@ApiMethod(instanceRequired=true)
Boolean checkConnection()

Checks if a monitoring robot can communicate with SoftLayer monitoring management system via the private network.

TCP port 48000 - 48002 must be open on your server or your virtual server in order for this test to succeed.

See Also:

SoftLayer_Monitoring_Robot::checkConnection

deployMonitoringAgents

@ApiMethod(instanceRequired=true)
Transaction deployMonitoringAgents(Group configurationTemplateGroup)

See Also:

SoftLayer_Monitoring_Robot::deployMonitoringAgents

getAvailableConfigurationGroups

@ApiMethod(instanceRequired=true)
List<Group> getAvailableConfigurationGroups()

Returns available configuration template groups for this monitoring agent.

See Also:

SoftLayer_Monitoring_Robot::getAvailableConfigurationGroups

getObject

@ApiMethod(instanceRequired=true)
Robot getObject()

See Also:

SoftLayer_Monitoring_Robot::getObject

resetStatus

@ApiMethod(instanceRequired=true)
Boolean resetStatus()

If our monitoring management system is not able to connect to your monitoring robot, it sets the robot status to "Limited Connectivity". Robots in this status will not be process by our monitoring management system. You cannot manage monitoring agents either.

Use this method to resets monitoring robot status to "Active" to indicate the connection issue is resolved.

See Also:

SoftLayer_Monitoring_Robot::resetStatus

getAccount

@ApiMethod(instanceRequired=true)
Account getAccount()

The account associated with the corresponding robot.

See Also:

SoftLayer_Monitoring_Robot::getAccount

getMonitoringAgents

@ApiMethod(instanceRequired=true)
List<Agent> getMonitoringAgents()

The program (monitoring agent) that gets details of a system or application and reporting of the metric data and triggers alarms for predefined events.

See Also:

SoftLayer_Monitoring_Robot::getMonitoringAgents

getRobotStatus

@ApiMethod(instanceRequired=true)
Status getRobotStatus()

The current status of the robot.

See Also:

SoftLayer_Monitoring_Robot::getRobotStatus

getSoftwareComponent

@ApiMethod(instanceRequired=true)
Component getSoftwareComponent()

The SoftLayer_Software_Component that corresponds to the robot installation on the server.

See Also:

SoftLayer_Monitoring_Robot::getSoftwareComponent