Documentation

nxos_bgp_af - Manages BGP Address-family configuration.

New in version 2.2.

Synopsis

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

Options

parameter required default choices comments
additional_paths_install
no
  • true
  • false
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
no
  • true
  • false
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
no
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
no
  • true
  • false
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
no
  • true
  • false
Advertise evpn routes.
afi
yes
  • ipv4
  • ipv6
  • vpnv4
  • vpnv6
  • l2vpn
Address Family Identifier.
asn
yes
BGP autonomous system number. Valid values are String, Integer in ASPLAIN or ASDOT notation.
client_to_client
no
  • true
  • false
Configure client-to-client route reflection.
dampen_igp_metric
no
Specify dampen value for IGP metric-related changes, in seconds. Valid values are integer and keyword 'default'.
dampening_half_time
no
Specify decay half-life in minutes for route-flap dampening. Valid values are integer and keyword 'default'.
dampening_max_suppress_time
no
Specify max suppress time for route-flap dampening stable route. Valid values are integer and keyword 'default'.
dampening_reuse_time
no
Specify route reuse time for route-flap dampening. Valid values are integer and keyword 'default'.
dampening_routemap
no
Specify route-map for route-flap dampening. Valid values are a string defining the name of the route-map.
dampening_state
no
  • true
  • false
Enable/disable route-flap dampening.
dampening_suppress_time
no
Specify route suppress time for route-flap dampening. Valid values are integer and keyword 'default'.
default_information_originate
no
  • true
  • false
Default information originate.
default_metric
no
Sets default metrics for routes redistributed into BGP. Valid values are Integer or keyword 'default'
distance_ebgp
no
Sets the administrative distance for eBGP routes. Valid values are Integer or keyword 'default'.
distance_ibgp
no
Sets the administrative distance for iBGP routes. Valid values are Integer or keyword 'default'.
distance_local
no
Sets the administrative distance for local BGP routes. Valid values are Integer or keyword 'default'.
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.
inject_map
no
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
no
Configures the maximum number of equal-cost paths for load sharing. Valid value is an integer in the range 1-64.
maximum_paths_ibgp
no
Configures the maximum number of ibgp equal-cost paths for load sharing. Valid value is an integer in the range 1-64.
networks
no
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
no
Configure a route-map for valid nexthops. Valid values are a string defining the name of the route-map.
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.
redistribute
no
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
yes
  • unicast
  • multicast
  • evpn
Sub Address Family Identifier.
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
  • present
  • absent
Determines whether the config should be present or not on the device.
suppress_inactive
no
  • true
  • false
Advertises only active routes to peers.
table_map
no
Apply table-map to filter routes downloaded into URIB. Valid values are a string.
table_map_filter
no
  • true
  • false
Filters routes rejected by the route-map and does not download them to the RIB.
timeout
(added in 2.3)
no 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
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
  • yes
  • 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. 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
no
  • yes
  • no
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.
vrf
yes
Name of the VRF. The name 'default' is a valid VRF representing the global bgp.

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 Return Values, the following are the fields unique to this module:

name description returned type sample
end_state k/v pairs of BGP AF configuration after module execution verbose mode dict {'table_map_filter': False, 'asn': '65535', 'dampening_max_suppress_time': '', 'additional_paths_send': False, 'safi': 'unicast', 'default_metric': '', 'additional_paths_install': False, 'client_to_client': True, 'dampen_igp_metric': '600', 'dampening_state': False, 'additional_paths_selection': '', 'additional_paths_receive': False, 'vrf': 'TESTING', 'suppress_inactive': False, 'distance_ebgp': '20', 'dampening_routemap': '', 'distance_ibgp': '200', 'redistribute': [], 'distance_local': '220', 'advertise_l2vpn_evpn': True, 'afi': 'ipv4', 'dampening_reuse_time': '', 'maximum_paths': '1', 'inject_map': [], 'networks': [], 'dampening_suppress_time': '', 'default_information_originate': False, 'next_hop_route_map': '', 'table_map': '', 'maximum_paths_ibgp': '1', 'dampening_half_time': ''}
changed check to see if a change was made on the device always boolean True
updates commands sent to the device always list ['router bgp 65535', 'vrf TESTING', 'address-family ipv4 unicast', 'advertise l2vpn evpn']
proposed k/v pairs of parameters passed into module verbose mode dict {'afi': 'ipv4', 'asn': '65535', 'advertise_l2vpn_evpn': True, 'vrf': 'TESTING', 'safi': 'unicast'}
existing k/v pairs of existing BGP AF configuration verbose mode dict {}


Notes

Note

  • state=absent removes the whole BGP ASN configuration
  • Default, where supported, restores params default value.

Status

This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

Support

This module is community maintained without core committer oversight.

For more information on what this means please read Module Support

For help in developing on modules, should you be so inclined, please read Community Information & Contributing, Helping Testing PRs and Developing Modules.