Developer Documentation
ADC CLI Commands
Current Release 13.1 13.0 12.1

ipTunnel

August 18, 2023
Contributed by: 
C

The following operations can be performed on “ipTunnel”:

rm unset show add set

rm ipTunnel

Removes an IP tunnel configuration from the Citrix ADC.

Synopsis

rm ipTunnel

Arguments

name Name of the IP Tunnel.

Example

rm iptunnel tunnel1

unset ipTunnel

Use this command to remove ipTunnel settings.Refer to the set ipTunnel command for meanings of the arguments.

Synopsis

unset ipTunnel [-vlanTagging] [-destPort] [-tosInherit]

show ipTunnel

Display the configured IP tunnels.

Synopsis

show ipTunnel [( ) | ]

Arguments

remote Public IPv4 address, of the remote device, used to set up the tunnel. For this parameter, you can alternatively specify a network address.

remoteSubnetMask Subnet mask of the remote IP address of the tunnel.

name Name for the IP tunnel. Leading character must be a number or letter. Other characters allowed, after the first character, are @ _ - . (period) : (colon) # and space ( ).

Output

name The name of the ip tunnel.

local Type of Citrix ADC owned public IPv4 address, configured on the local Citrix ADC and used to set up the tunnel.

protocol Name of the protocol to be used on this tunnel.

grepayload The payload GRE will carry

type The type of this tunnel.

encapIp The effective local IP address of the tunnel. Used as the source of the encapsulated packets.

channel The tunnel that is bound to a netbridge.

ipsecProfileName Name of IPSec profile to be associated.

vlan The vlan for mulicast packets

tunnelType Indicates that a tunnel is User-Configured, Internal or DELETE-IN-PROGRESS.

ipsecTunnelStatus Whether the ipsec on this tunnel is up or down.

ownerGroup The owner node group in a Cluster for the iptunnel.

refcnt Number of PBRs to bound to this iptunnel

vnid Virtual network identifier (VNID) is the value that identifies a specific virtual network in the data plane.

vlanTagging Option to select Vlan Tagging.

destPort Specifies UDP destination port for Geneve packets. Default port is 6081.

tosInherit Default behavior is to copy the ToS field of the internal IP Packet (Payload) to the outer IP packet (Transport packet). But the user can configure a new ToS field using this option.

devno count stateflag

Example

1) Name………: t1 Remote…….: 10.102.33.0 Mask……: 255.255.255.0 Local……..: * Encap…..: 0.0.0.0 Protocol…..: IPIP Type……: C

2) Name………: tunnel1 Remote…….: 10.100.20.0 Mask……: 255.255.255.0 Local……..: * Encap…..: 0.0.0.0 Protocol…..: IPIP Type……: C

3) Name………: Remote…….: 10.102.33.190 Mask……: 255.255.255.255 Local……..: * Encap…..: 10.102.33.85 Protocol…..: IPIP Type……: I

add ipTunnel

Creates an IPv4 tunnel. An IP tunnel is a communication channel, using encapsulation technologies, between two networks that do not have a routing path. Every IP packet that is shared between the two networks is encapsulated within another packet and then sent through the tunnel.

Synopsis

add ipTunnel \[-protocol ] \[-vnid <positive\_integer>] \[-vlanTagging \( ENABLED | DISABLED )] \[-destPort ] \[-tosInherit \( ENABLED | DISABLED )] \[-grepayload ] \[-ipsecProfileName ] \[-vlan <positive\_integer>] \[-ownerGroup ]

Arguments

name Name for the IP tunnel. Leading character must be a number or letter. Other characters allowed, after the first character, are @ _ - . (period) : (colon) # and space ( ).

remote Public IPv4 address, of the remote device, used to set up the tunnel. For this parameter, you can alternatively specify a network address.

remoteSubnetMask Subnet mask of the remote IP address of the tunnel.

local Type of Citrix ADC owned public IPv4 address, configured on the local Citrix ADC and used to set up the tunnel.

protocol Name of the protocol to be used on this tunnel.

Possible values: IPIP, GRE, IPSEC, UDP, GENEVE Default value: IPIP

vnid Virtual network identifier (VNID) is the value that identifies a specific virtual network in the data plane. Minimum value: 1 Maximum value: 16777215

vlanTagging Option to select Vlan Tagging.

Possible values: ENABLED, DISABLED Default value: DISABLED

destPort Specifies UDP destination port for Geneve packets. Default port is 6081. Default value: 6081 Minimum value: 1024 Maximum value: 65535

tosInherit Default behavior is to copy the ToS field of the internal IP Packet (Payload) to the outer IP packet (Transport packet). But the user can configure a new ToS field using this option.

Possible values: ENABLED, DISABLED Default value: ENABLED

grepayload The payload GRE will carry

Possible values: ETHERNETwithDOT1Q, ETHERNET, IP Default value: ETHERNETwithDOT1Q

ipsecProfileName Name of IPSec profile to be associated. Default value: “ns_ipsec_default_profile”

vlan The vlan for mulicast packets Minimum value: 1 Maximum value: 4094

ownerGroup The owner node group in a Cluster for the iptunnel. Default value: DEFAULT_NG

Example

add iptunnel tunnel1 10.100.20.0 255.255.255.0 *

set ipTunnel

Modifies parameters of a GENEVE Tunnel.

Synopsis

set ipTunnel \[-vlanTagging \( ENABLED | DISABLED )] \[-destPort ] \[-tosInherit \( ENABLED | DISABLED )]

Arguments

name Name of the IP tunnel

vlanTagging Enable or disable the VlanTagging in a Geneve Tunnel.

Possible values: ENABLED, DISABLED Default value: DISABLED

destPort Change the detination port for a Geneve Tunnel. Default value: 6081 Minimum value: 1024 Maximum value: 65535

tosInherit Enable or disable the copying of ToS value from the inner packet to the outer IP packet.

Possible values: ENABLED, DISABLED Default value: ENABLED

Example

set iptunnel tun1 -destPort 2000 -tosInherit DISABLED -vlanTagging DISABLED

ipTunnel
August 18, 2023
Contributed by: 
C
August 18, 2023
Contributed by: 
C

In this article

Site feedback | Privacy and legal terms | Cookie preferences | Consent settings | docs.cloud.com
© 1999- Cloud Software Group, Inc. All rights reserved.