Invoke ADCAddBotprofiletpsbinding - j81blog/J81.ADCToolkit GitHub Wiki

Invoke-ADCAddBotprofiletpsbinding

SYNOPSIS

Add Bot configuration Object.

SYNTAX

Invoke-ADCAddBotprofiletpsbinding [-Name] <String> [[-Bot_tps] <Boolean>] [[-Bot_tps_type] <String>]
 [[-Threshold] <Double>] [[-Percentage] <Double>] [[-Bot_tps_action] <String[]>] [[-Bot_tps_enabled] <String>]
 [[-Logmessage] <String>] [[-Bot_bind_comment] <String>] [-PassThru] [-WhatIf] [-Confirm] [<CommonParameters>]

DESCRIPTION

Binding object showing the tps that can be bound to botprofile.

EXAMPLES

EXAMPLE 1

Invoke-ADCAddBotprofiletpsbinding -name <string>

An example how to add botprofile_tps_binding 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: True
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Bot_tps

TPS binding. For each type only binding can be configured. To update the values of an existing binding, user has to first unbind that binding, and then needs to bind again with new values.

Type: Boolean
Parameter Sets: (All)
Aliases:

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

-Bot_tps_type

Type of TPS binding. Possible values = SOURCE_IP, GEOLOCATION, REQUEST_URL, Host

Type: String
Parameter Sets: (All)
Aliases:

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

-Threshold

Maximum number of requests that are allowed from (or to) a IP, Geolocation, URL or Host in 1 second time interval.

Type: Double
Parameter Sets: (All)
Aliases:

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

-Percentage

Maximum percentage increase in the requests from (or to) a IP, Geolocation, URL or Host in 30 minutes interval.

Type: Double
Parameter Sets: (All)
Aliases:

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

-Bot_tps_action

One to more actions to be taken if bot is detected based on this TPS binding. Only LOG action can be combined with DROP, RESET, REDIRECT, or MITIGIATION action. Possible values = NONE, LOG, DROP, REDIRECT, RESET, MITIGATION

Type: String[]
Parameter Sets: (All)
Aliases:

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

-Bot_tps_enabled

Enabled or disabled TPS binding. Possible values = ON, OFF

Type: String
Parameter Sets: (All)
Aliases:

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

-Logmessage

Message to be logged for this binding.

Type: String
Parameter Sets: (All)
Aliases:

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

-Bot_bind_comment

Any comments about this binding.

Type: String
Parameter Sets: (All)
Aliases:

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

-PassThru

Return details about the created botprofile_tps_binding item.

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

NOTES

File Name : Invoke-ADCAddBotprofiletpsbinding Version : v2111.2521 Author : John Billekens Reference : https://developer-docs.citrix.com/projects/citrix-adc-nitro-api-reference/en/latest/configuration/bot/botprofile_tps_binding/ 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** ⚠️