.. 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.catalystcenter.wired_campus_automation_playbook_config_generator_module:

.. Anchors: short name for ansible.builtin

.. Anchors: aliases



.. Title

cisco.catalystcenter.wired_campus_automation_playbook_config_generator module -- Generate YAML configurations playbook for 'wired\_campus\_automation\_workflow\_manager' module.
+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++

.. Collection note

.. note::
    This module is part of the `cisco.catalystcenter collection <https://galaxy.ansible.com/cisco/catalystcenter>`_ (version 2.10.0).

    To install it, use: :code:`ansible-galaxy collection install cisco.catalystcenter`.
    You need further requirements to be able to use this module,
    see :ref:`Requirements <ansible_collections.cisco.catalystcenter.wired_campus_automation_playbook_config_generator_module_requirements>` for details.

    To use it in a playbook, specify: :code:`cisco.catalystcenter.wired_campus_automation_playbook_config_generator`.

.. version_added

.. rst-class:: ansible-version-added

New in cisco.catalystcenter 6.40.0

.. contents::
   :local:
   :depth: 1

.. Deprecated


Synopsis
--------

.. Description

- Generates YAML configurations compatible with the 'wired\_campus\_automation\_workflow\_manager' module, reducing the effort required to manually create Ansible playbooks and enabling programmatic modifications.
- The YAML configurations generated represent the layer 2 configurations deployed on network devices within the Cisco Catalyst Center.
- Supports extraction of VLANs, CDP, LLDP, STP, VTP, DHCP Snooping, IGMP Snooping, MLD Snooping, Authentication, Logical Ports, and Port Configuration settings.


.. Aliases


.. Requirements

.. _ansible_collections.cisco.catalystcenter.wired_campus_automation_playbook_config_generator_module_requirements:

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

- catalystcentersdk \>= 3.1.6.0.2
- python \>= 3.12






