icontrol 0.3.1 → 0.3.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
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::GlobalLB
2
2
  ##
3
- # The Monitor interface enables you to manipulate a 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 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::GlobalLB
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::GlobalLB::Monitor::MonitorTemplate] :templates The names and types of the new monitor templates to create.
25
43
  # @option opts [IControl::GlobalLB::Monitor::CommonAttributes] :template_attributes The basic template attributes used to create the new template.
@@ -30,38 +48,44 @@ module IControl::GlobalLB
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
- # Gets the monitor template' ignore down response states. When enabled, the system will mark objects down only if the monitor timer expires without receiving an &amp;quot;up" response.
70
+ # Gets the monitor template' ignore down response states. When enabled, the system
71
+ # will mark objects down only if the monitor timer expires without receiving an &amp;quot;up"
72
+ # response.
73
+ # @rspec_example
51
74
  # @return [EnabledState]
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.
75
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
76
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
77
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
55
78
  def ignore_down_response_state
56
79
  super
57
80
  end
58
81
 
59
82
  ##
60
83
  # Gets the enabled/disabled states of the monitor instances.
84
+ # @rspec_example
61
85
  # @return [MonitorInstanceState]
62
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
63
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
64
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
86
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
87
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
88
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
65
89
  # @param [Hash] opts
66
90
  # @option opts [IControl::GlobalLB::MonitorInstance] :instances The monitor instances to get enable/disable states.
67
91
  def instance_state(opts)
@@ -70,51 +94,61 @@ module IControl::GlobalLB
70
94
  end
71
95
 
72
96
  ##
73
- # 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.
97
+ # Gets the monitor template' manual resume states. When enabled and a monitor has marked
98
+ # an object down, that object will not be marked up by the monitor, i.e. the object
99
+ # will be manually marked up.
100
+ # @rspec_example
74
101
  # @return [EnabledState]
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.
102
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
103
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
104
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
78
105
  def manual_resume_state
79
106
  super
80
107
  end
81
108
 
82
109
  ##
83
- # 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.
110
+ # Gets the parent monitor template from which this monitor template are derived. A
111
+ # user-defined monitor template will get its defaults from its parent monitor template.
112
+ # @rspec_example
84
113
  # @return [String]
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 parent_template
89
118
  super
90
119
  end
91
120
 
92
121
  ##
93
- # 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.
122
+ # Gets the destination address types of the monitor template. This allows the user
123
+ # to determine what node IP:port can be associated with this monitor when creating
124
+ # a monitor instance.
125
+ # @rspec_example
94
126
  # @return [AddressType]
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.
127
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
128
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
129
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
98
130
  def template_address_type
99
131
  super
100
132
  end
101
133
 
102
134
  ##
103
135
  # Gets the destination IP:port values of this monitor template.
136
+ # @rspec_example
104
137
  # @return [MonitorIPPort]
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.
138
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
139
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
140
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
108
141
  def template_destination
109
142
  super
110
143
  end
111
144
 
112
145
  ##
113
146
  # Gets the integer property values of this monitor template.
147
+ # @rspec_example
114
148
  # @return [IntegerValue]
115
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
116
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
117
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
149
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
150
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
151
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
118
152
  # @param [Hash] opts
119
153
  # @option opts [IControl::GlobalLB::Monitor::IntPropertyType] :property_types The property types from which to get values for the monitor templates.
120
154
  def template_integer_property(opts)
@@ -124,40 +158,44 @@ module IControl::GlobalLB
124
158
 
125
159
  ##
126
160
  # Gets the list of monitor template.
161
+ # @rspec_example
127
162
  # @return [MonitorTemplate]
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.
163
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
164
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
165
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
131
166
  def template_list
132
167
  super
133
168
  end
134
169
 
135
170
  ##
136
171
  # Gets the reverse mode states of this monitor template.
172
+ # @rspec_example
137
173
  # @return [boolean]
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.
174
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
175
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
176
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
141
177
  def template_reverse_mode
142
178
  super
143
179
  end
144
180
 
145
181
  ##
146
182
  # Gets the enabled/disabled states of this monitor template.
183
+ # @rspec_example
147
184
  # @return [EnabledState]
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.
185
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
186
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
187
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
151
188
  def template_state
152
189
  super
153
190
  end
154
191
 
155
192
  ##
