cisco.nxos.nxos_vrf – Manages global VRF configuration.¶
Note
This plugin is part of the cisco.nxos collection (version 1.4.0).
To install it use: ansible-galaxy collection install cisco.nxos
.
To use it in a playbook, specify: cisco.nxos.nxos_vrf
.
New in version 1.0.0: of cisco.nxos
Synopsis¶
This module provides declarative management of VRFs on CISCO NXOS network devices.
Note
This module has a corresponding action plugin.
Parameters¶
Parameter | Choices/Defaults | Comments | |
---|---|---|---|
admin_state
string
|
|
Administrative state of the VRF.
|
|
aggregate
list
/ elements=dictionary
|
List of VRFs definitions.
|
||
admin_state
string
|
|
Administrative state of the VRF.
|
|
associated_interfaces
list
/ elements=string
|
This is a intent option and checks the operational state of the for given vrf
name for associated interfaces. If the value in the associated_interfaces does not match with the operational state of vrf interfaces on device it will result in failure. |
||
delay
integer
|
Time in seconds to wait before checking for the operational state on remote device. This wait is applicable for operational state arguments.
|
||
description
string
|
Description of the VRF or keyword 'default'.
|
||
interfaces
list
/ elements=string
|
List of interfaces to check the VRF has been configured correctly or keyword 'default'.
|
||
name
string
|
Name of VRF to be managed.
aliases: vrf |
||
rd
string
|
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'.
|
||
state
string
|
|
Manages desired state of the resource.
|
|
vni
string
|
Specify virtual network identifier. Valid values are Integer or keyword 'default'.
|
||
associated_interfaces
list
/ elements=string
|
This is a intent option and checks the operational state of the for given vrf
name for associated interfaces. If the value in the associated_interfaces does not match with the operational state of vrf interfaces on device it will result in failure. |
||
delay
integer
|
Default: 10
|
Time in seconds to wait before checking for the operational state on remote device. This wait is applicable for operational state arguments.
|
|
description
string
|
Description of the VRF or keyword 'default'.
|
||
interfaces
list
/ elements=string
|
List of interfaces to check the VRF has been configured correctly or keyword 'default'.
|
||
name
string
|
Name of VRF to be managed.
aliases: vrf |
||
provider
dictionary
|
Deprecated
Starting with Ansible 2.5 we recommend using
connection: network_cli .Starting with Ansible 2.6 we recommend using
connection: httpapi for NX-API.This option will be removed in a release after 2022-06-01.
For more information please see the NXOS Platform Options guide.
A dict object containing connection details.
|
||
auth_pass
string
|
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
ANSIBLE_NET_AUTH_PASS will be used instead. |
||
authorize
boolean
|
|
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
ANSIBLE_NET_AUTHORIZE will be used instead. |
|
host
string
|
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.
|
||
password
string
|
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
ANSIBLE_NET_PASSWORD will be used instead. |
||
port
integer
|
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).
|
||
ssh_keyfile
string
|
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
ANSIBLE_NET_SSH_KEYFILE will be used instead. |
||
timeout
integer
|
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).
|
||
transport
string
|
|
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.
|
|
use_proxy
boolean
|
|
If
no , the environment variables http_proxy and https_proxy will be ignored. |
|
use_ssl
boolean
|
|
Configures the transport to use SSL if set to
yes only when the transport=nxapi , otherwise this value is ignored. |
|
username
string
|
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
ANSIBLE_NET_USERNAME will be used instead. |
||
validate_certs
boolean
|
|
If
no , SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates. If the transport argument is not nxapi, this value is ignored. |
|
purge
boolean
|
|
Purge VRFs not defined in the aggregate parameter.
|
|
rd
string
|
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'.
|
||
state
string
|
|
Manages desired state of the resource.
|
|
vni
string
|
Specify virtual network identifier. Valid values are Integer or keyword 'default'.
|
Notes¶
Note
Tested against NXOSv 7.3.(0)D1(1) on VIRL
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 NXOS Platform Options guide
For more information on using Ansible to manage network devices see the Ansible Network Guide
For more information on using Ansible to manage Cisco devices see the Cisco integration page.
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 | Returned | Description |
---|---|---|
commands
list
/ elements=string
|
always |
commands sent to the device
Sample:
['vrf context ntc', 'no shutdown', 'interface Ethernet1/2', 'no switchport', 'vrf member test2']
|
Authors¶
Jason Edelman (@jedelman8)
Gabriele Gerbino (@GGabriele)
Trishna Guha (@trishnaguha)