| bindbotprofile_ratelimit |
Use this method to bind ratelimit to bot profile. |
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. |
ratelimit |
Rate-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 |
Rate-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.
*GEOLOCATION - Rate-limiting based on the configured country name.
*JA3_FINGERPRINT - Rate-limiting based on client SSL JA3 fingerprint. Possible Values : SESSION, SOURCE_IP, URL, GEOLOCATION, JA3_FINGERPRINT. |
url |
URL for the resource based rate-limiting. |
cookiename |
Cookie name which is used to identify the session for session rate-limiting. |
countrycode |
Country name which is used for geolocation rate-limiting. Possible Values : AF, AX, AL, DZ, AS, AD, AO, AI, AQ, AG, AR, AM, AW, AU, AT, AZ, BS, BH, BD, BB, BY, BE, BZ, BJ, BM, BT, BO, BQ, BA, BW, BR, IO, BN, BG, BF, BI, KH, CM, CA, CV, KY, CF, TD, CL, CN, CX, CC, CO, KM, CG, CD, CK, CR, CI, HR, CU, CW, CY, CZ, DK, DJ, DM, DO, EC, EG, SV, GQ, ER, EE, ET, FK, FO, FJ, FI, FR, GF, PF, TF, GA, GM, GE, DE, GH, GI, GR, GL, GD, GP, GU, GT, GG, GN, GW, GY, HT, HM, VA, HN, HK, HU, IS, IN, ID, IR, IQ, IE, IM, IL, IT, JM, JP, JE, JO, KZ, KE, KI, XK, KW, KG, LA, LV, LB, LS, LR, LY, LI, LT, LU, MO, MK, MG, MW, MY, MV, ML, MT, MH, MQ, MR, MU, YT, MX, FM, MD, MC, MN, ME, MS, MA, MZ, MM, NA, NR, NP, NL, NC, NZ, NI, NE, NG, NU, NF, KP, MP, NO, OM, PK, PW, PS, PA, PG, PY, PE, PH, PN, PL, PT, PR, QA, RE, RO, RU, RW, BL, SH, KN, LC, MF, PM, VC, WS, SM, ST, SA, SN, RS, SC, SL, SG, SX, SK, SI, SB, SO, SZA, GS, KR, SS, ES, LK, SD, SR, SJ, SZ, SE, CH, SY, TW, TJ, TZ, TH, TL, TG, TK, TO, TT, TN, TR, TM, TC, TV, UG, UA, AE, GB, US, UM, UY, UZ, VU, VE, VN, VG, VI, WF, EH, YE, ZM, ZW. |
rate |
Maximum number of requests that are allowed in this session in the given period time. Default value = 1. Minimum value = 1. |
timeslice |
Time interval during which requests are tracked to check if they cross the given rate. Default value = 1000. Minimum value = 10. |
limittype |
Rate-Limiting traffic Type Default value = BOT_RATELIMIT_TRAFFIC_TYPE_BURSTY. Possible Values : BURSTY, SMOOTH. |
condition |
Expression to be used in a rate-limiting condition. This expression result must be a boolean value. |
actioN |
One 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, RESPOND_STATUS_TOO_MANY_REQUESTS or RESET action. Default value = BOT_ACTION_NONE. Possible Values : NONE, LOG, DROP, REDIRECT, RESET, RESPOND_STATUS_TOO_MANY_REQUESTS. |
enabled |
Enable or disable rate-limit binding. Default value = NS_OFF. Possible Values : ON, OFF. |
Return Value |
Returns simpleResult |
See Also |