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
@@ -34,6 +34,74 @@ module IControl::LocalLB
34
34
  class ProfileULong < IControl::Base::Struct; end
35
35
  class ProfileUShort < IControl::Base::Struct; end
36
36
  class ProfileUncleanShutdownMode < IControl::Base::Struct; end
37
+ class AddressTypeSequence < IControl::Base::Sequence ; end
38
+ class AuthenticationMethodSequence < IControl::Base::Sequence ; end
39
+ class AvailabilityStatusSequence < IControl::Base::Sequence ; end
40
+ class ClientSSLCertificateModeSequence < IControl::Base::Sequence ; end
41
+ class ClonePoolTypeSequence < IControl::Base::Sequence ; end
42
+ class CompressionMethodSequence < IControl::Base::Sequence ; end
43
+ class CookiePersistenceMethodSequence < IControl::Base::Sequence ; end
44
+ class CredentialSourceSequence < IControl::Base::Sequence ; end
45
+ class EnabledStatusSequence < IControl::Base::Sequence ; end
46
+ class HardwareAccelerationModeSequence < IControl::Base::Sequence ; end
47
+ class HttpChunkModeSequence < IControl::Base::Sequence ; end
48
+ class HttpCompressionModeSequence < IControl::Base::Sequence ; end
49
+ class HttpRedirectRewriteModeSequence < IControl::Base::Sequence ; end
50
+ class LBMethodSequence < IControl::Base::Sequence ; end
51
+ class MatchPatternStringSequence < IControl::Base::Sequence ; end
52
+ class MatchPatternStringSequenceSequence < IControl::Base::SequenceSequence ; end
53
+ class MonitorIPPortSequence < IControl::Base::Sequence ; end
54
+ class MonitorIPSequence < IControl::Base::Sequence ; end
55
+ class MonitorInstanceSequence < IControl::Base::Sequence ; end
56
+ class MonitorInstanceStateSequence < IControl::Base::Sequence ; end
57
+ class MonitorInstanceStateSequenceSequence < IControl::Base::SequenceSequence ; end
58
+ class MonitorInstanceStateTypeSequence < IControl::Base::Sequence ; end
59
+ class MonitorRuleSequence < IControl::Base::Sequence ; end
60
+ class MonitorStatusSequence < IControl::Base::Sequence ; end
61
+ class ObjectStatusSequence < IControl::Base::Sequence ; end
62
+ class PersistenceModeSequence < IControl::Base::Sequence ; end
63
+ class PersistenceRecordSequence < IControl::Base::Sequence ; end
64
+ class PersistenceRecordSequenceSequence < IControl::Base::SequenceSequence ; end
65
+ class ProfileAuthenticationMethodSequence < IControl::Base::Sequence ; end
66
+ class ProfileClientSSLCertificateModeSequence < IControl::Base::Sequence ; end
67
+ class ProfileCompressionMethodSequence < IControl::Base::Sequence ; end
68
+ class ProfileContextTypeSequence < IControl::Base::Sequence ; end
69
+ class ProfileCookiePersistenceMethodSequence < IControl::Base::Sequence ; end
70
+ class ProfileCredentialSourceSequence < IControl::Base::Sequence ; end
71
+ class ProfileEnabledStateSequence < IControl::Base::Sequence ; end
72
+ class ProfileHardwareAccelerationModeSequence < IControl::Base::Sequence ; end
73
+ class ProfileHttpChunkModeSequence < IControl::Base::Sequence ; end
74
+ class ProfileHttpCompressionModeSequence < IControl::Base::Sequence ; end
75
+ class ProfileHttpRedirectRewriteModeSequence < IControl::Base::Sequence ; end
76
+ class ProfileIPAddressSequence < IControl::Base::Sequence ; end
77
+ class ProfileMatchPatternStringArraySequence < IControl::Base::Sequence ; end
78
+ class ProfilePersistenceModeSequence < IControl::Base::Sequence ; end
79
+ class ProfilePortNumberSequence < IControl::Base::Sequence ; end
80
+ class ProfileProfileModeSequence < IControl::Base::Sequence ; end
81
+ class ProfileRamCacheCacheControlModeSequence < IControl::Base::Sequence ; end
82
+ class ProfileRtspProxyTypeSequence < IControl::Base::Sequence ; end
83
+ class ProfileSSLOptionSequence < IControl::Base::Sequence ; end
84
+ class ProfileServerSSLCertificateModeSequence < IControl::Base::Sequence ; end
85
+ class ProfileStringArraySequence < IControl::Base::Sequence ; end
86
+ class ProfileStringSequence < IControl::Base::Sequence ; end
87
+ class ProfileTCPCongestionControlModeSequence < IControl::Base::Sequence ; end
88
+ class ProfileTCPOptionModeSequence < IControl::Base::Sequence ; end
89
+ class ProfileTypeSequence < IControl::Base::Sequence ; end
90
+ class ProfileULongSequence < IControl::Base::Sequence ; end
91
+ class ProfileUShortSequence < IControl::Base::Sequence ; end
92
+ class ProfileUncleanShutdownModeSequence < IControl::Base::Sequence ; end
93
+ class RamCacheCacheControlModeSequence < IControl::Base::Sequence ; end
94
+ class RtspProxyTypeSequence < IControl::Base::Sequence ; end
95
+ class SSLOptionSequence < IControl::Base::Sequence ; end
96
+ class SSLOptionSequenceSequence < IControl::Base::SequenceSequence ; end
97
+ class ServerSSLCertificateModeSequence < IControl::Base::Sequence ; end
98
+ class ServiceDownActionSequence < IControl::Base::Sequence ; end
99
+ class SessionStatusSequence < IControl::Base::Sequence ; end
100
+ class SnatTypeSequence < IControl::Base::Sequence ; end
101
+ class TCPCongestionControlModeSequence < IControl::Base::Sequence ; end
102
+ class TCPOptionModeSequence < IControl::Base::Sequence ; end
103
+ class UncleanShutdownModeSequence < IControl::Base::Sequence ; end
104
+ class VirtualAddressStatusDependencySequence < IControl::Base::Sequence ; end
37
105
  class Klass < IControl::Base; end
