-
-
-
-
-
-
-
-
botsettings
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
videooptimizationdetectionpolicylabel_videooptimizationdetectionpolicy_binding
-
videooptimizationdetectionpolicy_videooptimizationglobaldetection_binding
-
videooptimizationglobaldetection_videooptimizationdetectionpolicy_binding
-
videooptimizationglobalpacing_videooptimizationpacingpolicy_binding
-
videooptimizationpacingpolicylabel_videooptimizationpacingpolicy_binding
-
videooptimizationpacingpolicy_videooptimizationglobalpacing_binding
-
This content has been machine translated dynamically.
Dieser Inhalt ist eine maschinelle Übersetzung, die dynamisch erstellt wurde. (Haftungsausschluss)
Cet article a été traduit automatiquement de manière dynamique. (Clause de non responsabilité)
Este artículo lo ha traducido una máquina de forma dinámica. (Aviso legal)
此内容已经过机器动态翻译。 放弃
このコンテンツは動的に機械翻訳されています。免責事項
이 콘텐츠는 동적으로 기계 번역되었습니다. 책임 부인
Este texto foi traduzido automaticamente. (Aviso legal)
Questo contenuto è stato tradotto dinamicamente con traduzione automatica.(Esclusione di responsabilità))
This article has been machine translated.
Dieser Artikel wurde maschinell übersetzt. (Haftungsausschluss)
Ce article a été traduit automatiquement. (Clause de non responsabilité)
Este artículo ha sido traducido automáticamente. (Aviso legal)
この記事は機械翻訳されています.免責事項
이 기사는 기계 번역되었습니다.책임 부인
Este artigo foi traduzido automaticamente.(Aviso legal)
这篇文章已经过机器翻译.放弃
Questo articolo è stato tradotto automaticamente.(Esclusione di responsabilità))
Translation failed!
botsettings
Configuration for Bot engine settings resource.
Properties
(click to see Operations )
Name | Data Type | Permissions | Description |
---|---|---|---|
defaultprofile |
|
Read-write | 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.
Minimum length = 1 |
defaultnonintrusiveprofile |
|
Read-write | 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.
Default value: BOT_STATS Minimum length = 1 Possible values = BOT_BYPASS, BOT_STATS, BOT_LOG |
javascriptname |
|
Read-write | 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’). Minimum length = 1 |
sessiontimeout |
|
Read-write | Timeout, in seconds, after which a user session is terminated.
Minimum value = 1 Maximum value = 65535 |
sessioncookiename |
|
Read-write | 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’). Minimum length = 1 |
dfprequestlimit |
|
Read-write | Number of requests to allow without bot session cookie if device fingerprint is enabled.
Minimum value = 1 |
signatureautoupdate |
|
Read-write | Flag used to enable/disable bot auto update signatures.
Default value: OFF Possible values = ON, OFF |
signatureurl |
|
Read-write | URL to download the bot signature mapping file from server.
Default value: https://nsbotsignatures.s3.amazonaws.com/BotSignatureMapping.json |
proxyserver |
|
Read-write | Proxy Server IP to get updated signatures from AWS. |
proxyport |
|
Read-write | Proxy Server Port to get updated signatures from AWS.
Default value: 8080 Range 1 - 65535 * in CLI is represented as 65535 in NITRO API |
trapurlautogenerate |
|
Read-write | Enable/disable trap URL auto generation. When enabled, trap URL is updated within the configured interval.
Default value: OFF Possible values = ON, OFF |
trapurlinterval |
|
Read-write | Time in seconds after which trap URL is updated.
Default value: 3600 Minimum value = 300 Maximum value = 86400 |
trapurllength |
|
Read-write | Length of the auto-generated trap URL.
Default value: 32 Minimum value = 10 Maximum value = 255 |
proxyusername |
|
Read-write | Proxy Username.
Minimum length = 1 |
proxypassword |
|
Read-write | Password with which user logs on.
Minimum length = 1 |
builtin | <String[]> | Read-only | Flag to determine if bot engine setting is built-in or not.
Possible values = MODIFIABLE, DELETABLE, IMMUTABLE, PARTITION_ALL |
feature |
|
Read-only | The feature to be checked while applying this config. |
Operations
(click to see Properties )
- UPDATE
- UNSET
- GET (ALL)
Some options that you can use for each operations:
-
Getting warnings in response: NITRO allows you to get warnings in an operation by specifying the 'warning' query parameter as 'yes'. For example, to get warnings while connecting to the NetScaler appliance, the URL is as follows:
http:// <netscaler-ip-address> /nitro/v1/config/login?warning=yes
If any, the warnings are displayed in the response payload with the HTTP code '209 X-NITRO-WARNING'.
-
Authenticated access for individual NITRO operations: NITRO allows you to logon to the NetScaler appliance to perform individual operations. You can use this option instead of creating a NITRO session (using the login object) and then using that session to perform all operations,
To do this, you must specify the username and password in the request header of the NITRO request as follows:
X-NITRO-USER: <username>
X-NITRO-PASS: <password>
Note: In such cases, make sure that the request header DOES not include the following:
Cookie:NITRO_AUTH_TOKEN= <tokenvalue>
*Note:
*
Mandatory parameters are marked in
red
and placeholder content is marked in
green
update
URL: http:// <netscaler-ip-address> /nitro/v1/config/botsettings HTTP Method: PUT
Request Headers:
Cookie:NITRO_AUTH_TOKEN= <tokenvalue>
Content-Type:application/json
Request Payload:
{"botsettings":{
"defaultprofile":<String_value>,
"defaultnonintrusiveprofile":<String_value>,
"javascriptname":<String_value>,
"sessiontimeout":<Double_value>,
"sessioncookiename":<String_value>,
"dfprequestlimit":<Double_value>,
"signatureautoupdate":<String_value>,
"signatureurl":<String_value>,
"proxyserver":<String_value>,
"proxyport":<Integer_value>,
"trapurlautogenerate":<String_value>,
"trapurlinterval":<Double_value>,
"trapurllength":<Double_value>,
"proxyusername":<String_value>,
"proxypassword":<String_value>
}}
<!--NeedCopy-->
Response: HTTP Status Code on Success: 200 OK
HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for NetScaler-specific errors). The response payload provides details of the error
unset
URL: http:// <netscaler-ip-address> /nitro/v1/config/botsettings? action=unset HTTP Method: POST
Request Headers:
Cookie:NITRO_AUTH_TOKEN= <tokenvalue>
Content-Type:application/json
Request Payload:
{"botsettings":{
"defaultprofile":true,
"defaultnonintrusiveprofile":true,
"javascriptname":true,
"sessiontimeout":true,
"sessioncookiename":true,
"dfprequestlimit":true,
"signatureautoupdate":true,
"signatureurl":true,
"proxyserver":true,
"proxyport":true,
"trapurlautogenerate":true,
"trapurlinterval":true,
"trapurllength":true,
"proxyusername":true,
"proxypassword":true
}}
<!--NeedCopy-->
Response: HTTP Status Code on Success: 200 OK
HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for NetScaler-specific errors). The response payload provides details of the error
get (all)
URL: http:// <netscaler-ip-address> /nitro/v1/config/botsettings HTTP Method: GET
Request Headers:
Cookie:NITRO_AUTH_TOKEN= <tokenvalue>
Accept:application/json
Response: HTTP Status Code on Success: 200 OK
HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for NetScaler-specific errors). The response payload provides details of the error
Response Header:
Content-Type:application/json
Response Payload:
{ "botsettings": [ {
"defaultprofile":<String_value>,
"defaultnonintrusiveprofile":<String_value>,
"javascriptname":<String_value>,
"sessiontimeout":<Double_value>,
"sessioncookiename":<String_value>,
"dfprequestlimit":<Double_value>,
"signatureautoupdate":<String_value>,
"signatureurl":<String_value>,
"proxyserver":<String_value>,
"proxyport":<Integer_value>,
"proxyusername":<String_value>,
"proxypassword":<String_value>,
"trapurlautogenerate":<String_value>,
"trapurlinterval":<Double_value>,
"trapurllength":<Double_value>,
"builtin":<String[]_value>,
"feature":<String_value>
}]}
<!--NeedCopy-->
Share
Share
In this article
This Preview product documentation is Citrix Confidential.
You agree to hold this documentation confidential pursuant to the terms of your Citrix Beta/Tech Preview Agreement.
The development, release and timing of any features or functionality described in the Preview documentation remains at our sole discretion and are subject to change without notice or consultation.
The documentation is for informational purposes only and is not a commitment, promise or legal obligation to deliver any material, code or functionality and should not be relied upon in making Citrix product purchase decisions.
If you do not agree, select I DO NOT AGREE to exit.