.. 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-catalystcenter_api_task_timeout"></div>
        <div class="ansibleOptionAnchor" id="parameter-dnac_api_task_timeout"></div>

      .. _ansible_collections.cisco.catalystcenter.wired_campus_automation_playbook_config_generator_module__parameter-catalystcenter_api_task_timeout:
      .. _ansible_collections.cisco.catalystcenter.wired_campus_automation_playbook_config_generator_module__parameter-dnac_api_task_timeout:

      .. rst-class:: ansible-option-title

      **catalystcenter_api_task_timeout**

      .. raw:: html

        <a class="ansibleOptionLink" href="#parameter-catalystcenter_api_task_timeout" title="Permalink to this option"></a>

      .. rst-class:: ansible-option-type-line

      :ansible-option-aliases:`aliases: dnac_api_task_timeout`

      .. rst-class:: ansible-option-type-line

      :ansible-option-type:`integer`

      .. raw:: html

        </div>

    - .. raw:: html

        <div class="ansible-option-cell">

      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

        </div>

  * - .. raw:: html

        <div class="ansible-option-cell">
        <div class="ansibleOptionAnchor" id="parameter-catalystcenter_debug"></div>
        <div class="ansibleOptionAnchor" id="parameter-dnac_debug"></div>

      .. _ansible_collections.cisco.catalystcenter.wired_campus_automation_playbook_config_generator_module__parameter-catalystcenter_debug:
      .. _ansible_collections.cisco.catalystcenter.wired_campus_automation_playbook_config_generator_module__parameter-dnac_debug:

      .. rst-class:: ansible-option-title

      **catalystcenter_debug**

      .. raw:: html

        <a class="ansibleOptionLink" href="#parameter-catalystcenter_debug" title="Permalink to this option"></a>

      .. rst-class:: ansible-option-type-line

      :ansible-option-aliases:`aliases: dnac_debug`

      .. 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-catalystcenter_host"></div>
        <div class="ansibleOptionAnchor" id="parameter-dnac_host"></div>

      .. _ansible_collections.cisco.catalystcenter.wired_campus_automation_playbook_config_generator_module__parameter-catalystcenter_host:
      .. _ansible_collections.cisco.catalystcenter.wired_campus_automation_playbook_config_generator_module__parameter-dnac_host:

      .. rst-class:: ansible-option-title

      **catalystcenter_host**

      .. raw:: html

        <a class="ansibleOptionLink" href="#parameter-catalystcenter_host" title="Permalink to this option"></a>

      .. rst-class:: ansible-option-type-line

      :ansible-option-aliases:`aliases: dnac_host`

      .. 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-catalystcenter_log"></div>
        <div class="ansibleOptionAnchor" id="parameter-dnac_log"></div>

      .. _ansible_collections.cisco.catalystcenter.wired_campus_automation_playbook_config_generator_module__parameter-catalystcenter_log:
      .. _ansible_collections.cisco.catalystcenter.wired_campus_automation_playbook_config_generator_module__parameter-dnac_log:

      .. rst-class:: ansible-option-title

      **catalystcenter_log**

      .. raw:: html

        <a class="ansibleOptionLink" href="#parameter-catalystcenter_log" title="Permalink to this option"></a>

      .. rst-class:: ansible-option-type-line

      :ansible-option-aliases:`aliases: dnac_log`

      .. 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 catalystcenter\_log\_file\_path is provided, - Create the log file at the execution location with the specified name.

      When true and catalystcenter\_log\_file\_path is not provided, - Create the log file at the execution location with the name 'catalystcenter.log'.

      When false, - Logging is disabled.

      If the log file doesn't exist, - It is created in append or write mode based on the "catalystcenter\_log\_append" flag.

      If the log file exists, - It is overwritten or appended based on the "catalystcenter\_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-catalystcenter_log_append"></div>
        <div class="ansibleOptionAnchor" id="parameter-dnac_log_append"></div>

      .. _ansible_collections.cisco.catalystcenter.wired_campus_automation_playbook_config_generator_module__parameter-catalystcenter_log_append:
      .. _ansible_collections.cisco.catalystcenter.wired_campus_automation_playbook_config_generator_module__parameter-dnac_log_append:

      .. rst-class:: ansible-option-title

      **catalystcenter_log_append**

      .. raw:: html

        <a class="ansibleOptionLink" href="#parameter-catalystcenter_log_append" title="Permalink to this option"></a>

      .. rst-class:: ansible-option-type-line

      :ansible-option-aliases:`aliases: dnac_log_append`

      .. 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-catalystcenter_log_file_path"></div>
        <div class="ansibleOptionAnchor" id="parameter-dnac_log_file_path"></div>

      .. _ansible_collections.cisco.catalystcenter.wired_campus_automation_playbook_config_generator_module__parameter-catalystcenter_log_file_path:
      .. _ansible_collections.cisco.catalystcenter.wired_campus_automation_playbook_config_generator_module__parameter-dnac_log_file_path:

      .. rst-class:: ansible-option-title

      **catalystcenter_log_file_path**

      .. raw:: html

        <a class="ansibleOptionLink" href="#parameter-catalystcenter_log_file_path" title="Permalink to this option"></a>

      .. rst-class:: ansible-option-type-line

      :ansible-option-aliases:`aliases: dnac_log_file_path`

      .. 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 catalystcenter\_log is True.

      If path is not specified, - When 'catalystcenter\_log\_append' is True, 'catalystcenter.log' is generated in the current Ansible directory; logs are appended. - When 'catalystcenter\_log\_append' is False, 'catalystcenter.log' is generated; logs are overwritten.

      If path is specified, - When 'catalystcenter\_log\_append' is True, the file opens in append mode. - When 'catalystcenter\_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:`"catalystcenter.log"`

      .. raw:: html

        </div>

  * - .. raw:: html

        <div class="ansible-option-cell">
        <div class="ansibleOptionAnchor" id="parameter-catalystcenter_log_level"></div>
        <div class="ansibleOptionAnchor" id="parameter-dnac_log_level"></div>

      .. _ansible_collections.cisco.catalystcenter.wired_campus_automation_playbook_config_generator_module__parameter-catalystcenter_log_level:
      .. _ansible_collections.cisco.catalystcenter.wired_campus_automation_playbook_config_generator_module__parameter-dnac_log_level:

      .. rst-class:: ansible-option-title

      **catalystcenter_log_level**

      .. raw:: html

        <a class="ansibleOptionLink" href="#parameter-catalystcenter_log_level" title="Permalink to this option"></a>

      .. rst-class:: ansible-option-type-line

      :ansible-option-aliases:`aliases: dnac_log_level`

      .. 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-catalystcenter_password"></div>
        <div class="ansibleOptionAnchor" id="parameter-dnac_password"></div>

      .. _ansible_collections.cisco.catalystcenter.wired_campus_automation_playbook_config_generator_module__parameter-catalystcenter_password:
      .. _ansible_collections.cisco.catalystcenter.wired_campus_automation_playbook_config_generator_module__parameter-dnac_password:

      .. rst-class:: ansible-option-title

      **catalystcenter_password**

      .. raw:: html

        <a class="ansibleOptionLink" href="#parameter-catalystcenter_password" title="Permalink to this option"></a>

      .. rst-class:: ansible-option-type-line

      :ansible-option-aliases:`aliases: dnac_password`

      .. 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-catalystcenter_port"></div>
        <div class="ansibleOptionAnchor" id="parameter-dnac_port"></div>
        <div class="ansibleOptionAnchor" id="parameter-catalystcenter_api_port"></div>

      .. _ansible_collections.cisco.catalystcenter.wired_campus_automation_playbook_config_generator_module__parameter-catalystcenter_api_port:
      .. _ansible_collections.cisco.catalystcenter.wired_campus_automation_playbook_config_generator_module__parameter-catalystcenter_port:
      .. _ansible_collections.cisco.catalystcenter.wired_campus_automation_playbook_config_generator_module__parameter-dnac_port:

      .. rst-class:: ansible-option-title

      **catalystcenter_port**

      .. raw:: html

        <a class="ansibleOptionLink" href="#parameter-catalystcenter_port" title="Permalink to this option"></a>

      .. rst-class:: ansible-option-type-line

      :ansible-option-aliases:`aliases: dnac_port, catalystcenter_api_port`

      .. 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-catalystcenter_task_poll_interval"></div>
        <div class="ansibleOptionAnchor" id="parameter-dnac_task_poll_interval"></div>

      .. _ansible_collections.cisco.catalystcenter.wired_campus_automation_playbook_config_generator_module__parameter-catalystcenter_task_poll_interval:
      .. _ansible_collections.cisco.catalystcenter.wired_campus_automation_playbook_config_generator_module__parameter-dnac_task_poll_interval:

      .. rst-class:: ansible-option-title

      **catalystcenter_task_poll_interval**

      .. raw:: html

        <a class="ansibleOptionLink" href="#parameter-catalystcenter_task_poll_interval" title="Permalink to this option"></a>

      .. rst-class:: ansible-option-type-line

      :ansible-option-aliases:`aliases: dnac_task_poll_interval`

      .. rst-class:: ansible-option-type-line

      :ansible-option-type:`integer`

      .. raw:: html

        </div>

    - .. raw:: html

        <div class="ansible-option-cell">

      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

        </div>

  * - .. raw:: html

        <div class="ansible-option-cell">
        <div class="ansibleOptionAnchor" id="parameter-catalystcenter_username"></div>
        <div class="ansibleOptionAnchor" id="parameter-dnac_username"></div>
        <div class="ansibleOptionAnchor" id="parameter-user"></div>

      .. _ansible_collections.cisco.catalystcenter.wired_campus_automation_playbook_config_generator_module__parameter-catalystcenter_username:
      .. _ansible_collections.cisco.catalystcenter.wired_campus_automation_playbook_config_generator_module__parameter-dnac_username:
      .. _ansible_collections.cisco.catalystcenter.wired_campus_automation_playbook_config_generator_module__parameter-user:

      .. rst-class:: ansible-option-title

      **catalystcenter_username**

      .. raw:: html

        <a class="ansibleOptionLink" href="#parameter-catalystcenter_username" title="Permalink to this option"></a>

      .. rst-class:: ansible-option-type-line

      :ansible-option-aliases:`aliases: dnac_username, 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-catalystcenter_verify"></div>
        <div class="ansibleOptionAnchor" id="parameter-dnac_verify"></div>

      .. _ansible_collections.cisco.catalystcenter.wired_campus_automation_playbook_config_generator_module__parameter-catalystcenter_verify:
      .. _ansible_collections.cisco.catalystcenter.wired_campus_automation_playbook_config_generator_module__parameter-dnac_verify:

      .. rst-class:: ansible-option-title

      **catalystcenter_verify**

      .. raw:: html

        <a class="ansibleOptionLink" href="#parameter-catalystcenter_verify" title="Permalink to this option"></a>

      .. rst-class:: ansible-option-type-line

      :ansible-option-aliases:`aliases: dnac_verify`

      .. 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-catalystcenter_version"></div>
        <div class="ansibleOptionAnchor" id="parameter-dnac_version"></div>

      .. _ansible_collections.cisco.catalystcenter.wired_campus_automation_playbook_config_generator_module__parameter-catalystcenter_version:
      .. _ansible_collections.cisco.catalystcenter.wired_campus_automation_playbook_config_generator_module__parameter-dnac_version:

      .. rst-class:: ansible-option-title

      **catalystcenter_version**

      .. raw:: html

        <a class="ansibleOptionLink" href="#parameter-catalystcenter_version" title="Permalink to this option"></a>

      .. rst-class:: ansible-option-type-line

      :ansible-option-aliases:`aliases: dnac_version`

      .. 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.3.7.6"`

      .. raw:: html

        </div>

  * - .. raw:: html

        <div class="ansible-option-cell">
        <div class="ansibleOptionAnchor" id="parameter-config"></div>

      .. _ansible_collections.cisco.catalystcenter.wired_campus_automation_playbook_config_generator_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:`dictionary`

      .. raw:: html

        </div>

    - .. raw:: html

        <div class="ansible-option-cell">

      A dictionary of filters for generating a YAML playbook compatible with the 'wired\_campus\_automation\_workflow\_manager' module.

      If omitted, all managed devices and all supported layer2 features are extracted automatically.

      Global filters identify target devices by IP address, hostname, or serial number.

      Component-specific filters select which layer2 features to extract and allow VLAN ID or interface name filtering.

      Global filters and component-specific filters are combined with AND logic. Omitting a filter means no restriction on that attribute.


      .. raw:: html

        </div>
    
  * - .. raw:: html

        <div class="ansible-option-indent"></div><div class="ansible-option-cell">
        <div class="ansibleOptionAnchor" id="parameter-config/component_specific_filters"></div>

      .. _ansible_collections.cisco.catalystcenter.wired_campus_automation_playbook_config_generator_module__parameter-config/component_specific_filters:

      .. rst-class:: ansible-option-title

      **component_specific_filters**

      .. raw:: html

        <a class="ansibleOptionLink" href="#parameter-config/component_specific_filters" 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">

      Filters to specify which layer2 components and features to include in the YAML configuration file.

      Allows granular selection of specific features and their parameters.

      If not specified, all supported layer2 features will be extracted.


      .. 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/component_specific_filters/components_list"></div>

      .. _ansible_collections.cisco.catalystcenter.wired_campus_automation_playbook_config_generator_module__parameter-config/component_specific_filters/components_list:

      .. rst-class:: ansible-option-title

      **components_list**

      .. raw:: html

        <a class="ansibleOptionLink" href="#parameter-config/component_specific_filters/components_list" 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">

      List of components to include in the YAML configuration file.

      Valid values are ["layer2\_configurations"]

      If not specified, all supported components are included.

      Future versions may support additional component types.


      .. rst-class:: ansible-option-line

      :ansible-option-choices:`Choices:`

      - :ansible-option-choices-entry:`"layer2\_configurations"`


      .. 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/component_specific_filters/layer2_configurations"></div>

      .. _ansible_collections.cisco.catalystcenter.wired_campus_automation_playbook_config_generator_module__parameter-config/component_specific_filters/layer2_configurations:

      .. rst-class:: ansible-option-title

      **layer2_configurations**

      .. raw:: html

        <a class="ansibleOptionLink" href="#parameter-config/component_specific_filters/layer2_configurations" 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">

      Filters specific to layer2 configurations.

      Allows selection of specific layer2 features and detailed filtering options.

      If not specified, all supported layer2 features and their configurations will be extracted.


      .. 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/component_specific_filters/layer2_configurations/layer2_features"></div>

      .. _ansible_collections.cisco.catalystcenter.wired_campus_automation_playbook_config_generator_module__parameter-config/component_specific_filters/layer2_configurations/layer2_features:

      .. rst-class:: ansible-option-title

      **layer2_features**

      .. raw:: html

        <a class="ansibleOptionLink" href="#parameter-config/component_specific_filters/layer2_configurations/layer2_features" 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-indent-desc"></div><div class="ansible-option-cell">

      List of specific layer2 features to extract from devices.

      Valid values are ["vlans", "cdp", "lldp", "stp", "vtp", "dhcp\_snooping", "igmp\_snooping", "mld\_snooping", "authentication", "logical\_ports", "port\_configuration"]

      If not specified, all supported layer2 features will be extracted.

      Example \ :literal:`["vlans", "stp", "cdp"]`\  to extract only VLAN, STP, and CDP configurations.


      .. rst-class:: ansible-option-line

      :ansible-option-choices:`Choices:`

      - :ansible-option-choices-entry:`"vlans"`
      - :ansible-option-choices-entry:`"cdp"`
      - :ansible-option-choices-entry:`"lldp"`
      - :ansible-option-choices-entry:`"stp"`
      - :ansible-option-choices-entry:`"vtp"`
      - :ansible-option-choices-entry:`"dhcp\_snooping"`
      - :ansible-option-choices-entry:`"igmp\_snooping"`
      - :ansible-option-choices-entry:`"mld\_snooping"`
      - :ansible-option-choices-entry:`"authentication"`
      - :ansible-option-choices-entry:`"logical\_ports"`
      - :ansible-option-choices-entry:`"port\_configuration"`


      .. 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/component_specific_filters/layer2_configurations/port_configuration"></div>

      .. _ansible_collections.cisco.catalystcenter.wired_campus_automation_playbook_config_generator_module__parameter-config/component_specific_filters/layer2_configurations/port_configuration:

      .. rst-class:: ansible-option-title

      **port_configuration**

      .. raw:: html

        <a class="ansibleOptionLink" href="#parameter-config/component_specific_filters/layer2_configurations/port_configuration" 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-indent-desc"></div><div class="ansible-option-cell">

      Specific port configuration filtering options.

      Allows extraction of configurations for only specific interfaces.

      If not specified, all configured interfaces will be extracted.


      .. 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-indent"></div><div class="ansible-option-cell">
        <div class="ansibleOptionAnchor" id="parameter-config/component_specific_filters/layer2_configurations/port_configuration/interface_names_list"></div>

      .. _ansible_collections.cisco.catalystcenter.wired_campus_automation_playbook_config_generator_module__parameter-config/component_specific_filters/layer2_configurations/port_configuration/interface_names_list:

      .. rst-class:: ansible-option-title

      **interface_names_list**

      .. raw:: html

        <a class="ansibleOptionLink" href="#parameter-config/component_specific_filters/layer2_configurations/port_configuration/interface_names_list" 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-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell">

      List of specific interface names to extract configurations from.

      Interface names must match the format used by the device.

      Example \ :literal:`["GigabitEthernet1/0/1", "TenGigabitEthernet1/0/1"]`\ .

      Only interfaces in this list will have their configurations extracted.


      .. 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/component_specific_filters/layer2_configurations/vlans"></div>

      .. _ansible_collections.cisco.catalystcenter.wired_campus_automation_playbook_config_generator_module__parameter-config/component_specific_filters/layer2_configurations/vlans:

      .. rst-class:: ansible-option-title

      **vlans**

      .. raw:: html

        <a class="ansibleOptionLink" href="#parameter-config/component_specific_filters/layer2_configurations/vlans" 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-indent-desc"></div><div class="ansible-option-cell">

      Specific VLAN filtering options.

      Allows extraction of only specific VLANs based on VLAN IDs.

      If not specified, all VLANs configured on the device will be extracted.


      .. 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-indent"></div><div class="ansible-option-cell">
        <div class="ansibleOptionAnchor" id="parameter-config/component_specific_filters/layer2_configurations/vlans/vlan_ids_list"></div>

      .. _ansible_collections.cisco.catalystcenter.wired_campus_automation_playbook_config_generator_module__parameter-config/component_specific_filters/layer2_configurations/vlans/vlan_ids_list:

      .. rst-class:: ansible-option-title

      **vlan_ids_list**

      .. raw:: html

        <a class="ansibleOptionLink" href="#parameter-config/component_specific_filters/layer2_configurations/vlans/vlan_ids_list" 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-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell">

      List of specific VLAN IDs to extract from devices.

      Each VLAN ID must be between 1 and 4094.

      Only VLANs in this list will be included in the generated configuration.

      Example \ :literal:`["10", "20", "100", "200"]`\  to extract only these specific VLANs.


      .. raw:: html

        </div>




  * - .. raw:: html

        <div class="ansible-option-indent"></div><div class="ansible-option-cell">
        <div class="ansibleOptionAnchor" id="parameter-config/global_filters"></div>

      .. _ansible_collections.cisco.catalystcenter.wired_campus_automation_playbook_config_generator_module__parameter-config/global_filters:

      .. rst-class:: ansible-option-title

      **global_filters**

      .. raw:: html

        <a class="ansibleOptionLink" href="#parameter-config/global_filters" 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">

      Filters that identify which network devices to extract configurations from.

      If no global filters are specified, all managed devices in Cisco Catalyst Center are targeted.

      When multiple filter types are provided, only the highest-priority type is used (IP \> serial \> hostname). Lower-priority filters are ignored.


      .. 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/global_filters/hostname_list"></div>

      .. _ansible_collections.cisco.catalystcenter.wired_campus_automation_playbook_config_generator_module__parameter-config/global_filters/hostname_list:

      .. rst-class:: ansible-option-title

      **hostname_list**

      .. raw:: html

        <a class="ansibleOptionLink" href="#parameter-config/global_filters/hostname_list" 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">

      List of device hostnames to extract configurations from.

      LOWEST PRIORITY - Only used if neither ip\_address\_list nor serial\_number\_list are provided.

      Hostnames must match those registered in Catalyst Center.

      Case-sensitive and must be exact matches.

      Example ["switch01.lab.com", "core-switch-01", "access-sw-floor2"]


      .. 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/global_filters/ip_address_list"></div>

      .. _ansible_collections.cisco.catalystcenter.wired_campus_automation_playbook_config_generator_module__parameter-config/global_filters/ip_address_list:

      .. rst-class:: ansible-option-title

      **ip_address_list**

      .. raw:: html

        <a class="ansibleOptionLink" href="#parameter-config/global_filters/ip_address_list" 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">

      List of device IP addresses to extract configurations from.

      HIGHEST PRIORITY - If provided, serial numbers and hostnames will be ignored.

      Each IP address must be a valid IPv4 address format.

      Devices must be managed by Cisco Catalyst Center.

      Example ["192.168.1.10", "192.168.1.11", "10.1.1.5"]


      .. 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/global_filters/serial_number_list"></div>

      .. _ansible_collections.cisco.catalystcenter.wired_campus_automation_playbook_config_generator_module__parameter-config/global_filters/serial_number_list:

      .. rst-class:: ansible-option-title

      **serial_number_list**

      .. raw:: html

        <a class="ansibleOptionLink" href="#parameter-config/global_filters/serial_number_list" 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">

      List of device serial numbers to extract configurations from.

      MEDIUM PRIORITY - Only used if ip\_address\_list is not provided.

      Serial numbers must match those registered in Catalyst Center.

      Useful when IP addresses may change but serial numbers remain constant.

      If both serial\_number\_list and hostname\_list are provided, serial\_number\_list takes priority.

      Example ["FCW2140L05Y", "FCW2140L06Z", "9080V0I41J3"]


      .. raw:: html

        </div>



  * - .. raw:: html

        <div class="ansible-option-cell">
        <div class="ansibleOptionAnchor" id="parameter-file_mode"></div>

      .. _ansible_collections.cisco.catalystcenter.wired_campus_automation_playbook_config_generator_module__parameter-file_mode:

      .. rst-class:: ansible-option-title

      **file_mode**

      .. raw:: html

        <a class="ansibleOptionLink" href="#parameter-file_mode" 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">

      Controls how the generated configuration is written to the output YAML file.

      \ :literal:`overwrite`\  replaces the existing file content entirely.

      \ :literal:`append`\  appends the generated YAML content to the existing file. If the file does not exist, it is created.


      .. rst-class:: ansible-option-line

      :ansible-option-choices:`Choices:`

      - :ansible-option-choices-entry-default:`"overwrite"` :ansible-option-choices-default-mark:`← (default)`
      - :ansible-option-choices-entry:`"append"`


      .. raw:: html

        </div>

  * - .. raw:: html

        <div class="ansible-option-cell">
        <div class="ansibleOptionAnchor" id="parameter-file_path"></div>

      .. _ansible_collections.cisco.catalystcenter.wired_campus_automation_playbook_config_generator_module__parameter-file_path:

      .. rst-class:: ansible-option-title

      **file_path**

      .. raw:: html

        <a class="ansibleOptionLink" href="#parameter-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">

      Absolute or relative path for YAML configuration file output.

      If not provided, a default filename is generated in the current working directory using the pattern \ :literal:`wired\_campus\_automation\_playbook\_config\_\<YYYY-MM-DD\_HH-MM-SS\>.yml`\ .

      Example default filename 'wired\_campus\_automation\_playbook\_config\_2026-02-27\_14-31-46.yml'

      Directory created automatically if path does not exist.

      Supports YAML file extension (.yml or .yaml).


      .. raw:: html

        </div>

  * - .. raw:: html

        <div class="ansible-option-cell">
        <div class="ansibleOptionAnchor" id="parameter-state"></div>

      .. _ansible_collections.cisco.catalystcenter.wired_campus_automation_playbook_config_generator_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 desired state of Cisco Catalyst Center 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

        </div>

  * - .. raw:: html

        <div class="ansible-option-cell">
        <div class="ansibleOptionAnchor" id="parameter-validate_response_schema"></div>

      .. _ansible_collections.cisco.catalystcenter.wired_campus_automation_playbook_config_generator_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::
   - SDK Methods used are - devices.Devices.get\_device\_list - wired.Wired.get\_configurations\_for\_a\_deployed\_layer2\_feature\_on\_a\_wired\_device
   - Paths used are - GET /dna/intent/api/v1/network-device - GET /dna/intent/api/v1/networkDevices/${id}/configFeatures/deployed/layer2/${feature}
   - Auto-population of \ :literal:`components\_list`\  - If component-specific filters (such as 'projects' or 'configuration\_templates') are provided without explicitly including them in 'components\_list', those components will be automatically added to 'components\_list'. This simplifies configuration by eliminating the need to redundantly specify components in both places.
   - Example of auto-population behavior - If you provide filters for 'projects' without including 'projects' in 'components\_list', the module will automatically add 'projects' to 'components\_list' before processing. This allows you to write more concise playbooks.
   - Module result behavior (changed/ok/failed) - The module result reflects local file state only, not Catalyst Center state. In overwrite mode, the full generated YAML content is compared against the existing file after excluding generated header comment lines. In append mode, only the last YAML document in the file is compared against the newly generated configuration. If a file contains multiple config entries from previous appends, only the most recent entry is used for the idempotency check. changed=true (status success) means the generated YAML configuration differs from the existing output file (or the file does not exist). The file was written and the configuration was updated. changed=false (status ok) means the generated YAML configuration matches the existing output file content. The write was skipped as the file is already up-to-date. failed=true (status failed) means the module encountered a validation error, API failure, or file write error. No file was written or modified. Re-running with identical inputs and unchanged Catalyst Center state will produce changed=false, ensuring idempotent playbook behavior. If append mode creates multiple config entries in the generated file, replaying the file as config in the workflow manager module applies only the last config entry because yaml.safe\_load uses last-key-wins semantics for duplicate keys in a single YAML document.
   - 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

