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
@@ -10,11 +10,18 @@ module IControl::GlobalLB
10
10
  class LinkMetricLimit < IControl::Base::Struct; end
11
11
  class LinkStatisticEntry < IControl::Base::Struct; end
12
12
  class LinkStatistics < IControl::Base::Struct; end
13
- class MonitorAssociation < IControl::Base::Struct; end ##
13
+ class MonitorAssociation < IControl::Base::Struct; end
14
+ class LinkCostSegmentSequence < IControl::Base::Sequence ; end
15
+ class LinkCostSegmentSequenceSequence < IControl::Base::SequenceSequence ; end
16
+ class LinkIPSequence < IControl::Base::Sequence ; end
17
+ class LinkMetricLimitSequence < IControl::Base::Sequence ; end
18
+ class LinkStatisticEntrySequence < IControl::Base::Sequence ; end
19
+ class MonitorAssociationSequence < IControl::Base::Sequence ; end ##
14
20
  # Adds the cost segments for this link.
15
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
16
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
17
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
21
+ # @rspec_example
22
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
23
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
24
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
18
25
  # @param [Hash] opts
19
26
  # @option opts [IControl::GlobalLB::Link::LinkCostSegment[]] :cost_segments The cost segments.
20
27
  def add_cost_segment(opts)
@@ -24,9 +31,10 @@ module IControl::GlobalLB
24
31
 
25
32
  ##
26
33
  # Adds the IP addresses to this link.
27
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
28
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
29
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
34
+ # @rspec_example
35
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
36
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
37
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
30
38
  # @param [Hash] opts
31
39
  # @option opts [IControl::GlobalLB::Link::LinkIPDefinition] :ips The IP addresses to add to the links.
32
40
  def add_ip(opts)
@@ -36,9 +44,10 @@ module IControl::GlobalLB
36
44
 
37
45
  ##
38
46
  # Creates this link.
39
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
40
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
41
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
47
+ # @rspec_example
48
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
49
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
50
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
42
51
  # @param [Hash] opts
43
52
  # @option opts [String] :data_centers The data centers associated with the links.
44
53
  def create(opts)
@@ -48,194 +57,214 @@ module IControl::GlobalLB
48
57
 
49
58
  ##
50
59
  # Deletes all link.
51
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
52
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
53
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
60
+ # @rspec_example
61
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
62
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
63
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
54
64
  def delete_all_links
55
65
  super
56
66
  end
57
67
 
58
68
  ##
59
69
  # Deletes this link.
60
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
61
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
62
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
70
+ # @rspec_example
71
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
72
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
73
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
63
74
  def delete_link
64
75
  super
65
76
  end
66
77
 
67
78
  ##
68
79
  # Gets the statistics for all the link.
80
+ # @rspec_example
69
81
  # @return [LinkStatistics]
70
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
71
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
72
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
82
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
83
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
84
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
73
85
  def all_statistics
74
86
  super
75
87
  end
76
88
 
77
89
  ##
78
90
  # Gets the list of cost segments for this link.
91
+ # @rspec_example
79
92
  # @return [LinkCostSegment[]]
80
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
81
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
82
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
93
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
94
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
95
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
83
96
  def cost_segment
84
97
  super
85
98
  end
86
99
 
87
100
  ##
88
101
  # Gets the data centers that this link belong to.
102
+ # @rspec_example
89
103
  # @return [String]
90
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
91
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
92
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
104
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
105
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
106
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
93
107
  def data_center
94
108
  super
95
109
  end
96
110
 
97
111
  ##
98
112
  # Gets the states indicating whether this link use duplex.
113
+ # @rspec_example
99
114
  # @return [EnabledState]
100
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
101
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
102
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
115
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
116
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
117
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
103
118
  def duplex_state
104
119
  super
105
120
  end
106
121
 
107
122
  ##
108
123
  # Gets the enabled state of this link.
124
+ # @rspec_example
109
125
  # @return [EnabledState]
110
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
111
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
112
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
126
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
127
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
128
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
113
129
  def enabled_state
114
130
  super
115
131
  end
116
132
 
117
133
  ##
118
134
  # Gets the inbound limits for link metrics.
135
+ # @rspec_example
119
136
  # @return [LinkMetricLimit]
120
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
121
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
122
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
137
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
138
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
139
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
123
140
  def inbound_limit
124
141
  super
125
142
  end
126
143
 
127
144
  ##
128
145
  # Gets the IP addresses that belong to this link.
146
+ # @rspec_example
129
147
  # @return [LinkIPDefinition]
