community.network.avi_stringgroup 模块 – 用于设置 StringGroup Avi RESTful 对象的模块

注意

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

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

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

要在 Playbook 中使用它，请指定：community.network.avi_stringgroup。

注意

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

已弃用

在以下版本中删除:

版本 6.0.0

原因:

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

替代方案:

未知。

概要

别名：network.avi.avi_stringgroup

要求

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

  • avisdk

参数

参数

注释

api_context

字典

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

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

api_version

字符串

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

默认值: "16.4.4"

avi_api_patch_op

字符串

当使用 avi_api_update_method 作为补丁时要使用的补丁操作。

选择

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

控制器

字符串

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

描述

字符串

用户定义的对象描述。

kv

字符串

在字符串组中配置键值。

名称

字符串 / 必需

字符串组的名称。

密码

字符串

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

状态

字符串

应应用于实体的状态。

选择

  • "absent"

  • "present" ← (默认)

租户

字符串

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

默认值: "admin"

tenant_ref

字符串

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

tenant_uuid

字符串

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

默认值: ""

类型

字符串 / 必需

字符串组的类型。

枚举选项 - SG_TYPE_STRING、SG_TYPE_KEYVAL。

当在 API 或模块中未指定时，Avi 控制器会将默认值解释为 SG_TYPE_STRING。

url

字符串

对象的 Avi 控制器 URL。

用户名

字符串

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

uuid

字符串

字符串组的 UUID。

注释

注意

示例

- name: Create a string group configuration
  community.network.avi_stringgroup:
    controller: '{{ controller }}'
    password: '{{ password }}'
    username: '{{ username }}'
    kv:
    - key: text/html
    - key: text/xml
    - key: text/plain
    - key: text/css
    - key: text/javascript
    - key: application/javascript
    - key: application/x-javascript
    - key: application/xml
    - key: application/pdf
    name: System-Compressible-Content-Types
    tenant_ref: admin
    type: SG_TYPE_STRING

返回值

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

键

描述

obj

字典

StringGroup (api/stringgroup) 对象

返回： success, changed

状态

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

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

作者

  • Gaurav Rastogi (@grastogi23)