Home > Configuration > Network > addiptunnel

addiptunnel

Use this method to 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.

Syntax



Parameters

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 ( ).
This is mandatory parameter.

remote

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

remotesubnetmask

Subnet mask of the remote IP address of the tunnel.
This is mandatory parameter.

local

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

protocol

Name of the protocol to be used on this tunnel.
Default value = TNL_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.
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.
Default value = ENABLED.

grepayload

The payload GRE will carry
Default value = NS_GREPAYLOAD_DOT1Q.

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.

Return Value

Returns simpleResult

See Also