.. 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.inventory_workflow_manager_module: .. Anchors: short name for ansible.builtin .. Anchors: aliases .. Title cisco.dnac.inventory_workflow_manager module -- Resource module for Network Device ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. Collection note .. note:: This module is part of the `cisco.dnac collection `_ (version 6.13.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.inventory_workflow_manager`. .. version_added .. rst-class:: ansible-version-added New in cisco.dnac 6.8.0 .. contents:: :local: :depth: 1 .. Deprecated Synopsis -------- .. Description - Manage operations create, update and delete of the resource Network Device. - Adds the device with given credential. - Deletes the network device for the given Id. - Sync the devices provided as input. .. Aliases .. Requirements .. _ansible_collections.cisco.dnac.inventory_workflow_manager_module_requirements: Requirements ------------ The below requirements are needed on the host that executes this module. - dnacentersdk \>= 2.5.5 - python \>= 3.5 .. Options Parameters ---------- .. rst-class:: ansible-option-table .. list-table:: :width: 100% :widths: auto :header-rows: 1 * - Parameter - Comments * - .. raw:: html
.. _ansible_collections.cisco.dnac.inventory_workflow_manager_module__parameter-config: .. rst-class:: ansible-option-title **config** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`list` / :ansible-option-elements:`elements=dictionary` / :ansible-option-required:`required` .. raw:: html
- .. raw:: html
List of devices with credentails to perform Add/Update/Delete/Resync operation .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.inventory_workflow_manager_module__parameter-config/admin_status: .. rst-class:: ansible-option-title **admin_status** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Status of Interface of a device, it can be (UP/DOWN). .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.inventory_workflow_manager_module__parameter-config/clean_config: .. rst-class:: ansible-option-title **clean_config** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Required if need to delete the Provisioned device by clearing current configuration. .. 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.inventory_workflow_manager_module__parameter-config/clear_mac_address_table: .. rst-class:: ansible-option-title **clear_mac_address_table** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` :ansible-option-versionadded:`added in cisco.dnac 6.12.0` .. raw:: html
- .. raw:: html
Set this to true if you need to clear the MAC address table for a specific device's interface. It's a boolean type, with a default value of False. .. 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.inventory_workflow_manager_module__parameter-config/cli_transport: .. rst-class:: ansible-option-title **cli_transport** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
The essential prerequisite for adding Network devices is the specification of the transport protocol (either SSH or Telnet) used by the device. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.inventory_workflow_manager_module__parameter-config/compute_device: .. rst-class:: ansible-option-title **compute_device** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Indicates whether a device is a compute device. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`false` - :ansible-option-choices-entry:`true` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.inventory_workflow_manager_module__parameter-config/credential_update: .. rst-class:: ansible-option-title **credential_update** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Make this as true needed for the updation of device credentials and other device details. .. 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.inventory_workflow_manager_module__parameter-config/deployment_mode: .. rst-class:: ansible-option-title **deployment_mode** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Preview/Deploy [Preview means the configuration is not pushed to the device. Deploy makes the configuration pushed to the device] .. rst-class:: ansible-option-line :ansible-option-default-bold:`Default:` :ansible-option-default:`"Deploy"` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.inventory_workflow_manager_module__parameter-config/description: .. rst-class:: ansible-option-title **description** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Info about the global user defined field. Also used while updating interface details. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.inventory_workflow_manager_module__parameter-config/device_resync: .. rst-class:: ansible-option-title **device_resync** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Make this as true needed for the resyncing of device. .. 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.inventory_workflow_manager_module__parameter-config/device_updated: .. rst-class:: ansible-option-title **device_updated** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Make this as true needed for the updation of device role, interface details, device credentails or details. .. 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.inventory_workflow_manager_module__parameter-config/enable_password: .. rst-class:: ansible-option-title **enable_password** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Password required for enabling configurations on the device. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.inventory_workflow_manager_module__parameter-config/extended_discovery_info: .. rst-class:: ansible-option-title **extended_discovery_info** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Additional discovery information for the device. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.inventory_workflow_manager_module__parameter-config/force_sync: .. rst-class:: ansible-option-title **force_sync** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
If forcesync is true then device sync would run in high priority thread if available, else the sync will fail. .. 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.inventory_workflow_manager_module__parameter-config/hostname_list: .. rst-class:: ansible-option-title **hostname_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 hostnames representing devices. Operations such as updating, deleting, resyncing, or rebooting can be performed as alternatives to using IP addresses. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.inventory_workflow_manager_module__parameter-config/http_password: .. rst-class:: ansible-option-title **http_password** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
HTTP password required for adding compute, Meraki, and Firepower Management Devices. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.inventory_workflow_manager_module__parameter-config/http_port: .. rst-class:: ansible-option-title **http_port** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
HTTP port number required for adding compute and Firepower Management Devices. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.inventory_workflow_manager_module__parameter-config/http_secure: .. rst-class:: ansible-option-title **http_secure** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Flag indicating HTTP security. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`false` - :ansible-option-choices-entry:`true` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.inventory_workflow_manager_module__parameter-config/http_username: .. rst-class:: ansible-option-title **http_username** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
HTTP username required for adding compute and Firepower Management Devices. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.inventory_workflow_manager_module__parameter-config/interface_name: .. rst-class:: ansible-option-title **interface_name** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`list` / :ansible-option-elements:`elements=string` .. raw:: html
- .. raw:: html
Specify the list of interface names to update the details of the device interface. (For example, GigabitEthernet1/0/11, FortyGigabitEthernet1/1/2) .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.inventory_workflow_manager_module__parameter-config/ip_address_list: .. rst-class:: ansible-option-title **ip_address_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 the IP addresses for the devices. It is required for tasks such as adding, updating, deleting, or resyncing devices, with Meraki devices being the exception. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.inventory_workflow_manager_module__parameter-config/mac_address_list: .. rst-class:: ansible-option-title **mac_address_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 MAC addresses representing devices. Operations such as updating, deleting, resyncing, or rebooting can be performed as alternatives to using IP addresses. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.inventory_workflow_manager_module__parameter-config/name: .. rst-class:: ansible-option-title **name** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Name of Global User Defined Field. Required for creating/deleting UDF and then assigning it to device. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.inventory_workflow_manager_module__parameter-config/netconf_port: .. rst-class:: ansible-option-title **netconf_port** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Specifies the port number for connecting to devices using the Netconf protocol. Netconf (Network Configuration Protocol) is used for managing network devices. Ensure that the provided port number corresponds to the Netconf service port configured on your network devices. NETCONF with user privilege 15 is mandatory for enabling Wireless Services on Wireless capable devices such as Catalyst 9000 series Switches and C9800 Series Wireless Controllers. The NETCONF credentials are required to connect to C9800 Series Wireless Controllers as the majority of data collection is done using NETCONF for these Devices. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.inventory_workflow_manager_module__parameter-config/operation_enum: .. rst-class:: ansible-option-title **operation_enum** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
enum(CREDENTIALDETAILS, DEVICEDETAILS) 0 to export Device Credential Details Or 1 to export Device Details. CREDENTIALDETAILS - Used for exporting device credentials details like snpm credntials, device crdentails etc. DEVICEDETAILS - Used for exporting device specific details like device hostname, serial number, type, family etc. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.inventory_workflow_manager_module__parameter-config/parameters: .. rst-class:: ansible-option-title **parameters** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`list` / :ansible-option-elements:`elements=string` .. raw:: html
- .. raw:: html
List of device parameters that needs to be exported to file. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.inventory_workflow_manager_module__parameter-config/password: .. rst-class:: ansible-option-title **password** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Password for accessing the device and for file encryption during device export. Required for adding Network Device. Also needed for file encryption while exporting device in a csv file. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.inventory_workflow_manager_module__parameter-config/provision_wired_device: .. rst-class:: ansible-option-title **provision_wired_device** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`list` / :ansible-option-elements:`elements=dictionary` .. raw:: html
- .. raw:: html
This parameter takes a list of dictionaries. Each dictionary provides the IP address of a wired device and the name of the site where the device will be provisioned. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.inventory_workflow_manager_module__parameter-config/provision_wired_device/device_ip: .. rst-class:: ansible-option-title **device_ip** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` :ansible-option-versionadded:`added in cisco.dnac 6.12.0` .. raw:: html
- .. raw:: html
Specifies the IP address of the wired device. This is a string value that should be in the format of standard IPv4 or IPv6 addresses. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.inventory_workflow_manager_module__parameter-config/provision_wired_device/resync_retry_count: .. rst-class:: ansible-option-title **resync_retry_count** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` :ansible-option-versionadded:`added in cisco.dnac 6.12.0` .. raw:: html
- .. raw:: html
Determines the total number of retry attempts for checking if the device has reached a managed state during the provisioning process. If unspecified, the default value is set to 200 retries. .. rst-class:: ansible-option-line :ansible-option-default-bold:`Default:` :ansible-option-default:`200` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.inventory_workflow_manager_module__parameter-config/provision_wired_device/resync_retry_interval: .. rst-class:: ansible-option-title **resync_retry_interval** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` :ansible-option-versionadded:`added in cisco.dnac 6.12.0` .. raw:: html
- .. raw:: html
Sets the interval, in seconds, at which the system will recheck the device status throughout the provisioning process. If unspecified, the system will check the device status every 2 seconds by default. .. rst-class:: ansible-option-line :ansible-option-default-bold:`Default:` :ansible-option-default:`2` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.inventory_workflow_manager_module__parameter-config/provision_wired_device/site_name: .. rst-class:: ansible-option-title **site_name** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Indicates the exact location where the wired device will be provisioned. This is a string value that should represent the complete hierarchical path of the site (For example, "Global/USA/San Francisco/BGL\_18/floor\_pnp"). .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.inventory_workflow_manager_module__parameter-config/provision_wireless_device: .. rst-class:: ansible-option-title **provision_wireless_device** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`list` / :ansible-option-elements:`elements=dictionary` :ansible-option-versionadded:`added in cisco.dnac 6.12.0` .. raw:: html
- .. raw:: html
This parameter takes a list of dictionaries. Each dictionary provides the IP address of a wireless device and the name of the site where the device will be provisioned along with dynamic interface details. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.inventory_workflow_manager_module__parameter-config/provision_wireless_device/device_ip: .. rst-class:: ansible-option-title **device_ip** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Specifies the IP address of the wirelesss device. This is a string value that should be in the format of standard IPv4 or IPv6 addresses. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.inventory_workflow_manager_module__parameter-config/provision_wireless_device/dynamic_interfaces: .. rst-class:: ansible-option-title **dynamic_interfaces** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`list` / :ansible-option-elements:`elements=dictionary` .. raw:: html
- .. raw:: html
Interface details of the wireless device .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.inventory_workflow_manager_module__parameter-config/provision_wireless_device/dynamic_interfaces/interface_gateway: .. rst-class:: ansible-option-title **interface_gateway** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
The name identifier for the gateway associated with the interface. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.inventory_workflow_manager_module__parameter-config/provision_wireless_device/dynamic_interfaces/interface_ip_address: .. rst-class:: ansible-option-title **interface_ip_address** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Ip Address allocated to the interface .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.inventory_workflow_manager_module__parameter-config/provision_wireless_device/dynamic_interfaces/interface_name: .. rst-class:: ansible-option-title **interface_name** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Name of the interface. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.inventory_workflow_manager_module__parameter-config/provision_wireless_device/dynamic_interfaces/interface_netmask_in_cidr: .. rst-class:: ansible-option-title **interface_netmask_in_cidr** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
The netmask of the interface, given in CIDR notation. This is an integer that represents the number of bits set in the netmask .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.inventory_workflow_manager_module__parameter-config/provision_wireless_device/dynamic_interfaces/lag_or_port_number: .. rst-class:: ansible-option-title **lag_or_port_number** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
The Link Aggregation Group (LAG) number or port number assigned to the interface. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.inventory_workflow_manager_module__parameter-config/provision_wireless_device/dynamic_interfaces/vlan_id: .. rst-class:: ansible-option-title **vlan_id** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
The VLAN (Virtual Local Area Network) ID associated with the network interface. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.inventory_workflow_manager_module__parameter-config/provision_wireless_device/managed_ap_locations: .. rst-class:: ansible-option-title **managed_ap_locations** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`list` / :ansible-option-elements:`elements=string` .. raw:: html
- .. raw:: html
Location of the sites allocated for the APs (For example, ["Global/USA/San Francisco/BGL\_18/floor\_test", "Global/USA/San Francisco/BGL\_18/floor\_check"]) .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.inventory_workflow_manager_module__parameter-config/provision_wireless_device/resync_retry_count: .. rst-class:: ansible-option-title **resync_retry_count** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
Determines the total number of retry attempts for checking if the device has reached a managed state during the provisioning process. If unspecified, the default value is set to 200 retries. .. rst-class:: ansible-option-line :ansible-option-default-bold:`Default:` :ansible-option-default:`200` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.inventory_workflow_manager_module__parameter-config/provision_wireless_device/resync_retry_interval: .. rst-class:: ansible-option-title **resync_retry_interval** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
Sets the interval, in seconds, at which the system will recheck the device status throughout the provisioning process. If unspecified, the system will check the device status every 2 seconds by default. .. rst-class:: ansible-option-line :ansible-option-default-bold:`Default:` :ansible-option-default:`2` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.inventory_workflow_manager_module__parameter-config/provision_wireless_device/site_name: .. rst-class:: ansible-option-title **site_name** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Indicates the exact location where the wired device will be provisioned. This is a string value that should represent the complete hierarchical path of the site (For example, "Global/USA/San Francisco/BGL\_18/floor\_pnp"). .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.inventory_workflow_manager_module__parameter-config/reboot_device: .. rst-class:: ansible-option-title **reboot_device** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Make this as true needed for the Rebooting of Access Points. .. 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.inventory_workflow_manager_module__parameter-config/reprovision_wired_device: .. rst-class:: ansible-option-title **reprovision_wired_device** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`list` / :ansible-option-elements:`elements=dictionary` :ansible-option-versionadded:`added in cisco.dnac 6.12.0` .. raw:: html
- .. raw:: html
This parameter takes a list of dictionaries. Each dictionary provides the IP address of a wired device and the name of the site where the device will be re-provisioned. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.inventory_workflow_manager_module__parameter-config/reprovision_wired_device/device_ip: .. rst-class:: ansible-option-title **device_ip** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Specifies the IP address of the wired device. This is a string value that should be in the format of standard IPv4 or IPv6 addresses. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.inventory_workflow_manager_module__parameter-config/reprovision_wired_device/site_name: .. rst-class:: ansible-option-title **site_name** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Indicates the exact location where the wired device will be provisioned. This is a string value that should represent the complete hierarchical path of the site (For example, "Global/USA/San Francisco/BGL\_18/floor\_pnp"). .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.inventory_workflow_manager_module__parameter-config/role: .. rst-class:: ansible-option-title **role** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Role of device which can be ACCESS, CORE, DISTRIBUTION, BORDER ROUTER, UNKNOWN. ALL - This role typically represents all devices within the network, regardless of their specific roles or functions. UNKNOWN - This role is assigned to devices whose roles or functions have not been identified or classified within Cisco Catalsyt Center. This could happen if the platform is unable to determine the device's role based on available information. ACCESS - This role typically represents switches or access points that serve as access points for end-user devices to connect to the network. These devices are often located at the edge of the network and provide connectivity to end-user devices. BORDER ROUTER - These are devices that connect different network domains or segments together. They often serve as gateways between different networks, such as connecting an enterprise network to the internet or connecting multiple branch offices. DISTRIBUTION - This role represents function as distribution switches or routers in hierarchical network designs. They aggregate traffic from access switches and route it toward the core of the network or toward other distribution switches. CORE - This role typically represents high-capacity switches or routers that form the backbone of the network. They handle large volumes of traffic and provide connectivity between different parts of network, such as connecting distribution switches or providing interconnection between different network segments. .. rst-class:: ansible-option-line :ansible-option-default-bold:`Default:` :ansible-option-default:`"ACCESS"` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.inventory_workflow_manager_module__parameter-config/serial_number_list: .. rst-class:: ansible-option-title **serial_number_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 serial numbers representing devices. Operations such as updating, deleting, resyncing, or rebooting can be performed as alternatives to using IP addresses. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.inventory_workflow_manager_module__parameter-config/snmp_auth_passphrase: .. rst-class:: ansible-option-title **snmp_auth_passphrase** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
SNMP authentication passphrase required for adding network, compute, and third-party devices. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.inventory_workflow_manager_module__parameter-config/snmp_auth_protocol: .. rst-class:: ansible-option-title **snmp_auth_protocol** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
SNMP authentication protocol. SHA (Secure Hash Algorithm) - cryptographic hash function commonly used for data integrity verification and authentication purposes. .. rst-class:: ansible-option-line :ansible-option-default-bold:`Default:` :ansible-option-default:`"SHA"` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.inventory_workflow_manager_module__parameter-config/snmp_mode: .. rst-class:: ansible-option-title **snmp_mode** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Device's snmp Mode refer to different SNMP (Simple Network Management Protocol) versions and their corresponding security levels. NOAUTHNOPRIV - This mode provides no authentication or encryption for SNMP messages. It means that devices communicating using SNMPv1 do not require any authentication (username/password) or encryption (data confidentiality). This makes it the least secure option. AUTHNOPRIV - This mode provides authentication but no encryption for SNMP messages. Authentication involves validating the source of the SNMP messages using a community string (similar to a password). However, the data transmitted between devices is not encrypted, so it's susceptible to eavesdropping. AUTHPRIV - This mode provides both authentication and encryption for SNMP messages. It offers the highest level of security among the three options. Authentication ensures that the source of the messages is genuine, and encryption ensures that the data exchanged between devices is confidential and cannot be intercepted by unauthorized parties. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.inventory_workflow_manager_module__parameter-config/snmp_priv_passphrase: .. rst-class:: ansible-option-title **snmp_priv_passphrase** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
SNMP private passphrase required for adding network, compute, and third-party devices. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.inventory_workflow_manager_module__parameter-config/snmp_priv_protocol: .. rst-class:: ansible-option-title **snmp_priv_protocol** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
SNMP private protocol required for adding network, compute, and third-party devices. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.inventory_workflow_manager_module__parameter-config/snmp_retry: .. rst-class:: ansible-option-title **snmp_retry** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
SNMP retry count. .. rst-class:: ansible-option-line :ansible-option-default-bold:`Default:` :ansible-option-default:`3` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.inventory_workflow_manager_module__parameter-config/snmp_ro_community: .. rst-class:: ansible-option-title **snmp_ro_community** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
SNMP Read-Only community required for adding V2C devices. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.inventory_workflow_manager_module__parameter-config/snmp_rw_community: .. rst-class:: ansible-option-title **snmp_rw_community** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
SNMP Read-Write community required for adding V2C devices. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.inventory_workflow_manager_module__parameter-config/snmp_timeout: .. rst-class:: ansible-option-title **snmp_timeout** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
SNMP timeout duration. .. rst-class:: ansible-option-line :ansible-option-default-bold:`Default:` :ansible-option-default:`5` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.inventory_workflow_manager_module__parameter-config/snmp_username: .. rst-class:: ansible-option-title **snmp_username** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
SNMP username required for adding network, compute, and third-party devices. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.inventory_workflow_manager_module__parameter-config/snmp_version: .. rst-class:: ansible-option-title **snmp_version** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
It is a standard protocol used for managing and monitoring network devices. v2 - In this communication between the SNMP manager (such as Cisco Catalyst) and the managed devices (such as routers, switches, or access points) is based on community strings.Community strings serve as form of authentication and they are transmitted in clear text, providing no encryption. v3 - It is the most secure version of SNMP, providing authentication, integrity, and encryption features. It allows for the use of usernames, authentication passwords, and encryption keys, providing stronger security compared to v2. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.inventory_workflow_manager_module__parameter-config/type: .. rst-class:: ansible-option-title **type** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Select Device's type from NETWORK\_DEVICE, COMPUTE\_DEVICE, MERAKI\_DASHBOARD, THIRD\_PARTY\_DEVICE, FIREPOWER\_MANAGEMENT\_SYSTEM. NETWORK\_DEVICE - This refers to traditional networking equipment such as routers, switches, access points, and firewalls. These devices are responsible for routing, switching, and providing connectivity within the network. COMPUTE\_DEVICE - These are computing resources such as servers, virtual machines, or containers that are part of the network infrastructure. Cisco Catalyst Center can integrate with compute devices to provide visibility and management capabilities, ensuring that the network and compute resources work together seamlessly to support applications and services. MERAKI\_DASHBOARD - It is cloud-based platform used to manage Meraki networking devices, including wireless access points, switches, security appliances, and cameras. THIRD\_PARTY\_DEVICE - This category encompasses devices from vendors other than Cisco or Meraki. Cisco Catalyst Center is designed to support integration with third-party devices through open standards and APIs. This allows organizations to manage heterogeneous network environments efficiently using Cisco Catalyst Center's centralized management and automation capabilities. FIREPOWER\_MANAGEMENT\_SYSTEM - It is a centralized management console used to manage Cisco's Firepower Next-Generation Firewall (NGFW) devices. It provides features such as policy management, threat detection, and advanced security analytics. .. rst-class:: ansible-option-line :ansible-option-default-bold:`Default:` :ansible-option-default:`"NETWORK\_DEVICE"` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.inventory_workflow_manager_module__parameter-config/update_mgmt_ipaddresslist: .. rst-class:: ansible-option-title **update_mgmt_ipaddresslist** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`list` / :ansible-option-elements:`elements=dictionary` .. raw:: html
- .. raw:: html
List of updated management IP addresses for network devices. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.inventory_workflow_manager_module__parameter-config/update_mgmt_ipaddresslist/exist_mgmt_ipaddress: .. rst-class:: ansible-option-title **exist_mgmt_ipaddress** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Device's existing Mgmt IpAddress. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.inventory_workflow_manager_module__parameter-config/update_mgmt_ipaddresslist/new_mgmt_ipaddress: .. rst-class:: ansible-option-title **new_mgmt_ipaddress** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Device's new Mgmt IpAddress. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.inventory_workflow_manager_module__parameter-config/username: .. rst-class:: ansible-option-title **username** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Username for accessing the device. Required for Adding Network Device. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.inventory_workflow_manager_module__parameter-config/value: .. rst-class:: ansible-option-title **value** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Value to assign to tag with or without the same user defined field name. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.inventory_workflow_manager_module__parameter-config/vlan_id: .. rst-class:: ansible-option-title **vlan_id** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
Unique Id number assigned to a VLAN within a network used only while updating interface details. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.inventory_workflow_manager_module__parameter-config/voice_vlan_id: .. rst-class:: ansible-option-title **voice_vlan_id** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
Identifier used to distinguish a specific VLAN that is dedicated to voice traffic used only while updating interface details. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.inventory_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 config 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.inventory_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.inventory_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.inventory_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.inventory_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.inventory_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.inventory_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.inventory_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.inventory_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.inventory_workflow_manager_module__parameter-dnac_username: .. _ansible_collections.cisco.dnac.inventory_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.inventory_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.inventory_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.inventory_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.inventory_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 Method used are devices.Devices.add\_device, devices.Devices.delete\_device\_by\_id, devices.Devices.sync\_devices, - Paths used are post /dna/intent/api/v1/network-device, delete /dna/intent/api/v1/network-device/{id}, put /dna/intent/api/v1/network-device, - Removed 'managementIpAddress' options in v4.3.0. - Renamed argument 'ip\_address' to 'ip\_address\_list' option in v6.12.0. - Removed 'serial\_number', 'device\_added', 'role\_source', options in v6.12.0. - 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 See Also -------- .. seealso:: `Cisco Catalyst Center documentation for Devices AddDevice2 `_ Complete reference of the AddDevice2 API. `Cisco Catalyst Center documentation for Devices DeleteDeviceById `_ Complete reference of the DeleteDeviceById API. `Cisco Catalyst Center documentation for Devices SyncDevices2 `_ Complete reference of the SyncDevices2 API. .. Examples Examples -------- .. code-block:: yaml+jinja - name: Add new device in Inventory with full credentials cisco.dnac.inventory_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_level: "{{dnac_log_level}}" dnac_log: False state: merged config: - cli_transport: ssh compute_device: False password: Test@123 enable_password: Test@1234 extended_discovery_info: test http_username: "testuser" http_password: "test" http_port: "443" http_secure: False ip_address_list: ["1.1.1.1", "2.2.2.2"] netconf_port: 830 snmp_auth_passphrase: "Lablab@12" snmp_auth_protocol: SHA snmp_mode: AUTHPRIV snmp_priv_passphrase: "Lablab@123" snmp_priv_protocol: AES256 snmp_retry: 3 snmp_timeout: 5 snmp_username: v3Public snmp_version: v3 type: NETWORK_DEVICE username: cisco - name: Add new Compute device in Inventory with full credentials.Inputs needed for Compute Device cisco.dnac.inventory_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_level: "{{dnac_log_level}}" dnac_log: False state: merged config: - ip_address_list: ["1.1.1.1", "2.2.2.2"] http_username: "testuser" http_password: "test" http_port: "443" snmp_auth_passphrase: "Lablab@12" snmp_auth_protocol: SHA snmp_mode: AUTHPRIV snmp_priv_passphrase: "Lablab@123" snmp_priv_protocol: AES256 snmp_retry: 3 snmp_timeout: 5 snmp_username: v3Public compute_device: True username: cisco type: "COMPUTE_DEVICE" - name: Add new Meraki device in Inventory with full credentials.Inputs needed for Meraki Device. cisco.dnac.inventory_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_level: "{{dnac_log_level}}" dnac_log: False state: merged config: - http_password: "test" type: "MERAKI_DASHBOARD" - name: Add new Firepower Management device in Inventory with full credentials.Input needed to add Device. cisco.dnac.inventory_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_level: "{{dnac_log_level}}" dnac_log: False state: merged config: - ip_address_list: ["1.1.1.1", "2.2.2.2"] http_username: "testuser" http_password: "test" http_port: "443" type: "FIREPOWER_MANAGEMENT_SYSTEM" - name: Add new Third Party device in Inventory with full credentials.Input needed to add Device. cisco.dnac.inventory_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_level: "{{dnac_log_level}}" dnac_log: False state: merged config: - ip_address_list: ["1.1.1.1", "2.2.2.2"] snmp_auth_passphrase: "Lablab@12" snmp_auth_protocol: SHA snmp_mode: AUTHPRIV snmp_priv_passphrase: "Lablab@123" snmp_priv_protocol: AES256 snmp_retry: 3 snmp_timeout: 5 snmp_username: v3Public type: "THIRD_PARTY_DEVICE" - name: Update device details or credentails in Inventory cisco.dnac.inventory_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_level: "{{dnac_log_level}}" dnac_log: False state: merged config: - cli_transport: telnet compute_device: False password: newtest123 enable_password: newtest1233 ip_address_list: ["1.1.1.1", "2.2.2.2"] type: NETWORK_DEVICE device_updated: True credential_update: True - name: Update new management IP address of device in inventory cisco.dnac.inventory_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_level: "{{dnac_log_level}}" dnac_log: False state: merged config: - device_updated: True ip_address_list: ["1.1.1.1"] credential_update: True update_mgmt_ipaddresslist: - exist_mgmt_ipaddress: "1.1.1.1" new_mgmt_ipaddress: "12.12.12.12" - name: Associate Wired Devices to site and Provisioned it in Inventory cisco.dnac.inventory_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_level: "{{dnac_log_level}}" dnac_log: False state: merged config: - provision_wired_device: - device_ip: "1.1.1.1" site_name: "Global/USA/San Francisco/BGL_18/floor_pnp" resync_retry_count: 200 resync_interval: 2 - device_ip: "2.2.2.2" site_name: "Global/USA/San Francisco/BGL_18/floor_test" resync_retry_count: 200 resync_retry_interval: 2 - name: Re-Provisioned Wired Devices to site in Inventory cisco.dnac.inventory_intent: 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_level: "{{dnac_log_level}}" dnac_log: False state: merged config: - reprovision_wired_device: - device_ip: "1.1.1.1" site_name: "Global/USA/San Francisco/BGL_18/floor_pnp" - device_ip: "2.2.2.2" site_name: "Global/USA/San Francisco/BGL_18/floor_test" - name: Associate Wireless Devices to site and Provisioned it in Inventory cisco.dnac.inventory_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_level: "{{dnac_log_level}}" dnac_log: False state: merged config: provision_wireless_device: - device_ip: "1.1.1.1" site_name: "Global/USA/BGL_18/floor_pnp" managed_ap_locations: ["Global/USA/BGL_18/floor_pnp", "Global/USA/BGL_18/floor_test"] dynamic_interfaces: - interface_ip_address: 23.23.21.12 interface_netmask_in_cidr: 24 interface_gateway: "gateway" lag_or_port_number: 12 vlan_id: 99 interface_name: "etherenet0/0" resync_retry_count: 200 resync_retry_interval: 2 - device_ip: "2.2.2.2" site_name: "Global/USA/BGL_18/floor_test" managed_ap_locations: ["Global/USA/BGL_19/floor_pnp", "Global/USA/BGL_19/floor_test"] dynamic_interfaces: - interface_ip_address: 32.31.12.23 interface_netmask_in_cidr: 26 interface_gateway: "gateway_test" lag_or_port_number: 33 vlan_id: 78 interface_name: "etherenet1/1" resync_retry_count: 200 resync_retry_interval: 2 - name: Update Device Role with IP Address cisco.dnac.inventory_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_level: "{{dnac_log_level}}" dnac_log: False state: merged config: - ip_address_list: ["1.1.1.1", "2.2.2.2"] device_updated: True update_device_role: role: ACCESS - name: Update Interface details with IP Address cisco.dnac.inventory_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_level: "{{dnac_log_level}}" dnac_log: False state: merged config: - ip_address_list: ["1.1.1.1", "2.2.2.2"] device_updated: True update_interface_details: description: "Testing for updating interface details" admin_status: "UP" vlan_id: 23 voice_vlan_id: 45 deployment_mode: "Deploy" interface_name: ["GigabitEthernet1/0/11", FortyGigabitEthernet1/1/1] clear_mac_address_table: True - name: Export Device Details in a CSV file Interface details with IP Address cisco.dnac.inventory_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_level: "{{dnac_log_level}}" dnac_log: False state: merged config: - ip_address_list: ["1.1.1.1", "2.2.2.2"] export_device_list: password: "File_password" operation_enum: "0" parameters: ["componentName", "SerialNumber", "Last Sync Status"] - name: Create Global User Defined with IP Address cisco.dnac.inventory_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_level: "{{dnac_log_level}}" dnac_log: False state: merged config: - ip_address_list: ["1.1.1.1", "2.2.2.2"] add_user_defined_field: - name: Test123 description: "Added first udf for testing" value: "value123" - name: Test321 description: "Added second udf for testing" value: "value321" - name: Resync Device with IP Addresses cisco.dnac.inventory_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_level: "{{dnac_log_level}}" dnac_log: False state: merged config: - ip_address_list: ["1.1.1.1", "2.2.2.2"] device_resync: True force_sync: False - name: Reboot AP Devices with IP Addresses cisco.dnac.inventory_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_level: "{{dnac_log_level}}" dnac_log: False state: merged config: - ip_address_list: ["1.1.1.1", "2.2.2.2"] reboot_device: True - name: Delete Provision/Unprovision Devices by IP Address cisco.dnac.inventory_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: False dnac_log_level: "{{dnac_log_level}}" state: deleted config: - ip_address_list: ["1.1.1.1", "2.2.2.2"] clean_config: False - name: Delete Global User Defined Field with name cisco.dnac.inventory_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_level: "{{dnac_log_level}}" dnac_log: False state: deleted config: - ip_address_list: ["1.1.1.1", "2.2.2.2"] add_user_defined_field: name: "Test123" .. 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.inventory_workflow_manager_module__return-dnac_response: .. rst-class:: ansible-option-title **dnac_response** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
A dictionary or list with the response returned by the Cisco Catalyst Center Python SDK .. 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": {"taskId": "string", "url": "string"}, "version": "string"}` .. raw:: html
.. Status (Presently only deprecated) .. Authors Authors ~~~~~~~ - Abhishek Maheshwari (@abmahesh) Madhan Sankaranarayanan (@madhansansel) .. Extra links Collection links ~~~~~~~~~~~~~~~~ .. raw:: html .. Parsing errors