cisco.dnac.site_intent 模块 – 站点操作资源模块
注意
此模块是 cisco.dnac 集合 (版本 6.25.0) 的一部分。
如果您使用的是 ansible 包，则可能已安装此集合。它不包含在 ansible-core 中。要检查它是否已安装，请运行 ansible-galaxy collection list。
要安装它，请使用：ansible-galaxy collection install cisco.dnac。您需要其他要求才能使用此模块，有关详细信息，请参见 要求。
要在剧本中使用它，请指定：cisco.dnac.site_intent。
cisco.dnac 6.6.0 新增功能
概要
管理站点资源的创建、更新和删除操作。
创建具有指定层次结构的区域/建筑物/楼层的站点。
更新具有指定层次结构的区域/建筑物/楼层的站点。
删除具有指定层次结构的区域/建筑物/楼层的站点。
要求
执行此模块的主机需要以下要求。
dnacentersdk == 2.4.5
python >= 3.9
参数
参数 |
注释 |
|---|---|
它表示用于创建/管理/删除站点的详细信息列表，包括区域、建筑物和楼层。 |
|
包含有关被管理站点的详细信息，包括区域、建筑物和楼层。 |
|
用于创建或管理站点内区域的配置详细信息。 |
|
要创建或管理的区域名称（例如，“Area1”）。 |
|
将在其下创建/管理/删除区域的父级的完整名称（例如，“Global/USA”）。 |
|
在站点内创建或管理建筑物所需的配置详细信息。 |
|
要创建或管理的建筑物的实际地址。 |
|
建筑物的地理纬度坐标。例如，对于加利福尼亚州圣何塞的位置，使用 37.338。有效值范围为 -90.0 到 +90.0 度。 |
|
建筑物的地理经度坐标。例如，对于加利福尼亚州圣何塞的位置，使用 -121.832。有效值范围为 -180.0 到 +180.0 度。 |
|
建筑物名称（例如，“Building1”）。 |
|
建筑物的分层父路径，指示其在站点中的位置（例如，“Global/USA/San Francisco”）。 |
|
在站点内创建或管理楼层所需的配置详细信息。 |
|
建筑物站点内的楼层编号（例如，5）。此值仅可在创建楼层时指定，之后无法修改。 |
|
楼层高度（英尺）（例如，15.23）。 |
|
楼层长度（英尺）（例如，100.11）。 |
|
楼层名称（例如，“Floor-1”）。 |
|
楼层的层次父路径，指示其在站点中的位置（例如，“Global/USA/San Francisco/BGL_18”）。 |
|
楼层的射频 (RF) 模型类型，对于模拟和优化无线网络覆盖至关重要。从以下允许的值中选择，这些值描述了不同的环境信号传播特性。楼层类型（允许的值为“Cubes And Walled Offices”、“Drywall Office Only”、“Indoor High Ceiling”、“Outdoor Open Space”）。Cubes And Walled Offices - 此 RF 模型通常表示带有隔间或带墙办公室的室内区域，无线电信号可能会因墙壁和障碍物而衰减。Drywall Office Only - 此 RF 模型表示带有干墙隔断的环境，通常存在于办公室空间中，可能会出现中等信号衰减。Indoor High Ceiling - 此 RF 模型适用于具有高天花板的室内空间，例如礼堂或中庭，由于天花板的高度，信号传播可能有所不同。Outdoor Open Space - 此 RF 模型用于具有开放空间的室外区域，信号传播受阻较小，与室内环境相比可能遵循不同的模式。 |
|
楼层宽度（英尺）（例如，100.22）。 |
|
要创建/更新/删除的站点类型（例如区域、建筑物、楼层）。 |
|
设置为 True 以在应用剧本配置后验证 Cisco Catalyst Center 配置。 选项
|
|
定义用于检索任务详细信息的 API 调用的超时时间（秒）。如果在此期间未收到任务详细信息，则进程将结束，并且将记录超时通知。 默认值： |
|
用于启用 Cisco DNA Center SDK 调试的标志。 选项
|
|
Cisco DNA Center 主机名。 |
|
启用/禁用剧本执行日志记录的标志。 当为 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) 模式打开。- 在共享文件场景中，如果没有追加模式，则每次模块执行后内容都会被覆盖。- 对于共享日志文件，将第一个模块的 append 设置为 False（以覆盖）；对于后续模块，将 append 设置为 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
返回值
常见的返回值已在此处记录，以下是此模块独有的字段。
键 |
描述 |
|---|---|
包含 Cisco Catalyst Center Python SDK 返回的 API 执行详细信息的字典。 返回：始终 示例： |
|
包含现有站点详细信息的字典。 返回：始终 示例： |
|
包含 Cisco Catalyst Center Python SDK 返回的 API 执行详细信息的字典。 返回：始终 示例： |
|
包含 Cisco Catalyst Center Python 返回的响应的列表。 返回：始终 示例： |