cisco.nxos.nxos_vrrp_module.rst

cisco.nxos.nxos_vrrp

Manages VRRP configuration on NX-OS switches.

Version added: 1.0.0

• Synopsis
• Parameters
• Notes
• Examples
• Return Values
• Status

Synopsis

• Manages VRRP configuration on NX-OS switches.

Parameters

Parameter	Choices/Defaults	Comments
admin_state string	Choices: shutdown ← no shutdown default	Used to enable or disable the VRRP process.
authentication string		Clear text authentication string or 'default' keyword
group string / required		VRRP group number.
interface string / required		Full name of interface that is being managed for VRRP.
interval string		Time interval between advertisement or 'default' keyword
preempt boolean	Choices: no yes	Enable/Disable preempt.
priority string		VRRP priority or 'default' keyword
state string	Choices: present ← absent	Specify desired state of the resource.
vip string		VRRP virtual IP address or 'default' keyword

Notes

Note

• Tested against NXOSv 7.3.(0)D1(1) on VIRL
• Unsupported for Cisco MDS
• VRRP feature needs to be enabled first on the system.
• SVIs must exist before using this module.
• Interface must be a L3 port before using this module.
• state=absent removes the VRRP group if it exists on the device.
• VRRP cannot be configured on loopback interfaces.
• 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.

Examples

- name: Ensure vrrp group 100 and vip 10.1.100.1 is on vlan10
  cisco.nxos.nxos_vrrp:
    interface: vlan10
    group: 100
    vip: 10.1.100.1

- name: Ensure removal of the vrrp group config
  cisco.nxos.nxos_vrrp:
    interface: vlan10
    group: 100
    vip: 10.1.100.1
    state: absent

- name: Re-config with more params
  cisco.nxos.nxos_vrrp:
    interface: vlan10
    group: 100
    vip: 10.1.100.1
    preempt: false
    priority: 130
    authentication: AUTHKEY

Return Values

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

Key	Returned	Description
commands list	always	commands sent to the device Sample: ['interface vlan10', 'vrrp 150', 'address 10.1.15.1', 'authentication text testing', 'no shutdown']

Status

Authors

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