cisco.dnac.virtual_account_sync (2.0.7) — module

Install collection

Install with ansible-galaxy collection install cisco.dnac:==2.0.7

Add to requirements.yml

  collections:
    - name: cisco.dnac
      version: 2.0.7

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.

Requirements

• dnacentersdk

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- 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

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- 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

Inputs

    
name:
    description:
    - Virtual Account Name.
    - Required for state query.
    type: str

token:
    description:
    - SAVAMapping's token.
    type: str

domain:
    description:
    - Smart Account Domain.
    - Required for state query.
    type: str

expiry:
    description:
    - SAVAMapping's expiry.
    type: int

ccoUser:
    description:
    - SAVAMapping's ccoUser.
    type: str

profile:
    description:
    - SAVAMapping's profile.
    - Required for state create.
    suboptions:
      addressFqdn:
        description:
        - It is the virtual account sync's addressFqdn.
        type: str
      addressIpV4:
        description:
        - It is the virtual account sync's addressIpV4.
        type: str
      cert:
        description:
        - It is the virtual account sync's cert.
        type: str
      makeDefault:
        description:
        - It is the virtual account sync's makeDefault.
        type: bool
      name:
        description:
        - It is the virtual account sync's name.
        type: str
      port:
        description:
        - It is the virtual account sync's port.
        type: int
      profileId:
        description:
        - It is the virtual account sync's profileId.
        type: str
      proxy:
        description:
        - It is the virtual account sync's proxy.
        type: bool
    type: dict

lastSync:
    description:
    - SAVAMapping's lastSync.
    type: int

tenantId:
    description:
    - SAVAMapping's tenantId.
    type: str

syncResult:
    description:
    - SAVAMapping's syncResult.
    suboptions:
      syncList:
        description:
        - It is the virtual account sync's syncList.
        elements: dict
        suboptions:
          deviceSnList:
            description:
            - It is the virtual account sync's deviceSnList.
            type: list
          syncType:
            description:
            - It is the virtual account sync's syncType.
            type: str
        type: list
      syncMsg:
        description:
        - It is the virtual account sync's syncMsg.
        type: str
    type: dict

syncStatus:
    description:
    - SAVAMapping's syncStatus.
    - Available values are 'NOT_SYNCED', 'SYNCING', 'SUCCESS' and 'FAILURE'.
    - Required for state create.
    type: str

syncResultStr:
    description:
    - SAVAMapping's syncResultStr.
    type: str

syncStartTime:
    description:
    - SAVAMapping's syncStartTime.
    type: int

autoSyncPeriod:
    description:
    - SAVAMapping's autoSyncPeriod.
    type: int

smartAccountId:
    description:
    - SAVAMapping's smartAccountId.
    - Required for state create.
    type: str

virtualAccountId:
    description:
    - SAVAMapping's virtualAccountId.
    - Required for state create.
    type: str

Outputs

dnac_response:
  description: A dictionary with the response returned by the DNA Center Python SDK
  returned: always
  sample:
    response: 29
    version: '1.0'
  type: dict
missing_params:
  description: Provided arguments do not comply with the schema of the DNA Center
    Python SDK function
  returned: when the function request schema is not satisfied
  sample: null
  type: list
sdk_function:
  description: The DNA Center SDK function used to execute the task
  returned: always
  sample: device_onboarding_pnp.get_sync_result_for_virtual_account
  type: str

See also

• cisco.dnac.plugins.module_utils.definitions.virtual_account_sync
• VirtualAccountSync reference: Complete reference of the VirtualAccountSync object model. link
• VirtualAccountSync reference: SDK reference. link