.. Document meta :orphan: .. Anchors .. _ansible_collections.cisco.dnac.virtual_account_sync_module: .. Anchors: short name for ansible.builtin .. Anchors: aliases .. Title cisco.dnac.virtual_account_sync -- Manage VirtualAccountSync objects of DeviceOnboardingPnp +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. Collection note .. note:: This plugin is part of the `cisco.dnac collection `_ (version 2.0.7). To install it use: :code:`ansible-galaxy collection install cisco.dnac`. To use it in a playbook, specify: :code:`cisco.dnac.virtual_account_sync`. .. version_added .. versionadded:: 1.0.0 of cisco.dnac .. contents:: :local: :depth: 1 .. Deprecated Synopsis -------- .. Description - Synchronizes the device info from the given smart account & virtual account with the PnP database. The response payload returns a list of synced devices. - Returns the summary of devices synced from the given smart account & virtual account with PnP. .. note:: This module has a corresponding :ref:`action plugin `. .. Aliases .. Requirements Requirements ------------ The below requirements are needed on the host that executes this module. - dnacentersdk .. Options Parameters ---------- .. raw:: html

Parameter			Choices/Defaults	Comments
autoSyncPeriod integer				SAVAMapping's autoSyncPeriod.
ccoUser string				SAVAMapping's ccoUser.
domain string				Smart Account Domain. Required for state query.
expiry integer				SAVAMapping's expiry.
lastSync integer				SAVAMapping's lastSync.
name string				Virtual Account Name. Required for state query.
profile dictionary				SAVAMapping's profile. Required for state create.
	addressFqdn string			It is the virtual account sync's addressFqdn.
	addressIpV4 string			It is the virtual account sync's addressIpV4.
	cert string			It is the virtual account sync's cert.
	makeDefault boolean		Choices: no yes	It is the virtual account sync's makeDefault.
	name string			It is the virtual account sync's name.
	port integer			It is the virtual account sync's port.
	profileId string			It is the virtual account sync's profileId.
	proxy boolean		Choices: no yes	It is the virtual account sync's proxy.
smartAccountId string				SAVAMapping's smartAccountId. Required for state create.
syncResult dictionary				SAVAMapping's syncResult.
	syncList list / elements=dictionary			It is the virtual account sync's syncList.
		deviceSnList list / elements=string		It is the virtual account sync's deviceSnList.
		syncType string		It is the virtual account sync's syncType.
	syncMsg string			It is the virtual account sync's syncMsg.
syncResultStr string				SAVAMapping's syncResultStr.
syncStartTime integer				SAVAMapping's syncStartTime.
syncStatus string				SAVAMapping's syncStatus. Available values are 'NOT_SYNCED', 'SYNCING', 'SUCCESS' and 'FAILURE'. Required for state create.
tenantId string				SAVAMapping's tenantId.
token string				SAVAMapping's token.
virtualAccountId string				SAVAMapping's virtualAccountId. Required for state create.

.. Notes .. Seealso See Also -------- .. seealso:: :ref:`cisco.dnac.plugins.module_utils.definitions.virtual_account_sync ` The official documentation on the **cisco.dnac.plugins.module_utils.definitions.virtual_account_sync** module. `VirtualAccountSync reference `_ Complete reference of the VirtualAccountSync object model. `VirtualAccountSync reference `_ SDK reference. .. Examples Examples -------- .. code-block:: yaml+jinja - name: sync_virtual_account_devices cisco.dnac.virtual_account_sync: state: create # required profile: # required addressFqdn: SomeValue # string addressIpV4: SomeValue # string cert: SomeValue # string makeDefault: True # boolean name: SomeValue # string port: 1 # integer profileId: SomeValue # string proxy: True # boolean smartAccountId: SomeValue # string, required syncStatus: # valid values are 'NOT_SYNCED', # 'SYNCING', # 'SUCCESS', # 'FAILURE'. SomeValue # string, required virtualAccountId: SomeValue # string, required autoSyncPeriod: 1 # integer ccoUser: SomeValue # string expiry: 1 # integer lastSync: 1 # integer syncResult: syncList: - deviceSnList: - SomeValue # string syncType: SomeValue # string syncMsg: SomeValue # string syncResultStr: SomeValue # string syncStartTime: 1 # integer tenantId: SomeValue # string token: SomeValue # string - name: get_sync_result_for_virtual_account cisco.dnac.virtual_account_sync: state: query # required domain: SomeValue # string, required name: SomeValue # string, required register: nm_get_sync_result_for_virtual_account .. Facts .. Return values Return Values ------------- Common return values are documented :ref:`here `, the following are the fields unique to this module: .. raw:: html

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: device_onboarding_pnp.get_sync_result_for_virtual_account

.. Status (Presently only deprecated) .. Authors Authors ~~~~~~~ - Rafael Campos (@racampos) .. Parsing errors