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
@@ -20,6 +20,48 @@ module IControl::Management
20
20
  class ViewInfo < IControl::Base::Struct; end
21
21
  class ViewZone < IControl::Base::Struct; end
22
22
  class ZoneInfo < IControl::Base::Struct; end
23
+ class A6RecordSequence < IControl::Base::Sequence ; end
24
+ class A6RecordSequenceSequence < IControl::Base::SequenceSequence ; end
25
+ class AAAARecordSequence < IControl::Base::Sequence ; end
26
+ class AAAARecordSequenceSequence < IControl::Base::SequenceSequence ; end
27
+ class ARecordSequence < IControl::Base::Sequence ; end
28
+ class ARecordSequenceSequence < IControl::Base::SequenceSequence ; end
29
+ class CNAMERecordSequence < IControl::Base::Sequence ; end
30
+ class CNAMERecordSequenceSequence < IControl::Base::SequenceSequence ; end
31
+ class DNAMERecordSequence < IControl::Base::Sequence ; end
32
+ class DNAMERecordSequenceSequence < IControl::Base::SequenceSequence ; end
33
+ class HINFORecordSequence < IControl::Base::Sequence ; end
34
+ class HINFORecordSequenceSequence < IControl::Base::SequenceSequence ; end
35
+ class KEYRecordSequence < IControl::Base::Sequence ; end
36
+ class KEYRecordSequenceSequence < IControl::Base::SequenceSequence ; end
37
+ class LDAPPasswordEncodingOptionSequence < IControl::Base::Sequence ; end
38
+ class LDAPSSLOptionSequence < IControl::Base::Sequence ; end
39
+ class LDAPSearchMethodSequence < IControl::Base::Sequence ; end
40
+ class LDAPSearchScopeSequence < IControl::Base::Sequence ; end
41
+ class MXRecordSequence < IControl::Base::Sequence ; end
42
+ class MXRecordSequenceSequence < IControl::Base::SequenceSequence ; end
43
+ class NSRecordSequence < IControl::Base::Sequence ; end
44
+ class NSRecordSequenceSequence < IControl::Base::SequenceSequence ; end
45
+ class NXTRecordSequence < IControl::Base::Sequence ; end
46
+ class NXTRecordSequenceSequence < IControl::Base::SequenceSequence ; end
47
+ class OCSPDigestMethodSequence < IControl::Base::Sequence ; end
48
+ class PTRRecordSequence < IControl::Base::Sequence ; end
49
+ class PTRRecordSequenceSequence < IControl::Base::SequenceSequence ; end
50
+ class RRListSequence < IControl::Base::Sequence ; end
51
+ class SIGRecordSequence < IControl::Base::Sequence ; end
52
+ class SIGRecordSequenceSequence < IControl::Base::SequenceSequence ; end
53
+ class SOARecordSequence < IControl::Base::Sequence ; end
54
+ class SOARecordSequenceSequence < IControl::Base::SequenceSequence ; end
55
+ class SRVRecordSequence < IControl::Base::Sequence ; end
56
+ class SRVRecordSequenceSequence < IControl::Base::SequenceSequence ; end
57
+ class StatementDefinitionSequence < IControl::Base::Sequence ; end
58
+ class TXTRecordSequence < IControl::Base::Sequence ; end
59
+ class TXTRecordSequenceSequence < IControl::Base::SequenceSequence ; end
60
+ class ViewInfoSequence < IControl::Base::Sequence ; end
61
+ class ViewInfoSequenceSequence < IControl::Base::SequenceSequence ; end
62
+ class ViewZoneSequence < IControl::Base::Sequence ; end
63
+ class ZoneInfoSequence < IControl::Base::Sequence ; end
64
+ class ZoneInfoSequenceSequence < IControl::Base::SequenceSequence ; end
23
65
  class CCLDAPConfiguration < IControl::Base; end
24
66
  class CRLDPConfiguration < IControl::Base; end
25
67
  class CRLDPServer < IControl::Base; end
@@ -197,37 +239,37 @@ module IControl::Management
197
239
 
