community.network.avi_cloudconnectoruser 模块 – 用于设置 CloudConnectorUser Avi RESTful 对象的模块

注意

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

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

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

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

注意

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

已弃用

在:中移除

版本 6.0.0

原因:

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

替代方案:

未知。

概要

别名：network.avi.avi_cloudconnectoruser

要求

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

  • avisdk

参数

参数

注释

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 操作。

选择

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

azure_serviceprincipal

字符串

在 17.2.1 中引入的字段。

azure_userpass

字符串

在 17.2.1 中引入的字段。

controller

字符串

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

gcp_credentials

字符串

Google Cloud Platform 的凭据。

在 18.2.1 中引入的字段。

name

字符串 / 必需

对象的名称。

oci_credentials

字符串

Oracle Cloud Infrastructure 的凭据。

在 18.2.1、18.1.3 中引入的字段。

password

字符串

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

private_key

字符串

cloudconnectoruser 的 Private_key。

public_key

字符串

cloudconnectoruser 的 Public_key。

state

字符串

应该应用于实体的状态。

选择

  • "absent"

  • "present" ←（默认）

tenant

字符串

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

默认值： "admin"

tenant_ref

字符串

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

tenant_uuid

字符串

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

默认值： ""

tencent_credentials

字符串

腾讯云的凭据。

在 18.2.3 中引入的字段。

url

字符串

对象的 Avi 控制器 URL。

username

字符串

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

uuid

字符串

对象的唯一对象标识符。

注释

注意

示例

- name: Create a Cloud connector user that is used for integration into cloud platforms
  community.network.avi_cloudconnectoruser:
    controller: '{{ controller }}'
    name: root
    password: '{{ password }}'
    private_key: |
      -----BEGIN RSA PRIVATE KEY-----
      -----END RSA PRIVATE KEY-----'
    public_key: 'ssh-rsa ...'
    tenant_ref: admin
    username: '{{ username }}'

返回值

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

键

描述

obj

字典

CloudConnectorUser (api/cloudconnectoruser) 对象

已返回：成功、已更改

状态

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

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

作者

  • Gaurav Rastogi (@grastogi23)