APIRef_tm_security_nat_source-translation¶
mgmt/tm/security/nat/source-translation
NAT Source Translation.
REST Endpoints
- Collection URI
/mgmt/tm/security/nat/source-translation- Collection Methods
OPTIONS, GET- Resource URI
/mgmt/tm/security/nat/source-translation/~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 that the object belongs to. | |
clientConnectionLimit |
integer | 0 | optional | read/write | Configures the number of connections allowed per client. Default value of 0 disables this option. This attribute is applicable only if type is ‘dynamic-pat’. |
description |
string | optional | read/write | User defined description. | |
egressInterfacesDisabled |
boolean | false | optional | read/write | Specifies that translated traffic may not exit on the interfaces specified in egress-interfaces list. |
egressInterfacesEnabled |
boolean | false | optional | read/write | Specifies that 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 translated IP addresses. This attribute is applicable only if type is ‘dynamic-pat’. |
icmpEcho |
string | disabled | optional | read/write | Enable or disable ICMP echo response on translation IP addresses. |
inboundMode |
string | none | optional | read/write | Specifies whether inbound connections are enabled or not. This attribute is applicable only if type is ‘dynamic-pat’. |
tmPartition |
string | Common | optional | read/write | |
patMode |
string | napt | optional | read/write | Configures the translation mode of operation if translation type is specified as ‘dynamic-pat’. Possible values are ‘napt’, ‘deterministic’ and ‘pba’. |
routeAdvertisement |
string | disabled | optional | read/write | Enable or disable route advertisements for translation IP addresses. |
type |
string | required | read/write | Specifies type of translation to be performed when using this object. Possible values are ‘static-nat’, ‘static-pat’, ‘dynamic-nat’ and ‘dynamic-pat’. |
Lists
| Name | Type | Default Value | Required | Access | Description |
|---|---|---|---|---|---|
egressInterfaces (net/tunnels/tunnel) |
array_structure | optional | read/write | List of interfaces over which translated traffic may or may not egress. |
Structures
| Name | Type | Default Value | Required | Access | Description |
|---|---|---|---|---|---|
/mapping |
array_structure | optional | read/write | ||
/mapping/mode |
string | address-pooling-paired | optional | read/write | Configures the mapping mode for successfully translated addresses. |
/mapping/timeout |
integer | 300 | optional | read/write | Configures the duration in seconds after which successfully translated addresses’ mappings are expired. |
/mapping/mode |
string | address-pooling-paired | optional | read/write | Configures the mapping mode for successfully translated addresses. |
/mapping/timeout |
integer | 300 | optional | read/write | Configures the duration in seconds after which successfully translated addresses’ mappings are expired. |
/pcp |
array_structure | optional | read/write | ||
/pcp/dslite |
string | optional | read/write | Specifies the DSLITE tunnel used by PCP for this Source Translation Object. Clients can send PCP requests through this tunnel. | |
/pcp/profile |
string | optional | read/write | Specifies the PCP profile used for this Source Translation Object. | |
/pcp/selfip |
string | optional | read/write | Specifies the PCP Server SelfIP name used for this Source Translation Object. Clients send PCP requests to this IP address. | |
/pcp/dslite |
string | optional | read/write | Specifies the DSLITE tunnel used by PCP for this Source Translation Object. Clients can send PCP requests through this tunnel. | |
/pcp/profile |
string | optional | read/write | Specifies the PCP profile used for this Source Translation Object. | |
/pcp/selfip |
string | optional | read/write | Specifies the PCP Server SelfIP name used for this Source Translation Object. Clients send PCP requests to this IP address. | |
/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. |
Array Structures
| Name | Type | Default Value | Required | Access | Description |
|---|---|---|---|---|---|
/addresses |
array_structure | optional | read/write | ||
/addresses/app-service |
string | optional | read/write | ||
/addresses/description |
string | optional | read/write | ||
/backup-addresses |
array_structure | optional | read/write | ||
/backup-addresses/app-service |
string | optional | read/write | ||
/backup-addresses/description |
string | optional | read/write | ||
/ports |
array_structure | optional | read/write | ||
/ports/app-service |
string | optional | read/write | ||
/ports/description |
string | optional | read/write |
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.