You are reading an unmaintained version of the Ansible documentation. Unmaintained Ansible versions can contain unfixed security vulnerabilities (CVE). Please upgrade to a maintained version. See the latest Ansible documentation.

cisco.nxos.nxos_vrf_af module – Manages VRF AF.

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_af.

New in cisco.nxos 1.0.0

Synopsis 

Manages VRF AF

Note

This module has a corresponding action plugin.

Parameters 

Parameter	Comments
afi string / required	Address-Family Identifier (AFI). Choices: `"ipv4"` `"ipv6"`
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	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. Choices: `false` ← (default) `true`
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. Choices: `"cli"` ← (default) `"nxapi"`
use_proxy boolean	If `no`, the environment variables `http_proxy` and `https_proxy` will be ignored. Choices: `false` `true` ← (default)
use_ssl boolean	Configures the transport to use SSL if set to `yes` only when the `transport=nxapi`, otherwise this value is ignored. Choices: `false` ← (default) `true`
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. Choices: `false` ← (default) `true`
route_target_both_auto_evpn boolean	Enable/Disable the EVPN route-target ‘auto’ setting for both import and export target communities. Choices: `false` `true`
route_targets list / elements=dictionary	Specify the route-targets which should be imported and/or exported under the AF. This argument accepts a list of dicts that specify the route-target, the direction (import\|export\|both) and state of each route-target. Default direction is `direction=both`. See examples.
direction string	Indicates the direction of the route-target (import\|export\|both) Choices: `"import"` `"export"` `"both"` ← (default)
rt string / required	Defines the route-target itself
state string	Determines whether the route-target with the given direction should be present or not on the device. Choices: `"present"` ← (default) `"absent"`
state string	Determines whether the config should be present or not on the device. Choices: `"present"` ← (default) `"absent"`
vrf string / required	Name of the VRF.

Notes 

Note

Tested against NXOSv 7.3.(0)D1(1) on VIRL
Unsupported for Cisco MDS
Default, where supported, restores params default value.
In case of state=absent the address-family configuration will be absent. Therefore the options route_target_both_auto_evpn and route_targets are ignored.
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 

- cisco.nxos.nxos_vrf_af:
    vrf: ntc
    afi: ipv4
    route_target_both_auto_evpn: true
    state: present

- cisco.nxos.nxos_vrf_af:
    vrf: ntc
    afi: ipv4
    route_targets:
    - rt: 65000:1000
      direction: import
    - rt: 65001:1000
      direction: import

- cisco.nxos.nxos_vrf_af:
    vrf: ntc
    afi: ipv4
    route_targets:
    - rt: 65000:1000
      direction: import
    - rt: 65001:1000
      state: absent

- cisco.nxos.nxos_vrf_af:
    vrf: ntc
    afi: ipv4
    route_targets:
    - rt: 65000:1000
      direction: export
    - rt: 65001:1000
      direction: export

- cisco.nxos.nxos_vrf_af:
    vrf: ntc
    afi: ipv4
    route_targets:
    - rt: 65000:1000
      direction: export
      state: absent

- cisco.nxos.nxos_vrf_af:
    vrf: ntc
    afi: ipv4
    route_targets:
    - rt: 65000:1000
      direction: both
      state: present
    - rt: 65001:1000
      direction: import
      state: present
    - rt: 65002:1000
      direction: both
      state: absent

Return Values 

Common return values are documented here, the following are the fields unique to this module:

Key	Description
commands list / elements=string	commands sent to the device Returned: always Sample: `["vrf context ntc", "address-family ipv4 unicast"]`

Authors

Gabriele Gerbino (@GGabriele)

Collection links

Issue Tracker Repository (Sources)

cisco.nxos.nxos_vrf_af module – Manages VRF AF.

Synopsis

Parameters

Notes

Examples

Return Values

Authors

Collection links

Synopsis 

Parameters 

Notes 

Examples 

Return Values 