| addbotprofile |
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.) |
Syntax |
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.
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 profile" or 'my profile'). This is mandatory parameter. |
signature |
Name of object containing bot static signature details. |
errorurl |
URL that Bot protection uses as the Error URL. Default value = NS_S_BOT_DEFAULT_ERRORURL. |
trapurl |
URL that Bot protection uses as the Trap URL. Default value = NS_S_BOT_DEFAULT_TRAPURL. |
comment |
Any comments about the purpose of profile, or other useful information about the profile. Default value = NS_S_BOT_DEFAULT_PROFILE_COMMENTS. |
whitelist |
Enable white-list bot detection. Default value = NS_OFF. |
blacklist |
Enable black-list bot detection. Default value = NS_OFF. |
ratelimit |
Enable rate-limit bot detection. Default value = NS_OFF. |
devicefingerprint |
Enable device-fingerprint bot detection Default value = NS_OFF. |
devicefingerprintaction |
Action to be taken for device-fingerprint based bot detection. Default value = BOT_ACTION_NONE. |
ipreputation |
Enable IP-reputation bot detection. Default value = NS_OFF. |
trap |
Enable trap bot detection. Default value = NS_OFF. |
trapaction |
Action to be taken for bot trap based bot detection. Default value = BOT_ACTION_NONE. |
signaturenouseragentheaderaction |
Actions to be taken if no User-Agent header in the request (Applicable if Signature check is enabled). Default value = BOT_ACTION_DROP. |
signaturemultipleuseragentheaderaction |
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 Default value = BOT_ACTION_CHECKLAST. |
tps |
Enable TPS. Default value = NS_OFF. |
devicefingerprintmobile |
Enabling bot device fingerprint protection for mobile clients Default value = BOT_DFP_MOBILE_NONE. |
headlessbrowserdetection |
Enable Headless Browser detection. Default value = NS_OFF. |
clientipexpression |
Expression to get the client IP. |
kmjavascriptname |
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'). Default value = NS_S_BOT_DEFAULT_KM_JS_NAME. |
kmdetection |
Enable keyboard-mouse based bot detection. Default value = NS_OFF. |
kmeventspostbodylimit |
Size of the KM data send by the browser, needs to be processed on ADC Default value = NS_BOT_DEFAULT_KM_POST_BODY_LIMIT. Minimum value = 1. Maximum value = NS_BOT_MAX_KM_POST_BODY_LIMIT. |
verboseloglevel |
Bot verbose Logging. Based on the log level, ADC will log additional information whenever client is detected as a bot. Default value = BOT_VERBOSE_LOGGING_NONE. |
spoofedreqaction |
Actions to be taken on a spoofed request (A request spoofing good bot user agent string). Default value = BOT_ACTION_LOG_DROP. |
dfprequestlimit |
Number of requests to allow without bot session cookie if device fingerprint is enabled Minimum value = 1. |
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'). |
sessiontimeout |
Timeout, in seconds, after which a user session is terminated. Minimum value = 1. Maximum value = AS_MAX_INT_LEN. |
addcookieflags |
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. Default value = AS_ADD_CKI_FLAGS_HTTP_ONLY. |
Return Value |
Returns simpleResult |
See Also |