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,8 @@
1
1
  module IControl::GlobalLB
2
2
  ##
3
- # The WideIP interface enables you to work with wide IPs, as well as with the pools and the virtual servers that make them up. For example, use the WideIP interface to get a list of wide IPs, to add a wide IP, or to remove a wide IP.
3
+ # The WideIP interface enables you to work with wide IPs, as well as with the pools
4
+ # and the virtual servers that make them up. For example, use the WideIP interface
5
+ # to get a list of wide IPs, to add a wide IP, or to remove a wide IP.
4
6
  class WideIP < IControl::Base
5
7
 
6
8
  set_id_name "wide_ips"
@@ -8,11 +10,18 @@ module IControl::GlobalLB
8
10
  class WideIPPool < IControl::Base::Struct; end
9
11
  class WideIPRule < IControl::Base::Struct; end
10
12
  class WideIPStatisticEntry < IControl::Base::Struct; end
11
- class WideIPStatistics < IControl::Base::Struct; end ##
12
- # Adds/associates aliases to this wide IPs. A given wide IP can have more than one alias.
13
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
14
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
15
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
13
+ class WideIPStatistics < IControl::Base::Struct; end
14
+ class WideIPPoolSequence < IControl::Base::Sequence ; end
15
+ class WideIPPoolSequenceSequence < IControl::Base::SequenceSequence ; end
16
+ class WideIPRuleSequence < IControl::Base::Sequence ; end
17
+ class WideIPRuleSequenceSequence < IControl::Base::SequenceSequence ; end
18
+ class WideIPStatisticEntrySequence < IControl::Base::Sequence ; end ##
19
+ # Adds/associates aliases to this wide IPs. A given wide IP can have more than one
20
+ # alias.
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.
16
25
  # @param [Hash] opts
17
26
  # @option opts [String[]] :aliases The aliases to add to the wide IPs .
18
27
  def add_alias(opts)
@@ -22,9 +31,10 @@ module IControl::GlobalLB
22
31
 
23
32
  ##
24
33
  # Adds/associates wide IP pools to this wide IPs.
25
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
26
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
27
- # @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.
28
38
  # @param [Hash] opts
29
39
  # @option opts [IControl::GlobalLB::WideIP::WideIPPool[]] :wideip_pools The wide IP pools to add to the wide IPs .
30
40
  def add_wideip_pool(opts)
@@ -34,9 +44,10 @@ module IControl::GlobalLB
34
44
 
35
45
  ##
36
46
  # Adds/associates wide IP rules to this wide IPs.
37
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
38
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
39
- # @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.
40
51
  # @param [Hash] opts
41
52
  # @option opts [IControl::GlobalLB::WideIP::WideIPRule[]] :wideip_rules The wide IP rules to add to the wide IPs .
42
53
  def add_wideip_rule(opts)
@@ -46,9 +57,10 @@ module IControl::GlobalLB
46
57
 
47
58
  ##
48
59
  # Creates this wide IPs with some basic attributes.
49
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
50
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
51
- # @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.
52
64
  # @param [Hash] opts
53
65
  # @option opts [IControl::GlobalLB::LBMethod] :lb_methods The load-balancing methods used when picking a pool to use when responding to a DNS request.
54
66
  # @option opts [IControl::GlobalLB::WideIP::WideIPPool[]] :wideip_pools The list of wide IP pools.
@@ -60,145 +72,164 @@ module IControl::GlobalLB
60
72
 
61
73
  ##
62
74
  # Deletes all wide IPs.
63
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
64
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
65
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
75
+ # @rspec_example
76
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
77
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
78
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
66
79
  def delete_all_wideips
67
80
  super
68
81
  end
69
82
 
70
83
  ##
71
84
  # Deletes this wide IPs.
72
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
73
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
74
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
85
+ # @rspec_example
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.
75
89
  def delete_wideip
76
90
  super
77
91
  end
78
92
 
79
93
  ##
80
- # Gets the lists of aliases this wide IPs are associated with. A given wide IP can have more than one alias.
94
+ # Gets the lists of aliases this wide IPs are associated with. A given wide IP can
95
+ # have more than one alias.
96
+ # @rspec_example
81
97
  # @return [String[]]
