cisco.dnac.transit_peer_network 模块 – 跨站点对等网络资源模块

注意

此模块是 cisco.dnac 集合 (版本 6.25.0) 的一部分。

如果您使用的是 ansible 包，则可能已安装此集合。它不包含在 ansible-core 中。要检查它是否已安装，请运行 ansible-galaxy collection list。

要安装它，请使用： ansible-galaxy collection install cisco.dnac。您需要其他要求才能使用此模块，有关详细信息，请参阅 要求。

要在剧本中使用它，请指定： cisco.dnac.transit_peer_network。

cisco.dnac 6.0.0 中的新增功能

概要

  • 此模块表示模块 transit_peer_network_v1 的别名。

注意

此模块具有相应的 操作插件。

要求

在执行此模块的主机上需要以下要求。

  • dnacentersdk >= 2.4.9

  • python >= 3.5

参数

参数

注释

dnac_debug

布尔值

用于 Cisco DNA Center SDK 以启用调试。

选项

  • false ← (默认)

  • true

dnac_host

字符串 / 必需

Cisco DNA Center 主机名。

dnac_password

字符串

用于身份验证的 Cisco DNA Center 密码。

dnac_port

整数

Cisco DNA Center 端口。

默认： 443

dnac_username

别名：user

字符串

用于身份验证的 Cisco DNA Center 用户名。

默认： "admin"

dnac_verify

布尔值

启用或禁用 SSL 证书验证的标志。

选项

  • false

  • true ← (默认)

dnac_version

字符串

告知 SDK 使用哪个版本的 Cisco DNA Center。

默认： "2.3.7.6"

ipTransitSettings

字典

跨站点对等网络的 ipTransitSettings。

autonomousSystemNumber

字符串

自治系统编号。

routingProtocolName

字符串

路由协议名称。

sdaTransitSettings

字典

跨站点对等网络的 sdaTransitSettings。

transitControlPlaneSettings

列表 / 元素=字典

跨站点对等网络的 transitControlPlaneSettings。

deviceManagementIpAddress

字符串

已配置设备的设备管理 IP 地址。

siteNameHierarchy

字符串

已配置设备的站点名称层次结构。

transitPeerNetworkName

字符串

transitPeerNetworkName 查询参数。跨站点对等网络名称。

transitPeerNetworkType

字符串

跨站点对等网络类型。

validate_response_schema

布尔值

用于 Cisco DNA Center SDK 的标志，用于根据 JSON 模式启用请求正文的验证。

选项

  • false

  • true ← (默认)

注释

注意

  • 使用的 SDK 方法为 sda.Sda.add_transit_peer_network_v1、sda.Sda.delete_transit_peer_network_v1，

  • 使用的路径为 post /dna/intent/api/v1/business/sda/transit-peer-network、delete /dna/intent/api/v1/business/sda/transit-peer-network，

  • 需要注意的是，此模块是 transit_peer_network_v1 的别名。

  • 不支持 check_mode

  • 插件在控制节点上运行，不使用任何 Ansible 连接插件，而是使用 Cisco DNAC SDK 中的嵌入式连接管理器。

  • 以 dnac_ 开头的参数由 Cisco DNAC Python SDK 用于建立连接。

另请参见

另请参见

Cisco DNA Center SDA AddTransitPeerNetworkV1 文档

AddTransitPeerNetworkV1 API 的完整参考。

Cisco DNA Center SDA DeleteTransitPeerNetworkV1 文档

DeleteTransitPeerNetworkV1 API 的完整参考。

示例

- name: Delete all
  cisco.dnac.transit_peer_network:
    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}}"
    state: absent
    transitPeerNetworkName: string

- name: Create
  cisco.dnac.transit_peer_network:
    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}}"
    state: present
    ipTransitSettings:
      autonomousSystemNumber: string
      routingProtocolName: string
    sdaTransitSettings:
      transitControlPlaneSettings:
      - deviceManagementIpAddress: string
        siteNameHierarchy: string
    transitPeerNetworkName: string
    transitPeerNetworkType: string

返回值

常见的返回值已在 此处 记录，以下是此模块独有的字段。

键

描述

dnac_response

字典

包含 Cisco DNAC Python SDK 返回的响应的字典或列表。

返回：始终

示例： {"description": "string", "executionId": "string", "executionStatusUrl": "string", "status": "string", "taskId": "string", "taskStatusUrl": "string"}

作者

  • Rafael Campos (@racampos)