icontrol 0.3.1 → 0.3.2

Sign up to get free protection for your applications and to get access to all the features.
Files changed (151) hide show
  1. data/lib/icontrol/arx.rb +38 -8
  2. data/lib/icontrol/arx/api.rb +1 -0
  3. data/lib/icontrol/arx/chassis.rb +11 -0
  4. data/lib/icontrol/arx/export.rb +4 -1
  5. data/lib/icontrol/arx/file_change_notification.rb +25 -4
  6. data/lib/icontrol/arx/file_server.rb +2 -0
  7. data/lib/icontrol/arx/namespace.rb +2 -0
  8. data/lib/icontrol/arx/network.rb +3 -0
  9. data/lib/icontrol/arx/policy.rb +3 -0
  10. data/lib/icontrol/arx/share.rb +2 -0
  11. data/lib/icontrol/arx/virtual_service.rb +3 -0
  12. data/lib/icontrol/arx/volume.rb +2 -0
  13. data/lib/icontrol/asm.rb +18 -3
  14. data/lib/icontrol/asm/object_params.rb +12 -6
  15. data/lib/icontrol/asm/policy.rb +118 -79
  16. data/lib/icontrol/asm/system_configuration.rb +27 -19
  17. data/lib/icontrol/asm/web_application.rb +74 -52
  18. data/lib/icontrol/asm/web_application_group.rb +33 -24
  19. data/lib/icontrol/base.rb +1 -0
  20. data/lib/icontrol/base/exception.rb +1 -0
  21. data/lib/icontrol/base/icontrol/local_lb/pool.rb +7 -0
  22. data/lib/icontrol/base/icontrol_overlay.rb +6 -0
  23. data/lib/icontrol/base/predeclarations.rb +5 -4
  24. data/lib/icontrol/base/struct.rb +6 -2
  25. data/lib/icontrol/common.rb +55 -4
  26. data/lib/icontrol/global_lb.rb +22 -3
  27. data/lib/icontrol/global_lb/application.rb +63 -44
  28. data/lib/icontrol/global_lb/data_center.rb +82 -58
  29. data/lib/icontrol/global_lb/dnssec_key.rb +152 -90
  30. data/lib/icontrol/global_lb/dnssec_zone.rb +55 -35
  31. data/lib/icontrol/global_lb/globals.rb +662 -430
  32. data/lib/icontrol/global_lb/link.rb +181 -131
  33. data/lib/icontrol/global_lb/monitor.rb +174 -104
  34. data/lib/icontrol/global_lb/pool.rb +290 -203
  35. data/lib/icontrol/global_lb/pool_member.rb +118 -71
  36. data/lib/icontrol/global_lb/region.rb +37 -25
  37. data/lib/icontrol/global_lb/rule.rb +53 -37
  38. data/lib/icontrol/global_lb/server.rb +176 -124
  39. data/lib/icontrol/global_lb/topology.rb +41 -27
  40. data/lib/icontrol/global_lb/virtual_server.rb +118 -84
  41. data/lib/icontrol/global_lb/wide_ip.rb +168 -117
  42. data/lib/icontrol/local_lb.rb +81 -10
  43. data/lib/icontrol/local_lb/klass.rb +233 -153
  44. data/lib/icontrol/local_lb/monitor.rb +158 -96
  45. data/lib/icontrol/local_lb/nat.rb +74 -52
  46. data/lib/icontrol/local_lb/node_address.rb +123 -86
  47. data/lib/icontrol/local_lb/pool.rb +229 -164
  48. data/lib/icontrol/local_lb/pool_member.rb +134 -76
  49. data/lib/icontrol/local_lb/profile_auth.rb +103 -75
  50. data/lib/icontrol/local_lb/profile_client_ssl.rb +284 -201
  51. data/lib/icontrol/local_lb/profile_diameter.rb +113 -71
  52. data/lib/icontrol/local_lb/profile_dns.rb +65 -46
  53. data/lib/icontrol/local_lb/profile_fast_http.rb +265 -178
  54. data/lib/icontrol/local_lb/profile_fast_l4.rb +283 -194
  55. data/lib/icontrol/local_lb/profile_ftp.rb +81 -58
  56. data/lib/icontrol/local_lb/profile_http.rb +701 -433
  57. data/lib/icontrol/local_lb/profile_http_class.rb +169 -121
  58. data/lib/icontrol/local_lb/profile_iiop.rb +87 -63
  59. data/lib/icontrol/local_lb/profile_one_connect.rb +99 -71
  60. data/lib/icontrol/local_lb/profile_persistence.rb +326 -203
  61. data/lib/icontrol/local_lb/profile_radius.rb +94 -62
  62. data/lib/icontrol/local_lb/profile_rtsp.rb +207 -129
  63. data/lib/icontrol/local_lb/profile_sctp.rb +231 -167
  64. data/lib/icontrol/local_lb/profile_server_ssl.rb +268 -189
  65. data/lib/icontrol/local_lb/profile_sip.rb +145 -99
  66. data/lib/icontrol/local_lb/profile_stream.rb +71 -51
  67. data/lib/icontrol/local_lb/profile_tcp.rb +455 -296
  68. data/lib/icontrol/local_lb/profile_udp.rb +109 -78
  69. data/lib/icontrol/local_lb/profile_user_statistic.rb +77 -46
  70. data/lib/icontrol/local_lb/profile_xml.rb +116 -79
  71. data/lib/icontrol/local_lb/ram_cache_information.rb +43 -20
  72. data/lib/icontrol/local_lb/rate_class.rb +523 -318
  73. data/lib/icontrol/local_lb/rule.rb +53 -37
  74. data/lib/icontrol/local_lb/snat.rb +96 -65
  75. data/lib/icontrol/local_lb/snat_pool.rb +54 -39
  76. data/lib/icontrol/local_lb/snat_pool_member.rb +22 -15
  77. data/lib/icontrol/local_lb/snat_translation_address.rb +94 -69
  78. data/lib/icontrol/local_lb/virtual_address.rb +99 -70
  79. data/lib/icontrol/local_lb/virtual_server.rb +358 -243
  80. data/lib/icontrol/lt_config.rb +8 -1
  81. data/lib/icontrol/lt_config/field.rb +87 -53
  82. data/lib/icontrol/lt_config/klass.rb +59 -43
  83. data/lib/icontrol/management.rb +80 -38
  84. data/lib/icontrol/management/ccldap_configuration.rb +218 -144
  85. data/lib/icontrol/management/change_control.rb +67 -41
  86. data/lib/icontrol/management/crldp_configuration.rb +73 -52
  87. data/lib/icontrol/management/crldp_server.rb +55 -39
  88. data/lib/icontrol/management/db_variable.rb +32 -21
  89. data/lib/icontrol/management/event_notification.rb +19 -8
  90. data/lib/icontrol/management/event_subscription.rb +121 -74
  91. data/lib/icontrol/management/key_certificate.rb +235 -138
  92. data/lib/icontrol/management/ldap_configuration.rb +249 -179
  93. data/lib/icontrol/management/license_administration.rb +97 -56
  94. data/lib/icontrol/management/named.rb +103 -67
  95. data/lib/icontrol/management/ocsp_configuration.rb +33 -24
  96. data/lib/icontrol/management/ocsp_responder.rb +294 -165
  97. data/lib/icontrol/management/partition.rb +42 -23
  98. data/lib/icontrol/management/provision.rb +73 -39
  99. data/lib/icontrol/management/radius_configuration.rb +85 -57
  100. data/lib/icontrol/management/radius_server.rb +51 -37
  101. data/lib/icontrol/management/resource_record.rb +163 -121
  102. data/lib/icontrol/management/snmp_configuration.rb +675 -390
  103. data/lib/icontrol/management/tacacs_configuration.rb +99 -67
  104. data/lib/icontrol/management/tmos_module.rb +20 -8
  105. data/lib/icontrol/management/user_management.rb +198 -124
  106. data/lib/icontrol/management/view.rb +33 -24
  107. data/lib/icontrol/management/zone.rb +49 -34
  108. data/lib/icontrol/management/zone_runner.rb +11 -7
  109. data/lib/icontrol/networking.rb +31 -4
  110. data/lib/icontrol/networking/admin_ip.rb +92 -71
  111. data/lib/icontrol/networking/arp.rb +41 -28
  112. data/lib/icontrol/networking/i_session_advertised_route.rb +47 -32
  113. data/lib/icontrol/networking/i_session_local_interface.rb +72 -52
  114. data/lib/icontrol/networking/i_session_peer_discovery.rb +105 -68
  115. data/lib/icontrol/networking/i_session_remote_interface.rb +105 -76
  116. data/lib/icontrol/networking/interfaces.rb +241 -142
  117. data/lib/icontrol/networking/packet_filter.rb +111 -69
  118. data/lib/icontrol/networking/packet_filter_globals.rb +39 -28
  119. data/lib/icontrol/networking/port_mirror.rb +39 -27
  120. data/lib/icontrol/networking/profile_gre.rb +63 -41
  121. data/lib/icontrol/networking/profile_ipip.rb +38 -25
  122. data/lib/icontrol/networking/profile_wccpgre.rb +85 -55
  123. data/lib/icontrol/networking/route_domain.rb +70 -44
  124. data/lib/icontrol/networking/route_table.rb +128 -91
  125. data/lib/icontrol/networking/self_ip.rb +57 -39
  126. data/lib/icontrol/networking/self_ip_port_lockdown.rb +34 -22
  127. data/lib/icontrol/networking/stp_globals.rb +115 -63
  128. data/lib/icontrol/networking/stp_instance.rb +166 -68
  129. data/lib/icontrol/networking/trunk.rb +165 -101
  130. data/lib/icontrol/networking/tunnel.rb +77 -52
  131. data/lib/icontrol/networking/vlan.rb +140 -98
  132. data/lib/icontrol/networking/vlan_group.rb +145 -101
  133. data/lib/icontrol/system.rb +70 -33
  134. data/lib/icontrol/system/cluster.rb +103 -81
  135. data/lib/icontrol/system/config_sync.rb +128 -72
  136. data/lib/icontrol/system/connections.rb +27 -17
  137. data/lib/icontrol/system/disk.rb +134 -67
  138. data/lib/icontrol/system/failover.rb +44 -27
  139. data/lib/icontrol/system/geo_ip.rb +16 -5
  140. data/lib/icontrol/system/inet.rb +47 -30
  141. data/lib/icontrol/system/internal.rb +13 -9
  142. data/lib/icontrol/system/services.rb +75 -42
  143. data/lib/icontrol/system/software_management.rb +132 -83
  144. data/lib/icontrol/system/statistics.rb +443 -298
  145. data/lib/icontrol/system/system_info.rb +137 -95
  146. data/lib/icontrol/web_accelerator/applications.rb +17 -10
  147. data/lib/icontrol/web_accelerator/policies.rb +13 -9
  148. data/lib/icontrol/web_accelerator/proxy_message.rb +11 -7
  149. data/spec/icontrol/local_lb/pool_member_spec.rb +495 -0
  150. data/spec/icontrol/local_lb/profile_http_class_spec.rb +514 -0
  151. metadata +10 -4
