cisco.dnac.sda_fabric_sites_zones_workflow_manager 模块 – 在 Cisco Catalyst Center 中管理 Fabric 站点/区域并更新身份验证配置文件模板。
注意
此模块是 cisco.dnac 集合（版本 6.25.0）的一部分。
如果您正在使用 ansible 包，则可能已经安装了此集合。它不包含在 ansible-core 中。要检查是否已安装，请运行 ansible-galaxy collection list。
要安装它，请使用：ansible-galaxy collection install cisco.dnac。您需要满足更多要求才能使用此模块，请参阅 要求 了解详细信息。
要在 playbook 中使用它，请指定：cisco.dnac.sda_fabric_sites_zones_workflow_manager。
cisco.dnac 6.17.0 中的新增功能
概要
在 Cisco Catalyst Center 中为 SDA 操作创建 Fabric 站点。
在 Cisco Catalyst Center 中更新 SDA 操作的 Fabric 站点。
在 Cisco Catalyst Center 中为 SDA 操作创建 Fabric 区域。
在 Cisco Catalyst Center 中更新 SDA 操作的 Fabric 区域。
从 Cisco Catalyst Center 中删除 Fabric 站点。
从 Cisco Catalyst Center 中删除 Fabric 区域。
在 Cisco Catalyst Center 中配置 Fabric 站点/区域的身份验证配置文件模板。
要求
在执行此模块的主机上需要满足以下要求。
dnacentersdk >= 2.9.2
python >= 3.9
参数
参数 |
注释 |
|---|---|
一个列表，其中包含用于在软件定义访问 (SDA) 环境中创建、更新或删除 Fabric 站点的详细配置。它还包括用于更新这些站点的身份验证配置文件模板的规范。列表中的每个元素都表示要在 SDA 基础设施上执行的特定操作，例如添加、修改或删除 Fabric 站点/区域，以及修改身份验证配置文件。 |
|
一个字典，其中包含用于管理 REST 端点的详细配置，这些端点将接收来自 Cisco Catalyst Center 平台的审计日志和事件。此字典对于指定 Fabric 站点、区域和关联身份验证配置文件的生命周期管理所需的属性和参数至关重要。 |
|
应用于指定 Fabric 的身份验证配置文件。此配置文件确定站点内网络访问的安全态势和控制。可能的值包括“关闭身份验证”、“低影响”、“无身份验证”和“打开身份验证”。在创建或更新 Fabric 站点或更新身份验证配置文件模板时，此设置至关重要。 |
|
指定要在 SDA 环境中管理的站点类型。可接受的值为“fabric_site”和“fabric_zone”。默认值为“fabric_site”，表示配置更广泛的网络区域，而“fabric_zone”通常指的是站点内更具体的细分。 |
|
一个布尔标志，指示是否为 Fabric 站点中的控制节点启用 pub/sub 机制。此功能仅在创建或更新 Fabric 站点时相关，而不适用于 Fabric 区域。当设置为 True 时，pub/sub 有助于站点内更高效的通信和控制。Fabric 站点的默认值为 True，此设置不适用于 Fabric 区域。 选项
|
|
此名称唯一标识用于创建、更新或删除 Fabric 站点或区域，以及用于更新身份验证配置文件模板等操作的站点。此参数对于任何 Fabric 站点/区域管理操作都是必需的。 |
|
一个字典，其中包含更新与 Fabric 站点关联的身份验证配置文件模板所需的特定详细信息。这包括微调站点内身份验证过程和安全控制的高级设置。 |
|
指定站点的主要身份验证方法。可用的方法是“dot1x”（IEEE 802.1X）和“mac”（基于 MAC 的身份验证）。此设置确定尝试身份验证机制的顺序。 |
|
从 802.1X 身份验证回退的超时持续时间（以秒为单位）。此值必须在 3 到 120 秒的范围内。它定义了如果 802.1X 失败，设备在尝试替代身份验证方法之前等待的时间段。 |
|
一个布尔值设置，用于启用或禁用 BPDU Guard。BPDU Guard 提供了一种安全机制，当接收到 BPDU（桥协议数据单元）时，会禁用端口，从而防止潜在的网络环路。此设置默认为 true，仅当身份验证配置文件设置为“封闭身份验证”时适用。 选项
|
|
指定每个端口允许的主机数量。可用选项为 ‘Single’（每个端口一个设备）或 ‘Unlimited’（多个设备）。此设置有助于控制网络访问并维护安全性。 |
|
一个布尔值，指示是否启用了 Wake-on-LAN 功能。Wake-on-LAN 允许网络远程唤醒处于低功耗状态的设备。 选项
|
|
设置为 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) 模式打开。- 在共享文件场景中，如果没有追加模式，则在每次模块执行后内容将被覆盖。- 对于共享日志文件，请为第一个模块将追加设置为 False（以覆盖）；对于后续模块，将追加设置为 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 站点/区域以及处理身份验证配置文件模板更新的扩展集正确运行，请在 playbook 中提供有效的输入。如果遇到任何故障，模块将停止执行，而不会继续进行进一步的操作。
删除 Fabric 站点时，请确保在 playbook 中提供输入以删除与其关联的 Fabric 区域。在删除所有基础 Fabric 区域之前，无法删除 Fabric 站点，并且可以按照模块设计以任何顺序进行操作，Fabric 区域将首先被删除，然后是 Fabric 站点。
参数 “site_name” 已更新为 “site_name_hierarchy”。
使用的 SDK 方法为 ccc_fabric_sites.FabricSitesZones.get_site ccc_fabric_sites.FabricSitesZones.get_fabric_sites ccc_fabric_sites.FabricSitesZones.get_fabric_zones ccc_fabric_sites.FabricSitesZones.add_fabric_site ccc_fabric_sites.FabricSitesZones.update_fabric_site ccc_fabric_sites.FabricSitesZones.add_fabric_zone ccc_fabric_sites.FabricSitesZones.update_fabric_zone ccc_fabric_sites.FabricSitesZones.get_authentication_profiles ccc_fabric_sites.FabricSitesZones.update_authentication_profile ccc_fabric_sites.FabricSitesZones.delete_fabric_site_by_id ccc_fabric_sites.FabricSitesZones.delete_fabric_zone_by_id
不支持
check_mode该插件在控制节点上运行，不使用任何 ansible 连接插件，而是使用来自 Cisco Catalyst Center SDK 的嵌入式连接管理器
以 dnac_ 开头的参数由 Cisco Catalyst Center Python SDK 用于建立连接
示例
- name: Create a fabric site for SDA with the specified name.
cisco.dnac.sda_fabric_sites_zones_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_sites:
- site_name_hierarchy: "Global/Test_SDA/Bld1"
authentication_profile: "Closed Authentication"
is_pub_sub_enabled: False
- name: Update a fabric site for SDA with the specified name.
cisco.dnac.sda_fabric_sites_zones_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_sites:
- site_name_hierarchy: "Global/Test_SDA/Bld1"
authentication_profile: "Open Authentication"
- name: Update a fabric zone for SDA with the specified name.
cisco.dnac.sda_fabric_sites_zones_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_sites:
- site_name_hierarchy: "Global/Test_SDA/Bld1/Floor1"
fabric_type: "fabric_zone"
authentication_profile: "Closed Authentication"
- name: Update fabric zone for sda with given name.
cisco.dnac.sda_fabric_sites_zones_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_sites:
- site_name_hierarchy: "Global/Test_SDA/Bld1/Floor1"
fabric_type: "fabric_zone"
authentication_profile: "Open Authentication"
- name: Update/customise authentication profile template for fabric site/zone.
cisco.dnac.sda_fabric_sites_zones_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_sites:
- site_name_hierarchy: "Global/Test_SDA/Bld1"
fabric_type: "fabric_zone"
authentication_profile: "Open Authentication"
is_pub_sub_enabled: False
update_authentication_profile:
authentication_order: "dot1x"
dot1x_fallback_timeout: 28
wake_on_lan: False
number_of_hosts: "Single"
- name: Deleting/removing fabric site from sda from Cisco Catalyst Center
cisco.dnac.sda_fabric_sites_zones_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_sites:
- site_name_hierarchy: "Global/Test_SDA/Bld1"
- name: Deleting/removing fabric zone from sda from Cisco Catalyst Center
cisco.dnac.sda_fabric_sites_zones_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_sites:
- site_name_hierarchy: "Global/Test_SDA/Bld1/Floor1"
fabric_type: "fabric_zone"
返回值
常见返回值在此处记录 此处，以下是此模块独有的字段
键 |
描述 |
|---|---|
包含 Cisco Catalyst Center Python SDK 返回的响应的字典或列表 返回： 始终 示例： |