cisco.dnac.site_update 模块 – 站点更新资源模块

注意

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

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

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

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

cisco.dnac 3.1.0 中的新增功能

概要 

此模块表示模块 site_update_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 字符串	区域名称。
parentName 字符串	父级分层名称（例如 Global/USA/CA）。
building 字典	站点更新的建筑物。
address 字符串	建筑物地址（例如 4900 Marie P. Debartolo Way, Santa Clara, California 95054, United States）。
country 字符串	国家/地区名称。此字段对于断网网络是必填项（例如美国）。
latitude 浮点数	建筑物纬度（例如 37.403712）。
longitude 浮点数	建筑物经度（例如 -121.971063）。
name 字符串	建筑物名称。
parentName 字符串	父级分层名称（例如 Global/USA/CA/SantaClara）。
floor 字典	站点更新的楼层。
floorNumber 浮点数	楼层编号（例如 3）。
height 浮点数	楼层高度（英尺）（例如 10）。
length 浮点数	楼层长度（英尺）（例如 100）。
name 字符串	楼层名称。
rfModel 字符串	射频模型（例如 Cubes And Walled Offices）。
width 浮点数	楼层宽度（英尺）（例如 200）。
siteId 字符串	SiteId 路径参数。要更新其详细信息的站点 ID。
type 字符串	站点类型。
validate_response_schema 布尔值	用于 Cisco DNA Center SDK 以启用根据 JSON 模式验证请求正文的标志。选项 `false` `true` ← (默认)

备注 

注意

使用的 SDK 方法是 sites.Sites.update_site_v1，
使用的路径是 put /dna/intent/api/v1/site/{siteId}，
需要注意的是，此模块是 site_update_v1 的别名
不支持 check_mode
插件在控制节点上运行，不使用任何 Ansible 连接插件，而是使用 Cisco DNAC SDK 中的嵌入式连接管理器
以 dnac_ 开头的参数由 Cisco DNAC Python SDK 用于建立连接

另请参阅 

另请参阅

Cisco DNA Center 站点更新 UpdateSiteV1 文档: UpdateSiteV1 API 的完整参考。

示例 

- name: Update by id
  cisco.dnac.site_update:
    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
        rfModel: string
        width: 0
    siteId: string
    type: string

返回值 

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

键

描述

dnac_response

字典

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

返回：始终

示例： {"response": {"data": "string", "endTime": "string", "id": "string", "instanceTenantId": "string", "isError": "string", "operationIdList": ["string"], "progress": "string", "rootId": "string", "serviceType": "string", "startTime": "string", "version": "string"}, "result": "string", "status": "string"}

作者

Rafael Campos (@racampos)