community.network.avi_applicationpersistenceprofile module – Module for setup of ApplicationPersistenceProfile Avi RESTful Object
Note
This module is part of the community.network collection (version 5.0.3).
You might already have this collection installed if you are using the ansible
package.
It is not included in ansible-core
.
To check whether it is installed, run ansible-galaxy collection list
.
To install it, use: ansible-galaxy collection install community.network
.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: community.network.avi_applicationpersistenceprofile
.
Synopsis
This module is used to configure ApplicationPersistenceProfile object
more examples at https://github.com/avinetworks/devops
Aliases: network.avi.avi_applicationpersistenceprofile
Requirements
The below requirements are needed on the host that executes this module.
avisdk
Parameters
Parameter |
Comments |
---|---|
Avi API context that includes current session ID and CSRF Token. This allows user to perform single login and re-use the session. |
|
Avi API version of to use for Avi API and objects. Default: |
|
Specifies the application cookie persistence profile parameters. |
|
Patch operation to use when using avi_api_update_method as patch. Choices:
|
|
Default method for object update is HTTP PUT. Setting to patch will override that behavior to use HTTP PATCH. Choices:
|
|
Avi Credentials dictionary which can be used in lieu of enumerating Avi Controller login details. |
|
Avi controller version Default: |
|
Avi controller IP or SQDN |
|
Avi controller API csrftoken to reuse existing session with session id Default: |
|
Avi controller password |
|
Avi controller port |
|
Avi controller API session id to reuse existing session with csrftoken Default: |
|
Avi controller tenant Default: |
|
Avi controller tenant UUID Default: |
|
Avi controller request timeout Default: |
|
Avi controller API token Default: |
|
Avi controller username |
|
It disables avi session information to be cached as a fact. Choices:
|
|
IP address or hostname of the controller. The default value is the environment variable |
|
User defined description for the object. |
|
Specifies the custom http header persistence profile parameters. |
|
Specifies the http cookie persistence profile parameters. |
|
Specifies the client ip persistence profile parameters. |
|
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. Default value when not specified in API or module is interpreted by Avi Controller as False. Choices:
|
|
A user-friendly name for the persistence profile. |
|
Password of Avi user in Avi controller. The default value is the environment variable |
|
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. Default value when not specified in API or module is interpreted by Avi Controller as PERSISTENCE_TYPE_CLIENT_IP_ADDRESS. |
|
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. Default value when not specified in API or module is interpreted by Avi Controller as HM_DOWN_PICK_NEW_SERVER. |
|
The state that should be applied on the entity. Choices:
|
|
Name of tenant used for all Avi API calls and context of object. Default: |
|
It is a reference to an object of type tenant. |
|
UUID of tenant used for all Avi API calls and context of object. Default: |
|
Avi controller URL of the object. |
|
Username used for accessing Avi controller. The default value is the environment variable |
|
Uuid of the persistence profile. |
Notes
Note
For more information on using Ansible to manage Avi Network devices see https://www.ansible.com/ansible-avi-networks.
Examples
- name: Create an Application Persistence setting using http cookie.
community.network.avi_applicationpersistenceprofile:
controller: '{{ controller }}'
username: '{{ username }}'
password: '{{ password }}'
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: Demo
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
ApplicationPersistenceProfile (api/applicationpersistenceprofile) object Returned: success, changed |