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。您需要其他要求才能使用此模块，请参阅 要求 获取详细信息。

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

注意

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

已弃用

在以下版本中移除：

版本 6.0.0

原因：

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

替代方案：

未知。

概要

别名：network.avi.avi_vsvip

要求

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

  • avisdk

参数

参数

注释

api_context

字典

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

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

api_version

字符串

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

默认值： "16.4.4"

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

cloud_ref

字符串

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

在 17.1.1 中引入的字段。

controller

字符串

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

dns_info

字符串

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

在 17.1.1 中引入的字段。

east_west_placement

布尔值

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

在 17.1.1 中引入的字段。

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

选项

  • false

  • true

name

字符串 / 必填

vsvip 对象的名称。

在 17.1.1 中引入的字段。

password

字符串

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

状态

字符串

应应用于实体的状态。

选项

  • “不存在”

  • "存在" ← (默认)

tenant

字符串

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

默认值： "admin"

tenant_ref

字符串

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

在 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

username

字符串

用于访问 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)