cisco.dnac.sda_port_assignments_info module -- Information module for Sda Portassignments

Note

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

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_info.

New in cisco.dnac 6.14.0

Synopsis

  • Get all Sda Portassignments.

  • Returns a list of port assignments that match the provided query parameters.

Note

This module has a corresponding action plugin.

Requirements

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

  • dnacentersdk >= 2.7.2

  • 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:

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: :ansible-option-default:`443`

dnac_username

aliases: user

string

The Cisco DNA Center username to authenticate.

Default: :ansible-option-default:`"admin"`

dnac_verify

boolean

Flag to enable or disable SSL certificate verification.

Choices:

dnac_version

string

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

Default: :ansible-option-default:`"2.3.7.6"`

fabricId

string

FabricId query parameter. ID of the fabric this device belongs to.

headers

dictionary

Additional headers.

interfaceName

string

InterfaceName query parameter. Interface Name of the port assignment.

limit

float

Limit query parameter. Maximum number of records to return.

networkDeviceId

string

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

offset

float

Offset query parameter. Starting record for pagination.

validate_response_schema

boolean

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

Choices:

voiceVlanName

string

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

Notes

Note

  • SDK Method used are sda.Sda.get_port_assignments,

  • Paths used are get /dna/intent/api/v1/sda/portAssignments,

  • Supports 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 GetPortAssignments

Complete reference of the GetPortAssignments API.

Examples

- name: Get all Sda Portassignments
  cisco.dnac.sda_port_assignments_info:
    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}}"
    headers: "{{my_headers | from_json}}"
    fabricId: string
    networkDeviceId: string
    interfaceName: string
    dataVlanName: string
    voiceVlanName: string
    offset: 0
    limit: 0
  register: result

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: :ansible-rv-sample-value:`{"response": [{"authenticateTemplateName": "string", "connectedDeviceType": "string", "dataVlanName": "string", "fabricId": "string", "id": "string", "interfaceDescription": "string", "interfaceName": "string", "networkDeviceId": "string", "scalableGroupName": "string", "voiceVlanName": "string"}], "version": "string"}`

Authors

  • Rafael Campos (@racampos)