.. Document meta :orphan: .. |antsibull-internal-nbsp| unicode:: 0xA0 :trim: .. role:: ansible-attribute-support-label .. role:: ansible-attribute-support-property .. role:: ansible-attribute-support-full .. role:: ansible-attribute-support-partial .. role:: ansible-attribute-support-none .. role:: ansible-attribute-support-na .. Anchors .. _ansible_collections.cisco.dnac.pnp_virtual_account_devices_sync_module: .. Anchors: short name for ansible.builtin .. Anchors: aliases .. Title cisco.dnac.pnp_virtual_account_devices_sync -- Resource module for Pnp Virtual Account Devices Sync +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. Collection note .. note:: This plugin is part of the `cisco.dnac collection `_ (version 3.2.3). 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 :code:`ansible-galaxy collection list`. To install it, use: :code:`ansible-galaxy collection install cisco.dnac`. To use it in a playbook, specify: :code:`cisco.dnac.pnp_virtual_account_devices_sync`. .. version_added .. versionadded:: 3.1.0 of cisco.dnac .. contents:: :local: :depth: 1 .. Deprecated Synopsis -------- .. Description - Manage operation create of the resource Pnp Virtual Account Devices Sync. .. 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 >= 2.3.3 - python >= 3.5 .. Options Parameters ---------- .. raw:: html
Parameter Choices/Defaults Comments
autoSyncPeriod
integer
Pnp Virtual Account Devices Sync's autoSyncPeriod.
ccoUser
string
Pnp Virtual Account Devices Sync's ccoUser.
dnac_debug
boolean
    Choices:
  • no ←
  • yes
Flag for Cisco DNA Center SDK to enable debugging.
dnac_host
string / required
The Cisco DNA Center hostname.
dnac_password
string
The Cisco DNA Center password to authenticate.
dnac_port
string
Default:
443
The Cisco DNA Center port.
dnac_username
string
Default:
"admin"
The Cisco DNA Center username to authenticate.

aliases: user
dnac_verify
boolean
    Choices:
  • no
  • yes ←
Flag to enable or disable SSL certificate verification.
dnac_version
string
Default:
"2.2.2.3"
Informs the SDK which version of Cisco DNA Center to use.
expiry
integer
Pnp Virtual Account Devices Sync's expiry.
lastSync
integer
Pnp Virtual Account Devices Sync's lastSync.
profile
dictionary
Pnp Virtual Account Devices Sync's profile.
addressFqdn
string
Pnp Virtual Account Devices Sync's addressFqdn.
addressIpV4
string
Pnp Virtual Account Devices Sync's addressIpV4.
cert
string
Pnp Virtual Account Devices Sync's cert.
makeDefault
boolean
    Choices:
  • no
  • yes
MakeDefault flag.
name
string
Pnp Virtual Account Devices Sync's name.
port
integer
Pnp Virtual Account Devices Sync's port.
profileId
string
Pnp Virtual Account Devices Sync's profileId.
proxy
boolean
    Choices:
  • no
  • yes
Proxy flag.
smartAccountId
string
Pnp Virtual Account Devices Sync's smartAccountId.
syncResult
dictionary
Pnp Virtual Account Devices Sync's syncResult.
syncList
list / elements=string
Pnp Virtual Account Devices Sync's syncList.
deviceSnList
list / elements=string
Pnp Virtual Account Devices Sync's deviceSnList.
syncType
string
Pnp Virtual Account Devices Sync's syncType.
syncMsg
string
Pnp Virtual Account Devices Sync's syncMsg.
syncResultStr
string
Pnp Virtual Account Devices Sync's syncResultStr.
syncStartTime
integer
Pnp Virtual Account Devices Sync's syncStartTime.
syncStatus
string
Pnp Virtual Account Devices Sync's syncStatus.
tenantId
string
Pnp Virtual Account Devices Sync's tenantId.
token
string
Pnp Virtual Account Devices Sync's token.
validate_response_schema
boolean
    Choices:
  • no
  • yes ←
Flag for Cisco DNA Center SDK to enable the validation of request bodies against a JSON schema.
virtualAccountId
string
Pnp Virtual Account Devices Sync's virtualAccountId.

.. Attributes .. Notes Notes ----- .. note:: - 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 .. Seealso See Also -------- .. seealso:: `Pnp Virtual Account Devices Sync reference `_ Complete reference of the Pnp Virtual Account Devices Sync object model. .. Examples Examples -------- .. code-block:: yaml+jinja - 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 .. 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 or list with the response returned by the Cisco DNAC Python SDK

Sample:
{ "virtualAccountId": "string", "autoSyncPeriod": 0, "syncResultStr": "string", "profile": { "proxy": true, "makeDefault": true, "port": 0, "profileId": "string", "name": "string", "addressIpV4": "string", "cert": "string", "addressFqdn": "string" }, "ccoUser": "string", "syncResult": { "syncList": [ { "syncType": "string", "deviceSnList": [ "string" ] } ], "syncMsg": "string" }, "token": "string", "syncStartTime": 0, "lastSync": 0, "tenantId": "string", "smartAccountId": "string", "expiry": 0, "syncStatus": "string" }


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