82
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
83
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
84
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
98
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
99
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
100
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
85
101
  def alias
86
102
  super
87
103
  end
88
104
 
89
105
  ##
90
106
  # Gets the statistics for all the wide IPs.
107
+ # @rspec_example
91
108
  # @return [WideIPStatistics]
92
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
93
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
94
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
109
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
110
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
111
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
95
112
  def all_statistics
96
113
  super
97
114
  end
98
115
 
99
116
  ##
100
117
  # Gets the names of the applications for this wide IPs.
118
+ # @rspec_example
101
119
  # @return [String]
102
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
103
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
104
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
120
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
121
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
122
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
105
123
  def application
106
124
  super
107
125
  end
108
126
 
109
127
  ##
110
128
  # Gets the enabled states for this wide IPs.
129
+ # @rspec_example
111
130
  # @return [EnabledState]
112
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
113
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
114
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
131
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
132
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
133
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
115
134
  def enabled_state
116
135
  super
117
136
  end
118
137
 
119
138
  ##
120
139
  # Gets the names of the last resort pools for this wide IPs.
140
+ # @rspec_example
121
141
  # @return [String]
122
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
123
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
124
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
142
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
143
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
144
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
125
145
  def last_resort_pool
126
146
  super
127
147
  end
128
148
 
129
149
  ##
130
150
  # Gets the load balancing methods for this wide IPs.
151
+ # @rspec_example
131
152
  # @return [LBMethod]
132
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
133
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
134
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
153
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
154
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
155
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
135
156
  def lb_method
136
157
  super
137
158
  end
138
159
 
139
160
  ##
140
161
  # Gets a list of wide IPs.
162
+ # @rspec_example
141
163
  # @return [String]
142
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
143
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
144
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
164
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
165
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
166
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
145
167
  def list
146
168
  super
147
169
  end
148
170
 
149
171
  ##
150
172
  # Gets the statuses of this wide IPs.
173
+ # @rspec_example
151
174
  # @return [ObjectStatus]
152
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
153
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
154
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
175
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
176
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
177
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
155
178
  def object_status
156
179
  super
157
180
  end
158
181
 
159
182
  ##
160
- # Gets the states indicating whether to maintain a connection between an LDNS and a particular virtual server.
183
+ # Gets the states indicating whether to maintain a connection between an LDNS and a
184
+ # particular virtual server.
185
+ # @rspec_example
161
186
  # @return [EnabledState]
162
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
163
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
164
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
187
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
188
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
189
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
165
190
  def persistence_state
166
191
  super
167
192
  end
168
193
 
169
194
  ##
170
- # Gets the persistence TTL values of this wide IPs. These values (in seconds) indicate the time to maintain a connection between an LDNS and a particular virtual server.
195
+ # Gets the persistence TTL values of this wide IPs. These values (in seconds) indicate
196
+ # the time to maintain a connection between an LDNS and a particular virtual server.
197
+ # @rspec_example
171
198
  # @return [long]
172
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
173
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
174
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
199
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
200
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
201
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
175
202
  def persistence_ttl
176
203
  super
177
204
  end
178
205
 
179
206
  ##
180
207
  # Gets the statistics for this wide IPs.
208
+ # @rspec_example
181
209
  # @return [WideIPStatistics]
182
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
183
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
184
- # @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.
185
213
  def statistics
186
214
  super
187
215
  end
188
216
 
189
217
  ##
190
218
  # Gets the version information for this interface.
219
+ # @rspec_example
191
220
  # @return [String]
192
221
  def version
193
222
  super
194
223
  end
195
224
 
196
225
  ##
197
- # Gets the lists of wide IPs associated with this aliases. Each alias maps to exactly one wide IP.
226
+ # Gets the lists of wide IPs associated with this aliases. Each alias maps to exactly
227
+ # one wide IP.
228
+ # @rspec_example
198
229
  # @return [String[]]
199
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
200
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
201
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
230
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
231
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
232
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
202
233
  # @param [Hash] opts
203
234
  # @option opts [String] :aliases The list of aliases.
204
235
  def wideip(opts)
