.. Document meta :orphan: .. |antsibull-internal-nbsp| unicode:: 0xA0 :trim: .. role:: ansible-attribute-support-label .. role:: ansible-attribute-support-property .. role:: ansible-attribute-support-full .. role:: ansible-attribute-support-partial .. role:: ansible-attribute-support-none .. role:: ansible-attribute-support-na .. role:: ansible-option-type .. role:: ansible-option-elements .. role:: ansible-option-required .. role:: ansible-option-versionadded .. role:: ansible-option-aliases .. role:: ansible-option-choices .. role:: ansible-option-choices-default-mark .. role:: ansible-option-default-bold .. role:: ansible-option-configuration .. role:: ansible-option-returned-bold .. role:: ansible-option-sample-bold .. Anchors .. _ansible_collections.cisco.dnac.user_role_workflow_manager_module: .. Anchors: short name for ansible.builtin .. Anchors: aliases .. Title cisco.dnac.user_role_workflow_manager module -- Resource module for managing users and roles in Cisco Catalyst Center. ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. Collection note .. note:: This module is part of the `cisco.dnac collection `_ (version 6.27.0). To install it, use: :code:`ansible-galaxy collection install cisco.dnac`. You need further requirements to be able to use this module, see :ref:`Requirements ` for details. To use it in a playbook, specify: :code:`cisco.dnac.user_role_workflow_manager`. .. version_added .. rst-class:: ansible-version-added New in cisco.dnac 6.17.0 .. contents:: :local: :depth: 1 .. Deprecated Synopsis -------- .. Description - Manages operations to create, update, and delete users and roles in Cisco Catalyst Center. - Provides APIs to create, update, and delete users and roles. .. Aliases .. Requirements .. _ansible_collections.cisco.dnac.user_role_workflow_manager_module_requirements: Requirements ------------ The below requirements are needed on the host that executes this module. - dnacentersdk \>= 2.7.2 - python \>= 3.9.19 .. Options Parameters ---------- .. rst-class:: ansible-option-table .. list-table:: :width: 100% :widths: auto :header-rows: 1 * - Parameter - Comments * - .. raw:: html