@@ -1,6 +1,9 @@
1
1
  module IControl::LocalLB
2
2
  ##
3
- # The Monitor interface enables you to manipulate a local load balancer's monitor templates and instances. For example, use the Monitor interface to enable or disable a monitor instance, or to create a monitor template, or to get and set different attributes of a monitor template.
3
+ # The Monitor interface enables you to manipulate a local load balancer's monitor templates
4
+ # and instances. For example, use the Monitor interface to enable or disable a monitor
5
+ # instance, or to create a monitor template, or to get and set different attributes
6
+ # of a monitor template.
4
7
  class Monitor < IControl::Base
5
8
 
6
9
  set_id_name "template_names"
@@ -10,16 +13,31 @@ module IControl::LocalLB
10
13
  class MonitorTemplate < IControl::Base::Struct; end
11
14
  class StringValue < IControl::Base::Struct; end
12
15
  class UserDefinedStringValue < IControl::Base::Struct; end
16
+ class CommonAttributesSequence < IControl::Base::Sequence ; end
17
+ class IntPropertyTypeSequence < IControl::Base::Sequence ; end
18
+ class IntegerValueSequence < IControl::Base::Sequence ; end
19
+ class MonitorTemplateSequence < IControl::Base::Sequence ; end
20
+ class StrPropertyTypeSequence < IControl::Base::Sequence ; end
21
+ class StringValueSequence < IControl::Base::Sequence ; end
22
+ class TemplateTypeSequence < IControl::Base::Sequence ; end
23
+ class UserDefinedStringValueSequence < IControl::Base::Sequence ; end
13
24
  # A list of monitor template's integer property types.
