getnsparamResult Structure Definition

The getnsparamResult structure defines the return type for getnsparam API.

Syntax



Members

rc

If the method succeeds, rc is 0 else rc > 0. Values above 0x8000 indicate Warnings.

message

If the method succeeds, message is NULL else message contains Error/Warning message.

nsparamList

List of nsparams


nsparam Structure Definition

The nsparam structure defines the actual return type values for getnsparam API.

Syntax



Members

httpport

The HTTP ports on the Web server.

maxconn

Maximum Number of Connections.

maxreq

Maxmimum Number of requests that can be handled.

cip

Insertion of client IP address into the HTTP header.

cipheader

The text that will be used as the client IP header.

cookieversion

Version of the cookie inserted by the system.

securecookie

Enable or disable secure flag for persistence cookie.

pmtumin

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.

pmtutimeout

Interval, in minutes, for flushing the PMTU entries.

ftpportrange

Minimum and maximum port (port range) that FTP services are allowed to use.

crportrange

Port range for cache redirection services.

timezone

Time zone for the Citrix ADC. Name of the time zone should be specified as argument.

grantquotamaxclient

Percentage of shared pool value granted to PE once PE exhausts the local exclusive quota. Where shared pool is the remaining maxclient quota after distribution of exclusive quota to PEs. Example: In a 2 PE NetScaler system if configured maxclient is 100 and exclusive quota is 80 percent then each PE will get 40 as local exclusive quota and 20 will be in shared pool. If configured grantQuota is 20 percent, then after exhausting its local exclusive quota PE borrows from shared pool in chunks of 4 i.e. 20 percent of 20.

exclusivequotamaxclient

Percentage of maxClient threshold to be divided equally among PEs.

grantquotaspillover

Percentage of shared pool value granted to PE once PE exhausts the local exclusive quota. Where shared pool is the remaining spillover quota after distribution of exclusive quota to PEs. Example: In a 2 PE NetScaler system if configured spillover is 100 and exclusive quota is 80 percent then each PE will get 40 as local exclusive quota and 20 will be in shared pool. If configured grantQuota is 20 percent, then after exhausting its local exclusive quota PE borrows from shared pool in chunks of 4 i.e. 20 percent of 20.

exclusivequotaspillover

Percentage of spillover threshold to be divided equally among PEs.

useproxyport

Enable/Disable use_proxy_port setting

internaluserlogin

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".

aftpallowrandomsourceport

Allow the FTP server to come from a random source port for active FTP data connections

icaports

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.

tcpcip

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.

servicepathingressvlan

VLAN on which the subscriber traffic arrives on the appliance.

secureicaports

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.

mgmthttpport

This allow the configuration of management HTTP port.
NOTE: This attribute is deprecated.
Deprecated, Use show mgmtParam method

mgmthttpsport

This allows the configuration of management HTTPS port.
NOTE: This attribute is deprecated.
Deprecated, Use show mgmtParam method

proxyprotocol

Disable/Enable v1 or v2 proxy protocol header for client info insertion

advancedanalyticsstats

Advnced analytics stats collection.

autoscaleoption

64 bits are provided for communication between ADM and ADC in cloud deployments. Currently LSB 3 bits are used.0x01=>AWS,0x02=>Azure,0x04=>GCP

ipttl

Set the IP Time to Live (TTL) and Hop Limit value for all outgoing packets from Citrix ADC.

_nextgenapiresource


See Also