Class: IControl::Management::LDAPConfiguration

Inherits:
Base
  • Object
show all
Defined in:
lib/icontrol/management/ldap_configuration.rb,
lib/icontrol/management.rb

Overview

The LDAPConfiguration interface enables you to manage LDAP PAM configuration.

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

- (Object) add_server(opts)

Adds/associates servers to this LDAP configurations.

Parameters:

  • opts (Hash)

Options Hash (opts):

  • :servers (String[])

    The servers to add to the 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.



16
17
18
19
# File 'lib/icontrol/management/ldap_configuration.rb', line 16

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

- (String) bind_distinguished_name

Gets the distinguished names used to bind to the servers. Default is to bind anonymously.

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.



90
91
92
# File 'lib/icontrol/management/ldap_configuration.rb', line 90

def bind_distinguished_name
  super
end

- (String) bind_password

Gets the credentials used to bind to the servers. Default is to bind with no credentials.

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.



101
102
103
# File 'lib/icontrol/management/ldap_configuration.rb', line 101

def bind_password
  super
end

- (long) bind_time_limit

Gets the bind time limits in seconds. This is the time to wait for the bind to complete.

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.



112
113
114
# File 'lib/icontrol/management/ldap_configuration.rb', line 112

def bind_time_limit
  super
end

- (EnabledState) check_host_attribute_state

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.

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.



126
127
128
# File 'lib/icontrol/management/ldap_configuration.rb', line 126

def check_host_attribute_state
  super
end

- (Object) create(opts)

Creates this LDAP configurations.

Parameters:

  • opts (Hash)

Options Hash (opts):

  • :search_base_dns (String)

    The distinguished names of the search bases used by the configurations.

  • :servers (String[])

    The list of servers to be assigned to each of 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.



30
31
32
33
# File 'lib/icontrol/management/ldap_configuration.rb', line 30

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

- (Object) create_default_authentication_ad_configuration(opts)

Creates the default authentication Active Directory configuration.

Parameters:

  • opts (Hash)

Options Hash (opts):

  • :search_base_dn (String)

    The distinguished name of the search base used by the configuration.

  • :servers (String)

    The list of servers to be assigned to the configuration.

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.



44
45
46
47
# File 'lib/icontrol/management/ldap_configuration.rb', line 44

def create_default_authentication_ad_configuration(opts)
  check_params(opts,[:search_base_dn,:servers])
  super
end

- (Object) create_default_authentication_ldap_configuration(opts)

Creates the default authentication LDAP configuration.

Parameters:

  • opts (Hash)

Options Hash (opts):

  • :search_base_dn (String)

    The distinguished name of the search base used by the configuration.

  • :servers (String)

    The list of servers to be assigned to the configuration.

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.



58
59
60
61
# File 'lib/icontrol/management/ldap_configuration.rb', line 58

def create_default_authentication_ldap_configuration(opts)
  check_params(opts,[:search_base_dn,:servers])
  super
end

- (EnabledState) debug_state

Gets the states indicating whether syslog debugging is enabled/disabled.

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.



137
138
139
# File 'lib/icontrol/management/ldap_configuration.rb', line 137

def debug_state
  super
end

- (Object) delete_all_configurations

Deletes all 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.



69
70
71
# File 'lib/icontrol/management/ldap_configuration.rb', line 69

def delete_all_configurations
  super
end

- (Object) delete_configuration

Deletes this 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.



79
80
81
# File 'lib/icontrol/management/ldap_configuration.rb', line 79

def delete_configuration
  super
end

- (String) filter

Gets the filter strings used by this 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.



148
149
150
# File 'lib/icontrol/management/ldap_configuration.rb', line 148

def filter
  super
end

- (String) group_distinguished_name

Gets the group distinguished names used to enforce membership.

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.



159
160
161
# File 'lib/icontrol/management/ldap_configuration.rb', line 159

def group_distinguished_name
  super
end

- (String) group_member_attribute

Gets the group member attributes for this 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.



170
171
172
# File 'lib/icontrol/management/ldap_configuration.rb', line 170

def group_member_attribute
  super
end

- (long) idle_time_limit

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.

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.



