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
@@ -7,9 +7,10 @@ module IControl::Management
7
7
 
8
8
  ##
9
9
  # Adds/associates servers to this 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.
10
+ # @rspec_example
11
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
12
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
13
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
13
14
  # @param [Hash] opts
14
15
  # @option opts [String[]] :servers The servers to add to the LDAP configurations.
15
16
  def add_server(opts)
@@ -19,9 +20,10 @@ module IControl::Management
19
20
 
20
21
  ##
21
22
  # Creates this LDAP configurations.
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.
23
+ # @rspec_example
24
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
25
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
26
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
25
27
  # @param [Hash] opts
26
28
  # @option opts [String] :search_base_dns The distinguished names of the search bases used by the configurations.
27
29
  # @option opts [String[]] :servers The list of servers to be assigned to each of the configurations.
@@ -32,9 +34,10 @@ module IControl::Management
32
34
 
33
35
  ##
34
36
  # Creates the default authentication Active Directory configuration.
35
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
36
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
37
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
37
+ # @rspec_example
38
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
39
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
40
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
38
41
  # @param [Hash] opts
39
42
  # @option opts [String] :search_base_dn The distinguished name of the search base used by the configuration.
40
43
  # @option opts [String] :servers The list of servers to be assigned to the configuration.
@@ -45,9 +48,10 @@ module IControl::Management
45
48
 
46
49
  ##
47
50
  # Creates the default authentication LDAP configuration.
48
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
49
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
50
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
51
+ # @rspec_example
52
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
53
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
54
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
51
55
  # @param [Hash] opts
52
56
  # @option opts [String] :search_base_dn The distinguished name of the search base used by the configuration.
53
57
  # @option opts [String] :servers The list of servers to be assigned to the configuration.
@@ -58,274 +62,308 @@ module IControl::Management
58
62
 
59
63
  ##
60
64
  # Deletes all LDAP configurations.
61
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
62
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
63
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
65
+ # @rspec_example
66
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
67
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
68
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
64
69
  def delete_all_configurations
65
70
  super
66
71
  end
67
72
 
68
73
  ##
69
74
  # Deletes this LDAP configurations.
70
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
71
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
72
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
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.
73
79
  def delete_configuration
74
80
  super
75
81
  end
76
82
 
77
83
  ##
78
84
  # Gets the distinguished names used to bind to the servers. Default is to bind anonymously.
85
+ # @rspec_example
79
86
  # @return [String]
80
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
81
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
82
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
87
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
88
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
89
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
83
90
  def bind_distinguished_name
84
91
  super
85
92
  end
86
93
 
87
94
  ##
88
95
  # Gets the credentials used to bind to the servers. Default is to bind with no credentials.
96
+ # @rspec_example
89
97
  # @return [String]
90
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
91
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
92
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
98
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
99
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
100
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
93
101
  def bind_password
94
102
  super
95
103
  end
96
104
 
97
105
  ##
98
106
  # Gets the bind time limits in seconds. This is the time to wait for the bind to complete.
107
+ # @rspec_example
99
108
  # @return [long]
100
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
101
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
102
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
109
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
110
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
111
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
103
112
  def bind_time_limit
104
113
  super
105
114
  end
106
115
 
107
116
  ##
108
- # Gets the states indicating whether to check the 'host' attribute for access control. Default is no; if set to yes, and user has no value for the host attribute, and pam_ldap is configured for account management (authorization) then the user will not be allowed to login.
117
+ # Gets the states indicating whether to check the 'host' attribute for access
118
+ # control. Default is no; if set to yes, and user has no value for the host attribute,
119
+ # and pam_ldap is configured for account management (authorization) then the user will
120
+ # not be allowed to login.
121
+ # @rspec_example
109
122
  # @return [EnabledState]
110
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
111
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
112
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
123
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
124
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
125
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
113
126
  def check_host_attribute_state
114
127
  super
115
128
  end
116
129
 
117
130
  ##
118
131
  # Gets the states indicating whether syslog debugging is enabled/disabled.
132
+ # @rspec_example
119
133
  # @return [EnabledState]
120
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
121
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
122
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
134
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
135
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
136
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
123
137
  def debug_state
124
138
  super
125
139
  end
126
140
 
127
141
  ##
128
142
  # Gets the filter strings used by this LDAP configurations.
143
+ # @rspec_example
129
144
  # @return [String]
130
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
131
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
132
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
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.
133
148
  def filter
134
149
  super
135
150
  end
136
151
 
