cisco.mso.mso_tenant 模块 – 管理租户

注意

此模块是 cisco.mso 集合 (版本 2.9.0) 的一部分。

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

要安装它，请使用： ansible-galaxy collection install cisco.mso。您需要其他要求才能使用此模块，有关详细信息，请参见 要求。

要在 playbook 中使用它，请指定： cisco.mso.mso_tenant。

概要

  • 管理 Cisco ACI 多站点上的租户。

要求

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

  • 多站点编排器 v2.1 或更高版本

参数

参数

注释

description

字符串

此租户的描述。

display_name

字符串

要在 Web UI 中显示的租户名称。

host

别名：hostname

字符串

ACI 多站点编排器主机的 IP 地址或主机名。

如果任务中未指定该值，则将改为使用环境变量 MSO_HOST 的值。

login_domain

字符串

用于身份验证的登录域名称。

默认值为 Local。

如果任务中未指定该值，则将改为使用环境变量 MSO_LOGIN_DOMAIN 的值。

使用 HTTPAPI 连接插件时，如果未指定此属性，将使用清单变量 ansible_httpapi_login_domain。

orchestrator_only

字符串

仅编排器 no 用于从 MSO 和站点/APIC 删除租户。

yes 用于仅从 MSO 中删除租户。

选项

  • "yes" ← (默认)

  • "no"

output_level

字符串

影响此 MSO 模块的输出。

normal 表示标准输出，包括 current 字典

info 添加信息输出，包括 previous、proposed 和 sent 字典

debug 添加调试输出，包括 filter_string、method、response、status 和 url 信息

如果任务中未指定该值，则将改为使用环境变量 MSO_OUTPUT_LEVEL 的值。

选项

  • "debug"

  • "info"

  • "normal" ← (默认)

password

字符串

用于身份验证的密码。

如果任务中未指定该值，则将改为使用环境变量 MSO_PASSWORD 或 ANSIBLE_NET_PASSWORD 的值。

port

整数

用于 REST 连接的端口号。

默认值取决于参数 `use_ssl`。

如果任务中未指定该值，则将改为使用环境变量 MSO_PORT 的值。

remote_users

列表 / 元素=字典

此租户关联的远程用户列表。

login_domain

字符串 / 必需

此租户关联的远程用户的域名。

name

字符串 / 必需

此租户关联的远程用户的名称。

sites

列表 / 元素=字符串

此租户关联的站点列表。

使用此属性将替换任何现有的关联站点。

state

字符串

使用 present 或 absent 来添加或删除。

使用 query 来列出对象或多个对象。

选项

  • "absent"

  • "present" ← (默认)

  • "query"

tenant

别名：name

字符串

租户的名称。

timeout

整数

以秒为单位的套接字级别超时。

默认值为 30 秒。

如果任务中未指定该值，则将改为使用环境变量 MSO_TIMEOUT 的值。

use_proxy

布尔值

如果为 false，则即使在目标主机上的环境变量中定义了代理，也不会使用代理。

如果任务中未指定值，则将使用环境变量MSO_USE_PROXY的值。

默认值为true。

选项

  • false

  • true

use_ssl

布尔值

如果为false，则将使用HTTP连接而不是默认的HTTPS连接。

如果任务中未指定值，则将使用环境变量MSO_USE_SSL的值。

当使用HTTPAPI连接插件时，如果未指定此属性，则将使用清单变量ansible_httpapi_use_ssl。

使用HTTPAPI连接插件（mso或nd）时，默认值为false；使用传统连接方法（仅适用于mso）时，默认值为true。

选项

  • false

  • true

用户名

字符串

用于身份验证的用户名。

如果任务中未指定值，则将使用环境变量MSO_USERNAME或ANSIBLE_NET_USERNAME的值。

用户

列表 / 元素=字符串

此租户关联用户的列表。

使用此属性将替换任何现有的关联用户。

无论是否使用此参数，管理员用户始终添加到关联用户列表中。

validate_certs

布尔值

如果为false，则不会验证SSL证书。

仅当在使用自签名证书的个人控制站点上使用时，才应将其设置为false。

如果任务中未指定值，则将使用环境变量MSO_VALIDATE_CERTS的值。

默认值为true。

选项

  • false

  • true

注释

注意

  • 此模块编写用于支持Multi Site Orchestrator v2.1或更高版本。某些或所有功能可能在早期版本上无法正常工作。

示例

- name: Add a new tenant
  cisco.mso.mso_tenant:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    tenant: north_europe
    display_name: North European Datacenter
    description: This tenant manages the NEDC environment.
    state: present

- name: Remove a tenant from MSO and Site/APIC
  cisco.mso.mso_tenant:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    tenant: north_europe
    orchestrator_only: 'no'
    state: absent

- name: Remove a tenant from MSO only
  cisco.mso.mso_tenant:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    tenant: north_europe
    orchestrator_only: 'yes'
    state: absent

- name: Query a tenant
  cisco.mso.mso_tenant:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    tenant: north_europe
    state: query
  register: query_result

- name: Query all tenants
  cisco.mso.mso_tenant:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    state: query
  register: query_result

作者

  • Dag Wieers (@dagwieers)