community.network.avi_cloud 模块 – 用于设置 Cloud Avi RESTful 对象的模块

注意

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

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

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

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

注意

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

已弃用

在以下版本中移除：

6.0.0 版本

原因：

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

替代方案：

未知。

概要

别名：network.avi.avi_cloud

要求

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

  • avisdk

参数

参数

注释

api_context

字典

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

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

api_version

字符串

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

默认值： "16.4.4"

apic_configuration

字符串

云的 Apicconfiguration 设置。

apic_mode

布尔值

用于设置 apic_mode 的布尔标志。

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

选项

  • false

  • true

autoscale_polling_interval

字符串

Cloudconnector 轮询外部自动缩放组的间隔。

在 18.2.2 版本中引入的字段。

API 或模块中未指定时的默认值将被 Avi Controller 解释为 60。

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 Controller 登录详细信息。

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

aws_configuration

字符串

云的 Awsconfiguration 设置。

azure_configuration

字符串

在 17.2.1 版本中引入的字段。

cloudstack_configuration

字符串

云的 Cloudstackconfiguration 设置。

controller

字符串

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

custom_tags

字符串

云基础设施中所有 avi 创建资源的自定义标签。

17.1.5 版本中引入的字段。

dhcp_enabled

布尔值

选择 IP 地址管理方案。

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

选项

  • false

  • true

dns_provider_ref

字符串

云的 DNS 配置文件。

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

docker_configuration

字符串

云的 Docker 配置设置。

east_west_dns_provider_ref

字符串

东西向服务的 DNS 配置文件。

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

east_west_ipam_provider_ref

字符串

东西向服务的 IPAM 配置文件。

警告 - 请在此 IPAM 配置文件中使用不会与底层网络或集群中任何覆盖网络冲突的虚拟子网。

例如，在 AWS 和 GCP 中，169.254.0.0/16 用于存储实例元数据。

因此，不应在此配置文件中使用它。

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

enable_vip_static_routes

布尔值

在虚拟服务放置期间，为 VIP 端网络解析使用静态路由。

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

选项

  • false

  • true

gcp_configuration

字符串

Google Cloud Platform 配置。

18.2.1 版本中引入的字段。

ip6_autocfg_enabled

布尔值

启用 IPv6 自动配置。

18.1.1 版本中引入的字段。

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

选项

  • false

  • true

ipam_provider_ref

字符串

云的 IPAM 配置文件。

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

license_tier

字符串

指定新的 SE 组将使用的默认许可层级。

此字段默认继承自系统配置的值。

枚举选项 - ENTERPRISE_16、ENTERPRISE_18。

17.2.5 版本中引入的字段。

license_type

字符串

如果未指定许可证类型，则选择云类型的默认许可证执行。

默认映射为：容器云为最大 SE；OpenStack 和 VMware 为核心；Linux 为套接字。

枚举选项 - LIC_BACKEND_SERVERS、LIC_SOCKETS、LIC_CORES、LIC_HOSTS、LIC_SE_BANDWIDTH、LIC_METERED_SE_BANDWIDTH。

linuxserver_configuration

字符串

云的 Linux 服务器配置设置。

mesos_configuration

字符串

18.2.2 版本中已弃用的字段。

mtu

字符串

云的 MTU 设置。

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

name

字符串 / 必填

对象的名称。

nsx_configuration

字符串

NSX 管理器的配置参数。

17.1.1 版本中引入的字段。

obj_name_prefix

字符串

此云中所有自动创建对象的默认前缀。

此前缀可以被 SE 组模板覆盖。

openstack_configuration

字符串

云的 OpenStack 配置设置。

oshiftk8s_configuration

字符串

云的 Openshift K8s 配置设置。

password

字符串

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

prefer_static_routes

布尔值

在虚拟服务放置期间，优先使用静态路由而不是接口路由。

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

选项

  • false

  • true

proxy_configuration

字符串

云的代理配置设置。

rancher_configuration

字符串

云的 Rancher 配置设置。

state

字符串

应应用于实体的状态。

选项

  • "absent"

  • "present" ← (默认)

state_based_dns_registration

布尔值

VIP 的 DNS 记录会根据 VIP 的运行状态进行添加/删除。

17.1.12 版本中引入的字段。

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

选项

  • false

  • true

tenant

字符串

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

默认值： "admin"

tenant_ref

字符串

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

tenant_uuid

字符串

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

默认值： ""

url

字符串

对象的 Avi 控制器 URL。

username

字符串

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

uuid

字符串

对象的唯一对象标识符。

vca_configuration

字符串

云的 vCloud Air 配置设置。

vcenter_configuration

字符串

云的 vCenter 配置设置。

vtype

字符串 / 必填

云类型。

枚举选项 - CLOUD_NONE、CLOUD_VCENTER、CLOUD_OPENSTACK、CLOUD_AWS、CLOUD_VCA、CLOUD_APIC、CLOUD_MESOS、CLOUD_LINUXSERVER、CLOUD_DOCKER_UCP、

CLOUD_RANCHER、CLOUD_OSHIFT_K8S、CLOUD_AZURE、CLOUD_GCP。

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

备注

注意

示例

- name: Create a VMware cloud with write access mode
  community.network.avi_cloud:
    username: '{{ username }}'
    controller: '{{ controller }}'
    password: '{{ password }}'
    apic_mode: false
    dhcp_enabled: true
    enable_vip_static_routes: false
    license_type: LIC_CORES
    mtu: 1500
    name: vCenter Cloud
    prefer_static_routes: false
    tenant_ref: admin
    vcenter_configuration:
      datacenter_ref: /api/vimgrdcruntime/datacenter-2-10.10.20.100
      management_network: /api/vimgrnwruntime/dvportgroup-103-10.10.20.100
      password: password
      privilege: WRITE_ACCESS
      username: user
      vcenter_url: 10.10.20.100
    vtype: CLOUD_VCENTER

返回值

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

键

描述

obj

字典

云 (api/cloud) 对象

返回：成功、已更改

状态

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

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

作者

  • Gaurav Rastogi (@grastogi23)