cisco.dnac.site_update_v1 模块 – 站点更新 V1 资源模块
注意
此模块是 cisco.dnac 集合 (版本 6.25.0) 的一部分。
如果您使用的是 ansible
包,则可能已经安装了此集合。它不包含在 ansible-core
中。要检查它是否已安装,请运行 ansible-galaxy collection list
。
要安装它,请使用:ansible-galaxy collection install cisco.dnac
。您需要其他要求才能使用此模块,有关详细信息,请参阅 要求。
要在 playbook 中使用它,请指定:cisco.dnac.site_update_v1
。
cisco.dnac 3.1.0 中的新增功能
概要
管理资源站点更新 V1 的操作更新。
使用指定的层次结构和新值更新站点区域/建筑/楼层。
注意
此模块具有相应的 动作插件。
要求
在执行此模块的主机上需要以下要求。
dnacentersdk >= 2.4.9
python >= 3.5
参数
参数 |
注释 |
---|---|
用于 Cisco DNA Center SDK 以启用调试。 选项
|
|
Cisco DNA Center 主机名。 |
|
用于身份验证的 Cisco DNA Center 密码。 |
|
Cisco DNA Center 端口。 默认值: |
|
用于身份验证的 Cisco DNA Center 用户名。 默认值: |
|
启用或禁用 SSL 证书验证的标志。 选项
|
|
告知 SDK 使用哪个版本的 Cisco DNA Center。 默认值: |
|
附加标头。 |
|
站点更新的站点。 |
|
站点更新的区域。 |
|
区域名称。 |
|
父级层次名称(示例 Global/USA/CA)。 |
|
站点更新的建筑物。 |
|
建筑物地址(示例 4900 Marie P. Debartolo Way, Santa Clara, California 95054, United States)。 |
|
国家/地区名称。对于隔离网络,此字段是必需的(示例 美国)。 |
|
建筑物纬度(示例 37.403712)。 |
|
建筑物经度(示例 -121.971063)。 |
|
建筑物名称。 |
|
父级层次名称(示例 Global/USA/CA/SantaClara)。 |
|
站点更新的楼层。 |
|
楼层编号(示例 3)。 |
|
楼层高度(英尺)(示例 10)。 |
|
楼层长度(英尺)(示例 100)。 |
|
楼层名称。 |
|
射频模型(示例 立方体和带墙办公室)。 |
|
楼层宽度(英尺)(示例 200)。 |
|
SiteId 路径参数。要更新其站点详细信息的站点 ID。 |
|
站点类型。 |
|
用于 Cisco DNA Center SDK 的标志,用于根据 JSON 模式启用请求正文的验证。 选项
|
备注
注意
使用的 SDK 方法为 sites.Sites.update_site_v1,
使用的路径为 put /dna/intent/api/v1/site/{siteId},
不支持
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_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
rfModel: string
width: 0
siteId: string
type: string
返回值
常见的返回值已在此处记录 此处,以下是此模块特有的字段
键 |
描述 |
---|---|
包含 Cisco DNAC Python SDK 返回的响应的字典或列表 返回值:始终 示例: |