community.network.avi_useraccount 模块 – Avi 用户帐户模块

注意

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

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

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

要在 playbook 中使用它,请指定:community.network.avi_useraccount

注意

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

已弃用

在以下版本中移除:

版本 6.0.0

原因:

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

替代方案:

未知。

概要

  • 此模块可用于更新用户的密码。

  • 此模块对于设置 Controller 引导的管理员密码非常有用。

别名:network.avi.avi_useraccount

要求

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

  • avisdk

参数

参数

注释

api_context

字典

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

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

api_version

字符串

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

默认: "16.4.4"

avi_credentials

字典

Avi 凭据字典,可用于代替枚举 Avi Controller 登录详细信息。

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

force_change

字符串

如果专门设置为 true,则首先尝试控制器的旧密码,然后尝试新密码。如果未指定此标志,则首先尝试新密码。

默认: false

old_password

字符串

用于更新密码的旧密码或用于引导的默认密码。

password

字符串

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

tenant

字符串

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

默认: "admin"

tenant_uuid

字符串

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

默认: ""

username

字符串

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

注释

注意

示例

- name: Update user password
  community.network.avi_useraccount:
    controller: ""
    username: ""
    password: new_password
    old_password: ""
    api_version: ""
    force_change: false

- name: Update user password using avi_credentials
  community.network.avi_useraccount:
    avi_credentials: ""
    old_password: ""
    force_change: false

返回值

常见的返回值记录在这里,以下是此模块特有的字段

描述

obj

字典

Avi REST 资源

返回: 成功, 已更改

状态

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

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

作者

  • Chaitanya Deshpande (@chaitanyaavi)