14
25
  class IntPropertyType < IControl::Base::Enumeration; end
15
26
  # A list of monitor template's string property types.
16
27
  class StrPropertyType < IControl::Base::Enumeration; end
17
28
  # A list of template types.
18
29
  class TemplateType < IControl::Base::Enumeration; end ##
19
- # Creates monitor template with some basic attributes. If the &amp;quot;parent_template" attribute in &amp;quot;template_attributes" is empty, then the new template is based on the template type field given in &amp;quot;template". If the &amp;quot;parent_template" attribute in &amp;quot;template_attributes" is specified, then the new template is derived from the &amp;quot;parent_template", and template type field in &amp;quot;template" is ignored. If &amp;quot;parent_template" is empty, and the template type field in &amp;quot;template" is not specified, then the new template is a root template.
20
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
21
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
22
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
30
+ # Creates monitor template with some basic attributes. If the &amp;quot;parent_template"
31
+ # attribute in &amp;quot;template_attributes" is empty, then the new template is based
32
+ # on the template type field given in &amp;quot;template". If the &amp;quot;parent_template"
33
+ # attribute in &amp;quot;template_attributes" is specified, then the new template is
34
+ # derived from the &amp;quot;parent_template", and template type field in &amp;quot;template"
35
+ # is ignored. If &amp;quot;parent_template" is empty, and the template type field in
36
+ # &amp;quot;template" is not specified, then the new template is a root template.
37
+ # @rspec_example
38
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
39
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
40
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
23
41
  # @param [Hash] opts
