cisco.dnac.roles_v1 模块 – 角色 V1 资源模块

注意

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

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

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

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

cisco.dnac 3.1.0 中的新增功能

概要 

管理资源角色 V1 的创建、更新和删除操作。
在 Cisco DNA Center 系统中添加新角色。
从 Cisco DNA Center 系统中删除角色。
更新 Cisco DNA Center 系统中的角色。

注意

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

要求 

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

dnacentersdk >= 2.4.9
python >= 3.5

参数 

参数	注释
description 字符串	角色描述。
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"`
resourceTypes 列表 / 元素=字典	角色的 resourceTypes。
operations 列表 / 元素=字符串	允许应用程序执行的操作列表。可能的值为“gRead”、“gCreate”、“gUpdate”、“gRemove”或这些值的某种组合。
type 字符串	Cisco DNA Center 系统中应用程序的名称。
role 字符串	角色名称。
roleId 字符串	角色 ID。
validate_response_schema 布尔值	用于 Cisco DNA Center SDK 以启用根据 JSON 架构验证请求正文。选项 `false` `true` ← (默认)

备注 

注意

使用的 SDK 方法为 user_and_roles.UserandRoles.add_role_api_v1、user_and_roless.UserandRoles.delete_role_api_v1、user_and_roless.UserandRoles.update_role_api_v1，
使用的路径为 post /dna/system/api/v1/role、delete /dna/system/api/v1/role/{roleId}、put /dna/system/api/v1/role，
不支持 check_mode
插件在控制节点上运行，不使用任何 Ansible 连接插件，而是使用 Cisco DNAC SDK 中的嵌入式连接管理器
以 dnac_ 开头的参数由 Cisco DNAC Python SDK 用于建立连接

另请参阅 

另请参阅

Cisco DNA Center 关于用户和角色 AddRoleAPIV1 的文档: AddRoleAPIV1 API 的完整参考。
Cisco DNA Center 关于用户和角色 DeleteRoleAPIV1 的文档: DeleteRoleAPIV1 API 的完整参考。
Cisco DNA Center 关于用户和角色 UpdateRoleAPIV1 的文档: UpdateRoleAPIV1 API 的完整参考。

示例 

- name: Create
  cisco.dnac.roles_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
    description: string
    resourceTypes:
    - operations:
      - string
      type: string
    role: string

- name: Update all
  cisco.dnac.roles_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
    description: string
    resourceTypes:
    - operations:
      - string
      type: string
    roleId: string

- name: Delete by id
  cisco.dnac.roles_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
    roleId: string

返回值 

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

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

作者

Rafael Campos (@racampos)