@@ -208,29 +239,32 @@ module IControl::GlobalLB
208
239
 
209
240
  ##
210
241
  # Gets the lists of wide IP pools this wide IPs are associated with.
242
+ # @rspec_example
211
243
  # @return [WideIPPool[]]
212
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
213
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
214
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
244
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
245
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
246
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
215
247
  def wideip_pool
216
248
  super
217
249
  end
218
250
 
219
251
  ##
220
252
  # Gets the lists of wide IP rules this wide IPs are associated with.
253
+ # @rspec_example
221
254
  # @return [WideIPRule[]]
222
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
223
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
224
- # @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.
225
258
  def wideip_rule
226
259
  super
227
260
  end
228
261
 
229
262
  ##
230
263
  # Removes aliases from this wide IPs. A given wide IP can have more than one alias.
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.
264
+ # @rspec_example
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.
234
268
  # @param [Hash] opts
235
269
  # @option opts [String[]] :aliases The aliases to remove from the wide IPs .
236
270
  def remove_alias(opts)
@@ -240,36 +274,40 @@ module IControl::GlobalLB
240
274
 
241
275
  ##
242
276
  # Removes all aliases from this wide IPs.
243
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
244
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
245
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
277
+ # @rspec_example
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.
246
281
  def remove_all_aliases
247
282
  super
248
283
  end
249
284
 
250
285
  ##
251
286
  # Removes all wide IP pools from this wide IPs.
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.
287
+ # @rspec_example
288
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
289
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
290
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
255
291
  def remove_all_wideip_pools
256
292
  super
257
293
  end
258
294
 
259
295
  ##
260
296
  # Removes all wide IP rules from this wide IPs.
261
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
262
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
263
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
297
+ # @rspec_example
298
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
299
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
300
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
264
301
  def remove_all_wideip_rules
265
302
  super
266
303
  end
267
304
 
268
305
  ##
269
306
  # Removes wide IP pools from this wide IPs.
270
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
271
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
272
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
307
+ # @rspec_example
308
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
309
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
310
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
273
311
  # @param [Hash] opts
274
312
  # @option opts [IControl::GlobalLB::WideIP::WideIPPool[]] :wideip_pools The wide IP pools to remove from the wide IPs .
275
313
  def remove_wideip_pool(opts)
@@ -279,9 +317,10 @@ module IControl::GlobalLB
279
317
 
280
318
  ##
281
319
  # Removes wide IP rules from this wide IPs.
282
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
283
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
284
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
320
+ # @rspec_example
321
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
322
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
323
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
285
324
  # @param [Hash] opts
286
325
  # @option opts [IControl::GlobalLB::WideIP::WideIPRule[]] :wideip_rules The wide IP rules to remove from the wide IPs .
287
326
  def remove_wideip_rule(opts)
@@ -290,28 +329,32 @@ module IControl::GlobalLB
290
329
  end
291
330
 
292
331
  ##
293
- # Resets the names of the applications for this wide IPs (i.e., sets them to nothing). This function disassociates each wide IP given from any application.
294
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
295
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
296
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
332
+ # Resets the names of the applications for this wide IPs (i.e., sets them to nothing).
333
+ # This function disassociates each wide IP given from any application.
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.
297
338
  def reset_application
298
339
  super
299
340
  end
300
341
 
301
342
  ##
302
343
  # Resets the statistics for this wide IPs.
303
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
304
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
305
- # @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.
306
348
  def reset_statistics
307
349
  super
308
350
  end
309
351
 
310
352
  ##
311
353
  # Sets the names of the applications for this wide IPs.
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.
354
+ # @rspec_example
355
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
356
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
357
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
315
358
  # @param [Hash] opts
316
359
  # @option opts [String] :applications The names of the applications for the specified wide IPs .
317
360
  def set_application(opts)
@@ -321,9 +364,10 @@ module IControl::GlobalLB
321
364
 
322
365
  ##
323
366
  # Sets the enabled states for this wide IPs.
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.
367
+ # @rspec_example
368
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
369
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
370
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
327
371
  # @param [Hash] opts