24
42
  # @option opts [IControl::LocalLB::Monitor::MonitorTemplate] :templates The names and types of the new monitor templates to create.
25
43
  # @option opts [IControl::LocalLB::Monitor::CommonAttributes] :template_attributes The basic template attributes used to create the new template.
@@ -30,28 +48,31 @@ module IControl::LocalLB
30
48
 
31
49
  ##
32
50
  # Deletes all user-defined (non-root) monitor template.
33
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
34
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
35
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
51
+ # @rspec_example
52
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
53
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
54
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
36
55
  def delete_all_templates
37
56
  super
38
57
  end
39
58
 
40
59
  ##
41
60
  # Deletes this monitor template.
42
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
43
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
44
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
61
+ # @rspec_example
62
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
63
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
64
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
45
65
  def delete_template
46
66
  super
47
67
  end
48
68
 
49
69
  ##
50
70
  # Gets the enabled/disabled states of the monitor instances.
71
+ # @rspec_example
51
72
  # @return [MonitorInstanceState]
52
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
53
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
54
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
73
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
74
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
75
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
55
76
  # @param [Hash] opts
56
77
  # @option opts [IControl::LocalLB::MonitorInstance] :instances The monitor instances to get enable/disable states.
57
78
  def instance_state(opts)
@@ -60,51 +81,61 @@ module IControl::LocalLB
60
81
  end