198
240
  ##
199
241
  # struct that contains sequences for all possible RRtypes in a zone
200
- # @attr [IControl::Management::ARecord] a_list - contains all A records
201
- # @attr [IControl::Management::NSRecord] ns_list - contains all NS records
202
- # @attr [IControl::Management::CNAMERecord] cname_list - contains all CNAME records
203
- # @attr [IControl::Management::SOARecord] soa_list - contains all SOA records
204
- # @attr [IControl::Management::PTRRecord] ptr_list - contains all PTR records
205
- # @attr [IControl::Management::HINFORecord] hinfo_list - contains all HINFO records
206
- # @attr [IControl::Management::MXRecord] mx_list - contains all MX records
207
- # @attr [IControl::Management::TXTRecord] txt_list - contains all TXT records
208
- # @attr [IControl::Management::SRVRecord] srv_list - contains all SRV records
209
- # @attr [IControl::Management::KEYRecord] key_list - contains all KEY records
210
- # @attr [IControl::Management::SIGRecord] sig_list - contains all SIG records
211
- # @attr [IControl::Management::NXTRecord] nxt_list - contains all NXT records
212
- # @attr [IControl::Management::AAAARecord] aaaa_list - contains all AAAA records
213
- # @attr [IControl::Management::A6Record] a6_list - contains all A6 records
214
- # @attr [IControl::Management::DNAMERecord] dname_list - contains all DNAME records
242
+ # @attr [IControl::Management::ARecordSequence] a_list - contains all A records
243
+ # @attr [IControl::Management::NSRecordSequence] ns_list - contains all NS records
244
+ # @attr [IControl::Management::CNAMERecordSequence] cname_list - contains all CNAME records
245
+ # @attr [IControl::Management::SOARecordSequence] soa_list - contains all SOA records
246
+ # @attr [IControl::Management::PTRRecordSequence] ptr_list - contains all PTR records
247
+ # @attr [IControl::Management::HINFORecordSequence] hinfo_list - contains all HINFO records
248
+ # @attr [IControl::Management::MXRecordSequence] mx_list - contains all MX records
249
+ # @attr [IControl::Management::TXTRecordSequence] txt_list - contains all TXT records
250
+ # @attr [IControl::Management::SRVRecordSequence] srv_list - contains all SRV records
251
+ # @attr [IControl::Management::KEYRecordSequence] key_list - contains all KEY records
252
+ # @attr [IControl::Management::SIGRecordSequence] sig_list - contains all SIG records
253
+ # @attr [IControl::Management::NXTRecordSequence] nxt_list - contains all NXT records
254
+ # @attr [IControl::Management::AAAARecordSequence] aaaa_list - contains all AAAA records
255
+ # @attr [IControl::Management::A6RecordSequence] a6_list - contains all A6 records
256
+ # @attr [IControl::Management::DNAMERecordSequence] dname_list - contains all DNAME records
215
257
  class RRList < IControl::Base::Struct
