cisco.dnac.sda_port_assignment_for_user_device 模块 – 用于用户设备的 SDA 端口分配资源模块

注意

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

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

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

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

cisco.dnac 3.1.0 中的新增功能

概要 

此模块表示模块 sda_port_assignment_for_user_device_v1 的别名

注意

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

要求 

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

dnacentersdk >= 2.4.9
python >= 3.5

参数 

参数	注释
authenticateTemplateName 字符串在 cisco.dnac 4.0.0 中添加	与 siteNameHierarchy 关联的认证模板名称。
dataIpAddressPoolName 字符串在 cisco.dnac 4.0.0 中添加	分配给虚拟网络的 IP 池名称，其流量类型为 DATA（如果 voiceIpAddressPoolName 为空，则不能为空）。
deviceManagementIpAddress 字符串	DeviceManagementIpAddress 查询参数。
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"`
interfaceDescription 字符串在 cisco.dnac 4.0.0 中添加	用户定义的端口分配文本消息。
interfaceName 字符串	InterfaceName 查询参数。
interfaceNames 列表 / 元素=字符串	边缘节点设备上的接口名称列表。例如：“GigabitEthernet1/0/3”、“GigabitEthernet1/0/4”。
scalableGroupName 字符串在 cisco.dnac 4.0.0 中添加	与 VN 关联的可扩展组名称。
siteNameHierarchy 字符串在 cisco.dnac 4.0.0 中添加	SD-Access Fabric 站点的完整路径。
validate_response_schema 布尔值	用于 Cisco DNA Center SDK 以启用根据 JSON 模式验证请求正文。选项 `false` `true` ← (默认)
voiceIpAddressPoolName 字符串在 cisco.dnac 4.0.0 中添加	分配给虚拟网络的 IP 池名称，其流量类型为 VOICE（如果 dataIpAddressPoolName 为空，则不能为空）。

备注 

注意

使用的 SDK 方法为 sda.Sda.add_port_assignment_for_user_device、sda.Sda.delete_port_assignment_for_user_device，
使用的路径为 post /dna/intent/api/v1/business/sda/hostonboarding/user-device、delete /dna/intent/api/v1/business/sda/hostonboarding/user-device，
需要注意的是，此模块是 sda_port_assignment_for_user_device_v1 的别名
不支持 check_mode
该插件在控制节点上运行，不使用任何 Ansible 连接插件，而是使用 Cisco DNAC SDK 中的嵌入式连接管理器
以 dnac_ 开头的参数由 Cisco DNAC Python SDK 用于建立连接

另请参阅 

另请参阅

Cisco DNA Center 文档，了解 SDA AddPortAssignmentForUserDeviceInSDAFabricV1: AddPortAssignmentForUserDeviceInSDAFabricV1 API 的完整参考。
思科 DNA Center SDA DeletePortAssignmentForUserDeviceInSDAFabricV1 文档: DeletePortAssignmentForUserDeviceInSDAFabricV1 API 的完整参考。

示例 

- name: Delete all
  cisco.dnac.sda_port_assignment_for_user_device:
    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
    deviceManagementIpAddress: string
    interfaceName: string

- name: Create
  cisco.dnac.sda_port_assignment_for_user_device:
    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
    authenticateTemplateName: string
    dataIpAddressPoolName: string
    deviceManagementIpAddress: string
    interfaceDescription: string
    interfaceName: string
    interfaceNames:
    - string
    scalableGroupName: string
    siteNameHierarchy: string
    voiceIpAddressPoolName: string

返回值 

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

键	描述
dnac_response 字典	包含 Cisco DNAC Python SDK 返回的响应的字典或列表返回值：始终返回示例： `{"description": "string", "executionId": "string", "executionStatusUrl": "string", "status": "string", "taskId": "string", "taskStatusUrl": "string"}`

作者

Rafael Campos (@racampos)