Skip to content

bot-settings

The following operations can be performed on "bot-settings":

set| unset| show|

set bot settings

Modifies the global bot settings. The global settings apply to all bot profiles.

Synopsis

set bot settings [-defaultProfile ] [-javaScriptName ] [-sessionTimeout ] [-sessionCookieName ] [-dfpRequestLimit ] [-signatureAutoUpdate ( ON | OFF )] [-signatureUrl ] [-proxyServer ] [-proxyPort ] [-trapURLAutoGenerate ( ON | OFF )] [-trapURLInterval ] [-trapURLLength ]

Arguments

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. Default value: NS_S_BOT_DEFAULT_PROFILE

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.

The following requirement applies only to the Citrix ADC CLI: If the name includes one or more spaces, enclose the name in double or single quotation marks (for example, "my cookie name" or 'my cookie name'). Default value: NS_S_BOT_DEFAULT_JS_NAME

sessionTimeout Timeout, in seconds, after which a user session is terminated. Default value: NS_BOT_DEFAULT_SESSION_TIMEOUT Minimum value: 1 Maximum value: 65535

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.

The following requirement applies only to the Citrix ADC CLI: If the name includes one or more spaces, enclose the name in double or single quotation marks (for example, "my cookie name" or 'my cookie name'). Default value: NS_S_BOT_DEFAULT_SESSION_CKI_NAME

dfpRequestLimit Number of requests to allow without bot session cookie if device fingerprint is enabled Default value: NS_BOT_DEFAULT_DFP_REQUEST_LIMIT Minimum value: 1

signatureAutoUpdate Flag used to enable/disable bot auto update signatures

Possible values: ON, OFF Default value: OFF

signatureUrl URL to download the bot signature mapping file from server Default value: https://nsbotsignatures.s3.amazonaws.com/BotSignatureMapping.json

proxyServer Proxy Server IP to get updated signatures from AWS.

proxyPort Proxy Server Port to get updated signatures from AWS. Default value: 8080

trapURLAutoGenerate Enable/disable trap URL auto generation. When enabled, trap URL is updated within the configured interval.

Possible values: ON, OFF Default value: OFF

trapURLInterval Time in seconds after which trap URL is updated. Default value: 3600 Minimum value: 300 Maximum value: 86400

trapURLLength Length of the auto-generated trap URL. Default value: 32 Minimum value: 10 Maximum value: 255

unset bot settings

Use this command to remove bot settings settings.Refer to the set bot settings command for meanings of the arguments.

Synopsis

unset bot settings [-defaultProfile] [-javaScriptName] [-sessionTimeout] [-sessionCookieName] [-dfpRequestLimit] [-signatureAutoUpdate] [-signatureUrl] [-proxyServer] [-proxyPort] [-trapURLAutoGenerate] [-trapURLInterval] [-trapURLLength]

show bot settings

Displays the current Bot Management global settings.

Synopsis

show bot settings

Arguments

Output

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.

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.

The following requirement applies only to the Citrix ADC CLI: If the name includes one or more spaces, enclose the name in double or single quotation marks (for example, "my cookie name" or 'my cookie name').

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

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.

The following requirement applies only to the Citrix ADC CLI: If the name includes one or more spaces, enclose the name in double or single quotation marks (for example, "my cookie name" or 'my cookie name').

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

signatureAutoUpdate Flag used to enable/disable bot auto update signatures

signatureUrl URL to download the bot signature mapping file from server

proxyServer Proxy Server IP to get updated signatures from AWS.

proxyPort Proxy Server Port to get updated signatures from AWS.

trapURLAutoGenerate Enable/disable trap URL auto generation. When enabled, trap URL is updated within the configured interval.

trapURLInterval Time in seconds after which trap URL is updated.

trapURLLength Length of the auto-generated trap URL.

builtin Flag to determine if bot engine setting is built-in or not

feature The feature to be checked while applying this config

Was this article helpful?