.. 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.lan_automation_workflow_manager_module:
.. Anchors: short name for ansible.builtin
.. Anchors: aliases
.. Title
cisco.dnac.lan_automation_workflow_manager module -- Automate network discovery, deployment, and device configuration with LAN Automation in Cisco Catalyst Center.
+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
.. Collection note
.. note::
This module is part of the `cisco.dnac collection <https://galaxy.ansible.com/cisco/dnac>`_ (version 6.25.1).
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 <ansible_collections.cisco.dnac.lan_automation_workflow_manager_module_requirements>` for details.
To use it in a playbook, specify: :code:`cisco.dnac.lan_automation_workflow_manager`.
.. version_added
.. rst-class:: ansible-version-added
New in cisco.dnac 6.20.0
.. contents::
:local:
:depth: 1
.. Deprecated
Synopsis
--------
.. Description
- Configuring LAN Automation sessions in Cisco Catalyst Center for automated discovery of devices and their integration into the network.
- Updating LAN Automation device configurations, including loopback addresses, hostnames, and link configurations.
- Automatically stopping an ongoing LAN Automation session based on conditions like timeout or discovery device list completion, without explicitly calling the stop API.
- Additionally, it provides functionalities to stop ongoing LAN Automation sessions and to handle PnP device authorization.
.. Aliases
.. Requirements
.. _ansible_collections.cisco.dnac.lan_automation_workflow_manager_module_requirements:
Requirements
------------
The below requirements are needed on the host that executes this module.
- dnacentersdk \>= 2.9.2
- python \>= 3.9
.. Options
Parameters
----------
.. rst-class:: ansible-option-table
.. list-table::
:width: 100%
:widths: auto
:header-rows: 1
* - Parameter
- Comments
* - .. raw:: html
<div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-config"></div>
.. _ansible_collections.cisco.dnac.lan_automation_workflow_manager_module__parameter-config:
.. rst-class:: ansible-option-title
**config**
.. raw:: html
<a class="ansibleOptionLink" href="#parameter-config" title="Permalink to this option"></a>
.. rst-class:: ansible-option-type-line
:ansible-option-type:`list` / :ansible-option-elements:`elements=dictionary` / :ansible-option-required:`required`
.. raw:: html
</div>
- .. raw:: html
<div class="ansible-option-cell">
A list containing detailed configurations for creating and stopping a LAN Automation session, and also for updating loopback addresses, hostnames, and link configurations for LAN automated devices. Each element in the list represents a specific operation to be performed on the LAN automation infrastructure.
.. raw:: html
</div>
* - .. raw:: html
<div class="ansible-option-indent"></div><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-config/lan_automated_device_update"></div>
.. _ansible_collections.cisco.dnac.lan_automation_workflow_manager_module__parameter-config/lan_automated_device_update:
.. rst-class:: ansible-option-title
**lan_automated_device_update**
.. raw:: html
<a class="ansibleOptionLink" href="#parameter-config/lan_automated_device_update" title="Permalink to this option"></a>
.. rst-class:: ansible-option-type-line
:ansible-option-type:`dictionary`
.. raw:: html
</div>
- .. raw:: html
<div class="ansible-option-indent-desc"></div><div class="ansible-option-cell">
Configuration for updating device settings discovered through LAN Automation.
.. raw:: html
</div>
* - .. raw:: html
<div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-config/lan_automated_device_update/hostname_update_devices"></div>
.. _ansible_collections.cisco.dnac.lan_automation_workflow_manager_module__parameter-config/lan_automated_device_update/hostname_update_devices:
.. rst-class:: ansible-option-title
**hostname_update_devices**
.. raw:: html
<a class="ansibleOptionLink" href="#parameter-config/lan_automated_device_update/hostname_update_devices" title="Permalink to this option"></a>
.. rst-class:: ansible-option-type-line
:ansible-option-type:`list` / :ansible-option-elements:`elements=dictionary`
.. raw:: html
</div>
- .. raw:: html
<div class="ansible-option-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell">
List of devices to update with new hostnames.
.. raw:: html
</div>
* - .. raw:: html
<div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-config/lan_automated_device_update/hostname_update_devices/device_management_ip_address"></div>
.. _ansible_collections.cisco.dnac.lan_automation_workflow_manager_module__parameter-config/lan_automated_device_update/hostname_update_devices/device_management_ip_address:
.. rst-class:: ansible-option-title
**device_management_ip_address**
.. raw:: html
<a class="ansibleOptionLink" href="#parameter-config/lan_automated_device_update/hostname_update_devices/device_management_ip_address" title="Permalink to this option"></a>
.. rst-class:: ansible-option-type-line
:ansible-option-type:`string` / :ansible-option-required:`required`
.. raw:: html
</div>
- .. raw:: html
<div class="ansible-option-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell">
Management IP address of the device.
.. raw:: html
</div>
* - .. raw:: html
<div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-config/lan_automated_device_update/hostname_update_devices/new_host_name"></div>
.. _ansible_collections.cisco.dnac.lan_automation_workflow_manager_module__parameter-config/lan_automated_device_update/hostname_update_devices/new_host_name:
.. rst-class:: ansible-option-title
**new_host_name**
.. raw:: html
<a class="ansibleOptionLink" href="#parameter-config/lan_automated_device_update/hostname_update_devices/new_host_name" title="Permalink to this option"></a>
.. rst-class:: ansible-option-type-line
:ansible-option-type:`string` / :ansible-option-required:`required`
.. raw:: html
</div>
- .. raw:: html
<div class="ansible-option-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell">
New hostname for the device.
.. raw:: html
</div>
* - .. raw:: html
<div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-config/lan_automated_device_update/link_add"></div>
.. _ansible_collections.cisco.dnac.lan_automation_workflow_manager_module__parameter-config/lan_automated_device_update/link_add:
.. rst-class:: ansible-option-title
**link_add**
.. raw:: html
<a class="ansibleOptionLink" href="#parameter-config/lan_automated_device_update/link_add" title="Permalink to this option"></a>
.. rst-class:: ansible-option-type-line
:ansible-option-type:`dictionary`
.. raw:: html
</div>
- .. raw:: html
<div class="ansible-option-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell">
Add a new link between two devices.
.. raw:: html
</div>
* - .. raw:: html
<div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-config/lan_automated_device_update/link_add/destination_device_interface_name"></div>
.. _ansible_collections.cisco.dnac.lan_automation_workflow_manager_module__parameter-config/lan_automated_device_update/link_add/destination_device_interface_name:
.. rst-class:: ansible-option-title
**destination_device_interface_name**
.. raw:: html
<a class="ansibleOptionLink" href="#parameter-config/lan_automated_device_update/link_add/destination_device_interface_name" title="Permalink to this option"></a>
.. rst-class:: ansible-option-type-line
:ansible-option-type:`string` / :ansible-option-required:`required`
.. raw:: html
</div>
- .. raw:: html
<div class="ansible-option-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell">
Interface name on the destination device.
.. raw:: html
</div>
* - .. raw:: html
<div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-config/lan_automated_device_update/link_add/destination_device_management_ip_address"></div>
.. _ansible_collections.cisco.dnac.lan_automation_workflow_manager_module__parameter-config/lan_automated_device_update/link_add/destination_device_management_ip_address:
.. rst-class:: ansible-option-title
**destination_device_management_ip_address**
.. raw:: html
<a class="ansibleOptionLink" href="#parameter-config/lan_automated_device_update/link_add/destination_device_management_ip_address" title="Permalink to this option"></a>
.. rst-class:: ansible-option-type-line
:ansible-option-type:`string` / :ansible-option-required:`required`
.. raw:: html
</div>
- .. raw:: html
<div class="ansible-option-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell">
Management IP address of the destination device.
.. raw:: html
</div>
* - .. raw:: html
<div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-config/lan_automated_device_update/link_add/ip_pool_name"></div>
.. _ansible_collections.cisco.dnac.lan_automation_workflow_manager_module__parameter-config/lan_automated_device_update/link_add/ip_pool_name:
.. rst-class:: ansible-option-title
**ip_pool_name**
.. raw:: html
<a class="ansibleOptionLink" href="#parameter-config/lan_automated_device_update/link_add/ip_pool_name" title="Permalink to this option"></a>
.. rst-class:: ansible-option-type-line
:ansible-option-type:`string` / :ansible-option-required:`required`
.. raw:: html
</div>
- .. raw:: html
<div class="ansible-option-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell">
Name of the IP pool configured within LAN Automation, from which IP addresses will be allocated for the new link.
.. raw:: html
</div>
* - .. raw:: html
<div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-config/lan_automated_device_update/link_add/source_device_interface_name"></div>
.. _ansible_collections.cisco.dnac.lan_automation_workflow_manager_module__parameter-config/lan_automated_device_update/link_add/source_device_interface_name:
.. rst-class:: ansible-option-title
**source_device_interface_name**
.. raw:: html
<a class="ansibleOptionLink" href="#parameter-config/lan_automated_device_update/link_add/source_device_interface_name" title="Permalink to this option"></a>
.. rst-class:: ansible-option-type-line
:ansible-option-type:`string` / :ansible-option-required:`required`
.. raw:: html
</div>
- .. raw:: html
<div class="ansible-option-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell">
Interface name on the source device.
.. raw:: html
</div>
* - .. raw:: html
<div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-config/lan_automated_device_update/link_add/source_device_management_ip_address"></div>
.. _ansible_collections.cisco.dnac.lan_automation_workflow_manager_module__parameter-config/lan_automated_device_update/link_add/source_device_management_ip_address:
.. rst-class:: ansible-option-title
**source_device_management_ip_address**
.. raw:: html
<a class="ansibleOptionLink" href="#parameter-config/lan_automated_device_update/link_add/source_device_management_ip_address" title="Permalink to this option"></a>
.. rst-class:: ansible-option-type-line
:ansible-option-type:`string` / :ansible-option-required:`required`
.. raw:: html
</div>
- .. raw:: html
<div class="ansible-option-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell">
Management IP address of the source device.
.. raw:: html
</div>
* - .. raw:: html
<div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-config/lan_automated_device_update/link_delete"></div>
.. _ansible_collections.cisco.dnac.lan_automation_workflow_manager_module__parameter-config/lan_automated_device_update/link_delete:
.. rst-class:: ansible-option-title
**link_delete**
.. raw:: html
<a class="ansibleOptionLink" href="#parameter-config/lan_automated_device_update/link_delete" title="Permalink to this option"></a>
.. rst-class:: ansible-option-type-line
:ansible-option-type:`dictionary`
.. raw:: html
</div>
- .. raw:: html
<div class="ansible-option-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell">
Remove an existing link between two devices.
.. raw:: html
</div>
* - .. raw:: html
<div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-config/lan_automated_device_update/link_delete/destination_device_interface_name"></div>
.. _ansible_collections.cisco.dnac.lan_automation_workflow_manager_module__parameter-config/lan_automated_device_update/link_delete/destination_device_interface_name:
.. rst-class:: ansible-option-title
**destination_device_interface_name**
.. raw:: html
<a class="ansibleOptionLink" href="#parameter-config/lan_automated_device_update/link_delete/destination_device_interface_name" title="Permalink to this option"></a>
.. rst-class:: ansible-option-type-line
:ansible-option-type:`string` / :ansible-option-required:`required`
.. raw:: html
</div>
- .. raw:: html
<div class="ansible-option-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell">
Interface name on the destination device.
.. raw:: html
</div>
* - .. raw:: html
<div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-config/lan_automated_device_update/link_delete/destination_device_management_ip_address"></div>
.. _ansible_collections.cisco.dnac.lan_automation_workflow_manager_module__parameter-config/lan_automated_device_update/link_delete/destination_device_management_ip_address:
.. rst-class:: ansible-option-title
**destination_device_management_ip_address**
.. raw:: html
<a class="ansibleOptionLink" href="#parameter-config/lan_automated_device_update/link_delete/destination_device_management_ip_address" title="Permalink to this option"></a>
.. rst-class:: ansible-option-type-line
:ansible-option-type:`string` / :ansible-option-required:`required`
.. raw:: html
</div>
- .. raw:: html
<div class="ansible-option-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell">
Management IP address of the destination device.
.. raw:: html
</div>
* - .. raw:: html
<div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-config/lan_automated_device_update/link_delete/source_device_interface_name"></div>
.. _ansible_collections.cisco.dnac.lan_automation_workflow_manager_module__parameter-config/lan_automated_device_update/link_delete/source_device_interface_name:
.. rst-class:: ansible-option-title
**source_device_interface_name**
.. raw:: html
<a class="ansibleOptionLink" href="#parameter-config/lan_automated_device_update/link_delete/source_device_interface_name" title="Permalink to this option"></a>
.. rst-class:: ansible-option-type-line
:ansible-option-type:`string` / :ansible-option-required:`required`
.. raw:: html
</div>
- .. raw:: html
<div class="ansible-option-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell">
Interface name on the source device.
.. raw:: html
</div>
* - .. raw:: html
<div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-config/lan_automated_device_update/link_delete/source_device_management_ip_address"></div>
.. _ansible_collections.cisco.dnac.lan_automation_workflow_manager_module__parameter-config/lan_automated_device_update/link_delete/source_device_management_ip_address:
.. rst-class:: ansible-option-title
**source_device_management_ip_address**
.. raw:: html
<a class="ansibleOptionLink" href="#parameter-config/lan_automated_device_update/link_delete/source_device_management_ip_address" title="Permalink to this option"></a>
.. rst-class:: ansible-option-type-line
:ansible-option-type:`string` / :ansible-option-required:`required`
.. raw:: html
</div>
- .. raw:: html
<div class="ansible-option-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell">
Management IP address of the source device.
.. raw:: html
</div>
* - .. raw:: html
<div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-config/lan_automated_device_update/loopback_update_device_list"></div>
.. _ansible_collections.cisco.dnac.lan_automation_workflow_manager_module__parameter-config/lan_automated_device_update/loopback_update_device_list:
.. rst-class:: ansible-option-title
**loopback_update_device_list**
.. raw:: html
<a class="ansibleOptionLink" href="#parameter-config/lan_automated_device_update/loopback_update_device_list" title="Permalink to this option"></a>
.. rst-class:: ansible-option-type-line
:ansible-option-type:`list` / :ansible-option-elements:`elements=dictionary`
.. raw:: html
</div>
- .. raw:: html
<div class="ansible-option-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell">
List of devices to update with new loopback IP addresses.
.. raw:: html
</div>
* - .. raw:: html
<div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-config/lan_automated_device_update/loopback_update_device_list/device_management_ip_address"></div>
.. _ansible_collections.cisco.dnac.lan_automation_workflow_manager_module__parameter-config/lan_automated_device_update/loopback_update_device_list/device_management_ip_address:
.. rst-class:: ansible-option-title
**device_management_ip_address**
.. raw:: html
<a class="ansibleOptionLink" href="#parameter-config/lan_automated_device_update/loopback_update_device_list/device_management_ip_address" title="Permalink to this option"></a>
.. rst-class:: ansible-option-type-line
:ansible-option-type:`string` / :ansible-option-required:`required`
.. raw:: html
</div>
- .. raw:: html
<div class="ansible-option-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell">
Management IP address of the device.
.. raw:: html
</div>
* - .. raw:: html
<div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-config/lan_automated_device_update/loopback_update_device_list/new_loopback0_ip_address"></div>
.. _ansible_collections.cisco.dnac.lan_automation_workflow_manager_module__parameter-config/lan_automated_device_update/loopback_update_device_list/new_loopback0_ip_address:
.. rst-class:: ansible-option-title
**new_loopback0_ip_address**
.. raw:: html
<a class="ansibleOptionLink" href="#parameter-config/lan_automated_device_update/loopback_update_device_list/new_loopback0_ip_address" title="Permalink to this option"></a>
.. rst-class:: ansible-option-type-line
:ansible-option-type:`string` / :ansible-option-required:`required`
.. raw:: html
</div>
- .. raw:: html
<div class="ansible-option-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell">
New Loopback0 IP Address for the device, sourced from the LAN pool associated with the device discovery site.
.. raw:: html
</div>
* - .. raw:: html
<div class="ansible-option-indent"></div><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-config/lan_automation"></div>
.. _ansible_collections.cisco.dnac.lan_automation_workflow_manager_module__parameter-config/lan_automation:
.. rst-class:: ansible-option-title
**lan_automation**
.. raw:: html
<a class="ansibleOptionLink" href="#parameter-config/lan_automation" title="Permalink to this option"></a>
.. rst-class:: ansible-option-type-line
:ansible-option-type:`dictionary`
.. raw:: html
</div>
- .. raw:: html
<div class="ansible-option-indent-desc"></div><div class="ansible-option-cell">
Configuration for starting or stopping LAN Automation sessions.
.. raw:: html
</div>
* - .. raw:: html
<div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-config/lan_automation/device_serial_number_authorization"></div>
.. _ansible_collections.cisco.dnac.lan_automation_workflow_manager_module__parameter-config/lan_automation/device_serial_number_authorization:
.. rst-class:: ansible-option-title
**device_serial_number_authorization**
.. raw:: html
<a class="ansibleOptionLink" href="#parameter-config/lan_automation/device_serial_number_authorization" title="Permalink to this option"></a>
.. rst-class:: ansible-option-type-line
:ansible-option-type:`list` / :ansible-option-elements:`elements=string`
.. raw:: html
</div>
- .. raw:: html
<div class="ansible-option-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell">
A list of serial numbers of devices to be authorized during the session.
.. raw:: html
</div>
* - .. raw:: html
<div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-config/lan_automation/discovered_device_site_name_hierarchy"></div>
.. _ansible_collections.cisco.dnac.lan_automation_workflow_manager_module__parameter-config/lan_automation/discovered_device_site_name_hierarchy:
.. rst-class:: ansible-option-title
**discovered_device_site_name_hierarchy**
.. raw:: html
<a class="ansibleOptionLink" href="#parameter-config/lan_automation/discovered_device_site_name_hierarchy" title="Permalink to this option"></a>
.. rst-class:: ansible-option-type-line
:ansible-option-type:`string` / :ansible-option-required:`required`
.. raw:: html
</div>
- .. raw:: html
<div class="ansible-option-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell">
Site hierarchy where the discovered devices will be placed.
.. raw:: html
</div>
* - .. raw:: html
<div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-config/lan_automation/discovery_devices"></div>
.. _ansible_collections.cisco.dnac.lan_automation_workflow_manager_module__parameter-config/lan_automation/discovery_devices:
.. rst-class:: ansible-option-title
**discovery_devices**
.. raw:: html
<a class="ansibleOptionLink" href="#parameter-config/lan_automation/discovery_devices" title="Permalink to this option"></a>
.. rst-class:: ansible-option-type-line
:ansible-option-type:`list` / :ansible-option-elements:`elements=dictionary`
.. raw:: html
</div>
- .. raw:: html
<div class="ansible-option-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell">
A list of devices to be discovered during the LAN Automation session. If only a device list is provided without a timeout, stop processing will occur once all devices from the list are discovered. The maximum number of devices that can be provided for a session is 50. If both the discovery devices list and timeout are provided, the stop processing will be attempted whichever happens earlier. Users may choose to use the LAN Automation 'deleted' state to stop processing at any time.
.. raw:: html
</div>
* - .. raw:: html
<div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-config/lan_automation/discovery_devices/device_host_name"></div>
.. _ansible_collections.cisco.dnac.lan_automation_workflow_manager_module__parameter-config/lan_automation/discovery_devices/device_host_name:
.. rst-class:: ansible-option-title
**device_host_name**
.. raw:: html
<a class="ansibleOptionLink" href="#parameter-config/lan_automation/discovery_devices/device_host_name" title="Permalink to this option"></a>
.. rst-class:: ansible-option-type-line
:ansible-option-type:`string`
.. raw:: html
</div>
- .. raw:: html
<div class="ansible-option-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell">
Hostname of the device to be discovered.
.. raw:: html
</div>
* - .. raw:: html
<div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-config/lan_automation/discovery_devices/device_management_ip_address"></div>
.. _ansible_collections.cisco.dnac.lan_automation_workflow_manager_module__parameter-config/lan_automation/discovery_devices/device_management_ip_address:
.. rst-class:: ansible-option-title
**device_management_ip_address**
.. raw:: html
<a class="ansibleOptionLink" href="#parameter-config/lan_automation/discovery_devices/device_management_ip_address" title="Permalink to this option"></a>
.. rst-class:: ansible-option-type-line
:ansible-option-type:`string`
.. raw:: html
</div>
- .. raw:: html
<div class="ansible-option-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell">
Management IP address of the device.
.. raw:: html
</div>
* - .. raw:: html
<div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-config/lan_automation/discovery_devices/device_serial_number"></div>
.. _ansible_collections.cisco.dnac.lan_automation_workflow_manager_module__parameter-config/lan_automation/discovery_devices/device_serial_number:
.. rst-class:: ansible-option-title
**device_serial_number**
.. raw:: html
<a class="ansibleOptionLink" href="#parameter-config/lan_automation/discovery_devices/device_serial_number" title="Permalink to this option"></a>
.. rst-class:: ansible-option-type-line
:ansible-option-type:`string` / :ansible-option-required:`required`
.. raw:: html
</div>
- .. raw:: html
<div class="ansible-option-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell">
Serial number of the device to be discovered.
.. raw:: html
</div>
* - .. raw:: html
<div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-config/lan_automation/discovery_devices/device_site_name_hierarchy"></div>
.. _ansible_collections.cisco.dnac.lan_automation_workflow_manager_module__parameter-config/lan_automation/discovery_devices/device_site_name_hierarchy:
.. rst-class:: ansible-option-title
**device_site_name_hierarchy**
.. raw:: html
<a class="ansibleOptionLink" href="#parameter-config/lan_automation/discovery_devices/device_site_name_hierarchy" title="Permalink to this option"></a>
.. rst-class:: ansible-option-type-line
:ansible-option-type:`string`
.. raw:: html
</div>
- .. raw:: html
<div class="ansible-option-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell">
Site hierarchy where the device will be placed after discovery.
.. raw:: html
</div>
* - .. raw:: html
<div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-config/lan_automation/discovery_level"></div>
.. _ansible_collections.cisco.dnac.lan_automation_workflow_manager_module__parameter-config/lan_automation/discovery_level:
.. rst-class:: ansible-option-title
**discovery_level**
.. raw:: html
<a class="ansibleOptionLink" href="#parameter-config/lan_automation/discovery_level" title="Permalink to this option"></a>
.. rst-class:: ansible-option-type-line
:ansible-option-type:`integer`
.. raw:: html
</div>
- .. raw:: html
<div class="ansible-option-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell">
Depth of the discovery during LAN automation (e.g., Level 1-5 below the primary seed device).
.. rst-class:: ansible-option-line
:ansible-option-default-bold:`Default:` :ansible-option-default:`2`
.. raw:: html
</div>
* - .. raw:: html
<div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-config/lan_automation/discovery_timeout"></div>
.. _ansible_collections.cisco.dnac.lan_automation_workflow_manager_module__parameter-config/lan_automation/discovery_timeout:
.. rst-class:: ansible-option-title
**discovery_timeout**
.. raw:: html
<a class="ansibleOptionLink" href="#parameter-config/lan_automation/discovery_timeout" title="Permalink to this option"></a>
.. rst-class:: ansible-option-type-line
:ansible-option-type:`integer`
.. raw:: html
</div>
- .. raw:: html
<div class="ansible-option-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell">
Timeout for device discovery during LAN Automation, in minutes. Until this time, stop processing will not be triggered. Any device contacting after the provided discovery timeout will not be processed, and a device reset and reload will be attempted to bring it back to the PnP agent state before process completion. The supported timeout range is in minutes [20-10080]. If both 'discovery\_timeout' and 'discovery\_devices' are provided, processing will stop based on whichever occurs earlier. Users can always use the LAN Automation deleted state to force stop processing.
.. raw:: html
</div>
* - .. raw:: html
<div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-config/lan_automation/host_name_prefix"></div>
.. _ansible_collections.cisco.dnac.lan_automation_workflow_manager_module__parameter-config/lan_automation/host_name_prefix:
.. rst-class:: ansible-option-title
**host_name_prefix**
.. raw:: html
<a class="ansibleOptionLink" href="#parameter-config/lan_automation/host_name_prefix" title="Permalink to this option"></a>
.. rst-class:: ansible-option-type-line
:ansible-option-type:`string`
.. raw:: html
</div>
- .. raw:: html
<div class="ansible-option-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell">
Prefix used for auto-generating hostnames during the LAN Automation session.
.. raw:: html
</div>
* - .. raw:: html
<div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-config/lan_automation/ip_pools"></div>
.. _ansible_collections.cisco.dnac.lan_automation_workflow_manager_module__parameter-config/lan_automation/ip_pools:
.. rst-class:: ansible-option-title
**ip_pools**
.. raw:: html
<a class="ansibleOptionLink" href="#parameter-config/lan_automation/ip_pools" title="Permalink to this option"></a>
.. rst-class:: ansible-option-type-line
:ansible-option-type:`list` / :ansible-option-elements:`elements=dictionary` / :ansible-option-required:`required`
.. raw:: html
</div>
- .. raw:: html
<div class="ansible-option-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell">
A list of IP pools used during the LAN Automation session.
.. raw:: html
</div>
* - .. raw:: html
<div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-config/lan_automation/ip_pools/ip_pool_name"></div>
.. _ansible_collections.cisco.dnac.lan_automation_workflow_manager_module__parameter-config/lan_automation/ip_pools/ip_pool_name:
.. rst-class:: ansible-option-title
**ip_pool_name**
.. raw:: html
<a class="ansibleOptionLink" href="#parameter-config/lan_automation/ip_pools/ip_pool_name" title="Permalink to this option"></a>
.. rst-class:: ansible-option-type-line
:ansible-option-type:`string` / :ansible-option-required:`required`
.. raw:: html
</div>
- .. raw:: html
<div class="ansible-option-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell">
Name of the IP pool.
.. raw:: html
</div>
* - .. raw:: html
<div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-config/lan_automation/ip_pools/ip_pool_role"></div>
.. _ansible_collections.cisco.dnac.lan_automation_workflow_manager_module__parameter-config/lan_automation/ip_pools/ip_pool_role:
.. rst-class:: ansible-option-title
**ip_pool_role**
.. raw:: html
<a class="ansibleOptionLink" href="#parameter-config/lan_automation/ip_pools/ip_pool_role" title="Permalink to this option"></a>
.. rst-class:: ansible-option-type-line
:ansible-option-type:`string` / :ansible-option-required:`required`
.. raw:: html
</div>
- .. raw:: html
<div class="ansible-option-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell">
Role of the IP pool in the automation session, either MAIN\_POOL or PHYSICAL\_LINK\_POOL.
.. rst-class:: ansible-option-line
:ansible-option-choices:`Choices:`
- :ansible-option-choices-entry:`"MAIN\_POOL"`
- :ansible-option-choices-entry:`"PHYSICAL\_LINK\_POOL"`
.. raw:: html
</div>
* - .. raw:: html
<div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-config/lan_automation/isis_domain_pwd"></div>
.. _ansible_collections.cisco.dnac.lan_automation_workflow_manager_module__parameter-config/lan_automation/isis_domain_pwd:
.. rst-class:: ansible-option-title
**isis_domain_pwd**
.. raw:: html
<a class="ansibleOptionLink" href="#parameter-config/lan_automation/isis_domain_pwd" title="Permalink to this option"></a>
.. rst-class:: ansible-option-type-line
:ansible-option-type:`string`
.. raw:: html
</div>
- .. raw:: html
<div class="ansible-option-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell">
Password for IS-IS domain configuration.
.. raw:: html
</div>
* - .. raw:: html
<div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-config/lan_automation/launch_and_wait"></div>
.. _ansible_collections.cisco.dnac.lan_automation_workflow_manager_module__parameter-config/lan_automation/launch_and_wait:
.. rst-class:: ansible-option-title
**launch_and_wait**
.. raw:: html
<a class="ansibleOptionLink" href="#parameter-config/lan_automation/launch_and_wait" title="Permalink to this option"></a>
.. rst-class:: ansible-option-type-line
:ansible-option-type:`boolean`
.. raw:: html
</div>
- .. raw:: html
<div class="ansible-option-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell">
Flag indicating whether the task should pause until the LAN Automation session completes before continuing to subsequent tasks. If set to false, the process will move to the next task immediately.
.. 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
</div>
* - .. raw:: html
<div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-config/lan_automation/multicast_enabled"></div>
.. _ansible_collections.cisco.dnac.lan_automation_workflow_manager_module__parameter-config/lan_automation/multicast_enabled:
.. rst-class:: ansible-option-title
**multicast_enabled**
.. raw:: html
<a class="ansibleOptionLink" href="#parameter-config/lan_automation/multicast_enabled" title="Permalink to this option"></a>
.. rst-class:: ansible-option-type-line
:ansible-option-type:`boolean`
.. raw:: html
</div>
- .. raw:: html
<div class="ansible-option-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell">
Flag to enable multicast routing in the LAN Automation session.
.. 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
</div>
* - .. raw:: html
<div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-config/lan_automation/peer_device_management_ip_address"></div>
.. _ansible_collections.cisco.dnac.lan_automation_workflow_manager_module__parameter-config/lan_automation/peer_device_management_ip_address:
.. rst-class:: ansible-option-title
**peer_device_management_ip_address**
.. raw:: html
<a class="ansibleOptionLink" href="#parameter-config/lan_automation/peer_device_management_ip_address" title="Permalink to this option"></a>
.. rst-class:: ansible-option-type-line
:ansible-option-type:`string`
.. raw:: html
</div>
- .. raw:: html
<div class="ansible-option-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell">
Management IP address of the peer device in the LAN Automation session.
.. raw:: html
</div>
* - .. raw:: html
<div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-config/lan_automation/pnp_authorization"></div>
.. _ansible_collections.cisco.dnac.lan_automation_workflow_manager_module__parameter-config/lan_automation/pnp_authorization:
.. rst-class:: ansible-option-title
**pnp_authorization**
.. raw:: html
<a class="ansibleOptionLink" href="#parameter-config/lan_automation/pnp_authorization" title="Permalink to this option"></a>
.. rst-class:: ansible-option-type-line
:ansible-option-type:`boolean`
.. raw:: html
</div>
- .. raw:: html
<div class="ansible-option-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell">
Flag to enable Plug and Play (PnP) authorization for devices discovered during the session.
.. 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
</div>
* - .. raw:: html
<div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-config/lan_automation/primary_device_interface_names"></div>
.. _ansible_collections.cisco.dnac.lan_automation_workflow_manager_module__parameter-config/lan_automation/primary_device_interface_names:
.. rst-class:: ansible-option-title
**primary_device_interface_names**
.. raw:: html
<a class="ansibleOptionLink" href="#parameter-config/lan_automation/primary_device_interface_names" title="Permalink to this option"></a>
.. rst-class:: ansible-option-type-line
:ansible-option-type:`list` / :ansible-option-elements:`elements=string` / :ansible-option-required:`required`
.. raw:: html
</div>
- .. raw:: html
<div class="ansible-option-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell">
A list of interface names on the primary device to be used for LAN automation.
.. raw:: html
</div>
* - .. raw:: html
<div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-config/lan_automation/primary_device_management_ip_address"></div>
.. _ansible_collections.cisco.dnac.lan_automation_workflow_manager_module__parameter-config/lan_automation/primary_device_management_ip_address:
.. rst-class:: ansible-option-title
**primary_device_management_ip_address**
.. raw:: html
<a class="ansibleOptionLink" href="#parameter-config/lan_automation/primary_device_management_ip_address" title="Permalink to this option"></a>
.. rst-class:: ansible-option-type-line
:ansible-option-type:`string` / :ansible-option-required:`required`
.. raw:: html
</div>
- .. raw:: html
<div class="ansible-option-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell">
Management IP address of the primary or seed device in the LAN Automation session.
.. raw:: html
</div>
* - .. raw:: html
<div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-config/lan_automation/redistribute_isis_to_bgp"></div>
.. _ansible_collections.cisco.dnac.lan_automation_workflow_manager_module__parameter-config/lan_automation/redistribute_isis_to_bgp:
.. rst-class:: ansible-option-title
**redistribute_isis_to_bgp**
.. raw:: html
<a class="ansibleOptionLink" href="#parameter-config/lan_automation/redistribute_isis_to_bgp" title="Permalink to this option"></a>
.. rst-class:: ansible-option-type-line
:ansible-option-type:`boolean`
.. raw:: html
</div>
- .. raw:: html
<div class="ansible-option-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell">
Flag to enable the redistribution of IS-IS routes to BGP.
.. 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
</div>
* - .. raw:: html
<div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-config_verify"></div>
.. _ansible_collections.cisco.dnac.lan_automation_workflow_manager_module__parameter-config_verify:
.. rst-class:: ansible-option-title
**config_verify**
.. raw:: html
<a class="ansibleOptionLink" href="#parameter-config_verify" title="Permalink to this option"></a>
.. rst-class:: ansible-option-type-line
:ansible-option-type:`boolean`
.. raw:: html
</div>
- .. raw:: html
<div class="ansible-option-cell">
Set to true to verify the LAN Automation 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
</div>
* - .. raw:: html
<div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-dnac_api_task_timeout"></div>
.. _ansible_collections.cisco.dnac.lan_automation_workflow_manager_module__parameter-dnac_api_task_timeout:
.. rst-class:: ansible-option-title
**dnac_api_task_timeout**
.. raw:: html
<a class="ansibleOptionLink" href="#parameter-dnac_api_task_timeout" title="Permalink to this option"></a>
.. rst-class:: ansible-option-type-line
:ansible-option-type:`integer`
.. raw:: html
</div>
- .. raw:: html
<div class="ansible-option-cell">
The maximum time to wait for a task to complete on Cisco DNA Center for LAN Automation.
.. rst-class:: ansible-option-line
:ansible-option-default-bold:`Default:` :ansible-option-default:`604800`
.. raw:: html
</div>
* - .. raw:: html
<div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-dnac_debug"></div>
.. _ansible_collections.cisco.dnac.lan_automation_workflow_manager_module__parameter-dnac_debug:
.. rst-class:: ansible-option-title
**dnac_debug**
.. raw:: html
<a class="ansibleOptionLink" href="#parameter-dnac_debug" title="Permalink to this option"></a>
.. rst-class:: ansible-option-type-line
:ansible-option-type:`boolean`
.. raw:: html
</div>
- .. raw:: html
<div class="ansible-option-cell">
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
</div>
* - .. raw:: html
<div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-dnac_host"></div>
.. _ansible_collections.cisco.dnac.lan_automation_workflow_manager_module__parameter-dnac_host:
.. rst-class:: ansible-option-title
**dnac_host**
.. raw:: html
<a class="ansibleOptionLink" href="#parameter-dnac_host" title="Permalink to this option"></a>
.. rst-class:: ansible-option-type-line
:ansible-option-type:`string` / :ansible-option-required:`required`
.. raw:: html
</div>
- .. raw:: html
<div class="ansible-option-cell">
The hostname of the Cisco Catalyst Center.
.. raw:: html
</div>
* - .. raw:: html
<div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-dnac_log"></div>
.. _ansible_collections.cisco.dnac.lan_automation_workflow_manager_module__parameter-dnac_log:
.. rst-class:: ansible-option-title
**dnac_log**
.. raw:: html
<a class="ansibleOptionLink" href="#parameter-dnac_log" title="Permalink to this option"></a>
.. rst-class:: ansible-option-type-line
:ansible-option-type:`boolean`
.. raw:: html
</div>
- .. raw:: html
<div class="ansible-option-cell">
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
</div>
* - .. raw:: html
<div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-dnac_log_append"></div>
.. _ansible_collections.cisco.dnac.lan_automation_workflow_manager_module__parameter-dnac_log_append:
.. rst-class:: ansible-option-title
**dnac_log_append**
.. raw:: html
<a class="ansibleOptionLink" href="#parameter-dnac_log_append" title="Permalink to this option"></a>
.. rst-class:: ansible-option-type-line
:ansible-option-type:`boolean`
.. raw:: html
</div>
- .. raw:: html
<div class="ansible-option-cell">
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
</div>
* - .. raw:: html
<div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-dnac_log_file_path"></div>
.. _ansible_collections.cisco.dnac.lan_automation_workflow_manager_module__parameter-dnac_log_file_path:
.. rst-class:: ansible-option-title
**dnac_log_file_path**
.. raw:: html
<a class="ansibleOptionLink" href="#parameter-dnac_log_file_path" title="Permalink to this option"></a>
.. rst-class:: ansible-option-type-line
:ansible-option-type:`string`
.. raw:: html
</div>
- .. raw:: html
<div class="ansible-option-cell">
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
</div>
* - .. raw:: html
<div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-dnac_log_level"></div>
.. _ansible_collections.cisco.dnac.lan_automation_workflow_manager_module__parameter-dnac_log_level:
.. rst-class:: ansible-option-title
**dnac_log_level**
.. raw:: html
<a class="ansibleOptionLink" href="#parameter-dnac_log_level" title="Permalink to this option"></a>
.. rst-class:: ansible-option-type-line
:ansible-option-type:`string`
.. raw:: html
</div>
- .. raw:: html
<div class="ansible-option-cell">
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
</div>
* - .. raw:: html
<div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-dnac_password"></div>
.. _ansible_collections.cisco.dnac.lan_automation_workflow_manager_module__parameter-dnac_password:
.. rst-class:: ansible-option-title
**dnac_password**
.. raw:: html
<a class="ansibleOptionLink" href="#parameter-dnac_password" title="Permalink to this option"></a>
.. rst-class:: ansible-option-type-line
:ansible-option-type:`string`
.. raw:: html
</div>
- .. raw:: html
<div class="ansible-option-cell">
The password for authentication at the Cisco Catalyst Center.
.. raw:: html
</div>
* - .. raw:: html
<div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-dnac_port"></div>
.. _ansible_collections.cisco.dnac.lan_automation_workflow_manager_module__parameter-dnac_port:
.. rst-class:: ansible-option-title
**dnac_port**
.. raw:: html
<a class="ansibleOptionLink" href="#parameter-dnac_port" title="Permalink to this option"></a>
.. rst-class:: ansible-option-type-line
:ansible-option-type:`string`
.. raw:: html
</div>
- .. raw:: html
<div class="ansible-option-cell">
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
</div>
* - .. raw:: html
<div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-dnac_task_poll_interval"></div>
.. _ansible_collections.cisco.dnac.lan_automation_workflow_manager_module__parameter-dnac_task_poll_interval:
.. rst-class:: ansible-option-title
**dnac_task_poll_interval**
.. raw:: html
<a class="ansibleOptionLink" href="#parameter-dnac_task_poll_interval" title="Permalink to this option"></a>
.. rst-class:: ansible-option-type-line
:ansible-option-type:`integer`
.. raw:: html
</div>
- .. raw:: html
<div class="ansible-option-cell">
The interval, in seconds, to poll for task completion.
.. rst-class:: ansible-option-line
:ansible-option-default-bold:`Default:` :ansible-option-default:`30`
.. raw:: html
</div>
* - .. raw:: html
<div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-dnac_username"></div>
<div class="ansibleOptionAnchor" id="parameter-user"></div>
.. _ansible_collections.cisco.dnac.lan_automation_workflow_manager_module__parameter-dnac_username:
.. _ansible_collections.cisco.dnac.lan_automation_workflow_manager_module__parameter-user:
.. rst-class:: ansible-option-title
**dnac_username**
.. raw:: html
<a class="ansibleOptionLink" href="#parameter-dnac_username" title="Permalink to this option"></a>
.. rst-class:: ansible-option-type-line
:ansible-option-aliases:`aliases: user`
.. rst-class:: ansible-option-type-line
:ansible-option-type:`string`
.. raw:: html
</div>
- .. raw:: html
<div class="ansible-option-cell">
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
</div>
* - .. raw:: html
<div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-dnac_verify"></div>
.. _ansible_collections.cisco.dnac.lan_automation_workflow_manager_module__parameter-dnac_verify:
.. rst-class:: ansible-option-title
**dnac_verify**
.. raw:: html
<a class="ansibleOptionLink" href="#parameter-dnac_verify" title="Permalink to this option"></a>
.. rst-class:: ansible-option-type-line
:ansible-option-type:`boolean`
.. raw:: html
</div>
- .. raw:: html
<div class="ansible-option-cell">
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
</div>
* - .. raw:: html
<div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-dnac_version"></div>
.. _ansible_collections.cisco.dnac.lan_automation_workflow_manager_module__parameter-dnac_version:
.. rst-class:: ansible-option-title
**dnac_version**
.. raw:: html
<a class="ansibleOptionLink" href="#parameter-dnac_version" title="Permalink to this option"></a>
.. rst-class:: ansible-option-type-line
:ansible-option-type:`string`
.. raw:: html
</div>
- .. raw:: html
<div class="ansible-option-cell">
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
</div>
* - .. raw:: html
<div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-state"></div>
.. _ansible_collections.cisco.dnac.lan_automation_workflow_manager_module__parameter-state:
.. rst-class:: ansible-option-title
**state**
.. raw:: html
<a class="ansibleOptionLink" href="#parameter-state" title="Permalink to this option"></a>
.. rst-class:: ansible-option-type-line
:ansible-option-type:`string`
.. raw:: html
</div>
- .. raw:: html
<div class="ansible-option-cell">
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
</div>
* - .. raw:: html
<div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-validate_response_schema"></div>
.. _ansible_collections.cisco.dnac.lan_automation_workflow_manager_module__parameter-validate_response_schema:
.. rst-class:: ansible-option-title
**validate_response_schema**
.. raw:: html
<a class="ansibleOptionLink" href="#parameter-validate_response_schema" title="Permalink to this option"></a>
.. rst-class:: ansible-option-type-line
:ansible-option-type:`boolean`
.. raw:: html
</div>
- .. raw:: html
<div class="ansible-option-cell">
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
</div>
.. Attributes
.. Notes
Notes
-----
.. note::
- When waiting for the LAN automation session to complete, the timeout and the list of devices to be discovered will initially be considered. If neither a timeout nor a device list is provided, LAN automation will continue running until stopped.
- To stop a LAN automation session, execute the same details in the 'deleted' state. Only the seed device IP is required to terminate the session.
- PnP authorization will be performed if device authorization has been selected in Catalyst Center. LAN automation will continue running until the provided serial numbers are authorized, continuously checking the status of the devices. If PnP authorization is enabled without a list of devices for either authorization or discovery, the module will not wait for the LAN automation task to complete. However, if a device is in an Error state or authorization is not checked on Catalyst Center, the playbook will keep running until the state of the device is active or reached the timeout value.
- SDK Method used are ccc\_lan\_automation.lanautomation.lan\_automation\_start\_v2 ccc\_lan\_automation.lanautomation.lan\_automation\_stop ccc\_lan\_automation.lanautomation.lan\_automation\_device\_update ccc\_lan\_automation.lanautomation.lan\_automation\_active\_sessions ccc\_lan\_automation.lanautomation.lan\_automation\_status ccc\_lan\_automation.lanautomation.lan\_automation\_log ccc\_lan\_automation.devices.get\_device\_list ccc\_lan\_automation.devices.get\_interface\_details ccc\_lan\_automation.deviceonboardingpnp.authorize\_device ccc\_lan\_automation.deviceonboardingpnp.get\_device\_list
- Does not support \ :literal:`check\_mode`\
- The plugin runs on the control node and does not use any ansible connection plugins instead embedded connection manager from Cisco Catalyst Center SDK
- The parameters starting with dnac\_ are used by the Cisco Catalyst Center Python SDK to establish the connection
.. Seealso
.. Examples
Examples
--------
.. code-block:: yaml+jinja
- name: Start a LAN Automation session without waiting for it to finish
cisco.dnac.lan_automation_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
config_verify: false
state: merged
config:
- lan_automation:
discovered_device_site_name_hierarchy: "Global/USA/SAN JOSE"
peer_device_management_ip_address: "204.1.1.2"
primary_device_management_ip_address: "204.1.1.1"
primary_device_interface_names:
- "HundredGigE1/0/2"
- "HundredGigE1/0/29"
ip_pools:
- ip_pool_name: "underlay_sub"
ip_pool_role: "MAIN_POOL"
- ip_pool_name: "underlay_sub_sj"
ip_pool_role: "PHYSICAL_LINK_POOL"
multicast_enabled: true
redistribute_isis_to_bgp: true
host_name_prefix: "San-Jose"
isis_domain_pwd: "cisco"
discovery_level: 5
discovery_timeout: 40
discovery_devices:
- device_serial_number: "FJC27172JDW"
device_host_name: "SR-LAN-9300-IM1"
device_site_name_hierarchy: "Global/USA/SAN JOSE/BLD23"
device_management_ip_address: "204.1.1.10"
- device_serial_number: "FJC2721261A"
device_host_name: "SR-LAN-9300-IM2"
device_site_name_hierarchy: "Global/USA/SAN JOSE/BLD20"
device_management_ip_address: "204.1.1.11"
launch_and_wait: false
pnp_authorization: false
- name: Start a LAN Automation session with device authorization and waiting for the task to complete
cisco.dnac.lan_automation_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
config_verify: false
state: merged
config:
- lan_automation:
discovered_device_site_name_hierarchy: "Global/USA/SAN JOSE"
peer_device_management_ip_address: "204.1.1.2"
primary_device_management_ip_address: "204.1.1.1"
primary_device_interface_names:
- "HundredGigE1/0/2"
- "HundredGigE1/0/29"
ip_pools:
- ip_pool_name: "underlay_sub"
ip_pool_role: "MAIN_POOL"
- ip_pool_name: "underlay_sub_sj"
ip_pool_role: "PHYSICAL_LINK_POOL"
multicast_enabled: true
redistribute_isis_to_bgp: true
host_name_prefix: "San-Jose"
isis_domain_pwd: "cisco"
discovery_level: 5
discovery_timeout: 40
discovery_devices:
- device_serial_number: "FJC27172JDW"
device_host_name: "SR-LAN-9300-IM1"
device_site_name_hierarchy: "Global/USA/SAN JOSE/BLD23"
device_management_ip_address: "204.1.1.10"
- device_serial_number: "FJC2721261A"
device_host_name: "SR-LAN-9300-IM2"
device_site_name_hierarchy: "Global/USA/SAN JOSE/BLD20"
device_management_ip_address: "204.1.1.11"
launch_and_wait: true
pnp_authorization: true
device_serial_number_authorization:
- "FJC27172JDW"
- "FJC2721261A"
- name: Stop a LAN Automation session
cisco.dnac.lan_automation_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
config_verify: false
state: deleted
config:
- lan_automation:
discovered_device_site_name_hierarchy: "Global/USA/SAN JOSE"
primary_device_management_ip_address: "204.1.1.1"
- name: Update loopback for LAN Automated devices
cisco.dnac.lan_automation_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
config_verify: false
state: merged
config:
- lan_automated_device_update:
loopback_update_device_list:
- device_management_ip_address: "204.1.3.160"
new_loopback0_ip_address: "91.1.2.6"
- device_management_ip_address: "204.1.2.163"
new_loopback0_ip_address: "91.1.2.5"
- name: Update hostname for LAN Automated devices
cisco.dnac.lan_automation_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
config_verify: false
state: merged
config:
- lan_automated_device_update:
hostname_update_devices:
- device_management_ip_address: "204.1.1.1"
new_host_name: "SR-LAN-9300-im1"
- device_management_ip_address: "91.1.1.6"
new_host_name: "Test"
- name: Add link for LAN Automated devices
cisco.dnac.lan_automation_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
config_verify: false
state: merged
config:
- lan_automated_device_update:
link_add:
source_device_management_ip_address: "204.1.1.1"
source_device_interface_name: "HundredGigE1/0/2"
destination_device_management_ip_address: "204.1.1.4"
destination_device_interface_name: "HundredGigE1/0/5"
ip_pool_name: "underlay_sj"
- name: Delete link between LAN Automated devices
cisco.dnac.lan_automation_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
config_verify: false
state: merged
config:
- lan_automated_device_update:
link_delete:
source_device_management_ip_address: "204.1.1.1"
source_device_interface_name: "HundredGigE1/0/2"
destination_device_management_ip_address: "204.1.1.4"
destination_device_interface_name: "HundredGigE1/0/5"
- name: Apply loopback and hostname updates for LAN Automated devices
cisco.dnac.lan_automation_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
config_verify: false
state: merged
config:
- lan_automated_device_update:
loopback_update_device_list:
- device_management_ip_address: "204.1.1.160"
new_loopback0_ip_address: "10.4.18.101"
hostname_update_devices:
- device_management_ip_address: "91.1.3.2"
new_host_name: "SR-LAN-9300-SJ"
- device_management_ip_address: "204.1.1.5"
new_host_name: "SR-LAN-9500-SJ"
.. Facts
.. Return values
Return Values
-------------
Common return values are documented :ref:`here <common_return_values>`, 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
<div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="return-dnac_response"></div>
.. _ansible_collections.cisco.dnac.lan_automation_workflow_manager_module__return-dnac_response:
.. rst-class:: ansible-option-title
**dnac_response**
.. raw:: html
<a class="ansibleOptionLink" href="#return-dnac_response" title="Permalink to this return value"></a>
.. rst-class:: ansible-option-type-line
:ansible-option-type:`dictionary`
.. raw:: html
</div>
- .. raw:: html
<div class="ansible-option-cell">
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
</div>
.. Status (Presently only deprecated)
.. Authors
Authors
~~~~~~~
- Luna Aliaj (@majlona)
- Madhan Sankaranarayanan (@madhansansel)
.. Extra links
Collection links
~~~~~~~~~~~~~~~~
.. raw:: html
<p class="ansible-links">
<a href="https://github.com/cisco-en-programmability/dnacenter-ansible/issues" aria-role="button" target="_blank" rel="noopener external">Issue Tracker</a>
<a href="https://github.com/cisco-en-programmability/dnacenter-ansible" aria-role="button" target="_blank" rel="noopener external">Repository (Sources)</a>
</p>
.. Parsing errors