cisco.nxos.nxos_vrf_interface module – Manages interface specific VRF configuration.
Note
This module is part of the cisco.nxos collection (version 8.1.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_vrf_interface.
New in cisco.nxos 1.0.0
Synopsis
Manages interface specific VRF configuration.
Aliases: vrf_interface
Parameters
Parameter |
Comments |
|---|---|
Full name of interface to be managed, i.e. Ethernet1/1. |
|
Manages desired state of the resource. Choices:
|
|
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 cisco.nxos.nxos_vrf 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 <https://www.ansible.com/integrations/networks/cisco>`_.
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 |
Description |
|---|---|
commands sent to the device Returned: always Sample: |