Invoke ADCUnsetBotprofile - j81blog/J81.ADCToolkit GitHub Wiki

Invoke-ADCUnsetBotprofile

SYNOPSIS

Unset Bot configuration Object.

SYNTAX

Invoke-ADCUnsetBotprofile [[-Name] <String>] [[-signature] <Boolean>] [[-errorurl] <Boolean>]
 [[-trapurl] <Boolean>] [[-comment] <Boolean>] [[-bot_enable_white_list] <Boolean>]
 [[-bot_enable_black_list] <Boolean>] [[-bot_enable_rate_limit] <Boolean>] [[-devicefingerprint] <Boolean>]
 [[-devicefingerprintaction] <Boolean>] [[-bot_enable_ip_reputation] <Boolean>] [[-trap] <Boolean>]
 [[-signaturenouseragentheaderaction] <Boolean>] [[-signaturemultipleuseragentheaderaction] <Boolean>]
 [[-trapaction] <Boolean>] [[-bot_enable_tps] <Boolean>] [[-devicefingerprintmobile] <Boolean>]
 [[-clientipexpression] <Boolean>] [[-kmjavascriptname] <Boolean>] [[-kmdetection] <Boolean>]
 [[-kmeventspostbodylimit] <Boolean>] [[-verboseloglevel] <Boolean>] [-WhatIf] [-Confirm] [<CommonParameters>]

DESCRIPTION

Configuration for Bot profile resource.

EXAMPLES

EXAMPLE 1

Invoke-ADCUnsetBotprofile -name <string>

An example how to unset botprofile configuration Object(s).

PARAMETERS

-Name

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: False
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-signature

Name of object containing bot static signature details.

Type: Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: 3
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-errorurl

URL that Bot protection uses as the Error URL.

Type: Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: 4
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-trapurl

URL that Bot protection uses as the Trap URL.

Type: Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: 5
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-comment

Any comments about the purpose of profile, or other useful information about the profile.

Type: Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: 6
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-bot_enable_white_list

Enable white-list bot detection. Possible values = ON, OFF

Type: Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: 7
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-bot_enable_black_list

Enable black-list bot detection. Possible values = ON, OFF

Type: Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: 8
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-bot_enable_rate_limit

Enable rate-limit bot detection. Possible values = ON, OFF

Type: Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: 9
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-devicefingerprint

Enable device-fingerprint bot detection. Possible values = ON, OFF

Type: Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: 10
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-devicefingerprintaction

Action to be taken for device-fingerprint based bot detection. Possible values = NONE, LOG, DROP, REDIRECT, RESET, MITIGATION

Type: Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: 11
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-bot_enable_ip_reputation

Enable IP-reputation bot detection. Possible values = ON, OFF

Type: Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: 12
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-trap

Enable trap bot detection. Possible values = ON, OFF

Type: Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: 13
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-signaturenouseragentheaderaction

Actions 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: Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: 14
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-signaturemultipleuseragentheaderaction

Actions 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: Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: 15
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-trapaction

Action to be taken for bot trap based bot detection. Possible values = NONE, LOG, DROP, REDIRECT, RESET

Type: Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: 16
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-bot_enable_tps

Enable TPS. Possible values = ON, OFF

Type: Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: 17
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-devicefingerprintmobile

Enabling bot device fingerprint protection for mobile clients. Possible values = NONE, Android, iOS

Type: Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: 18
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-clientipexpression

Expression to get the client IP.

Type: Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: 19
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-kmjavascriptname

Name 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: Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: 20
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-kmdetection

Enable keyboard-mouse based bot detection. Possible values = ON, OFF

Type: Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: 21
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-kmeventspostbodylimit

Size of the KM data send by the browser, needs to be processed on ADC.

Type: Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: 22
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-verboseloglevel

Bot 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: Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: 23
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

NOTES

File Name : Invoke-ADCUnsetBotprofile 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.

RELATED LINKS

https://blog.j81.nl

⚠️ **GitHub.com Fallback** ⚠️