New in version 2.1.
Manages interface specific VRF configuration.
| parameter | required | default | choices | comments |
|---|---|---|---|---|
| host | yes | 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. |
||
| interface | yes | Full name of interface to be managed, i.e. Ethernet1/1. |
||
| password | no | 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 | no | 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). |
|
| provider | no | Convenience method that allows all nxos arguments to be passed as a dict object. All constraints (required, choices, etc) must be met either by individual arguments or values in this dict. |
||
| ssh_keyfile | no | 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. |
||
| state | no | present |
| Manages desired state of the resource. |
| transport | yes | 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. |
|
| use_ssl | no |
| Configures the transport to use SSL if set to true only when the transport=nxapi, otherwise this value is ignored. |
|
| username | no | Configures the username to use to authenticate the connection to the remote device. The value of username 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. |
||
| vrf | yes | Name of VRF to be managed. |
# ensure vrf ntc exists on Eth1/1 - nxos_vrf_interface: vrf=ntc interface=Ethernet1/1 host=68.170.147.165 state=present # ensure ntc VRF does not exist on Eth1/1 - nxos_vrf_interface: vrf=ntc interface=Ethernet1/1 host=68.170.147.165 state=absent
Common return values are documented here Common Return Values, the following are the fields unique to this module:
| name | description | returned | type | sample |
|---|---|---|---|---|
| end_state | k/v pairs of vrf after module execution | always | dict | {'interface': 'loopback16', 'vrf': 'ntc'} |
| changed | check to see if a change was made on the device | always | boolean | True |
| updates | commands sent to the device | always | list | ['interface loopback16', 'vrf member ntc'] |
| proposed | k/v pairs of parameters passed into module | always | dict | {'interface': 'loopback16', 'vrf': 'ntc'} |
| existing | k/v pairs of existing vrf on the interface | dict | {'interface': 'loopback16', 'vrf': ''} |
Note
VRF needs to be added globally with nxos_vrf before adding a VRF to an interface.
Note
Remove a VRF from an interface will still remove all L3 attributes just as it does from CLI.
Note
VRF is not read from an interface until IP address is configured on that interface.
For more information on what this means please read Core Modules
For help in developing on modules, should you be so inclined, please read Community Information & Contributing, developing_test_pr and Developing Modules.
© 2012–2016 Michael DeHaan
© 2016 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/nxos_vrf_interface_module.html