38
106
  class Monitor < IControl::Base; end
39
107
  class NAT < IControl::Base; end
@@ -135,7 +203,8 @@ module IControl::LocalLB
135
203
  class TCPOptionMode < IControl::Base::Enumeration; end
136
204
  # A list of profile's unclean shutdown modes.
137
205
  class UncleanShutdownMode < IControl::Base::Enumeration; end
138
- # An enumeration of virtual address status dependency types. This indicates how status of the related virtual servers affects status of the virtual address.
206
+ # An enumeration of virtual address status dependency types. This indicates how status
207
+ # of the related virtual servers affects status of the virtual address.
139
208
  class VirtualAddressStatusDependency < IControl::Base::Enumeration; end##
140
209
  # A struct that describes a pattern, represented either as a glob or a regular expression.
141
210
  # @attr [String] pattern The match pattern string.
@@ -155,7 +224,8 @@ module IControl::LocalLB
155
224
  end
156
225
 
157
226
  ##
158
- # A struct that describes monitored node server definition, used in the destination address:port of the monitor template.
227
+ # A struct that describes monitored node server definition, used in the destination
228
+ # address:port of the monitor template.
159
229
  # @attr [IControl::LocalLB::AddressType] address_type The address type of the IP:port specified in ipport.
160
230
  # @attr [IControl::Common::IPPortDefinition] ipport The IP:port definition.
161
231
  class MonitorIPPort < IControl::Base::Struct
@@ -187,7 +257,7 @@ module IControl::LocalLB
187
257
  # An struct that specifies a monitor rule.
188
258
  # @attr [IControl::LocalLB::MonitorRuleType] type An indicator of how to deal/interpret with the list of monitors in monitor_templates.
189
259
  # @attr [Numeric] quorum A value to be used when type is MONITOR_RULE_TYPE_M_OF_N, i.e. this value is the M in M of N. This value is ignored for other rule types.
190
- # @attr [String] monitor_templates The list of monitors that constitutes this monitor rule.
260
+ # @attr [StringSequence] monitor_templates The list of monitors that constitutes this monitor rule.
191
261
  class MonitorRule < IControl::Base::Struct
192
262
  icontrol_attribute :type, IControl::LocalLB::MonitorRuleType
193
263
  icontrol_attribute :quorum, Numeric
@@ -325,10 +395,10 @@ module IControl::LocalLB
325
395
 
326
396
  ##
327
397
  # A structure that specifies a sequence of match pattern strings used in profile attributes.
