Class: IControl::Management::CCLDAPConfiguration

Inherits:
Base
  • Object
show all
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

Dynamic Method Handling

This class handles dynamic methods through the method_missing method in the class IControl::Base

Instance Method Details

#add_server(opts) ⇒ Object

Adds/associates servers to this Client Certificate LDAP configurations.

Parameters:

  • opts (Hash)

Options Hash (opts):

  • :servers (String[]) —

    The servers to add to the Client Certificate LDAP configurations.

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



18
19
20
21
 
# File 'lib/icontrol/management/ccldap_configuration.rb', line 18

def add_server(opts)
  opts = check_params(opts,[:servers])
  super(opts)
end

#add_valid_group(opts) ⇒ Object

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.

Parameters:

  • opts (Hash)

Options Hash (opts):

  • :groups (String[]) —

    The valid groups to add to the Client Certificate LDAP configurations.

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



33
34
35
36
 
# File 'lib/icontrol/management/ccldap_configuration.rb', line 33

def add_valid_group(opts)
  opts = check_params(opts,[:groups])
  super(opts)
end

#add_valid_role(opts) ⇒ Object

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.

Parameters:

  • opts (Hash)

Options Hash (opts):

  • :roles (String[]) —

    The valid roles to add to the Client Certificate LDAP configurations.

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



48
49
50
51
 
# File 'lib/icontrol/management/ccldap_configuration.rb', line 48

def add_valid_role(opts)
  opts = check_params(opts,[:roles])
  super(opts)
end

#admin_distinguished_name ⇒ String

Gets the admin DNs for this Client Certificate LDAP configurations.

Returns:

  • (String)

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



94
95
96
 
# File 'lib/icontrol/management/ccldap_configuration.rb', line 94

def admin_distinguished_name
  super
end

#admin_password ⇒ String

Gets the admin passwords for this Client Certificate LDAP configurations.

Returns:

  • (String)

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



105
106
107
 
# File 'lib/icontrol/management/ccldap_configuration.rb', line 105

def admin_password
  super
end

#cache_size ⇒ long

Gets the maximum LDAP response cache sizes in bytes. If zero is specified, the cache is not activated.

Returns:

  • (long)

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



117
118
119
 
# File 'lib/icontrol/management/ccldap_configuration.rb', line 117

def cache_size
  super
end

#cache_timeout ⇒ long

Gets the LDAP response cache timeout in seconds. If zero is specified, the cache is not activated.

Returns:

  • (long)

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



129
130
131
 
# File 'lib/icontrol/management/ccldap_configuration.rb', line 129

def cache_timeout
  super
end

#create(opts) ⇒ Object

Creates this Client Certificate LDAP configurations.

Parameters:

  • opts (Hash)

Options Hash (opts):

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



62
63
64
65
 
# File 'lib/icontrol/management/ccldap_configuration.rb', line 62

def create(opts)
  opts = check_params(opts,[:search_options,:servers])
  super(opts)
end

#delete_all_configurations ⇒ Object

Deletes all Client Certificate LDAP configurations.

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



73
74
75
 
# File 'lib/icontrol/management/ccldap_configuration.rb', line 73

def delete_all_configurations
  super
end

#delete_configuration ⇒ Object

Deletes this Client Certificate LDAP configurations.

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



83
84
85
 
# File 'lib/icontrol/management/ccldap_configuration.rb', line 83

def delete_configuration
  super
end

#group_base ⇒ String

Gets the search bases for the subtrees used by group searches.

Returns:

  • (String)

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



140
141
142
 
# File 'lib/icontrol/management/ccldap_configuration.rb', line 140

def group_base
  super
end

#group_key ⇒ String

Gets the names of the attributes in the LDAP database that identify the group names in the group subtrees.

Returns:

  • (String)

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



152
153
154
 
# File 'lib/icontrol/management/ccldap_configuration.rb', line 152

def group_key
  super
end

#group_member_key ⇒ String

Gets the names of the attributes in the LDAP database that identify members (DNs) of a group. A typical key would be "member“.

Returns:

  • (String)

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



164
165
166
 
# File 'lib/icontrol/management/ccldap_configuration.rb', line 164

def group_member_key
  super
end

#list ⇒ String

Gets a list of all Client Certificate LDAP configurations.

Returns:

  • (String)

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



175
176
177
 
# File 'lib/icontrol/management/ccldap_configuration.rb', line 175

def list
  super
end

#remove_all_valid_groups ⇒ Object

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.

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



292
293
294
 
# File 'lib/icontrol/management/ccldap_configuration.rb', line 292

