Developer Documentation
ADC NITRO APIs
Current Release 13.1 13

iptunnelparam

August 17, 2023
Contributed by: 
C

Configuration for ip tunnel parameter resource.

Properties

(click to see Operations )

Name Data Type Permissions Description
srcip Read-write Common source-IP address for all tunnels. For a specific tunnel, this global setting is overridden if you have specified another source IP address. Must be a MIP or SNIP address.

Minimum length = 1
dropfrag Read-write Drop any IP packet that requires fragmentation before it is sent through the tunnel.

Default value: NO

Possible values = YES, NO
dropfragcputhreshold Read-write Threshold value, as a percentage of CPU usage, at which to drop packets that require fragmentation to use the IP tunnel. Applies only if dropFragparameter is set to NO. The default value, 0, specifies that this parameter is not set.

Minimum value = 1

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

Default value: NO

Possible values = YES, NO
enablestrictrx Read-write Strict PBR check for IPSec packets received through tunnel.

Default value: NO

Possible values = YES, NO
enablestricttx Read-write Strict PBR check for packets to be sent IPSec protected.

Default value: NO

Possible values = YES, NO
mac Read-write The shared MAC used for shared IP between cluster nodes/HA peers.
useclientsourceip Read-write Use client source IP as source IP for outer tunnel IP 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/iptunnelparam

HTTP Method: PUT

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Content-Type:application/json

Request Payload: 


{"iptunnelparam":{
      "srcip":<String_value>,
      "dropfrag":<String_value>,
      "dropfragcputhreshold":<Double_value>,
      "srciproundrobin":<String_value>,
      "enablestrictrx":<String_value>,
      "enablestricttx":<String_value>,
      "mac":<String_value>,
      "useclientsourceip":<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/iptunnelparam? action=unset

HTTP Method: POST

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Content-Type:application/json

Request Payload: 


{"iptunnelparam":{
      "srcip":true,
      "dropfrag":true,
      "dropfragcputhreshold":true,
      "srciproundrobin":true,
      "enablestrictrx":true,
      "enablestricttx":true,
      "mac":true,
      "useclientsourceip":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/iptunnelparam

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: 


{ "iptunnelparam": [ {
      "srcip":<String_value>,
      "dropfrag":<String_value>,
      "dropfragcputhreshold":<Double_value>,
      "srciproundrobin":<String_value>,
      "enablestrictrx":<String_value>,
      "enablestricttx":<String_value>,
      "mac":<String_value>,
      "useclientsourceip":<String_value>
}]}

<!--NeedCopy-->
iptunnelparam
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.