/ home / cisco / cisco.dnac / 6.13.3 / module / pnp_virtual_account_devices_sync

cisco.dnac.pnp_virtual_account_devices_sync (6.13.3) — module

Resource module for Pnp Virtual Account Devices Sync

| "added in version" 3.1.0 of cisco.dnac"

Authors: Rafael Campos (@racampos)

This plugin has a corresponding action plugin.

Install collection

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

Add to requirements.yml

  collections:
    - name: cisco.dnac
      version: 6.13.3

Description

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.

Requirements

dnacentersdk >= 2.6.0
python >= 3.9

Usage examples

Scanned by Steampunk Spotter

- 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

Inputs

    
token:
    description: Pnp Virtual Account Devices Sync's token.
    type: str

expiry:
    description: Pnp Virtual Account Devices Sync's expiry.
    type: int

ccoUser:
    description: Pnp Virtual Account Devices Sync's ccoUser.
    type: str

profile:
    description: Pnp Virtual Account Devices Sync's profile.
    suboptions:
      addressFqdn:
        description: Pnp Virtual Account Devices Sync's addressFqdn.
        type: str
      addressIpV4:
        description: Pnp Virtual Account Devices Sync's addressIpV4.
        type: str
      cert:
        description: Pnp Virtual Account Devices Sync's cert.
        type: str
      makeDefault:
        description: MakeDefault flag.
        type: bool
      name:
        description: Pnp Virtual Account Devices Sync's name.
        type: str
      port:
        description: Pnp Virtual Account Devices Sync's port.
        type: int
      profileId:
        description: Pnp Virtual Account Devices Sync's profileId.
        type: str
      proxy:
        description: Proxy flag.
        type: bool
    type: dict

lastSync:
    description: Pnp Virtual Account Devices Sync's lastSync.
    type: int

tenantId:
    description: Pnp Virtual Account Devices Sync's tenantId.
    type: str

dnac_host:
    description:
    - The Cisco DNA Center hostname.
    required: true
    type: str

dnac_port:
    default: 443
    description:
    - The Cisco DNA Center port.
    type: int

dnac_debug:
    default: false
    description:
    - Flag for Cisco DNA Center SDK to enable debugging.
    type: bool

syncResult:
    description: Pnp Virtual Account Devices Sync's syncResult.
    suboptions:
      syncList:
        description: Pnp Virtual Account Devices Sync's syncList.
        elements: dict
        suboptions:
          deviceSnList:
            description: Pnp Virtual Account Devices Sync's deviceSnList.
            elements: str
            type: list
          syncType:
            description: Pnp Virtual Account Devices Sync's syncType.
            type: str
        type: list
      syncMsg:
        description: Pnp Virtual Account Devices Sync's syncMsg.
        type: str
    type: dict

syncStatus:
    description: Pnp Virtual Account Devices Sync's syncStatus.
    type: str

dnac_verify:
    default: true
    description:
    - Flag to enable or disable SSL certificate verification.
    type: bool

dnac_version:
    default: 2.3.5.3
    description:
    - Informs the SDK which version of Cisco DNA Center to use.
    type: str

dnac_password:
    description:
    - The Cisco DNA Center password to authenticate.
    type: str

dnac_username:
    aliases:
    - user
    default: admin
    description:
    - The Cisco DNA Center username to authenticate.
    type: str

syncResultStr:
    description: Pnp Virtual Account Devices Sync's syncResultStr.
    type: str

syncStartTime:
    description: Pnp Virtual Account Devices Sync's syncStartTime.
    type: int

autoSyncPeriod:
    description: Pnp Virtual Account Devices Sync's autoSyncPeriod.
    type: int

smartAccountId:
    description: Pnp Virtual Account Devices Sync's smartAccountId.
    type: str

virtualAccountId:
    description: Pnp Virtual Account Devices Sync's virtualAccountId.
    type: str

validate_response_schema:
    default: true
    description:
    - Flag for Cisco DNA Center SDK to enable the validation of request bodies against
      a JSON schema.
    type: bool

Outputs

dnac_response:
  description: A dictionary or list with the response returned by the Cisco DNAC Python
    SDK
  returned: always
  sample: "{\n  \"virtualAccountId\": \"string\",\n  \"autoSyncPeriod\": 0,\n  \"\
    syncResultStr\": \"string\",\n  \"profile\": {\n    \"proxy\": true,\n    \"makeDefault\"\
    : true,\n    \"port\": 0,\n    \"profileId\": \"string\",\n    \"name\": \"string\"\
    ,\n    \"addressIpV4\": \"string\",\n    \"cert\": \"string\",\n    \"addressFqdn\"\
    : \"string\"\n  },\n  \"ccoUser\": \"string\",\n  \"syncResult\": {\n    \"syncList\"\
    : [\n      {\n        \"syncType\": \"string\",\n        \"deviceSnList\": [\n\
    \          \"string\"\n        ]\n      }\n    ],\n    \"syncMsg\": \"string\"\
    \n  },\n  \"token\": \"string\",\n  \"syncStartTime\": 0,\n  \"lastSync\": 0,\n\
    \  \"tenantId\": \"string\",\n  \"smartAccountId\": \"string\",\n  \"expiry\"\
    : 0,\n  \"syncStatus\": \"string\"\n}\n"
  type: dict