Developer Documentation
ADC NITRO APIs
Current Release 13.1 13

ip6tunnelparam

August 17, 2023
Contributed by: 
C

Configuration for ip6 tunnel parameter resource.

Properties

(click to see Operations )

Name Data Type Permissions Description
srcip <String> Read-write Common source IPv6 address for all IPv6 tunnels. Must be a SNIP6 or VIP6 address.

Minimum length = 1
dropfrag <String> Read-write Drop any packet that requires fragmentation.

Default value: NO

Possible values = YES, NO
dropfragcputhreshold <Double> Read-write Threshold value, as a percentage of CPU usage, at which to drop packets that require fragmentation. Applies only if dropFragparameter is set to NO.

Minimum value = 1

Maximum value = 100
srciproundrobin <String> Read-write Use a different source IPv6 address for each new session through a particular IPv6 tunnel, as determined by round robin selection of one of the SNIP6 addresses. This setting is ignored if a common global source IPv6 address has been specified for all the IPv6 tunnels. This setting does not apply to a tunnel for which a source IPv6 address has been specified.

Default value: NO

Possible values = YES, NO
useclientsourceipv6 <String> Read-write Use client source IPv6 address as source IPv6 address for outer tunnel IPv6 header.

Default value: NO

Possible values = YES, NO

Operations

(click to see Properties )

  • UPDATE
  • UNSET
  • GET (ALL)

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

update

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

HTTP Method: PUT

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Content-Type:application/json

Request Payload: 


{"ip6tunnelparam":{
      "srcip":<String_value>,
      "dropfrag":<String_value>,
      "dropfragcputhreshold":<Double_value>,
      "srciproundrobin":<String_value>,
      "useclientsourceipv6":<String_value>
}}

<!--NeedCopy-->

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

unset

URL: http:// <netscaler-ip-address> /nitro/v1/config/ip6tunnelparam? action=unset

HTTP Method: POST

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Content-Type:application/json

Request Payload: 


{"ip6tunnelparam":{
      "srcip":true,
      "dropfrag":true,
      "dropfragcputhreshold":true,
      "srciproundrobin":true,
      "useclientsourceipv6":true
}}

<!--NeedCopy-->

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/ip6tunnelparam

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 Header:

Content-Type:application/json

Response Payload: 


{ "ip6tunnelparam": [ {
      "srcip":<String_value>,
      "dropfrag":<String_value>,
      "dropfragcputhreshold":<Double_value>,
      "srciproundrobin":<String_value>,
      "useclientsourceipv6":<String_value>
}]}

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

In this article

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