cisco.dnac.inventory_playbook_config_generator module -- Generate YAML playbook for inventory_workflow_manager module.

Note

This module is part of the cisco.dnac collection (version 6.51.0).

To install it, use: ansible-galaxy collection install cisco.dnac. You need further requirements to be able to use this module, see Requirements for details.

To use it in a playbook, specify: cisco.dnac.inventory_playbook_config_generator.

New in cisco.dnac 6.44.0

Synopsis

  • Generates YAML configurations compatible with the inventory_workflow_manager module, reducing the effort required to manually create Ansible playbooks and enabling programmatic modifications.

  • The YAML configurations generated represent the inventory configurations configured on the Cisco Catalyst Center.

Requirements

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

  • dnacentersdk >= 2.7.2

  • python >= 3.9

Parameters

Parameter

Comments

config

dictionary

A dictionary of filters for generating YAML playbook compatible with the inventory_workflow_manager module.

If config is not provided (omitted entirely), all configurations for all inventory devices will be generated.

This is useful for complete brownfield infrastructure discovery and documentation.

Important - An empty dictionary {} is not valid. Either omit 'config' entirely to generate all configurations, or provide specific filters within 'config'.

global_filters

dictionary

Global filters used to filter inventory data.

Multiple filters under global_filters are combined using logical AND.

At least one supported global filter must be provided when using global_filters.

Unknown keys fail validation with an error.

device_identifier

string

Identifier used to build the generated list key in output config.

The output key is written as <device_identifier>_list.

Choices:

device_roles

list / elements=string

List of inventory device roles to include.

Supported values are ACCESS, DISTRIBUTION, CORE, BORDER ROUTER, and UNKNOWN.

Choices:

devices

list / elements=string

List of device identifier values to filter inventory records.

You can provide one or more values from ip_address, hostname, serial_number, or mac_address, and the module matches each value against these identifier fields.

dnac_api_task_timeout

integer

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.

Default: :ansible-option-default:`1200`

dnac_debug

boolean

Indicates whether debugging is enabled in the Cisco Catalyst Center SDK.

Choices:

dnac_host

string / required

The hostname of the Cisco Catalyst Center.

dnac_log

boolean

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.

Choices:

dnac_log_append

boolean

Determines the mode of the file. Set to True for 'append' mode. Set to False for 'write' mode.

Choices:

dnac_log_file_path

string

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.

Default: :ansible-option-default:`"dnac.log"`

dnac_log_level

string

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.

Default: :ansible-option-default:`"WARNING"`

dnac_password

string

The password for authentication at the Cisco Catalyst Center.

dnac_port

string

Specifies the port number associated with the Cisco Catalyst Center.

Default: :ansible-option-default:`"443"`

dnac_task_poll_interval

integer

Specifies the interval in seconds between successive calls to the API to retrieve task details.

Default: :ansible-option-default:`2`

dnac_username

aliases: user

string

The username for authentication at the Cisco Catalyst Center.

Default: :ansible-option-default:`"admin"`

dnac_verify

boolean

Flag to enable or disable SSL certificate verification.

Choices:

dnac_version

string

Specifies the version of the Cisco Catalyst Center that the SDK should use.

Default: :ansible-option-default:`"2.2.3.3"`

file_mode

string

Controls how config is written to the YAML file.

overwrite replaces existing file content.

append appends generated YAML content to the existing file.

This parameter is only relevant when file_path is specified. Defaults to overwrite.

Choices:

file_path

string

Path where the YAML configuration file will be saved.

If not provided, the file will be saved in the current working directory with a default file name inventory_playbook_config_<YYYY-MM-DD_HH-MM-SS>.yml.

For example, inventory_playbook_config_2026-02-20_13-34-58.yml.

state

string

The desired state of Cisco Catalyst Center after module execution.

Choices:

validate_response_schema

boolean

Flag for Cisco Catalyst Center SDK to enable the validation of request bodies against a JSON schema.

Choices:

Notes

Note

  • Cisco Catalyst Center >= 2.3.7.9

  • SDK Methods used are devices.Devices.get_device_list

  • SDK/REST Paths used are GET /dna/intent/api/v1/network-device

  • Auto-discovery mode: When config is omitted entirely, the module runs in auto-discovery mode and generates inventory configuration for all discovered devices without applying filters.

  • Filter behavior: When config.global_filters is provided, devices and device_roles are applied with AND semantics. Unknown global filter keys fail validation with an error.

  • Module result behavior (changed/ok/failed): The module result reflects local file state only, not Catalyst Center state. In overwrite mode, generated YAML is compared against existing file content after excluding generated comment lines. In append mode, only the last YAML document is considered for idempotency check. - changed=true (status: success): Generated configuration differs (or file does not exist), and file is written. - changed=false (status: ok): Generated configuration matches existing content, so write is skipped. - failed=true (status: failed): Validation/API/file-write failure occurred.

  • Does not support 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

