cisco.dnac.pnp_intent module – Resource module for Site and PnP related functions

Note

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

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_intent.

New in cisco.dnac 6.6.0

Synopsis

• Manage operations add device, claim device and unclaim device of Onboarding Configuration(PnP) resource

• API to add device to pnp inventory and claim it to a site.

• API to delete device from the pnp inventory.

• API to reset the device from errored state.

Requirements

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

• dnacentersdk == 2.6.10

• python >= 3.5

Parameters

Parameter	Comments
config list / elements=dictionary / required	List of details of device being managed.
device_info list / elements=dictionary / required	Pnp Device’s device_info. This is mainly for adding the devices that are not a part of the PnP database. For single addition the length of the list must be equal to one. Followed by single addition a device can be claimed as well if site name is provided. For Bulk Import of devices the size of the list must be greater than 1 and can be only used for adding. For claiming the devices please use separate tasks or configs in the case of bulk import.
hostname string	Pnp Device’s hostname that we want to keep post claiming. Hostname can only be changed during claiming not bulk adding/ single adding
is_sudi_required boolean	Sudi Authentication requiremnet’s flag. Choices: :ansible-option-choices-entry:`false` :ansible-option-choices-entry:`true`
pid string	Pnp Device’s pid.
serial_number string	Pnp Device’s serial_number.
state string	Pnp Device’s onbording state (Unclaimed/Claimed/Provisioned).
gateway string	Gateway IP address of the Wireless Controller for getting pinged
golden_image boolean	Is the image to be condifgured tagged as golden image Choices: :ansible-option-choices-entry:`false` :ansible-option-choices-entry:`true`
image_name string	Name of image to be configured on the device
ip_interface_name string	Name of the Interface used for Pnp by the Wireless Controller
pnp_type string	Device type of the Pnp device (Default/catalyst_wlc/access_point/stack_switch) Default: :ansible-option-default:`"Default"`
project_name string	Name of the project under which the template is present Default: :ansible-option-default:`"Onboarding Configuration"`
rf_profile string	Radio frequecy profile of the AP being claimed (HIGH/LOW/TYPICAL)
site_name string	Name of the site for which device will be claimed.
static_ip string	Management IP address of the Wireless Controller
subnet_mask string	Subnet Mask of the Management IP address of the Wireless Controller
template_name string	Name of template to be configured on the device.
template_params dictionary	Parameter values for the parameterised templates. Each varibale has a value that needs to be passed as key-value pair in the dictionary. We can pass values as variable_name:variable_value.
vlan_id string	Vlan Id allocated for claimimg of Wireless Controller
config_verify boolean	Set to True to verify the Cisco DNA Center config after applying the playbook config. Choices: :ansible-option-choices-entry-default:`false` ← (default) :ansible-option-choices-entry:`true`
dnac_debug boolean	Flag for Cisco DNA Center SDK to enable debugging. Choices: :ansible-option-choices-entry-default:`false` ← (default) :ansible-option-choices-entry:`true`
dnac_host string / required	The Cisco DNA Center hostname.
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: :ansible-option-choices-entry-default:`false` ← (default) :ansible-option-choices-entry:`true`
dnac_log_append boolean	Determines the mode of the file. Set to True for ‘append’ mode. Set to False for ‘write’ mode. Choices: :ansible-option-choices-entry:`false` :ansible-option-choices-entry-default:`true` ← (default)
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 Cisco DNA Center password to authenticate.
dnac_port string	The Cisco DNA Center port. Default: :ansible-option-default:`"443"`
dnac_username aliases: user string	The Cisco DNA Center username to authenticate. Default: :ansible-option-default:`"admin"`
dnac_verify boolean	Flag to enable or disable SSL certificate verification. Choices: :ansible-option-choices-entry:`false` :ansible-option-choices-entry-default:`true` ← (default)
dnac_version string	Informs the SDK which version of Cisco DNA Center to use. Default: :ansible-option-default:`"2.2.3.3"`
state string	The state of DNAC after module completion. Choices: :ansible-option-choices-entry-default:`"merged"` ← (default) :ansible-option-choices-entry:`"deleted"`
validate_response_schema boolean	Flag for Cisco DNA Center SDK to enable the validation of request bodies against a JSON schema. Choices: :ansible-option-choices-entry:`false` :ansible-option-choices-entry-default:`true` ← (default)

Notes

Note

• SDK Method used are device_onboarding_pnp.DeviceOnboardingPnp.add_device, device_onboarding_pnp.DeviceOnboardingPnp.get_device_list, device_onboarding_pnp.DeviceOnboardingPnp.claim_a_device_to_a_site, device_onboarding_pnp.DeviceOnboardingPnp.delete_device_by_id_from_pnp, device_onboarding_pnp.DeviceOnboardingPnp.get_device_count, device_onboarding_pnp.DeviceOnboardingPnp.get_device_by_id, device_onboarding_pnp.DeviceOnboardingPnp.update_device, sites.Sites.get_site, software_image_management_swim.SoftwareImageManagementSwim.get_software_image_details, configuration_templates.ConfigurationTemplates.gets_the_templates_available

• Paths used are post /dna/intent/api/v1/onboarding/pnp-device post /dna/intent/api/v1/onboarding/pnp-device/site-claim post /dna/intent/api/v1/onboarding/pnp-device/{id} get /dna/intent/api/v1/onboarding/pnp-device/count get /dna/intent/api/v1/onboarding/pnp-device put /onboarding/pnp-device/${id} get /dna/intent/api/v1/site get /dna/intent/api/v1/image/importation get /dna/intent/api/v1/template-programmer/template

• Does not support check_mode

• The plugin runs on the control node and does not use any ansible connection plugins, but instead the embedded connection manager from Cisco DNAC SDK

• The parameters starting with dnac_ are used by the Cisco DNAC Python SDK to establish the connection

Examples

- name: Add a new device and claim the device
  cisco.dnac.pnp_intent:
    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: merged
    config_verify: True
    config:
        - template_name: string
          image_name: string
          golden_image: bool
          site_name: string
          project_name: string
          pnp_type: string
          static_ip: string
          subnet_mask: string
          gateway: string
          vlan_id: string
          ip_interface_name: string
          rf_profile: string
          device_info:
            - hostname: string
              state: string
              pid: string
              serial_number: string
              add_device_method: string
              is_sudi_required: string

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 DNAC Python SDK Returned: always Sample: :ansible-rv-sample-value:`"{\\n \\"response\\":\\n {\\n \\"response\\": String,\\n \\"version\\": String\\n },\\n \\"msg\\": String\\n}\\n"`
response_2 list / elements=string	A list with the response returned by the Cisco DNAC Python SDK Returned: always Sample: :ansible-rv-sample-value:`["{\\n \\"response\\": []", "\\n \\"msg\\": String\\n}\\n"]`
response_3 dictionary	A string with the response returned by the Cisco DNAC Python SDK Returned: always Sample: :ansible-rv-sample-value:`"{\\n \\"response\\": String,\\n \\"msg\\": String\\n}\\n"`

Authors

• Madhan Sankaranarayanan (@madhansansel) Rishita Chowdhary (@rishitachowdhary) Abinash Mishra (@abimishr)

Collection links

Issue Tracker Repository (Sources)