156
193
  # Gets a string property values of this monitor template.
194
+ # @rspec_example
157
195
  # @return [StringValue]
158
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
159
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
160
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
196
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
197
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
198
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
161
199
  # @param [Hash] opts
162
200
  # @option opts [IControl::GlobalLB::Monitor::StrPropertyType] :property_types The property types from which to get values for the monitor templates.
163
201
  def template_string_property(opts)
@@ -167,30 +205,33 @@ module IControl::GlobalLB
167
205
 
168
206
  ##
169
207
  # Gets the transparent mode states of this monitor template.
208
+ # @rspec_example
170
209
  # @return [boolean]
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.
210
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
211
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
212
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
174
213
  def template_transparent_mode
175
214
  super
176
215
  end
177
216
 
178
217
  ##
179
218
  # Gets the template types of this monitor template.
219
+ # @rspec_example
180
220
  # @return [TemplateType]
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.
221
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
222
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
223
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
184
224
  def template_type
185
225
  super
186
226
  end
187
227
 
188
228
  ##
189
229
  # Gets the string property values of this monitor template.
230
+ # @rspec_example
190
231
  # @return [UserDefinedStringValue]
191
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
192
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
193
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
232
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
233
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
234
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
194
235
  # @param [Hash] opts
195
236
  # @option opts [String] :property_names The user-defined string property names from which to get values for the monitor templates.
196
237
  def template_user_defined_string_property(opts)
@@ -200,46 +241,57 @@ module IControl::GlobalLB
200
241
 
201
242
  ##
202
243
  # Gets the version information for this interface.
244
+ # @rspec_example
203
245
  # @return [String]
204
246
  def version
205
247
  super
206
248
  end
207
249
 
208
250
  ##
209
- # 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.
251
+ # Determines if this monitor template can be used directly, or a user-defined monitor
252
+ # based on each monitor must be created first before it can be used.
253
+ # @rspec_example
210
254
  # @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.
255
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
256
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
257
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
214
258
  def is_template_directly_usable
215
259
  super
216
260
  end
217
261
 
218
262
  ##
219
- # Determines if this monitor template are read-only. The user can only modify properties for read/write monitor template.
263
+ # Determines if this monitor template are read-only. The user can only modify properties
264
+ # for read/write monitor template.
265
+ # @rspec_example
220
266
  # @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.
267
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
268
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
269
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
224
270
  def is_template_read_only
225
271
  super
226
272
  end
227
273
 
228
274
  ##
229
275
  # Determines if this monitor template are of the base monitor template.
276
+ # @rspec_example
230
277
  # @return [boolean]
231
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
232
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
233
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
278
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
279
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
280
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
234
281
  def is_template_root
235
282
  super
236
283
  end
237
284
 
238
285
  ##
239
- # Sets the monitor template' ignore down response states. When enabled, the system will mark objects down only if the monitor timer expires without receiving an &amp;quot;up" response. This is useful because probe_num_probes is not effective with ECV monitors. To get similar functionality, enable ignore down response, and set timeout and probe timeout.
240
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
241
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
242
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
286
+ # Sets the monitor template' ignore down response states. When enabled, the system
287
+ # will mark objects down only if the monitor timer expires without receiving an &amp;quot;up"
288
+ # response. This is useful because probe_num_probes is not effective with ECV monitors.
289
+ # To get similar functionality, enable ignore down response, and set timeout and probe
290
+ # timeout.
291
+ # @rspec_example
292
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
293
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
294
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
243
295
  # @param [Hash] opts
244
296
  # @option opts [IControl::Common::EnabledState] :states The ignore down response states of the monitor templates.
245
297
  def set_ignore_down_response_state(opts)
@@ -249,9 +301,10 @@ module IControl::GlobalLB
249
301
 
250
302
  ##
251
303
  # Sets the enabled/disabled states of the monitor instances.
252
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
253
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
254
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
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.
255
308
  # @param [Hash] opts
256
309
  # @option opts [IControl::GlobalLB::MonitorInstanceState] :instance_states The monitor instances and their enabled/disabled states.
257
310
  def set_instance_state(opts)
@@ -260,10 +313,13 @@ module IControl::GlobalLB
260
313
  end
261
314
 
262
315
  ##