216
- icontrol_attribute :a_list, IControl::Management::ARecord
217
- icontrol_attribute :ns_list, IControl::Management::NSRecord
218
- icontrol_attribute :cname_list, IControl::Management::CNAMERecord
219
- icontrol_attribute :soa_list, IControl::Management::SOARecord
220
- icontrol_attribute :ptr_list, IControl::Management::PTRRecord
221
- icontrol_attribute :hinfo_list, IControl::Management::HINFORecord
222
- icontrol_attribute :mx_list, IControl::Management::MXRecord
223
- icontrol_attribute :txt_list, IControl::Management::TXTRecord
224
- icontrol_attribute :srv_list, IControl::Management::SRVRecord
225
- icontrol_attribute :key_list, IControl::Management::KEYRecord
226
- icontrol_attribute :sig_list, IControl::Management::SIGRecord
227
- icontrol_attribute :nxt_list, IControl::Management::NXTRecord
228
- icontrol_attribute :aaaa_list, IControl::Management::AAAARecord
229
- icontrol_attribute :a6_list, IControl::Management::A6Record
230
- icontrol_attribute :dname_list, IControl::Management::DNAMERecord
258
+ icontrol_attribute :a_list, IControl::Management::ARecordSequence
259
+ icontrol_attribute :ns_list, IControl::Management::NSRecordSequence
260
+ icontrol_attribute :cname_list, IControl::Management::CNAMERecordSequence
261
+ icontrol_attribute :soa_list, IControl::Management::SOARecordSequence
262
+ icontrol_attribute :ptr_list, IControl::Management::PTRRecordSequence
263
+ icontrol_attribute :hinfo_list, IControl::Management::HINFORecordSequence
264
+ icontrol_attribute :mx_list, IControl::Management::MXRecordSequence
265
+ icontrol_attribute :txt_list, IControl::Management::TXTRecordSequence
266
+ icontrol_attribute :srv_list, IControl::Management::SRVRecordSequence
267
+ icontrol_attribute :key_list, IControl::Management::KEYRecordSequence
268
+ icontrol_attribute :sig_list, IControl::Management::SIGRecordSequence
269
+ icontrol_attribute :nxt_list, IControl::Management::NXTRecordSequence
270
+ icontrol_attribute :aaaa_list, IControl::Management::AAAARecordSequence
271
+ icontrol_attribute :a6_list, IControl::Management::A6RecordSequence
272
+ icontrol_attribute :dname_list, IControl::Management::DNAMERecordSequence
231
273
  end
232
274
 
233
275
  ##
@@ -300,10 +342,10 @@ module IControl::Management
300
342
  ##
301
343
  # A struct that describes a statement
302
344
  # @attr [String] statement_id The name of the statement. If empty, then either there's only one statement of its kind in the configuration file (i.e. "controls"...), or statement id is not applicable (i.e. "include")
303
- # @attr [String] sub_strings A sequence of substrings that make up a statement.
345
+ # @attr [StringSequence] sub_strings A sequence of substrings that make up a statement.
304
346
  class StatementDefinition < IControl::Base::Struct
305
347
  icontrol_attribute :statement_id, String
306
- icontrol_attribute :sub_strings, String
348
+ icontrol_attribute :sub_strings, StringSequence
307
349
  end
308
350
 
309
351
  ##
@@ -321,13 +363,13 @@ module IControl::Management
321
363
  # a struct that describes a view
322
364
  # @attr [String] view_name The name of the view
323
365
  # @attr [Numeric] view_order The order of the view within the named.conf file 0 = first in zone 0xffffffff on a change means to move the view to last any other number will move the view to that position, and bump up any view(s) 1 if necessary
324
- # @attr [String] option_seq a sequence of options for the view
325
- # @attr [String] zone_names a sequence of zones in this view
366
+ # @attr [StringSequence] option_seq a sequence of options for the view
367
+ # @attr [StringSequence] zone_names a sequence of zones in this view
326
368
  class ViewInfo < IControl::Base::Struct
327
369
  icontrol_attribute :view_name, String
328
370
  icontrol_attribute :view_order, Numeric
329
- icontrol_attribute :option_seq, String
330
- icontrol_attribute :zone_names, String
371
+ icontrol_attribute :option_seq, StringSequence
372
+ icontrol_attribute :zone_names, StringSequence
331
373
  end
332
374
 
333
375
  ##
@@ -345,13 +387,13 @@ module IControl::Management
345
387
  # @attr [String] zone_name The name of the zone
346
388
  # @attr [IControl::Management::ZoneType] zone_type one of the types of ZoneType enum
347
389
  # @attr [String] zone_file The name of the file for the zone data
348
- # @attr [String] option_seq A sequence of options for the zone
390
+ # @attr [StringSequence] option_seq A sequence of options for the zone
349
391
  class ZoneInfo < IControl::Base::Struct
350
392
  icontrol_attribute :view_name, String
351
393
  icontrol_attribute :zone_name, String
352
394
  icontrol_attribute :zone_type, IControl::Management::ZoneType
353
395
  icontrol_attribute :zone_file, String
