cisco.dnac.sda_fabric_devices_layer2_handoffs_sda_transits 模块 – Sda Fabric Devices Layer2 Handoffs Sda Transits 资源模块

注意

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

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

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

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

cisco.dnac 6.14.0 中的新增功能

概要

  • 此模块表示模块 sda_fabric_devices_layer2_handoffs_sda_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。

networkDeviceId

字符串

NetworkDeviceId 查询参数。结构域设备的网络设备 ID。

payload

列表 / 元素=字典

Sda Fabric Devices Layer2 Handoffs Sda Transits 的有效负载。

affinityIdDecider

整数

边界节点的亲和性 ID 决定值。当多个设备上的亲和性 ID 主要值相同时,亲和性 ID 决定值用作仲裁者。允许的范围是 0-2147483647。亲和性 ID 决定器的相对值越低,对目标边界节点的偏好越高。

affinityIdPrime

整数

边界节点的亲和性 ID 主要值。它取代边界优先级来确定边界节点的偏好。允许的范围是 0-2147483647。亲和性 ID 主要值的相对值越低,对目标边界节点的偏好越高。

connectedToInternet

布尔值

将其设置为 true 以允许关联站点通过 sd-access 为其他站点提供互联网访问。

选项

  • false

  • true

fabricId

字符串

此设备分配到的结构域的 ID。(不允许更新此字段)。

isMulticastOverTransitEnabled

布尔值

将其设置为 true 以配置连接到 sd-access 传输的多个站点上的本地组播。

选项

  • false

  • true

networkDeviceId

字符串

结构域设备的网络设备 ID。(不允许更新此字段)。

transitNetworkId

字符串

第 3 层切换 sda 传输的传输网络的 ID。(不允许更新此字段)。

validate_response_schema

布尔值

用于 Cisco DNA Center SDK 以启用针对 JSON 架构的请求正文验证的标志。

选项

  • false

  • true ← (默认)

备注

注意

  • 使用的 SDK 方法是 sda.Sda.add_fabric_devices_layer3_handoffs_with_sda_transit_v1、sda.Sda.delete_fabric_device_layer3_handoffs_with_sda_transit_v1、sda.Sda.update_fabric_devices_layer3_handoffs_with_sda_transit_v1,

  • 使用的路径为:post /dna/intent/api/v1/sda/fabricDevices/layer3Handoffs/sdaTransits,delete /dna/intent/api/v1/sda/fabricDevices/layer3Handoffs/sdaTransits,put /dna/intent/api/v1/sda/fabricDevices/layer3Handoffs/sdaTransits。

  • 需要注意的是,此模块是sda_fabric_devices_layer2_handoffs_sda_transits_v1的别名。

  • 不支持check_mode

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

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

另请参阅

另请参阅

Cisco DNA Center文档,关于SDA AddFabricDevicesLayer3HandoffsWithSdaTransitV1

AddFabricDevicesLayer3HandoffsWithSdaTransitV1 API的完整参考。

Cisco DNA Center文档,关于SDA DeleteFabricDeviceLayer3HandoffsWithSdaTransitV1

DeleteFabricDeviceLayer3HandoffsWithSdaTransitV1 API的完整参考。

Cisco DNA Center文档,关于SDA UpdateFabricDevicesLayer3HandoffsWithSdaTransitV1

UpdateFabricDevicesLayer3HandoffsWithSdaTransitV1 API的完整参考。

示例

- name: Update all
  cisco.dnac.sda_fabric_devices_layer2_handoffs_sda_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:
    - affinityIdDecider: 0
      affinityIdPrime: 0
      connectedToInternet: true
      fabricId: string
      isMulticastOverTransitEnabled: true
      networkDeviceId: string
      transitNetworkId: string

- name: Delete all
  cisco.dnac.sda_fabric_devices_layer2_handoffs_sda_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: Create
  cisco.dnac.sda_fabric_devices_layer2_handoffs_sda_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:
    - affinityIdDecider: 0
      affinityIdPrime: 0
      connectedToInternet: true
      fabricId: string
      isMulticastOverTransitEnabled: true
      networkDeviceId: string
      transitNetworkId: string

返回值

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

描述

dnac_response

字典

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

返回值:始终返回

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

作者

  • Rafael Campos (@racampos)