cisco.dnac.pnp_virtual_account_devices_sync module – Resource module for Pnp Virtual Account Devices Sync
Note
This module is part of the cisco.dnac collection (version 6.18.0).
You might already have this collection installed if you are using the ansible
package.
It is not included in ansible-core
.
To check whether it is installed, run ansible-galaxy collection list
.
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_virtual_account_devices_sync
.
New in cisco.dnac 3.1.0
Synopsis
Manage operation create of the resource Pnp Virtual Account Devices Sync.
Synchronizes the device info from the given smart account & virtual account with the PnP database. The response payload returns a list of synced devices Deprecated .
Note
This module has a corresponding action plugin.
Requirements
The below requirements are needed on the host that executes this module.
dnacentersdk >= 2.7.2
python >= 3.5
Parameters
Parameter |
Comments |
---|---|
Pnp Virtual Account Devices Sync’s autoSyncPeriod. |
|
Pnp Virtual Account Devices Sync’s ccoUser. |
|
Flag for Cisco DNA Center SDK to enable debugging. Choices:
|
|
The Cisco DNA Center hostname. |
|
The Cisco DNA Center password to authenticate. |
|
The Cisco DNA Center port. Default: |
|
The Cisco DNA Center username to authenticate. Default: |
|
Flag to enable or disable SSL certificate verification. Choices:
|
|
Informs the SDK which version of Cisco DNA Center to use. Default: |
|
Pnp Virtual Account Devices Sync’s expiry. |
|
Pnp Virtual Account Devices Sync’s lastSync. |
|
Pnp Virtual Account Devices Sync’s profile. |
|
Pnp Virtual Account Devices Sync’s addressFqdn. |
|
Pnp Virtual Account Devices Sync’s addressIpV4. |
|
Pnp Virtual Account Devices Sync’s cert. |
|
MakeDefault flag. Choices:
|
|
Pnp Virtual Account Devices Sync’s name. |
|
Pnp Virtual Account Devices Sync’s port. |
|
Pnp Virtual Account Devices Sync’s profileId. |
|
Proxy flag. Choices:
|
|
Pnp Virtual Account Devices Sync’s smartAccountId. |
|
Pnp Virtual Account Devices Sync’s syncResult. |
|
Pnp Virtual Account Devices Sync’s syncList. |
|
Pnp Virtual Account Devices Sync’s deviceSnList. |
|
Pnp Virtual Account Devices Sync’s syncType. |
|
Pnp Virtual Account Devices Sync’s syncMsg. |
|
Pnp Virtual Account Devices Sync’s syncResultStr. |
|
Pnp Virtual Account Devices Sync’s syncStartTime. |
|
Pnp Virtual Account Devices Sync’s syncStatus. |
|
Pnp Virtual Account Devices Sync’s tenantId. |
|
Pnp Virtual Account Devices Sync’s token. |
|
Flag for Cisco DNA Center SDK to enable the validation of request bodies against a JSON schema. Choices:
|
|
Pnp Virtual Account Devices Sync’s virtualAccountId. |
Notes
Note
SDK Method used are device_onboarding_pnp.DeviceOnboardingPnp.sync_virtual_account_devices,
Paths used are post /dna/intent/api/v1/onboarding/pnp-device/vacct-sync,
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
See Also
See also
- Cisco DNA Center documentation for Device Onboarding (PnP) SyncVirtualAccountDevices
Complete reference of the SyncVirtualAccountDevices API.
Examples
- name: Create
cisco.dnac.pnp_virtual_account_devices_sync:
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}}"
autoSyncPeriod: 0
ccoUser: string
expiry: 0
lastSync: 0
profile:
addressFqdn: string
addressIpV4: string
cert: string
makeDefault: true
name: string
port: 0
profileId: string
proxy: true
smartAccountId: string
syncResult:
syncList:
- deviceSnList:
- string
syncType: string
syncMsg: string
syncResultStr: string
syncStartTime: 0
syncStatus: string
tenantId: string
token: string
virtualAccountId: string
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
A dictionary or list with the response returned by the Cisco DNAC Python SDK Returned: always Sample: |