Skip to content

systemparameter

Configuration for system parameter resource.

Properties

(click to see Operations)

NameData TypePermissionsDescription
rbaonresponse<String>Read-writeEnable or disable Role-Based Authentication (RBA) on responses.
Default value: ENABLED
Possible values = ENABLED, DISABLED
promptstring<String>Read-writeString 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.
Minimum length = 1
natpcbforceflushlimit<Double>Read-writeFlush the system if the number of Network Address Translation Protocol Control Blocks (NATPCBs) exceeds this value.
Default value: 2147483647
Minimum value = 1000
natpcbrstontimeout<String>Read-writeSend a reset signal to client and server connections when their NATPCBs time out. Avoids the buildup of idle TCP connections on both the sides.
Default value: DISABLED
Possible values = ENABLED, DISABLED
timeout<Double>Read-writeCLI 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<String>Read-writeWhen 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.
Default value: ENABLED
Possible values = ENABLED, DISABLED
minpasswordlen<Double>Read-writeMinimum length of system user password. When strong password is enabled default minimum length is 4. User entered value can be greater than or equal to 4. Default mininum value is 1 when strong password is disabled. Maximum value is 127 in both cases.
Minimum value = 1
Maximum value = 127
strongpassword<String>Read-writeAfter 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.
Default value: disabled
Possible values = enableall, enablelocal, disabled
restrictedtimeout<String>Read-writeEnable/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.
Default value: DISABLED
Possible values = ENABLED, DISABLED
fipsusermode<String>Read-writeUse 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, theses processes will use FIPS 140-2 Level-1 certified crypto algorithms. Default is disabled, wherein, these user-land processes will not operate in FIPS mode.
Default value: DISABLED
Possible values = ENABLED, DISABLED
doppler<String>Read-writeEnable or disable Doppler.
Default value: 0
Possible values = ENABLED, DISABLED
googleanalytics<String>Read-writeEnable or disable Google analytics.
Default value: DISABLED
Possible values = ENABLED, DISABLED
totalauthtimeout<Double>Read-writeTotal time a request can take for authentication/authorization.
Default value: 20
Minimum value = 5
Maximum value = 120
cliloglevel<String>Read-writeAudit 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.
Default value: INFORMATIONAL
Possible values = EMERGENCY, ALERT, CRITICAL, ERROR, WARNING, NOTICE, INFORMATIONAL, DEBUG
forcepasswordchange<String>Read-writeEnable or disable force password change for nsroot user.
Default value: DISABLED
Possible values = ENABLED, DISABLED
basicauth<String>Read-writeEnable or disable basic authentication for Nitro API.
Default value: ENABLED
Possible values = ENABLED, DISABLED
reauthonauthparamchange<String>Read-writeEnable or disable External user reauthentication when authentication parameter changes.
Default value: DISABLED
Possible values = ENABLED, DISABLED
removesensitivefiles<String>Read-writeUse 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.
Default value: DISABLED
Possible values = ENABLED, DISABLED
maxclient<Double>Read-onlyMaximum number of client connection allowed by the system.
Minimum value = 20
Maximum value = 40
allowdefaultpartition<String>Read-onlyEnable/Disable the allowing partition users to access default partition.
Default value: NO
Possible values = YES, NO

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 Citrix ADC appliance, the URL is as follows:

    http://<Citrix-ADC-IP-address(NSIP)>/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 Citrix ADC 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 redand placeholder content is marked in <green>.

update

URL:http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/systemparameter

HTTP Method:PUT

Request Headers:

Cookie:NITRO_AUTH_TOKEN=<tokenvalue> Content-Type:application/json

Request Payload:

{"systemparameter":{
"rbaonresponse":<String_value>,
"promptstring":<String_value>,
"natpcbforceflushlimit":<Double_value>,
"natpcbrstontimeout":<String_value>,
"timeout":<Double_value>,
"localauth":<String_value>,
"minpasswordlen":<Double_value>,
"strongpassword":<String_value>,
"restrictedtimeout":<String_value>,
"fipsusermode":<String_value>,
"doppler":<String_value>,
"googleanalytics":<String_value>,
"totalauthtimeout":<Double_value>,
"cliloglevel":<String_value>,
"forcepasswordchange":<String_value>,
"basicauth":<String_value>,
"reauthonauthparamchange":<String_value>,
"removesensitivefiles":<String_value>
}}

Response:

HTTP Status Code on Success: 200 OK HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for Citrix ADC specific errors). The response payload provides details of the error

unset

URL:http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/systemparameter?action=unset

HTTP Method:POST

Request Headers:

Cookie:NITRO_AUTH_TOKEN=<tokenvalue> Content-Type:application/json

Request Payload:

{"systemparameter":{
"minpasswordlen":true,
"rbaonresponse":true,
"promptstring":true,
"natpcbforceflushlimit":true,
"natpcbrstontimeout":true,
"timeout":true,
"localauth":true,
"strongpassword":true,
"restrictedtimeout":true,
"fipsusermode":true,
"doppler":true,
"googleanalytics":true,
"totalauthtimeout":true,
"cliloglevel":true,
"forcepasswordchange":true,
"basicauth":true,
"reauthonauthparamchange":true,
"removesensitivefiles":true
}}

Response:

HTTP Status Code on Success: 200 OK HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for Citrix ADC specific errors). The response payload provides details of the error

get (all)

URL:http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/systemparameter

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 Citrix ADC specific errors). The response payload provides details of the errorResponse Headers:

Content-Type:application/json

Response Payload:

{ "systemparameter": [ {
"rbaonresponse":<String_value>,
"promptstring":<String_value>,
"natpcbforceflushlimit":<Double_value>,
"natpcbrstontimeout":<String_value>,
"timeout":<Double_value>,
"maxclient":<Double_value>,
"localauth":<String_value>,
"minpasswordlen":<Double_value>,
"strongpassword":<String_value>,
"restrictedtimeout":<String_value>,
"fipsusermode":<String_value>,
"doppler":<String_value>,
"googleanalytics":<String_value>,
"cliloglevel":<String_value>,
"forcepasswordchange":<String_value>,
"totalauthtimeout":<Double_value>,
"basicauth":<String_value>,
"allowdefaultpartition":<String_value>,
"reauthonauthparamchange":<String_value>,
"removesensitivefiles":<String_value>
}]}