avi_httppolicyset.rst

vmware.alb.avi_httppolicyset

Module for setup of HTTPPolicySet Avi RESTful Object

• Synopsis
• Parameters
• Examples

Synopsis

• This module is used to configure HTTPPolicySet object.
• More examples at (https://github.com/avinetworks/devops).

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.
cloud_config_cksum str			- Checksum of cloud configuration for pool. - Internally set by cloud connector. - Allowed in enterprise edition with any value, essentials, basic, enterprise with cloud services edition.
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.
created_by str			- Creator name. - Allowed in enterprise edition with any value, essentials, basic, enterprise with cloud services edition.
description str			- Allowed in enterprise edition with any value, essentials, basic, enterprise with cloud services edition.
geo_db_ref str			- Geo database. - It is a reference to an object of type geodb. - Field introduced in 21.1.1. - Allowed in enterprise edition with any value, enterprise with cloud services edition.
http_request_policy dict			- Http request policy for the virtual service. - Allowed in enterprise edition with any value, essentials, basic, enterprise with cloud services edition.
http_response_policy dict			- Http response policy for the virtual service. - Allowed in enterprise edition with any value, essentials, basic, enterprise with cloud services edition.
http_security_policy dict			- Http security policy for the virtual service. - Allowed in enterprise edition with any value, essentials, basic, enterprise with cloud services edition.
ip_reputation_db_ref str			- Ip reputation database. - It is a reference to an object of type ipreputationdb. - Field introduced in 20.1.3. - Allowed in enterprise edition with any value, enterprise with cloud services edition.
is_internal_policy bool			- 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.
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.
name str		required: true	- Name of the http policy set. - Allowed in enterprise edition with any value, essentials, basic, enterprise with cloud services edition.
tenant_ref str			- It is a reference to an object of type tenant. - 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 the http policy set. - 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: "{{ username }}"
      password: "{{ password }}"
      controller: "{{ controller }}"
      api_version: "{{ api_version }}"
  tasks:
    - name: Create a HTTP Policy set two switch between testpool1 and testpool2
      avi_httppolicyset:
        avi_credentials: "{{ avi_credentials }}"
        name: test-HTTP-Policy-Set
        tenant_ref: /api/tenant?name=admin
        http_request_policy:
        rules:
          - index: 1
            enable: true
            name: test-test1
            match:
              path:
                match_case: INSENSITIVE
                match_str:
                  - /test1
                match_criteria: EQUALS
            switching_action:
              action: HTTP_SWITCHING_SELECT_POOL
              status_code: HTTP_LOCAL_RESPONSE_STATUS_CODE_200
              pool_ref: "/api/pool?name=testpool1"
          - index: 2
            enable: true
            name: test-test2
            match:
              path:
                match_case: INSENSITIVE
                match_str:
                  - /test2
                match_criteria: CONTAINS
            switching_action:
              action: HTTP_SWITCHING_SELECT_POOL
              status_code: HTTP_LOCAL_RESPONSE_STATUS_CODE_200
              pool_ref: "/api/pool?name=testpool2"
        is_internal_policy: false

Authors

• Gaurav Rastogi ([email protected])
• Sandeep Bandi ([email protected])
• Amol Shinde ([email protected])