cisco.catalystcenter.roles_v2 module -- Resource module for Roles V2

Note

This module is part of the cisco.catalystcenter collection (version 2.3.1).

To install it, use: ansible-galaxy collection install cisco.catalystcenter. You need further requirements to be able to use this module, see Requirements for details.

To use it in a playbook, specify: cisco.catalystcenter.roles_v2.

New in cisco.catalystcenter 6.46.0

Synopsis

• Manage operations create, update and delete of the resource Roles V2.

• Add a new role into system v2-.

• Delete a role in the system.

• Update a role in the system v2-.

Note

This module has a corresponding action plugin.

Requirements

The below requirements are needed on the host that executes this module.

• catalystcentersdk >= 3.1.6.0.0

• python >= 3.12

Parameters

Parameter	Comments
catalystcenter_debug boolean	Flag for Cisco Catalyst Center SDK to enable debugging. Choices: :ansible-option-choices-entry-default:`false` ← (default) :ansible-option-choices-entry:`true`
catalystcenter_host string / required	The Cisco Catalyst Center hostname.
catalystcenter_password string	The Cisco Catalyst Center password to authenticate.
catalystcenter_port integer	The Cisco Catalyst Center port. Default: :ansible-option-default:`443`
catalystcenter_username string	The Cisco Catalyst Center username to authenticate. Default: :ansible-option-default:`"admin"`
catalystcenter_verify boolean	Flag to enable or disable SSL certificate verification. Choices: :ansible-option-choices-entry:`false` :ansible-option-choices-entry-default:`true` ← (default)
catalystcenter_version string	Informs the SDK which version of Cisco Catalyst Center to use. Default: :ansible-option-default:`"3.1.6.0"`
description string	Description of role.
id string	Id path parameter. The Id of the role to be deleted.
name string	Name of the role.
permissions list / elements=dictionary	Roles V2's permissions.
operations list / elements=string	List of operations allowed for the application. Possible values are "gRead", "gCreate", "gUpdate", "gRemove", or some combination of these.
type string	Name of the application in the System.
validate_response_schema boolean	Flag for Cisco Catalyst Center SDK to enable the validation of request bodies against a JSON schema. Choices: :ansible-option-choices-entry:`false` :ansible-option-choices-entry-default:`true` ← (default)

Notes

Note

• SDK Method used are userand_roles.UserandRoles.add_role_v2, userand_roles.UserandRoles.delete_role_v2, userand_roles.UserandRoles.update_role_v2,

• Paths used are post /dna/system/api/v2/roles, delete /dna/system/api/v2/roles/{id}, put /dna/system/api/v2/roles/{id},

• Does not support check_mode

• The plugin runs on the control node and does not use any ansible connection plugins,

• but instead uses the embedded connection manager from Cisco CATALYST SDK

See Also

See also

Cisco DNA Center documentation for User and Roles AddRoleV2

Complete reference of the AddRoleV2 API.

Cisco DNA Center documentation for User and Roles DeleteRoleV2

Complete reference of the DeleteRoleV2 API.

Cisco DNA Center documentation for User and Roles UpdateRoleV2

Complete reference of the UpdateRoleV2 API.

Examples

---
- name: Create
  cisco.catalystcenter.roles_v2:
    catalystcenter_host: "{{catalystcenter_host}}"
    catalystcenter_username: "{{catalystcenter_username}}"
    catalystcenter_password: "{{catalystcenter_password}}"
    catalystcenter_verify: "{{catalystcenter_verify}}"
    catalystcenter_port: "{{catalystcenter_port}}"
    catalystcenter_version: "{{catalystcenter_version}}"
    catalystcenter_debug: "{{catalystcenter_debug}}"
    state: present
    description: string
    name: string
    permissions:
      - operations:
          - string
        type: string
- name: Delete by id
  cisco.catalystcenter.roles_v2:
    catalystcenter_host: "{{catalystcenter_host}}"
    catalystcenter_username: "{{catalystcenter_username}}"
    catalystcenter_password: "{{catalystcenter_password}}"
    catalystcenter_verify: "{{catalystcenter_verify}}"
    catalystcenter_port: "{{catalystcenter_port}}"
    catalystcenter_version: "{{catalystcenter_version}}"
    catalystcenter_debug: "{{catalystcenter_debug}}"
    state: absent
    id: string
- name: Update by id
  cisco.catalystcenter.roles_v2:
    catalystcenter_host: "{{catalystcenter_host}}"
    catalystcenter_username: "{{catalystcenter_username}}"
    catalystcenter_password: "{{catalystcenter_password}}"
    catalystcenter_verify: "{{catalystcenter_verify}}"
    catalystcenter_port: "{{catalystcenter_port}}"
    catalystcenter_version: "{{catalystcenter_version}}"
    catalystcenter_debug: "{{catalystcenter_debug}}"
    state: present
    description: string
    id: string
    name: string
    permissions:
      - operations:
          - string
        type: string

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key	Description
dnac_response dictionary	A dictionary or list with the response returned by the Cisco DNAC Python SDK Returned: always Sample: :ansible-rv-sample-value:`{"description": "string", "id": "string", "meta": {"created": "string", "createdBy": "string", "lastModified": "string", "lastModifiedBy": "string"}, "name": "string", "permissions": [{"id": "string", "privilege": "string"}], "type": "string", "version": "string"}`

Authors

• Rafael Campos (@racampos)

Collection links

Issue Tracker Repository (Sources)