328
- # @attr [IControl::LocalLB::MatchPatternString] values The attribute match pattern strings.
398
+ # @attr [IControl::LocalLB::MatchPatternStringSequence] values The attribute match pattern strings.
329
399
  # @attr [Object] default_flag The flag that indicates how the value should be interpreted. On queries, if default_flag is true, that means the requested value is the parent profile's default value. If false, that means the requested value has been explicitly set by the user. On creations/modifications, if default_flag is true, that means the parent profile's default value should be restored for this attribute value, hence the passed-in value is ignored. If false, that means the user wants to set the attribute value using the passed-in value.
330
400
  class ProfileMatchPatternStringArray < IControl::Base::Struct
331
- icontrol_attribute :values, IControl::LocalLB::MatchPatternString
401
+ icontrol_attribute :values, IControl::LocalLB::MatchPatternStringSequence
332
402
  icontrol_attribute :default_flag, Object
333
403
  end
334
404
 
@@ -379,10 +449,10 @@ module IControl::LocalLB
379
449
 
380
450
  ##
381
451
  # A structure that specifies a profile's SSL options.
382
- # @attr [IControl::LocalLB::SSLOption] values The SSL options.
452
+ # @attr [IControl::LocalLB::SSLOptionSequence] values The SSL options.
383
453
  # @attr [Object] default_flag The flag that indicates how the value should be interpreted. On queries, if default_flag is true, that means the requested value is the parent profile's default value. If false, that means the requested value has been explicitly set by the user. On creations/modifications, if default_flag is true, that means the parent profile's default value should be restored for this attribute value, hence the passed-in value is ignored. If false, that means the user wants to set the attribute value using the passed-in value.
384
454
  class ProfileSSLOption < IControl::Base::Struct
385
- icontrol_attribute :values, IControl::LocalLB::SSLOption
455
+ icontrol_attribute :values, IControl::LocalLB::SSLOptionSequence
386
456
  icontrol_attribute :default_flag, Object
387
457
  end
388
458
 
@@ -406,10 +476,10 @@ module IControl::LocalLB
406
476
 
407
477
  ##
408
478
  # A structure that specifies a sequence of strings used in profile attributes.
409
- # @attr [String] values The attribute strings.
479
+ # @attr [StringSequence] values The attribute strings.
410
480
  # @attr [Object] default_flag The flag that indicates how the value should be interpreted. On queries, if default_flag is true, that means the requested value is the parent profile's default value. If false, that means the requested value has been explicitly set by the user. On creations/modifications, if default_flag is true, that means the parent profile's default value should be restored for this attribute value, hence the passed-in value is ignored. If false, that means the user wants to set the attribute value using the passed-in value.
411
481
  class ProfileStringArray < IControl::Base::Struct
412
- icontrol_attribute :values, String
482
+ icontrol_attribute :values, StringSequence
413
483
  icontrol_attribute :default_flag, Object
414
484
  end
415
485
 
@@ -1185,7 +1255,8 @@ module IControl::LocalLB
1185
1255
  end
1186
1256
 
1187
1257
 
1188
- # An enumeration of virtual address status dependency types. This indicates how status of the related virtual servers affects status of the virtual address.
1258
+ # An enumeration of virtual address status dependency types. This indicates how status
1259
+ # of the related virtual servers affects status of the virtual address.
1189
1260
  class VirtualAddressStatusDependency < IControl::Base::Enumeration
1190
1261
  # Virtual address is always green regardless of virtual servers' status.
1191
1262
  VIRTUAL_ADDRESS_STATUS_DEPENDENCY_NONE = :VIRTUAL_ADDRESS_STATUS_DEPENDENCY_NONE
@@ -1,6 +1,7 @@
1
1
  module IControl::LocalLB
2
2
  ##
3
- # The Class interface enables you to manipulate a local load balancer's Class attributes. There are 3 different Class types: Address, String, and Value.
3
+ # The Class interface enables you to manipulate a local load balancer's Class attributes.
4
+ # There are 3 different Class types: Address, String, and Value.
4
5
  class Klass < IControl::Base
5
6
 
6
7
  set_id_name "class_members"
@@ -10,6 +11,15 @@ module IControl::LocalLB
10
11
  class MetaInformation < IControl::Base::Struct; end
11
12
  class StringClass < IControl::Base::Struct; end
12
13
  class ValueClass < IControl::Base::Struct; end
