cisco.dnac.sda_fabric_virtual_networks_workflow_manager 模块 – 在 Cisco Catalyst Center 中配置 Fabric VLAN、虚拟网络和任播网关。
注意
此模块是 cisco.dnac 集合（版本 6.25.0）的一部分。
如果您正在使用 ansible 包，您可能已经安装了此集合。它不包含在 ansible-core 中。要检查是否已安装，请运行 ansible-galaxy collection list。
要安装它，请使用：ansible-galaxy collection install cisco.dnac。您需要进一步的要求才能使用此模块，请参阅 要求 了解详细信息。
要在 playbook 中使用它，请指定：cisco.dnac.sda_fabric_virtual_networks_workflow_manager。
cisco.dnac 6.18.0 中的新增功能
概要
在 Cisco Catalyst Center 中为 SDA 操作创建、更新或删除第 2 层 Fabric VLAN。
在 Cisco Catalyst Center 中为 SDA 操作创建、更新或删除第 3 层虚拟网络。
在 Cisco Catalyst Center 中为 SDA 操作创建、更新或删除任播网关。
要求
执行此模块的主机需要满足以下要求。
dnacentersdk >= 2.9.2
python >= 3.9
参数
参数 |
注释 |
|---|---|
一个列表，其中包含在软件定义访问 (SDA) 环境中创建、更新或删除 fabric 站点/区域的详细配置。它还包括更新这些站点的身份验证配置文件模板的规范。列表中的每个元素都表示要在 SDA 基础设施上执行的特定操作，例如添加、修改或删除 fabric 站点/区域以及修改身份验证配置文件。 |
|
SDA fabric 中任播网关的列表，每个网关都包含其关联的虚拟网络、IP 池、VLAN 配置和其他高级网络设置的详细信息。 |
|
指定是否应自动生成 VLAN 名称。如果 ‘is_critical_pool’ 设置为 true，则此字段也必须设置为 true。如果 ‘auto_generate_vlan_name’ 设置为 true，则即使在 playbook 中提供了 ‘vlan_name’ 或 ‘vlan_id’，Catalyst Center 也会自动生成 ‘vlan_name’ 和 ‘vlan_id’。 选择
|
|
指定是否为 fabric 中的无线启用了任播网关。默认情况下，此字段设置为 false。此字段不适用于 INFRA_VN。 选择
|
|
将分配此第 3 层虚拟网络的 fabric 站点位置列表，包括有关站点层次结构和 fabric 类型的详细信息。如果提供了此参数，请确保为每个条目指定 site_name 和 fabric_type。这是在指定的 fabric 站点上扩展虚拟网络所必需的。 |
|
指定在 SDA 环境中要管理的站点类型。可接受的值为 ‘fabric_site’ 和 ‘fabric_zone’。默认值为 ‘fabric_site’，表示配置更广泛的网络区域，而 ‘fabric_zone’ 通常是指站点内更具体的网段。 默认值： |
|
部署任播网关的站点的分层名称。 |
|
指示是否在 fabric 中启用了组策略强制执行。默认情况下，它设置为 false。 选择
|
|
指定是否在子网内启用了路由。默认情况下，此字段设置为 false。此字段不适用于 INFRA_VN。不允许更新此字段。 选择
|
|
指示是否允许 IP 定向广播。默认情况下，它设置为 false。此字段不适用于 INFRA_VN。 选择
|
|
与任播网关关联的 IP 池的名称。IP 池必须已存在于 Cisco Catalyst Center 中，如果不存在，可以使用 ‘network_settings_workflow_manager’ 模块创建或保留。不允许更新此字段。 |
|
指定是否将此池标记为网络的关键池。如果设置为 true，则 ‘auto_generate_vlan_name’ 也必须为 true。默认情况下，此字段设置为 false。此字段不适用于 INFRA_VN。不允许更新此字段。 选择
|
|
指示是否在网络中启用了第 2 层洪泛。默认情况下，它设置为 false。它不适用于 INFRA_VN。 选择
|
|
指示是否可以将多个 IP 与单个 MAC 地址关联。默认情况下，它设置为 false。此字段不适用于 INFRA_VN。 选择
|
|
任播网关的池类型。此字段是必需的，并且仅适用于 INFRA_VN。必须选择以下值之一（EXTENDED_NODE、FABRIC_AP）。不允许更新此字段。 |
|
与任播网关关联的安全组的名称。它不适用于 INFRA_VN。 |
|
指定是否启用了扩展节点的基于请求者的入职。默认情况下，此字段设置为 false。此字段仅适用于 INFRA_VN 请求，当 ‘pool_type’ 为 EXTENDED_NODE 时，此字段不能为 null。 选择
|
|
用于调整 TCP 最大分段大小 (MSS) 的值。该值应在 (500, 1441) 范围内。 |
|
VLAN 处理的流量类型（例如，DATA、VOICE）。默认情况下，它设置为 “DATA”。如果 “is_critical_pool” 设置为 true，则不允许在任播网关中更新 “traffic_type”。 |
|
任意播网关的 VLAN ID。允许的 VLAN 范围是 2-4093，但保留的 VLAN 1002-1005、2046 和 4094 除外。如果在 Fabric 区域上部署任意播网关，则此 ‘vlan_id’ 必须与 Fabric 站点上相应任意播网关的 ‘vlan_id’ 匹配。如果参数 ‘auto_generate_vlan_name’ 设置为 true，则此字段是可选的。不允许更新此字段。 |
|
任意播网关的 VLAN 名称。如果参数 auto_generate_vlan_name 设置为 True，则此字段是可选的。不允许更新此字段。 |
|
三层虚拟网络的名称。它必须仅由字母、数字和下划线组成，长度在 1 到 16 个字符之间。创建后无法更新此字段。 |
|
SDA 环境中 Fabric 站点的 VLAN 配置列表。每个 VLAN 条目都包含有关其名称、ID、流量类型和无线功能的信息。 |
|
与二层 Fabric VLAN 关联的三层虚拟网络的名称。提供此字段是为了支持与虚拟网络锚定相关的请求。三层虚拟网络必须在关联之前已添加到 Fabric。此字段必须存在于所有有效负载元素中，或都不存在。并且不允许更新此字段。 |
|
指示是否在 Fabric 环境中为无线启用 Fabric VLAN。默认情况下，它设置为 False。 选择
|
|
部署此 VLAN 的 Fabric 站点位置列表，包括站点层次结构和 Fabric 类型详细信息。 |
|
指定在 SDA 环境中要管理的站点类型。可接受的值为 ‘fabric_site’ 和 ‘fabric_zone’。默认值为 ‘fabric_site’，表示配置更广泛的网络区域，而 ‘fabric_zone’ 通常是指站点内更具体的网段。 |
|
此名称唯一标识用于创建/更新/删除任何 Fabric VLAN 等操作的站点。此参数是必需的，并且不允许更新此字段。 |
|
VLAN 处理的流量类型（例如，DATA、VOICE）。默认情况下，它设置为“DATA”。 |
|
二层 VLAN 网络的 ID。允许的 VLAN 范围是 2-4093，但保留的 VLAN 1002-1005 和 2046 除外。如果在 Fabric 区域上部署，则此 vlan_id 必须与 Fabric 站点上相应二层虚拟网络的 vlan_id 匹配。并且不允许更新此字段。 |
|
二层虚拟网络的 VLAN 名称。必须仅包含字母数字字符、下划线和连字符。不允许更新此字段。 |
|
在 SDA Fabric 中配置的虚拟网络 (VN) 列表。每个虚拟网络都包含其名称、关联的 Fabric 站点以及（可选）锚定站点等详细信息。 |
|
指定虚拟网络锚定的 Fabric 站点的名称。当提供此参数时，请确保 ‘fabric_site_locations’ 包含相同的 ‘site_name’，并且仅指定一个 Fabric 站点位置。如果提供了所有参数，则会创建三层虚拟网络并将其扩展到多个 Fabric 站点。但是，由于 ‘anchored_site_name’ 设置冲突，操作将失败，并且模块将返回失败响应。对于锚定在站点的虚拟网络，必须至少存在一个控制平面 (CP) 和外部边界。 |
|
此三层虚拟网络要分配到的 Fabric 站点位置列表，包括站点层次结构和 Fabric 类型详细信息。如果提供此参数，请确保提供 site_name 和 fabric_type，以及跨给定 Fabric 站点扩展虚拟网络所需的参数。 |
|
指定在 SDA 环境中要管理的站点类型。可接受的值为 ‘fabric_site’ 和 ‘fabric_zone’。默认值为 ‘fabric_site’，表示配置更广泛的网络区域，而 ‘fabric_zone’ 通常是指站点内更具体的网段。 默认值： |
|
此名称唯一标识用于创建/更新/删除任何三层虚拟网络等操作的站点。 |
|
虚拟网络必须在创建任何播网关之前添加到站点。不允许更新此字段。它仅由字母、数字和下划线组成，并且长度必须在 1-16 个字符之间。 |
|
设置为 True 以在应用 playbook 配置后验证 Cisco Catalyst Center 配置。 选择
|
|
定义 API 调用以检索任务详细信息的超时时间（以秒为单位）。如果在此期间未收到任务详细信息，则该过程将结束，并且将记录超时通知。 默认值： |
|
指示是否在 Cisco Catalyst Center SDK 中启用调试。 选择
|
|
Cisco Catalyst 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) 模式打开。- 在共享文件场景中，如果没有追加模式，则每次模块执行后都会覆盖内容。- 对于共享日志文件，请将第一个模块的 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 Catalyst Center 进行身份验证的密码。 |
|
指定与 Cisco Catalyst Center 关联的端口号。 默认值： |
|
指定 API 之间检索任务详细信息的连续调用之间的间隔（以秒为单位）。 默认值： |
|
用于在 Cisco Catalyst Center 进行身份验证的用户名。 默认值： |
|
启用或禁用 SSL 证书验证的标志。 选择
|
|
指定 SDK 应使用的 Cisco Catalyst Center 的版本。 默认值： |
|
模块完成后 Cisco Catalyst Center 的状态。 选择
|
|
Cisco Catalyst Center SDK 的标志，用于启用根据 JSON 架构验证请求主体。 选择
|
说明
注意
为了确保该模块对于涉及创建、更新或删除二层 Fabric VLAN 和三层虚拟网络以及配置任意播网关的扩展集正常运行，playbook 中需要有效的输入。如果遇到任何故障，模块将停止执行，而不会继续进行进一步的操作。
要在 Fabric 站点上删除 Fabric VLAN，如果该站点中存在任何 Fabric 区域，则必须先从 Fabric 区域中删除 Fabric VLAN。仅当从 Fabric 区域中删除所有 Fabric VLAN 后，父 Fabric 站点（带有 VLAN）才可用于删除。
对于三层虚拟网络，必须先删除与给定虚拟网络关联的所有任意播网关，然后才能启用虚拟网络的删除操作。
所有新创建的三层虚拟网络都必须分配给一个或多个 Fabric 站点，或者它们都不得分配给任何 Fabric 站点。
要根据模块设计创建或更新 Fabric VLAN，必须将 vlan_id 参数作为必需的输入提供。尽管在 GUI 中它是可选参数，但为了唯一标识 VLAN，需要 vlan 以及 Fabric 站点位置。
使用的 SDK 方法是 ccc_virtual_network.sda.get_site ccc_virtual_network.sda.get_fabric_sites ccc_virtual_network.sda.get_fabric_zones ccc_virtual_network.sda.get_layer2_virtual_networks ccc_virtual_network.sda.add_layer2_virtual_networks ccc_virtual_network.sda.update_layer2_virtual_networks ccc_virtual_network.sda.delete_layer2_virtual_network_by_id ccc_virtual_network.sda.get_layer3_virtual_networks ccc_virtual_network.sda.add_layer3_virtual_networks ccc_virtual_network.sda.update_layer3_virtual_networks ccc_virtual_network.sda.delete_layer3_virtual_network_by_id ccc_virtual_network.sda.get_reserve_ip_subpool ccc_virtual_network.sda.get_anycast_gateways ccc_virtual_network.sda.add_anycast_gateways ccc_virtual_network.sda.update_anycast_gateways ccc_virtual_network.sda.delete_anycast_gateway_by_id
不支持
check_mode该插件在控制节点上运行，不使用任何 ansible 连接插件，而是使用 Cisco Catalyst Center SDK 中的嵌入式连接管理器
以 dnac_ 开头的参数由 Cisco Catalyst Center Python SDK 用于建立连接
示例
- name: Create Layer2 Fabric VLAN for SDA for sda in Cisco Catalyst Center.
cisco.dnac.sda_fabric_virtual_networks_workflow_manager:
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: false
state: merged
config:
- fabric_vlan:
- vlan_name: "vlan_test1"
fabric_site_locations:
- site_name_hierarchy: "Global/India"
fabric_type: "fabric_site"
- site_name_hierarchy: "Global/India/Chennai"
fabric_type: "fabric_zone"
vlan_id: 1333
traffic_type: "DATA"
fabric_enabled_wireless: false
- vlan_name: "vlan_test2"
fabric_site_locations:
- site_name_hierarchy: "Global/USA"
fabric_type: "fabric_site"
vlan_id: 1334
traffic_type: "VOICE"
fabric_enabled_wireless: false
- name: Update Layer 2 Fabric VLAN for SDA in Cisco Catalyst Center.
cisco.dnac.sda_fabric_virtual_networks_workflow_manager:
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: false
state: merged
config:
- fabric_vlan:
- vlan_name: "vlan_test1"
fabric_site_locations:
- site_name_hierarchy: "Global/India"
fabric_type: "fabric_site"
- site_name_hierarchy: "Global/India/Chennai"
fabric_type: "fabric_zone"
vlan_id: 1333
traffic_type: "VOICE"
fabric_enabled_wireless: true
- name: Deleting Layer 2 Fabric VLAN from the Cisco Catalyst Center.
cisco.dnac.sda_fabric_virtual_networks_workflow_manager:
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: false
state: deleted
config:
- fabric_vlan:
- vlan_name: "vlan_test1"
fabric_site_locations:
- site_name_hierarchy: "Global/India/Chennai"
fabric_type: "fabric_zone"
vlan_id: 1333
- name: Create layer3 Virtual Network and anchored the site to the VN as well.
cisco.dnac.sda_fabric_virtual_networks_workflow_manager:
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: false
state: merged
config:
- virtual_networks:
- vn_name: "vn_with_anchor"
fabric_site_locations:
- site_name_hierarchy: "Global/India"
fabric_type: "fabric_site"
anchored_site_name: "Global/India"
- name: Create layer3 Virtual Network and extend it to multiple fabric sites.
cisco.dnac.sda_fabric_virtual_networks_workflow_manager:
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: false
state: merged
config:
- virtual_networks:
- vn_name: "vn_test"
fabric_site_locations:
- site_name_hierarchy: "Global/India"
fabric_type: "fabric_site"
- site_name_hierarchy: "Global/USA"
fabric_type: "fabric_site"
- name: Update layer3 Virtual Network in the Cisco Catalyst Center.
cisco.dnac.sda_fabric_virtual_networks_workflow_manager:
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: false
state: merged
config:
- virtual_networks:
- vn_name: "vn_test"
fabric_site_locations:
- site_name_hierarchy: "Global/India"
fabric_type: "fabric_site"
- site_name_hierarchy: "Global/USA"
fabric_type: "fabric_site"
- site_name_hierarchy: "Global/China"
fabric_type: "fabric_site"
- name: Deleting layer3 Virtual Network from the Cisco Catalyst Center.
cisco.dnac.sda_fabric_virtual_networks_workflow_manager:
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: false
state: deleted
config:
- virtual_networks:
- vn_name: "vlan_test1"
- name: Create the Anycast gateway(s) for SDA in Catalsyt Center.
cisco.dnac.sda_fabric_virtual_networks_workflow_manager:
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: false
state: merged
config:
- anycast_gateways:
- vn_name: "VN_Anycast"
fabric_site_location:
site_name_hierarchy: "Global/India"
fabric_type: "fabric_site"
ip_pool_name: "IP_Pool_1"
tcp_mss_adjustment: 580
traffic_type: "DATA"
is_critical_pool: false
auto_generate_vlan_name: true
- name: Update the Anycast gateway(s) for SDA in Catalsyt Center.
cisco.dnac.sda_fabric_virtual_networks_workflow_manager:
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: false
state: merged
config:
- anycast_gateways:
- vn_name: "VN_India"
fabric_site_location:
site_name_hierarchy: "Global/India"
fabric_type: "fabric_site"
ip_pool_name: "Reserve_Ip_Abhi_pool"
tcp_mss_adjustment: 590
traffic_type: "DATA"
is_critical_pool: false
layer2_flooding_enabled: false
multiple_ip_to_mac_addresses: false
- name: Deleting Anycast Gateway from the Cisco Catalyst Center.
cisco.dnac.sda_fabric_virtual_networks_workflow_manager:
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: false
state: deleted
config:
- anycast_gateways:
- vn_name: "vlan_test1"
fabric_site_location:
site_name_hierarchy: "Global/India"
fabric_type: "fabric_site"
ip_pool_name: "IP_Pool_1"
返回值
通用返回值记录在此处此处，以下是此模块独有的字段
键 |
描述 |
|---|---|
包含 Cisco Catalyst Center Python SDK 返回的响应的字典或列表 返回：始终 示例： |