Skip to content

Latest commit

 

History

History
509 lines (488 loc) · 21.9 KB

avi_applicationpersistenceprofile.rst

File metadata and controls

509 lines (488 loc) · 21.9 KB

vmware.alb.avi_applicationpersistenceprofile

Module for setup of ApplicationPersistenceProfile 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.
app_cookie_persistence_profile
dict
- Specifies the application cookie persistence profile parameters.
- 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.
description
str
- Allowed in enterprise edition with any value, essentials, basic, enterprise with cloud services edition.
hdr_persistence_profile
dict
- Specifies the custom http header persistence profile parameters.
- Allowed in enterprise edition with any value, enterprise with cloud services edition.
http_cookie_persistence_profile
dict
- Specifies the http cookie persistence profile parameters.
- Allowed in enterprise edition with any value, essentials, basic, enterprise with cloud services edition.
ip_persistence_profile
dict
- Specifies the client ip persistence profile parameters.
- Allowed in enterprise edition with any value, essentials, basic, enterprise with cloud services edition.
is_federated
bool
- This field describes the object's replication scope.
- If the field is set to false, then the object is visible within the controller-cluster and its associated service-engines.
- If the field is set to true, then the object is replicated across the federation.
- Field introduced in 17.1.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.
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
- A user-friendly name for the persistence profile.
- Allowed in enterprise edition with any value, essentials, basic, enterprise with cloud services edition.
persistence_type
str
required: true
- Method used to persist clients to the same server for a duration of time or a session.
- Enum options - PERSISTENCE_TYPE_CLIENT_IP_ADDRESS, PERSISTENCE_TYPE_HTTP_COOKIE, PERSISTENCE_TYPE_TLS, PERSISTENCE_TYPE_CLIENT_IPV6_ADDRESS,
- PERSISTENCE_TYPE_CUSTOM_HTTP_HEADER, PERSISTENCE_TYPE_APP_COOKIE, PERSISTENCE_TYPE_GSLB_SITE.
- Allowed in enterprise edition with any value, essentials edition(allowed values-
- persistence_type_client_ip_address,persistence_type_http_cookie), basic edition(allowed values-
- persistence_type_client_ip_address,persistence_type_http_cookie), enterprise with cloud services edition.
- Default value when not specified in API or module is interpreted by Avi Controller as PERSISTENCE_TYPE_CLIENT_IP_ADDRESS.
server_hm_down_recovery
str
- Specifies behavior when a persistent server has been marked down by a health monitor.
- Enum options - HM_DOWN_PICK_NEW_SERVER, HM_DOWN_ABORT_CONNECTION, HM_DOWN_CONTINUE_PERSISTENT_SERVER.
- Allowed in enterprise edition with any value, essentials edition(allowed values- hm_down_pick_new_server), basic edition(allowed values-
- hm_down_pick_new_server), enterprise with cloud services edition.
- Default value when not specified in API or module is interpreted by Avi Controller as HM_DOWN_PICK_NEW_SERVER.
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 persistence profile.
- 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 an Application Persistence setting using http cookie.
      avi_applicationpersistenceprofile:
        avi_credentials: "{{ avi_credentials }}"
        http_cookie_persistence_profile:
          always_send_cookie: false
          cookie_name: My-HTTP
          key:
          - aes_key: ShYGZdMks8j6Bpvm2sCvaXWzvXms2Z9ob+TTjRy46lQ=
            name: c1276819-550c-4adf-912d-59efa5fd7269
          - aes_key: OGsyVk84VCtyMENFOW0rMnRXVnNrb0RzdG5mT29oamJRb0dlbHZVSjR1az0=
            name: a080de57-77c3-4580-a3ea-e7a6493c14fd
          - aes_key: UVN0cU9HWmFUM2xOUzBVcmVXaHFXbnBLVUUxMU1VSktSVU5HWjJOWmVFMTBUMUV4UmxsNk4xQmFZejA9
            name: 60478846-33c6-484d-868d-bbc324fce4a5
          timeout: 15
        name: My-HTTP-Cookie
        persistence_type: PERSISTENCE_TYPE_HTTP_COOKIE
        server_hm_down_recovery: HM_DOWN_PICK_NEW_SERVER
        tenant_ref: /api/tenant?name=Demo

Authors