ADC CLI Commands

ns-param

May 28, 2024

Contributed by:

The following operations can be performed on “ns-param”:

set

unset

show

set ns param

Sets the parameters of the Citrix ADC.

Synopsis

set ns param [-httpPort ...] \[-maxConn <positive\_integer>] \[-maxReq <positive\_integer>] \[-cip \( ENABLED | DISABLED ) ] \[-cookieversion \( 0 | 1 )] \[-secureCookie \( ENABLED | DISABLED )] \[-pmtuMin <positive\_integer>] \[-pmtuTimeout ] \[-ftpPortRange <int\[-int]>] \[-crPortRange <int\[-int]>] \[-timezone ] \[-grantQuotaMaxClient <positive\_integer>] \[-exclusiveQuotaMaxClient <positive\_integer>] \[-grantQuotaSpillOver <positive\_integer>] \[-exclusiveQuotaSpillOver <positive\_integer>] \[-useproxyport \( ENABLED | DISABLED )] \[-internaluserlogin \( ENABLED | DISABLED )] \[-aftpAllowRandomSourcePort \( ENABLED | DISABLED )] \[-icaPorts ...] \[-tcpCIP \( ENABLED | DISABLED )] \[-servicePathIngressVLAN <positive\_integer>] \[-secureicaPorts ...] \[-mgmthttpport ] \[-mgmthttpsport ] \[-proxyProtocol \( ENABLED | DISABLED )] \[-advancedAnalyticsStats \( ENABLED | DISABLED )] \[-ipTtl <positive\_integer>]

Arguments

httpPort 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 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 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 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 Text that will be used as the client IP address header.

cookieversion Version of the cookie inserted by the system.

Possible values: 0, 1

secureCookie Enable or disable secure flag for persistence cookie.

Possible values: ENABLED, DISABLED Default value: ENABLED

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. Default value: 576 Minimum value: 168 Maximum value: 1500

pmtuTimeout Interval, in minutes, for flushing the PMTU entries. Default value: 10 Minimum value: 1 Maximum value: 1440

ftpPortRange Minimum and maximum port (port range) that FTP services are allowed to use. Minimum value: 1024 Maximum value: 64000

crPortRange Port range for cache redirection services. Minimum value: 1 Maximum value: 65535

timezone Time zone for the Citrix ADC. Name of the time zone should be specified as argument. Default value: CoordinatedUniversalTime

grantQuotaMaxClient Percentage of shared quota to be granted at a time for maxClient. Default value: 10 Minimum value: 0 Maximum value: 100

exclusiveQuotaMaxClient Percentage of maxClient to be given to PEs. Default value: 80 Minimum value: 0 Maximum value: 100

grantQuotaSpillOver Percentage of shared quota to be granted at a time for spillover. Default value: 10 Minimum value: 0 Maximum value: 100

exclusiveQuotaSpillOver Percentage of maximum limit to be given to PEs. Default value: 80 Minimum value: 0 Maximum value: 100

useproxyport Enable/Disable use_proxy_port setting

Possible values: ENABLED, DISABLED Default value: ENABLED

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

Possible values: ENABLED, DISABLED Default value: ENABLED

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

Possible values: ENABLED, DISABLED Default value: DISABLED

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. Minimum value: 1

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.

Possible values: ENABLED, DISABLED Default value: DISABLED

servicePathIngressVLAN VLAN on which the subscriber traffic arrives on the appliance. Minimum value: 1

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. Minimum value: 1

mgmthttpport This allow the configuration of management HTTP port. Default value: 80 Minimum value: 1 Maximum value: 65534

mgmthttpsport This allows the configuration of management HTTPS port. Default value: 443 Minimum value: 1 Maximum value: 65534

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

Possible values: ENABLED, DISABLED Default value: DISABLED

advancedAnalyticsStats Disable/Enable advanace analytics stats

Possible values: ENABLED, DISABLED Default value: DISABLED

ipTtl Set the IP Time to Live (TTL) and Hop Limit value for all outgoing packets from Citrix ADC. Default value: 255 Minimum value: 1 Maximum value: 255

unset ns param

Removes the attributes of the Citrix ADC parameters. Attributes for which a default value is available revert to their default values. Refer to the ‘set ns param’ command for a description of the parameters..Refer to the set ns param command for meanings of the arguments.

Synopsis

unset ns param [-ftpPortRange] [-crPortRange] [-aftpAllowRandomSourcePort] [-httpPort] [-maxConn] [-maxReq] [-cip] [-cipHeader] [-cookieversion] [-secureCookie] [-pmtuMin] [-pmtuTimeout] [-timezone] [-grantQuotaMaxClient] [-exclusiveQuotaMaxClient] [-grantQuotaSpillOver] [-exclusiveQuotaSpillOver] [-useproxyport] [-internaluserlogin] [-icaPorts] [-tcpCIP] [-servicePathIngressVLAN] [-secureicaPorts] [-mgmthttpport] [-mgmthttpsport] [-proxyProtocol] [-advancedAnalyticsStats] [-ipTtl]

show ns param

Displays the information of the parameters of the Citrix ADC that were set by using the ‘set ns param’ command.

Synopsis

show ns param

Arguments

Output

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 quota to be granted at a time for maxClient.

exclusiveQuotaMaxClient Percentage of maxClient to be given to PEs.

grantQuotaSpillOver Percentage of shared quota to be granted at a time for spillover.

exclusiveQuotaSpillOver Percentage of maximum limit to be given to PEs.

useproxyport Enable/Disable use_proxy_port setting

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.

servicePathIngressVLAN VLAN on which the subscriber traffic arrives on the appliance.

mgmthttpport This allow the configuration of management HTTP port.

mgmthttpsport This allows the configuration of management HTTPS port.

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.

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

ns-param

May 28, 2024

Contributed by:

May 28, 2024

Contributed by:

ns-param

set ns param

Synopsis

Arguments

unset ns param

Synopsis

show ns param

Synopsis

Arguments

Output

In this article