cisco.nxos.nxos_vrf module – Manages global VRF configuration.
Note
This module is part of the cisco.nxos collection (version 3.2.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
.
New in cisco.nxos 1.0.0
Synopsis
This module provides declarative management of VRFs on CISCO NXOS network devices.
Note
This module has a corresponding action plugin.
Parameters
Parameter |
Comments |
---|---|
Administrative state of the VRF. Choices:
|
|
List of VRFs definitions. |
|
Administrative state of the VRF. Choices:
|
|
This is a intent option and checks the operational state of the for given vrf |
|
Time in seconds to wait before checking for the operational state on remote device. This wait is applicable for operational state arguments. |
|
Description of the VRF or keyword ‘default’. |
|
List of interfaces to check the VRF has been configured correctly or keyword ‘default’. |
|
Name of VRF to be managed. |
|
VPN Route Distinguisher (RD). Valid values are a string in one of the route-distinguisher formats (ASN2:NN, ASN4:NN, or IPV4:NN); the keyword ‘auto’, or the keyword ‘default’. |
|
Manages desired state of the resource. Choices:
|
|
Specify virtual network identifier. Valid values are Integer or keyword ‘default’. |
|
This is a intent option and checks the operational state of the for given vrf |
|
Time in seconds to wait before checking for the operational state on remote device. This wait is applicable for operational state arguments. Default: |
|
Description of the VRF or keyword ‘default’. |
|
List of interfaces to check the VRF has been configured correctly or keyword ‘default’. |
|
Name of VRF to be managed. |
|
Deprecated Starting with Ansible 2.5 we recommend using Starting with Ansible 2.6 we recommend using This option will be removed in a release after 2022-06-01. For more information please see the https://docs.ansible.com/ansible/latest/network/user_guide/platform_nxos.html. A dict object containing connection details. |
|
Specifies the password to use if required to enter privileged mode on the remote device. If authorize is false, then this argument does nothing. If the value is not specified in the task, the value of environment variable |
|
Instructs the module to enter privileged mode on the remote device before sending any commands. If not specified, the device will attempt to execute all commands in non-privileged mode. If the value is not specified in the task, the value of environment variable Choices:
|
|
Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport. |
|
Specifies the password to use to authenticate the connection to the remote device. This is a common argument used for either cli or nxapi transports. If the value is not specified in the task, the value of environment variable |
|
Specifies the port to use when building the connection to the remote device. This value applies to either cli or nxapi. The port value will default to the appropriate transport common port if none is provided in the task. (cli=22, http=80, https=443). |
|
Specifies the SSH key to use to authenticate the connection to the remote device. This argument is only used for the cli transport. If the value is not specified in the task, the value of environment variable |
|
Specifies the timeout in seconds for communicating with the network device for either connecting or sending commands. If the timeout is exceeded before the operation is completed, the module will error. NX-API can be slow to return on long-running commands (sh mac, sh bgp, etc). |
|
Configures the transport connection to use when connecting to the remote device. The transport argument supports connectivity to the device over cli (ssh) or nxapi. Choices:
|
|
If Choices:
|
|
Configures the transport to use SSL if set to Choices:
|
|
Configures the username to use to authenticate the connection to the remote device. This value is used to authenticate either the CLI login or the nxapi authentication depending on which transport is used. If the value is not specified in the task, the value of environment variable |
|
If Choices:
|
|
Purge VRFs not defined in the aggregate parameter. Choices:
|
|
VPN Route Distinguisher (RD). Valid values are a string in one of the route-distinguisher formats (ASN2:NN, ASN4:NN, or IPV4:NN); the keyword ‘auto’, or the keyword ‘default’. |
|
Manages desired state of the resource. Choices:
|
|
Specify virtual network identifier. Valid values are Integer or keyword ‘default’. |
Notes
Note
Tested against NXOSv 7.3.(0)D1(1) on VIRL
Unsupported for Cisco MDS
Cisco NX-OS creates the default VRF by itself. Therefore, you’re not allowed to use default as vrf name in this module.
vrf
name must be shorter than 32 chars.VRF names are not case sensible in NX-OS. Anyway, the name is stored just like it’s inserted by the user and it’ll not be changed again unless the VRF is removed and re-created. i.e.
vrf=NTC
will create a VRF named NTC, but running it again withvrf=ntc
will not cause a configuration change.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 ntc VRF exists on switch
cisco.nxos.nxos_vrf:
name: ntc
description: testing
state: present
- name: Aggregate definition of VRFs
cisco.nxos.nxos_vrf:
aggregate:
- {name: test1, description: Testing, admin_state: down}
- {name: test2, interfaces: Ethernet1/2}
- name: Aggregate definitions of VRFs with Purge
cisco.nxos.nxos_vrf:
aggregate:
- {name: ntc1, description: purge test1}
- {name: ntc2, description: purge test2}
state: present
purge: yes
- name: Delete VRFs exist on switch
cisco.nxos.nxos_vrf:
aggregate:
- {name: ntc1}
- {name: ntc2}
state: absent
- name: Assign interfaces to VRF declaratively
cisco.nxos.nxos_vrf:
name: test1
interfaces:
- Ethernet2/3
- Ethernet2/5
- name: Check interfaces assigned to VRF
cisco.nxos.nxos_vrf:
name: test1
associated_interfaces:
- Ethernet2/3
- Ethernet2/5
- name: Ensure VRF is tagged with interface Ethernet2/5 only (Removes from Ethernet2/3)
cisco.nxos.nxos_vrf:
name: test1
interfaces:
- Ethernet2/5
- name: Delete VRF
cisco.nxos.nxos_vrf:
name: ntc
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: |