ADC NITRO APIs

nsparam

August 17, 2023

Contributed by:

Configuration for Citrix ADC parameters resource.

Properties

(click to see Operations )

Name	Data Type	Permissions	Description
httpport	<Integer[]>	Read-write	HTTP ports on the web server. This allows the system to perform connection off-load for any client request that has a destination port matching one of these configured ports. Minimum value = 1 Maximum value = 65535
maxconn		Read-write	Maximum number of connections that will be made from the appliance to the web server(s) attached to it. The value entered here is applied globally to all attached servers. Default value: 0 Minimum value = 0 Maximum value = 4294967294
maxreq		Read-write	Maximum number of requests that the system can pass on a particular connection between the appliance and a server attached to it. Setting this value to 0 allows an unlimited number of requests to be passed. This value is overridden by the maximum number of requests configured on the individual service. Minimum value = 0 Maximum value = 65535
cip		Read-write	Enable or disable the insertion of the actual client IP address into the HTTP header request passed from the client to one, some, or all servers attached to the system. The passed address can then be accessed through a minor modification to the server. * If the CIP header is specified, it will be used as the client IP header. * If the CIP header is not specified, the value that has been set will be used as the client IP header. Possible values = ENABLED, DISABLED
cipheader		Read-write	Text that will be used as the client IP address header. Minimum length = 1
cookieversion		Read-write	Version of the cookie inserted by the system. Possible values = 0, 1
securecookie		Read-write	Enable or disable secure flag for persistence cookie. Default value: ENABLED Possible values = ENABLED, DISABLED
pmtumin		Read-write	Minimum path MTU value that Citrix ADC will process in the ICMP fragmentation needed message. If the ICMP message contains a value less than this value, then this value is used instead. Default value: 576 Minimum value = 168 Maximum value = 1500
pmtutimeout		Read-write	Interval, in minutes, for flushing the PMTU entries. Default value: 10 Minimum value = 1 Maximum value = 1440
ftpportrange		Read-write	Minimum and maximum port (port range) that FTP services are allowed to use. Minimum length = 1024 Maximum length = 64000
crportrange		Read-write	Port range for cache redirection services. Minimum length = 1 Maximum length = 65535
timezone		Read-write	Time zone for the Citrix ADC. Name of the time zone should be specified as argument. Default value: CoordinatedUniversalTime Minimum length = 1 Maximum length = 63
grantquotamaxclient		Read-write	Percentage of shared quota to be granted at a time for maxClient. Default value: 10 Minimum value = 0 Maximum value = 100
exclusivequotamaxclient		Read-write	Percentage of maxClient to be given to PEs. Default value: 80 Minimum value = 0 Maximum value = 100
grantquotaspillover		Read-write	Percentage of shared quota to be granted at a time for spillover. Default value: 10 Minimum value = 0 Maximum value = 100
exclusivequotaspillover		Read-write	Percentage of maximum limit to be given to PEs. Default value: 80 Minimum value = 0 Maximum value = 100
useproxyport		Read-write	Enable/Disable use_proxy_port setting. Default value: ENABLED Possible values = ENABLED, DISABLED
internaluserlogin		Read-write	Enables/disables the internal user from logging in to the appliance. Before disabling internal user login, you must have key-based authentication set up on the appliance. The file name for the key pair must be “ns_comm_key”. Default value: ENABLED Possible values = ENABLED, DISABLED
aftpallowrandomsourceport		Read-write	Allow the FTP server to come from a random source port for active FTP data connections. Default value: DISABLED Possible values = ENABLED, DISABLED
icaports	<Integer[]>	Read-write	The ICA ports on the Web server. This allows the system to perform connection off-load for any client request that has a destination port matching one of these configured ports. Minimum value = 1
tcpcip		Read-write	Enable or disable the insertion of the client TCP/IP header in TCP payload passed from the client to one, some, or all servers attached to the system. The passed address can then be accessed through a minor modification to the server. Default value: DISABLED Possible values = ENABLED, DISABLED
servicepathingressvlan		Read-write	VLAN on which the subscriber traffic arrives on the appliance. Minimum value = 1
secureicaports	<Integer[]>	Read-write	The Secure ICA ports on the Web server. This allows the system to perform connection off-load for any client request that has a destination port matching one of these configured ports. Minimum value = 1
mgmthttpport		Read-write	This allow the configuration of management HTTP port. Default value: 80 Minimum value = 1 Maximum value = 65534
mgmthttpsport		Read-write	This allows the configuration of management HTTPS port. Default value: 443 Minimum value = 1 Maximum value = 65534
proxyprotocol		Read-write	Disable/Enable v1 or v2 proxy protocol header for client info insertion. Default value: DISABLED Possible values = ENABLED, DISABLED
advancedanalyticsstats		Read-write	Disable/Enable advanace analytics stats. 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/nsparam

