cisco.dnac.lan_automation_port_channels_id_add_link module – Resource module for Lan Automation Port Channels Id Add Link

Note

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

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

New in cisco.dnac 6.18.0

Synopsis

• Manage operation create of the resource Lan Automation Port Channels Id Add Link. - > This API adds a new LAN Automated link as a member to an existing Port Channel, provided the interface is in UP state and already LAN Automated.

Note

This module has a corresponding action plugin.

Requirements

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

• dnacentersdk >= 2.10.1

• python >= 3.5

Parameters

Parameter	Comments
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"
id string	Id path parameter. ID of the port channel.
portChannelMembers list / elements=dictionary	Lan Automation Port Channels Id Add Link’s portChannelMembers.
device1Interface string	Either device1InterfaceUuid or device1InterfaceName is required.
device1InterfaceUuid string	Either device1InterfaceUuid or device1InterfaceName is required.
device2Interface string	Either device2InterfaceUuid or device1InterfaceName is required.
device2InterfaceUuid string	Either device2InterfaceUuid or device1InterfaceName is required.
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)

Notes

Note

• SDK Method used are lan_automation.LanAutomation.add_a_lan_automated_link_to_a_port_channel,

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

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

Complete reference of the AddALANAutomatedLinkToAPortChannel API.

Examples

---
- name: Create
  cisco.dnac.lan_automation_port_channels_id_add_link:
    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}}"
    id: string
    portChannelMembers:
      - device1Interface: string
        device1InterfaceUuid: string
        device2Interface: string
        device2InterfaceUuid: 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)

Collection links

• Issue Tracker
• Repository (Sources)