cisco.dnac.buildings_v2 模块 – Buildings V2 资源模块

注意

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

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

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

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

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}，
不支持 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_v2:
    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_v2:
    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_v2:
    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": "string", "url": "string"}, "version": "string"}`

作者

Rafael Campos (@racampos)