14
+ class AddressClassSequence < IControl::Base::Sequence ; end
15
+ class AddressEntrySequence < IControl::Base::Sequence ; end
16
+ class AddressEntrySequenceSequence < IControl::Base::SequenceSequence ; end
17
+ class ClassTypeSequence < IControl::Base::Sequence ; end
18
+ class FileFormatTypeSequence < IControl::Base::Sequence ; end
19
+ class FileModeTypeSequence < IControl::Base::Sequence ; end
20
+ class MetaInformationSequence < IControl::Base::Sequence ; end
21
+ class StringClassSequence < IControl::Base::Sequence ; end
22
+ class ValueClassSequence < IControl::Base::Sequence ; end
13
23
  # A list of different class types.
14
24
  class ClassType < IControl::Base::Enumeration; end
15
25
  # A list of different file format types.
@@ -17,36 +27,40 @@ module IControl::LocalLB
17
27
  # A list of different file mode types.
18
28
  class FileModeType < IControl::Base::Enumeration; end ##
19
29
  # Incrementally adds address class member.
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
+ # @rspec_example
31
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
32
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
33
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
23
34
  def add_address_class_member
24
35
  super
25
36
  end
26
37
 
27
38
  ##
28
39
  # Incrementally adds string class member.
29
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
30
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
31
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
40
+ # @rspec_example
41
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
42
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
43
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
32
44
  def add_string_class_member
33
45
  super
34
46
  end
35
47
 
36
48
  ##
37
49
  # Incrementally adds value class member.
38
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
39
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
40
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
50
+ # @rspec_example
51
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
52
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
53
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
41
54
  def add_value_class_member
42
55
  super
43
56
  end
44
57
 
45
58
  ##
46
59
  # Creates address classes. The specified classes must not already exist.
47
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
48
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
49
- # @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.
50
64
  # @param [Hash] opts
51
65
  # @option opts [IControl::LocalLB::Class::AddressClass] :classes The class names and the class members.
52
66
  def create_address_class(opts)
@@ -55,10 +69,13 @@ module IControl::LocalLB
55
69
  end
56
70
 
57
71
  ##
58
- # Creates external classes. Note: As of v9.6.0, the validation on the file_name field in external_classes was improved to ensure the class file exists on pain of Common::OperationFailed exception.
59
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
60
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
61
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
72
+ # Creates external classes. Note: As of v9.6.0, the validation on the file_name field
73
+ # in external_classes was improved to ensure the class file exists on pain of Common::OperationFailed
74
+ # exception.
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.
62
79
  # @param [Hash] opts
63
80
  # @option opts [IControl::LocalLB::Class::MetaInformation] :external_classes The sequence of external classes to create.
64
81
  def create_external_class(opts)
@@ -68,9 +85,10 @@ module IControl::LocalLB
68
85
 
69
86
  ##
70
87
  # Creates string classes. The specified classes must not already exist.
71
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
72
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
73
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
88
+ # @rspec_example
89
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
90
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
91
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
74
92
  # @param [Hash] opts
75
93
  # @option opts [IControl::LocalLB::Class::StringClass] :classes The class names and the class members.
76
94
  def create_string_class(opts)
@@ -80,9 +98,10 @@ module IControl::LocalLB
80
98
 
81
99
  ##
82
100
  # Creates value classes. The specified classes must not already exist.
83
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
84
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
85
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
101
+ # @rspec_example
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.
86
105
  # @param [Hash] opts
87
106
  # @option opts [IControl::LocalLB::Class::ValueClass] :classes The class names and the class members.
88
107
  def create_value_class(opts)
@@ -92,45 +111,51 @@ module IControl::LocalLB
92
111
 
93
112
  ##
94
113
  # Incrementally deletes address class member.
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.
114
+ # @rspec_example
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.
98
118
  def delete_address_class_member
99
119
  super
100
120
  end
101
121
 
102
122
  ##
103
123
  # Deletes all address classes.
104
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
105
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
106
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
124
+ # @rspec_example
125
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
126
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
127
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
107
128
  def delete_all_address_classes
108
129
  super
109
130
  end
110
131
 
111
132
  ##
112
133
  # Deletes all string classes.
113
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
114
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
115
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
134
+ # @rspec_example
135
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
136
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
137
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
116
138
  def delete_all_string_classes
117
139
  super
118
140
  end
119
141
 
120
142
  ##
121
143
  # Deletes all value classes.
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.
144
+ # @rspec_example
145
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
146
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
147
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
125
148
  def delete_all_value_classes
126
149
  super
127
150
  end
128
151
 
129
152
  ##
