ADC NITRO APIs

icaparameter

September 25, 2025

Contributed by:

Configuration for Config Parameters for NS ICA resource.

Properties

(click to see Operations )

Name	Data Type	Permissions	Description
enablesronhafailover		Read-write	Enable/Disable Session Reliability on HA failover. The default value is No. Default value: NO Possible values = YES, NO
hdxinsightnonnsap		Read-write	Enable/Disable HDXInsight for Non NSAP ICA Sessions. The default value is Yes. Default value: YES Possible values = YES, NO
edtpmtuddf		Read-write	Enable/Disable DF enforcement for EDT PMTUD Control Blocks. Default value: ENABLED Possible values = ENABLED, DISABLED
edtpmtuddftimeout		Read-write	DF enforcement timeout for EDTPMTUDDF. Default value: 100 Minimum value = 10 Maximum value = 65535
l7latencyfrequency		Read-write	Specify the time interval/period for which L7 Client Latency value is to be calculated. By default, L7 Client Latency is calculated for every packet. The default value is 0. Default value: 0 Minimum value = 0 Maximum value = 60
edtlosstolerant		Read-write	Enable/Disable EDT Loss Tolerant feature. Default value: ENABLED Possible values = ENABLED, DISABLED
edtpmtudrediscovery		Read-write	Enable/Disable EDT PMTUD Rediscovery. Default value: DISABLED Possible values = ENABLED, DISABLED
dfpersistence		Read-write	Enable/Disable DF Persistence. Default value: DISABLED Possible values = ENABLED, DISABLED
insightonlytodirector		Read-write	Enable/Disable HDX Insight data to Director even if HDX Insight policy is not configured on Gateway and Network Telemtry policy is enabled on VDA. Default value: ENABLED Possible values = ENABLED, DISABLED
builtin	<String[]>	Read-only	Indicates that the ICA parameter is a built-in (SYSTEM INTERNAL) type. Possible values = MODIFIABLE, DELETABLE, IMMUTABLE, PARTITION_ALL
_nextgenapiresource		Read-only	.

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

HTTP Method: PUT

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Content-Type:application/json

Request Payload:

{"icaparameter":{
"enablesronhafailover":<String_value>,
"hdxinsightnonnsap":<String_value>,
"edtpmtuddf":<String_value>,
"edtpmtuddftimeout":<Integer_value>,
"l7latencyfrequency":<Integer_value>,
"edtlosstolerant":<String_value>,
"edtpmtudrediscovery":<String_value>,
"dfpersistence":<String_value>,
"insightonlytodirector":<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/icaparameter? action=unset

HTTP Method: POST

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Content-Type:application/json

Request Payload:

{"icaparameter":{
"enablesronhafailover":true,
"hdxinsightnonnsap":true,
"edtpmtuddf":true,
"edtpmtuddftimeout":true,
"l7latencyfrequency":true,
"edtlosstolerant":true,
"edtpmtudrediscovery":true,
"dfpersistence":true,
"insightonlytodirector":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/icaparameter

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:

{ "icaparameter": [ {
"enablesronhafailover":<String_value>,
"hdxinsightnonnsap":<String_value>,
"edtpmtuddf":<String_value>,
"edtpmtuddftimeout":<Integer_value>,
"builtin":<String[]_value>,
"l7latencyfrequency":<Integer_value>,
"edtlosstolerant":<String_value>,
"edtpmtudrediscovery":<String_value>,
"dfpersistence":<String_value>,
"insightonlytodirector":<String_value>,
"_nextgenapiresource":<String_value>
}]}


<!--NeedCopy-->

The official version of this content is in English. Some of the Cloud Software Group documentation content is machine translated for your convenience only. Cloud Software Group has no control over machine-translated content, which may contain errors, inaccuracies or unsuitable language. No warranty of any kind, either expressed or implied, is made as to the accuracy, reliability, suitability, or correctness of any translations made from the English original into any other language, or that your Cloud Software Group product or service conforms to any machine translated content, and any warranty provided under the applicable end user license agreement or terms of service, or any other agreement with Cloud Software Group, that the product or service conforms with any documentation shall not apply to the extent that such documentation has been machine translated. Cloud Software Group will not be held responsible for any damage or issues that may arise from using machine-translated content.

Was this helpful

icaparameter

September 25, 2025

Contributed by:

September 25, 2025

Contributed by:

icaparameter

Properties

Operations

update

unset

get (all)

In this article