137
152
  ##
138
153
  # Gets the group distinguished names used to enforce membership.
154
+ # @rspec_example
139
155
  # @return [String]
140
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
141
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
142
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
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.
143
159
  def group_distinguished_name
144
160
  super
145
161
  end
146
162
 
147
163
  ##
148
164
  # Gets the group member attributes for this LDAP configurations.
165
+ # @rspec_example
149
166
  # @return [String]
150
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
151
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
152
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
167
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
168
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
169
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
153
170
  def group_member_attribute
154
171
  super
155
172
  end
156
173
 
157
174
  ##
158
- # Gets the idle time limits in seconds. This client will close connections if the server has not been contacted for the number of seconds specified by this value.
175
+ # Gets the idle time limits in seconds. This client will close connections if the server
176
+ # has not been contacted for the number of seconds specified by this value.
177
+ # @rspec_example
159
178
  # @return [long]
160
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
161
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
162
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
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.
163
182
  def idle_time_limit
164
183
  super
165
184
  end
166
185
 
167
186
  ##
168
- # Gets the states indicating whether to ignore errors when authentication information is unavailable.
187
+ # Gets the states indicating whether to ignore errors when authentication information
188
+ # is unavailable.
189
+ # @rspec_example
169
190
  # @return [EnabledState]
170
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
171
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
172
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
191
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
192
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
193
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
173
194
  def ignore_unavailable_authentication_information_state
174
195
  super
175
196
  end
176
197
 
177
198
  ##
178
199
  # Gets the LDAP SSL options used by the LDAP configurations.
200
+ # @rspec_example
179
201
  # @return [LDAPSSLOption]
180
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
181
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
182
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
202
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
203
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
204
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
183
205
  def ldap_ssl_option
184
206
  super
185
207
  end
186
208
 
187
209
  ##
188
210
  # Gets the LDAP versions to use by the LDAP configurations.
211
+ # @rspec_example
189
212
  # @return [long]
190
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
191
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
192
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
213
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
214
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
215
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
193
216
  def ldap_version
194
217
  super
195
218
  end
196
219
 
197
220
  ##
198
221
  # Gets a list of all LDAP configurations.
222
+ # @rspec_example
199
223
  # @return [String]
200
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
201
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
202
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
224
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
225
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
226
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
203
227
  def list
204
228
  super
205
229
  end
206
230
 
207
231
  ##
208
232
  # Gets the login attributes used by this LDAP configurations.
233
+ # @rspec_example
209
234
  # @return [String]
210
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
211
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
212
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
235
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
236
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
237
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
213
238
  def login_attribute
214
239
  super
215
240
  end
216
241
 
217
242
  ##
218
243
  # Gets the ports used by the LDAP servers to listen for requests.
244
+ # @rspec_example
219
245
  # @return [long]
220
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
221
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
222
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
246
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
247
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
248
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
223
249
  def port
224
250
  super
225
251
  end
226
252
 
227
253
  ##
228
254
  # Gets the distinguished names of the search bases used by the LDAP configurations.
255
+ # @rspec_example
229
256
  # @return [String]
230
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
231
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
232
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
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.
233
260
  def search_base_distinguished_name
234
261
  super
235
262
  end
236
263
 
237
264
  ##
238
265
  # Gets the search scopes used by the LDAP configurations.
266
+ # @rspec_example
239
267
  # @return [LDAPSearchScope]
240
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
241
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
242
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
268
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
269
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
270
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
243
271
  def search_scope
244
272
  super
245
273
  end
246
274
 
247
275
  ##
248
- # Gets the search time limits in seconds. This is the time to wait for the search to complete.
276
+ # Gets the search time limits in seconds. This is the time to wait for the search to
277
+ # complete.
278
+ # @rspec_example
249
279
  # @return [long]
250
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
251
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
252
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
280
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
281
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
282
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
253
283
  def search_time_limit
254
284
  super
255
285
  end
256
286
 
257
287
  ##
258
288
  # Gets the lists of servers this LDAP configurations are associated with.
289
+ # @rspec_example
259
290
  # @return [String[]]
260
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
261
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
262
- # @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.
263
294
  def server
264
295
  super
265
296
  end
266
297
 
267
298
  ##
268
299
  # Gets the CA certificates used in server certificate verification.
300
+ # @rspec_example
269
301
  # @return [String]
270
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
271
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
272
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
302
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
303
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
304
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
273
305
  def ssl_ca_certificate_file
274
306
  super
275
307
  end
