New in version 2.1.
Parameter | Choices/Defaults | Comments | |
---|---|---|---|
admin_state |
|
Administrative state of the VRF.
|
|
aggregate
(added in 2.5) |
List of VRFs definitions.
|
||
associated_interfaces
(added in 2.5) |
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 |
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 |
Description of the VRF or keyword 'default'.
|
||
interfaces
(added in 2.5) |
List of interfaces to check the VRF has been configured correctly or keyword 'default'.
|
||
name
required |
Name of VRF to be managed.
aliases: vrf |
||
provider |
Deprecated
Starting with Ansible 2.5 we recommend using
connection: network_cli .This option is only required if you are using NX-API.
For more information please see the NXOS Platform Options guide.
A dict object containing connection details.
|
||
username |
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. |
||
authorize
bool (added in 2.5.3) |
|
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. |
|
ssh_keyfile |
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. |
||
use_proxy
bool (added in 2.5) |
|
If
no , the environment variables http_proxy and https_proxy will be ignored. |
|
auth_pass
(added in 2.5.3) |
Default: none
|
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. |
|
host
required |
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.
|
||
timeout
(added in 2.3) |
Default: 10
|
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).
|
|
use_ssl
bool |
|
Configures the transport to use SSL if set to true only when the
transport=nxapi , otherwise this value is ignored. |
|
password |
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. |
||
validate_certs
bool |
|
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. |
|
port |
Default: 0 (use common port)
|
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).
|
|
transport
required |
Default: cli
|
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.
|
|
purge
bool (added in 2.5) |
|
Purge VRFs not defined in the aggregate parameter.
|
|
rd
(added in 2.2) |
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 |
|
Manages desired state of the resource.
|
|
vni
(added in 2.2) |
Specify virtual network identifier. Valid values are Integer or keyword 'default'.
|
Note
vrf
name must be shorter than 32 chars.vrf=NTC
will create a VRF named NTC, but running it again with vrf=ntc
will not cause a configuration change.- name: Ensure ntc VRF exists on switch
nxos_vrf:
name: ntc
description: testing
state: present
- name: Aggregate definition of VRFs
nxos_vrf:
aggregate:
- { name: test1, description: Testing, admin_state: down }
- { name: test2, interfaces: Ethernet1/2 }
- name: Aggregate definitions of VRFs with Purge
nxos_vrf:
aggregate:
- { name: ntc1, description: purge test1 }
- { name: ntc2, description: purge test2 }
state: present
purge: yes
- name: Delete VRFs exist on switch
nxos_vrf:
aggregate:
- { name: ntc1 }
- { name: ntc2 }
state: absent
- name: Assign interfaces to VRF declaratively
nxos_vrf:
name: test1
interfaces:
- Ethernet2/3
- Ethernet2/5
- name: Check interfaces assigend to VRF
nxos_vrf:
name: test1
associated_interfaces:
- Ethernet2/3
- Ethernet2/5
- name: Ensure VRF is tagged with interface Ethernet2/5 only (Removes from Ethernet2/3)
nxos_vrf:
name: test1
interfaces:
- Ethernet2/5
- name: Delete VRF
nxos_vrf:
name: ntc
state: absent
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:
['vrf context ntc', 'no shutdown', 'interface Ethernet1/2', 'no switchport', 'vrf member test2']
|
This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.
For more information about Red Hat’s support of this module, please refer to this Knowledge Base article
Hint
If you notice any issues in this documentation you can edit this document to improve it.