61
82
 
62
83
  ##
63
- # Gets the monitor template' manual resume states. When enabled and a monitor has marked an object down, that object will not be marked up by the monitor, i.e. the object will be manually marked up.
84
+ # Gets the monitor template' manual resume states. When enabled and a monitor has marked
85
+ # an object down, that object will not be marked up by the monitor, i.e. the object
86
+ # will be manually marked up.
87
+ # @rspec_example
64
88
  # @return [EnabledState]
65
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
66
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
67
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
89
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
90
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
91
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
68
92
  def manual_resume_state
69
93
  super
70
94
  end
71
95
 
72
96
  ##
73
- # Gets the parent monitor template from which this monitor template are derived. A user-defined monitor template will get its defaults from its parent monitor template.
97
+ # Gets the parent monitor template from which this monitor template are derived. A
98
+ # user-defined monitor template will get its defaults from its parent monitor template.
99
+ # @rspec_example
74
100
  # @return [String]
75
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
76
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
77
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
101
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
102
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
103
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
78
104
  def parent_template
79
105
  super
80
106
  end
81
107
 
82
108
  ##
83
- # Gets the destination address types of the monitor template. This allows the user to determine what node IP:port can be associated with this monitor when creating a monitor instance.
109
+ # Gets the destination address types of the monitor template. This allows the user
110
+ # to determine what node IP:port can be associated with this monitor when creating
111
+ # a monitor instance.
112
+ # @rspec_example
84
113
  # @return [AddressType]
85
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
86
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
87
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
114
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
115
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
116
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
88
117
  def template_address_type
89
118
  super
90
119
  end
91
120
 
92
121
  ##
93
122
  # Gets the destination IP:port values of this monitor template.
123
+ # @rspec_example
94
124
  # @return [MonitorIPPort]
95
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
96
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
97
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
125
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
126
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
127
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
98
128
  def template_destination
99
129
  super
100
130
  end
101
131
 
102
132
  ##
103
133
  # Gets the integer property values of this monitor template.
134
+ # @rspec_example
104
135
  # @return [IntegerValue]
105
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
106
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
107
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
136
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
137
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
138
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
108
139
  # @param [Hash] opts
109
140
  # @option opts [IControl::LocalLB::Monitor::IntPropertyType] :property_types The property types from which to get values for the monitor templates.
110
141
  def template_integer_property(opts)
@@ -114,40 +145,44 @@ module IControl::LocalLB
114
145
 
115
146
  ##
116
147
  # Gets the list of monitor template.
148
+ # @rspec_example
117
149
  # @return [MonitorTemplate]
118
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
119
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
120
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
150
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
151
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
152
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
121
153
  def template_list
122
154
  super
123
155
  end
124
156
 
125
157
  ##
126
158
  # Gets the reverse mode states of this monitor template.
159
+ # @rspec_example
127
160
  # @return [boolean]
128
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
129
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
130
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
161
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
162
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
163
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
131
164
  def template_reverse_mode
132
165
  super
133
166
  end
134
167
 
135
168
  ##
136
169
  # Gets the enabled/disabled states of this monitor template.
170
+ # @rspec_example
137
171
  # @return [EnabledState]
138
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
139
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
140
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
172
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
173
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
174
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
141
175
  def template_state
142
176
  super
143
177
  end
144
178
 
145
179
  ##
146
180
  # Gets a string property values of this monitor template.
181
+ # @rspec_example
147
182
  # @return [StringValue]
148
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
149
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
150
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
183
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
184
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
185
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
151
186
  # @param [Hash] opts
152
187
  # @option opts [IControl::LocalLB::Monitor::StrPropertyType] :property_types The property types from which to get values for the monitor templates.
153
188
  def template_string_property(opts)
@@ -157,30 +192,33 @@ module IControl::LocalLB
157
192
 
158
193
  ##
159
194
  # Gets the transparent mode states of this monitor template.