def remove_all_valid_groups
  super
end

#remove_all_valid_roles ⇒ Object

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.

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



303
304
305
 
# File 'lib/icontrol/management/ccldap_configuration.rb', line 303

def remove_all_valid_roles
  super
end

#remove_server(opts) ⇒ Object

Removes servers from this Client Certificate LDAP configurations.

Parameters:

  • opts (Hash)

Options Hash (opts):

  • :servers (String[]) —

    The servers to remove from the Client Certificate LDAP configurations.

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



315
316
317
318
 
# File 'lib/icontrol/management/ccldap_configuration.rb', line 315

def remove_server(opts)
  opts = check_params(opts,[:servers])
  super(opts)
end

#remove_valid_group(opts) ⇒ Object

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.

Parameters:

  • opts (Hash)

Options Hash (opts):

  • :groups (String[]) —

    The valid groups to remove from the Client Certificate LDAP configurations.

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



330
331
332
333
 
# File 'lib/icontrol/management/ccldap_configuration.rb', line 330

def remove_valid_group(opts)
  opts = check_params(opts,[:groups])
  super(opts)
end

#remove_valid_role(opts) ⇒ Object

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.

Parameters:

  • opts (Hash)

Options Hash (opts):

  • :roles (String[]) —

    The valid roles to remove from the Client Certificate LDAP configurations.

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



344
345
346
347
 
# File 'lib/icontrol/management/ccldap_configuration.rb', line 344

def remove_valid_role(opts)
  opts = check_params(opts,[:roles])
  super(opts)
end

#role_key ⇒ String

Gets the names of the attributes in the LDAP database that identify a user’s authorization roles.

Returns:

  • (String)

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



187
188
189
 
# File 'lib/icontrol/management/ccldap_configuration.rb', line 187

def role_key
  super
end

#search_option ⇒ LDAPSearchOption

Gets the search options used by the Client Certificate LDAP configurations.

Returns:

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



198
199
200
 
# File 'lib/icontrol/management/ccldap_configuration.rb', line 198

def search_option
  super
end

#server ⇒ String[]

Gets the lists of servers this Client Certificate LDAP configurations are associated with.

Returns:

  • (String[])

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



210
211
212
 
# File 'lib/icontrol/management/ccldap_configuration.rb', line 210

def server
  super
end

#set_admin_distinguished_name(opts) ⇒ Object

Sets the admin DNs for this Client Certificate LDAP configurations.

Parameters:

  • opts (Hash)

Options Hash (opts):

  • :admin_dns (String) —

    The admin Distinguished names.

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



357
358
359
360
 
# File 'lib/icontrol/management/ccldap_configuration.rb', line 357

def set_admin_distinguished_name(opts)
  opts = check_params(opts,[:admin_dns])
  super(opts)
end

#set_admin_password(opts) ⇒ Object

Sets the admin passwords for this Client Certificate LDAP configurations.

Parameters:

  • opts (Hash)

Options Hash (opts):

  • :admin_passwords (String) —

    The admin passwords.

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



370
371
372
373
 
# File 'lib/icontrol/management/ccldap_configuration.rb', line 370

def set_admin_password(opts)
  opts = check_params(opts,[:admin_passwords])
  super(opts)
end

#set_cache_size(opts) ⇒ Object

Sets the maximum LDAP response cache sizes in bytes. If zero is specified, the cache is not activated.

Parameters:

  • opts (Hash)

Options Hash (opts):

  • :sizes (long) —

    The cache sizes used by the LDAP servers in the configurations.

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



384
385
386
387
 
# File 'lib/icontrol/management/ccldap_configuration.rb', line 384

def set_cache_size(opts)
  opts = check_params(opts,[:sizes])
  super(opts)
end

#set_cache_timeout(opts) ⇒ Object

Sets the LDAP response cache timeout in seconds. If zero is specified, the cache is not activated.

Parameters:

  • opts (Hash)

Options Hash (opts):

  • :timeouts (long) —

    The cache timeouts used by the configurations.

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



398
399
400
401
 
# File 'lib/icontrol/management/ccldap_configuration.rb', line 398

def set_cache_timeout(opts)
  opts = check_params(opts,[:timeouts])
  super(opts)
end

#set_group_base(opts) ⇒ Object

Sets the search bases for the subtrees used by group searches.

Parameters:

  • opts (Hash)

Options Hash (opts):

  • :bases (String) —

    The search bases for the subtrees used by the Client Certificate LDAP configurations.

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



411
412
413
414
 
# File 'lib/icontrol/management/ccldap_configuration.rb', line 411

