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

注意

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

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

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

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

cisco.dnac 6.14.0 中的新增功能

概要 

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

注意

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

要求 

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

dnacentersdk >= 2.4.9
python >= 3.5

参数 

参数	注释
dataVlanName string	DataVlanName 查询参数。端口分配的数据 VLAN 名称。
dnac_debug boolean	用于 Cisco DNA Center SDK 启用调试的标志。选择 `false` ← (默认) `true`
dnac_host string / required	Cisco DNA Center 主机名。
dnac_password string	用于身份验证的 Cisco DNA Center 密码。
dnac_port integer	Cisco DNA Center 端口。默认值: `443`
dnac_username 别名: user string	用于身份验证的 Cisco DNA Center 用户名。默认值: `"admin"`
dnac_verify boolean	用于启用或禁用 SSL 证书验证的标志。选择 `false` `true` ← (默认)
dnac_version string	通知 SDK 要使用的 Cisco DNA Center 版本。默认值: `"2.3.7.6"`
fabricId string	FabricId 查询参数。设备分配到的 fabric 的 ID。
id string	Id 路径参数。端口分配的 ID。
interfaceName string	InterfaceName 查询参数。端口分配的接口名称。
networkDeviceId string	NetworkDeviceId 查询参数。端口分配的网络设备 ID。
payload list / elements=dictionary	Sda 端口分配的负载。
authenticateTemplateName string	端口分配的身份验证模板名称。
connectedDeviceType string	端口分配的连接设备类型。
dataVlanName string	端口分配的数据 VLAN 名称。
fabricId string	设备分配到的 fabric 的 ID。
interfaceDescription string	端口分配的接口描述。
interfaceName string	端口分配的接口名称。
networkDeviceId string	端口分配的网络设备 ID。
securityGroupName string	端口分配的安全组名称。
voiceVlanName string	端口分配的语音 VLAN 名称。
validate_response_schema boolean	用于 Cisco DNA Center SDK 启用根据 JSON 模式验证请求体的标志。选择 `false` `true` ← (默认)
voiceVlanName string	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
不支持 check_mode
该插件在控制节点上运行，不使用任何 ansible 连接插件，而是使用 Cisco DNAC SDK 中的嵌入式连接管理器
以 dnac_ 开头的参数由 Cisco DNAC Python SDK 用于建立连接

另请参阅 

另请参阅

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

示例 

- name: Create
  cisco.dnac.sda_port_assignments_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:
    - 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_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:
    - 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_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
    dataVlanName: string
    fabricId: string
    interfaceName: string
    networkDeviceId: string
    voiceVlanName: string

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