cisco.dnac.transit_peer_network_info 模块 – Transit Peer Network Info 的信息模块

注意

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

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

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

要在 Playbook 中使用它,请指定:cisco.dnac.transit_peer_network_info

cisco.dnac 6.0.0 中的新增功能

概要

  • 此模块表示模块 transit_peer_network_v1_info 的别名

注意

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

要求

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

  • dnacentersdk >= 2.4.9

  • python >= 3.5

参数

参数

注释

dnac_debug

boolean

用于 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

boolean

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

选择

  • false

  • true ←(默认)

dnac_version

字符串

通知 SDK 要使用的 Cisco DNA Center 版本。

默认值: "2.3.7.6"

headers

字典

其他标头。

transitPeerNetworkName

字符串

TransitPeerNetworkName 查询参数。Transit 或 Peer 网络名称。

validate_response_schema

boolean

用于 Cisco DNA Center SDK 启用针对 JSON 模式验证请求体的标志。

选择

  • false

  • true ←(默认)

注意

注意

  • 使用的 SDK 方法是 sda.Sda.get_transit_peer_network_info_v1,

  • 使用的路径是 get /dna/intent/api/v1/business/sda/transit-peer-network,

  • 应该注意的是,此模块是 transit_peer_network_v1_info 的别名

  • 支持 check_mode

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

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

另请参阅

另请参阅

有关 SDA GetTransitPeerNetworkInfoV1 的 Cisco DNA Center 文档

GetTransitPeerNetworkInfoV1 API 的完整参考。

示例

- name: Get all Transit Peer Network Info
  cisco.dnac.transit_peer_network_info:
    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}}"
    headers: "{{my_headers | from_json}}"
    transitPeerNetworkName: string
  register: result

返回值

常见的返回值记录在这里,以下是此模块特有的字段

描述

dnac_response

字典

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

已返回: 始终

示例: {"description": "string", "ipTransitSettings": {"autonomousSystemNumber": "string", "routingProtocolName": "string"}, "sdaTransitSettings": {"transitControlPlaneSettings": [{"deviceManagementIpAddress": "string", "siteNameHierarchy": "string"}]}, "status": "string", "transitPeerNetworkId": "string", "transitPeerNetworkName": "string", "transitPeerNetworkType": "string"}

作者

  • Rafael Campos (@racampos)