.. _ansible_collections.cisco.dnac.user_role_workflow_manager_module__parameter-config: .. rst-class:: ansible-option-title **config** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` / :ansible-option-required:`required` .. raw:: html

- .. raw:: html

A dictionary containing the configuration details for users or roles. .. raw:: html

* - .. raw:: html

.. _ansible_collections.cisco.dnac.user_role_workflow_manager_module__parameter-config/role_details: .. rst-class:: ansible-option-title **role_details** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`list` / :ansible-option-elements:`elements=dictionary` .. raw:: html

- .. raw:: html

Manages the configuration details for roles. .. raw:: html

* - .. raw:: html

.. _ansible_collections.cisco.dnac.user_role_workflow_manager_module__parameter-config/role_details/assurance: .. rst-class:: ansible-option-title **assurance** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html

- .. raw:: html

Ensure consistent service levels with complete visibility across all aspects of the network. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`"deny"` - :ansible-option-choices-entry-default:`"read"` :ansible-option-choices-default-mark:`← (default)` - :ansible-option-choices-entry:`"write"` .. raw:: html

* - .. raw:: html

.. _ansible_collections.cisco.dnac.user_role_workflow_manager_module__parameter-config/role_details/assurance/monitoring_and_troubleshooting: .. rst-class:: ansible-option-title **monitoring_and_troubleshooting** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html

- .. raw:: html

Monitor and manage network health, troubleshoot issues, and perform remediation. Includes proactive network monitoring and AI-driven insights. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`"deny"` - :ansible-option-choices-entry-default:`"read"` :ansible-option-choices-default-mark:`← (default)` - :ansible-option-choices-entry:`"write"` .. raw:: html

* - .. raw:: html

.. _ansible_collections.cisco.dnac.user_role_workflow_manager_module__parameter-config/role_details/assurance/monitoring_settings: .. rst-class:: ansible-option-title **monitoring_settings** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html

- .. raw:: html

Configure and manage health thresholds for the network, clients, and applications. Requires at least 'read' permission for Monitoring and Troubleshooting. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`"deny"` - :ansible-option-choices-entry-default:`"read"` :ansible-option-choices-default-mark:`← (default)` - :ansible-option-choices-entry:`"write"` .. raw:: html

* - .. raw:: html

.. _ansible_collections.cisco.dnac.user_role_workflow_manager_module__parameter-config/role_details/assurance/overall: .. rst-class:: ansible-option-title **overall** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html

- .. raw:: html

Set the same access level for all sub-parameters. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`"deny"` - :ansible-option-choices-entry-default:`"read"` :ansible-option-choices-default-mark:`← (default)` - :ansible-option-choices-entry:`"write"` .. raw:: html

* - .. raw:: html

.. _ansible_collections.cisco.dnac.user_role_workflow_manager_module__parameter-config/role_details/assurance/troubleshooting_tools: .. rst-class:: ansible-option-title **troubleshooting_tools** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html

- .. raw:: html

Create and manage sensor tests. Schedule on-demand forensic packet captures (Intelligent Capture) for troubleshooting clients. Requires at least 'read' permission for Monitoring and Troubleshooting. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`"deny"` - :ansible-option-choices-entry-default:`"read"` :ansible-option-choices-default-mark:`← (default)` - :ansible-option-choices-entry:`"write"` .. raw:: html

* - .. raw:: html

.. _ansible_collections.cisco.dnac.user_role_workflow_manager_module__parameter-config/role_details/description: .. rst-class:: ansible-option-title **description** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html

- .. raw:: html

A brief description of the role's purpose and scope. .. raw:: html

* - .. raw:: html

.. _ansible_collections.cisco.dnac.user_role_workflow_manager_module__parameter-config/role_details/network_analytics: .. rst-class:: ansible-option-title **network_analytics** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html

- .. raw:: html

Manage components related to network analytics. .. raw:: html

* - .. raw:: html

.. _ansible_collections.cisco.dnac.user_role_workflow_manager_module__parameter-config/role_details/network_analytics/data_access: .. rst-class:: ansible-option-title **data_access** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html

- .. raw:: html

Enable access to query engine APIs. Manage functions such as global search, rogue management, and aWIPS. Setting this to 'deny' affects Search and Assurance functionality. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`"deny"` - :ansible-option-choices-entry-default:`"read"` :ansible-option-choices-default-mark:`← (default)` - :ansible-option-choices-entry:`"write"` .. raw:: html

* - .. raw:: html

.. _ansible_collections.cisco.dnac.user_role_workflow_manager_module__parameter-config/role_details/network_analytics/overall: .. rst-class:: ansible-option-title **overall** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html

- .. raw:: html

* - .. raw:: html

.. _ansible_collections.cisco.dnac.user_role_workflow_manager_module__parameter-config/role_details/network_design: .. rst-class:: ansible-option-title **network_design** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html

- .. raw:: html

Set up the network hierarchy, update the software image repository, and configure network profiles and settings for managing sites and network devices. .. raw:: html

* - .. raw:: html

.. _ansible_collections.cisco.dnac.user_role_workflow_manager_module__parameter-config/role_details/network_design/advanced_network_settings: .. rst-class:: ansible-option-title **advanced_network_settings** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html

- .. raw:: html

Update network settings, including global device credentials, authentication and policy servers, certificates, trustpool, cloud access keys, stealthwatch, umbrella, and data anonymization. Export the device inventory and its credentials. Requires at least 'read' permission on Network Settings. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`"deny"` - :ansible-option-choices-entry-default:`"read"` :ansible-option-choices-default-mark:`← (default)` - :ansible-option-choices-entry:`"write"` .. raw:: html

* - .. raw:: html

.. _ansible_collections.cisco.dnac.user_role_workflow_manager_module__parameter-config/role_details/network_design/image_repository: .. rst-class:: ansible-option-title **image_repository** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html

- .. raw:: html

Manage software images and facilitate upgrades and updates on physical and virtual network entities .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`"deny"` - :ansible-option-choices-entry-default:`"read"` :ansible-option-choices-default-mark:`← (default)` - :ansible-option-choices-entry:`"write"` .. raw:: html

* - .. raw:: html

.. _ansible_collections.cisco.dnac.user_role_workflow_manager_module__parameter-config/role_details/network_design/network_hierarchy: .. rst-class:: ansible-option-title **network_hierarchy** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html

- .. raw:: html

Define and create a network hierarchy of sites, buildings, floors, and areas based on geographic location. .. raw:: html

* - .. raw:: html

.. _ansible_collections.cisco.dnac.user_role_workflow_manager_module__parameter-config/role_details/network_design/network_profiles: .. rst-class:: ansible-option-title **network_profiles** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html

- .. raw:: html

Create network profiles for routing, switching, and wireless. Assign profiles to sites. Includes roles such as template editor, tagging, model config editor, and authentication template. To create SSIDs, 'write' permission on network settings is required. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`"deny"` - :ansible-option-choices-entry-default:`"read"` :ansible-option-choices-default-mark:`← (default)` - :ansible-option-choices-entry:`"write"` .. raw:: html

* - .. raw:: html

.. _ansible_collections.cisco.dnac.user_role_workflow_manager_module__parameter-config/role_details/network_design/network_settings: .. rst-class:: ansible-option-title **network_settings** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html

- .. raw:: html

Manage common site-wide network settings such as AAA, NTP, DHCP, DNS, Syslog, SNMP, and Telemetry. Users in this role can add an SFTP server and adjust the Network Resync Interval found under Systems \> Settings. To create wireless profiles, 'write' permission on Network Profiles is required. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`"deny"` - :ansible-option-choices-entry-default:`"read"` :ansible-option-choices-default-mark:`← (default)` - :ansible-option-choices-entry:`"write"` .. raw:: html

* - .. raw:: html

.. _ansible_collections.cisco.dnac.user_role_workflow_manager_module__parameter-config/role_details/network_design/overall: .. rst-class:: ansible-option-title **overall** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html

- .. raw:: html

* - .. raw:: html

.. _ansible_collections.cisco.dnac.user_role_workflow_manager_module__parameter-config/role_details/network_design/virtual_network: .. rst-class:: ansible-option-title **virtual_network** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html

- .. raw:: html

Manage virtual networks (VNs). Segment physical networks into multiple logical networks for traffic isolation and controlled inter-VN communication. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`"deny"` - :ansible-option-choices-entry-default:`"read"` :ansible-option-choices-default-mark:`← (default)` - :ansible-option-choices-entry:`"write"` .. raw:: html

* - .. raw:: html

.. _ansible_collections.cisco.dnac.user_role_workflow_manager_module__parameter-config/role_details/network_provision: .. rst-class:: ansible-option-title **network_provision** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html

- .. raw:: html

Configure, upgrade, provision, and manage network devices. .. raw:: html

* - .. raw:: html

.. _ansible_collections.cisco.dnac.user_role_workflow_manager_module__parameter-config/role_details/network_provision/compliance: .. rst-class:: ansible-option-title **compliance** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html

- .. raw:: html

Manage compliance provisioning. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`"deny"` - :ansible-option-choices-entry-default:`"read"` :ansible-option-choices-default-mark:`← (default)` - :ansible-option-choices-entry:`"write"` .. raw:: html

* - .. raw:: html

.. _ansible_collections.cisco.dnac.user_role_workflow_manager_module__parameter-config/role_details/network_provision/exo: .. rst-class:: ansible-option-title **exo** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html

- .. raw:: html

Scan the network for End of Life, End of Sales, or End of Support information for hardware and software. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`"deny"` - :ansible-option-choices-entry-default:`"read"` :ansible-option-choices-default-mark:`← (default)` - :ansible-option-choices-entry:`"write"` .. raw:: html

* - .. raw:: html

.. _ansible_collections.cisco.dnac.user_role_workflow_manager_module__parameter-config/role_details/network_provision/image_update: .. rst-class:: ansible-option-title **image_update** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html

- .. raw:: html

Upgrade software images on devices that do not match the Golden Image settings after a complete upgrade lifecycle. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`"deny"` - :ansible-option-choices-entry-default:`"read"` :ansible-option-choices-default-mark:`← (default)` - :ansible-option-choices-entry:`"write"` .. raw:: html

* - .. raw:: html

.. _ansible_collections.cisco.dnac.user_role_workflow_manager_module__parameter-config/role_details/network_provision/inventory_management: .. rst-class:: ansible-option-title **inventory_management** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`list` / :ansible-option-elements:`elements=dictionary` .. raw:: html

- .. raw:: html

Discover, add, replace, or delete devices while managing device attributes and configuration properties. To replace a device, 'write' permission is required for pnp under network provision. .. raw:: html

* - .. raw:: html

.. _ansible_collections.cisco.dnac.user_role_workflow_manager_module__parameter-config/role_details/network_provision/inventory_management/device_configuration: .. rst-class:: ansible-option-title **device_configuration** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html

- .. raw:: html

Display the running configuration of a device. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`"deny"` - :ansible-option-choices-entry-default:`"read"` :ansible-option-choices-default-mark:`← (default)` - :ansible-option-choices-entry:`"write"` .. raw:: html

* - .. raw:: html

.. _ansible_collections.cisco.dnac.user_role_workflow_manager_module__parameter-config/role_details/network_provision/inventory_management/discovery: .. rst-class:: ansible-option-title **discovery** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html

- .. raw:: html

Discover new devices on the network. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`"deny"` - :ansible-option-choices-entry-default:`"read"` :ansible-option-choices-default-mark:`← (default)` - :ansible-option-choices-entry:`"write"` .. raw:: html

* - .. raw:: html

.. _ansible_collections.cisco.dnac.user_role_workflow_manager_module__parameter-config/role_details/network_provision/inventory_management/network_device: .. rst-class:: ansible-option-title **network_device** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html

- .. raw:: html

Add devices from inventory, view device details, and perform device-level actions. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`"deny"` - :ansible-option-choices-entry-default:`"read"` :ansible-option-choices-default-mark:`← (default)` - :ansible-option-choices-entry:`"write"` .. raw:: html

* - .. raw:: html

.. _ansible_collections.cisco.dnac.user_role_workflow_manager_module__parameter-config/role_details/network_provision/inventory_management/overall: .. rst-class:: ansible-option-title **overall** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html

- .. raw:: html

Provides the same choice for all sub-parameters. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`"deny"` - :ansible-option-choices-entry-default:`"read"` :ansible-option-choices-default-mark:`← (default)` - :ansible-option-choices-entry:`"write"` .. raw:: html

* - .. raw:: html

.. _ansible_collections.cisco.dnac.user_role_workflow_manager_module__parameter-config/role_details/network_provision/inventory_management/port_management: .. rst-class:: ansible-option-title **port_management** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html

- .. raw:: html

Allow port actions on a device. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`"deny"` - :ansible-option-choices-entry-default:`"read"` :ansible-option-choices-default-mark:`← (default)` - :ansible-option-choices-entry:`"write"` .. raw:: html

* - .. raw:: html

.. _ansible_collections.cisco.dnac.user_role_workflow_manager_module__parameter-config/role_details/network_provision/inventory_management/topology: .. rst-class:: ansible-option-title **topology** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html

- .. raw:: html

Display the network device and link connectivity. Manage device roles, tag devices, customize the display, and save custom topology layouts. To view the SD-Access Fabric window, at least 'read' permission on "Network Provision \> Inventory Management \> Topology" is required. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`"deny"` - :ansible-option-choices-entry-default:`"read"` :ansible-option-choices-default-mark:`← (default)` - :ansible-option-choices-entry:`"write"` .. raw:: html

* - .. raw:: html

.. _ansible_collections.cisco.dnac.user_role_workflow_manager_module__parameter-config/role_details/network_provision/license: .. rst-class:: ansible-option-title **license** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html

- .. raw:: html

Unified view of software and network assets related to license usage and compliance. Also controls permissions for cisco.com and Smart accounts. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`"deny"` - :ansible-option-choices-entry-default:`"read"` :ansible-option-choices-default-mark:`← (default)` - :ansible-option-choices-entry:`"write"` .. raw:: html

* - .. raw:: html

.. _ansible_collections.cisco.dnac.user_role_workflow_manager_module__parameter-config/role_details/network_provision/network_telemetry: .. rst-class:: ansible-option-title **network_telemetry** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html

- .. raw:: html

Enable or disable the collection of application telemetry from devices. Configure telemetry settings for the assigned site. Configure additional settings such as wireless service assurance and controller certificates. To enable or disable network telemetry, 'write' permission on Provision is required. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`"deny"` - :ansible-option-choices-entry-default:`"read"` :ansible-option-choices-default-mark:`← (default)` - :ansible-option-choices-entry:`"write"` .. raw:: html

* - .. raw:: html

.. _ansible_collections.cisco.dnac.user_role_workflow_manager_module__parameter-config/role_details/network_provision/overall: .. rst-class:: ansible-option-title **overall** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html

- .. raw:: html

* - .. raw:: html

.. _ansible_collections.cisco.dnac.user_role_workflow_manager_module__parameter-config/role_details/network_provision/pnp: .. rst-class:: ansible-option-title **pnp** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html

- .. raw:: html

Automatically onboard new devices, assign them to sites, and configure them with site-specific settings. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`"deny"` - :ansible-option-choices-entry-default:`"read"` :ansible-option-choices-default-mark:`← (default)` - :ansible-option-choices-entry:`"write"` .. raw:: html

* - .. raw:: html

.. _ansible_collections.cisco.dnac.user_role_workflow_manager_module__parameter-config/role_details/network_provision/provision: .. rst-class:: ansible-option-title **provision** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html

- .. raw:: html

Provision devices with site-specific settings and network policies. Includes roles such as Fabric, Application Policy, Application Visibility, Cloud, Site-to-Site VPN, Network/Application Telemetry, Stealthwatch, Sync Start vs Run Configuration, and Umbrella provisioning. On the main dashboards for rogue and aWIPS, certain actions, including rogue containment, can be enabled or disabled. To provision devices, 'write' permission on Network Design and Network Provision is required. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`"deny"` - :ansible-option-choices-entry-default:`"read"` :ansible-option-choices-default-mark:`← (default)` - :ansible-option-choices-entry:`"write"` .. raw:: html

* - .. raw:: html

.. _ansible_collections.cisco.dnac.user_role_workflow_manager_module__parameter-config/role_details/network_services: .. rst-class:: ansible-option-title **network_services** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html

- .. raw:: html

Configure additional capabilities on the network beyond basic network connectivity and access. .. rst-class:: ansible-option-line :ansible-option-default-bold:`Default:` :ansible-option-default:`"read"` .. raw:: html

* - .. raw:: html

.. _ansible_collections.cisco.dnac.user_role_workflow_manager_module__parameter-config/role_details/network_services/app_hosting: .. rst-class:: ansible-option-title **app_hosting** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html

- .. raw:: html

Deploy, manage, and monitor virtualized and container-based applications running on network devices. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`"deny"` - :ansible-option-choices-entry-default:`"read"` :ansible-option-choices-default-mark:`← (default)` - :ansible-option-choices-entry:`"write"` .. raw:: html

* - .. raw:: html

.. _ansible_collections.cisco.dnac.user_role_workflow_manager_module__parameter-config/role_details/network_services/bonjour: .. rst-class:: ansible-option-title **bonjour** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html

- .. raw:: html

Enable the Wide Area Bonjour service to facilitate policy-based service discovery across the network. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`"deny"` - :ansible-option-choices-entry-default:`"read"` :ansible-option-choices-default-mark:`← (default)` - :ansible-option-choices-entry:`"write"` .. raw:: html

* - .. raw:: html

.. _ansible_collections.cisco.dnac.user_role_workflow_manager_module__parameter-config/role_details/network_services/overall: .. rst-class:: ansible-option-title **overall** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html

- .. raw:: html

* - .. raw:: html

.. _ansible_collections.cisco.dnac.user_role_workflow_manager_module__parameter-config/role_details/network_services/stealthwatch: .. rst-class:: ansible-option-title **stealthwatch** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html

- .. raw:: html

Configure network elements to send data to Cisco Stealthwatch for threat detection and mitigation, including encrypted traffic. To provision Stealthwatch, 'write' permission is required for the following components. Network Design \> Network Settings. Network Provision \> Provision. Network Services \> Stealthwatch. Network Design \> Advanced Settings. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`"deny"` - :ansible-option-choices-entry-default:`"read"` :ansible-option-choices-default-mark:`← (default)` - :ansible-option-choices-entry:`"write"` .. raw:: html

* - .. raw:: html

.. _ansible_collections.cisco.dnac.user_role_workflow_manager_module__parameter-config/role_details/network_services/umbrella: .. rst-class:: ansible-option-title **umbrella** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html

- .. raw:: html

Configure network elements to use Cisco Umbrella as a first line of defense against cybersecurity threats. To provision Umbrella, 'write' permission is required for the following components. Network Design \> Network Settings. Network Provision \> Provision. Network Provision \> Scheduler. Network Services \> Umbrella. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`"deny"` - :ansible-option-choices-entry-default:`"read"` :ansible-option-choices-default-mark:`← (default)` - :ansible-option-choices-entry:`"write"` .. raw:: html

* - .. raw:: html

.. _ansible_collections.cisco.dnac.user_role_workflow_manager_module__parameter-config/role_details/platform: .. rst-class:: ansible-option-title **platform** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html

- .. raw:: html

Open platform for accessible, intent-based workflows, data exchange, notifications, and third-party app integrations. .. rst-class:: ansible-option-line :ansible-option-default-bold:`Default:` :ansible-option-default:`"deny"` .. raw:: html

* - .. raw:: html

.. _ansible_collections.cisco.dnac.user_role_workflow_manager_module__parameter-config/role_details/platform/apis: .. rst-class:: ansible-option-title **apis** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html

- .. raw:: html

Access Cisco Catalyst Center through REST APIs to drive value. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry-default:`"deny"` :ansible-option-choices-default-mark:`← (default)` - :ansible-option-choices-entry:`"read"` - :ansible-option-choices-entry:`"write"` .. raw:: html

* - .. raw:: html

.. _ansible_collections.cisco.dnac.user_role_workflow_manager_module__parameter-config/role_details/platform/bundles: .. rst-class:: ansible-option-title **bundles** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html

- .. raw:: html

Enhance productivity by configuring and activating preconfigured bundles for ITSM integration. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry-default:`"deny"` :ansible-option-choices-default-mark:`← (default)` - :ansible-option-choices-entry:`"read"` - :ansible-option-choices-entry:`"write"` .. raw:: html

* - .. raw:: html

.. _ansible_collections.cisco.dnac.user_role_workflow_manager_module__parameter-config/role_details/platform/events: .. rst-class:: ansible-option-title **events** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html

- .. raw:: html

Subscribe to near real-time notifications for network and system events of interest. Configure email and syslog logs in System \> Settings \> Destinations. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry-default:`"deny"` :ansible-option-choices-default-mark:`← (default)` - :ansible-option-choices-entry:`"read"` - :ansible-option-choices-entry:`"write"` .. raw:: html

* - .. raw:: html

.. _ansible_collections.cisco.dnac.user_role_workflow_manager_module__parameter-config/role_details/platform/overall: .. rst-class:: ansible-option-title **overall** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html

- .. raw:: html

Provides the same choice for all sub-parameters. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry-default:`"deny"` :ansible-option-choices-default-mark:`← (default)` - :ansible-option-choices-entry:`"read"` - :ansible-option-choices-entry:`"write"` .. raw:: html

* - .. raw:: html

.. _ansible_collections.cisco.dnac.user_role_workflow_manager_module__parameter-config/role_details/platform/reports: .. rst-class:: ansible-option-title **reports** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html

- .. raw:: html

Generate reports using predefined templates for all aspects of the network. Generate reports for rogue devices and aWIPS. Configure webhooks in System \> Settings \> Destinations. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry-default:`"deny"` :ansible-option-choices-default-mark:`← (default)` - :ansible-option-choices-entry:`"read"` - :ansible-option-choices-entry:`"write"` .. raw:: html

* - .. raw:: html

.. _ansible_collections.cisco.dnac.user_role_workflow_manager_module__parameter-config/role_details/role_name: .. rst-class:: ansible-option-title **role_name** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html

- .. raw:: html

The name of the role to be managed. .. raw:: html

* - .. raw:: html

.. _ansible_collections.cisco.dnac.user_role_workflow_manager_module__parameter-config/role_details/security: .. rst-class:: ansible-option-title **security** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html

- .. raw:: html

Manage and control secure access to the network. .. rst-class:: ansible-option-line :ansible-option-default-bold:`Default:` :ansible-option-default:`"read"` .. raw:: html

* - .. raw:: html

.. _ansible_collections.cisco.dnac.user_role_workflow_manager_module__parameter-config/role_details/security/group_based_policy: .. rst-class:: ansible-option-title **group_based_policy** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html

- .. raw:: html

Manage group-based policies for networks that enforce segmentation and access control based on Cisco security group tags. This role includes Endpoint Analytics. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`"deny"` - :ansible-option-choices-entry-default:`"read"` :ansible-option-choices-default-mark:`← (default)` - :ansible-option-choices-entry:`"write"` .. raw:: html

* - .. raw:: html

.. _ansible_collections.cisco.dnac.user_role_workflow_manager_module__parameter-config/role_details/security/ip_based_access_control: .. rst-class:: ansible-option-title **ip_based_access_control** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html

- .. raw:: html

Manage IP-based access control lists that enforce network segmentation based on IP addresses. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`"deny"` - :ansible-option-choices-entry-default:`"read"` :ansible-option-choices-default-mark:`← (default)` - :ansible-option-choices-entry:`"write"` .. raw:: html

* - .. raw:: html

.. _ansible_collections.cisco.dnac.user_role_workflow_manager_module__parameter-config/role_details/security/overall: .. rst-class:: ansible-option-title **overall** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html

- .. raw:: html

* - .. raw:: html

.. _ansible_collections.cisco.dnac.user_role_workflow_manager_module__parameter-config/role_details/security/security_advisories: .. rst-class:: ansible-option-title **security_advisories** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html

- .. raw:: html

Scan the network for security advisories. Review and understand the impact of published Cisco security advisories. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`"deny"` - :ansible-option-choices-entry-default:`"read"` :ansible-option-choices-default-mark:`← (default)` - :ansible-option-choices-entry:`"write"` .. raw:: html

* - .. raw:: html

.. _ansible_collections.cisco.dnac.user_role_workflow_manager_module__parameter-config/role_details/system: .. rst-class:: ansible-option-title **system** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html

- .. raw:: html

Centralized administration of Cisco Catalyst Center, including configuration management, network connectivity, software upgrades, and more. .. rst-class:: ansible-option-line :ansible-option-default-bold:`Default:` :ansible-option-default:`"read"` .. raw:: html

* - .. raw:: html

.. _ansible_collections.cisco.dnac.user_role_workflow_manager_module__parameter-config/role_details/system/machine_reasoning: .. rst-class:: ansible-option-title **machine_reasoning** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html

- .. raw:: html

Configure automatic updates to the machine reasoning knowledge base to rapidly identify security vulnerabilities and improve automated issue analysis. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`"deny"` - :ansible-option-choices-entry-default:`"read"` :ansible-option-choices-default-mark:`← (default)` - :ansible-option-choices-entry:`"write"` .. raw:: html

* - .. raw:: html

.. _ansible_collections.cisco.dnac.user_role_workflow_manager_module__parameter-config/role_details/system/overall: .. rst-class:: ansible-option-title **overall** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html

- .. raw:: html

* - .. raw:: html

.. _ansible_collections.cisco.dnac.user_role_workflow_manager_module__parameter-config/role_details/system/system_management: .. rst-class:: ansible-option-title **system_management** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html

- .. raw:: html

Manage core system functionality and connectivity settings, user roles, and external authentication. This role includes Cisco Credentials, Integrity Verification, Device EULA, HA, Integration Settings, Disaster Recovery, Debugging Logs, Telemetry Collection, System EULA, IPAM, vManage Servers, Cisco AI Analytics, Backup & Restore, and Data Platform. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`"deny"` - :ansible-option-choices-entry-default:`"read"` :ansible-option-choices-default-mark:`← (default)` - :ansible-option-choices-entry:`"write"` .. raw:: html

* - .. raw:: html

.. _ansible_collections.cisco.dnac.user_role_workflow_manager_module__parameter-config/role_details/utilities: .. rst-class:: ansible-option-title **utilities** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html

- .. raw:: html

One-stop-shop productivity resource for the most commonly used troubleshooting tools and services. .. raw:: html

* - .. raw:: html

.. _ansible_collections.cisco.dnac.user_role_workflow_manager_module__parameter-config/role_details/utilities/audit_log: .. rst-class:: ansible-option-title **audit_log** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html

- .. raw:: html

Detailed log of changes made via UI or API interface to network devices or Cisco Catalyst Center. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry-default:`"deny"` :ansible-option-choices-default-mark:`← (default)` - :ansible-option-choices-entry:`"read"` - :ansible-option-choices-entry:`"write"` .. raw:: html

* - .. raw:: html

.. _ansible_collections.cisco.dnac.user_role_workflow_manager_module__parameter-config/role_details/utilities/event_viewer: .. rst-class:: ansible-option-title **event_viewer** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html

- .. raw:: html

View network device and client events for troubleshooting. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`"deny"` - :ansible-option-choices-entry-default:`"read"` :ansible-option-choices-default-mark:`← (default)` - :ansible-option-choices-entry:`"write"` .. raw:: html

* - .. raw:: html

.. _ansible_collections.cisco.dnac.user_role_workflow_manager_module__parameter-config/role_details/utilities/network_reasoner: .. rst-class:: ansible-option-title **network_reasoner** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html

- .. raw:: html

Allow the Cisco support team to remotely troubleshoot the network devices managed by Cisco Catalyst Center. Enables an engineer from the Cisco Technical Assistance Center (TAC) to connect remotely to a customer's Cisco Catalyst Center setup for troubleshooting. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`"deny"` - :ansible-option-choices-entry-default:`"read"` :ansible-option-choices-default-mark:`← (default)` - :ansible-option-choices-entry:`"write"` .. raw:: html

* - .. raw:: html

.. _ansible_collections.cisco.dnac.user_role_workflow_manager_module__parameter-config/role_details/utilities/overall: .. rst-class:: ansible-option-title **overall** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html

- .. raw:: html

Provides the same choice for all sub-parameters. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`"deny"` - :ansible-option-choices-entry:`"read"` - :ansible-option-choices-entry:`"write"` .. raw:: html

* - .. raw:: html

.. _ansible_collections.cisco.dnac.user_role_workflow_manager_module__parameter-config/role_details/utilities/remote_device_support: .. rst-class:: ansible-option-title **remote_device_support** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html

- .. raw:: html

Allow Cisco support team to remotely troubleshoot any network devices managed by Cisco Catalyst Center. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry-default:`"deny"` :ansible-option-choices-default-mark:`← (default)` - :ansible-option-choices-entry:`"read"` - :ansible-option-choices-entry:`"write"` .. raw:: html

* - .. raw:: html

.. _ansible_collections.cisco.dnac.user_role_workflow_manager_module__parameter-config/role_details/utilities/scheduler: .. rst-class:: ansible-option-title **scheduler** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html

- .. raw:: html

Run, schedule, and monitor network tasks and activities such as deploying policies, provisioning, or upgrading the network, integrated with other back-end services. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`"deny"` - :ansible-option-choices-entry:`"read"` - :ansible-option-choices-entry-default:`"write"` :ansible-option-choices-default-mark:`← (default)` .. raw:: html

* - .. raw:: html

.. _ansible_collections.cisco.dnac.user_role_workflow_manager_module__parameter-config/role_details/utilities/search: .. rst-class:: ansible-option-title **search** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html

- .. raw:: html

Search for various objects in Cisco Catalyst Center, including sites, network devices, clients, applications, policies, settings, tags, menu items, and more. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`"deny"` - :ansible-option-choices-entry-default:`"read"` :ansible-option-choices-default-mark:`← (default)` - :ansible-option-choices-entry:`"write"` .. raw:: html

* - .. raw:: html

.. _ansible_collections.cisco.dnac.user_role_workflow_manager_module__parameter-config/user_details: .. rst-class:: ansible-option-title **user_details** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`list` / :ansible-option-elements:`elements=dictionary` .. raw:: html

- .. raw:: html

Manages the configuration details for user accounts. .. raw:: html

* - .. raw:: html

.. _ansible_collections.cisco.dnac.user_role_workflow_manager_module__parameter-config/user_details/email: .. rst-class:: ansible-option-title **email** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html

- .. raw:: html

The email address of the user (e.g., syedkhadeerahmed@example.com). Used to retrieve user data if the 'username' is forgotten. Required for user deletion if the 'username' is forgotten. .. raw:: html

* - .. raw:: html

.. _ansible_collections.cisco.dnac.user_role_workflow_manager_module__parameter-config/user_details/first_name: .. rst-class:: ansible-option-title **first_name** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html

- .. raw:: html

The first name of the user. .. raw:: html

* - .. raw:: html

.. _ansible_collections.cisco.dnac.user_role_workflow_manager_module__parameter-config/user_details/last_name: .. rst-class:: ansible-option-title **last_name** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html

- .. raw:: html

The last name of the user. .. raw:: html

* - .. raw:: html

.. _ansible_collections.cisco.dnac.user_role_workflow_manager_module__parameter-config/user_details/password: .. rst-class:: ansible-option-title **password** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html

- .. raw:: html

The password for the user account, which must adhere to specified complexity requirements. Must contain at least one special character, one capital letter, one lowercase letter, and a minimum length of 8 characters. Required for creating a new user account. .. raw:: html

* - .. raw:: html

.. _ansible_collections.cisco.dnac.user_role_workflow_manager_module__parameter-config/user_details/password_update: .. rst-class:: ansible-option-title **password_update** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html

- .. raw:: html

Indicates whether the password should be updated. Set to \`true\` to trigger a password update. Required if a password change is necessary; must be explicitly set to \`true\` to initiate the update process. If no update is needed, omit this parameter or set it to \`false\`. Ensure this parameter is correctly set to avoid unnecessary updates or errors. .. raw:: html

* - .. raw:: html

.. _ansible_collections.cisco.dnac.user_role_workflow_manager_module__parameter-config/user_details/role_list: .. rst-class:: ansible-option-title **role_list** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`list` / :ansible-option-elements:`elements=string` .. raw:: html

- .. raw:: html

A list of role names to be assigned to the user. If no role is specified, the default role will be "OBSERVER-ROLE". The role names must match with those defined in the Cisco Catalyst Center. The default roles present in the Cisco Catalyst Center are "SUPER-ADMIN-ROLE", "NETWORK-ADMIN-ROLE", "OBSERVER-ROLE". SUPER-ADMIN-ROLE grants Full access, including user management. NETWORK-ADMIN-ROLE grants Full network access, no system functions. OBSERVER-ROLE grants view-only access, no configuration or control functions. .. raw:: html

* - .. raw:: html

.. _ansible_collections.cisco.dnac.user_role_workflow_manager_module__parameter-config/user_details/username: .. rst-class:: ansible-option-title **username** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html

- .. raw:: html

The 'username' associated with the user account. Required for user create, update and delete operations. .. raw:: html

* - .. raw:: html

.. _ansible_collections.cisco.dnac.user_role_workflow_manager_module__parameter-config_verify: .. rst-class:: ansible-option-title **config_verify** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html

- .. raw:: html

Set to True to verify the Cisco Catalyst Center after applying the playbook config. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry-default:`false` :ansible-option-choices-default-mark:`← (default)` - :ansible-option-choices-entry:`true` .. raw:: html

* - .. raw:: html

.. _ansible_collections.cisco.dnac.user_role_workflow_manager_module__parameter-dnac_api_task_timeout: .. rst-class:: ansible-option-title **dnac_api_task_timeout** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html

- .. raw:: html

Defines the timeout in seconds for API calls to retrieve task details. If the task details are not received within this period, the process will end, and a timeout notification will be logged. .. rst-class:: ansible-option-line :ansible-option-default-bold:`Default:` :ansible-option-default:`1200` .. raw:: html

* - .. raw:: html

.. _ansible_collections.cisco.dnac.user_role_workflow_manager_module__parameter-dnac_debug: .. rst-class:: ansible-option-title **dnac_debug** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html

- .. raw:: html

Indicates whether debugging is enabled in the Cisco Catalyst Center SDK. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry-default:`false` :ansible-option-choices-default-mark:`← (default)` - :ansible-option-choices-entry:`true` .. raw:: html

* - .. raw:: html

.. _ansible_collections.cisco.dnac.user_role_workflow_manager_module__parameter-dnac_host: .. rst-class:: ansible-option-title **dnac_host** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html

- .. raw:: html

The hostname of the Cisco Catalyst Center. .. raw:: html

* - .. raw:: html

.. _ansible_collections.cisco.dnac.user_role_workflow_manager_module__parameter-dnac_log: .. rst-class:: ansible-option-title **dnac_log** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html

- .. raw:: html

Flag to enable/disable playbook execution logging. When true and dnac\_log\_file\_path is provided, - Create the log file at the execution location with the specified name. When true and dnac\_log\_file\_path is not provided, - Create the log file at the execution location with the name 'dnac.log'. When false, - Logging is disabled. If the log file doesn't exist, - It is created in append or write mode based on the "dnac\_log\_append" flag. If the log file exists, - It is overwritten or appended based on the "dnac\_log\_append" flag. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry-default:`false` :ansible-option-choices-default-mark:`← (default)` - :ansible-option-choices-entry:`true` .. raw:: html

* - .. raw:: html

.. _ansible_collections.cisco.dnac.user_role_workflow_manager_module__parameter-dnac_log_append: .. rst-class:: ansible-option-title **dnac_log_append** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html

- .. raw:: html

Determines the mode of the file. Set to True for 'append' mode. Set to False for 'write' mode. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`false` - :ansible-option-choices-entry-default:`true` :ansible-option-choices-default-mark:`← (default)` .. raw:: html

* - .. raw:: html

.. _ansible_collections.cisco.dnac.user_role_workflow_manager_module__parameter-dnac_log_file_path: .. rst-class:: ansible-option-title **dnac_log_file_path** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html

- .. raw:: html

Governs logging. Logs are recorded if dnac\_log is True. If path is not specified, - When 'dnac\_log\_append' is True, 'dnac.log' is generated in the current Ansible directory; logs are appended. - When 'dnac\_log\_append' is False, 'dnac.log' is generated; logs are overwritten. If path is specified, - When 'dnac\_log\_append' is True, the file opens in append mode. - When 'dnac\_log\_append' is False, the file opens in write (w) mode. - In shared file scenarios, without append mode, content is overwritten after each module execution. - For a shared log file, set append to False for the 1st module (to overwrite); for subsequent modules, set append to True. .. rst-class:: ansible-option-line :ansible-option-default-bold:`Default:` :ansible-option-default:`"dnac.log"` .. raw:: html

* - .. raw:: html

.. _ansible_collections.cisco.dnac.user_role_workflow_manager_module__parameter-dnac_log_level: .. rst-class:: ansible-option-title **dnac_log_level** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html

- .. raw:: html

Sets the threshold for log level. Messages with a level equal to or higher than this will be logged. Levels are listed in order of severity [CRITICAL, ERROR, WARNING, INFO, DEBUG]. CRITICAL indicates serious errors halting the program. Displays only CRITICAL messages. ERROR indicates problems preventing a function. Displays ERROR and CRITICAL messages. WARNING indicates potential future issues. Displays WARNING, ERROR, CRITICAL messages. INFO tracks normal operation. Displays INFO, WARNING, ERROR, CRITICAL messages. DEBUG provides detailed diagnostic info. Displays all log messages. .. rst-class:: ansible-option-line :ansible-option-default-bold:`Default:` :ansible-option-default:`"WARNING"` .. raw:: html

* - .. raw:: html

.. _ansible_collections.cisco.dnac.user_role_workflow_manager_module__parameter-dnac_password: .. rst-class:: ansible-option-title **dnac_password** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html

- .. raw:: html

The password for authentication at the Cisco Catalyst Center. .. raw:: html

* - .. raw:: html

.. _ansible_collections.cisco.dnac.user_role_workflow_manager_module__parameter-dnac_port: .. rst-class:: ansible-option-title **dnac_port** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html

- .. raw:: html

Specifies the port number associated with the Cisco Catalyst Center. .. rst-class:: ansible-option-line :ansible-option-default-bold:`Default:` :ansible-option-default:`"443"` .. raw:: html

* - .. raw:: html

.. _ansible_collections.cisco.dnac.user_role_workflow_manager_module__parameter-dnac_task_poll_interval: .. rst-class:: ansible-option-title **dnac_task_poll_interval** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html

- .. raw:: html

Specifies the interval in seconds between successive calls to the API to retrieve task details. .. rst-class:: ansible-option-line :ansible-option-default-bold:`Default:` :ansible-option-default:`2` .. raw:: html

* - .. raw:: html

.. _ansible_collections.cisco.dnac.user_role_workflow_manager_module__parameter-dnac_username: .. _ansible_collections.cisco.dnac.user_role_workflow_manager_module__parameter-user: .. rst-class:: ansible-option-title **dnac_username** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-aliases:`aliases: user` .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html

- .. raw:: html

The username for authentication at the Cisco Catalyst Center. .. rst-class:: ansible-option-line :ansible-option-default-bold:`Default:` :ansible-option-default:`"admin"` .. raw:: html

* - .. raw:: html

.. _ansible_collections.cisco.dnac.user_role_workflow_manager_module__parameter-dnac_verify: .. rst-class:: ansible-option-title **dnac_verify** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html

- .. raw:: html

Flag to enable or disable SSL certificate verification. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`false` - :ansible-option-choices-entry-default:`true` :ansible-option-choices-default-mark:`← (default)` .. raw:: html

* - .. raw:: html

.. _ansible_collections.cisco.dnac.user_role_workflow_manager_module__parameter-dnac_version: .. rst-class:: ansible-option-title **dnac_version** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html

- .. raw:: html

Specifies the version of the Cisco Catalyst Center that the SDK should use. .. rst-class:: ansible-option-line :ansible-option-default-bold:`Default:` :ansible-option-default:`"2.2.3.3"` .. raw:: html

* - .. raw:: html

.. _ansible_collections.cisco.dnac.user_role_workflow_manager_module__parameter-state: .. rst-class:: ansible-option-title **state** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html

- .. raw:: html

The state of Cisco Catalyst Center after module completion. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry-default:`"merged"` :ansible-option-choices-default-mark:`← (default)` - :ansible-option-choices-entry:`"deleted"` .. raw:: html

* - .. raw:: html

.. _ansible_collections.cisco.dnac.user_role_workflow_manager_module__parameter-validate_response_schema: .. rst-class:: ansible-option-title **validate_response_schema** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html

- .. raw:: html

Flag for Cisco Catalyst Center SDK to enable the validation of request bodies against a JSON schema. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`false` - :ansible-option-choices-entry-default:`true` :ansible-option-choices-default-mark:`← (default)` .. raw:: html

.. Attributes .. Notes Notes ----- .. note:: - SDK Methods used - user\_and\_roles.UserandRoles.get\_user\_api - user\_and\_roles.UserandRoles.add\_user\_api - user\_and\_roles.UserandRoles.update\_user\_api - user\_and\_roles.UserandRoles.delete\_user\_api - Paths used - get /dna/system/api/v1/user - post /dna/system/api/v1/user - put /dna/system/api/v1/user - delete /dna/system/api/v1/user/{userId} - Does not support \ :literal:`check\_mode`\ - The plugin runs on the control node and does not use any ansible connection plugins instead embedded connection manager from Cisco Catalyst Center SDK - The parameters starting with dnac\_ are used by the Cisco Catalyst Center Python SDK to establish the connection .. Seealso .. Examples Examples -------- .. code-block:: yaml+jinja --- - name: Create a user cisco.dnac.user_role_workflow_manager: 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 }}" dnac_log: True dnac_log_level: DEBUG config_verify: True dnac_api_task_timeout: 1000 dnac_task_poll_interval: 1 state: merged config: user_details: - username: "ajithandrewj" first_name: "ajith" last_name: "andrew" email: "ajith.andrew@example.com" password: "Example@0101" role_list: ["SUPER-ADMIN-ROLE"] - name: Update a user for first name, last name, email, and role list cisco.dnac.user_role_workflow_manager: 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 }}" dnac_log: True dnac_log_level: DEBUG config_verify: True dnac_api_task_timeout: 1000 dnac_task_poll_interval: 1 state: merged config: user_details: - username: "ajithandrewj" first_name: "ajith" last_name: "andrew" email: "ajith.andrew@example.com" role_list: ["SUPER-ADMIN-ROLE"] - name: Update a user for role list cisco.dnac.user_role_workflow_manager: 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 }}" dnac_log: True dnac_log_level: DEBUG config_verify: True dnac_api_task_timeout: 1000 dnac_task_poll_interval: 1 state: merged config: user_details: - username: "ajithandrewj" role_list: ["NETWORK-ADMIN-ROLE"] - name: Update the user password cisco.dnac.user_role_workflow_manager: 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 }}" dnac_log: True dnac_log_level: DEBUG config_verify: True dnac_api_task_timeout: 1000 dnac_task_poll_interval: 1 state: merged config: user_details: - username: "ajithandrewj" password: "Example@010101" password_update: True - name: Delete a user using username or email address cisco.dnac.user_role_workflow_manager: 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 }}" dnac_log: True dnac_log_level: DEBUG config_verify: True dnac_api_task_timeout: 1000 dnac_task_poll_interval: 1 state: deleted config: user_details: username: "ajithandrewj" - name: Create a role with all params cisco.dnac.user_role_workflow_manager: 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 }}" dnac_log: True dnac_log_level: DEBUG config_verify: True config: role_details: - role_name: "role_name" description: "role_description" assurance: - monitoring_and_troubleshooting: "write" monitoring_settings: "read" troubleshooting_tools: "deny" network_analytics: - data_access: "write" network_design: - advanced_network_settings: "deny" image_repository: "deny" network_hierarchy: "deny" network_profiles: "write" network_settings: "write" virtual_network: "read" network_provision: - compliance: "deny" eox: "read" image_update: "write" inventory_management: - device_configuration: "write" discovery: "deny" network_device: "read" port_management: "write" topology: "write" license: "write" network_telemetry: "write" pnp: "deny" provision: "read" network_services: - app_hosting: "deny" bonjour: "write" stealthwatch: "read" umbrella: "deny" platform: - apis: "write" bundles: "write" events: "write" reports: "read" security: - group_based_policy: "read" ip_based_access_control: "write" security_advisories: "write" system: - machine_reasoning: "read" system_management: "write" utilities: - audit_log: "read" event_viewer: "deny" network_reasoner: "write" remote_device_support: "read" scheduler: "read" search: "write" - name: Create a role for assurance cisco.dnac.user_role_workflow_manager: 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 }}" dnac_log: True dnac_log_level: DEBUG config_verify: True config: role_details: - role_name: "role_name" description: "role_description" assurance: - overall: "write" monitoring_and_troubleshooting: "read" - name: Create a role for network provision cisco.dnac.user_role_workflow_manager: 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 }}" dnac_log: True dnac_log_level: DEBUG config_verify: True config: role_details: - role_name: "role_name" description: "role_description" network_provision: - compliance: "deny" image_update: "write" inventory_management: - overall: "read" device_configuration: "write" license: "write" network_telemetry: "write" pnp: "deny" provision: "read" - name: Update a role for assurance and platform cisco.dnac.user_role_workflow_manager: 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 }}" dnac_log: True dnac_log_level: DEBUG config_verify: True config: role_details: - role_name: "role_name" assurance: - overall: "deny" platform: - apis: "write" bundles: "write" events: "write" reports: "read" - name: Delete a role cisco.dnac.user_role_workflow_manager: 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 }}" dnac_log: True dnac_log_level: DEBUG config_verify: True dnac_api_task_timeout: 1000 dnac_task_poll_interval: 1 state: deleted config: role_details: - rolename: "role_name" .. Facts .. Return values Return Values ------------- Common return values are documented :ref:`here `, the following are the fields unique to this module: .. rst-class:: ansible-option-table .. list-table:: :width: 100% :widths: auto :header-rows: 1 * - Key - Description * - .. raw:: html

.. _ansible_collections.cisco.dnac.user_role_workflow_manager_module__return-response_1: .. rst-class:: ansible-option-title **response_1** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html

- .. raw:: html

A dictionary with details of the API execution from Cisco Catalyst Center. .. rst-class:: ansible-option-line :ansible-option-returned-bold:`Returned:` always .. rst-class:: ansible-option-line .. rst-class:: ansible-option-sample :ansible-option-sample-bold:`Sample:` :ansible-rv-sample-value:`{"response": {"message": "string", "userId": "string"}}` .. raw:: html

* - .. raw:: html

.. _ansible_collections.cisco.dnac.user_role_workflow_manager_module__return-response_10: .. rst-class:: ansible-option-title **response_10** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html

- .. raw:: html

A dictionary with details of the API execution and error information. .. rst-class:: ansible-option-line :ansible-option-returned-bold:`Returned:` always .. rst-class:: ansible-option-line .. rst-class:: ansible-option-sample :ansible-option-sample-bold:`Sample:` :ansible-rv-sample-value:`{"response": {"msg": "Error during creating, updating or deleting the role."}}` .. raw:: html

* - .. raw:: html

.. _ansible_collections.cisco.dnac.user_role_workflow_manager_module__return-response_11: .. rst-class:: ansible-option-title **response_11** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html

- .. raw:: html

A dictionary indicating role not found during delete operation. .. rst-class:: ansible-option-line :ansible-option-returned-bold:`Returned:` always .. rst-class:: ansible-option-line .. rst-class:: ansible-option-sample :ansible-option-sample-bold:`Sample:` :ansible-rv-sample-value:`{"response": {"msg": "Role not found."}}` .. raw:: html

* - .. raw:: html

.. _ansible_collections.cisco.dnac.user_role_workflow_manager_module__return-response_2: .. rst-class:: ansible-option-title **response_2** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html

- .. raw:: html

* - .. raw:: html

.. _ansible_collections.cisco.dnac.user_role_workflow_manager_module__return-response_3: .. rst-class:: ansible-option-title **response_3** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html

- .. raw:: html

* - .. raw:: html

.. _ansible_collections.cisco.dnac.user_role_workflow_manager_module__return-response_4: .. rst-class:: ansible-option-title **response_4** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html

- .. raw:: html

A dictionary with existing user details indicating no update needed. .. rst-class:: ansible-option-line :ansible-option-returned-bold:`Returned:` always .. rst-class:: ansible-option-line .. rst-class:: ansible-option-sample :ansible-option-sample-bold:`Sample:` :ansible-rv-sample-value:`{"msg": "User already exists and no update needed.", "response": {"type": "string", "user": {"email": "user@example.com", "first\_name": "John", "last\_name": "Doe", "role\_list": ["NETWORK-ADMIN-ROLE"], "username": "johndoe"}, "userId": "string"}}` .. raw:: html

* - .. raw:: html

.. _ansible_collections.cisco.dnac.user_role_workflow_manager_module__return-response_5: .. rst-class:: ansible-option-title **response_5** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html

- .. raw:: html

* - .. raw:: html

.. _ansible_collections.cisco.dnac.user_role_workflow_manager_module__return-response_6: .. rst-class:: ansible-option-title **response_6** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html

- .. raw:: html

A dictionary indicating user not found during delete operation. .. rst-class:: ansible-option-line :ansible-option-returned-bold:`Returned:` always .. rst-class:: ansible-option-line .. rst-class:: ansible-option-sample :ansible-option-sample-bold:`Sample:` :ansible-rv-sample-value:`{"response": {"msg": "User not found."}}` .. raw:: html

* - .. raw:: html

.. _ansible_collections.cisco.dnac.user_role_workflow_manager_module__return-response_7: .. rst-class:: ansible-option-title **response_7** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html

- .. raw:: html

* - .. raw:: html

.. _ansible_collections.cisco.dnac.user_role_workflow_manager_module__return-response_8: .. rst-class:: ansible-option-title **response_8** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html

- .. raw:: html

* - .. raw:: html

.. _ansible_collections.cisco.dnac.user_role_workflow_manager_module__return-response_9: .. rst-class:: ansible-option-title **response_9** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html

- .. raw:: html

.. Status (Presently only deprecated) .. Authors Authors ~~~~~~~ - Ajith Andrew J (@ajithandrewj) - Syed Khadeer Ahmed (@syed-khadeerahmed) - Rangaprabhu Deenadayalu (@rangaprabha-d) - Madhan Sankaranarayanan (@madhansansel) .. Extra links Collection links ~~~~~~~~~~~~~~~~ .. raw:: html

Issue Tracker Repository (Sources)

.. Parsing errors