cisco.nxos.nxos_vpc module – Manages global VPC configuration

Note

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

New in cisco.nxos 1.0.0

Synopsis

  • Manages global VPC configuration

Note

This module has a corresponding action plugin.

Parameters

Parameter

Comments

auto_recovery

boolean

Enables/Disables auto recovery on platforms that support disable

timers are not modifiable with this attribute

mutually exclusive with auto_recovery_reload_delay

Choices:

  • false

  • true

auto_recovery_reload_delay

string

Manages auto-recovery reload-delay timer in seconds

mutually exclusive with auto_recovery

delay_restore

string

manages delay restore command and config value in seconds

delay_restore_interface_vlan

string

manages delay restore interface-vlan command and config value in seconds

not supported on all platforms

delay_restore_orphan_port

string

manages delay restore orphan-port command and config value in seconds

not supported on all platforms

domain

string / required

VPC domain

peer_gw

boolean

Enables/Disables peer gateway

Choices:

  • false

  • true

pkl_dest

string

Destination (remote) IP address used for peer keepalive link

pkl_dest is required whenever pkl options are used.

pkl_src

string

Source IP address used for peer keepalive link

pkl_vrf

string

VRF used for peer keepalive link

The VRF must exist on the device before using pkl_vrf.

(Note) ‘default’ is an overloaded term: Default vrf context for pkl_vrf is ‘management’; ‘pkl_vrf: default’ refers to the literal ‘default’ rib.

role_priority

string

Role priority for device. Remember lower is better.

state

string

Manages desired state of the resource

Choices:

  • "present" ← (default)

  • "absent"

system_priority

string

System priority device. Remember they must match between peers.

Notes

Note

  • Tested against NXOSv 7.3.(0)D1(1) on VIRL

  • Unsupported for Cisco MDS

  • The feature vpc must be enabled before this module can be used

  • If not using management vrf, vrf must be globally on the device before using in the pkl config

  • Although source IP isn’t required on the command line it is required when using this module. The PKL VRF must also be configured prior to using this module.

  • Both pkl_src and pkl_dest are needed when changing PKL VRF.

  • 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

- name: configure a simple asn
  cisco.nxos.nxos_vpc:
    domain: 100
    role_priority: 1000
    system_priority: 2000
    pkl_dest: 192.168.100.4
    pkl_src: 10.1.100.20
    peer_gw: true
    auto_recovery: true

- name: configure
  cisco.nxos.nxos_vpc:
    domain: 100
    role_priority: 32667
    system_priority: 2000
    peer_gw: true
    pkl_src: 10.1.100.2
    pkl_dest: 192.168.100.4
    auto_recovery: true

- name: Configure VPC with delay restore and existing keepalive VRF
  cisco.nxos.nxos_vpc:
    domain: 10
    role_priority: 28672
    system_priority: 2000
    delay_restore: 180
    peer_gw: true
    pkl_src: 1.1.1.2
    pkl_dest: 1.1.1.1
    pkl_vrf: vpckeepalive
    auto_recovery: true

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: ["vpc domain 100", "peer-keepalive destination 192.168.100.4 source 10.1.100.20 vrf management", "auto-recovery", "peer-gateway"]

Authors

  • Jason Edelman (@jedelman8)

  • Gabriele Gerbino (@GGabriele)