cisco.mso.mso_role 模块 – 管理角色

注意

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

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

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

要在 Playbook 中使用它，请指定：cisco.mso.mso_role。

概要

  • 管理 Cisco ACI Multi-Site 上的角色。

要求

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

  • Multi Site Orchestrator v2.1 或更高版本

参数

参数

注释

描述

字符串

角色的描述。

display_name

字符串

要在 Web UI 中显示的角色名称。

host

别名：hostname

字符串

ACI Multi Site Orchestrator 主机的 IP 地址或主机名。

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

login_domain

字符串

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

默认值为 Local。

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

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

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 的值。

read_permissions

列表 / 元素=字符串

与此角色绑定的读取权限列表。

选项

  • "backup-db"

  • "manage-audit-records"

  • "manage-labels"

  • "manage-roles"

  • "manage-schemas"

  • "manage-sites"

  • "manage-tenants"

  • "manage-tenant-schemas"

  • "manage-users"

  • "platform-logs"

  • "view-all-audit-records"

  • "view-labels"

  • "view-roles"

  • "view-schemas"

  • "view-sites"

  • "view-tenants"

  • "view-tenant-schemas"

  • "view-users"

role

别名：name

字符串

角色名称。

state

字符串

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

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

选项

  • "absent"

  • "present" ← (默认)

  • "query"

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

username

字符串

用于身份验证的用户名。

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

validate_certs

布尔值

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

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

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

默认值为 true。

选项

  • false

  • true

write_permissions

别名: permissions

列表 / 元素=字符串

与此角色关联的写入权限列表。

选项

  • "backup-db"

  • "manage-audit-records"

  • "manage-labels"

  • "manage-roles"

  • "manage-schemas"

  • "manage-sites"

  • "manage-tenants"

  • "manage-tenant-schemas"

  • "manage-users"

  • "platform-logs"

  • "view-all-audit-records"

  • "view-labels"

  • "view-roles"

  • "view-schemas"

  • "view-sites"

  • "view-tenants"

  • "view-tenant-schemas"

  • "view-users"

注释

注意

  • 此模块旨在支持 Multi Site Orchestrator v2.1 或更高版本。某些或全部功能可能在早期版本上无法工作。

示例

- name: Add a new role
  cisco.mso.mso_role:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    role: readOnly
    display_name: Read Only
    description: Read-only access for troubleshooting
    read_permissions:
      - view-roles
      - view-schemas
      - view-sites
      - view-tenants
      - view-tenant-schemas
      - view-users
    write_permissions:
      - manage-roles
      - manage-schemas
      - manage-sites
      - manage-tenants
      - manage-tenant-schemas
      - manage-users
    state: present

- name: Remove a role
  cisco.mso.mso_role:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    role: readOnly
    state: absent

- name: Query a role
  cisco.mso.mso_role:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    role: readOnly
    state: query
  register: query_result

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

作者

  • Dag Wieers (@dagwieers)