Skip to content

Latest commit

 

History

History
522 lines (502 loc) · 21.5 KB

avi_botdetectionpolicy.rst

File metadata and controls

522 lines (502 loc) · 21.5 KB

vmware.alb.avi_botdetectionpolicy

Module for setup of BotDetectionPolicy Avi RESTful Object

Synopsis

Parameters

Parameter Choices/Defaults Comments
state
str
  • absent
  • present ←
- The state that should be applied on the entity.
avi_api_update_method
str
  • put ←
  • patch
- Default method for object update is HTTP PUT.
- Setting to patch will override that behavior to use HTTP PATCH.
avi_api_patch_op
str
  • add ←
  • replace
  • delete
  • remove
- Patch operation to use when using avi_api_update_method as patch.
avi_patch_path
str
- Patch path to use when using avi_api_update_method as patch.
avi_patch_value
str
- Patch value to use when using avi_api_update_method as patch.
allow_list
dict
- Allow the user to skip botmanagement for selected requests.
- Field introduced in 21.1.1.
- Allowed in enterprise edition with any value, enterprise with cloud services edition.
client_behavior_detector
dict
- The client behavior configuration used in this policy.
- Field introduced in 30.2.1.
- Allowed in enterprise edition with any value, enterprise with cloud services edition.
description
str
- Human-readable description of this bot detection policy.
- Field introduced in 21.1.1.
- Allowed in enterprise edition with any value, enterprise with cloud services edition.
ip_location_detector
dict
required: true
- The ip location configuration used in this policy.
- Field introduced in 21.1.1.
- Allowed in enterprise edition with any value, enterprise with cloud services edition.
ip_reputation_detector
dict
required: true
- The ip reputation configuration used in this policy.
- Field introduced in 21.1.1.
- Allowed in enterprise edition with any value, enterprise with cloud services edition.
name
str
required: true
- The name of this bot detection policy.
- Field introduced in 21.1.1.
- Allowed in enterprise edition with any value, enterprise with cloud services edition.
system_bot_mapping_ref
str
- System-defined rules for classification.
- It is a reference to an object of type botmapping.
- Field introduced in 21.1.1.
- Allowed in enterprise edition with any value, enterprise with cloud services edition.
system_consolidator_ref
str
- The installation provides an updated ruleset for consolidating the results of different decider phases.
- It is a reference to an object of type botconfigconsolidator.
- Field introduced in 21.1.1.
- Allowed in enterprise edition with any value, enterprise with cloud services edition.
tenant_ref
str
- The unique identifier of the tenant to which this policy belongs.
- It is a reference to an object of type tenant.
- Field introduced in 21.1.1.
- Allowed in enterprise edition with any value, enterprise with cloud services edition.
url
str
- Avi controller URL of the object.
user_agent_detector
dict
required: true
- The user-agent configuration used in this policy.
- Field introduced in 21.1.1.
- Allowed in enterprise edition with any value, enterprise with cloud services edition.
user_bot_mapping_ref
str
- User-defined rules for classification.
- These are applied before the system classification rules.
- If a rule matches, processing terminates and the system-defined rules will not run.
- It is a reference to an object of type botmapping.
- Field introduced in 21.1.1.
- Allowed in enterprise edition with any value, enterprise with cloud services edition.
user_consolidator_ref
str
- The user-provided ruleset for consolidating the results of different decider phases.
- This runs before the system consolidator.
- If it successfully sets a consolidation, the system consolidator will not change it.
- It is a reference to an object of type botconfigconsolidator.
- Field introduced in 21.1.1.
- Allowed in enterprise edition with any value, enterprise with cloud services edition.
uuid
str
- A unique identifier to this bot detection policy.
- Field introduced in 21.1.1.
- Allowed in enterprise edition with any value, enterprise with cloud services edition.

Examples

- hosts: localhost
  connection: local
  collections:
    - vmware.alb
  vars:
    avi_credentials:
      username: "avi_user"
      password: "avi_password"
      controller: "192.168.138.18"
      api_version: "21.1.1"
  tasks:
    - name: Example to create BotDetectionPolicy object
      avi_botdetectionpolicy:
        avi_credentials: "{{ avi_credentials }}"
        state: present
        name: sample_botdetectionpolicy

Authors