Class: IControl::Management::CCLDAPConfiguration
- Inherits:
-
Base
- Object
- Base
- IControl::Management::CCLDAPConfiguration
- Defined in:
- lib/icontrol/management/ccldap_configuration.rb,
lib/icontrol/management.rb
Overview
The CCLDAPConfiguration interface enables you to manage SSL Client Certificate LDAP PAM configuration.
Defined Under Namespace
Classes: LDAPSearchOption, LDAPSearchOptionSequence
Instance Method Summary (collapse)
-
- (Object) add_server(opts)
Adds/associates servers to this Client Certificate LDAP configurations.
-
- (Object) add_valid_group(opts)
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).
-
- (Object) add_valid_role(opts)
Adds/associates lists of valid roles that the client must possess in order to be authorized.
-
- (String) admin_distinguished_name
Gets the admin DNs for this Client Certificate LDAP configurations.
-
- (String) admin_password
Gets the admin passwords for this Client Certificate LDAP configurations.
-
- (long) cache_size
Gets the maximum LDAP response cache sizes in bytes.
-
- (long) cache_timeout
Gets the LDAP response cache timeout in seconds.
-
- (Object) create(opts)
Creates this Client Certificate LDAP configurations.
-
- (Object) delete_all_configurations
Deletes all Client Certificate LDAP configurations.
-
- (Object) delete_configuration
Deletes this Client Certificate LDAP configurations.
-
- (String) group_base
Gets the search bases for the subtrees used by group searches.
-
- (String) group_key
Gets the names of the attributes in the LDAP database that identify the group names in the group subtrees.
-
- (String) group_member_key
Gets the names of the attributes in the LDAP database that identify members (DNs) of a group.
-
- (String) list
Gets a list of all Client Certificate LDAP configurations.
-
- (Object) remove_all_valid_groups
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).
-
- (Object) remove_all_valid_roles
Removes all lists of valid roles that the client must possess in order to be authorized.
-
- (Object) remove_server(opts)
Removes servers from this Client Certificate LDAP configurations.
-
- (Object) remove_valid_group(opts)
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).
-
- (Object) remove_valid_role(opts)
Removes lists of valid roles that the client must possess in order to be authorized.
-
- (String) role_key
Gets the names of the attributes in the LDAP database that identify a user's authorization roles.
-
- (LDAPSearchOption) search_option
Gets the search options used by the Client Certificate LDAP configurations.
-
- (String[]) server
Gets the lists of servers this Client Certificate LDAP configurations are associated with.
-
- (Object) set_admin_distinguished_name(opts)
Sets the admin DNs for this Client Certificate LDAP configurations.
-
- (Object) set_admin_password(opts)
Sets the admin passwords for this Client Certificate LDAP configurations.
-
- (Object) set_cache_size(opts)
Sets the maximum LDAP response cache sizes in bytes.
-
- (Object) set_cache_timeout(opts)
Sets the LDAP response cache timeout in seconds.
-
- (Object) set_group_base(opts)
Sets the search bases for the subtrees used by group searches.
-
- (Object) set_group_key(opts)
Sets the names of the attributes in the LDAP database that identify the group names in the group subtrees.
-
- (Object) set_group_member_key(opts)
Sets the names of the attributes in the LDAP database that identify members (DNs) of a group.
-
- (Object) set_role_key(opts)
Sets the names of the attributes in the LDAP database that identify a user's authorization roles.
-
- (Object) set_search_option(opts)
Sets the search options used by the Client Certificate LDAP configurations.
-
- (Object) set_use_certificate_serial_state(opts)
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.
-
- (Object) set_use_security_state(opts)
Sets the states indicating whether SSL/TLS should be used when connecting to the LDAP server.
-
- (Object) set_user_class(opts)
Sets the user classes (only in certficate search method) for this Client Certificate LDAP configurations.
-
- (EnabledState) use_certificate_serial_state
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.
-
- (EnabledState) use_security_state
Gets the states indicating whether SSL/TLS should be used when connecting to the LDAP server.
-
- (String) user_class
Gets the user classes (only in certficate search method) for this Client Certificate LDAP configurations.
-
- (String[]) valid_group
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).
-
- (String[]) valid_role
Gets the lists of valid roles that the client must possess in order to be authorized.
-
- (String) version
Gets the version information for this interface.
Dynamic Method Handling
This class handles dynamic methods through the method_missing method in the class IControl::Base
Instance Method Details
- (Object) add_server(opts)
Adds/associates servers to this Client Certificate LDAP configurations.
18 19 20 21 |
# File 'lib/icontrol/management/ccldap_configuration.rb', line 18 def add_server(opts) check_params(opts,[:servers]) super end |
- (Object) add_valid_group(opts)
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.
33 34 35 36 |
# File 'lib/icontrol/management/ccldap_configuration.rb', line 33 def add_valid_group(opts) check_params(opts,[:groups]) super end |
- (Object) add_valid_role(opts)
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.
48 49 50 51 |
# File 'lib/icontrol/management/ccldap_configuration.rb', line 48 def add_valid_role(opts) check_params(opts,[:roles]) super end |
- (String) admin_distinguished_name
Gets the admin DNs for this Client Certificate LDAP configurations.
94 95 96 |
# File 'lib/icontrol/management/ccldap_configuration.rb', line 94 def admin_distinguished_name super end |
- (String) admin_password
Gets the admin passwords for this Client Certificate LDAP configurations.
105 106 107 |
# File 'lib/icontrol/management/ccldap_configuration.rb', line 105 def admin_password super end |
- (long) cache_size
Gets the maximum LDAP response cache sizes in bytes. If zero is specified, the cache is not activated.
117 118 119 |
# File 'lib/icontrol/management/ccldap_configuration.rb', line 117 def cache_size super end |
- (long) cache_timeout
Gets the LDAP response cache timeout in seconds. If zero is specified, the cache is not activated.
129 130 131 |
# File 'lib/icontrol/management/ccldap_configuration.rb', line 129 def cache_timeout super end |
- (Object) create(opts)
Creates this Client Certificate LDAP configurations.
62 63 64 65 |
# File 'lib/icontrol/management/ccldap_configuration.rb', line 62 def create(opts) check_params(opts,[:search_options,:servers]) super end |
- (Object) delete_all_configurations
Deletes all Client Certificate LDAP configurations.
73 74 75 |
# File 'lib/icontrol/management/ccldap_configuration.rb', line 73 def delete_all_configurations super end |
- (Object) delete_configuration
Deletes this Client Certificate LDAP configurations.
83 84 85 |
# File 'lib/icontrol/management/ccldap_configuration.rb', line 83 def delete_configuration super end |
- (String) group_base
Gets the search bases for the subtrees used by group searches.
140 141 142 |
# File 'lib/icontrol/management/ccldap_configuration.rb', line 140 def group_base super end |
- (String) group_key
Gets the names of the attributes in the LDAP database that identify the group names in the group subtrees.
152 153 154 |
# File 'lib/icontrol/management/ccldap_configuration.rb', line 152 def group_key super end |
- (String) group_member_key
Gets the names of the attributes in the LDAP database that identify members (DNs) of a group. A typical key would be "member".
164 165 166 |
# File 'lib/icontrol/management/ccldap_configuration.rb', line 164 def group_member_key super end |
- (String) list
Gets a list of all Client Certificate LDAP configurations.
175 176 177 |
# File 'lib/icontrol/management/ccldap_configuration.rb', line 175 def list super end |
- (Object) remove_all_valid_groups
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.
292 293 294 |
# File 'lib/icontrol/management/ccldap_configuration.rb', line 292 def remove_all_valid_groups super end |
- (Object) remove_all_valid_roles
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.
303 304 305 |
# File 'lib/icontrol/management/ccldap_configuration.rb', line 303 def remove_all_valid_roles super end |
- (Object) remove_server(opts)
Removes servers from this Client Certificate LDAP configurations.
315 316 317 318 |
# File 'lib/icontrol/management/ccldap_configuration.rb', line 315 def remove_server(opts) check_params(opts,[:servers]) super end |
- (Object) remove_valid_group(opts)
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.
330 331 332 333 |
# File 'lib/icontrol/management/ccldap_configuration.rb', line 330 def remove_valid_group(opts) check_params(opts,[:groups]) super end |
- (Object) remove_valid_role(opts)
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.
344 345 346 347 |
# File 'lib/icontrol/management/ccldap_configuration.rb', line 344 def remove_valid_role(opts) check_params(opts,[:roles]) super end |
- (String) role_key
Gets the names of the attributes in the LDAP database that identify a user's authorization roles.
187 188 189 |
# File 'lib/icontrol/management/ccldap_configuration.rb', line 187 def role_key super end |
- (LDAPSearchOption) search_option
Gets the search options used by the Client Certificate LDAP configurations.
198 199 200 |
# File 'lib/icontrol/management/ccldap_configuration.rb', line 198 def search_option super end |
- (String[]) server
Gets the lists of servers this Client Certificate LDAP configurations are associated with.
210 211 212 |
# File 'lib/icontrol/management/ccldap_configuration.rb', line 210 def server super end |
- (Object) set_admin_distinguished_name(opts)
Sets the admin DNs for this Client Certificate LDAP configurations.
357 358 359 360 |
# File 'lib/icontrol/management/ccldap_configuration.rb', line 357 def set_admin_distinguished_name(opts) check_params(opts,[:admin_dns]) super end |
- (Object) set_admin_password(opts)
Sets the admin passwords for this Client Certificate LDAP configurations.
370 371 372 373 |
# File 'lib/icontrol/management/ccldap_configuration.rb', line 370 def set_admin_password(opts) check_params(opts,[:admin_passwords]) super end |
- (Object) set_cache_size(opts)
Sets the maximum LDAP response cache sizes in bytes. If zero is specified, the cache is not activated.
384 385 386 387 |
# File 'lib/icontrol/management/ccldap_configuration.rb', line 384 def set_cache_size(opts) check_params(opts,[:sizes]) super end |
- (Object) set_cache_timeout(opts)
Sets the LDAP response cache timeout in seconds. If zero is specified, the cache is not activated.
398 399 400 401 |
# File 'lib/icontrol/management/ccldap_configuration.rb', line 398 def set_cache_timeout(opts) check_params(opts,[:timeouts]) super end |
- (Object) set_group_base(opts)
Sets the search bases for the subtrees used by group searches.
411 412 413 414 |
# File 'lib/icontrol/management/ccldap_configuration.rb', line 411 def set_group_base(opts) check_params(opts,[:bases]) super end |
- (Object) set_group_key(opts)
Sets the names of the attributes in the LDAP database that identify the group names in the group subtrees.
425 426 427 428 |
# File 'lib/icontrol/management/ccldap_configuration.rb', line 425 def set_group_key(opts) check_params(opts,[:keys]) super end |
- (Object) set_group_member_key(opts)
Sets the names of the attributes in the LDAP database that identify members (DNs) of a group. A typical key would be "member".
439 440 441 442 |
# File 'lib/icontrol/management/ccldap_configuration.rb', line 439 def set_group_member_key(opts) check_params(opts,[:keys]) super end |
- (Object) set_role_key(opts)
Sets the names of the attributes in the LDAP database that identify a user's authorization roles.
453 454 455 456 |
# File 'lib/icontrol/management/ccldap_configuration.rb', line 453 def set_role_key(opts) check_params(opts,[:keys]) super end |
- (Object) set_search_option(opts)
Sets the search options used by the Client Certificate LDAP configurations.
466 467 468 469 |
# File 'lib/icontrol/management/ccldap_configuration.rb', line 466 def set_search_option(opts) check_params(opts,[:options]) super end |
- (Object) set_use_certificate_serial_state(opts)
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.
481 482 483 484 |
# File 'lib/icontrol/management/ccldap_configuration.rb', line 481 def set_use_certificate_serial_state(opts) check_params(opts,[:states]) super end |
- (Object) set_use_security_state(opts)
Sets the states indicating whether SSL/TLS should be used when connecting to the LDAP server.
495 496 497 498 |
# File 'lib/icontrol/management/ccldap_configuration.rb', line 495 def set_use_security_state(opts) check_params(opts,[:states]) super end |
- (Object) set_user_class(opts)
Sets the user classes (only in certficate search method) for this Client Certificate LDAP configurations.
509 510 511 512 |
# File 'lib/icontrol/management/ccldap_configuration.rb', line 509 def set_user_class(opts) check_params(opts,[:user_classes]) super end |
- (EnabledState) use_certificate_serial_state
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.
223 224 225 |
# File 'lib/icontrol/management/ccldap_configuration.rb', line 223 def use_certificate_serial_state super end |
- (EnabledState) use_security_state
Gets the states indicating whether SSL/TLS should be used when connecting to the LDAP server.
235 236 237 |
# File 'lib/icontrol/management/ccldap_configuration.rb', line 235 def use_security_state super end |
- (String) user_class
Gets the user classes (only in certficate search method) for this Client Certificate LDAP configurations.
247 248 249 |
# File 'lib/icontrol/management/ccldap_configuration.rb', line 247 def user_class super end |
- (String[]) valid_group
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.
260 261 262 |
# File 'lib/icontrol/management/ccldap_configuration.rb', line 260 def valid_group super end |
- (String[]) valid_role
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.
272 273 274 |
# File 'lib/icontrol/management/ccldap_configuration.rb', line 272 def valid_role super end |
- (String) version
Gets the version information for this interface.
280 281 282 |
# File 'lib/icontrol/management/ccldap_configuration.rb', line 280 def version super end |