276
308
 
277
309
  ##
278
310
  # Gets the states indicating whether to require and verify server certificate.
311
+ # @rspec_example
279
312
  # @return [EnabledState]
280
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
281
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
282
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
313
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
314
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
315
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
283
316
  def ssl_check_peer_state
284
317
  super
285
318
  end
286
319
 
287
320
  ##
288
321
  # Gets the SSL cipher suite used by the LDAP configurations.
322
+ # @rspec_example
289
323
  # @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.
324
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
325
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
326
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
293
327
  def ssl_cipher
294
328
  super
295
329
  end
296
330
 
297
331
  ##
298
332
  # Gets the client certificates used by the LDAP configurations.
333
+ # @rspec_example
299
334
  # @return [String]
300
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
301
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
302
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
335
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
336
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
337
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
303
338
  def ssl_client_certificate
304
339
  super
305
340
  end
306
341
 
307
342
  ##
308
343
  # Gets the client keys used by the LDAP configurations.
344
+ # @rspec_example
309
345
  # @return [String]
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.
346
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
347
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
348
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
313
349
  def ssl_client_key
314
350
  super
315
351
  end
316
352
 
317
353
  ##
318
354
  # Gets the user templates used by this LDAP configurations.
355
+ # @rspec_example
319
356
  # @return [String]
320
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
321
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
322
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
357
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
358
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
359
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
323
360
  def user_template
324
361
  super
325
362
  end
326
363
 
327
364
  ##
328
365
  # Gets the version information for this interface.
366
+ # @rspec_example
329
367
  # @return [String]
330
368
  def version
331
369
  super
@@ -333,19 +371,21 @@ module IControl::Management
333
371
 
334
372
  ##
335
373
  # Gets the states indicating whether to enabled/disable warning messages.
374
+ # @rspec_example
336
375
  # @return [EnabledState]
337
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
338
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
339
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
376
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
377
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
378
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
340
379
  def warning_state
341
380
  super
342
381
  end
343
382
 
344
383
  ##
345
384
  # Removes servers from this LDAP configurations.
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.
385
+ # @rspec_example
386
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
387
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
388
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
349
389
  # @param [Hash] opts
350
390
  # @option opts [String[]] :servers The servers to remove from the LDAP configurations.
351
391
  def remove_server(opts)
@@ -355,9 +395,10 @@ module IControl::Management
355
395
 
356
396
  ##
357
397
  # Sets the distinguished names used to bind to the servers. Default is to bind anonymously.
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.
398
+ # @rspec_example
399
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
400
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
401
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
361
402
  # @param [Hash] opts
362
403
  # @option opts [String] :bind_dns The distinguished names used to bind to the servers.
363
404
  def set_bind_distinguished_name(opts)
@@ -367,9 +408,10 @@ module IControl::Management
367
408
 
368
409
  ##
369
410
  # Sets the credentials used to bind to the servers. Default is to bind with no credentials.
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.
411
+ # @rspec_example
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.
373
415
  # @param [Hash] opts
374
416
  # @option opts [String] :bind_passwords The credentials used to bind to the servers.
375
417
  def set_bind_password(opts)
@@ -379,9 +421,10 @@ module IControl::Management
379
421
 
380
422
  ##
381
423
  # Sets the bind time limits in seconds. This is the time to wait for the bind to complete.
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.
424
+ # @rspec_example
425
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
426
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
427
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
385
428
  # @param [Hash] opts
386
429
  # @option opts [long] :time_limits The bind time limits in seconds.
387
430
  def set_bind_time_limit(opts)
@@ -390,10 +433,14 @@ module IControl::Management
390
433
  end
391
434
 
392
435
  ##
393
- # Sets the states indicating whether to check the 'host' attribute for access control. Default is no; if set to yes, and user has no value for the host attribute, and pam_ldap is configured for account management (authorization) then the user will not be allowed to login.
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.
436
+ # Sets the states indicating whether to check the 'host' attribute for access
437
+ # control. Default is no; if set to yes, and user has no value for the host attribute,
438
+ # and pam_ldap is configured for account management (authorization) then the user will
439
+ # not be allowed to login.
440
+ # @rspec_example
441
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
442
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
443
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
397
444
  # @param [Hash] opts
398
445
  # @option opts [IControl::Common::EnabledState] :states The states of the specified configurations.
399
446
  def set_check_host_attribute_state(opts)
@@ -403,9 +450,10 @@ module IControl::Management
403
450
 
404
451
  ##
