community.network.avi_vsvip 模块 – 用于设置 VsVip Avi RESTful 对象的模块

注意

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

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

要安装它，请使用：ansible-galaxy collection install community.network。您需要进一步的要求才能使用此模块，请参阅 要求 了解详细信息。

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

注意

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

已弃用

在：中删除

版本 6.0.0

原因：

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

替代方案：

未知。

概要

别名：network.avi.avi_vsvip

要求

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

  • avisdk

参数

参数

注释

api_context

字典

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

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

api_version

字符串

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

默认值： "16.4.4"

avi_api_patch_op

字符串

当使用 avi_api_update_method 作为 patch 时要使用的 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"

控制器

字符串

Avi 控制器 IP 或 SQDN

csrftoken

字符串

Avi 控制器 API csrftoken，用于通过会话 ID 重用现有会话

默认值： ""

密码

字符串

Avi 控制器密码

端口

字符串

Avi 控制器端口

session_id

字符串

Avi 控制器 API 会话 ID，用于通过 csrftoken 重用现有会话

默认值： ""

租户

字符串

Avi 控制器租户

默认值： "admin"

tenant_uuid

字符串

Avi 控制器租户 UUID

默认值： ""

超时

字符串

Avi 控制器请求超时

默认值： 300

令牌

字符串

Avi 控制器 API 令牌

默认值： ""

用户名

字符串

Avi 控制器用户名

avi_disable_session_cache_as_fact

布尔值

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

选项

  • false ← (默认)

  • true

cloud_ref

字符串

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

在 17.1.1 中引入的字段。

控制器

字符串

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

dns_info

字符串

服务发现特定数据，包括完全限定域名、类型和 dns 记录的生存时间。

在 17.1.1 中引入的字段。

east_west_placement

布尔值

强制放置在服务引擎组中的所有服务引擎上（仅限容器云）。

在 17.1.1 中引入的字段。

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

选项

  • false

  • true

名称

字符串 / 必需

vsvip 对象的名称。

在 17.1.1 中引入的字段。

密码

字符串

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

状态

字符串

应应用于实体的状态。

选项

  • "absent"

  • "present" ← (默认)

租户

字符串

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

默认值： "admin"

tenant_ref

字符串

它是对租户类型对象的引用。

在 17.1.1 中引入的字段。

tenant_uuid

字符串

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

默认值： ""

url

字符串

对象的 Avi 控制器 URL。

use_standard_alb

布尔值

这将覆盖云级别的默认值，并且如果 se 组 use_standard_alb 值被设置，则需要与将要使用的 se 组值匹配。

已设置。

这仅在 Azure 云上为 vs 使用 fip 时使用。

在 18.2.3 中引入的字段。

选项

  • false

  • true

用户名

字符串

用于访问 Avi 控制器的用户名。默认值是环境变量 AVI_USERNAME。

uuid

字符串

vsvip 对象的 UUID。

在 17.1.1 中引入的字段。

vip

字符串

虚拟服务 IP 和其他可共享实体列表。

在 17.1.1 中引入的字段。

vrf_context_ref

字符串

虚拟服务绑定到的虚拟路由上下文。

这用于提供应用程序附加到的一组网络的隔离。

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

在 17.1.1 中引入的字段。

vsvip_cloud_config_cksum

字符串

vsvip 的云配置校验和。

由云连接器内部设置。

在 17.2.9、18.1.2 中引入的字段。

注释

注意

示例

- name: Example to create VsVip object
  community.network.avi_vsvip:
    controller: 10.10.25.42
    username: admin
    password: something
    state: present
    name: sample_vsvip

返回值

常见的返回值记录在 这里，以下是此模块特有的字段

键

描述

obj

字典

VsVip (api/vsvip) 对象

返回: 成功，已更改

状态

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

  • 有关更多信息，请参阅 已弃用。

作者

  • Gaurav Rastogi (@grastogi23)