APIRef_tm_ltm_snat¶
mgmt/tm/ltm/snat
Secure network address translation (SNAT) configuration
REST Endpoints
- Collection URI
/mgmt/tm/ltm/snat- Collection Methods
OPTIONS, GET- Resource URI
/mgmt/tm/ltm/snat/~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. | |
autoLasthop |
string | default | optional | read/write | Specifies whether to automatically map last hop for pools or not. The default is to use next level’s default. |
automap |
boolean | none | optional | read/write | Specifies that the system translate the source IP address to an available self IP address when establishing connections through the virtual IP. |
description |
string | optional | read/write | User defined description. | |
mirror |
string | optional | read/write | Enables or disables mirroring of SNAT connections. | |
tmPartition |
string | Common | optional | read/write | Displays the administrative partition within which the snat resides. |
snatpool |
string | optional | read/write | Specifies the name of a SNAT pool. You can only use this option when automap and translation are not used. | |
sourcePort |
string | preserve | optional | read/write | Specifies whether the system preserves the source port of the connection. The default is preserve. Use of the preserve-strict setting should be restricted to UDP only under very special circumstances such as nPath or transparent (that is, no translation of any other L3/L4 field), where there is a 1:1 relationship between virtual IP addresses and node addresses, or when clustered multi-processing (CMP) is disabled. The change setting is useful for obfuscating internal network addresses. |
translation |
string | optional | read/write | Specifies the name of a translated IP address. Note that translated addresses are outside the traffic management system. You can only use this option when automap and snatpool are not used. | |
vlansDisabled |
boolean | optional | read/write | Disables the SNAT on all VLANs. | |
vlansEnabled |
boolean | optional | read/write | Enables the SNAT on all VLANs. |
Lists
| Name | Type | Default Value | Required | Access | Description |
|---|---|---|---|---|---|
vlans (net/tunnels/tunnel) |
array_structure | optional | read/write | Specifies the name of the VLAN to which you want to assign the SNAT. The default is vlans-enabled. |
Array Structures
| Name | Type | Default Value | Required | Access | Description |
|---|---|---|---|---|---|
/metadata |
array_structure | optional | read/write | User defined generic data for the SNAT. It is a name and value pair. | |
/metadata/app-service |
string | optional | read/write | ||
/metadata/persist |
string | true | optional | read/write | Specifies whether the command “tmsh save sys config” will save the metadata entry to the configuration files. |
/metadata/value |
string | optional | read/write | Value of the SNAT metadata | |
/origins |
array_structure | optional | read/write | ||
/origins/app-service |
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.