Developer Documentation
Citrix ADC 12.1 NITRO API Reference
Current Release 13.1 13

iptunnel

August 17, 2023
Contributed by: 
C

Configuration for ip Tunnel resource.

Properties

(click to see Operations)

Name Data Type Permissions Description
name 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 ( ).
Minimum length = 1
remote 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.
Minimum length = 1
remotesubnetmask Read-write Subnet mask of the remote IP address of the tunnel.
local Read-write Type of Citrix ADC owned public IPv4 address, configured on the local Citrix ADC and used to set up the tunnel.
protocol Read-write Name of the protocol to be used on this tunnel.
Default value: IPIP
Possible values = IPIP, GRE, IPSEC, UDP
grepayload Read-write The payload GRE will carry.
Default value: ETHERNETwithDOT1Q
Possible values = ETHERNETwithDOT1Q, ETHERNET, IP
ipsecprofilename Read-write Name of IPSec profile to be associated.
Default value: “ns_ipsec_default_profile”
vlan Read-write The vlan for mulicast packets.
Minimum value = 1
Maximum value = 4094
ownergroup Read-write The owner node group in a Cluster for the iptunnel.
Default value: DEFAULT_NG
Minimum length = 1
sysname Read-only The name of the ip tunnel.
type Read-only The type of this tunnel.
encapip Read-only The effective local IP address of the tunnel. Used as the source of the encapsulated packets.
channel 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.
Possible values = Configured, Delete-In-Progress
ipsectunnelstatus Read-only Whether the ipsec on this tunnel is up or down.
Possible values = DOWN, UP, PARTIAL-UP, UNKNOWN
refcnt Read-only Number of PBRs to bound to this iptunnel.
__count 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 Citrix ADC appliance, the URL is as follows:

    http://<Citrix-ADC-IP-address(NSIP)>/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 Citrix ADC 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 redand placeholder content is marked in <green>.

add

URL:http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/iptunnel

HTTP Method:POST

Request Headers:

Cookie:NITRO_AUTH_TOKEN=<tokenvalue> Content-Type:application/json

Request Payload: 


{"iptunnel":{
<b>"name":<String_value>,
</b><b>"remote":<String_value>,
</b><b>"remotesubnetmask":<String_value>,
</b><b>"local":<String_value>,
</b>"protocol":<String_value>,
"grepayload":<String_value>,
"ipsecprofilename":<String_value>,
"vlan":<Double_value>,
"ownergroup":<String_value>
}}

<!--NeedCopy-->

Response:

HTTP Status Code on Success: 201 Created HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for Citrix ADC specific errors). The response payload provides details of the error

delete

URL:http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/iptunnel/name_value<String>

HTTP Method:DELETE

Request Headers:

Cookie:NITRO_AUTH_TOKEN=<tokenvalue>

Response:

HTTP Status Code on Success: 200 OK HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for Citrix ADC specific errors). The response payload provides details of the error

get (all)

URL:http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/iptunnel

Query-parameters:

args

http://<Citrix-ADC-IP-address(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.

attrs

http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/iptunnel?attrs=property-name1,property-name2

Use this query parameter to specify the resource details that you want to retrieve.

filter

http://<Citrix-ADC-IP-address(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 Citrix ADC. Filtering can be done on any of the properties of the resource.

view

http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/iptunnel?view=summary

Note:By default, the retrieved results are displayed in detail view (?view=detail).

pagination

http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/iptunnel?pagesize=#no;pageno=#no

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

HTTP Method:GET

Request Headers:

Cookie:NITRO_AUTH_TOKEN=<tokenvalue> Accept:application/json

Response:

HTTP Status Code on Success: 200 OK HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for Citrix ADC specific errors). The response payload provides details of the errorResponse Headers:

Content-Type:application/json

Response Payload: 


{ "iptunnel": [ {
remote:<String_value>,remotesubnetmask:<String_value>,name:<String_value>"sysname":<String_value>,
"local":<String_value>,
"protocol":<String_value>,
"grepayload":<String_value>,
"type":<Double_value>,
"encapip":<String_value>,
"channel":<Double_value>,
"ipsecprofilename":<String_value>,
"vlan":<Double_value>,
"tunneltype":<String[]_value>,
"ipsectunnelstatus":<String_value>,
"ownergroup":<String_value>,
"refcnt":<Double_value>
}]}

<!--NeedCopy-->

get

URL:http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/iptunnel/name_value<String>

Query-parameters:

attrs

http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/iptunnel/name_value<String>?attrs=property-name1,property-name2

Use this query parameter to specify the resource details that you want to retrieve.

view

http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/iptunnel/name_value<String>?view=summary

Note:By default, the retrieved results are displayed in detail view (?view=detail).

HTTP Method:GET

Request Headers:

Cookie:NITRO_AUTH_TOKEN=<tokenvalue> Accept:application/json

Response:

HTTP Status Code on Success: 200 OK HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for Citrix ADC specific errors). The response payload provides details of the errorResponse Headers:

Content-Type:application/json

Response Payload: 


{ "iptunnel": [ {
remote:<String_value>,remotesubnetmask:<String_value>,name:<String_value>"sysname":<String_value>,
"local":<String_value>,
"protocol":<String_value>,
"grepayload":<String_value>,
"type":<Double_value>,
"encapip":<String_value>,
"channel":<Double_value>,
"ipsecprofilename":<String_value>,
"vlan":<Double_value>,
"tunneltype":<String[]_value>,
"ipsectunnelstatus":<String_value>,
"ownergroup":<String_value>,
"refcnt":<Double_value>
}]}

<!--NeedCopy-->

count

URL:http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/iptunnel?count=yes

HTTP Method:GET

Request Headers:

Cookie:NITRO_AUTH_TOKEN=<tokenvalue> Accept:application/json

Response:

HTTP Status Code on Success: 200 OK HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for Citrix ADC specific errors). The response payload provides details of the errorResponse Headers:

Content-Type:application/json

Response Payload: 


{ "iptunnel": [ { "__count": "#no"} ] }

<!--NeedCopy-->
iptunnel
August 17, 2023
Contributed by: 
C
August 17, 2023
Contributed by: 
C

In this article

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