182
183
184
# File 'lib/icontrol/management/ldap_configuration.rb', line 182

def idle_time_limit
  super
end

- (EnabledState) ignore_unavailable_authentication_information_state

Gets the states indicating whether to ignore errors when authentication information is unavailable.

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.



194
195
196
# File 'lib/icontrol/management/ldap_configuration.rb', line 194

def ignore_unavailable_authentication_information_state
  super
end

- (LDAPSSLOption) ldap_ssl_option

Gets the LDAP SSL options used by the 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.



205
206
207
# File 'lib/icontrol/management/ldap_configuration.rb', line 205

def ldap_ssl_option
  super
end

- (long) ldap_version

Gets the LDAP versions to use by the LDAP configurations.

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.



216
217
218
# File 'lib/icontrol/management/ldap_configuration.rb', line 216

def ldap_version
  super
end

- (String) list

Gets a list of all 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.



227
228
229
# File 'lib/icontrol/management/ldap_configuration.rb', line 227

def list
  super
end

- (String) login_attribute

Gets the login attributes used by this 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.



238
239
240
# File 'lib/icontrol/management/ldap_configuration.rb', line 238

def 
  super
end

- (long) port

Gets the ports used by the LDAP servers to listen for requests.

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.



249
250
251
# File 'lib/icontrol/management/ldap_configuration.rb', line 249

def port
  super
end

- (Object) remove_server(opts)

Removes servers from this LDAP configurations.

Parameters:

  • opts (Hash)

Options Hash (opts):

  • :servers (String[])

    The servers to remove from the 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.



391
392
393
394
# File 'lib/icontrol/management/ldap_configuration.rb', line 391

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

- (String) search_base_distinguished_name

Gets the distinguished names of the search bases used by the 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.



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

def search_base_distinguished_name
  super
end

- (LDAPSearchScope) search_scope

Gets the search scopes used by the 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.



271
272
273
# File 'lib/icontrol/management/ldap_configuration.rb', line 271

def search_scope
  super
end

- (long) search_time_limit

Gets the search time limits in seconds. This is the time to wait for the search to complete.

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.



283
284
285
# File 'lib/icontrol/management/ldap_configuration.rb', line 283

def search_time_limit
  super
end

- (String[]) server

Gets the lists of servers this 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.



294
295
296
# File 'lib/icontrol/management/ldap_configuration.rb', line 294

def server
  super
end

- (Object) set_bind_distinguished_name(opts)

Sets the distinguished names used to bind to the servers. Default is to bind anonymously.

Parameters:

  • opts (Hash)

Options Hash (opts):

  • :bind_dns (String)

    The distinguished names used to bind to the servers.

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.



404
405
406
407
# File 'lib/icontrol/management/ldap_configuration.rb', line 404

def set_bind_distinguished_name(opts)
  check_params(opts,[:bind_dns])
  super
end

- (Object) set_bind_password(opts)

Sets the credentials used to bind to the servers. Default is to bind with no credentials.

Parameters:

  • opts (Hash)

Options Hash (opts):

  • :bind_passwords (String)

    The credentials used to bind to the servers.

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.



417
418
419
420
# File 'lib/icontrol/management/ldap_configuration.rb', line 417

def set_bind_password(opts)
  check_params(opts,[:bind_passwords])
  super
end

- (Object) set_bind_time_limit(opts)

Sets the bind time limits in seconds. This is the time to wait for the bind to complete.

Parameters:

  • opts (Hash)

Options Hash (opts):

  • :time_limits (long)

    The bind time limits in seconds.

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.



430
431
432
433
# File 'lib/icontrol/management/ldap_configuration.rb', line 430

def set_bind_time_limit(opts)
  check_params(opts,[:time_limits])
  super
end

- (Object) set_check_host_attribute_state(opts)

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.

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.



446
447
448
449
# File 'lib/icontrol/management/ldap_configuration.rb', line 446

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

- (Object) set_debug_state(opts)

Sets the states indicating whether syslog debugging is enabled/disabled.

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.



459
460
461
462
# File 'lib/icontrol/management/ldap_configuration.rb', line 459

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