130
- # Deletes this classes. The specified classes can be of any class type, even external classes.
131
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
132
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
133
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
153
+ # Deletes this classes. The specified classes can be of any class type, even external
154
+ # classes.
155
+ # @rspec_example
156
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
157
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
158
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
134
159
  # @param [Hash] opts
135
160
  # @option opts [String] :classes The classes to delete.
136
161
  def delete_class(opts)
@@ -140,58 +165,64 @@ module IControl::LocalLB
140
165
 
141
166
  ##
142
167
  # Incrementally deletes string class member.
143
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
144
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
145
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
168
+ # @rspec_example
169
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
170
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
171
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
146
172
  def delete_string_class_member
147
173
  super
148
174
  end
149
175
 
150
176
  ##
151
177
  # Incrementally deletes value class member.
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.
178
+ # @rspec_example
179
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
180
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
181
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
155
182
  def delete_value_class_member
156
183
  super
157
184
  end
158
185
 
159
186
  ##
160
187
  # Checks to see if this class member are in this class names.
188
+ # @rspec_example
161
189
  # @return [boolean[]]
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.
190
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
191
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
192
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
165
193
  def find_address_class_member
166
194
  super
167
195
  end
168
196
 
169
197
  ##
170
198
  # Checks to see if this class member are in this class names.
199
+ # @rspec_example
171
200
  # @return [boolean[]]
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.
201
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
202
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
203
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
175
204
  def find_string_class_member
176
205
  super
177
206
  end
178
207
 
179
208
  ##
180
209
  # Checks to see if this class member are in this class names.
210
+ # @rspec_example
181
211
  # @return [boolean[]]
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.
212
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
213
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
214
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
185
215
  def find_value_class_member
186
216
  super
187
217
  end
188
218
 
189
219
  ##
190
220
  # Gets this address classes.
221
+ # @rspec_example
191
222
  # @return [AddressClass]
192
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
193
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
194
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
223
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
224
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
225
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
195
226
  # @param [Hash] opts
196
227
  # @option opts [String] :class_names The class names.
197
228
  def address_class(opts)
@@ -201,30 +232,36 @@ module IControl::LocalLB
201
232
 
202
233
  ##
203
234
  # Gets the list of available address classes.
235
+ # @rspec_example
204
236
  # @return [String]
205
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
206
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
207
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
237
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
238
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
239
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
208
240
  def address_class_list
209
241
  super
210
242
  end
211
243
 
212
244
  ##
213
- # Gets the data values associated with a set of address class member. This method is effectively the lookup method for using the class as a value map.
245
+ # Gets the data values associated with a set of address class member. This method is
246
+ # effectively the lookup method for using the class as a value map.
247
+ # @rspec_example
214
248
  # @return [String[]]
215
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
216
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
217
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
249
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
250
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
251
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
218
252
  def address_class_member_data_value
219
253
  super
220
254
  end
221
255
 
222
256
  ##
223
- # Gets the meta data information for this classes. For external classes, the meta information will indicate the external file and other relevant information. For non-external classes, only applicable information such as class name/type will be of importance.
257
+ # Gets the meta data information for this classes. For external classes, the meta information
258
+ # will indicate the external file and other relevant information. For non-external
259
+ # classes, only applicable information such as class name/type will be of importance.
260
+ # @rspec_example
224
261
  # @return [MetaInformation]
225
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
226
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
227
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
262
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
263
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
264
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
228
265
  # @param [Hash] opts
229
266
  # @option opts [String] :class_names The class names to retrieve class meta information from.
230
267
  def class_meta_information(opts)
@@ -234,10 +271,11 @@ module IControl::LocalLB
234
271
 
235
272
  ##
236
273
  # Gets the class types for this classes.
274
+ # @rspec_example
237
275
  # @return [ClassType]
238
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
239
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
240
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
276
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
277
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
278
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
241
279
  # @param [Hash] opts
242
280
  # @option opts [String] :class_names The class names to retrieve class types.
243
281
  def class_type(opts)
@@ -246,11 +284,13 @@ module IControl::LocalLB
246
284
  end
247
285
 
248
286
  ##
249
- # Gets the strings used to separate a class member value from its optional associated data value for a set of classes.
287
+ # Gets the strings used to separate a class member value from its optional associated
288
+ # data value for a set of classes.
289
+ # @rspec_example
250
290
  # @return [String]
251
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
252
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
253
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
291
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
292
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
293
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
254
294
  # @param [Hash] opts
255
295
  # @option opts [String] :class_names Names of the requested classes
