cisco.dnac.floors_v2 模块 – 楼层 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 中的新增功能

概要

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

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

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

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

注意

此模块具有相应的 action 插件

需求

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

  • 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 用于建立连接。

另请参阅

另请参阅

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

CreatesAFloorV2 API 的完整参考。

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

DeletesAFloorV2 API 的完整参考。

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

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": "字符串", "url": "字符串"}, "version": "字符串"}

作者

  • Rafael Campos (@racampos)