net tunnels tunnel
net tunnels tunnel(1) BIG-IP TMSH Manual net tunnels tunnel(1)
NAME
tunnel - Configures a tunnel.
MODULE
net tunnels
SYNTAX
Configure the tunnel component within the net tunnels module using the
syntax in the following sections.
CREATE/MODIFY
create tunnel [name]
modify tunnel [name]
options:
app-service [[string] | none]
auto-lasthop [default | enabled | disabled ]
description [string]
local-address [ip address]
secondary-address [ip address]
mode [bidirectional | inbound | outbound]
mtu [integer]
use-pmtu [enabled | disabled ]
profile [name]
remote-address [ip address]
traffic-group [[traffic group] | none]
tos [integer]
transparent [enabled | disabled ]
idle-timeout [integer]
key [integer]
edit tunnel [ [ [name] | [glob] | [regex] ] ... ]
options:
all-properties
non-default-properties
DISPLAY
list tunnel
list tunnel [ [ [name] | [glob] | [regex] ] ... ]
show running-config tunnel
show running-config tunnel [ [ [name] | [glob] | [regex] ] ... ]
options:
all-properties
app-service
non-default-properties
one-line
partition
DELETE
delete tunnel [ all | [name] ]
DESCRIPTION
You can use the tunnel component to configure a tunnel.
EXAMPLES
create tunnel my_tunnel local-address 10.10.10.1 remote-address
11.11.11.1 profile gre
Creates a tunnel named my_tunnel between the local IP address
10.10.10.1 and the remote IP address 11.11.11.1.
list tunnel all-properties
Displays all of the properties of all of the tunnels.
OPTIONS
app-service
Specifies the name of the application service to which the object
belongs. The default value is none. Note: If the strict-updates
option is enabled on the application service that owns the object,
you cannot modify or delete the object. Only the application
service can modify or delete the object.
auto-lasthop
When enabled, specifies that the system returns packets to the MAC
address from which they were sent. The default setting is default,
which specifies that the system uses the default route to send
back the request.
description
User defined description.
glob Displays the items that match the glob expression. See help glob
for a description of glob expression syntax.
if-index
Displays the index assigned to this tunnel. It is a unique
identifier assigned for all objects displayed in the SNMP IF-MIB.
local-address
Specifies a local IP address. This option is required.
secondary-address
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.
mode Specifies how the tunnel carries traffic. The default value is
bidirectional.
mtu Specifies the maximum transmission unit (MTU) of the tunnel. The
default value is 0. When the MTU is set to the default value (of
0), the MTU of the tunnel is computed by the system and is set to
the MTU size of the underlying interface minus the encapsulation
overhead introduced by the tunneling protocol. The valid range is
0 - 65535.
use-pmtu
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.
name Specifies a unique name for the component. This option is required
for the commands create, and modify.
partition
Displays the administrative partition within which the component
resides.
profile
Specifies the profile that you want to associate with the tunnel.
This option is required for the create command.
regex
Displays the items that match the regular expression. The regular
expression must be preceded by an at sign (@[regular expression])
to indicate that the identifier is a regular expression. See help
regex for a description of regular expression syntax.
remote-address
Specifies a remote IP address. This value is required for the
commands create and modify.
traffic-group
Specifies a traffic-group for use with the tunnel. Traffic group
determines the ConfigSync behavior of the tunnel object.
tos 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. The possible
values are 0 (zero) - 255.
transparent
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.
idle-timeout
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.
key The key field may represent different values depending on the type
of the tunnel. For VXLAN it represents the Virtual Network
Identifier (VNI). The default value is 0.
SEE ALSO
create, delete, edit, glob, list, modify, net tunnels gre, net tunnels
ipip, net tunnels wccp, regex, show, tmsh
COPYRIGHT
No part of this program may be reproduced or transmitted in any form or
by any means, electronic or mechanical, including photocopying,
recording, or information storage and retrieval systems, for any
purpose other than the purchaser's personal use, without the express
written permission of F5 Networks, Inc.
F5 Networks and BIG-IP (c) Copyright 2008-2013, 2016. All rights
reserved.
BIG-IP 2016-03-14 net tunnels tunnel(1)