Invoke ADCUnsetSystemparameter - j81blog/J81.ADCToolkit GitHub Wiki
Unset System configuration Object.
Invoke-ADCUnsetSystemparameter [[-minpasswordlen] <Boolean>] [[-rbaonresponse] <Boolean>]
[[-promptstring] <Boolean>] [[-natpcbforceflushlimit] <Boolean>] [[-natpcbrstontimeout] <Boolean>]
[[-timeout] <Boolean>] [[-localauth] <Boolean>] [[-strongpassword] <Boolean>] [[-restrictedtimeout] <Boolean>]
[[-fipsusermode] <Boolean>] [[-doppler] <Boolean>] [[-googleanalytics] <Boolean>]
[[-totalauthtimeout] <Boolean>] [[-cliloglevel] <Boolean>] [[-forcepasswordchange] <Boolean>]
[[-basicauth] <Boolean>] [[-reauthonauthparamchange] <Boolean>] [[-removesensitivefiles] <Boolean>] [-WhatIf]
[-Confirm] [<CommonParameters>]
Configuration for system parameter resource.
Invoke-ADCUnsetSystemparameter
An example how to unset systemparameter configuration Object(s).
Minimum 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.
Type: Boolean
Parameter Sets: (All)
Aliases:
Required: False
Position: 2
Default value: False
Accept pipeline input: False
Accept wildcard characters: FalseEnable or disable Role-Based Authentication (RBA) on responses. Possible values = ENABLED, DISABLED
Type: Boolean
Parameter Sets: (All)
Aliases:
Required: False
Position: 3
Default value: False
Accept pipeline input: False
Accept wildcard characters: FalseString 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.
Type: Boolean
Parameter Sets: (All)
Aliases:
Required: False
Position: 4
Default value: False
Accept pipeline input: False
Accept wildcard characters: FalseFlush the system if the number of Network Address Translation Protocol Control Blocks (NATPCBs) exceeds this value.
Type: Boolean
Parameter Sets: (All)
Aliases:
Required: False
Position: 5
Default value: False
Accept pipeline input: False
Accept wildcard characters: FalseSend 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
Type: Boolean
Parameter Sets: (All)
Aliases:
Required: False
Position: 6
Default value: False
Accept pipeline input: False
Accept wildcard characters: FalseCLI 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.
Type: Boolean
Parameter Sets: (All)
Aliases:
Required: False
Position: 7
Default value: False
Accept pipeline input: False
Accept wildcard characters: FalseWhen 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
Type: Boolean
Parameter Sets: (All)
Aliases:
Required: False
Position: 8
Default value: False
Accept pipeline input: False
Accept wildcard characters: FalseAfter 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
Type: Boolean
Parameter Sets: (All)
Aliases:
Required: False
Position: 9
Default value: False
Accept pipeline input: False
Accept wildcard characters: FalseEnable/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
Type: Boolean
Parameter Sets: (All)
Aliases:
Required: False
Position: 10
Default value: False
Accept pipeline input: False
Accept wildcard characters: FalseUse 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
Type: Boolean
Parameter Sets: (All)
Aliases:
Required: False
Position: 11
Default value: False
Accept pipeline input: False
Accept wildcard characters: FalseEnable or disable Doppler. Possible values = ENABLED, DISABLED
Type: Boolean
Parameter Sets: (All)
Aliases:
Required: False
Position: 12
Default value: False
Accept pipeline input: False
Accept wildcard characters: FalseEnable or disable Google analytics. Possible values = ENABLED, DISABLED
Type: Boolean
Parameter Sets: (All)
Aliases:
Required: False
Position: 13
Default value: False
Accept pipeline input: False
Accept wildcard characters: FalseTotal time a request can take for authentication/authorization.
Type: Boolean
Parameter Sets: (All)
Aliases:
Required: False
Position: 14
Default value: False
Accept pipeline input: False
Accept wildcard characters: FalseAudit 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
Type: Boolean
Parameter Sets: (All)
Aliases:
Required: False
Position: 15
Default value: False
Accept pipeline input: False
Accept wildcard characters: FalseEnable or disable force password change for nsroot user. Possible values = ENABLED, DISABLED
Type: Boolean
Parameter Sets: (All)
Aliases:
Required: False
Position: 16
Default value: False
Accept pipeline input: False
Accept wildcard characters: FalseEnable or disable basic authentication for Nitro API. Possible values = ENABLED, DISABLED
Type: Boolean
Parameter Sets: (All)
Aliases:
Required: False
Position: 17
Default value: False
Accept pipeline input: False
Accept wildcard characters: FalseEnable or disable External user reauthentication when authentication parameter changes. Possible values = ENABLED, DISABLED
Type: Boolean
Parameter Sets: (All)
Aliases:
Required: False
Position: 18
Default value: False
Accept pipeline input: False
Accept wildcard characters: FalseUse 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
Type: Boolean
Parameter Sets: (All)
Aliases:
Required: False
Position: 19
Default value: False
Accept pipeline input: False
Accept wildcard characters: FalseShows what would happen if the cmdlet runs. The cmdlet is not run.
Type: SwitchParameter
Parameter Sets: (All)
Aliases: wi
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalsePrompts you for confirmation before running the cmdlet.
Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseThis cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
File Name : Invoke-ADCUnsetSystemparameter Version : v2111.2521 Author : John Billekens Reference : https://developer-docs.citrix.com/projects/citrix-adc-nitro-api-reference/en/latest/configuration/system/systemparameter Requires : PowerShell v5.1 and up ADC 13.x and up. ADC 12 and lower may work, not guaranteed.