cisco.dnac.network_device_by_serial_number_v1_info 模块 – 用于按序列号获取网络设备 V1 的信息模块

注意

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

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

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

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

cisco.dnac 3.1.0 中的新增功能

概要

  • 按 ID 获取按序列号的网络设备 V1。

  • 返回具有给定序列号的网络设备。

注意

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

要求

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

  • dnacentersdk >= 2.4.9

  • python >= 3.5

参数

参数

注释

dnac_debug

boolean

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

选项

  • false ←(默认)

  • true

dnac_host

string / 必需

Cisco DNA Center 主机名。

dnac_password

string

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

dnac_port

integer

Cisco DNA Center 端口。

默认值: 443

dnac_username

别名:user

string

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

默认值: "admin"

dnac_verify

boolean

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

选项

  • false

  • true ←(默认)

dnac_version

string

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

默认值: "2.3.7.6"

headers

dictionary

其他标头。

serialNumber

string

SerialNumber 路径参数。设备序列号。

validate_response_schema

boolean

用于 Cisco DNA Center SDK 启用针对 JSON 架构验证请求正文的标志。

选项

  • false

  • true ←(默认)

注意

注意

  • 使用的 SDK 方法是 devices.Devices.get_device_by_serial_number_v1,

  • 使用的路径是 get /dna/intent/api/v1/network-device/serial-number/{serialNumber},

  • 支持 check_mode

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

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

另请参阅

另请参阅

Cisco DNA Center 文档,了解 Devices GetDeviceBySerialNumberV1

GetDeviceBySerialNumberV1 API 的完整参考。

示例

- name: Get Network Device By Serial Number V1 by id
  cisco.dnac.network_device_by_serial_number_v1_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: string
  register: result

返回值

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

描述

dnac_response

dictionary

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

已返回:始终

示例: {"response": {"apEthernetMacAddress": "string", "apManagerInterfaceIp": "string", "associatedWlcIp": "string", "bootDateTime": "string", "collectionInterval": "string", "collectionStatus": "string", "description": "string", "deviceSupportLevel": "string", "dnsResolvedManagementAddress": "string", "errorCode": "string", "errorDescription": "string", "family": "string", "hostname": "string", "id": "string", "instanceTenantId": "string", "instanceUuid": "string", "interfaceCount": "string", "inventoryStatusDetail": "string", "lastDeviceResyncStartTime": "string", "lastUpdateTime": 0, "lastUpdated": "string", "lineCardCount": "string", "lineCardId": "string", "location": "string", "locationName": "string", "macAddress": "string", "managedAtleastOnce": true, "managementIpAddress": "string", "managementState": "string", "memorySize": "string", "pendingSyncRequestsCount": "string", "platformId": "string", "reachabilityFailureReason": "string", "reachabilityStatus": "string", "reasonsForDeviceResync": "string", "reasonsForPendingSyncRequests": "string", "role": "string", "roleSource": "string", "serialNumber": "string", "series": "string", "snmpContact": "string", "snmpLocation": "string", "softwareType": "string", "softwareVersion": "string", "tagCount": "string", "tunnelUdpPort": "string", "type": "string", "upTime": "string", "uptimeSeconds": 0, "vendor": "string", "waasDeviceMode": "string"}, "version": "string"}

作者

  • Rafael Campos (@racampos)