130
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
131
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
132
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
148
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
149
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
150
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
133
151
  def ip
134
152
  super
135
153
  end
136
154
 
137
155
  ##
138
156
  # Gets the ISP names for this link.
157
+ # @rspec_example
139
158
  # @return [String]
140
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
141
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
142
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
159
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
160
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
161
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
143
162
  def isp_name
144
163
  super
145
164
  end
146
165
 
147
166
  ##
148
167
  # Gets a list of link.
168
+ # @rspec_example
149
169
  # @return [String]
150
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
151
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
152
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
170
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
171
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
172
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
153
173
  def list
154
174
  super
155
175
  end
156
176
 
157
177
  ##
158
178
  # Gets the monitor associations for this link, i.e. the monitor rules used by the link.
179
+ # @rspec_example
159
180
  # @return [MonitorAssociation]
160
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
161
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
162
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
181
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
182
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
183
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
163
184
  def monitor_association
164
185
  super
165
186
  end
166
187
 
167
188
  ##
168
189
  # Gets the statuses of this link.
190
+ # @rspec_example
169
191
  # @return [ObjectStatus]
170
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
171
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
172
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
192
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
193
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
194
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
173
195
  def object_status
174
196
  super
175
197
  end
176
198
 
177
199
  ##
178
200
  # Gets the outbound limits for link metrics.
201
+ # @rspec_example
179
202
  # @return [LinkMetricLimit]
180
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
181
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
182
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
203
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
204
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
205
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
183
206
  def outbound_limit
184
207
  super
185
208
  end
186
209
 
187
210
  ##
188
211
  # Gets the prepaid traffic bandwidth values for this link.
212
+ # @rspec_example
189
213
  # @return [ULong64]
190
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
191
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
192
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
214
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
215
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
216
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
193
217
  def prepaid_traffic
194
218
  super
195
219
  end
196
220
 
197
221
  ##
198
222
  # Gets the ratios used to load-balance the traffic for this link.
223
+ # @rspec_example
199
224
  # @return [long]
200
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
201
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
202
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
225
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
226
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
227
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
203
228
  def ratio
204
229
  super
205
230
  end
206
231
 
207
232
  ##
208
233
  # Gets the statistics for this link.
234
+ # @rspec_example
209
235
  # @return [LinkStatistics]
210
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
211
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
212
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
236
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
237
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
238
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
213
239
  def statistics
214
240
  super
215
241
  end
216
242
 
217
243
  ##
218
244
  # Gets the total limits for link metrics.
245
+ # @rspec_example
219
246
  # @return [LinkMetricLimit]
220
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
221
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
222
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
247
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
248
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
249
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
223
250
  def total_limit
224
251
  super
225
252
  end
226
253
 
227
254
  ##
228
255
  # Gets the IP addresses on the uplink side of the router, used for SNMP probing only.
256
+ # @rspec_example
229
257
  # @return [String]
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.
258
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
259
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
260
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
233
261
  def uplink_address
234
262
  super
235
263
  end
236
264
 
237
265
  ##
238
266
  # Gets the version information for this interface.
267
+ # @rspec_example
239
268
  # @return [String]
240
269
  def version
241
270
  super
@@ -243,28 +272,31 @@ module IControl::GlobalLB
243
272
 
244
273
  ##
245
274
  # Gets the weight types for this link.
275
+ # @rspec_example
246
276
  # @return [LinkWeightType]
247
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
248
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
249
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
277
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
278
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
279
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
250
280
  def weight_type
251
281
  super
252
282
  end
253
283
 
254
284
  ##
255
285
  # Removes any and all cost segment of this link.
256
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
257
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
258
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
286
+ # @rspec_example
287
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
288
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
289
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
259
290
  def remove_all_cost_segments
260
291
  super
261
292
  end
262
293
 
263
294
  ##
264
295
  # Removes the cost segments for this link.
265
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
266
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
267
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
296
+ # @rspec_example
297
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
298
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
299
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
268
300
  # @param [Hash] opts
269
301
  # @option opts [IControl::GlobalLB::Link::LinkCostSegment[]] :cost_segments The cost segments.
270
302
  def remove_cost_segment(opts)
@@ -274,9 +306,10 @@ module IControl::GlobalLB
274
306
 
275
307
  ##
276
308
  # Removes the IP addresses from this link.
277
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
278
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
279
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
309
+ # @rspec_example
310
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
311
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
312
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
280
313
  # @param [Hash] opts
