community.network.avi_ipaddrgroup 模块 – 用于设置 IpAddrGroup Avi RESTful 对象的模块

注意

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

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

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

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

注意

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

已弃用

在:中删除

版本 6.0.0

原因:

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

替代方案:

未知。

概要

别名：network.avi.avi_ipaddrgroup

要求

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

  • avisdk

参数

参数

注释

addrs

字符串

配置 IP 地址。

api_context

字典

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

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

api_version

字符串

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

默认值： "16.4.4"

apic_epg_name

字符串

从此 cisco apic epg 的成员填充 IP 地址。

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"

controller

字符串

Avi 控制器 IP 或 SQDN

csrftoken

字符串

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

默认值： ""

password

字符串

Avi 控制器密码

port

字符串

Avi 控制器端口

session_id

字符串

Avi 控制器 API 会话 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。

country_codes

字符串

从此国家/地区的地理数据库中填充 IP 地址范围。

description

字符串

用户定义的对象描述。

ip_ports

字符串

配置（IP 地址、端口）元组。

marathon_app_name

字符串

从此 marathon 应用程序的任务填充 IP 地址。

marathon_service_port

字符串

与 marathon 服务端口关联的任务端口。

如果 marathon 应用程序有多个服务端口，则这是必需的。

否则，将使用第一个任务端口。

name

字符串 / 必需

IP 地址组的名称。

password

字符串

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

prefixes

字符串

配置 IP 地址前缀。

ranges

字符串

配置 IP 地址范围。

state

字符串

应在实体上应用的状态。

选项

  • "absent"

  • "present" ← (默认)

tenant

字符串

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

默认值： "admin"

tenant_ref

字符串

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

tenant_uuid

字符串

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

默认值： ""

url

字符串

对象的 Avi 控制器 URL。

username

字符串

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

uuid

字符串

IP 地址组的 UUID。

说明

注意

示例

- name: Create an IP Address Group configuration
  community.network.avi_ipaddrgroup:
    controller: '{{ controller }}'
    username: '{{ username }}'
    password: '{{ password }}'
    name: Client-Source-Block
    prefixes:
    - ip_addr:
        addr: 10.0.0.0
        type: V4
      mask: 8
    - ip_addr:
        addr: 172.16.0.0
        type: V4
      mask: 12
    - ip_addr:
        addr: 192.168.0.0
        type: V4
      mask: 16

返回值

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

键

描述

obj

字典

IpAddrGroup (api/ipaddrgroup) 对象

返回： 成功, 已更改

状态

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

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

作者

  • Gaurav Rastogi (@grastogi23)