You are reading an unmaintained version of the Ansible documentation. Unmaintained Ansible versions can contain unfixed security vulnerabilities (CVE). Please upgrade to a maintained version. See the latest Ansible documentation.

avi_httppolicyset - Module for setup of HTTPPolicySet Avi RESTful Object¶

New in version 2.4.

Synopsis
Requirements (on host that executes module)
Options
Examples
Return Values
- Status

Synopsis ¶

This module is used to configure HTTPPolicySet object
more examples at https://github.com/avinetworks/devops

Requirements (on host that executes module)¶

avisdk

Options ¶

parameter	required	default	choices	comments
api_version	no			Avi API version of to use for Avi API and objects.
cloud_config_cksum	no			Checksum of cloud configuration for pool. Internally set by cloud connector.
controller	no			IP address or hostname of the controller. The default value is the environment variable `AVI_CONTROLLER`.
created_by	no			Creator name.
description	no			User defined description for the object.
http_request_policy	no			Http request policy for the virtual service.
http_response_policy	no			Http response policy for the virtual service.
http_security_policy	no			Http security policy for the virtual service.
is_internal_policy	no			Boolean flag to set is_internal_policy. Default value when not specified in API or module is interpreted by Avi Controller as False.
name	yes			Name of the http policy set.
password	no			Password of Avi user in Avi controller. The default value is the environment variable `AVI_PASSWORD`.
state	no	present	absent present	The state that should be applied on the entity.
tenant	no	admin		Name of tenant used for all Avi API calls and context of object.
tenant_ref	no			It is a reference to an object of type tenant.
tenant_uuid	no			UUID of tenant used for all Avi API calls and context of object.
url	no			Avi controller URL of the object.
username	no			Username used for accessing Avi controller. The default value is the environment variable `AVI_USERNAME`.
uuid	no			Uuid of the http policy set.

Examples ¶

- name: Create a HTTP Policy set two switch between testpool1 and testpool2
  avi_httppolicyset:
    controller: 10.10.27.90
    username: admin
    password: AviNetworks123!
    name: test-HTTP-Policy-Set
    tenant_ref: 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

Return Values ¶

Common return values are documented here Return Values, the following are the fields unique to this module:

name	description	returned	type	sample
obj	HTTPPolicySet (api/httppolicyset) object	success, changed	dict

Status ¶

This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

For help in developing on modules, should you be so inclined, please read Community Information & Contributing, Testing Ansible and Developing Modules.