- AnsibleFest
- Products
- Community
- Webinars & Training
- Blog

Documentation

# nxos_bgp_af – Manages BGP Address-family configuration

- Synopsis

- Parameters

- Notes

- Examples

- Return Values

- Status

## Synopsis

- Manages BGP Address-family configurations on NX-OS switches.

## Parameters

Parameter | Choices/Defaults | Comments
--- | --- | ---
additional_paths_install boolean | Choices: no yes | Install a backup path into the forwarding table and provide prefix independent convergence (PIC) in case of a PE-CE link failure.
additional_paths_receive boolean | Choices: no yes | Enables the receive capability of additional paths for all of the neighbors under this address family for which the capability has not been disabled.
additional_paths_selection - |  | Configures the capability of selecting additional paths for a prefix. Valid values are a string defining the name of the route-map.
additional_paths_send boolean | Choices: no yes | Enables the send capability of additional paths for all of the neighbors under this address family for which the capability has not been disabled.
advertise_l2vpn_evpn boolean | Choices: no yes | Advertise evpn routes.
afi - / required | Choices: ipv4 ipv6 vpnv4 vpnv6 l2vpn | Address Family Identifier.
asn - / required |  | BGP autonomous system number. Valid values are String, Integer in ASPLAIN or ASDOT notation.
client_to_client boolean | Choices: no yes | Configure client-to-client route reflection.
dampen_igp_metric - |  | Specify dampen value for IGP metric-related changes, in seconds. Valid values are integer and keyword 'default'.
dampening_half_time - |  | Specify decay half-life in minutes for route-flap dampening. Valid values are integer and keyword 'default'.
dampening_max_suppress_time - |  | Specify max suppress time for route-flap dampening stable route. Valid values are integer and keyword 'default'.
dampening_reuse_time - |  | Specify route reuse time for route-flap dampening. Valid values are integer and keyword 'default'.
dampening_routemap - |  | Specify route-map for route-flap dampening. Valid values are a string defining the name of the route-map.
dampening_state boolean | Choices: no yes | Enable/disable route-flap dampening.
dampening_suppress_time - |  | Specify route suppress time for route-flap dampening. Valid values are integer and keyword 'default'.
default_information_originate boolean | Choices: no yes | Default information originate.
default_metric - |  | Sets default metrics for routes redistributed into BGP. Valid values are Integer or keyword 'default'
distance_ebgp - |  | Sets the administrative distance for eBGP routes. Valid values are Integer or keyword 'default'.
distance_ibgp - |  | Sets the administrative distance for iBGP routes. Valid values are Integer or keyword 'default'.
distance_local - |  | Sets the administrative distance for local BGP routes. Valid values are Integer or keyword 'default'.
inject_map - |  | An array of route-map names which will specify prefixes to inject. Each array entry must first specify the inject-map name, secondly an exist-map name, and optionally the copy-attributes keyword which indicates that attributes should be copied from the aggregate. For example [['lax_inject_map', 'lax_exist_map'], ['nyc_inject_map', 'nyc_exist_map', 'copy-attributes'], ['fsd_inject_map', 'fsd_exist_map']].
maximum_paths - |  | Configures the maximum number of equal-cost paths for load sharing. Valid value is an integer in the range 1-64.
maximum_paths_ibgp - |  | Configures the maximum number of ibgp equal-cost paths for load sharing. Valid value is an integer in the range 1-64.
networks - |  | Networks to configure. Valid value is a list of network prefixes to advertise. The list must be in the form of an array. Each entry in the array must include a prefix address and an optional route-map. For example [['10.0.0.0/16', 'routemap_LA'], ['192.168.1.1', 'Chicago'], ['192.168.2.0/24'], ['192.168.3.0/24', 'routemap_NYC']].
next_hop_route_map - |  | Configure a route-map for valid nexthops. Valid values are a string defining the name of the route-map.
provider dictionary |  | 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.
| auth_pass string added in 2.5.3 |  | 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 added in 2.5.3 | 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 / 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.
| 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 | 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).
| 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 | 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).
| transport string / required | 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 added in 2.5 | 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.
redistribute - |  | A list of redistribute directives. Multiple redistribute entries are allowed. The list must be in the form of a nested array. the first entry of each array defines the source-protocol to redistribute from; the second entry defines a route-map name. A route-map is highly advised but may be optional on some platforms, in which case it may be omitted from the array list. For example [['direct', 'rm_direct'], ['lisp', 'rm_lisp']].
safi - / required | Choices: unicast multicast evpn | Sub Address Family Identifier.
state - | Choices: present ← absent | Determines whether the config should be present or not on the device.
suppress_inactive boolean | Choices: no yes | Advertises only active routes to peers.
table_map - |  | Apply table-map to filter routes downloaded into URIB. Valid values are a string.
table_map_filter boolean | Choices: no yes | Filters routes rejected by the route-map and does not download them to the RIB.
vrf - / required |  | Name of the VRF. The name 'default' is a valid VRF representing the global bgp.

## Notes

Note

- Tested against NXOSv 7.3.(0)D1(1) on VIRL

- `state=absent` removes the whole BGP ASN configuration

- Default, where supported, restores params default value.

- 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

    # configure a simple address-family
    - nxos_bgp_af:
        asn: 65535
        vrf: TESTING
        afi: ipv4
        safi: unicast
        advertise_l2vpn_evpn: true
        state: present

## Return Values

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: ['router bgp 65535', 'vrf TESTING', 'address-family ipv4 unicast', 'advertise l2vpn evpn']

## Status

- This module is not guaranteed to have a backwards compatible interface. [preview]

- This module is maintained by the Ansible Network Team. [network]

### Red Hat Support

More information about Red Hat’s support of this module is available from this Red Hat Knowledge Base article.

### Authors

- Gabriele Gerbino (@GGabriele)

Hint

If you notice any issues in this documentation, you can edit this document to improve it.