bot-profile¶
The following operations can be performed on "bot-profile":
add| set| unset| rm| show| stat|
add bot profile¶
Creates bot profile, which has configuration options for bot management. (A profile is equivalent to an action in other Citrix ADC features.)
Synopsis¶
add bot profile <name> [-signature <string>] [-errorURL <string>] [-comment <string>]
Arguments¶
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').
signature
Name of JSON config file which have static signature details.
errorURL
URL that Bot protection uses as the Error URL. Default value: NS_S_BOT_DEFAULT_ERRORURL
comment
Any comments about the purpose of profile, or other useful information about the profile. Default value: NS_S_BOT_DEFAULT_PROFILE_COMMENTS
set bot profile¶
Set the bot profile parameters
Synopsis¶
set bot profile <name> [-signature <string>] [-errorURL <string>] [-comment <string>]
Arguments¶
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').
signature
Name of JSON config file which have static signature details.
errorURL
URL that Bot protection uses as the Error URL. Default value: NS_S_BOT_DEFAULT_ERRORURL
comment
Any comments about the purpose of profile, or other useful information about the profile. Default value: NS_S_BOT_DEFAULT_PROFILE_COMMENTS
unset bot profile¶
Use this command to remove bot profile settings.Refer to the set bot profile command for meanings of the arguments.
Synopsis¶
unset bot profile <name> [-signature] [-errorURL] [-comment]
rm bot profile¶
Removes the specified botnet profile.
Synopsis¶
rm bot profile <name>
Arguments¶
name
Name of the profile.
show bot profile¶
Displays details of the specified bot profile. If no profile is specified, displays a list of all bot profiles on the Citrix ADC.
Synopsis¶
show bot profile [<name>]
Arguments¶
name
Name of the botnet profile.
Output¶
signature
Name of JSON config file which have static signature details.
errorURL
URL that Bot protection uses as the Error URL.
comment
Any comments about the purpose of profile, or other useful information about the profile.
builtin
Flag to determine if bot profille is built-in or not
feature
The feature to be checked while applying this config
devno
count
stateflag
stat bot profile¶
Displays statistics for the specified bot profile. If no profile is specified, displays abbreviated statistics for all the profiles.
Synopsis¶
stat bot profile [<name>] [-detail] [-fullValues] [-ntimes <positive_integer>] [-logFile <input_filename>] [-clearstats ( basic | full )]
Arguments¶
name
Name of the bot profile.
detail
Specifies detailed output (including more statistics). The output can be quite voluminous. Without this argument, the output will show only a summary.
fullValues
Specifies that numbers and strings should be displayed in their full form. Without this option, long strings are shortened and large numbers are abbreviated
ntimes
The number of times, in intervals of seven seconds, the statistics should be displayed. Default value: 1 Minimum value: 0
logFile
The name of the log file to be used as input.
clearstats
Clear the statsistics / counters
Possible values: basic, full
Output¶
count
devno
stateflag
Counters¶
Device Fingerprint (deviceFingerPrintProfile)
Number of device fingerprint violations seen by the Bot profile.
Device Fingerprint Logs (deviceFingerPrintLogProfile)
Number of device fingerprint violations logged by the Bot profile.
Device Fingerprint Drop (deviceFingerPrintDropProfile)
Number of device fingerprint violations dropped by the Bot profile.
Device Fingerprint Redirect (deviceFingerPrintRedirectProfile)
Number of device fingerprint violations requests redirected by the Bot profile to a different Web page or web server.
IP Reputation (ipRepProfile)
Number of ip reputation violations seen by the Bot profile.
IP Reputation Logs (ipRepLogProfile)
Number of ip reputation violations logged by the Bot Profile.
IP Reputation Drop (ipRepDropProfile)
Number of ip reputation violations dropped by the Bot profile.
IP Reputation Redirect (ipRepRedirectProfile)
Number of ip reputation violations requests redirected by the Bot profile to a different Web page or web server.
White List (whiteListProfile)
Number of white list violations seen by the Bot profile.
White List Logs (whiteListLogProfile)
Number of white list violations logged by the Bot profile.
Black List (blackListProfile)
Number of black list violations seen by the Bot profile.
Black List Logs (blackListLogProfile)
Number of black list violations logged by the Bot profile.
Black List Drop (blackListDropProfile)
Number of black list violations dropped by the Bot profile.
Black List Redirect (blackListRedirectProfile)
Number of black list violations redirected by the Bot profile to a different Web page or web server.
Rate Limit (rateLimitProfile)
Number of rate limiting violations seen by the Bot profile.
Rate Limit Logs (rateLimitLogProfile)
Number of rate limiting violations logged by the Bot profile.
Rate Limit Drop (rateLimitDropProfile)
Number of rate limiting violations dropped by the Bot profile.
Rate Limit Redirect (rateLimitRedirectProfile)
Number of rate limiting violations requests redirected by the Bot profile to a different Web page or web server.
Static Signature (staticSignnatureProfile)
Number of static signatutre violations seen by the Bot profile.
Static Signature Logs (staticSignnatureLogProfile)
Number of static signatutre violations logged by the Bot profile.
Static Signature Drop (staticSignnatureDropProfile)
Number of static signatutre violations dropped by the Bot profile.
Static Signature Redirect (staticSignnatureRedirectProfile)
Number of static signatutre violations redirected by the Bot profile to a different Web page or web server.
requests (reqs)
HTTP/HTTPS requests sent to your protected web servers via the Bot profile.
Request Bytes (reqBytes)
Number of bytes transfered for requests
responses (resps)
HTTP/HTTPS responses sent by your protected web servers via the Bot profile.
Response Bytes (resBytes)
Number of bytes transfered for responses
Example¶
stat bot profile