405
452
  # Sets the states indicating whether syslog debugging is enabled/disabled.
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.
453
+ # @rspec_example
454
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
455
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
456
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
409
457
  # @param [Hash] opts
410
458
  # @option opts [IControl::Common::EnabledState] :states The syslog debugging states of the specified configurations.
411
459
  def set_debug_state(opts)
@@ -415,9 +463,10 @@ module IControl::Management
415
463
 
416
464
  ##
417
465
  # Sets the filter strings used by this LDAP configurations.
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.
466
+ # @rspec_example
467
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
468
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
469
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
421
470
  # @param [Hash] opts
422
471
  # @option opts [String] :filters The filter strings.
423
472
  def set_filter(opts)
@@ -427,9 +476,10 @@ module IControl::Management
427
476
 
428
477
  ##
429
478
  # Sets the group distinguished names used to enforce membership.
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.
479
+ # @rspec_example
480
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
481
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
482
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
433
483
  # @param [Hash] opts
434
484
  # @option opts [String] :group_dns The group distinguished names.
435
485
  def set_group_distinguished_name(opts)
@@ -439,9 +489,10 @@ module IControl::Management
439
489
 
440
490
  ##
441
491
  # Sets the group member attributes for this LDAP configurations.
442
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
443
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
444
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
492
+ # @rspec_example
493
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
494
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
495
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
445
496
  # @param [Hash] opts
446
497
  # @option opts [String] :member_attrs The group member attributes.
447
498
  def set_group_member_attribute(opts)
@@ -450,10 +501,12 @@ module IControl::Management
450
501
  end
451
502
 
452
503
  ##
453
- # Sets the idle time limits in seconds. This client will close connections if the server has not been contacted for the number of seconds specified by this value.
454
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
455
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
456
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
504
+ # Sets the idle time limits in seconds. This client will close connections if the server
505
+ # has not been contacted for the number of seconds specified by this value.
506
+ # @rspec_example
507
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
508
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
509
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
457
510
  # @param [Hash] opts
458
511
  # @option opts [long] :time_limits The idle time limits in seconds.
459
512
  def set_idle_time_limit(opts)
@@ -462,10 +515,12 @@ module IControl::Management
462
515
  end
463
516
 
464
517
  ##
465
- # Sets the states indicating whether to ignore errors when authentication information is unavailable.
466
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
467
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
468
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
518
+ # Sets the states indicating whether to ignore errors when authentication information
519
+ # is unavailable.
520
+ # @rspec_example
521
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
522
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
523
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
469
524
  # @param [Hash] opts
470
525
  # @option opts [IControl::Common::EnabledState] :states The states of the specified configurations.
471
526
  def set_ignore_unavailable_authentication_information_state(opts)
@@ -475,9 +530,10 @@ module IControl::Management
475
530
 
476
531
  ##
477
532
  # Sets the LDAP SSL options used by the LDAP configurations.
478
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
479
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
480
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
533
+ # @rspec_example
534
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
535
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
536
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
481
537
  # @param [Hash] opts
482
538
  # @option opts [IControl::Management::LDAPSSLOption] :options The LDAP SSL options used by the configurations.
483
539
  def set_ldap_ssl_option(opts)
@@ -487,9 +543,10 @@ module IControl::Management
487
543
 
488
544
  ##
489
545
  # Sets the LDAP versions to use by the LDAP configurations.
490
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
491
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
492
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
546
+ # @rspec_example
547
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
548
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
549
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
493
550
  # @param [Hash] opts
494
551
  # @option opts [long] :versions The LDAP versions to use by the LDAP configurations.
495
552
  def set_ldap_version(opts)
@@ -499,9 +556,10 @@ module IControl::Management
499
556
 
500
557
  ##
501
558
  # Sets the login attributes used by this LDAP configurations.
502
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
503
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
504
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
559
+ # @rspec_example
560
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
561
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
562
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
505
563
  # @param [Hash] opts
506
564
  # @option opts [String] :login_attributes The login attributes.
507
565
  def set_login_attribute(opts)
@@ -511,9 +569,10 @@ module IControl::Management
511
569
 
512
570
  ##
513
571
  # Sets the ports used by the LDAP servers to listen for requests.
514
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
515
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
516
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
572
+ # @rspec_example
573
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
574
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
575
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
517
576
  # @param [Hash] opts
518
577
  # @option opts [long] :ports The ports used by the LDAP servers in the configurations.
519
578
  def set_port(opts)
