.. 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.network_devices_info_workflow_manager_module: .. Anchors: short name for ansible.builtin .. Anchors: aliases .. Title cisco.dnac.network_devices_info_workflow_manager module -- Gather facts about network devices from Cisco Catalyst Center (facts/info module) using flexible filters. ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. Collection note .. note:: This module is part of the `cisco.dnac collection `_ (version 6.46.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.network_devices_info_workflow_manager`. .. version_added .. rst-class:: ansible-version-added New in cisco.dnac 6.31.0 .. contents:: :local: :depth: 1 .. Deprecated Synopsis -------- .. Description - Gathers detailed facts (information) about network devices managed by Cisco Catalyst Center using flexible user-defined filters. - Supports filtering by management IP, MAC address, hostname, serial number, software type, software version, role, device type, family, and site hierarchy. - Allows selection of specific device information types, such as device details, interfaces, VLANs, line cards, supervisor cards, POE, module count, connected devices, configuration, summary, polling interval, stack, and link mismatch details. - Handles query retries, timeouts, and polling intervals for robust data collection. - Supports output to a file using the \ :literal:`output\_file\_info`\ option. Output can be JSON or YAML, with user-defined file path, file mode (overwrite or append), and optional timestamp. - If \ :literal:`output\_file\_info`\ is provided, results are written to the file; otherwise, results are returned in the Ansible output. - Returns structured results for each requested information type, or an empty list if no devices match the filters after all retries. - This module is tagged as a facts/info module and is safe to use in check mode. .. Aliases .. Requirements .. _ansible_collections.cisco.dnac.network_devices_info_workflow_manager_module_requirements: Requirements ------------ The below requirements are needed on the host that executes this module. - dnacentersdk \>= 2.9.3 - 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.network_devices_info_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 dictionaries specifying network device query parameters. Each dictionary must contain a \ :literal:`network\_devices`\ list with at least one unique identifier (such as management IP, MAC address, hostname, or serial number) per device. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.network_devices_info_workflow_manager_module__parameter-config/network_devices: .. rst-class:: ansible-option-title **network_devices** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`list` / :ansible-option-elements:`elements=dictionary` .. raw:: html
- .. raw:: html
Contains filters and configuration for retrieving network devices information. Requires at least one device identification or filtering criterion. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.network_devices_info_workflow_manager_module__parameter-config/network_devices/device_family: .. rst-class:: ansible-option-title **device_family** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Device family filter for device category-based filtering. Examples include "Switches and Hubs", "Routers", "Wireless Controller". .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`"Switches and Hubs"` - :ansible-option-choices-entry:`"Routers"` - :ansible-option-choices-entry:`"Wireless Controller"` - :ansible-option-choices-entry:`"Unified AP"` - :ansible-option-choices-entry:`"Sensors"` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.network_devices_info_workflow_manager_module__parameter-config/network_devices/device_identifier: .. rst-class:: ansible-option-title **device_identifier** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`list` / :ansible-option-elements:`elements=dictionary` .. raw:: html
- .. raw:: html
Optional list of device identification criteria to further filter network devices. Provides granular control over which network devices have their information retrieved. Multiple identification methods can be combined for comprehensive device targeting. Only devices that are both network-enabled and match the identifier criteria will be processed. When multiple identification parameters (ip\_address, hostname, serial\_number, mac\_address) are specified in the same entry, they must all refer to the same physical device for proper validation. Use separate device\_identifier entries when targeting different devices with different identification methods. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.network_devices_info_workflow_manager_module__parameter-config/network_devices/device_identifier/hostname: .. rst-class:: ansible-option-title **hostname** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`list` / :ansible-option-elements:`elements=string` .. raw:: html
- .. raw:: html
List of device hostnames to identify specific network devices. Each hostname must match exactly as configured in Cisco Catalyst Center device inventory. Only devices with matching hostnames will have their information retrieved. Hostnames are case-sensitive and must match the exact device hostname configuration. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.network_devices_info_workflow_manager_module__parameter-config/network_devices/device_identifier/ip_address: .. rst-class:: ansible-option-title **ip_address** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`list` / :ansible-option-elements:`elements=string` .. raw:: html
- .. raw:: html
List of management IP addresses to identify specific network devices. Each IP address must correspond to a managed device in the Cisco Catalyst Center inventory. Only devices with matching IP addresses will have their information retrieved. IP addresses must be valid IPv4 addresses in dotted decimal notation. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.network_devices_info_workflow_manager_module__parameter-config/network_devices/device_identifier/mac_address: .. rst-class:: ansible-option-title **mac_address** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`list` / :ansible-option-elements:`elements=string` .. raw:: html
- .. raw:: html
List of device MAC addresses to identify specific network devices. Each MAC address must correspond to a managed device in the Cisco Catalyst Center inventory. Only devices with matching MAC addresses will have their information retrieved. MAC addresses should be in standard format (e.g., "aa:bb:cc:dd:ee:ff"). .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.network_devices_info_workflow_manager_module__parameter-config/network_devices/device_identifier/serial_number: .. rst-class:: ansible-option-title **serial_number** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`list` / :ansible-option-elements:`elements=string` .. raw:: html
- .. raw:: html
List of device serial numbers to identify specific network devices. Each serial number must match exactly as recorded in Cisco Catalyst Center device inventory. Only devices with matching serial numbers will have their information retrieved. Serial numbers are case-sensitive and must match the format used by the device manufacturer. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.network_devices_info_workflow_manager_module__parameter-config/network_devices/device_role: .. rst-class:: ansible-option-title **device_role** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Device role filter for network function-based filtering. Common roles include ACCESS, DISTRIBUTION, CORE, WAN, WLC, DATA\_CENTER. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`"ACCESS"` - :ansible-option-choices-entry:`"DISTRIBUTION"` - :ansible-option-choices-entry:`"CORE"` - :ansible-option-choices-entry:`"WAN"` - :ansible-option-choices-entry:`"WLC"` - :ansible-option-choices-entry:`"DATA\_CENTER"` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.network_devices_info_workflow_manager_module__parameter-config/network_devices/device_type: .. rst-class:: ansible-option-title **device_type** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Device type filter for specific device models. Examples include "Cisco Catalyst 9300 Switch", "Cisco Catalyst 9400 Switch". .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`"Cisco Catalyst 9300 Switch"` - :ansible-option-choices-entry:`"Cisco Catalyst 9400 Switch"` - :ansible-option-choices-entry:`"Cisco Catalyst 9500 Switch"` - :ansible-option-choices-entry:`"Cisco Catalyst C9500-48Y4C Switch"` - :ansible-option-choices-entry:`"Cisco 3800E Unified Access Point"` - :ansible-option-choices-entry:`"Cisco Catalyst 9130AXI Unified Access Point"` - :ansible-option-choices-entry:`"Cisco Catalyst 9800-L-C Wireless Controller"` - :ansible-option-choices-entry:`"Cisco Catalyst 9115AXI Unified Access Point"` - :ansible-option-choices-entry:`"Cisco Catalyst Wireless 9164I Unified Access Point"` - :ansible-option-choices-entry:`"Cisco Wireless 9176D1 Access Point"` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.network_devices_info_workflow_manager_module__parameter-config/network_devices/interval: .. rst-class:: ansible-option-title **interval** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
Time in seconds to wait between retry attempts for device information retrieval operations. Applied as a delay between failed attempts during device lookup filtering processes. Combined with timeout and retries to determine total operation duration. If (retries \* interval) exceeds timeout, retries will continue until timeout is reached. Longer intervals help reduce API load on Cisco Catalyst Center during retry operations. Should be balanced with timeout settings to avoid excessively long operation times. .. rst-class:: ansible-option-line :ansible-option-default-bold:`Default:` :ansible-option-default:`10` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.network_devices_info_workflow_manager_module__parameter-config/network_devices/os_type: .. rst-class:: ansible-option-title **os_type** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Operating system type filter for software platform filtering. Common types include IOS-XE, IOS, IOS-XR, NX-OS, ASA, FTD. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`"IOS-XE"` - :ansible-option-choices-entry:`"IOS"` - :ansible-option-choices-entry:`"IOS-XR"` - :ansible-option-choices-entry:`"NX-OS"` - :ansible-option-choices-entry:`"ASA"` - :ansible-option-choices-entry:`"FTD"` - :ansible-option-choices-entry:`"IOS-XE SD-WAN"` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.network_devices_info_workflow_manager_module__parameter-config/network_devices/output_file_info: .. rst-class:: ansible-option-title **output_file_info** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
Controls file output generation for network device information retrieval results. When provided, saves retrieved device information to the specified file along with returning the data in standard Ansible module output. Supports flexible file formatting, writing modes, and optional timestamp inclusion for audit purposes. Enables automated reporting and data archival workflows for network device monitoring operations. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.network_devices_info_workflow_manager_module__parameter-config/network_devices/output_file_info/file_format: .. rst-class:: ansible-option-title **file_format** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Output data format for the generated file. Determines file structure and extension applied to the file path. YAML format provides better human readability while JSON offers programmatic parsing advantages. Format selection affects file extension and data serialization method. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`"json"` - :ansible-option-choices-entry-default:`"yaml"` :ansible-option-choices-default-mark:`← (default)` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.network_devices_info_workflow_manager_module__parameter-config/network_devices/output_file_info/file_mode: .. rst-class:: ansible-option-title **file_mode** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
File writing mode determining how data is written to the target file. Use 'w' to overwrite existing file content or 'a' to append new data to existing content. Append mode enables incremental data collection across multiple playbook runs. Overwrite mode ensures clean data sets for each execution. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry-default:`"w"` :ansible-option-choices-default-mark:`← (default)` - :ansible-option-choices-entry:`"a"` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.network_devices_info_workflow_manager_module__parameter-config/network_devices/output_file_info/file_path: .. rst-class:: ansible-option-title **file_path** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Absolute path to the output file without file extension. File extension is automatically appended based on the selected file format (.json or .yaml). Directory structure will be created automatically if it does not exist. Path must be writable by the user executing the Ansible playbook. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.network_devices_info_workflow_manager_module__parameter-config/network_devices/output_file_info/timestamp: .. rst-class:: ansible-option-title **timestamp** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Controls inclusion of data retrieval timestamp in the output file content. When enabled, adds the data collection timestamp as the first entry for audit trail purposes. Useful for tracking when network device information was collected in automated workflows. Timestamp format follows "YYYY-MM-DD HH:MM:SS" standard format. .. 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.network_devices_info_workflow_manager_module__parameter-config/network_devices/requested_info: .. rst-class:: ansible-option-title **requested_info** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`list` / :ansible-option-elements:`elements=string` .. raw:: html
- .. raw:: html
List of device information types to retrieve. If set to ['all'], retrieves all available information categories. If specific types are listed, only those will be retrieved. If omitted, defaults to all information types. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`"all"` - :ansible-option-choices-entry:`"device\_interfaces\_by\_range\_info"` - :ansible-option-choices-entry:`"device\_info"` - :ansible-option-choices-entry:`"interface\_info"` - :ansible-option-choices-entry:`"interface\_vlan\_info"` - :ansible-option-choices-entry:`"line\_card\_info"` - :ansible-option-choices-entry:`"supervisor\_card\_info"` - :ansible-option-choices-entry:`"poe\_info"` - :ansible-option-choices-entry:`"module\_count\_info"` - :ansible-option-choices-entry:`"connected\_device\_info"` - :ansible-option-choices-entry:`"device\_config\_info"` - :ansible-option-choices-entry:`"device\_summary\_info"` - :ansible-option-choices-entry:`"device\_polling\_interval\_info"` - :ansible-option-choices-entry:`"device\_stack\_info"` - :ansible-option-choices-entry:`"device\_link\_mismatch\_info"` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.network_devices_info_workflow_manager_module__parameter-config/network_devices/retries: .. rst-class:: ansible-option-title **retries** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
Number of retry attempts for device information retrieval operations when initial attempts fail. Applied to each individual device lookup filtering operation. Higher retry counts improve reliability in environments with intermittent connectivity or high API load. Total operation time is affected by retries combined with timeout and interval settings. Actual retry attempts may be less than specified if timeout period is reached first. .. rst-class:: ansible-option-line :ansible-option-default-bold:`Default:` :ansible-option-default:`3` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.network_devices_info_workflow_manager_module__parameter-config/network_devices/site_hierarchy: .. rst-class:: ansible-option-title **site_hierarchy** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Site hierarchy path for filtering devices by location. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.network_devices_info_workflow_manager_module__parameter-config/network_devices/software_version: .. rst-class:: ansible-option-title **software_version** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Software version filter for specific software releases. Format example "16.12.05", "17.6.1". .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.network_devices_info_workflow_manager_module__parameter-config/network_devices/timeout: .. rst-class:: ansible-option-title **timeout** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
Maximum time in seconds to wait for device information retrieval operations to complete. Applied to each individual device lookup operation during the filtering process. If device information retrieval fails within this timeout period, the operation will retry based on the 'retries' parameter. Longer timeouts may be needed for environments with slower network connectivity or larger device inventories. If timeout is greater than (retries \* interval), the operation will continue retrying until the timeout period ends. Total operation time is bounded by the timeout value regardless of retry configuration. .. rst-class:: ansible-option-line :ansible-option-default-bold:`Default:` :ansible-option-default:`120` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.network_devices_info_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.network_devices_info_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.network_devices_info_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.network_devices_info_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.network_devices_info_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.network_devices_info_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.network_devices_info_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.network_devices_info_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.network_devices_info_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.network_devices_info_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.network_devices_info_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.network_devices_info_workflow_manager_module__parameter-dnac_username: .. _ansible_collections.cisco.dnac.network_devices_info_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.network_devices_info_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.network_devices_info_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.network_devices_info_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 desired state of the configuration after module execution. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry-default:`"gathered"` :ansible-option-choices-default-mark:`← (default)` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.network_devices_info_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:: - This is a facts/info module, it only retrieves information and does not modify any device or configuration. - Writing to a local file is for reporting/archival purposes only and does not affect the state of any managed device. - Safe to use in check mode. - SDK Methods used are - devices.Devices.get\_device\_list - devices.Devices.get\_device\_interface\_vlans - devices.Devices.get\_device\_interfaces\_by\_specified\_range - devices.Devices.get\_linecard\_details - devices.Devices.inventory\_insight\_device\_link\_mismatch - devices.Devices.get\_stack\_details\_for\_device - devices.Devices.get\_device\_config\_by\_id - devices.Devices.get\_polling\_interval\_by\_id - devices.Devices.get\_supervisor\_card\_detail - devices.Devices.poe\_details - devices.Devices.get\_connected\_device\_detail - devices.Devices.get\_interface\_info\_by\_id - devices.Devices.get\_module\_count - devices.Devices.get\_network\_device\_by\_ip - devices.Devices.get\_device\_summary - Paths used are - GET/dna/intent/api/v1/network-device - GET/dna/intent/api/v1/network-device/{id}/vlan - GET/dna/intent/api/v1/interface/network-device/{deviceId}/{startIndex}/{recordsToReturn} - GET/dna/intent/api/v1/network-device/{deviceUuid}/line-card - GET/dna/intent/api/v1/network-device/insight/{siteId}/device-link - GET/dna/intent/api/v1/network-device/{deviceId}/stack - GET/dna/intent/api/v1/network-device/{networkDeviceId}/config - GET/dna/intent/api/v1/network-device/{id}/collection-schedule - GET/dna/intent/api/v1/network-device/{id}/brief - GET/dna/intent/api/v1/network-device/{deviceUuid}/supervisor-card - GET/dna/intent/api/v1/network-device/{deviceUuid}/poe - GET/dna/intent/api/v1/network-device/{deviceUuid}/interface/{interfaceUuid}/neighbor - GET/dna/intent/api/v1/interface/network-device/{deviceId} - GET/dna/intent/api/v1/network-device/module/count - GET/dna/intent/api/v1/network-device/ip-address/{ipAddress} - 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 # 1 Example Playbook to gather specific network device information from Cisco Catalyst Center --- - name: Get Specific Network devices information on Cisco Catalyst Center hosts: localhost connection: local vars_files: - "credentials.yml" tasks: - name: Gather detailed facts for specific network devices cisco.dnac.network_devices_info_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: false dnac_api_task_timeout: 1000 dnac_task_poll_interval: 1 state: queried config: - network_devices: - site_hierarchy: Global/USA/SAN JOSE device_type: "Cisco Catalyst 9300 Switch" device_role: "ACCESS" device_family: "Switches and Hubs" software_version: "17.12.1" os_type: "IOS-XE" device_identifier: - ip_address: ["204.1.2.2"] - serial_number: ["FCW2137L0SB"] - hostname: ["SJ-BN-9300.cisco.local"] - mac_address: ["90:88:55:90:26:00"] timeout: 60 retries: 3 interval: 10 requested_info: - device_info - interface_info - interface_vlan_info - line_card_info - supervisor_card_info - poe_info - module_count_info - connected_device_info - device_interfaces_by_range_info - device_config_info - device_summary_info - device_polling_interval_info - device_stack_info - device_link_mismatch_info output_file_info: file_path: /Users/priyadharshini/Downloads/info file_format: json file_mode: w timestamp: true # 2 Example Playbook to gather all network device information from Cisco Catalyst Center - name: Get All Network devices information on Cisco Catalyst Center hosts: localhost connection: local vars_files: - "credentials.yml" tasks: - name: Gather detailed facts for all network devices cisco.dnac.network_devices_info_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: false dnac_api_task_timeout: 1000 dnac_task_poll_interval: 1 state: queried config: - network_devices: - site_hierarchy: Global/USA/SAN JOSE device_type: "Cisco Catalyst 9300 Switch" device_role: "ACCESS" device_family: "Switches and Hubs" software_version: "17.12.1" os_type: "IOS-XE" device_identifier: - ip_address: ["204.1.2.2"] - serial_number: ["FCW2137L0SB"] - hostname: ["SJ-BN-9300.cisco.local"] - mac_address: ["90:88:55:90:26:00"] timeout: 60 retries: 3 interval: 10 requested_info: - all output_file_info: file_path: /Users/priyadharshini/Downloads/info file_format: json file_mode: w timestamp: true .. 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.network_devices_info_workflow_manager_module__return-response_connected_device_detail: .. rst-class:: ansible-option-title **response_connected_device_detail** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
Details of the response containing information about a connected neighbor device. .. 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": {"capabilities": ["IGMP\_CONDITIONAL\_FILTERING", "ROUTER", "SWITCH"], "neighborDevice": "DC-T-9300", "neighborPort": "TenGigabitEthernet1/1/8"}, "version": "string"}` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.network_devices_info_workflow_manager_module__return-response_device_config: .. rst-class:: ansible-option-title **response_device_config** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
Details of the response containing the device configuration as a string. .. 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": "Building Configuration Operation Successful", "version": "string"}` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.network_devices_info_workflow_manager_module__return-response_device_info: .. rst-class:: ansible-option-title **response_device_info** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
Device information for network devices, including family, type, software version, serial number, and more. Returned for each device matching the query. .. 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": [{"apEthernetMacAddress": null, "apManagerInterfaceIp": "", "associatedWlcIp": "", "bootDateTime": "2025-04-23 04:36:19", "collectionInterval": "Global Default", "collectionStatus": "Managed", "description": "Cisco IOS Software [Amsterdam], Catalyst L3 Switch Software (CAT9K\_IOSXE), Version 17.2.1, RELEASE SOFTWARE (fc4) Technical Support: http://www.cisco.com/techsupport Copyright (c) 1986-2020 by Cisco Systems, Inc. Compiled Thu 26-Mar-20 03:29 by mcpre netconf enabled", "deviceSupportLevel": "Supported", "dnsResolvedManagementAddress": "204.1.2.3", "errorCode": null, "errorDescription": null, "family": "Switches and Hubs", "hostname": "test123", "id": "e62e6405-13e4-4f1b-ae1c-580a28a96a88", "instanceTenantId": "66e48af26fe687300375675e", "instanceUuid": "e62e6405-13e4-4f1b-ae1c-580a28a96a88", "interfaceCount": "0", "inventoryStatusDetail": "\\\", "lastDeviceResyncStartTime": "2025-06-26 00:11:45", "lastManagedResyncReasons": "Periodic", "lastUpdateTime": 1750896739913, "lastUpdated": "2025-06-26 00:12:19", "lineCardCount": "0", "lineCardId": "", "location": null, "locationName": null, "macAddress": "0c:75:bd:42:db:80", "managedAtleastOnce": false, "managementIpAddress": "204.1.2.3", "managementState": "Managed", "memorySize": "NA", "pendingSyncRequestsCount": "0", "platformId": "C9300-48UXM", "reachabilityFailureReason": "", "reachabilityStatus": "Reachable", "reasonsForDeviceResync": "Periodic", "reasonsForPendingSyncRequests": "", "role": "ACCESS", "roleSource": "MANUAL", "serialNumber": "FJC2335S09F", "series": "Cisco Catalyst 9300 Series Switches", "snmpContact": "", "snmpLocation": "", "softwareType": "IOS-XE", "softwareVersion": "17.2.1", "syncRequestedByApp": "", "tagCount": "0", "tunnelUdpPort": null, "type": "Cisco Catalyst 9300 Switch", "upTime": "63 days, 19:36:43.08", "uptimeSeconds": 5528803, "vendor": "Cisco", "waasDeviceMode": null}], "version": "string"}` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.network_devices_info_workflow_manager_module__return-response_device_interface_vlan_info: .. rst-class:: ansible-option-title **response_device_interface_vlan_info** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
Details of the response containing VLAN information for device interfaces. .. 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": [{"interfaceName": "GigabitEthernet0/1", "ipAddress": "192.168.10.25", "mask": 24, "networkAddress": "192.168.10.0", "numberOfIPs": 254, "prefix": "192.168.10.0/24", "vlanNumber": 10, "vlanType": "Data"}], "version": "string"}` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.network_devices_info_workflow_manager_module__return-response_device_interfaces_range: .. rst-class:: ansible-option-title **response_device_interfaces_range** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
Details of the response containing device interface information retrieved by a specified range. .. 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": [{"addresses": [], "adminStatus": "UP", "className": null, "description": "", "deviceId": "e62e6405-13e4-4f1b-ae1c-580a28a96a88", "duplex": "FullDuplex", "id": "c9c638b6-4627-4a2e-be25-05f6e487bfcf", "ifIndex": "73", "instanceTenantId": "66e48af26fe687300375675e", "instanceUuid": "c9c638b6-4627-4a2e-be25-05f6e487bfcf", "interfaceType": "Physical", "ipv4Address": null, "ipv4Mask": null, "isisSupport": "false", "lastIncomingPacketTime": null, "lastOutgoingPacketTime": 1750896368000, "lastUpdated": null, "macAddress": "0c:75:bd:42:db:c1", "mappedPhysicalInterfaceId": null, "mappedPhysicalInterfaceName": null, "mediaType": null, "mtu": "9100", "name": null, "nativeVlanId": "1", "ospfSupport": "false", "pid": "C9300-48UXM", "portMode": "access", "portName": "AppGigabitEthernet1/0/1", "portType": "Ethernet Port", "serialNo": "FJC2335S09F", "series": "Cisco Catalyst 9300 Series Switches", "speed": "1000000", "status": "up", "vlanId": "1", "voiceVlan": ""}], "version": "string"}` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.network_devices_info_workflow_manager_module__return-response_device_summary: .. rst-class:: ansible-option-title **response_device_summary** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
Details of the response containing a summary of the device. .. 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": {"id": "e62e6405-13e4-4f1b-ae1c-580a28a96a88", "role": "ACCESS", "roleSource": "MANUAL"}, "version": "string"}` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.network_devices_info_workflow_manager_module__return-response_interface_info: .. rst-class:: ansible-option-title **response_interface_info** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
Details of the response containing interface information for a device. .. 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": [{"addresses": [], "adminStatus": "UP", "className": null, "description": "", "deviceId": "e62e6405-13e4-4f1b-ae1c-580a28a96a88", "duplex": "FullDuplex", "id": "c9c638b6-4627-4a2e-be25-05f6e487bfcf", "ifIndex": "73", "instanceTenantId": "66e48af26fe687300375675e", "instanceUuid": "c9c638b6-4627-4a2e-be25-05f6e487bfcf", "interfaceType": "Physical", "ipv4Address": null, "ipv4Mask": null, "isisSupport": "false", "lastIncomingPacketTime": null, "lastOutgoingPacketTime": 1750896368000, "lastUpdated": null, "macAddress": "0c:75:bd:42:db:c1", "mappedPhysicalInterfaceId": null, "mappedPhysicalInterfaceName": null, "mediaType": null, "mtu": "9100", "name": null, "nativeVlanId": "1", "ospfSupport": "false", "pid": "C9300-48UXM", "portMode": "access", "portName": "AppGigabitEthernet1/0/1", "portType": "Ethernet Port", "serialNo": "FJC2335S09F", "series": "Cisco Catalyst 9300 Series Switches", "speed": "1000000", "status": "up", "vlanId": "1", "voiceVlan": ""}], "version": "string"}` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.network_devices_info_workflow_manager_module__return-response_inventory_insight_link_mismatch: .. rst-class:: ansible-option-title **response_inventory_insight_link_mismatch** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
Details of the response containing device link mismatch information from Inventory Insight API. .. 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": [{"avgUpdateFrequency": 4.0, "endDeviceHostName": "switch-nyc-01", "endDeviceId": "device-1001", "endDeviceIpAddress": "192.168.1.10", "endPortAddress": "GigabitEthernet1/0/24", "endPortAllowedVlanIds": "10,20,30", "endPortDuplex": "full", "endPortId": "endport-1001", "endPortMask": "255.255.255.0", "endPortName": "Gi1/0/24", "endPortNativeVlanId": "10", "endPortPepId": "pep-ep-1001", "endPortSpeed": "1000Mbps", "instanceTenantId": "tenant-xyz123", "instanceUuid": "123e4567-e89b-12d3-a456-426614174000", "lastUpdated": "2025-06-26T10:15:00Z", "linkStatus": "up", "numUpdates": 15, "startDeviceHostName": "router-dc-01", "startDeviceId": "device-2001", "startDeviceIpAddress": "192.168.1.1", "startPortAddress": "GigabitEthernet0/1", "startPortAllowedVlanIds": "10,20,30", "startPortDuplex": "full", "startPortId": "startport-2001", "startPortMask": "255.255.255.0", "startPortName": "Gi0/1", "startPortNativeVlanId": "10", "startPortPepId": "pep-sp-2001", "startPortSpeed": "1000Mbps", "type": "ethernet-link"}], "version": "string"}` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.network_devices_info_workflow_manager_module__return-response_linecard_details: .. rst-class:: ansible-option-title **response_linecard_details** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
Details of the response containing linecard information for the device. .. 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": [{"partno": "PN987654321", "serialno": "SN123456789", "slotno": "Slot-04", "switchno": "SW-001-A1"}], "version": "string"}` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.network_devices_info_workflow_manager_module__return-response_module_count: .. rst-class:: ansible-option-title **response_module_count** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
Details of the response containing the count of modules. .. 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:`{"module\_count\_info": [3], "version": "string"}` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.network_devices_info_workflow_manager_module__return-response_network_device_by_ip: .. rst-class:: ansible-option-title **response_network_device_by_ip** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
Details of the response containing network device information retrieved by IP address. .. 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": {"apEthernetMacAddress": "00:1A:2B:3C:4D:5E", "apManagerInterfaceIp": "10.10.10.15", "associatedWlcIp": "10.10.10.1", "bootDateTime": "2025-06-20T09:30:00Z", "collectionInterval": "300", "collectionStatus": "success", "description": "Office wireless access point on Floor 2", "deviceSupportLevel": "Gold", "dnsResolvedManagementAddress": "ap-office23.example.com", "errorCode": "0", "errorDescription": "", "family": "Cisco Aironet", "hostname": "AP-Office-23", "id": "ap-12345", "instanceTenantId": "tenant-001", "instanceUuid": "a1b2c3d4-e5f6-7890-1234-56789abcdef0", "interfaceCount": "6", "inventoryStatusDetail": "Active", "lastDeviceResyncStartTime": "2025-06-24T08:00:00Z", "lastUpdateTime": 1687700000, "lastUpdated": "2025-06-25T10:00:00Z", "lineCardCount": "1", "lineCardId": "lc-001", "location": "Building 1, Floor 2", "locationName": "HQ Floor 2", "macAddress": "00:1A:2B:3C:4D:5E", "managedAtleastOnce": true, "managementIpAddress": "10.10.10.15", "managementState": "Managed", "memorySize": "2048MB", "pendingSyncRequestsCount": "0", "platformId": "AIR-AP2800", "reachabilityFailureReason": "", "reachabilityStatus": "reachable", "reasonsForDeviceResync": "", "reasonsForPendingSyncRequests": "", "role": "Access Point", "roleSource": "auto-discovery", "serialNumber": "FTX12345678", "series": "2800", "snmpContact": "admin@example.com", "snmpLocation": "Data Center Rack 5", "softwareType": "IOS-XE", "softwareVersion": "17.6.1", "tagCount": "4", "tunnelUdpPort": "4500", "type": "wireless-ap", "upTime": "3 days, 5 hours", "uptimeSeconds": 277200, "vendor": "Cisco", "waasDeviceMode": "N/A"}, "version": "string"}` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.network_devices_info_workflow_manager_module__return-response_poe_details: .. rst-class:: ansible-option-title **response_poe_details** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
Details of the response containing Power over Ethernet (POE) statistics. .. 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": {"powerAllocated": "525", "powerConsumed": "0", "powerRemaining": "525"}, "version": "string"}` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.network_devices_info_workflow_manager_module__return-response_polling_interval: .. rst-class:: ansible-option-title **response_polling_interval** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
Details of the response containing the polling interval value. .. 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:`{"device\_polling\_interval\_info": [86400], "version": "string"}` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.network_devices_info_workflow_manager_module__return-response_stack_details: .. rst-class:: ansible-option-title **response_stack_details** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
Details of the response containing stack information for the device. .. 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": {"device\_stack\_info": [{"deviceId": "e62e6405-13e4-4f1b-ae1c-580a28a96a88", "stackPortInfo": [{"isSynchOk": "Yes", "linkActive": false, "linkOk": false, "name": "StackSub-St1-1", "neighborPort": "NONE", "nrLinkOkChanges": 0, "stackCableLengthInfo": "NO\_CABLE", "stackPortOperStatusInfo": "DOWN", "switchPort": "1/1"}, {"isSynchOk": "Yes", "linkActive": false, "linkOk": false, "name": "StackSub-St1-2", "neighborPort": "NONE", "nrLinkOkChanges": 0, "stackCableLengthInfo": "NO\_CABLE", "stackPortOperStatusInfo": "DOWN", "switchPort": "1/2"}], "stackSwitchInfo": [{"entPhysicalIndex": "1000", "hwPriority": 0, "macAddress": "0c:75:bd:42:db:80", "numNextReload": 1, "platformId": "C9300-48UXM", "role": "ACTIVE", "serialNumber": "FJC2335S09F", "softwareImage": "17.02.01", "stackMemberNumber": 1, "state": "READY", "switchPriority": 1}], "svlSwitchInfo": null}]}, "version": "string"}` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.network_devices_info_workflow_manager_module__return-response_supervisor_card_detail: .. rst-class:: ansible-option-title **response_supervisor_card_detail** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
Details of the response containing supervisor card information for the device. .. 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": [{"partno": "PN9876543210", "serialno": "SN1234567890", "slotno": "3", "switchno": "SW-01"}], "version": "string"}` .. raw:: html
.. Status (Presently only deprecated) .. Authors Authors ~~~~~~~ - Karthick S N (@karthick-s-n) - Priyadharshini B (@pbalaku2) - Madhan Sankaranarayanan (@madhansansel) .. Extra links Collection links ~~~~~~~~~~~~~~~~ .. raw:: html .. Parsing errors