def set_group_base(opts)
  opts = check_params(opts,[:bases])
  super(opts)
end

#set_group_key(opts) ⇒ Object

Sets the names of the attributes in the LDAP database that identify the group names in the group subtrees.

Parameters:

  • opts (Hash)

Options Hash (opts):

  • :keys (String) —

    The names of the attributes in the LDAP database that identify the group names.

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



425
426
427
428
 
# File 'lib/icontrol/management/ccldap_configuration.rb', line 425

def set_group_key(opts)
  opts = check_params(opts,[:keys])
  super(opts)
end

#set_group_member_key(opts) ⇒ Object

Sets the names of the attributes in the LDAP database that identify members (DNs) of a group. A typical key would be "member“.

Parameters:

  • opts (Hash)

Options Hash (opts):

  • :keys (String) —

    The names of the attributes in the LDAP database that identify members ( DNs ) of a group.

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



439
440
441
442
 
# File 'lib/icontrol/management/ccldap_configuration.rb', line 439

def set_group_member_key(opts)
  opts = check_params(opts,[:keys])
  super(opts)
end

#set_role_key(opts) ⇒ Object

Sets the names of the attributes in the LDAP database that identify a user’s authorization roles.

Parameters:

  • opts (Hash)

Options Hash (opts):

  • :keys (String) —

    The names of the attributes in the LDAP database that identify a user’s authorization roles.

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



453
454
455
456
 
# File 'lib/icontrol/management/ccldap_configuration.rb', line 453

def set_role_key(opts)
  opts = check_params(opts,[:keys])
  super(opts)
end

#set_search_option(opts) ⇒ Object

Sets the search options used by the Client Certificate LDAP configurations.

Parameters:

  • opts (Hash)

Options Hash (opts):

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



466
467
468
469
 
# File 'lib/icontrol/management/ccldap_configuration.rb', line 466

def set_search_option(opts)
  opts = check_params(opts,[:options])
  super(opts)
end

#set_use_certificate_serial_state(opts) ⇒ Object

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.

Parameters:

  • opts (Hash)

Options Hash (opts):

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



481
482
483
484
 
# File 'lib/icontrol/management/ccldap_configuration.rb', line 481

def set_use_certificate_serial_state(opts)
  opts = check_params(opts,[:states])
  super(opts)
end

#set_use_security_state(opts) ⇒ Object

Sets the states indicating whether SSL/TLS should be used when connecting to the LDAP server.

Parameters:

  • opts (Hash)

Options Hash (opts):

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



495
496
497
498
 
# File 'lib/icontrol/management/ccldap_configuration.rb', line 495

def set_use_security_state(opts)
  opts = check_params(opts,[:states])
  super(opts)
end

#set_user_class(opts) ⇒ Object

Sets the user classes (only in certficate search method) for this Client Certificate LDAP configurations.

Parameters:

  • opts (Hash)

Options Hash (opts):

  • :user_classes (String) —

    The user classes.

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



509
510
511
512
 
# File 'lib/icontrol/management/ccldap_configuration.rb', line 509

def set_user_class(opts)
  opts = check_params(opts,[:user_classes])
  super(opts)
end

#use_certificate_serial_state ⇒ EnabledState

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.

Returns:

  • (EnabledState)

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



223
224
225
 
# File 'lib/icontrol/management/ccldap_configuration.rb', line 223

def use_certificate_serial_state
  super
end

#use_security_state ⇒ EnabledState

Gets the states indicating whether SSL/TLS should be used when connecting to the LDAP server.

Returns:

  • (EnabledState)

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



235
236
237
 
# File 'lib/icontrol/management/ccldap_configuration.rb', line 235

def use_security_state
  super
end

#user_class ⇒ String

Gets the user classes (only in certficate search method) for this Client Certificate LDAP configurations.

Returns:

  • (String)

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



247
248
249
 
# File 'lib/icontrol/management/ccldap_configuration.rb', line 247

def user_class
  super
end

#valid_group ⇒ String[]

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.

Returns:

  • (String[])

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



260
261
262
 
# File 'lib/icontrol/management/ccldap_configuration.rb', line 260

def valid_group
  super
end

#valid_role ⇒ String[]

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.

Returns:

  • (String[])

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



272
273
274
 
# File 'lib/icontrol/management/ccldap_configuration.rb', line 272

def valid_role
  super
end

#version ⇒ String

Gets the version information for this interface.

Returns:

  • (String) 


280
281
282
 
# File 'lib/icontrol/management/ccldap_configuration.rb', line 280

def version
  super
end