W3cubDocs

/Ansible

cisco.dnac.sda_port_assignments_v1 module – Resource module for Sda Port Assignments V1

Note

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

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. You need further requirements to be able to use this module, see Requirements for details.

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

New in cisco.dnac 6.14.0

Synopsis

  • Manage operations create, update and delete of the resource Sda Port Assignments V1.
  • Adds port assignments based on user input.
  • Deletes a port assignment based on id.
  • Deletes port assignments based on user input.
  • Updates port assignments based on user input.

Note

This module has a corresponding action plugin.

Requirements

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

  • dnacentersdk >= 2.4.9
  • python >= 3.5

Parameters

Parameter

Comments

dataVlanName

string

DataVlanName query parameter. Data VLAN name of the port assignment.

dnac_debug

boolean

Flag for Cisco DNA Center SDK to enable debugging.

Choices:

  • false ← (default)
  • true

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:

  • false
  • true ← (default)

dnac_version

string

Informs the SDK which version of Cisco DNA Center to use.

Default: "2.3.7.6"

fabricId

string

FabricId query parameter. ID of the fabric the device is assigned to.

id

string

Id path parameter. ID of the port assignment.

interfaceName

string

InterfaceName query parameter. Interface name of the port assignment.

networkDeviceId

string

NetworkDeviceId query parameter. Network device ID of the port assignment.

payload

list / elements=dictionary

Sda Port Assignments’s payload.

authenticateTemplateName

string

Authenticate template name of the port assignment.

connectedDeviceType

string

Connected device type of the port assignment.

dataVlanName

string

Data VLAN name of the port assignment.

fabricId

string

ID of the fabric the device is assigned to.

interfaceDescription

string

Interface description of the port assignment.

interfaceName

string

Interface name of the port assignment.

networkDeviceId

string

Network device ID of the port assignment.

securityGroupName

string

Security group name of the port assignment.

voiceVlanName

string

Voice VLAN name of the port assignment.

validate_response_schema

boolean

Flag for Cisco DNA Center SDK to enable the validation of request bodies against a JSON schema.

Choices:

  • false
  • true ← (default)

voiceVlanName

string

VoiceVlanName query parameter. Voice VLAN name of the port assignment.

Notes

Note

  • SDK Method used are sda.Sda.add_port_assignments_v1, sda.Sda.delete_port_assignment_by_id_v1, sda.Sda.update_port_assignments_v1,
  • Paths used are 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,
  • 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

See Also

See also

Cisco DNA Center documentation for SDA AddPortAssignmentsV1

Complete reference of the AddPortAssignmentsV1 API.

Cisco DNA Center documentation for SDA DeletePortAssignmentByIdV1

Complete reference of the DeletePortAssignmentByIdV1 API.

Cisco DNA Center documentation for SDA DeletePortAssignmentsV1

Complete reference of the DeletePortAssignmentsV1 API.

Cisco DNA Center documentation for SDA UpdatePortAssignmentsV1

Complete reference of the UpdatePortAssignmentsV1 API.

Examples

- 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

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: {"response": {"taskId": "string", "url": "string"}, "version": "string"}

Authors

  • Rafael Campos (@racampos)

© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/cisco/dnac/sda_port_assignments_v1_module.html