cisco.dnac.sda_extranet_policies_workflow_manager 模块 – SDA 外联网策略模块提供在 Cisco Catalyst Center 中管理 SD-Access 外联网策略的功能。
注意
此模块是 cisco.dnac 集合 (版本 6.25.0) 的一部分。
如果您使用的是 ansible 软件包，则可能已经安装了此集合。它不包含在 ansible-core 中。要检查它是否已安装，请运行 ansible-galaxy collection list。
要安装它，请使用： ansible-galaxy collection install cisco.dnac。您需要其他要求才能使用此模块，请参阅 要求 了解详细信息。
要在 playbook 中使用它，请指定： cisco.dnac.sda_extranet_policies_workflow_manager。
cisco.dnac 6.17.0 中的新增功能
概要
管理 SD-Access 外联网策略操作，例如在 Cisco Catalyst Center 中创建、更新或删除外联网策略。
创建新的外联网策略的 API。
更新现有或编辑现有外联网策略的 API。
使用策略名称删除现有外联网策略的 API。
要求
在执行此模块的主机上需要以下要求。
dnacentersdk == 2.7.0
python >= 3.9
参数
参数 |
注释 |
|---|---|
用于创建、更新或删除操作的外联网策略详细信息列表。 |
|
SDA 外联网策略的名称。 用于创建、更新或删除策略。 所有操作（创建、更新、删除）都需要。 设置后无法修改。 |
|
指定将应用此外联网策略的结构站点。 在应用策略之前，必须已将提供商虚拟网络添加到结构站点。 允许更新此字段，但是一旦外联网策略应用于某个站点，就无法将其删除。 连接到同一 SD-Access 传输的结构站点必须具有一致的外联网策略。 选择连接到 SD-Access 传输的结构站点将自动选择连接到该传输的所有其他站点。 示例 - [“Global/USA/San Jose/Building23”, “Global/India/Bangalore/Building18”] |
|
指定包含订户需要访问的共享服务资源的提供商虚拟网络。 如果虚拟网络已定义为提供商，则无法再次将其分配为提供商。 如果将 INFRA_VN 定义为提供商，请确保全局路由表中存在默认路由。 对于具有多个提供商且具有重叠路由的订户虚拟网络，流量将在这些提供商虚拟网络之间进行负载均衡。 创建或更新策略需要。 不允许更新此字段。 |
|
指定需要访问包含共享服务资源的提供商虚拟网络的订户虚拟网络列表。 先前定义为提供商的虚拟网络不能选择为订户。 创建或更新策略需要。 可以修改。 示例 - [“VN_2”, “VN_4”] |
|
设置为 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模式验证请求正文。 选项
|
注释
注意
使用的SDK方法为sites.Sites.get_site sda.SDA.get_fabric_sites sda.SDA.get_extranet_policies sda.SDA.add_extranet_policy sda.SDA.update_extranet_policy sda.SDA.delete_extranet_policy_by_id task.Task.get_task_by_id
使用的路径为get /dna/intent/api/v1/site get /dna/intent/api/v1/sda/fabricSites get /dna/intent/api/v1/sda/extranetPolicies post /dna/intent/api/v1/sda/extranetPolicies put /dna/intent/api/v1/sda/extranetPolicies delete dna/intent/api/v1/sda/extranetPolicies/${id} get /dna/intent/api/v1/task/{taskId}
不支持
check_mode插件在控制节点上运行，不使用任何Ansible连接插件，而是使用来自Cisco Catalyst Center SDK的嵌入式连接管理器。
以dnac_开头的参数由Cisco Catalyst Center Python SDK用于建立连接。
示例
- name: Create Extranet Policy
cisco.dnac.sda_extranet_policies_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: true
state: merged
config:
- extranet_policy_name: "test_extranet_policy_1"
provider_virtual_network: "VN_1"
subscriber_virtual_networks: ["VN_2", "VN_3"]
- name: Create Extranet Policy with Fabric Site(s) specified
cisco.dnac.sda_extranet_policies_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: true
state: merged
config:
- extranet_policy_name: "test_extranet_policy_1"
provider_virtual_network: "VN_1"
subscriber_virtual_networks: ["VN_2", "VN_3"]
fabric_sites: ["Global/Test_Extranet_Polcies/USA", "Global/Test_Extranet_Polcies/India"]
- name: Update existing Extranet Policy
cisco.dnac.sda_extranet_policies_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: true
state: merged
config:
- extranet_policy_name: "test_extranet_policy_1"
provider_virtual_network: "VN_1"
subscriber_virtual_networks: ["VN_2", "VN_4"]
- name: Update existing Extranet Policy with Fabric Site(s) specified
cisco.dnac.sda_extranet_policies_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: true
state: merged
config:
- extranet_policy_name: "test_extranet_policy_1"
fabric_sites: ["Global/Test_Extranet_Polcies/USA", "Global/Test_Extranet_Polcies/India"]
provider_virtual_network: "VN_1"
subscriber_virtual_networks: ["VN_2", "VN_4"]
- name: Delete Extranet Policy
cisco.dnac.sda_extranet_policies_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: true
state: deleted
config:
- extranet_policy_name: "test_extranet_policy_1"
返回值
常见的返回值已在此处记录，以下是此模块独有的字段。
键 |
描述 |
|---|---|
包含Cisco Catalyst Center Python SDK返回的响应的字典。 返回：始终 示例： |
|
包含Cisco Catalyst Center Python SDK返回的响应的字典。 返回：始终 示例： |