community.network.avi_user 模块 – Avi 用户模块

注意

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

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

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

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

注意

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

已弃用

在以下版本中删除:

版本 6.0.0

原因:

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

替代方案:

未知。

概要

  • 此模块可用于创建、更新和删除用户。

别名：network.avi.avi_user

要求

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

  • avisdk

参数

参数

注释

访问权限

列表 / 元素=字符串

Vantage 中每种资源类型的访问设置（写入、读取或无访问权限）。

api_context

字典

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

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

api_version

字符串

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

默认值: "16.4.4"

avi_api_patch_op

字符串

当使用 avi_api_update_method 作为 patch 时要使用的 Patch 操作。

选项

  • "添加"

  • "替换"

  • "删除"

avi_api_update_method

字符串

对象更新的默认方法是 HTTP PUT。

设置为 patch 将覆盖该行为以使用 HTTP PATCH。

选项

  • "post"

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

default_tenant_ref

字符串

默认租户参考。

这也可以是完整的 URI，与响应负载中的 URI 相同

默认值: "/api/tenant?name=admin"

电子邮件

字符串

用户的电子邮件地址。当用户丢失密码并请求重置密码时，将使用此字段。请参阅密码恢复。

is_active

布尔值

激活当前用户帐户。

选项

  • false

  • true

is_superuser

布尔值

如果用户需要具有与管理员帐户相同的权限，请将其设置为 true。

选项

  • false

  • true

名称

字符串 / 必需

用户的全名。

obj_password

字符串 / 必需

您可以在此字段中输入新用户或现有用户区分大小写的密码。

obj_username

字符串 / 必需

用户在登录 Avi Vantage 时将提供的名称，例如 jdoe 或 jdoe@avinetworks.com。

密码

字符串

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

状态

字符串

应在实体上应用的状态。

选项

  • "缺席"

  • "present" ← (默认)

租户

字符串

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

默认值: "admin"

tenant_uuid

字符串

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

默认值: ""

user_profile_ref

字符串

引用用户配置文件。

这也可以是完整的 URI，与响应负载中的 URI 相同

用户名

字符串

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

注释

注意

示例

- name: User creation
  community.network.avi_user:
    controller: ""
    username: ""
    password: ""
    api_version: ""
    name: "testuser"
    obj_username: "testuser"
    obj_password: "test123"
    email: "[email protected]"
    access:
      - role_ref: "/api/role?name=Tenant-Admin"
        tenant_ref: "/api/tenant/admin#admin"
    user_profile_ref: "/api/useraccountprofile?name=Default-User-Account-Profile"
    is_active: true
    is_superuser: true
    default_tenant_ref: "/api/tenant?name=admin"

- name: User creation
  community.network.avi_user:
    controller: ""
    username: ""
    password: ""
    api_version: ""
    name: "testuser"
    obj_username: "testuser2"
    obj_password: "password"
    email: "[email protected]"
    access:
      - role_ref: "https://192.0.2.10/api/role?name=Tenant-Admin"
        tenant_ref: "https://192.0.2.10/api/tenant/admin#admin"
    user_profile_ref: "https://192.0.2.10/api/useraccountprofile?name=Default-User-Account-Profile"
    is_active: true
    is_superuser: true
    default_tenant_ref: "https://192.0.2.10/api/tenant?name=admin"

返回值

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

键

描述

obj

字典

Avi REST 资源

返回: success, changed

状态

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

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

作者

  • Shrikant Chaudhari (@gitshrikant)