.. Seealso

See Also
--------

.. seealso::

   \ :ref:`cisco.catalystcenter.wired\_campus\_automation\_workflow\_manager <ansible_collections.cisco.catalystcenter.wired_campus_automation_workflow_manager_module>`\ 
       Module for managing wired campus automation workflows in Cisco Catalyst Center.

.. Examples

Examples
--------

.. code-block:: yaml+jinja

    

    # NOT Recommended for actual use cases due to potential API errors on non-layer2 devices.
    # - name: Auto-generate YAML Configuration for all devices and features
    #   cisco.catalystcenter.wired_campus_automation_playbook_config_generator:
    #     catalystcenter_host: "{{catalystcenter_host}}"
    #     catalystcenter_username: "{{catalystcenter_username}}"
    #     catalystcenter_password: "{{catalystcenter_password}}"
    #     catalystcenter_verify: "{{catalystcenter_verify}}"
    #     catalystcenter_port: "{{catalystcenter_port}}"
    #     catalystcenter_version: "{{catalystcenter_version}}"
    #     catalystcenter_debug: "{{catalystcenter_debug}}"
    #     catalystcenter_log: true
    #     catalystcenter_log_level: "{{catalystcenter_log_level}}"
    #     state: gathered
    #     file_mode: "append"

    # NOT Recommended for actual use cases due to potential API errors on non-layer2 devices.
    # - name: Auto-generate YAML Configuration with custom file path
    #   cisco.catalystcenter.wired_campus_automation_playbook_config_generator:
    #     catalystcenter_host: "{{catalystcenter_host}}"
    #     catalystcenter_username: "{{catalystcenter_username}}"
    #     catalystcenter_password: "{{catalystcenter_password}}"
    #     catalystcenter_verify: "{{catalystcenter_verify}}"
    #     catalystcenter_port: "{{catalystcenter_port}}"
    #     catalystcenter_version: "{{catalystcenter_version}}"
    #     catalystcenter_debug: "{{catalystcenter_debug}}"
    #     catalystcenter_log: true
    #     catalystcenter_log_level: "{{catalystcenter_log_level}}"
    #     state: gathered
    #     file_path: "/tmp/complete_infrastructure_config.yml"
    #     file_mode: "append"

    - name: Generate YAML Configuration with default file path
      cisco.catalystcenter.wired_campus_automation_playbook_config_generator:
        catalystcenter_host: "{{catalystcenter_host}}"
        catalystcenter_username: "{{catalystcenter_username}}"
        catalystcenter_password: "{{catalystcenter_password}}"
        catalystcenter_verify: "{{catalystcenter_verify}}"
        catalystcenter_port: "{{catalystcenter_port}}"
        catalystcenter_version: "{{catalystcenter_version}}"
        catalystcenter_debug: "{{catalystcenter_debug}}"
        catalystcenter_log: true
        catalystcenter_log_level: "{{catalystcenter_log_level}}"
        state: gathered
        file_mode: "append"
        config:
          global_filters:
            ip_address_list: ["192.168.1.10"]

    - name: Generate YAML Configuration with specific devices by IP address
      cisco.catalystcenter.wired_campus_automation_playbook_config_generator:
        catalystcenter_host: "{{catalystcenter_host}}"
        catalystcenter_username: "{{catalystcenter_username}}"
        catalystcenter_password: "{{catalystcenter_password}}"
        catalystcenter_verify: "{{catalystcenter_verify}}"
        catalystcenter_port: "{{catalystcenter_port}}"
        catalystcenter_version: "{{catalystcenter_version}}"
        catalystcenter_debug: "{{catalystcenter_debug}}"
        catalystcenter_log: true
        catalystcenter_log_level: "{{catalystcenter_log_level}}"
        state: gathered
        file_path: "/tmp/wired_campus_automation_config.yml"
        file_mode: "append"
        config:
          global_filters:
            ip_address_list: ["192.168.1.10", "192.168.1.11", "192.168.1.12"]

    - name: Generate YAML Configuration with specific devices by hostname
      cisco.catalystcenter.wired_campus_automation_playbook_config_generator:
        catalystcenter_host: "{{catalystcenter_host}}"
        catalystcenter_username: "{{catalystcenter_username}}"
        catalystcenter_password: "{{catalystcenter_password}}"
        catalystcenter_verify: "{{catalystcenter_verify}}"
        catalystcenter_port: "{{catalystcenter_port}}"
        catalystcenter_version: "{{catalystcenter_version}}"
        catalystcenter_debug: "{{catalystcenter_debug}}"
        catalystcenter_log: true
        catalystcenter_log_level: "{{catalystcenter_log_level}}"
        state: gathered
        file_path: "/tmp/wired_campus_automation_config.yml"
        file_mode: "append"
        config:
          global_filters:
            hostname_list: ["switch01.lab.com", "switch02.lab.com", "core-switch-01"]

    - name: Generate YAML Configuration with specific devices by serial number
      cisco.catalystcenter.wired_campus_automation_playbook_config_generator:
        catalystcenter_host: "{{catalystcenter_host}}"
        catalystcenter_username: "{{catalystcenter_username}}"
        catalystcenter_password: "{{catalystcenter_password}}"
        catalystcenter_verify: "{{catalystcenter_verify}}"
        catalystcenter_port: "{{catalystcenter_port}}"
        catalystcenter_version: "{{catalystcenter_version}}"
        catalystcenter_debug: "{{catalystcenter_debug}}"
        catalystcenter_log: true
        catalystcenter_log_level: "{{catalystcenter_log_level}}"
        state: gathered
        file_path: "/tmp/wired_campus_automation_config.yml"
        file_mode: "append"
        config:
          global_filters:
            serial_number_list: ["FCW2140L05Y", "FCW2140L06Z", "9080V0I41J3"]

    - name: Generate YAML Configuration with specific devices by hostname
      cisco.catalystcenter.wired_campus_automation_playbook_config_generator:
        catalystcenter_host: "{{catalystcenter_host}}"
        catalystcenter_username: "{{catalystcenter_username}}"
        catalystcenter_password: "{{catalystcenter_password}}"
        catalystcenter_verify: "{{catalystcenter_verify}}"
        catalystcenter_port: "{{catalystcenter_port}}"
        catalystcenter_version: "{{catalystcenter_version}}"
        catalystcenter_debug: "{{catalystcenter_debug}}"
        catalystcenter_log: true
        catalystcenter_log_level: "{{catalystcenter_log_level}}"
        state: gathered
        file_path: "/tmp/wired_campus_automation_config.yml"
        file_mode: "append"
        config:
          global_filters:
            hostname_list: ["switch01.lab.com", "switch02.lab.com", "core-switch-01"]

    - name: Generate YAML Configuration with specific devices by serial number
      cisco.catalystcenter.wired_campus_automation_playbook_config_generator:
        catalystcenter_host: "{{catalystcenter_host}}"
        catalystcenter_username: "{{catalystcenter_username}}"
        catalystcenter_password: "{{catalystcenter_password}}"
        catalystcenter_verify: "{{catalystcenter_verify}}"
        catalystcenter_port: "{{catalystcenter_port}}"
        catalystcenter_version: "{{catalystcenter_version}}"
        catalystcenter_debug: "{{catalystcenter_debug}}"
        catalystcenter_log: true
        catalystcenter_log_level: "{{catalystcenter_log_level}}"
        state: gathered
        file_path: "/tmp/wired_campus_automation_config.yml"
        file_mode: "append"
        config:
          global_filters:
            serial_number_list: ["FCW2140L05Y", "FCW2140L06Z", "9080V0I41J3"]

    - name: Generate YAML Configuration using explicit components list
      cisco.catalystcenter.wired_campus_automation_playbook_config_generator:
        catalystcenter_host: "{{catalystcenter_host}}"
        catalystcenter_username: "{{catalystcenter_username}}"
        catalystcenter_password: "{{catalystcenter_password}}"
        catalystcenter_verify: "{{catalystcenter_verify}}"
        catalystcenter_port: "{{catalystcenter_port}}"
        catalystcenter_version: "{{catalystcenter_version}}"
        catalystcenter_debug: "{{catalystcenter_debug}}"
        catalystcenter_log: true
        catalystcenter_log_level: "{{catalystcenter_log_level}}"
        state: gathered
        file_path: "/tmp/wired_campus_automation_config.yml"
        file_mode: "append"
        config:
          global_filters:
            ip_address_list: ["192.168.1.10", "192.168.1.11"]
          component_specific_filters:
            components_list: ["layer2_configurations"]

    - name: Generate YAML Configuration with components list and specific features
      cisco.catalystcenter.wired_campus_automation_playbook_config_generator:
        catalystcenter_host: "{{catalystcenter_host}}"
        catalystcenter_username: "{{catalystcenter_username}}"
        catalystcenter_password: "{{catalystcenter_password}}"
        catalystcenter_verify: "{{catalystcenter_verify}}"
        catalystcenter_port: "{{catalystcenter_port}}"
        catalystcenter_version: "{{catalystcenter_version}}"
        catalystcenter_debug: "{{catalystcenter_debug}}"
        catalystcenter_log: true
        catalystcenter_log_level: "{{catalystcenter_log_level}}"
        state: gathered
        file_path: "/tmp/wired_campus_automation_config.yml"
        file_mode: "append"
        config:
          global_filters:
            ip_address_list: ["192.168.1.10"]
          component_specific_filters:
            components_list: ["layer2_configurations"]
            layer2_configurations:
              - layer2_features: ["vlans", "stp", "cdp"]

    - name: Generate YAML Configuration for specific VLANs
      cisco.catalystcenter.wired_campus_automation_playbook_config_generator:
        catalystcenter_host: "{{catalystcenter_host}}"
        catalystcenter_username: "{{catalystcenter_username}}"
        catalystcenter_password: "{{catalystcenter_password}}"
        catalystcenter_verify: "{{catalystcenter_verify}}"
        catalystcenter_port: "{{catalystcenter_port}}"
        catalystcenter_version: "{{catalystcenter_version}}"
        catalystcenter_debug: "{{catalystcenter_debug}}"
        catalystcenter_log: true
        catalystcenter_log_level: "{{catalystcenter_log_level}}"
        state: gathered
        file_path: "/tmp/wired_campus_automation_config.yml"
        file_mode: "append"
        config:
          global_filters:
            ip_address_list: ["192.168.1.10"]
          component_specific_filters:
            components_list: ["layer2_configurations"]
            layer2_configurations:
              - layer2_features: ["vlans"]
                vlans:
                  vlan_ids_list: ["10", "20", "100", "200"]

    - name: Generate YAML Configuration for specific interfaces
      cisco.catalystcenter.wired_campus_automation_playbook_config_generator:
        catalystcenter_host: "{{catalystcenter_host}}"
        catalystcenter_username: "{{catalystcenter_username}}"
        catalystcenter_password: "{{catalystcenter_password}}"
        catalystcenter_verify: "{{catalystcenter_verify}}"
        catalystcenter_port: "{{catalystcenter_port}}"
        catalystcenter_version: "{{catalystcenter_version}}"
        catalystcenter_debug: "{{catalystcenter_debug}}"
        catalystcenter_log: true
        catalystcenter_log_level: "{{catalystcenter_log_level}}"
        state: gathered
        file_path: "/tmp/wired_campus_automation_config.yml"
        file_mode: "append"
        config:
          global_filters:
            ip_address_list: ["192.168.1.10"]
          component_specific_filters:
            components_list: ["layer2_configurations"]
            layer2_configurations:
              - layer2_features: ["port_configuration"]
                port_configuration:
                  interface_names_list:
                    - "GigabitEthernet1/0/1"
                    - "GigabitEthernet1/0/2"
                    - "TenGigabitEthernet1/0/1"

    - name: Generate YAML Configuration with comprehensive filtering
      cisco.catalystcenter.wired_campus_automation_playbook_config_generator:
        catalystcenter_host: "{{catalystcenter_host}}"
        catalystcenter_username: "{{catalystcenter_username}}"
        catalystcenter_password: "{{catalystcenter_password}}"
        catalystcenter_verify: "{{catalystcenter_verify}}"
        catalystcenter_port: "{{catalystcenter_port}}"
        catalystcenter_version: "{{catalystcenter_version}}"
        catalystcenter_debug: "{{catalystcenter_debug}}"
        catalystcenter_log: true
        catalystcenter_log_level: "{{catalystcenter_log_level}}"
        state: gathered
        file_path: "/tmp/wired_campus_automation_config.yml"
        file_mode: "append"
        config:
          global_filters:
            ip_address_list: ["192.168.1.10", "192.168.1.11"]
          component_specific_filters:
            components_list: ["layer2_configurations"]
            layer2_configurations:
              - layer2_features: ["vlans", "stp", "port_configuration"]
                vlans:
                  vlan_ids_list: ["10", "20", "100"]
                port_configuration:
                  interface_names_list:
                    - "GigabitEthernet1/0/1"
                    - "GigabitEthernet1/0/24"

    - name: Generate YAML Configuration for specific interfaces
      cisco.catalystcenter.wired_campus_automation_playbook_config_generator:
        catalystcenter_host: "{{catalystcenter_host}}"
        catalystcenter_username: "{{catalystcenter_username}}"
        catalystcenter_password: "{{catalystcenter_password}}"
        catalystcenter_verify: "{{catalystcenter_verify}}"
        catalystcenter_port: "{{catalystcenter_port}}"
        catalystcenter_version: "{{catalystcenter_version}}"
        catalystcenter_debug: "{{catalystcenter_debug}}"
        catalystcenter_log: true
        catalystcenter_log_level: "{{catalystcenter_log_level}}"
        state: gathered
        file_path: "/tmp/wired_campus_automation_config.yml"
        file_mode: "append"
        config:
          global_filters:
            ip_address_list: ["192.168.1.10"]
          component_specific_filters:
            components_list: ["layer2_configurations"]
            layer2_configurations:
              - layer2_features: ["port_configuration"]
                port_configuration:
                  interface_names_list:
                    - "GigabitEthernet1/0/1"
                    - "GigabitEthernet1/0/2"
                    - "TenGigabitEthernet1/0/1"

    - name: Generate YAML Configuration with comprehensive filtering
      cisco.catalystcenter.wired_campus_automation_playbook_config_generator:
        catalystcenter_host: "{{catalystcenter_host}}"
        catalystcenter_username: "{{catalystcenter_username}}"
        catalystcenter_password: "{{catalystcenter_password}}"
        catalystcenter_verify: "{{catalystcenter_verify}}"
        catalystcenter_port: "{{catalystcenter_port}}"
        catalystcenter_version: "{{catalystcenter_version}}"
        catalystcenter_debug: "{{catalystcenter_debug}}"
        catalystcenter_log: true
        catalystcenter_log_level: "{{catalystcenter_log_level}}"
        state: gathered
        file_path: "/tmp/wired_campus_automation_config.yml"
        file_mode: "append"
        config:
          global_filters:
            ip_address_list: ["192.168.1.10", "192.168.1.11"]
          component_specific_filters:
            components_list: ["layer2_configurations"]
            layer2_configurations:
              - layer2_features: ["vlans", "stp", "port_configuration"]
                vlans:
                  vlan_ids_list: ["10", "20", "100"]
                port_configuration:
                  interface_names_list:
                    - "GigabitEthernet1/0/1"
                    - "GigabitEthernet1/0/24"

    - name: Generate YAML Configuration for all features (no component filters)
      cisco.catalystcenter.wired_campus_automation_playbook_config_generator:
        catalystcenter_host: "{{catalystcenter_host}}"
        catalystcenter_username: "{{catalystcenter_username}}"
        catalystcenter_password: "{{catalystcenter_password}}"
        catalystcenter_verify: "{{catalystcenter_verify}}"
        catalystcenter_port: "{{catalystcenter_port}}"
        catalystcenter_version: "{{catalystcenter_version}}"
        catalystcenter_debug: "{{catalystcenter_debug}}"
        catalystcenter_log: true
        catalystcenter_log_level: "{{catalystcenter_log_level}}"
        state: gathered
        file_path: "/tmp/wired_campus_automation_config.yml"
        file_mode: "append"
        config:
          global_filters:
            ip_address_list: ["192.168.1.10"]

    - name: Generate YAML Configuration with default file path
      cisco.catalystcenter.wired_campus_automation_playbook_config_generator:
        catalystcenter_host: "{{catalystcenter_host}}"
        catalystcenter_username: "{{catalystcenter_username}}"
        catalystcenter_password: "{{catalystcenter_password}}"
        catalystcenter_verify: "{{catalystcenter_verify}}"
        catalystcenter_port: "{{catalystcenter_port}}"
        catalystcenter_version: "{{catalystcenter_version}}"
        catalystcenter_debug: "{{catalystcenter_debug}}"
        catalystcenter_log: true
        catalystcenter_log_level: "{{catalystcenter_log_level}}"
        state: gathered
        file_path: "/tmp/wired_campus_automation_config.yml"
        file_mode: "append"
        config:
          global_filters:
            ip_address_list: ["192.168.1.10"]

    - name: Generate YAML Configuration for protocol features
      cisco.catalystcenter.wired_campus_automation_playbook_config_generator:
        catalystcenter_host: "{{catalystcenter_host}}"
        catalystcenter_username: "{{catalystcenter_username}}"
        catalystcenter_password: "{{catalystcenter_password}}"
        catalystcenter_verify: "{{catalystcenter_verify}}"
        catalystcenter_port: "{{catalystcenter_port}}"
        catalystcenter_version: "{{catalystcenter_version}}"
        catalystcenter_debug: "{{catalystcenter_debug}}"
        catalystcenter_log: true
        catalystcenter_log_level: "{{catalystcenter_log_level}}"
        state: gathered
        file_path: "/tmp/wired_campus_automation_config.yml"
        file_mode: "append"
        config:
          global_filters:
            hostname_list: ["switch01.lab.com", "switch02.lab.com"]
          component_specific_filters:
            components_list: ["layer2_configurations"]
            layer2_configurations:
              - layer2_features: ["cdp", "lldp", "stp", "vtp"]

    - name: Generate YAML Configuration for security features
      cisco.catalystcenter.wired_campus_automation_playbook_config_generator:
        catalystcenter_host: "{{catalystcenter_host}}"
        catalystcenter_username: "{{catalystcenter_username}}"
        catalystcenter_password: "{{catalystcenter_password}}"
        catalystcenter_verify: "{{catalystcenter_verify}}"
        catalystcenter_port: "{{catalystcenter_port}}"
        catalystcenter_version: "{{catalystcenter_version}}"
        catalystcenter_debug: "{{catalystcenter_debug}}"
        catalystcenter_log: true
        catalystcenter_log_level: "{{catalystcenter_log_level}}"
        state: gathered
        file_path: "/tmp/wired_campus_automation_config.yml"
        file_mode: "append"
        config:
          global_filters:
            serial_number_list: ["FCW2140L05Y", "FCW2140L06Z"]
          component_specific_filters:
            components_list: ["layer2_configurations"]
            layer2_configurations:
              - layer2_features: ["dhcp_snooping", "igmp_snooping", "authentication"]




