avi_httppolicyset – Module for setup of HTTPPolicySet Avi RESTful Object

From Get docs
Ansible/docs/2.7/modules/avi httppolicyset module


avi_httppolicyset – Module for setup of HTTPPolicySet Avi RESTful Object

New in version 2.4.


Synopsis

Requirements

The below requirements are needed on the host that executes this module.

  • avisdk

Parameters

Parameter Choices/Defaults Comments

api_context

-

added in 2.5

Avi API context that includes current session ID and CSRF Token.

This allows user to perform single login and re-use the session.

api_version

-

Default:

"16.4.4"

Avi API version of to use for Avi API and objects.

avi_api_patch_op

-

added in 2.5

  • add
  • replace
  • delete

Patch operation to use when using avi_api_update_method as patch.

avi_api_update_method

-

added in 2.5

  • put

  • patch

Default method for object update is HTTP PUT.

Setting to patch will override that behavior to use HTTP PATCH.

avi_credentials

-

added in 2.5

Avi Credentials dictionary which can be used in lieu of enumerating Avi Controller login details.

cloud_config_cksum

-

Checksum of cloud configuration for pool.

Internally set by cloud connector.

controller

-

Default:

""

IP address or hostname of the controller. The default value is the environment variable AVI_CONTROLLER.

created_by

-

Creator name.

description

-

User defined description for the object.

http_request_policy

-

Http request policy for the virtual service.

http_response_policy

-

Http response policy for the virtual service.

http_security_policy

-

Http security policy for the virtual service.

is_internal_policy

boolean

  • no
  • yes

Boolean flag to set is_internal_policy.

Default value when not specified in API or module is interpreted by Avi Controller as False.

name

- / required

Name of the http policy set.

password

-

Default:

""

Password of Avi user in Avi controller. The default value is the environment variable AVI_PASSWORD.

state

-

  • absent
  • present

The state that should be applied on the entity.

tenant

-

Default:

"admin"

Name of tenant used for all Avi API calls and context of object.

tenant_ref

-

It is a reference to an object of type tenant.

tenant_uuid

-

Default:

""

UUID of tenant used for all Avi API calls and context of object.

url

-

Avi controller URL of the object.

username

-

Default:

""

Username used for accessing Avi controller. The default value is the environment variable AVI_USERNAME.

uuid

-

Uuid of the http policy set.



Notes

Note


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, the following are the fields unique to this module:

Key Returned Description

obj

dictionary

success, changed

HTTPPolicySet (api/httppolicyset) object





Status

Authors

Hint

If you notice any issues in this documentation you can edit this document to improve it.


© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.7/modules/avi_httppolicyset_module.html