Invoke-NSAddAuthenticationWebAuthAction
SYNOPSIS
Creates a NetScaler authenticationwebauthaction resource.
SYNTAX
Invoke-NSAddAuthenticationWebAuthAction [-Attribute1 <String>] [-Attribute10 <String>] [-Attribute11 <String>]
[-Attribute12 <String>] [-Attribute13 <String>] [-Attribute14 <String>] [-Attribute15 <String>]
[-Attribute16 <String>] [-Attribute2 <String>] [-Attribute3 <String>] [-Attribute4 <String>]
[-Attribute5 <String>] [-Attribute6 <String>] [-Attribute7 <String>] [-Attribute8 <String>]
[-Attribute9 <String>] [-DefaultAuthenticationGroup <String>] [-Fullreqexpr <String>] [-Name] <String>
-Scheme <String> -ServerIp <String> -ServerPort <Int32> -SuccessRule <String> [-Session <PSObject>]
[-IgnoreNotFound] [-ReturnNullOnNotFound] [-ThrowOnWarning] [-PassThru] [-WhatIf] [-Confirm]
[<CommonParameters>]
DESCRIPTION
Configuration for Web authentication action resource.
EXAMPLES
EXAMPLE 1
Invoke-NSAddAuthenticationWebAuthAction -Name 'example' -Scheme http -ServerIp 'example' -ServerPort 1 -SuccessRule 'example' -PassThru
EXAMPLE 2
Invoke-NSAddAuthenticationWebAuthAction -Name 'example' -Scheme http -ServerIp 'example' -ServerPort 1 -SuccessRule 'example' -WhatIf
PARAMETERS
-Attribute1
Expression that would be evaluated to extract attribute1 from the webauth response. Maximum length = 128
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Attribute10
Expression that would be evaluated to extract attribute10 from the webauth response. Maximum length = 128
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Attribute11
Expression that would be evaluated to extract attribute11 from the webauth response. Maximum length = 128
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Attribute12
Expression that would be evaluated to extract attribute12 from the webauth response. Maximum length = 128
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Attribute13
Expression that would be evaluated to extract attribute13 from the webauth response. Maximum length = 128
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Attribute14
Expression that would be evaluated to extract attribute14 from the webauth response. Maximum length = 128
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Attribute15
Expression that would be evaluated to extract attribute15 from the webauth response. Maximum length = 128
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Attribute16
Expression that would be evaluated to extract attribute16 from the webauth response. Maximum length = 128
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Attribute2
Expression that would be evaluated to extract attribute2 from the webauth response. Maximum length = 128
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Attribute3
Expression that would be evaluated to extract attribute3 from the webauth response. Maximum length = 128
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Attribute4
Expression that would be evaluated to extract attribute4 from the webauth response. Maximum length = 128
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Attribute5
Expression that would be evaluated to extract attribute5 from the webauth response. Maximum length = 128
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Attribute6
Expression that would be evaluated to extract attribute6 from the webauth response. Maximum length = 128
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Attribute7
Expression that would be evaluated to extract attribute7 from the webauth response. Maximum length = 128
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Attribute8
Expression that would be evaluated to extract attribute8 from the webauth response. Maximum length = 128
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Attribute9
Expression that would be evaluated to extract attribute9 from the webauth response. Maximum length = 128
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-DefaultAuthenticationGroup
This is the default group that is chosen when the authentication succeeds in addition to extracted groups.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Fullreqexpr
Exact HTTP request, in the form of an expression, which the Citrix ADC sends to the authentication server. The Citrix ADC does not check the validity of this request. One must manually validate the request.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Name
Name for the Web Authentication action. Must begin with a letter, number, or the underscore character (_), and must contain only letters, numbers, and the hyphen (-), period (.) pound (#), space ( ), at (@), equals (=), colon (:), and underscore characters. Cannot be changed after the profile is created. The following requirement applies only to the Citrix ADC CLI: If the name includes one or more spaces, enclose the name in double or single quotation marks (for example, "my authentication action" or 'my authentication action'). Minimum length = 1
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Scheme
Type of scheme for the web server. Possible values = http, https
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-ServerIp
IP address of the web server to be used for authentication. Minimum length = 1
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-ServerPort
Port on which the web server accepts connections. Minimum value = 1 Range 1 - 65535 * in CLI is represented as 65535 in NITRO API
Type: Int32
Parameter Sets: (All)
Aliases:
Required: True
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
-SuccessRule
Expression, that checks to see if authentication is successful.
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Session
The NetScaler session. If omitted, the current default session is used.
Type: PSObject
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: (Get-NSSession)
Accept pipeline input: False
Accept wildcard characters: False
-IgnoreNotFound
Returns null instead of throwing for known NITRO not-found responses.
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
-ReturnNullOnNotFound
Returns null instead of throwing for known NITRO not-found responses.
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
-ThrowOnWarning
Treats NITRO warning responses as terminating errors.
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
-PassThru
Returns the updated resource after the operation completes.
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
-WhatIf
Shows 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: False
-Confirm
Prompts 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: False
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
INPUTS
OUTPUTS
System.Management.Automation.PSCustomObject
NOTES
Generated from NetScaler NITRO API metadata. Generated: 2026-06-01 21:28 Supported metadata versions: 13.1, 14.1.