cisco.dnac.lan_automation_port_channels_info module -- Information module for Lan Automation Port Channels

Note

This module is part of the cisco.dnac collection (version 6.46.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.lan_automation_port_channels_info.

New in cisco.dnac 6.18.0

Synopsis

  • Get all Lan Automation Port Channels.

  • Get Lan Automation Port Channels by id.

  • Returns a list of Port Channel between the LAN Automation associated devices.

  • This API retrieves Port Channel information using its ID.

Note

This module has a corresponding action plugin.

Requirements

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

  • dnacentersdk >= 2.11.0

  • python >= 3.12

Parameters

Parameter

Comments

device1ManagementIPAddress

string

Device1ManagementIPAddress query parameter. The management IP address of the device1.

device1Uuid

string

Device1Uuid query parameter. Unique identifier for the network device1.

device2ManagementIPAddress

string

Device2ManagementIPAddress query parameter. The management IP address of the device2.

device2Uuid

string

Device2Uuid query parameter. Unique identifier for the network device2.

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:`"3.1.6.0"`

headers

dictionary

Additional headers.

id

string

Id path parameter. ID of the port channel.

limit

integer

Limit query parameter. Maximum number of Port Channel to return.

offset

integer

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:

Notes

Note

  • SDK Method used are lan_automation.LanAutomation.get_port_channel_information_by_id, lan_automation.LanAutomation.get_port_channels,

  • Paths used are get /dna/intent/api/v1/lanAutomation/portChannels, get /dna/intent/api/v1/lanAutomation/portChannels/{id},

  • 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 LAN Automation GetPortChannelInformationById

Complete reference of the GetPortChannelInformationById API.

Cisco DNA Center documentation for LAN Automation GetPortChannels

Complete reference of the GetPortChannels API.

Examples

---
- name: Get all Lan Automation Port Channels
  cisco.dnac.lan_automation_port_channels_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}}"
    device1ManagementIPAddress: string
    device1Uuid: string
    device2ManagementIPAddress: string
    device2Uuid: string
    offset: 0
    limit: 0
  register: result
- name: Get Lan Automation Port Channels by id
  cisco.dnac.lan_automation_port_channels_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}}"
    id: string
  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": [{"device1ManagementIPAddress": "string", "device1PortChannelNumber": 0, "device1PortChannelUuid": "string", "device1Uuid": "string", "device2ManagementIPAddress": "string", "device2PortChannelNumber": 0, "device2PortChannelUuid": "string", "device2Uuid": "string", "id": "string", "portChannelMembers": [{"device1Interface": "string", "device1InterfaceUuid": "string", "device2Interface": "string", "device2InterfaceUuid": "string"}]}], "version": "string"}`

Authors

  • Rafael Campos (@racampos)