cisco.dnac.site_create 模块 – 站点创建资源模块

注意

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

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

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

要在剧本中使用它,请指定:cisco.dnac.site_create

cisco.dnac 3.1.0 中的新增功能

概要

  • 此模块表示模块 site_create_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"

headers

字典

附加的标头。

site

字典

站点创建的站点。

area

字典

站点创建的区域。

name

字符串

区域的名称(例如 Area1)。

parentName

字符串

要创建的区域的父名称。

building

字典

站点创建的建筑物。

address

字符串

要创建的建筑物的地址。

country

字符串

国家/地区(例如 美国)。

latitude

浮点数

建筑物的纬度坐标(例如 37.338)。

longitude

浮点数

建筑物的经度坐标(例如 -121.832)。

name

字符串

建筑物的名称(例如 building1)。

parentName

字符串

要创建的建筑物的父名称。

floor

字典

站点创建的楼层。

floorNumber

浮点数

楼层编号。(例如 5)。

height

浮点数

楼层的高度。计量单位为英尺。(例如 15)。

length

浮点数

楼层的长度。计量单位为英尺。(例如 100)。

name

字符串

楼层的名称(例如 floor-1)。

parentName

字符串

要创建的楼层的父名称。

rfModel

字符串

楼层类型(例如 Cubes And Walled Offices0)。

width

浮点数

楼层的宽度。计量单位为英尺。(例如 100)。

type

字符串

要创建的站点类型(例如 area、building、floor)。

validate_response_schema

布尔值

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

选项

  • false

  • true ← (默认)

备注

注意

  • 使用的 SDK 方法为 sites.Sites.create_site_v1,

  • 使用的路径为 post /dna/intent/api/v1/site,

  • 需要注意的是,此模块是 site_create_v1 的别名

  • 不支持 check_mode

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

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

另请参见

另请参见

Cisco DNA Center 关于站点创建站点 V1 的文档

CreateSiteV1 API 的完整参考。

示例

- name: Create
  cisco.dnac.site_create:
    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}}"
    headers: '{{my_headers | from_json}}'
    site:
      area:
        name: string
        parentName: string
      building:
        address: string
        country: string
        latitude: 0
        longitude: 0
        name: string
        parentName: string
      floor:
        floorNumber: 0
        height: 0
        length: 0
        name: string
        parentName: string
        rfModel: string
        width: 0
    type: string

返回值

常用的返回值已在 此处 记录,以下是此模块独有的字段

描述

dnac_response

字典

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

返回值: 始终

示例: {"executionId": "string", "executionStatusUrl": "string", "message": "string"}

作者

  • Rafael Campos (@racampos)