community.network.avi_applicationpersistenceprofile 模块 – 用于设置 ApplicationPersistenceProfile Avi RESTful 对象的模块

注意

此模块是 community.network 集合 (版本 5.1.0) 的一部分。

如果您使用的是 ansible 包，则可能已经安装了此集合。它不包含在 ansible-core 中。要检查是否已安装，请运行 ansible-galaxy collection list。

要安装它，请使用：ansible-galaxy collection install community.network。您需要其他需求才能使用此模块，请参阅 需求 获取详细信息。

要在 playbook 中使用它，请指定：community.network.avi_applicationpersistenceprofile。

注意

community.network 集合已被弃用，并将从 Ansible 12 中删除。请参阅 讨论主题 获取更多信息。

已弃用

在以下版本中移除：

6.0.0 版本

原因：

此集合及其中的所有内容均未维护且已弃用。

替代方案：

未知。

摘要

别名：network.avi.avi_applicationpersistenceprofile

需求

执行此模块的主机需要以下需求。

  • avisdk

参数

参数

注释

api_context

字典

包含当前会话 ID 和 CSRF 令牌的 Avi API 上下文。

这允许用户执行单点登录并重用会话。

api_version

字符串

要用于 Avi API 和对象的 Avi API 版本。

默认值： "16.4.4"

字符串

指定应用程序 Cookie 持久性配置文件参数。

avi_api_patch_op

字符串

当使用 avi_api_update_method 为 patch 时使用的修补操作。

选项

  • "add"

  • "replace"

  • "delete"

avi_api_update_method

字符串

对象更新的默认方法是 HTTP PUT。

设置为 patch 将覆盖该行为以使用 HTTP PATCH。

选项

  • "put" ← (默认)

  • "patch"

avi_credentials

字典

Avi 凭据字典，可用于代替枚举 Avi 控制器登录详细信息。

api_version

字符串

Avi 控制器版本

默认值： "16.4.4"

controller

字符串

Avi 控制器 IP 或 SQDN

csrftoken

字符串

Avi 控制器 API csrftoken，用于与 session id 重用现有会话

默认值： ""

password

字符串

Avi 控制器密码

port

字符串

Avi 控制器端口

session_id

字符串

Avi 控制器 API session id，用于与 csrftoken 重用现有会话

默认值： ""

tenant

字符串

Avi 控制器租户

默认值： "admin"

tenant_uuid

字符串

Avi 控制器租户 UUID

默认值： ""

timeout

字符串

Avi 控制器请求超时

默认值： 300

token

字符串

Avi 控制器 API 令牌

默认值： ""

username

字符串

Avi 控制器用户名

avi_disable_session_cache_as_fact

布尔值

它禁用将 avi 会话信息作为事实缓存。

选项

  • false ← (默认)

  • true

controller

字符串

控制器的 IP 地址或主机名。默认值为环境变量 AVI_CONTROLLER。

description

字符串

用户为对象定义的描述。

hdr_persistence_profile

字符串

指定自定义 HTTP 标头持久性配置文件参数。

字符串

指定 HTTP Cookie 持久性配置文件参数。

ip_persistence_profile

字符串

指定客户端 IP 持久性配置文件参数。

is_federated

布尔值

此字段描述对象的复制范围。

如果该字段设置为 false，则该对象在控制器集群及其关联的服务引擎中可见。

如果该字段设置为 true，则该对象将在联合体中复制。

在 17.1.3 版中引入的字段。

API 或模块中未指定时的默认值由 Avi 控制器解释为 False。

选项

  • false

  • true

name

字符串 / 必需

持久性配置文件的用户友好名称。

password

字符串

Avi 控制器中 Avi 用户的密码。默认值为环境变量 AVI_PASSWORD。

persistence_type

字符串 / 必需

用于将客户端持久保存到同一服务器一段时间或一个会话的方法。

枚举选项 - 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。

如果未在 API 或模块中指定，Avi Controller 将默认值解释为 PERSISTENCE_TYPE_CLIENT_IP_ADDRESS。

server_hm_down_recovery

字符串

指定健康检查将持久服务器标记为关闭时的行为。

枚举选项 - HM_DOWN_PICK_NEW_SERVER、HM_DOWN_ABORT_CONNECTION、HM_DOWN_CONTINUE_PERSISTENT_SERVER。

如果未在 API 或模块中指定，Avi Controller 将默认值解释为 HM_DOWN_PICK_NEW_SERVER。

state

字符串

应应用于实体的状态。

选项

  • "absent"

  • "present" ← (默认)

tenant

字符串

用于所有 Avi API 调用和对象上下文的租户名称。

默认值： "admin"

tenant_ref

字符串

它是对 tenant 类型对象的引用。

tenant_uuid

字符串

用于所有 Avi API 调用和对象上下文的租户 UUID。

默认值： ""

url

字符串

对象的 Avi Controller URL。

username

字符串

用于访问 Avi Controller 的用户名。默认值为环境变量 AVI_USERNAME。

uuid

字符串

持久性配置文件的 UUID。

注释

注意

示例

- 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

返回值

常用返回值已记录在 此处，以下是此模块特有的字段

键

描述

obj

字典

ApplicationPersistenceProfile (api/applicationpersistenceprofile) 对象

返回：成功、已更改

状态

  • 此模块将在 6.0.0 版本中移除。[已弃用]

  • 更多信息请参见 已弃用。

作者

  • Gaurav Rastogi (@grastogi23)