cisco.dnac.roles 模块 – 角色资源模块

注意

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

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

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

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

cisco.dnac 3.1.0中的新增功能

概要 

此模块代表模块roles_v1的别名

注意

此模块具有相应的 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_roles.UserandRoles.delete_role_api_v1、user_and_roles.UserandRoles.update_role_api_v1，
使用的路径为post /dna/system/api/v1/role、delete /dna/system/api/v1/role/{roleId}、put /dna/system/api/v1/role，
需要注意的是，此模块是roles_v1的别名
不支持 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:
    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:
    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:
    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": "字符串", "roleId": "字符串"}`

作者

Rafael Campos (@racampos)