cisco.dnac.sda_fabric_devices_layer2_handoffs_ip_transits 模块 – SDA Fabric 设备 Layer2 交接 IP 转接的资源模块

注意

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

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

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

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

cisco.dnac 6.14.0 中的新增功能

概要

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

注意

此模块具有相应的 action 插件。

要求

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

• 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"
fabricId 字符串	FabricId 查询参数。此设备所属的结构域的 ID。
id 字符串	Id 路径参数。结构域设备的具有 IP 转接的 Layer 3 交接的 ID。
networkDeviceId 字符串	NetworkDeviceId 查询参数。结构域设备的网络设备 ID。
payload 列表 / 元素=字典	SDA Fabric 设备 Layer2 交接 IP 转接的有效负载。
externalConnectivityIpPoolName 字符串	Catalyst Center 将使用外部连接 IP 池为边界节点和对等体之间的连接分配 IP 地址。
fabricId 字符串	分配给此设备的结构域的 ID。
interfaceName 字符串	Layer 3 交接 IP 转接的接口名称。
localIpAddress 字符串	所选虚拟网络的本地 IPv4 地址。以 CIDR 表示法输入 IP 地址和子网掩码（IP 地址/前缀长度）。如果您已提供外部连接 IP 池名称，则不适用。
localIpv6Address 字符串	所选虚拟网络的本地 IPv6 地址。以 CIDR 表示法输入 IP 地址和子网掩码（IP 地址/前缀长度）。如果您已提供外部连接 IP 池名称，则不适用。
networkDeviceId 字符串	结构域设备的网络设备 ID。
remoteIpAddress 字符串	所选虚拟网络的远程 IPv4 地址。以 CIDR 表示法输入 IP 地址和子网掩码（IP 地址/前缀长度）。如果您已提供外部连接 IP 池名称，则不适用。
remoteIpv6Address 字符串	所选虚拟网络的远程 IPv6 地址。以 CIDR 表示法输入 IP 地址和子网掩码（IP 地址/前缀长度）。如果您已提供外部连接 IP 池名称，则不适用。
tcpMssAdjustment 整数	Layer 3 交接的 TCP 最大分段大小 (mss) 值。允许的范围是 500-1440。TCP MSS 调整值适用于 IPv4 和 IPv6 上的 TCP 会话。
transitNetworkId 字符串	Layer 3 交接 IP 转接的转接网络的 ID。
virtualNetworkName 字符串	与此结构域站点关联的虚拟网络的名称。
vlanId 整数	用于与虚拟网络的外部域建立 BGP 对等连接的交换机虚拟接口 (SVI) 的 VLAN 号。允许的 VLAN 范围是 2-4094，但保留 VLAN（1、1002-1005、2046、4094）除外。
validate_response_schema 布尔值	用于 Cisco DNA Center SDK 的标志，用于启用根据 JSON 模式验证请求正文。 选项 false true ← (默认)

备注

注意

• 使用的 SDK 方法是 sda.Sda.add_fabric_devices_layer3_handoffs_with_ip_transit_v1、sda.Sda.delete_fabric_device_layer3_handoff_with_ip_transit_by_id_v1、sda.Sda.update_fabric_devices_layer3_handoffs_with_ip_transit_v1，

• 使用的路径是 post /dna/intent/api/v1/sda/fabricDevices/layer3Handoffs/ipTransits、delete /dna/intent/api/v1/sda/fabricDevices/layer3Handoffs/ipTransits、delete /dna/intent/api/v1/sda/fabricDevices/layer3Handoffs/ipTransits/{id}、put /dna/intent/api/v1/sda/fabricDevices/layer3Handoffs/ipTransits，

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

• 不支持 check_mode

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

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

另请参见

另请参见

有关 SDA AddFabricDevicesLayer3HandoffsWithIpTransitV1 的 Cisco DNA Center 文档

AddFabricDevicesLayer3HandoffsWithIpTransitV1 API 的完整参考。

有关 SDA DeleteFabricDeviceLayer3HandoffWithIpTransitByIdV1 的 Cisco DNA Center 文档

DeleteFabricDeviceLayer3HandoffWithIpTransitByIdV1 API 的完整参考。

有关 SDA DeleteFabricDeviceLayer3HandoffsWithIpTransitV1 的 Cisco DNA Center 文档

DeleteFabricDeviceLayer3HandoffsWithIpTransitV1 API 的完整参考。

Cisco DNA Center SDA UpdateFabricDevicesLayer3HandoffsWithIpTransitV1 文档

UpdateFabricDevicesLayer3HandoffsWithIpTransitV1 API 的完整参考。

示例

- name: Create
  cisco.dnac.sda_fabric_devices_layer2_handoffs_ip_transits:
    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:
    - externalConnectivityIpPoolName: string
      fabricId: string
      interfaceName: string
      localIpAddress: string
      localIpv6Address: string
      networkDeviceId: string
      remoteIpAddress: string
      remoteIpv6Address: string
      tcpMssAdjustment: 0
      transitNetworkId: string
      virtualNetworkName: string
      vlanId: 0

- name: Update all
  cisco.dnac.sda_fabric_devices_layer2_handoffs_ip_transits:
    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:
    - externalConnectivityIpPoolName: string
      fabricId: string
      id: string
      interfaceName: string
      localIpAddress: string
      localIpv6Address: string
      networkDeviceId: string
      remoteIpAddress: string
      remoteIpv6Address: string
      tcpMssAdjustment: 0
      transitNetworkId: string
      virtualNetworkName: string
      vlanId: 0

- name: Delete all
  cisco.dnac.sda_fabric_devices_layer2_handoffs_ip_transits:
    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
    fabricId: string
    networkDeviceId: string

- name: Delete by id
  cisco.dnac.sda_fabric_devices_layer2_handoffs_ip_transits:
    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
    id: string

返回值

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

键	描述
dnac_response 字典	包含 Cisco DNAC Python SDK 返回的响应的字典或列表 返回值：始终返回 示例： {"response": {"taskId": "string", "url": "string"}, "version": "string"}

作者

• Rafael Campos (@racampos)

资源链接

• 问题追踪器
• 代码库 (源代码)