cisco.dnac.user_v1 模块 – 用户 V1 资源模块

注意

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

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

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

要在 playbook 中使用它，请指定：cisco.dnac.user_v1。

cisco.dnac 3.1.0 中的新增功能

概要 

管理资源 User V1 的创建、更新和删除操作。
为 Cisco DNA Center 系统添加新用户。
从 Cisco DNA Center 系统中删除用户。
更新 Cisco DNA Center 系统的用户。

注意

此模块具有相应的 action 插件。

要求 

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

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，
不支持 check_mode
插件在控制节点上运行，不使用任何 Ansible 连接插件，而是使用 Cisco DNAC SDK 中的嵌入式连接管理器
以 dnac_ 开头的参数由 Cisco DNAC Python SDK 用于建立连接

另请参见 

另请参见

Cisco DNA Center User and Roles AddUserAPIV1 文档: AddUserAPIV1 API 的完整参考。
Cisco DNA Center User and Roles DeleteUserAPIV1 文档: DeleteUserAPIV1 API 的完整参考。
Cisco DNA Center User and Roles UpdateUserAPIV1 文档: UpdateUserAPIV1 API 的完整参考。

示例 

- name: Create
  cisco.dnac.user_v1:
    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_v1:
    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_v1:
    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": "string", "userId": "string"}`

作者

Rafael Campos (@racampos)