Networking::Tunnel

Introduced : BIG-IP_v10.1.0
The Tunnel interface manages a virtual network interface that allows a network protocol to carry packets of another protocol between two endpoints. Once created, it can be used just like a VLAN in BIG-IP configurations.

Methods

Method Description Introduced
add_static_forwarding This method has been deprecated. Please use add_static_forwarding_v2 instead. Adds the static L2 tunnel FDB entries for the specified tunnels. BIG-IP_v11.6.0
add_static_forwarding_v2 Adds the static L2 tunnel FDB entries for the specified tunnels. BIG-IP_v12.0.0
create Creates the specified tunnels. BIG-IP_v10.1.0
create_with_key Creates a set of tunnels with key values specified. It is for convenience to allow you to avoid using a transaction, because the existing tunnel create API does not allow key values to be specified during tunnel creation. (Either a transaction or this method are good ways of satisfying this validation). BIG-IP_v11.4.0
create_with_transparent_state Creates the specified tunnels with transparent states. It is for convenience to allow you to avoid using a transaction, because you can specify a 0.0.0.0 local address only if transparent is enabled. (Either a transaction or this method are good ways of satisfying this validation). BIG-IP_v11.3.0
delete_all_tunnels Deletes all tunnels. BIG-IP_v10.1.0
delete_tunnel Deletes the specified tunnels. BIG-IP_v10.1.0
get_auto_lasthop Gets the attribute that specifies auto-lasthop behavior, for the specified tunnels. BIG-IP_v11.4.0
get_description Gets the descriptions for the specified tunnels. BIG-IP_v11.0.0
get_direction Gets the direction for traffic flow within the specified tunnels. BIG-IP_v10.1.0
get_idle_timeout Gets the idle timeout values for the specified tunnels. BIG-IP_v11.3.0
get_if_index Gets the IF indices for the specified tunnels. This is a unique identifier assigned to all objects displayed in the SNMP IF-MIB. BIG-IP_v12.0.0
get_key Gets the keys for a set of tunnels. BIG-IP_v11.4.0
get_list Gets the names of all tunnels. BIG-IP_v10.1.0
get_local_address Gets the IP address for the local end for the specified tunnels. BIG-IP_v10.1.0
get_mac_address Gets the MAC addresses used by the specified tunnels. The MAC address for tunnels cannot be set by the user. BIG-IP_v11.4.0
get_mtu Gets the maximum transmission unit (MTU) for the specified tunnels. BIG-IP_v10.1.0
get_profile This method has been deprecated. Please use get_profile_v2 instead. Gets the profile specifying the tunneling protocol for the specified tunnels. BIG-IP_v10.1.0
get_profile_v2 Gets the lists of profiles and types the specified tunnels are associated with. BIG-IP_v11.6.0
get_remote_address Gets the IP address for the remote end for the specified tunnels. BIG-IP_v10.1.0
get_secondary_address Gets the secondary addresses of the tunnels. BIG-IP_v12.0.0
get_static_forwarding This method has been deprecated. Please use get_static_forwarding_v2 instead. Gets the static L2 tunnel FDB entries (see struct L2TunnelFDBEntry for more details) for the specified tunnels. BIG-IP_v11.6.0
get_static_forwarding_v2 Gets the static L2 tunnel FDB entries (see struct L2TunnelFDBEntryV2 for more details) for the specified tunnels. BIG-IP_v12.0.0
get_tos Gets the Type of Service (ToS) value for the encapsulating packet&aposs IP header. BIG-IP_v10.1.0
get_traffic_group Gets the traffic groups of the tunnels. BIG-IP_v12.0.0
get_transparent_state Gets the transparent property for the specified tunnels. BIG-IP_v11.3.0
get_version Gets the version information for this interface. BIG-IP_v10.1.0
remove_all_static_forwardings Removes all static L2 tunnel FDB entries from the specified tunnels. BIG-IP_v11.6.0
remove_static_forwarding This method has been deprecated. Please use remove_static_forwarding_v2 instead. Removes the static L2 tunnel FDB entries from the specified tunnels. BIG-IP_v11.6.0
remove_static_forwarding_v2 Removes the static L2 tunnel FDB entries from the specified tunnels. BIG-IP_v12.0.0
set_auto_lasthop Sets the attribute that specifies auto-lasthop behavior, for the specified tunnels. This controls how the system routes return traffic. The default is AUTO_LASTHOP_DEFAULT. BIG-IP_v11.4.0
set_description Sets the description for the specified tunnels. This is an arbitrary field which can be used for any purpose. BIG-IP_v11.0.0
set_direction Sets the direction for traffic flow within the specified tunnels. BIG-IP_v10.1.0
set_idle_timeout Sets the idle timeout for the specified tunnels. Specifies an idle timeout for wildcard tunnels (i.e. tunnels with remote address 0.0.0.0) in seconds. This setting specifies the number of seconds that a wildcard tunnel connection is idle before the connection is eligible for deletion. If zero, the tunnel&aposs idle timeout is automatically set to the default of 300. BIG-IP_v11.3.0
set_key Sets the keys for a set of tunnels. A key can be used to signify different values depending on the type of tunnel. As an example, it is used as the Virtual Network Identifier (VNI) for VXLAN tunnels. The default value is 0. BIG-IP_v11.4.0
set_local_address Sets the IP address for the local end of the tunnel for the specified tunnels. BIG-IP_v10.1.0
set_local_address_with_transparent_state Sets the IP address for the local end of the tunnel along with the transparent state of the tunnel for the specified tunnels. It is for convenience to allow you to avoid using a transaction, because you can specify a 0.0.0.0 local address only if transparent is enabled. (Either a transaction or this method are good ways of satisfying this validation). BIG-IP_v11.3.0
set_mtu Sets the maximum transmission unit (MTU) for the specified tunnels. If zero, the tunnel&aposs MTU is automatically set to the MTU of the tunnel&aposs underlying interface minus the encapsulation overhead introduced by the tunneling protocol in use for the tunnel. BIG-IP_v10.1.0
set_profile Sets the profile specifying the tunneling protocol for the specified tunnels (e.g. IPIP, GRE, WCCP-GRE tunnel profiles). BIG-IP_v10.1.0
set_remote_address Sets the IP address for the remote end for the specified tunnels. BIG-IP_v10.1.0
set_secondary_address Sets the secondary addresses of the tunnels. A secondary address is 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. BIG-IP_v12.0.0
set_tos Sets the Type of Service (ToS) value for the encapsulating packet&aposs IP header. The valid range is zero to 255. The special value 65535 specifies that the encapsulating packet&aposs IP header ToS value is set to the encapsulated packet&aposs IP header ToS value. BIG-IP_v10.1.0
set_traffic_group Sets the traffic groups of the tunnels. The traffic group determines the ConfigSync behavior of the tunnel object. BIG-IP_v12.0.0
set_transparent_state Sets the transparent property for the specified tunnels. 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. BIG-IP_v11.3.0

Structures

Structure

Description

L2TunnelFDBEntry

A struct that describes a static L2 tunnel forwarding database (FDB) entry.

L2TunnelFDBEntryV2

A struct that describes a static L2 tunnel forwarding database (FDB) entry.

TunnelProfileAttribute

A struct that describes the profile type and name.


Enumerations

Enumeration Description
TunnelDirection Direction of traffic flow through the tunnel

Exceptions

Exception Description

Constants

Constant Type Value Description

Aliases

Alias Type Description
L2TunnelFDBEntrySequence L2TunnelFDBEntry [] A sequence of static L2 tunnel FDB entries.
L2TunnelFDBEntrySequenceSequence L2TunnelFDBEntry [] [] A sequence of sequence of static L2 tunnel FDB entries.
L2TunnelFDBEntryV2Sequence L2TunnelFDBEntryV2 [] A sequence of static L2 tunnel FDB entries.
L2TunnelFDBEntryV2SequenceSequence L2TunnelFDBEntryV2 [] [] A sequence of sequence of static L2 tunnel FDB entries.
TunnelDirectionSequence TunnelDirection [] Sequence of tunnel directions
TunnelProfileAttributeSequence TunnelProfileAttribute [] A sequence of profile types and names.

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.