cisco.nxos.nxos_vrf_interface_module.rst

cisco.nxos.nxos_vrf_interface

Manages interface specific VRF configuration.

Version added: 1.0.0

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

Synopsis

• Manages interface specific VRF configuration.

Parameters

Parameter	Choices/Defaults	Comments
interface string / required		Full name of interface to be managed, i.e. Ethernet1/1.
state string	Choices: present ← absent	Manages desired state of the resource.
vrf string / required		Name of VRF to be managed.

Notes

Note

• Tested against NXOSv 7.3.(0)D1(1) on VIRL
• Unsupported for Cisco MDS
• VRF needs to be added globally with :ref:`cisco.nxos.nxos_vrf <cisco.nxos.nxos_vrf_module>` before adding a VRF to an interface.
• Remove a VRF from an interface will still remove all L3 attributes just as it does from CLI.
• VRF is not read from an interface until IP address is configured on that interface.
• 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 vrf ntc exists on Eth1/1
  cisco.nxos.nxos_vrf_interface:
    vrf: ntc
    interface: Ethernet1/1
    state: present

- name: Ensure ntc VRF does not exist on Eth1/1
  cisco.nxos.nxos_vrf_interface:
    vrf: ntc
    interface: Ethernet1/1
    state: absent

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 loopback16', 'vrf member ntc']

Status

Authors

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