cisco.dnac.user 模块 – 用户资源模块

注意

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

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

要安装它，请使用：ansible-galaxy collection install cisco.dnac。您需要进一步的要求才能使用此模块，请参阅要求以获取详细信息。

要在 Playbook 中使用它，请指定：cisco.dnac.user。

cisco.dnac 3.1.0 中的新增功能

概要 

此模块表示模块 user_v1 的别名

注意

此模块具有相应的操作插件。

要求 

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

dnacentersdk >= 2.4.9
python >= 3.5

参数 

参数	注释
dnac_debug 布尔值	Cisco DNA Center SDK 用于启用调试的标志。选择 `false` ← (默认) `true`
dnac_host 字符串 / 必需	Cisco DNA Center 主机名。
dnac_password 字符串	用于身份验证的 Cisco DNA Center 密码。
dnac_port 整数	Cisco DNA Center 端口。默认值： `443`
dnac_username 别名：user 字符串	用于身份验证的 Cisco DNA Center 用户名。默认值： `"admin"`
dnac_verify 布尔值	启用或禁用 SSL 证书验证的标志。选择 `false` `true` ← (默认)
dnac_version 字符串	通知 SDK 使用哪个版本的 Cisco DNA Center。默认值： `"2.3.7.6"`
email 字符串	电子邮件。
firstName 字符串	名字。
lastName 字符串	姓氏。
password 字符串	密码。
roleList 列表 / 元素=字符串	角色 ID 列表。
userId 字符串	用户 ID。
username 字符串	用户名。
validate_response_schema 布尔值	Cisco DNA Center SDK 用于启用针对 JSON 模式验证请求体的标志。选择 `false` `true` ← (默认)

说明 

注意

使用的 SDK 方法是 user_and_roles.UserandRoles.add_user_api_v1、user_and_roles.UserandRoles.delete_user_api_v1、user_and_roles.UserandRoles.update_user_api_v1，
使用的路径是 post /dna/system/api/v1/user、delete /dna/system/api/v1/user/{userId}、put /dna/system/api/v1/user，
应该注意的是，此模块是 user_v1 的别名
不支持 check_mode
该插件在控制节点上运行，不使用任何 Ansible 连接插件，而是使用 Cisco DNAC SDK 中的嵌入式连接管理器
以 dnac_ 开头的参数由 Cisco DNAC Python SDK 用于建立连接

另请参阅 

另请参阅

Cisco DNA Center 关于用户和角色 AddUserAPIV1 的文档: AddUserAPIV1 API 的完整参考。
Cisco DNA Center 关于用户和角色 DeleteUserAPIV1 的文档: DeleteUserAPIV1 API 的完整参考。
Cisco DNA Center 关于用户和角色 UpdateUserAPIV1 的文档: UpdateUserAPIV1 API 的完整参考。

示例 

- name: Create
  cisco.dnac.user:
    dnac_host: "{{dnac_host}}"
    dnac_username: "{{dnac_username}}"
    dnac_password: "{{dnac_password}}"
    dnac_verify: "{{dnac_verify}}"
    dnac_port: "{{dnac_port}}"
    dnac_version: "{{dnac_version}}"
    dnac_debug: "{{dnac_debug}}"
    state: present
    email: string
    firstName: string
    lastName: string
    password: string
    roleList:
    - string
    username: string

- name: Update all
  cisco.dnac.user:
    dnac_host: "{{dnac_host}}"
    dnac_username: "{{dnac_username}}"
    dnac_password: "{{dnac_password}}"
    dnac_verify: "{{dnac_verify}}"
    dnac_port: "{{dnac_port}}"
    dnac_version: "{{dnac_version}}"
    dnac_debug: "{{dnac_debug}}"
    state: present
    email: string
    firstName: string
    lastName: string
    roleList:
    - string
    userId: string
    username: string

- name: Delete by id
  cisco.dnac.user:
    dnac_host: "{{dnac_host}}"
    dnac_username: "{{dnac_username}}"
    dnac_password: "{{dnac_password}}"
    dnac_verify: "{{dnac_verify}}"
    dnac_port: "{{dnac_port}}"
    dnac_version: "{{dnac_version}}"
    dnac_debug: "{{dnac_debug}}"
    state: absent
    userId: string

返回值 

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

键	描述
dnac_response 字典	包含 Cisco DNAC Python SDK 返回的响应的字典或列表已返回：始终示例： `{"message": "字符串", "userId": "字符串"}`

作者

Rafael Campos (@racampos)