328
372
  # @option opts [IControl::Common::EnabledState] :states The states to set for the wide IPs .
329
373
  def set_enabled_state(opts)
@@ -333,9 +377,10 @@ module IControl::GlobalLB
333
377
 
334
378
  ##
335
379
  # Sets the names of the last resort pools for this wide IPs.
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.
380
+ # @rspec_example
381
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
382
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
383
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
339
384
  # @param [Hash] opts
340
385
  # @option opts [String] :pool_names The names of the last resort pools for the specified wide IPs .
341
386
  def set_last_resort_pool(opts)
@@ -344,10 +389,12 @@ module IControl::GlobalLB
344
389
  end
345
390
 
346
391
  ##
347
- # Sets the load balancing methods for this wide IPs. This is used by the wide IPs when picking a pool to use when responding to a DNS request.
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.
392
+ # Sets the load balancing methods for this wide IPs. This is used by the wide IPs when
393
+ # picking a pool to use when responding to a DNS request.
394
+ # @rspec_example
395
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
396
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
397
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
351
398
  # @param [Hash] opts
352
399
  # @option opts [IControl::GlobalLB::LBMethod] :lb_methods The load balancing methods to use for the wide IPs .
353
400
  def set_lb_method(opts)
@@ -356,10 +403,12 @@ module IControl::GlobalLB
356
403
  end
357
404
 
358
405
  ##
359
- # Sets the states indicating whether to maintain a connection between an LDNS and a particular virtual server.
360
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
361
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
362
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
406
+ # Sets the states indicating whether to maintain a connection between an LDNS and a
407
+ # particular virtual server.
408
+ # @rspec_example
409
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
410
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
411
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
363
412
  # @param [Hash] opts
364
413
  # @option opts [IControl::Common::EnabledState] :states The states to set for the wide IPs .
365
414
  def set_persistence_state(opts)
@@ -368,10 +417,12 @@ module IControl::GlobalLB
368
417
  end
369
418
 
370
419
  ##
371
- # Sets the persistence TTL values of this wide IPs. These values (in seconds) indicate the time to maintain a connection between an LDNS and a particular virtual server.
372
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
373
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
374
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
420
+ # Sets the persistence TTL values of this wide IPs. These values (in seconds) indicate
421
+ # the time to maintain a connection between an LDNS and a particular virtual server.
422
+ # @rspec_example
423
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
424
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
425
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
375
426
  # @param [Hash] opts
376
427
  # @option opts [long] :values The persistence TTLs of the specified wide IPs .
377
428
  def set_persistence_ttl(opts)
@@ -402,18 +453,18 @@ module IControl::GlobalLB
402
453
  ##
403
454
  # A struct that describes statistics for a particular wide IP.
404
455
  # @attr [String] wide_ip The wide IP name.
405
- # @attr [IControl::Common::Statistic] statistics The statistics for the wide IP.
456
+ # @attr [IControl::Common::StatisticSequence] statistics The statistics for the wide IP.
406
457
  class WideIPStatisticEntry < IControl::Base::Struct
407
458
  icontrol_attribute :wide_ip, String
408
- icontrol_attribute :statistics, IControl::Common::Statistic
459
+ icontrol_attribute :statistics, IControl::Common::StatisticSequence
409
460
  end
410
461
 
411
462
  ##
412
463
  # A struct that describes wide IP statistics and timestamp.
413
- # @attr [IControl::GlobalLB::WideIP::WideIPStatisticEntry] statistics The statistics for a sequence of wide IPs .
464
+ # @attr [IControl::GlobalLB::WideIP::WideIPStatisticEntrySequence] statistics The statistics for a sequence of wide IPs .
414
465
  # @attr [IControl::Common::TimeStamp] time_stamp The time stamp at the time the statistics are gathered.
415
466
  class WideIPStatistics < IControl::Base::Struct
416
- icontrol_attribute :statistics, IControl::GlobalLB::WideIP::WideIPStatisticEntry
467
+ icontrol_attribute :statistics, IControl::GlobalLB::WideIP::WideIPStatisticEntrySequence
417
468
  icontrol_attribute :time_stamp, IControl::Common::TimeStamp
418
469
  end
419
470