Invoke ADCUpdateBotsettings - j81blog/J81.ADCToolkit GitHub Wiki

Invoke-ADCUpdateBotsettings

SYNOPSIS

Update Bot configuration Object.

SYNTAX

Invoke-ADCUpdateBotsettings [[-Defaultprofile] <String>] [[-Javascriptname] <String>]
 [[-Sessiontimeout] <Double>] [[-Sessioncookiename] <String>] [[-Dfprequestlimit] <Double>]
 [[-Signatureautoupdate] <String>] [[-Signatureurl] <String>] [[-Proxyserver] <String>] [[-Proxyport] <Int32>]
 [[-Trapurlautogenerate] <String>] [[-Trapurlinterval] <Double>] [[-Trapurllength] <Double>] [-WhatIf]
 [-Confirm] [<CommonParameters>]

DESCRIPTION

Configuration for Bot engine settings resource.

EXAMPLES

EXAMPLE 1

Invoke-ADCUpdateBotsettings

An example how to update botsettings configuration Object(s).

PARAMETERS

-Defaultprofile

Profile to use when a connection does not match any policy. Default setting is " ", which sends unmatched connections back to the Citrix ADC without attempting to filter them further.

Type: String
Parameter Sets: (All)
Aliases:

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

-Javascriptname

Name of the JavaScript that the Bot Management feature uses in response. Must begin with a letter or number, and can consist of from 1 to 31 letters, numbers, and the hyphen (-) and underscore (_) symbols.

Type: String
Parameter Sets: (All)
Aliases:

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

-Sessiontimeout

Timeout, in seconds, after which a user session is terminated.

Type: Double
Parameter Sets: (All)
Aliases:

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

-Sessioncookiename

Name of the SessionCookie that the Bot Management feature uses for tracking. Must begin with a letter or number, and can consist of from 1 to 31 letters, numbers, and the hyphen (-) and underscore (_) symbols.

Type: String
Parameter Sets: (All)
Aliases:

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

-Dfprequestlimit

Number of requests to allow without bot session cookie if device fingerprint is enabled.

Type: Double
Parameter Sets: (All)
Aliases:

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

-Signatureautoupdate

Flag used to enable/disable bot auto update signatures. Possible values = ON, OFF

Type: String
Parameter Sets: (All)
Aliases:

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

-Signatureurl

URL to download the bot signature mapping file from server.

Type: String
Parameter Sets: (All)
Aliases:

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

-Proxyserver

Proxy Server IP to get updated signatures from AWS.

Type: String
Parameter Sets: (All)
Aliases:

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

-Proxyport

Proxy Server Port to get updated signatures from AWS.

  • in CLI is represented as 65535 in NITRO API
Type: Int32
Parameter Sets: (All)
Aliases:

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

-Trapurlautogenerate

Enable/disable trap URL auto generation. When enabled, trap URL is updated within the configured interval. Possible values = ON, OFF

Type: String
Parameter Sets: (All)
Aliases:

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

-Trapurlinterval

Time in seconds after which trap URL is updated.

Type: Double
Parameter Sets: (All)
Aliases:

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

-Trapurllength

Length of the auto-generated trap URL.

Type: Double
Parameter Sets: (All)
Aliases:

Required: False
Position: 13
Default value: 0
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-ADCUpdateBotsettings Version : v2111.2521 Author : John Billekens Reference : https://developer-docs.citrix.com/projects/citrix-adc-nitro-api-reference/en/latest/configuration/bot/botsettings/ 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** ⚠️