cisco.dnac.network_device_config – Manage NetworkDeviceConfig objects of Devices

Note

This plugin is part of the cisco.dnac collection (version 2.0.7).

To install it use: ansible-galaxy collection install cisco.dnac.

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

New in version 1.0.0: of cisco.dnac

Synopsis

  • Returns the config for all devices.

  • Returns the count of device configs.

Note

This module has a corresponding action plugin.

Requirements

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

  • dnacentersdk

Parameters

Parameter Choices/Defaults Comments
count
boolean / required
    Choices:
  • no
  • yes
If true gets the number of objects.

See Also

See also

cisco.dnac.plugins.module_utils.definitions.network_device_config

The official documentation on the cisco.dnac.plugins.module_utils.definitions.network_device_config module.

NetworkDeviceConfig reference

Complete reference of the NetworkDeviceConfig object model.

NetworkDeviceConfig reference

SDK reference.

Examples

- name: get_device_config_for_all_devices
  cisco.dnac.network_device_config:
    state: query  # required
  register: nm_get_device_config_for_all_devices

- name: get_device_config_count
  cisco.dnac.network_device_config:
    state: query  # required
    count: True  # boolean, required
  register: nm_get_device_config_count

Return Values

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

Key Returned Description
dnac_response
dictionary
always
A dictionary with the response returned by the DNA Center Python SDK

Sample:
{'response': 29, 'version': '1.0'}
missing_params
list / elements=string
when the function request schema is not satisfied
Provided arguments do not comply with the schema of the DNA Center Python SDK function
sdk_function
string
always
The DNA Center SDK function used to execute the task

Sample:
devices.get_device_config_count


Authors

  • Rafael Campos (@racampos)