Invoke ADCAddBotprofilecaptchabinding - j81blog/J81.ADCToolkit GitHub Wiki
Add Bot configuration Object.
Invoke-ADCAddBotprofilecaptchabinding [-Name] <String> [[-Captcharesource] <Boolean>]
[[-Bot_captcha_url] <String>] [[-Waittime] <Double>] [[-Graceperiod] <Double>] [[-Muteperiod] <Double>]
[[-Requestsizelimit] <Double>] [[-Retryattempts] <Double>] [[-Bot_captcha_action] <String[]>]
[[-Bot_captcha_enabled] <String>] [[-Logmessage] <String>] [[-Bot_bind_comment] <String>] [-PassThru]
[-WhatIf] [-Confirm] [<CommonParameters>]
Binding object showing the captcha that can be bound to botprofile.
Invoke-ADCAddBotprofilecaptchabinding -name <string>
An example how to add botprofile_captcha_binding configuration Object(s).
Name for the profile. 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 added.
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseCaptcha action binding. For each URL, only one binding is allowed. To update the values of an existing URL binding, user has to first unbind that binding, and then needs to bind the URL again with new values. Maximum 30 bindings can be configured per profile.
Type: Boolean
Parameter Sets: (All)
Aliases:
Required: False
Position: 3
Default value: False
Accept pipeline input: False
Accept wildcard characters: FalseURL for which the Captcha action, if configured under IP reputation, TPS or device fingerprint, need to be applied.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 4
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseWait time in seconds for which ADC needs to wait for the Captcha response. This is to avoid DOS attacks.
Type: Double
Parameter Sets: (All)
Aliases:
Required: False
Position: 5
Default value: 15
Accept pipeline input: False
Accept wildcard characters: FalseTime (in seconds) duration for which no new captcha challenge is sent after current captcha challenge has been answered successfully.
Type: Double
Parameter Sets: (All)
Aliases:
Required: False
Position: 6
Default value: 900
Accept pipeline input: False
Accept wildcard characters: FalseTime (in seconds) duration for which client which failed captcha need to wait until allowed to try again. The requests from this client are silently dropped during the mute period.
Type: Double
Parameter Sets: (All)
Aliases:
Required: False
Position: 7
Default value: 300
Accept pipeline input: False
Accept wildcard characters: FalseLength of body request (in Bytes) up to (equal or less than) which captcha challenge will be provided to client. Above this length threshold the request will be dropped. This is to avoid DOS and DDOS attacks.
Type: Double
Parameter Sets: (All)
Aliases:
Required: False
Position: 8
Default value: 8000
Accept pipeline input: False
Accept wildcard characters: FalseNumber of times client can retry solving the captcha.
Type: Double
Parameter Sets: (All)
Aliases:
Required: False
Position: 9
Default value: 3
Accept pipeline input: False
Accept wildcard characters: FalseOne or more actions to be taken when client fails captcha challenge. Only, log action can be configured with DROP, REDIRECT or RESET action. Possible values = NONE, LOG, DROP, REDIRECT, RESET
Type: String[]
Parameter Sets: (All)
Aliases:
Required: False
Position: 10
Default value: NONE
Accept pipeline input: False
Accept wildcard characters: FalseEnable or disable the captcha binding. Possible values = ON, OFF
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 11
Default value: OFF
Accept pipeline input: False
Accept wildcard characters: FalseMessage to be logged for this binding.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 12
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseAny comments about this binding.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 13
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseReturn details about the created botprofile_captcha_binding item.
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
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-ADCAddBotprofilecaptchabinding Version : v2111.2521 Author : John Billekens Reference : https://developer-docs.citrix.com/projects/citrix-adc-nitro-api-reference/en/latest/configuration/bot/botprofile_captcha_binding/ Requires : PowerShell v5.1 and up ADC 13.x and up. ADC 12 and lower may work, not guaranteed.