Class: Softlayer::Monitoring::Agent

Inherits:
Entity show all
Defined in:
lib/softlayer/monitoring/agent.rb,
lib/softlayer/monitoring/agent/status.rb,
lib/softlayer/monitoring/agent/configuration.rb,
lib/softlayer/monitoring/agent/configuration/value.rb,
lib/softlayer/monitoring/agent/configuration/template.rb,
lib/softlayer/monitoring/agent/configuration/template/group.rb,
lib/softlayer/monitoring/agent/configuration/template/group/reference.rb

Defined Under Namespace

Modules: Configuration Classes: Representer, Status

Constant Summary collapse

SERVICE =
'SoftLayer_Monitoring_Agent'

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from Softlayer::Model

all, all_request_for, create, find, #init_headers, parse, request, #request, service_name, #service_name, #to_hash

Methods included from Softlayer::Model::Operations

extended, #filter, included, #limit, #mask, #request_headers

Instance Attribute Details

#agent_statusObject

Returns the value of attribute agent_status.



17
18
19
# File 'lib/softlayer/monitoring/agent.rb', line 17

def agent_status
  @agent_status
end

#configuration_profile_countObject

Returns the value of attribute configuration_profile_count.



15
16
17
# File 'lib/softlayer/monitoring/agent.rb', line 15

def configuration_profile_count
  @configuration_profile_count
end

#configuration_profilesObject

Returns the value of attribute configuration_profiles.



18
19
20
# File 'lib/softlayer/monitoring/agent.rb', line 18

def configuration_profiles
  @configuration_profiles
end

#configuration_templateObject

Returns the value of attribute configuration_template.



19
20
21
# File 'lib/softlayer/monitoring/agent.rb', line 19

def configuration_template
  @configuration_template
end

#configuration_template_idObject

Returns the value of attribute configuration_template_id.



7
8
9
# File 'lib/softlayer/monitoring/agent.rb', line 7

def configuration_template_id
  @configuration_template_id
end

#configuration_value_countObject

Returns the value of attribute configuration_value_count.



16
17
18
# File 'lib/softlayer/monitoring/agent.rb', line 16

def configuration_value_count
  @configuration_value_count
end

#configuration_valuesObject

Returns the value of attribute configuration_values.



20
21
22
# File 'lib/softlayer/monitoring/agent.rb', line 20

def configuration_values
  @configuration_values
end

#create_dateObject

Returns the value of attribute create_date.



8
9
10
# File 'lib/softlayer/monitoring/agent.rb', line 8

def create_date
  @create_date
end

#hardwareObject

Returns the value of attribute hardware.



21
22
23
# File 'lib/softlayer/monitoring/agent.rb', line 21

def hardware
  @hardware
end

#idObject

Returns the value of attribute id.



9
10
11
# File 'lib/softlayer/monitoring/agent.rb', line 9

def id
  @id
end

#modify_dateObject

Returns the value of attribute modify_date.



10
11
12
# File 'lib/softlayer/monitoring/agent.rb', line 10

def modify_date
  @modify_date
end

#nameObject

Returns the value of attribute name.



11
12
13
# File 'lib/softlayer/monitoring/agent.rb', line 11

def name
  @name
end

#product_itemObject

Returns the value of attribute product_item.



22
23
24
# File 'lib/softlayer/monitoring/agent.rb', line 22

def product_item
  @product_item
end

#remote_monitoring_agent_flagObject

Returns the value of attribute remote_monitoring_agent_flag.



12
13
14
# File 'lib/softlayer/monitoring/agent.rb', line 12

def remote_monitoring_agent_flag
  @remote_monitoring_agent_flag
end

#robot_idObject

Returns the value of attribute robot_id.



13
14
15
# File 'lib/softlayer/monitoring/agent.rb', line 13

def robot_id
  @robot_id
end

#software_descriptionObject

Returns the value of attribute software_description.



23
24
25
# File 'lib/softlayer/monitoring/agent.rb', line 23

def software_description
  @software_description
end

#status_idObject

Returns the value of attribute status_id.



14
15
16
# File 'lib/softlayer/monitoring/agent.rb', line 14

def status_id
  @status_id
end

#status_nameObject

Returns the value of attribute status_name.



24
25
26
# File 'lib/softlayer/monitoring/agent.rb', line 24

def status_name
  @status_name
end

#virtual_guestObject

Returns the value of attribute virtual_guest.



25
26
27
# File 'lib/softlayer/monitoring/agent.rb', line 25

def virtual_guest
  @virtual_guest
end

Instance Method Details

#activateObject



27
28
29
# File 'lib/softlayer/monitoring/agent.rb', line 27

def activate
  request(:activate, Boolean)
end

#add_configuration_profile(configuration_values = nil) ⇒ Object



31
32
33
34
# File 'lib/softlayer/monitoring/agent.rb', line 31

def add_configuration_profile(configuration_values = nil)
  message = {configuration_values: configuration_values}
  request(:add_configuration_profile, Softlayer::Provisioning::Version1::Transaction, message)
end

#apply_configuration_values(configuration_values = nil) ⇒ Object



36
37
38
39
# File 'lib/softlayer/monitoring/agent.rb', line 36

def apply_configuration_values(configuration_values = nil)
  message = {configuration_values: configuration_values}
  request(:apply_configuration_values, Softlayer::Provisioning::Version1::Transaction, message)
end

#deactivateObject



41
42
43
# File 'lib/softlayer/monitoring/agent.rb', line 41

def deactivate
  request(:deactivate, Boolean)
end

#delete_configuration_profile(section_id = nil, profile_id = nil) ⇒ Object



45
46
47
48
# File 'lib/softlayer/monitoring/agent.rb', line 45

