getbotsettingsResult Structure Definition

The getbotsettingsResult structure defines the return type for getbotsettings 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.

botsettingsList

List of botsettingss


botsettings Structure Definition

The botsettings structure defines the actual return type values for getbotsettings API.

Syntax



Members

defaultprofile

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.

defaultnonintrusiveprofile

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.

javascriptname

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').

sessiontimeout

Timeout, in seconds, after which a user session is terminated.

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').

dfprequestlimit

Number of requests to allow without bot session cookie if device fingerprint is enabled

signatureautoupdate

Flag used to enable/disable bot auto update signatures

signatureurl

URL to download the bot signature mapping file from server

proxyserver

Proxy Server IP to get updated signatures from AWS.

proxyport

Proxy Server Port to get updated signatures from AWS.

proxyusername

Proxy Username

proxypassword

Password with which user logs on.

trapurlautogenerate

Enable/disable trap URL auto generation. When enabled, trap URL is updated within the configured interval.

trapurlinterval

Time in seconds after which trap URL is updated.

trapurllength

Length of the auto-generated trap URL.

builtin

Flag to determine if bot engine setting is built-in or not

_nextgenapiresource


See Also