cisco.mso.mso_user 模块 – 用户管理

注意

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

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

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

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

概要 

管理 Cisco ACI 多站点上的用户。

要求 

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

多站点协调器 v2.1 或更高版本

参数 

参数	注释
account_status 字符串	用户帐户的状态。选项 `"active"` `"inactive"`
domain 字符串	此用户所属的域。创建新用户时，默认为 `Local`。
email 字符串	用户的电子邮件地址。创建新用户时，此参数是必需的。
first_name 字符串	用户的姓名。创建新用户时，此参数是必需的。
host 别名：hostname 字符串	ACI 多站点协调器主机的 IP 地址或主机名。如果任务中未指定此值，则将使用环境变量 `MSO_HOST` 的值。
last_name 字符串	用户的姓氏。创建新用户时，此参数是必需的。
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` 的值。
phone 字符串	用户的电话号码。创建新用户时，此参数是必需的。
port 整数	用于 REST 连接的端口号。默认值取决于参数 `use_ssl`。如果任务中未指定此值，则将使用环境变量 `MSO_PORT` 的值。
roles 列表 / 元素=字符串	此用户的角色及其访问类型（读或写）。访问类型默认为 `write`。
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`
用户别名：名称字符串	用户名。
user_password 字符串	用户的密码。
username 字符串	用于身份验证的用户名。如果任务中未指定值，则将使用环境变量`MSO_USERNAME`或`ANSIBLE_NET_USERNAME`的值。
validate_certs 布尔型	如果为`false`，则不会验证SSL证书。只有在使用自签名证书的个人控制站点时，才应将其设置为`false`。如果任务中未指定值，则将使用环境变量`MSO_VALIDATE_CERTS`的值。默认为`true`。选项 `false` `true`

备注 

注意

ACI Multi-Site的默认安装程序的管理员密码为“we1come!”，首次登录时需要更改密码。请参阅如何使用Ansible更改“admin”密码的示例。
此模块编写用于支持Multi Site Orchestrator v2.1或更高版本。早期版本可能无法使用部分或全部功能。

示例 

- name: Update initial admin password
  cisco.mso.mso_user:
    host: mso_host
    username: admin
    password: initialPassword
    validate_certs: false
    user: admin
    user_password: newPassword
    state: present

- name: Add a new user
  cisco.mso.mso_user:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    validate_certs: false
    user: dag
    user_password: userPassword
    first_name: Dag
    last_name: Wieers
    email: [email protected]
    phone: +32 478 436 299
    roles:
      - name: siteManager
        access_type: write
      - name: schemaManager
        access_type: read
    state: present

- name: Add a new user
  cisco.mso.mso_user:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    validate_certs: false
    user: dag
    first_name: Dag
    last_name: Wieers
    email: [email protected]
    phone: +32 478 436 299
    roles:
      - powerUser

- name: Remove a user
  cisco.mso.mso_user:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    validate_certs: false
    user: dag
    state: absent

- name: Query a user
  cisco.mso.mso_user:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    validate_certs: false
    user: dag
    state: query
  register: query_result

- name: Query all users
  cisco.mso.mso_user:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    validate_certs: false
    state: query
  register: query_result

作者

Dag Wieers (@dagwieers)