cisco.dnac.pnp_playbook_config_generator module -- Generate YAML playbook for PnP workflow with device information
Note
This module is part of the cisco.dnac collection (version 6.49.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.pnp_playbook_config_generator.
New in cisco.dnac 6.40.0
Synopsis
Generates YAML configurations compatible with the pnp_workflow_manager module for brownfield infrastructure discovery and documentation.
Retrieves existing PnP device information from Cisco Catalyst Center PnP inventory including serial numbers, hostnames, device states, product IDs, and SUDI requirements.
Transforms API responses to playbook-compatible YAML format with parameter name mapping and structure optimization for Ansible execution.
Supports device state filtering for targeted device discovery.
Enables automated brownfield discovery by retrieving all registered PnP devices when
configis omitted.Creates structured playbook files ready for modification and redeployment through pnp_workflow_manager module.
Extracts essential device attributes without site assignments, templates, projects, or advanced configuration parameters.
Supports extraction of both claimed and unclaimed devices across all PnP workflow states.
Requirements
The below requirements are needed on the host that executes this module.
dnacentersdk >= 2.9.3
python >= 3.9
Parameters
Parameter |
Comments |
|---|---|
Configuration dictionary controlling PnP filter behavior. When provided, at least one of To retrieve all PnP devices, omit |
|
Filter configuration controlling which components are included in generated YAML playbook. Currently supports only 'device_info' component for basic device information extraction. Must include |
|
List of component types to include in generated YAML playbook file. Only 'device_info' component is currently supported for extracting basic device information. Device info includes serial_number, hostname, state, pid, is_sudi_required, and authorize fields. Order of components in list determines order in generated YAML playbook structure. Choices: |
|
Global filters to apply across PnP device extraction. Currently supports filtering by device state only. |
|
Filter devices by their current PnP workflow state. Valid states represent different stages in PnP device lifecycle. Multiple states can be specified to include devices in any of the listed states. When not specified, devices in all states are included in generated configuration. State filtering applied at API level for efficient data retrieval. Choices: |
|
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` |
|
Indicates whether debugging is enabled in the Cisco Catalyst Center SDK. Choices: |
|
The hostname of the Cisco Catalyst Center. |
|
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: |
|
Determines the mode of the file. Set to True for 'append' mode. Set to False for 'write' mode. Choices: |
|
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"` |
|
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"` |
|
The password for authentication at the Cisco Catalyst Center. |
|
Specifies the port number associated with the Cisco Catalyst Center. Default: :ansible-option-default:`"443"` |
|
Specifies the interval in seconds between successive calls to the API to retrieve task details. Default: :ansible-option-default:`2` |
|
The username for authentication at the Cisco Catalyst Center. Default: :ansible-option-default:`"admin"` |
|
Flag to enable or disable SSL certificate verification. Choices: |
|
Specifies the version of the Cisco Catalyst Center that the SDK should use. Default: :ansible-option-default:`"2.2.3.3"` |
|
Controls how generated YAML content is written when
|
|
Absolute or relative path where generated YAML configuration file will be saved. If not provided, file is saved in current working directory with auto-generated filename. |
|
Desired state for module execution controlling playbook generation workflow. Only 'gathered' state is supported for retrieving configurations from Catalyst Center. The 'gathered' state initiates device discovery, API calls, transformation, and YAML file generation. Choices: |
|
Flag for Cisco Catalyst Center SDK to enable the validation of request bodies against a JSON schema. Choices: |
Notes
Note
SDK Methods used are - device_onboarding_pnp.DeviceOnboardingPnp.get_device_list
Paths used are - GET /dna/intent/api/v1/onboarding/pnp-device
Minimum Catalyst Center version required is 2.3.7.9 for PnP device APIs.
Module performs read-only operations and does not modify Catalyst Center configurations.
Generated YAML files contain only device_info section with basic device attributes.
Site assignments, templates, projects, and advanced parameters are not included in output.
Module supports both check mode and normal execution mode with identical behavior.
Generated playbooks are compatible with pnp_workflow_manager module v6.40.0+.
Device transformation skips devices missing required fields (serial_number, pid).
Operation tracking includes success and failure details for all processed devices.
Device state defaults to "Unclaimed" when not provided by API response.
Authorization flag set to True when authOperation requires authorization.
Does not support
check_modeThe 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
Examples
- name: Generate basic device info for all PnP devices
cisco.dnac.pnp_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: true
dnac_log_level: "{{dnac_log_level}}"
state: gathered
file_path: "/tmp/pnp_device_info.yml"
- name: Generate device info with component filter
cisco.dnac.pnp_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: true
dnac_log_level: "{{dnac_log_level}}"
state: gathered
file_path: "/tmp/pnp_device_info.yml"
file_mode: append
config:
component_specific_filters:
components_list: ["device_info"]
- name: Generate device info for unclaimed devices only
cisco.dnac.pnp_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: true
dnac_log_level: "{{dnac_log_level}}"
state: gathered
file_path: "/tmp/unclaimed_device_info.yml"
config:
component_specific_filters:
components_list: ["device_info"]
global_filters:
device_state: ["Unclaimed"]
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
|---|---|
Successful device info YAML generation Returned: always |