cisco.dnac.buildings_planned_access_points_info 模块 – 建筑物规划接入点信息信息模块
注意
此模块是 cisco.dnac 集合 (版本 6.25.0) 的一部分。
如果您使用的是 ansible 包，则可能已经安装了此集合。它不包含在 ansible-core 中。要检查它是否已安装，请运行 ansible-galaxy collection list。
要安装它，请使用：ansible-galaxy collection install cisco.dnac。您需要其他要求才能使用此模块，请参阅 需求 了解详情。
要在 playbook 中使用它，请指定：cisco.dnac.buildings_planned_access_points_info。
cisco.dnac 6.0.0 中的新增功能
概要
此模块表示模块 buildings_planned_access_points_v1_info 的别名。
注意
此模块具有相应的 操作插件。
需求
执行此模块的主机需要以下需求。
dnacentersdk >= 2.4.9
python >= 3.5
参数
参数 |
注释 |
|---|---|
BuildingId 路径参数。建筑物层次结构元素的实例 UUID。 |
|
用于 Cisco DNA Center SDK 的标志，用于启用调试。 选项
|
|
Cisco DNA Center 主机名。 |
|
用于身份验证的 Cisco DNA Center 密码。 |
|
Cisco DNA Center 端口。 默认值： |
|
用于身份验证的 Cisco DNA Center 用户名。 默认值： |
|
启用或禁用 SSL 证书验证的标志。 选项
|
|
告知 SDK 使用哪个版本的 Cisco DNA Center。 默认值： |
|
附加的 headers。 |
|
Limit 查询参数。响应的页面大小限制，例如 Limit=100 将返回最多 100 条记录。 |
|
Offset 查询参数。响应的页面偏移量。例如，如果 limit=100，offset=0 将返回前 100 条记录，offset=1 将返回接下来的 100 条记录，依此类推。 |
|
Radios 查询参数。是否包含规划接入点的规划无线电详细信息。 选项
|
|
用于 Cisco DNA Center SDK 的标志，用于启用根据 JSON 模式验证请求正文。 选项
|
注释
注意
使用的 SDK 方法是 devices.Devices.get_planned_access_points_for_building_v1，
使用的路径是 get /dna/intent/api/v1/buildings/{buildingId}/planned-access-points，
需要注意的是，此模块是 buildings_planned_access_points_v1_info 的别名。
支持
check_mode插件在控制节点上运行，不使用任何 Ansible 连接插件，而是使用 Cisco DNAC SDK 中的嵌入式连接管理器。
以 dnac_ 开头的参数由 Cisco DNAC Python SDK 用于建立连接。
另请参阅
另请参阅
- Cisco DNA Center 设备 GetPlannedAccessPointsForBuildingV1 文档
GetPlannedAccessPointsForBuildingV1 API 的完整参考。
示例
- name: Get all Buildings Planned Access Points Info
cisco.dnac.buildings_planned_access_points_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}}"
limit: 0
offset: 0
radios: True
buildingId: string
register: result
返回值
常用的返回值已在 此处 记录，以下是此模块特有的字段。
键 |
描述 |
|---|---|
包含 Cisco DNAC Python SDK 返回的响应的字典或列表。 返回：始终 示例： |