354
- icontrol_attribute :option_seq, String
396
+ icontrol_attribute :option_seq, StringSequence
355
397
  end
356
398
 
357
399
 
@@ -1,15 +1,18 @@
1
1
  module IControl::Management
2
2
  ##
3
- # The CCLDAPConfiguration interface enables you to manage SSL Client Certificate LDAP PAM configuration.
3
+ # The CCLDAPConfiguration interface enables you to manage SSL Client Certificate LDAP
4
+ # PAM configuration.
4
5
  class CCLDAPConfiguration < IControl::Base
5
6
 
6
7
  set_id_name "config_names"
7
8
 
8
- class LDAPSearchOption < IControl::Base::Struct; end ##
9
+ class LDAPSearchOption < IControl::Base::Struct; end
10
+ class LDAPSearchOptionSequence < IControl::Base::Sequence ; end ##
9
11
  # Adds/associates servers to this Client Certificate LDAP configurations.
10
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
11
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
12
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
12
+ # @rspec_example
13
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
14
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
15
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
13
16
  # @param [Hash] opts
14
17
  # @option opts [String[]] :servers The servers to add to the Client Certificate LDAP configurations.
15
18
  def add_server(opts)
@@ -18,10 +21,13 @@ module IControl::Management
18
21
  end
19
22
 
20
23
  ##
21
- # Adds/associates lists of valid groups in which the clients must belong in order to be authorized (matches against the group key in the group subtree). A client only needs to be a member of a single specified group in order to be authorized.
22
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
23
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
24
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
24
+ # Adds/associates lists of valid groups in which the clients must belong in order to
25
+ # be authorized (matches against the group key in the group subtree). A client only
26
+ # needs to be a member of a single specified group in order to be authorized.
27
+ # @rspec_example
28
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
29
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
30
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
25
31
  # @param [Hash] opts
26
32
  # @option opts [String[]] :groups The valid groups to add to the Client Certificate LDAP configurations.
27
33
  def add_valid_group(opts)
@@ -30,10 +36,13 @@ module IControl::Management
30
36
  end
31
37
 
32
38
  ##
33
- # Adds/associates lists of valid roles that the client must possess in order to be authorized. A client only needs to match of a single specified role in order to be authorized.
34
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
35
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
36
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
39
+ # Adds/associates lists of valid roles that the client must possess in order to be
40
+ # authorized. A client only needs to match of a single specified role in order to be
41
+ # authorized.
42
+ # @rspec_example
43
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
44
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
45
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
37
46
  # @param [Hash] opts
38
47
  # @option opts [String[]] :roles The valid roles to add to the Client Certificate LDAP configurations.
39
48
  def add_valid_role(opts)
@@ -43,9 +52,10 @@ module IControl::Management
43
52
 
44
53
  ##
45
54
  # Creates this Client Certificate LDAP configurations.
46
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
47
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
48
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
55
+ # @rspec_example
56
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
57
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
58
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
49
59
  # @param [Hash] opts
50
60
  # @option opts [IControl::Management::CCLDAPConfiguration::LDAPSearchOption] :search_options The search options used by the configurations.
51
61
  # @option opts [String[]] :servers The list of servers to be assigned to each of the configurations.
@@ -56,212 +66,250 @@ module IControl::Management
56
66
 
57
67
  ##
58
68
  # Deletes all Client Certificate LDAP configurations.
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.
69
+ # @rspec_example
70
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
71
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
72
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
62
73
  def delete_all_configurations
63
74
  super
64
75
  end
65
76
 
66
77
  ##
67
78
  # Deletes this Client Certificate LDAP configurations.
68
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
69
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
70
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
79
+ # @rspec_example
80
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
81
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
82
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
71
83
  def delete_configuration
72
84
  super
73
85
  end
74
86
 
75
87
  ##
76
88
  # Gets the admin DNs for this Client Certificate LDAP configurations.
89
+ # @rspec_example
77
90
  # @return [String]
78
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
79
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
80
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
91
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
92
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
93
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
81
94
  def admin_distinguished_name
82
95
  super