256
296
  def data_separator(opts)
@@ -259,11 +299,13 @@ module IControl::LocalLB
259
299
  end
260
300
 
261
301
  ##
262
- # Gets the file format for this classes. This should only be called for external classes, since it does not make sense for non-external classes.
302
+ # Gets the file format for this classes. This should only be called for external classes,
303
+ # since it does not make sense for non-external classes.
304
+ # @rspec_example
263
305
  # @return [FileFormatType]
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.
306
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
307
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
308
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
267
309
  # @param [Hash] opts
268
310
  # @option opts [String] :class_names The class names to retrieve file formats.
269
311
  def external_class_file_format(opts)
@@ -272,11 +314,13 @@ module IControl::LocalLB
272
314
  end
273
315
 
274
316
  ##
275
- # Gets the file modes for this classes. This should only be called for external classes, since it does not make sense for non-external classes.
317
+ # Gets the file modes for this classes. This should only be called for external classes,
318
+ # since it does not make sense for non-external classes.
319
+ # @rspec_example
276
320
  # @return [FileModeType]
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.
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.
280
324
  # @param [Hash] opts
281
325
  # @option opts [String] :class_names The class names to retrieve file modes.
282
326
  def external_class_file_mode(opts)
@@ -285,11 +329,13 @@ module IControl::LocalLB
285
329
  end
286
330
 
287
331
  ##
288
- # Gets the file names for this classes. This should only be called for external classes, since it does not make sense for non-external classes.
332
+ # Gets the file names for this classes. This should only be called for external classes,
333
+ # since it does not make sense for non-external classes.
334
+ # @rspec_example
289
335
  # @return [String]
290
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
291
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
292
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
336
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
337
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
338
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
293
339
  # @param [Hash] opts
294
340
  # @option opts [String] :class_names The class names to retrieve file names.
295
341
  def external_class_file_name(opts)
@@ -299,20 +345,22 @@ module IControl::LocalLB
299
345
 
300
346
  ##
301
347
  # Gets the list of all available external classes.
348
+ # @rspec_example
302
349
  # @return [MetaInformation]
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.
350
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
351
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
352
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
306
353
  def external_class_list
307
354
  super
308
355
  end
309
356
 
310
357
  ##
311
358
  # Gets this string classes.
359
+ # @rspec_example
312
360
  # @return [StringClass]
313
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
314
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
315
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
361
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
362
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
363
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
316
364
  # @param [Hash] opts
317
365
  # @option opts [String] :class_names The class names.
318
366
  def string_class(opts)
@@ -322,30 +370,34 @@ module IControl::LocalLB
322
370
 
323
371
  ##
324
372
  # Gets the list of available string classes.
373
+ # @rspec_example
325
374
  # @return [String]
326
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
327
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
328
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
375
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
376
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
377
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
329
378
  def string_class_list
330
379
  super
331
380
  end
332
381
 
333
382
  ##
334
- # Gets the data values associated with a set of string class member. This method is effectively the lookup method for using the class as a value map.
383
+ # Gets the data values associated with a set of string class member. This method is
384
+ # effectively the lookup method for using the class as a value map.
385
+ # @rspec_example
335
386
  # @return [String[]]
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.
387
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
388
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
389
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
339
390
  def string_class_member_data_value
340
391
  super
341
392
  end
342
393
 
343
394
  ##
344
395
  # Gets this value classes.
396
+ # @rspec_example
345
397
  # @return [ValueClass]
346
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
347
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
348
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
398
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
399
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
400
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
349
401
  # @param [Hash] opts
350
402
  # @option opts [String] :class_names The class names.
351
403
  def value_class(opts)
@@ -355,26 +407,30 @@ module IControl::LocalLB
355
407
 
356
408
  ##
357
409
  # Gets the list of available value classes.
410
+ # @rspec_example
358
411
  # @return [String]
359
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
360
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
361
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
412
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
413
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
414
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
362
415
  def value_class_list
363
416
  super
364
417
  end
365
418
 
366
419
  ##
367
- # Gets the data values associated with a set of value class member. This method is effectively the lookup method for using the class as a value map.
420
+ # Gets the data values associated with a set of value class member. This method is
421
+ # effectively the lookup method for using the class as a value map.
422
+ # @rspec_example
368
423
  # @return [String[]]
369
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
370
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
371
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
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.
372
427
  def value_class_member_data_value
373
428
  super
374
429
  end
375
430
 