HTTP Method: PUT

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Content-Type:application/json

Request Payload:

{"nsparam":{
      "httpport":<Integer[]_value>,
      "maxconn":<Double_value>,
      "maxreq":<Double_value>,
      "cip":<String_value>,
      "cipheader":<String_value>,
      "cookieversion":<String_value>,
      "securecookie":<String_value>,
      "pmtumin":<Double_value>,
      "pmtutimeout":<Double_value>,
      "ftpportrange":<String_value>,
      "crportrange":<String_value>,
      "timezone":<String_value>,
      "grantquotamaxclient":<Double_value>,
      "exclusivequotamaxclient":<Double_value>,
      "grantquotaspillover":<Double_value>,
      "exclusivequotaspillover":<Double_value>,
      "useproxyport":<String_value>,
      "internaluserlogin":<String_value>,
      "aftpallowrandomsourceport":<String_value>,
      "icaports":<Integer[]_value>,
      "tcpcip":<String_value>,
      "servicepathingressvlan":<Double_value>,
      "secureicaports":<Integer[]_value>,
      "mgmthttpport":<Integer_value>,
      "mgmthttpsport":<Integer_value>,
      "proxyprotocol":<String_value>,
      "advancedanalyticsstats":<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/nsparam? action=unset

HTTP Method: POST

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Content-Type:application/json

Request Payload:

{"nsparam":{
      "ftpportrange":true,
      "crportrange":true,
      "aftpallowrandomsourceport":true,
      "httpport":true,
      "maxconn":true,
      "maxreq":true,
      "cip":true,
      "cipheader":true,
      "cookieversion":true,
      "securecookie":true,
      "pmtumin":true,
      "pmtutimeout":true,
      "timezone":true,
      "grantquotamaxclient":true,
      "exclusivequotamaxclient":true,
      "grantquotaspillover":true,
      "exclusivequotaspillover":true,
      "useproxyport":true,
      "internaluserlogin":true,
      "icaports":true,
      "tcpcip":true,
      "servicepathingressvlan":true,
      "secureicaports":true,
      "mgmthttpport":true,
      "mgmthttpsport":true,
      "proxyprotocol":true,
      "advancedanalyticsstats":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/nsparam

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:

{ "nsparam": [ {
      "httpport":<Integer[]_value>,
      "maxconn":<Double_value>,
      "maxreq":<Double_value>,
      "cip":<String_value>,
      "cipheader":<String_value>,
      "cookieversion":<String_value>,
      "securecookie":<String_value>,
      "pmtumin":<Double_value>,
      "pmtutimeout":<Double_value>,
      "ftpportrange":<String_value>,
      "crportrange":<String_value>,
      "timezone":<String_value>,
      "grantquotamaxclient":<Double_value>,
      "exclusivequotamaxclient":<Double_value>,
      "grantquotaspillover":<Double_value>,
      "exclusivequotaspillover":<Double_value>,
      "useproxyport":<String_value>,
      "internaluserlogin":<String_value>,
      "aftpallowrandomsourceport":<String_value>,
      "icaports":<Integer[]_value>,
      "tcpcip":<String_value>,
      "servicepathingressvlan":<Double_value>,
      "secureicaports":<Integer[]_value>,
      "mgmthttpport":<Integer_value>,
      "mgmthttpsport":<Integer_value>,
      "proxyprotocol":<String_value>,
      "advancedanalyticsstats":<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

nsparam

August 17, 2023

Contributed by:

August 17, 2023

Contributed by:

nsparam

Properties

Operations

update

unset

get (all)

In this article