cisco.nxos.nxos_vrf_interface – Manages interface specific VRF configuration.  Note This plugin is part of the cisco.nxos collection (version 2.7.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 version 1.0.0: of cisco.nxos   Synopsis Parameters Notes Examples Return Values  Synopsis  Manages interface specific VRF configuration.   Note This module has a corresponding action plugin.  Parameters   Parameter Choices/Defaults Comments    interface  string / required      Full name of interface to be managed, i.e. Ethernet1/1.     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 https://docs.ansible.com/ansible/latest/network/user_guide/platform_nxos.html. 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    
Choices: 
no ← yes    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    
Choices: 
cli ← nxapi    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    
Choices: no 
yes ←    If no, the environment variables http_proxy and https_proxy will be ignored.      use_ssl  boolean    
Choices: 
no ← yes    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    
Choices: 
no ← yes    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.     state  string    
Choices: 
present ← absent    Manages desired state of the resource.     vrf  string / required      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 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 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 Returned Description    commands  list / elements=string   always  commands sent to the device  Sample: ['interface loopback16', 'vrf member ntc']     Authors  Jason Edelman (@jedelman8) Gabriele Gerbino (@GGabriele) 

    © 2012–2018 Michael DeHaan
{'path': 'public/docs/ansible/collections/cisco/nxos/nxos_vrf_interface_module.html', 'source': 'DevDocs.IO'}