cisco.catalystcenter.lan_automation_port_channels module -- Resource module for Lan Automation Port Channels

Note

This module is part of the cisco.catalystcenter collection (version 2.2.2).

To install it, use: ansible-galaxy collection install cisco.catalystcenter. You need further requirements to be able to use this module, see Requirements for details.

To use it in a playbook, specify: cisco.catalystcenter.lan_automation_port_channels.

New in cisco.catalystcenter 6.18.0

Synopsis

• Manage operation create of the resource Lan Automation Port Channels. - > This API creates a Port Channel between two LAN Automation associated devices using the PAgP protocol, with a minimum of 2 and a maximum of 8 LAN Automated interfaces in UP status.

Note

This module has a corresponding action plugin.

Requirements

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

• catalystcentersdk >= 3.1.3.0.0

• python >= 3.5

Parameters

Parameter	Comments
catalystcenter_api_port integer	The Cisco Catalyst Center port. Default: :ansible-option-default:`443`
catalystcenter_debug boolean	Flag for Cisco Catalyst Center SDK to enable debugging. Choices: :ansible-option-choices-entry-default:`false` ← (default) :ansible-option-choices-entry:`true`
catalystcenter_host string / required	The Cisco Catalyst Center hostname.
catalystcenter_password string	The Cisco Catalyst Center password to authenticate.
catalystcenter_username string	The Cisco Catalyst Center username to authenticate. Default: :ansible-option-default:`"admin"`
catalystcenter_verify boolean	Flag to enable or disable SSL certificate verification. Choices: :ansible-option-choices-entry:`false` :ansible-option-choices-entry-default:`true` ← (default)
catalystcenter_version string	Informs the SDK which version of Cisco Catalyst Center to use. Default: :ansible-option-default:`"2.3.7.6"`
device1ManagementIPAddress string	Either device1ManagementIPAddress or device1Uuid is required.
device1Uuid string	Either device1ManagementIPAddress or device1Uuid is required.
device2ManagementIPAddress string	Either device2ManagementIPAddress or device2Uuid is required.
device2Uuid string	Either device2ManagementIPAddress or device2Uuid is required.
portChannelMembers list / elements=dictionary	Lan Automation Port Channels's portChannelMembers.
device1Interface string	Either device1InterfaceUuid or device1InterfaceName is required.
device1InterfaceUuid string	Either device1InterfaceUuid or device1InterfaceName is required.
device2Interface string	Either device2InterfaceUuid or device2InterfaceName is required.
device2InterfaceUuid string	Either device2InterfaceUuid or device2InterfaceName is required.
validate_response_schema boolean	Flag for Cisco Catalyst 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.create_a_new_port_channel_between_devices,

• Paths used are post /dna/intent/api/v1/lanAutomation/portChannels,

• Does not support check_mode

• The plugin runs on the control node and does not use any ansible connection plugins,

• but instead uses the embedded connection manager from Cisco CATALYST SDK

See Also

See also

Cisco DNA Center documentation for LAN Automation CreateANewPortChannelBetweenDevices

Complete reference of the CreateANewPortChannelBetweenDevices API.

Examples

---
- name: Create
  cisco.catalystcenter.lan_automation_port_channels:
    catalystcenter_host: "{{catalystcenter_host}}"
    catalystcenter_username: "{{catalystcenter_username}}"
    catalystcenter_password: "{{catalystcenter_password}}"
    catalystcenter_verify: "{{catalystcenter_verify}}"
    catalystcenter_api_port: "{{catalystcenter_api_port}}"
    catalystcenter_version: "{{catalystcenter_version}}"
    catalystcenter_debug: "{{catalystcenter_debug}}"
    state: present
    device1ManagementIPAddress: string
    device1Uuid: string
    device2ManagementIPAddress: string
    device2Uuid: 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 CATALYST 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)