cisco.dnac.network_device_sync – Manage NetworkDeviceSync 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_sync.

New in version 1.0.0: of cisco.dnac

Synopsis

  • Synchronizes the devices. If forceSync param is false (default) then the sync would run in normal priority thread. If forceSync param is true then the sync would run in high priority thread if available, else the sync will fail. Result can be seen in the child task of each device.

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
force_sync
boolean
    Choices:
  • no
  • yes
ForceSync query parameter.
payload
list / elements=string / required
An object to send in the Request body.

See Also

See also

cisco.dnac.plugins.module_utils.definitions.network_device_sync

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

NetworkDeviceSync reference

Complete reference of the NetworkDeviceSync object model.

NetworkDeviceSync reference

SDK reference.

Examples

- name: sync_devices_using_forcesync
  cisco.dnac.network_device_sync:
    state: update  # required
    payload: None, required
    force_sync: True  # boolean

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


Authors

  • Rafael Campos (@racampos)