Tunnel configuration

REST Endpoints

Collection URI
Collection Methods
Resource URI
/mgmt/tm/net/tunnels/tunnel/~resource id
Resource Methods
Resource Natural Key
name, partition, subPath


Name Type Default Value Required Access Description
appService string   optional read/write The application service that the object belongs to.
autoLasthop string default optional read/write Specifies whether auto lasthop is enabled or not. The default is to use next levels default.
description string   optional read/write User defined description.
idleTimeout integer 300 optional read/write Specifies an idle timeout for wildcard tunnels in seconds. This setting specifies the number of seconds that a wildcard tunnel connection is idle before the connection is eligible for deletion. The default value is 300 seconds.
ifIndex integer 0 optional read/write Displays the index assigned to this tunnel. It is a unique identifier assigned for all objects displayed in the SNMP IF-MIB.
key integer 0 optional read/write The key field may represent different values depending on the type of the tunnel. E.g. it represents the Virtual Network Identifier(VNI) for VXLAN tunnels. The default value is 0.
localAddress string   optional read/write Specifies a local IP address. This option is required.
mode string bidirectional optional read/write Specifies how the tunnel carries traffic. The default value is bidirectional.
mtu integer 0 optional read/write Specifies the maximum transmission unit (MTU) of the tunnel. The default value is the MTU of the tunnel’s underlying interface minus the encapsulation overhead introduced by the tunneling protocol in use for the tunnel.
tmPartition string Common optional read/write Displays the admin-partition within which this component resides.
profile string   required read/write Specifies the profile that you want to associate with the tunnel. The default value is gre.
remoteAddress string   optional read/write Specifies a remote IP address. This option is required.
secondaryAddress string   optional read/write Specifies a secondary non-floating IP address when the local-address is set to a floating address. Currently this setting is supported by NVGRE tunnels only.
tos string 65535 optional read/write Specifies a value for insertion into the Type of Service (ToS) octet within the IP header of the encapsulating header of transmitted packets. The default value is preserve, which will cause the ToS octet from the encapsulated packet header to be copied into the ToS octet of the encapsulating packet header. The valid range is zero to 255
trafficGroup string   optional read/write Specifies a traffic-group for use with the tunnel. Traffic group determines the ConfigSync behavior of the tunnel object.
transparent string disabled optional read/write Enables or disables the tunnel to be transparent. If enabled, the user can inspect and/or manipulate the encapsulated traffic flowing through the BIG-IP. A transparent tunnel terminates a tunnel while presenting the illusion that the tunnel transits the device unperturbed i.e. the BIG-IP appears like an intermediate router that simply routes IP traffic through the device. The default value is disabled.
usePmtu string enabled optional read/write Enables or disables the tunnel to use the PMTU (Path MTU) information provided by ICMP NeedFrag error messages. If enabled and the tunnel MTU is set to 0, the tunnel will use the PMTU information. If enabled and the tunnel MTU is fixed to a non-zero value, the tunnel will use the minimum of PMTU and MTU. If disabled, the tunnel will use fixed MTU or calculate its MTU using tunnel encapsulation configurations.
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.