cisco.dnac.sda_transit_networks 模块 – Sda 传输网络的资源模块

注意

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

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

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

要在 playbook 中使用它,请指定:cisco.dnac.sda_transit_networks

cisco.dnac 6.15.0 中的新增功能

概要

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

注意

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

要求

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

  • dnacentersdk >= 2.4.9

  • python >= 3.5

参数

参数

注释

dnac_debug

boolean

用于启用 Cisco DNA Center SDK 调试的标志。

选择

  • false ← (默认)

  • true

dnac_host

string / required

Cisco DNA Center 主机名。

dnac_password

string

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

dnac_port

integer

Cisco DNA Center 端口。

默认值: 443

dnac_username

别名:user

string

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

默认值: "admin"

dnac_verify

boolean

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

选择

  • false

  • true ← (默认)

dnac_version

string

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

默认值: "2.3.7.6"

payload

list / elements=dictionary

Sda 传输网络的 payload。

id

string

传输网络的 ID(不允许更新此字段)。

ipTransitSettings

dictionary

Sda 传输网络的 ipTransitSettings。

autonomousSystemNumber

string

IP 传输网络的自治系统号。允许的范围是 1 到 4294967295(不允许更新此字段)。

routingProtocolName

string

IP 传输网络的路由协议名称(不允许更新此字段)。

name

string

传输网络的名称(不允许更新此字段)。

sdaTransitSettings

dictionary

Sda 传输网络的 sdaTransitSettings。

controlPlaneNetworkDeviceIds

list / elements=string

将用作控制平面节点的网络设备 ID 列表。对于 SDA_LISP_BGP_TRANSIT 类型的传输,最多可提供 2 个网络设备 ID,对于 SDA_LISP_PUB_SUB_TRANSIT 类型的传输,最多可提供 4 个网络设备 ID。

isMulticastOverTransitEnabled

boolean

将此设置为 true 以启用 SD-Access 传输上的多播。这支持 SD-Access 传输上的本机多播。这仅适用于 SDA_LISP_PUB_SUB_TRANSIT 类型的传输。

选择

  • false

  • true

type

string

传输网络的类型(不允许更新此字段)。

validate_response_schema

boolean

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

选择

  • false

  • true ← (默认)

注释

注意

  • 使用的 SDK 方法是 sda.Sda.add_transit_networks_v1、sda.Sda.update_transit_networks_v1,

  • 使用的路径是 post /dna/intent/api/v1/sda/transitNetworks、put /dna/intent/api/v1/sda/transitNetworks,

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

  • 不支持 check_mode

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

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

另请参阅

另请参阅

SDA AddTransitNetworksV1 的 Cisco DNA Center 文档

AddTransitNetworksV1 API 的完整参考。

SDA UpdateTransitNetworksV1 的 Cisco DNA Center 文档

UpdateTransitNetworksV1 API 的完整参考。

示例

- name: Update all
  cisco.dnac.sda_transit_networks:
    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
    payload:
    - id: string
      ipTransitSettings:
        autonomousSystemNumber: string
        routingProtocolName: string
      name: string
      sdaTransitSettings:
        controlPlaneNetworkDeviceIds:
        - string
        isMulticastOverTransitEnabled: true
      type: string

- name: Create
  cisco.dnac.sda_transit_networks:
    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
    payload:
    - ipTransitSettings:
        autonomousSystemNumber: string
        routingProtocolName: string
      name: string
      sdaTransitSettings:
        controlPlaneNetworkDeviceIds:
        - string
        isMulticastOverTransitEnabled: true
      type: string

返回值

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

描述

dnac_response

dictionary

一个字典或列表,其中包含 Cisco DNAC Python SDK 返回的响应

已返回: 始终

示例: {"response": {"taskId": "string", "url": "string"}, "version": "string"}

作者

  • Rafael Campos (@racampos)