@@ -523,9 +582,10 @@ module IControl::Management
523
582
 
524
583
  ##
525
584
  # Sets the distinguished names of the search bases used by the LDAP configurations.
526
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
527
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
528
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
585
+ # @rspec_example
586
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
587
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
588
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
529
589
  # @param [Hash] opts
530
590
  # @option opts [String] :search_base_dns The distinguished names of the search bases used by the LDAP configurations.
531
591
  def set_search_base_distinguished_name(opts)
@@ -535,9 +595,10 @@ module IControl::Management
535
595
 
536
596
  ##
537
597
  # Sets the search scopes used by the LDAP configurations.
538
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
539
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
540
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
598
+ # @rspec_example
599
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
600
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
601
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
541
602
  # @param [Hash] opts
542
603
  # @option opts [IControl::Management::LDAPSearchScope] :search_scopes The search scopes used by the LDAP configurations.
543
604
  def set_search_scope(opts)
@@ -546,10 +607,12 @@ module IControl::Management
546
607
  end
547
608
 
548
609
  ##
549
- # Sets the search time limits in seconds. This is the time to wait for the search to complete.
550
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
551
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
552
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
610
+ # Sets the search time limits in seconds. This is the time to wait for the search to
611
+ # complete.
612
+ # @rspec_example
613
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
614
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
615
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
553
616
  # @param [Hash] opts
554
617
  # @option opts [long] :time_limits The search time limits in seconds.
555
618
  def set_search_time_limit(opts)
@@ -559,9 +622,10 @@ module IControl::Management
559
622
 
560
623
  ##
561
624
  # Sets the CA certificates used in server certificate verification.
562
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
563
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
564
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
625
+ # @rspec_example
626
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
627
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
628
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
565
629
  # @param [Hash] opts
566
630
  # @option opts [String] :ca_cert_files The CA certificates used in server certificate verification.
567
631
  def set_ssl_ca_certificate_file(opts)
@@ -571,9 +635,10 @@ module IControl::Management
571
635
 
572
636
  ##
573
637
  # Sets the states indicating whether to require and verify server certificate.
574
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
575
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
576
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
638
+ # @rspec_example
639
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
640
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
641
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
577
642
  # @param [Hash] opts
578
643
  # @option opts [IControl::Common::EnabledState] :states The states of the specified configurations.
579
644
  def set_ssl_check_peer_state(opts)
@@ -583,9 +648,10 @@ module IControl::Management
583
648
 
584
649
  ##
585
650
  # Sets the SSL cipher suite used by the LDAP configurations.
586
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
587
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
588
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
651
+ # @rspec_example
652
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
653
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
654
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
589
655
  # @param [Hash] opts
590
656
  # @option opts [String[]] :ciphers The SSL cipher suite used by the LDAP configurations.
591
657
  def set_ssl_cipher(opts)
@@ -595,9 +661,10 @@ module IControl::Management
595
661
 
596
662
  ##
597
663
  # Sets the client certificates used by the LDAP configurations.
598
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
599
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
600
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
664
+ # @rspec_example
665
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
666
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
667
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
601
668
  # @param [Hash] opts
602
669
  # @option opts [String] :certificates The client certificates used by the LDAP configurations.
603
670
  def set_ssl_client_certificate(opts)
@@ -607,9 +674,10 @@ module IControl::Management
607
674
 
608
675
  ##
609
676
  # Sets the client keys used by the LDAP configurations.
610
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
611
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
612
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
677
+ # @rspec_example
678
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
679
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
680
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
613
681
  # @param [Hash] opts
614
682
  # @option opts [String] :keys The client keys used by the LDAP configurations.
615
683
  def set_ssl_client_key(opts)
@@ -619,9 +687,10 @@ module IControl::Management
619
687
 
620
688
  ##
621
689
  # Sets the user templates used by this LDAP configurations.
622
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
623
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
624
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
690
+ # @rspec_example
691
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
692
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
693
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
625
694
  # @param [Hash] opts
626
695
  # @option opts [String] :templates The user templates.
627
696
  def set_user_template(opts)
@@ -631,9 +700,10 @@ module IControl::Management
631
700
 
632
701
  ##
633
702
  # Sets the states indicating whether to enabled/disable warning messages.
634
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
635
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
636
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
703
+ # @rspec_example
704
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
705
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
706
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
637
707
  # @param [Hash] opts
638
708
  # @option opts [IControl::Common::EnabledState] :states The states of the specified configurations.
639
709
  def set_warning_state(opts)