l3param¶
Configuration for Layer 3 related parameter resource.
Properties¶
(click to see Operations )
Name | Data Type | Permissions | Description |
---|---|---|---|
srcnat | <String> | Read-write | Perform NAT if only the source is in the private network.
Default value: ENABLED Possible values = ENABLED, DISABLED |
icmpgenratethreshold | <Double> | Read-write | NS generated ICMP pkts per 10ms rate threshold.
Default value: 100 |
overridernat | <String> | Read-write | USNIP/USIP settings override RNAT settings for configured
service/virtual server traffic.. . Default value: DISABLED Possible values = ENABLED, DISABLED |
dropdfflag | <String> | Read-write | Enable dropping the IP DF flag.
Default value: DISABLED Possible values = ENABLED, DISABLED |
miproundrobin | <String> | Read-write | Enable round robin usage of mapped IPs.
Default value: ENABLED Possible values = ENABLED, DISABLED |
externalloopback | <String> | Read-write | Enable external loopback.
Default value: DISABLED Possible values = ENABLED, DISABLED |
tnlpmtuwoconn | <String> | Read-write | Enable/Disable learning PMTU of IP tunnel when ICMP error does not contain connection information.
Default value: ENABLED Possible values = ENABLED, DISABLED |
usipserverstraypkt | <String> | Read-write | Enable detection of stray server side pkts in USIP mode.
Default value: DISABLED Possible values = ENABLED, DISABLED |
forwardicmpfragments | <String> | Read-write | Enable forwarding of ICMP fragments.
Default value: DISABLED Possible values = ENABLED, DISABLED |
dropipfragments | <String> | Read-write | Enable dropping of IP fragments.
Default value: DISABLED Possible values = ENABLED, DISABLED |
acllogtime | <Double> | Read-write | Parameter to tune acl logging time.
Default value: 5000 |
implicitaclallow | <String> | Read-write | Do not apply ACLs for internal ports.
Default value: ENABLED Possible values = ENABLED, DISABLED |
dynamicrouting | <String> | Read-write | Enable/Disable Dynamic routing on partition. This configuration is not applicable to default partition.
Default value: DISABLED Possible values = ENABLED, DISABLED |
ipv6dynamicrouting | <String> | Read-write | Enable/Disable IPv6 Dynamic routing.
Default value: DISABLED Possible values = ENABLED, DISABLED |
allowclasseipv4 | <String> | Read-write | Enable/Disable IPv4 Class E address clients.
Default value: DISABLED 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:// <netscaler-ip-address> /nitro/v1/config/l3param
HTTP Method: PUT
Request Headers:
Cookie:NITRO_AUTH_TOKEN= <tokenvalue>
Content-Type:application/json
Request Payload:
{"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>,
"implicitaclallow":<String_value>,
"dynamicrouting":<String_value>,
"ipv6dynamicrouting":<String_value>,
"allowclasseipv4":<String_value>
}}
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/l3param? action=unset
HTTP Method: POST
Request Headers:
Cookie:NITRO_AUTH_TOKEN= <tokenvalue>
Content-Type:application/json
Request Payload:
{"l3param":{
"srcnat":true,
"icmpgenratethreshold":true,
"overridernat":true,
"dropdfflag":true,
"miproundrobin":true,
"externalloopback":true,
"tnlpmtuwoconn":true,
"usipserverstraypkt":true,
"forwardicmpfragments":true,
"dropipfragments":true,
"acllogtime":true,
"implicitaclallow":true,
"dynamicrouting":true,
"ipv6dynamicrouting":true,
"allowclasseipv4":true
}}
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/l3param
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:
{ "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>,
"implicitaclallow":<String_value>,
"dynamicrouting":<String_value>,
"ipv6dynamicrouting":<String_value>,
"allowclasseipv4":<String_value>
}]}