cisco.dnac.sda_fabric_devices_layer2_handoffs 模块 – SDA Fabric 设备二层切换资源模块

注意

此模块是 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。

cisco.dnac 6.14.0 中的新增功能

摘要 

此模块表示模块 sda_fabric_devices_layer2_handoffs_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"`
fabricId 字符串	FabricId 查询参数。此设备所属的结构域的 ID。
id 字符串	Id 路径参数。结构域设备的二层切换的 ID。
networkDeviceId 字符串	NetworkDeviceId 查询参数。结构域设备的网络设备 ID。
payload 列表 / 元素=字典	SDA Fabric 设备二层切换的有效负载。
externalVlanId 整数	必须扩展结构域的外部 VLAN 号。允许的 VLAN 范围是 2-4094，但保留 VLAN (1、1002-1005、2046、4094) 除外。
fabricId 字符串	分配给此设备的结构域的 ID。
interfaceName 字符串	二层切换的接口名称。例如，GigabitEthernet1/0/4。
internalVlanId 整数	与此结构域关联的 VLAN 号。允许的 VLAN 范围是 2-4094，但保留 VLAN (1、1002-1005、2046、4094) 除外。
networkDeviceId 字符串	结构域设备的网络设备 ID。
validate_response_schema 布尔值	用于 Cisco DNA Center SDK 的标志，用于启用针对 JSON 架构的请求正文验证。选项 `false` `true` ← (默认)

注释 

注意

使用的 SDK 方法是 sda.Sda.add_fabric_devices_layer2_handoffs_v1、sda.Sda.delete_fabric_device_layer2_handoff_by_id_v1，
使用的路径是 post /dna/intent/api/v1/sda/fabricDevices/layer2Handoffs、delete /dna/intent/api/v1/sda/fabricDevices/layer2Handoffs、delete /dna/intent/api/v1/sda/fabricDevices/layer2Handoffs/{id}，
需要注意的是，此模块是 sda_fabric_devices_layer2_handoffs_v1 的别名。
不支持 check_mode
该插件在控制节点上运行，不使用任何 Ansible 连接插件，而是使用 Cisco DNAC SDK 中的嵌入式连接管理器。
以 dnac_ 开头的参数由 Cisco DNAC Python SDK 用于建立连接。

另请参阅 

另请参阅

有关 SDA AddFabricDevicesLayer2HandoffsV1 的 Cisco DNA Center 文档: AddFabricDevicesLayer2HandoffsV1 API 的完整参考。
思科 DNA Center SDA DeleteFabricDeviceLayer2HandoffByIdV1 文档: DeleteFabricDeviceLayer2HandoffByIdV1 API 的完整参考。
思科 DNA Center SDA DeleteFabricDeviceLayer2HandoffsV1 文档: DeleteFabricDeviceLayer2HandoffsV1 API 的完整参考。

示例 

- name: Delete all
  cisco.dnac.sda_fabric_devices_layer2_handoffs:
    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:
    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:
    - externalVlanId: 0
      fabricId: string
      interfaceName: string
      internalVlanId: 0
      networkDeviceId: string

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