Invoke ADCAddBotprofileratelimitbinding - j81blog/J81.ADCToolkit GitHub Wiki
Add Bot configuration Object.
Invoke-ADCAddBotprofileratelimitbinding [-Name] <String> [[-Bot_ratelimit] <Boolean>]
[[-Bot_rate_limit_type] <String>] [[-Bot_rate_limit_url] <String>] [[-Cookiename] <String>] [[-Rate] <Double>]
[[-Timeslice] <Double>] [[-Bot_rate_limit_action] <String[]>] [[-Bot_rate_limit_enabled] <String>]
[[-Logmessage] <String>] [[-Bot_bind_comment] <String>] [-PassThru] [-WhatIf] [-Confirm] [<CommonParameters>]
Binding object showing the ratelimit that can be bound to botprofile.
Invoke-ADCAddBotprofileratelimitbinding -name <string>
An example how to add botprofile_ratelimit_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: FalseRate-limit binding. Maximum 30 bindings can be configured per profile for rate-limit detection. For SOURCE_IP type, only one binding can be configured, and for URL type, only one binding is allowed per URL, and for SESSION type, only one binding is allowed for a cookie name. 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: FalseRate-limiting type Following rate-limiting types are allowed: *SOURCE_IP - Rate-limiting based on the client IP. *SESSION - Rate-limiting based on the configured cookie name. *URL - Rate-limiting based on the configured URL. Possible values = SESSION, SOURCE_IP, URL
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 4
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseURL for the resource based rate-limiting.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 5
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseCookie name which is used to identify the session for session rate-limiting.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 6
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseMaximum number of requests that are allowed in this session in the given period time.
Type: Double
Parameter Sets: (All)
Aliases:
Required: False
Position: 7
Default value: 1
Accept pipeline input: False
Accept wildcard characters: FalseTime interval during which requests are tracked to check if they cross the given rate.
Type: Double
Parameter Sets: (All)
Aliases:
Required: False
Position: 8
Default value: 1000
Accept pipeline input: False
Accept wildcard characters: FalseOne or more actions to be taken when the current rate becomes more than the configured rate. Only LOG action can be combined with DROP, REDIRECT or RESET action. Possible values = NONE, LOG, DROP, REDIRECT, RESET
Type: String[]
Parameter Sets: (All)
Aliases:
Required: False
Position: 9
Default value: NONE
Accept pipeline input: False
Accept wildcard characters: FalseEnable or disable rate-limit binding. Possible values = ON, OFF
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 10
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: 11
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseAny comments about this binding.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 12
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseReturn details about the created botprofile_ratelimit_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-ADCAddBotprofileratelimitbinding Version : v2111.2521 Author : John Billekens Reference : https://developer-docs.citrix.com/projects/citrix-adc-nitro-api-reference/en/latest/configuration/bot/botprofile_ratelimit_binding/ Requires : PowerShell v5.1 and up ADC 13.x and up. ADC 12 and lower may work, not guaranteed.