Download full document:

l3param

Configuration for Layer 3 related parameter resource.

Properties

(click to see Operations)

Name Data Type PermissionsDescription
srcnat<String>Read-writePerform NAT if only the source is in the private network.<br>Default value: ENABLED<br>Possible values = ENABLED, DISABLED
icmpgenratethreshold<Double>Read-writeNS generated ICMP pkts per 10ms rate threshold.<br>Default value: 100
overridernat<String>Read-writeUSNIP/USIP settings override RNAT settings for configured service/virtual server traffic.. .<br>Default value: DISABLED<br>Possible values = ENABLED, DISABLED
dropdfflag<String>Read-writeEnable dropping the IP DF flag.<br>Default value: DISABLED<br>Possible values = ENABLED, DISABLED
miproundrobin<String>Read-writeEnable round robin usage of mapped IPs.<br>Default value: ENABLED<br>Possible values = ENABLED, DISABLED
externalloopback<String>Read-writeEnable external loopback.<br>Default value: DISABLED<br>Possible values = ENABLED, DISABLED
tnlpmtuwoconn<String>Read-writeEnable external loopback.<br>Default value: ENABLED<br>Possible values = ENABLED, DISABLED
usipserverstraypkt<String>Read-writeEnable detection of stray server side pkts in USIP mode.<br>Default value: DISABLED<br>Possible values = ENABLED, DISABLED
forwardicmpfragments<String>Read-writeEnable forwarding of ICMP fragments.<br>Default value: DISABLED<br>Possible values = ENABLED, DISABLED
dropipfragments<String>Read-writeEnable dropping of IP fragments.<br>Default value: DISABLED<br>Possible values = ENABLED, DISABLED
acllogtime<Double>Read-writeParameter to tune acl logging time.<br>Default value: 5000
icmperrgenerate<String>Read-writeEnable/Disable fragmentation required icmp error generation, before encapsulating a packet with vPath header. This knob is only functional for vPath Environment.<br>Default value: ENABLED<br>Possible values = ENABLED, DISABLED
implicitaclallow<String>Read-writeDo not apply ACLs for internal ports.<br>Default value: ENABLED<br>Possible values = ENABLED, DISABLED

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://<NSIP>/nitro/v1/config/

HTTP Method: PUT

Request Payload:

{
"params": {
      "warning":<String_value>,
      "onerror":<String_value>"
},
sessionid":"##sessionid",
"l3param":{
      "srcnat":<String_value>,
      "icmpgenratethreshold":<Double_value>,
      "overridernat":<String_value>,
      "dropdfflag":<String_value>,
      "miproundrobin":<String_value>,
      "externalloopback":<String_value>,
      "tnlpmtuwoconn":<String_value>,
      "usipserverstraypkt":<String_value>,
      "forwardicmpfragments":<String_value>,
      "dropipfragments":<String_value>,
      "acllogtime":<Double_value>,
      "icmperrgenerate":<String_value>,
      "implicitaclallow":<String_value>,
}}

Response Payload:

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

unset

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

HTTP Method: POST

Request Payload:

object={
"params":{
      "warning":<String_value>,
      "onerror":<String_value>,
      "action":"unset"
},
"sessionid":"##sessionid",
"l3param":{
      "srcnat":true,
      "icmpgenratethreshold":true,
      "overridernat":true,
      "dropdfflag":true,
      "miproundrobin":true,
      "externalloopback":true,
      "tnlpmtuwoconn":true,
      "usipserverstraypkt":true,
      "forwardicmpfragments":true,
      "dropipfragments":true,
      "acllogtime":true,
      "icmperrgenerate":true,
      "implicitaclallow":true,
}}

Response Payload:

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

get (all)

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

HTTP Method: GET

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": <String_value>, "l3param": [ {
      "srcnat":<String_value>,
      "icmpgenratethreshold":<Double_value>,
      "overridernat":<String_value>,
      "dropdfflag":<String_value>,
      "miproundrobin":<String_value>,
      "externalloopback":<String_value>,
      "tnlpmtuwoconn":<String_value>,
      "usipserverstraypkt":<String_value>,
      "forwardicmpfragments":<String_value>,
      "dropipfragments":<String_value>,
      "acllogtime":<Double_value>,
      "icmperrgenerate":<String_value>,
      "implicitaclallow":<String_value>

}]}