LocalLB::LSNPool¶
Introduced : BIG-IP_v11.3.0
The LSN pool interface enables you to work with the definitions
contained in a local load balancer&aposs LSN pool. LSN stands for
Large Scale Network Address Translation (and is also known as Carrier
Grade Network Address Translation, CGNAT). An LSN pool is a set of
networks and port numbers that can be translated to one or more
subscriber or client IP addresses. NOTE: Translation addresses in an
LSN pool are not self-IP addresses. When a subscriber or client device
seeks to connect to a server via the service provider, the
client&aposs IP address is translated based on the specifications of
the LSN pool that the client classifies into. Translation can be
performed in: - Deterministic mode (Deterministic Network Address
Translation or DNAT) - Network Address Port Translation mode (or NAPT
mode). - Port Block Allocation mode (or PBA mode). Either a virtual
server or an iRule can reference an LSN pool.
Methods¶
| Method | Description | Introduced |
| add_backup_member | Adds backup members to the specified LSN pools. | BIG-IP_v11.3.0 |
| add_member | Adds members to the specified LSN pools. | BIG-IP_v11.3.0 |
| create | Creates the specified LSN pools. | BIG-IP_v11.3.0 |
| delete_all_lsn_pools | Deletes all LSN pools. | BIG-IP_v11.3.0 |
| delete_lsn_pool | Deletes a specified list of LSN pools. | BIG-IP_v11.3.0 |
| get_all_statistics | Gets the statistics for all pools. Note: This function has been deprecated. Please use get_all_statistics_v2. | BIG-IP_v11.4.0 |
| get_all_statistics_v2 | Gets the statistics for all pools. | BIG-IP_v12.1.0 |
| get_backup_member | Gets the list of backup members belonging to the specified LSN pools. | BIG-IP_v11.3.0 |
| get_block_idle_timeout | Gets the port block idle timeout for the specified LSN pools. | BIG-IP_v11.6.0 |
| get_block_lifetime | Gets the port block lifetime for the specified LSN pools. | BIG-IP_v11.6.0 |
| get_block_size | Gets the port block sizes for the specified LSN pools. | BIG-IP_v11.6.0 |
| get_client_block_limit | Gets the client block limits for the specified LSN pools. | BIG-IP_v11.6.0 |
| get_connection_limit | Gets the connection limits of the specified LSN pools. | BIG-IP_v11.3.0 |
| get_description | Gets the descriptions for a set of LSN pools. | BIG-IP_v11.3.0 |
| get_egress_interface | Gets the list of egress interfaces on which LSN is disabled/enabled. | BIG-IP_v11.3.0 |
| get_egress_interface_state | Gets the egress interface states of the specified LSN pools. | BIG-IP_v11.3.0 |
| get_hairpin_mode | Gets the hairpinning modes of the specified LSN pools. | BIG-IP_v11.4.0 |
| get_icmp_echo_state | Gets the icmp echo states of the specified LSN pools. | BIG-IP_v11.3.0 |
| get_inbound_connection_state | This method is deprecated and new applications should use the get_inbound_mode method instead. Gets the inbound connection states of the specified LSN pools. | BIG-IP_v11.3.0 |
| get_inbound_mode | Gets the inbound modes of the specified LSN pools. | BIG-IP_v11.5.0 |
| get_list | Gets a list of all LSN pools. | BIG-IP_v11.3.0 |
| get_log_profile | Gets the LSN log profiles for a set of LSN pools. | BIG-IP_v11.6.0 |
| get_log_publisher | Gets the log publishers for a set of LSN pools. | BIG-IP_v11.3.0 |
| get_member | Gets the list of members belonging to the specified LSN pools. | BIG-IP_v11.3.0 |
| get_nat_mode | Gets the NAT modes for the specified LSN pools. | BIG-IP_v11.3.0 |
| get_pcp_dslite_tunnel | Gets the PCP DS-Lite Tunnel for a set of LSN pools. | BIG-IP_v11.5.0 |
| get_pcp_profile | Gets the PCP profile names for a set of LSN pools. | BIG-IP_v11.5.0 |
| get_pcp_selfip | Gets the PCP self IP for a set of LSN pools. | BIG-IP_v11.5.0 |
| get_persistence_mode | Gets the persistence modes for the specified LSN pools. | BIG-IP_v11.3.0 |
| get_persistence_timeout | Gets the persistence timeouts of the specified LSN pools. | BIG-IP_v11.3.0 |
| get_route_advertisement_state | Gets the route advertisement states for the specified LSN pools. | BIG-IP_v11.3.0 |
| get_statistics | Gets the statistics for a list of pools. Note: This function has been deprecated. Please use get_statistics_v2. | BIG-IP_v11.4.0 |
| get_statistics_v2 | Gets the statistics for a list of pools. | BIG-IP_v12.1.0 |
| get_translation_port_range | Gets the translation port ranges of the specified LSN pools. | BIG-IP_v11.3.0 |
| get_version | Get the version information for this interface. | BIG-IP_v11.3.0 |
| get_zombie_timeout | Gets the port block zombie timeout for the specified LSN pools. | BIG-IP_v11.6.0 |
| remove_all_backup_members | Removes all backup members from the specified LSN pools. | BIG-IP_v11.3.0 |
| remove_all_members | Removes all members from the specified LSN pools. | BIG-IP_v11.3.0 |
| remove_backup_member | Removes backup members from the specified LSN pools. | BIG-IP_v11.3.0 |
| remove_member | Removes members from the specified LSN pools. | BIG-IP_v11.3.0 |
| reset_statistics | Resets the statistics for a list of pools. | BIG-IP_v11.4.0 |
| set_block_idle_timeout | Sets the port block idle timeout for the specified LSN pools. The port block idle timeout defines the time after the last connection using the block is freed that the block assignment expires. | BIG-IP_v11.6.0 |
| set_block_lifetime | Sets the port block lifetime for the specified LSN pools. Port block lifetime specifies the timeout after which the block is no longer used for new port allocations. The block becomes a zombie block. The default is 0 which corresponds to an infinite timeout. | BIG-IP_v11.6.0 |
| set_block_size | Sets the port block size for the specified LSN pools. Port block size defines the number of ports in a block. | BIG-IP_v11.6.0 |
| set_client_block_limit | Sets the client block limit for the specified LSN pools. Client block limit defines the number of blocks that can be assigned to a single subscriber IP address. | BIG-IP_v11.6.0 |
| set_connection_limit | Sets the connection limits of the specified LSN pools. This configures the number of connections allowed per client. A default value of 0 disables this option. | BIG-IP_v11.3.0 |
| set_description | Sets the description for a set of LSN pools. This is an arbitrary field which can be used for any purpose. | BIG-IP_v11.3.0 |
| set_egress_interface | Sets the list of egress interfaces on which LSN is disabled/enabled. This specifies a list of VLANS and for each one, whether or not LSN translated traffic may egress on them. | BIG-IP_v11.3.0 |
| set_egress_interface_state | Sets the egress interface state for a list of LSN pools. This state specifies whether or not LSN translated traffic may exit on the interfaces specified in egress-interfaces list. | BIG-IP_v11.3.0 |
| set_hairpin_mode | Sets the hairpinning modes for a list of LSN pools. A hairpin connection between two subscribers goes through the NAT device and uses translation addresses so that it appears to each subscriber that the other is an external host. | BIG-IP_v11.4.0 |
| set_icmp_echo_state | Sets the icmp echo state for a list of LSN pools. This state specifies whether ICMP echo is enabled or disabled on LSN translated IP addresses. | BIG-IP_v11.3.0 |
| set_inbound_connection_state | This method is deprecated and new applications should use the set_inbound_mode method instead. Sets the inbound connection states for a list of LSN pools. This state specifies whether incoming connections are allowed or disallowed on LSN translated IP addresses. | BIG-IP_v11.3.0 |
| set_inbound_mode | Sets the inbound connection mode for a list of LSN pools. The inbound connection mode specifies whether inbound connections are allowed, and whether the inbound mappings are created automatically or explicitly. | BIG-IP_v11.5.0 |
| set_log_profile | Sets the LSN log profiles for a set of LSN pools. The LSN log profile controls the logging of LSN translation events. See LocalLB::LSNLogProfile for more details. | BIG-IP_v11.6.0 |
| set_log_publisher | Sets the log publishers for a set of LSN pools. | BIG-IP_v11.3.0 |
| set_nat_mode | Sets the NAT mode for the specified LSN pools. This determines how translation address mapping is performed and can be configured in either in Deterministic mode (Deterministic Network Address Translation or DNAT) or in Network Address Port Translation mode (or NAPT mode). | BIG-IP_v11.3.0 |
| set_pcp_dslite_tunnel | Sets the DS-Lite Tunnel for a set of LSN pools. This will allow to specify an already pre-configured DS-Lite Tunnel name as the one used by the PCP Server for those LSN pools. | BIG-IP_v11.5.0 |
| set_pcp_full_config | This is a convenience method that will allow you to set all PCP configuration parameters in one transaction. A PCP profile cannot be specified for a LSN Pool without either a self IP or a DS-Lite Tunnel for the PCP Server. If only one of them is present the other must be passed in as empty quotes (“”). | BIG-IP_v11.5.0 |
| set_pcp_profile | Sets the PCP profile name for a set of LSN pools. This will allow you to specify an already pre-defined set of PCP parameters that will determine how to process incoming PCP packets. | BIG-IP_v11.5.0 |
| set_pcp_selfip | Sets the PCP server self IP for a set of LSN pools. This will allow you to specify an already pre-configured self IP name as the listening IP for the PCP Server for those LSN pools. | BIG-IP_v11.5.0 |
| set_persistence_mode | Sets the persistence mode for the specified LSN pools. This configures whether or not previously translated addresses are persisted upon and if so, which of two modes the persistence is based on: address or address-port | BIG-IP_v11.3.0 |
| set_persistence_timeout | Sets the persistence timeouts of the specified LSN pools. This configures the duration in seconds for which successfully transmitted LSN addresses are persisted. | BIG-IP_v11.3.0 |
| set_route_advertisement_state | Sets the route advertisement states for the specified LSN pools. | BIG-IP_v11.3.0 |
| set_translation_port_range | Sets the translation port ranges of the specified LSN pools (the port range used for translated addresses). | BIG-IP_v11.3.0 |
| set_zombie_timeout | Sets the port block zombie timeout for the specified LSN pools. The port block zombie timeout specifies the time after which connections using the zombie block are killed. After connections are killed the zombie block is freed after the block idle timeout. This parameter is unused unless the port block lifetime is set. The default value is 0 which corresponds to an infinite timeout. | BIG-IP_v11.6.0 |
Structures¶
Structure
Description
A struct that describes statistics for a specified LSN pool.
A struct that describes statistics for a specified LSN pool, this version includes failure cause statistics.
A struct that describes LSN pool statistics and timestamp.
A struct that describes LSN pool statistics and timestamp, this version include failure cause statistics.
Enumerations¶
| Enumeration | Description |
| HairpinMode | A list of LSN Pool Hairpin modes. |
| InboundMode | A list of LSN Pool Inbound modes. |
| NATMode | A list of LSN Pool NAT modes. |
| PersistMode | A list of LSN Pool Persistence modes. |
Aliases¶
| Alias | Type | Description |
| HairpinModeSequence | HairpinMode [] | A sequence of LSN pool hairpin modes. |
| HairpinModeSequenceSequence | HairpinMode [] [] | A sequence of sequence of LSN pool hairpin modes. |
| InboundModeSequence | InboundMode [] | A sequence of LSN pool inbound modes. |
| InboundModeSequenceSequence | InboundMode [] [] | A sequence of sequence of LSN pool inbound modes. |
| LSNPoolFailureStatisticSequence | LSNPoolFailureStatistic [] | A sequence of LSN Pool failure statistics. |
| LSNPoolStatisticEntrySequence | LSNPoolStatisticEntry [] | A sequence of pool statistics. |
| LSNPoolStatisticEntry_v2Sequence | LSNPoolStatisticEntry_v2 [] | A sequence of pool statistics. |
| NATModeSequence | NATMode [] | A sequence of LSN pool NAT modes. |
| NATModeSequenceSequence | NATMode [] [] | A sequence of sequence of LSN pool NAT modes. |
| PersistModeSequence | PersistMode [] | A sequence of LSN pool persistence modes. |
| PersistModeSequenceSequence | PersistMode [] [] | A sequence of sequence of LSN pool persistence modes. |
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.