ADC CLI Commands

system-parameter

May 28, 2024

Contributed by:

The following operations can be performed on “system-parameter”:

set

show

unset

set system parameter

Modifies the specified system parameters.

Synopsis

set system parameter [-rbaOnResponse ( ENABLED

DISABLED )] [-promptString ] \[-natPcbForceFlushLimit <positive\_integer>] \[-natPcbRstOnTimeout \( ENABLED

DISABLED )] [-timeout ] \[-localAuth \( ENABLED

DISABLED )] [-minpasswordlen ] [-strongpassword ] \[-restrictedtimeout \( ENABLED

DISABLED )] [-fipsUserMode ( ENABLED

DISABLED )] [-doppler ( ENABLED

DISABLED )] [-googleanalytics ( ENABLED

DISABLED )] [-totalAuthTimeout ] [-cliLoglevel ] \[-forcePasswordChange \( ENABLED

DISABLED )] [-basicAuth ( ENABLED

DISABLED )] [-reauthOnAuthParamChange ( ENABLED

DISABLED )] [-removeSensitiveFiles ( ENABLED

DISABLED )] [-maxsessionperuser ] [-daystoexpire [-warnpriorndays ]]

Arguments

rbaOnResponse Enable or disable Role-Based Authentication (RBA) on responses.

Possible values: ENABLED, DISABLED Default value: ENABLED

