LocalLB::ProfileClientLDAP

Introduced : BIG-IPv11.6.0
The ClientLDAP Profile interface configures the handling of the LDAP STARTTLS protocol. The ClientLDAP Profile facilitates allowing STARTTLS to be terminated at the system. STARTTLS allows the client to request that communications on this connection should be encrypted. This profile has the dual advantages of being able to terminate the connection on the system as well as to support this functionality even if the backend LDAP server does not.

Methods

Method Description Introduced
create Creates the specified ClientLDAP profiles. BIG-IPv11.6.0
delete_all_profiles Deletes all ClientLDAP profiles. BIG-IPv11.6.0
delete_profile Deletes the specified ClientLDAP profiles. BIG-IPv11.6.0
get_activation_mode Gets the client side activation mode for the specified ClientLDAP profiles. BIG-IPv11.6.0
get_all_statistics Gets the statistics for all the ClientLDAP profiles. BIG-IPv11.6.0
get_default_profile Gets the default profile of the specified ClientLDAP profiles. BIG-IPv11.6.0
get_description Gets the descriptions for the specified ClientLDAP profiles. BIG-IPv11.6.0
get_list Get the names of all ClientLDAP profiles. BIG-IPv11.6.0
get_statistics Gets the statistics for the specified ClientLDAP profiles. BIG-IPv11.6.0
get_statistics_by_virtual Gets the statistics for the specified ClientLDAP profiles, by virtual server. BIG-IPv11.6.0
get_version Gets the version information for this interface. BIG-IPv11.6.0
is_base_profile Determines whether the specified ClientLDAP profiles are base profiles. A base profile sits at the base of the profile&aposs inheritance tree, supplying the defaults for every profile derived from it. (See also is_system_profile). BIG-IPv11.6.0
is_system_profile Determines whether the specified ClientLDAP profiles are system profiles. A system profile is a profile pre-configured on the system, ready for use. Non-system profiles are profiles created or modified by a user. Note that if a system profile is modified, it is no longer considered a system profile. (See also is_base_profile). BIG-IPv11.6.0
reset_statistics Resets the statistics for the specified ClientLDAP profiles. BIG-IPv11.6.0
reset_statistics_by_virtual Resets the statistics for the specified ClientLDAP profiles, for the specified virtual servers. BIG-IPv11.6.0
set_activation_mode Sets the client side activation mode for the specified ClientLDAP profiles which determines the manner in which ClientLDAP connections are made. See Common::ActivationMode for more details. BIG-IPv11.6.0
set_default_profile Sets the default profiles for the given ClientLDAP profiles. BIG-IPv11.6.0
set_description Sets the description for the specified ClientLDAP profiles. This is an arbitrary field which can be used for any purpose. BIG-IPv11.6.0

Structures

Structure

Description

ProfileClientLDAPStatisticEntry

A struct that describes statistics for a particular ClientLDAP profile.

ProfileClientLDAPStatistics

A struct that describes profile statistics and timestamp.


Enumerations

Enumeration Description

Exceptions

Exception Description

Constants

Constant Type Value Description

Aliases

Alias Type Description
ProfileClientLDAPStatisticEntrySequence ProfileClientLDAPStatisticEntry [] A sequence of ProfileClientLDAP statistics.

See Also

Warning

The links to the sample code below are remnants of the old DevCentral wiki and will result in a 404 error. For best results, please copy the link text and search the codeshare directly on DevCentral.

Sample Code


The BIG-IP API Reference documentation contains community-contributed content. F5 does not monitor or control community code contributions. We make no guarantees or warranties regarding the available code, and it may contain errors, defects, bugs, inaccuracies, or security vulnerabilities. Your access to and use of any code available in the BIG-IP API reference guides is solely at your own risk.