376
431
  ##
377
432
  # Gets the version information for this interface.
433
+ # @rspec_example
378
434
  # @return [String]
379
435
  def version
380
436
  super
@@ -382,9 +438,10 @@ module IControl::LocalLB
382
438
 
383
439
  ##
384
440
  # Modifies address classes. The specified classes must already exist.
385
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
386
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
387
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
441
+ # @rspec_example
442
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
443
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
444
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
388
445
  # @param [Hash] opts
389
446
  # @option opts [IControl::LocalLB::Class::AddressClass] :classes The class names and the class members. The result is that the class now has the members specified in the class_members, regardless of what the class has before.
390
447
  def modify_address_class(opts)
@@ -394,9 +451,10 @@ module IControl::LocalLB
394
451
 
395
452
  ##
396
453
  # Modifies string classes. The specified classes must already exist.
397
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
398
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
399
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
454
+ # @rspec_example
455
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
456
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
457
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
400
458
  # @param [Hash] opts
401
459
  # @option opts [IControl::LocalLB::Class::StringClass] :classes The class names and the class members. The result is that the class now has the members specified in the class_members, regardless of what the class has before.
402
460
  def modify_string_class(opts)
@@ -406,9 +464,10 @@ module IControl::LocalLB
406
464
 
407
465
  ##
408
466
  # Modifies value classes. The specified classes must already exist.
409
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
410
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
411
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
467
+ # @rspec_example
468
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
469
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
470
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
412
471
  # @param [Hash] opts
413
472
  # @option opts [IControl::LocalLB::Class::ValueClass] :classes The class names and the class members. The result is that the class now has the members specified in the class_members, regardless of what the class has before.
414
473
  def modify_value_class(opts)
@@ -417,10 +476,13 @@ module IControl::LocalLB
417
476
  end
418
477
 
419
478
  ##
420
- # Sets the data values associated with a set of address class member. This data value is an optional arbitrary string, which can be retrieved given the class member information, allowing the class to be used as a value map.
421
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
422
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
423
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
479
+ # Sets the data values associated with a set of address class member. This data value
480
+ # is an optional arbitrary string, which can be retrieved given the class member information,
481
+ # allowing the class to be used as a value map.
482
+ # @rspec_example
483
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
484
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
485
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
424
486
  # @param [Hash] opts
425
487
  # @option opts [String[]] :values Data values to associate with each class member, organized in the same manner as the class member IP addresses (default: "" (i.e., no value))
426
488
  def set_address_class_member_data_value(opts)
@@ -429,10 +491,13 @@ module IControl::LocalLB
429
491
  end
430
492
 
431
493
  ##
432
- # Sets the strings used to separate a class member value from its optional associated data value for a set of classes. This is used for listing and storing both external and internal classes.
433
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
434
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
435
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
494
+ # Sets the strings used to separate a class member value from its optional associated
495
+ # data value for a set of classes. This is used for listing and storing both external
496
+ # and internal classes.
497
+ # @rspec_example
498
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
499
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
500
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
436
501
  # @param [Hash] opts
437
502
  # @option opts [String] :class_names Names of the requested classes
438
503
  # @option opts [String] :separators String separator for each class (default: ":=")
@@ -442,10 +507,13 @@ module IControl::LocalLB
442
507
  end
443
508
 
444
509
  ##
445
- # Sets the file format for this classes. This should only be called for external classes, since it does not make sense for non-external classes. If called for non-external classes, it will silently accept it, but nothing will be done.
446
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
447
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
448
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
510
+ # Sets the file format for this classes. This should only be called for external classes,
511
+ # since it does not make sense for non-external classes. If called for non-external
512
+ # classes, it will silently accept it, but nothing will be done.
513
+ # @rspec_example
514
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
515
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
516
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
449
517
  # @param [Hash] opts
450
518
  # @option opts [String] :class_names The class names to set the file formats.
451
519
  # @option opts [IControl::LocalLB::Class::FileFormatType] :file_formats A list of file formats to set for the specified classes.
@@ -455,10 +523,13 @@ module IControl::LocalLB
455
523
  end
456
524
 
457
525
  ##
458
- # Sets the file mode for this classes. This should only be called for external classes, since it does not make sense for non-external classes. If called for non-external classes, it will silently accept it, but nothing will be done.
459
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
460
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
461
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
526
+ # Sets the file mode for this classes. This should only be called for external classes,
527
+ # since it does not make sense for non-external classes. If called for non-external
528
+ # classes, it will silently accept it, but nothing will be done.
529
+ # @rspec_example
530
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
531
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
532
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
462
533
  # @param [Hash] opts
