cisco.dnac.site_create_v1 模块 – Site Create V1 资源模块

注意

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

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

要安装它，请使用：ansible-galaxy collection install cisco.dnac。您需要其他要求才能使用此模块，请参阅要求了解详情。

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

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 字典	附加的 header。
site 字典	Site Create 的站点。
area 字典	Site Create 的区域。
name 字符串	区域的名称（例如 Area1）。
parentName 字符串	要创建的区域的父名称。
building 字典	Site Create 的建筑物。
address 字符串	要创建的建筑物的地址。
country 字符串	国家/地区（例如美国）。
latitude 浮点数	建筑物的纬度坐标（例如 37.338）。
longitude 浮点数	建筑物的经度坐标（例如 -121.832）。
name 字符串	建筑物的名称（例如 building1）。
parentName 字符串	要创建的建筑物的父名称。
floor 字典	Site Create 的楼层。
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，
不支持 check_mode
插件在控制节点上运行，不使用任何 Ansible 连接插件，而是使用 Cisco DNAC SDK 的嵌入式连接管理器
以 dnac_ 开头的参数由 Cisco DNAC Python SDK 用于建立连接

另请参阅 

另请参阅

Cisco DNA Center 关于 Sites CreateSiteV1 的文档: CreateSiteV1 API 的完整参考。

示例 

- name: Create
  cisco.dnac.site_create_v1:
    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)