83
96
  end
84
97
 
85
98
  ##
86
99
  # Gets the admin passwords for this Client Certificate LDAP configurations.
100
+ # @rspec_example
87
101
  # @return [String]
88
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
89
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
90
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
102
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
103
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
104
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
91
105
  def admin_password
92
106
  super
93
107
  end
94
108
 
95
109
  ##
96
- # Gets the maximum LDAP response cache sizes in bytes. If zero is specified, the cache is not activated.
110
+ # Gets the maximum LDAP response cache sizes in bytes. If zero is specified, the cache
111
+ # is not activated.
112
+ # @rspec_example
97
113
  # @return [long]
98
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
99
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
100
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
114
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
115
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
116
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
101
117
  def cache_size
102
118
  super
103
119
  end
104
120
 
105
121
  ##
106
- # Gets the LDAP response cache timeout in seconds. If zero is specified, the cache is not activated.
122
+ # Gets the LDAP response cache timeout in seconds. If zero is specified, the cache
123
+ # is not activated.
124
+ # @rspec_example
107
125
  # @return [long]
108
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
109
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
110
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
126
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
127
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
128
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
111
129
  def cache_timeout
112
130
  super
113
131
  end
114
132
 
115
133
  ##
116
134
  # Gets the search bases for the subtrees used by group searches.
135
+ # @rspec_example
117
136
  # @return [String]
118
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
119
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
120
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
137
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
138
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
139
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
121
140
  def group_base
122
141
  super
123
142
  end
124
143
 
125
144
  ##
126
- # Gets the names of the attributes in the LDAP database that identify the group names in the group subtrees.
145
+ # Gets the names of the attributes in the LDAP database that identify the group names
146
+ # in the group subtrees.
147
+ # @rspec_example
127
148
  # @return [String]
128
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
129
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
130
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
149
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
150
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
151
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
131
152
  def group_key
132
153
  super
133
154
  end
134
155
 
135
156
  ##
136
- # Gets the names of the attributes in the LDAP database that identify members (DNs) of a group. A typical key would be &amp;quot;member".
157
+ # Gets the names of the attributes in the LDAP database that identify members (DNs)
158
+ # of a group. A typical key would be &amp;quot;member".
159
+ # @rspec_example
137
160
  # @return [String]
138
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
139
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
140
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
161
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
162
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
163
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
141
164
  def group_member_key
142
165
  super
143
166
  end
144
167
 
145
168
  ##
146
169
  # Gets a list of all Client Certificate LDAP configurations.
170
+ # @rspec_example
147
171
  # @return [String]
148
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
149
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
150
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
172
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
173
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
174
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
151
175
  def list
152
176
  super
153
177
  end
154
178
 
155
179
  ##
156
- # Gets the names of the attributes in the LDAP database that identify a user's authorization roles.
180
+ # Gets the names of the attributes in the LDAP database that identify a user's authorization
181
+ # roles.
182
+ # @rspec_example
157
183
  # @return [String]
158
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
159
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
160
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
184
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
185
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
186
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
161
187
  def role_key
162
188
  super
163
189
  end
164
190
 
165
191
  ##
166
192
  # Gets the search options used by the Client Certificate LDAP configurations.
193
+ # @rspec_example
167
194
  # @return [LDAPSearchOption]
168
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
169
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
170
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
195
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
196
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
197
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
171
198
  def search_option
172
199
  super
173
200
  end
174
201
 
175
202
  ##
176
- # Gets the lists of servers this Client Certificate LDAP configurations are associated with.
203
+ # Gets the lists of servers this Client Certificate LDAP configurations are associated
204
+ # with.
205
+ # @rspec_example
177
206
  # @return [String[]]
178
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
179
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
180
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
207
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
208
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
209
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
181
210
  def server
182
211
  super
183
212
  end
184
213
 
185
214
  ##