195
+ # @rspec_example
160
196
  # @return [boolean]
161
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
162
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
163
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
197
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
198
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
199
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
164
200
  def template_transparent_mode
165
201
  super
166
202
  end
167
203
 
168
204
  ##
169
205
  # Gets the template types of this monitor template.
206
+ # @rspec_example
170
207
  # @return [TemplateType]
171
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
172
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
173
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
208
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
209
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
210
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
174
211
  def template_type
175
212
  super
176
213
  end
177
214
 
178
215
  ##
179
216
  # Gets the string property values of this monitor template.
217
+ # @rspec_example
180
218
  # @return [UserDefinedStringValue]
181
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
182
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
183
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
219
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
220
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
221
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
184
222
  # @param [Hash] opts
185
223
  # @option opts [String] :property_names The user-defined string property names from which to get values for the monitor templates.
186
224
  def template_user_defined_string_property(opts)
@@ -190,46 +228,53 @@ module IControl::LocalLB
190
228
 
191
229
  ##
192
230
  # Gets the version information for this interface.
231
+ # @rspec_example
193
232
  # @return [String]
194
233
  def version
195
234
  super
196
235
  end
197
236
 
198
237
  ##
199
- # Determines if this monitor template can be used directly, or a user-defined monitor based on each monitor must be created first before it can be used.
238
+ # Determines if this monitor template can be used directly, or a user-defined monitor
239
+ # based on each monitor must be created first before it can be used.
240
+ # @rspec_example
200
241
  # @return [boolean]
201
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
202
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
203
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
242
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
243
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
244
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
204
245
  def is_template_directly_usable
205
246
  super
206
247
  end
207
248
 
208
249
  ##
209
- # Determines if this monitor template are read-only. The user can only modify properties for read/write monitor template.
250
+ # Determines if this monitor template are read-only. The user can only modify properties
251
+ # for read/write monitor template.
252
+ # @rspec_example
210
253
  # @return [boolean]
211
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
212
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
213
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
254
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
255
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
256
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
214
257
  def is_template_read_only
215
258
  super
216
259
  end
217
260
 
218
261
  ##
219
262
  # Determines if this monitor template are of the base monitor template.
263
+ # @rspec_example
220
264
  # @return [boolean]
221
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
222
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
223
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
265
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
266
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
267
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
224
268
  def is_template_root
225
269
  super
226
270
  end
227
271
 
228
272
  ##
229
273
  # Sets the enabled/disabled states of the monitor instances.
230
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
231
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
232
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
274
+ # @rspec_example
275
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
276
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
277
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
233
278
  # @param [Hash] opts
234
279
  # @option opts [IControl::LocalLB::MonitorInstanceState] :instance_states The monitor instances and their enabled/disabled states.
235
280
  def set_instance_state(opts)
@@ -238,10 +283,13 @@ module IControl::LocalLB
238
283
  end
239
284
 
240
285
  ##
241
- # Sets the monitor template' manual resume states. When enabled and a monitor has marked an object down, that object will not be marked up by the monitor, i.e. the object will be manually marked up.
242
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
243
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
244
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
286
+ # Sets the monitor template' manual resume states. When enabled and a monitor has marked
287
+ # an object down, that object will not be marked up by the monitor, i.e. the object
288
+ # will be manually marked up.
289
+ # @rspec_example
290
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
291
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
292
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
245
293
  # @param [Hash] opts
246
294
  # @option opts [IControl::Common::EnabledState] :states The manual resume states of the monitor templates.
247
295
  def set_manual_resume_state(opts)
@@ -250,10 +298,13 @@ module IControl::LocalLB
250
298
  end
251
299
 
252
300
  ##
253
- # Sets the destination IP:port values for this template. NOTE: This should only be done when the monitor template in &amp;quot;template_names" have NOT been associated to any node addresses or pool members.
254
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
255
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
256
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
301
+ # Sets the destination IP:port values for this template. NOTE: This should only be
302
+ # done when the monitor template in &amp;quot;template_names" have NOT been associated
303
+ # to any node addresses or pool members.
304
+ # @rspec_example
305
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
306
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
307
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
257
308
  # @param [Hash] opts
