cisco.dnac.network_devices_assigned_to_site_info 模块 – 用于获取分配给站点的网络设备信息的模块

注意

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

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

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

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

cisco.dnac 6.15.0 中的新增功能

概要

  • 此模块表示模块 network_devices_assigned_to_site_v1_info 的别名

注意

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

要求

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

  • 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

字典

其他标头。

limit

浮点数

限制查询参数。此页面要显示的记录数。

offset

浮点数

偏移查询参数。此页面要显示的第一条记录;第一条记录编号为 1。

siteId

字符串

SiteId 查询参数。站点 ID。它必须是区域 ID 或建筑物 ID 或楼层 ID。

validate_response_schema

布尔值

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

选项

  • false

  • true ←(默认)

说明

注意

  • 使用的 SDK 方法是 site_design.SiteDesign.get_site_assigned_network_devices_v1,

  • 使用的路径是 get /dna/intent/api/v1/networkDevices/assignedToSite,

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

  • 支持 check_mode

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

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

另请参阅

另请参阅

有关站点设计 GetSiteAssignedNetworkDevicesV1 的 Cisco DNA Center 文档

GetSiteAssignedNetworkDevicesV1 API 的完整参考。

示例

- name: Get all Network Devices Assigned To Site Info
  cisco.dnac.network_devices_assigned_to_site_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}}"
    siteId: string
    offset: 0
    limit: 0
  register: result

返回值

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

描述

dnac_response

字典

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

返回: 始终

示例: {"response": [{"deviceId": "string", "siteId": "string", "siteNameHierarchy": "string", "siteType": "string"}], "version": "string"}

作者

  • Rafael Campos (@racampos)