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.
Parameters¶
Parameter | Choices/Defaults | Comments |
---|---|---|
force_sync
boolean
|
|
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:
Authors¶
Rafael Campos (@racampos)