cisco.dnac.floors_v2 模块 – Floors V2 的资源模块

注意

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

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

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

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

cisco.dnac 6.15.0 中的新增功能

概要

  • 管理资源 Floors V2 的创建、更新和删除操作。

  • 在建筑物的网络层次结构下创建一个楼层。

  • 从网络层次结构中删除楼层。如果此楼层有任何设备分配，则此操作将失败。

  • 更新网络层次结构中的楼层。

注意

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

要求

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

  • 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"

floorNumber

整数

楼层号。

height

浮点数

楼层高度。示例 10.1。

id

字符串

Id 路径参数。楼层 Id。

length

浮点数

楼层长度。示例 110.3。

name

字符串

楼层名称。

parentId

字符串

父 Id。

rfModel

字符串

RF 模型。

unitsOfMeasure

字符串

计量单位。

validate_response_schema

布尔值

用于启用 Cisco DNA Center SDK 以根据 JSON 模式验证请求正文的标志。

选项

  • false

  • true ←（默认）

width

浮点数

楼层宽度。示例 100.5。

注意事项

注意

  • 使用的 SDK 方法是 site_design.SiteDesign.creates_a_floor_v2，site_design.SiteDesign.deletes_a_floor_v2，site_design.SiteDesign.updates_a_floor_v2，

  • 使用的路径是 post /dna/intent/api/v2/floors，delete /dna/intent/api/v2/floors/{id}，put /dna/intent/api/v2/floors/{id}，

  • 不支持 check_mode

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

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

另请参阅

另请参阅

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

CreatesAFloorV2 API 的完整参考。

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

DeletesAFloorV2 API 的完整参考。

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

UpdatesAFloorV2 API 的完整参考。

示例

- name: Create
  cisco.dnac.floors_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
    floorNumber: 0
    height: 0
    length: 0
    name: string
    parentId: string
    rfModel: string
    unitsOfMeasure: string
    width: 0

- name: Update by id
  cisco.dnac.floors_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
    floorNumber: 0
    height: 0
    id: string
    length: 0
    name: string
    parentId: string
    rfModel: string
    unitsOfMeasure: string
    width: 0

- name: Delete by id
  cisco.dnac.floors_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)