See Also

See also

cisco.dnac.inventory_workflow_manager

Module for managing inventory settings and workflows.

Examples

- name: Auto-generate YAML Configuration for all inventory devices
  cisco.dnac.inventory_playbook_config_generator:
    dnac_host: "{{ dnac_host }}"
    dnac_username: "{{ dnac_username }}"
    dnac_password: "{{ dnac_password }}"
    dnac_verify: "{{ dnac_verify }}"
    dnac_port: "{{ dnac_port }}"
    dnac_version: "{{ dnac_version }}"
    dnac_debug: "{{ dnac_debug }}"
    dnac_log_level: "{{ dnac_log_level }}"
    dnac_log: true
    state: gathered
    # No config provided - generates all inventory configurations

- name: Generate YAML Configuration with file path and overwrite mode
  cisco.dnac.inventory_playbook_config_generator:
    dnac_host: "{{ dnac_host }}"
    dnac_username: "{{ dnac_username }}"
    dnac_password: "{{ dnac_password }}"
    dnac_verify: "{{ dnac_verify }}"
    dnac_port: "{{ dnac_port }}"
    dnac_version: "{{ dnac_version }}"
    dnac_debug: "{{ dnac_debug }}"
    dnac_log_level: "{{ dnac_log_level }}"
    dnac_log: true
    state: gathered
    file_path: "tmp/catc_inventory_config.yml"
    file_mode: "overwrite"

- name: Generate YAML Configuration filtered by device roles
  cisco.dnac.inventory_playbook_config_generator:
    dnac_host: "{{ dnac_host }}"
    dnac_username: "{{ dnac_username }}"
    dnac_password: "{{ dnac_password }}"
    dnac_verify: "{{ dnac_verify }}"
    dnac_port: "{{ dnac_port }}"
    dnac_version: "{{ dnac_version }}"
    dnac_debug: "{{ dnac_debug }}"
    dnac_log_level: "{{ dnac_log_level }}"
    dnac_log: true
    state: gathered
    file_path: "tmp/catc_filtered_inventory_config.yml"
    file_mode: "overwrite"
    config:
      global_filters:
        device_roles: ["ACCESS", "CORE"]
        device_identifier: "hostname"

- name: Generate YAML Configuration for selected devices using serial number and IP
  cisco.dnac.inventory_playbook_config_generator:
    dnac_host: "{{ dnac_host }}"
    dnac_username: "{{ dnac_username }}"
    dnac_password: "{{ dnac_password }}"
    dnac_verify: "{{ dnac_verify }}"
    dnac_port: "{{ dnac_port }}"
    dnac_version: "{{ dnac_version }}"
    dnac_debug: "{{ dnac_debug }}"
    dnac_log_level: "{{ dnac_log_level }}"
    dnac_log: true
    state: gathered
    file_path: "tmp/catc_inventory_config.yml"
    file_mode: "append"
    config:
      global_filters:
        devices:
          - "10.10.20.11"
          - "FDO1234A1BC"

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key

Description

response_1

dictionary

A dictionary with the response returned by the Cisco Catalyst Center Python SDK

Returned: always

Sample: :ansible-rv-sample-value:`{"msg": {"configurations\_count": 31, "file\_mode": "overwrite", "file\_path": "tmp/inventory\_testing.yml", "message": "YAML configuration file generated successfully for module 'inventory\_workflow\_manager'", "status": "success"}, "response": {"configurations\_count": 31, "file\_mode": "overwrite", "file\_path": "tmp/inventory\_testing.yml", "message": "YAML configuration file generated successfully for module 'inventory\_workflow\_manager'", "status": "success"}, "status": "success"}`

response_2

dictionary

A string with the response returned by the Cisco Catalyst Center Python SDK

Returned: always

Sample: :ansible-rv-sample-value:`"{\\n \\"msg\\":\\n \\"Configuration cannot be an empty dictionary. Either omit 'config' entirely to generate all configurations,\\n or provide specific filters within 'config'.\\",\\n \\"response\\":\\n \\"Configuration cannot be an empty dictionary. Either omit 'config' entirely to generate all configurations,\\n or provide specific filters within 'config'.\\"\\n}\\n"`

Authors

  • Mridul Saurabh (@msaurabh12)

  • Sunil Shatagopa (@shatagopasunil)

  • Madhan Sankaranarayanan (@madhansansel)