263
- # 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.
264
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
265
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
266
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
316
+ # Sets the monitor template' manual resume states. When enabled and a monitor has marked
317
+ # an object down, that object will not be marked up by the monitor, i.e. the object
318
+ # will be manually marked up.
319
+ # @rspec_example
320
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
321
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
322
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
267
323
  # @param [Hash] opts
268
324
  # @option opts [IControl::Common::EnabledState] :states The manual resume states of the monitor templates.
269
325
  def set_manual_resume_state(opts)
@@ -272,10 +328,13 @@ module IControl::GlobalLB
272
328
  end
273
329
 
274
330
  ##
275
- # 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.
276
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
277
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
278
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
331
+ # Sets the destination IP:port values for this template. NOTE: This should only be
332
+ # done when the monitor template in &amp;quot;template_names" have NOT been associated
333
+ # to any node addresses or pool members.
334
+ # @rspec_example
335
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
336
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
337
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
279
338
  # @param [Hash] opts
280
339
  # @option opts [IControl::GlobalLB::MonitorIPPort] :destinations The destinations to set for the specified monitor templates.
281
340
  def set_template_destination(opts)
@@ -285,9 +344,10 @@ module IControl::GlobalLB
285
344
 
286
345
  ##
287
346
  # Sets an integer property values of this monitor template.
288
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
289
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
290
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
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.
291
351
  # @param [Hash] opts
292
352
  # @option opts [IControl::GlobalLB::Monitor::IntegerValue] :values The property types and values to set for the monitor templates.
293
353
  def set_template_integer_property(opts)
@@ -296,10 +356,12 @@ module IControl::GlobalLB
296
356
  end
297
357
 
298
358
  ##
299
- # Sets the reverse mode states of this monitor template. When in reverse mode, a successful test marks the node down instead of up.
300
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
301
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
302
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
359
+ # Sets the reverse mode states of this monitor template. When in reverse mode, a successful
360
+ # test marks the node down instead of up.
361
+ # @rspec_example
362
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
363
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
364
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
303
365
  # @param [Hash] opts
304
366
  # @option opts [boolean] :reverse_modes The reverse mode states of the monitor templates.
305
367
  def set_template_reverse_mode(opts)
@@ -308,10 +370,14 @@ module IControl::GlobalLB
308
370
  end
309
371
 
310
372
  ##
311
- # 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.
312
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
313
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
314
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
373
+ # Sets the monitor template' enabled/disabled states. This will enable/disable all
374
+ # instances that use this template. This serves as a quick and convenient method to
375
+ # enable/disable all instances, but if you want only to enable/disable a specific instance,
376
+ # use set_instance_enabled.
377
+ # @rspec_example
378
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
379
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
380
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
315
381
  # @param [Hash] opts
316
382
  # @option opts [IControl::Common::EnabledState] :states The enabled/disabled states of the monitor templates.
317
383
  def set_template_state(opts)
@@ -321,9 +387,10 @@ module IControl::GlobalLB
321
387
 
322
388
  ##
323
389
  # Sets a string property values of this monitor template.
324
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
325
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
326
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
390
+ # @rspec_example
391
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
392
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
393
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
327
394
  # @param [Hash] opts
328
395
  # @option opts [IControl::GlobalLB::Monitor::StringValue] :values The property types and values to set for the monitor templates.
329
396
  def set_template_string_property(opts)
@@ -332,10 +399,12 @@ module IControl::GlobalLB
332
399
  end
333
400
 
334
401
  ##
335
- # 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.
336
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
337
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
338
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
402
+ # Sets the transparent mode states of this monitor template. Transparent mode is used
403
+ # when a user has to go through a firewall to do monitoring.
404
+ # @rspec_example
405
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
406
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
407
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
339
408
  # @param [Hash] opts
340
409
  # @option opts [boolean] :transparent_modes The transparent mode states of the monitor templates.
341
410
  def set_template_transparent_mode(opts)
@@ -345,9 +414,10 @@ module IControl::GlobalLB
345
414
 
346
415
  ##
347
416
  # Sets the user-defined string property values of this monitor template.
348
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
349
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
350
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
417
+ # @rspec_example
418
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
419
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
420
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
351
421
  # @param [Hash] opts
352
422
  # @option opts [IControl::GlobalLB::Monitor::UserDefinedStringValue] :values The string property names and values to set for the monitor templates.
353
423
  def set_template_user_defined_string_property(opts)