- (Object) set_filter(opts)

Sets the filter strings used by this LDAP configurations.

Parameters:

  • opts (Hash)

Options Hash (opts):

  • :filters (String)

    The filter strings.

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.



472
473
474
475
# File 'lib/icontrol/management/ldap_configuration.rb', line 472

def set_filter(opts)
  check_params(opts,[:filters])
  super
end

- (Object) set_group_distinguished_name(opts)

Sets the group distinguished names used to enforce membership.

Parameters:

  • opts (Hash)

Options Hash (opts):

  • :group_dns (String)

    The group 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.



485
486
487
488
# File 'lib/icontrol/management/ldap_configuration.rb', line 485

def set_group_distinguished_name(opts)
  check_params(opts,[:group_dns])
  super
end

- (Object) set_group_member_attribute(opts)

Sets the group member attributes for this LDAP configurations.

Parameters:

  • opts (Hash)

Options Hash (opts):

  • :member_attrs (String)

    The group member attributes.

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.



498
499
500
501
# File 'lib/icontrol/management/ldap_configuration.rb', line 498

def set_group_member_attribute(opts)
  check_params(opts,[:member_attrs])
  super
end

- (Object) set_idle_time_limit(opts)

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.

Parameters:

  • opts (Hash)

Options Hash (opts):

  • :time_limits (long)

    The idle time limits in seconds.

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.



512
513
514
515
# File 'lib/icontrol/management/ldap_configuration.rb', line 512

def set_idle_time_limit(opts)
  check_params(opts,[:time_limits])
  super
end

- (Object) set_ignore_unavailable_authentication_information_state(opts)

Sets the states indicating whether to ignore errors when authentication information is unavailable.

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.



526
527
528
529
# File 'lib/icontrol/management/ldap_configuration.rb', line 526

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

- (Object) set_ldap_ssl_option(opts)

Sets the LDAP SSL options used by the 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.



539
540
541
542
# File 'lib/icontrol/management/ldap_configuration.rb', line 539

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

- (Object) set_ldap_version(opts)

Sets the LDAP versions to use by the LDAP configurations.

Parameters:

  • opts (Hash)

Options Hash (opts):

  • :versions (long)

    The LDAP versions to use by the 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.



552
553
554
555
# File 'lib/icontrol/management/ldap_configuration.rb', line 552

def set_ldap_version(opts)
  check_params(opts,[:versions])
  super
end

- (Object) set_login_attribute(opts)

Sets the login attributes used by this LDAP configurations.

Parameters:

  • opts (Hash)

Options Hash (opts):

  • :login_attributes (String)

    The login attributes.

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.



565
566
567
568
# File 'lib/icontrol/management/ldap_configuration.rb', line 565

def (opts)
  check_params(opts,[:login_attributes])
  super
end

- (Object) set_port(opts)

Sets the ports used by the LDAP servers to listen for requests.

Parameters:

  • opts (Hash)

Options Hash (opts):

  • :ports (long)

    The ports 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.



578
579
580
581
# File 'lib/icontrol/management/ldap_configuration.rb', line 578

def set_port(opts)
  check_params(opts,[:ports])
  super
end

- (Object) set_search_base_distinguished_name(opts)

Sets the distinguished names of the search bases used by the LDAP configurations.

Parameters:

  • opts (Hash)

Options Hash (opts):

  • :search_base_dns (String)

    The distinguished names of the search bases used by the 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.



591
592
593
594
# File 'lib/icontrol/management/ldap_configuration.rb', line 591

def set_search_base_distinguished_name(opts)
  check_params(opts,[:search_base_dns])
  super
end

- (Object) set_search_scope(opts)

Sets the search scopes used by the 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.



604
605
606
607
# File 'lib/icontrol/management/ldap_configuration.rb', line 604

def set_search_scope(opts)
  check_params(opts,[:search_scopes])
  super
end

- (Object) set_search_time_limit(opts)

Sets the search time limits in seconds. This is the time to wait for the search to complete.

Parameters:

  • opts (Hash)

Options Hash (opts):

  • :time_limits (long)

    The search time limits in seconds.

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.



