cisco.dnac.sda_port_channels_v1 模块 – Sda 端口通道 V1 的资源模块

注意

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

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

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

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

cisco.dnac 6.15.0 中的新功能

概要 

管理资源 Sda 端口通道 V1 的创建、更新和删除操作。
根据用户输入添加端口通道。
根据 ID 删除端口通道。
根据用户输入删除端口通道。
根据用户输入更新端口通道。

注意

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

要求 

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

dnacentersdk >= 2.4.9
python >= 3.5

参数 

参数	注释
connectedDeviceType 字符串	ConnectedDeviceType 查询参数。端口通道的连接设备类型。允许的值为 TRUNK、EXTENDED_NODE。
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 列表 / elements=字典	Sda 端口通道的有效负载。
connectedDeviceType 字符串	端口通道的连接设备类型。
description 字符串	端口通道的描述。
fabricId 字符串	设备分配到的结构的 ID。
interfaceNames 列表 / elements=字符串	此端口通道的接口名称（LACP 协议最多 16 个端口，PAGP 和 ON 协议最多 8 个端口）。
networkDeviceId 字符串	网络设备的 ID。
protocol 字符串	端口通道的协议（如果 connectedDeviceType 为 EXTENDED_NODE，则只允许使用 PAGP）。
portChannelName 字符串	PortChannelName 查询参数。端口通道的名称。
validate_response_schema 布尔值	用于启用针对 JSON 模式验证请求正文的 Cisco DNA Center SDK 标志。选择 `false` `true` ← (默认)

注释 

注意

使用的 SDK 方法为 sda.Sda.add_port_channels_v1、sda.Sda.delete_port_channel_by_id_v1、sda.Sda.update_port_channels_v1，
使用的路径为 post /dna/intent/api/v1/sda/portChannels、delete /dna/intent/api/v1/sda/portChannels、delete /dna/intent/api/v1/sda/portChannels/{id}、put /dna/intent/api/v1/sda/portChannels，
不支持 check_mode
该插件在控制节点上运行，不使用任何 ansible 连接插件，而是使用 Cisco DNAC SDK 中的嵌入式连接管理器
以 dnac_ 开头的参数由 Cisco DNAC Python SDK 用于建立连接

另请参阅 

另请参阅

有关 SDA AddPortChannelsV1 的 Cisco DNA Center 文档: AddPortChannelsV1 API 的完整参考。
有关 SDA DeletePortChannelByIdV1 的 Cisco DNA Center 文档: DeletePortChannelByIdV1 API 的完整参考。
Cisco DNA Center 关于 SDA DeletePortChannelsV1 的文档: DeletePortChannelsV1 API 的完整参考。
Cisco DNA Center 关于 SDA UpdatePortChannelsV1 的文档: UpdatePortChannelsV1 API 的完整参考。

示例 

- name: Create
  cisco.dnac.sda_port_channels_v1:
    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:
    - connectedDeviceType: string
      description: string
      fabricId: string
      interfaceNames:
      - string
      networkDeviceId: string
      protocol: string

- name: Update all
  cisco.dnac.sda_port_channels_v1:
    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:
    - connectedDeviceType: string
      description: string
      fabricId: string
      id: string
      interfaceNames:
      - string
      networkDeviceId: string
      portChannelName: string
      protocol: string

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

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