258
309
  # @option opts [IControl::LocalLB::MonitorIPPort] :destinations The destinations to set for the specified monitor templates.
259
310
  def set_template_destination(opts)
@@ -263,9 +314,10 @@ module IControl::LocalLB
263
314
 
264
315
  ##
265
316
  # Sets an integer property values of this monitor template.
266
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
267
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
268
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
317
+ # @rspec_example
318
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
319
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
320
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
269
321
  # @param [Hash] opts
270
322
  # @option opts [IControl::LocalLB::Monitor::IntegerValue] :values The property types and values to set for the monitor templates.
271
323
  def set_template_integer_property(opts)
@@ -274,10 +326,12 @@ module IControl::LocalLB
274
326
  end
275
327
 
276
328
  ##
277
- # Sets the reverse mode states of this monitor template. When in reverse mode, a successful test marks the node down instead of up.
278
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
279
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
280
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
329
+ # Sets the reverse mode states of this monitor template. When in reverse mode, a successful
330
+ # test marks the node down instead of up.
331
+ # @rspec_example
332
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
333
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
334
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
281
335
  # @param [Hash] opts
282
336
  # @option opts [boolean] :reverse_modes The reverse mode states of the monitor templates.
283
337
  def set_template_reverse_mode(opts)
@@ -286,10 +340,14 @@ module IControl::LocalLB
286
340
  end
287
341
 
288
342
  ##
289
- # Sets the monitor template' enabled/disabled states. This will enable/disable all instances that use this template. This serves as a quick and convenient method to enable/disable all instances, but if you want only to enable/disable a specific instance, use set_instance_enabled.
290
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
291
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
292
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
343
+ # Sets the monitor template' enabled/disabled states. This will enable/disable all
344
+ # instances that use this template. This serves as a quick and convenient method to
345
+ # enable/disable all instances, but if you want only to enable/disable a specific instance,
346
+ # use set_instance_enabled.
347
+ # @rspec_example
348
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
349
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
350
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
293
351
  # @param [Hash] opts
294
352
  # @option opts [IControl::Common::EnabledState] :states The enabled/disabled states of the monitor templates.
295
353
  def set_template_state(opts)
@@ -299,9 +357,10 @@ module IControl::LocalLB
299
357
 
300
358
  ##
301
359
  # Sets a string property values of this monitor template.
302
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
303
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
304
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
360
+ # @rspec_example
361
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
362
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
363
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
305
364
  # @param [Hash] opts
306
365
  # @option opts [IControl::LocalLB::Monitor::StringValue] :values The property types and values to set for the monitor templates.
307
366
  def set_template_string_property(opts)
@@ -310,10 +369,12 @@ module IControl::LocalLB
310
369
  end
311
370
 
312
371
  ##
313
- # Sets the transparent mode states of this monitor template. Transparent mode is used when a user has to go through a firewall to do monitoring.
314
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
315
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
316
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
372
+ # Sets the transparent mode states of this monitor template. Transparent mode is used
373
+ # when a user has to go through a firewall to do monitoring.
374
+ # @rspec_example
375
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
376
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
377
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
317
378
  # @param [Hash] opts
318
379
  # @option opts [boolean] :transparent_modes The transparent mode states of the monitor templates.
319
380
  def set_template_transparent_mode(opts)
@@ -323,9 +384,10 @@ module IControl::LocalLB
323
384
 
324
385
  ##
325
386
  # Sets the user-defined string property values of this monitor template.
326
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
327
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
328
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
387
+ # @rspec_example
388
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
389
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
390
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
329
391
  # @param [Hash] opts
330
392
  # @option opts [IControl::LocalLB::Monitor::UserDefinedStringValue] :values The string property names and values to set for the monitor templates.
331
393
  def set_template_user_defined_string_property(opts)