cisco.dnac.sda_fabric_transits_workflow_manager 模块 – 用于 SDA 架构传输的资源模块
注意
此模块是 cisco.dnac 集合 (版本 6.25.0) 的一部分。
如果您使用的是 ansible 包，您可能已经安装了此集合。它不包含在 ansible-core 中。要检查是否已安装，请运行 ansible-galaxy collection list。
要安装它，请使用：ansible-galaxy collection install cisco.dnac。您需要其他要求才能使用此模块，请参阅 要求 以获取详细信息。
要在剧本中使用它，请指定：cisco.dnac.sda_fabric_transits_workflow_manager。
cisco.dnac 6.18.0 中的新功能
概要
管理 SDA 架构传输上的操作。
用于创建传输网络的 API。
用于更新传输网络的 API。
用于删除传输网络的 API。
要求
执行此模块的主机需要满足以下要求。
dnacentersdk >= 2.9.2
python >= 3.9
参数
参数 |
注释 |
|---|---|
SDA 架构传输配置的列表。 列表中的每个条目都表示一个传输网络配置。 |
|
SDA 架构传输配置。 |
|
基于 IP 的传输的配置设置。 当类型设置为 IP_BASED_TRANSIT 时必需。 IP_BASED_TRANSIT 无法更新。 |
|
由 BGP 等路由协议使用，用于管理不同自治系统之间的路由。 自治系统编号 (ANS) 应介于 1 到 4294967295 之间。 每个基于 IP 的传输的 ASN 应该是唯一的。 当 transit_type 设置为 IP_BASED_TRANSIT 时必需。 |
|
定义用于确定网络之间数据传输的最佳路径的协议。 选项
|
|
SDA 架构传输的名称。 它有助于不同网络段之间的无缝通信。 对于 SDA 架构传输中的操作是必需的。 |
|
基于 SDA 的传输的配置设置。 当 transit_type 设置为 SDA_LISP_PUB_SUB_TRANSIT 或 SDA_LISP_BGP_TRANSIT 时必需。 |
|
指定构成控制平面的网络设备的 IP 地址。 当 transit_type 设置为 SDA_LISP_BGP_TRANSIT 或 SDA_LISP_PUB_SUB_TRANSIT 时必需。 至少需要一个控制平面网络设备。 当 transit_type 为 SDA_LISP_BGP_TRANSIT 时，最多允许 2 个控制平面网络设备。 当 transit_type 为 SDA_LISP_PUB_SUB_TRANSIT 时，最多允许 4 个控制平面网络设备。 SDA_LISP_PUB_SUB_TRANSIT 仅支持 IOS XE 17.6 或更高版本的设备。 这些设备必须存在于架构站点或区域中。 |
|
确定是否允许组播流量遍历传输网络。 启用此选项允许将数据分发到不同网络段的多个接收者。 仅当传输类型设置为 SDA_LISP_PUB_SUB_TRANSIT 时才可用。 选项
|
|
架构传输的类型。IP_BASED_TRANSIT - 负责管理 IP 路由并确保网络各个段之间的数据流。SDA_LISP_PUB_SUB_TRANSIT - 促进设备的位置和身份信息的解耦，从而实现动态路由。SDA_LISP_BGP_TRANSIT - 将 LISP 与 BGP 集成，以管理和优化不同网络段之间的路由决策。 选项
|
|
设置为 True 以在应用剧本配置后验证 Cisco Catalyst Center。 选项
|
|
定义 API 调用以检索任务详细信息的超时时间（以秒为单位）。如果在此期间未收到任务详细信息，则该过程将结束，并且将记录超时通知。 默认值： |
|
指示是否在 Cisco Catalyst Center SDK 中启用了调试。 选项
|
|
Cisco Catalyst 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) 模式打开。- 在共享文件场景中，如果没有追加模式，每次模块执行后内容都会被覆盖。- 对于共享日志文件，第一个模块将追加设置为 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 模式验证请求正文。 选项
|
备注
注意
使用的 SDK 方法是 devices.Devices.get_device_list、sda.Sda.get_transit_networks、sda.Sda.add_transit_networks、sda.Sda.update_transit_networks、sda.Sda.delete_transit_network_by_id、task.Task.get_tasks_by_id、task.Task.get_task_details_by_id。
使用的路径是 get /dna/intent/api/v1/network-device、get /dna/intent/api/v1/sda/transitNetworks、post /dna/intent/api/v1/sda/transitNetworks、put /dna/intent/api/v1/sda/transitNetworks、delete /dna/intent/api/v1/sda/transitNetworks/${id}、get /dna/intent/api/v1/tasks/${id}、get /dna/intent/api/v1/tasks/${id}/detail
不支持
check_mode该插件在控制节点上运行，不使用任何 Ansible 连接插件，而是使用来自 Cisco Catalyst Center SDK 的嵌入式连接管理器。
以 dnac_ 开头的参数由 Cisco Catalyst Center Python SDK 用于建立连接。
示例
- name: Create SDA fabric transit of transit_type IP_BASED_TRANSIT
cisco.dnac.sda_fabric_transits_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: True
dnac_log_level: "{{ dnac_log_level }}"
state: merged
config_verify: True
config:
- sda_fabric_transits:
- name: sample_transit
transit_type: IP_BASED_TRANSIT
ip_transit_settings:
routing_protocol_name: BGP
autonomous_system_number: 1234
- name: Create SDA fabric transit of transit_type SDA_LISP_BGP_TRANSIT
cisco.dnac.sda_fabric_transits_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: True
dnac_log_level: "{{ dnac_log_level }}"
state: merged
config_verify: True
config:
- sda_fabric_transits:
- name: sample_transit
transit_type: SDA_LISP_BGP_TRANSIT
sda_transit_settings:
control_plane_network_device_ips:
- string
- string
- name: Create SDA fabric transit of transit_type SDA_LISP_PUB_SUB_TRANSIT
cisco.dnac.sda_fabric_transits_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: True
dnac_log_level: "{{ dnac_log_level }}"
state: merged
config_verify: True
config:
- sda_fabric_transits:
- name: sample_transit
transit_type: SDA_LISP_PUB_SUB_TRANSIT
sda_transit_settings:
is_multicast_over_transit_enabled: false
control_plane_network_device_ips:
- string
- string
- string
- string
- name: Update SDA fabric transit of transit_type SDA_LISP_BGP_TRANSIT
cisco.dnac.sda_fabric_transits_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: True
dnac_log_level: "{{ dnac_log_level }}"
state: merged
config_verify: True
config:
- sda_fabric_transits:
- name: sample_transit
transit_type: SDA_LISP_BGP_TRANSIT
sda_transit_settings:
control_plane_network_device_ips:
- string
- string
- name: Update the multicast over transit
cisco.dnac.sda_fabric_transits_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: True
dnac_log_level: "{{ dnac_log_level }}"
state: merged
config_verify: True
config:
- sda_fabric_transits:
- name: sample_transit
transit_type: SDA_LISP_PUB_SUB_TRANSIT
sda_transit_settings:
is_multicast_over_transit_enabled: true
- name: Update the control plane network devices
cisco.dnac.sda_fabric_transits_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: True
dnac_log_level: "{{ dnac_log_level }}"
state: merged
config_verify: True
config:
- sda_fabric_transits:
- name: sample_transit
transit_type: SDA_LISP_PUB_SUB_TRANSIT
sda_transit_settings:
control_plane_network_device_ips:
- string
- string
- string
- name: Delete SDA fabric transit
cisco.dnac.sda_fabric_transits_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: True
dnac_log_level: "{{ dnac_log_level }}"
state: deleted
config_verify: True
config:
- sda_fabric_transits:
- name: sample_transit1
- name: sample_transit2
返回值
常见的返回值记录在 此处，以下是此模块独有的字段
键 |
描述 |
|---|---|
包含 Cisco Catalyst Center Python SDK 返回的响应的字典或列表。 返回： 总是 示例： |
|
包含 Cisco Catalyst Center Python SDK 返回的响应的字典或列表。 返回： 总是 示例： |
|
包含 Cisco Catalyst Center Python SDK 返回的响应的字典或列表。 返回： 总是 示例： |