cisco.dnac.roles_v1 模块 – Roles 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 中的新增功能

概要 

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

注意

此模块有一个对应的 action 插件。

要求 

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

dnacentersdk >= 2.4.9
python >= 3.5

参数 

参数	注释
description string	角色的描述。
dnac_debug boolean	Cisco DNA Center SDK 的标志，用于启用调试。选项 `false` ←（默认） `true`
dnac_host string / 必填	Cisco DNA 中心的主机名。
dnac_password string	用于身份验证的 Cisco DNA 中心密码。
dnac_port integer	Cisco DNA 中心的端口。默认值： `443`
dnac_username 别名：user string	用于身份验证的 Cisco DNA 中心用户名。默认值： `"admin"`
dnac_verify boolean	用于启用或禁用 SSL 证书验证的标志。选项 `false` `true` ←（默认）
dnac_version string	通知 SDK 要使用的 Cisco DNA 中心版本。默认值： `"2.3.7.6"`
resourceTypes list / 元素=dictionary	角色的 resourceTypes。
operations list / 元素=string	允许应用程序进行的操作列表。可能的值为“gRead”、“gCreate”、“gUpdate”、“gRemove”或这些值的某种组合。
type string	Cisco DNA 中心系统中应用程序的名称。
role string	角色的名称。
roleId string	角色的 ID。
validate_response_schema boolean	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 中心关于用户和角色 AddRoleAPIV1 的文档: AddRoleAPIV1 API 的完整参考。
Cisco DNA 中心关于用户和角色 DeleteRoleAPIV1 的文档: DeleteRoleAPIV1 API 的完整参考。
Cisco DNA 中心关于用户和角色 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 dictionary	一个字典或列表，其中包含 Cisco DNAC Python SDK 返回的响应已返回：始终示例： `{"message": "string", "roleId": "string"}`

作者

Rafael Campos (@racampos)