New in version 2.3.
parameter | required | default | choices | comments |
---|---|---|---|---|
app_cookie_persistence_profile |
no | Specifies the application cookie persistence profile parameters. | ||
controller |
no | IP address or hostname of the controller. The default value is the environment variable AVI_CONTROLLER . | ||
description |
no | User defined description for the object. | ||
hdr_persistence_profile |
no | Specifies the custom http header persistence profile parameters. | ||
http_cookie_persistence_profile |
no | Specifies the http cookie persistence profile parameters. | ||
ip_persistence_profile |
no | Specifies the client ip persistence profile parameters. | ||
name |
yes | A user-friendly name for the persistence profile. | ||
password |
no | Password of Avi user in Avi controller. The default value is the environment variable AVI_PASSWORD . | ||
persistence_type |
yes | Method used to persist clients to the same server for a duration of time or a session. Default value when not specified in API or module is interpreted by Avi Controller as PERSISTENCE_TYPE_CLIENT_IP_ADDRESS. | ||
server_hm_down_recovery |
no | Specifies behavior when a persistent server has been marked down by a health monitor. Default value when not specified in API or module is interpreted by Avi Controller as HM_DOWN_PICK_NEW_SERVER. | ||
state |
no | 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 persistence profile. |
- name: Create an Application Persistence setting using http cookie. avi_applicationpersistenceprofile: controller: '' username: '' 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
Common return values are documented here Return Values, the following are the fields unique to this module:
name | description | returned | type | sample |
---|---|---|---|---|
obj | ApplicationPersistenceProfile (api/applicationpersistenceprofile) object | success, changed | dict |
This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.
This module is community maintained without core committer oversight.
For more information on what this means please read Module Support
For help in developing on modules, should you be so inclined, please read Community Information & Contributing, Helping Testing PRs and Developing Modules.