cisco.dnac.buildings 模块 – 建筑物资源模块

注意

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

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

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

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

cisco.dnac 6.15.0 中的新功能

概要

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

注意

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

要求

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

  • dnacentersdk >= 2.4.9

  • python >= 3.5

参数

参数

注释

address

字符串

建筑物地址。 示例:4900 Marie P. Debartolo Way, Santa Clara, California 95054, United States。

country

字符串

国家名称。

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"

id

字符串

Id 路径参数。 建筑物 Id。

latitude

浮点数

建筑物纬度。 示例:37.403712。

longitude

浮点数

建筑物经度。 示例:-121.971063。

name

字符串

建筑物名称。

parentId

字符串

父 Id。

validate_response_schema

布尔值

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

选项

  • false

  • true ← (默认)

注意

注意

  • 使用的 SDK 方法是 site_design.SiteDesign.creates_a_building_v2、site_design.SiteDesign.deletes_a_building_v2、site_design.SiteDesign.updates_a_building_v2,

  • 使用的路径是 post /dna/intent/api/v2/buildings、delete /dna/intent/api/v2/buildings/{id}、put /dna/intent/api/v2/buildings/{id},

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

  • 不支持 check_mode

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

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

另请参阅

另请参阅

Cisco DNA Center 文档,了解站点设计 CreatesABuildingV2

CreatesABuildingV2 API 的完整参考。

Cisco DNA Center 文档,了解站点设计 DeletesABuildingV2

DeletesABuildingV2 API 的完整参考。

Cisco DNA Center 文档,了解站点设计 UpdatesABuildingV2

UpdatesABuildingV2 API 的完整参考。

示例

- name: Create
  cisco.dnac.buildings:
    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}}"
    state: present
    address: string
    country: string
    latitude: 0
    longitude: 0
    name: string
    parentId: string

- name: Update by id
  cisco.dnac.buildings:
    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}}"
    state: present
    address: string
    country: string
    id: string
    latitude: 0
    longitude: 0
    name: string
    parentId: string

- name: Delete by id
  cisco.dnac.buildings:
    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}}"
    state: absent
    id: string

返回值

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

描述

dnac_response

字典

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

已返回: 始终

示例: {"response": {"taskId": "字符串", "url": "字符串"}, "version": "字符串"}

作者

  • Rafael Campos (@racampos)