cisco.dnac.sites_bulk 模块 – 用于站点批量操作的资源模块

注意

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

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

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

要在 Playbook 中使用它,请指定:cisco.dnac.sites_bulk

cisco.dnac 6.15.0 中的新增功能

概要

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

注意

此模块具有对应的 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"

payload

列表 / 元素=字典

站点批量的负载。

address

字符串

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

country

字符串

国家/地区名称。建筑物必需。

floorNumber

整数

楼层号。楼层必需。

height

浮点数

楼层高度。楼层必需。例如 10.1。

latitude

浮点数

建筑物纬度。例如 37.403712。

length

浮点数

楼层长度。楼层必需。例如 110.3。

longitude

浮点数

建筑物经度。例如 -121.971063。

name

字符串

站点名称。

parentNameHierarchy

字符串

父级层次结构名称。例如 Global/USA/San Jose/Building1。

rfModel

字符串

楼层 RF 模型。楼层必需。

type

字符串

类型。

unitsOfMeasure

字符串

楼层计量单位。楼层必需。

width

浮点数

楼层宽度。楼层必需。例如 100.5。

validate_response_schema

布尔值

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

选项

  • false

  • true ← (默认)

注释

注意

  • 使用的 SDK 方法是 site_design.SiteDesign.create_sites_v1,

  • 使用的路径是 post /dna/intent/api/v1/sites/bulk,

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

  • 不支持 check_mode

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

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

另请参阅

另请参阅

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

CreateSitesV1 API 的完整参考。

示例

- name: Create
  cisco.dnac.sites_bulk:
    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}}"
    payload:
    - address: string
      country: string
      floorNumber: 0
      height: 0
      latitude: 0
      length: 0
      longitude: 0
      name: string
      parentNameHierarchy: string
      rfModel: string
      type: string
      unitsOfMeasure: string
      width: 0

返回值

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

描述

dnac_response

字典

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

返回:始终

示例: {"response": {"taskId": "string", "url": "string"}, "version": "string"}

作者

  • Rafael Campos (@racampos)