Product Documentation

ipTunnel

Sep 12, 2016

The following operations can be performed on "ipTunnel":

add | rm | show

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.

Synopsys

add ipTunnel <name> <remote> <remoteSubnetMask> <local> [-protocol <protocol> [-vlan <positive_integer>]] [-grepayload <grepayload>] [-ipsecProfileName <string>] [-ownerGroup <string>]

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 ofNetScaler owned public IPv4 address, configured on the local NetScaler appliance and used to set up the tunnel.

protocol

Name of the protocol to be used on this tunnel.

Possible values: IPIP, GRE, IPSEC, VXLAN

Default value: IPIP

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 *

rm ipTunnel

Removes an IP tunnel configuration from the NetScaler appliance.

Synopsys

rm ipTunnel <name>

Arguments

name

Name of the IP Tunnel.

Example

rm iptunnel tunnel1

show ipTunnel

Display the configured IP tunnels.

Synopsys

show ipTunnel [(<remote> <remoteSubnetMask>) | <name>]

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 ( ).

Outputs

name

The name of the ip tunnel.

local

Type ofNetScaler owned public IPv4 address, configured on the local NetScaler appliance 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

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