Bot

bot management.

Configuration APIs


Use this method to creates a bot policy.


Use this method to creates a user-defined bot policy label, to which you can bind policies.
A policy label is a tool for evaluating a set of policies in a specified order. By using a policy label, you can configure the responder feature to choose the next policy, invoke a different policy label, or terminate policy evaluation completely by looking at whether the previous policy evaluated to TRUE or FALSE.


Use this method to creates bot profile, which has configuration options for bot management. (A profile is equivalent to an action in other Citrix ADC features.)


Use this method to bind policy to bot global.


Use this method to bind policy to bot policylabel.


Use this method to bind blacklist to bot profile.


Use this method to bind captcharesource to bot profile.


Use this method to bind comment to bot profile.


Use this method to bind ipreputation to bot profile.


Use this method to bind kmdetectionexpr to bot profile.


Use this method to bind logexpression to bot profile.


Use this method to bind logmessage to bot profile.


Use this method to bind ratelimit to bot profile.


Use this method to bind tps to bot profile.


Use this method to bind trapinsertionurl to bot profile.


Use this method to bind whitelist to bot profile.


Use this method to get the list of policies bound to the specified bot global bind point.


Use this method to get the current settings for the specified bot policy.


Use this method to get the current settings for the specified bot policy label.


Use this method to get details of the specified bot profile. If no profile is specified, displays a list of all bot profiles on the Citrix ADC.


Use this method to get the current Bot Management global settings.


Use this method to get the specified signature object. If no signature object is specified, lists all bot signature objects on the Citrix ADC.


Use this method to imports the specified Signature page to the Citrix ADC, assigns it the specified name, and stores it in the list of BOT signature objects.


Use this method to renames the specified bot policy.


Use this method to renames the specified bot policy label.


Use this method to removes the specified bot policy.


Use this method to removes a bot policy label.


Use this method to removes the specified bot management profile.


Use this method to removes the specified signature object.


Use this method to set any type of information about this bot policy.


Use this method to set name of the messagelog action to use for requests that match this policy.


Use this method to set name of the bot profile to apply if the request matches this bot policy.


Use this method to set expression that the policy uses to determine whether to apply bot profile on the specified request.


Use this method to set action to perform if the result of policy evaluation is undefined (UNDEF). An UNDEF event indicates an internal error condition.


Use this method to set add the specified flags to bot session cookies. Available settings function as follows:
* None - Do not add flags to cookies.
* HTTP Only - Add the HTTP Only flag to cookies, which prevents scripts from accessing cookies.
* Secure - Add Secure flag to cookies.
* All - Add both HTTPOnly and Secure flags to cookies.


Use this method to set enable black-list bot detection.


Use this method to set expression to get the client IP.


Use this method to set any comments about the purpose of profile, or other useful information about the profile.


Use this method to set enable device-fingerprint bot detection


Use this method to set action to be taken for device-fingerprint based bot detection.


Use this method to set enabling bot device fingerprint protection for mobile clients


Use this method to set number of requests to allow without bot session cookie if device fingerprint is enabled


Use this method to set uRL that Bot protection uses as the Error URL.


Use this method to set enable Headless Browser detection.


Use this method to set enable IP-reputation bot detection.


Use this method to set enable keyboard-mouse based bot detection.


Use this method to set size of the KM data send by the browser, needs to be processed on ADC


Use this method to set 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.

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 javascript file name" or 'my javascript file name').


Use this method to set enable rate-limit bot detection.


Use this method to set 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').


Use this method to set timeout, in seconds, after which a user session is terminated.


Use this method to set name of object containing bot static signature details.


Use this method to set 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


Use this method to set actions to be taken if no User-Agent header in the request (Applicable if Signature check is enabled).


Use this method to set actions to be taken on a spoofed request (A request spoofing good bot user agent string).


Use this method to set enable TPS.


Use this method to set enable trap bot detection.


Use this method to set action to be taken for bot trap based bot detection.


Use this method to set uRL that Bot protection uses as the Trap URL.


Use this method to set bot verbose Logging. Based on the log level, ADC will log additional information whenever client is detected as a bot.


Use this method to set enable white-list bot detection.


Use this method to set profile to use when the feature is not enabled but feature is licensed. NonIntrusive checks will be disabled and IPRep cronjob(24 Hours) will be removed if this is set to BOT_BYPASS.


Use this method to set 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.


Use this method to set number of requests to allow without bot session cookie if device fingerprint is enabled


Use this method to set 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').


Use this method to set proxy Server Port to get updated signatures from AWS.


Use this method to set proxy Server IP to get updated signatures from AWS.


Use this method to set proxy Username


Use this method to set 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').


Use this method to set timeout, in seconds, after which a user session is terminated.


Use this method to set flag used to enable/disable bot auto update signatures


Use this method to set uRL to download the bot signature mapping file from server


Use this method to set enable/disable trap URL auto generation. When enabled, trap URL is updated within the configured interval.


Use this method to set time in seconds after which trap URL is updated.


Use this method to set length of the auto-generated trap URL.


Use this method to unbind policy from bot global.


Use this method to unbind policy from bot policylabel.


Use this method to unbind priority from bot policylabel.


Use this method to unbind blacklist from bot profile.


Use this method to unbind captcharesource from bot profile.


Use this method to unbind ipreputation from bot profile.


Use this method to unbind kmdetectionexpr from bot profile.


Use this method to unbind logexpression from bot profile.


Use this method to unbind ratelimit from bot profile.


Use this method to unbind tps from bot profile.


Use this method to unbind trapinsertionurl from bot profile.


Use this method to unbind whitelist from bot profile.


Remove bot policy comment setting.


Remove bot policy logaction setting.


Remove bot policy undefaction setting.


Remove bot profile addcookieflags setting.


Remove bot profile blacklist setting.


Remove bot profile clientipexpression setting.


Remove bot profile comment setting.


Remove bot profile devicefingerprint setting.


Remove bot profile devicefingerprintaction setting.


Remove bot profile devicefingerprintmobile setting.


Remove bot profile dfprequestlimit setting.


Remove bot profile errorurl setting.


Remove bot profile headlessbrowserdetection setting.


Remove bot profile ipreputation setting.


Remove bot profile kmdetection setting.


Remove bot profile kmeventspostbodylimit setting.


Remove bot profile kmjavascript setting.


Remove bot profile ratelimit setting.


Remove bot profile sessioncookie setting.


Remove bot profile sessiontimeout setting.


Remove bot profile signature setting.


Remove bot profile signaturemultipleuseragentheaderaction setting.


Remove bot profile signaturenouseragentheaderaction setting.


Remove bot profile spoofedreqaction setting.


Remove bot profile tps setting.


Remove bot profile trap setting.


Remove bot profile trapaction setting.


Remove bot profile trapurl setting.


Remove bot profile verboseloglevel setting.


Remove bot profile whitelist setting.


Remove bot settings defaultnonintrusiveprofile setting.


Remove bot settings defaultprofile setting.


Remove bot settings dfprequestlimit setting.


Remove bot settings javascript setting.


Remove bot settings proxypassword setting.


Remove bot settings proxyport setting.


Remove bot settings proxyserver setting.


Remove bot settings proxyuser setting.


Remove bot settings sessioncookie setting.


Remove bot settings sessiontimeout setting.


Remove bot settings signatureautoupdate setting.


Remove bot settings signatureurl setting.


Remove bot settings trapurlautogenerate setting.


Remove bot settings trapurlinterval setting.


Remove bot settings trapurllength setting.


Use this method to updates the specified signature object from the source.