cisco.dnac.site_intent 模块 – 用于站点操作的资源模块
注意
此模块是 cisco.dnac 集合（版本 6.25.0）的一部分。
如果您正在使用 ansible 包，您可能已经安装了这个集合。它不包含在 ansible-core 中。要检查它是否已安装，请运行 ansible-galaxy collection list。
要安装它，请使用：ansible-galaxy collection install cisco.dnac。您需要更多要求才能使用此模块，有关详细信息，请参阅 要求。
要在 playbook 中使用它，请指定：cisco.dnac.site_intent。
cisco.dnac 6.6.0 中的新增功能
概要
管理资源站点创建、更新和删除操作。
使用指定的层次结构创建包含区域/建筑物/楼层的站点。
使用指定的层次结构更新包含区域/建筑物/楼层的站点。
使用指定的层次结构删除包含区域/建筑物/楼层的站点。
要求
执行此模块的主机需要以下要求。
dnacentersdk == 2.4.5
python >= 3.9
参数
参数 |
注释 |
|---|---|
它表示用于创建/管理/删除站点的详细信息列表，包括区域、建筑物和楼层。 |
|
包含有关被管理站点（包括区域、建筑物和楼层）的详细信息。 |
|
用于在站点内创建或管理区域的配置详细信息。 |
|
要创建或管理的区域的名称（例如，“区域1”）。 |
|
将在其下创建/管理/删除区域的父项的完整名称（例如，“Global/USA”）。 |
|
在站点内创建或管理建筑物所需的配置详细信息。 |
|
要创建或管理的建筑物的物理地址。 |
|
建筑物的地理纬度坐标。例如，对于加利福尼亚州圣何塞的位置，使用 37.338。有效值范围为 -90.0 到 +90.0 度。 |
|
建筑物的地理经度坐标。例如，对于加利福尼亚州圣何塞的位置，使用 -121.832。有效值范围为 -180.0 到 +180.0 度。 |
|
建筑物的名称（例如，“建筑物1”）。 |
|
建筑物的层次结构父路径，指示其在站点中的位置（例如，“Global/USA/San Francisco”）。 |
|
在站点内创建或管理楼层所需的配置详细信息。 |
|
建筑物站点内的楼层号（例如，5）。此值只能在创建楼层时指定，之后无法修改。 |
|
楼层的高度，以英尺为单位（例如，15.23）。 |
|
楼层的长度，以英尺为单位（例如，100.11）。 |
|
楼层的名称（例如，“楼层-1”）。 |
|
楼层的层次结构父路径，指示其在站点中的位置（例如，“Global/USA/San Francisco/BGL_18”）。 |
|
楼层的 RF（射频）模型类型，对于模拟和优化无线网络覆盖至关重要。从以下允许值中选择，这些值描述了不同的环境信号传播特性。楼层类型（允许的值为“立方体和有墙办公室”、“仅石膏板办公室”、“室内高天花板”、“室外开放空间”）。立方体和有墙办公室 - 此 RF 模型通常表示带有隔间或有墙办公室的室内区域，其中无线电信号可能会因墙壁和障碍物而衰减。仅石膏板办公室 - 此 RF 模型指示具有石膏板隔断的环境，常见于办公空间，可能具有适度的信号衰减。室内高天花板 - 此 RF 模型适用于具有高天花板的室内空间，例如礼堂或中庭，其中信号传播可能会因天花板的高度而有所不同。室外开放空间 - 此 RF 模型用于室外开放空间区域，其中信号传播的障碍较少，并且可能遵循与室内环境不同的模式。 |
|
楼层的宽度，以英尺为单位（例如，100.22）。 |
|
要创建/更新/删除的站点类型（例如，区域、建筑物、楼层）。 |
|
设置为 True 以在应用 playbook 配置后验证 Cisco Catalyst Center 配置。 选择
|
|
定义用于检索任务详细信息的 API 调用的超时时间（以秒为单位）。如果在此期间未收到任务详细信息，则该过程将结束，并将记录超时通知。 默认值： |
|
用于 Cisco DNA Center SDK 以启用调试的标志。 选择
|
|
Cisco DNA Center 主机名。 |
|
用于启用/禁用 playbook 执行日志记录的标志。 当为 true 且提供了 dnac_log_file_path 时，- 在执行位置使用指定的名称创建日志文件。 当为 true 且未提供 dnac_log_file_path 时，- 在执行位置创建名为 “dnac.log” 的日志文件。 当为 false 时，- 禁用日志记录。 如果日志文件不存在，- 则根据 “dnac_log_append” 标志以追加或写入模式创建该文件。 如果日志文件存在，- 它会根据“dnac_log_append”标志被覆盖或追加。 选择
|
|
确定文件的模式。设置为 True 为“追加”模式。设置为 False 为“写入”模式。 选择
|
|
控制日志记录。如果 dnac_log 为 True，则记录日志。 如果未指定路径， - 当 'dnac_log_append' 为 True 时，会在当前的 Ansible 目录中生成 'dnac.log'；日志将追加。- 当 'dnac_log_append' 为 False 时，会生成 'dnac.log'；日志将被覆盖。 如果指定了路径，- 当 'dnac_log_append' 为 True 时，文件以追加模式打开。- 当 'dnac_log_append' 为 False 时，文件以写入 (w) 模式打开。- 在共享文件场景中，如果没有追加模式，则每次模块执行后内容都会被覆盖。- 对于共享日志文件，将第一个模块的追加设置为 False（以覆盖）；对于后续模块，将追加设置为 True。 默认值： |
|
设置日志级别的阈值。级别等于或高于此级别的消息将被记录。级别按严重性顺序排列 [CRITICAL, ERROR, WARNING, INFO, DEBUG]。 CRITICAL 表示会中止程序的严重错误。仅显示 CRITICAL 消息。 ERROR 表示会阻止功能的出现的问题。显示 ERROR 和 CRITICAL 消息。 WARNING 表示潜在的未来问题。显示 WARNING、ERROR 和 CRITICAL 消息。 INFO 跟踪正常操作。显示 INFO、WARNING、ERROR 和 CRITICAL 消息。 DEBUG 提供详细的诊断信息。显示所有日志消息。 默认值： |
|
用于身份验证的 Cisco DNA Center 密码。 |
|
Cisco DNA Center 端口。 默认值： |
|
指定连续调用 API 以检索任务详细信息之间的间隔（以秒为单位）。 默认值： |
|
用于身份验证的 Cisco DNA Center 用户名。 默认值： |
|
启用或禁用 SSL 证书验证的标志。 选择
|
|
通知 SDK 要使用的 Cisco DNA Center 版本。 默认值： |
|
模块完成后 Catalyst Center 的状态。 选择
|
|
Cisco DNA Center SDK 的标志，用于启用根据 JSON 模式验证请求正文。 选择
|
备注
注意
使用的 SDK 方法为 sites.Sites.create_site、sites.Sites.update_site、sites.Sites.delete_site
使用的路径为 post /dna/intent/api/v1/site、put dna/intent/api/v1/site/{siteId}、delete dna/intent/api/v1/site/{siteId}
不支持
check_mode该插件在控制节点上运行，不使用任何 ansible 连接插件，而是使用 Cisco DNAC SDK 中的嵌入式连接管理器
以 dnac_ 开头的参数由 Cisco DNAC Python SDK 用于建立连接
示例
- name: Create a new area site
cisco.dnac.site_intent:
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}}"
dnac_log_level: "{{dnac_log_level}}"
dnac_log: "{{dnac_log}}"
state: merged
config:
- site:
area:
name: Test
parent_name: Global/India
site_type: area
- name: Create a new building site
cisco.dnac.site_intent:
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}}"
dnac_log_level: "{{dnac_log_level}}"
dnac_log: "{{dnac_log}}"
state: merged
config:
- site:
building:
name: Building_1
parent_name: Global/India
address: Bengaluru, Karnataka, India
latitude: 24.12
longitude: 23.45
site_type: building
- name: Create a Floor site under the building
cisco.dnac.site_intent:
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}}"
dnac_log_level: "{{dnac_log_level}}"
dnac_log: "{{dnac_log}}"
state: merged
config:
- site:
floor:
name: Floor_1
parent_name: Global/India/Building_1
length: 75.76
width: 35.54
height: 30.12
rf_model: Cubes And Walled Offices
floor_number: 2
site_type: floor
- name: Updating the Floor details under the building
cisco.dnac.site_intent:
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}}"
dnac_log_level: "{{dnac_log_level}}"
dnac_log: "{{dnac_log}}"
state: merged
config:
- site:
floor:
name: Floor_1
parent_name: Global/India/Building_1
length: 75.76
width: 35.54
height: 30.12
site_type: floor
- name: Deleting any site you need site name and parent name
cisco.dnac.site_intent:
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}}"
dnac_log_level: "{{dnac_log_level}}"
dnac_log: "{{dnac_log}}"
state: deleted
config:
- site:
floor:
name: Floor_1
parent_name: Global/India/Building_1
site_type: floor
返回值
常用返回值在此处记录 这里，以下是此模块特有的字段
键 |
描述 |
|---|---|
一个包含 API 执行详细信息的字典，由 Cisco Catalyst Center Python SDK 返回 返回：总是 示例： |
|
一个包含现有站点详细信息的字典。 返回：总是 示例： |
|
一个包含 API 执行详细信息的字典，由 Cisco Catalyst Center Python SDK 返回 返回：总是 示例： |
|
一个列表，其中包含 Cisco Catalyst Center Python 返回的响应 返回：总是 示例： |