W3cubDocs

/Ansible

cisco.nxos.nxos_vpc_interface module – Manages interface VPC configuration

Note

This module is part of the cisco.nxos collection (version 9.4.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.nxos.

To use it in a playbook, specify: cisco.nxos.nxos_vpc_interface.

New in cisco.nxos 1.0.0

Synopsis

  • Manages interface VPC configuration

Parameters

Parameter

Comments

boolean

Set to true/false for peer link config on associated portchannel.

Choices:

  • false
  • true

portchannel

string / required

Group number of the portchannel that will be configured.

state

string

Manages desired state of the resource.

Choices:

  • "present" ← (default)
  • "absent"

vpc

string

VPC group/id that will be configured on associated portchannel.

Notes

Note

  • Tested against NXOSv 7.3.(0)D1(1) on VIRL
  • Unsupported for Cisco MDS
  • Either vpc or peer_link param is required, but not both.
  • state=absent removes whatever VPC config is on a port-channel if one exists.
  • Re-assigning a vpc or peerlink from one portchannel to another is not supported. The module will force the user to unconfigure an existing vpc/pl before configuring the same value on a new portchannel
  • For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide <nxos_platform_options>`
  • For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide <network_guide>`
  • For more information on using Ansible to manage Cisco devices see the `Cisco integration page <https://www.ansible.com/integrations/networks/cisco>`_.

Examples

- cisco.nxos.nxos_vpc_interface:
    portchannel: 10
    vpc: 100

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key

Description

commands

list / elements=string

commands sent to the device

Returned: always

Sample: ["interface port-channel100", "vpc 10"]

Authors

  • Jason Edelman (@jedelman8)
  • Gabriele Gerbino (@GGabriele)

© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/cisco/nxos/nxos_vpc_interface_module.html