186
- # Gets the states indicating whether to use the client certificate's serial number instead of its subject (one or the other is always used in conjunction with the certificate issuer) when trying to match an entry in the certificate map subtree.
215
+ # Gets the states indicating whether to use the client certificate's serial number
216
+ # instead of its subject (one or the other is always used in conjunction with the certificate
217
+ # issuer) when trying to match an entry in the certificate map subtree.
218
+ # @rspec_example
187
219
  # @return [EnabledState]
188
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
189
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
190
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
220
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
221
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
222
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
191
223
  def use_certificate_serial_state
192
224
  super
193
225
  end
194
226
 
195
227
  ##
196
- # Gets the states indicating whether SSL/TLS should be used when connecting to the LDAP server.
228
+ # Gets the states indicating whether SSL/TLS should be used when connecting to the
229
+ # LDAP server.
230
+ # @rspec_example
197
231
  # @return [EnabledState]
198
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
199
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
200
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
232
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
233
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
234
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
201
235
  def use_security_state
202
236
  super
203
237
  end
204
238
 
205
239
  ##
206
- # Gets the user classes (only in certficate search method) for this Client Certificate LDAP configurations.
240
+ # Gets the user classes (only in certficate search method) for this Client Certificate
241
+ # LDAP configurations.
242
+ # @rspec_example
207
243
  # @return [String]
208
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
209
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
210
- # @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.
211
247
  def user_class
212
248
  super
213
249
  end
214
250
 
215
251
  ##
216
- # Gets the lists of valid groups in which the clients must belong in order to be authorized (matches against the group key in the group subtree). A client only needs to be a member of a single specified group in order to be authorized.
252
+ # Gets the lists of valid groups in which the clients must belong in order to be authorized
253
+ # (matches against the group key in the group subtree). A client only needs to be a
254
+ # member of a single specified group in order to be authorized.
255
+ # @rspec_example
217
256
  # @return [String[]]
218
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
219
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
220
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
257
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
258
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
259
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
221
260
  def valid_group
222
261
  super
223
262
  end
224
263
 
225
264
  ##
226
- # Gets the lists of valid roles that the client must possess in order to be authorized. A client only needs to match of a single specified role in order to be authorized.
265
+ # Gets the lists of valid roles that the client must possess in order to be authorized.
266
+ # A client only needs to match of a single specified role in order to be authorized.
267
+ # @rspec_example
227
268
  # @return [String[]]
228
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
229
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
230
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
269
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
270
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
271
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
231
272
  def valid_role
232
273
  super
233
274
  end
234
275
 
235
276
  ##
236
277
  # Gets the version information for this interface.
278
+ # @rspec_example
237
279
  # @return [String]
238
280
  def version
239
281
  super
240
282
  end
241
283
 
242
284
  ##
243
- # Removes all lists of valid groups in which the clients must belong in order to be authorized (matches against the group key in the group subtree). A client only needs to be a member of a single specified group in order to be authorized.
244
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
245
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
246
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
285
+ # Removes all lists of valid groups in which the clients must belong in order to be
286
+ # authorized (matches against the group key in the group subtree). A client only needs
287
+ # to be a member of a single specified group in order to be authorized.
288
+ # @rspec_example
289
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
290
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
291
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
247
292
  def remove_all_valid_groups
248
293
  super
249
294
  end
250
295
 
251
296
  ##
252
- # Removes all lists of valid roles that the client must possess in order to be authorized. A client only needs to match of a single specified role in order to be authorized.
253
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
254
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
255
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
297
+ # Removes all lists of valid roles that the client must possess in order to be authorized.
298
+ # A client only needs to match of a single specified role in order to be authorized.
299
+ # @rspec_example
300
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
301
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
302
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
256
303
  def remove_all_valid_roles
257
304
  super
258
305
  end
259
306
 
260
307
  ##
261
308
  # Removes servers from this Client Certificate LDAP configurations.
262
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
263
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
264
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
309
+ # @rspec_example
310
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
311
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
312
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
265
313
  # @param [Hash] opts
266
314
  # @option opts [String[]] :servers The servers to remove from the Client Certificate LDAP configurations.
267
315
  def remove_server(opts)
@@ -270,10 +318,13 @@ module IControl::Management
270
318
  end