281
314
  # @option opts [IControl::GlobalLB::Link::LinkIPDefinition] :ips The IP addresses to remove from the links.
282
315
  def remove_ip(opts)
@@ -285,28 +318,33 @@ module IControl::GlobalLB
285
318
  end
286
319
 
287
320
  ##
288
- # Removes the monitor associations for this link. This basically deletes the monitor associations between a link and a monitor rule, i.e. this link will no longer be monitored.
289
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
290
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
291
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
321
+ # Removes the monitor associations for this link. This basically deletes the monitor
322
+ # associations between a link and a monitor rule, i.e. this link will no longer be
323
+ # monitored.
324
+ # @rspec_example
325
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
326
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
327
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
292
328
  def remove_monitor_association
293
329
  super
294
330
  end
295
331
 
296
332
  ##
297
333
  # Resets the statistics for this link.
298
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
299
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
300
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
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.
301
338
  def reset_statistics
302
339
  super
303
340
  end
304
341
 
305
342
  ##
306
343
  # Moves this link to the new data centers.
307
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
308
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
309
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
344
+ # @rspec_example
345
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
346
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
347
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
310
348
  # @param [Hash] opts
311
349
  # @option opts [String] :data_centers The names of the new data centers.
312
350
  def set_data_center(opts)
@@ -316,9 +354,10 @@ module IControl::GlobalLB
316
354
 
317
355
  ##
318
356
  # Sets the states indicating whether this link use duplex.
319
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
320
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
321
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
357
+ # @rspec_example
358
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
359
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
360
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
322
361
  # @param [Hash] opts
323
362
  # @option opts [IControl::Common::EnabledState] :states The states to set.
324
363
  def set_duplex_state(opts)
@@ -328,9 +367,10 @@ module IControl::GlobalLB
328
367
 
329
368
  ##
330
369
  # Sets the enabled state of this link.
331
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
332
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
333
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
370
+ # @rspec_example
371
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
372
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
373
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
334
374
  # @param [Hash] opts
335
375
  # @option opts [IControl::Common::EnabledState] :states The enabled states to set.
336
376
  def set_enabled_state(opts)
@@ -340,9 +380,10 @@ module IControl::GlobalLB
340
380
 
341
381
  ##
342
382
  # Sets the inbound limits for link metrics.
343
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
344
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
345
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
383
+ # @rspec_example
384
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
385
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
386
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
346
387
  # @param [Hash] opts
347
388
  # @option opts [IControl::GlobalLB::Link::LinkMetricLimit] :limits The links' metric limits.
348
389
  def set_inbound_limit(opts)
@@ -352,9 +393,10 @@ module IControl::GlobalLB
352
393
 
353
394
  ##
354
395
  # Sets the ISP names for this link.
355
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
356
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
357
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
396
+ # @rspec_example
397
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
398
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
399
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
358
400
  # @param [Hash] opts
359
401
  # @option opts [String] :isp_names The ISP names.
360
402
  def set_isp_name(opts)
@@ -363,10 +405,12 @@ module IControl::GlobalLB
363
405
  end
364
406
 
365
407
  ##
366
- # Sets/creates the monitor associations for this link. This basically creates the monitor associations between a link and a monitor rule.
367
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
368
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
369
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
408
+ # Sets/creates the monitor associations for this link. This basically creates the monitor
409
+ # associations between a link and a monitor rule.
410
+ # @rspec_example
411
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
412
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
413
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
370
414
  # @param [Hash] opts
371
415
  # @option opts [IControl::GlobalLB::Link::MonitorAssociation] :monitor_associations The monitor associations that will be used to evaluate the specified links.
372
416
  def set_monitor_association(opts)
@@ -376,9 +420,10 @@ module IControl::GlobalLB
376
420
 
377
421
  ##
378
422
  # Sets the outbound limits for link metrics.
379
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
380
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
381
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
423
+ # @rspec_example
424
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
425
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
426
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
382
427
  # @param [Hash] opts
383
428
  # @option opts [IControl::GlobalLB::Link::LinkMetricLimit] :limits The links' metric limits.
384
429
  def set_outbound_limit(opts)
@@ -388,9 +433,10 @@ module IControl::GlobalLB
388
433
 
389
434
  ##
390
435
  # Sets the prepaid traffic bandwidth values for this link.
391
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
392
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
393
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
436
+ # @rspec_example
437
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
438
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
439
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
394
440
  # @param [Hash] opts
395
441
  # @option opts [IControl::Common::ULong64] :prepaids The prepaid traffic bandwidths.