promptString String to display at the command-line prompt. Can consist of letters, numbers, hyphen (-), period (.), hash (#), space ( ), at (@), equal (=), colon (:), underscore (_), and the following variables:

%u - Will be replaced by the user name.
%h - Will be replaced by the hostname of the Citrix ADC.
%t - Will be replaced by the current time in 12-hour format.
%T - Will be replaced by the current time in 24-hour format.
%d - Will be replaced by the current date.
%s - Will be replaced by the state of the Citrix ADC.

Note: The 63-character limit for the length of the string does not apply to the characters that replace the variables.

natPcbForceFlushLimit Flush the system if the number of Network Address Translation Protocol Control Blocks (NATPCBs) exceeds this value. Default value: 2147483647 Minimum value: 1000

natPcbRstOnTimeout Send a reset signal to client and server connections when their NATPCBs time out. Avoids the buildup of idle TCP connections on both the sides.

Possible values: ENABLED, DISABLED Default value: DISABLED

timeout CLI session inactivity timeout, in seconds. If Restrictedtimeout argument is enabled, Timeout can have values in the range [300-86400] seconds. If Restrictedtimeout argument is disabled, Timeout can have values in the range [0, 10-100000000] seconds. Default value is 900 seconds.

localAuth When enabled, local users can access Citrix ADC even when external authentication is configured. When disabled, local users are not allowed to access the Citrix ADC, Local users can access the Citrix ADC only when the configured external authentication servers are unavailable. This parameter is not applicable to SSH Key-based authentication

Possible values: ENABLED, DISABLED Default value: ENABLED

minpasswordlen Minimum length of system user password. When strong password is enabled default minimum length is 8. User entered value can be greater than or equal to 8. Default mininum value is 1 when strong password is disabled. Maximum value is 127 in both cases. Minimum value: 1 Maximum value: 127

strongpassword After enabling strong password (enableall / enablelocal - not included in exclude list), all the passwords / sensitive information must have - Atleast 1 Lower case character, Atleast 1 Upper case character, Atleast 1 numeric character, Atleast 1 special character ( ~, `, !, @, #, $, %, ^, &, *, -, _, =, +, {, }, [, ], |, \, :, <, >, /, ., ,, “ “). Exclude list in case of enablelocal is - NS_FIPS, NS_CRL, NS_RSAKEY, NS_PKCS12, NS_PKCS8, NS_LDAP, NS_TACACS, NS_TACACSACTION, NS_RADIUS, NS_RADIUSACTION, NS_ENCRYPTION_PARAMS. So no Strong Password checks will be performed on these ObjectType commands for enablelocal case.

Possible values: enableall, enablelocal, disabled Default value: disabled

restrictedtimeout Enable/Disable the restricted timeout behaviour. When enabled, timeout cannot be configured beyond admin configured timeout and also it will have the [minimum - maximum] range check. When disabled, timeout will have the old behaviour. By default the value is disabled

Possible values: ENABLED, DISABLED Default value: DISABLED

fipsUserMode Use this option to set the FIPS mode for key user-land processes. When enabled, these user-land processes will operate in FIPS mode. In this mode, these processes will use FIPS 140-2 certified crypto algorithms. With a FIPS license, it is enabled by default and cannot be disabled. Without a FIPS license, it is disabled by default, wherein these user-land processes will not operate in FIPS mode.

Possible values: ENABLED, DISABLED Default value: DISABLED

doppler Enable or disable Doppler

Possible values: ENABLED, DISABLED Default value: ENABLED

googleanalytics Enable or disable Google analytics

Possible values: ENABLED, DISABLED Default value: DISABLED

totalAuthTimeout Total time a request can take for authentication/authorization Default value: 20 Minimum value: 5 Maximum value: 120

cliLoglevel Audit log level, which specifies the types of events to log for cli executed commands. Available values function as follows:

EMERGENCY - Events that indicate an immediate crisis on the server.
ALERT - Events that might require action.
CRITICAL - Events that indicate an imminent server crisis.
ERROR - Events that indicate some type of error.
WARNING - Events that require action in the near future.
NOTICE - Events that the administrator should know about.
INFORMATIONAL - All but low-level events.
DEBUG - All events, in extreme detail.

Possible values: EMERGENCY, ALERT, CRITICAL, ERROR, WARNING, NOTICE, INFORMATIONAL, DEBUG Default value: INFORMATIONAL

forcePasswordChange Enable or disable force password change for nsroot user

Possible values: ENABLED, DISABLED Default value: DISABLED

basicAuth Enable or disable basic authentication for Nitro API.

Possible values: ENABLED, DISABLED Default value: ENABLED

reauthOnAuthParamChange Enable or disable External user reauthentication when authentication parameter changes

Possible values: ENABLED, DISABLED Default value: DISABLED

removeSensitiveFiles Use this option to remove the sensitive files from the system like authorise keys, public keys etc. The commands which will remove sensitive files when this system paramter is enabled are rm cluster instance, rm cluster node, rm ha node, clear config full, join cluster and add cluster instance.

Possible values: ENABLED, DISABLED Default value: DISABLED

maxsessionperuser Maximum number of client connection allowed per user.The maxsessionperuser value ranges from 1 to 40 Minimum value: 1 Maximum value: 40

daystoexpire nsroot password expire days Minimum value: 30 Maximum value: 500

warnpriorndays Number of days before which password expiration warning would be thrown with respect to datstoexpire Minimum value: 5 Maximum value: 40

show system parameter

Displays information about the system parameters.

Synopsis

show system parameter

Arguments

Output

rbaOnResponse Enable or disable Role-Based Authentication (RBA) on responses.

promptString The global system prompt.

natPcbForceFlushLimit Flush the system if the number of Network Address Translation Protocol Control Blocks (NATPCBs) exceeds this value.

natPcbRstOnTimeout Send RST to client and server connections when the natpcbs timeout.This avoids the buildup of idle TCP connections on the both the sides.

maxClient Maximum number of client connection allowed by the system

strongpassword After enabling strong password (enableall / enablelocal - not included in exclude list), all the passwords / sensitive information must have - Atleast 1 Lower case character, Atleast 1 Upper case character, Atleast 1 numeric character, Atleast 1 special character ( ~, `, !, @, #, $, %, ^, &, *, -, _, =, +, {, }, [, ], |, \, :, <, >, /, ., ,, " "). Exclude list in case of enablelocal is - NS_FIPS, NS_CRL, NS_RSAKEY, NS_PKCS12, NS_PKCS8, NS_LDAP, NS_TACACS, NS_TACACSACTION, NS_RADIUS, NS_RADIUSACTION, NS_ENCRYPTION_PARAMS. So no Strong Password checks will be performed on these ObjectType commands for enablelocal case.

doppler Enable or disable Doppler

googleanalytics Enable or disable Google analytics

cliLoglevel Audit log level, which specifies the types of events to log for cli executed commands. Available values function as follows:

EMERGENCY - Events that indicate an immediate crisis on the server.
ALERT - Events that might require action.
CRITICAL - Events that indicate an imminent server crisis.
ERROR - Events that indicate some type of error.
WARNING - Events that require action in the near future.
NOTICE - Events that the administrator should know about.
INFORMATIONAL - All but low-level events.
DEBUG - All events, in extreme detail.

forcePasswordChange Enable or disable force password change for nsroot user

totalAuthTimeout Total time a request can take for authentication/authorization

basicAuth Enable or disable basic authentication for Nitro API.

allowDefaultPartition Enable/Disable the allowing partition users to access default partition

reauthOnAuthParamChange Enable or disable External user reauthentication when authentication parameter changes

maxsessionperuser Maximum number of client connection allowed per user.The maxsessionperuser value ranges from 1 to 40

daystoexpire nsroot password expire days

warnpriorndays Number of days before which password expiration warning would be thrown with respect to datstoexpire

unset system parameter

Resets the specified system parameters..Refer to the set system parameter command for meanings of the arguments.

Synopsis

unset system parameter [-minpasswordlen] [-rbaOnResponse] [-promptString] [-natPcbForceFlushLimit] [-natPcbRstOnTimeout] [-timeout] [-localAuth] [-strongpassword] [-restrictedtimeout] [-fipsUserMode] [-doppler] [-googleanalytics] [-totalAuthTimeout] [-cliLoglevel] [-forcePasswordChange] [-basicAuth] [-reauthOnAuthParamChange] [-removeSensitiveFiles] [-maxsessionperuser] [-daystoexpire] [-warnpriorndays]

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

system-parameter

May 28, 2024

Contributed by:

May 28, 2024

Contributed by:

system-parameter

set system parameter

Synopsis

Arguments

show system parameter

Synopsis

Arguments

Output

unset system parameter

Synopsis

In this article