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

Documentation

# nxos_bgp_neighbor_af – Manages BGP address-family’s neighbors configuration

- Synopsis

- Parameters

- Notes

- Examples

- Return Values

- Status

## Synopsis

- Manages BGP address-family’s neighbors configurations on NX-OS switches.

## Parameters

Parameter | Choices/Defaults | Comments
--- | --- | ---
additional_paths_receive - | Choices: enable disable inherit | Valid values are enable for basic command enablement; disable for disabling the command at the neighbor af level (it adds the disable keyword to the basic command); and inherit to remove the command at this level (the command value is inherited from a higher BGP layer).
additional_paths_send - | Choices: enable disable inherit | Valid values are enable for basic command enablement; disable for disabling the command at the neighbor af level (it adds the disable keyword to the basic command); and inherit to remove the command at this level (the command value is inherited from a higher BGP layer).
advertise_map_exist - |  | Conditional route advertisement. This property requires two route maps, an advertise-map and an exist-map. Valid values are an array specifying both the advertise-map name and the exist-map name, or simply 'default' e.g. ['my_advertise_map', 'my_exist_map']. This command is mutually exclusive with the advertise_map_non_exist property.
advertise_map_non_exist - |  | Conditional route advertisement. This property requires two route maps, an advertise-map and an exist-map. Valid values are an array specifying both the advertise-map name and the non-exist-map name, or simply 'default' e.g. ['my_advertise_map', 'my_non_exist_map']. This command is mutually exclusive with the advertise_map_exist property.
afi - / required | Choices: ipv4 ipv6 vpnv4 vpnv6 l2vpn | Address Family Identifier.
allowas_in boolean | Choices: no yes | Activate allowas-in property
allowas_in_max - |  | Max-occurrences value for allowas_in. Valid values are an integer value or 'default'. This is mutually exclusive with allowas_in.
as_override boolean | Choices: no yes | Activate the as-override feature.
asn - / required |  | BGP autonomous system number. Valid values are String, Integer in ASPLAIN or ASDOT notation.
default_originate boolean | Choices: no yes | Activate the default-originate feature.
default_originate_route_map - |  | Route-map for the default_originate property. Valid values are a string defining a route-map name, or 'default'. This is mutually exclusive with default_originate.
disable_peer_as_check boolean added in 2.5 | Choices: no yes | Disable checking of peer AS-number while advertising
filter_list_in - |  | Valid values are a string defining a filter-list name, or 'default'.
filter_list_out - |  | Valid values are a string defining a filter-list name, or 'default'.
max_prefix_interval - |  | Optional restart interval. Valid values are an integer. Requires max_prefix_limit. May not be combined with max_prefix_warning.
max_prefix_limit - |  | maximum-prefix limit value. Valid values are an integer value or 'default'.
max_prefix_threshold - |  | Optional threshold percentage at which to generate a warning. Valid values are an integer value. Requires max_prefix_limit.
max_prefix_warning boolean | Choices: no yes | Optional warning-only keyword. Requires max_prefix_limit. May not be combined with max_prefix_interval.
neighbor - / required |  | Neighbor Identifier. Valid values are string. Neighbors may use IPv4 or IPv6 notation, with or without prefix length.
next_hop_self boolean | Choices: no yes | Activate the next-hop-self feature.
next_hop_third_party boolean | Choices: no yes | Activate the next-hop-third-party feature.
prefix_list_in - |  | Valid values are a string defining a prefix-list name, or 'default'.
prefix_list_out - |  | Valid values are a string defining a prefix-list name, or 'default'.
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.
route_map_in - |  | Valid values are a string defining a route-map name, or 'default'.
route_map_out - |  | Valid values are a string defining a route-map name, or 'default'.
route_reflector_client boolean | Choices: no yes | Router reflector client.
safi - / required | Choices: unicast multicast evpn | Sub Address Family Identifier.
send_community - | Choices: none both extended standard default | send-community attribute.
soft_reconfiguration_in - | Choices: enable always inherit | Valid values are 'enable' for basic command enablement; 'always' to add the always keyword to the basic command; and 'inherit' to remove the command at this level (the command value is inherited from a higher BGP layer).
soo - |  | Site-of-origin. Valid values are a string defining a VPN extcommunity or 'default'.
state - | Choices: present ← absent | Determines whether the config should be present or not on the device.
suppress_inactive boolean | Choices: no yes | suppress-inactive feature.
unsuppress_map - |  | unsuppress-map. Valid values are a string defining a route-map name or 'default'.
vrf - | Default: "default" | Name of the VRF. The name 'default' is a valid VRF representing the global bgp.
weight - |  | Weight value. Valid values are an integer value or 'default'.

## Notes

Note

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

- `state=absent` removes the whole BGP address-family’s neighbor configuration.

- Default, when supported, removes properties

- In order to default maximum-prefix configuration, only `max_prefix_limit=default` is needed.

- 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: configure RR client
      nxos_bgp_neighbor_af:
        asn: 65535
        neighbor: '192.0.2.3'
        afi: ipv4
        safi: unicast
        route_reflector_client: 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', 'neighbor 192.0.2.3', 'address-family ipv4 unicast', 'route-reflector-client']

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