Skip to content

Latest commit

 

History

History
476 lines (456 loc) · 19.7 KB

avi_wafpolicypsmgroup.rst

File metadata and controls

476 lines (456 loc) · 19.7 KB

vmware.alb.avi_wafpolicypsmgroup

Module for setup of WafPolicyPSMGroup 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.
configpb_attributes
dict
- Protobuf versioning for config pbs.
- Field introduced in 21.1.1.
- Allowed in enterprise edition with any value, essentials edition with any value, basic edition with any value, enterprise with cloud services
- edition.
description
str
- Free-text comment about this group.
- Field introduced in 18.2.3.
- Allowed in enterprise edition with any value, essentials, basic, enterprise with cloud services edition.
enable
bool
- Enable or disable this waf rule group.
- Field introduced in 18.2.3.
- Allowed in enterprise edition with any value, essentials, basic, enterprise with cloud services edition.
- Default value when not specified in API or module is interpreted by Avi Controller as True.
hit_action
str
- If a rule in this group matches the match_value pattern, this action will be executed.
- Allowed actions are waf_action_no_op and waf_action_allow_parameter.
- Enum options - WAF_ACTION_NO_OP, WAF_ACTION_BLOCK, WAF_ACTION_ALLOW_PARAMETER.
- Field introduced in 18.2.3.
- Allowed in enterprise edition with any value, essentials, basic, enterprise with cloud services edition.
- Default value when not specified in API or module is interpreted by Avi Controller as WAF_ACTION_ALLOW_PARAMETER.
is_learning_group
bool
- This field indicates that this group is used for learning.
- Field introduced in 18.2.3.
- Allowed in enterprise edition with any value, essentials, basic, enterprise with cloud services edition.
- Default value when not specified in API or module is interpreted by Avi Controller as False.
locations
list
- Positive security model locations.
- These are used to partition the application name space.
- Field introduced in 18.2.3.
- Allowed in enterprise edition with any value, essentials, basic, enterprise with cloud services edition.
markers
list
- List of labels to be used for granular rbac.
- Field introduced in 20.1.5.
- Allowed in enterprise edition with any value, essentials edition with any value, basic edition with any value, enterprise with cloud services
- edition.
miss_action
str
- If a rule in this group does not match the match_value pattern, this action will be executed.
- Allowed actions are waf_action_no_op and waf_action_block.
- Enum options - WAF_ACTION_NO_OP, WAF_ACTION_BLOCK, WAF_ACTION_ALLOW_PARAMETER.
- Field introduced in 18.2.3.
- Allowed in enterprise edition with any value, essentials, basic, enterprise with cloud services edition.
- Default value when not specified in API or module is interpreted by Avi Controller as WAF_ACTION_NO_OP.
name
str
required: true
- User defined name of the group.
- Field introduced in 18.2.3.
- Allowed in enterprise edition with any value, essentials, basic, enterprise with cloud services edition.
tenant_ref
str
- Tenant that this object belongs to.
- It is a reference to an object of type tenant.
- Field introduced in 18.2.3.
- Allowed in enterprise edition with any value, essentials, basic, enterprise with cloud services edition.
url
str
- Avi controller URL of the object.
uuid
str
- Uuid of this object.
- Field introduced in 18.2.3.
- Allowed in enterprise edition with any value, essentials, basic, 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 WafPolicyPSMGroup object
      avi_wafpolicypsmgroup:
        avi_credentials: "{{ avi_credentials }}"
        state: present
        name: sample_wafpolicypsmgroup

Authors