271
319
 
272
320
  ##
273
- # Removes lists of valid groups in which the clients must belong in order to be authorized (matches against the group key in the group subtree). A client only needs to be a member of a single specified group in order to be authorized.
274
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
275
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
276
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
321
+ # Removes lists of valid groups in which the clients must belong in order to be authorized
322
+ # (matches against the group key in the group subtree). A client only needs to be a
323
+ # member of a single specified group in order to be authorized.
324
+ # @rspec_example
325
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
326
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
327
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
277
328
  # @param [Hash] opts
278
329
  # @option opts [String[]] :groups The valid groups to remove from the Client Certificate LDAP configurations.
279
330
  def remove_valid_group(opts)
@@ -282,10 +333,12 @@ module IControl::Management
282
333
  end
283
334
 
284
335
  ##
285
- # Removes lists of valid roles that the client must possess in order to be authorized. A client only needs to match of a single specified role in order to be authorized.
286
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
287
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
288
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
336
+ # Removes lists of valid roles that the client must possess in order to be authorized.
337
+ # A client only needs to match of a single specified role in order to be authorized.
338
+ # @rspec_example
339
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
340
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
341
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
289
342
  # @param [Hash] opts
290
343
  # @option opts [String[]] :roles The valid roles to remove from the Client Certificate LDAP configurations.
291
344
  def remove_valid_role(opts)
@@ -295,9 +348,10 @@ module IControl::Management
295
348
 
296
349
  ##
297
350
  # Sets the admin DNs for this Client Certificate LDAP configurations.
298
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
299
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
300
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
351
+ # @rspec_example
352
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
353
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
354
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
301
355
  # @param [Hash] opts
302
356
  # @option opts [String] :admin_dns The admin Distinguished names.
303
357
  def set_admin_distinguished_name(opts)
@@ -307,9 +361,10 @@ module IControl::Management
307
361
 
308
362
  ##
309
363
  # Sets the admin passwords for this Client Certificate LDAP configurations.
310
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
311
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
312
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
364
+ # @rspec_example
365
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
366
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
367
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
313
368
  # @param [Hash] opts
314
369
  # @option opts [String] :admin_passwords The admin passwords.
315
370
  def set_admin_password(opts)
@@ -318,10 +373,12 @@ module IControl::Management
318
373
  end
319
374
 
320
375
  ##
321
- # Sets the maximum LDAP response cache sizes in bytes. If zero is specified, the cache is not activated.
322
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
323
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
324
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
376
+ # Sets the maximum LDAP response cache sizes in bytes. If zero is specified, the cache
377
+ # is not activated.
378
+ # @rspec_example
379
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
380
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
381
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
325
382
  # @param [Hash] opts
326
383
  # @option opts [long] :sizes The cache sizes used by the LDAP servers in the configurations.
327
384
  def set_cache_size(opts)
@@ -330,10 +387,12 @@ module IControl::Management
330
387
  end
331
388
 
332
389
  ##
333
- # Sets the LDAP response cache timeout in seconds. If zero is specified, the cache is not activated.
334
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
335
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
336
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
390
+ # Sets the LDAP response cache timeout in seconds. If zero is specified, the cache
391
+ # is not activated.
392
+ # @rspec_example
393
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
394
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
395
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
337
396
  # @param [Hash] opts
338
397
  # @option opts [long] :timeouts The cache timeouts used by the configurations.
339
398
  def set_cache_timeout(opts)
@@ -343,9 +402,10 @@ module IControl::Management
343
402
 
344
403
  ##
345
404
  # Sets the search bases for the subtrees used by group searches.
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.
405
+ # @rspec_example
406
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
407
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
408
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
349
409
  # @param [Hash] opts
350
410
  # @option opts [String] :bases The search bases for the subtrees used by the Client Certificate LDAP configurations.
351
411
  def set_group_base(opts)
@@ -354,10 +414,12 @@ module IControl::Management
354
414
  end
355
415
 
356
416
  ##