463
534
  # @option opts [String] :class_names The class names to set the file modes.
464
535
  # @option opts [IControl::LocalLB::Class::FileModeType] :file_modes A list of file modes to set for the specified classes.
@@ -468,10 +539,13 @@ module IControl::LocalLB
468
539
  end
469
540
 
470
541
  ##
471
- # Sets the file names for this external classes. This should only be called for external classes, since it does not make sense for non-external classes. If called for non-external classes, it will silently accept it, but nothing will be done.
472
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
473
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
474
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
542
+ # Sets the file names for this external classes. This should only be called for external
543
+ # classes, since it does not make sense for non-external classes. If called for non-external
544
+ # classes, it will silently accept it, but nothing will be done.
545
+ # @rspec_example
546
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
547
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
548
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
475
549
  # @param [Hash] opts
476
550
  # @option opts [String] :class_names The class names to set the file names.
477
551
  # @option opts [String] :file_names A list of file names to set for the specified classes.
@@ -481,10 +555,13 @@ module IControl::LocalLB
481
555
  end
482
556
 
483
557
  ##
484
- # Sets the data values associated with a set of string class member. This data value is an optional arbitrary string, which can be retrieved given the class member information, allowing the class to be used as a value map.
485
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
486
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
487
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
558
+ # Sets the data values associated with a set of string class member. This data value
559
+ # is an optional arbitrary string, which can be retrieved given the class member information,
560
+ # allowing the class to be used as a value map.
561
+ # @rspec_example
562
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
563
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
564
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
488
565
  # @param [Hash] opts
489
566
  # @option opts [String[]] :values Data values to associate with each class member, organized in the same manner as the class member string values (default: "" (i.e., no value))
490
567
  def set_string_class_member_data_value(opts)
@@ -493,10 +570,13 @@ module IControl::LocalLB
493
570
  end
494
571
 
495
572
  ##
496
- # Sets the data values associated with a set of value class member. This data value is an arbitrary optional string, which can be retrieved given the class member information, allowing the class to be used as a value map.
497
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
498
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
499
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
573
+ # Sets the data values associated with a set of value class member. This data value
574
+ # is an arbitrary optional string, which can be retrieved given the class member information,
575
+ # allowing the class to be used as a value map.
576
+ # @rspec_example
577
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
578
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
579
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
500
580
  # @param [Hash] opts
501
581
  # @option opts [String[]] :values Data values to associate with each class member, organized in the same manner as the class member integer values (default: "" (i.e., no value))
502
582
  def set_value_class_member_data_value(opts)
@@ -507,10 +587,10 @@ module IControl::LocalLB
507
587
  ##
508
588
  # A struct that describes an Address class.
509
589
  # @attr [String] name The Address class name.
510
- # @attr [IControl::LocalLB::Klass::AddressEntry] members The Address class member list.
590
+ # @attr [IControl::LocalLB::Klass::AddressEntrySequence] members The Address class member list.
511
591
  class AddressClass < IControl::Base::Struct
512
592
  icontrol_attribute :name, String
513
- icontrol_attribute :members, IControl::LocalLB::Klass::AddressEntry
593
+ icontrol_attribute :members, IControl::LocalLB::Klass::AddressEntrySequence
514
594
  end
515
595
 
516
596
  ##
@@ -540,19 +620,19 @@ module IControl::LocalLB
540
620
  ##
541
621
  # A struct that describes a String class.
542
622
  # @attr [String] name The String class name.
543
- # @attr [String] members The String class member list.
623
+ # @attr [StringSequence] members The String class member list.
544
624
  class StringClass < IControl::Base::Struct
545
625
  icontrol_attribute :name, String
546
- icontrol_attribute :members, String
626
+ icontrol_attribute :members, StringSequence
547
627
  end
548
628
 
549
629
  ##
550
630
  # A struct that describes a Value class.
551
631
  # @attr [String] name The Value class name.
552
- # @attr [Numeric] members The Value class member list.
632
+ # @attr [LongSequence] members The Value class member list.
553
633
  class ValueClass < IControl::Base::Struct
554
634
  icontrol_attribute :name, String
555
- icontrol_attribute :members, Numeric
635
+ icontrol_attribute :members, LongSequence
556
636
  end
557
637
 
558
638