cisco.dnac.sites_v1_info 模块 – 站点 V1 信息模块

注意

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

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

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

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

cisco.dnac 6.15.0 中的新增功能

概要

• 获取所有站点 V1。

• 获取站点。

注意

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

要求

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

• dnacentersdk >= 2.4.9

• python >= 3.5

参数

参数	注释
_unitsOfMeasure 字符串	_unitsOfMeasure 查询参数。楼层计量单位。
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 整数	Limit 查询参数。此页显示的记录数。
name 字符串	Name 查询参数。站点名称。
nameHierarchy 字符串	NameHierarchy 查询参数。站点名称层次结构。
offset 整数	Offset 查询参数。此页显示的第一条记录；第一条记录编号为 1。
type 字符串	Type 查询参数。站点类型。
validate_response_schema 布尔值	用于 Cisco DNA Center SDK 的标志，用于启用根据 JSON 模式验证请求正文。 选项 false true ← (默认)

注释

注意

• 使用的 SDK 方法是 site_design.SiteDesign.get_sites_v1，

• 使用的路径是 get /dna/intent/api/v1/sites，

• 支持 check_mode

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

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

另请参阅

另请参阅

Cisco DNA Center 站点设计 GetSitesV1 文档

GetSitesV1 API 的完整参考。

示例

- name: Get all Sites V1
  cisco.dnac.sites_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}}"
    name: string
    nameHierarchy: string
    type: string
    _unitsOfMeasure: string
    offset: 0
    limit: 0
  register: result

返回值

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

键	描述
dnac_response 字典	包含 Cisco DNAC Python SDK 返回的响应的字典或列表 返回：始终 示例： {"response": [{"address": "字符串", "country": "字符串", "floorNumber": 0, "height": 0, "id": "字符串", "latitude": 0, "length": 0, "longitude": 0, "name": "字符串", "nameHierarchy": "字符串", "parentId": "字符串", "rfModel": "字符串", "type": "字符串", "unitsOfMeasure": "字符串", "width": 0}], "version": "字符串"}

作者

• Rafael Campos (@racampos)

资源链接

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