LocalLB::ProfileSMTPS

Introduced : BIG-IP_v11.5.0
The SMTPS Profile interface configures the handling of the SMTP STARTTLS protocol. The SMTPS 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 SMTP server does not.

Methods

Method Description Introduced
create Creates the specified SMTPS profiles. BIG-IP_v11.5.0
delete_all_profiles Deletes all SMTPS profiles. BIG-IP_v11.5.0
delete_profile Deletes the specified SMTPS profiles. BIG-IP_v11.5.0
get_activation_mode Gets the activation mode for the specified SMTPS profiles. BIG-IP_v11.5.0
get_all_statistics Gets the statistics for all the SMTPS profiles. BIG-IP_v11.5.0
get_default_profile Gets the default profile of the specified SMTPS profiles. BIG-IP_v11.5.0
get_description Gets the descriptions for the specified SMTPS profiles. BIG-IP_v11.5.0
get_list Gets the name of all SMTPS profiles. BIG-IP_v11.5.0
get_statistics Gets the statistics for the specified SMTPS profiles. BIG-IP_v11.5.0
get_statistics_by_virtual Gets the statistics for the specified SMTPS profiles, by virtual server. BIG-IP_v11.5.0
get_version Gets the version information for this interface. BIG-IP_v11.5.0
is_base_profile Determines whether the specified SMTPS 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-IP_v11.5.0
is_system_profile Determines whether the specified SMTPS 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-IP_v11.5.0
reset_statistics Resets the statistics for the specified SMTPS profiles. BIG-IP_v11.5.0
reset_statistics_by_virtual Resets the statistics for the specified SMTPS profiles, for specified virtual servers. BIG-IP_v11.5.0
set_activation_mode Sets the activation mode for the specified SMTPS profiles which determines the manner in which SMTPS connections are made. See ActivationMode for more details. BIG-IP_v11.5.0
set_default_profile Sets the default profiles for the given SMTPS profiles. BIG-IP_v11.5.0
set_description Sets the description for the specified SMTPS profiles. This is an arbitrary field which can be used for any purpose. BIG-IP_v11.5.0

Structures

Structure

Description

ProfileActivationMode

A structure that specifies an ActivationMode enum used in profile attributes.

ProfileSMTPSStatisticEntry

A struct that describes statistics for a particular SMTPS profile.

ProfileSMTPSStatistics

A struct that describes profile statistics and timestamp.


Enumerations

Enumeration Description
ActivationMode Determines the manner in which SMTPS connections are made.

Exceptions

Exception Description

Constants

Constant Type Value Description

Aliases

Alias Type Description
ProfileActivationModeSequence ProfileActivationMode [] A sequence of ProfileActivationModes.
ProfileSMTPSStatisticEntrySequence ProfileSMTPSStatisticEntry [] A sequence of ProfileSMTPS statistics.

See Also

iControl ::
iControl :: LocalLB :: ProfileSMTPS

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


Copyright © 1996-2012, F5 Networks, Inc. All rights reserved.

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.