.. 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-response_1"></div>

      .. _ansible_collections.cisco.catalystcenter.wired_campus_automation_playbook_config_generator_module__return-response_1:

      .. rst-class:: ansible-option-title

      **response_1**

      .. raw:: html

        <a class="ansibleOptionLink" href="#return-response_1" 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 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:`{"changed": true, "diff": [], "invocation": {"module\_args": {"catalystcenter\_api\_task\_timeout": 1200, "catalystcenter\_debug": false, "catalystcenter\_host": "10.22.40.214", "catalystcenter\_log": true, "catalystcenter\_log\_append": true, "catalystcenter\_log\_file\_path": "catalystcenter.log", "catalystcenter\_log\_level": "DEBUG", "catalystcenter\_password": "VALUE\_SPECIFIED\_IN\_NO\_LOG\_PARAMETER", "catalystcenter\_port": "443", "catalystcenter\_task\_poll\_interval": 2, "catalystcenter\_username": "admin", "catalystcenter\_verify": false, "catalystcenter\_version": "3.1.3.0", "config": {"component\_specific\_filters": {"components\_list": ["layer2\_configurations"], "layer2\_configurations": [{"layer2\_features": ["vlans", "cdp"]}]}, "global\_filters": {"ip\_address\_list": ["1.1.1.1"]}}, "file\_mode": "overwrite", "file\_path": "wired\_campus\_automation\_config.yml", "state": "gathered", "validate\_response\_schema": true}}, "msg": {"components\_processed": 1, "components\_skipped": 0, "configurations\_count": 1, "file\_mode": "overwrite", "file\_path": "wired\_campus\_automation\_config.yml", "message": "YAML configuration file generated successfully for module 'wired\_campus\_automation\_workflow\_manager'", "status": "success"}, "response": {"components\_processed": 1, "components\_skipped": 0, "configurations\_count": 1, "file\_mode": "overwrite", "file\_path": "wired\_campus\_automation\_config.yml", "message": "YAML configuration file generated successfully for module 'wired\_campus\_automation\_workflow\_manager'", "status": "success"}, "status": "success"}`


      .. raw:: html

        </div>


  * - .. raw:: html

        <div class="ansible-option-cell">
        <div class="ansibleOptionAnchor" id="return-response_2"></div>

      .. _ansible_collections.cisco.catalystcenter.wired_campus_automation_playbook_config_generator_module__return-response_2:

      .. rst-class:: ansible-option-title

      **response_2**

      .. raw:: html

        <a class="ansibleOptionLink" href="#return-response_2" 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 with the response when no configurations are found


      .. rst-class:: ansible-option-line

      :ansible-option-returned-bold:`Returned:` always

      .. rst-class:: ansible-option-line
      .. rst-class:: ansible-option-sample

      :ansible-option-sample-bold:`Sample:` :ansible-rv-sample-value:`{"msg": "No configurations or components to process for module 'wired\_campus\_automation\_workflow\_manager'. Verify input filters or configuration.", "response": {"message": "No configurations or components to process for module 'wired\_campus\_automation\_workflow\_manager'. Verify input filters or configuration.", "operation\_summary": {"devices\_with\_complete\_failure": [], "devices\_with\_complete\_success": [], "devices\_with\_partial\_success": [], "failure\_details": [], "success\_details": [], "total\_devices\_processed": 0, "total\_failed\_operations": 0, "total\_features\_processed": 0, "total\_successful\_operations": 0}}}`


      .. raw:: html

        </div>


  * - .. raw:: html

        <div class="ansible-option-cell">
        <div class="ansibleOptionAnchor" id="return-response_3"></div>

      .. _ansible_collections.cisco.catalystcenter.wired_campus_automation_playbook_config_generator_module__return-response_3:

      .. rst-class:: ansible-option-title

      **response_3**

      .. raw:: html

        <a class="ansibleOptionLink" href="#return-response_3" 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 with error details when YAML generation fails


      .. rst-class:: ansible-option-line

      :ansible-option-returned-bold:`Returned:` always

      .. rst-class:: ansible-option-line
      .. rst-class:: ansible-option-sample

      :ansible-option-sample-bold:`Sample:` :ansible-rv-sample-value:`{"msg": "YAML config generation failed for module 'wired\_campus\_automation\_workflow\_manager'.", "response": {"file\_path": "/tmp/wired\_campus\_automation\_config.yml", "message": "YAML config generation failed for module 'wired\_campus\_automation\_workflow\_manager'.", "operation\_summary": {"devices\_with\_complete\_failure": ["192.168.1.11"], "devices\_with\_complete\_success": [], "devices\_with\_partial\_success": ["192.168.1.10"], "failure\_details": [{"device\_id": "12345678-1234-1234-1234-123456789ghi", "device\_ip": "192.168.1.11", "error\_info": {"error\_code": "DEVICE\_UNREACHABLE", "error\_message": "Device is not reachable or not managed", "error\_type": "device\_unreachable"}, "feature": "vlans", "status": "failed"}], "success\_details": [], "total\_devices\_processed": 2, "total\_failed\_operations": 10, "total\_features\_processed": 20, "total\_successful\_operations": 10}}}`


      .. raw:: html

        </div>



..  Status (Presently only deprecated)


.. Authors

Authors
~~~~~~~

- Rugvedi Kapse (@rukapse)
- Vivek Raj (@vivekraj2000)
- Madhan Sankaranarayanan (@madhansansel)



.. Extra links

Collection links
~~~~~~~~~~~~~~~~

.. raw:: html

  <p class="ansible-links">
    <a href="https://github.com/cisco-en-programmability/catalystcenter-ansible/issues" aria-role="button" target="_blank" rel="noopener external">Issue Tracker</a>
    <a href="https://github.com/cisco-en-programmability/catalystcenter-ansible" aria-role="button" target="_blank" rel="noopener external">Repository (Sources)</a>
  </p>

.. Parsing errors