cisco.dnac.network_devices_count_info 模块 – 网络设备数量信息模块

注意

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

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

要安装它，请使用：ansible-galaxy collection install cisco.dnac。您需要其他要求才能使用此模块，请参阅 要求 以了解详细信息。

要在 playbook 中使用它，请指定：cisco.dnac.network_devices_count_info。

cisco.dnac 6.15.0 中的新增功能

概要

• 此模块表示模块 network_devices_count_v1_info 的别名。

注意

此模块具有相应的 action 插件。

要求

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

• dnacentersdk >= 2.4.9

• python >= 3.5

参数

参数	注释
attribute 字符串	属性查询参数。网络设备模型属性列表。这有助于指定请求中感兴趣的字段。
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"
endTime 浮点数	EndTime 查询参数。API 查询与资源相关的数集的结束时间。必须以毫秒为单位的 UNIX 纪元时间指定。值为包含。
family 字符串	Family 查询参数。网络设备系列名称列表。示例 family=交换机和集线器（单个网络设备系列名称）family=交换机和集线器&family=路由器&family=无线控制器（多个网络设备系列名称，用 & 分隔）。此字段不区分大小写。
headers 字典	附加标头。
healthScore 字符串	HealthScore 查询参数。实体健康评分类别列表。示例 healthScore=良好，healthScore=良好&healthScore=一般（多个实体健康评分值，用 & 分隔）。此字段不区分大小写。
id 字符串	Id 查询参数。实体 UUID 列表。（例如“6bef213c-19ca-4170-8375-b694e251101c”）示例 id=6bef213c-19ca-4170-8375-b694e251101c（请求单个实体 uuid）id=6bef213c-19ca-4170-8375-b694e251101c&id=32219612-819e-4b5e-a96b-cf22aca13dd9&id=2541e9a7-b80d-4955-8aa2-79b233318ba0（多个实体 uuid，用“&”分隔）。
macAddress 字符串	MacAddress 查询参数。网络设备或客户端的 macAddress。此字段支持基于通配符（`*`）字符的搜索。例如 `*AB AB AB*` 或 `AB AB AB*` 或 `*AB AB AB` 示例 `macAddress=AB AB AB CD CD CD`（请求单个 macAddress）`macAddress=AB AB AB CD CD DC&macAddress=AB AB AB CD CD FE`（请求多个 macAddress）。
maintenanceMode 布尔值	MaintenanceMode 查询参数。设备维护模式状态 true 或 false。 选项 false true
managementIpAddress 字符串	ManagementIpAddress 查询参数。实体管理 IP 地址列表。可以是 IPv4 或 IPv6 地址或两者的组合（例如，“121.1.1.10”）。此字段支持基于通配符（`*`）字符的搜索。例如 `*1.1*` 或 `1.1*` 或 `*1.1` 示例 managementIpAddresses=121.1.1.10 managementIpAddresses=121.1.1.10&managementIpAddresses=172.20.1.10&managementIpAddresses=20010&=managementIpAddresses172.20.3.4（多个实体 IP 地址，用 & 分隔）。
role 字符串	Role 查询参数。网络设备角色列表。示例 role=核心，role=核心&role=接入&role=路由器（多个网络设备角色，用 & 分隔）。此字段不区分大小写。
serialNumber 字符串	SerialNumber 查询参数。网络设备序列号列表。此字段支持基于通配符（`*`）字符的搜索。例如 `*MS1SV*` 或 `MS1SV*` 或 `*MS1SV` 示例 serialNumber=9FUFMS1SVAX serialNumber=9FUFMS1SVAX&FCW2333Q0BY&FJC240617JX（多个网络设备序列号，用 & 分隔）。
siteHierarchy 字符串	SiteHierarchy 查询参数。从全局站点名称开始到特定站点名称结束的站点树的完整分层细分。根站点名为“全局”（例如，`Global/AreaName/BuildingName/FloorName`）。此字段支持通配符星号 (*) 字符搜索支持。例如，*/San*, */San, /San* 示例 `?siteHierarchy=Global/AreaName/BuildingName/FloorName`（请求单个 siteHierarchy）`?siteHierarchy=Global/AreaName/BuildingName/FloorName&siteHierarchy=Global/AreaName2/BuildingName2/FloorName2`（请求多个 siteHierarchies）。
siteHierarchyId 字符串	SiteHierarchyId 查询参数。从全局站点 UUID 开始到特定站点 UUID 结束的站点树的完整分层细分。（例如，`globalUuid/areaUuid/buildingUuid/floorUuid`）。此字段支持通配符星号 (*) 字符搜索支持。例如，`*uuid*, *uuid, uuid* 示例 `?siteHierarchyId=globalUuid/areaUuid/buildingUuid/floorUuid `（请求单个 siteHierarchyId）`?siteHierarchyId=globalUuid/areaUuid/buildingUuid/floorUuid&siteHierarchyId=globalUuid/areaUuid2/buildingUuid2/floorUuid2`（请求多个 siteHierarchyIds）。
siteId 字符串	SiteId 查询参数。站点的 UUID。（例如，`flooruuid`）。此字段支持通配符星号 (*) 字符搜索支持。例如，*flooruuid*, *flooruuid, flooruuid* 示例 `?siteId=id1`（请求单个 id）`?siteId=id1&siteId=id2&siteId=id3`（请求多个 id）。
softwareVersion 字符串	SoftwareVersion 查询参数。网络设备软件版本的列表。此字段支持基于通配符（`*`）的搜索。例如 `*17.8*` 或 `*17.8` 或 `17.8*`。示例：softwareVersion=2.3.4.0（单个网络设备软件版本）softwareVersion=17.9.3.23&softwareVersion=17.7.1.2&softwareVersion=*.17.7（使用 & 分隔符的多个网络设备软件版本）。
startTime 浮点数	StartTime 查询参数。API 从该时间点开始查询与资源相关的 数据集。必须以毫秒为单位的 UNIX 时间戳指定。值包含在内。如果未提供 `startTime`，API 将默认为当前时间。
type 字符串	Type 查询参数。网络设备类型的列表。此字段支持基于通配符（`*`）的搜索。例如 `*9407R*` 或 `*9407R` 或 `9407R*`。示例：type=SwitchesCisco Catalyst 9407R Switch（单个网络设备类型）type=Cisco Catalyst 38xx stack-able ethernet switch&type=Cisco 3945 Integrated Services Router G2（使用 & 分隔符的多个网络设备类型）。
validate_response_schema 布尔值	用于 Cisco DNA Center SDK 的标志，用于启用根据 JSON 模式验证请求正文。 选项 false true ← (默认)
view 字符串	View 查询参数。网络设备模型视图的列表。请参考 ```NetworkDeviceView``` 获取支持的列表。

备注

注意

• 使用的 SDK 方法为 devices.Devices.gets_the_total_network_device_counts_based_on_the_provided_query_parameters_v1,

• 使用的路径为 get /dna/data/api/v1/networkDevices/count,

• 需要注意的是，此模块是 network_devices_count_v1_info 的别名。

• 支持 check_mode

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

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

另请参见

另请参见

Cisco DNA Center 文档，了解 Devices GetsTheTotalNetworkDeviceCountsBasedOnTheProvidedQueryParametersV1

GetsTheTotalNetworkDeviceCountsBasedOnTheProvidedQueryParametersV1 API 的完整参考。

示例

- name: Get all Network Devices Count Info
  cisco.dnac.network_devices_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}}"
    startTime: 0
    endTime: 0
    id: string
    siteHierarchy: string
    siteHierarchyId: string
    siteId: string
    managementIpAddress: string
    macAddress: string
    family: string
    type: string
    role: string
    serialNumber: string
    maintenanceMode: True
    softwareVersion: string
    healthScore: string
    view: string
    attribute: string
  register: result

返回值

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

键	描述
dnac_response 字典	包含 Cisco DNAC Python SDK 返回的响应的字典或列表。 返回：始终 示例： {"response": {"count": 0}, "version": "string"}

作者

• Rafael Campos (@racampos)

集合链接

• 问题跟踪器
• 代码库（源代码）