cisco.dnac.sda_port_assignment_for_access_point module – Resource module for Sda Port Assignment For Access Point

Note

This module is part of the cisco.dnac collection (version 6.2.1).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install cisco.dnac.

To use it in a playbook, specify: cisco.dnac.sda_port_assignment_for_access_point.

New in version 3.1.0: of cisco.dnac

Synopsis

• Manage operations create and delete of the resource Sda Port Assignment For Access Point.

• Add Port assignment for access point in SDA Fabric.

• Delete Port assignment for access point in SDA Fabric.

Note

This module has a corresponding action plugin.

Requirements

The below requirements are needed on the host that executes this module.

• dnacentersdk >= 2.4.8

• python >= 3.5

Parameters

Parameter	Comments
authenticateTemplateName string added in 4.0.0 of cisco.dnac	Authenticate TemplateName associated to siteNameHierarchy.
dataIpAddressPoolName string added in 4.0.0 of cisco.dnac	Ip Pool Name, that is assigned to INFRA_VN.
deviceManagementIpAddress string added in 4.0.0 of cisco.dnac	Management Ip Address of the edge device.
dnac_debug boolean	Flag for Cisco DNA Center SDK to enable debugging. Choices: no ← (default) yes
dnac_host string / required	The Cisco DNA Center hostname.
dnac_password string	The Cisco DNA Center password to authenticate.
dnac_port integer	The Cisco DNA Center port. Default: 443
dnac_username aliases: user string	The Cisco DNA Center username to authenticate. Default: “admin”
dnac_verify boolean	Flag to enable or disable SSL certificate verification. Choices: no yes ← (default)
dnac_version string	Informs the SDK which version of Cisco DNA Center to use. Default: “2.2.3.3”
interfaceDescription string added in 4.0.0 of cisco.dnac	Details or note of interface assignment.
interfaceName string	Interface Name of the edge device.
siteNameHierarchy string added in 4.0.0 of cisco.dnac	Site Name Hierarchy should be a valid fabric site name hierarchy. E.g Global/USA/San Jose.
validate_response_schema boolean	Flag for Cisco DNA Center SDK to enable the validation of request bodies against a JSON schema. Choices: no yes ← (default)

Notes

Note

• SDK Method used are sda.Sda.add_port_assignment_for_access_point, sda.Sda.delete_port_assignment_for_access_point,

• Paths used are post /dna/intent/api/v1/business/sda/hostonboarding/access-point, delete /dna/intent/api/v1/business/sda/hostonboarding/access-point,

• Does not support check_mode

• The plugin runs on the control node and does not use any ansible connection plugins, but instead the embedded connection manager from Cisco DNAC SDK

• The parameters starting with dnac_ are used by the Cisco DNAC Python SDK to establish the connection

Examples

- name: Create
  cisco.dnac.sda_port_assignment_for_access_point:
    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
    siteNameHierarchy: string

- name: Delete all
  cisco.dnac.sda_port_assignment_for_access_point:
    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

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key	Description
dnac_response dictionary	A dictionary or list with the response returned by the Cisco DNAC Python SDK Returned: always Sample: “{\n \”status\”: \”string\”,\n \”description\”: \”string\”,\n \”taskId\”: \”string\”,\n \”taskStatusUrl\”: \”string\”,\n \”executionStatusUrl\”: \”string\”,\n \”executionId\”: \”string\”\n}\n”

Authors

• Rafael Campos (@racampos)