618
619
620
621
# File 'lib/icontrol/management/ldap_configuration.rb', line 618

def set_search_time_limit(opts)
  check_params(opts,[:time_limits])
  super
end

- (Object) set_ssl_ca_certificate_file(opts)

Sets the CA certificates used in server certificate verification.

Parameters:

  • opts (Hash)

Options Hash (opts):

  • :ca_cert_files (String)

    The CA certificates used in server certificate verification.

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.



631
632
633
634
# File 'lib/icontrol/management/ldap_configuration.rb', line 631

def set_ssl_ca_certificate_file(opts)
  check_params(opts,[:ca_cert_files])
  super
end

- (Object) set_ssl_check_peer_state(opts)

Sets the states indicating whether to require and verify server certificate.

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.



644
645
646
647
# File 'lib/icontrol/management/ldap_configuration.rb', line 644

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

- (Object) set_ssl_cipher(opts)

Sets the SSL cipher suite used by the LDAP configurations.

Parameters:

  • opts (Hash)

Options Hash (opts):

  • :ciphers (String[])

    The SSL cipher suite used by the 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.



657
658
659
660
# File 'lib/icontrol/management/ldap_configuration.rb', line 657

def set_ssl_cipher(opts)
  check_params(opts,[:ciphers])
  super
end

- (Object) set_ssl_client_certificate(opts)

Sets the client certificates used by the LDAP configurations.

Parameters:

  • opts (Hash)

Options Hash (opts):

  • :certificates (String)

    The client certificates used by the 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.



670
671
672
673
# File 'lib/icontrol/management/ldap_configuration.rb', line 670

def set_ssl_client_certificate(opts)
  check_params(opts,[:certificates])
  super
end

- (Object) set_ssl_client_key(opts)

Sets the client keys used by the LDAP configurations.

Parameters:

  • opts (Hash)

Options Hash (opts):

  • :keys (String)

    The client keys used by the 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.



683
684
685
686
# File 'lib/icontrol/management/ldap_configuration.rb', line 683

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

- (Object) set_user_template(opts)

Sets the user templates used by this LDAP configurations.

Parameters:

  • opts (Hash)

Options Hash (opts):

  • :templates (String)

    The user templates.

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.



696
697
698
699
# File 'lib/icontrol/management/ldap_configuration.rb', line 696

def set_user_template(opts)
  check_params(opts,[:templates])
  super
end

- (Object) set_warning_state(opts)

Sets the states indicating whether to enabled/disable warning messages.

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.



709
710
711
712
# File 'lib/icontrol/management/ldap_configuration.rb', line 709

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

- (String) ssl_ca_certificate_file

Gets the CA certificates used in server certificate verification.

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.



305
306
307
# File 'lib/icontrol/management/ldap_configuration.rb', line 305

def ssl_ca_certificate_file
  super
end

- (EnabledState) ssl_check_peer_state

Gets the states indicating whether to require and verify server certificate.

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.



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

def ssl_check_peer_state
  super
end

- (String[]) ssl_cipher

Gets the SSL cipher suite used by the 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.



327
328
329
# File 'lib/icontrol/management/ldap_configuration.rb', line 327

def ssl_cipher
  super
end

- (String) ssl_client_certificate

Gets the client certificates used by the 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.



338
339
340
# File 'lib/icontrol/management/ldap_configuration.rb', line 338

def ssl_client_certificate
  super
end

- (String) ssl_client_key

Gets the client keys used by the 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.



349
350
351
# File 'lib/icontrol/management/ldap_configuration.rb', line 349

def ssl_client_key
  super
end

- (String) user_template

Gets the user templates used by this 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.



360
361
362
# File 'lib/icontrol/management/ldap_configuration.rb', line 360

def user_template
  super
end

- (String) version

Gets the version information for this interface.

Returns:

  • (String)


368
369
370
# File 'lib/icontrol/management/ldap_configuration.rb', line 368

def version
  super
end

- (EnabledState) warning_state

Gets the states indicating whether to enabled/disable warning messages.

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.



379
380
381
# File 'lib/icontrol/management/ldap_configuration.rb', line 379

def warning_state
  super
end