Try SpotterConfiguration for Bot profile resource.
| "added in version" 2.0.0 of netscaler.adc"
Authors: Sumanth Lingappa (@sumanth-lingappa)
preview | supported by community
Install with ansible-galaxy collection install netscaler.adc:==2.5.1
collections:
- name: netscaler.adc
version: 2.5.1Configuration for Bot profile resource.
name:
description:
- 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').
type: str
nsip:
description:
- The ip address of the NetScaler ADC appliance where the nitro API calls will be
made.
- The port can be specified with the colon (:). E.g. 192.168.1.1:555.
required: true
type: str
trap:
choices:
- 'ON'
- 'OFF'
description:
- Enable trap bot detection.
type: str
state:
choices:
- present
- absent
- unset
default: present
description:
- The state of the resource being configured by the module on the NetScaler ADC node.
- When C(present), the resource will be added/updated configured according to the
module's parameters.
- When C(absent), the resource will be deleted from the NetScaler ADC node.
- When C(unset), the resource will be unset on the NetScaler ADC node.
type: str
comment:
description:
- Any comments about the purpose of profile, or other useful information about the
profile.
type: str
trapurl:
description:
- URL that Bot protection uses as the Trap URL.
type: str
api_path:
default: nitro/v1/config
description:
- Base NITRO API path.
- Define only in case of an ADM service proxy call
type: str
errorurl:
description:
- URL that Bot protection uses as the Error URL.
type: str
signature:
description:
- Name of object containing bot static signature details.
type: str
nitro_pass:
description:
- The password with which to authenticate to the NetScaler ADC node.
required: false
type: str
nitro_user:
description:
- The username with which to authenticate to the NetScaler ADC node.
required: false
type: str
trapaction:
choices:
- NONE
- LOG
- DROP
- REDIRECT
- RESET
description:
- Action to be taken for bot trap based bot detection.
elements: str
type: list
kmdetection:
choices:
- 'ON'
- 'OFF'
description:
- Enable keyboard-mouse based bot detection.
type: str
save_config:
default: false
description:
- If C(true) the module will save the configuration on the NetScaler ADC node if it
makes any changes.
- The module will not save the configuration on the NetScaler ADC node if it made
no changes.
type: bool
bot_enable_tps:
choices:
- 'ON'
- 'OFF'
description:
- Enable TPS.
type: str
nitro_protocol:
choices:
- http
- https
default: https
description:
- Which protocol to use when accessing the nitro API objects.
type: str
sessiontimeout:
description:
- Timeout, in seconds, after which a user session is terminated.
type: float
validate_certs:
default: true
description:
- If C(false), SSL certificates will not be validated. This should only be used on
personally controlled sites using self-signed certificates.
required: false
type: bool
dfprequestlimit:
description:
- Number of requests to allow without bot session cookie if device fingerprint is
enabled
type: float
verboseloglevel:
choices:
- NONE
- HTTP_FULL_HEADER
description:
- Bot verbose Logging. Based on the log level, ADC will log additional information
whenever client is detected as a bot.
type: str
kmjavascriptname:
description:
- Name of the JavaScript file that the Bot Management feature will insert in the response
for keyboard-mouse based detection.
- Must begin with a letter, number, or the underscore character (_), and must contain
only letters, numbers, and the hyphen (-), period (.) hash (#), space ( ), at (@),
equals (=), colon (:), and underscore characters.
- ''
- '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 javascript file name" or 'my javascript file name').
type: str
nitro_auth_token:
description:
- The authentication token provided by a login operation.
type: str
version_added: 2.6.0
version_added_collection: netscaler.adc
spoofedreqaction:
choices:
- NONE
- LOG
- DROP
- REDIRECT
- RESET
description:
- Actions to be taken on a spoofed request (A request spoofing good bot user agent
string).
elements: str
type: list
devicefingerprint:
choices:
- 'ON'
- 'OFF'
description:
- Enable device-fingerprint bot detection
type: str
sessioncookiename:
description:
- 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').
type: str
clientipexpression:
description:
- Expression to get the client IP.
type: str
bot_enable_black_list:
choices:
- 'ON'
- 'OFF'
description:
- Enable black-list bot detection.
type: str
bot_enable_rate_limit:
choices:
- 'ON'
- 'OFF'
description:
- Enable rate-limit bot detection.
type: str
bot_enable_white_list:
choices:
- 'ON'
- 'OFF'
description:
- Enable white-list bot detection.
type: str
kmeventspostbodylimit:
description:
- Size of the KM data send by the browser, needs to be processed on ADC
type: float
botprofile_tps_binding:
description: Bindings for botprofile_tps_binding resource
suboptions:
binding_members:
default: []
description: List of binding members
elements: dict
type: list
mode:
choices:
- desired
- bind
- unbind
default: desired
description:
- The mode in which to configure the bindings.
- If mode is set to C(desired), the bindings will be added or removed from the
target NetScaler ADCs as necessary to match the bindings specified in the state.
- If mode is set to C(bind), the specified bindings will be added to the resource.
The existing bindings in the target ADCs will not be modified.
- If mode is set to C(unbind), the specified bindings will be removed from the
resource. The existing bindings in the target ADCs will not be modified.
type: str
type: dict
devicefingerprintaction:
choices:
- NONE
- LOG
- DROP
- REDIRECT
- RESET
- MITIGATION
description:
- Action to be taken for device-fingerprint based bot detection.
elements: str
type: list
devicefingerprintmobile:
choices:
- NONE
- Android
- iOS
description:
- Enabling bot device fingerprint protection for mobile clients
elements: str
type: list
bot_enable_ip_reputation:
choices:
- 'ON'
- 'OFF'
description:
- Enable IP-reputation bot detection.
type: str
headlessbrowserdetection:
choices:
- 'ON'
- 'OFF'
description:
- Enable Headless Browser detection.
type: str
botprofile_captcha_binding:
description: Bindings for botprofile_captcha_binding resource
suboptions:
binding_members:
default: []
description: List of binding members
elements: dict
type: list
mode:
choices:
- desired
- bind
- unbind
default: desired
description:
- The mode in which to configure the bindings.
- If mode is set to C(desired), the bindings will be added or removed from the
target NetScaler ADCs as necessary to match the bindings specified in the state.
- If mode is set to C(bind), the specified bindings will be added to the resource.
The existing bindings in the target ADCs will not be modified.
- If mode is set to C(unbind), the specified bindings will be removed from the
resource. The existing bindings in the target ADCs will not be modified.
type: str
type: dict
botprofile_blacklist_binding:
description: Bindings for botprofile_blacklist_binding resource
suboptions:
binding_members:
default: []
description: List of binding members
elements: dict
type: list
mode:
choices:
- desired
- bind
- unbind
default: desired
description:
- The mode in which to configure the bindings.
- If mode is set to C(desired), the bindings will be added or removed from the
target NetScaler ADCs as necessary to match the bindings specified in the state.
- If mode is set to C(bind), the specified bindings will be added to the resource.
The existing bindings in the target ADCs will not be modified.
- If mode is set to C(unbind), the specified bindings will be removed from the
resource. The existing bindings in the target ADCs will not be modified.
type: str
type: dict
botprofile_ratelimit_binding:
description: Bindings for botprofile_ratelimit_binding resource
suboptions:
binding_members:
default: []
description: List of binding members
elements: dict
type: list
mode:
choices:
- desired
- bind
- unbind
default: desired
description:
- The mode in which to configure the bindings.
- If mode is set to C(desired), the bindings will be added or removed from the
target NetScaler ADCs as necessary to match the bindings specified in the state.
- If mode is set to C(bind), the specified bindings will be added to the resource.
The existing bindings in the target ADCs will not be modified.
- If mode is set to C(unbind), the specified bindings will be removed from the
resource. The existing bindings in the target ADCs will not be modified.
type: str
type: dict
botprofile_whitelist_binding:
description: Bindings for botprofile_whitelist_binding resource
suboptions:
binding_members:
default: []
description: List of binding members
elements: dict
type: list
mode:
choices:
- desired
- bind
- unbind
default: desired
description:
- The mode in which to configure the bindings.
- If mode is set to C(desired), the bindings will be added or removed from the
target NetScaler ADCs as necessary to match the bindings specified in the state.
- If mode is set to C(bind), the specified bindings will be added to the resource.
The existing bindings in the target ADCs will not be modified.
- If mode is set to C(unbind), the specified bindings will be removed from the
resource. The existing bindings in the target ADCs will not be modified.
type: str
type: dict
botprofile_ipreputation_binding:
description: Bindings for botprofile_ipreputation_binding resource
suboptions:
binding_members:
default: []
description: List of binding members
elements: dict
type: list
mode:
choices:
- desired
- bind
- unbind
default: desired
description:
- The mode in which to configure the bindings.
- If mode is set to C(desired), the bindings will be added or removed from the
target NetScaler ADCs as necessary to match the bindings specified in the state.
- If mode is set to C(bind), the specified bindings will be added to the resource.
The existing bindings in the target ADCs will not be modified.
- If mode is set to C(unbind), the specified bindings will be removed from the
resource. The existing bindings in the target ADCs will not be modified.
type: str
type: dict
botprofile_logexpression_binding:
description: Bindings for botprofile_logexpression_binding resource
suboptions:
binding_members:
default: []
description: List of binding members
elements: dict
type: list
mode:
choices:
- desired
- bind
- unbind
default: desired
description:
- The mode in which to configure the bindings.
- If mode is set to C(desired), the bindings will be added or removed from the
target NetScaler ADCs as necessary to match the bindings specified in the state.
- If mode is set to C(bind), the specified bindings will be added to the resource.
The existing bindings in the target ADCs will not be modified.
- If mode is set to C(unbind), the specified bindings will be removed from the
resource. The existing bindings in the target ADCs will not be modified.
type: str
type: dict
signaturenouseragentheaderaction:
choices:
- NONE
- LOG
- DROP
- REDIRECT
- RESET
description:
- Actions to be taken if no User-Agent header in the request (Applicable if Signature
check is enabled).
elements: str
type: list
botprofile_kmdetectionexpr_binding:
description: Bindings for botprofile_kmdetectionexpr_binding resource
suboptions:
binding_members:
default: []
description: List of binding members
elements: dict
type: list
mode:
choices:
- desired
- bind
- unbind
default: desired
description:
- The mode in which to configure the bindings.
- If mode is set to C(desired), the bindings will be added or removed from the
target NetScaler ADCs as necessary to match the bindings specified in the state.
- If mode is set to C(bind), the specified bindings will be added to the resource.
The existing bindings in the target ADCs will not be modified.
- If mode is set to C(unbind), the specified bindings will be removed from the
resource. The existing bindings in the target ADCs will not be modified.
type: str
type: dict
botprofile_trapinsertionurl_binding:
description: Bindings for botprofile_trapinsertionurl_binding resource
suboptions:
binding_members:
default: []
description: List of binding members
elements: dict
type: list
mode:
choices:
- desired
- bind
- unbind
default: desired
description:
- The mode in which to configure the bindings.
- If mode is set to C(desired), the bindings will be added or removed from the
target NetScaler ADCs as necessary to match the bindings specified in the state.
- If mode is set to C(bind), the specified bindings will be added to the resource.
The existing bindings in the target ADCs will not be modified.
- If mode is set to C(unbind), the specified bindings will be removed from the
resource. The existing bindings in the target ADCs will not be modified.
type: str
type: dict
signaturemultipleuseragentheaderaction:
choices:
- CHECKLAST
- LOG
- DROP
- REDIRECT
- RESET
description:
- Actions to be taken if multiple User-Agent headers are seen in a request (Applicable
if Signature check is enabled). Log action should be combined with other actions
elements: str
type: list
changed:
description: Indicates if any change is made by the module
returned: always
sample: true
type: bool
diff:
description: Dictionary of before and after changes
returned: always
sample:
after:
key2: pqr
before:
key1: xyz
prepared: changes done
type: dict
diff_list:
description: List of differences between the actual configured object and the configuration
specified in the module
returned: when changed
sample:
- 'Attribute `key1` differs. Desired: (<class ''str''>) XYZ. Existing: (<class ''str''>)
PQR'
type: list
failed:
description: Indicates if the module failed or not
returned: always
sample: false
type: bool
loglines:
description: list of logged messages by the module
returned: always
sample:
- message 1
- message 2
type: list