Download full document:

iptunnel

Configuration for ip Tunnel resource.

Properties

(click to see Operations)

Name	Data Type	Permissions	Description
name	<String>	Read-write	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 ( ).<br>Minimum length = 1
remote	<String>	Read-write	Public IPv4 address, of the remote device, used to set up the tunnel. For this parameter, you can alternatively specify a network address.<br>Minimum length = 1
remotesubnetmask	<String>	Read-write	Subnet mask of the remote IP address of the tunnel.
local	<String>	Read-write	Type ofNetScaler owned public IPv4 address, configured on the local NetScaler appliance and used to set up the tunnel.
protocol	<String>	Read-write	Name of the protocol to be used on this tunnel.<br>Default value: IPIP<br>Possible values = IPIP, GRE, IPSEC, VXLAN
ipsecprofilename	<String>	Read-write	Name of IPSec profile to be associated.<br>Default value: "ns_ipsec_default_profile"
vlan	<Double>	Read-write	The vlan for mulicast packets.<br>Minimum value = 1<br>Maximum value = 4094
sysname	<String>	Read-only	The name of the ip tunnel.
type	<Double>	Read-only	The type of this tunnel.
encapip	<String>	Read-only	The effective local IP address of the tunnel. Used as the source of the encapsulated packets.
channel	<Double>	Read-only	The tunnel that is bound to a netbridge.
tunneltype	<String[]>	Read-only	Indicates that a tunnel is User-Configured, Internal or DELETE-IN-PROGRESS.<br>Possible values = Configured, Delete-In-Progress
ipsectunnelstatus	<String>	Read-only	Whether the ipsec on this tunnel is up or down.<br>Possible values = DOWN, UP, PARTIAL-UP, UNKNOWN
pbrname	<String>	Read-only	Name for the PBR.
__count	<Double>	Read-only	count parameter

Operations

(click to see Properties)

ADD | DELETE | GET (ALL) | GET | COUNT

Some options that you can use for each operations:

Getting warnings in response: NITRO allows you to get warnings in an operation by specifying the "warning" query parameter as "yes". For example, to get warnings while connecting to the NetScaler appliance, the URL is as follows:
http://<netscaler-ip-address>/nitro/v1/config/login?warning=yes
If any, the warnings are displayed in the response payload with the HTTP code "209 X-NITRO-WARNING".
Authenticated access for individual NITRO operations: NITRO allows you to logon to the NetScaler appliance to perform individual operations. You can use this option instead of creating a NITRO session (using the login object) and then using that session to perform all operations,
To do this, you must specify the username and password in the request header of the NITRO request as follows:
X-NITRO-USER:<username>
X-NITRO-PASS:<password>
Note: In such cases, make sure that the request header DOES not include the following:
Cookie:NITRO_AUTH_TOKEN=<tokenvalue>

Note:

Mandatory parameters are marked in red and placeholder content is marked in <green>.

add

URL: http://<NSIP>/nitro/v1/config/

HTTP Method: POST

Request Payload:

object={
"params":{
      "warning":<String_value>,
      "onerror":<String_value>
},
"sessionid":"##sessionid",
"iptunnel":{
      "name":<String_value>,
      "remote":<String_value>,
      "remotesubnetmask":<String_value>,
      "local":<String_value>,
      "protocol":<String_value>,
      "ipsecprofilename":<String_value>,
      "vlan":<Double_value>,
}}

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": }

delete

URL: http://<NSIP>/nitro/v1/config/iptunnel/name_value<String>

Query-parameters:

warning

http://<NS_IP>/nitro/v1/config/iptunnel/name_value<String>?warning=yes

Use this query parameter to get warnings in nitro response. If this field is set to YES, warning message will be sent in 'message' field and 'WARNING' value is set in severity field of the response in case there is a

HTTP Method: DELETE

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": }

get (all)

URL: http://<NSIP>/nitro/v1/config/iptunnel

Query-parameters:

args

http://<NSIP>/nitro/v1/config/iptunnel?args= "remote":<String_value>, "remotesubnetmask":<String_value>, "name":<String_value>,

Use this query-parameter to get iptunnel resources based on additional properties.

filter

http://<NSIP>/nitro/v1/config/iptunnel?filter=property-name1:property-val1,property-name2:property-val2

Use this query-parameter to get the filtered set of iptunnel resources configured on NetScaler.Filtering can be done on any of the properties of the resource.

view

http://<NS_IP>/nitro/v1/config/iptunnel?view=summary

Use this query-parameter to get the summary output of iptunnel resources configured on NetScaler.

pagesize=#no;pageno=#no

http://<NS_IP>/nitro/v1/config/iptunnel?pagesize=#no;pageno=#no

Use this query-parameter to get the iptunnel resources in chunks.

warning

http://<NS_IP>/nitro/v1/config/iptunnel?warning=yes

Use this query parameter to get warnings in nitro response. If this field is set to YES, warning message will be sent in 'message' field and 'WARNING' value is set in severity field of the response in case there is a

HTTP Method: GET

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": <String_value>, "iptunnel": [ {
      "remote":<String_value>,
                  "remotesubnetmask":<String_value>,
      "name":<String_value>,
      "sysname":<String_value>,
      "local":<String_value>,
      "protocol":<String_value>,
      "type":<Double_value>,
      "encapip":<String_value>,
      "channel":<Double_value>,
      "ipsecprofilename":<String_value>,
      "vlan":<Double_value>,
      "tunneltype":<String[]_value>,
      "ipsectunnelstatus":<String_value>,
      "pbrname":<String_value>

}]}

get

URL: http://<NS_IP>/nitro/v1/config/iptunnel/name_value<String>

HTTP Method: GET

Response Payload:

{ "errorcode": 0, "message": "Done", "iptunnel": [ {
      "remote":<String_value>,
                  "remotesubnetmask":<String_value>,
      "name":<String_value>,
      "sysname":<String_value>,
      "local":<String_value>,
      "protocol":<String_value>,
      "type":<Double_value>,
      "encapip":<String_value>,
      "channel":<Double_value>,
      "ipsecprofilename":<String_value>,
      "vlan":<Double_value>,
      "tunneltype":<String[]_value>,
      "ipsectunnelstatus":<String_value>,
      "pbrname":<String_value>

}]}

count

URL: http://<NS_IP>/nitro/v1/config/iptunnel?count=yes

HTTP Method: GET

Response Payload:

{ "errorcode": 0, "message": "Done",iptunnel: [ { "__count": "#no"} ] }