Product Documentation

ip6tunnel

Sep 07, 2016

Configuration for ip6 Tunnel resource.

Properties (click to see Operations)

Name Data Type Permissions Description
name
<String>
Read-write
Name for the IPv6 Tunnel. Cannot be changed after the service group is created. Must begin with a number or letter, and can consist of letters, numbers, and the @ _ - . (period) : (colon) # and space ( ) characters.
Minimum length = 1
Maximum length = 31
remote
<String>
Read-write
An IPv6 address of the remote NetScaler appliance used to set up the tunnel.
Minimum length = 1
local
<String>
Read-write
An IPv6 address of the local NetScaler appliance used to set up the tunnel.
ownergroup
<String>
Read-write
The owner node group in a Cluster for the tunnel.
Default value: DEFAULT_NG
Minimum length = 1
remoteip
<String>
Read-only
The remote IP address or subnet of the 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.
__count
<Double>
Read-only
count parameter

Operations (click to see Properties)

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>

메모

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

add

URL: http://<netscaler-ip-address>/nitro/v1/config/ip6tunnel

HTTP Method: POST

Request Headers:

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

Request Payload:

{"ip6tunnel":{
      "name":<String_value>,
      "remote":<String_value>,
      "local":<String_value>,
      "ownergroup":<String_value>
}}

Response:

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

delete

URL: http://<netscaler-ip-address>/nitro/v1/config/ip6tunnel/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 NetScaler-specific errors). The response payload provides details of the error

get (all)

URL: http://<netscaler-ip-address>/nitro/v1/config/ip6tunnel

Query-parameters:

args

http://<netscaler-ip-address>/nitro/v1/config/ip6tunnel?args=name:<String_value>,remote:<String_value>

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

attrs

http://<netscaler-ip-address>/nitro/v1/config/ip6tunnel?attrs=property-name1,property-name2

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

filter

http://<netscaler-ip-address>/nitro/v1/config/ip6tunnel?filter=property-name1:property-val1,property-name2:property-val2

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

view

http://<netscaler-ip-address>/nitro/v1/config/ip6tunnel?view=summary

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

pagination

http://<netscaler-ip-address>/nitro/v1/config/ip6tunnel?pagesize=#no&pageno=#no

Use this query-parameter to get the ip6tunnel 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 NetScaler-specific errors). The response payload provides details of the error

Response Headers:

Content-Type:application/json

Response Payload:

{ "ip6tunnel": [ {
name:<String_value>,remote:<String_value>      "remoteip":<String_value>,
      "local":<String_value>,
      "type":<Double_value>,
      "encapip":<String_value>,
      "ownergroup":<String_value>
}]}

get

URL: http://<netscaler-ip-address>/nitro/v1/config/ip6tunnel/name_value<String>

Query-parameters:

attrs

http://<netscaler-ip-address>/nitro/v1/config/ip6tunnel/name_value<String>?attrs=property-name1,property-name2

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

view

http://<netscaler-ip-address>/nitro/v1/config/ip6tunnel/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 NetScaler-specific errors). The response payload provides details of the error

Response Headers:

Content-Type:application/json

Response Payload:

{ "ip6tunnel": [ {
name:<String_value>,remote:<String_value>      "remoteip":<String_value>,
      "local":<String_value>,
      "type":<Double_value>,
      "encapip":<String_value>,
      "ownergroup":<String_value>
}]}

count

URL: http://<netscaler-ip-address>/nitro/v1/config/ip6tunnel?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 NetScaler-specific errors). The response payload provides details of the error

Response Headers:

Content-Type:application/json

Response Payload:

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