cisco.dnac.pnp_device_count_info 模块 – 用于 Pnp 设备计数信息的 Information 模块

注意

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

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

要安装它,请使用:ansible-galaxy collection install cisco.dnac。您需要进一步的要求才能使用此模块,请参阅 要求 了解详细信息。

要在 playbook 中使用它,请指定:cisco.dnac.pnp_device_count_info

cisco.dnac 3.1.0 中的新功能

概要

  • 此模块代表模块 pnp_device_count_v1_info 的别名

注意

此模块具有相应的 action 插件

要求

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

  • dnacentersdk >= 2.4.9

  • python >= 3.5

参数

参数

注释

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"

headers

字典

其他标头。

lastContact

布尔值

LastContact 查询参数。设备上次联系时间 > 0。

选项

  • false

  • true

name

列表 / 元素=字符串

Name 查询参数。设备名称。

onbState

列表 / 元素=字符串

OnbState 查询参数。设备引导状态。

pid

列表 / 元素=字符串

Pid 查询参数。设备产品 ID。

serialNumber

列表 / 元素=字符串

SerialNumber 查询参数。设备序列号。

smartAccountId

列表 / 元素=字符串

SmartAccountId 查询参数。设备智能账户。

source

列表 / 元素=字符串

Source 查询参数。设备来源。

state_

列表 / 元素=字符串

State 查询参数。设备状态。

validate_response_schema

布尔值

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

选项

  • false

  • true ← (默认)

virtualAccountId

列表 / 元素=字符串

VirtualAccountId 查询参数。设备虚拟账户。

workflowId

列表 / 元素=字符串

WorkflowId 查询参数。设备工作流 ID。

workflowName

列表 / 元素=字符串

WorkflowName 查询参数。设备工作流名称。

备注

注意

  • 使用的 SDK 方法是 device_onboarding_pnp.DeviceOnboardingPnp.get_device_count,

  • 使用的路径是 get /dna/intent/api/v1/onboarding/pnp-device/count,

  • 应该注意的是,此模块是 pnp_device_count_v1_info 的别名

  • 支持 check_mode

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

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

另请参阅

另请参阅

Cisco DNA Center 设备引导 (PnP) GetDeviceCountV1 的文档

GetDeviceCountV1 API 的完整参考。

示例

- name: Get all Pnp Device Count Info
  cisco.dnac.pnp_device_count_info:
    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}}"
    headers: "{{my_headers | from_json}}"
    serialNumber: []
    state_: []
    onbState: []
    name: []
    pid: []
    source: []
    workflowId: []
    workflowName: []
    smartAccountId: []
    virtualAccountId: []
    lastContact: True
  register: result

返回值

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

描述

dnac_response

字典

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

已返回: 始终

示例: {"response": 0}

作者

  • Rafael Campos (@racampos)