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

注意

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

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

要安装它，请使用：ansible-galaxy collection install cisco.mso。您需要进一步的要求才能使用此模块，请参阅 要求 以了解详情。

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

概要

  • 管理 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。

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

用户名

字符串

用于身份验证的用户名。

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

验证证书

布尔值

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

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

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

默认为 true。

选项

  • false

  • true

写入权限

别名：权限

列表 / 元素=字符串

与该角色关联的一系列写入权限。

选项

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