| getsystemparameterResult Structure Definition |
The getsystemparameterResult structure defines the return type for getsystemparameter 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. |
systemparameterList |
List of systemparameters |
| systemparameter Structure Definition |
The systemparameter structure defines the actual return type values for getsystemparameter API. |
Syntax |
Members |
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. |
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. |
maxclient |
Maximum number of client connection allowed by the system |
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 |
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. |
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 methods for enablelocal case. |
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 |
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. |
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 methods.
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 |
removesensitivefiles |
Use this option to remove the sensitive files from the system like authorise keys, public keys etc. The methods 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. |
maxsessionperuser |
Maximum number of client connection allowed per user.The maxsessionperuser value ranges from 1 to 40 |
wafprotection |
Configure WAF protection for endpoints used by NetScaler management interfaces. The available options are:
* DEFAULT - NetScaler decides which endpoints have WAF protection enabled.
* GUI - Endpoints used by the Management GUI Interface are WAF protected.
* DISABLED - WAF protection is disabled. |
denylist |
Enable or disable denylist protection. The available options are:
* ON - Denylist feature is enabled.
* OFF - Denylist feature is disabled. |
denylistlogging |
Enable or disable denylist protection logging. The available options are:
* ON - Denylist logging is enabled.
* OFF - Denylist logging is disabled. |
passwordhistorycontrol |
Enables or disable password expiry feature for system users.
If the feature is ENABLED, by default the last 6 passwords of users will be maintained and will not be allowed to reuse same.
When the feature is enabled the daystoexpire, warnpriorndays and pwdhistoryCount will be set with default values. The values can only be set in system
for system parameter. It cannot be unset. It is possible to set and unset the values for daytoexpire and warnpriorndays in system groups.
Default values if feature is ENABLED:
daystoexpire: 30
warnpriorndays: 5
pwdhistoryCount: 6
If the feature is DISABLED the values cannot be set or unset in system parameter and system groups |
daystoexpire |
Password expiry days for all the system users. The daystoexpire value ranges from 30 to 255. |
warnpriorndays |
Number of days before which password expiration warning would be thrown with respect to daystoexpire. The warnpriorndays value ranges from 5 to 40. |
pwdhistorycount |
Number of passwords to be maintained as history for system users. The pwdhistorycount value ranges from 1 to 10. |
_nextgenapiresource |
See Also |