cisco.dnac.pnp_virtual_account_devices_sync_v1 模块 – PnP 虚拟账户设备同步 V1 资源模块

注意

此模块是 cisco.dnac 集合 (版本 6.25.0) 的一部分。

如果您使用的是 ansible 包,则可能已经安装了此集合。它不包含在 ansible-core 中。要检查它是否已安装,请运行 ansible-galaxy collection list

要安装它,请使用: ansible-galaxy collection install cisco.dnac。您需要其他要求才能使用此模块,请参阅 需求 获取详细信息。

要在剧本中使用它,请指定: cisco.dnac.pnp_virtual_account_devices_sync_v1

cisco.dnac 3.1.0 中的新增功能

概要

  • 管理资源 PnP 虚拟账户设备同步 V1 的创建操作。

  • 将给定智能帐户和虚拟帐户中的设备信息与 PnP 数据库同步。响应有效负载返回已同步设备的列表(已弃用)。

注意

此模块具有相应的 操作插件

需求

执行此模块的主机需要以下需求。

  • dnacentersdk >= 2.4.9

  • python >= 3.5

参数

参数

注释

autoSyncPeriod

整数

PnP 虚拟账户设备同步的 autoSyncPeriod。

ccoUser

字符串

PnP 虚拟账户设备同步的 ccoUser。

dnac_debug

布尔值

用于 Cisco DNA Center SDK 以启用调试的标志。

选项

  • false ← (默认)

  • true

dnac_host

字符串 / 必需

Cisco DNA Center 主机名。

dnac_password

字符串

用于身份验证的 Cisco DNA Center 密码。

dnac_port

整数

Cisco DNA Center 端口。

默认值: 443

dnac_username

别名:user

字符串

用于身份验证的 Cisco DNA Center 用户名。

默认值: "admin"

dnac_verify

布尔值

启用或禁用 SSL 证书验证的标志。

选项

  • false

  • true ← (默认)

dnac_version

字符串

通知 SDK 使用哪个版本的 Cisco DNA Center。

默认值: "2.3.7.6"

expiry

整数

PnP 虚拟账户设备同步的 expiry。

lastSync

整数

PnP 虚拟账户设备同步的 lastSync。

profile

字典

PnP 虚拟账户设备同步的 profile。

addressFqdn

字符串

PnP 虚拟账户设备同步的 addressFqdn。

addressIpV4

字符串

PnP 虚拟账户设备同步的 addressIpV4。

cert

字符串

PnP 虚拟账户设备同步的 cert。

makeDefault

布尔值

MakeDefault 标志。

选项

  • false

  • true

name

字符串

PnP 虚拟账户设备同步的 name。

port

整数

PnP 虚拟账户设备同步的 port。

profileId

字符串

PnP 虚拟账户设备同步的 profileId。

proxy

布尔值

代理标志。

选项

  • false

  • true

smartAccountId

字符串

PnP 虚拟账户设备同步的 smartAccountId。

syncResult

字典

PnP 虚拟账户设备同步的 syncResult。

syncList

列表 / 元素=字典

PnP 虚拟账户设备同步的 syncList。

deviceSnList

列表 / 元素=字符串

PnP 虚拟账户设备同步的 deviceSnList。

syncType

字符串

PnP 虚拟账户设备同步的 syncType。

syncMsg

字符串

PnP 虚拟账户设备同步的 syncMsg。

syncResultStr

字符串

PnP 虚拟账户设备同步的 syncResultStr。

syncStartTime

整数

PnP 虚拟账户设备同步的 syncStartTime。

syncStatus

字符串

PnP 虚拟账户设备同步的 syncStatus。

tenantId

字符串

PnP 虚拟账户设备同步的 tenantId。

token

字符串

PnP 虚拟账户设备同步的 token。

validate_response_schema

布尔值

用于 Cisco DNA Center SDK 以启用根据 JSON 模式验证请求主体的标志。

选项

  • false

  • true ← (默认)

virtualAccountId

字符串

PnP 虚拟账户设备同步的 virtualAccountId。

备注

注意

  • 使用的 SDK 方法为 device_onboarding_pnp.DeviceOnboardingPnp.sync_virtual_account_devices_v1。

  • 使用的路径为 post /dna/intent/api/v1/onboarding/pnp-device/vacct-sync。

  • 不支持 check_mode

  • 插件在控制节点上运行,不使用任何 Ansible 连接插件,而是使用 Cisco DNAC SDK 中的嵌入式连接管理器。

  • 以 dnac_ 开头的参数由 Cisco DNAC Python SDK 用于建立连接。

另请参阅

另请参阅

Cisco DNA Center 设备上线 (PnP) SyncVirtualAccountDevicesV1 文档

SyncVirtualAccountDevicesV1 API 的完整参考。

示例

- name: Create
  cisco.dnac.pnp_virtual_account_devices_sync_v1:
    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

返回值

常见的返回值已在 此处 记录,以下是此模块特有的字段

描述

dnac_response

字典

Cisco DNAC Python SDK 返回的响应的字典或列表

返回:始终

示例: {"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"}

作者

  • Rafael Campos (@racampos)