cisco.dnac.lan_automation_port_channels_id_remove_link module -- Resource module for Lan Automation Port Channels Id Remove Link

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

New in cisco.dnac 6.18.0

Synopsis

• Manage operation create of the resource Lan Automation Port Channels Id Remove Link.

• This API removes a member link from an existing Port Channel, reverting the link to a P2P L3 interface.

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
dnac_debug boolean	Flag for Cisco DNA Center SDK to enable debugging. Choices: :ansible-option-choices-entry-default:`false` ← (default) :ansible-option-choices-entry:`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: :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: :ansible-option-choices-entry:`false` :ansible-option-choices-entry-default:`true` ← (default)
dnac_version string	Informs the SDK which version of Cisco DNA Center to use. Default: :ansible-option-default:`"3.1.6.0"`
id string	Id path parameter. ID of the port channel.
portChannelMembers list / elements=dictionary	Lan Automation Port Channels Id Remove 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: :ansible-option-choices-entry:`false` :ansible-option-choices-entry-default:`true` ← (default)

Notes

Note

• SDK Method used are lan_automation.LanAutomation.remove_a_link_from_port_channel,

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

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

Complete reference of the RemoveALinkFromPortChannel API.

Examples

---
- name: Create
  cisco.dnac.lan_automation_port_channels_id_remove_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: :ansible-rv-sample-value:`{"response": {"taskId": "string", "url": "string"}, "version": "string"}`

Authors

• Rafael Campos (@racampos)

Collection links

Issue Tracker Repository (Sources)