Invoke ADCAddBotprofile - j81blog/J81.ADCToolkit GitHub Wiki
Add Bot configuration Object.
Invoke-ADCAddBotprofile [-Name] <String> [[-Signature] <String>] [[-Errorurl] <String>] [[-Trapurl] <String>]
[[-Comment] <String>] [[-Bot_enable_white_list] <String>] [[-Bot_enable_black_list] <String>]
[[-Bot_enable_rate_limit] <String>] [[-Devicefingerprint] <String>] [[-Devicefingerprintaction] <String[]>]
[[-Bot_enable_ip_reputation] <String>] [[-Trap] <String>] [[-Trapaction] <String[]>]
[[-Signaturenouseragentheaderaction] <String[]>] [[-Signaturemultipleuseragentheaderaction] <String[]>]
[[-Bot_enable_tps] <String>] [[-Devicefingerprintmobile] <String[]>] [[-Clientipexpression] <String>]
[[-Kmjavascriptname] <String>] [[-Kmdetection] <String>] [[-Kmeventspostbodylimit] <Double>]
[[-Verboseloglevel] <String>] [-PassThru] [-WhatIf] [-Confirm] [<CommonParameters>]
Configuration for Bot profile resource.
Invoke-ADCAddBotprofile -name <string>
An example how to add botprofile 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: FalseName of object containing bot static signature details.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 3
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseURL that Bot protection uses as the Error URL.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 4
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseURL that Bot protection uses as the Trap URL.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 5
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseAny comments about the purpose of profile, or other useful information about the profile.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 6
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseEnable white-list bot detection. Possible values = ON, OFF
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 7
Default value: OFF
Accept pipeline input: False
Accept wildcard characters: FalseEnable black-list bot detection. Possible values = ON, OFF
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 8
Default value: OFF
Accept pipeline input: False
Accept wildcard characters: FalseEnable rate-limit bot detection. Possible values = ON, OFF
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 9
Default value: OFF
Accept pipeline input: False
Accept wildcard characters: FalseEnable device-fingerprint bot detection. Possible values = ON, OFF
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 10
Default value: OFF
Accept pipeline input: False
Accept wildcard characters: FalseAction to be taken for device-fingerprint based bot detection. Possible values = NONE, LOG, DROP, REDIRECT, RESET, MITIGATION
Type: String[]
Parameter Sets: (All)
Aliases:
Required: False
Position: 11
Default value: NONE
Accept pipeline input: False
Accept wildcard characters: FalseEnable IP-reputation bot detection. Possible values = ON, OFF
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 12
Default value: OFF
Accept pipeline input: False
Accept wildcard characters: FalseEnable trap bot detection. Possible values = ON, OFF
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 13
Default value: OFF
Accept pipeline input: False
Accept wildcard characters: FalseAction to be taken for bot trap based bot detection. Possible values = NONE, LOG, DROP, REDIRECT, RESET
Type: String[]
Parameter Sets: (All)
Aliases:
Required: False
Position: 14
Default value: NONE
Accept pipeline input: False
Accept wildcard characters: FalseActions to be taken if no User-Agent header in the request (Applicable if Signature check is enabled). Possible values = NONE, LOG, DROP, REDIRECT, RESET
Type: String[]
Parameter Sets: (All)
Aliases:
Required: False
Position: 15
Default value: DROP
Accept pipeline input: False
Accept wildcard characters: FalseActions to be taken if multiple User-Agent headers are seen in a request (Applicable if Signature check is enabled). Log action should be combined with other actions. Possible values = CHECKLAST, LOG, DROP, REDIRECT, RESET
Type: String[]
Parameter Sets: (All)
Aliases:
Required: False
Position: 16
Default value: CHECKLAST
Accept pipeline input: False
Accept wildcard characters: FalseEnable TPS. Possible values = ON, OFF
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 17
Default value: OFF
Accept pipeline input: False
Accept wildcard characters: FalseEnabling bot device fingerprint protection for mobile clients. Possible values = NONE, Android, iOS
Type: String[]
Parameter Sets: (All)
Aliases:
Required: False
Position: 18
Default value: NONE
Accept pipeline input: False
Accept wildcard characters: FalseExpression to get the client IP.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 19
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseName of the JavaScript file that the Bot Management feature will insert in the response for keyboard-mouse based detection. Must begin with a letter, number, or the underscore character (_), and must contain only letters, numbers, and the hyphen (-), period (.) hash (#), space ( ), at (@), equals (=), colon (:), and underscore characters.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 20
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseEnable keyboard-mouse based bot detection. Possible values = ON, OFF
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 21
Default value: OFF
Accept pipeline input: False
Accept wildcard characters: FalseSize of the KM data send by the browser, needs to be processed on ADC.
Type: Double
Parameter Sets: (All)
Aliases:
Required: False
Position: 22
Default value: 0
Accept pipeline input: False
Accept wildcard characters: FalseBot verbose Logging. Based on the log level, ADC will log additional information whenever client is detected as a bot. Possible values = NONE, HTTP_FULL_HEADER
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 23
Default value: NONE
Accept pipeline input: False
Accept wildcard characters: FalseReturn details about the created botprofile 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-ADCAddBotprofile Version : v2111.2521 Author : John Billekens Reference : https://developer-docs.citrix.com/projects/citrix-adc-nitro-api-reference/en/latest/configuration/bot/botprofile/ Requires : PowerShell v5.1 and up ADC 13.x and up. ADC 12 and lower may work, not guaranteed.