396
442
  def set_prepaid_traffic(opts)
@@ -400,9 +446,10 @@ module IControl::GlobalLB
400
446
 
401
447
  ##
402
448
  # Sets the ratios used to load-balance the traffic for this link.
403
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
404
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
405
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
449
+ # @rspec_example
450
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
451
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
452
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
406
453
  # @param [Hash] opts
407
454
  # @option opts [long] :ratios The ratios to set.
408
455
  def set_ratio(opts)
@@ -412,9 +459,10 @@ module IControl::GlobalLB
412
459
 
413
460
  ##
414
461
  # Sets the total limits for link metrics.
415
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
416
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
417
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
462
+ # @rspec_example
463
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
464
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
465
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
418
466
  # @param [Hash] opts
419
467
  # @option opts [IControl::GlobalLB::Link::LinkMetricLimit] :limits The links' metric limits.
420
468
  def set_total_limit(opts)
@@ -424,9 +472,10 @@ module IControl::GlobalLB
424
472
 
425
473
  ##
426
474
  # Sets the IP addresses on the uplink side of the router, used for SNMP probing only.
427
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
428
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
429
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
475
+ # @rspec_example
476
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
477
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
478
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
430
479
  # @param [Hash] opts
431
480
  # @option opts [String] :uplinks The uplink addresses.
432
481
  def set_uplink_address(opts)
@@ -436,9 +485,10 @@ module IControl::GlobalLB
436
485
 
437
486
  ##
438
487
  # Sets the weight types for this link.
439
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
440
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
441
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
488
+ # @rspec_example
489
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
490
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
491
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
442
492
  # @param [Hash] opts
443
493
  # @option opts [IControl::GlobalLB::LinkWeightType] :weight_types The weight types to set.
444
494
  def set_weight_type(opts)
@@ -458,36 +508,36 @@ module IControl::GlobalLB
458
508
  ##
459
509
  # A struct that contains definition for the link and the associated IP addresses.
460
510
  # @attr [String] link The link name.
461
- # @attr [String] addresses The IP addresses associated with the link.
511
+ # @attr [StringSequence] addresses The IP addresses associated with the link.
462
512
  class LinkIPDefinition < IControl::Base::Struct
463
513
  icontrol_attribute :link, String
464
- icontrol_attribute :addresses, String
514
+ icontrol_attribute :addresses, StringSequence
465
515
  end
466
516
 
467
517
  ##
468
518
  # A struct that contains metric limits for a link.
469
519
  # @attr [String] link The link name.
470
- # @attr [IControl::GlobalLB::MetricLimit] metric_limits Metric limits of the link.
520
+ # @attr [IControl::GlobalLB::MetricLimitSequence] metric_limits Metric limits of the link.
471
521
  class LinkMetricLimit < IControl::Base::Struct
472
522
  icontrol_attribute :link, String
473
- icontrol_attribute :metric_limits, IControl::GlobalLB::MetricLimit
523
+ icontrol_attribute :metric_limits, IControl::GlobalLB::MetricLimitSequence
474
524
  end
475
525
 
476
526
  ##
477
527
  # A struct that describes statistics for a particular link.
478
528
  # @attr [String] link The definition that identifies a link.
479
- # @attr [IControl::Common::Statistic] statistics The statistics for the link.
529
+ # @attr [IControl::Common::StatisticSequence] statistics The statistics for the link.
480
530
  class LinkStatisticEntry < IControl::Base::Struct
481
531
  icontrol_attribute :link, String
482
- icontrol_attribute :statistics, IControl::Common::Statistic
532
+ icontrol_attribute :statistics, IControl::Common::StatisticSequence
483
533
  end
484
534
 
485
535
  ##
486
536
  # A struct that describes link statistics and timestamp.
487
- # @attr [IControl::GlobalLB::Link::LinkStatisticEntry] statistics The statistics for a sequence of links.
537
+ # @attr [IControl::GlobalLB::Link::LinkStatisticEntrySequence] statistics The statistics for a sequence of links.
488
538
  # @attr [IControl::Common::TimeStamp] time_stamp The time stamp at the time the statistics are gathered.
489
539
  class LinkStatistics < IControl::Base::Struct
490
- icontrol_attribute :statistics, IControl::GlobalLB::Link::LinkStatisticEntry
540
+ icontrol_attribute :statistics, IControl::GlobalLB::Link::LinkStatisticEntrySequence
491
541
  icontrol_attribute :time_stamp, IControl::Common::TimeStamp
492
542
  end
493
543