community.network.avi_gslbgeodbprofile 模块 – 用于设置 GslbGeoDbProfile Avi RESTful 对象的模块

注意

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

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

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

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

注意

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

已弃用

在以下版本中移除：

版本 6.0.0

原因：

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

替代方案：

未知。

概要

别名：network.avi.avi_gslbgeodbprofile

要求

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

  • 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 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

controller

字符串

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

description

字符串

在 17.1.1 版中引入的字段。

entries

字符串

地理数据库条目的列表。

条目可以是地理数据库文件或具有地理属性的 IP 地址组。

在 17.1.1 版中引入的字段。

is_federated

布尔值

此字段表示此对象在 GSLB 联合体中进行复制。

该字段在 17.1.3 版本中引入。

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

选项

  • false

  • true

名称

字符串 / 必填

GeoDB 配置文件的用户友好型名称。

在 17.1.1 版中引入的字段。

password

字符串

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

状态

字符串

应应用于实体的状态。

选项

  • “absent”（不存在）

  • "present" ← (默认)

tenant

字符串

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

默认值： "admin"

tenant_ref

字符串

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

在 17.1.1 版中引入的字段。

tenant_uuid

字符串

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

默认值： ""

URL

字符串

对象的 Avi Controller URL。

username

字符串

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

UUID

字符串

GeoDB 配置文件的 UUID。

在 17.1.1 版中引入的字段。

备注

注意

示例

- name: Example to create GslbGeoDbProfile object
  community.network.avi_gslbgeodbprofile:
    controller: 10.10.25.42
    username: admin
    password: something
    state: present
    name: sample_gslbgeodbprofile

返回值

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

键

描述

obj

字典

GslbGeoDbProfile (api/gslbgeodbprofile) 对象

返回：成功，已更改

状态

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

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

作者

  • Gaurav Rastogi (@grastogi23)