-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
systemparameter
-
-
-
-
videooptimizationdetectionpolicylabel_videooptimizationdetectionpolicy_binding
-
videooptimizationdetectionpolicy_videooptimizationglobaldetection_binding
-
videooptimizationglobaldetection_videooptimizationdetectionpolicy_binding
-
videooptimizationglobalpacing_videooptimizationpacingpolicy_binding
-
videooptimizationpacingpolicylabel_videooptimizationpacingpolicy_binding
-
videooptimizationpacingpolicy_videooptimizationglobalpacing_binding
-
This content has been machine translated dynamically.
Dieser Inhalt ist eine maschinelle Übersetzung, die dynamisch erstellt wurde. (Haftungsausschluss)
Cet article a été traduit automatiquement de manière dynamique. (Clause de non responsabilité)
Este artículo lo ha traducido una máquina de forma dinámica. (Aviso legal)
此内容已经过机器动态翻译。 放弃
このコンテンツは動的に機械翻訳されています。免責事項
이 콘텐츠는 동적으로 기계 번역되었습니다. 책임 부인
Este texto foi traduzido automaticamente. (Aviso legal)
Questo contenuto è stato tradotto dinamicamente con traduzione automatica.(Esclusione di responsabilità))
This article has been machine translated.
Dieser Artikel wurde maschinell übersetzt. (Haftungsausschluss)
Ce article a été traduit automatiquement. (Clause de non responsabilité)
Este artículo ha sido traducido automáticamente. (Aviso legal)
この記事は機械翻訳されています.免責事項
이 기사는 기계 번역되었습니다.책임 부인
Este artigo foi traduzido automaticamente.(Aviso legal)
这篇文章已经过机器翻译.放弃
Questo articolo è stato tradotto automaticamente.(Esclusione di responsabilità))
Translation failed!
systemparameter
Configuration for system parameter resource.
Properties
(click to see Operations )
Name | Data Type | Permissions | Description |
---|---|---|---|
rbaonresponse |
|
Read-write | Enable or disable Role-Based Authentication (RBA) on responses.
Default value: ENABLED Possible values = ENABLED, DISABLED |
promptstring |
|
Read-write | 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
|
natpcbforceflushlimit |
|
Read-write | Flush the system if the number of Network Address Translation Protocol Control Blocks (NATPCBs) exceeds this value.
Default value: 2147483647 Minimum value = 1000 |
natpcbrstontimeout |
|
Read-write | 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.
Default value: DISABLED Possible values = ENABLED, DISABLED |
timeout |
|
Read-write | 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 |
|
Read-write | 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.
Default value: ENABLED Possible values = ENABLED, DISABLED |
minpasswordlen |
|
Read-write | 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 |
|
Read-write | 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.
Default value: disabled Possible values = enableall, enablelocal, disabled |
restrictedtimeout |
|
Read-write | 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.
Default value: DISABLED Possible values = ENABLED, DISABLED |
fipsusermode |
|
Read-write | 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. Default value: DISABLED Possible values = ENABLED, DISABLED |
doppler |
|
Read-write | Enable or disable Doppler.
Default value: ENABLED Possible values = ENABLED, DISABLED |
googleanalytics |
|
Read-write | Enable or disable Google analytics.
Default value: DISABLED Possible values = ENABLED, DISABLED |
totalauthtimeout |
|
Read-write | Total time a request can take for authentication/authorization.
Default value: 20 Minimum value = 5 Maximum value = 120 |
cliloglevel |
|
Read-write | Audit log level, which specifies the types of events to log for cli executed commands.
Available values function as follows
|
forcepasswordchange |
|
Read-write | Enable or disable force password change for nsroot user.
Default value: DISABLED Possible values = ENABLED, DISABLED |
basicauth |
|
Read-write | Enable or disable basic authentication for Nitro API.
Default value: ENABLED Possible values = ENABLED, DISABLED |
reauthonauthparamchange |
|
Read-write | Enable or disable External user reauthentication when authentication parameter changes.
Default value: DISABLED Possible values = ENABLED, DISABLED |
removesensitivefiles |
|
Read-write | 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.
Default value: DISABLED Possible values = ENABLED, DISABLED |
maxsessionperuser |
|
Read-write | Maximum number of client connection allowed per user.The maxsessionperuser value ranges from 1 to 40.
Minimum value = 1 Maximum value = 40 |
daystoexpire |
|
Read-write | nsroot password expire days.
Minimum value = 30 Maximum value = 500 |
warnpriorndays |
|
Read-write | Number of days before which password expiration warning would be thrown with respect to datstoexpire.
Minimum value = 5 Maximum value = 40 |
maxclient |
|
Read-only | Maximum number of client connection allowed by the system.
Minimum value = 10 Maximum value = 40 |
allowdefaultpartition |
|
Read-only | Enable/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 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/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>,
"maxsessionperuser":<Double_value>,
"daystoexpire":<Double_value>,
"warnpriorndays":<Double_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/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,
"maxsessionperuser":true,
"daystoexpire":true,
"warnpriorndays":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/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 NetScaler-specific errors). The response payload provides details of the error
Response Header:
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>,
"maxsessionperuser":<Double_value>,
"daystoexpire":<Double_value>,
"warnpriorndays":<Double_value>
}]}
<!--NeedCopy-->
Share
Share
In this article
This Preview product documentation is Citrix Confidential.
You agree to hold this documentation confidential pursuant to the terms of your Citrix Beta/Tech Preview Agreement.
The development, release and timing of any features or functionality described in the Preview documentation remains at our sole discretion and are subject to change without notice or consultation.
The documentation is for informational purposes only and is not a commitment, promise or legal obligation to deliver any material, code or functionality and should not be relied upon in making Citrix product purchase decisions.
If you do not agree, select I DO NOT AGREE to exit.