LocalLB::SNATPool

Introduced : BIG-IP_v9.0
The SNATPool interface enables you to work with the definitions contained in a local load balancer&aposs SNAT pool, which is a set of translation addresses. Either a virtual server, an iRule or a top-level SNAT object can reference a SNAT pool.

Methods

Method Description Introduced
add_member This method has been deprecated, due to now using names (vs IP addresses) to identify SNAT pool members. Please use add_member_v2. Adds members to the specified SNAT pools. BIG-IP_v9.0
add_member_v2 Adds members to the specified SNAT pools. BIG-IP_v11.0.0
create This method has been deprecated, due to now using names (vs IP addresses) to identify SNAT pool members. Please use create_v2. Creates the specified SNAT pools. BIG-IP_v9.0
create_v2 Creates the specified SNAT pools. BIG-IP_v11.0.0
delete_all_snat_pools Deletes all SNAT pools. BIG-IP_v9.0
delete_snat_pool Deletes a specified list of SNAT pools. BIG-IP_v9.0
get_all_member_statistics Gets the statistics for all SNATPool members in the specified SNAT pools. BIG-IP_v11.0.0
get_all_statistics Gets the statistics for all SNAT pools. BIG-IP_v9.0
get_description Gets the descriptions for a set of SNAT pools. BIG-IP_v11.0.0
get_list Gets a list of all SNAT pools. BIG-IP_v9.0
get_member This method has been deprecated, due to now using names (vs IP addresses) to identify SNAT pool members. Please use get_member_v2. Gets the list of members belonging to the specified SNAT pools. BIG-IP_v9.0
get_member_statistics Gets the statistics for a list of SNATPool members in the specified SNAT pools. BIG-IP_v11.0.0
get_member_traffic_acceleration_status Gets the traffic acceleration status of the specified SNAT pool members, which specifies whether the SNAT pool member is in use by traffic acceleration. BIG-IP_v13.0.0
get_member_v2 Gets the list of members belonging to the specified SNAT pools. BIG-IP_v11.0.0
get_statistics Gets the statistics for a list of SNAT pools. BIG-IP_v9.0
get_traffic_acceleration_status Gets the traffic acceleration status of the specified SNAT pools, which specifies whether the SNAT pool is in use by traffic acceleration. BIG-IP_v13.0.0
get_version Get the version information for this interface. BIG-IP_v9.0
remove_all_members Removes all members from the specified SNAT pools. BIG-IP_v9.0
remove_member This method has been deprecated, due to now using names (vs IP addresses) to identify SNAT pool members. Please use remove_member_v2. Removes members from the specified SNAT pools. BIG-IP_v9.0
remove_member_v2 Removes members from the specified SNAT pools. BIG-IP_v11.0.0
reset_member_statistics Resets the statistics for a list of SNATPool members in the specified SNAT pools. BIG-IP_v11.0.0
reset_statistics Resets the statistics for a list of SNAT pools. BIG-IP_v9.0
set_description Sets the description for a set of SNAT pools. This is an arbitrary field which can be used for any purpose. BIG-IP_v11.0.0

Structures

Structure

Description

SNATPoolMemberStatisticEntry

A struct that describes statistics for a particular SNATPool member.

SNATPoolMemberStatistics

A struct that describes SNATPool member statistics and timestamp.

SNATPoolStatisticEntry

A struct that describes statistics for a specified SNAT pool.

SNATPoolStatistics

A struct that describes SNAT pool statistics and timestamp.


Enumerations

Enumeration Description

Exceptions

Exception Description

Constants

Constant Type Value Description

Aliases

Alias Type Description
SNATPoolMemberStatisticEntrySequence SNATPoolMemberStatisticEntry [] A sequence of SNATPool member statistics.
SNATPoolMemberStatisticsSequence SNATPoolMemberStatistics [] An alias for a sequence of SNATPool member statistics.
SNATPoolStatisticEntrySequence SNATPoolStatisticEntry [] A sequence of SNAT pool statistics.

See Also

iControl ::
iControl :: LocalLB :: SNATPool

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.