357
- # Sets the names of the attributes in the LDAP database that identify the group names in the group subtrees.
358
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
359
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
360
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
417
+ # Sets the names of the attributes in the LDAP database that identify the group names
418
+ # in the group subtrees.
419
+ # @rspec_example
420
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
421
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
422
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
361
423
  # @param [Hash] opts
362
424
  # @option opts [String] :keys The names of the attributes in the LDAP database that identify the group names.
363
425
  def set_group_key(opts)
@@ -366,10 +428,12 @@ module IControl::Management
366
428
  end
367
429
 
368
430
  ##
369
- # Sets the names of the attributes in the LDAP database that identify members (DNs) of a group. A typical key would be &amp;quot;member".
370
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
371
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
372
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
431
+ # Sets the names of the attributes in the LDAP database that identify members (DNs)
432
+ # of a group. A typical key would be &amp;quot;member".
433
+ # @rspec_example
434
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
435
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
436
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
373
437
  # @param [Hash] opts
374
438
  # @option opts [String] :keys The names of the attributes in the LDAP database that identify members ( DNs ) of a group.
375
439
  def set_group_member_key(opts)
@@ -378,10 +442,12 @@ module IControl::Management
378
442
  end
379
443
 
380
444
  ##
381
- # Sets the names of the attributes in the LDAP database that identify a user's authorization roles.
382
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
383
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
384
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
445
+ # Sets the names of the attributes in the LDAP database that identify a user's authorization
446
+ # roles.
447
+ # @rspec_example
448
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
449
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
450
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
385
451
  # @param [Hash] opts
386
452
  # @option opts [String] :keys The names of the attributes in the LDAP database that identify a user's authorization roles.
387
453
  def set_role_key(opts)
@@ -391,9 +457,10 @@ module IControl::Management
391
457
 
392
458
  ##
393
459
  # Sets the search options used by the Client Certificate LDAP configurations.
394
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
395
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
396
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
460
+ # @rspec_example
461
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
462
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
463
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
397
464
  # @param [Hash] opts
398
465
  # @option opts [IControl::Management::CCLDAPConfiguration::LDAPSearchOption] :options The search options used by the configurations.
399
466
  def set_search_option(opts)
@@ -402,10 +469,13 @@ module IControl::Management
402
469
  end
403
470
 
404
471
  ##
405
- # Sets the states indicating whether to use the client certificate's serial number instead of its subject (one or the other is always used in conjunction with the certificate issuer) when trying to match an entry in the certificate map subtree.
406
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
407
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
408
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
472
+ # Sets the states indicating whether to use the client certificate's serial number
473
+ # instead of its subject (one or the other is always used in conjunction with the certificate
474
+ # issuer) when trying to match an entry in the certificate map subtree.
475
+ # @rspec_example
476
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
477
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
478
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
409
479
  # @param [Hash] opts
410
480
  # @option opts [IControl::Common::EnabledState] :states The states of the specified configurations.
411
481
  def set_use_certificate_serial_state(opts)
@@ -414,10 +484,12 @@ module IControl::Management
414
484
  end
415
485
 
416
486
  ##
417
- # Sets the states indicating whether SSL/TLS should be used when connecting to the LDAP server.
418
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
419
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
420
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
487
+ # Sets the states indicating whether SSL/TLS should be used when connecting to the
488
+ # LDAP server.
489
+ # @rspec_example
490
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
491
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
492
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
421
493
  # @param [Hash] opts
422
494
  # @option opts [IControl::Common::EnabledState] :states The states of the specified configurations.
423
495
  def set_use_security_state(opts)
@@ -426,10 +498,12 @@ module IControl::Management
426
498
  end
427
499
 
428
500
  ##
429
- # Sets the user classes (only in certficate search method) for this Client Certificate LDAP configurations.
430
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
431
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
432
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
501
+ # Sets the user classes (only in certficate search method) for this Client Certificate
502
+ # LDAP configurations.
503
+ # @rspec_example
504
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
505
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
506
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
433
507
  # @param [Hash] opts
434
508
  # @option opts [String] :user_classes The user classes.
435
509
  def set_user_class(opts)