cisco.dnac.sda_port_channels_v1 module -- Resource module for Sda Port Channels V1

Note

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

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

New in cisco.dnac 6.15.0

Synopsis

  • Manage operations create, update and delete of the resource Sda Port Channels V1.

  • Adds port channels based on user input.

  • Deletes a port channel based on id.

  • Deletes port channels based on user input.

  • Updates port channels based on user input.

Note

This module has a corresponding action plugin.

Requirements

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

  • dnacentersdk >= 2.4.9

  • python >= 3.5

Parameters

Parameter

Comments

connectedDeviceType

string

ConnectedDeviceType query parameter. Connected device type of the port channel. The allowed values are TRUNK, EXTENDED_NODE.

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 the device is assigned to.

id

string

Id path parameter. ID of the port channel.

networkDeviceId

string

NetworkDeviceId query parameter. ID of the network device.

payload

list / elements=dictionary

Sda Port Channels's payload.

connectedDeviceType

string

Connected device type of the port channel.

description

string

Description of the port channel.

fabricId

string

ID of the fabric the device is assigned to.

interfaceNames

list / elements=string

Interface names for this port channel (Maximum 16 ports for LACP protocol, Maximum 8 ports for PAGP and ON protocol).

networkDeviceId

string

ID of the network device.

protocol

string

Protocol of the port channel (only PAGP is allowed if connectedDeviceType is EXTENDED_NODE).

portChannelName

string

PortChannelName query parameter. Name of the port channel.

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 sda.Sda.add_port_channels_v1, sda.Sda.delete_port_channel_by_id_v1, sda.Sda.update_port_channels_v1,

  • Paths used are post /dna/intent/api/v1/sda/portChannels, delete /dna/intent/api/v1/sda/portChannels, delete /dna/intent/api/v1/sda/portChannels/{id}, put /dna/intent/api/v1/sda/portChannels,

  • 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 SDA AddPortChannelsV1

Complete reference of the AddPortChannelsV1 API.

Cisco DNA Center documentation for SDA DeletePortChannelByIdV1

Complete reference of the DeletePortChannelByIdV1 API.

Cisco DNA Center documentation for SDA DeletePortChannelsV1

Complete reference of the DeletePortChannelsV1 API.

Cisco DNA Center documentation for SDA UpdatePortChannelsV1

Complete reference of the UpdatePortChannelsV1 API.

Examples

- name: Create
  cisco.dnac.sda_port_channels_v1:
    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}}"
    state: present
    payload:
    - connectedDeviceType: string
      description: string
      fabricId: string
      interfaceNames:
      - string
      networkDeviceId: string
      protocol: string

- name: Update all
  cisco.dnac.sda_port_channels_v1:
    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}}"
    state: present
    payload:
    - connectedDeviceType: string
      description: string
      fabricId: string
      id: string
      interfaceNames:
      - string
      networkDeviceId: string
      portChannelName: string
      protocol: string

- name: Delete all
  cisco.dnac.sda_port_channels_v1:
    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}}"
    state: absent
    connectedDeviceType: string
    fabricId: string
    networkDeviceId: string
    portChannelName: string

- name: Delete by id
  cisco.dnac.sda_port_channels_v1:
    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}}"
    state: absent
    id: 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)