cisco.dnac.sda_port_assignments 模块 – Sda 端口分配的资源模块

注意

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

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

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

要在 playbook 中使用它，请指定： cisco.dnac.sda_port_assignments。

cisco.dnac 6.14.0 中的新增功能

概要 

此模块表示模块 sda_port_assignments_v1 的别名

注意

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

需求 

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

dnacentersdk >= 2.4.9
python >= 3.5

参数 

参数	注释
dataVlanName 字符串	DataVlanName 查询参数。端口分配的数据 VLAN 名称。
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。
interfaceName 字符串	InterfaceName 查询参数。端口分配的接口名称。
networkDeviceId 字符串	NetworkDeviceId 查询参数。端口分配的网络设备 ID。
payload 列表 / 元素=字典	Sda 端口分配的有效负载。
authenticateTemplateName 字符串	端口分配的身份验证模板名称。
connectedDeviceType 字符串	端口分配的连接设备类型。
dataVlanName 字符串	端口分配的数据 VLAN 名称。
fabricId 字符串	设备分配到的结构域的 ID。
interfaceDescription 字符串	端口分配的接口描述。
interfaceName 字符串	端口分配的接口名称。
networkDeviceId 字符串	端口分配的网络设备 ID。
securityGroupName 字符串	端口分配的安全组名称。
voiceVlanName 字符串	端口分配的语音 VLAN 名称。
validate_response_schema 布尔值	用于 Cisco DNA Center SDK 的标志，用于启用根据 JSON 架构验证请求正文。选项 `false` `true` ← (默认)
voiceVlanName 字符串	VoiceVlanName 查询参数。端口分配的语音 VLAN 名称。

备注 

注意

使用的 SDK 方法是 sda.Sda.add_port_assignments_v1、sda.Sda.delete_port_assignment_by_id_v1、sda.Sda.update_port_assignments_v1，
使用的路径是 post /dna/intent/api/v1/sda/portAssignments、delete /dna/intent/api/v1/sda/portAssignments、delete /dna/intent/api/v1/sda/portAssignments/{id}、put /dna/intent/api/v1/sda/portAssignments，
需要注意的是，此模块是 sda_port_assignments_v1 的别名
不支持 check_mode
插件在控制节点上运行，不使用任何 ansible 连接插件，而是使用来自 Cisco DNAC SDK 的嵌入式连接管理器
以 dnac_ 开头的参数由 Cisco DNAC Python SDK 用于建立连接

参见 

另请参见

Cisco DNA Center 文档，关于 SDA AddPortAssignmentsV1: AddPortAssignmentsV1 API 的完整参考。
Cisco DNA Center 文档，关于 SDA DeletePortAssignmentByIdV1: DeletePortAssignmentByIdV1 API 的完整参考。
Cisco DNA Center 文档，关于 SDA DeletePortAssignmentsV1: DeletePortAssignmentsV1 API 的完整参考。
Cisco DNA Center 文档，关于 SDA UpdatePortAssignmentsV1: UpdatePortAssignmentsV1 API 的完整参考。

示例 

- name: Create
  cisco.dnac.sda_port_assignments:
    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:
    - authenticateTemplateName: string
      connectedDeviceType: string
      dataVlanName: string
      fabricId: string
      interfaceDescription: string
      interfaceName: string
      networkDeviceId: string
      securityGroupName: string
      voiceVlanName: string

- name: Update all
  cisco.dnac.sda_port_assignments:
    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:
    - authenticateTemplateName: string
      connectedDeviceType: string
      dataVlanName: string
      fabricId: string
      id: string
      interfaceDescription: string
      interfaceName: string
      networkDeviceId: string
      scalableGroupName: string
      voiceVlanName: string

- name: Delete all
  cisco.dnac.sda_port_assignments:
    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
    dataVlanName: string
    fabricId: string
    interfaceName: string
    networkDeviceId: string
    voiceVlanName: string

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