| getnslimitidentifierResult Structure Definition |
The getnslimitidentifierResult structure defines the return type for getnslimitidentifier API. |
Syntax |
Members |
rc |
If the method succeeds, rc is 0 else rc > 0. Values above 0x8000 indicate Warnings. |
message |
If the method succeeds, message is NULL else message contains Error/Warning message. |
nslimitidentifierList |
List of nslimitidentifiers |
| nslimitidentifier Structure Definition |
The nslimitidentifier structure defines the actual return type values for getnslimitidentifier API. |
Syntax |
Members |
limitidentifier |
Name of the rate limit identifier about which to display information. |
ngname |
Nodegroup name to which this identifier belongs to. |
threshold |
Maximum number of requests that are allowed in the given timeslice when requests (mode is set as REQUEST_RATE) are tracked per timeslice.
When connections (mode is set as CONNECTION) are tracked, it is the total number of connections that would be let through. |
timeslice |
Defines the time interval in msecs specified in multiples of 10 msec during which the requests are tracked to see if they cross the threshold. It is used and displayed only when the mode is REQUEST_RATE while tracking request rate and for defining the trap timeslice. |
mode |
Defines the type of traffic to be tracked.
* REQUEST_RATE - Tracks requests/timeslice.
* CONNECTION - Tracks active transactions.
Examples
1. To permit 20 requests in 10 ms and 2 traps in 10 ms:
add limitidentifier limit_req -mode request_rate -limitType smooth -timeslice 1000 -Threshold 2000 -trapsInTimeSlice 200
2. To permit 50 requests in 10 ms:
set limitidentifier limit_req -mode request_rate -timeslice 1000 -Threshold 5000 -limitType smooth
3. To permit 1 request in 40 ms:
set limitidentifier limit_req -mode request_rate -timeslice 2000 -Threshold 50 -limitType smooth
4. To permit 1 request in 200 ms and 1 trap in 130 ms:
set limitidentifier limit_req -mode request_rate -timeslice 1000 -Threshold 5 -limitType smooth -trapsInTimeSlice 8
5. To permit 5000 requests in 1000 ms and 200 traps in 1000 ms:
set limitidentifier limit_req -mode request_rate -timeslice 1000 -Threshold 5000 -limitType BURSTY |
limittype |
Smooth or bursty request type.
* SMOOTH - When you want the permitted number of requests in a given interval of time to be spread evenly across the timeslice
* BURSTY - When you want the permitted number of requests to exhaust the quota anytime within the timeslice.
This argument is needed only when the mode is set to REQUEST_RATE. |
selectorname |
Name of the rate limit selector. If this argument is NULL, rate limiting will be applied on all traffic received by the virtual server or the Citrix ADC (depending on whether the limit identifier is bound to a virtual server or globally) without any filtering. |
hits |
The number of times this identifier was evaluated. |
drop |
The number of times action was taken. |
rule |
Rule. |
time |
Time interval considered for rate limiting |
total |
Maximum number of requests permitted in the computed timeslice |
maxbandwidth |
The maximum bandwidth in kbps permitted |
trapsintimeslice |
The maximum bandwidth permitted in kbps |
trapscomputedintimeslice |
The number of traps that would be sent in the timeslice configured. |
computedtraptimeslice |
The time interval computed for sending traps. |
referencecount |
Total number of transactions pointing to this entry. |
_nextgenapiresource |
See Also |