APIRef_tm_ltm_lsn-pool¶
mgmt/tm/ltm/lsn-pool
LSNAT/CGNAT translation address configuration
REST Endpoints
- Collection URI
/mgmt/tm/ltm/lsn-pool- Collection Methods
OPTIONS, GET- Resource URI
/mgmt/tm/ltm/lsn-pool/~resource id- Resource Methods
OPTIONS, GET, PUT, PATCH, DELETE, POST- Resource Natural Key
name, partition, subPath
Properties
| Name | Type | Default Value | Required | Access | Description |
|---|---|---|---|---|---|
appService |
string | optional | read/write | The application service to which the object belongs. | |
clientConnectionLimit |
integer | 0 | optional | read/write | Configures the number of connections allowed per client. Default value of 0 disables this option. |
description |
string | optional | read/write | User defined description. | |
egressInterfacesDisabled |
boolean | false | optional | read/write | Specifies that LSN translated traffic may not exit on the interfaces specified in egress-interfaces list. |
egressInterfacesEnabled |
boolean | false | optional | read/write | Specifies that LSN translated traffic may exit only on the interfaces specified in egress-interfaces list. |
hairpinMode |
string | disabled | optional | read/write | Specifies whether hairpinning for incoming connections is enabled or disabled on LSN translated IP addresses. |
icmpEcho |
string | disabled | optional | read/write | Enable or disable ICMP echo response on translation IP addresses. |
inboundConnections |
string | disabled | optional | read/write | Specifies whether inbound connections are enabled, and if they are created automatically or explicitly. |
logProfile |
string | optional | read/write | Configures the lsn log profile that controls logging. | |
logPublisher |
string | optional | read/write | Configures the log publisher that handles LSN translation events logging for this LSN pool. | |
mode |
string | napt | optional | read/write | Configures the translation mode of operation for this LSN pool. |
tmPartition |
string | Common | optional | read/write | |
routeAdvertisement |
string | disabled | optional | read/write | Enable or disable route advertisements for LSN translation IP addresses. |
translationPortRange |
string | optional | read/write | Configures the port range used for translated addresses. |
Lists
| Name | Type | Default Value | Required | Access | Description |
|---|---|---|---|---|---|
undefined |
array_structure | optional | read/write | Configures the list of networks that may be used to get translation addresses if LSN configured in DNAT mode fails deterministic translation and falls back to NAPT mode. | |
egressInterfaces (net/tunnels/tunnel) |
array_structure | optional | read/write | List of interfaces over which LSN translated traffic may or may not egress. | |
egressInterfaces (net/tunnels/tunnel) |
array_structure | optional | read/write | Configures the list of networks that may be used as translated IP addresses. |
Structures
| Name | Type | Default Value | Required | Access | Description |
|---|---|---|---|---|---|
/pcp |
array_structure | optional | read/write | ||
/pcp/dslite |
string | optional | read/write | Specifies the DSLITE tunnel used by PCP for this LSN pool. Clients can send PCP requests through this tunnel. | |
/pcp/profile |
string | optional | read/write | Specifies the PCP profile used for this LSN pool. | |
/pcp/selfip |
string | optional | read/write | Specifies the PCP Server SelfIP name used for this LSN pool. Clients send PCP requests to this IP address. | |
/pcp/dslite |
string | optional | read/write | Specifies the DSLITE tunnel used by PCP for this LSN pool. Clients can send PCP requests through this tunnel. | |
/pcp/profile |
string | optional | read/write | Specifies the PCP profile used for this LSN pool. | |
/pcp/selfip |
string | optional | read/write | Specifies the PCP Server SelfIP name used for this LSN pool. Clients send PCP requests to this IP address. | |
/persistence |
array_structure | optional | read/write | ||
/persistence/mode |
string | none | optional | read/write | Configures the persistence mode for successfully translated addresses. |
/persistence/timeout |
integer | 300 | optional | read/write | Configures the duration in seconds for which successfully transmitted LSN addresses are persisted. |
/persistence/mode |
string | none | optional | read/write | Configures the persistence mode for successfully translated addresses. |
/persistence/timeout |
integer | 300 | optional | read/write | Configures the duration in seconds for which successfully transmitted LSN addresses are persisted. |
/port-block-allocation |
array_structure | optional | read/write | ||
/port-block-allocation/block-idle-timeout |
integer | 3600 | optional | read/write | Configures the time after the last connection using the block is freed that the block assignment expires. The default value is 3600 seconds. |
/port-block-allocation/block-lifetime |
integer | 0 | optional | read/write | Configures 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. |
/port-block-allocation/block-size |
integer | 64 | optional | read/write | Configures the number of ports in a block. The default value is 64. |
/port-block-allocation/client-block-limit |
integer | 1 | optional | read/write | Configures the number of blocks that can be assigned to a single subscriber IP address. The default value is 1. |
/port-block-allocation/zombie-timeout |
integer | 0 | optional | read/write | Configures the timeout after which connections using the zombie block are killed. After connections are killed zombie block is freed after port-block-allocation.block-idle-timeout. This parameter is unused unless the port-block-allocation.block-lifetime is set. The default value is 0 which corresponds to infinite timeout. |
/port-block-allocation/block-idle-timeout |
integer | 3600 | optional | read/write | Configures the time after the last connection using the block is freed that the block assignment expires. The default value is 3600 seconds. |
/port-block-allocation/block-lifetime |
integer | 0 | optional | read/write | Configures 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. |
/port-block-allocation/block-size |
integer | 64 | optional | read/write | Configures the number of ports in a block. The default value is 64. |
/port-block-allocation/client-block-limit |
integer | 1 | optional | read/write | Configures the number of blocks that can be assigned to a single subscriber IP address. The default value is 1. |
/port-block-allocation/zombie-timeout |
integer | 0 | optional | read/write | Configures the timeout after which connections using the zombie block are killed. After connections are killed zombie block is freed after port-block-allocation.block-idle-timeout. This parameter is unused unless the port-block-allocation.block-lifetime is set. The default value is 0 which corresponds to infinite timeout. |
Copyright (c) 2016, 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.