def delete_configuration_profile(section_id = nil, profile_id = nil)
  message = {section_id: section_id, profile_id: profile_id}
  request(:delete_configuration_profile, Boolean, message)
end

#deploy_monitoring_agent(configuration_template_id = nil) ⇒ Object



50
51
52
53
# File 'lib/softlayer/monitoring/agent.rb', line 50

def deploy_monitoring_agent(configuration_template_id = nil)
  message = {configuration_template_id: configuration_template_id}
  request(:deploy_monitoring_agent, Softlayer::Provisioning::Version1::Transaction, message)
end

#get_active_alarm_subscribersObject



55
56
57
# File 'lib/softlayer/monitoring/agent.rb', line 55

def get_active_alarm_subscribers
  request(:get_active_alarm_subscribers, Array[Softlayer::Notification::User::Subscriber])
end

#get_agent_statusObject



59
60
61
# File 'lib/softlayer/monitoring/agent.rb', line 59

def get_agent_status
  request(:get_agent_status, Softlayer::Monitoring::Agent::Status)
end

#get_available_configuration_templatesObject



63
64
65
# File 'lib/softlayer/monitoring/agent.rb', line 63

def get_available_configuration_templates
  request(:get_available_configuration_templates, Array[Softlayer::Configuration::Template])
end

#get_available_configuration_values(configuration_definition_id = nil, config_values = nil) ⇒ Object



67
68
69
70
# File 'lib/softlayer/monitoring/agent.rb', line 67

def get_available_configuration_values(configuration_definition_id = nil, config_values = nil)
  message = {configuration_definition_id: configuration_definition_id, config_values: config_values}
  request(:get_available_configuration_values, Array[Softlayer::Monitoring::Agent::Configuration::Value], message)
end

#get_configuration_profilesObject



72
73
74
# File 'lib/softlayer/monitoring/agent.rb', line 72

def get_configuration_profiles
  request(:get_configuration_profiles, Array[Softlayer::Configuration::Template::Section::Profile])
end

#get_configuration_templateObject



76
77
78
# File 'lib/softlayer/monitoring/agent.rb', line 76

def get_configuration_template
  request(:get_configuration_template, Softlayer::Configuration::Template)
end

#get_configuration_valuesObject



80
81
82
# File 'lib/softlayer/monitoring/agent.rb', line 80

def get_configuration_values
  request(:get_configuration_values, Array[Softlayer::Monitoring::Agent::Configuration::Value])
end

#get_eligible_alarm_subscibersObject



84
85
86
# File 'lib/softlayer/monitoring/agent.rb', line 84

def get_eligible_alarm_subscibers
  request(:get_eligible_alarm_subscibers, Array[Softlayer::User::Customer])
end

#get_graph(configuration_values = nil, begin_date = nil, end_date = nil) ⇒ Object



88
89
90
91
# File 'lib/softlayer/monitoring/agent.rb', line 88

def get_graph(configuration_values = nil, begin_date = nil, end_date = nil)
  message = {configuration_values: configuration_values, begin_date: begin_date, end_date: end_date}
  request(:get_graph, Softlayer::Container::Monitoring::Graph::Outputs, message)
end

#get_graph_data(metric_data_types = nil, start_date = nil, end_date = nil) ⇒ Object



93
94
95
96
# File 'lib/softlayer/monitoring/agent.rb', line 93

def get_graph_data(metric_data_types = nil, start_date = nil, end_date = nil)
  message = {metric_data_types: metric_data_types, start_date: start_date, end_date: end_date}
  request(:get_graph_data, Array[Softlayer::Metric::Tracking::Object::Data], message)
end

#get_hardwareObject



98
99
100
# File 'lib/softlayer/monitoring/agent.rb', line 98

def get_hardware
  request(:get_hardware, Softlayer::Hardware)
end

#get_objectObject



102
103
104
# File 'lib/softlayer/monitoring/agent.rb', line 102

def get_object
  request(:get_object, Softlayer::Monitoring::Agent)
end

#get_product_itemObject



106
107
108
# File 'lib/softlayer/monitoring/agent.rb', line 106

def get_product_item
  request(:get_product_item, Softlayer::Product::Item)
end

#get_software_descriptionObject



110
111
112
# File 'lib/softlayer/monitoring/agent.rb', line 110

def get_software_description
  request(:get_software_description, Softlayer::Software::Description)
end

#get_status_nameObject



114
115
116
# File 'lib/softlayer/monitoring/agent.rb', line 114

def get_status_name
  request(:get_status_name, String)
end

#get_virtual_guestObject



118
119
120
# File 'lib/softlayer/monitoring/agent.rb', line 118

def get_virtual_guest
  request(:get_virtual_guest, Softlayer::Virtual::Guest)
end

#remove_active_alarm_subscriber(user_record_id = nil) ⇒ Object



122
123
124
125
# File 'lib/softlayer/monitoring/agent.rb', line 122

def remove_active_alarm_subscriber(user_record_id = nil)
  message = {user_record_id: user_record_id}
  request(:remove_active_alarm_subscriber, Boolean, message)
end

#remove_all_alarm_subscribersObject



127
128
129
# File 'lib/softlayer/monitoring/agent.rb', line 127

def remove_all_alarm_subscribers
  request(:remove_all_alarm_subscribers, Boolean)
end

#restart_monitoring_agentObject



131
132
133
# File 'lib/softlayer/monitoring/agent.rb', line 131

def restart_monitoring_agent
  request(:restart_monitoring_agent, Boolean)
end

#set_active_alarm_subscriber(user_record_id = nil) ⇒ Object



135
136
137
138
# File 'lib/softlayer/monitoring/agent.rb', line 135

def set_active_alarm_subscriber(user_record_id = nil)
  message = {user_record_id: user_record_id}
  request(:set_active_alarm_subscriber, Boolean, message)
end